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