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