drivers/gpio/gpiolib-acpi.c

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