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 <sound/soc-dapm.h>
17 #include <linux/gpio.h>
18 #include <linux/interrupt.h>
19 #include <linux/workqueue.h>
20 #include <linux/delay.h>
23 * snd_soc_jack_new - Create a new jack
25 * @id: an identifying string for this jack
26 * @type: a bitmask of enum snd_jack_type values that can be detected by
28 * @jack: structure to use for the jack
30 * Creates a new jack object.
32 * Returns zero if successful, or a negative error code on failure.
33 * On success jack will be initialised.
35 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
36 struct snd_soc_jack *jack)
39 INIT_LIST_HEAD(&jack->pins);
40 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
42 return snd_jack_new(card->codec->card, id, type, &jack->jack);
44 EXPORT_SYMBOL_GPL(snd_soc_jack_new);
47 * snd_soc_jack_report - Report the current status for a jack
50 * @status: a bitmask of enum snd_jack_type values that are currently detected.
51 * @mask: a bitmask of enum snd_jack_type values that being reported.
53 * If configured using snd_soc_jack_add_pins() then the associated
54 * DAPM pins will be enabled or disabled as appropriate and DAPM
57 * Note: This function uses mutexes and should be called from a
58 * context which can sleep (such as a workqueue).
60 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
62 struct snd_soc_codec *codec;
63 struct snd_soc_jack_pin *pin;
70 codec = jack->card->codec;
72 mutex_lock(&codec->mutex);
74 oldstatus = jack->status;
76 jack->status &= ~mask;
77 jack->status |= status & mask;
79 /* The DAPM sync is expensive enough to be worth skipping.
80 * However, empty mask means pin synchronization is desired. */
81 if (mask && (jack->status == oldstatus))
84 list_for_each_entry(pin, &jack->pins, list) {
85 enable = pin->mask & jack->status;
91 snd_soc_dapm_enable_pin(codec, pin->pin);
93 snd_soc_dapm_disable_pin(codec, pin->pin);
96 /* Report before the DAPM sync to help users updating micbias status */
97 blocking_notifier_call_chain(&jack->notifier, status, NULL);
99 snd_soc_dapm_sync(codec);
101 snd_jack_report(jack->jack, status);
104 mutex_unlock(&codec->mutex);
106 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
109 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
112 * @count: Number of pins
113 * @pins: Array of pins
115 * After this function has been called the DAPM pins specified in the
116 * pins array will have their status updated to reflect the current
117 * state of the jack whenever the jack status is updated.
119 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
120 struct snd_soc_jack_pin *pins)
124 for (i = 0; i < count; i++) {
126 printk(KERN_ERR "No name for pin %d\n", i);
130 printk(KERN_ERR "No mask for pin %d (%s)\n", i,
135 INIT_LIST_HEAD(&pins[i].list);
136 list_add(&(pins[i].list), &jack->pins);
139 /* Update to reflect the last reported status; canned jack
140 * implementations are likely to set their state before the
141 * card has an opportunity to associate pins.
143 snd_soc_jack_report(jack, 0, 0);
147 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
150 * snd_soc_jack_notifier_register - Register a notifier for jack status
153 * @nb: Notifier block to register
155 * Register for notification of the current status of the jack. Note
156 * that it is not possible to report additional jack events in the
157 * callback from the notifier, this is intended to support
158 * applications such as enabling electrical detection only when a
159 * mechanical detection event has occurred.
161 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
162 struct notifier_block *nb)
164 blocking_notifier_chain_register(&jack->notifier, nb);
166 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
169 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
172 * @nb: Notifier block to unregister
174 * Stop notifying for status changes.
176 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
177 struct notifier_block *nb)
179 blocking_notifier_chain_unregister(&jack->notifier, nb);
181 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
183 #ifdef CONFIG_GPIOLIB
185 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
187 struct snd_soc_jack *jack = gpio->jack;
191 if (gpio->debounce_time > 0)
192 mdelay(gpio->debounce_time);
194 enable = gpio_get_value(gpio->gpio);
199 report = gpio->report;
203 if (gpio->jack_status_check)
204 report = gpio->jack_status_check();
206 snd_soc_jack_report(jack, report, gpio->report);
209 /* irq handler for gpio pin */
210 static irqreturn_t gpio_handler(int irq, void *data)
212 struct snd_soc_jack_gpio *gpio = data;
214 schedule_work(&gpio->work);
220 static void gpio_work(struct work_struct *work)
222 struct snd_soc_jack_gpio *gpio;
224 gpio = container_of(work, struct snd_soc_jack_gpio, work);
225 snd_soc_jack_gpio_detect(gpio);
229 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
232 * @count: number of pins
233 * @gpios: array of gpio pins
235 * This function will request gpio, set data direction and request irq
236 * for each gpio in the array.
238 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
239 struct snd_soc_jack_gpio *gpios)
243 for (i = 0; i < count; i++) {
244 if (!gpio_is_valid(gpios[i].gpio)) {
245 printk(KERN_ERR "Invalid gpio %d\n",
250 if (!gpios[i].name) {
251 printk(KERN_ERR "No name for gpio %d\n",
257 ret = gpio_request(gpios[i].gpio, gpios[i].name);
261 ret = gpio_direction_input(gpios[i].gpio);
265 INIT_WORK(&gpios[i].work, gpio_work);
266 gpios[i].jack = jack;
268 ret = request_irq(gpio_to_irq(gpios[i].gpio),
270 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
271 jack->card->dev->driver->name,
276 #ifdef CONFIG_GPIO_SYSFS
277 /* Expose GPIO value over sysfs for diagnostic purposes */
278 gpio_export(gpios[i].gpio, false);
281 /* Update initial jack status */
282 snd_soc_jack_gpio_detect(&gpios[i]);
288 gpio_free(gpios[i].gpio);
290 snd_soc_jack_free_gpios(jack, i, gpios);
294 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
297 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
300 * @count: number of pins
301 * @gpios: array of gpio pins
303 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
305 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
306 struct snd_soc_jack_gpio *gpios)
310 for (i = 0; i < count; i++) {
311 #ifdef CONFIG_GPIO_SYSFS
312 gpio_unexport(gpios[i].gpio);
314 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
315 gpio_free(gpios[i].gpio);
316 gpios[i].jack = NULL;
319 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
320 #endif /* CONFIG_GPIOLIB */