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