blob: 6c5ebd38c1b0f050f515dbb2dc1c47acaafc1ba4 [file] [log] [blame]
Mark Brown8a2cd612009-01-07 17:31:10 +00001/*
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>
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -060016#include <linux/gpio.h>
17#include <linux/interrupt.h>
18#include <linux/workqueue.h>
19#include <linux/delay.h>
Paul Gortmakerd81a6d72011-09-22 09:34:58 -040020#include <linux/export.h>
Mark Brown3028eb82010-12-05 12:22:46 +000021#include <trace/events/asoc.h>
Mark Brown8a2cd612009-01-07 17:31:10 +000022
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 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000036int snd_soc_jack_new(struct snd_soc_codec *codec, const char *id, int type,
Mark Brown8a2cd612009-01-07 17:31:10 +000037 struct snd_soc_jack *jack)
38{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000039 jack->codec = codec;
Mark Brown8a2cd612009-01-07 17:31:10 +000040 INIT_LIST_HEAD(&jack->pins);
Vinod Koulfa9879e2011-02-09 14:44:17 +053041 INIT_LIST_HEAD(&jack->jack_zones);
Mark Brownd5021ec2010-03-22 12:06:30 +000042 BLOCKING_INIT_NOTIFIER_HEAD(&jack->notifier);
Mark Brown8a2cd612009-01-07 17:31:10 +000043
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000044 return snd_jack_new(codec->card->snd_card, id, type, &jack->jack);
Mark Brown8a2cd612009-01-07 17:31:10 +000045}
46EXPORT_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 */
62void snd_soc_jack_report(struct snd_soc_jack *jack, int status, int mask)
63{
Julia Lawall4f066172009-10-17 08:32:56 +020064 struct snd_soc_codec *codec;
Liam Girdwoodce6120c2010-11-05 15:53:46 +020065 struct snd_soc_dapm_context *dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000066 struct snd_soc_jack_pin *pin;
67 int enable;
68 int oldstatus;
69
Mark Brown3028eb82010-12-05 12:22:46 +000070 trace_snd_soc_jack_report(jack, mask, status);
71
Mark Brown3a278a02010-03-29 20:31:14 +010072 if (!jack)
Mark Brown8a2cd612009-01-07 17:31:10 +000073 return;
Mark Brown3a278a02010-03-29 20:31:14 +010074
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000075 codec = jack->codec;
Liam Girdwoodce6120c2010-11-05 15:53:46 +020076 dapm = &codec->dapm;
Mark Brown8a2cd612009-01-07 17:31:10 +000077
78 mutex_lock(&codec->mutex);
79
80 oldstatus = jack->status;
81
82 jack->status &= ~mask;
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020083 jack->status |= status & mask;
Mark Brown8a2cd612009-01-07 17:31:10 +000084
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020085 /* 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))
Mark Brown8a2cd612009-01-07 17:31:10 +000088 goto out;
89
Mark Brown3028eb82010-12-05 12:22:46 +000090 trace_snd_soc_jack_notify(jack, status);
91
Mark Brown8a2cd612009-01-07 17:31:10 +000092 list_for_each_entry(pin, &jack->pins, list) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +020093 enable = pin->mask & jack->status;
Mark Brown8a2cd612009-01-07 17:31:10 +000094
95 if (pin->invert)
96 enable = !enable;
97
98 if (enable)
Liam Girdwoodce6120c2010-11-05 15:53:46 +020099 snd_soc_dapm_enable_pin(dapm, pin->pin);
Mark Brown8a2cd612009-01-07 17:31:10 +0000100 else
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200101 snd_soc_dapm_disable_pin(dapm, pin->pin);
Mark Brown8a2cd612009-01-07 17:31:10 +0000102 }
103
Mark Brownd5021ec2010-03-22 12:06:30 +0000104 /* Report before the DAPM sync to help users updating micbias status */
Mark Brown1d2c27f2011-02-22 12:42:35 -0800105 blocking_notifier_call_chain(&jack->notifier, status, jack);
Mark Brownd5021ec2010-03-22 12:06:30 +0000106
Liam Girdwoodce6120c2010-11-05 15:53:46 +0200107 snd_soc_dapm_sync(dapm);
Mark Brown8a2cd612009-01-07 17:31:10 +0000108
Mark Brown747da0f2011-09-04 08:18:18 -0700109 snd_jack_report(jack->jack, jack->status);
Mark Brown8a2cd612009-01-07 17:31:10 +0000110
111out:
112 mutex_unlock(&codec->mutex);
113}
114EXPORT_SYMBOL_GPL(snd_soc_jack_report);
115
116/**
Vinod Koulfa9879e2011-02-09 14:44:17 +0530117 * 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 */
126int 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}
137EXPORT_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 */
148int 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}
159EXPORT_SYMBOL_GPL(snd_soc_jack_get_type);
160
161/**
Mark Brown8a2cd612009-01-07 17:31:10 +0000162 * 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 */
172int 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
Mark Brown143d62a2011-10-06 13:30:55 +0100192 snd_soc_dapm_new_widgets(&jack->codec->card->dapm);
193
Mark Brown8a2cd612009-01-07 17:31:10 +0000194 /* 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}
202EXPORT_SYMBOL_GPL(snd_soc_jack_add_pins);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600203
Mark Brownd5021ec2010-03-22 12:06:30 +0000204/**
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 */
216void 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}
221EXPORT_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 */
231void 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}
236EXPORT_SYMBOL_GPL(snd_soc_jack_notifier_unregister);
237
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600238#ifdef CONFIG_GPIOLIB
239/* gpio detect */
Mark Brown26bd7b42009-03-06 11:32:17 +0000240static void snd_soc_jack_gpio_detect(struct snd_soc_jack_gpio *gpio)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600241{
242 struct snd_soc_jack *jack = gpio->jack;
243 int enable;
244 int report;
245
Jarkko Nikula535787b2011-02-10 17:22:23 +0200246 enable = gpio_get_value_cansleep(gpio->gpio);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600247 if (gpio->invert)
248 enable = !enable;
249
250 if (enable)
251 report = gpio->report;
252 else
253 report = 0;
254
Joonyoung Shimc871a052009-11-12 17:14:04 +0900255 if (gpio->jack_status_check)
256 report = gpio->jack_status_check();
257
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600258 snd_soc_jack_report(jack, report, gpio->report);
259}
260
261/* irq handler for gpio pin */
262static irqreturn_t gpio_handler(int irq, void *data)
263{
264 struct snd_soc_jack_gpio *gpio = data;
Mark Brownf9a67052010-11-14 19:25:09 +0000265 struct device *dev = gpio->jack->codec->card->dev;
266
Mark Brown3028eb82010-12-05 12:22:46 +0000267 trace_snd_soc_jack_irq(gpio->name);
268
Mark Brownf9a67052010-11-14 19:25:09 +0000269 if (device_may_wakeup(dev))
270 pm_wakeup_event(dev, gpio->debounce_time + 50);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600271
Mark Brown4c14d782010-10-06 15:54:28 -0700272 schedule_delayed_work(&gpio->work,
273 msecs_to_jiffies(gpio->debounce_time));
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600274
275 return IRQ_HANDLED;
276}
277
278/* gpio work */
279static void gpio_work(struct work_struct *work)
280{
281 struct snd_soc_jack_gpio *gpio;
282
Mark Brown4c14d782010-10-06 15:54:28 -0700283 gpio = container_of(work, struct snd_soc_jack_gpio, work.work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600284 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 */
297int 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
Mark Brown4c14d782010-10-06 15:54:28 -0700324 INIT_DELAYED_WORK(&gpios[i].work, gpio_work);
Lars-Peter Clausenb8e22c12009-07-31 21:15:25 +0200325 gpios[i].jack = jack;
326
Mark Brown3f58fd82010-11-03 09:35:31 -0400327 ret = request_any_context_irq(gpio_to_irq(gpios[i].gpio),
328 gpio_handler,
329 IRQF_TRIGGER_RISING |
330 IRQF_TRIGGER_FALLING,
Stephen Warren363618f2011-04-01 14:50:43 -0600331 gpios[i].name,
Mark Brown3f58fd82010-11-03 09:35:31 -0400332 &gpios[i]);
Axel Lind2b4c7b2011-08-13 19:15:01 +0800333 if (ret < 0)
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600334 goto err;
335
Mark Brown7887ab32011-02-17 16:35:55 -0800336 if (gpios[i].wake) {
Thomas Gleixner458f7f82011-03-30 00:39:44 +0200337 ret = irq_set_irq_wake(gpio_to_irq(gpios[i].gpio), 1);
Mark Brown7887ab32011-02-17 16:35:55 -0800338 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
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200344#ifdef CONFIG_GPIO_SYSFS
345 /* Expose GPIO value over sysfs for diagnostic purposes */
346 gpio_export(gpios[i].gpio, false);
347#endif
348
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200349 /* Update initial jack status */
350 snd_soc_jack_gpio_detect(&gpios[i]);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600351 }
352
353 return 0;
354
355err:
356 gpio_free(gpios[i].gpio);
357undo:
358 snd_soc_jack_free_gpios(jack, i, gpios);
359
360 return ret;
361}
362EXPORT_SYMBOL_GPL(snd_soc_jack_add_gpios);
363
364/**
365 * snd_soc_jack_free_gpios - Release GPIO pins' resources of an ASoC jack
366 *
367 * @jack: ASoC jack
368 * @count: number of pins
369 * @gpios: array of gpio pins
370 *
371 * Release gpio and irq resources for gpio pins associated with an ASoC jack.
372 */
373void snd_soc_jack_free_gpios(struct snd_soc_jack *jack, int count,
374 struct snd_soc_jack_gpio *gpios)
375{
376 int i;
377
378 for (i = 0; i < count; i++) {
Janusz Krzysztofik178b6992009-07-24 02:48:57 +0200379#ifdef CONFIG_GPIO_SYSFS
380 gpio_unexport(gpios[i].gpio);
381#endif
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600382 free_irq(gpio_to_irq(gpios[i].gpio), &gpios[i]);
Mark Brown4c14d782010-10-06 15:54:28 -0700383 cancel_delayed_work_sync(&gpios[i].work);
Lopez Cruz, Misaelec676242009-03-03 15:25:04 -0600384 gpio_free(gpios[i].gpio);
385 gpios[i].jack = NULL;
386 }
387}
388EXPORT_SYMBOL_GPL(snd_soc_jack_free_gpios);
389#endif /* CONFIG_GPIOLIB */