Commit | Line | Data |
---|---|---|
8a2cd618 MB |
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> | |
ec67624d LCM |
16 | #include <linux/gpio.h> |
17 | #include <linux/interrupt.h> | |
18 | #include <linux/workqueue.h> | |
19 | #include <linux/delay.h> | |
d81a6d71 | 20 | #include <linux/export.h> |
3028eb8c | 21 | #include <trace/events/asoc.h> |
8a2cd618 MB |
22 | |
23 | /** | |
24 | * snd_soc_jack_new - Create a new jack | |
a92b078e | 25 | * @codec: ASoC codec |
8a2cd618 MB |
26 | * @id: an identifying string for this jack |
27 | * @type: a bitmask of enum snd_jack_type values that can be detected by | |
28 | * this jack | |
29 | * @jack: structure to use for the jack | |
30 | * | |
31 | * Creates a new jack object. | |
32 | * | |
33 | * Returns zero if successful, or a negative error code on failure. | |
34 | * On success jack will be initialised. | |
35 | */ | |
f0fba2ad | 36 | int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type, |
8a2cd618 MB |
37 | struct snd_soc_jack *jack) |
38 | { | |
2667b4b8 | 39 | mutex_init(&jack->mutex); |
f0fba2ad | 40 | jack->codec = codec; |
8a2cd618 | 41 | INIT_LIST_HEAD(&jack->pins); |
fa9879ed | 42 | INIT_LIST_HEAD(&jack->jack_zones); |
d5021ec9 | 43 | BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier); |
8a2cd618 | 44 | |
f0fba2ad | 45 | return snd_jack_new(codec->card->snd_card, id, type, &jack->jack); |
8a2cd618 MB |
46 | } |
47 | EXPORT_SYMBOL_GPL(snd_soc_jack_new); | |
48 | ||
49 | /** | |
50 | * snd_soc_jack_report - Report the current status for a jack | |
51 | * | |
52 | * @jack: the 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. | |
55 | * | |
56 | * If configured using snd_soc_jack_add_pins() then the associated | |
57 | * DAPM pins will be enabled or disabled as appropriate and DAPM | |
58 | * synchronised. | |
59 | * | |
60 | * Note: This function uses mutexes and should be called from a | |
61 | * context which can sleep (such as a workqueue). | |
62 | */ | |
63 | void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask) | |
64 | { | |
4f066173 | 65 | struct snd_soc_codec *codec; |
ce6120cc | 66 | struct snd_soc_dapm_context *dapm; |
8a2cd618 MB |
67 | struct snd_soc_jack_pin *pin; |
68 | int enable; | |
69 | int oldstatus; | |
70 | ||
3028eb8c MB |
71 | trace_snd_soc_jack_report(jack, mask, status); |
72 | ||
3a278a0c | 73 | if (!jack) |
8a2cd618 | 74 | return; |
3a278a0c | 75 | |
f0fba2ad | 76 | codec = jack->codec; |
ce6120cc | 77 | dapm = &codec->dapm; |
8a2cd618 | 78 | |
2667b4b8 | 79 | mutex_lock(&jack->mutex); |
8a2cd618 MB |
80 | |
81 | oldstatus = jack->status; | |
82 | ||
83 | jack->status &= ~mask; | |
178b699c | 84 | jack->status |= status & mask; |
8a2cd618 | 85 | |
3028eb8c MB |
86 | trace_snd_soc_jack_notify(jack, status); |
87 | ||
8a2cd618 | 88 | list_for_each_entry(pin, &jack->pins, list) { |
178b699c | 89 | enable = pin->mask & jack->status; |
8a2cd618 MB |
90 | |
91 | if (pin->invert) | |
92 | enable = !enable; | |
93 | ||
94 | if (enable) | |
ce6120cc | 95 | snd_soc_dapm_enable_pin(dapm, pin->pin); |
8a2cd618 | 96 | else |
ce6120cc | 97 | snd_soc_dapm_disable_pin(dapm, pin->pin); |
8a2cd618 MB |
98 | } |
99 | ||
d5021ec9 | 100 | /* Report before the DAPM sync to help users updating micbias status */ |
12022a78 | 101 | blocking_notifier_call_chain(&jack->notifier, jack->status, jack); |
d5021ec9 | 102 | |
ce6120cc | 103 | snd_soc_dapm_sync(dapm); |
8a2cd618 | 104 | |
747da0f8 | 105 | snd_jack_report(jack->jack, jack->status); |
8a2cd618 | 106 | |
2667b4b8 | 107 | mutex_unlock(&jack->mutex); |
8a2cd618 MB |
108 | } |
109 | EXPORT_SYMBOL_GPL(snd_soc_jack_report); | |
110 | ||
fa9879ed VK |
111 | /** |
112 | * snd_soc_jack_add_zones - Associate voltage zones with jack | |
113 | * | |
114 | * @jack: ASoC jack | |
115 | * @count: Number of zones | |
116 | * @zone: Array of zones | |
117 | * | |
118 | * After this function has been called the zones specified in the | |
119 | * array will be associated with the jack. | |
120 | */ | |
121 | int snd_soc_jack_add_zones(struct snd_soc_jack *jack, int count, | |
122 | struct snd_soc_jack_zone *zones) | |
123 | { | |
124 | int i; | |
125 | ||
126 | for (i = 0; i < count; i++) { | |
127 | INIT_LIST_HEAD(&zones[i].list); | |
128 | list_add(&(zones[i].list), &jack->jack_zones); | |
129 | } | |
130 | return 0; | |
131 | } | |
132 | EXPORT_SYMBOL_GPL(snd_soc_jack_add_zones); | |
133 | ||
134 | /** | |
135 | * snd_soc_jack_get_type - Based on the mic bias value, this function returns | |
a92b078e | 136 | * the type of jack from the zones declared in the jack type |
fa9879ed | 137 | * |
a92b078e | 138 | * @jack: ASoC jack |
fa9879ed VK |
139 | * @micbias_voltage: mic bias voltage at adc channel when jack is plugged in |
140 | * | |
141 | * Based on the mic bias value passed, this function helps identify | |
a92b078e | 142 | * the type of jack from the already declared jack zones |
fa9879ed VK |
143 | */ |
144 | int snd_soc_jack_get_type(struct snd_soc_jack *jack, int micbias_voltage) | |
145 | { | |
146 | struct snd_soc_jack_zone *zone; | |
147 | ||
148 | list_for_each_entry(zone, &jack->jack_zones, list) { | |
149 | if (micbias_voltage >= zone->min_mv && | |
150 | micbias_voltage < zone->max_mv) | |
151 | return zone->jack_type; | |
152 | } | |
153 | return 0; | |
154 | } | |
155 | EXPORT_SYMBOL_GPL(snd_soc_jack_get_type); | |
156 | ||
8a2cd618 MB |
157 | /** |
158 | * snd_soc_jack_add_pins - Associate DAPM pins with an ASoC jack | |
159 | * | |
160 | * @jack: ASoC jack | |
161 | * @count: Number of pins | |
162 | * @pins: Array of pins | |
163 | * | |
164 | * After this function has been called the DAPM pins specified in the | |
165 | * pins array will have their status updated to reflect the current | |
166 | * state of the jack whenever the jack status is updated. | |
167 | */ | |
168 | int snd_soc_jack_add_pins(struct snd_soc_jack *jack, int count, | |
169 | struct snd_soc_jack_pin *pins) | |
170 | { | |
171 | int i; | |
172 | ||
173 | for (i = 0; i < count; i++) { | |
174 | if (!pins[i].pin) { | |
175 | printk(KERN_ERR "No name for pin %d\n", i); | |
176 | return -EINVAL; | |
177 | } | |
178 | if (!pins[i].mask) { | |
179 | printk(KERN_ERR "No mask for pin %d (%s)\n", i, | |
180 | pins[i].pin); | |
181 | return -EINVAL; | |
182 | } | |
183 | ||
184 | INIT_LIST_HEAD(&pins[i].list); | |
185 | list_add(&(pins[i].list), &jack->pins); | |
186 | } | |
187 | ||
143d62a4 MB |
188 | snd_soc_dapm_new_widgets(&jack->codec->card->dapm); |
189 | ||
8a2cd618 MB |
190 | /* Update to reflect the last reported status; canned jack |
191 | * implementations are likely to set their state before the | |
192 | * card has an opportunity to associate pins. | |
193 | */ | |
194 | snd_soc_jack_report(jack, 0, 0); | |
195 | ||
196 | return 0; | |
197 | } | |
198 | EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins); | |
ec67624d | 199 | |
d5021ec9 MB |
200 | /** |
201 | * snd_soc_jack_notifier_register - Register a notifier for jack status | |
202 | * | |
203 | * @jack: ASoC jack | |
204 | * @nb: Notifier block to register | |
205 | * | |
206 | * Register for notification of the current status of the jack. Note | |
207 | * that it is not possible to report additional jack events in the | |
208 | * callback from the notifier, this is intended to support | |
209 | * applications such as enabling electrical detection only when a | |
210 | * mechanical detection event has occurred. | |
211 | */ | |
212 | void snd_soc_jack_notifier_register(struct snd_soc_jack *jack, | |
213 | struct notifier_block *nb) | |
214 | { | |
215 | blocking_notifier_chain_register(&jack->notifier, nb); | |
216 | } | |
217 | EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_register); | |
218 | ||
219 | /** | |
220 | * snd_soc_jack_notifier_unregister - Unregister a notifier for jack status | |
221 | * | |
222 | * @jack: ASoC jack | |
223 | * @nb: Notifier block to unregister | |
224 | * | |
225 | * Stop notifying for status changes. | |
226 | */ | |
227 | void snd_soc_jack_notifier_unregister(struct snd_soc_jack *jack, | |
228 | struct notifier_block *nb) | |
229 | { | |
230 | blocking_notifier_chain_unregister(&jack->notifier, nb); | |
231 | } | |
232 | EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister); | |
233 | ||
ec67624d LCM |
234 | #ifdef CONFIG_GPIOLIB |
235 | /* gpio detect */ | |
26bd7b49 | 236 | static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio) |
ec67624d LCM |
237 | { |
238 | struct snd_soc_jack *jack = gpio->jack; | |
239 | int enable; | |
240 | int report; | |
241 | ||
535787b6 | 242 | enable = gpio_get_value_cansleep(gpio->gpio); |
ec67624d LCM |
243 | if (gpio->invert) |
244 | enable = !enable; | |
245 | ||
246 | if (enable) | |
247 | report = gpio->report; | |
248 | else | |
249 | report = 0; | |
250 | ||
c871a053 JS |
251 | if (gpio->jack_status_check) |
252 | report = gpio->jack_status_check(); | |
253 | ||
ec67624d LCM |
254 | snd_soc_jack_report(jack, report, gpio->report); |
255 | } | |
256 | ||
257 | /* irq handler for gpio pin */ | |
258 | static irqreturn_t gpio_handler(int irq, void *data) | |
259 | { | |
260 | struct snd_soc_jack_gpio *gpio = data; | |
f9a67059 MB |
261 | struct device *dev = gpio->jack->codec->card->dev; |
262 | ||
3028eb8c MB |
263 | trace_snd_soc_jack_irq(gpio->name); |
264 | ||
f9a67059 MB |
265 | if (device_may_wakeup(dev)) |
266 | pm_wakeup_event(dev, gpio->debounce_time + 50); | |
ec67624d | 267 | |
4c14d78e MB |
268 | schedule_delayed_work(&gpio->work, |
269 | msecs_to_jiffies(gpio->debounce_time)); | |
ec67624d LCM |
270 | |
271 | return IRQ_HANDLED; | |
272 | } | |
273 | ||
274 | /* gpio work */ | |
275 | static void gpio_work(struct work_struct *work) | |
276 | { | |
277 | struct snd_soc_jack_gpio *gpio; | |
278 | ||
4c14d78e | 279 | gpio = container_of(work, struct snd_soc_jack_gpio, work.work); |
ec67624d LCM |
280 | snd_soc_jack_gpio_detect(gpio); |
281 | } | |
282 | ||
283 | /** | |
284 | * snd_soc_jack_add_gpios - Associate GPIO pins with an ASoC jack | |
285 | * | |
286 | * @jack: ASoC jack | |
287 | * @count: number of pins | |
288 | * @gpios: array of gpio pins | |
289 | * | |
290 | * This function will request gpio, set data direction and request irq | |
291 | * for each gpio in the array. | |
292 | */ | |
293 | int snd_soc_jack_add_gpios(struct snd_soc_jack *jack, int count, | |
294 | struct snd_soc_jack_gpio *gpios) | |
295 | { | |
296 | int i, ret; | |
297 | ||
298 | for (i = 0; i < count; i++) { | |
299 | if (!gpio_is_valid(gpios[i].gpio)) { | |
300 | printk(KERN_ERR "Invalid gpio %d\n", | |
301 | gpios[i].gpio); | |
302 | ret = -EINVAL; | |
303 | goto undo; | |
304 | } | |
305 | if (!gpios[i].name) { | |
306 | printk(KERN_ERR "No name for gpio %d\n", | |
307 | gpios[i].gpio); | |
308 | ret = -EINVAL; | |
309 | goto undo; | |
310 | } | |
311 | ||
312 | ret = gpio_request(gpios[i].gpio, gpios[i].name); | |
313 | if (ret) | |
314 | goto undo; | |
315 | ||
316 | ret = gpio_direction_input(gpios[i].gpio); | |
317 | if (ret) | |
318 | goto err; | |
319 | ||
4c14d78e | 320 | INIT_DELAYED_WORK(&gpios[i].work, gpio_work); |
b8e22c1f LPC |
321 | gpios[i].jack = jack; |
322 | ||
3f58fd84 MB |
323 | ret = request_any_context_irq(gpio_to_irq(gpios[i].gpio), |
324 | gpio_handler, | |
325 | IRQF_TRIGGER_RISING | | |
326 | IRQF_TRIGGER_FALLING, | |
363618f0 | 327 | gpios[i].name, |
3f58fd84 | 328 | &gpios[i]); |
d2b4c7bd | 329 | if (ret < 0) |
ec67624d LCM |
330 | goto err; |
331 | ||
7887ab3a | 332 | if (gpios[i].wake) { |
458f7f8f | 333 | ret = irq_set_irq_wake(gpio_to_irq(gpios[i].gpio), 1); |
7887ab3a MB |
334 | if (ret != 0) |
335 | printk(KERN_ERR | |
336 | "Failed to mark GPIO %d as wake source: %d\n", | |
337 | gpios[i].gpio, ret); | |
338 | } | |
339 | ||
178b699c JK |
340 | /* Expose GPIO value over sysfs for diagnostic purposes */ |
341 | gpio_export(gpios[i].gpio, false); | |
178b699c | 342 | |
178b699c JK |
343 | /* Update initial jack status */ |
344 | snd_soc_jack_gpio_detect(&gpios[i]); | |
ec67624d LCM |
345 | } |
346 | ||
347 | return 0; | |
348 | ||
349 | err: | |
350 | gpio_free(gpios[i].gpio); | |
351 | undo: | |
352 | snd_soc_jack_free_gpios(jack, i, gpios); | |
353 | ||
354 | return ret; | |
355 | } | |
356 | EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios); | |
357 | ||
358 | /** | |
359 | * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack | |
360 | * | |
361 | * @jack: ASoC jack | |
362 | * @count: number of pins | |
363 | * @gpios: array of gpio pins | |
364 | * | |
365 | * Release gpio and irq resources for gpio pins associated with an ASoC jack. | |
366 | */ | |
367 | void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count, | |
368 | struct snd_soc_jack_gpio *gpios) | |
369 | { | |
370 | int i; | |
371 | ||
372 | for (i = 0; i < count; i++) { | |
178b699c | 373 | gpio_unexport(gpios[i].gpio); |
ec67624d | 374 | free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]); |
4c14d78e | 375 | cancel_delayed_work_sync(&gpios[i].work); |
ec67624d LCM |
376 | gpio_free(gpios[i].gpio); |
377 | gpios[i].jack = NULL; | |
378 | } | |
379 | } | |
380 | EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios); | |
381 | #endif /* CONFIG_GPIOLIB */ |