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