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