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->dev)
  55                 return false;
  56
  57         return ACPI_HANDLE(gc->dev) == 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 contigous 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  * Returns GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
 118  * error value
 119  */
 120
 121 static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
 122 {
 123         struct gpio_chip *chip;
 124         acpi_handle handle;
 125         acpi_status status;
 126         int offset;
 127
 128         status = acpi_get_handle(NULL, path, &handle);
 129         if (ACPI_FAILURE(status))
 130                 return ERR_PTR(-ENODEV);
 131
 132         chip = gpiochip_find(handle, acpi_gpiochip_find);
 133         if (!chip)
 134                 return ERR_PTR(-ENODEV);
 135
 136         offset = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
 137         if (offset < 0)
 138                 return ERR_PTR(offset);
 139
 140         return gpiochip_get_desc(chip, offset);
 141 }
 142
 143 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
 144 {
 145         struct acpi_gpio_event *event = data;
 146
 147         acpi_evaluate_object(event->handle, NULL, NULL, NULL);
 148
 149         return IRQ_HANDLED;
 150 }
 151
 152 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
 153 {
 154         struct acpi_gpio_event *event = data;
 155
 156         acpi_execute_simple_method(event->handle, NULL, event->pin);
 157
 158         return IRQ_HANDLED;
 159 }
 160
 161 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
 162 {
 163         /* The address of this function is used as a key. */
 164 }
 165
 166 static acpi_status acpi_gpiochip_request_interrupt(struct acpi_resource *ares,
 167                                                    void *context)
 168 {
 169         struct acpi_gpio_chip *acpi_gpio = context;
 170         struct gpio_chip *chip = acpi_gpio->chip;
 171         struct acpi_resource_gpio *agpio;
 172         acpi_handle handle, evt_handle;
 173         struct acpi_gpio_event *event;
 174         irq_handler_t handler = NULL;
 175         struct gpio_desc *desc;
 176         unsigned long irqflags;
 177         int ret, pin, irq;
 178
 179         if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
 180                 return AE_OK;
 181
 182         agpio = &ares->data.gpio;
 183         if (agpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
 184                 return AE_OK;
 185
 186         handle = ACPI_HANDLE(chip->dev);
 187         pin = agpio->pin_table[0];
 188
 189         if (pin <= 255) {
 190                 char ev_name[5];
 191                 sprintf(ev_name, "_%c%02X",
 192                         agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
 193                         pin);
 194                 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
 195                         handler = acpi_gpio_irq_handler;
 196         }
 197         if (!handler) {
 198                 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
 199                         handler = acpi_gpio_irq_handler_evt;
 200         }
 201         if (!handler)
 202                 return AE_BAD_PARAMETER;
 203
 204         desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event");
 205         if (IS_ERR(desc)) {
 206                 dev_err(chip->dev, "Failed to request GPIO\n");
 207                 return AE_ERROR;
 208         }
 209
 210         gpiod_direction_input(desc);
 211
 212         ret = gpio_lock_as_irq(chip, pin);
 213         if (ret) {
 214                 dev_err(chip->dev, "Failed to lock GPIO as interrupt\n");
 215                 goto fail_free_desc;
 216         }
 217
 218         irq = gpiod_to_irq(desc);
 219         if (irq < 0) {
 220                 dev_err(chip->dev, "Failed to translate GPIO to IRQ\n");
 221                 goto fail_unlock_irq;
 222         }
 223
 224         irqflags = IRQF_ONESHOT;
 225         if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
 226                 if (agpio->polarity == ACPI_ACTIVE_HIGH)
 227                         irqflags |= IRQF_TRIGGER_HIGH;
 228                 else
 229                         irqflags |= IRQF_TRIGGER_LOW;
 230         } else {
 231                 switch (agpio->polarity) {
 232                 case ACPI_ACTIVE_HIGH:
 233                         irqflags |= IRQF_TRIGGER_RISING;
 234                         break;
 235                 case ACPI_ACTIVE_LOW:
 236                         irqflags |= IRQF_TRIGGER_FALLING;
 237                         break;
 238                 default:
 239                         irqflags |= IRQF_TRIGGER_RISING |
 240                                     IRQF_TRIGGER_FALLING;
 241                         break;
 242                 }
 243         }
 244
 245         event = kzalloc(sizeof(*event), GFP_KERNEL);
 246         if (!event)
 247                 goto fail_unlock_irq;
 248
 249         event->handle = evt_handle;
 250         event->irq = irq;
 251         event->pin = pin;
 252         event->desc = desc;
 253
 254         ret = request_threaded_irq(event->irq, NULL, handler, irqflags,
 255                                    "ACPI:Event", event);
 256         if (ret) {
 257                 dev_err(chip->dev, "Failed to setup interrupt handler for %d\n",
 258                         event->irq);
 259                 goto fail_free_event;
 260         }
 261
 262         list_add_tail(&event->node, &acpi_gpio->events);
 263         return AE_OK;
 264
 265 fail_free_event:
 266         kfree(event);
 267 fail_unlock_irq:
 268         gpio_unlock_as_irq(chip, pin);
 269 fail_free_desc:
 270         gpiochip_free_own_desc(desc);
 271
 272         return AE_ERROR;
 273 }
 274
 275 /**
 276  * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
 277  * @chip:      GPIO chip
 278  *
 279  * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
 280  * handled by ACPI event methods which need to be called from the GPIO
 281  * chip's interrupt handler. acpi_gpiochip_request_interrupts finds out which
 282  * gpio pins have acpi event methods and assigns interrupt handlers that calls
 283  * the acpi event methods for those pins.
 284  */
 285 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
 286 {
 287         struct acpi_gpio_chip *acpi_gpio;
 288         acpi_handle handle;
 289         acpi_status status;
 290
 291         if (!chip->dev || !chip->to_irq)
 292                 return;
 293
 294         handle = ACPI_HANDLE(chip->dev);
 295         if (!handle)
 296                 return;
 297
 298         status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
 299         if (ACPI_FAILURE(status))
 300                 return;
 301
 302         INIT_LIST_HEAD(&acpi_gpio->events);
 303         acpi_walk_resources(ACPI_HANDLE(chip->dev), "_AEI",
 304                             acpi_gpiochip_request_interrupt, acpi_gpio);
 305 }
 306
 307 /**
 308  * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
 309  * @chip:      GPIO chip
 310  *
 311  * Free interrupts associated with GPIO ACPI event method for the given
 312  * GPIO chip.
 313  */
 314 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
 315 {
 316         struct acpi_gpio_chip *acpi_gpio;
 317         struct acpi_gpio_event *event, *ep;
 318         acpi_handle handle;
 319         acpi_status status;
 320
 321         if (!chip->dev || !chip->to_irq)
 322                 return;
 323
 324         handle = ACPI_HANDLE(chip->dev);
 325         if (!handle)
 326                 return;
 327
 328         status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
 329         if (ACPI_FAILURE(status))
 330                 return;
 331
 332         list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
 333                 struct gpio_desc *desc;
 334
 335                 free_irq(event->irq, event);
 336                 desc = event->desc;
 337                 if (WARN_ON(IS_ERR(desc)))
 338                         continue;
 339                 gpio_unlock_as_irq(chip, event->pin);
 340                 gpiochip_free_own_desc(desc);
 341                 list_del(&event->node);
 342                 kfree(event);
 343         }
 344 }
 345
 346 struct acpi_gpio_lookup {
 347         struct acpi_gpio_info info;
 348         int index;
 349         struct gpio_desc *desc;
 350         int n;
 351 };
 352
 353 static int acpi_find_gpio(struct acpi_resource *ares, void *data)
 354 {
 355         struct acpi_gpio_lookup *lookup = data;
 356
 357         if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
 358                 return 1;
 359
 360         if (lookup->n++ == lookup->index && !lookup->desc) {
 361                 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
 362
 363                 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
 364                                               agpio->pin_table[0]);
 365                 lookup->info.gpioint =
 366                         agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
 367                 lookup->info.active_low =
 368                         agpio->polarity == ACPI_ACTIVE_LOW;
 369         }
 370
 371         return 1;
 372 }
 373
 374 /**
 375  * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
 376  * @dev: pointer to a device to get GPIO from
 377  * @index: index of GpioIo/GpioInt resource (starting from %0)
 378  * @info: info pointer to fill in (optional)
 379  *
 380  * Function goes through ACPI resources for @dev and based on @index looks
 381  * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
 382  * and returns it. @index matches GpioIo/GpioInt resources only so if there
 383  * are total %3 GPIO resources, the index goes from %0 to %2.
 384  *
 385  * If the GPIO cannot be translated or there is an error an ERR_PTR is
 386  * returned.
 387  *
 388  * Note: if the GPIO resource has multiple entries in the pin list, this
 389  * function only returns the first.
 390  */
 391 struct gpio_desc *acpi_get_gpiod_by_index(struct device *dev, int index,
 392                                           struct acpi_gpio_info *info)
 393 {
 394         struct acpi_gpio_lookup lookup;
 395         struct list_head resource_list;
 396         struct acpi_device *adev;
 397         acpi_handle handle;
 398         int ret;
 399
 400         if (!dev)
 401                 return ERR_PTR(-EINVAL);
 402
 403         handle = ACPI_HANDLE(dev);
 404         if (!handle || acpi_bus_get_device(handle, &adev))
 405                 return ERR_PTR(-ENODEV);
 406
 407         memset(&lookup, 0, sizeof(lookup));
 408         lookup.index = index;
 409
 410         INIT_LIST_HEAD(&resource_list);
 411         ret = acpi_dev_get_resources(adev, &resource_list, acpi_find_gpio,
 412                                      &lookup);
 413         if (ret < 0)
 414                 return ERR_PTR(ret);
 415
 416         acpi_dev_free_resource_list(&resource_list);
 417
 418         if (lookup.desc && info)
 419                 *info = lookup.info;
 420
 421         return lookup.desc ? lookup.desc : ERR_PTR(-ENOENT);
 422 }
 423
 424 static acpi_status
 425 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
 426                             u32 bits, u64 *value, void *handler_context,
 427                             void *region_context)
 428 {
 429         struct acpi_gpio_chip *achip = region_context;
 430         struct gpio_chip *chip = achip->chip;
 431         struct acpi_resource_gpio *agpio;
 432         struct acpi_resource *ares;
 433         int pin_index = (int)address;
 434         acpi_status status;
 435         bool pull_up;
 436         int length;
 437         int i;
 438
 439         status = acpi_buffer_to_resource(achip->conn_info.connection,
 440                                          achip->conn_info.length, &ares);
 441         if (ACPI_FAILURE(status))
 442                 return status;
 443
 444         if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
 445                 ACPI_FREE(ares);
 446                 return AE_BAD_PARAMETER;
 447         }
 448
 449         agpio = &ares->data.gpio;
 450         pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;
 451
 452         if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
 453             function == ACPI_WRITE)) {
 454                 ACPI_FREE(ares);
 455                 return AE_BAD_PARAMETER;
 456         }
 457
 458         length = min(agpio->pin_table_length, (u16)(pin_index + bits));
 459         for (i = pin_index; i < length; ++i) {
 460                 unsigned pin = agpio->pin_table[i];
 461                 struct acpi_gpio_connection *conn;
 462                 struct gpio_desc *desc;
 463                 bool found;
 464
 465                 mutex_lock(&achip->conn_lock);
 466
 467                 found = false;
 468                 list_for_each_entry(conn, &achip->conns, node) {
 469                         if (conn->pin == pin) {
 470                                 found = true;
 471                                 desc = conn->desc;
 472                                 break;
 473                         }
 474                 }
 475                 if (!found) {
 476                         desc = gpiochip_request_own_desc(chip, pin,
 477                                                          "ACPI:OpRegion");
 478                         if (IS_ERR(desc)) {
 479                                 status = AE_ERROR;
 480                                 mutex_unlock(&achip->conn_lock);
 481                                 goto out;
 482                         }
 483
 484                         switch (agpio->io_restriction) {
 485                         case ACPI_IO_RESTRICT_INPUT:
 486                                 gpiod_direction_input(desc);
 487                                 break;
 488                         case ACPI_IO_RESTRICT_OUTPUT:
 489                                 /*
 490                                  * ACPI GPIO resources don't contain an
 491                                  * initial value for the GPIO. Therefore we
 492                                  * deduce that value from the pull field
 493                                  * instead. If the pin is pulled up we
 494                                  * assume default to be high, otherwise
 495                                  * low.
 496                                  */
 497                                 gpiod_direction_output(desc, pull_up);
 498                                 break;
 499                         default:
 500                                 /*
 501                                  * Assume that the BIOS has configured the
 502                                  * direction and pull accordingly.
 503                                  */
 504                                 break;
 505                         }
 506
 507                         conn = kzalloc(sizeof(*conn), GFP_KERNEL);
 508                         if (!conn) {
 509                                 status = AE_NO_MEMORY;
 510                                 gpiochip_free_own_desc(desc);
 511                                 mutex_unlock(&achip->conn_lock);
 512                                 goto out;
 513                         }
 514
 515                         conn->pin = pin;
 516                         conn->desc = desc;
 517                         list_add_tail(&conn->node, &achip->conns);
 518                 }
 519
 520                 mutex_unlock(&achip->conn_lock);
 521
 522                 if (function == ACPI_WRITE)
 523                         gpiod_set_raw_value_cansleep(desc,
 524                                                      !!((1 << i) & *value));
 525                 else
 526                         *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
 527         }
 528
 529 out:
 530         ACPI_FREE(ares);
 531         return status;
 532 }
 533
 534 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
 535 {
 536         struct gpio_chip *chip = achip->chip;
 537         acpi_handle handle = ACPI_HANDLE(chip->dev);
 538         acpi_status status;
 539
 540         INIT_LIST_HEAD(&achip->conns);
 541         mutex_init(&achip->conn_lock);
 542         status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
 543                                                     acpi_gpio_adr_space_handler,
 544                                                     NULL, achip);
 545         if (ACPI_FAILURE(status))
 546                 dev_err(chip->dev, "Failed to install GPIO OpRegion handler\n");
 547 }
 548
 549 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
 550 {
 551         struct gpio_chip *chip = achip->chip;
 552         acpi_handle handle = ACPI_HANDLE(chip->dev);
 553         struct acpi_gpio_connection *conn, *tmp;
 554         acpi_status status;
 555
 556         status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
 557                                                    acpi_gpio_adr_space_handler);
 558         if (ACPI_FAILURE(status)) {
 559                 dev_err(chip->dev, "Failed to remove GPIO OpRegion handler\n");
 560                 return;
 561         }
 562
 563         list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
 564                 gpiochip_free_own_desc(conn->desc);
 565                 list_del(&conn->node);
 566                 kfree(conn);
 567         }
 568 }
 569
 570 void acpi_gpiochip_add(struct gpio_chip *chip)
 571 {
 572         struct acpi_gpio_chip *acpi_gpio;
 573         acpi_handle handle;
 574         acpi_status status;
 575
 576         if (!chip || !chip->dev)
 577                 return;
 578
 579         handle = ACPI_HANDLE(chip->dev);
 580         if (!handle)
 581                 return;
 582
 583         acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
 584         if (!acpi_gpio) {
 585                 dev_err(chip->dev,
 586                         "Failed to allocate memory for ACPI GPIO chip\n");
 587                 return;
 588         }
 589
 590         acpi_gpio->chip = chip;
 591
 592         status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
 593         if (ACPI_FAILURE(status)) {
 594                 dev_err(chip->dev, "Failed to attach ACPI GPIO chip\n");
 595                 kfree(acpi_gpio);
 596                 return;
 597         }
 598
 599         acpi_gpiochip_request_regions(acpi_gpio);
 600 }
 601
 602 void acpi_gpiochip_remove(struct gpio_chip *chip)
 603 {
 604         struct acpi_gpio_chip *acpi_gpio;
 605         acpi_handle handle;
 606         acpi_status status;
 607
 608         if (!chip || !chip->dev)
 609                 return;
 610
 611         handle = ACPI_HANDLE(chip->dev);
 612         if (!handle)
 613                 return;
 614
 615         status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
 616         if (ACPI_FAILURE(status)) {
 617                 dev_warn(chip->dev, "Failed to retrieve ACPI GPIO chip\n");
 618                 return;
 619         }
 620
 621         acpi_gpiochip_free_regions(acpi_gpio);
 622
 623         acpi_detach_data(handle, acpi_gpio_chip_dh);
 624         kfree(acpi_gpio);
 625 }