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_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
32 * Creates a new jack object.
34 * Returns zero if successful, or a negative error code on failure.
35 * On success jack will be initialised.
37 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
38 struct snd_soc_jack *jack)
40 mutex_init(&jack->mutex);
42 INIT_LIST_HEAD(&jack->pins);
43 INIT_LIST_HEAD(&jack->jack_zones);
44 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
46 return snd_jack_new(codec->card->snd_card, id, type, &jack->jack);
48 EXPORT_SYMBOL_GPL(snd_soc_jack_new);
51 * snd_soc_jack_report - Report the current status for a jack
54 * @status: a bitmask of enum snd_jack_type values that are currently detected.
55 * @mask: a bitmask of enum snd_jack_type values that being reported.
57 * If configured using snd_soc_jack_add_pins() then the associated
58 * DAPM pins will be enabled or disabled as appropriate and DAPM
61 * Note: This function uses mutexes and should be called from a
62 * context which can sleep (such as a workqueue).
64 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
66 struct snd_soc_codec *codec;
67 struct snd_soc_dapm_context *dapm;
68 struct snd_soc_jack_pin *pin;
69 unsigned int sync = 0;
72 trace_snd_soc_jack_report(jack, mask, status);
80 mutex_lock(&jack->mutex);
82 jack->status &= ~mask;
83 jack->status |= status & mask;
85 trace_snd_soc_jack_notify(jack, status);
87 list_for_each_entry(pin, &jack->pins, list) {
88 enable = pin->mask & jack->status;
94 snd_soc_dapm_enable_pin(dapm, pin->pin);
96 snd_soc_dapm_disable_pin(dapm, pin->pin);
98 /* we need to sync for this case only */
102 /* Report before the DAPM sync to help users updating micbias status */
103 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
106 snd_soc_dapm_sync(dapm);
108 snd_jack_report(jack->jack, jack->status);
110 mutex_unlock(&jack->mutex);
112 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
115 * snd_soc_jack_add_zones - Associate voltage zones with jack
118 * @count: Number of zones
119 * @zone: Array of zones
121 * After this function has been called the zones specified in the
122 * array will be associated with the jack.
124 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
125 struct snd_soc_jack_zone *zones)
129 for (i = 0; i < count; i++) {
130 INIT_LIST_HEAD(&zones[i].list);
131 list_add(&(zones[i].list), &jack->jack_zones);
135 EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
138 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
139 * the type of jack from the zones declared in the jack type
142 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
144 * Based on the mic bias value passed, this function helps identify
145 * the type of jack from the already declared jack zones
147 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
149 struct snd_soc_jack_zone *zone;
151 list_for_each_entry(zone, &jack->jack_zones, list) {
152 if (micbias_voltage >= zone->min_mv &&
153 micbias_voltage < zone->max_mv)
154 return zone->jack_type;
158 EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
161 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
164 * @count: Number of pins
165 * @pins: Array of pins
167 * After this function has been called the DAPM pins specified in the
168 * pins array will have their status updated to reflect the current
169 * state of the jack whenever the jack status is updated.
171 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
172 struct snd_soc_jack_pin *pins)
176 for (i = 0; i < count; i++) {
178 dev_err(jack->codec->dev, "ASoC: No name for pin %d\n",
183 dev_err(jack->codec->dev, "ASoC: No mask for pin %d"
184 " (%s)\n", i, pins[i].pin);
188 INIT_LIST_HEAD(&pins[i].list);
189 list_add(&(pins[i].list), &jack->pins);
192 /* Update to reflect the last reported status; canned jack
193 * implementations are likely to set their state before the
194 * card has an opportunity to associate pins.
196 snd_soc_jack_report(jack, 0, 0);
200 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
203 * snd_soc_jack_notifier_register - Register a notifier for jack status
206 * @nb: Notifier block to register
208 * Register for notification of the current status of the jack. Note
209 * that it is not possible to report additional jack events in the
210 * callback from the notifier, this is intended to support
211 * applications such as enabling electrical detection only when a
212 * mechanical detection event has occurred.
214 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
215 struct notifier_block *nb)
217 blocking_notifier_chain_register(&jack->notifier, nb);
219 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
222 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
225 * @nb: Notifier block to unregister
227 * Stop notifying for status changes.
229 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
230 struct notifier_block *nb)
232 blocking_notifier_chain_unregister(&jack->notifier, nb);
234 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
236 #ifdef CONFIG_GPIOLIB
238 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
240 struct snd_soc_jack *jack = gpio->jack;
244 enable = gpiod_get_value_cansleep(gpio->desc);
249 report = gpio->report;
253 if (gpio->jack_status_check)
254 report = gpio->jack_status_check(gpio->data);
256 snd_soc_jack_report(jack, report, gpio->report);
259 /* irq handler for gpio pin */
260 static irqreturn_t gpio_handler(int irq, void *data)
262 struct snd_soc_jack_gpio *gpio = data;
263 struct device *dev = gpio->jack->codec->card->dev;
265 trace_snd_soc_jack_irq(gpio->name);
267 if (device_may_wakeup(dev))
268 pm_wakeup_event(dev, gpio->debounce_time + 50);
270 queue_delayed_work(system_power_efficient_wq, &gpio->work,
271 msecs_to_jiffies(gpio->debounce_time));
277 static void gpio_work(struct work_struct *work)
279 struct snd_soc_jack_gpio *gpio;
281 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
282 snd_soc_jack_gpio_detect(gpio);
286 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
289 * @count: number of pins
290 * @gpios: array of gpio pins
292 * This function will request gpio, set data direction and request irq
293 * for each gpio in the array.
295 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
296 struct snd_soc_jack_gpio *gpios)
300 for (i = 0; i < count; i++) {
301 if (!gpios[i].name) {
302 dev_err(jack->codec->dev,
303 "ASoC: No name for gpio at index %d\n", i);
308 if (gpios[i].gpiod_dev) {
309 /* GPIO descriptor */
310 gpios[i].desc = gpiod_get_index(gpios[i].gpiod_dev,
313 if (IS_ERR(gpios[i].desc)) {
314 ret = PTR_ERR(gpios[i].desc);
315 dev_err(gpios[i].gpiod_dev,
316 "ASoC: Cannot get gpio at index %d: %d",
321 /* legacy GPIO number */
322 if (!gpio_is_valid(gpios[i].gpio)) {
323 dev_err(jack->codec->dev,
324 "ASoC: Invalid gpio %d\n",
330 ret = gpio_request(gpios[i].gpio, gpios[i].name);
334 gpios[i].desc = gpio_to_desc(gpios[i].gpio);
337 ret = gpiod_direction_input(gpios[i].desc);
341 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
342 gpios[i].jack = jack;
344 ret = request_any_context_irq(gpiod_to_irq(gpios[i].desc),
346 IRQF_TRIGGER_RISING |
347 IRQF_TRIGGER_FALLING,
354 ret = irq_set_irq_wake(gpiod_to_irq(gpios[i].desc), 1);
356 dev_err(jack->codec->dev,
357 "ASoC: Failed to mark GPIO at index %d as wake source: %d\n",
361 /* Expose GPIO value over sysfs for diagnostic purposes */
362 gpiod_export(gpios[i].desc, false);
364 /* Update initial jack status */
365 schedule_delayed_work(&gpios[i].work,
366 msecs_to_jiffies(gpios[i].debounce_time));
372 gpio_free(gpios[i].gpio);
374 snd_soc_jack_free_gpios(jack, i, gpios);
378 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
381 * snd_soc_jack_add_gpiods - Associate GPIO descriptor pins with an ASoC jack
383 * @gpiod_dev: GPIO consumer device
385 * @count: number of pins
386 * @gpios: array of gpio pins
388 * This function will request gpio, set data direction and request irq
389 * for each gpio in the array.
391 int snd_soc_jack_add_gpiods(struct device *gpiod_dev,
392 struct snd_soc_jack *jack,
393 int count, struct snd_soc_jack_gpio *gpios)
397 for (i = 0; i < count; i++)
398 gpios[i].gpiod_dev = gpiod_dev;
400 return snd_soc_jack_add_gpios(jack, count, gpios);
402 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpiods);
405 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
408 * @count: number of pins
409 * @gpios: array of gpio pins
411 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
413 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
414 struct snd_soc_jack_gpio *gpios)
418 for (i = 0; i < count; i++) {
419 gpiod_unexport(gpios[i].desc);
420 free_irq(gpiod_to_irq(gpios[i].desc), &gpios[i]);
421 cancel_delayed_work_sync(&gpios[i].work);
422 gpiod_put(gpios[i].desc);
423 gpios[i].jack = NULL;
426 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
427 #endif /* CONFIG_GPIOLIB */