Commit | Line | Data |
---|---|---|
8ab0215c KM |
1 | // SPDX-License-Identifier: GPL-2.0+ |
2 | // | |
3 | // soc-jack.c -- ALSA SoC jack handling | |
4 | // | |
5 | // Copyright 2008 Wolfson Microelectronics PLC. | |
6 | // | |
7 | // Author: Mark Brown <broonie@opensource.wolfsonmicro.com> | |
8a2cd618 MB |
8 | |
9 | #include <sound/jack.h> | |
10 | #include <sound/soc.h> | |
ec67624d | 11 | #include <linux/gpio.h> |
50dfb69d | 12 | #include <linux/gpio/consumer.h> |
ec67624d LCM |
13 | #include <linux/interrupt.h> |
14 | #include <linux/workqueue.h> | |
15 | #include <linux/delay.h> | |
d81a6d71 | 16 | #include <linux/export.h> |
73548dd3 | 17 | #include <linux/suspend.h> |
3028eb8c | 18 | #include <trace/events/asoc.h> |
8a2cd618 | 19 | |
bd29ae96 TI |
20 | struct jack_gpio_tbl { |
21 | int count; | |
22 | struct snd_soc_jack *jack; | |
23 | struct snd_soc_jack_gpio *gpios; | |
24 | }; | |
25 | ||
44c07365 KM |
26 | /** |
27 | * snd_soc_component_set_jack - configure component jack. | |
28 | * @component: COMPONENTs | |
29 | * @jack: structure to use for the jack | |
30 | * @data: can be used if codec driver need extra data for configuring jack | |
31 | * | |
32 | * Configures and enables jack detection function. | |
33 | */ | |
34 | int snd_soc_component_set_jack(struct snd_soc_component *component, | |
35 | struct snd_soc_jack *jack, void *data) | |
36 | { | |
44c07365 KM |
37 | if (component->driver->set_jack) |
38 | return component->driver->set_jack(component, jack, data); | |
39 | ||
40 | return -ENOTSUPP; | |
41 | } | |
42 | EXPORT_SYMBOL_GPL(snd_soc_component_set_jack); | |
43 | ||
8a2cd618 | 44 | /** |
97093996 LPC |
45 | * snd_soc_card_jack_new - Create a new jack |
46 | * @card: ASoC card | |
8a2cd618 MB |
47 | * @id: an identifying string for this jack |
48 | * @type: a bitmask of enum snd_jack_type values that can be detected by | |
49 | * this jack | |
50 | * @jack: structure to use for the jack | |
97093996 LPC |
51 | * @pins: Array of jack pins to be added to the jack or NULL |
52 | * @num_pins: Number of elements in the @pins array | |
8a2cd618 MB |
53 | * |
54 | * Creates a new jack object. | |
55 | * | |
56 | * Returns zero if successful, or a negative error code on failure. | |
57 | * On success jack will be initialised. | |
58 | */ | |
97093996 LPC |
59 | int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type, |
60 | struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins, | |
61 | unsigned int num_pins) | |
8a2cd618 | 62 | { |
97093996 LPC |
63 | int ret; |
64 | ||
2667b4b8 | 65 | mutex_init(&jack->mutex); |
97093996 | 66 | jack->card = card; |
8a2cd618 | 67 | INIT_LIST_HEAD(&jack->pins); |
fa9879ed | 68 | INIT_LIST_HEAD(&jack->jack_zones); |
d5021ec9 | 69 | BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier); |
8a2cd618 | 70 | |
4e3f0dc6 | 71 | ret = snd_jack_new(card->snd_card, id, type, &jack->jack, false, false); |
97093996 LPC |
72 | if (ret) |
73 | return ret; | |
74 | ||
75 | if (num_pins) | |
76 | return snd_soc_jack_add_pins(jack, num_pins, pins); | |
77 | ||
78 | return 0; | |
8a2cd618 | 79 | } |
97093996 | 80 | EXPORT_SYMBOL_GPL(snd_soc_card_jack_new); |
8a2cd618 MB |
81 | |
82 | /** | |
83 | * snd_soc_jack_report - Report the current status for a jack | |
84 | * | |
85 | * @jack: the jack | |
86 | * @status: a bitmask of enum snd_jack_type values that are currently detected. | |
87 | * @mask: a bitmask of enum snd_jack_type values that being reported. | |
88 | * | |
89 | * If configured using snd_soc_jack_add_pins() then the associated | |
90 | * DAPM pins will be enabled or disabled as appropriate and DAPM | |
91 | * synchronised. | |
92 | * | |
93 | * Note: This function uses mutexes and should be called from a | |
94 | * context which can sleep (such as a workqueue). | |
95 | */ | |
96 | void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask) | |
97 | { | |
ce6120cc | 98 | struct snd_soc_dapm_context *dapm; |
8a2cd618 | 99 | struct snd_soc_jack_pin *pin; |
30a765d6 | 100 | unsigned int sync = 0; |
8a2cd618 | 101 | int enable; |
8a2cd618 | 102 | |
3028eb8c MB |
103 | trace_snd_soc_jack_report(jack, mask, status); |
104 | ||
3a278a0c | 105 | if (!jack) |
8a2cd618 | 106 | return; |
3a278a0c | 107 | |
97093996 | 108 | dapm = &jack->card->dapm; |
8a2cd618 | 109 | |
2667b4b8 | 110 | mutex_lock(&jack->mutex); |
8a2cd618 | 111 | |
8a2cd618 | 112 | jack->status &= ~mask; |
178b699c | 113 | jack->status |= status & mask; |
8a2cd618 | 114 | |
3028eb8c MB |
115 | trace_snd_soc_jack_notify(jack, status); |
116 | ||
8a2cd618 | 117 | list_for_each_entry(pin, &jack->pins, list) { |
178b699c | 118 | enable = pin->mask & jack->status; |
8a2cd618 MB |
119 | |
120 | if (pin->invert) | |
121 | enable = !enable; | |
122 | ||
123 | if (enable) | |
ce6120cc | 124 | snd_soc_dapm_enable_pin(dapm, pin->pin); |
8a2cd618 | 125 | else |
ce6120cc | 126 | snd_soc_dapm_disable_pin(dapm, pin->pin); |
30a765d6 VK |
127 | |
128 | /* we need to sync for this case only */ | |
129 | sync = 1; | |
8a2cd618 MB |
130 | } |
131 | ||
d5021ec9 | 132 | /* Report before the DAPM sync to help users updating micbias status */ |
12022a78 | 133 | blocking_notifier_call_chain(&jack->notifier, jack->status, jack); |
d5021ec9 | 134 | |
30a765d6 VK |
135 | if (sync) |
136 | snd_soc_dapm_sync(dapm); | |
8a2cd618 | 137 | |
747da0f8 | 138 | snd_jack_report(jack->jack, jack->status); |
8a2cd618 | 139 | |
2667b4b8 | 140 | mutex_unlock(&jack->mutex); |
8a2cd618 MB |
141 | } |
142 | EXPORT_SYMBOL_GPL(snd_soc_jack_report); | |
143 | ||
fa9879ed VK |
144 | /** |
145 | * snd_soc_jack_add_zones - Associate voltage zones with jack | |
146 | * | |
147 | * @jack: ASoC jack | |
148 | * @count: Number of zones | |
bb29a93b | 149 | * @zones: Array of zones |
fa9879ed VK |
150 | * |
151 | * After this function has been called the zones specified in the | |
152 | * array will be associated with the jack. | |
153 | */ | |
154 | int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count, | |
155 | struct snd_soc_jack_zone *zones) | |
156 | { | |
157 | int i; | |
158 | ||
159 | for (i = 0; i < count; i++) { | |
160 | INIT_LIST_HEAD(&zones[i].list); | |
161 | list_add(&(zones[i].list), &jack->jack_zones); | |
162 | } | |
163 | return 0; | |
164 | } | |
165 | EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones); | |
166 | ||
167 | /** | |
168 | * snd_soc_jack_get_type - Based on the mic bias value, this function returns | |
a92b078e | 169 | * the type of jack from the zones declared in the jack type |
fa9879ed | 170 | * |
a92b078e | 171 | * @jack: ASoC jack |
fa9879ed VK |
172 | * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in |
173 | * | |
174 | * Based on the mic bias value passed, this function helps identify | |
a92b078e | 175 | * the type of jack from the already declared jack zones |
fa9879ed VK |
176 | */ |
177 | int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage) | |
178 | { | |
179 | struct snd_soc_jack_zone *zone; | |
180 | ||
181 | list_for_each_entry(zone, &jack->jack_zones, list) { | |
182 | if (micbias_voltage >= zone->min_mv && | |
183 | micbias_voltage < zone->max_mv) | |
184 | return zone->jack_type; | |
185 | } | |
186 | return 0; | |
187 | } | |
188 | EXPORT_SYMBOL_GPL(snd_soc_jack_get_type); | |
189 | ||
8a2cd618 MB |
190 | /** |
191 | * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack | |
192 | * | |
193 | * @jack: ASoC jack | |
194 | * @count: Number of pins | |
195 | * @pins: Array of pins | |
196 | * | |
197 | * After this function has been called the DAPM pins specified in the | |
198 | * pins array will have their status updated to reflect the current | |
199 | * state of the jack whenever the jack status is updated. | |
200 | */ | |
201 | int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, | |
202 | struct snd_soc_jack_pin *pins) | |
203 | { | |
204 | int i; | |
205 | ||
206 | for (i = 0; i < count; i++) { | |
207 | if (!pins[i].pin) { | |
97093996 | 208 | dev_err(jack->card->dev, "ASoC: No name for pin %d\n", |
008d55e2 | 209 | i); |
8a2cd618 MB |
210 | return -EINVAL; |
211 | } | |
212 | if (!pins[i].mask) { | |
97093996 | 213 | dev_err(jack->card->dev, "ASoC: No mask for pin %d" |
008d55e2 | 214 | " (%s)\n", i, pins[i].pin); |
8a2cd618 MB |
215 | return -EINVAL; |
216 | } | |
217 | ||
218 | INIT_LIST_HEAD(&pins[i].list); | |
219 | list_add(&(pins[i].list), &jack->pins); | |
f63e8581 | 220 | snd_jack_add_new_kctl(jack->jack, pins[i].pin, pins[i].mask); |
8a2cd618 MB |
221 | } |
222 | ||
223 | /* Update to reflect the last reported status; canned jack | |
224 | * implementations are likely to set their state before the | |
225 | * card has an opportunity to associate pins. | |
226 | */ | |
227 | snd_soc_jack_report(jack, 0, 0); | |
228 | ||
229 | return 0; | |
230 | } | |
231 | EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins); | |
ec67624d | 232 | |
d5021ec9 MB |
233 | /** |
234 | * snd_soc_jack_notifier_register - Register a notifier for jack status | |
235 | * | |
236 | * @jack: ASoC jack | |
237 | * @nb: Notifier block to register | |
238 | * | |
239 | * Register for notification of the current status of the jack. Note | |
240 | * that it is not possible to report additional jack events in the | |
241 | * callback from the notifier, this is intended to support | |
242 | * applications such as enabling electrical detection only when a | |
243 | * mechanical detection event has occurred. | |
244 | */ | |
245 | void snd_soc_jack_notifier_register(struct snd_soc_jack *jack, | |
246 | struct notifier_block *nb) | |
247 | { | |
248 | blocking_notifier_chain_register(&jack->notifier, nb); | |
249 | } | |
250 | EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register); | |
251 | ||
252 | /** | |
253 | * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status | |
254 | * | |
255 | * @jack: ASoC jack | |
256 | * @nb: Notifier block to unregister | |
257 | * | |
258 | * Stop notifying for status changes. | |
259 | */ | |
260 | void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack, | |
261 | struct notifier_block *nb) | |
262 | { | |
263 | blocking_notifier_chain_unregister(&jack->notifier, nb); | |
264 | } | |
265 | EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister); | |
266 | ||
ec67624d LCM |
267 | #ifdef CONFIG_GPIOLIB |
268 | /* gpio detect */ | |
26bd7b49 | 269 | static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio) |
ec67624d LCM |
270 | { |
271 | struct snd_soc_jack *jack = gpio->jack; | |
272 | int enable; | |
273 | int report; | |
274 | ||
50dfb69d | 275 | enable = gpiod_get_value_cansleep(gpio->desc); |
ec67624d LCM |
276 | if (gpio->invert) |
277 | enable = !enable; | |
278 | ||
279 | if (enable) | |
280 | report = gpio->report; | |
281 | else | |
282 | report = 0; | |
283 | ||
c871a053 | 284 | if (gpio->jack_status_check) |
cb29d7b9 | 285 | report = gpio->jack_status_check(gpio->data); |
c871a053 | 286 | |
ec67624d LCM |
287 | snd_soc_jack_report(jack, report, gpio->report); |
288 | } | |
289 | ||
290 | /* irq handler for gpio pin */ | |
291 | static irqreturn_t gpio_handler(int irq, void *data) | |
292 | { | |
293 | struct snd_soc_jack_gpio *gpio = data; | |
97093996 | 294 | struct device *dev = gpio->jack->card->dev; |
f9a67059 | 295 | |
3028eb8c MB |
296 | trace_snd_soc_jack_irq(gpio->name); |
297 | ||
f9a67059 MB |
298 | if (device_may_wakeup(dev)) |
299 | pm_wakeup_event(dev, gpio->debounce_time + 50); | |
ec67624d | 300 | |
e6058aaa | 301 | queue_delayed_work(system_power_efficient_wq, &gpio->work, |
4c14d78e | 302 | msecs_to_jiffies(gpio->debounce_time)); |
ec67624d LCM |
303 | |
304 | return IRQ_HANDLED; | |
305 | } | |
306 | ||
307 | /* gpio work */ | |
308 | static void gpio_work(struct work_struct *work) | |
309 | { | |
310 | struct snd_soc_jack_gpio *gpio; | |
311 | ||
4c14d78e | 312 | gpio = container_of(work, struct snd_soc_jack_gpio, work.work); |
ec67624d LCM |
313 | snd_soc_jack_gpio_detect(gpio); |
314 | } | |
315 | ||
73548dd3 DT |
316 | static int snd_soc_jack_pm_notifier(struct notifier_block *nb, |
317 | unsigned long action, void *data) | |
318 | { | |
319 | struct snd_soc_jack_gpio *gpio = | |
320 | container_of(nb, struct snd_soc_jack_gpio, pm_notifier); | |
321 | ||
322 | switch (action) { | |
323 | case PM_POST_SUSPEND: | |
324 | case PM_POST_HIBERNATION: | |
325 | case PM_POST_RESTORE: | |
326 | /* | |
327 | * Use workqueue so we do not have to care about running | |
328 | * concurrently with work triggered by the interrupt handler. | |
329 | */ | |
330 | queue_delayed_work(system_power_efficient_wq, &gpio->work, 0); | |
331 | break; | |
332 | } | |
333 | ||
334 | return NOTIFY_DONE; | |
335 | } | |
336 | ||
bd29ae96 TI |
337 | static void jack_free_gpios(struct snd_soc_jack *jack, int count, |
338 | struct snd_soc_jack_gpio *gpios) | |
339 | { | |
340 | int i; | |
341 | ||
342 | for (i = 0; i < count; i++) { | |
343 | gpiod_unexport(gpios[i].desc); | |
344 | unregister_pm_notifier(&gpios[i].pm_notifier); | |
345 | free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]); | |
346 | cancel_delayed_work_sync(&gpios[i].work); | |
347 | gpiod_put(gpios[i].desc); | |
348 | gpios[i].jack = NULL; | |
349 | } | |
350 | } | |
351 | ||
352 | static void jack_devres_free_gpios(struct device *dev, void *res) | |
353 | { | |
354 | struct jack_gpio_tbl *tbl = res; | |
355 | ||
356 | jack_free_gpios(tbl->jack, tbl->count, tbl->gpios); | |
357 | } | |
358 | ||
ec67624d LCM |
359 | /** |
360 | * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack | |
361 | * | |
362 | * @jack: ASoC jack | |
363 | * @count: number of pins | |
364 | * @gpios: array of gpio pins | |
365 | * | |
366 | * This function will request gpio, set data direction and request irq | |
367 | * for each gpio in the array. | |
368 | */ | |
369 | int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, | |
370 | struct snd_soc_jack_gpio *gpios) | |
371 | { | |
372 | int i, ret; | |
bd29ae96 TI |
373 | struct jack_gpio_tbl *tbl; |
374 | ||
375 | tbl = devres_alloc(jack_devres_free_gpios, sizeof(*tbl), GFP_KERNEL); | |
376 | if (!tbl) | |
377 | return -ENOMEM; | |
378 | tbl->jack = jack; | |
379 | tbl->count = count; | |
380 | tbl->gpios = gpios; | |
ec67624d LCM |
381 | |
382 | for (i = 0; i < count; i++) { | |
ec67624d | 383 | if (!gpios[i].name) { |
97093996 | 384 | dev_err(jack->card->dev, |
f025d3b9 | 385 | "ASoC: No name for gpio at index %d\n", i); |
ec67624d LCM |
386 | ret = -EINVAL; |
387 | goto undo; | |
388 | } | |
389 | ||
e616d2eb DR |
390 | if (gpios[i].desc) { |
391 | /* Already have a GPIO descriptor. */ | |
392 | goto got_gpio; | |
393 | } else if (gpios[i].gpiod_dev) { | |
394 | /* Get a GPIO descriptor */ | |
f025d3b9 JN |
395 | gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev, |
396 | gpios[i].name, | |
00d647b0 | 397 | gpios[i].idx, GPIOD_IN); |
f025d3b9 JN |
398 | if (IS_ERR(gpios[i].desc)) { |
399 | ret = PTR_ERR(gpios[i].desc); | |
400 | dev_err(gpios[i].gpiod_dev, | |
401 | "ASoC: Cannot get gpio at index %d: %d", | |
402 | i, ret); | |
403 | goto undo; | |
404 | } | |
405 | } else { | |
406 | /* legacy GPIO number */ | |
407 | if (!gpio_is_valid(gpios[i].gpio)) { | |
97093996 | 408 | dev_err(jack->card->dev, |
f025d3b9 JN |
409 | "ASoC: Invalid gpio %d\n", |
410 | gpios[i].gpio); | |
411 | ret = -EINVAL; | |
412 | goto undo; | |
413 | } | |
414 | ||
00d647b0 AC |
415 | ret = gpio_request_one(gpios[i].gpio, GPIOF_IN, |
416 | gpios[i].name); | |
f025d3b9 JN |
417 | if (ret) |
418 | goto undo; | |
419 | ||
420 | gpios[i].desc = gpio_to_desc(gpios[i].gpio); | |
421 | } | |
e616d2eb | 422 | got_gpio: |
4c14d78e | 423 | INIT_DELAYED_WORK(&gpios[i].work, gpio_work); |
b8e22c1f LPC |
424 | gpios[i].jack = jack; |
425 | ||
50dfb69d | 426 | ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc), |
3f58fd84 MB |
427 | gpio_handler, |
428 | IRQF_TRIGGER_RISING | | |
429 | IRQF_TRIGGER_FALLING, | |
363618f0 | 430 | gpios[i].name, |
3f58fd84 | 431 | &gpios[i]); |
d2b4c7bd | 432 | if (ret < 0) |
ec67624d LCM |
433 | goto err; |
434 | ||
7887ab3a | 435 | if (gpios[i].wake) { |
50dfb69d | 436 | ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1); |
7887ab3a | 437 | if (ret != 0) |
97093996 | 438 | dev_err(jack->card->dev, |
f025d3b9 JN |
439 | "ASoC: Failed to mark GPIO at index %d as wake source: %d\n", |
440 | i, ret); | |
7887ab3a MB |
441 | } |
442 | ||
73548dd3 DT |
443 | /* |
444 | * Register PM notifier so we do not miss state transitions | |
445 | * happening while system is asleep. | |
446 | */ | |
447 | gpios[i].pm_notifier.notifier_call = snd_soc_jack_pm_notifier; | |
448 | register_pm_notifier(&gpios[i].pm_notifier); | |
449 | ||
178b699c | 450 | /* Expose GPIO value over sysfs for diagnostic purposes */ |
50dfb69d | 451 | gpiod_export(gpios[i].desc, false); |
178b699c | 452 | |
178b699c | 453 | /* Update initial jack status */ |
f1adf5be | 454 | schedule_delayed_work(&gpios[i].work, |
455 | msecs_to_jiffies(gpios[i].debounce_time)); | |
ec67624d LCM |
456 | } |
457 | ||
bd29ae96 | 458 | devres_add(jack->card->dev, tbl); |
ec67624d LCM |
459 | return 0; |
460 | ||
461 | err: | |
462 | gpio_free(gpios[i].gpio); | |
463 | undo: | |
bd29ae96 TI |
464 | jack_free_gpios(jack, i, gpios); |
465 | devres_free(tbl); | |
ec67624d LCM |
466 | |
467 | return ret; | |
468 | } | |
469 | EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios); | |
470 | ||
f025d3b9 JN |
471 | /** |
472 | * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack | |
473 | * | |
474 | * @gpiod_dev: GPIO consumer device | |
475 | * @jack: ASoC jack | |
476 | * @count: number of pins | |
477 | * @gpios: array of gpio pins | |
478 | * | |
479 | * This function will request gpio, set data direction and request irq | |
480 | * for each gpio in the array. | |
481 | */ | |
482 | int snd_soc_jack_add_gpiods(struct device *gpiod_dev, | |
483 | struct snd_soc_jack *jack, | |
484 | int count, struct snd_soc_jack_gpio *gpios) | |
485 | { | |
486 | int i; | |
487 | ||
488 | for (i = 0; i < count; i++) | |
489 | gpios[i].gpiod_dev = gpiod_dev; | |
490 | ||
491 | return snd_soc_jack_add_gpios(jack, count, gpios); | |
492 | } | |
493 | EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods); | |
494 | ||
ec67624d LCM |
495 | /** |
496 | * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack | |
497 | * | |
498 | * @jack: ASoC jack | |
499 | * @count: number of pins | |
500 | * @gpios: array of gpio pins | |
501 | * | |
502 | * Release gpio and irq resources for gpio pins associated with an ASoC jack. | |
503 | */ | |
504 | void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, | |
505 | struct snd_soc_jack_gpio *gpios) | |
506 | { | |
bd29ae96 TI |
507 | jack_free_gpios(jack, count, gpios); |
508 | devres_destroy(jack->card->dev, jack_devres_free_gpios, NULL, NULL); | |
ec67624d LCM |
509 | } |
510 | EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios); | |
511 | #endif /* CONFIG_GPIOLIB */ |