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)
98 return gc->parent && device_match_acpi_handle(gc->parent, data);
102 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
103 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
104 * @pin: ACPI GPIO pin number (0-based, controller-relative)
106 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
107 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
108 * controller does not have GPIO chip registered at the moment. This is to
109 * support probe deferral.
111 static struct gpio_desc *acpi_get_gpiod(char *path, unsigned int pin)
113 struct gpio_chip *chip;
117 status = acpi_get_handle(NULL, path, &handle);
118 if (ACPI_FAILURE(status))
119 return ERR_PTR(-ENODEV);
121 chip = gpiochip_find(handle, acpi_gpiochip_find);
123 return ERR_PTR(-EPROBE_DEFER);
125 return gpiochip_get_desc(chip, pin);
129 * acpi_get_and_request_gpiod - Translate ACPI GPIO pin to GPIO descriptor and
130 * hold a refcount to the GPIO device.
131 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
132 * @pin: ACPI GPIO pin number (0-based, controller-relative)
133 * @label: Label to pass to gpiod_request()
135 * This function is a simple pass-through to acpi_get_gpiod(), except that
136 * as it is intended for use outside of the GPIO layer (in a similar fashion to
137 * gpiod_get_index() for example) it also holds a reference to the GPIO device.
139 struct gpio_desc *acpi_get_and_request_gpiod(char *path, unsigned int pin, char *label)
141 struct gpio_desc *gpio;
144 gpio = acpi_get_gpiod(path, pin);
148 ret = gpiod_request(gpio, label);
154 EXPORT_SYMBOL_GPL(acpi_get_and_request_gpiod);
156 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
158 struct acpi_gpio_event *event = data;
160 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
165 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
167 struct acpi_gpio_event *event = data;
169 acpi_execute_simple_method(event->handle, NULL, event->pin);
174 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
176 /* The address of this function is used as a key. */
179 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
180 struct acpi_resource_gpio **agpio)
182 struct acpi_resource_gpio *gpio;
184 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
187 gpio = &ares->data.gpio;
188 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
194 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
197 * acpi_gpio_get_io_resource - Fetch details of an ACPI resource if it is a GPIO
198 * I/O resource or return False if not.
199 * @ares: Pointer to the ACPI resource to fetch
200 * @agpio: Pointer to a &struct acpi_resource_gpio to store the output pointer
202 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
203 struct acpi_resource_gpio **agpio)
205 struct acpi_resource_gpio *gpio;
207 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
210 gpio = &ares->data.gpio;
211 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_IO)
217 EXPORT_SYMBOL_GPL(acpi_gpio_get_io_resource);
219 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
220 struct acpi_gpio_event *event)
222 struct device *parent = acpi_gpio->chip->parent;
225 ret = request_threaded_irq(event->irq, NULL, event->handler,
226 event->irqflags | IRQF_ONESHOT, "ACPI:Event", event);
228 dev_err(parent, "Failed to setup interrupt handler for %d\n", event->irq);
232 if (event->irq_is_wake)
233 enable_irq_wake(event->irq);
235 event->irq_requested = true;
237 /* Make sure we trigger the initial state of edge-triggered IRQs */
238 if (run_edge_events_on_boot &&
239 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
240 value = gpiod_get_raw_value_cansleep(event->desc);
241 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
242 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
243 event->handler(event->irq, event);
247 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
249 struct acpi_gpio_event *event;
251 list_for_each_entry(event, &acpi_gpio->events, node)
252 acpi_gpiochip_request_irq(acpi_gpio, event);
255 static enum gpiod_flags
256 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio, int polarity)
258 /* GpioInt() implies input configuration */
259 if (agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
262 switch (agpio->io_restriction) {
263 case ACPI_IO_RESTRICT_INPUT:
265 case ACPI_IO_RESTRICT_OUTPUT:
267 * ACPI GPIO resources don't contain an initial value for the
268 * GPIO. Therefore we deduce that value from the pull field
269 * and the polarity instead. If the pin is pulled up we assume
270 * default to be high, if it is pulled down we assume default
271 * to be low, otherwise we leave pin untouched. For active low
272 * polarity values will be switched. See also
273 * Documentation/firmware-guide/acpi/gpio-properties.rst.
275 switch (agpio->pin_config) {
276 case ACPI_PIN_CONFIG_PULLUP:
277 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_LOW : GPIOD_OUT_HIGH;
278 case ACPI_PIN_CONFIG_PULLDOWN:
279 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
289 * Assume that the BIOS has configured the direction and pull
295 static struct gpio_desc *acpi_request_own_gpiod(struct gpio_chip *chip,
296 struct acpi_resource_gpio *agpio,
300 int polarity = GPIO_ACTIVE_HIGH;
301 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio, polarity);
302 unsigned int pin = agpio->pin_table[index];
303 struct gpio_desc *desc;
306 desc = gpiochip_request_own_desc(chip, pin, label, polarity, flags);
310 /* ACPI uses hundredths of milliseconds units */
311 ret = gpio_set_debounce_timeout(desc, agpio->debounce_timeout * 10);
313 dev_warn(chip->parent,
314 "Failed to set debounce-timeout for pin 0x%04X, err %d\n",
320 static bool acpi_gpio_in_ignore_list(const char *controller_in, unsigned int pin_in)
322 const char *controller, *pin_str;
327 controller = ignore_wake;
329 pin_str = strchr(controller, '@');
333 len = pin_str - controller;
334 if (len == strlen(controller_in) &&
335 strncmp(controller, controller_in, len) == 0) {
336 pin = simple_strtoul(pin_str + 1, &endp, 10);
337 if (*endp != 0 && *endp != ',')
344 controller = strchr(controller, ',');
351 pr_err_once("Error: Invalid value for gpiolib_acpi.ignore_wake: %s\n", ignore_wake);
355 static bool acpi_gpio_irq_is_wake(struct device *parent,
356 struct acpi_resource_gpio *agpio)
358 unsigned int pin = agpio->pin_table[0];
360 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
363 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
364 dev_info(parent, "Ignoring wakeup on pin %u\n", pin);
371 /* Always returns AE_OK so that we keep looping over the resources */
372 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
375 struct acpi_gpio_chip *acpi_gpio = context;
376 struct gpio_chip *chip = acpi_gpio->chip;
377 struct acpi_resource_gpio *agpio;
378 acpi_handle handle, evt_handle;
379 struct acpi_gpio_event *event;
380 irq_handler_t handler = NULL;
381 struct gpio_desc *desc;
385 if (!acpi_gpio_get_irq_resource(ares, &agpio))
388 handle = ACPI_HANDLE(chip->parent);
389 pin = agpio->pin_table[0];
393 sprintf(ev_name, "_%c%02X",
394 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
396 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
397 handler = acpi_gpio_irq_handler;
400 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
401 handler = acpi_gpio_irq_handler_evt;
406 desc = acpi_request_own_gpiod(chip, agpio, 0, "ACPI:Event");
408 dev_err(chip->parent,
409 "Failed to request GPIO for pin 0x%04X, err %ld\n",
414 ret = gpiochip_lock_as_irq(chip, pin);
416 dev_err(chip->parent,
417 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
422 irq = gpiod_to_irq(desc);
424 dev_err(chip->parent,
425 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
427 goto fail_unlock_irq;
430 event = kzalloc(sizeof(*event), GFP_KERNEL);
432 goto fail_unlock_irq;
434 event->irqflags = IRQF_ONESHOT;
435 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
436 if (agpio->polarity == ACPI_ACTIVE_HIGH)
437 event->irqflags |= IRQF_TRIGGER_HIGH;
439 event->irqflags |= IRQF_TRIGGER_LOW;
441 switch (agpio->polarity) {
442 case ACPI_ACTIVE_HIGH:
443 event->irqflags |= IRQF_TRIGGER_RISING;
445 case ACPI_ACTIVE_LOW:
446 event->irqflags |= IRQF_TRIGGER_FALLING;
449 event->irqflags |= IRQF_TRIGGER_RISING |
450 IRQF_TRIGGER_FALLING;
455 event->handle = evt_handle;
456 event->handler = handler;
458 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
462 list_add_tail(&event->node, &acpi_gpio->events);
467 gpiochip_unlock_as_irq(chip, pin);
469 gpiochip_free_own_desc(desc);
475 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
478 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
479 * handled by ACPI event methods which need to be called from the GPIO
480 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
481 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
482 * the ACPI event methods for those pins.
484 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
486 struct acpi_gpio_chip *acpi_gpio;
491 if (!chip->parent || !chip->to_irq)
494 handle = ACPI_HANDLE(chip->parent);
498 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
499 if (ACPI_FAILURE(status))
502 acpi_walk_resources(handle, "_AEI",
503 acpi_gpiochip_alloc_event, acpi_gpio);
505 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
506 defer = !acpi_gpio_deferred_req_irqs_done;
508 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
509 &acpi_gpio_deferred_req_irqs_list);
510 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
515 acpi_gpiochip_request_irqs(acpi_gpio);
517 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
520 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
523 * Free interrupts associated with GPIO ACPI event method for the given
526 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
528 struct acpi_gpio_chip *acpi_gpio;
529 struct acpi_gpio_event *event, *ep;
533 if (!chip->parent || !chip->to_irq)
536 handle = ACPI_HANDLE(chip->parent);
540 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
541 if (ACPI_FAILURE(status))
544 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
545 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
546 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
547 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
549 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
550 if (event->irq_requested) {
551 if (event->irq_is_wake)
552 disable_irq_wake(event->irq);
554 free_irq(event->irq, event);
557 gpiochip_unlock_as_irq(chip, event->pin);
558 gpiochip_free_own_desc(event->desc);
559 list_del(&event->node);
563 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
565 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
566 const struct acpi_gpio_mapping *gpios)
569 adev->driver_gpios = gpios;
574 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
576 void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
579 adev->driver_gpios = NULL;
581 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
583 static void acpi_dev_release_driver_gpios(void *adev)
585 acpi_dev_remove_driver_gpios(adev);
588 int devm_acpi_dev_add_driver_gpios(struct device *dev,
589 const struct acpi_gpio_mapping *gpios)
591 struct acpi_device *adev = ACPI_COMPANION(dev);
594 ret = acpi_dev_add_driver_gpios(adev, gpios);
598 return devm_add_action_or_reset(dev, acpi_dev_release_driver_gpios, adev);
600 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
602 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
603 const char *name, int index,
604 struct fwnode_reference_args *args,
605 unsigned int *quirks)
607 const struct acpi_gpio_mapping *gm;
609 if (!adev->driver_gpios)
612 for (gm = adev->driver_gpios; gm->name; gm++)
613 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
614 const struct acpi_gpio_params *par = gm->data + index;
616 args->fwnode = acpi_fwnode_handle(adev);
617 args->args[0] = par->crs_entry_index;
618 args->args[1] = par->line_index;
619 args->args[2] = par->active_low;
622 *quirks = gm->quirks;
630 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
632 const enum gpiod_flags mask =
633 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
634 GPIOD_FLAGS_BIT_DIR_VAL;
638 * Check if the BIOS has IoRestriction with explicitly set direction
639 * and update @flags accordingly. Otherwise use whatever caller asked
642 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
643 enum gpiod_flags diff = *flags ^ update;
646 * Check if caller supplied incompatible GPIO initialization
649 * Return %-EINVAL to notify that firmware has different
650 * settings and we are going to use them.
652 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
653 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
655 *flags = (*flags & ~mask) | (update & mask);
661 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
663 struct device *dev = &info->adev->dev;
664 enum gpiod_flags old = *flags;
667 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
668 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
670 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
673 dev_dbg(dev, "Override GPIO initialization flags\n");
680 int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
681 struct acpi_gpio_info *info)
683 switch (info->pin_config) {
684 case ACPI_PIN_CONFIG_PULLUP:
685 *lookupflags |= GPIO_PULL_UP;
687 case ACPI_PIN_CONFIG_PULLDOWN:
688 *lookupflags |= GPIO_PULL_DOWN;
690 case ACPI_PIN_CONFIG_NOPULL:
691 *lookupflags |= GPIO_PULL_DISABLE;
697 if (info->polarity == GPIO_ACTIVE_LOW)
698 *lookupflags |= GPIO_ACTIVE_LOW;
703 struct acpi_gpio_lookup {
704 struct acpi_gpio_info info;
708 struct gpio_desc *desc;
712 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
714 struct acpi_gpio_lookup *lookup = data;
716 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
720 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
721 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
722 struct gpio_desc *desc;
725 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
728 if (lookup->n++ != lookup->index)
731 pin_index = lookup->pin_index;
732 if (pin_index >= agpio->pin_table_length)
735 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER)
736 desc = gpio_to_desc(agpio->pin_table[pin_index]);
738 desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
739 agpio->pin_table[pin_index]);
741 lookup->info.pin_config = agpio->pin_config;
742 lookup->info.debounce = agpio->debounce_timeout;
743 lookup->info.gpioint = gpioint;
744 lookup->info.wake_capable = agpio->wake_capable == ACPI_WAKE_CAPABLE;
747 * Polarity and triggering are only specified for GpioInt
749 * Note: we expect here:
750 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
751 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
753 if (lookup->info.gpioint) {
754 lookup->info.polarity = agpio->polarity;
755 lookup->info.triggering = agpio->triggering;
757 lookup->info.polarity = lookup->active_low;
760 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio, lookup->info.polarity);
766 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
767 struct acpi_gpio_info *info)
769 struct acpi_device *adev = lookup->info.adev;
770 struct list_head res_list;
773 INIT_LIST_HEAD(&res_list);
775 ret = acpi_dev_get_resources(adev, &res_list,
776 acpi_populate_gpio_lookup,
781 acpi_dev_free_resource_list(&res_list);
787 *info = lookup->info;
791 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
792 const char *propname, int index,
793 struct acpi_gpio_lookup *lookup)
795 struct fwnode_reference_args args;
796 unsigned int quirks = 0;
799 memset(&args, 0, sizeof(args));
800 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
803 struct acpi_device *adev = to_acpi_device_node(fwnode);
808 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
813 * The property was found and resolved, so need to lookup the GPIO based
816 if (!to_acpi_device_node(args.fwnode))
821 lookup->index = args.args[0];
822 lookup->pin_index = args.args[1];
823 lookup->active_low = !!args.args[2];
825 lookup->info.adev = to_acpi_device_node(args.fwnode);
826 lookup->info.quirks = quirks;
832 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
833 * @adev: pointer to a ACPI device to get GPIO from
834 * @propname: Property name of the GPIO (optional)
835 * @index: index of GpioIo/GpioInt resource (starting from %0)
836 * @info: info pointer to fill in (optional)
838 * Function goes through ACPI resources for @adev and based on @index looks
839 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
840 * and returns it. @index matches GpioIo/GpioInt resources only so if there
841 * are total %3 GPIO resources, the index goes from %0 to %2.
843 * If @propname is specified the GPIO is looked using device property. In
844 * that case @index is used to select the GPIO entry in the property value
845 * (in case of multiple).
847 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
850 * Note: if the GPIO resource has multiple entries in the pin list, this
851 * function only returns the first.
853 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
854 const char *propname, int index,
855 struct acpi_gpio_info *info)
857 struct acpi_gpio_lookup lookup;
861 return ERR_PTR(-ENODEV);
863 memset(&lookup, 0, sizeof(lookup));
864 lookup.index = index;
867 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
869 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
870 propname, index, &lookup);
874 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %u %u\n",
875 dev_name(&lookup.info.adev->dev), lookup.index,
876 lookup.pin_index, lookup.active_low);
878 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
879 lookup.info.adev = adev;
882 ret = acpi_gpio_resource_lookup(&lookup, info);
883 return ret ? ERR_PTR(ret) : lookup.desc;
886 static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
889 /* Never allow fallback if the device has properties */
890 if (acpi_dev_has_props(adev) || adev->driver_gpios)
893 return con_id == NULL;
896 struct gpio_desc *acpi_find_gpio(struct device *dev,
899 enum gpiod_flags *dflags,
900 unsigned long *lookupflags)
902 struct acpi_device *adev = ACPI_COMPANION(dev);
903 struct acpi_gpio_info info;
904 struct gpio_desc *desc;
908 /* Try first from _DSD */
909 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
911 snprintf(propname, sizeof(propname), "%s-%s",
912 con_id, gpio_suffixes[i]);
914 snprintf(propname, sizeof(propname), "%s",
918 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
921 if (PTR_ERR(desc) == -EPROBE_DEFER)
922 return ERR_CAST(desc);
925 /* Then from plain _CRS GPIOs */
927 if (!acpi_can_fallback_to_crs(adev, con_id))
928 return ERR_PTR(-ENOENT);
930 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
936 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
937 dev_dbg(&adev->dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
938 return ERR_PTR(-ENOENT);
941 acpi_gpio_update_gpiod_flags(dflags, &info);
942 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
947 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
948 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
949 * @propname: Property name of the GPIO
950 * @index: index of GpioIo/GpioInt resource (starting from %0)
951 * @info: info pointer to fill in (optional)
953 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
954 * Otherwise (i.e. it is a data-only non-device object), use the property-based
955 * GPIO lookup to get to the GPIO resource with the relevant information and use
956 * that to obtain the GPIO descriptor to return.
958 * If the GPIO cannot be translated or there is an error an ERR_PTR is
961 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
962 const char *propname, int index,
963 struct acpi_gpio_info *info)
965 struct acpi_gpio_lookup lookup;
966 struct acpi_device *adev;
969 adev = to_acpi_device_node(fwnode);
971 return acpi_get_gpiod_by_index(adev, propname, index, info);
973 if (!is_acpi_data_node(fwnode))
974 return ERR_PTR(-ENODEV);
977 return ERR_PTR(-EINVAL);
979 memset(&lookup, 0, sizeof(lookup));
980 lookup.index = index;
982 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
986 ret = acpi_gpio_resource_lookup(&lookup, info);
987 return ret ? ERR_PTR(ret) : lookup.desc;
991 * acpi_dev_gpio_irq_wake_get_by() - Find GpioInt and translate it to Linux IRQ number
992 * @adev: pointer to a ACPI device to get IRQ from
993 * @name: optional name of GpioInt resource
994 * @index: index of GpioInt resource (starting from %0)
995 * @wake_capable: Set to true if the IRQ is wake capable
997 * If the device has one or more GpioInt resources, this function can be
998 * used to translate from the GPIO offset in the resource to the Linux IRQ
1001 * The function is idempotent, though each time it runs it will configure GPIO
1002 * pin direction according to the flags in GpioInt resource.
1004 * The function takes optional @name parameter. If the resource has a property
1005 * name, then only those will be taken into account.
1007 * The GPIO is considered wake capable if the GpioInt resource specifies
1008 * SharedAndWake or ExclusiveAndWake.
1010 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
1012 int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *name, int index,
1016 unsigned int irq_flags;
1019 for (i = 0, idx = 0; idx <= index; i++) {
1020 struct acpi_gpio_info info;
1021 struct gpio_desc *desc;
1023 desc = acpi_get_gpiod_by_index(adev, name, i, &info);
1025 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
1026 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
1027 return PTR_ERR(desc);
1029 if (info.gpioint && idx++ == index) {
1030 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1031 enum gpiod_flags dflags = GPIOD_ASIS;
1036 return PTR_ERR(desc);
1038 irq = gpiod_to_irq(desc);
1042 acpi_gpio_update_gpiod_flags(&dflags, &info);
1043 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
1045 snprintf(label, sizeof(label), "GpioInt() %d", index);
1046 ret = gpiod_configure_flags(desc, label, lflags, dflags);
1050 /* ACPI uses hundredths of milliseconds units */
1051 ret = gpio_set_debounce_timeout(desc, info.debounce * 10);
1055 irq_flags = acpi_dev_get_irq_type(info.triggering,
1059 * If the IRQ is not already in use then set type
1060 * if specified and different than the current one.
1062 if (can_request_irq(irq, irq_flags)) {
1063 if (irq_flags != IRQ_TYPE_NONE &&
1064 irq_flags != irq_get_trigger_type(irq))
1065 irq_set_irq_type(irq, irq_flags);
1067 dev_dbg(&adev->dev, "IRQ %d already in use\n", irq);
1071 *wake_capable = info.wake_capable;
1079 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_wake_get_by);
1082 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
1083 u32 bits, u64 *value, void *handler_context,
1084 void *region_context)
1086 struct acpi_gpio_chip *achip = region_context;
1087 struct gpio_chip *chip = achip->chip;
1088 struct acpi_resource_gpio *agpio;
1089 struct acpi_resource *ares;
1090 u16 pin_index = address;
1095 status = acpi_buffer_to_resource(achip->conn_info.connection,
1096 achip->conn_info.length, &ares);
1097 if (ACPI_FAILURE(status))
1100 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
1102 return AE_BAD_PARAMETER;
1105 agpio = &ares->data.gpio;
1107 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
1108 function == ACPI_WRITE)) {
1110 return AE_BAD_PARAMETER;
1113 length = min_t(u16, agpio->pin_table_length, pin_index + bits);
1114 for (i = pin_index; i < length; ++i) {
1115 unsigned int pin = agpio->pin_table[i];
1116 struct acpi_gpio_connection *conn;
1117 struct gpio_desc *desc;
1120 mutex_lock(&achip->conn_lock);
1123 list_for_each_entry(conn, &achip->conns, node) {
1124 if (conn->pin == pin) {
1132 * The same GPIO can be shared between operation region and
1133 * event but only if the access here is ACPI_READ. In that
1134 * case we "borrow" the event GPIO instead.
1136 if (!found && agpio->shareable == ACPI_SHARED &&
1137 function == ACPI_READ) {
1138 struct acpi_gpio_event *event;
1140 list_for_each_entry(event, &achip->events, node) {
1141 if (event->pin == pin) {
1150 desc = acpi_request_own_gpiod(chip, agpio, i, "ACPI:OpRegion");
1152 mutex_unlock(&achip->conn_lock);
1157 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1159 gpiochip_free_own_desc(desc);
1160 mutex_unlock(&achip->conn_lock);
1161 status = AE_NO_MEMORY;
1167 list_add_tail(&conn->node, &achip->conns);
1170 mutex_unlock(&achip->conn_lock);
1172 if (function == ACPI_WRITE)
1173 gpiod_set_raw_value_cansleep(desc, !!(*value & BIT(i)));
1175 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1183 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1185 struct gpio_chip *chip = achip->chip;
1186 acpi_handle handle = ACPI_HANDLE(chip->parent);
1189 INIT_LIST_HEAD(&achip->conns);
1190 mutex_init(&achip->conn_lock);
1191 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1192 acpi_gpio_adr_space_handler,
1194 if (ACPI_FAILURE(status))
1195 dev_err(chip->parent,
1196 "Failed to install GPIO OpRegion handler\n");
1199 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1201 struct gpio_chip *chip = achip->chip;
1202 acpi_handle handle = ACPI_HANDLE(chip->parent);
1203 struct acpi_gpio_connection *conn, *tmp;
1206 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1207 acpi_gpio_adr_space_handler);
1208 if (ACPI_FAILURE(status)) {
1209 dev_err(chip->parent,
1210 "Failed to remove GPIO OpRegion handler\n");
1214 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1215 gpiochip_free_own_desc(conn->desc);
1216 list_del(&conn->node);
1221 static struct gpio_desc *
1222 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1223 struct fwnode_handle *fwnode,
1225 unsigned long *lflags,
1226 enum gpiod_flags *dflags)
1228 struct gpio_chip *chip = achip->chip;
1229 struct gpio_desc *desc;
1233 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1234 *dflags = GPIOD_ASIS;
1237 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1240 return ERR_PTR(ret);
1242 desc = gpiochip_get_desc(chip, gpios[0]);
1247 *lflags |= GPIO_ACTIVE_LOW;
1249 if (fwnode_property_present(fwnode, "input"))
1250 *dflags |= GPIOD_IN;
1251 else if (fwnode_property_present(fwnode, "output-low"))
1252 *dflags |= GPIOD_OUT_LOW;
1253 else if (fwnode_property_present(fwnode, "output-high"))
1254 *dflags |= GPIOD_OUT_HIGH;
1256 return ERR_PTR(-EINVAL);
1258 fwnode_property_read_string(fwnode, "line-name", name);
1263 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1265 struct gpio_chip *chip = achip->chip;
1266 struct fwnode_handle *fwnode;
1268 device_for_each_child_node(chip->parent, fwnode) {
1269 unsigned long lflags;
1270 enum gpiod_flags dflags;
1271 struct gpio_desc *desc;
1275 if (!fwnode_property_present(fwnode, "gpio-hog"))
1278 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1283 ret = gpiod_hog(desc, name, lflags, dflags);
1285 dev_err(chip->parent, "Failed to hog GPIO\n");
1286 fwnode_handle_put(fwnode);
1292 void acpi_gpiochip_add(struct gpio_chip *chip)
1294 struct acpi_gpio_chip *acpi_gpio;
1295 struct acpi_device *adev;
1298 if (!chip || !chip->parent)
1301 adev = ACPI_COMPANION(chip->parent);
1305 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1307 dev_err(chip->parent,
1308 "Failed to allocate memory for ACPI GPIO chip\n");
1312 acpi_gpio->chip = chip;
1313 INIT_LIST_HEAD(&acpi_gpio->events);
1314 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1316 status = acpi_attach_data(adev->handle, acpi_gpio_chip_dh, acpi_gpio);
1317 if (ACPI_FAILURE(status)) {
1318 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1323 acpi_gpiochip_request_regions(acpi_gpio);
1324 acpi_gpiochip_scan_gpios(acpi_gpio);
1325 acpi_dev_clear_dependencies(adev);
1328 void acpi_gpiochip_remove(struct gpio_chip *chip)
1330 struct acpi_gpio_chip *acpi_gpio;
1334 if (!chip || !chip->parent)
1337 handle = ACPI_HANDLE(chip->parent);
1341 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1342 if (ACPI_FAILURE(status)) {
1343 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1347 acpi_gpiochip_free_regions(acpi_gpio);
1349 acpi_detach_data(handle, acpi_gpio_chip_dh);
1353 void acpi_gpio_dev_init(struct gpio_chip *gc, struct gpio_device *gdev)
1355 /* Set default fwnode to parent's one if present */
1357 ACPI_COMPANION_SET(&gdev->dev, ACPI_COMPANION(gc->parent));
1360 device_set_node(&gdev->dev, gc->fwnode);
1363 static int acpi_gpio_package_count(const union acpi_object *obj)
1365 const union acpi_object *element = obj->package.elements;
1366 const union acpi_object *end = element + obj->package.count;
1367 unsigned int count = 0;
1369 while (element < end) {
1370 switch (element->type) {
1371 case ACPI_TYPE_LOCAL_REFERENCE:
1374 case ACPI_TYPE_INTEGER:
1387 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1389 unsigned int *count = data;
1391 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1392 *count += ares->data.gpio.pin_table_length;
1398 * acpi_gpio_count - count the GPIOs associated with a device / function
1399 * @dev: GPIO consumer, can be %NULL for system-global GPIOs
1400 * @con_id: function within the GPIO consumer
1403 * The number of GPIOs associated with a device / function or %-ENOENT,
1404 * if no GPIO has been assigned to the requested function.
1406 int acpi_gpio_count(struct device *dev, const char *con_id)
1408 struct acpi_device *adev = ACPI_COMPANION(dev);
1409 const union acpi_object *obj;
1410 const struct acpi_gpio_mapping *gm;
1411 int count = -ENOENT;
1416 /* Try first from _DSD */
1417 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1419 snprintf(propname, sizeof(propname), "%s-%s",
1420 con_id, gpio_suffixes[i]);
1422 snprintf(propname, sizeof(propname), "%s",
1425 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1428 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1430 else if (obj->type == ACPI_TYPE_PACKAGE)
1431 count = acpi_gpio_package_count(obj);
1432 } else if (adev->driver_gpios) {
1433 for (gm = adev->driver_gpios; gm->name; gm++)
1434 if (strcmp(propname, gm->name) == 0) {
1443 /* Then from plain _CRS GPIOs */
1445 struct list_head resource_list;
1446 unsigned int crs_count = 0;
1448 if (!acpi_can_fallback_to_crs(adev, con_id))
1451 INIT_LIST_HEAD(&resource_list);
1452 acpi_dev_get_resources(adev, &resource_list,
1453 acpi_find_gpio_count, &crs_count);
1454 acpi_dev_free_resource_list(&resource_list);
1458 return count ? count : -ENOENT;
1461 /* Run deferred acpi_gpiochip_request_irqs() */
1462 static int __init acpi_gpio_handle_deferred_request_irqs(void)
1464 struct acpi_gpio_chip *acpi_gpio, *tmp;
1466 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1467 list_for_each_entry_safe(acpi_gpio, tmp,
1468 &acpi_gpio_deferred_req_irqs_list,
1469 deferred_req_irqs_list_entry)
1470 acpi_gpiochip_request_irqs(acpi_gpio);
1472 acpi_gpio_deferred_req_irqs_done = true;
1473 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1477 /* We must use _sync so that this runs after the first deferred_probe run */
1478 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1480 static const struct dmi_system_id gpiolib_acpi_quirks[] __initconst = {
1483 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1484 * a non existing micro-USB-B connector which puts the HDMI
1485 * DDC pins in GPIO mode, breaking HDMI support.
1488 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1489 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1491 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1492 .no_edge_events_on_boot = true,
1497 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1498 * instead of controlling the actual micro-USB-B turns the 5V
1499 * boost for its USB-A connector off. The actual micro-USB-B
1500 * connector is wired for charging only.
1503 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1504 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1506 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1507 .no_edge_events_on_boot = true,
1512 * The Dell Venue 10 Pro 5055, with Bay Trail SoC + TI PMIC uses an
1513 * external embedded-controller connected via I2C + an ACPI GPIO
1514 * event handler on INT33FFC:02 pin 12, causing spurious wakeups.
1517 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
1518 DMI_MATCH(DMI_PRODUCT_NAME, "Venue 10 Pro 5055"),
1520 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1521 .ignore_wake = "INT33FC:02@12",
1526 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1527 * external embedded-controller connected via I2C + an ACPI GPIO
1528 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1529 * When suspending by closing the LID, the power to the USB
1530 * keyboard is turned off, causing INT0002 ACPI events to
1531 * trigger once the XHCI controller notices the keyboard is
1532 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1533 * EC wakes breaks wakeup when opening the lid, the user needs
1534 * to press the power-button to wakeup the system. The
1535 * alternative is suspend simply not working, which is worse.
1538 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1539 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1541 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1542 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1547 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1548 * external embedded-controller connected via I2C + an ACPI GPIO
1549 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1552 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1553 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1554 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1556 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1557 .ignore_wake = "INT33FC:02@28",
1562 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1563 * external embedded-controller connected via I2C + an ACPI GPIO
1564 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1567 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1568 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1569 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1571 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1572 .ignore_wake = "INT33FF:01@0",
1575 {} /* Terminating entry */
1578 static int __init acpi_gpio_setup_params(void)
1580 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1581 const struct dmi_system_id *id;
1583 id = dmi_first_match(gpiolib_acpi_quirks);
1585 quirk = id->driver_data;
1587 if (run_edge_events_on_boot < 0) {
1588 if (quirk && quirk->no_edge_events_on_boot)
1589 run_edge_events_on_boot = 0;
1591 run_edge_events_on_boot = 1;
1594 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1595 ignore_wake = quirk->ignore_wake;
1600 /* Directly after dmi_setup() which runs as core_initcall() */
1601 postcore_initcall(acpi_gpio_setup_params);