blob: 71358e3b54d93ef10c3e402d98f66773b81d27fc [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;
68 int enable;
Mark Brown8a2cd612009-01-07 17:31:10 +000069
Mark Brown3028eb82010-12-05 12:22:46 +000070 trace_snd_soc_jack_report(jack, mask, status);
71
Mark Brown3a278a02010-03-29 20:31:14 +010072 if (!jack)
Mark Brown8a2cd612009-01-07 17:31:10 +000073 return;
Mark Brown3a278a02010-03-29 20:31:14 +010074
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000075 codec = jack->codec;
Liam Girdwoodce6120c2010-11-05 15:53:46 +020076 dapm = &codec->dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000077
Mark Brown2667b4b2012-03-12 14:07:49 +000078 mutex_lock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +000079
Mark Brown8a2cd612009-01-07 17:31:10 +000080 jack->status &= ~mask;
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020081 jack->status |= status & mask;
Mark Brown8a2cd612009-01-07 17:31:10 +000082
Mark Brown3028eb82010-12-05 12:22:46 +000083 trace_snd_soc_jack_notify(jack, status);
84
Mark Brown8a2cd612009-01-07 17:31:10 +000085 list_for_each_entry(pin, &jack->pins, list) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020086 enable = pin->mask & jack->status;
Mark Brown8a2cd612009-01-07 17:31:10 +000087
88 if (pin->invert)
89 enable = !enable;
90
91 if (enable)
Liam Girdwoodce6120c2010-11-05 15:53:46 +020092 snd_soc_dapm_enable_pin(dapm, pin->pin);
Mark Brown8a2cd612009-01-07 17:31:10 +000093 else
Liam Girdwoodce6120c2010-11-05 15:53:46 +020094 snd_soc_dapm_disable_pin(dapm, pin->pin);
Mark Brown8a2cd612009-01-07 17:31:10 +000095 }
96
Mark Brownd5021ec2010-03-22 12:06:30 +000097 /* Report before the DAPM sync to help users updating micbias status */
Mark Brown12022a72012-08-13 16:28:36 +010098 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
Mark Brownd5021ec2010-03-22 12:06:30 +000099
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200100 snd_soc_dapm_sync(dapm);
Mark Brown8a2cd612009-01-07 17:31:10 +0000101
Mark Brown747da0f2011-09-04 08:18:18 -0700102 snd_jack_report(jack->jack, jack->status);
Mark Brown8a2cd612009-01-07 17:31:10 +0000103
Mark Brown2667b4b2012-03-12 14:07:49 +0000104 mutex_unlock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +0000105}
106EXPORT_SYMBOL_GPL(snd_soc_jack_report);
107
108/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530109 * snd_soc_jack_add_zones - Associate voltage zones with jack
110 *
111 * @jack: ASoC jack
112 * @count: Number of zones
113 * @zone: Array of zones
114 *
115 * After this function has been called the zones specified in the
116 * array will be associated with the jack.
117 */
118int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
119 struct snd_soc_jack_zone *zones)
120{
121 int i;
122
123 for (i = 0; i < count; i++) {
124 INIT_LIST_HEAD(&zones[i].list);
125 list_add(&(zones[i].list), &jack->jack_zones);
126 }
127 return 0;
128}
129EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
130
131/**
132 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
Peter Meerwalda92b0782012-10-02 14:08:19 +0200133 * the type of jack from the zones declared in the jack type
Vinod Koulfa9879e2011-02-09 14:44:17 +0530134 *
Peter Meerwalda92b0782012-10-02 14:08:19 +0200135 * @jack: ASoC jack
Vinod Koulfa9879e2011-02-09 14:44:17 +0530136 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
137 *
138 * Based on the mic bias value passed, this function helps identify
Peter Meerwalda92b0782012-10-02 14:08:19 +0200139 * the type of jack from the already declared jack zones
Vinod Koulfa9879e2011-02-09 14:44:17 +0530140 */
141int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
142{
143 struct snd_soc_jack_zone *zone;
144
145 list_for_each_entry(zone, &jack->jack_zones, list) {
146 if (micbias_voltage >= zone->min_mv &&
147 micbias_voltage < zone->max_mv)
148 return zone->jack_type;
149 }
150 return 0;
151}
152EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
153
154/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000155 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
156 *
157 * @jack: ASoC jack
158 * @count: Number of pins
159 * @pins: Array of pins
160 *
161 * After this function has been called the DAPM pins specified in the
162 * pins array will have their status updated to reflect the current
163 * state of the jack whenever the jack status is updated.
164 */
165int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
166 struct snd_soc_jack_pin *pins)
167{
168 int i;
169
170 for (i = 0; i < count; i++) {
171 if (!pins[i].pin) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000172 dev_err(jack->codec->dev, "ASoC: No name for pin %d\n",
173 i);
Mark Brown8a2cd612009-01-07 17:31:10 +0000174 return -EINVAL;
175 }
176 if (!pins[i].mask) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000177 dev_err(jack->codec->dev, "ASoC: No mask for pin %d"
178 " (%s)\n", i, pins[i].pin);
Mark Brown8a2cd612009-01-07 17:31:10 +0000179 return -EINVAL;
180 }
181
182 INIT_LIST_HEAD(&pins[i].list);
183 list_add(&(pins[i].list), &jack->pins);
184 }
185
186 /* Update to reflect the last reported status; canned jack
187 * implementations are likely to set their state before the
188 * card has an opportunity to associate pins.
189 */
190 snd_soc_jack_report(jack, 0, 0);
191
192 return 0;
193}
194EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600195
Mark Brownd5021ec2010-03-22 12:06:30 +0000196/**
197 * snd_soc_jack_notifier_register - Register a notifier for jack status
198 *
199 * @jack: ASoC jack
200 * @nb: Notifier block to register
201 *
202 * Register for notification of the current status of the jack. Note
203 * that it is not possible to report additional jack events in the
204 * callback from the notifier, this is intended to support
205 * applications such as enabling electrical detection only when a
206 * mechanical detection event has occurred.
207 */
208void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
209 struct notifier_block *nb)
210{
211 blocking_notifier_chain_register(&jack->notifier, nb);
212}
213EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
214
215/**
216 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
217 *
218 * @jack: ASoC jack
219 * @nb: Notifier block to unregister
220 *
221 * Stop notifying for status changes.
222 */
223void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
224 struct notifier_block *nb)
225{
226 blocking_notifier_chain_unregister(&jack->notifier, nb);
227}
228EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
229
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600230#ifdef CONFIG_GPIOLIB
231/* gpio detect */
Mark Brown26bd7b42009-03-06 11:32:17 +0000232static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600233{
234 struct snd_soc_jack *jack = gpio->jack;
235 int enable;
236 int report;
237
Jarkko Nikula535787b2011-02-10 17:22:23 +0200238 enable = gpio_get_value_cansleep(gpio->gpio);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600239 if (gpio->invert)
240 enable = !enable;
241
242 if (enable)
243 report = gpio->report;
244 else
245 report = 0;
246
Joonyoung Shimc871a052009-11-12 17:14:04 +0900247 if (gpio->jack_status_check)
248 report = gpio->jack_status_check();
249
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600250 snd_soc_jack_report(jack, report, gpio->report);
251}
252
253/* irq handler for gpio pin */
254static irqreturn_t gpio_handler(int irq, void *data)
255{
256 struct snd_soc_jack_gpio *gpio = data;
Mark Brownf9a67052010-11-14 19:25:09 +0000257 struct device *dev = gpio->jack->codec->card->dev;
258
Mark Brown3028eb82010-12-05 12:22:46 +0000259 trace_snd_soc_jack_irq(gpio->name);
260
Mark Brownf9a67052010-11-14 19:25:09 +0000261 if (device_may_wakeup(dev))
262 pm_wakeup_event(dev, gpio->debounce_time + 50);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600263
Mark Browne6058aa2013-07-18 22:47:10 +0100264 queue_delayed_work(system_power_efficient_wq, &gpio->work,
Mark Brown4c14d782010-10-06 15:54:28 -0700265 msecs_to_jiffies(gpio->debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600266
267 return IRQ_HANDLED;
268}
269
270/* gpio work */
271static void gpio_work(struct work_struct *work)
272{
273 struct snd_soc_jack_gpio *gpio;
274
Mark Brown4c14d782010-10-06 15:54:28 -0700275 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600276 snd_soc_jack_gpio_detect(gpio);
277}
278
279/**
280 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
281 *
282 * @jack: ASoC jack
283 * @count: number of pins
284 * @gpios: array of gpio pins
285 *
286 * This function will request gpio, set data direction and request irq
287 * for each gpio in the array.
288 */
289int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
290 struct snd_soc_jack_gpio *gpios)
291{
292 int i, ret;
293
294 for (i = 0; i < count; i++) {
295 if (!gpio_is_valid(gpios[i].gpio)) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000296 dev_err(jack->codec->dev, "ASoC: Invalid gpio %d\n",
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600297 gpios[i].gpio);
298 ret = -EINVAL;
299 goto undo;
300 }
301 if (!gpios[i].name) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000302 dev_err(jack->codec->dev, "ASoC: No name for gpio %d\n",
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600303 gpios[i].gpio);
304 ret = -EINVAL;
305 goto undo;
306 }
307
308 ret = gpio_request(gpios[i].gpio, gpios[i].name);
309 if (ret)
310 goto undo;
311
312 ret = gpio_direction_input(gpios[i].gpio);
313 if (ret)
314 goto err;
315
Mark Brown4c14d782010-10-06 15:54:28 -0700316 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
Lars-Peter Clausenb8e22c12009-07-31 21:15:25 +0200317 gpios[i].jack = jack;
318
Mark Brown3f58fd82010-11-03 09:35:31 -0400319 ret = request_any_context_irq(gpio_to_irq(gpios[i].gpio),
320 gpio_handler,
321 IRQF_TRIGGER_RISING |
322 IRQF_TRIGGER_FALLING,
Stephen Warren363618f2011-04-01 14:50:43 -0600323 gpios[i].name,
Mark Brown3f58fd82010-11-03 09:35:31 -0400324 &gpios[i]);
Axel Lind2b4c7b2011-08-13 19:15:01 +0800325 if (ret < 0)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600326 goto err;
327
Mark Brown7887ab32011-02-17 16:35:55 -0800328 if (gpios[i].wake) {
Thomas Gleixner458f7f82011-03-30 00:39:44 +0200329 ret = irq_set_irq_wake(gpio_to_irq(gpios[i].gpio), 1);
Mark Brown7887ab32011-02-17 16:35:55 -0800330 if (ret != 0)
Liam Girdwood008d55e2012-11-19 14:39:14 +0000331 dev_err(jack->codec->dev, "ASoC: "
Mark Brown7887ab32011-02-17 16:35:55 -0800332 "Failed to mark GPIO %d as wake source: %d\n",
333 gpios[i].gpio, ret);
334 }
335
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200336 /* Expose GPIO value over sysfs for diagnostic purposes */
337 gpio_export(gpios[i].gpio, false);
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200338
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200339 /* Update initial jack status */
340 snd_soc_jack_gpio_detect(&gpios[i]);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600341 }
342
343 return 0;
344
345err:
346 gpio_free(gpios[i].gpio);
347undo:
348 snd_soc_jack_free_gpios(jack, i, gpios);
349
350 return ret;
351}
352EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
353
354/**
355 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
356 *
357 * @jack: ASoC jack
358 * @count: number of pins
359 * @gpios: array of gpio pins
360 *
361 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
362 */
363void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
364 struct snd_soc_jack_gpio *gpios)
365{
366 int i;
367
368 for (i = 0; i < count; i++) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200369 gpio_unexport(gpios[i].gpio);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600370 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
Mark Brown4c14d782010-10-06 15:54:28 -0700371 cancel_delayed_work_sync(&gpios[i].work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600372 gpio_free(gpios[i].gpio);
373 gpios[i].jack = NULL;
374 }
375}
376EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
377#endif /* CONFIG_GPIOLIB */