drivers/gpio/gpiolib-acpi.c

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