1 // SPDX-License-Identifier: GPL-2.0+
3 // soc-jack.c -- ALSA SoC jack handling
5 // Copyright 2008 Wolfson Microelectronics PLC.
7 // Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
9 #include <sound/jack.h>
10 #include <sound/soc.h>
11 #include <linux/gpio.h>
12 #include <linux/gpio/consumer.h>
13 #include <linux/interrupt.h>
14 #include <linux/workqueue.h>
15 #include <linux/delay.h>
16 #include <linux/export.h>
17 #include <linux/suspend.h>
18 #include <trace/events/asoc.h>
21 * snd_soc_jack_report - Report the current status for a jack
24 * @status: a bitmask of enum snd_jack_type values that are currently detected.
25 * @mask: a bitmask of enum snd_jack_type values that being reported.
27 * If configured using snd_soc_jack_add_pins() then the associated
28 * DAPM pins will be enabled or disabled as appropriate and DAPM
31 * Note: This function uses mutexes and should be called from a
32 * context which can sleep (such as a workqueue).
34 void snd_soc_jack_report(struct snd_soc_jack
*jack
, int status
, int mask
)
36 struct snd_soc_dapm_context
*dapm
;
37 struct snd_soc_jack_pin
*pin
;
38 unsigned int sync
= 0;
42 trace_snd_soc_jack_report(jack
, mask
, status
);
44 dapm
= &jack
->card
->dapm
;
46 mutex_lock(&jack
->mutex
);
48 jack
->status
&= ~mask
;
49 jack
->status
|= status
& mask
;
51 trace_snd_soc_jack_notify(jack
, status
);
53 list_for_each_entry(pin
, &jack
->pins
, list
) {
54 int enable
= pin
->mask
& jack
->status
;
60 snd_soc_dapm_enable_pin(dapm
, pin
->pin
);
62 snd_soc_dapm_disable_pin(dapm
, pin
->pin
);
64 /* we need to sync for this case only */
68 /* Report before the DAPM sync to help users updating micbias status */
69 blocking_notifier_call_chain(&jack
->notifier
, jack
->status
, jack
);
72 snd_soc_dapm_sync(dapm
);
74 snd_jack_report(jack
->jack
, jack
->status
);
76 mutex_unlock(&jack
->mutex
);
78 EXPORT_SYMBOL_GPL(snd_soc_jack_report
);
81 * snd_soc_jack_add_zones - Associate voltage zones with jack
84 * @count: Number of zones
85 * @zones: Array of zones
87 * After this function has been called the zones specified in the
88 * array will be associated with the jack.
90 int snd_soc_jack_add_zones(struct snd_soc_jack
*jack
, int count
,
91 struct snd_soc_jack_zone
*zones
)
95 for (i
= 0; i
< count
; i
++) {
96 INIT_LIST_HEAD(&zones
[i
].list
);
97 list_add(&(zones
[i
].list
), &jack
->jack_zones
);
101 EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones
);
104 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
105 * the type of jack from the zones declared in the jack type
108 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
110 * Based on the mic bias value passed, this function helps identify
111 * the type of jack from the already declared jack zones
113 int snd_soc_jack_get_type(struct snd_soc_jack
*jack
, int micbias_voltage
)
115 struct snd_soc_jack_zone
*zone
;
117 list_for_each_entry(zone
, &jack
->jack_zones
, list
) {
118 if (micbias_voltage
>= zone
->min_mv
&&
119 micbias_voltage
< zone
->max_mv
)
120 return zone
->jack_type
;
124 EXPORT_SYMBOL_GPL(snd_soc_jack_get_type
);
127 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
129 * @jack: ASoC jack created with snd_soc_card_jack_new_pins()
130 * @count: Number of pins
131 * @pins: Array of pins
133 * After this function has been called the DAPM pins specified in the
134 * pins array will have their status updated to reflect the current
135 * state of the jack whenever the jack status is updated.
137 int snd_soc_jack_add_pins(struct snd_soc_jack
*jack
, int count
,
138 struct snd_soc_jack_pin
*pins
)
142 for (i
= 0; i
< count
; i
++) {
144 dev_err(jack
->card
->dev
, "ASoC: No name for pin %d\n",
149 dev_err(jack
->card
->dev
, "ASoC: No mask for pin %d"
150 " (%s)\n", i
, pins
[i
].pin
);
154 INIT_LIST_HEAD(&pins
[i
].list
);
155 list_add(&(pins
[i
].list
), &jack
->pins
);
156 snd_jack_add_new_kctl(jack
->jack
, pins
[i
].pin
, pins
[i
].mask
);
159 /* Update to reflect the last reported status; canned jack
160 * implementations are likely to set their state before the
161 * card has an opportunity to associate pins.
163 snd_soc_jack_report(jack
, 0, 0);
167 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins
);
170 * snd_soc_jack_notifier_register - Register a notifier for jack status
173 * @nb: Notifier block to register
175 * Register for notification of the current status of the jack. Note
176 * that it is not possible to report additional jack events in the
177 * callback from the notifier, this is intended to support
178 * applications such as enabling electrical detection only when a
179 * mechanical detection event has occurred.
181 void snd_soc_jack_notifier_register(struct snd_soc_jack
*jack
,
182 struct notifier_block
*nb
)
184 blocking_notifier_chain_register(&jack
->notifier
, nb
);
186 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register
);
189 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
192 * @nb: Notifier block to unregister
194 * Stop notifying for status changes.
196 void snd_soc_jack_notifier_unregister(struct snd_soc_jack
*jack
,
197 struct notifier_block
*nb
)
199 blocking_notifier_chain_unregister(&jack
->notifier
, nb
);
201 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister
);
203 #ifdef CONFIG_GPIOLIB
204 struct jack_gpio_tbl
{
206 struct snd_soc_jack
*jack
;
207 struct snd_soc_jack_gpio
*gpios
;
211 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio
*gpio
)
213 struct snd_soc_jack
*jack
= gpio
->jack
;
217 enable
= gpiod_get_value_cansleep(gpio
->desc
);
222 report
= gpio
->report
;
226 if (gpio
->jack_status_check
)
227 report
= gpio
->jack_status_check(gpio
->data
);
229 snd_soc_jack_report(jack
, report
, gpio
->report
);
232 /* irq handler for gpio pin */
233 static irqreturn_t
gpio_handler(int irq
, void *data
)
235 struct snd_soc_jack_gpio
*gpio
= data
;
236 struct device
*dev
= gpio
->jack
->card
->dev
;
238 trace_snd_soc_jack_irq(gpio
->name
);
240 if (device_may_wakeup(dev
))
241 pm_wakeup_event(dev
, gpio
->debounce_time
+ 50);
243 queue_delayed_work(system_power_efficient_wq
, &gpio
->work
,
244 msecs_to_jiffies(gpio
->debounce_time
));
250 static void gpio_work(struct work_struct
*work
)
252 struct snd_soc_jack_gpio
*gpio
;
254 gpio
= container_of(work
, struct snd_soc_jack_gpio
, work
.work
);
255 snd_soc_jack_gpio_detect(gpio
);
258 static int snd_soc_jack_pm_notifier(struct notifier_block
*nb
,
259 unsigned long action
, void *data
)
261 struct snd_soc_jack_gpio
*gpio
=
262 container_of(nb
, struct snd_soc_jack_gpio
, pm_notifier
);
265 case PM_POST_SUSPEND
:
266 case PM_POST_HIBERNATION
:
267 case PM_POST_RESTORE
:
269 * Use workqueue so we do not have to care about running
270 * concurrently with work triggered by the interrupt handler.
272 queue_delayed_work(system_power_efficient_wq
, &gpio
->work
, 0);
279 static void jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
280 struct snd_soc_jack_gpio
*gpios
)
284 for (i
= 0; i
< count
; i
++) {
285 gpiod_unexport(gpios
[i
].desc
);
286 unregister_pm_notifier(&gpios
[i
].pm_notifier
);
287 free_irq(gpiod_to_irq(gpios
[i
].desc
), &gpios
[i
]);
288 cancel_delayed_work_sync(&gpios
[i
].work
);
289 gpiod_put(gpios
[i
].desc
);
290 gpios
[i
].jack
= NULL
;
294 static void jack_devres_free_gpios(struct device
*dev
, void *res
)
296 struct jack_gpio_tbl
*tbl
= res
;
298 jack_free_gpios(tbl
->jack
, tbl
->count
, tbl
->gpios
);
302 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
305 * @count: number of pins
306 * @gpios: array of gpio pins
308 * This function will request gpio, set data direction and request irq
309 * for each gpio in the array.
311 int snd_soc_jack_add_gpios(struct snd_soc_jack
*jack
, int count
,
312 struct snd_soc_jack_gpio
*gpios
)
315 struct jack_gpio_tbl
*tbl
;
317 tbl
= devres_alloc(jack_devres_free_gpios
, sizeof(*tbl
), GFP_KERNEL
);
324 for (i
= 0; i
< count
; i
++) {
325 if (!gpios
[i
].name
) {
326 dev_err(jack
->card
->dev
,
327 "ASoC: No name for gpio at index %d\n", i
);
333 /* Already have a GPIO descriptor. */
335 } else if (gpios
[i
].gpiod_dev
) {
336 /* Get a GPIO descriptor */
337 gpios
[i
].desc
= gpiod_get_index(gpios
[i
].gpiod_dev
,
339 gpios
[i
].idx
, GPIOD_IN
);
340 if (IS_ERR(gpios
[i
].desc
)) {
341 ret
= PTR_ERR(gpios
[i
].desc
);
342 dev_err(gpios
[i
].gpiod_dev
,
343 "ASoC: Cannot get gpio at index %d: %d",
348 /* legacy GPIO number */
349 if (!gpio_is_valid(gpios
[i
].gpio
)) {
350 dev_err(jack
->card
->dev
,
351 "ASoC: Invalid gpio %d\n",
357 ret
= gpio_request_one(gpios
[i
].gpio
, GPIOF_IN
,
362 gpios
[i
].desc
= gpio_to_desc(gpios
[i
].gpio
);
365 INIT_DELAYED_WORK(&gpios
[i
].work
, gpio_work
);
366 gpios
[i
].jack
= jack
;
368 ret
= request_any_context_irq(gpiod_to_irq(gpios
[i
].desc
),
370 IRQF_TRIGGER_RISING
|
371 IRQF_TRIGGER_FALLING
,
378 ret
= irq_set_irq_wake(gpiod_to_irq(gpios
[i
].desc
), 1);
380 dev_err(jack
->card
->dev
,
381 "ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
386 * Register PM notifier so we do not miss state transitions
387 * happening while system is asleep.
389 gpios
[i
].pm_notifier
.notifier_call
= snd_soc_jack_pm_notifier
;
390 register_pm_notifier(&gpios
[i
].pm_notifier
);
392 /* Expose GPIO value over sysfs for diagnostic purposes */
393 gpiod_export(gpios
[i
].desc
, false);
395 /* Update initial jack status */
396 schedule_delayed_work(&gpios
[i
].work
,
397 msecs_to_jiffies(gpios
[i
].debounce_time
));
400 devres_add(jack
->card
->dev
, tbl
);
404 gpio_free(gpios
[i
].gpio
);
406 jack_free_gpios(jack
, i
, gpios
);
411 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios
);
414 * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
416 * @gpiod_dev: GPIO consumer device
418 * @count: number of pins
419 * @gpios: array of gpio pins
421 * This function will request gpio, set data direction and request irq
422 * for each gpio in the array.
424 int snd_soc_jack_add_gpiods(struct device
*gpiod_dev
,
425 struct snd_soc_jack
*jack
,
426 int count
, struct snd_soc_jack_gpio
*gpios
)
430 for (i
= 0; i
< count
; i
++)
431 gpios
[i
].gpiod_dev
= gpiod_dev
;
433 return snd_soc_jack_add_gpios(jack
, count
, gpios
);
435 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods
);
438 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
441 * @count: number of pins
442 * @gpios: array of gpio pins
444 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
446 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
447 struct snd_soc_jack_gpio
*gpios
)
449 jack_free_gpios(jack
, count
, gpios
);
450 devres_destroy(jack
->card
->dev
, jack_devres_free_gpios
, NULL
, NULL
);
452 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios
);
453 #endif /* CONFIG_GPIOLIB */