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);
132 * acpi_get_and_request_gpiod - Translate ACPI GPIO pin to GPIO descriptor and
133 * hold a refcount to the GPIO device.
134 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
135 * @pin: ACPI GPIO pin number (0-based, controller-relative)
136 * @label: Label to pass to gpiod_request()
138 * This function is a simple pass-through to acpi_get_gpiod(), except that
139 * as it is intended for use outside of the GPIO layer (in a similar fashion to
140 * gpiod_get_index() for example) it also holds a reference to the GPIO device.
142 struct gpio_desc *acpi_get_and_request_gpiod(char *path, int pin, char *label)
144 struct gpio_desc *gpio;
147 gpio = acpi_get_gpiod(path, pin);
151 ret = gpiod_request(gpio, label);
157 EXPORT_SYMBOL_GPL(acpi_get_and_request_gpiod);
159 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
161 struct acpi_gpio_event *event = data;
163 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
168 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
170 struct acpi_gpio_event *event = data;
172 acpi_execute_simple_method(event->handle, NULL, event->pin);
177 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
179 /* The address of this function is used as a key. */
182 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
183 struct acpi_resource_gpio **agpio)
185 struct acpi_resource_gpio *gpio;
187 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
190 gpio = &ares->data.gpio;
191 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
197 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
200 * acpi_gpio_get_io_resource - Fetch details of an ACPI resource if it is a GPIO
201 * I/O resource or return False if not.
202 * @ares: Pointer to the ACPI resource to fetch
203 * @agpio: Pointer to a &struct acpi_resource_gpio to store the output pointer
205 bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
206 struct acpi_resource_gpio **agpio)
208 struct acpi_resource_gpio *gpio;
210 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
213 gpio = &ares->data.gpio;
214 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_IO)
220 EXPORT_SYMBOL_GPL(acpi_gpio_get_io_resource);
222 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
223 struct acpi_gpio_event *event)
227 ret = request_threaded_irq(event->irq, NULL, event->handler,
228 event->irqflags | IRQF_ONESHOT, "ACPI:Event", event);
230 dev_err(acpi_gpio->chip->parent,
231 "Failed to setup interrupt handler for %d\n",
236 if (event->irq_is_wake)
237 enable_irq_wake(event->irq);
239 event->irq_requested = true;
241 /* Make sure we trigger the initial state of edge-triggered IRQs */
242 if (run_edge_events_on_boot &&
243 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
244 value = gpiod_get_raw_value_cansleep(event->desc);
245 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
246 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
247 event->handler(event->irq, event);
251 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
253 struct acpi_gpio_event *event;
255 list_for_each_entry(event, &acpi_gpio->events, node)
256 acpi_gpiochip_request_irq(acpi_gpio, event);
259 static enum gpiod_flags
260 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio, int polarity)
262 /* GpioInt() implies input configuration */
263 if (agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
266 switch (agpio->io_restriction) {
267 case ACPI_IO_RESTRICT_INPUT:
269 case ACPI_IO_RESTRICT_OUTPUT:
271 * ACPI GPIO resources don't contain an initial value for the
272 * GPIO. Therefore we deduce that value from the pull field
273 * and the polarity instead. If the pin is pulled up we assume
274 * default to be high, if it is pulled down we assume default
275 * to be low, otherwise we leave pin untouched. For active low
276 * polarity values will be switched. See also
277 * Documentation/firmware-guide/acpi/gpio-properties.rst.
279 switch (agpio->pin_config) {
280 case ACPI_PIN_CONFIG_PULLUP:
281 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_LOW : GPIOD_OUT_HIGH;
282 case ACPI_PIN_CONFIG_PULLDOWN:
283 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
293 * Assume that the BIOS has configured the direction and pull
299 static struct gpio_desc *acpi_request_own_gpiod(struct gpio_chip *chip,
300 struct acpi_resource_gpio *agpio,
304 int polarity = GPIO_ACTIVE_HIGH;
305 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio, polarity);
306 unsigned int pin = agpio->pin_table[index];
307 struct gpio_desc *desc;
310 desc = gpiochip_request_own_desc(chip, pin, label, polarity, flags);
314 /* ACPI uses hundredths of milliseconds units */
315 ret = gpio_set_debounce_timeout(desc, agpio->debounce_timeout * 10);
317 dev_warn(chip->parent,
318 "Failed to set debounce-timeout for pin 0x%04X, err %d\n",
324 static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
326 const char *controller, *pin_str;
330 controller = ignore_wake;
332 pin_str = strchr(controller, '@');
336 len = pin_str - controller;
337 if (len == strlen(controller_in) &&
338 strncmp(controller, controller_in, len) == 0) {
339 pin = simple_strtoul(pin_str + 1, &endp, 10);
340 if (*endp != 0 && *endp != ',')
347 controller = strchr(controller, ',');
354 pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
359 static bool acpi_gpio_irq_is_wake(struct device *parent,
360 struct acpi_resource_gpio *agpio)
362 int pin = agpio->pin_table[0];
364 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
367 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
368 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
375 /* Always returns AE_OK so that we keep looping over the resources */
376 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
379 struct acpi_gpio_chip *acpi_gpio = context;
380 struct gpio_chip *chip = acpi_gpio->chip;
381 struct acpi_resource_gpio *agpio;
382 acpi_handle handle, evt_handle;
383 struct acpi_gpio_event *event;
384 irq_handler_t handler = NULL;
385 struct gpio_desc *desc;
388 if (!acpi_gpio_get_irq_resource(ares, &agpio))
391 handle = ACPI_HANDLE(chip->parent);
392 pin = agpio->pin_table[0];
396 sprintf(ev_name, "_%c%02X",
397 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
399 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
400 handler = acpi_gpio_irq_handler;
403 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
404 handler = acpi_gpio_irq_handler_evt;
409 desc = acpi_request_own_gpiod(chip, agpio, 0, "ACPI:Event");
411 dev_err(chip->parent,
412 "Failed to request GPIO for pin 0x%04X, err %ld\n",
417 ret = gpiochip_lock_as_irq(chip, pin);
419 dev_err(chip->parent,
420 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
425 irq = gpiod_to_irq(desc);
427 dev_err(chip->parent,
428 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
430 goto fail_unlock_irq;
433 event = kzalloc(sizeof(*event), GFP_KERNEL);
435 goto fail_unlock_irq;
437 event->irqflags = IRQF_ONESHOT;
438 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
439 if (agpio->polarity == ACPI_ACTIVE_HIGH)
440 event->irqflags |= IRQF_TRIGGER_HIGH;
442 event->irqflags |= IRQF_TRIGGER_LOW;
444 switch (agpio->polarity) {
445 case ACPI_ACTIVE_HIGH:
446 event->irqflags |= IRQF_TRIGGER_RISING;
448 case ACPI_ACTIVE_LOW:
449 event->irqflags |= IRQF_TRIGGER_FALLING;
452 event->irqflags |= IRQF_TRIGGER_RISING |
453 IRQF_TRIGGER_FALLING;
458 event->handle = evt_handle;
459 event->handler = handler;
461 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
465 list_add_tail(&event->node, &acpi_gpio->events);
470 gpiochip_unlock_as_irq(chip, pin);
472 gpiochip_free_own_desc(desc);
478 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
481 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
482 * handled by ACPI event methods which need to be called from the GPIO
483 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
484 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
485 * the ACPI event methods for those pins.
487 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
489 struct acpi_gpio_chip *acpi_gpio;
494 if (!chip->parent || !chip->to_irq)
497 handle = ACPI_HANDLE(chip->parent);
501 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
502 if (ACPI_FAILURE(status))
505 acpi_walk_resources(handle, "_AEI",
506 acpi_gpiochip_alloc_event, acpi_gpio);
508 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
509 defer = !acpi_gpio_deferred_req_irqs_done;
511 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
512 &acpi_gpio_deferred_req_irqs_list);
513 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
518 acpi_gpiochip_request_irqs(acpi_gpio);
520 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
523 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
526 * Free interrupts associated with GPIO ACPI event method for the given
529 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
531 struct acpi_gpio_chip *acpi_gpio;
532 struct acpi_gpio_event *event, *ep;
536 if (!chip->parent || !chip->to_irq)
539 handle = ACPI_HANDLE(chip->parent);
543 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
544 if (ACPI_FAILURE(status))
547 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
548 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
549 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
550 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
552 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
553 if (event->irq_requested) {
554 if (event->irq_is_wake)
555 disable_irq_wake(event->irq);
557 free_irq(event->irq, event);
560 gpiochip_unlock_as_irq(chip, event->pin);
561 gpiochip_free_own_desc(event->desc);
562 list_del(&event->node);
566 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
568 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
569 const struct acpi_gpio_mapping *gpios)
572 adev->driver_gpios = gpios;
577 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
579 void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
582 adev->driver_gpios = NULL;
584 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
586 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
588 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
591 int devm_acpi_dev_add_driver_gpios(struct device *dev,
592 const struct acpi_gpio_mapping *gpios)
597 res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
601 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
606 devres_add(dev, res);
609 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
611 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
613 WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
615 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
617 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
618 const char *name, int index,
619 struct fwnode_reference_args *args,
620 unsigned int *quirks)
622 const struct acpi_gpio_mapping *gm;
624 if (!adev->driver_gpios)
627 for (gm = adev->driver_gpios; gm->name; gm++)
628 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
629 const struct acpi_gpio_params *par = gm->data + index;
631 args->fwnode = acpi_fwnode_handle(adev);
632 args->args[0] = par->crs_entry_index;
633 args->args[1] = par->line_index;
634 args->args[2] = par->active_low;
637 *quirks = gm->quirks;
645 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
647 const enum gpiod_flags mask =
648 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
649 GPIOD_FLAGS_BIT_DIR_VAL;
653 * Check if the BIOS has IoRestriction with explicitly set direction
654 * and update @flags accordingly. Otherwise use whatever caller asked
657 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
658 enum gpiod_flags diff = *flags ^ update;
661 * Check if caller supplied incompatible GPIO initialization
664 * Return %-EINVAL to notify that firmware has different
665 * settings and we are going to use them.
667 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
668 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
670 *flags = (*flags & ~mask) | (update & mask);
676 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
678 struct device *dev = &info->adev->dev;
679 enum gpiod_flags old = *flags;
682 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
683 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
685 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
688 dev_dbg(dev, "Override GPIO initialization flags\n");
695 int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
696 struct acpi_gpio_info *info)
698 switch (info->pin_config) {
699 case ACPI_PIN_CONFIG_PULLUP:
700 *lookupflags |= GPIO_PULL_UP;
702 case ACPI_PIN_CONFIG_PULLDOWN:
703 *lookupflags |= GPIO_PULL_DOWN;
709 if (info->polarity == GPIO_ACTIVE_LOW)
710 *lookupflags |= GPIO_ACTIVE_LOW;
715 struct acpi_gpio_lookup {
716 struct acpi_gpio_info info;
720 struct gpio_desc *desc;
724 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
726 struct acpi_gpio_lookup *lookup = data;
728 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
732 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
733 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
734 struct gpio_desc *desc;
737 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
740 if (lookup->n++ != lookup->index)
743 pin_index = lookup->pin_index;
744 if (pin_index >= agpio->pin_table_length)
747 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER)
748 desc = gpio_to_desc(agpio->pin_table[pin_index]);
750 desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
751 agpio->pin_table[pin_index]);
753 lookup->info.pin_config = agpio->pin_config;
754 lookup->info.debounce = agpio->debounce_timeout;
755 lookup->info.gpioint = gpioint;
758 * Polarity and triggering are only specified for GpioInt
760 * Note: we expect here:
761 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
762 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
764 if (lookup->info.gpioint) {
765 lookup->info.polarity = agpio->polarity;
766 lookup->info.triggering = agpio->triggering;
768 lookup->info.polarity = lookup->active_low;
771 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio, lookup->info.polarity);
777 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
778 struct acpi_gpio_info *info)
780 struct acpi_device *adev = lookup->info.adev;
781 struct list_head res_list;
784 INIT_LIST_HEAD(&res_list);
786 ret = acpi_dev_get_resources(adev, &res_list,
787 acpi_populate_gpio_lookup,
792 acpi_dev_free_resource_list(&res_list);
798 *info = lookup->info;
802 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
803 const char *propname, int index,
804 struct acpi_gpio_lookup *lookup)
806 struct fwnode_reference_args args;
807 unsigned int quirks = 0;
810 memset(&args, 0, sizeof(args));
811 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
814 struct acpi_device *adev = to_acpi_device_node(fwnode);
819 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
824 * The property was found and resolved, so need to lookup the GPIO based
827 if (!to_acpi_device_node(args.fwnode))
832 lookup->index = args.args[0];
833 lookup->pin_index = args.args[1];
834 lookup->active_low = !!args.args[2];
836 lookup->info.adev = to_acpi_device_node(args.fwnode);
837 lookup->info.quirks = quirks;
843 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
844 * @adev: pointer to a ACPI device to get GPIO from
845 * @propname: Property name of the GPIO (optional)
846 * @index: index of GpioIo/GpioInt resource (starting from %0)
847 * @info: info pointer to fill in (optional)
849 * Function goes through ACPI resources for @adev and based on @index looks
850 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
851 * and returns it. @index matches GpioIo/GpioInt resources only so if there
852 * are total %3 GPIO resources, the index goes from %0 to %2.
854 * If @propname is specified the GPIO is looked using device property. In
855 * that case @index is used to select the GPIO entry in the property value
856 * (in case of multiple).
858 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
861 * Note: if the GPIO resource has multiple entries in the pin list, this
862 * function only returns the first.
864 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
865 const char *propname, int index,
866 struct acpi_gpio_info *info)
868 struct acpi_gpio_lookup lookup;
872 return ERR_PTR(-ENODEV);
874 memset(&lookup, 0, sizeof(lookup));
875 lookup.index = index;
878 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
880 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
881 propname, index, &lookup);
885 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %u %u\n",
886 dev_name(&lookup.info.adev->dev), lookup.index,
887 lookup.pin_index, lookup.active_low);
889 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
890 lookup.info.adev = adev;
893 ret = acpi_gpio_resource_lookup(&lookup, info);
894 return ret ? ERR_PTR(ret) : lookup.desc;
897 static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
900 /* Never allow fallback if the device has properties */
901 if (acpi_dev_has_props(adev) || adev->driver_gpios)
904 return con_id == NULL;
907 struct gpio_desc *acpi_find_gpio(struct device *dev,
910 enum gpiod_flags *dflags,
911 unsigned long *lookupflags)
913 struct acpi_device *adev = ACPI_COMPANION(dev);
914 struct acpi_gpio_info info;
915 struct gpio_desc *desc;
919 /* Try first from _DSD */
920 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
922 snprintf(propname, sizeof(propname), "%s-%s",
923 con_id, gpio_suffixes[i]);
925 snprintf(propname, sizeof(propname), "%s",
929 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
932 if (PTR_ERR(desc) == -EPROBE_DEFER)
933 return ERR_CAST(desc);
936 /* Then from plain _CRS GPIOs */
938 if (!acpi_can_fallback_to_crs(adev, con_id))
939 return ERR_PTR(-ENOENT);
941 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
947 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
948 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
949 return ERR_PTR(-ENOENT);
952 acpi_gpio_update_gpiod_flags(dflags, &info);
953 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
958 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
959 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
960 * @propname: Property name of the GPIO
961 * @index: index of GpioIo/GpioInt resource (starting from %0)
962 * @info: info pointer to fill in (optional)
964 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
965 * Otherwise (i.e. it is a data-only non-device object), use the property-based
966 * GPIO lookup to get to the GPIO resource with the relevant information and use
967 * that to obtain the GPIO descriptor to return.
969 * If the GPIO cannot be translated or there is an error an ERR_PTR is
972 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
973 const char *propname, int index,
974 struct acpi_gpio_info *info)
976 struct acpi_gpio_lookup lookup;
977 struct acpi_device *adev;
980 adev = to_acpi_device_node(fwnode);
982 return acpi_get_gpiod_by_index(adev, propname, index, info);
984 if (!is_acpi_data_node(fwnode))
985 return ERR_PTR(-ENODEV);
988 return ERR_PTR(-EINVAL);
990 memset(&lookup, 0, sizeof(lookup));
991 lookup.index = index;
993 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
997 ret = acpi_gpio_resource_lookup(&lookup, info);
998 return ret ? ERR_PTR(ret) : lookup.desc;
1002 * acpi_dev_gpio_irq_get_by() - Find GpioInt and translate it to Linux IRQ number
1003 * @adev: pointer to a ACPI device to get IRQ from
1004 * @name: optional name of GpioInt resource
1005 * @index: index of GpioInt resource (starting from %0)
1007 * If the device has one or more GpioInt resources, this function can be
1008 * used to translate from the GPIO offset in the resource to the Linux IRQ
1011 * The function is idempotent, though each time it runs it will configure GPIO
1012 * pin direction according to the flags in GpioInt resource.
1014 * The function takes optional @name parameter. If the resource has a property
1015 * name, then only those will be taken into account.
1017 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
1019 int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index)
1022 unsigned int irq_flags;
1025 for (i = 0, idx = 0; idx <= index; i++) {
1026 struct acpi_gpio_info info;
1027 struct gpio_desc *desc;
1029 desc = acpi_get_gpiod_by_index(adev, name, i, &info);
1031 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
1032 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
1033 return PTR_ERR(desc);
1035 if (info.gpioint && idx++ == index) {
1036 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1037 enum gpiod_flags dflags = GPIOD_ASIS;
1042 return PTR_ERR(desc);
1044 irq = gpiod_to_irq(desc);
1048 acpi_gpio_update_gpiod_flags(&dflags, &info);
1049 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
1051 snprintf(label, sizeof(label), "GpioInt() %d", index);
1052 ret = gpiod_configure_flags(desc, label, lflags, dflags);
1056 /* ACPI uses hundredths of milliseconds units */
1057 ret = gpio_set_debounce_timeout(desc, info.debounce * 10);
1061 irq_flags = acpi_dev_get_irq_type(info.triggering,
1065 * If the IRQ is not already in use then set type
1066 * if specified and different than the current one.
1068 if (can_request_irq(irq, irq_flags)) {
1069 if (irq_flags != IRQ_TYPE_NONE &&
1070 irq_flags != irq_get_trigger_type(irq))
1071 irq_set_irq_type(irq, irq_flags);
1073 dev_dbg(&adev->dev, "IRQ %d already in use\n", irq);
1082 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get_by);
1085 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
1086 u32 bits, u64 *value, void *handler_context,
1087 void *region_context)
1089 struct acpi_gpio_chip *achip = region_context;
1090 struct gpio_chip *chip = achip->chip;
1091 struct acpi_resource_gpio *agpio;
1092 struct acpi_resource *ares;
1093 u16 pin_index = address;
1098 status = acpi_buffer_to_resource(achip->conn_info.connection,
1099 achip->conn_info.length, &ares);
1100 if (ACPI_FAILURE(status))
1103 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
1105 return AE_BAD_PARAMETER;
1108 agpio = &ares->data.gpio;
1110 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
1111 function == ACPI_WRITE)) {
1113 return AE_BAD_PARAMETER;
1116 length = min_t(u16, agpio->pin_table_length, pin_index + bits);
1117 for (i = pin_index; i < length; ++i) {
1118 int pin = agpio->pin_table[i];
1119 struct acpi_gpio_connection *conn;
1120 struct gpio_desc *desc;
1123 mutex_lock(&achip->conn_lock);
1126 list_for_each_entry(conn, &achip->conns, node) {
1127 if (conn->pin == pin) {
1135 * The same GPIO can be shared between operation region and
1136 * event but only if the access here is ACPI_READ. In that
1137 * case we "borrow" the event GPIO instead.
1139 if (!found && agpio->shareable == ACPI_SHARED &&
1140 function == ACPI_READ) {
1141 struct acpi_gpio_event *event;
1143 list_for_each_entry(event, &achip->events, node) {
1144 if (event->pin == pin) {
1153 desc = acpi_request_own_gpiod(chip, agpio, i, "ACPI:OpRegion");
1155 mutex_unlock(&achip->conn_lock);
1160 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1162 gpiochip_free_own_desc(desc);
1163 mutex_unlock(&achip->conn_lock);
1164 status = AE_NO_MEMORY;
1170 list_add_tail(&conn->node, &achip->conns);
1173 mutex_unlock(&achip->conn_lock);
1175 if (function == ACPI_WRITE)
1176 gpiod_set_raw_value_cansleep(desc, !!(*value & BIT(i)));
1178 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1186 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1188 struct gpio_chip *chip = achip->chip;
1189 acpi_handle handle = ACPI_HANDLE(chip->parent);
1192 INIT_LIST_HEAD(&achip->conns);
1193 mutex_init(&achip->conn_lock);
1194 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1195 acpi_gpio_adr_space_handler,
1197 if (ACPI_FAILURE(status))
1198 dev_err(chip->parent,
1199 "Failed to install GPIO OpRegion handler\n");
1202 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1204 struct gpio_chip *chip = achip->chip;
1205 acpi_handle handle = ACPI_HANDLE(chip->parent);
1206 struct acpi_gpio_connection *conn, *tmp;
1209 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1210 acpi_gpio_adr_space_handler);
1211 if (ACPI_FAILURE(status)) {
1212 dev_err(chip->parent,
1213 "Failed to remove GPIO OpRegion handler\n");
1217 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1218 gpiochip_free_own_desc(conn->desc);
1219 list_del(&conn->node);
1224 static struct gpio_desc *
1225 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1226 struct fwnode_handle *fwnode,
1228 unsigned long *lflags,
1229 enum gpiod_flags *dflags)
1231 struct gpio_chip *chip = achip->chip;
1232 struct gpio_desc *desc;
1236 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1237 *dflags = GPIOD_ASIS;
1240 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1243 return ERR_PTR(ret);
1245 desc = gpiochip_get_desc(chip, gpios[0]);
1250 *lflags |= GPIO_ACTIVE_LOW;
1252 if (fwnode_property_present(fwnode, "input"))
1253 *dflags |= GPIOD_IN;
1254 else if (fwnode_property_present(fwnode, "output-low"))
1255 *dflags |= GPIOD_OUT_LOW;
1256 else if (fwnode_property_present(fwnode, "output-high"))
1257 *dflags |= GPIOD_OUT_HIGH;
1259 return ERR_PTR(-EINVAL);
1261 fwnode_property_read_string(fwnode, "line-name", name);
1266 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1268 struct gpio_chip *chip = achip->chip;
1269 struct fwnode_handle *fwnode;
1271 device_for_each_child_node(chip->parent, fwnode) {
1272 unsigned long lflags;
1273 enum gpiod_flags dflags;
1274 struct gpio_desc *desc;
1278 if (!fwnode_property_present(fwnode, "gpio-hog"))
1281 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1286 ret = gpiod_hog(desc, name, lflags, dflags);
1288 dev_err(chip->parent, "Failed to hog GPIO\n");
1289 fwnode_handle_put(fwnode);
1295 void acpi_gpiochip_add(struct gpio_chip *chip)
1297 struct acpi_gpio_chip *acpi_gpio;
1298 struct acpi_device *adev;
1301 if (!chip || !chip->parent)
1304 adev = ACPI_COMPANION(chip->parent);
1308 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1310 dev_err(chip->parent,
1311 "Failed to allocate memory for ACPI GPIO chip\n");
1315 acpi_gpio->chip = chip;
1316 INIT_LIST_HEAD(&acpi_gpio->events);
1317 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1319 status = acpi_attach_data(adev->handle, acpi_gpio_chip_dh, acpi_gpio);
1320 if (ACPI_FAILURE(status)) {
1321 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1326 acpi_gpiochip_request_regions(acpi_gpio);
1327 acpi_gpiochip_scan_gpios(acpi_gpio);
1328 acpi_dev_clear_dependencies(adev);
1331 void acpi_gpiochip_remove(struct gpio_chip *chip)
1333 struct acpi_gpio_chip *acpi_gpio;
1337 if (!chip || !chip->parent)
1340 handle = ACPI_HANDLE(chip->parent);
1344 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1345 if (ACPI_FAILURE(status)) {
1346 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1350 acpi_gpiochip_free_regions(acpi_gpio);
1352 acpi_detach_data(handle, acpi_gpio_chip_dh);
1356 void acpi_gpio_dev_init(struct gpio_chip *gc, struct gpio_device *gdev)
1358 /* Set default fwnode to parent's one if present */
1360 ACPI_COMPANION_SET(&gdev->dev, ACPI_COMPANION(gc->parent));
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);