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 <linux/export.h>
21 #include <trace/events/asoc.h>
24 * snd_soc_jack_new - Create a new jack
26 * @id: an identifying string for this jack
27 * @type: a bitmask of enum snd_jack_type values that can be detected by
29 * @jack: structure to use for the jack
31 * Creates a new jack object.
33 * Returns zero if successful, or a negative error code on failure.
34 * On success jack will be initialised.
36 int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
37 struct snd_soc_jack *jack)
39 mutex_init(&jack->mutex);
41 INIT_LIST_HEAD(&jack->pins);
42 INIT_LIST_HEAD(&jack->jack_zones);
43 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
45 return snd_jack_new(codec->card->snd_card, id, type, &jack->jack);
47 EXPORT_SYMBOL_GPL(snd_soc_jack_new);
50 * snd_soc_jack_report - Report the current status for a jack
53 * @status: a bitmask of enum snd_jack_type values that are currently detected.
54 * @mask: a bitmask of enum snd_jack_type values that being reported.
56 * If configured using snd_soc_jack_add_pins() then the associated
57 * DAPM pins will be enabled or disabled as appropriate and DAPM
60 * Note: This function uses mutexes and should be called from a
61 * context which can sleep (such as a workqueue).
63 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
65 struct snd_soc_codec *codec;
66 struct snd_soc_dapm_context *dapm;
67 struct snd_soc_jack_pin *pin;
71 trace_snd_soc_jack_report(jack, mask, status);
79 mutex_lock(&jack->mutex);
81 oldstatus = jack->status;
83 jack->status &= ~mask;
84 jack->status |= status & mask;
86 trace_snd_soc_jack_notify(jack, status);
88 list_for_each_entry(pin, &jack->pins, list) {
89 enable = pin->mask & jack->status;
95 snd_soc_dapm_enable_pin(dapm, pin->pin);
97 snd_soc_dapm_disable_pin(dapm, pin->pin);
100 /* Report before the DAPM sync to help users updating micbias status */
101 blocking_notifier_call_chain(&jack->notifier, jack->status, jack);
103 snd_soc_dapm_sync(dapm);
105 snd_jack_report(jack->jack, jack->status);
107 mutex_unlock(&jack->mutex);
109 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
112 * snd_soc_jack_add_zones - Associate voltage zones with jack
115 * @count: Number of zones
116 * @zone: Array of zones
118 * After this function has been called the zones specified in the
119 * array will be associated with the jack.
121 int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count,
122 struct snd_soc_jack_zone *zones)
126 for (i = 0; i < count; i++) {
127 INIT_LIST_HEAD(&zones[i].list);
128 list_add(&(zones[i].list), &jack->jack_zones);
132 EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones);
135 * snd_soc_jack_get_type - Based on the mic bias value, this function returns
136 * the type of jack from the zones delcared in the jack type
138 * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in
140 * Based on the mic bias value passed, this function helps identify
141 * the type of jack from the already delcared jack zones
143 int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage)
145 struct snd_soc_jack_zone *zone;
147 list_for_each_entry(zone, &jack->jack_zones, list) {
148 if (micbias_voltage >= zone->min_mv &&
149 micbias_voltage < zone->max_mv)
150 return zone->jack_type;
154 EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
157 * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
160 * @count: Number of pins
161 * @pins: Array of pins
163 * After this function has been called the DAPM pins specified in the
164 * pins array will have their status updated to reflect the current
165 * state of the jack whenever the jack status is updated.
167 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
168 struct snd_soc_jack_pin *pins)
172 for (i = 0; i < count; i++) {
174 printk(KERN_ERR "No name for pin %d\n", i);
178 printk(KERN_ERR "No mask for pin %d (%s)\n", i,
183 INIT_LIST_HEAD(&pins[i].list);
184 list_add(&(pins[i].list), &jack->pins);
187 snd_soc_dapm_new_widgets(&jack->codec->card->dapm);
189 /* Update to reflect the last reported status; canned jack
190 * implementations are likely to set their state before the
191 * card has an opportunity to associate pins.
193 snd_soc_jack_report(jack, 0, 0);
197 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
200 * snd_soc_jack_notifier_register - Register a notifier for jack status
203 * @nb: Notifier block to register
205 * Register for notification of the current status of the jack. Note
206 * that it is not possible to report additional jack events in the
207 * callback from the notifier, this is intended to support
208 * applications such as enabling electrical detection only when a
209 * mechanical detection event has occurred.
211 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
212 struct notifier_block *nb)
214 blocking_notifier_chain_register(&jack->notifier, nb);
216 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
219 * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
222 * @nb: Notifier block to unregister
224 * Stop notifying for status changes.
226 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
227 struct notifier_block *nb)
229 blocking_notifier_chain_unregister(&jack->notifier, nb);
231 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
233 #ifdef CONFIG_GPIOLIB
235 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
237 struct snd_soc_jack *jack = gpio->jack;
241 enable = gpio_get_value_cansleep(gpio->gpio);
246 report = gpio->report;
250 if (gpio->jack_status_check)
251 report = gpio->jack_status_check();
253 snd_soc_jack_report(jack, report, gpio->report);
256 /* irq handler for gpio pin */
257 static irqreturn_t gpio_handler(int irq, void *data)
259 struct snd_soc_jack_gpio *gpio = data;
260 struct device *dev = gpio->jack->codec->card->dev;
262 trace_snd_soc_jack_irq(gpio->name);
264 if (device_may_wakeup(dev))
265 pm_wakeup_event(dev, gpio->debounce_time + 50);
267 schedule_delayed_work(&gpio->work,
268 msecs_to_jiffies(gpio->debounce_time));
274 static void gpio_work(struct work_struct *work)
276 struct snd_soc_jack_gpio *gpio;
278 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
279 snd_soc_jack_gpio_detect(gpio);
283 * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
286 * @count: number of pins
287 * @gpios: array of gpio pins
289 * This function will request gpio, set data direction and request irq
290 * for each gpio in the array.
292 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
293 struct snd_soc_jack_gpio *gpios)
297 for (i = 0; i < count; i++) {
298 if (!gpio_is_valid(gpios[i].gpio)) {
299 printk(KERN_ERR "Invalid gpio %d\n",
304 if (!gpios[i].name) {
305 printk(KERN_ERR "No name for gpio %d\n",
311 ret = gpio_request(gpios[i].gpio, gpios[i].name);
315 ret = gpio_direction_input(gpios[i].gpio);
319 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
320 gpios[i].jack = jack;
322 ret = request_any_context_irq(gpio_to_irq(gpios[i].gpio),
324 IRQF_TRIGGER_RISING |
325 IRQF_TRIGGER_FALLING,
332 ret = irq_set_irq_wake(gpio_to_irq(gpios[i].gpio), 1);
335 "Failed to mark GPIO %d as wake source: %d\n",
339 /* Expose GPIO value over sysfs for diagnostic purposes */
340 gpio_export(gpios[i].gpio, false);
342 /* Update initial jack status */
343 snd_soc_jack_gpio_detect(&gpios[i]);
349 gpio_free(gpios[i].gpio);
351 snd_soc_jack_free_gpios(jack, i, gpios);
355 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
358 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
361 * @count: number of pins
362 * @gpios: array of gpio pins
364 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
366 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
367 struct snd_soc_jack_gpio *gpios)
371 for (i = 0; i < count; i++) {
372 gpio_unexport(gpios[i].gpio);
373 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
374 cancel_delayed_work_sync(&gpios[i].work);
375 gpio_free(gpios[i].gpio);
376 gpios[i].jack = NULL;
379 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
380 #endif /* CONFIG_GPIOLIB */