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_codec *codec, 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(codec->card->snd_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_dapm_context *dapm;
64 struct snd_soc_jack_pin *pin;
74 mutex_lock(&codec->mutex);
76 oldstatus = jack->status;
78 jack->status &= ~mask;
79 jack->status |= status & mask;
81 /* The DAPM sync is expensive enough to be worth skipping.
82 * However, empty mask means pin synchronization is desired. */
83 if (mask && (jack->status == oldstatus))
86 list_for_each_entry(pin, &jack->pins, list) {
87 enable = pin->mask & jack->status;
93 snd_soc_dapm_enable_pin(dapm, pin->pin);
95 snd_soc_dapm_disable_pin(dapm, pin->pin);
98 /* Report before the DAPM sync to help users updating micbias status */
99 blocking_notifier_call_chain(&jack->notifier, status, NULL);
101 snd_soc_dapm_sync(dapm);
103 snd_jack_report(jack->jack, status);
106 mutex_unlock(&codec->mutex);
108 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
111 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
114 * @count: Number of pins
115 * @pins: Array of pins
117 * After this function has been called the DAPM pins specified in the
118 * pins array will have their status updated to reflect the current
119 * state of the jack whenever the jack status is updated.
121 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
122 struct snd_soc_jack_pin *pins)
126 for (i = 0; i < count; i++) {
128 printk(KERN_ERR "No name for pin %d\n", i);
132 printk(KERN_ERR "No mask for pin %d (%s)\n", i,
137 INIT_LIST_HEAD(&pins[i].list);
138 list_add(&(pins[i].list), &jack->pins);
141 /* Update to reflect the last reported status; canned jack
142 * implementations are likely to set their state before the
143 * card has an opportunity to associate pins.
145 snd_soc_jack_report(jack, 0, 0);
149 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
152 * snd_soc_jack_notifier_register - Register a notifier for jack status
155 * @nb: Notifier block to register
157 * Register for notification of the current status of the jack. Note
158 * that it is not possible to report additional jack events in the
159 * callback from the notifier, this is intended to support
160 * applications such as enabling electrical detection only when a
161 * mechanical detection event has occurred.
163 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
164 struct notifier_block *nb)
166 blocking_notifier_chain_register(&jack->notifier, nb);
168 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
171 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
174 * @nb: Notifier block to unregister
176 * Stop notifying for status changes.
178 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
179 struct notifier_block *nb)
181 blocking_notifier_chain_unregister(&jack->notifier, nb);
183 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
185 #ifdef CONFIG_GPIOLIB
187 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
189 struct snd_soc_jack *jack = gpio->jack;
193 enable = gpio_get_value(gpio->gpio);
198 report = gpio->report;
202 if (gpio->jack_status_check)
203 report = gpio->jack_status_check();
205 snd_soc_jack_report(jack, report, gpio->report);
208 /* irq handler for gpio pin */
209 static irqreturn_t gpio_handler(int irq, void *data)
211 struct snd_soc_jack_gpio *gpio = data;
212 struct device *dev = gpio->jack->codec->card->dev;
214 if (device_may_wakeup(dev))
215 pm_wakeup_event(dev, gpio->debounce_time + 50);
217 schedule_delayed_work(&gpio->work,
218 msecs_to_jiffies(gpio->debounce_time));
224 static void gpio_work(struct work_struct *work)
226 struct snd_soc_jack_gpio *gpio;
228 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
229 snd_soc_jack_gpio_detect(gpio);
233 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
236 * @count: number of pins
237 * @gpios: array of gpio pins
239 * This function will request gpio, set data direction and request irq
240 * for each gpio in the array.
242 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
243 struct snd_soc_jack_gpio *gpios)
247 for (i = 0; i < count; i++) {
248 if (!gpio_is_valid(gpios[i].gpio)) {
249 printk(KERN_ERR "Invalid gpio %d\n",
254 if (!gpios[i].name) {
255 printk(KERN_ERR "No name for gpio %d\n",
261 ret = gpio_request(gpios[i].gpio, gpios[i].name);
265 ret = gpio_direction_input(gpios[i].gpio);
269 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
270 gpios[i].jack = jack;
272 ret = request_any_context_irq(gpio_to_irq(gpios[i].gpio),
274 IRQF_TRIGGER_RISING |
275 IRQF_TRIGGER_FALLING,
276 jack->codec->dev->driver->name,
281 #ifdef CONFIG_GPIO_SYSFS
282 /* Expose GPIO value over sysfs for diagnostic purposes */
283 gpio_export(gpios[i].gpio, false);
286 /* Update initial jack status */
287 snd_soc_jack_gpio_detect(&gpios[i]);
293 gpio_free(gpios[i].gpio);
295 snd_soc_jack_free_gpios(jack, i, gpios);
299 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
302 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
305 * @count: number of pins
306 * @gpios: array of gpio pins
308 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
310 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
311 struct snd_soc_jack_gpio *gpios)
315 for (i = 0; i < count; i++) {
316 #ifdef CONFIG_GPIO_SYSFS
317 gpio_unexport(gpios[i].gpio);
319 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
320 cancel_delayed_work_sync(&gpios[i].work);
321 gpio_free(gpios[i].gpio);
322 gpios[i].jack = NULL;
325 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
326 #endif /* CONFIG_GPIOLIB */