blob: 4380dcc064a5301a9fa4a077566d6bc450b1d28f [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/**
25 * snd_soc_jack_new - Create a new jack
Peter Meerwalda92b0782012-10-02 14:08:19 +020026 * @codec: ASoC codec
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
31 *
32 * Creates a new jack object.
33 *
34 * Returns zero if successful, or a negative error code on failure.
35 * On success jack will be initialised.
36 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000037int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +000038 struct snd_soc_jack *jack)
39{
Mark Brown2667b4b2012-03-12 14:07:49 +000040 mutex_init(&jack->mutex);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000041 jack->codec = codec;
Mark Brown8a2cd612009-01-07 17:31:10 +000042 INIT_LIST_HEAD(&jack->pins);
Vinod Koulfa9879e2011-02-09 14:44:17 +053043 INIT_LIST_HEAD(&jack->jack_zones);
Mark Brownd5021ec2010-03-22 12:06:30 +000044 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
Mark Brown8a2cd612009-01-07 17:31:10 +000045
Lars-Peter Clausen00200102014-07-17 22:01:07 +020046 return snd_jack_new(codec->component.card->snd_card, id, type, &jack->jack);
Mark Brown8a2cd612009-01-07 17:31:10 +000047}
48EXPORT_SYMBOL_GPL(snd_soc_jack_new);
49
50/**
51 * snd_soc_jack_report - Report the current status for a jack
52 *
53 * @jack: the jack
54 * @status: a bitmask of enum snd_jack_type values that are currently detected.
55 * @mask: a bitmask of enum snd_jack_type values that being reported.
56 *
57 * If configured using snd_soc_jack_add_pins() then the associated
58 * DAPM pins will be enabled or disabled as appropriate and DAPM
59 * synchronised.
60 *
61 * Note: This function uses mutexes and should be called from a
62 * context which can sleep (such as a workqueue).
63 */
64void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
65{
Julia Lawall4f066172009-10-17 08:32:56 +020066 struct snd_soc_codec *codec;
Liam Girdwoodce6120c2010-11-05 15:53:46 +020067 struct snd_soc_dapm_context *dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000068 struct snd_soc_jack_pin *pin;
Vinod Koul30a765d2013-10-21 19:07:34 +053069 unsigned int sync = 0;
Mark Brown8a2cd612009-01-07 17:31:10 +000070 int enable;
Mark Brown8a2cd612009-01-07 17:31:10 +000071
Mark Brown3028eb82010-12-05 12:22:46 +000072 trace_snd_soc_jack_report(jack, mask, status);
73
Mark Brown3a278a02010-03-29 20:31:14 +010074 if (!jack)
Mark Brown8a2cd612009-01-07 17:31:10 +000075 return;
Mark Brown3a278a02010-03-29 20:31:14 +010076
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000077 codec = jack->codec;
Liam Girdwoodce6120c2010-11-05 15:53:46 +020078 dapm = &codec->dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000079
Mark Brown2667b4b2012-03-12 14:07:49 +000080 mutex_lock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +000081
Mark Brown8a2cd612009-01-07 17:31:10 +000082 jack->status &= ~mask;
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020083 jack->status |= status & mask;
Mark Brown8a2cd612009-01-07 17:31:10 +000084
Mark Brown3028eb82010-12-05 12:22:46 +000085 trace_snd_soc_jack_notify(jack, status);
86
Mark Brown8a2cd612009-01-07 17:31:10 +000087 list_for_each_entry(pin, &jack->pins, list) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020088 enable = pin->mask & jack->status;
Mark Brown8a2cd612009-01-07 17:31:10 +000089
90 if (pin->invert)
91 enable = !enable;
92
93 if (enable)
Liam Girdwoodce6120c2010-11-05 15:53:46 +020094 snd_soc_dapm_enable_pin(dapm, pin->pin);
Mark Brown8a2cd612009-01-07 17:31:10 +000095 else
Liam Girdwoodce6120c2010-11-05 15:53:46 +020096 snd_soc_dapm_disable_pin(dapm, pin->pin);
Vinod Koul30a765d2013-10-21 19:07:34 +053097
98 /* we need to sync for this case only */
99 sync = 1;
Mark Brown8a2cd612009-01-07 17:31:10 +0000100 }
101
Mark Brownd5021ec2010-03-22 12:06:30 +0000102 /* Report before the DAPM sync to help users updating micbias status */
Mark Brown12022a72012-08-13 16:28:36 +0100103 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
Mark Brownd5021ec2010-03-22 12:06:30 +0000104
Vinod Koul30a765d2013-10-21 19:07:34 +0530105 if (sync)
106 snd_soc_dapm_sync(dapm);
Mark Brown8a2cd612009-01-07 17:31:10 +0000107
Mark Brown747da0f2011-09-04 08:18:18 -0700108 snd_jack_report(jack->jack, jack->status);
Mark Brown8a2cd612009-01-07 17:31:10 +0000109
Mark Brown2667b4b2012-03-12 14:07:49 +0000110 mutex_unlock(&jack->mutex);
Mark Brown8a2cd612009-01-07 17:31:10 +0000111}
112EXPORT_SYMBOL_GPL(snd_soc_jack_report);
113
114/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530115 * snd_soc_jack_add_zones - Associate voltage zones with jack
116 *
117 * @jack: ASoC jack
118 * @count: Number of zones
Masanari Iidabb29a932014-11-12 00:52:23 +0900119 * @zones: Array of zones
Vinod Koulfa9879e2011-02-09 14:44:17 +0530120 *
121 * After this function has been called the zones specified in the
122 * array will be associated with the jack.
123 */
124int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
125 struct snd_soc_jack_zone *zones)
126{
127 int i;
128
129 for (i = 0; i < count; i++) {
130 INIT_LIST_HEAD(&zones[i].list);
131 list_add(&(zones[i].list), &jack->jack_zones);
132 }
133 return 0;
134}
135EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
136
137/**
138 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
Peter Meerwalda92b0782012-10-02 14:08:19 +0200139 * the type of jack from the zones declared in the jack type
Vinod Koulfa9879e2011-02-09 14:44:17 +0530140 *
Peter Meerwalda92b0782012-10-02 14:08:19 +0200141 * @jack: ASoC jack
Vinod Koulfa9879e2011-02-09 14:44:17 +0530142 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
143 *
144 * Based on the mic bias value passed, this function helps identify
Peter Meerwalda92b0782012-10-02 14:08:19 +0200145 * the type of jack from the already declared jack zones
Vinod Koulfa9879e2011-02-09 14:44:17 +0530146 */
147int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
148{
149 struct snd_soc_jack_zone *zone;
150
151 list_for_each_entry(zone, &jack->jack_zones, list) {
152 if (micbias_voltage >= zone->min_mv &&
153 micbias_voltage < zone->max_mv)
154 return zone->jack_type;
155 }
156 return 0;
157}
158EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
159
160/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000161 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
162 *
163 * @jack: ASoC jack
164 * @count: Number of pins
165 * @pins: Array of pins
166 *
167 * After this function has been called the DAPM pins specified in the
168 * pins array will have their status updated to reflect the current
169 * state of the jack whenever the jack status is updated.
170 */
171int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
172 struct snd_soc_jack_pin *pins)
173{
174 int i;
175
176 for (i = 0; i < count; i++) {
177 if (!pins[i].pin) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000178 dev_err(jack->codec->dev, "ASoC: No name for pin %d\n",
179 i);
Mark Brown8a2cd612009-01-07 17:31:10 +0000180 return -EINVAL;
181 }
182 if (!pins[i].mask) {
Liam Girdwood008d55e2012-11-19 14:39:14 +0000183 dev_err(jack->codec->dev, "ASoC: No mask for pin %d"
184 " (%s)\n", i, pins[i].pin);
Mark Brown8a2cd612009-01-07 17:31:10 +0000185 return -EINVAL;
186 }
187
188 INIT_LIST_HEAD(&pins[i].list);
189 list_add(&(pins[i].list), &jack->pins);
190 }
191
192 /* Update to reflect the last reported status; canned jack
193 * implementations are likely to set their state before the
194 * card has an opportunity to associate pins.
195 */
196 snd_soc_jack_report(jack, 0, 0);
197
198 return 0;
199}
200EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600201
Mark Brownd5021ec2010-03-22 12:06:30 +0000202/**
203 * snd_soc_jack_notifier_register - Register a notifier for jack status
204 *
205 * @jack: ASoC jack
206 * @nb: Notifier block to register
207 *
208 * Register for notification of the current status of the jack. Note
209 * that it is not possible to report additional jack events in the
210 * callback from the notifier, this is intended to support
211 * applications such as enabling electrical detection only when a
212 * mechanical detection event has occurred.
213 */
214void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
215 struct notifier_block *nb)
216{
217 blocking_notifier_chain_register(&jack->notifier, nb);
218}
219EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
220
221/**
222 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
223 *
224 * @jack: ASoC jack
225 * @nb: Notifier block to unregister
226 *
227 * Stop notifying for status changes.
228 */
229void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
230 struct notifier_block *nb)
231{
232 blocking_notifier_chain_unregister(&jack->notifier, nb);
233}
234EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
235
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600236#ifdef CONFIG_GPIOLIB
237/* gpio detect */
Mark Brown26bd7b42009-03-06 11:32:17 +0000238static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600239{
240 struct snd_soc_jack *jack = gpio->jack;
241 int enable;
242 int report;
243
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300244 enable = gpiod_get_value_cansleep(gpio->desc);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600245 if (gpio->invert)
246 enable = !enable;
247
248 if (enable)
249 report = gpio->report;
250 else
251 report = 0;
252
Joonyoung Shimc871a052009-11-12 17:14:04 +0900253 if (gpio->jack_status_check)
xiangxiaocb29d7b2014-02-23 14:40:44 +0800254 report = gpio->jack_status_check(gpio->data);
Joonyoung Shimc871a052009-11-12 17:14:04 +0900255
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600256 snd_soc_jack_report(jack, report, gpio->report);
257}
258
259/* irq handler for gpio pin */
260static irqreturn_t gpio_handler(int irq, void *data)
261{
262 struct snd_soc_jack_gpio *gpio = data;
Lars-Peter Clausen00200102014-07-17 22:01:07 +0200263 struct device *dev = gpio->jack->codec->component.card->dev;
Mark Brownf9a67052010-11-14 19:25:09 +0000264
Mark Brown3028eb82010-12-05 12:22:46 +0000265 trace_snd_soc_jack_irq(gpio->name);
266
Mark Brownf9a67052010-11-14 19:25:09 +0000267 if (device_may_wakeup(dev))
268 pm_wakeup_event(dev, gpio->debounce_time + 50);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600269
Mark Browne6058aa2013-07-18 22:47:10 +0100270 queue_delayed_work(system_power_efficient_wq, &gpio->work,
Mark Brown4c14d782010-10-06 15:54:28 -0700271 msecs_to_jiffies(gpio->debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600272
273 return IRQ_HANDLED;
274}
275
276/* gpio work */
277static void gpio_work(struct work_struct *work)
278{
279 struct snd_soc_jack_gpio *gpio;
280
Mark Brown4c14d782010-10-06 15:54:28 -0700281 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600282 snd_soc_jack_gpio_detect(gpio);
283}
284
285/**
286 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
287 *
288 * @jack: ASoC jack
289 * @count: number of pins
290 * @gpios: array of gpio pins
291 *
292 * This function will request gpio, set data direction and request irq
293 * for each gpio in the array.
294 */
295int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
296 struct snd_soc_jack_gpio *gpios)
297{
298 int i, ret;
299
300 for (i = 0; i < count; i++) {
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600301 if (!gpios[i].name) {
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300302 dev_err(jack->codec->dev,
303 "ASoC: No name for gpio at index %d\n", i);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600304 ret = -EINVAL;
305 goto undo;
306 }
307
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300308 if (gpios[i].gpiod_dev) {
309 /* GPIO descriptor */
310 gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev,
311 gpios[i].name,
Alexandre Courbot00d647b2014-10-23 17:15:18 +0900312 gpios[i].idx, GPIOD_IN);
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300313 if (IS_ERR(gpios[i].desc)) {
314 ret = PTR_ERR(gpios[i].desc);
315 dev_err(gpios[i].gpiod_dev,
316 "ASoC: Cannot get gpio at index %d: %d",
317 i, ret);
318 goto undo;
319 }
320 } else {
321 /* legacy GPIO number */
322 if (!gpio_is_valid(gpios[i].gpio)) {
323 dev_err(jack->codec->dev,
324 "ASoC: Invalid gpio %d\n",
325 gpios[i].gpio);
326 ret = -EINVAL;
327 goto undo;
328 }
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600329
Alexandre Courbot00d647b2014-10-23 17:15:18 +0900330 ret = gpio_request_one(gpios[i].gpio, GPIOF_IN,
331 gpios[i].name);
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300332 if (ret)
333 goto undo;
334
335 gpios[i].desc = gpio_to_desc(gpios[i].gpio);
336 }
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300337
Mark Brown4c14d782010-10-06 15:54:28 -0700338 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
Lars-Peter Clausenb8e22c12009-07-31 21:15:25 +0200339 gpios[i].jack = jack;
340
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300341 ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc),
Mark Brown3f58fd82010-11-03 09:35:31 -0400342 gpio_handler,
343 IRQF_TRIGGER_RISING |
344 IRQF_TRIGGER_FALLING,
Stephen Warren363618f2011-04-01 14:50:43 -0600345 gpios[i].name,
Mark Brown3f58fd82010-11-03 09:35:31 -0400346 &gpios[i]);
Axel Lind2b4c7b2011-08-13 19:15:01 +0800347 if (ret < 0)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600348 goto err;
349
Mark Brown7887ab32011-02-17 16:35:55 -0800350 if (gpios[i].wake) {
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300351 ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1);
Mark Brown7887ab32011-02-17 16:35:55 -0800352 if (ret != 0)
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300353 dev_err(jack->codec->dev,
354 "ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
355 i, ret);
Mark Brown7887ab32011-02-17 16:35:55 -0800356 }
357
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200358 /* Expose GPIO value over sysfs for diagnostic purposes */
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300359 gpiod_export(gpios[i].desc, false);
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200360
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200361 /* Update initial jack status */
xiangxiaof1adf5b2014-02-23 14:44:52 +0800362 schedule_delayed_work(&gpios[i].work,
363 msecs_to_jiffies(gpios[i].debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600364 }
365
366 return 0;
367
368err:
369 gpio_free(gpios[i].gpio);
370undo:
371 snd_soc_jack_free_gpios(jack, i, gpios);
372
373 return ret;
374}
375EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
376
377/**
Jarkko Nikulaf025d3b2014-05-26 14:34:37 +0300378 * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
379 *
380 * @gpiod_dev: GPIO consumer device
381 * @jack: ASoC jack
382 * @count: number of pins
383 * @gpios: array of gpio pins
384 *
385 * This function will request gpio, set data direction and request irq
386 * for each gpio in the array.
387 */
388int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
389 struct snd_soc_jack *jack,
390 int count, struct snd_soc_jack_gpio *gpios)
391{
392 int i;
393
394 for (i = 0; i < count; i++)
395 gpios[i].gpiod_dev = gpiod_dev;
396
397 return snd_soc_jack_add_gpios(jack, count, gpios);
398}
399EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods);
400
401/**
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600402 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
403 *
404 * @jack: ASoC jack
405 * @count: number of pins
406 * @gpios: array of gpio pins
407 *
408 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
409 */
410void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
411 struct snd_soc_jack_gpio *gpios)
412{
413 int i;
414
415 for (i = 0; i < count; i++) {
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300416 gpiod_unexport(gpios[i].desc);
417 free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]);
Mark Brown4c14d782010-10-06 15:54:28 -0700418 cancel_delayed_work_sync(&gpios[i].work);
Jarkko Nikula50dfb692014-05-26 14:34:36 +0300419 gpiod_put(gpios[i].desc);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600420 gpios[i].jack = NULL;
421 }
422}
423EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
424#endif /* CONFIG_GPIOLIB */