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                 if (event->irq_requested) {
 361                         if (event->irq_is_wake)
 362                                 disable_irq_wake(event->irq);
 363
 364                         free_irq(event->irq, event);
 365                 }
 366
 367                 gpiochip_unlock_as_irq(chip, event->pin);
 368                 gpiochip_free_own_desc(event->desc);
 369                 list_del(&event->node);
 370                 kfree(event);
 371         }
 372 }
 373 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
 374
 375 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
 376                               const struct acpi_gpio_mapping *gpios)
 377 {
 378         if (adev && gpios) {
 379                 adev->driver_gpios = gpios;
 380                 return 0;
 381         }
 382         return -EINVAL;
 383 }
 384 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
 385
 386 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
 387 {
 388         acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
 389 }
 390
 391 int devm_acpi_dev_add_driver_gpios(struct device *dev,
 392                                    const struct acpi_gpio_mapping *gpios)
 393 {
 394         void *res;
 395         int ret;
 396
 397         res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
 398         if (!res)
 399                 return -ENOMEM;
 400
 401         ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
 402         if (ret) {
 403                 devres_free(res);
 404                 return ret;
 405         }
 406         devres_add(dev, res);
 407         return 0;
 408 }
 409 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
 410
 411 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
 412 {
 413         WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
 414 }
 415 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
 416
 417 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
 418                                       const char *name, int index,
 419                                       struct fwnode_reference_args *args,
 420                                       unsigned int *quirks)
 421 {
 422         const struct acpi_gpio_mapping *gm;
 423
 424         if (!adev->driver_gpios)
 425                 return false;
 426
 427         for (gm = adev->driver_gpios; gm->name; gm++)
 428                 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
 429                         const struct acpi_gpio_params *par = gm->data + index;
 430
 431                         args->fwnode = acpi_fwnode_handle(adev);
 432                         args->args[0] = par->crs_entry_index;
 433                         args->args[1] = par->line_index;
 434                         args->args[2] = par->active_low;
 435                         args->nargs = 3;
 436
 437                         *quirks = gm->quirks;
 438                         return true;
 439                 }
 440
 441         return false;
 442 }
 443
 444 static enum gpiod_flags
 445 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio)
 446 {
 447         bool pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;
 448
 449         switch (agpio->io_restriction) {
 450         case ACPI_IO_RESTRICT_INPUT:
 451                 return GPIOD_IN;
 452         case ACPI_IO_RESTRICT_OUTPUT:
 453                 /*
 454                  * ACPI GPIO resources don't contain an initial value for the
 455                  * GPIO. Therefore we deduce that value from the pull field
 456                  * instead. If the pin is pulled up we assume default to be
 457                  * high, otherwise low.
 458                  */
 459                 return pull_up ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
 460         default:
 461                 /*
 462                  * Assume that the BIOS has configured the direction and pull
 463                  * accordingly.
 464                  */
 465                 return GPIOD_ASIS;
 466         }
 467 }
 468
 469 static int
 470 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
 471 {
 472         int ret = 0;
 473
 474         /*
 475          * Check if the BIOS has IoRestriction with explicitly set direction
 476          * and update @flags accordingly. Otherwise use whatever caller asked
 477          * for.
 478          */
 479         if (update & GPIOD_FLAGS_BIT_DIR_SET) {
 480                 enum gpiod_flags diff = *flags ^ update;
 481
 482                 /*
 483                  * Check if caller supplied incompatible GPIO initialization
 484                  * flags.
 485                  *
 486                  * Return %-EINVAL to notify that firmware has different
 487                  * settings and we are going to use them.
 488                  */
 489                 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
 490                     ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
 491                         ret = -EINVAL;
 492                 *flags = update;
 493         }
 494         return ret;
 495 }
 496
 497 int
 498 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
 499 {
 500         struct device *dev = &info->adev->dev;
 501         enum gpiod_flags old = *flags;
 502         int ret;
 503
 504         ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
 505         if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
 506                 if (ret)
 507                         dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
 508         } else {
 509                 if (ret)
 510                         dev_dbg(dev, "Override GPIO initialization flags\n");
 511                 *flags = old;
 512         }
 513
 514         return ret;
 515 }
 516
 517 struct acpi_gpio_lookup {
 518         struct acpi_gpio_info info;
 519         int index;
 520         int pin_index;
 521         bool active_low;
 522         struct gpio_desc *desc;
 523         int n;
 524 };
 525
 526 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
 527 {
 528         struct acpi_gpio_lookup *lookup = data;
 529
 530         if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
 531                 return 1;
 532
 533         if (!lookup->desc) {
 534                 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
 535                 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
 536                 int pin_index;
 537
 538                 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
 539                         lookup->index++;
 540
 541                 if (lookup->n++ != lookup->index)
 542                         return 1;
 543
 544                 pin_index = lookup->pin_index;
 545                 if (pin_index >= agpio->pin_table_length)
 546                         return 1;
 547
 548                 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
 549                                               agpio->pin_table[pin_index]);
 550                 lookup->info.gpioint = gpioint;
 551
 552                 /*
 553                  * Polarity and triggering are only specified for GpioInt
 554                  * resource.
 555                  * Note: we expect here:
 556                  * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
 557                  * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
 558                  */
 559                 if (lookup->info.gpioint) {
 560                         lookup->info.flags = GPIOD_IN;
 561                         lookup->info.polarity = agpio->polarity;
 562                         lookup->info.triggering = agpio->triggering;
 563                 } else {
 564                         lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio);
 565                         lookup->info.polarity = lookup->active_low;
 566                 }
 567         }
 568
 569         return 1;
 570 }
 571
 572 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
 573                                      struct acpi_gpio_info *info)
 574 {
 575         struct acpi_device *adev = lookup->info.adev;
 576         struct list_head res_list;
 577         int ret;
 578
 579         INIT_LIST_HEAD(&res_list);
 580
 581         ret = acpi_dev_get_resources(adev, &res_list,
 582                                      acpi_populate_gpio_lookup,
 583                                      lookup);
 584         if (ret < 0)
 585                 return ret;
 586
 587         acpi_dev_free_resource_list(&res_list);
 588
 589         if (!lookup->desc)
 590                 return -ENOENT;
 591
 592         if (info)
 593                 *info = lookup->info;
 594         return 0;
 595 }
 596
 597 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
 598                                      const char *propname, int index,
 599                                      struct acpi_gpio_lookup *lookup)
 600 {
 601         struct fwnode_reference_args args;
 602         unsigned int quirks = 0;
 603         int ret;
 604
 605         memset(&args, 0, sizeof(args));
 606         ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
 607                                                  &args);
 608         if (ret) {
 609                 struct acpi_device *adev = to_acpi_device_node(fwnode);
 610
 611                 if (!adev)
 612                         return ret;
 613
 614                 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
 615                                                &quirks))
 616                         return ret;
 617         }
 618         /*
 619          * The property was found and resolved, so need to lookup the GPIO based
 620          * on returned args.
 621          */
 622         if (!to_acpi_device_node(args.fwnode))
 623                 return -EINVAL;
 624         if (args.nargs != 3)
 625                 return -EPROTO;
 626
 627         lookup->index = args.args[0];
 628         lookup->pin_index = args.args[1];
 629         lookup->active_low = !!args.args[2];
 630
 631         lookup->info.adev = to_acpi_device_node(args.fwnode);
 632         lookup->info.quirks = quirks;
 633
 634         return 0;
 635 }
 636
 637 /**
 638  * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
 639  * @adev: pointer to a ACPI device to get GPIO from
 640  * @propname: Property name of the GPIO (optional)
 641  * @index: index of GpioIo/GpioInt resource (starting from %0)
 642  * @info: info pointer to fill in (optional)
 643  *
 644  * Function goes through ACPI resources for @adev and based on @index looks
 645  * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
 646  * and returns it. @index matches GpioIo/GpioInt resources only so if there
 647  * are total %3 GPIO resources, the index goes from %0 to %2.
 648  *
 649  * If @propname is specified the GPIO is looked using device property. In
 650  * that case @index is used to select the GPIO entry in the property value
 651  * (in case of multiple).
 652  *
 653  * If the GPIO cannot be translated or there is an error an ERR_PTR is
 654  * returned.
 655  *
 656  * Note: if the GPIO resource has multiple entries in the pin list, this
 657  * function only returns the first.
 658  */
 659 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
 660                                           const char *propname, int index,
 661                                           struct acpi_gpio_info *info)
 662 {
 663         struct acpi_gpio_lookup lookup;
 664         int ret;
 665
 666         if (!adev)
 667                 return ERR_PTR(-ENODEV);
 668
 669         memset(&lookup, 0, sizeof(lookup));
 670         lookup.index = index;
 671
 672         if (propname) {
 673                 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
 674
 675                 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
 676                                                 propname, index, &lookup);
 677                 if (ret)
 678                         return ERR_PTR(ret);
 679
 680                 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
 681                         dev_name(&lookup.info.adev->dev), lookup.index,
 682                         lookup.pin_index, lookup.active_low);
 683         } else {
 684                 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
 685                 lookup.info.adev = adev;
 686         }
 687
 688         ret = acpi_gpio_resource_lookup(&lookup, info);
 689         return ret ? ERR_PTR(ret) : lookup.desc;
 690 }
 691
 692 struct gpio_desc *acpi_find_gpio(struct device *dev,
 693                                  const char *con_id,
 694                                  unsigned int idx,
 695                                  enum gpiod_flags *dflags,
 696                                  enum gpio_lookup_flags *lookupflags)
 697 {
 698         struct acpi_device *adev = ACPI_COMPANION(dev);
 699         struct acpi_gpio_info info;
 700         struct gpio_desc *desc;
 701         char propname[32];
 702         int i;
 703
 704         /* Try first from _DSD */
 705         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
 706                 if (con_id) {
 707                         snprintf(propname, sizeof(propname), "%s-%s",
 708                                  con_id, gpio_suffixes[i]);
 709                 } else {
 710                         snprintf(propname, sizeof(propname), "%s",
 711                                  gpio_suffixes[i]);
 712                 }
 713
 714                 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
 715                 if (!IS_ERR(desc))
 716                         break;
 717                 if (PTR_ERR(desc) == -EPROBE_DEFER)
 718                         return ERR_CAST(desc);
 719         }
 720
 721         /* Then from plain _CRS GPIOs */
 722         if (IS_ERR(desc)) {
 723                 if (!acpi_can_fallback_to_crs(adev, con_id))
 724                         return ERR_PTR(-ENOENT);
 725
 726                 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
 727                 if (IS_ERR(desc))
 728                         return desc;
 729         }
 730
 731         if (info.gpioint &&
 732             (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
 733                 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
 734                 return ERR_PTR(-ENOENT);
 735         }
 736
 737         if (info.polarity == GPIO_ACTIVE_LOW)
 738                 *lookupflags |= GPIO_ACTIVE_LOW;
 739
 740         acpi_gpio_update_gpiod_flags(dflags, &info);
 741         return desc;
 742 }
 743
 744 /**
 745  * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
 746  * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
 747  * @propname: Property name of the GPIO
 748  * @index: index of GpioIo/GpioInt resource (starting from %0)
 749  * @info: info pointer to fill in (optional)
 750  *
 751  * If @fwnode is an ACPI device object, call %acpi_get_gpiod_by_index() for it.
 752  * Otherwise (ie. it is a data-only non-device object), use the property-based
 753  * GPIO lookup to get to the GPIO resource with the relevant information and use
 754  * that to obtain the GPIO descriptor to return.
 755  */
 756 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
 757                                       const char *propname, int index,
 758                                       struct acpi_gpio_info *info)
 759 {
 760         struct acpi_gpio_lookup lookup;
 761         struct acpi_device *adev;
 762         int ret;
 763
 764         adev = to_acpi_device_node(fwnode);
 765         if (adev)
 766                 return acpi_get_gpiod_by_index(adev, propname, index, info);
 767
 768         if (!is_acpi_data_node(fwnode))
 769                 return ERR_PTR(-ENODEV);
 770
 771         if (!propname)
 772                 return ERR_PTR(-EINVAL);
 773
 774         memset(&lookup, 0, sizeof(lookup));
 775         lookup.index = index;
 776
 777         ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
 778         if (ret)
 779                 return ERR_PTR(ret);
 780
 781         ret = acpi_gpio_resource_lookup(&lookup, info);
 782         return ret ? ERR_PTR(ret) : lookup.desc;
 783 }
 784
 785 /**
 786  * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
 787  * @adev: pointer to a ACPI device to get IRQ from
 788  * @index: index of GpioInt resource (starting from %0)
 789  *
 790  * If the device has one or more GpioInt resources, this function can be
 791  * used to translate from the GPIO offset in the resource to the Linux IRQ
 792  * number.
 793  *
 794  * The function is idempotent, though each time it runs it will configure GPIO
 795  * pin direction according to the flags in GpioInt resource.
 796  *
 797  * Return: Linux IRQ number (> %0) on success, negative errno on failure.
 798  */
 799 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
 800 {
 801         int idx, i;
 802         unsigned int irq_flags;
 803         int ret;
 804
 805         for (i = 0, idx = 0; idx <= index; i++) {
 806                 struct acpi_gpio_info info;
 807                 struct gpio_desc *desc;
 808
 809                 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
 810
 811                 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
 812                 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
 813                         return PTR_ERR(desc);
 814
 815                 if (info.gpioint && idx++ == index) {
 816                         char label[32];
 817                         int irq;
 818
 819                         if (IS_ERR(desc))
 820                                 return PTR_ERR(desc);
 821
 822                         irq = gpiod_to_irq(desc);
 823                         if (irq < 0)
 824                                 return irq;
 825
 826                         snprintf(label, sizeof(label), "GpioInt() %d", index);
 827                         ret = gpiod_configure_flags(desc, label, 0, info.flags);
 828                         if (ret < 0)
 829                                 return ret;
 830
 831                         irq_flags = acpi_dev_get_irq_type(info.triggering,
 832                                                           info.polarity);
 833
 834                         /* Set type if specified and different than the current one */
 835                         if (irq_flags != IRQ_TYPE_NONE &&
 836                             irq_flags != irq_get_trigger_type(irq))
 837                                 irq_set_irq_type(irq, irq_flags);
 838
 839                         return irq;
 840                 }
 841
 842         }
 843         return -ENOENT;
 844 }
 845 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
 846
 847 static acpi_status
 848 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
 849                             u32 bits, u64 *value, void *handler_context,
 850                             void *region_context)
 851 {
 852         struct acpi_gpio_chip *achip = region_context;
 853         struct gpio_chip *chip = achip->chip;
 854         struct acpi_resource_gpio *agpio;
 855         struct acpi_resource *ares;
 856         int pin_index = (int)address;
 857         acpi_status status;
 858         int length;
 859         int i;
 860
 861         status = acpi_buffer_to_resource(achip->conn_info.connection,
 862                                          achip->conn_info.length, &ares);
 863         if (ACPI_FAILURE(status))
 864                 return status;
 865
 866         if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
 867                 ACPI_FREE(ares);
 868                 return AE_BAD_PARAMETER;
 869         }
 870
 871         agpio = &ares->data.gpio;
 872
 873         if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
 874             function == ACPI_WRITE)) {
 875                 ACPI_FREE(ares);
 876                 return AE_BAD_PARAMETER;
 877         }
 878
 879         length = min(agpio->pin_table_length, (u16)(pin_index + bits));
 880         for (i = pin_index; i < length; ++i) {
 881                 int pin = agpio->pin_table[i];
 882                 struct acpi_gpio_connection *conn;
 883                 struct gpio_desc *desc;
 884                 bool found;
 885
 886                 mutex_lock(&achip->conn_lock);
 887
 888                 found = false;
 889                 list_for_each_entry(conn, &achip->conns, node) {
 890                         if (conn->pin == pin) {
 891                                 found = true;
 892                                 desc = conn->desc;
 893                                 break;
 894                         }
 895                 }
 896
 897                 /*
 898                  * The same GPIO can be shared between operation region and
 899                  * event but only if the access here is ACPI_READ. In that
 900                  * case we "borrow" the event GPIO instead.
 901                  */
 902                 if (!found && agpio->shareable == ACPI_SHARED &&
 903                      function == ACPI_READ) {
 904                         struct acpi_gpio_event *event;
 905
 906                         list_for_each_entry(event, &achip->events, node) {
 907                                 if (event->pin == pin) {
 908                                         desc = event->desc;
 909                                         found = true;
 910                                         break;
 911                                 }
 912                         }
 913                 }
 914
 915                 if (!found) {
 916                         enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio);
 917                         const char *label = "ACPI:OpRegion";
 918
 919                         desc = gpiochip_request_own_desc(chip, pin, label,
 920                                                          flags);
 921                         if (IS_ERR(desc)) {
 922                                 status = AE_ERROR;
 923                                 mutex_unlock(&achip->conn_lock);
 924                                 goto out;
 925                         }
 926
 927                         conn = kzalloc(sizeof(*conn), GFP_KERNEL);
 928                         if (!conn) {
 929                                 status = AE_NO_MEMORY;
 930                                 gpiochip_free_own_desc(desc);
 931                                 mutex_unlock(&achip->conn_lock);
 932                                 goto out;
 933                         }
 934
 935                         conn->pin = pin;
 936                         conn->desc = desc;
 937                         list_add_tail(&conn->node, &achip->conns);
 938                 }
 939
 940                 mutex_unlock(&achip->conn_lock);
 941
 942                 if (function == ACPI_WRITE)
 943                         gpiod_set_raw_value_cansleep(desc,
 944                                                      !!((1 << i) & *value));
 945                 else
 946                         *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
 947         }
 948
 949 out:
 950         ACPI_FREE(ares);
 951         return status;
 952 }
 953
 954 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
 955 {
 956         struct gpio_chip *chip = achip->chip;
 957         acpi_handle handle = ACPI_HANDLE(chip->parent);
 958         acpi_status status;
 959
 960         INIT_LIST_HEAD(&achip->conns);
 961         mutex_init(&achip->conn_lock);
 962         status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
 963                                                     acpi_gpio_adr_space_handler,
 964                                                     NULL, achip);
 965         if (ACPI_FAILURE(status))
 966                 dev_err(chip->parent,
 967                         "Failed to install GPIO OpRegion handler\n");
 968 }
 969
 970 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
 971 {
 972         struct gpio_chip *chip = achip->chip;
 973         acpi_handle handle = ACPI_HANDLE(chip->parent);
 974         struct acpi_gpio_connection *conn, *tmp;
 975         acpi_status status;
 976
 977         status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
 978                                                    acpi_gpio_adr_space_handler);
 979         if (ACPI_FAILURE(status)) {
 980                 dev_err(chip->parent,
 981                         "Failed to remove GPIO OpRegion handler\n");
 982                 return;
 983         }
 984
 985         list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
 986                 gpiochip_free_own_desc(conn->desc);
 987                 list_del(&conn->node);
 988                 kfree(conn);
 989         }
 990 }
 991
 992 static struct gpio_desc *acpi_gpiochip_parse_own_gpio(
 993         struct acpi_gpio_chip *achip, struct fwnode_handle *fwnode,
 994         const char **name, unsigned int *lflags, unsigned int *dflags)
 995 {
 996         struct gpio_chip *chip = achip->chip;
 997         struct gpio_desc *desc;
 998         u32 gpios[2];
 999         int ret;
1000
1001         *lflags = 0;
1002         *dflags = 0;
1003         *name = NULL;
1004
1005         ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1006                                              ARRAY_SIZE(gpios));
1007         if (ret < 0)
1008                 return ERR_PTR(ret);
1009
1010         desc = gpiochip_get_desc(chip, gpios[0]);
1011         if (IS_ERR(desc))
1012                 return desc;
1013
1014         if (gpios[1])
1015                 *lflags |= GPIO_ACTIVE_LOW;
1016
1017         if (fwnode_property_present(fwnode, "input"))
1018                 *dflags |= GPIOD_IN;
1019         else if (fwnode_property_present(fwnode, "output-low"))
1020                 *dflags |= GPIOD_OUT_LOW;
1021         else if (fwnode_property_present(fwnode, "output-high"))
1022                 *dflags |= GPIOD_OUT_HIGH;
1023         else
1024                 return ERR_PTR(-EINVAL);
1025
1026         fwnode_property_read_string(fwnode, "line-name", name);
1027
1028         return desc;
1029 }
1030
1031 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1032 {
1033         struct gpio_chip *chip = achip->chip;
1034         struct fwnode_handle *fwnode;
1035
1036         device_for_each_child_node(chip->parent, fwnode) {
1037                 unsigned int lflags, dflags;
1038                 struct gpio_desc *desc;
1039                 const char *name;
1040                 int ret;
1041
1042                 if (!fwnode_property_present(fwnode, "gpio-hog"))
1043                         continue;
1044
1045                 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1046                                                     &lflags, &dflags);
1047                 if (IS_ERR(desc))
1048                         continue;
1049
1050                 ret = gpiod_hog(desc, name, lflags, dflags);
1051                 if (ret) {
1052                         dev_err(chip->parent, "Failed to hog GPIO\n");
1053                         fwnode_handle_put(fwnode);
1054                         return;
1055                 }
1056         }
1057 }
1058
1059 void acpi_gpiochip_add(struct gpio_chip *chip)
1060 {
1061         struct acpi_gpio_chip *acpi_gpio;
1062         acpi_handle handle;
1063         acpi_status status;
1064
1065         if (!chip || !chip->parent)
1066                 return;
1067
1068         handle = ACPI_HANDLE(chip->parent);
1069         if (!handle)
1070                 return;
1071
1072         acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1073         if (!acpi_gpio) {
1074                 dev_err(chip->parent,
1075                         "Failed to allocate memory for ACPI GPIO chip\n");
1076                 return;
1077         }
1078
1079         acpi_gpio->chip = chip;
1080         INIT_LIST_HEAD(&acpi_gpio->events);
1081         INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1082
1083         status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1084         if (ACPI_FAILURE(status)) {
1085                 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1086                 kfree(acpi_gpio);
1087                 return;
1088         }
1089
1090         if (!chip->names)
1091                 devprop_gpiochip_set_names(chip, dev_fwnode(chip->parent));
1092
1093         acpi_gpiochip_request_regions(acpi_gpio);
1094         acpi_gpiochip_scan_gpios(acpi_gpio);
1095         acpi_walk_dep_device_list(handle);
1096 }
1097
1098 void acpi_gpiochip_remove(struct gpio_chip *chip)
1099 {
1100         struct acpi_gpio_chip *acpi_gpio;
1101         acpi_handle handle;
1102         acpi_status status;
1103
1104         if (!chip || !chip->parent)
1105                 return;
1106
1107         handle = ACPI_HANDLE(chip->parent);
1108         if (!handle)
1109                 return;
1110
1111         status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1112         if (ACPI_FAILURE(status)) {
1113                 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1114                 return;
1115         }
1116
1117         acpi_gpiochip_free_regions(acpi_gpio);
1118
1119         acpi_detach_data(handle, acpi_gpio_chip_dh);
1120         kfree(acpi_gpio);
1121 }
1122
1123 static int acpi_gpio_package_count(const union acpi_object *obj)
1124 {
1125         const union acpi_object *element = obj->package.elements;
1126         const union acpi_object *end = element + obj->package.count;
1127         unsigned int count = 0;
1128
1129         while (element < end) {
1130                 switch (element->type) {
1131                 case ACPI_TYPE_LOCAL_REFERENCE:
1132                         element += 3;
1133                         /* Fallthrough */
1134                 case ACPI_TYPE_INTEGER:
1135                         element++;
1136                         count++;
1137                         break;
1138
1139                 default:
1140                         return -EPROTO;
1141                 }
1142         }
1143
1144         return count;
1145 }
1146
1147 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1148 {
1149         unsigned int *count = data;
1150
1151         if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1152                 *count += ares->data.gpio.pin_table_length;
1153
1154         return 1;
1155 }
1156
1157 /**
1158  * acpi_gpio_count - return the number of GPIOs associated with a
1159  *              device / function or -ENOENT if no GPIO has been
1160  *              assigned to the requested function.
1161  * @dev:        GPIO consumer, can be NULL for system-global GPIOs
1162  * @con_id:     function within the GPIO consumer
1163  */
1164 int acpi_gpio_count(struct device *dev, const char *con_id)
1165 {
1166         struct acpi_device *adev = ACPI_COMPANION(dev);
1167         const union acpi_object *obj;
1168         const struct acpi_gpio_mapping *gm;
1169         int count = -ENOENT;
1170         int ret;
1171         char propname[32];
1172         unsigned int i;
1173
1174         /* Try first from _DSD */
1175         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1176                 if (con_id)
1177                         snprintf(propname, sizeof(propname), "%s-%s",
1178                                  con_id, gpio_suffixes[i]);
1179                 else
1180                         snprintf(propname, sizeof(propname), "%s",
1181                                  gpio_suffixes[i]);
1182
1183                 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1184                                             &obj);
1185                 if (ret == 0) {
1186                         if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1187                                 count = 1;
1188                         else if (obj->type == ACPI_TYPE_PACKAGE)
1189                                 count = acpi_gpio_package_count(obj);
1190                 } else if (adev->driver_gpios) {
1191                         for (gm = adev->driver_gpios; gm->name; gm++)
1192                                 if (strcmp(propname, gm->name) == 0) {
1193                                         count = gm->size;
1194                                         break;
1195                                 }
1196                 }
1197                 if (count > 0)
1198                         break;
1199         }
1200
1201         /* Then from plain _CRS GPIOs */
1202         if (count < 0) {
1203                 struct list_head resource_list;
1204                 unsigned int crs_count = 0;
1205
1206                 if (!acpi_can_fallback_to_crs(adev, con_id))
1207                         return count;
1208
1209                 INIT_LIST_HEAD(&resource_list);
1210                 acpi_dev_get_resources(adev, &resource_list,
1211                                        acpi_find_gpio_count, &crs_count);
1212                 acpi_dev_free_resource_list(&resource_list);
1213                 if (crs_count > 0)
1214                         count = crs_count;
1215         }
1216         return count ? count : -ENOENT;
1217 }
1218
1219 bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id)
1220 {
1221         /* Never allow fallback if the device has properties */
1222         if (acpi_dev_has_props(adev) || adev->driver_gpios)
1223                 return false;
1224
1225         return con_id == NULL;
1226 }
1227
1228 /* Run deferred acpi_gpiochip_request_irqs() */
1229 static int acpi_gpio_handle_deferred_request_irqs(void)
1230 {
1231         struct acpi_gpio_chip *acpi_gpio, *tmp;
1232
1233         mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1234         list_for_each_entry_safe(acpi_gpio, tmp,
1235                                  &acpi_gpio_deferred_req_irqs_list,
1236                                  deferred_req_irqs_list_entry)
1237                 acpi_gpiochip_request_irqs(acpi_gpio);
1238
1239         acpi_gpio_deferred_req_irqs_done = true;
1240         mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1241
1242         return 0;
1243 }
1244 /* We must use _sync so that this runs after the first deferred_probe run */
1245 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);