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