ASoC: Add a notifier for jack status changes
[linux-2.6.git] / sound / soc / soc-jack.c
1 /*
2  * soc-jack.c  --  ALSA SoC jack handling
3  *
4  * Copyright 2008 Wolfson Microelectronics PLC.
5  *
6  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7  *
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.
12  */
13
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>
21
22 /**
23  * snd_soc_jack_new - Create a new jack
24  * @card:  ASoC card
25  * @id:    an identifying string for this jack
26  * @type:  a bitmask of enum snd_jack_type values that can be detected by
27  *         this jack
28  * @jack:  structure to use for the jack
29  *
30  * Creates a new jack object.
31  *
32  * Returns zero if successful, or a negative error code on failure.
33  * On success jack will be initialised.
34  */
35 int snd_soc_jack_new(struct snd_soc_card *card, const char *id, int type,
36                      struct snd_soc_jack *jack)
37 {
38         jack->card = card;
39         INIT_LIST_HEAD(&jack->pins);
40         BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
41
42         return snd_jack_new(card->codec->card, id, type, &jack->jack);
43 }
44 EXPORT_SYMBOL_GPL(snd_soc_jack_new);
45
46 /**
47  * snd_soc_jack_report - Report the current status for a jack
48  *
49  * @jack:   the 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.
52  *
53  * If configured using snd_soc_jack_add_pins() then the associated
54  * DAPM pins will be enabled or disabled as appropriate and DAPM
55  * synchronised.
56  *
57  * Note: This function uses mutexes and should be called from a
58  * context which can sleep (such as a workqueue).
59  */
60 void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
61 {
62         struct snd_soc_codec *codec;
63         struct snd_soc_jack_pin *pin;
64         int enable;
65         int oldstatus;
66
67         if (!jack) {
68                 WARN_ON_ONCE(!jack);
69                 return;
70         }
71         codec = jack->card->codec;
72
73         mutex_lock(&codec->mutex);
74
75         oldstatus = jack->status;
76
77         jack->status &= ~mask;
78         jack->status |= status & mask;
79
80         /* The DAPM sync is expensive enough to be worth skipping.
81          * However, empty mask means pin synchronization is desired. */
82         if (mask && (jack->status == oldstatus))
83                 goto out;
84
85         list_for_each_entry(pin, &jack->pins, list) {
86                 enable = pin->mask & jack->status;
87
88                 if (pin->invert)
89                         enable = !enable;
90
91                 if (enable)
92                         snd_soc_dapm_enable_pin(codec, pin->pin);
93                 else
94                         snd_soc_dapm_disable_pin(codec, pin->pin);
95         }
96
97         /* Report before the DAPM sync to help users updating micbias status */
98         blocking_notifier_call_chain(&jack->notifier, status, NULL);
99
100         snd_soc_dapm_sync(codec);
101
102         snd_jack_report(jack->jack, status);
103
104 out:
105         mutex_unlock(&codec->mutex);
106 }
107 EXPORT_SYMBOL_GPL(snd_soc_jack_report);
108
109 /**
110  * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack
111  *
112  * @jack:  ASoC jack
113  * @count: Number of pins
114  * @pins:  Array of pins
115  *
116  * After this function has been called the DAPM pins specified in the
117  * pins array will have their status updated to reflect the current
118  * state of the jack whenever the jack status is updated.
119  */
120 int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count,
121                           struct snd_soc_jack_pin *pins)
122 {
123         int i;
124
125         for (i = 0; i < count; i++) {
126                 if (!pins[i].pin) {
127                         printk(KERN_ERR "No name for pin %d\n", i);
128                         return -EINVAL;
129                 }
130                 if (!pins[i].mask) {
131                         printk(KERN_ERR "No mask for pin %d (%s)\n", i,
132                                pins[i].pin);
133                         return -EINVAL;
134                 }
135
136                 INIT_LIST_HEAD(&pins[i].list);
137                 list_add(&(pins[i].list), &jack->pins);
138         }
139
140         /* Update to reflect the last reported status; canned jack
141          * implementations are likely to set their state before the
142          * card has an opportunity to associate pins.
143          */
144         snd_soc_jack_report(jack, 0, 0);
145
146         return 0;
147 }
148 EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
149
150 /**
151  * snd_soc_jack_notifier_register - Register a notifier for jack status
152  *
153  * @jack:  ASoC jack
154  * @nb:    Notifier block to register
155  *
156  * Register for notification of the current status of the jack.  Note
157  * that it is not possible to report additional jack events in the
158  * callback from the notifier, this is intended to support
159  * applications such as enabling electrical detection only when a
160  * mechanical detection event has occurred.
161  */
162 void snd_soc_jack_notifier_register(struct snd_soc_jack *jack,
163                                     struct notifier_block *nb)
164 {
165         blocking_notifier_chain_register(&jack->notifier, nb);
166 }
167 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register);
168
169 /**
170  * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status
171  *
172  * @jack:  ASoC jack
173  * @nb:    Notifier block to unregister
174  *
175  * Stop notifying for status changes.
176  */
177 void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack,
178                                       struct notifier_block *nb)
179 {
180         blocking_notifier_chain_unregister(&jack->notifier, nb);
181 }
182 EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
183
184 #ifdef CONFIG_GPIOLIB
185 /* gpio detect */
186 static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
187 {
188         struct snd_soc_jack *jack = gpio->jack;
189         int enable;
190         int report;
191
192         if (gpio->debounce_time > 0)
193                 mdelay(gpio->debounce_time);
194
195         enable = gpio_get_value(gpio->gpio);
196         if (gpio->invert)
197                 enable = !enable;
198
199         if (enable)
200                 report = gpio->report;
201         else
202                 report = 0;
203
204         if (gpio->jack_status_check)
205                 report = gpio->jack_status_check();
206
207         snd_soc_jack_report(jack, report, gpio->report);
208 }
209
210 /* irq handler for gpio pin */
211 static irqreturn_t gpio_handler(int irq, void *data)
212 {
213         struct snd_soc_jack_gpio *gpio = data;
214
215         schedule_work(&gpio->work);
216
217         return IRQ_HANDLED;
218 }
219
220 /* gpio work */
221 static void gpio_work(struct work_struct *work)
222 {
223         struct snd_soc_jack_gpio *gpio;
224
225         gpio = container_of(work, struct snd_soc_jack_gpio, work);
226         snd_soc_jack_gpio_detect(gpio);
227 }
228
229 /**
230  * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack
231  *
232  * @jack:  ASoC jack
233  * @count: number of pins
234  * @gpios: array of gpio pins
235  *
236  * This function will request gpio, set data direction and request irq
237  * for each gpio in the array.
238  */
239 int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count,
240                         struct snd_soc_jack_gpio *gpios)
241 {
242         int i, ret;
243
244         for (i = 0; i < count; i++) {
245                 if (!gpio_is_valid(gpios[i].gpio)) {
246                         printk(KERN_ERR "Invalid gpio %d\n",
247                                 gpios[i].gpio);
248                         ret = -EINVAL;
249                         goto undo;
250                 }
251                 if (!gpios[i].name) {
252                         printk(KERN_ERR "No name for gpio %d\n",
253                                 gpios[i].gpio);
254                         ret = -EINVAL;
255                         goto undo;
256                 }
257
258                 ret = gpio_request(gpios[i].gpio, gpios[i].name);
259                 if (ret)
260                         goto undo;
261
262                 ret = gpio_direction_input(gpios[i].gpio);
263                 if (ret)
264                         goto err;
265
266                 INIT_WORK(&gpios[i].work, gpio_work);
267                 gpios[i].jack = jack;
268
269                 ret = request_irq(gpio_to_irq(gpios[i].gpio),
270                                 gpio_handler,
271                                 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING,
272                                 jack->card->dev->driver->name,
273                                 &gpios[i]);
274                 if (ret)
275                         goto err;
276
277 #ifdef CONFIG_GPIO_SYSFS
278                 /* Expose GPIO value over sysfs for diagnostic purposes */
279                 gpio_export(gpios[i].gpio, false);
280 #endif
281
282                 /* Update initial jack status */
283                 snd_soc_jack_gpio_detect(&gpios[i]);
284         }
285
286         return 0;
287
288 err:
289         gpio_free(gpios[i].gpio);
290 undo:
291         snd_soc_jack_free_gpios(jack, i, gpios);
292
293         return ret;
294 }
295 EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
296
297 /**
298  * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
299  *
300  * @jack:  ASoC jack
301  * @count: number of pins
302  * @gpios: array of gpio pins
303  *
304  * Release gpio and irq resources for gpio pins associated with an ASoC jack.
305  */
306 void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
307                         struct snd_soc_jack_gpio *gpios)
308 {
309         int i;
310
311         for (i = 0; i < count; i++) {
312 #ifdef CONFIG_GPIO_SYSFS
313                 gpio_unexport(gpios[i].gpio);
314 #endif
315                 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
316                 gpio_free(gpios[i].gpio);
317                 gpios[i].jack = NULL;
318         }
319 }
320 EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
321 #endif  /* CONFIG_GPIOLIB */