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