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