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, 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, 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 ret = gpio_set_debounce_timeout(desc, agpio->debounce_timeout);
312 dev_warn(chip->parent,
313 "Failed to set debounce-timeout for pin 0x%04X, err %d\n",
319 static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
321 const char *controller, *pin_str;
325 controller = ignore_wake;
327 pin_str = strchr(controller, '@');
331 len = pin_str - controller;
332 if (len == strlen(controller_in) &&
333 strncmp(controller, controller_in, len) == 0) {
334 pin = simple_strtoul(pin_str + 1, &endp, 10);
335 if (*endp != 0 && *endp != ',')
342 controller = strchr(controller, ',');
349 pr_err_once("Error: Invalid value for gpiolib_acpi.ignore_wake: %s\n", ignore_wake);
353 static bool acpi_gpio_irq_is_wake(struct device *parent,
354 struct acpi_resource_gpio *agpio)
356 int pin = agpio->pin_table[0];
358 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
361 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
362 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
369 /* Always returns AE_OK so that we keep looping over the resources */
370 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
373 struct acpi_gpio_chip *acpi_gpio = context;
374 struct gpio_chip *chip = acpi_gpio->chip;
375 struct acpi_resource_gpio *agpio;
376 acpi_handle handle, evt_handle;
377 struct acpi_gpio_event *event;
378 irq_handler_t handler = NULL;
379 struct gpio_desc *desc;
382 if (!acpi_gpio_get_irq_resource(ares, &agpio))
385 handle = ACPI_HANDLE(chip->parent);
386 pin = agpio->pin_table[0];
390 sprintf(ev_name, "_%c%02hhX",
391 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
393 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
394 handler = acpi_gpio_irq_handler;
397 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
398 handler = acpi_gpio_irq_handler_evt;
403 desc = acpi_request_own_gpiod(chip, agpio, 0, "ACPI:Event");
405 dev_err(chip->parent,
406 "Failed to request GPIO for pin 0x%04X, err %ld\n",
411 ret = gpiochip_lock_as_irq(chip, pin);
413 dev_err(chip->parent,
414 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
419 irq = gpiod_to_irq(desc);
421 dev_err(chip->parent,
422 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
424 goto fail_unlock_irq;
427 event = kzalloc(sizeof(*event), GFP_KERNEL);
429 goto fail_unlock_irq;
431 event->irqflags = IRQF_ONESHOT;
432 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
433 if (agpio->polarity == ACPI_ACTIVE_HIGH)
434 event->irqflags |= IRQF_TRIGGER_HIGH;
436 event->irqflags |= IRQF_TRIGGER_LOW;
438 switch (agpio->polarity) {
439 case ACPI_ACTIVE_HIGH:
440 event->irqflags |= IRQF_TRIGGER_RISING;
442 case ACPI_ACTIVE_LOW:
443 event->irqflags |= IRQF_TRIGGER_FALLING;
446 event->irqflags |= IRQF_TRIGGER_RISING |
447 IRQF_TRIGGER_FALLING;
452 event->handle = evt_handle;
453 event->handler = handler;
455 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
459 list_add_tail(&event->node, &acpi_gpio->events);
464 gpiochip_unlock_as_irq(chip, pin);
466 gpiochip_free_own_desc(desc);
472 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
475 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
476 * handled by ACPI event methods which need to be called from the GPIO
477 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
478 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
479 * the ACPI event methods for those pins.
481 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
483 struct acpi_gpio_chip *acpi_gpio;
488 if (!chip->parent || !chip->to_irq)
491 handle = ACPI_HANDLE(chip->parent);
495 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
496 if (ACPI_FAILURE(status))
499 acpi_walk_resources(handle, "_AEI",
500 acpi_gpiochip_alloc_event, acpi_gpio);
502 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
503 defer = !acpi_gpio_deferred_req_irqs_done;
505 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
506 &acpi_gpio_deferred_req_irqs_list);
507 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
512 acpi_gpiochip_request_irqs(acpi_gpio);
514 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
517 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
520 * Free interrupts associated with GPIO ACPI event method for the given
523 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
525 struct acpi_gpio_chip *acpi_gpio;
526 struct acpi_gpio_event *event, *ep;
530 if (!chip->parent || !chip->to_irq)
533 handle = ACPI_HANDLE(chip->parent);
537 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
538 if (ACPI_FAILURE(status))
541 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
542 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
543 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
544 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
546 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
547 if (event->irq_requested) {
548 if (event->irq_is_wake)
549 disable_irq_wake(event->irq);
551 free_irq(event->irq, event);
554 gpiochip_unlock_as_irq(chip, event->pin);
555 gpiochip_free_own_desc(event->desc);
556 list_del(&event->node);
560 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
562 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
563 const struct acpi_gpio_mapping *gpios)
566 adev->driver_gpios = gpios;
571 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
573 void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
576 adev->driver_gpios = NULL;
578 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
580 static void acpi_dev_release_driver_gpios(void *adev)
582 acpi_dev_remove_driver_gpios(adev);
585 int devm_acpi_dev_add_driver_gpios(struct device *dev,
586 const struct acpi_gpio_mapping *gpios)
588 struct acpi_device *adev = ACPI_COMPANION(dev);
591 ret = acpi_dev_add_driver_gpios(adev, gpios);
595 return devm_add_action_or_reset(dev, acpi_dev_release_driver_gpios, adev);
597 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
599 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
600 const char *name, int index,
601 struct fwnode_reference_args *args,
602 unsigned int *quirks)
604 const struct acpi_gpio_mapping *gm;
606 if (!adev->driver_gpios)
609 for (gm = adev->driver_gpios; gm->name; gm++)
610 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
611 const struct acpi_gpio_params *par = gm->data + index;
613 args->fwnode = acpi_fwnode_handle(adev);
614 args->args[0] = par->crs_entry_index;
615 args->args[1] = par->line_index;
616 args->args[2] = par->active_low;
619 *quirks = gm->quirks;
627 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
629 const enum gpiod_flags mask =
630 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
631 GPIOD_FLAGS_BIT_DIR_VAL;
635 * Check if the BIOS has IoRestriction with explicitly set direction
636 * and update @flags accordingly. Otherwise use whatever caller asked
639 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
640 enum gpiod_flags diff = *flags ^ update;
643 * Check if caller supplied incompatible GPIO initialization
646 * Return %-EINVAL to notify that firmware has different
647 * settings and we are going to use them.
649 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
650 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
652 *flags = (*flags & ~mask) | (update & mask);
658 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
660 struct device *dev = &info->adev->dev;
661 enum gpiod_flags old = *flags;
664 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
665 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
667 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
670 dev_dbg(dev, "Override GPIO initialization flags\n");
677 int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
678 struct acpi_gpio_info *info)
680 switch (info->pin_config) {
681 case ACPI_PIN_CONFIG_PULLUP:
682 *lookupflags |= GPIO_PULL_UP;
684 case ACPI_PIN_CONFIG_PULLDOWN:
685 *lookupflags |= GPIO_PULL_DOWN;
691 if (info->polarity == GPIO_ACTIVE_LOW)
692 *lookupflags |= GPIO_ACTIVE_LOW;
697 struct acpi_gpio_lookup {
698 struct acpi_gpio_info info;
702 struct gpio_desc *desc;
706 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
708 struct acpi_gpio_lookup *lookup = data;
710 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
714 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
715 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
716 struct gpio_desc *desc;
719 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
722 if (lookup->n++ != lookup->index)
725 pin_index = lookup->pin_index;
726 if (pin_index >= agpio->pin_table_length)
729 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER)
730 desc = gpio_to_desc(agpio->pin_table[pin_index]);
732 desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
733 agpio->pin_table[pin_index]);
735 lookup->info.pin_config = agpio->pin_config;
736 lookup->info.debounce = agpio->debounce_timeout;
737 lookup->info.gpioint = gpioint;
740 * Polarity and triggering are only specified for GpioInt
742 * Note: we expect here:
743 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
744 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
746 if (lookup->info.gpioint) {
747 lookup->info.polarity = agpio->polarity;
748 lookup->info.triggering = agpio->triggering;
750 lookup->info.polarity = lookup->active_low;
753 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio, lookup->info.polarity);
759 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
760 struct acpi_gpio_info *info)
762 struct acpi_device *adev = lookup->info.adev;
763 struct list_head res_list;
766 INIT_LIST_HEAD(&res_list);
768 ret = acpi_dev_get_resources(adev, &res_list,
769 acpi_populate_gpio_lookup,
774 acpi_dev_free_resource_list(&res_list);
780 *info = lookup->info;
784 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
785 const char *propname, int index,
786 struct acpi_gpio_lookup *lookup)
788 struct fwnode_reference_args args;
789 unsigned int quirks = 0;
792 memset(&args, 0, sizeof(args));
793 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
796 struct acpi_device *adev = to_acpi_device_node(fwnode);
801 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
806 * The property was found and resolved, so need to lookup the GPIO based
809 if (!to_acpi_device_node(args.fwnode))
814 lookup->index = args.args[0];
815 lookup->pin_index = args.args[1];
816 lookup->active_low = !!args.args[2];
818 lookup->info.adev = to_acpi_device_node(args.fwnode);
819 lookup->info.quirks = quirks;
825 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
826 * @adev: pointer to a ACPI device to get GPIO from
827 * @propname: Property name of the GPIO (optional)
828 * @index: index of GpioIo/GpioInt resource (starting from %0)
829 * @info: info pointer to fill in (optional)
831 * Function goes through ACPI resources for @adev and based on @index looks
832 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
833 * and returns it. @index matches GpioIo/GpioInt resources only so if there
834 * are total %3 GPIO resources, the index goes from %0 to %2.
836 * If @propname is specified the GPIO is looked using device property. In
837 * that case @index is used to select the GPIO entry in the property value
838 * (in case of multiple).
840 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
843 * Note: if the GPIO resource has multiple entries in the pin list, this
844 * function only returns the first.
846 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
847 const char *propname, int index,
848 struct acpi_gpio_info *info)
850 struct acpi_gpio_lookup lookup;
854 return ERR_PTR(-ENODEV);
856 memset(&lookup, 0, sizeof(lookup));
857 lookup.index = index;
860 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
862 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
863 propname, index, &lookup);
867 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %u %u\n",
868 dev_name(&lookup.info.adev->dev), lookup.index,
869 lookup.pin_index, lookup.active_low);
871 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
872 lookup.info.adev = adev;
875 ret = acpi_gpio_resource_lookup(&lookup, info);
876 return ret ? ERR_PTR(ret) : lookup.desc;
879 static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
882 /* Never allow fallback if the device has properties */
883 if (acpi_dev_has_props(adev) || adev->driver_gpios)
886 return con_id == NULL;
889 struct gpio_desc *acpi_find_gpio(struct device *dev,
892 enum gpiod_flags *dflags,
893 unsigned long *lookupflags)
895 struct acpi_device *adev = ACPI_COMPANION(dev);
896 struct acpi_gpio_info info;
897 struct gpio_desc *desc;
901 /* Try first from _DSD */
902 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
904 snprintf(propname, sizeof(propname), "%s-%s",
905 con_id, gpio_suffixes[i]);
907 snprintf(propname, sizeof(propname), "%s",
911 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
914 if (PTR_ERR(desc) == -EPROBE_DEFER)
915 return ERR_CAST(desc);
918 /* Then from plain _CRS GPIOs */
920 if (!acpi_can_fallback_to_crs(adev, con_id))
921 return ERR_PTR(-ENOENT);
923 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
929 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
930 dev_dbg(&adev->dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
931 return ERR_PTR(-ENOENT);
934 acpi_gpio_update_gpiod_flags(dflags, &info);
935 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
940 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
941 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
942 * @propname: Property name of the GPIO
943 * @index: index of GpioIo/GpioInt resource (starting from %0)
944 * @info: info pointer to fill in (optional)
946 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
947 * Otherwise (i.e. it is a data-only non-device object), use the property-based
948 * GPIO lookup to get to the GPIO resource with the relevant information and use
949 * that to obtain the GPIO descriptor to return.
951 * If the GPIO cannot be translated or there is an error an ERR_PTR is
954 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
955 const char *propname, int index,
956 struct acpi_gpio_info *info)
958 struct acpi_gpio_lookup lookup;
959 struct acpi_device *adev;
962 adev = to_acpi_device_node(fwnode);
964 return acpi_get_gpiod_by_index(adev, propname, index, info);
966 if (!is_acpi_data_node(fwnode))
967 return ERR_PTR(-ENODEV);
970 return ERR_PTR(-EINVAL);
972 memset(&lookup, 0, sizeof(lookup));
973 lookup.index = index;
975 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
979 ret = acpi_gpio_resource_lookup(&lookup, info);
980 return ret ? ERR_PTR(ret) : lookup.desc;
984 * acpi_dev_gpio_irq_get_by() - Find GpioInt and translate it to Linux IRQ number
985 * @adev: pointer to a ACPI device to get IRQ from
986 * @name: optional name of GpioInt resource
987 * @index: index of GpioInt resource (starting from %0)
989 * If the device has one or more GpioInt resources, this function can be
990 * used to translate from the GPIO offset in the resource to the Linux IRQ
993 * The function is idempotent, though each time it runs it will configure GPIO
994 * pin direction according to the flags in GpioInt resource.
996 * The function takes optional @name parameter. If the resource has a property
997 * name, then only those will be taken into account.
999 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
1001 int acpi_dev_gpio_irq_get_by(struct acpi_device *adev, const char *name, int index)
1004 unsigned int irq_flags;
1007 for (i = 0, idx = 0; idx <= index; i++) {
1008 struct acpi_gpio_info info;
1009 struct gpio_desc *desc;
1011 desc = acpi_get_gpiod_by_index(adev, name, i, &info);
1013 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
1014 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
1015 return PTR_ERR(desc);
1017 if (info.gpioint && idx++ == index) {
1018 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1019 enum gpiod_flags dflags = GPIOD_ASIS;
1024 return PTR_ERR(desc);
1026 irq = gpiod_to_irq(desc);
1030 acpi_gpio_update_gpiod_flags(&dflags, &info);
1031 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
1033 snprintf(label, sizeof(label), "GpioInt() %d", index);
1034 ret = gpiod_configure_flags(desc, label, lflags, dflags);
1038 ret = gpio_set_debounce_timeout(desc, info.debounce);
1042 irq_flags = acpi_dev_get_irq_type(info.triggering,
1046 * If the IRQ is not already in use then set type
1047 * if specified and different than the current one.
1049 if (can_request_irq(irq, irq_flags)) {
1050 if (irq_flags != IRQ_TYPE_NONE &&
1051 irq_flags != irq_get_trigger_type(irq))
1052 irq_set_irq_type(irq, irq_flags);
1054 dev_dbg(&adev->dev, "IRQ %d already in use\n", irq);
1063 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get_by);
1066 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
1067 u32 bits, u64 *value, void *handler_context,
1068 void *region_context)
1070 struct acpi_gpio_chip *achip = region_context;
1071 struct gpio_chip *chip = achip->chip;
1072 struct acpi_resource_gpio *agpio;
1073 struct acpi_resource *ares;
1074 u16 pin_index = address;
1079 status = acpi_buffer_to_resource(achip->conn_info.connection,
1080 achip->conn_info.length, &ares);
1081 if (ACPI_FAILURE(status))
1084 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
1086 return AE_BAD_PARAMETER;
1089 agpio = &ares->data.gpio;
1091 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
1092 function == ACPI_WRITE)) {
1094 return AE_BAD_PARAMETER;
1097 length = min_t(u16, agpio->pin_table_length, pin_index + bits);
1098 for (i = pin_index; i < length; ++i) {
1099 int pin = agpio->pin_table[i];
1100 struct acpi_gpio_connection *conn;
1101 struct gpio_desc *desc;
1104 mutex_lock(&achip->conn_lock);
1107 list_for_each_entry(conn, &achip->conns, node) {
1108 if (conn->pin == pin) {
1116 * The same GPIO can be shared between operation region and
1117 * event but only if the access here is ACPI_READ. In that
1118 * case we "borrow" the event GPIO instead.
1120 if (!found && agpio->shareable == ACPI_SHARED &&
1121 function == ACPI_READ) {
1122 struct acpi_gpio_event *event;
1124 list_for_each_entry(event, &achip->events, node) {
1125 if (event->pin == pin) {
1134 desc = acpi_request_own_gpiod(chip, agpio, i, "ACPI:OpRegion");
1136 mutex_unlock(&achip->conn_lock);
1141 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1143 gpiochip_free_own_desc(desc);
1144 mutex_unlock(&achip->conn_lock);
1145 status = AE_NO_MEMORY;
1151 list_add_tail(&conn->node, &achip->conns);
1154 mutex_unlock(&achip->conn_lock);
1156 if (function == ACPI_WRITE)
1157 gpiod_set_raw_value_cansleep(desc, !!(*value & BIT(i)));
1159 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1167 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1169 struct gpio_chip *chip = achip->chip;
1170 acpi_handle handle = ACPI_HANDLE(chip->parent);
1173 INIT_LIST_HEAD(&achip->conns);
1174 mutex_init(&achip->conn_lock);
1175 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1176 acpi_gpio_adr_space_handler,
1178 if (ACPI_FAILURE(status))
1179 dev_err(chip->parent,
1180 "Failed to install GPIO OpRegion handler\n");
1183 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1185 struct gpio_chip *chip = achip->chip;
1186 acpi_handle handle = ACPI_HANDLE(chip->parent);
1187 struct acpi_gpio_connection *conn, *tmp;
1190 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1191 acpi_gpio_adr_space_handler);
1192 if (ACPI_FAILURE(status)) {
1193 dev_err(chip->parent,
1194 "Failed to remove GPIO OpRegion handler\n");
1198 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1199 gpiochip_free_own_desc(conn->desc);
1200 list_del(&conn->node);
1205 static struct gpio_desc *
1206 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1207 struct fwnode_handle *fwnode,
1209 unsigned long *lflags,
1210 enum gpiod_flags *dflags)
1212 struct gpio_chip *chip = achip->chip;
1213 struct gpio_desc *desc;
1217 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1218 *dflags = GPIOD_ASIS;
1221 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1224 return ERR_PTR(ret);
1226 desc = gpiochip_get_desc(chip, gpios[0]);
1231 *lflags |= GPIO_ACTIVE_LOW;
1233 if (fwnode_property_present(fwnode, "input"))
1234 *dflags |= GPIOD_IN;
1235 else if (fwnode_property_present(fwnode, "output-low"))
1236 *dflags |= GPIOD_OUT_LOW;
1237 else if (fwnode_property_present(fwnode, "output-high"))
1238 *dflags |= GPIOD_OUT_HIGH;
1240 return ERR_PTR(-EINVAL);
1242 fwnode_property_read_string(fwnode, "line-name", name);
1247 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1249 struct gpio_chip *chip = achip->chip;
1250 struct fwnode_handle *fwnode;
1252 device_for_each_child_node(chip->parent, fwnode) {
1253 unsigned long lflags;
1254 enum gpiod_flags dflags;
1255 struct gpio_desc *desc;
1259 if (!fwnode_property_present(fwnode, "gpio-hog"))
1262 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1267 ret = gpiod_hog(desc, name, lflags, dflags);
1269 dev_err(chip->parent, "Failed to hog GPIO\n");
1270 fwnode_handle_put(fwnode);
1276 void acpi_gpiochip_add(struct gpio_chip *chip)
1278 struct acpi_gpio_chip *acpi_gpio;
1279 struct acpi_device *adev;
1282 if (!chip || !chip->parent)
1285 adev = ACPI_COMPANION(chip->parent);
1289 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1291 dev_err(chip->parent,
1292 "Failed to allocate memory for ACPI GPIO chip\n");
1296 acpi_gpio->chip = chip;
1297 INIT_LIST_HEAD(&acpi_gpio->events);
1298 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1300 status = acpi_attach_data(adev->handle, acpi_gpio_chip_dh, acpi_gpio);
1301 if (ACPI_FAILURE(status)) {
1302 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1307 acpi_gpiochip_request_regions(acpi_gpio);
1308 acpi_gpiochip_scan_gpios(acpi_gpio);
1309 acpi_dev_clear_dependencies(adev);
1312 void acpi_gpiochip_remove(struct gpio_chip *chip)
1314 struct acpi_gpio_chip *acpi_gpio;
1318 if (!chip || !chip->parent)
1321 handle = ACPI_HANDLE(chip->parent);
1325 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1326 if (ACPI_FAILURE(status)) {
1327 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1331 acpi_gpiochip_free_regions(acpi_gpio);
1333 acpi_detach_data(handle, acpi_gpio_chip_dh);
1337 void acpi_gpio_dev_init(struct gpio_chip *gc, struct gpio_device *gdev)
1339 /* Set default fwnode to parent's one if present */
1341 ACPI_COMPANION_SET(&gdev->dev, ACPI_COMPANION(gc->parent));
1344 device_set_node(&gdev->dev, gc->fwnode);
1347 static int acpi_gpio_package_count(const union acpi_object *obj)
1349 const union acpi_object *element = obj->package.elements;
1350 const union acpi_object *end = element + obj->package.count;
1351 unsigned int count = 0;
1353 while (element < end) {
1354 switch (element->type) {
1355 case ACPI_TYPE_LOCAL_REFERENCE:
1358 case ACPI_TYPE_INTEGER:
1371 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1373 unsigned int *count = data;
1375 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1376 *count += ares->data.gpio.pin_table_length;
1382 * acpi_gpio_count - count the GPIOs associated with a device / function
1383 * @dev: GPIO consumer, can be %NULL for system-global GPIOs
1384 * @con_id: function within the GPIO consumer
1387 * The number of GPIOs associated with a device / function or %-ENOENT,
1388 * if no GPIO has been assigned to the requested function.
1390 int acpi_gpio_count(struct device *dev, const char *con_id)
1392 struct acpi_device *adev = ACPI_COMPANION(dev);
1393 const union acpi_object *obj;
1394 const struct acpi_gpio_mapping *gm;
1395 int count = -ENOENT;
1400 /* Try first from _DSD */
1401 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1403 snprintf(propname, sizeof(propname), "%s-%s",
1404 con_id, gpio_suffixes[i]);
1406 snprintf(propname, sizeof(propname), "%s",
1409 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1412 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1414 else if (obj->type == ACPI_TYPE_PACKAGE)
1415 count = acpi_gpio_package_count(obj);
1416 } else if (adev->driver_gpios) {
1417 for (gm = adev->driver_gpios; gm->name; gm++)
1418 if (strcmp(propname, gm->name) == 0) {
1427 /* Then from plain _CRS GPIOs */
1429 struct list_head resource_list;
1430 unsigned int crs_count = 0;
1432 if (!acpi_can_fallback_to_crs(adev, con_id))
1435 INIT_LIST_HEAD(&resource_list);
1436 acpi_dev_get_resources(adev, &resource_list,
1437 acpi_find_gpio_count, &crs_count);
1438 acpi_dev_free_resource_list(&resource_list);
1442 return count ? count : -ENOENT;
1445 /* Run deferred acpi_gpiochip_request_irqs() */
1446 static int __init acpi_gpio_handle_deferred_request_irqs(void)
1448 struct acpi_gpio_chip *acpi_gpio, *tmp;
1450 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1451 list_for_each_entry_safe(acpi_gpio, tmp,
1452 &acpi_gpio_deferred_req_irqs_list,
1453 deferred_req_irqs_list_entry)
1454 acpi_gpiochip_request_irqs(acpi_gpio);
1456 acpi_gpio_deferred_req_irqs_done = true;
1457 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1461 /* We must use _sync so that this runs after the first deferred_probe run */
1462 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1464 static const struct dmi_system_id gpiolib_acpi_quirks[] __initconst = {
1467 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1468 * a non existing micro-USB-B connector which puts the HDMI
1469 * DDC pins in GPIO mode, breaking HDMI support.
1472 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1473 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1475 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1476 .no_edge_events_on_boot = true,
1481 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1482 * instead of controlling the actual micro-USB-B turns the 5V
1483 * boost for its USB-A connector off. The actual micro-USB-B
1484 * connector is wired for charging only.
1487 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1488 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1490 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1491 .no_edge_events_on_boot = true,
1496 * The Dell Venue 10 Pro 5055, with Bay Trail SoC + TI PMIC uses an
1497 * external embedded-controller connected via I2C + an ACPI GPIO
1498 * event handler on INT33FFC:02 pin 12, causing spurious wakeups.
1501 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
1502 DMI_MATCH(DMI_PRODUCT_NAME, "Venue 10 Pro 5055"),
1504 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1505 .ignore_wake = "INT33FC:02@12",
1510 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1511 * external embedded-controller connected via I2C + an ACPI GPIO
1512 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1513 * When suspending by closing the LID, the power to the USB
1514 * keyboard is turned off, causing INT0002 ACPI events to
1515 * trigger once the XHCI controller notices the keyboard is
1516 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1517 * EC wakes breaks wakeup when opening the lid, the user needs
1518 * to press the power-button to wakeup the system. The
1519 * alternative is suspend simply not working, which is worse.
1522 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1523 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1525 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1526 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1531 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1532 * external embedded-controller connected via I2C + an ACPI GPIO
1533 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1536 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1537 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1538 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1540 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1541 .ignore_wake = "INT33FC:02@28",
1546 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1547 * external embedded-controller connected via I2C + an ACPI GPIO
1548 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1551 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1552 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1553 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1555 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1556 .ignore_wake = "INT33FF:01@0",
1559 {} /* Terminating entry */
1562 static int __init acpi_gpio_setup_params(void)
1564 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1565 const struct dmi_system_id *id;
1567 id = dmi_first_match(gpiolib_acpi_quirks);
1569 quirk = id->driver_data;
1571 if (run_edge_events_on_boot < 0) {
1572 if (quirk && quirk->no_edge_events_on_boot)
1573 run_edge_events_on_boot = 0;
1575 run_edge_events_on_boot = 1;
1578 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1579 ignore_wake = quirk->ignore_wake;
1584 /* Directly after dmi_setup() which runs as core_initcall() */
1585 postcore_initcall(acpi_gpio_setup_params);