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