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