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