drivers/gpio/gpiolib-acpi.c

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