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 <trace/events/asoc.h>
25 * snd_soc_card_jack_new - Create a new jack
27 * @id: an identifying string for this jack
28 * @type: a bitmask of enum snd_jack_type values that can be detected by
30 * @jack: structure to use for the jack
31 * @pins: Array of jack pins to be added to the jack or NULL
32 * @num_pins: Number of elements in the @pins array
34 * Creates a new jack object.
36 * Returns zero if successful, or a negative error code on failure.
37 * On success jack will be initialised.
39 int snd_soc_card_jack_new(struct snd_soc_card *card, const char *id, int type,
40 struct snd_soc_jack *jack, struct snd_soc_jack_pin *pins,
41 unsigned int num_pins)
45 mutex_init(&jack->mutex);
47 INIT_LIST_HEAD(&jack->pins);
48 INIT_LIST_HEAD(&jack->jack_zones);
49 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
51 ret = snd_jack_new(card->snd_card, id, type, &jack->jack);
56 return snd_soc_jack_add_pins(jack, num_pins, pins);
60 EXPORT_SYMBOL_GPL(snd_soc_card_jack_new);
63 * snd_soc_jack_report - Report the current status for a jack
66 * @status: a bitmask of enum snd_jack_type values that are currently detected.
67 * @mask: a bitmask of enum snd_jack_type values that being reported.
69 * If configured using snd_soc_jack_add_pins() then the associated
70 * DAPM pins will be enabled or disabled as appropriate and DAPM
73 * Note: This function uses mutexes and should be called from a
74 * context which can sleep (such as a workqueue).
76 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
78 struct snd_soc_dapm_context *dapm;
79 struct snd_soc_jack_pin *pin;
80 unsigned int sync = 0;
83 trace_snd_soc_jack_report(jack, mask, status);
88 dapm = &jack->card->dapm;
90 mutex_lock(&jack->mutex);
92 jack->status &= ~mask;
93 jack->status |= status & mask;
95 trace_snd_soc_jack_notify(jack, status);
97 list_for_each_entry(pin, &jack->pins, list) {
98 enable = pin->mask & jack->status;
104 snd_soc_dapm_enable_pin(dapm, pin->pin);
106 snd_soc_dapm_disable_pin(dapm, pin->pin);
108 /* we need to sync for this case only */
112 /* Report before the DAPM sync to help users updating micbias status */
113 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
116 snd_soc_dapm_sync(dapm);
118 snd_jack_report(jack->jack, jack->status);
120 mutex_unlock(&jack->mutex);
122 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
125 * snd_soc_jack_add_zones - Associate voltage zones with jack
128 * @count: Number of zones
129 * @zones: Array of zones
131 * After this function has been called the zones specified in the
132 * array will be associated with the jack.
134 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
135 struct snd_soc_jack_zone *zones)
139 for (i = 0; i < count; i++) {
140 INIT_LIST_HEAD(&zones[i].list);
141 list_add(&(zones[i].list), &jack->jack_zones);
145 EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
148 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
149 * the type of jack from the zones declared in the jack type
152 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
154 * Based on the mic bias value passed, this function helps identify
155 * the type of jack from the already declared jack zones
157 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
159 struct snd_soc_jack_zone *zone;
161 list_for_each_entry(zone, &jack->jack_zones, list) {
162 if (micbias_voltage >= zone->min_mv &&
163 micbias_voltage < zone->max_mv)
164 return zone->jack_type;
168 EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
171 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
174 * @count: Number of pins
175 * @pins: Array of pins
177 * After this function has been called the DAPM pins specified in the
178 * pins array will have their status updated to reflect the current
179 * state of the jack whenever the jack status is updated.
181 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
182 struct snd_soc_jack_pin *pins)
186 for (i = 0; i < count; i++) {
188 dev_err(jack->card->dev, "ASoC: No name for pin %d\n",
193 dev_err(jack->card->dev, "ASoC: No mask for pin %d"
194 " (%s)\n", i, pins[i].pin);
198 INIT_LIST_HEAD(&pins[i].list);
199 list_add(&(pins[i].list), &jack->pins);
202 /* Update to reflect the last reported status; canned jack
203 * implementations are likely to set their state before the
204 * card has an opportunity to associate pins.
206 snd_soc_jack_report(jack, 0, 0);
210 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
213 * snd_soc_jack_notifier_register - Register a notifier for jack status
216 * @nb: Notifier block to register
218 * Register for notification of the current status of the jack. Note
219 * that it is not possible to report additional jack events in the
220 * callback from the notifier, this is intended to support
221 * applications such as enabling electrical detection only when a
222 * mechanical detection event has occurred.
224 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
225 struct notifier_block *nb)
227 blocking_notifier_chain_register(&jack->notifier, nb);
229 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
232 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
235 * @nb: Notifier block to unregister
237 * Stop notifying for status changes.
239 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
240 struct notifier_block *nb)
242 blocking_notifier_chain_unregister(&jack->notifier, nb);
244 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
246 #ifdef CONFIG_GPIOLIB
248 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
250 struct snd_soc_jack *jack = gpio->jack;
254 enable = gpiod_get_value_cansleep(gpio->desc);
259 report = gpio->report;
263 if (gpio->jack_status_check)
264 report = gpio->jack_status_check(gpio->data);
266 snd_soc_jack_report(jack, report, gpio->report);
269 /* irq handler for gpio pin */
270 static irqreturn_t gpio_handler(int irq, void *data)
272 struct snd_soc_jack_gpio *gpio = data;
273 struct device *dev = gpio->jack->card->dev;
275 trace_snd_soc_jack_irq(gpio->name);
277 if (device_may_wakeup(dev))
278 pm_wakeup_event(dev, gpio->debounce_time + 50);
280 queue_delayed_work(system_power_efficient_wq, &gpio->work,
281 msecs_to_jiffies(gpio->debounce_time));
287 static void gpio_work(struct work_struct *work)
289 struct snd_soc_jack_gpio *gpio;
291 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
292 snd_soc_jack_gpio_detect(gpio);
296 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
299 * @count: number of pins
300 * @gpios: array of gpio pins
302 * This function will request gpio, set data direction and request irq
303 * for each gpio in the array.
305 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
306 struct snd_soc_jack_gpio *gpios)
310 for (i = 0; i < count; i++) {
311 if (!gpios[i].name) {
312 dev_err(jack->card->dev,
313 "ASoC: No name for gpio at index %d\n", i);
318 if (gpios[i].gpiod_dev) {
319 /* GPIO descriptor */
320 gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev,
322 gpios[i].idx, GPIOD_IN);
323 if (IS_ERR(gpios[i].desc)) {
324 ret = PTR_ERR(gpios[i].desc);
325 dev_err(gpios[i].gpiod_dev,
326 "ASoC: Cannot get gpio at index %d: %d",
331 /* legacy GPIO number */
332 if (!gpio_is_valid(gpios[i].gpio)) {
333 dev_err(jack->card->dev,
334 "ASoC: Invalid gpio %d\n",
340 ret = gpio_request_one(gpios[i].gpio, GPIOF_IN,
345 gpios[i].desc = gpio_to_desc(gpios[i].gpio);
348 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
349 gpios[i].jack = jack;
351 ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc),
353 IRQF_TRIGGER_RISING |
354 IRQF_TRIGGER_FALLING,
361 ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1);
363 dev_err(jack->card->dev,
364 "ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
368 /* Expose GPIO value over sysfs for diagnostic purposes */
369 gpiod_export(gpios[i].desc, false);
371 /* Update initial jack status */
372 schedule_delayed_work(&gpios[i].work,
373 msecs_to_jiffies(gpios[i].debounce_time));
379 gpio_free(gpios[i].gpio);
381 snd_soc_jack_free_gpios(jack, i, gpios);
385 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
388 * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
390 * @gpiod_dev: GPIO consumer device
392 * @count: number of pins
393 * @gpios: array of gpio pins
395 * This function will request gpio, set data direction and request irq
396 * for each gpio in the array.
398 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
399 struct snd_soc_jack *jack,
400 int count, struct snd_soc_jack_gpio *gpios)
404 for (i = 0; i < count; i++)
405 gpios[i].gpiod_dev = gpiod_dev;
407 return snd_soc_jack_add_gpios(jack, count, gpios);
409 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods);
412 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
415 * @count: number of pins
416 * @gpios: array of gpio pins
418 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
420 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
421 struct snd_soc_jack_gpio *gpios)
425 for (i = 0; i < count; i++) {
426 gpiod_unexport(gpios[i].desc);
427 free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]);
428 cancel_delayed_work_sync(&gpios[i].work);
429 gpiod_put(gpios[i].desc);
430 gpios[i].jack = NULL;
433 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
434 #endif /* CONFIG_GPIOLIB */