1 // SPDX-License-Identifier: GPL-2.0
3 * ACPI helpers for GPIO API
5 * Copyright (C) 2012, Intel Corporation
6 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
7 * Mika Westerberg <mika.westerberg@linux.intel.com>
10 #include <linux/dmi.h>
11 #include <linux/errno.h>
12 #include <linux/gpio/consumer.h>
13 #include <linux/gpio/driver.h>
14 #include <linux/gpio/machine.h>
15 #include <linux/export.h>
16 #include <linux/acpi.h>
17 #include <linux/interrupt.h>
18 #include <linux/mutex.h>
19 #include <linux/pinctrl/pinctrl.h>
22 #include "gpiolib-acpi.h"
24 static int run_edge_events_on_boot = -1;
25 module_param(run_edge_events_on_boot, int, 0444);
26 MODULE_PARM_DESC(run_edge_events_on_boot,
27 "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");
29 static char *ignore_wake;
30 module_param(ignore_wake, charp, 0444);
31 MODULE_PARM_DESC(ignore_wake,
32 "controller@pin combos on which to ignore the ACPI wake flag "
33 "ignore_wake=controller@pin[,controller@pin[,...]]");
35 struct acpi_gpiolib_dmi_quirk {
36 bool no_edge_events_on_boot;
41 * struct acpi_gpio_event - ACPI GPIO event handler data
43 * @node: list-entry of the events list of the struct acpi_gpio_chip
44 * @handle: handle of ACPI method to execute when the IRQ triggers
45 * @handler: handler function to pass to request_irq() when requesting the IRQ
46 * @pin: GPIO pin number on the struct gpio_chip
47 * @irq: Linux IRQ number for the event, for request_irq() / free_irq()
48 * @irqflags: flags to pass to request_irq() when requesting the IRQ
49 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
50 * @irq_requested:True if request_irq() has been done
51 * @desc: struct gpio_desc for the GPIO pin for this event
53 struct acpi_gpio_event {
54 struct list_head node;
56 irq_handler_t handler;
59 unsigned long irqflags;
62 struct gpio_desc *desc;
65 struct acpi_gpio_connection {
66 struct list_head node;
68 struct gpio_desc *desc;
71 struct acpi_gpio_chip {
73 * ACPICA requires that the first field of the context parameter
74 * passed to acpi_install_address_space_handler() is large enough
75 * to hold struct acpi_connection_info.
77 struct acpi_connection_info conn_info;
78 struct list_head conns;
79 struct mutex conn_lock;
80 struct gpio_chip *chip;
81 struct list_head events;
82 struct list_head deferred_req_irqs_list_entry;
86 * For GPIO chips which call acpi_gpiochip_request_interrupts() before late_init
87 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
88 * late_initcall_sync() handler, so that other builtin drivers can register their
89 * OpRegions before the event handlers can run. This list contains GPIO chips
90 * for which the acpi_gpiochip_request_irqs() call has been deferred.
92 static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
93 static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
94 static bool acpi_gpio_deferred_req_irqs_done;
96 static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
101 return ACPI_HANDLE(gc->parent) == data;
105 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
106 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
107 * @pin: ACPI GPIO pin number (0-based, controller-relative)
109 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
110 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
111 * controller does not have GPIO chip registered at the moment. This is to
112 * support probe deferral.
114 static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
116 struct gpio_chip *chip;
120 status = acpi_get_handle(NULL, path, &handle);
121 if (ACPI_FAILURE(status))
122 return ERR_PTR(-ENODEV);
124 chip = gpiochip_find(handle, acpi_gpiochip_find);
126 return ERR_PTR(-EPROBE_DEFER);
128 return gpiochip_get_desc(chip, pin);
131 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
133 struct acpi_gpio_event *event = data;
135 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
140 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
142 struct acpi_gpio_event *event = data;
144 acpi_execute_simple_method(event->handle, NULL, event->pin);
149 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
151 /* The address of this function is used as a key. */
154 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
155 struct acpi_resource_gpio **agpio)
157 struct acpi_resource_gpio *gpio;
159 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
162 gpio = &ares->data.gpio;
163 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
169 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
171 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
172 struct acpi_gpio_event *event)
176 ret = request_threaded_irq(event->irq, NULL, event->handler,
177 event->irqflags | IRQF_ONESHOT, "ACPI:Event", event);
179 dev_err(acpi_gpio->chip->parent,
180 "Failed to setup interrupt handler for %d\n",
185 if (event->irq_is_wake)
186 enable_irq_wake(event->irq);
188 event->irq_requested = true;
190 /* Make sure we trigger the initial state of edge-triggered IRQs */
191 if (run_edge_events_on_boot &&
192 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
193 value = gpiod_get_raw_value_cansleep(event->desc);
194 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
195 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
196 event->handler(event->irq, event);
200 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
202 struct acpi_gpio_event *event;
204 list_for_each_entry(event, &acpi_gpio->events, node)
205 acpi_gpiochip_request_irq(acpi_gpio, event);
208 static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
210 const char *controller, *pin_str;
214 controller = ignore_wake;
216 pin_str = strchr(controller, '@');
220 len = pin_str - controller;
221 if (len == strlen(controller_in) &&
222 strncmp(controller, controller_in, len) == 0) {
223 pin = simple_strtoul(pin_str + 1, &endp, 10);
224 if (*endp != 0 && *endp != ',')
231 controller = strchr(controller, ',');
238 pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
243 static bool acpi_gpio_irq_is_wake(struct device *parent,
244 struct acpi_resource_gpio *agpio)
246 int pin = agpio->pin_table[0];
248 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
251 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
252 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
259 /* Always returns AE_OK so that we keep looping over the resources */
260 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
263 struct acpi_gpio_chip *acpi_gpio = context;
264 struct gpio_chip *chip = acpi_gpio->chip;
265 struct acpi_resource_gpio *agpio;
266 acpi_handle handle, evt_handle;
267 struct acpi_gpio_event *event;
268 irq_handler_t handler = NULL;
269 struct gpio_desc *desc;
272 if (!acpi_gpio_get_irq_resource(ares, &agpio))
275 handle = ACPI_HANDLE(chip->parent);
276 pin = agpio->pin_table[0];
280 sprintf(ev_name, "_%c%02X",
281 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
283 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
284 handler = acpi_gpio_irq_handler;
287 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
288 handler = acpi_gpio_irq_handler_evt;
293 desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event",
294 GPIO_ACTIVE_HIGH, GPIOD_IN);
296 dev_err(chip->parent,
297 "Failed to request GPIO for pin 0x%04X, err %ld\n",
302 ret = gpiochip_lock_as_irq(chip, pin);
304 dev_err(chip->parent,
305 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
310 irq = gpiod_to_irq(desc);
312 dev_err(chip->parent,
313 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
315 goto fail_unlock_irq;
318 event = kzalloc(sizeof(*event), GFP_KERNEL);
320 goto fail_unlock_irq;
322 event->irqflags = IRQF_ONESHOT;
323 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
324 if (agpio->polarity == ACPI_ACTIVE_HIGH)
325 event->irqflags |= IRQF_TRIGGER_HIGH;
327 event->irqflags |= IRQF_TRIGGER_LOW;
329 switch (agpio->polarity) {
330 case ACPI_ACTIVE_HIGH:
331 event->irqflags |= IRQF_TRIGGER_RISING;
333 case ACPI_ACTIVE_LOW:
334 event->irqflags |= IRQF_TRIGGER_FALLING;
337 event->irqflags |= IRQF_TRIGGER_RISING |
338 IRQF_TRIGGER_FALLING;
343 event->handle = evt_handle;
344 event->handler = handler;
346 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
350 list_add_tail(&event->node, &acpi_gpio->events);
355 gpiochip_unlock_as_irq(chip, pin);
357 gpiochip_free_own_desc(desc);
363 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
366 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
367 * handled by ACPI event methods which need to be called from the GPIO
368 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
369 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
370 * the ACPI event methods for those pins.
372 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
374 struct acpi_gpio_chip *acpi_gpio;
379 if (!chip->parent || !chip->to_irq)
382 handle = ACPI_HANDLE(chip->parent);
386 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
387 if (ACPI_FAILURE(status))
390 acpi_walk_resources(handle, "_AEI",
391 acpi_gpiochip_alloc_event, acpi_gpio);
393 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
394 defer = !acpi_gpio_deferred_req_irqs_done;
396 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
397 &acpi_gpio_deferred_req_irqs_list);
398 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
403 acpi_gpiochip_request_irqs(acpi_gpio);
405 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
408 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
411 * Free interrupts associated with GPIO ACPI event method for the given
414 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
416 struct acpi_gpio_chip *acpi_gpio;
417 struct acpi_gpio_event *event, *ep;
421 if (!chip->parent || !chip->to_irq)
424 handle = ACPI_HANDLE(chip->parent);
428 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
429 if (ACPI_FAILURE(status))
432 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
433 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
434 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
435 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
437 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
438 if (event->irq_requested) {
439 if (event->irq_is_wake)
440 disable_irq_wake(event->irq);
442 free_irq(event->irq, event);
445 gpiochip_unlock_as_irq(chip, event->pin);
446 gpiochip_free_own_desc(event->desc);
447 list_del(&event->node);
451 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
453 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
454 const struct acpi_gpio_mapping *gpios)
457 adev->driver_gpios = gpios;
462 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
464 void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
467 adev->driver_gpios = NULL;
469 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
471 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
473 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
476 int devm_acpi_dev_add_driver_gpios(struct device *dev,
477 const struct acpi_gpio_mapping *gpios)
482 res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
486 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
491 devres_add(dev, res);
494 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
496 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
498 WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
500 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
502 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
503 const char *name, int index,
504 struct fwnode_reference_args *args,
505 unsigned int *quirks)
507 const struct acpi_gpio_mapping *gm;
509 if (!adev->driver_gpios)
512 for (gm = adev->driver_gpios; gm->name; gm++)
513 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
514 const struct acpi_gpio_params *par = gm->data + index;
516 args->fwnode = acpi_fwnode_handle(adev);
517 args->args[0] = par->crs_entry_index;
518 args->args[1] = par->line_index;
519 args->args[2] = par->active_low;
522 *quirks = gm->quirks;
529 static enum gpiod_flags
530 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio)
532 switch (agpio->io_restriction) {
533 case ACPI_IO_RESTRICT_INPUT:
535 case ACPI_IO_RESTRICT_OUTPUT:
537 * ACPI GPIO resources don't contain an initial value for the
538 * GPIO. Therefore we deduce that value from the pull field
539 * instead. If the pin is pulled up we assume default to be
540 * high, if it is pulled down we assume default to be low,
541 * otherwise we leave pin untouched.
543 switch (agpio->pin_config) {
544 case ACPI_PIN_CONFIG_PULLUP:
545 return GPIOD_OUT_HIGH;
546 case ACPI_PIN_CONFIG_PULLDOWN:
547 return GPIOD_OUT_LOW;
556 * Assume that the BIOS has configured the direction and pull
563 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
565 const enum gpiod_flags mask =
566 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
567 GPIOD_FLAGS_BIT_DIR_VAL;
571 * Check if the BIOS has IoRestriction with explicitly set direction
572 * and update @flags accordingly. Otherwise use whatever caller asked
575 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
576 enum gpiod_flags diff = *flags ^ update;
579 * Check if caller supplied incompatible GPIO initialization
582 * Return %-EINVAL to notify that firmware has different
583 * settings and we are going to use them.
585 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
586 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
588 *flags = (*flags & ~mask) | (update & mask);
594 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
596 struct device *dev = &info->adev->dev;
597 enum gpiod_flags old = *flags;
600 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
601 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
603 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
606 dev_dbg(dev, "Override GPIO initialization flags\n");
613 int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
614 struct acpi_gpio_info *info)
616 switch (info->pin_config) {
617 case ACPI_PIN_CONFIG_PULLUP:
618 *lookupflags |= GPIO_PULL_UP;
620 case ACPI_PIN_CONFIG_PULLDOWN:
621 *lookupflags |= GPIO_PULL_DOWN;
627 if (info->polarity == GPIO_ACTIVE_LOW)
628 *lookupflags |= GPIO_ACTIVE_LOW;
633 struct acpi_gpio_lookup {
634 struct acpi_gpio_info info;
638 struct gpio_desc *desc;
642 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
644 struct acpi_gpio_lookup *lookup = data;
646 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
650 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
651 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
652 struct gpio_desc *desc;
655 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
658 if (lookup->n++ != lookup->index)
661 pin_index = lookup->pin_index;
662 if (pin_index >= agpio->pin_table_length)
665 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER)
666 desc = gpio_to_desc(agpio->pin_table[pin_index]);
668 desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
669 agpio->pin_table[pin_index]);
671 lookup->info.pin_config = agpio->pin_config;
672 lookup->info.gpioint = gpioint;
675 * Polarity and triggering are only specified for GpioInt
677 * Note: we expect here:
678 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
679 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
681 if (lookup->info.gpioint) {
682 lookup->info.flags = GPIOD_IN;
683 lookup->info.polarity = agpio->polarity;
684 lookup->info.triggering = agpio->triggering;
686 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio);
687 lookup->info.polarity = lookup->active_low;
694 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
695 struct acpi_gpio_info *info)
697 struct acpi_device *adev = lookup->info.adev;
698 struct list_head res_list;
701 INIT_LIST_HEAD(&res_list);
703 ret = acpi_dev_get_resources(adev, &res_list,
704 acpi_populate_gpio_lookup,
709 acpi_dev_free_resource_list(&res_list);
715 *info = lookup->info;
719 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
720 const char *propname, int index,
721 struct acpi_gpio_lookup *lookup)
723 struct fwnode_reference_args args;
724 unsigned int quirks = 0;
727 memset(&args, 0, sizeof(args));
728 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
731 struct acpi_device *adev = to_acpi_device_node(fwnode);
736 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
741 * The property was found and resolved, so need to lookup the GPIO based
744 if (!to_acpi_device_node(args.fwnode))
749 lookup->index = args.args[0];
750 lookup->pin_index = args.args[1];
751 lookup->active_low = !!args.args[2];
753 lookup->info.adev = to_acpi_device_node(args.fwnode);
754 lookup->info.quirks = quirks;
760 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
761 * @adev: pointer to a ACPI device to get GPIO from
762 * @propname: Property name of the GPIO (optional)
763 * @index: index of GpioIo/GpioInt resource (starting from %0)
764 * @info: info pointer to fill in (optional)
766 * Function goes through ACPI resources for @adev and based on @index looks
767 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
768 * and returns it. @index matches GpioIo/GpioInt resources only so if there
769 * are total %3 GPIO resources, the index goes from %0 to %2.
771 * If @propname is specified the GPIO is looked using device property. In
772 * that case @index is used to select the GPIO entry in the property value
773 * (in case of multiple).
775 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
778 * Note: if the GPIO resource has multiple entries in the pin list, this
779 * function only returns the first.
781 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
782 const char *propname, int index,
783 struct acpi_gpio_info *info)
785 struct acpi_gpio_lookup lookup;
789 return ERR_PTR(-ENODEV);
791 memset(&lookup, 0, sizeof(lookup));
792 lookup.index = index;
795 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
797 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
798 propname, index, &lookup);
802 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
803 dev_name(&lookup.info.adev->dev), lookup.index,
804 lookup.pin_index, lookup.active_low);
806 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
807 lookup.info.adev = adev;
810 ret = acpi_gpio_resource_lookup(&lookup, info);
811 return ret ? ERR_PTR(ret) : lookup.desc;
814 static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
817 /* Never allow fallback if the device has properties */
818 if (acpi_dev_has_props(adev) || adev->driver_gpios)
821 return con_id == NULL;
824 struct gpio_desc *acpi_find_gpio(struct device *dev,
827 enum gpiod_flags *dflags,
828 unsigned long *lookupflags)
830 struct acpi_device *adev = ACPI_COMPANION(dev);
831 struct acpi_gpio_info info;
832 struct gpio_desc *desc;
836 /* Try first from _DSD */
837 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
839 snprintf(propname, sizeof(propname), "%s-%s",
840 con_id, gpio_suffixes[i]);
842 snprintf(propname, sizeof(propname), "%s",
846 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
849 if (PTR_ERR(desc) == -EPROBE_DEFER)
850 return ERR_CAST(desc);
853 /* Then from plain _CRS GPIOs */
855 if (!acpi_can_fallback_to_crs(adev, con_id))
856 return ERR_PTR(-ENOENT);
858 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
864 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
865 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
866 return ERR_PTR(-ENOENT);
869 acpi_gpio_update_gpiod_flags(dflags, &info);
870 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
875 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
876 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
877 * @propname: Property name of the GPIO
878 * @index: index of GpioIo/GpioInt resource (starting from %0)
879 * @info: info pointer to fill in (optional)
881 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
882 * Otherwise (i.e. it is a data-only non-device object), use the property-based
883 * GPIO lookup to get to the GPIO resource with the relevant information and use
884 * that to obtain the GPIO descriptor to return.
886 * If the GPIO cannot be translated or there is an error an ERR_PTR is
889 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
890 const char *propname, int index,
891 struct acpi_gpio_info *info)
893 struct acpi_gpio_lookup lookup;
894 struct acpi_device *adev;
897 adev = to_acpi_device_node(fwnode);
899 return acpi_get_gpiod_by_index(adev, propname, index, info);
901 if (!is_acpi_data_node(fwnode))
902 return ERR_PTR(-ENODEV);
905 return ERR_PTR(-EINVAL);
907 memset(&lookup, 0, sizeof(lookup));
908 lookup.index = index;
910 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
914 ret = acpi_gpio_resource_lookup(&lookup, info);
915 return ret ? ERR_PTR(ret) : lookup.desc;
919 * acpi_dev_gpio_irq_get_by() - Find GpioInt and translate it to Linux IRQ number
920 * @adev: pointer to a ACPI device to get IRQ from
921 * @name: optional name of GpioInt resource
922 * @index: index of GpioInt resource (starting from %0)
924 * If the device has one or more GpioInt resources, this function can be
925 * used to translate from the GPIO offset in the resource to the Linux IRQ
928 * The function is idempotent, though each time it runs it will configure GPIO
929 * pin direction according to the flags in GpioInt resource.
931 * The function takes optional @name parameter. If the resource has a property
932 * name, then only those will be taken into account.
934 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
936 int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index)
939 unsigned int irq_flags;
942 for (i = 0, idx = 0; idx <= index; i++) {
943 struct acpi_gpio_info info;
944 struct gpio_desc *desc;
946 desc = acpi_get_gpiod_by_index(adev, name, i, &info);
948 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
949 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
950 return PTR_ERR(desc);
952 if (info.gpioint && idx++ == index) {
953 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
958 return PTR_ERR(desc);
960 irq = gpiod_to_irq(desc);
964 snprintf(label, sizeof(label), "GpioInt() %d", index);
965 ret = gpiod_configure_flags(desc, label, lflags, info.flags);
969 irq_flags = acpi_dev_get_irq_type(info.triggering,
973 * If the IRQ is not already in use then set type
974 * if specified and different than the current one.
976 if (can_request_irq(irq, irq_flags)) {
977 if (irq_flags != IRQ_TYPE_NONE &&
978 irq_flags != irq_get_trigger_type(irq))
979 irq_set_irq_type(irq, irq_flags);
981 dev_dbg(&adev->dev, "IRQ %d already in use\n", irq);
990 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get_by);
993 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
994 u32 bits, u64 *value, void *handler_context,
995 void *region_context)
997 struct acpi_gpio_chip *achip = region_context;
998 struct gpio_chip *chip = achip->chip;
999 struct acpi_resource_gpio *agpio;
1000 struct acpi_resource *ares;
1001 int pin_index = (int)address;
1006 status = acpi_buffer_to_resource(achip->conn_info.connection,
1007 achip->conn_info.length, &ares);
1008 if (ACPI_FAILURE(status))
1011 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
1013 return AE_BAD_PARAMETER;
1016 agpio = &ares->data.gpio;
1018 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
1019 function == ACPI_WRITE)) {
1021 return AE_BAD_PARAMETER;
1024 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
1025 for (i = pin_index; i < length; ++i) {
1026 int pin = agpio->pin_table[i];
1027 struct acpi_gpio_connection *conn;
1028 struct gpio_desc *desc;
1031 mutex_lock(&achip->conn_lock);
1034 list_for_each_entry(conn, &achip->conns, node) {
1035 if (conn->pin == pin) {
1043 * The same GPIO can be shared between operation region and
1044 * event but only if the access here is ACPI_READ. In that
1045 * case we "borrow" the event GPIO instead.
1047 if (!found && agpio->shareable == ACPI_SHARED &&
1048 function == ACPI_READ) {
1049 struct acpi_gpio_event *event;
1051 list_for_each_entry(event, &achip->events, node) {
1052 if (event->pin == pin) {
1061 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio);
1062 const char *label = "ACPI:OpRegion";
1064 desc = gpiochip_request_own_desc(chip, pin, label,
1069 mutex_unlock(&achip->conn_lock);
1073 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1075 status = AE_NO_MEMORY;
1076 gpiochip_free_own_desc(desc);
1077 mutex_unlock(&achip->conn_lock);
1083 list_add_tail(&conn->node, &achip->conns);
1086 mutex_unlock(&achip->conn_lock);
1088 if (function == ACPI_WRITE)
1089 gpiod_set_raw_value_cansleep(desc,
1090 !!((1 << i) & *value));
1092 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1100 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1102 struct gpio_chip *chip = achip->chip;
1103 acpi_handle handle = ACPI_HANDLE(chip->parent);
1106 INIT_LIST_HEAD(&achip->conns);
1107 mutex_init(&achip->conn_lock);
1108 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1109 acpi_gpio_adr_space_handler,
1111 if (ACPI_FAILURE(status))
1112 dev_err(chip->parent,
1113 "Failed to install GPIO OpRegion handler\n");
1116 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1118 struct gpio_chip *chip = achip->chip;
1119 acpi_handle handle = ACPI_HANDLE(chip->parent);
1120 struct acpi_gpio_connection *conn, *tmp;
1123 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1124 acpi_gpio_adr_space_handler);
1125 if (ACPI_FAILURE(status)) {
1126 dev_err(chip->parent,
1127 "Failed to remove GPIO OpRegion handler\n");
1131 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1132 gpiochip_free_own_desc(conn->desc);
1133 list_del(&conn->node);
1138 static struct gpio_desc *
1139 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1140 struct fwnode_handle *fwnode,
1142 unsigned long *lflags,
1143 enum gpiod_flags *dflags)
1145 struct gpio_chip *chip = achip->chip;
1146 struct gpio_desc *desc;
1150 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1154 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1157 return ERR_PTR(ret);
1159 desc = gpiochip_get_desc(chip, gpios[0]);
1164 *lflags |= GPIO_ACTIVE_LOW;
1166 if (fwnode_property_present(fwnode, "input"))
1167 *dflags |= GPIOD_IN;
1168 else if (fwnode_property_present(fwnode, "output-low"))
1169 *dflags |= GPIOD_OUT_LOW;
1170 else if (fwnode_property_present(fwnode, "output-high"))
1171 *dflags |= GPIOD_OUT_HIGH;
1173 return ERR_PTR(-EINVAL);
1175 fwnode_property_read_string(fwnode, "line-name", name);
1180 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1182 struct gpio_chip *chip = achip->chip;
1183 struct fwnode_handle *fwnode;
1185 device_for_each_child_node(chip->parent, fwnode) {
1186 unsigned long lflags;
1187 enum gpiod_flags dflags;
1188 struct gpio_desc *desc;
1192 if (!fwnode_property_present(fwnode, "gpio-hog"))
1195 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1200 ret = gpiod_hog(desc, name, lflags, dflags);
1202 dev_err(chip->parent, "Failed to hog GPIO\n");
1203 fwnode_handle_put(fwnode);
1209 void acpi_gpiochip_add(struct gpio_chip *chip)
1211 struct acpi_gpio_chip *acpi_gpio;
1215 if (!chip || !chip->parent)
1218 handle = ACPI_HANDLE(chip->parent);
1222 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1224 dev_err(chip->parent,
1225 "Failed to allocate memory for ACPI GPIO chip\n");
1229 acpi_gpio->chip = chip;
1230 INIT_LIST_HEAD(&acpi_gpio->events);
1231 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1233 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1234 if (ACPI_FAILURE(status)) {
1235 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1240 acpi_gpiochip_request_regions(acpi_gpio);
1241 acpi_gpiochip_scan_gpios(acpi_gpio);
1242 acpi_walk_dep_device_list(handle);
1245 void acpi_gpiochip_remove(struct gpio_chip *chip)
1247 struct acpi_gpio_chip *acpi_gpio;
1251 if (!chip || !chip->parent)
1254 handle = ACPI_HANDLE(chip->parent);
1258 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1259 if (ACPI_FAILURE(status)) {
1260 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1264 acpi_gpiochip_free_regions(acpi_gpio);
1266 acpi_detach_data(handle, acpi_gpio_chip_dh);
1270 static int acpi_gpio_package_count(const union acpi_object *obj)
1272 const union acpi_object *element = obj->package.elements;
1273 const union acpi_object *end = element + obj->package.count;
1274 unsigned int count = 0;
1276 while (element < end) {
1277 switch (element->type) {
1278 case ACPI_TYPE_LOCAL_REFERENCE:
1281 case ACPI_TYPE_INTEGER:
1294 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1296 unsigned int *count = data;
1298 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1299 *count += ares->data.gpio.pin_table_length;
1305 * acpi_gpio_count - count the GPIOs associated with a device / function
1306 * @dev: GPIO consumer, can be %NULL for system-global GPIOs
1307 * @con_id: function within the GPIO consumer
1310 * The number of GPIOs associated with a device / function or %-ENOENT,
1311 * if no GPIO has been assigned to the requested function.
1313 int acpi_gpio_count(struct device *dev, const char *con_id)
1315 struct acpi_device *adev = ACPI_COMPANION(dev);
1316 const union acpi_object *obj;
1317 const struct acpi_gpio_mapping *gm;
1318 int count = -ENOENT;
1323 /* Try first from _DSD */
1324 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1326 snprintf(propname, sizeof(propname), "%s-%s",
1327 con_id, gpio_suffixes[i]);
1329 snprintf(propname, sizeof(propname), "%s",
1332 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1335 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1337 else if (obj->type == ACPI_TYPE_PACKAGE)
1338 count = acpi_gpio_package_count(obj);
1339 } else if (adev->driver_gpios) {
1340 for (gm = adev->driver_gpios; gm->name; gm++)
1341 if (strcmp(propname, gm->name) == 0) {
1350 /* Then from plain _CRS GPIOs */
1352 struct list_head resource_list;
1353 unsigned int crs_count = 0;
1355 if (!acpi_can_fallback_to_crs(adev, con_id))
1358 INIT_LIST_HEAD(&resource_list);
1359 acpi_dev_get_resources(adev, &resource_list,
1360 acpi_find_gpio_count, &crs_count);
1361 acpi_dev_free_resource_list(&resource_list);
1365 return count ? count : -ENOENT;
1368 /* Run deferred acpi_gpiochip_request_irqs() */
1369 static int __init acpi_gpio_handle_deferred_request_irqs(void)
1371 struct acpi_gpio_chip *acpi_gpio, *tmp;
1373 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1374 list_for_each_entry_safe(acpi_gpio, tmp,
1375 &acpi_gpio_deferred_req_irqs_list,
1376 deferred_req_irqs_list_entry)
1377 acpi_gpiochip_request_irqs(acpi_gpio);
1379 acpi_gpio_deferred_req_irqs_done = true;
1380 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1384 /* We must use _sync so that this runs after the first deferred_probe run */
1385 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1387 static const struct dmi_system_id gpiolib_acpi_quirks[] __initconst = {
1390 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1391 * a non existing micro-USB-B connector which puts the HDMI
1392 * DDC pins in GPIO mode, breaking HDMI support.
1395 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1396 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1398 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1399 .no_edge_events_on_boot = true,
1404 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1405 * instead of controlling the actual micro-USB-B turns the 5V
1406 * boost for its USB-A connector off. The actual micro-USB-B
1407 * connector is wired for charging only.
1410 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1411 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1413 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1414 .no_edge_events_on_boot = true,
1419 * The Dell Venue 10 Pro 5055, with Bay Trail SoC + TI PMIC uses an
1420 * external embedded-controller connected via I2C + an ACPI GPIO
1421 * event handler on INT33FFC:02 pin 12, causing spurious wakeups.
1424 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
1425 DMI_MATCH(DMI_PRODUCT_NAME, "Venue 10 Pro 5055"),
1427 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1428 .ignore_wake = "INT33FC:02@12",
1433 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1434 * external embedded-controller connected via I2C + an ACPI GPIO
1435 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1436 * When suspending by closing the LID, the power to the USB
1437 * keyboard is turned off, causing INT0002 ACPI events to
1438 * trigger once the XHCI controller notices the keyboard is
1439 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1440 * EC wakes breaks wakeup when opening the lid, the user needs
1441 * to press the power-button to wakeup the system. The
1442 * alternative is suspend simply not working, which is worse.
1445 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1446 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1448 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1449 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1454 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1455 * external embedded-controller connected via I2C + an ACPI GPIO
1456 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1459 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1460 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1461 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1463 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1464 .ignore_wake = "INT33FC:02@28",
1469 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1470 * external embedded-controller connected via I2C + an ACPI GPIO
1471 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1474 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1475 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1476 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1478 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1479 .ignore_wake = "INT33FF:01@0",
1484 * Spurious wakeups from TP_ATTN# pin
1485 * Found in BIOS 0.35
1486 * https://gitlab.freedesktop.org/drm/amd/-/issues/3073
1489 DMI_MATCH(DMI_SYS_VENDOR, "GPD"),
1490 DMI_MATCH(DMI_PRODUCT_NAME, "G1619-04"),
1492 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1493 .ignore_wake = "PNP0C50:00@8",
1496 {} /* Terminating entry */
1499 static int __init acpi_gpio_setup_params(void)
1501 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1502 const struct dmi_system_id *id;
1504 id = dmi_first_match(gpiolib_acpi_quirks);
1506 quirk = id->driver_data;
1508 if (run_edge_events_on_boot < 0) {
1509 if (quirk && quirk->no_edge_events_on_boot)
1510 run_edge_events_on_boot = 0;
1512 run_edge_events_on_boot = 1;
1515 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1516 ignore_wake = quirk->ignore_wake;
1521 /* Directly after dmi_setup() which runs as core_initcall() */
1522 postcore_initcall(acpi_gpio_setup_params);