1 // SPDX-License-Identifier: GPL-2.0
3 * ACPI helpers for GPIO API
5 * Copyright (C) 2012, Intel Corporation
6 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
7 * Mika Westerberg <mika.westerberg@linux.intel.com>
10 #include <linux/dmi.h>
11 #include <linux/errno.h>
12 #include <linux/gpio/consumer.h>
13 #include <linux/gpio/driver.h>
14 #include <linux/gpio/machine.h>
15 #include <linux/export.h>
16 #include <linux/acpi.h>
17 #include <linux/interrupt.h>
18 #include <linux/mutex.h>
19 #include <linux/pinctrl/pinctrl.h>
22 #include "gpiolib-acpi.h"
24 static int run_edge_events_on_boot = -1;
25 module_param(run_edge_events_on_boot, int, 0444);
26 MODULE_PARM_DESC(run_edge_events_on_boot,
27 "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");
29 static char *ignore_wake;
30 module_param(ignore_wake, charp, 0444);
31 MODULE_PARM_DESC(ignore_wake,
32 "controller@pin combos on which to ignore the ACPI wake flag "
33 "ignore_wake=controller@pin[,controller@pin[,...]]");
35 struct acpi_gpiolib_dmi_quirk {
36 bool no_edge_events_on_boot;
41 * struct acpi_gpio_event - ACPI GPIO event handler data
43 * @node: list-entry of the events list of the struct acpi_gpio_chip
44 * @handle: handle of ACPI method to execute when the IRQ triggers
45 * @handler: handler function to pass to request_irq() when requesting the IRQ
46 * @pin: GPIO pin number on the struct gpio_chip
47 * @irq: Linux IRQ number for the event, for request_irq() / free_irq()
48 * @irqflags: flags to pass to request_irq() when requesting the IRQ
49 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
50 * @irq_requested:True if request_irq() has been done
51 * @desc: struct gpio_desc for the GPIO pin for this event
53 struct acpi_gpio_event {
54 struct list_head node;
56 irq_handler_t handler;
59 unsigned long irqflags;
62 struct gpio_desc *desc;
65 struct acpi_gpio_connection {
66 struct list_head node;
68 struct gpio_desc *desc;
71 struct acpi_gpio_chip {
73 * ACPICA requires that the first field of the context parameter
74 * passed to acpi_install_address_space_handler() is large enough
75 * to hold struct acpi_connection_info.
77 struct acpi_connection_info conn_info;
78 struct list_head conns;
79 struct mutex conn_lock;
80 struct gpio_chip *chip;
81 struct list_head events;
82 struct list_head deferred_req_irqs_list_entry;
86 * For GPIO chips which call acpi_gpiochip_request_interrupts() before late_init
87 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
88 * late_initcall_sync() handler, so that other builtin drivers can register their
89 * OpRegions before the event handlers can run. This list contains GPIO chips
90 * for which the acpi_gpiochip_request_irqs() call has been deferred.
92 static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
93 static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
94 static bool acpi_gpio_deferred_req_irqs_done;
96 static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
101 return ACPI_HANDLE(gc->parent) == data;
105 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
106 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
107 * @pin: ACPI GPIO pin number (0-based, controller-relative)
109 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
110 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
111 * controller does not have GPIO chip registered at the moment. This is to
112 * support probe deferral.
114 static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
116 struct gpio_chip *chip;
120 status = acpi_get_handle(NULL, path, &handle);
121 if (ACPI_FAILURE(status))
122 return ERR_PTR(-ENODEV);
124 chip = gpiochip_find(handle, acpi_gpiochip_find);
126 return ERR_PTR(-EPROBE_DEFER);
128 return gpiochip_get_desc(chip, pin);
131 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
133 struct acpi_gpio_event *event = data;
135 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
140 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
142 struct acpi_gpio_event *event = data;
144 acpi_execute_simple_method(event->handle, NULL, event->pin);
149 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
151 /* The address of this function is used as a key. */
154 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
155 struct acpi_resource_gpio **agpio)
157 struct acpi_resource_gpio *gpio;
159 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
162 gpio = &ares->data.gpio;
163 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
169 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
171 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
172 struct acpi_gpio_event *event)
176 ret = request_threaded_irq(event->irq, NULL, event->handler,
177 event->irqflags, "ACPI:Event", event);
179 dev_err(acpi_gpio->chip->parent,
180 "Failed to setup interrupt handler for %d\n",
185 if (event->irq_is_wake)
186 enable_irq_wake(event->irq);
188 event->irq_requested = true;
190 /* Make sure we trigger the initial state of edge-triggered IRQs */
191 if (run_edge_events_on_boot &&
192 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
193 value = gpiod_get_raw_value_cansleep(event->desc);
194 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
195 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
196 event->handler(event->irq, event);
200 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
202 struct acpi_gpio_event *event;
204 list_for_each_entry(event, &acpi_gpio->events, node)
205 acpi_gpiochip_request_irq(acpi_gpio, event);
208 static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
210 const char *controller, *pin_str;
214 controller = ignore_wake;
216 pin_str = strchr(controller, '@');
220 len = pin_str - controller;
221 if (len == strlen(controller_in) &&
222 strncmp(controller, controller_in, len) == 0) {
223 pin = simple_strtoul(pin_str + 1, &endp, 10);
224 if (*endp != 0 && *endp != ',')
231 controller = strchr(controller, ',');
238 pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
243 static bool acpi_gpio_irq_is_wake(struct device *parent,
244 struct acpi_resource_gpio *agpio)
246 int pin = agpio->pin_table[0];
248 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
251 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
252 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
259 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
262 struct acpi_gpio_chip *acpi_gpio = context;
263 struct gpio_chip *chip = acpi_gpio->chip;
264 struct acpi_resource_gpio *agpio;
265 acpi_handle handle, evt_handle;
266 struct acpi_gpio_event *event;
267 irq_handler_t handler = NULL;
268 struct gpio_desc *desc;
271 if (!acpi_gpio_get_irq_resource(ares, &agpio))
274 handle = ACPI_HANDLE(chip->parent);
275 pin = agpio->pin_table[0];
279 sprintf(ev_name, "_%c%02hhX",
280 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
282 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
283 handler = acpi_gpio_irq_handler;
286 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
287 handler = acpi_gpio_irq_handler_evt;
292 desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event",
293 GPIO_ACTIVE_HIGH, GPIOD_IN);
295 dev_err(chip->parent, "Failed to request GPIO\n");
299 ret = gpiochip_lock_as_irq(chip, pin);
301 dev_err(chip->parent, "Failed to lock GPIO as interrupt\n");
305 irq = gpiod_to_irq(desc);
307 dev_err(chip->parent, "Failed to translate GPIO to IRQ\n");
308 goto fail_unlock_irq;
311 event = kzalloc(sizeof(*event), GFP_KERNEL);
313 goto fail_unlock_irq;
315 event->irqflags = IRQF_ONESHOT;
316 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
317 if (agpio->polarity == ACPI_ACTIVE_HIGH)
318 event->irqflags |= IRQF_TRIGGER_HIGH;
320 event->irqflags |= IRQF_TRIGGER_LOW;
322 switch (agpio->polarity) {
323 case ACPI_ACTIVE_HIGH:
324 event->irqflags |= IRQF_TRIGGER_RISING;
326 case ACPI_ACTIVE_LOW:
327 event->irqflags |= IRQF_TRIGGER_FALLING;
330 event->irqflags |= IRQF_TRIGGER_RISING |
331 IRQF_TRIGGER_FALLING;
336 event->handle = evt_handle;
337 event->handler = handler;
339 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
343 list_add_tail(&event->node, &acpi_gpio->events);
348 gpiochip_unlock_as_irq(chip, pin);
350 gpiochip_free_own_desc(desc);
356 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
359 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
360 * handled by ACPI event methods which need to be called from the GPIO
361 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
362 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
363 * the ACPI event methods for those pins.
365 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
367 struct acpi_gpio_chip *acpi_gpio;
372 if (!chip->parent || !chip->to_irq)
375 handle = ACPI_HANDLE(chip->parent);
379 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
380 if (ACPI_FAILURE(status))
383 acpi_walk_resources(handle, "_AEI",
384 acpi_gpiochip_alloc_event, acpi_gpio);
386 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
387 defer = !acpi_gpio_deferred_req_irqs_done;
389 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
390 &acpi_gpio_deferred_req_irqs_list);
391 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
396 acpi_gpiochip_request_irqs(acpi_gpio);
398 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
401 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
404 * Free interrupts associated with GPIO ACPI event method for the given
407 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
409 struct acpi_gpio_chip *acpi_gpio;
410 struct acpi_gpio_event *event, *ep;
414 if (!chip->parent || !chip->to_irq)
417 handle = ACPI_HANDLE(chip->parent);
421 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
422 if (ACPI_FAILURE(status))
425 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
426 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
427 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
428 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
430 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
431 if (event->irq_requested) {
432 if (event->irq_is_wake)
433 disable_irq_wake(event->irq);
435 free_irq(event->irq, event);
438 gpiochip_unlock_as_irq(chip, event->pin);
439 gpiochip_free_own_desc(event->desc);
440 list_del(&event->node);
444 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
446 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
447 const struct acpi_gpio_mapping *gpios)
450 adev->driver_gpios = gpios;
455 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
457 void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
460 adev->driver_gpios = NULL;
462 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
464 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
466 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
469 int devm_acpi_dev_add_driver_gpios(struct device *dev,
470 const struct acpi_gpio_mapping *gpios)
475 res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
479 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
484 devres_add(dev, res);
487 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
489 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
491 WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
493 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
495 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
496 const char *name, int index,
497 struct fwnode_reference_args *args,
498 unsigned int *quirks)
500 const struct acpi_gpio_mapping *gm;
502 if (!adev->driver_gpios)
505 for (gm = adev->driver_gpios; gm->name; gm++)
506 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
507 const struct acpi_gpio_params *par = gm->data + index;
509 args->fwnode = acpi_fwnode_handle(adev);
510 args->args[0] = par->crs_entry_index;
511 args->args[1] = par->line_index;
512 args->args[2] = par->active_low;
515 *quirks = gm->quirks;
522 static enum gpiod_flags
523 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio)
525 switch (agpio->io_restriction) {
526 case ACPI_IO_RESTRICT_INPUT:
528 case ACPI_IO_RESTRICT_OUTPUT:
530 * ACPI GPIO resources don't contain an initial value for the
531 * GPIO. Therefore we deduce that value from the pull field
532 * instead. If the pin is pulled up we assume default to be
533 * high, if it is pulled down we assume default to be low,
534 * otherwise we leave pin untouched.
536 switch (agpio->pin_config) {
537 case ACPI_PIN_CONFIG_PULLUP:
538 return GPIOD_OUT_HIGH;
539 case ACPI_PIN_CONFIG_PULLDOWN:
540 return GPIOD_OUT_LOW;
549 * Assume that the BIOS has configured the direction and pull
556 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
558 const enum gpiod_flags mask =
559 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
560 GPIOD_FLAGS_BIT_DIR_VAL;
564 * Check if the BIOS has IoRestriction with explicitly set direction
565 * and update @flags accordingly. Otherwise use whatever caller asked
568 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
569 enum gpiod_flags diff = *flags ^ update;
572 * Check if caller supplied incompatible GPIO initialization
575 * Return %-EINVAL to notify that firmware has different
576 * settings and we are going to use them.
578 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
579 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
581 *flags = (*flags & ~mask) | (update & mask);
587 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
589 struct device *dev = &info->adev->dev;
590 enum gpiod_flags old = *flags;
593 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
594 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
596 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
599 dev_dbg(dev, "Override GPIO initialization flags\n");
606 int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
607 struct acpi_gpio_info *info)
609 switch (info->pin_config) {
610 case ACPI_PIN_CONFIG_PULLUP:
611 *lookupflags |= GPIO_PULL_UP;
613 case ACPI_PIN_CONFIG_PULLDOWN:
614 *lookupflags |= GPIO_PULL_DOWN;
620 if (info->polarity == GPIO_ACTIVE_LOW)
621 *lookupflags |= GPIO_ACTIVE_LOW;
626 struct acpi_gpio_lookup {
627 struct acpi_gpio_info info;
631 struct gpio_desc *desc;
635 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
637 struct acpi_gpio_lookup *lookup = data;
639 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
643 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
644 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
647 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
650 if (lookup->n++ != lookup->index)
653 pin_index = lookup->pin_index;
654 if (pin_index >= agpio->pin_table_length)
657 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
658 agpio->pin_table[pin_index]);
659 lookup->info.pin_config = agpio->pin_config;
660 lookup->info.gpioint = gpioint;
663 * Polarity and triggering are only specified for GpioInt
665 * Note: we expect here:
666 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
667 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
669 if (lookup->info.gpioint) {
670 lookup->info.flags = GPIOD_IN;
671 lookup->info.polarity = agpio->polarity;
672 lookup->info.triggering = agpio->triggering;
674 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio);
675 lookup->info.polarity = lookup->active_low;
682 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
683 struct acpi_gpio_info *info)
685 struct acpi_device *adev = lookup->info.adev;
686 struct list_head res_list;
689 INIT_LIST_HEAD(&res_list);
691 ret = acpi_dev_get_resources(adev, &res_list,
692 acpi_populate_gpio_lookup,
697 acpi_dev_free_resource_list(&res_list);
703 *info = lookup->info;
707 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
708 const char *propname, int index,
709 struct acpi_gpio_lookup *lookup)
711 struct fwnode_reference_args args;
712 unsigned int quirks = 0;
715 memset(&args, 0, sizeof(args));
716 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
719 struct acpi_device *adev = to_acpi_device_node(fwnode);
724 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
729 * The property was found and resolved, so need to lookup the GPIO based
732 if (!to_acpi_device_node(args.fwnode))
737 lookup->index = args.args[0];
738 lookup->pin_index = args.args[1];
739 lookup->active_low = !!args.args[2];
741 lookup->info.adev = to_acpi_device_node(args.fwnode);
742 lookup->info.quirks = quirks;
748 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
749 * @adev: pointer to a ACPI device to get GPIO from
750 * @propname: Property name of the GPIO (optional)
751 * @index: index of GpioIo/GpioInt resource (starting from %0)
752 * @info: info pointer to fill in (optional)
754 * Function goes through ACPI resources for @adev and based on @index looks
755 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
756 * and returns it. @index matches GpioIo/GpioInt resources only so if there
757 * are total %3 GPIO resources, the index goes from %0 to %2.
759 * If @propname is specified the GPIO is looked using device property. In
760 * that case @index is used to select the GPIO entry in the property value
761 * (in case of multiple).
763 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
766 * Note: if the GPIO resource has multiple entries in the pin list, this
767 * function only returns the first.
769 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
770 const char *propname, int index,
771 struct acpi_gpio_info *info)
773 struct acpi_gpio_lookup lookup;
777 return ERR_PTR(-ENODEV);
779 memset(&lookup, 0, sizeof(lookup));
780 lookup.index = index;
783 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
785 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
786 propname, index, &lookup);
790 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
791 dev_name(&lookup.info.adev->dev), lookup.index,
792 lookup.pin_index, lookup.active_low);
794 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
795 lookup.info.adev = adev;
798 ret = acpi_gpio_resource_lookup(&lookup, info);
799 return ret ? ERR_PTR(ret) : lookup.desc;
802 static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
805 /* Never allow fallback if the device has properties */
806 if (acpi_dev_has_props(adev) || adev->driver_gpios)
809 return con_id == NULL;
812 struct gpio_desc *acpi_find_gpio(struct device *dev,
815 enum gpiod_flags *dflags,
816 unsigned long *lookupflags)
818 struct acpi_device *adev = ACPI_COMPANION(dev);
819 struct acpi_gpio_info info;
820 struct gpio_desc *desc;
824 /* Try first from _DSD */
825 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
827 snprintf(propname, sizeof(propname), "%s-%s",
828 con_id, gpio_suffixes[i]);
830 snprintf(propname, sizeof(propname), "%s",
834 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
837 if (PTR_ERR(desc) == -EPROBE_DEFER)
838 return ERR_CAST(desc);
841 /* Then from plain _CRS GPIOs */
843 if (!acpi_can_fallback_to_crs(adev, con_id))
844 return ERR_PTR(-ENOENT);
846 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
852 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
853 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
854 return ERR_PTR(-ENOENT);
857 acpi_gpio_update_gpiod_flags(dflags, &info);
858 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
863 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
864 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
865 * @propname: Property name of the GPIO
866 * @index: index of GpioIo/GpioInt resource (starting from %0)
867 * @info: info pointer to fill in (optional)
869 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
870 * Otherwise (i.e. it is a data-only non-device object), use the property-based
871 * GPIO lookup to get to the GPIO resource with the relevant information and use
872 * that to obtain the GPIO descriptor to return.
874 * If the GPIO cannot be translated or there is an error an ERR_PTR is
877 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
878 const char *propname, int index,
879 struct acpi_gpio_info *info)
881 struct acpi_gpio_lookup lookup;
882 struct acpi_device *adev;
885 adev = to_acpi_device_node(fwnode);
887 return acpi_get_gpiod_by_index(adev, propname, index, info);
889 if (!is_acpi_data_node(fwnode))
890 return ERR_PTR(-ENODEV);
893 return ERR_PTR(-EINVAL);
895 memset(&lookup, 0, sizeof(lookup));
896 lookup.index = index;
898 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
902 ret = acpi_gpio_resource_lookup(&lookup, info);
903 return ret ? ERR_PTR(ret) : lookup.desc;
907 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
908 * @adev: pointer to a ACPI device to get IRQ from
909 * @index: index of GpioInt resource (starting from %0)
911 * If the device has one or more GpioInt resources, this function can be
912 * used to translate from the GPIO offset in the resource to the Linux IRQ
915 * The function is idempotent, though each time it runs it will configure GPIO
916 * pin direction according to the flags in GpioInt resource.
918 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
920 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
923 unsigned int irq_flags;
926 for (i = 0, idx = 0; idx <= index; i++) {
927 struct acpi_gpio_info info;
928 struct gpio_desc *desc;
930 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
932 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
933 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
934 return PTR_ERR(desc);
936 if (info.gpioint && idx++ == index) {
937 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
942 return PTR_ERR(desc);
944 irq = gpiod_to_irq(desc);
948 snprintf(label, sizeof(label), "GpioInt() %d", index);
949 ret = gpiod_configure_flags(desc, label, lflags, info.flags);
953 irq_flags = acpi_dev_get_irq_type(info.triggering,
956 /* Set type if specified and different than the current one */
957 if (irq_flags != IRQ_TYPE_NONE &&
958 irq_flags != irq_get_trigger_type(irq))
959 irq_set_irq_type(irq, irq_flags);
967 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
970 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
971 u32 bits, u64 *value, void *handler_context,
972 void *region_context)
974 struct acpi_gpio_chip *achip = region_context;
975 struct gpio_chip *chip = achip->chip;
976 struct acpi_resource_gpio *agpio;
977 struct acpi_resource *ares;
978 int pin_index = (int)address;
983 status = acpi_buffer_to_resource(achip->conn_info.connection,
984 achip->conn_info.length, &ares);
985 if (ACPI_FAILURE(status))
988 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
990 return AE_BAD_PARAMETER;
993 agpio = &ares->data.gpio;
995 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
996 function == ACPI_WRITE)) {
998 return AE_BAD_PARAMETER;
1001 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
1002 for (i = pin_index; i < length; ++i) {
1003 int pin = agpio->pin_table[i];
1004 struct acpi_gpio_connection *conn;
1005 struct gpio_desc *desc;
1008 mutex_lock(&achip->conn_lock);
1011 list_for_each_entry(conn, &achip->conns, node) {
1012 if (conn->pin == pin) {
1020 * The same GPIO can be shared between operation region and
1021 * event but only if the access here is ACPI_READ. In that
1022 * case we "borrow" the event GPIO instead.
1024 if (!found && agpio->shareable == ACPI_SHARED &&
1025 function == ACPI_READ) {
1026 struct acpi_gpio_event *event;
1028 list_for_each_entry(event, &achip->events, node) {
1029 if (event->pin == pin) {
1038 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio);
1039 const char *label = "ACPI:OpRegion";
1041 desc = gpiochip_request_own_desc(chip, pin, label,
1046 mutex_unlock(&achip->conn_lock);
1050 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1052 status = AE_NO_MEMORY;
1053 gpiochip_free_own_desc(desc);
1054 mutex_unlock(&achip->conn_lock);
1060 list_add_tail(&conn->node, &achip->conns);
1063 mutex_unlock(&achip->conn_lock);
1065 if (function == ACPI_WRITE)
1066 gpiod_set_raw_value_cansleep(desc,
1067 !!((1 << i) & *value));
1069 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1077 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1079 struct gpio_chip *chip = achip->chip;
1080 acpi_handle handle = ACPI_HANDLE(chip->parent);
1083 INIT_LIST_HEAD(&achip->conns);
1084 mutex_init(&achip->conn_lock);
1085 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1086 acpi_gpio_adr_space_handler,
1088 if (ACPI_FAILURE(status))
1089 dev_err(chip->parent,
1090 "Failed to install GPIO OpRegion handler\n");
1093 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1095 struct gpio_chip *chip = achip->chip;
1096 acpi_handle handle = ACPI_HANDLE(chip->parent);
1097 struct acpi_gpio_connection *conn, *tmp;
1100 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1101 acpi_gpio_adr_space_handler);
1102 if (ACPI_FAILURE(status)) {
1103 dev_err(chip->parent,
1104 "Failed to remove GPIO OpRegion handler\n");
1108 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1109 gpiochip_free_own_desc(conn->desc);
1110 list_del(&conn->node);
1115 static struct gpio_desc *
1116 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1117 struct fwnode_handle *fwnode,
1119 unsigned long *lflags,
1120 enum gpiod_flags *dflags)
1122 struct gpio_chip *chip = achip->chip;
1123 struct gpio_desc *desc;
1127 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1131 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1134 return ERR_PTR(ret);
1136 desc = gpiochip_get_desc(chip, gpios[0]);
1141 *lflags |= GPIO_ACTIVE_LOW;
1143 if (fwnode_property_present(fwnode, "input"))
1144 *dflags |= GPIOD_IN;
1145 else if (fwnode_property_present(fwnode, "output-low"))
1146 *dflags |= GPIOD_OUT_LOW;
1147 else if (fwnode_property_present(fwnode, "output-high"))
1148 *dflags |= GPIOD_OUT_HIGH;
1150 return ERR_PTR(-EINVAL);
1152 fwnode_property_read_string(fwnode, "line-name", name);
1157 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1159 struct gpio_chip *chip = achip->chip;
1160 struct fwnode_handle *fwnode;
1162 device_for_each_child_node(chip->parent, fwnode) {
1163 unsigned long lflags;
1164 enum gpiod_flags dflags;
1165 struct gpio_desc *desc;
1169 if (!fwnode_property_present(fwnode, "gpio-hog"))
1172 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1177 ret = gpiod_hog(desc, name, lflags, dflags);
1179 dev_err(chip->parent, "Failed to hog GPIO\n");
1180 fwnode_handle_put(fwnode);
1186 void acpi_gpiochip_add(struct gpio_chip *chip)
1188 struct acpi_gpio_chip *acpi_gpio;
1192 if (!chip || !chip->parent)
1195 handle = ACPI_HANDLE(chip->parent);
1199 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1201 dev_err(chip->parent,
1202 "Failed to allocate memory for ACPI GPIO chip\n");
1206 acpi_gpio->chip = chip;
1207 INIT_LIST_HEAD(&acpi_gpio->events);
1208 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1210 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1211 if (ACPI_FAILURE(status)) {
1212 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1218 devprop_gpiochip_set_names(chip, dev_fwnode(chip->parent));
1220 acpi_gpiochip_request_regions(acpi_gpio);
1221 acpi_gpiochip_scan_gpios(acpi_gpio);
1222 acpi_walk_dep_device_list(handle);
1225 void acpi_gpiochip_remove(struct gpio_chip *chip)
1227 struct acpi_gpio_chip *acpi_gpio;
1231 if (!chip || !chip->parent)
1234 handle = ACPI_HANDLE(chip->parent);
1238 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1239 if (ACPI_FAILURE(status)) {
1240 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1244 acpi_gpiochip_free_regions(acpi_gpio);
1246 acpi_detach_data(handle, acpi_gpio_chip_dh);
1250 static int acpi_gpio_package_count(const union acpi_object *obj)
1252 const union acpi_object *element = obj->package.elements;
1253 const union acpi_object *end = element + obj->package.count;
1254 unsigned int count = 0;
1256 while (element < end) {
1257 switch (element->type) {
1258 case ACPI_TYPE_LOCAL_REFERENCE:
1261 case ACPI_TYPE_INTEGER:
1274 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1276 unsigned int *count = data;
1278 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1279 *count += ares->data.gpio.pin_table_length;
1285 * acpi_gpio_count - count the GPIOs associated with a device / function
1286 * @dev: GPIO consumer, can be %NULL for system-global GPIOs
1287 * @con_id: function within the GPIO consumer
1290 * The number of GPIOs associated with a device / function or %-ENOENT,
1291 * if no GPIO has been assigned to the requested function.
1293 int acpi_gpio_count(struct device *dev, const char *con_id)
1295 struct acpi_device *adev = ACPI_COMPANION(dev);
1296 const union acpi_object *obj;
1297 const struct acpi_gpio_mapping *gm;
1298 int count = -ENOENT;
1303 /* Try first from _DSD */
1304 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1306 snprintf(propname, sizeof(propname), "%s-%s",
1307 con_id, gpio_suffixes[i]);
1309 snprintf(propname, sizeof(propname), "%s",
1312 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1315 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1317 else if (obj->type == ACPI_TYPE_PACKAGE)
1318 count = acpi_gpio_package_count(obj);
1319 } else if (adev->driver_gpios) {
1320 for (gm = adev->driver_gpios; gm->name; gm++)
1321 if (strcmp(propname, gm->name) == 0) {
1330 /* Then from plain _CRS GPIOs */
1332 struct list_head resource_list;
1333 unsigned int crs_count = 0;
1335 if (!acpi_can_fallback_to_crs(adev, con_id))
1338 INIT_LIST_HEAD(&resource_list);
1339 acpi_dev_get_resources(adev, &resource_list,
1340 acpi_find_gpio_count, &crs_count);
1341 acpi_dev_free_resource_list(&resource_list);
1345 return count ? count : -ENOENT;
1348 /* Run deferred acpi_gpiochip_request_irqs() */
1349 static int acpi_gpio_handle_deferred_request_irqs(void)
1351 struct acpi_gpio_chip *acpi_gpio, *tmp;
1353 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1354 list_for_each_entry_safe(acpi_gpio, tmp,
1355 &acpi_gpio_deferred_req_irqs_list,
1356 deferred_req_irqs_list_entry)
1357 acpi_gpiochip_request_irqs(acpi_gpio);
1359 acpi_gpio_deferred_req_irqs_done = true;
1360 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1364 /* We must use _sync so that this runs after the first deferred_probe run */
1365 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1367 static const struct dmi_system_id gpiolib_acpi_quirks[] = {
1370 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1371 * a non existing micro-USB-B connector which puts the HDMI
1372 * DDC pins in GPIO mode, breaking HDMI support.
1375 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1376 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1378 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1379 .no_edge_events_on_boot = true,
1384 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1385 * instead of controlling the actual micro-USB-B turns the 5V
1386 * boost for its USB-A connector off. The actual micro-USB-B
1387 * connector is wired for charging only.
1390 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1391 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1393 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1394 .no_edge_events_on_boot = true,
1399 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1400 * external embedded-controller connected via I2C + an ACPI GPIO
1401 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1402 * When suspending by closing the LID, the power to the USB
1403 * keyboard is turned off, causing INT0002 ACPI events to
1404 * trigger once the XHCI controller notices the keyboard is
1405 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1406 * EC wakes breaks wakeup when opening the lid, the user needs
1407 * to press the power-button to wakeup the system. The
1408 * alternative is suspend simply not working, which is worse.
1411 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1412 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1414 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1415 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1420 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1421 * external embedded-controller connected via I2C + an ACPI GPIO
1422 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1425 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1426 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1427 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1429 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1430 .ignore_wake = "INT33FC:02@28",
1435 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1436 * external embedded-controller connected via I2C + an ACPI GPIO
1437 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1440 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1441 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1442 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1444 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1445 .ignore_wake = "INT33FF:01@0",
1448 {} /* Terminating entry */
1451 static int acpi_gpio_setup_params(void)
1453 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1454 const struct dmi_system_id *id;
1456 id = dmi_first_match(gpiolib_acpi_quirks);
1458 quirk = id->driver_data;
1460 if (run_edge_events_on_boot < 0) {
1461 if (quirk && quirk->no_edge_events_on_boot)
1462 run_edge_events_on_boot = 0;
1464 run_edge_events_on_boot = 1;
1467 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1468 ignore_wake = quirk->ignore_wake;
1473 /* Directly after dmi_setup() which runs as core_initcall() */
1474 postcore_initcall(acpi_gpio_setup_params);