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