sound/soc/soc-jack.c

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