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