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