2 * soc-jack.c -- ALSA SoC jack handling
4 * Copyright 2008 Wolfson Microelectronics PLC.
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
14 #include <sound/jack.h>
15 #include <sound/soc.h>
16 #include <linux/gpio.h>
17 #include <linux/gpio/consumer.h>
18 #include <linux/interrupt.h>
19 #include <linux/workqueue.h>
20 #include <linux/delay.h>
21 #include <linux/export.h>
22 #include <linux/suspend.h>
23 #include <trace/events/asoc.h>
25 struct jack_gpio_tbl {
27 struct snd_soc_jack *jack;
28 struct snd_soc_jack_gpio *gpios;
32 * snd_soc_component_set_jack - configure component jack.
33 * @component: COMPONENTs
34 * @jack: structure to use for the jack
35 * @data: can be used if codec driver need extra data for configuring jack
37 * Configures and enables jack detection function.
39 int snd_soc_component_set_jack(struct snd_soc_component *component,
40 struct snd_soc_jack *jack, void *data)
42 if (component->driver->set_jack)
43 return component->driver->set_jack(component, jack, data);
47 EXPORT_SYMBOL_GPL(snd_soc_component_set_jack);
50 * snd_soc_card_jack_new - Create a new jack
52 * @id: an identifying string for this jack
53 * @type: a bitmask of enum snd_jack_type values that can be detected by
55 * @jack: structure to use for the jack
56 * @pins: Array of jack pins to be added to the jack or NULL
57 * @num_pins: Number of elements in the @pins array
59 * Creates a new jack object.
61 * Returns zero if successful, or a negative error code on failure.
62 * On success jack will be initialised.
64 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
65 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
66 unsigned int num_pins)
70 mutex_init(&jack->mutex);
72 INIT_LIST_HEAD(&jack->pins);
73 INIT_LIST_HEAD(&jack->jack_zones);
74 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
76 ret = snd_jack_new(card->snd_card, id, type, &jack->jack, false, false);
81 return snd_soc_jack_add_pins(jack, num_pins, pins);
85 EXPORT_SYMBOL_GPL(snd_soc_card_jack_new);
88 * snd_soc_jack_report - Report the current status for a jack
91 * @status: a bitmask of enum snd_jack_type values that are currently detected.
92 * @mask: a bitmask of enum snd_jack_type values that being reported.
94 * If configured using snd_soc_jack_add_pins() then the associated
95 * DAPM pins will be enabled or disabled as appropriate and DAPM
98 * Note: This function uses mutexes and should be called from a
99 * context which can sleep (such as a workqueue).
101 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
103 struct snd_soc_dapm_context *dapm;
104 struct snd_soc_jack_pin *pin;
105 unsigned int sync = 0;
108 trace_snd_soc_jack_report(jack, mask, status);
113 dapm = &jack->card->dapm;
115 mutex_lock(&jack->mutex);
117 jack->status &= ~mask;
118 jack->status |= status & mask;
120 trace_snd_soc_jack_notify(jack, status);
122 list_for_each_entry(pin, &jack->pins, list) {
123 enable = pin->mask & jack->status;
129 snd_soc_dapm_enable_pin(dapm, pin->pin);
131 snd_soc_dapm_disable_pin(dapm, pin->pin);
133 /* we need to sync for this case only */
137 /* Report before the DAPM sync to help users updating micbias status */
138 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
141 snd_soc_dapm_sync(dapm);
143 snd_jack_report(jack->jack, jack->status);
145 mutex_unlock(&jack->mutex);
147 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
150 * snd_soc_jack_add_zones - Associate voltage zones with jack
153 * @count: Number of zones
154 * @zones: Array of zones
156 * After this function has been called the zones specified in the
157 * array will be associated with the jack.
159 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
160 struct snd_soc_jack_zone *zones)
164 for (i = 0; i < count; i++) {
165 INIT_LIST_HEAD(&zones[i].list);
166 list_add(&(zones[i].list), &jack->jack_zones);
170 EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
173 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
174 * the type of jack from the zones declared in the jack type
177 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
179 * Based on the mic bias value passed, this function helps identify
180 * the type of jack from the already declared jack zones
182 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
184 struct snd_soc_jack_zone *zone;
186 list_for_each_entry(zone, &jack->jack_zones, list) {
187 if (micbias_voltage >= zone->min_mv &&
188 micbias_voltage < zone->max_mv)
189 return zone->jack_type;
193 EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
196 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
199 * @count: Number of pins
200 * @pins: Array of pins
202 * After this function has been called the DAPM pins specified in the
203 * pins array will have their status updated to reflect the current
204 * state of the jack whenever the jack status is updated.
206 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
207 struct snd_soc_jack_pin *pins)
211 for (i = 0; i < count; i++) {
213 dev_err(jack->card->dev, "ASoC: No name for pin %d\n",
218 dev_err(jack->card->dev, "ASoC: No mask for pin %d"
219 " (%s)\n", i, pins[i].pin);
223 INIT_LIST_HEAD(&pins[i].list);
224 list_add(&(pins[i].list), &jack->pins);
225 snd_jack_add_new_kctl(jack->jack, pins[i].pin, pins[i].mask);
228 /* Update to reflect the last reported status; canned jack
229 * implementations are likely to set their state before the
230 * card has an opportunity to associate pins.
232 snd_soc_jack_report(jack, 0, 0);
236 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
239 * snd_soc_jack_notifier_register - Register a notifier for jack status
242 * @nb: Notifier block to register
244 * Register for notification of the current status of the jack. Note
245 * that it is not possible to report additional jack events in the
246 * callback from the notifier, this is intended to support
247 * applications such as enabling electrical detection only when a
248 * mechanical detection event has occurred.
250 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
251 struct notifier_block *nb)
253 blocking_notifier_chain_register(&jack->notifier, nb);
255 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
258 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
261 * @nb: Notifier block to unregister
263 * Stop notifying for status changes.
265 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
266 struct notifier_block *nb)
268 blocking_notifier_chain_unregister(&jack->notifier, nb);
270 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
272 #ifdef CONFIG_GPIOLIB
274 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
276 struct snd_soc_jack *jack = gpio->jack;
280 enable = gpiod_get_value_cansleep(gpio->desc);
285 report = gpio->report;
289 if (gpio->jack_status_check)
290 report = gpio->jack_status_check(gpio->data);
292 snd_soc_jack_report(jack, report, gpio->report);
295 /* irq handler for gpio pin */
296 static irqreturn_t gpio_handler(int irq, void *data)
298 struct snd_soc_jack_gpio *gpio = data;
299 struct device *dev = gpio->jack->card->dev;
301 trace_snd_soc_jack_irq(gpio->name);
303 if (device_may_wakeup(dev))
304 pm_wakeup_event(dev, gpio->debounce_time + 50);
306 queue_delayed_work(system_power_efficient_wq, &gpio->work,
307 msecs_to_jiffies(gpio->debounce_time));
313 static void gpio_work(struct work_struct *work)
315 struct snd_soc_jack_gpio *gpio;
317 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
318 snd_soc_jack_gpio_detect(gpio);
321 static int snd_soc_jack_pm_notifier(struct notifier_block *nb,
322 unsigned long action, void *data)
324 struct snd_soc_jack_gpio *gpio =
325 container_of(nb, struct snd_soc_jack_gpio, pm_notifier);
328 case PM_POST_SUSPEND:
329 case PM_POST_HIBERNATION:
330 case PM_POST_RESTORE:
332 * Use workqueue so we do not have to care about running
333 * concurrently with work triggered by the interrupt handler.
335 queue_delayed_work(system_power_efficient_wq, &gpio->work, 0);
342 static void jack_free_gpios(struct snd_soc_jack *jack, int count,
343 struct snd_soc_jack_gpio *gpios)
347 for (i = 0; i < count; i++) {
348 gpiod_unexport(gpios[i].desc);
349 unregister_pm_notifier(&gpios[i].pm_notifier);
350 free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]);
351 cancel_delayed_work_sync(&gpios[i].work);
352 gpiod_put(gpios[i].desc);
353 gpios[i].jack = NULL;
357 static void jack_devres_free_gpios(struct device *dev, void *res)
359 struct jack_gpio_tbl *tbl = res;
361 jack_free_gpios(tbl->jack, tbl->count, tbl->gpios);
365 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
368 * @count: number of pins
369 * @gpios: array of gpio pins
371 * This function will request gpio, set data direction and request irq
372 * for each gpio in the array.
374 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
375 struct snd_soc_jack_gpio *gpios)
378 struct jack_gpio_tbl *tbl;
380 tbl = devres_alloc(jack_devres_free_gpios, sizeof(*tbl), GFP_KERNEL);
387 for (i = 0; i < count; i++) {
388 if (!gpios[i].name) {
389 dev_err(jack->card->dev,
390 "ASoC: No name for gpio at index %d\n", i);
396 /* Already have a GPIO descriptor. */
398 } else if (gpios[i].gpiod_dev) {
399 /* Get a GPIO descriptor */
400 gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev,
402 gpios[i].idx, GPIOD_IN);
403 if (IS_ERR(gpios[i].desc)) {
404 ret = PTR_ERR(gpios[i].desc);
405 dev_err(gpios[i].gpiod_dev,
406 "ASoC: Cannot get gpio at index %d: %d",
411 /* legacy GPIO number */
412 if (!gpio_is_valid(gpios[i].gpio)) {
413 dev_err(jack->card->dev,
414 "ASoC: Invalid gpio %d\n",
420 ret = gpio_request_one(gpios[i].gpio, GPIOF_IN,
425 gpios[i].desc = gpio_to_desc(gpios[i].gpio);
428 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
429 gpios[i].jack = jack;
431 ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc),
433 IRQF_TRIGGER_RISING |
434 IRQF_TRIGGER_FALLING,
441 ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1);
443 dev_err(jack->card->dev,
444 "ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
449 * Register PM notifier so we do not miss state transitions
450 * happening while system is asleep.
452 gpios[i].pm_notifier.notifier_call = snd_soc_jack_pm_notifier;
453 register_pm_notifier(&gpios[i].pm_notifier);
455 /* Expose GPIO value over sysfs for diagnostic purposes */
456 gpiod_export(gpios[i].desc, false);
458 /* Update initial jack status */
459 schedule_delayed_work(&gpios[i].work,
460 msecs_to_jiffies(gpios[i].debounce_time));
463 devres_add(jack->card->dev, tbl);
467 gpio_free(gpios[i].gpio);
469 jack_free_gpios(jack, i, gpios);
474 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
477 * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
479 * @gpiod_dev: GPIO consumer device
481 * @count: number of pins
482 * @gpios: array of gpio pins
484 * This function will request gpio, set data direction and request irq
485 * for each gpio in the array.
487 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
488 struct snd_soc_jack *jack,
489 int count, struct snd_soc_jack_gpio *gpios)
493 for (i = 0; i < count; i++)
494 gpios[i].gpiod_dev = gpiod_dev;
496 return snd_soc_jack_add_gpios(jack, count, gpios);
498 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods);
501 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
504 * @count: number of pins
505 * @gpios: array of gpio pins
507 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
509 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
510 struct snd_soc_jack_gpio *gpios)
512 jack_free_gpios(jack, count, gpios);
513 devres_destroy(jack->card->dev, jack_devres_free_gpios, NULL, NULL);
515 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
516 #endif /* CONFIG_GPIOLIB */