blob: fbaa1bb41102f45920f478008070ee53cdbbb6b4 [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>
Jarkko Nikula50dfb692014-05-26 14:34:36 +030017#include <linux/gpio/consumer.h>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060018#include <linux/interrupt.h>
19#include <linux/workqueue.h>
20#include <linux/delay.h>
Paul Gortmakerd81a6d72011-09-22 09:34:58 -040021#include <linux/export.h>
Mark Brown3028eb82010-12-05 12:22:46 +000022#include <trace/events/asoc.h>
Mark Brown8a2cd612009-01-07 17:31:10 +000023
24/**
Lars-Peter Clausen97093992015-03-04 10:33:17 +010025 * snd_soc_card_jack_new - Create a new jack
26 * @card: ASoC card
Mark Brown8a2cd612009-01-07 17:31:10 +000027 * @id: an identifying string for this jack
28 * @type: a bitmask of enum snd_jack_type values that can be detected by
29 * this jack
30 * @jack: structure to use for the jack
Lars-Peter Clausen97093992015-03-04 10:33:17 +010031 * @pins: Array of jack pins to be added to the jack or NULL
32 * @num_pins: Number of elements in the @pins array
Mark Brown8a2cd612009-01-07 17:31:10 +000033 *
34 * Creates a new jack object.
35 *
36 * Returns zero if successful, or a negative error code on failure.
37 * On success jack will be initialised.
38 */
Lars-Peter Clausen97093992015-03-04 10:33:17 +010039int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
40 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
41 unsigned int num_pins)
Mark Brown8a2cd612009-01-07 17:31:10 +000042{
Lars-Peter Clausen97093992015-03-04 10:33:17 +010043 int ret;
44
Mark Brown2667b4b2012-03-12 14:07:49 +000045 mutex_init(&jack->mutex);
Lars-Peter Clausen97093992015-03-04 10:33:17 +010046 jack->card = card;
Mark Brown8a2cd612009-01-07 17:31:10 +000047 INIT_LIST_HEAD(&jack->pins);
Vinod Koulfa9879e2011-02-09 14:44:17 +053048 INIT_LIST_HEAD(&jack->jack_zones);
Mark Brownd5021ec2010-03-22 12:06:30 +000049 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
Mark Brown8a2cd612009-01-07 17:31:10 +000050
Jie Yang4e3f0dc2015-04-27 21:20:58 +080051 ret = snd_jack_new(card->snd_card, id, type, &jack->jack, false, false);
Lars-Peter Clausen97093992015-03-04 10:33:17 +010052 if (ret)
53 return ret;
54
55 if (num_pins)
56 return snd_soc_jack_add_pins(jack, num_pins, pins);
57
58 return 0;
Mark Brown8a2cd612009-01-07 17:31:10 +000059}
Lars-Peter Clausen97093992015-03-04 10:33:17 +010060EXPORT_SYMBOL_GPL(snd_soc_card_jack_new);
Mark Brown8a2cd612009-01-07 17:31:10 +000061
62/**
63 * snd_soc_jack_report - Report the current status for a jack
64 *
65 * @jack: the jack
66 * @status: a bitmask of enum snd_jack_type values that are currently detected.
67 * @mask: a bitmask of enum snd_jack_type values that being reported.
68 *
69 * If configured using snd_soc_jack_add_pins() then the associated
70 * DAPM pins will be enabled or disabled as appropriate and DAPM
71 * synchronised.
72 *
73 * Note: This function uses mutexes and should be called from a
74 * context which can sleep (such as a workqueue).
75 */
76void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
77{
Liam Girdwoodce6120c2010-11-05 15:53:46 +020078 struct snd_soc_dapm_context *dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000079 struct snd_soc_jack_pin *pin;
Vinod Koul30a765d2013-10-21 19:07:34 +053080 unsigned int sync = 0;
Mark Brown8a2cd612009-01-07 17:31:10 +000081 int enable;
Mark Brown8a2cd612009-01-07 17:31:10 +000082
Mark Brown3028eb82010-12-05 12:22:46 +000083 trace_snd_soc_jack_report(jack, mask, status);
84
Mark Brown3a278a02010-03-29 20:31:14 +010085 if (!jack)
Mark Brown8a2cd612009-01-07 17:31:10 +000086 return;
Mark Brown3a278a02010-03-29 20:31:14 +010087
Lars-Peter Clausen97093992015-03-04 10:33:17 +010088 dapm = &jack->card->dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000089
Mark Brown2667b4b2012-03-12 14:07:49 +000090 mutex_lock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +000091
Mark Brown8a2cd612009-01-07 17:31:10 +000092 jack->status &= ~mask;
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020093 jack->status |= status & mask;
Mark Brown8a2cd612009-01-07 17:31:10 +000094
Mark Brown3028eb82010-12-05 12:22:46 +000095 trace_snd_soc_jack_notify(jack, status);
96
Mark Brown8a2cd612009-01-07 17:31:10 +000097 list_for_each_entry(pin, &jack->pins, list) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020098 enable = pin->mask & jack->status;
Mark Brown8a2cd612009-01-07 17:31:10 +000099
100 if (pin->invert)
101 enable = !enable;
102
103 if (enable)
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200104 snd_soc_dapm_enable_pin(dapm, pin->pin);
Mark Brown8a2cd612009-01-07 17:31:10 +0000105 else
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200106 snd_soc_dapm_disable_pin(dapm, pin->pin);
Vinod Koul30a765d2013-10-21 19:07:34 +0530107
108 /* we need to sync for this case only */
109 sync = 1;
Mark Brown8a2cd612009-01-07 17:31:10 +0000110 }
111
Mark Brownd5021ec2010-03-22 12:06:30 +0000112 /* Report before the DAPM sync to help users updating micbias status */
Mark Brown12022a72012-08-13 16:28:36 +0100113 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
Mark Brownd5021ec2010-03-22 12:06:30 +0000114
Vinod Koul30a765d2013-10-21 19:07:34 +0530115 if (sync)
116 snd_soc_dapm_sync(dapm);
Mark Brown8a2cd612009-01-07 17:31:10 +0000117
Mark Brown747da0f2011-09-04 08:18:18 -0700118 snd_jack_report(jack->jack, jack->status);
Mark Brown8a2cd612009-01-07 17:31:10 +0000119
Mark Brown2667b4b2012-03-12 14:07:49 +0000120 mutex_unlock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +0000121}
122EXPORT_SYMBOL_GPL(snd_soc_jack_report);
123
124/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530125 * snd_soc_jack_add_zones - Associate voltage zones with jack
126 *
127 * @jack: ASoC jack
128 * @count: Number of zones
Masanari Iidabb29a932014-11-12 00:52:23 +0900129 * @zones: Array of zones
Vinod Koulfa9879e2011-02-09 14:44:17 +0530130 *
131 * After this function has been called the zones specified in the
132 * array will be associated with the jack.
133 */
134int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
135 struct snd_soc_jack_zone *zones)
136{
137 int i;
138
139 for (i = 0; i < count; i++) {
140 INIT_LIST_HEAD(&zones[i].list);
141 list_add(&(zones[i].list), &jack->jack_zones);
142 }
143 return 0;
144}
145EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
146
147/**
148 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
Peter Meerwalda92b0782012-10-02 14:08:19 +0200149 * the type of jack from the zones declared in the jack type
Vinod Koulfa9879e2011-02-09 14:44:17 +0530150 *
Peter Meerwalda92b0782012-10-02 14:08:19 +0200151 * @jack: ASoC jack
Vinod Koulfa9879e2011-02-09 14:44:17 +0530152 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
153 *
154 * Based on the mic bias value passed, this function helps identify
Peter Meerwalda92b0782012-10-02 14:08:19 +0200155 * the type of jack from the already declared jack zones
Vinod Koulfa9879e2011-02-09 14:44:17 +0530156 */
157int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
158{
159 struct snd_soc_jack_zone *zone;
160
161 list_for_each_entry(zone, &jack->jack_zones, list) {
162 if (micbias_voltage >= zone->min_mv &&
163 micbias_voltage < zone->max_mv)
164 return zone->jack_type;
165 }
166 return 0;
167}
168EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
169
170/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000171 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
172 *
173 * @jack: ASoC jack
174 * @count: Number of pins
175 * @pins: Array of pins
176 *
177 * After this function has been called the DAPM pins specified in the
178 * pins array will have their status updated to reflect the current
179 * state of the jack whenever the jack status is updated.
180 */
181int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
182 struct snd_soc_jack_pin *pins)
183{
184 int i;
185
186 for (i = 0; i < count; i++) {
187 if (!pins[i].pin) {
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100188 dev_err(jack->card->dev, "ASoC: No name for pin %d\n",
Liam Girdwood008d55e2012-11-19 14:39:14 +0000189 i);
Mark Brown8a2cd612009-01-07 17:31:10 +0000190 return -EINVAL;
191 }
192 if (!pins[i].mask) {
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100193 dev_err(jack->card->dev, "ASoC: No mask for pin %d"
Liam Girdwood008d55e2012-11-19 14:39:14 +0000194 " (%s)\n", i, pins[i].pin);
Mark Brown8a2cd612009-01-07 17:31:10 +0000195 return -EINVAL;
196 }
197
198 INIT_LIST_HEAD(&pins[i].list);
199 list_add(&(pins[i].list), &jack->pins);
Jie Yangf63e8582015-04-27 21:21:00 +0800200 snd_jack_add_new_kctl(jack->jack, pins[i].pin, pins[i].mask);
Mark Brown8a2cd612009-01-07 17:31:10 +0000201 }
202
203 /* Update to reflect the last reported status; canned jack
204 * implementations are likely to set their state before the
205 * card has an opportunity to associate pins.
206 */
207 snd_soc_jack_report(jack, 0, 0);
208
209 return 0;
210}
211EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600212
Mark Brownd5021ec2010-03-22 12:06:30 +0000213/**
214 * snd_soc_jack_notifier_register - Register a notifier for jack status
215 *
216 * @jack: ASoC jack
217 * @nb: Notifier block to register
218 *
219 * Register for notification of the current status of the jack. Note
220 * that it is not possible to report additional jack events in the
221 * callback from the notifier, this is intended to support
222 * applications such as enabling electrical detection only when a
223 * mechanical detection event has occurred.
224 */
225void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
226 struct notifier_block *nb)
227{
228 blocking_notifier_chain_register(&jack->notifier, nb);
229}
230EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
231
232/**
233 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
234 *
235 * @jack: ASoC jack
236 * @nb: Notifier block to unregister
237 *
238 * Stop notifying for status changes.
239 */
240void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
241 struct notifier_block *nb)
242{
243 blocking_notifier_chain_unregister(&jack->notifier, nb);
244}
245EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
246
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600247#ifdef CONFIG_GPIOLIB
248/* gpio detect */
Mark Brown26bd7b42009-03-06 11:32:17 +0000249static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600250{
251 struct snd_soc_jack *jack = gpio->jack;
252 int enable;
253 int report;
254
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300255 enable = gpiod_get_value_cansleep(gpio->desc);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600256 if (gpio->invert)
257 enable = !enable;
258
259 if (enable)
260 report = gpio->report;
261 else
262 report = 0;
263
Joonyoung Shimc871a052009-11-12 17:14:04 +0900264 if (gpio->jack_status_check)
xiangxiaocb29d7b2014-02-23 14:40:44 +0800265 report = gpio->jack_status_check(gpio->data);
Joonyoung Shimc871a052009-11-12 17:14:04 +0900266
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600267 snd_soc_jack_report(jack, report, gpio->report);
268}
269
270/* irq handler for gpio pin */
271static irqreturn_t gpio_handler(int irq, void *data)
272{
273 struct snd_soc_jack_gpio *gpio = data;
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100274 struct device *dev = gpio->jack->card->dev;
Mark Brownf9a67052010-11-14 19:25:09 +0000275
Mark Brown3028eb82010-12-05 12:22:46 +0000276 trace_snd_soc_jack_irq(gpio->name);
277
Mark Brownf9a67052010-11-14 19:25:09 +0000278 if (device_may_wakeup(dev))
279 pm_wakeup_event(dev, gpio->debounce_time + 50);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600280
Mark Browne6058aa2013-07-18 22:47:10 +0100281 queue_delayed_work(system_power_efficient_wq, &gpio->work,
Mark Brown4c14d782010-10-06 15:54:28 -0700282 msecs_to_jiffies(gpio->debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600283
284 return IRQ_HANDLED;
285}
286
287/* gpio work */
288static void gpio_work(struct work_struct *work)
289{
290 struct snd_soc_jack_gpio *gpio;
291
Mark Brown4c14d782010-10-06 15:54:28 -0700292 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600293 snd_soc_jack_gpio_detect(gpio);
294}
295
296/**
297 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
298 *
299 * @jack: ASoC jack
300 * @count: number of pins
301 * @gpios: array of gpio pins
302 *
303 * This function will request gpio, set data direction and request irq
304 * for each gpio in the array.
305 */
306int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
307 struct snd_soc_jack_gpio *gpios)
308{
309 int i, ret;
310
311 for (i = 0; i < count; i++) {
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600312 if (!gpios[i].name) {
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100313 dev_err(jack->card->dev,
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300314 "ASoC: No name for gpio at index %d\n", i);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600315 ret = -EINVAL;
316 goto undo;
317 }
318
Dylan Reide616d2e2015-05-22 15:09:20 -0700319 if (gpios[i].desc) {
320 /* Already have a GPIO descriptor. */
321 goto got_gpio;
322 } else if (gpios[i].gpiod_dev) {
323 /* Get a GPIO descriptor */
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300324 gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev,
325 gpios[i].name,
Alexandre Courbot00d647b2014-10-23 17:15:18 +0900326 gpios[i].idx, GPIOD_IN);
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300327 if (IS_ERR(gpios[i].desc)) {
328 ret = PTR_ERR(gpios[i].desc);
329 dev_err(gpios[i].gpiod_dev,
330 "ASoC: Cannot get gpio at index %d: %d",
331 i, ret);
332 goto undo;
333 }
334 } else {
335 /* legacy GPIO number */
336 if (!gpio_is_valid(gpios[i].gpio)) {
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100337 dev_err(jack->card->dev,
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300338 "ASoC: Invalid gpio %d\n",
339 gpios[i].gpio);
340 ret = -EINVAL;
341 goto undo;
342 }
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600343
Alexandre Courbot00d647b2014-10-23 17:15:18 +0900344 ret = gpio_request_one(gpios[i].gpio, GPIOF_IN,
345 gpios[i].name);
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300346 if (ret)
347 goto undo;
348
349 gpios[i].desc = gpio_to_desc(gpios[i].gpio);
350 }
Dylan Reide616d2e2015-05-22 15:09:20 -0700351got_gpio:
Mark Brown4c14d782010-10-06 15:54:28 -0700352 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
Lars-Peter Clausenb8e22c12009-07-31 21:15:25 +0200353 gpios[i].jack = jack;
354
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300355 ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc),
Mark Brown3f58fd82010-11-03 09:35:31 -0400356 gpio_handler,
357 IRQF_TRIGGER_RISING |
358 IRQF_TRIGGER_FALLING,
Stephen Warren363618f2011-04-01 14:50:43 -0600359 gpios[i].name,
Mark Brown3f58fd82010-11-03 09:35:31 -0400360 &gpios[i]);
Axel Lind2b4c7b2011-08-13 19:15:01 +0800361 if (ret < 0)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600362 goto err;
363
Mark Brown7887ab32011-02-17 16:35:55 -0800364 if (gpios[i].wake) {
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300365 ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1);
Mark Brown7887ab32011-02-17 16:35:55 -0800366 if (ret != 0)
Lars-Peter Clausen97093992015-03-04 10:33:17 +0100367 dev_err(jack->card->dev,
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300368 "ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
369 i, ret);
Mark Brown7887ab32011-02-17 16:35:55 -0800370 }
371
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200372 /* Expose GPIO value over sysfs for diagnostic purposes */
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300373 gpiod_export(gpios[i].desc, false);
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200374
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200375 /* Update initial jack status */
xiangxiaof1adf5b2014-02-23 14:44:52 +0800376 schedule_delayed_work(&gpios[i].work,
377 msecs_to_jiffies(gpios[i].debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600378 }
379
380 return 0;
381
382err:
383 gpio_free(gpios[i].gpio);
384undo:
385 snd_soc_jack_free_gpios(jack, i, gpios);
386
387 return ret;
388}
389EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
390
391/**
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300392 * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
393 *
394 * @gpiod_dev: GPIO consumer device
395 * @jack: ASoC jack
396 * @count: number of pins
397 * @gpios: array of gpio pins
398 *
399 * This function will request gpio, set data direction and request irq
400 * for each gpio in the array.
401 */
402int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
403 struct snd_soc_jack *jack,
404 int count, struct snd_soc_jack_gpio *gpios)
405{
406 int i;
407
408 for (i = 0; i < count; i++)
409 gpios[i].gpiod_dev = gpiod_dev;
410
411 return snd_soc_jack_add_gpios(jack, count, gpios);
412}
413EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods);
414
415/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600416 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
417 *
418 * @jack: ASoC jack
419 * @count: number of pins
420 * @gpios: array of gpio pins
421 *
422 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
423 */
424void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
425 struct snd_soc_jack_gpio *gpios)
426{
427 int i;
428
429 for (i = 0; i < count; i++) {
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300430 gpiod_unexport(gpios[i].desc);
431 free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]);
Mark Brown4c14d782010-10-06 15:54:28 -0700432 cancel_delayed_work_sync(&gpios[i].work);
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300433 gpiod_put(gpios[i].desc);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600434 gpios[i].jack = NULL;
435 }
436}
437EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
438#endif /* CONFIG_GPIOLIB */