drivers/gpio/gpiolib-acpi.c

   1 /*
   2  * ACPI helpers for GPIO API
   3  *
   4  * Copyright (C) 2012, Intel Corporation
   5  * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
   6  *          Mika Westerberg <mika.westerberg@linux.intel.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/dmi.h>
  14 #include <linux/errno.h>
  15 #include <linux/gpio.h>
  16 #include <linux/gpio/consumer.h>
  17 #include <linux/gpio/driver.h>
  18 #include <linux/gpio/machine.h>
  19 #include <linux/export.h>
  20 #include <linux/acpi.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/mutex.h>
  23 #include <linux/pinctrl/pinctrl.h>
  24
  25 #include "gpiolib.h"
  26
  27 static int run_edge_events_on_boot = -1;
  28 module_param(run_edge_events_on_boot, int, 0444);
  29 MODULE_PARM_DESC(run_edge_events_on_boot,
  30                  "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");
  31
  32 static char *ignore_wake;
  33 module_param(ignore_wake, charp, 0444);
  34 MODULE_PARM_DESC(ignore_wake,
  35                  "controller@pin combos on which to ignore the ACPI wake flag "
  36                  "ignore_wake=controller@pin[,controller@pin[,...]]");
  37
  38 struct acpi_gpiolib_dmi_quirk {
  39         bool no_edge_events_on_boot;
  40         char *ignore_wake;
  41 };
  42
  43 /**
  44  * struct acpi_gpio_event - ACPI GPIO event handler data
  45  *
  46  * @node:         list-entry of the events list of the struct acpi_gpio_chip
  47  * @handle:       handle of ACPI method to execute when the IRQ triggers
  48  * @handler:      irq_handler to pass to request_irq when requesting the IRQ
  49  * @pin:          GPIO pin number on the gpio_chip
  50  * @irq:          Linux IRQ number for the event, for request_ / free_irq
  51  * @irqflags:     flags to pass to request_irq when requesting the IRQ
  52  * @irq_is_wake:  If the ACPI flags indicate the IRQ is a wakeup source
  53  * @is_requested: True if request_irq has been done
  54  * @desc:         gpio_desc for the GPIO pin for this event
  55  */
  56 struct acpi_gpio_event {
  57         struct list_head node;
  58         acpi_handle handle;
  59         irq_handler_t handler;
  60         unsigned int pin;
  61         unsigned int irq;
  62         unsigned long irqflags;
  63         bool irq_is_wake;
  64         bool irq_requested;
  65         struct gpio_desc *desc;
  66 };
  67
  68 struct acpi_gpio_connection {
  69         struct list_head node;
  70         unsigned int pin;
  71         struct gpio_desc *desc;
  72 };
  73
  74 struct acpi_gpio_chip {
  75         /*
  76          * ACPICA requires that the first field of the context parameter
  77          * passed to acpi_install_address_space_handler() is large enough
  78          * to hold struct acpi_connection_info.
  79          */
  80         struct acpi_connection_info conn_info;
  81         struct list_head conns;
  82         struct mutex conn_lock;
  83         struct gpio_chip *chip;
  84         struct list_head events;
  85         struct list_head deferred_req_irqs_list_entry;
  86 };
  87
  88 /*
  89  * For gpiochips which call acpi_gpiochip_request_interrupts() before late_init
  90  * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
  91  * late_initcall_sync handler, so that other builtin drivers can register their
  92  * OpRegions before the event handlers can run.  This list contains gpiochips
  93  * for which the acpi_gpiochip_request_irqs() call has been deferred.
  94  */
  95 static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
  96 static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
  97 static bool acpi_gpio_deferred_req_irqs_done;
  98
  99 static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
 100 {
 101         if (!gc->parent)
 102                 return false;
 103
 104         return ACPI_HANDLE(gc->parent) == data;
 105 }
 106
 107 #ifdef CONFIG_PINCTRL
 108 /**
 109  * acpi_gpiochip_pin_to_gpio_offset() - translates ACPI GPIO to Linux GPIO
 110  * @gdev: GPIO device
 111  * @pin: ACPI GPIO pin number from GpioIo/GpioInt resource
 112  *
 113  * Function takes ACPI GpioIo/GpioInt pin number as a parameter and
 114  * translates it to a corresponding offset suitable to be passed to a
 115  * GPIO controller driver.
 116  *
 117  * Typically the returned offset is same as @pin, but if the GPIO
 118  * controller uses pin controller and the mapping is not contiguous the
 119  * offset might be different.
 120  */
 121 static int acpi_gpiochip_pin_to_gpio_offset(struct gpio_device *gdev, int pin)
 122 {
 123         struct gpio_pin_range *pin_range;
 124
 125         /* If there are no ranges in this chip, use 1:1 mapping */
 126         if (list_empty(&gdev->pin_ranges))
 127                 return pin;
 128
 129         list_for_each_entry(pin_range, &gdev->pin_ranges, node) {
 130                 const struct pinctrl_gpio_range *range = &pin_range->range;
 131                 int i;
 132
 133                 if (range->pins) {
 134                         for (i = 0; i < range->npins; i++) {
 135                                 if (range->pins[i] == pin)
 136                                         return range->base + i - gdev->base;
 137                         }
 138                 } else {
 139                         if (pin >= range->pin_base &&
 140                             pin < range->pin_base + range->npins) {
 141                                 unsigned gpio_base;
 142
 143                                 gpio_base = range->base - gdev->base;
 144                                 return gpio_base + pin - range->pin_base;
 145                         }
 146                 }
 147         }
 148
 149         return -EINVAL;
 150 }
 151 #else
 152 static inline int acpi_gpiochip_pin_to_gpio_offset(struct gpio_device *gdev,
 153                                                    int pin)
 154 {
 155         return pin;
 156 }
 157 #endif
 158
 159 /**
 160  * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
 161  * @path:       ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
 162  * @pin:        ACPI GPIO pin number (0-based, controller-relative)
 163  *
 164  * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
 165  * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
 166  * controller does not have gpiochip registered at the moment. This is to
 167  * support probe deferral.
 168  */
 169 static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
 170 {
 171         struct gpio_chip *chip;
 172         acpi_handle handle;
 173         acpi_status status;
 174         int offset;
 175
 176         status = acpi_get_handle(NULL, path, &handle);
 177         if (ACPI_FAILURE(status))
 178                 return ERR_PTR(-ENODEV);
 179
 180         chip = gpiochip_find(handle, acpi_gpiochip_find);
 181         if (!chip)
 182                 return ERR_PTR(-EPROBE_DEFER);
 183
 184         offset = acpi_gpiochip_pin_to_gpio_offset(chip->gpiodev, pin);
 185         if (offset < 0)
 186                 return ERR_PTR(offset);
 187
 188         return gpiochip_get_desc(chip, offset);
 189 }
 190
 191 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
 192 {
 193         struct acpi_gpio_event *event = data;
 194
 195         acpi_evaluate_object(event->handle, NULL, NULL, NULL);
 196
 197         return IRQ_HANDLED;
 198 }
 199
 200 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
 201 {
 202         struct acpi_gpio_event *event = data;
 203
 204         acpi_execute_simple_method(event->handle, NULL, event->pin);
 205
 206         return IRQ_HANDLED;
 207 }
 208
 209 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
 210 {
 211         /* The address of this function is used as a key. */
 212 }
 213
 214 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
 215                                 struct acpi_resource_gpio **agpio)
 216 {
 217         struct acpi_resource_gpio *gpio;
 218
 219         if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
 220                 return false;
 221
 222         gpio = &ares->data.gpio;
 223         if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
 224                 return false;
 225
 226         *agpio = gpio;
 227         return true;
 228 }
 229 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
 230
 231 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
 232                                       struct acpi_gpio_event *event)
 233 {
 234         int ret, value;
 235
 236         ret = request_threaded_irq(event->irq, NULL, event->handler,
 237                                    event->irqflags | IRQF_ONESHOT, "ACPI:Event", event);
 238         if (ret) {
 239                 dev_err(acpi_gpio->chip->parent,
 240                         "Failed to setup interrupt handler for %d\n",
 241                         event->irq);
 242                 return;
 243         }
 244
 245         if (event->irq_is_wake)
 246                 enable_irq_wake(event->irq);
 247
 248         event->irq_requested = true;
 249
 250         /* Make sure we trigger the initial state of edge-triggered IRQs */
 251         if (run_edge_events_on_boot &&
 252             (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
 253                 value = gpiod_get_raw_value_cansleep(event->desc);
 254                 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
 255                     ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
 256                         event->handler(event->irq, event);
 257         }
 258 }
 259
 260 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
 261 {
 262         struct acpi_gpio_event *event;
 263
 264         list_for_each_entry(event, &acpi_gpio->events, node)
 265                 acpi_gpiochip_request_irq(acpi_gpio, event);
 266 }
 267
 268 static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
 269 {
 270         const char *controller, *pin_str;
 271         int len, pin;
 272         char *endp;
 273
 274         controller = ignore_wake;
 275         while (controller) {
 276                 pin_str = strchr(controller, '@');
 277                 if (!pin_str)
 278                         goto err;
 279
 280                 len = pin_str - controller;
 281                 if (len == strlen(controller_in) &&
 282                     strncmp(controller, controller_in, len) == 0) {
 283                         pin = simple_strtoul(pin_str + 1, &endp, 10);
 284                         if (*endp != 0 && *endp != ',')
 285                                 goto err;
 286
 287                         if (pin == pin_in)
 288                                 return true;
 289                 }
 290
 291                 controller = strchr(controller, ',');
 292                 if (controller)
 293                         controller++;
 294         }
 295
 296         return false;
 297 err:
 298         pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
 299                     ignore_wake);
 300         return false;
 301 }
 302
 303 static bool acpi_gpio_irq_is_wake(struct device *parent,
 304                                   struct acpi_resource_gpio *agpio)
 305 {
 306         int pin = agpio->pin_table[0];
 307
 308         if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
 309                 return false;
 310
 311         if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
 312                 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
 313                 return false;
 314         }
 315
 316         return true;
 317 }
 318
 319 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
 320                                              void *context)
 321 {
 322         struct acpi_gpio_chip *acpi_gpio = context;
 323         struct gpio_chip *chip = acpi_gpio->chip;
 324         struct acpi_resource_gpio *agpio;
 325         acpi_handle handle, evt_handle;
 326         struct acpi_gpio_event *event;
 327         irq_handler_t handler = NULL;
 328         struct gpio_desc *desc;
 329         int ret, pin, irq;
 330
 331         if (!acpi_gpio_get_irq_resource(ares, &agpio))
 332                 return AE_OK;
 333
 334         handle = ACPI_HANDLE(chip->parent);
 335         pin = agpio->pin_table[0];
 336
 337         if (pin <= 255) {
 338                 char ev_name[5];
 339                 sprintf(ev_name, "_%c%02hhX",
 340                         agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
 341                         pin);
 342                 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
 343                         handler = acpi_gpio_irq_handler;
 344         }
 345         if (!handler) {
 346                 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
 347                         handler = acpi_gpio_irq_handler_evt;
 348         }
 349         if (!handler)
 350                 return AE_OK;
 351
 352         pin = acpi_gpiochip_pin_to_gpio_offset(chip->gpiodev, pin);
 353         if (pin < 0)
 354                 return AE_BAD_PARAMETER;
 355
 356         desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event");
 357         if (IS_ERR(desc)) {
 358                 dev_err(chip->parent, "Failed to request GPIO\n");
 359                 return AE_ERROR;
 360         }
 361
 362         gpiod_direction_input(desc);
 363
 364         ret = gpiochip_lock_as_irq(chip, pin);
 365         if (ret) {
 366                 dev_err(chip->parent, "Failed to lock GPIO as interrupt\n");
 367                 goto fail_free_desc;
 368         }
 369
 370         irq = gpiod_to_irq(desc);
 371         if (irq < 0) {
 372                 dev_err(chip->parent, "Failed to translate GPIO to IRQ\n");
 373                 goto fail_unlock_irq;
 374         }
 375
 376         event = kzalloc(sizeof(*event), GFP_KERNEL);
 377         if (!event)
 378                 goto fail_unlock_irq;
 379
 380         event->irqflags = IRQF_ONESHOT;
 381         if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
 382                 if (agpio->polarity == ACPI_ACTIVE_HIGH)
 383                         event->irqflags |= IRQF_TRIGGER_HIGH;
 384                 else
 385                         event->irqflags |= IRQF_TRIGGER_LOW;
 386         } else {
 387                 switch (agpio->polarity) {
 388                 case ACPI_ACTIVE_HIGH:
 389                         event->irqflags |= IRQF_TRIGGER_RISING;
 390                         break;
 391                 case ACPI_ACTIVE_LOW:
 392                         event->irqflags |= IRQF_TRIGGER_FALLING;
 393                         break;
 394                 default:
 395                         event->irqflags |= IRQF_TRIGGER_RISING |
 396                                            IRQF_TRIGGER_FALLING;
 397                         break;
 398                 }
 399         }
 400
 401         event->handle = evt_handle;
 402         event->handler = handler;
 403         event->irq = irq;
 404         event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
 405         event->pin = pin;
 406         event->desc = desc;
 407
 408         list_add_tail(&event->node, &acpi_gpio->events);
 409
 410         return AE_OK;
 411
 412 fail_unlock_irq:
 413         gpiochip_unlock_as_irq(chip, pin);
 414 fail_free_desc:
 415         gpiochip_free_own_desc(desc);
 416
 417         return AE_ERROR;
 418 }
 419
 420 /**
 421  * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
 422  * @chip:      GPIO chip
 423  *
 424  * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
 425  * handled by ACPI event methods which need to be called from the GPIO
 426  * chip's interrupt handler. acpi_gpiochip_request_interrupts finds out which
 427  * gpio pins have acpi event methods and assigns interrupt handlers that calls
 428  * the acpi event methods for those pins.
 429  */
 430 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
 431 {
 432         struct acpi_gpio_chip *acpi_gpio;
 433         acpi_handle handle;
 434         acpi_status status;
 435         bool defer;
 436
 437         if (!chip->parent || !chip->to_irq)
 438                 return;
 439
 440         handle = ACPI_HANDLE(chip->parent);
 441         if (!handle)
 442                 return;
 443
 444         status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
 445         if (ACPI_FAILURE(status))
 446                 return;
 447
 448         acpi_walk_resources(handle, "_AEI",
 449                             acpi_gpiochip_alloc_event, acpi_gpio);
 450
 451         mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
 452         defer = !acpi_gpio_deferred_req_irqs_done;
 453         if (defer)
 454                 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
 455                          &acpi_gpio_deferred_req_irqs_list);
 456         mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
 457
 458         if (defer)
 459                 return;
 460
 461         acpi_gpiochip_request_irqs(acpi_gpio);
 462 }
 463 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
 464
 465 /**
 466  * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
 467  * @chip:      GPIO chip
 468  *
 469  * Free interrupts associated with GPIO ACPI event method for the given
 470  * GPIO chip.
 471  */
 472 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
 473 {
 474         struct acpi_gpio_chip *acpi_gpio;
 475         struct acpi_gpio_event *event, *ep;
 476         acpi_handle handle;
 477         acpi_status status;
 478
 479         if (!chip->parent || !chip->to_irq)
 480                 return;
 481
 482         handle = ACPI_HANDLE(chip->parent);
 483         if (!handle)
 484                 return;
 485
 486         status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
 487         if (ACPI_FAILURE(status))
 488                 return;
 489
 490         mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
 491         if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
 492                 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
 493         mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
 494
 495         list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
 496                 struct gpio_desc *desc;
 497
 498                 if (event->irq_requested) {
 499                         if (event->irq_is_wake)
 500                                 disable_irq_wake(event->irq);
 501
 502                         free_irq(event->irq, event);
 503                 }
 504
 505                 desc = event->desc;
 506                 if (WARN_ON(IS_ERR(desc)))
 507                         continue;
 508                 gpiochip_unlock_as_irq(chip, event->pin);
 509                 gpiochip_free_own_desc(desc);
 510                 list_del(&event->node);
 511                 kfree(event);
 512         }
 513 }
 514 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
 515
 516 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
 517                               const struct acpi_gpio_mapping *gpios)
 518 {
 519         if (adev && gpios) {
 520                 adev->driver_gpios = gpios;
 521                 return 0;
 522         }
 523         return -EINVAL;
 524 }
 525 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
 526
 527 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
 528 {
 529         acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
 530 }
 531
 532 int devm_acpi_dev_add_driver_gpios(struct device *dev,
 533                                    const struct acpi_gpio_mapping *gpios)
 534 {
 535         void *res;
 536         int ret;
 537
 538         res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
 539         if (!res)
 540                 return -ENOMEM;
 541
 542         ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
 543         if (ret) {
 544                 devres_free(res);
 545                 return ret;
 546         }
 547         devres_add(dev, res);
 548         return 0;
 549 }
 550 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
 551
 552 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
 553 {
 554         WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
 555 }
 556 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
 557
 558 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
 559                                       const char *name, int index,
 560                                       struct acpi_reference_args *args)
 561 {
 562         const struct acpi_gpio_mapping *gm;
 563
 564         if (!adev->driver_gpios)
 565                 return false;
 566
 567         for (gm = adev->driver_gpios; gm->name; gm++)
 568                 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
 569                         const struct acpi_gpio_params *par = gm->data + index;
 570
 571                         args->adev = adev;
 572                         args->args[0] = par->crs_entry_index;
 573                         args->args[1] = par->line_index;
 574                         args->args[2] = par->active_low;
 575                         args->nargs = 3;
 576                         return true;
 577                 }
 578
 579         return false;
 580 }
 581
 582 static enum gpiod_flags
 583 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio)
 584 {
 585         bool pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;
 586
 587         switch (agpio->io_restriction) {
 588         case ACPI_IO_RESTRICT_INPUT:
 589                 return GPIOD_IN;
 590         case ACPI_IO_RESTRICT_OUTPUT:
 591                 /*
 592                  * ACPI GPIO resources don't contain an initial value for the
 593                  * GPIO. Therefore we deduce that value from the pull field
 594                  * instead. If the pin is pulled up we assume default to be
 595                  * high, otherwise low.
 596                  */
 597                 return pull_up ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
 598         default:
 599                 /*
 600                  * Assume that the BIOS has configured the direction and pull
 601                  * accordingly.
 602                  */
 603                 return GPIOD_ASIS;
 604         }
 605 }
 606
 607 int
 608 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
 609 {
 610         int ret = 0;
 611
 612         /*
 613          * Check if the BIOS has IoRestriction with explicitly set direction
 614          * and update @flags accordingly. Otherwise use whatever caller asked
 615          * for.
 616          */
 617         if (update & GPIOD_FLAGS_BIT_DIR_SET) {
 618                 enum gpiod_flags diff = *flags ^ update;
 619
 620                 /*
 621                  * Check if caller supplied incompatible GPIO initialization
 622                  * flags.
 623                  *
 624                  * Return %-EINVAL to notify that firmware has different
 625                  * settings and we are going to use them.
 626                  */
 627                 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
 628                     ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
 629                         ret = -EINVAL;
 630                 *flags = update;
 631         }
 632         return ret;
 633 }
 634
 635 struct acpi_gpio_lookup {
 636         struct acpi_gpio_info info;
 637         int index;
 638         int pin_index;
 639         bool active_low;
 640         struct acpi_device *adev;
 641         struct gpio_desc *desc;
 642         int n;
 643 };
 644
 645 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
 646 {
 647         struct acpi_gpio_lookup *lookup = data;
 648
 649         if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
 650                 return 1;
 651
 652         if (lookup->n++ == lookup->index && !lookup->desc) {
 653                 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
 654                 int pin_index = lookup->pin_index;
 655
 656                 if (pin_index >= agpio->pin_table_length)
 657                         return 1;
 658
 659                 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
 660                                               agpio->pin_table[pin_index]);
 661                 lookup->info.gpioint =
 662                         agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
 663
 664                 /*
 665                  * Polarity and triggering are only specified for GpioInt
 666                  * resource.
 667                  * Note: we expect here:
 668                  * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
 669                  * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
 670                  */
 671                 if (lookup->info.gpioint) {
 672                         lookup->info.flags = GPIOD_IN;
 673                         lookup->info.polarity = agpio->polarity;
 674                         lookup->info.triggering = agpio->triggering;
 675                 } else {
 676                         lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio);
 677                 }
 678
 679         }
 680
 681         return 1;
 682 }
 683
 684 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
 685                                      struct acpi_gpio_info *info)
 686 {
 687         struct list_head res_list;
 688         int ret;
 689
 690         INIT_LIST_HEAD(&res_list);
 691
 692         ret = acpi_dev_get_resources(lookup->adev, &res_list,
 693                                      acpi_populate_gpio_lookup,
 694                                      lookup);
 695         if (ret < 0)
 696                 return ret;
 697
 698         acpi_dev_free_resource_list(&res_list);
 699
 700         if (!lookup->desc)
 701                 return -ENOENT;
 702
 703         if (info) {
 704                 *info = lookup->info;
 705                 if (lookup->active_low)
 706                         info->polarity = lookup->active_low;
 707         }
 708         return 0;
 709 }
 710
 711 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
 712                                      const char *propname, int index,
 713                                      struct acpi_gpio_lookup *lookup)
 714 {
 715         struct acpi_reference_args args;
 716         int ret;
 717
 718         memset(&args, 0, sizeof(args));
 719         ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
 720                                                  &args);
 721         if (ret) {
 722                 struct acpi_device *adev = to_acpi_device_node(fwnode);
 723
 724                 if (!adev)
 725                         return ret;
 726
 727                 if (!acpi_get_driver_gpio_data(adev, propname, index, &args))
 728                         return ret;
 729         }
 730         /*
 731          * The property was found and resolved, so need to lookup the GPIO based
 732          * on returned args.
 733          */
 734         lookup->adev = args.adev;
 735         if (args.nargs != 3)
 736                 return -EPROTO;
 737
 738         lookup->index = args.args[0];
 739         lookup->pin_index = args.args[1];
 740         lookup->active_low = !!args.args[2];
 741
 742         return 0;
 743 }
 744
 745 /**
 746  * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
 747  * @adev: pointer to a ACPI device to get GPIO from
 748  * @propname: Property name of the GPIO (optional)
 749  * @index: index of GpioIo/GpioInt resource (starting from %0)
 750  * @info: info pointer to fill in (optional)
 751  *
 752  * Function goes through ACPI resources for @adev and based on @index looks
 753  * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
 754  * and returns it. @index matches GpioIo/GpioInt resources only so if there
 755  * are total %3 GPIO resources, the index goes from %0 to %2.
 756  *
 757  * If @propname is specified the GPIO is looked using device property. In
 758  * that case @index is used to select the GPIO entry in the property value
 759  * (in case of multiple).
 760  *
 761  * If the GPIO cannot be translated or there is an error an ERR_PTR is
 762  * returned.
 763  *
 764  * Note: if the GPIO resource has multiple entries in the pin list, this
 765  * function only returns the first.
 766  */
 767 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
 768                                           const char *propname, int index,
 769                                           struct acpi_gpio_info *info)
 770 {
 771         struct acpi_gpio_lookup lookup;
 772         int ret;
 773
 774         if (!adev)
 775                 return ERR_PTR(-ENODEV);
 776
 777         memset(&lookup, 0, sizeof(lookup));
 778         lookup.index = index;
 779
 780         if (propname) {
 781                 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
 782
 783                 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
 784                                                 propname, index, &lookup);
 785                 if (ret)
 786                         return ERR_PTR(ret);
 787
 788                 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
 789                         dev_name(&lookup.adev->dev), lookup.index,
 790                         lookup.pin_index, lookup.active_low);
 791         } else {
 792                 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
 793                 lookup.adev = adev;
 794         }
 795
 796         ret = acpi_gpio_resource_lookup(&lookup, info);
 797         return ret ? ERR_PTR(ret) : lookup.desc;
 798 }
 799
 800 struct gpio_desc *acpi_find_gpio(struct device *dev,
 801                                  const char *con_id,
 802                                  unsigned int idx,
 803                                  enum gpiod_flags *dflags,
 804                                  enum gpio_lookup_flags *lookupflags)
 805 {
 806         struct acpi_device *adev = ACPI_COMPANION(dev);
 807         struct acpi_gpio_info info;
 808         struct gpio_desc *desc;
 809         char propname[32];
 810         int err;
 811         int i;
 812
 813         /* Try first from _DSD */
 814         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
 815                 if (con_id) {
 816                         snprintf(propname, sizeof(propname), "%s-%s",
 817                                  con_id, gpio_suffixes[i]);
 818                 } else {
 819                         snprintf(propname, sizeof(propname), "%s",
 820                                  gpio_suffixes[i]);
 821                 }
 822
 823                 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
 824                 if (!IS_ERR(desc))
 825                         break;
 826                 if (PTR_ERR(desc) == -EPROBE_DEFER)
 827                         return ERR_CAST(desc);
 828         }
 829
 830         /* Then from plain _CRS GPIOs */
 831         if (IS_ERR(desc)) {
 832                 if (!acpi_can_fallback_to_crs(adev, con_id))
 833                         return ERR_PTR(-ENOENT);
 834
 835                 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
 836                 if (IS_ERR(desc))
 837                         return desc;
 838         }
 839
 840         if (info.gpioint &&
 841             (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
 842                 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
 843                 return ERR_PTR(-ENOENT);
 844         }
 845
 846         if (info.polarity == GPIO_ACTIVE_LOW)
 847                 *lookupflags |= GPIO_ACTIVE_LOW;
 848
 849         err = acpi_gpio_update_gpiod_flags(dflags, info.flags);
 850         if (err)
 851                 dev_dbg(dev, "Override GPIO initialization flags\n");
 852
 853         return desc;
 854 }
 855
 856 /**
 857  * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
 858  * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
 859  * @propname: Property name of the GPIO
 860  * @index: index of GpioIo/GpioInt resource (starting from %0)
 861  * @info: info pointer to fill in (optional)
 862  *
 863  * If @fwnode is an ACPI device object, call %acpi_get_gpiod_by_index() for it.
 864  * Otherwise (ie. it is a data-only non-device object), use the property-based
 865  * GPIO lookup to get to the GPIO resource with the relevant information and use
 866  * that to obtain the GPIO descriptor to return.
 867  */
 868 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
 869                                       const char *propname, int index,
 870                                       struct acpi_gpio_info *info)
 871 {
 872         struct acpi_gpio_lookup lookup;
 873         struct acpi_device *adev;
 874         int ret;
 875
 876         adev = to_acpi_device_node(fwnode);
 877         if (adev)
 878                 return acpi_get_gpiod_by_index(adev, propname, index, info);
 879
 880         if (!is_acpi_data_node(fwnode))
 881                 return ERR_PTR(-ENODEV);
 882
 883         if (!propname)
 884                 return ERR_PTR(-EINVAL);
 885
 886         memset(&lookup, 0, sizeof(lookup));
 887         lookup.index = index;
 888
 889         ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
 890         if (ret)
 891                 return ERR_PTR(ret);
 892
 893         ret = acpi_gpio_resource_lookup(&lookup, info);
 894         return ret ? ERR_PTR(ret) : lookup.desc;
 895 }
 896
 897 /**
 898  * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
 899  * @adev: pointer to a ACPI device to get IRQ from
 900  * @index: index of GpioInt resource (starting from %0)
 901  *
 902  * If the device has one or more GpioInt resources, this function can be
 903  * used to translate from the GPIO offset in the resource to the Linux IRQ
 904  * number.
 905  *
 906  * The function is idempotent, though each time it runs it will configure GPIO
 907  * pin direction according to the flags in GpioInt resource.
 908  *
 909  * Return: Linux IRQ number (> %0) on success, negative errno on failure.
 910  */
 911 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
 912 {
 913         int idx, i;
 914         unsigned int irq_flags;
 915         int ret;
 916
 917         for (i = 0, idx = 0; idx <= index; i++) {
 918                 struct acpi_gpio_info info;
 919                 struct gpio_desc *desc;
 920
 921                 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
 922
 923                 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
 924                 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
 925                         return PTR_ERR(desc);
 926
 927                 if (info.gpioint && idx++ == index) {
 928                         char label[32];
 929                         int irq;
 930
 931                         if (IS_ERR(desc))
 932                                 return PTR_ERR(desc);
 933
 934                         irq = gpiod_to_irq(desc);
 935                         if (irq < 0)
 936                                 return irq;
 937
 938                         snprintf(label, sizeof(label), "GpioInt() %d", index);
 939                         ret = gpiod_configure_flags(desc, label, 0, info.flags);
 940                         if (ret < 0)
 941                                 return ret;
 942
 943                         irq_flags = acpi_dev_get_irq_type(info.triggering,
 944                                                           info.polarity);
 945
 946                         /* Set type if specified and different than the current one */
 947                         if (irq_flags != IRQ_TYPE_NONE &&
 948                             irq_flags != irq_get_trigger_type(irq))
 949                                 irq_set_irq_type(irq, irq_flags);
 950
 951                         return irq;
 952                 }
 953
 954         }
 955         return -ENOENT;
 956 }
 957 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
 958
 959 static acpi_status
 960 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
 961                             u32 bits, u64 *value, void *handler_context,
 962                             void *region_context)
 963 {
 964         struct acpi_gpio_chip *achip = region_context;
 965         struct gpio_chip *chip = achip->chip;
 966         struct acpi_resource_gpio *agpio;
 967         struct acpi_resource *ares;
 968         int pin_index = (int)address;
 969         acpi_status status;
 970         int length;
 971         int i;
 972
 973         status = acpi_buffer_to_resource(achip->conn_info.connection,
 974                                          achip->conn_info.length, &ares);
 975         if (ACPI_FAILURE(status))
 976                 return status;
 977
 978         if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
 979                 ACPI_FREE(ares);
 980                 return AE_BAD_PARAMETER;
 981         }
 982
 983         agpio = &ares->data.gpio;
 984
 985         if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
 986             function == ACPI_WRITE)) {
 987                 ACPI_FREE(ares);
 988                 return AE_BAD_PARAMETER;
 989         }
 990
 991         length = min(agpio->pin_table_length, (u16)(pin_index + bits));
 992         for (i = pin_index; i < length; ++i) {
 993                 int pin = agpio->pin_table[i];
 994                 struct acpi_gpio_connection *conn;
 995                 struct gpio_desc *desc;
 996                 bool found;
 997
 998                 pin = acpi_gpiochip_pin_to_gpio_offset(chip->gpiodev, pin);
 999                 if (pin < 0) {
1000                         status = AE_BAD_PARAMETER;
1001                         goto out;
1002                 }
1003
1004                 mutex_lock(&achip->conn_lock);
1005
1006                 found = false;
1007                 list_for_each_entry(conn, &achip->conns, node) {
1008                         if (conn->pin == pin) {
1009                                 found = true;
1010                                 desc = conn->desc;
1011                                 break;
1012                         }
1013                 }
1014
1015                 /*
1016                  * The same GPIO can be shared between operation region and
1017                  * event but only if the access here is ACPI_READ. In that
1018                  * case we "borrow" the event GPIO instead.
1019                  */
1020                 if (!found && agpio->sharable == ACPI_SHARED &&
1021                      function == ACPI_READ) {
1022                         struct acpi_gpio_event *event;
1023
1024                         list_for_each_entry(event, &achip->events, node) {
1025                                 if (event->pin == pin) {
1026                                         desc = event->desc;
1027                                         found = true;
1028                                         break;
1029                                 }
1030                         }
1031                 }
1032
1033                 if (!found) {
1034                         enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio);
1035                         const char *label = "ACPI:OpRegion";
1036                         int err;
1037
1038                         desc = gpiochip_request_own_desc(chip, pin, label);
1039                         if (IS_ERR(desc)) {
1040                                 status = AE_ERROR;
1041                                 mutex_unlock(&achip->conn_lock);
1042                                 goto out;
1043                         }
1044
1045                         err = gpiod_configure_flags(desc, label, 0, flags);
1046                         if (err < 0) {
1047                                 status = AE_NOT_CONFIGURED;
1048                                 gpiochip_free_own_desc(desc);
1049                                 mutex_unlock(&achip->conn_lock);
1050                                 goto out;
1051                         }
1052
1053                         conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1054                         if (!conn) {
1055                                 status = AE_NO_MEMORY;
1056                                 gpiochip_free_own_desc(desc);
1057                                 mutex_unlock(&achip->conn_lock);
1058                                 goto out;
1059                         }
1060
1061                         conn->pin = pin;
1062                         conn->desc = desc;
1063                         list_add_tail(&conn->node, &achip->conns);
1064                 }
1065
1066                 mutex_unlock(&achip->conn_lock);
1067
1068                 if (function == ACPI_WRITE)
1069                         gpiod_set_raw_value_cansleep(desc,
1070                                                      !!((1 << i) & *value));
1071                 else
1072                         *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1073         }
1074
1075 out:
1076         ACPI_FREE(ares);
1077         return status;
1078 }
1079
1080 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1081 {
1082         struct gpio_chip *chip = achip->chip;
1083         acpi_handle handle = ACPI_HANDLE(chip->parent);
1084         acpi_status status;
1085
1086         INIT_LIST_HEAD(&achip->conns);
1087         mutex_init(&achip->conn_lock);
1088         status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1089                                                     acpi_gpio_adr_space_handler,
1090                                                     NULL, achip);
1091         if (ACPI_FAILURE(status))
1092                 dev_err(chip->parent,
1093                         "Failed to install GPIO OpRegion handler\n");
1094 }
1095
1096 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1097 {
1098         struct gpio_chip *chip = achip->chip;
1099         acpi_handle handle = ACPI_HANDLE(chip->parent);
1100         struct acpi_gpio_connection *conn, *tmp;
1101         acpi_status status;
1102
1103         status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1104                                                    acpi_gpio_adr_space_handler);
1105         if (ACPI_FAILURE(status)) {
1106                 dev_err(chip->parent,
1107                         "Failed to remove GPIO OpRegion handler\n");
1108                 return;
1109         }
1110
1111         list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1112                 gpiochip_free_own_desc(conn->desc);
1113                 list_del(&conn->node);
1114                 kfree(conn);
1115         }
1116 }
1117
1118 static struct gpio_desc *acpi_gpiochip_parse_own_gpio(
1119         struct acpi_gpio_chip *achip, struct fwnode_handle *fwnode,
1120         const char **name, unsigned int *lflags, unsigned int *dflags)
1121 {
1122         struct gpio_chip *chip = achip->chip;
1123         struct gpio_desc *desc;
1124         u32 gpios[2];
1125         int ret;
1126
1127         *lflags = 0;
1128         *dflags = 0;
1129         *name = NULL;
1130
1131         ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1132                                              ARRAY_SIZE(gpios));
1133         if (ret < 0)
1134                 return ERR_PTR(ret);
1135
1136         ret = acpi_gpiochip_pin_to_gpio_offset(chip->gpiodev, gpios[0]);
1137         if (ret < 0)
1138                 return ERR_PTR(ret);
1139
1140         desc = gpiochip_get_desc(chip, ret);
1141         if (IS_ERR(desc))
1142                 return desc;
1143
1144         if (gpios[1])
1145                 *lflags |= GPIO_ACTIVE_LOW;
1146
1147         if (fwnode_property_present(fwnode, "input"))
1148                 *dflags |= GPIOD_IN;
1149         else if (fwnode_property_present(fwnode, "output-low"))
1150                 *dflags |= GPIOD_OUT_LOW;
1151         else if (fwnode_property_present(fwnode, "output-high"))
1152                 *dflags |= GPIOD_OUT_HIGH;
1153         else
1154                 return ERR_PTR(-EINVAL);
1155
1156         fwnode_property_read_string(fwnode, "line-name", name);
1157
1158         return desc;
1159 }
1160
1161 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1162 {
1163         struct gpio_chip *chip = achip->chip;
1164         struct fwnode_handle *fwnode;
1165
1166         device_for_each_child_node(chip->parent, fwnode) {
1167                 unsigned int lflags, dflags;
1168                 struct gpio_desc *desc;
1169                 const char *name;
1170                 int ret;
1171
1172                 if (!fwnode_property_present(fwnode, "gpio-hog"))
1173                         continue;
1174
1175                 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1176                                                     &lflags, &dflags);
1177                 if (IS_ERR(desc))
1178                         continue;
1179
1180                 ret = gpiod_hog(desc, name, lflags, dflags);
1181                 if (ret) {
1182                         dev_err(chip->parent, "Failed to hog GPIO\n");
1183                         fwnode_handle_put(fwnode);
1184                         return;
1185                 }
1186         }
1187 }
1188
1189 void acpi_gpiochip_add(struct gpio_chip *chip)
1190 {
1191         struct acpi_gpio_chip *acpi_gpio;
1192         acpi_handle handle;
1193         acpi_status status;
1194
1195         if (!chip || !chip->parent)
1196                 return;
1197
1198         handle = ACPI_HANDLE(chip->parent);
1199         if (!handle)
1200                 return;
1201
1202         acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1203         if (!acpi_gpio) {
1204                 dev_err(chip->parent,
1205                         "Failed to allocate memory for ACPI GPIO chip\n");
1206                 return;
1207         }
1208
1209         acpi_gpio->chip = chip;
1210         INIT_LIST_HEAD(&acpi_gpio->events);
1211         INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1212
1213         status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1214         if (ACPI_FAILURE(status)) {
1215                 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1216                 kfree(acpi_gpio);
1217                 return;
1218         }
1219
1220         if (!chip->names)
1221                 devprop_gpiochip_set_names(chip, dev_fwnode(chip->parent));
1222
1223         acpi_gpiochip_request_regions(acpi_gpio);
1224         acpi_gpiochip_scan_gpios(acpi_gpio);
1225         acpi_walk_dep_device_list(handle);
1226 }
1227
1228 void acpi_gpiochip_remove(struct gpio_chip *chip)
1229 {
1230         struct acpi_gpio_chip *acpi_gpio;
1231         acpi_handle handle;
1232         acpi_status status;
1233
1234         if (!chip || !chip->parent)
1235                 return;
1236
1237         handle = ACPI_HANDLE(chip->parent);
1238         if (!handle)
1239                 return;
1240
1241         status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1242         if (ACPI_FAILURE(status)) {
1243                 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1244                 return;
1245         }
1246
1247         acpi_gpiochip_free_regions(acpi_gpio);
1248
1249         acpi_detach_data(handle, acpi_gpio_chip_dh);
1250         kfree(acpi_gpio);
1251 }
1252
1253 static int acpi_gpio_package_count(const union acpi_object *obj)
1254 {
1255         const union acpi_object *element = obj->package.elements;
1256         const union acpi_object *end = element + obj->package.count;
1257         unsigned int count = 0;
1258
1259         while (element < end) {
1260                 switch (element->type) {
1261                 case ACPI_TYPE_LOCAL_REFERENCE:
1262                         element += 3;
1263                         /* Fallthrough */
1264                 case ACPI_TYPE_INTEGER:
1265                         element++;
1266                         count++;
1267                         break;
1268
1269                 default:
1270                         return -EPROTO;
1271                 }
1272         }
1273
1274         return count;
1275 }
1276
1277 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1278 {
1279         unsigned int *count = data;
1280
1281         if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1282                 *count += ares->data.gpio.pin_table_length;
1283
1284         return 1;
1285 }
1286
1287 /**
1288  * acpi_gpio_count - return the number of GPIOs associated with a
1289  *              device / function or -ENOENT if no GPIO has been
1290  *              assigned to the requested function.
1291  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
1292  * @con_id:     function within the GPIO consumer
1293  */
1294 int acpi_gpio_count(struct device *dev, const char *con_id)
1295 {
1296         struct acpi_device *adev = ACPI_COMPANION(dev);
1297         const union acpi_object *obj;
1298         const struct acpi_gpio_mapping *gm;
1299         int count = -ENOENT;
1300         int ret;
1301         char propname[32];
1302         unsigned int i;
1303
1304         /* Try first from _DSD */
1305         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1306                 if (con_id)
1307                         snprintf(propname, sizeof(propname), "%s-%s",
1308                                  con_id, gpio_suffixes[i]);
1309                 else
1310                         snprintf(propname, sizeof(propname), "%s",
1311                                  gpio_suffixes[i]);
1312
1313                 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1314                                             &obj);
1315                 if (ret == 0) {
1316                         if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1317                                 count = 1;
1318                         else if (obj->type == ACPI_TYPE_PACKAGE)
1319                                 count = acpi_gpio_package_count(obj);
1320                 } else if (adev->driver_gpios) {
1321                         for (gm = adev->driver_gpios; gm->name; gm++)
1322                                 if (strcmp(propname, gm->name) == 0) {
1323                                         count = gm->size;
1324                                         break;
1325                                 }
1326                 }
1327                 if (count > 0)
1328                         break;
1329         }
1330
1331         /* Then from plain _CRS GPIOs */
1332         if (count < 0) {
1333                 struct list_head resource_list;
1334                 unsigned int crs_count = 0;
1335
1336                 if (!acpi_can_fallback_to_crs(adev, con_id))
1337                         return count;
1338
1339                 INIT_LIST_HEAD(&resource_list);
1340                 acpi_dev_get_resources(adev, &resource_list,
1341                                        acpi_find_gpio_count, &crs_count);
1342                 acpi_dev_free_resource_list(&resource_list);
1343                 if (crs_count > 0)
1344                         count = crs_count;
1345         }
1346         return count ? count : -ENOENT;
1347 }
1348
1349 bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id)
1350 {
1351         /* Never allow fallback if the device has properties */
1352         if (adev->data.properties || adev->driver_gpios)
1353                 return false;
1354
1355         return con_id == NULL;
1356 }
1357
1358 /* Run deferred acpi_gpiochip_request_irqs() */
1359 static int acpi_gpio_handle_deferred_request_irqs(void)
1360 {
1361         struct acpi_gpio_chip *acpi_gpio, *tmp;
1362
1363         mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1364         list_for_each_entry_safe(acpi_gpio, tmp,
1365                                  &acpi_gpio_deferred_req_irqs_list,
1366                                  deferred_req_irqs_list_entry)
1367                 acpi_gpiochip_request_irqs(acpi_gpio);
1368
1369         acpi_gpio_deferred_req_irqs_done = true;
1370         mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1371
1372         return 0;
1373 }
1374 /* We must use _sync so that this runs after the first deferred_probe run */
1375 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1376
1377 static const struct dmi_system_id gpiolib_acpi_quirks[] = {
1378         {
1379                 /*
1380                  * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1381                  * a non existing micro-USB-B connector which puts the HDMI
1382                  * DDC pins in GPIO mode, breaking HDMI support.
1383                  */
1384                 .matches = {
1385                         DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1386                         DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1387                 },
1388                 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1389                         .no_edge_events_on_boot = true,
1390                 },
1391         },
1392         {
1393                 /*
1394                  * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1395                  * instead of controlling the actual micro-USB-B turns the 5V
1396                  * boost for its USB-A connector off. The actual micro-USB-B
1397                  * connector is wired for charging only.
1398                  */
1399                 .matches = {
1400                         DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1401                         DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1402                 },
1403                 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1404                         .no_edge_events_on_boot = true,
1405                 },
1406         },
1407         {
1408                 /*
1409                  * The Dell Venue 10 Pro 5055, with Bay Trail SoC + TI PMIC uses an
1410                  * external embedded-controller connected via I2C + an ACPI GPIO
1411                  * event handler on INT33FFC:02 pin 12, causing spurious wakeups.
1412                  */
1413                 .matches = {
1414                         DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
1415                         DMI_MATCH(DMI_PRODUCT_NAME, "Venue 10 Pro 5055"),
1416                 },
1417                 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1418                         .ignore_wake = "INT33FC:02@12",
1419                 },
1420         },
1421         {
1422                 /*
1423                  * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1424                  * external embedded-controller connected via I2C + an ACPI GPIO
1425                  * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1426                  * When suspending by closing the LID, the power to the USB
1427                  * keyboard is turned off, causing INT0002 ACPI events to
1428                  * trigger once the XHCI controller notices the keyboard is
1429                  * gone. So INT0002 events cause spurious wakeups too. Ignoring
1430                  * EC wakes breaks wakeup when opening the lid, the user needs
1431                  * to press the power-button to wakeup the system. The
1432                  * alternative is suspend simply not working, which is worse.
1433                  */
1434                 .matches = {
1435                         DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1436                         DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1437                 },
1438                 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1439                         .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1440                 },
1441         },
1442         {
1443                 /*
1444                  * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1445                  * external embedded-controller connected via I2C + an ACPI GPIO
1446                  * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1447                  */
1448                 .matches = {
1449                         DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1450                         DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1451                         DMI_MATCH(DMI_BOARD_NAME, "815D"),
1452                 },
1453                 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1454                         .ignore_wake = "INT33FC:02@28",
1455                 },
1456         },
1457         {
1458                 /*
1459                  * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1460                  * external embedded-controller connected via I2C + an ACPI GPIO
1461                  * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1462                  */
1463                 .matches = {
1464                         DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1465                         DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1466                         DMI_MATCH(DMI_BOARD_NAME, "813E"),
1467                 },
1468                 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1469                         .ignore_wake = "INT33FF:01@0",
1470                 },
1471         },
1472         {} /* Terminating entry */
1473 };
1474
1475 static int acpi_gpio_setup_params(void)
1476 {
1477         const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1478         const struct dmi_system_id *id;
1479
1480         id = dmi_first_match(gpiolib_acpi_quirks);
1481         if (id)
1482                 quirk = id->driver_data;
1483
1484         if (run_edge_events_on_boot < 0) {
1485                 if (quirk && quirk->no_edge_events_on_boot)
1486                         run_edge_events_on_boot = 0;
1487                 else
1488                         run_edge_events_on_boot = 1;
1489         }
1490
1491         if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1492                 ignore_wake = quirk->ignore_wake;
1493
1494         return 0;
1495 }
1496
1497 /* Directly after dmi_setup() which runs as core_initcall() */
1498 postcore_initcall(acpi_gpio_setup_params);