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
;
213 schedule_delayed_work(&gpio
->work
,
214 msecs_to_jiffies(gpio
->debounce_time
));
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
.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_DELAYED_WORK(&gpios
[i
].work
, gpio_work
);
266 gpios
[i
].jack
= jack
;
268 ret
= request_any_context_irq(gpio_to_irq(gpios
[i
].gpio
),
270 IRQF_TRIGGER_RISING
|
271 IRQF_TRIGGER_FALLING
,
272 jack
->codec
->dev
->driver
->name
,
277 #ifdef CONFIG_GPIO_SYSFS
278 /* Expose GPIO value over sysfs for diagnostic purposes */
279 gpio_export(gpios
[i
].gpio
, false);
282 /* Update initial jack status */
283 snd_soc_jack_gpio_detect(&gpios
[i
]);
289 gpio_free(gpios
[i
].gpio
);
291 snd_soc_jack_free_gpios(jack
, i
, gpios
);
295 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios
);
298 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
301 * @count: number of pins
302 * @gpios: array of gpio pins
304 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
306 void snd_soc_jack_free_gpios(struct snd_soc_jack
*jack
, int count
,
307 struct snd_soc_jack_gpio
*gpios
)
311 for (i
= 0; i
< count
; i
++) {
312 #ifdef CONFIG_GPIO_SYSFS
313 gpio_unexport(gpios
[i
].gpio
);
315 free_irq(gpio_to_irq(gpios
[i
].gpio
), &gpios
[i
]);
316 cancel_delayed_work_sync(&gpios
[i
].work
);
317 gpio_free(gpios
[i
].gpio
);
318 gpios
[i
].jack
= NULL
;
321 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios
);
322 #endif /* CONFIG_GPIOLIB */