blob: b903f822d1b2069062cae422d4a3a5f96f3ca342 [file] [log] [blame]
Mark Brown8a2cd612009-01-07 17:31:10 +00001/*
2 * soc-jack.c -- ALSA SoC jack handling
3 *
4 * Copyright 2008 Wolfson Microelectronics PLC.
5 *
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
12 */
13
14#include <sound/jack.h>
15#include <sound/soc.h>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060016#include <linux/gpio.h>
17#include <linux/interrupt.h>
18#include <linux/workqueue.h>
19#include <linux/delay.h>
Paul Gortmakerd81a6d72011-09-22 09:34:58 -040020#include <linux/export.h>
Mark Brown3028eb82010-12-05 12:22:46 +000021#include <trace/events/asoc.h>
Mark Brown8a2cd612009-01-07 17:31:10 +000022
23/**
24 * snd_soc_jack_new - Create a new jack
Peter Meerwalda92b0782012-10-02 14:08:19 +020025 * @codec: ASoC codec
Mark Brown8a2cd612009-01-07 17:31:10 +000026 * @id: an identifying string for this jack
27 * @type: a bitmask of enum snd_jack_type values that can be detected by
28 * this jack
29 * @jack: structure to use for the jack
30 *
31 * Creates a new jack object.
32 *
33 * Returns zero if successful, or a negative error code on failure.
34 * On success jack will be initialised.
35 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000036int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +000037 struct snd_soc_jack *jack)
38{
Mark Brown2667b4b2012-03-12 14:07:49 +000039 mutex_init(&jack->mutex);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000040 jack->codec = codec;
Mark Brown8a2cd612009-01-07 17:31:10 +000041 INIT_LIST_HEAD(&jack->pins);
Vinod Koulfa9879e2011-02-09 14:44:17 +053042 INIT_LIST_HEAD(&jack->jack_zones);
Mark Brownd5021ec2010-03-22 12:06:30 +000043 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
Mark Brown8a2cd612009-01-07 17:31:10 +000044
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000045 return snd_jack_new(codec->card->snd_card, id, type, &jack->jack);
Mark Brown8a2cd612009-01-07 17:31:10 +000046}
47EXPORT_SYMBOL_GPL(snd_soc_jack_new);
48
49/**
50 * snd_soc_jack_report - Report the current status for a jack
51 *
52 * @jack: the jack
53 * @status: a bitmask of enum snd_jack_type values that are currently detected.
54 * @mask: a bitmask of enum snd_jack_type values that being reported.
55 *
56 * If configured using snd_soc_jack_add_pins() then the associated
57 * DAPM pins will be enabled or disabled as appropriate and DAPM
58 * synchronised.
59 *
60 * Note: This function uses mutexes and should be called from a
61 * context which can sleep (such as a workqueue).
62 */
63void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
64{
Julia Lawall4f066172009-10-17 08:32:56 +020065 struct snd_soc_codec *codec;
Liam Girdwoodce6120c2010-11-05 15:53:46 +020066 struct snd_soc_dapm_context *dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000067 struct snd_soc_jack_pin *pin;
Vinod Koul30a765d2013-10-21 19:07:34 +053068 unsigned int sync = 0;
Mark Brown8a2cd612009-01-07 17:31:10 +000069 int enable;
Mark Brown8a2cd612009-01-07 17:31:10 +000070
Mark Brown3028eb82010-12-05 12:22:46 +000071 trace_snd_soc_jack_report(jack, mask, status);
72
Mark Brown3a278a02010-03-29 20:31:14 +010073 if (!jack)
Mark Brown8a2cd612009-01-07 17:31:10 +000074 return;
Mark Brown3a278a02010-03-29 20:31:14 +010075
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000076 codec = jack->codec;
Liam Girdwoodce6120c2010-11-05 15:53:46 +020077 dapm = &codec->dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000078
Mark Brown2667b4b2012-03-12 14:07:49 +000079 mutex_lock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +000080
Mark Brown8a2cd612009-01-07 17:31:10 +000081 jack->status &= ~mask;
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020082 jack->status |= status & mask;
Mark Brown8a2cd612009-01-07 17:31:10 +000083
Mark Brown3028eb82010-12-05 12:22:46 +000084 trace_snd_soc_jack_notify(jack, status);
85
Mark Brown8a2cd612009-01-07 17:31:10 +000086 list_for_each_entry(pin, &jack->pins, list) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020087 enable = pin->mask & jack->status;
Mark Brown8a2cd612009-01-07 17:31:10 +000088
89 if (pin->invert)
90 enable = !enable;
91
92 if (enable)
Liam Girdwoodce6120c2010-11-05 15:53:46 +020093 snd_soc_dapm_enable_pin(dapm, pin->pin);
Mark Brown8a2cd612009-01-07 17:31:10 +000094 else
Liam Girdwoodce6120c2010-11-05 15:53:46 +020095 snd_soc_dapm_disable_pin(dapm, pin->pin);
Vinod Koul30a765d2013-10-21 19:07:34 +053096
97 /* we need to sync for this case only */
98 sync = 1;
Mark Brown8a2cd612009-01-07 17:31:10 +000099 }
100
Mark Brownd5021ec2010-03-22 12:06:30 +0000101 /* Report before the DAPM sync to help users updating micbias status */
Mark Brown12022a72012-08-13 16:28:36 +0100102 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
Mark Brownd5021ec2010-03-22 12:06:30 +0000103
Vinod Koul30a765d2013-10-21 19:07:34 +0530104 if (sync)
105 snd_soc_dapm_sync(dapm);
Mark Brown8a2cd612009-01-07 17:31:10 +0000106
Mark Brown747da0f2011-09-04 08:18:18 -0700107 snd_jack_report(jack->jack, jack->status);
Mark Brown8a2cd612009-01-07 17:31:10 +0000108
Mark Brown2667b4b2012-03-12 14:07:49 +0000109 mutex_unlock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +0000110}
111EXPORT_SYMBOL_GPL(snd_soc_jack_report);
112
113/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530114 * snd_soc_jack_add_zones - Associate voltage zones with jack
115 *
116 * @jack: ASoC jack
117 * @count: Number of zones
118 * @zone: Array of zones
119 *
120 * After this function has been called the zones specified in the
121 * array will be associated with the jack.
122 */
123int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
124 struct snd_soc_jack_zone *zones)
125{
126 int i;
127
128 for (i = 0; i < count; i++) {
129 INIT_LIST_HEAD(&zones[i].list);
130 list_add(&(zones[i].list), &jack->jack_zones);
131 }
132 return 0;
133}
134EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
135
136/**
137 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
Peter Meerwalda92b0782012-10-02 14:08:19 +0200138 * the type of jack from the zones declared in the jack type
Vinod Koulfa9879e2011-02-09 14:44:17 +0530139 *
Peter Meerwalda92b0782012-10-02 14:08:19 +0200140 * @jack: ASoC jack
Vinod Koulfa9879e2011-02-09 14:44:17 +0530141 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
142 *
143 * Based on the mic bias value passed, this function helps identify
Peter Meerwalda92b0782012-10-02 14:08:19 +0200144 * the type of jack from the already declared jack zones
Vinod Koulfa9879e2011-02-09 14:44:17 +0530145 */
146int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
147{
148 struct snd_soc_jack_zone *zone;
149
150 list_for_each_entry(zone, &jack->jack_zones, list) {
151 if (micbias_voltage >= zone->min_mv &&
152 micbias_voltage < zone->max_mv)
153 return zone->jack_type;
154 }
155 return 0;
156}
157EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
158
159/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000160 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
161 *
162 * @jack: ASoC jack
163 * @count: Number of pins
164 * @pins: Array of pins
165 *
166 * After this function has been called the DAPM pins specified in the
167 * pins array will have their status updated to reflect the current
168 * state of the jack whenever the jack status is updated.
169 */
170int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
171 struct snd_soc_jack_pin *pins)
172{
173 int i;
174
175 for (i = 0; i < count; i++) {
176 if (!pins[i].pin) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000177 dev_err(jack->codec->dev, "ASoC: No name for pin %d\n",
178 i);
Mark Brown8a2cd612009-01-07 17:31:10 +0000179 return -EINVAL;
180 }
181 if (!pins[i].mask) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000182 dev_err(jack->codec->dev, "ASoC: No mask for pin %d"
183 " (%s)\n", i, pins[i].pin);
Mark Brown8a2cd612009-01-07 17:31:10 +0000184 return -EINVAL;
185 }
186
187 INIT_LIST_HEAD(&pins[i].list);
188 list_add(&(pins[i].list), &jack->pins);
189 }
190
191 /* Update to reflect the last reported status; canned jack
192 * implementations are likely to set their state before the
193 * card has an opportunity to associate pins.
194 */
195 snd_soc_jack_report(jack, 0, 0);
196
197 return 0;
198}
199EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600200
Mark Brownd5021ec2010-03-22 12:06:30 +0000201/**
202 * snd_soc_jack_notifier_register - Register a notifier for jack status
203 *
204 * @jack: ASoC jack
205 * @nb: Notifier block to register
206 *
207 * Register for notification of the current status of the jack. Note
208 * that it is not possible to report additional jack events in the
209 * callback from the notifier, this is intended to support
210 * applications such as enabling electrical detection only when a
211 * mechanical detection event has occurred.
212 */
213void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
214 struct notifier_block *nb)
215{
216 blocking_notifier_chain_register(&jack->notifier, nb);
217}
218EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
219
220/**
221 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
222 *
223 * @jack: ASoC jack
224 * @nb: Notifier block to unregister
225 *
226 * Stop notifying for status changes.
227 */
228void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
229 struct notifier_block *nb)
230{
231 blocking_notifier_chain_unregister(&jack->notifier, nb);
232}
233EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
234
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600235#ifdef CONFIG_GPIOLIB
236/* gpio detect */
Mark Brown26bd7b42009-03-06 11:32:17 +0000237static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600238{
239 struct snd_soc_jack *jack = gpio->jack;
240 int enable;
241 int report;
242
Jarkko Nikula535787b2011-02-10 17:22:23 +0200243 enable = gpio_get_value_cansleep(gpio->gpio);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600244 if (gpio->invert)
245 enable = !enable;
246
247 if (enable)
248 report = gpio->report;
249 else
250 report = 0;
251
Joonyoung Shimc871a052009-11-12 17:14:04 +0900252 if (gpio->jack_status_check)
xiangxiaocb29d7b2014-02-23 14:40:44 +0800253 report = gpio->jack_status_check(gpio->data);
Joonyoung Shimc871a052009-11-12 17:14:04 +0900254
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600255 snd_soc_jack_report(jack, report, gpio->report);
256}
257
258/* irq handler for gpio pin */
259static irqreturn_t gpio_handler(int irq, void *data)
260{
261 struct snd_soc_jack_gpio *gpio = data;
Mark Brownf9a67052010-11-14 19:25:09 +0000262 struct device *dev = gpio->jack->codec->card->dev;
263
Mark Brown3028eb82010-12-05 12:22:46 +0000264 trace_snd_soc_jack_irq(gpio->name);
265
Mark Brownf9a67052010-11-14 19:25:09 +0000266 if (device_may_wakeup(dev))
267 pm_wakeup_event(dev, gpio->debounce_time + 50);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600268
Mark Browne6058aa2013-07-18 22:47:10 +0100269 queue_delayed_work(system_power_efficient_wq, &gpio->work,
Mark Brown4c14d782010-10-06 15:54:28 -0700270 msecs_to_jiffies(gpio->debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600271
272 return IRQ_HANDLED;
273}
274
275/* gpio work */
276static void gpio_work(struct work_struct *work)
277{
278 struct snd_soc_jack_gpio *gpio;
279
Mark Brown4c14d782010-10-06 15:54:28 -0700280 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600281 snd_soc_jack_gpio_detect(gpio);
282}
283
284/**
285 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
286 *
287 * @jack: ASoC jack
288 * @count: number of pins
289 * @gpios: array of gpio pins
290 *
291 * This function will request gpio, set data direction and request irq
292 * for each gpio in the array.
293 */
294int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
295 struct snd_soc_jack_gpio *gpios)
296{
297 int i, ret;
298
299 for (i = 0; i < count; i++) {
300 if (!gpio_is_valid(gpios[i].gpio)) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000301 dev_err(jack->codec->dev, "ASoC: Invalid gpio %d\n",
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600302 gpios[i].gpio);
303 ret = -EINVAL;
304 goto undo;
305 }
306 if (!gpios[i].name) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000307 dev_err(jack->codec->dev, "ASoC: No name for gpio %d\n",
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600308 gpios[i].gpio);
309 ret = -EINVAL;
310 goto undo;
311 }
312
313 ret = gpio_request(gpios[i].gpio, gpios[i].name);
314 if (ret)
315 goto undo;
316
317 ret = gpio_direction_input(gpios[i].gpio);
318 if (ret)
319 goto err;
320
Mark Brown4c14d782010-10-06 15:54:28 -0700321 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
Lars-Peter Clausenb8e22c12009-07-31 21:15:25 +0200322 gpios[i].jack = jack;
323
Mark Brown3f58fd82010-11-03 09:35:31 -0400324 ret = request_any_context_irq(gpio_to_irq(gpios[i].gpio),
325 gpio_handler,
326 IRQF_TRIGGER_RISING |
327 IRQF_TRIGGER_FALLING,
Stephen Warren363618f2011-04-01 14:50:43 -0600328 gpios[i].name,
Mark Brown3f58fd82010-11-03 09:35:31 -0400329 &gpios[i]);
Axel Lind2b4c7b2011-08-13 19:15:01 +0800330 if (ret < 0)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600331 goto err;
332
Mark Brown7887ab32011-02-17 16:35:55 -0800333 if (gpios[i].wake) {
Thomas Gleixner458f7f82011-03-30 00:39:44 +0200334 ret = irq_set_irq_wake(gpio_to_irq(gpios[i].gpio), 1);
Mark Brown7887ab32011-02-17 16:35:55 -0800335 if (ret != 0)
Liam Girdwood008d55e2012-11-19 14:39:14 +0000336 dev_err(jack->codec->dev, "ASoC: "
Mark Brown7887ab32011-02-17 16:35:55 -0800337 "Failed to mark GPIO %d as wake source: %d\n",
338 gpios[i].gpio, ret);
339 }
340
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200341 /* Expose GPIO value over sysfs for diagnostic purposes */
342 gpio_export(gpios[i].gpio, false);
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200343
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200344 /* Update initial jack status */
xiangxiaof1adf5b2014-02-23 14:44:52 +0800345 schedule_delayed_work(&gpios[i].work,
346 msecs_to_jiffies(gpios[i].debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600347 }
348
349 return 0;
350
351err:
352 gpio_free(gpios[i].gpio);
353undo:
354 snd_soc_jack_free_gpios(jack, i, gpios);
355
356 return ret;
357}
358EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
359
360/**
361 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
362 *
363 * @jack: ASoC jack
364 * @count: number of pins
365 * @gpios: array of gpio pins
366 *
367 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
368 */
369void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
370 struct snd_soc_jack_gpio *gpios)
371{
372 int i;
373
374 for (i = 0; i < count; i++) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200375 gpio_unexport(gpios[i].gpio);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600376 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
Mark Brown4c14d782010-10-06 15:54:28 -0700377 cancel_delayed_work_sync(&gpios[i].work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600378 gpio_free(gpios[i].gpio);
379 gpios[i].jack = NULL;
380 }
381}
382EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
383#endif /* CONFIG_GPIOLIB */