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/interrupt.h>
18 #include <linux/workqueue.h>
19 #include <linux/delay.h>
20 #include <trace/events/asoc.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 INIT_LIST_HEAD(&jack->jack_zones);
41 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
43 return snd_jack_new(codec->card->snd_card, id, type, &jack->jack);
45 EXPORT_SYMBOL_GPL(snd_soc_jack_new);
48 * snd_soc_jack_report - Report the current status for a jack
51 * @status: a bitmask of enum snd_jack_type values that are currently detected.
52 * @mask: a bitmask of enum snd_jack_type values that being reported.
54 * If configured using snd_soc_jack_add_pins() then the associated
55 * DAPM pins will be enabled or disabled as appropriate and DAPM
58 * Note: This function uses mutexes and should be called from a
59 * context which can sleep (such as a workqueue).
61 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
63 struct snd_soc_codec *codec;
64 struct snd_soc_dapm_context *dapm;
65 struct snd_soc_jack_pin *pin;
69 trace_snd_soc_jack_report(jack, mask, status);
77 mutex_lock(&codec->mutex);
79 oldstatus = jack->status;
81 jack->status &= ~mask;
82 jack->status |= status & mask;
84 /* The DAPM sync is expensive enough to be worth skipping.
85 * However, empty mask means pin synchronization is desired. */
86 if (mask && (jack->status == oldstatus))
89 trace_snd_soc_jack_notify(jack, status);
91 list_for_each_entry(pin, &jack->pins, list) {
92 enable = pin->mask & jack->status;
98 snd_soc_dapm_enable_pin(dapm, pin->pin);
100 snd_soc_dapm_disable_pin(dapm, pin->pin);
103 /* Report before the DAPM sync to help users updating micbias status */
104 blocking_notifier_call_chain(&jack->notifier, status, jack);
106 snd_soc_dapm_sync(dapm);
108 snd_jack_report(jack->jack, status);
111 mutex_unlock(&codec->mutex);
113 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
116 * snd_soc_jack_add_zones - Associate voltage zones with jack
119 * @count: Number of zones
120 * @zone: Array of zones
122 * After this function has been called the zones specified in the
123 * array will be associated with the jack.
125 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
126 struct snd_soc_jack_zone *zones)
130 for (i = 0; i < count; i++) {
131 INIT_LIST_HEAD(&zones[i].list);
132 list_add(&(zones[i].list), &jack->jack_zones);
136 EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
139 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
140 * the type of jack from the zones delcared 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 delcared 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 printk(KERN_ERR "No name for pin %d\n", i);
182 printk(KERN_ERR "No mask for pin %d (%s)\n", i,
187 INIT_LIST_HEAD(&pins[i].list);
188 list_add(&(pins[i].list), &jack->pins);
191 /* Update to reflect the last reported status; canned jack
192 * implementations are likely to set their state before the
193 * card has an opportunity to associate pins.
195 snd_soc_jack_report(jack, 0, 0);
199 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
202 * snd_soc_jack_notifier_register - Register a notifier for jack status
205 * @nb: Notifier block to register
207 * Register for notification of the current status of the jack. Note
208 * that it is not possible to report additional jack events in the
209 * callback from the notifier, this is intended to support
210 * applications such as enabling electrical detection only when a
211 * mechanical detection event has occurred.
213 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
214 struct notifier_block *nb)
216 blocking_notifier_chain_register(&jack->notifier, nb);
218 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
221 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
224 * @nb: Notifier block to unregister
226 * Stop notifying for status changes.
228 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
229 struct notifier_block *nb)
231 blocking_notifier_chain_unregister(&jack->notifier, nb);
233 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
235 #ifdef CONFIG_GPIOLIB
237 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
239 struct snd_soc_jack *jack = gpio->jack;
243 enable = gpio_get_value_cansleep(gpio->gpio);
248 report = gpio->report;
252 if (gpio->jack_status_check)
253 report = gpio->jack_status_check();
255 snd_soc_jack_report(jack, report, gpio->report);
258 /* irq handler for gpio pin */
259 static irqreturn_t gpio_handler(int irq, void *data)
261 struct snd_soc_jack_gpio *gpio = data;
262 struct device *dev = gpio->jack->codec->card->dev;
264 trace_snd_soc_jack_irq(gpio->name);
266 if (device_may_wakeup(dev))
267 pm_wakeup_event(dev, gpio->debounce_time + 50);
269 schedule_delayed_work(&gpio->work,
270 msecs_to_jiffies(gpio->debounce_time));
276 static void gpio_work(struct work_struct *work)
278 struct snd_soc_jack_gpio *gpio;
280 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
281 snd_soc_jack_gpio_detect(gpio);
285 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
288 * @count: number of pins
289 * @gpios: array of gpio pins
291 * This function will request gpio, set data direction and request irq
292 * for each gpio in the array.
294 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
295 struct snd_soc_jack_gpio *gpios)
299 for (i = 0; i < count; i++) {
300 if (!gpio_is_valid(gpios[i].gpio)) {
301 printk(KERN_ERR "Invalid gpio %d\n",
306 if (!gpios[i].name) {
307 printk(KERN_ERR "No name for gpio %d\n",
313 ret = gpio_request(gpios[i].gpio, gpios[i].name);
317 ret = gpio_direction_input(gpios[i].gpio);
321 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
322 gpios[i].jack = jack;
324 ret = request_any_context_irq(gpio_to_irq(gpios[i].gpio),
326 IRQF_TRIGGER_RISING |
327 IRQF_TRIGGER_FALLING,
328 jack->codec->dev->driver->name,
334 ret = irq_set_irq_wake(gpio_to_irq(gpios[i].gpio), 1);
337 "Failed to mark GPIO %d as wake source: %d\n",
341 #ifdef CONFIG_GPIO_SYSFS
342 /* Expose GPIO value over sysfs for diagnostic purposes */
343 gpio_export(gpios[i].gpio, false);
346 /* Update initial jack status */
347 snd_soc_jack_gpio_detect(&gpios[i]);
353 gpio_free(gpios[i].gpio);
355 snd_soc_jack_free_gpios(jack, i, gpios);
359 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
362 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
365 * @count: number of pins
366 * @gpios: array of gpio pins
368 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
370 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
371 struct snd_soc_jack_gpio *gpios)
375 for (i = 0; i < count; i++) {
376 #ifdef CONFIG_GPIO_SYSFS
377 gpio_unexport(gpios[i].gpio);
379 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
380 cancel_delayed_work_sync(&gpios[i].work);
381 gpio_free(gpios[i].gpio);
382 gpios[i].jack = NULL;
385 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
386 #endif /* CONFIG_GPIOLIB */