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