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 enum gpiod_flags
209 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio, int polarity)
211 /* GpioInt() implies input configuration */
212 if (agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
215 switch (agpio->io_restriction) {
216 case ACPI_IO_RESTRICT_INPUT:
218 case ACPI_IO_RESTRICT_OUTPUT:
220 * ACPI GPIO resources don't contain an initial value for the
221 * GPIO. Therefore we deduce that value from the pull field
222 * and the polarity instead. If the pin is pulled up we assume
223 * default to be high, if it is pulled down we assume default
224 * to be low, otherwise we leave pin untouched. For active low
225 * polarity values will be switched. See also
226 * Documentation/firmware-guide/acpi/gpio-properties.rst.
228 switch (agpio->pin_config) {
229 case ACPI_PIN_CONFIG_PULLUP:
230 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_LOW : GPIOD_OUT_HIGH;
231 case ACPI_PIN_CONFIG_PULLDOWN:
232 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
241 * Assume that the BIOS has configured the direction and pull
247 static struct gpio_desc *acpi_request_own_gpiod(struct gpio_chip *chip,
248 struct acpi_resource_gpio *agpio,
252 int polarity = GPIO_ACTIVE_HIGH;
253 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio, polarity);
254 unsigned int pin = agpio->pin_table[index];
255 struct gpio_desc *desc;
258 desc = gpiochip_request_own_desc(chip, pin, label, polarity, flags);
262 ret = gpio_set_debounce_timeout(desc, agpio->debounce_timeout);
264 gpiochip_free_own_desc(desc);
266 return ret ? ERR_PTR(ret) : desc;
269 static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
271 const char *controller, *pin_str;
275 controller = ignore_wake;
277 pin_str = strchr(controller, '@');
281 len = pin_str - controller;
282 if (len == strlen(controller_in) &&
283 strncmp(controller, controller_in, len) == 0) {
284 pin = simple_strtoul(pin_str + 1, &endp, 10);
285 if (*endp != 0 && *endp != ',')
292 controller = strchr(controller, ',');
299 pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
304 static bool acpi_gpio_irq_is_wake(struct device *parent,
305 struct acpi_resource_gpio *agpio)
307 int pin = agpio->pin_table[0];
309 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
312 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
313 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
320 /* Always returns AE_OK so that we keep looping over the resources */
321 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
324 struct acpi_gpio_chip *acpi_gpio = context;
325 struct gpio_chip *chip = acpi_gpio->chip;
326 struct acpi_resource_gpio *agpio;
327 acpi_handle handle, evt_handle;
328 struct acpi_gpio_event *event;
329 irq_handler_t handler = NULL;
330 struct gpio_desc *desc;
333 if (!acpi_gpio_get_irq_resource(ares, &agpio))
336 handle = ACPI_HANDLE(chip->parent);
337 pin = agpio->pin_table[0];
341 sprintf(ev_name, "_%c%02hhX",
342 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
344 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
345 handler = acpi_gpio_irq_handler;
348 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
349 handler = acpi_gpio_irq_handler_evt;
354 desc = acpi_request_own_gpiod(chip, agpio, 0, "ACPI:Event");
356 dev_err(chip->parent,
357 "Failed to request GPIO for pin 0x%04X, err %ld\n",
362 ret = gpiochip_lock_as_irq(chip, pin);
364 dev_err(chip->parent,
365 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
370 irq = gpiod_to_irq(desc);
372 dev_err(chip->parent,
373 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
375 goto fail_unlock_irq;
378 event = kzalloc(sizeof(*event), GFP_KERNEL);
380 goto fail_unlock_irq;
382 event->irqflags = IRQF_ONESHOT;
383 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
384 if (agpio->polarity == ACPI_ACTIVE_HIGH)
385 event->irqflags |= IRQF_TRIGGER_HIGH;
387 event->irqflags |= IRQF_TRIGGER_LOW;
389 switch (agpio->polarity) {
390 case ACPI_ACTIVE_HIGH:
391 event->irqflags |= IRQF_TRIGGER_RISING;
393 case ACPI_ACTIVE_LOW:
394 event->irqflags |= IRQF_TRIGGER_FALLING;
397 event->irqflags |= IRQF_TRIGGER_RISING |
398 IRQF_TRIGGER_FALLING;
403 event->handle = evt_handle;
404 event->handler = handler;
406 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
410 list_add_tail(&event->node, &acpi_gpio->events);
415 gpiochip_unlock_as_irq(chip, pin);
417 gpiochip_free_own_desc(desc);
423 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
426 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
427 * handled by ACPI event methods which need to be called from the GPIO
428 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
429 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
430 * the ACPI event methods for those pins.
432 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
434 struct acpi_gpio_chip *acpi_gpio;
439 if (!chip->parent || !chip->to_irq)
442 handle = ACPI_HANDLE(chip->parent);
446 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
447 if (ACPI_FAILURE(status))
450 acpi_walk_resources(handle, "_AEI",
451 acpi_gpiochip_alloc_event, acpi_gpio);
453 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
454 defer = !acpi_gpio_deferred_req_irqs_done;
456 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
457 &acpi_gpio_deferred_req_irqs_list);
458 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
463 acpi_gpiochip_request_irqs(acpi_gpio);
465 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
468 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
471 * Free interrupts associated with GPIO ACPI event method for the given
474 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
476 struct acpi_gpio_chip *acpi_gpio;
477 struct acpi_gpio_event *event, *ep;
481 if (!chip->parent || !chip->to_irq)
484 handle = ACPI_HANDLE(chip->parent);
488 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
489 if (ACPI_FAILURE(status))
492 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
493 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
494 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
495 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
497 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
498 if (event->irq_requested) {
499 if (event->irq_is_wake)
500 disable_irq_wake(event->irq);
502 free_irq(event->irq, event);
505 gpiochip_unlock_as_irq(chip, event->pin);
506 gpiochip_free_own_desc(event->desc);
507 list_del(&event->node);
511 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
513 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
514 const struct acpi_gpio_mapping *gpios)
517 adev->driver_gpios = gpios;
522 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
524 void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
527 adev->driver_gpios = NULL;
529 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
531 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
533 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
536 int devm_acpi_dev_add_driver_gpios(struct device *dev,
537 const struct acpi_gpio_mapping *gpios)
542 res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
546 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
551 devres_add(dev, res);
554 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
556 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
558 WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
560 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
562 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
563 const char *name, int index,
564 struct fwnode_reference_args *args,
565 unsigned int *quirks)
567 const struct acpi_gpio_mapping *gm;
569 if (!adev->driver_gpios)
572 for (gm = adev->driver_gpios; gm->name; gm++)
573 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
574 const struct acpi_gpio_params *par = gm->data + index;
576 args->fwnode = acpi_fwnode_handle(adev);
577 args->args[0] = par->crs_entry_index;
578 args->args[1] = par->line_index;
579 args->args[2] = par->active_low;
582 *quirks = gm->quirks;
590 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
592 const enum gpiod_flags mask =
593 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
594 GPIOD_FLAGS_BIT_DIR_VAL;
598 * Check if the BIOS has IoRestriction with explicitly set direction
599 * and update @flags accordingly. Otherwise use whatever caller asked
602 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
603 enum gpiod_flags diff = *flags ^ update;
606 * Check if caller supplied incompatible GPIO initialization
609 * Return %-EINVAL to notify that firmware has different
610 * settings and we are going to use them.
612 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
613 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
615 *flags = (*flags & ~mask) | (update & mask);
621 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
623 struct device *dev = &info->adev->dev;
624 enum gpiod_flags old = *flags;
627 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
628 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
630 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
633 dev_dbg(dev, "Override GPIO initialization flags\n");
640 int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
641 struct acpi_gpio_info *info)
643 switch (info->pin_config) {
644 case ACPI_PIN_CONFIG_PULLUP:
645 *lookupflags |= GPIO_PULL_UP;
647 case ACPI_PIN_CONFIG_PULLDOWN:
648 *lookupflags |= GPIO_PULL_DOWN;
654 if (info->polarity == GPIO_ACTIVE_LOW)
655 *lookupflags |= GPIO_ACTIVE_LOW;
660 struct acpi_gpio_lookup {
661 struct acpi_gpio_info info;
665 struct gpio_desc *desc;
669 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
671 struct acpi_gpio_lookup *lookup = data;
673 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
677 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
678 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
681 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
684 if (lookup->n++ != lookup->index)
687 pin_index = lookup->pin_index;
688 if (pin_index >= agpio->pin_table_length)
691 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
692 agpio->pin_table[pin_index]);
693 lookup->info.pin_config = agpio->pin_config;
694 lookup->info.debounce = agpio->debounce_timeout;
695 lookup->info.gpioint = gpioint;
698 * Polarity and triggering are only specified for GpioInt
700 * Note: we expect here:
701 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
702 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
704 if (lookup->info.gpioint) {
705 lookup->info.polarity = agpio->polarity;
706 lookup->info.triggering = agpio->triggering;
708 lookup->info.polarity = lookup->active_low;
711 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio, lookup->info.polarity);
717 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
718 struct acpi_gpio_info *info)
720 struct acpi_device *adev = lookup->info.adev;
721 struct list_head res_list;
724 INIT_LIST_HEAD(&res_list);
726 ret = acpi_dev_get_resources(adev, &res_list,
727 acpi_populate_gpio_lookup,
732 acpi_dev_free_resource_list(&res_list);
738 *info = lookup->info;
742 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
743 const char *propname, int index,
744 struct acpi_gpio_lookup *lookup)
746 struct fwnode_reference_args args;
747 unsigned int quirks = 0;
750 memset(&args, 0, sizeof(args));
751 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
754 struct acpi_device *adev = to_acpi_device_node(fwnode);
759 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
764 * The property was found and resolved, so need to lookup the GPIO based
767 if (!to_acpi_device_node(args.fwnode))
772 lookup->index = args.args[0];
773 lookup->pin_index = args.args[1];
774 lookup->active_low = !!args.args[2];
776 lookup->info.adev = to_acpi_device_node(args.fwnode);
777 lookup->info.quirks = quirks;
783 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
784 * @adev: pointer to a ACPI device to get GPIO from
785 * @propname: Property name of the GPIO (optional)
786 * @index: index of GpioIo/GpioInt resource (starting from %0)
787 * @info: info pointer to fill in (optional)
789 * Function goes through ACPI resources for @adev and based on @index looks
790 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
791 * and returns it. @index matches GpioIo/GpioInt resources only so if there
792 * are total %3 GPIO resources, the index goes from %0 to %2.
794 * If @propname is specified the GPIO is looked using device property. In
795 * that case @index is used to select the GPIO entry in the property value
796 * (in case of multiple).
798 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
801 * Note: if the GPIO resource has multiple entries in the pin list, this
802 * function only returns the first.
804 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
805 const char *propname, int index,
806 struct acpi_gpio_info *info)
808 struct acpi_gpio_lookup lookup;
812 return ERR_PTR(-ENODEV);
814 memset(&lookup, 0, sizeof(lookup));
815 lookup.index = index;
818 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
820 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
821 propname, index, &lookup);
825 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %u %u\n",
826 dev_name(&lookup.info.adev->dev), lookup.index,
827 lookup.pin_index, lookup.active_low);
829 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
830 lookup.info.adev = adev;
833 ret = acpi_gpio_resource_lookup(&lookup, info);
834 return ret ? ERR_PTR(ret) : lookup.desc;
837 static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
840 /* Never allow fallback if the device has properties */
841 if (acpi_dev_has_props(adev) || adev->driver_gpios)
844 return con_id == NULL;
847 struct gpio_desc *acpi_find_gpio(struct device *dev,
850 enum gpiod_flags *dflags,
851 unsigned long *lookupflags)
853 struct acpi_device *adev = ACPI_COMPANION(dev);
854 struct acpi_gpio_info info;
855 struct gpio_desc *desc;
859 /* Try first from _DSD */
860 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
862 snprintf(propname, sizeof(propname), "%s-%s",
863 con_id, gpio_suffixes[i]);
865 snprintf(propname, sizeof(propname), "%s",
869 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
872 if (PTR_ERR(desc) == -EPROBE_DEFER)
873 return ERR_CAST(desc);
876 /* Then from plain _CRS GPIOs */
878 if (!acpi_can_fallback_to_crs(adev, con_id))
879 return ERR_PTR(-ENOENT);
881 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
887 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
888 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
889 return ERR_PTR(-ENOENT);
892 acpi_gpio_update_gpiod_flags(dflags, &info);
893 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
898 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
899 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
900 * @propname: Property name of the GPIO
901 * @index: index of GpioIo/GpioInt resource (starting from %0)
902 * @info: info pointer to fill in (optional)
904 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
905 * Otherwise (i.e. it is a data-only non-device object), use the property-based
906 * GPIO lookup to get to the GPIO resource with the relevant information and use
907 * that to obtain the GPIO descriptor to return.
909 * If the GPIO cannot be translated or there is an error an ERR_PTR is
912 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
913 const char *propname, int index,
914 struct acpi_gpio_info *info)
916 struct acpi_gpio_lookup lookup;
917 struct acpi_device *adev;
920 adev = to_acpi_device_node(fwnode);
922 return acpi_get_gpiod_by_index(adev, propname, index, info);
924 if (!is_acpi_data_node(fwnode))
925 return ERR_PTR(-ENODEV);
928 return ERR_PTR(-EINVAL);
930 memset(&lookup, 0, sizeof(lookup));
931 lookup.index = index;
933 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
937 ret = acpi_gpio_resource_lookup(&lookup, info);
938 return ret ? ERR_PTR(ret) : lookup.desc;
942 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
943 * @adev: pointer to a ACPI device to get IRQ from
944 * @index: index of GpioInt resource (starting from %0)
946 * If the device has one or more GpioInt resources, this function can be
947 * used to translate from the GPIO offset in the resource to the Linux IRQ
950 * The function is idempotent, though each time it runs it will configure GPIO
951 * pin direction according to the flags in GpioInt resource.
953 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
955 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
958 unsigned int irq_flags;
961 for (i = 0, idx = 0; idx <= index; i++) {
962 struct acpi_gpio_info info;
963 struct gpio_desc *desc;
965 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
967 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
968 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
969 return PTR_ERR(desc);
971 if (info.gpioint && idx++ == index) {
972 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
973 enum gpiod_flags dflags = GPIOD_ASIS;
978 return PTR_ERR(desc);
980 irq = gpiod_to_irq(desc);
984 acpi_gpio_update_gpiod_flags(&dflags, &info);
985 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
987 snprintf(label, sizeof(label), "GpioInt() %d", index);
988 ret = gpiod_configure_flags(desc, label, lflags, dflags);
992 ret = gpio_set_debounce_timeout(desc, info.debounce);
996 irq_flags = acpi_dev_get_irq_type(info.triggering,
999 /* Set type if specified and different than the current one */
1000 if (irq_flags != IRQ_TYPE_NONE &&
1001 irq_flags != irq_get_trigger_type(irq))
1002 irq_set_irq_type(irq, irq_flags);
1010 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
1013 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
1014 u32 bits, u64 *value, void *handler_context,
1015 void *region_context)
1017 struct acpi_gpio_chip *achip = region_context;
1018 struct gpio_chip *chip = achip->chip;
1019 struct acpi_resource_gpio *agpio;
1020 struct acpi_resource *ares;
1021 u16 pin_index = address;
1026 status = acpi_buffer_to_resource(achip->conn_info.connection,
1027 achip->conn_info.length, &ares);
1028 if (ACPI_FAILURE(status))
1031 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
1033 return AE_BAD_PARAMETER;
1036 agpio = &ares->data.gpio;
1038 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
1039 function == ACPI_WRITE)) {
1041 return AE_BAD_PARAMETER;
1044 length = min_t(u16, agpio->pin_table_length, pin_index + bits);
1045 for (i = pin_index; i < length; ++i) {
1046 int pin = agpio->pin_table[i];
1047 struct acpi_gpio_connection *conn;
1048 struct gpio_desc *desc;
1051 mutex_lock(&achip->conn_lock);
1054 list_for_each_entry(conn, &achip->conns, node) {
1055 if (conn->pin == pin) {
1063 * The same GPIO can be shared between operation region and
1064 * event but only if the access here is ACPI_READ. In that
1065 * case we "borrow" the event GPIO instead.
1067 if (!found && agpio->shareable == ACPI_SHARED &&
1068 function == ACPI_READ) {
1069 struct acpi_gpio_event *event;
1071 list_for_each_entry(event, &achip->events, node) {
1072 if (event->pin == pin) {
1081 desc = acpi_request_own_gpiod(chip, agpio, i, "ACPI:OpRegion");
1083 mutex_unlock(&achip->conn_lock);
1088 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1090 gpiochip_free_own_desc(desc);
1091 mutex_unlock(&achip->conn_lock);
1092 status = AE_NO_MEMORY;
1098 list_add_tail(&conn->node, &achip->conns);
1101 mutex_unlock(&achip->conn_lock);
1103 if (function == ACPI_WRITE)
1104 gpiod_set_raw_value_cansleep(desc,
1105 !!((1 << i) & *value));
1107 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1115 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1117 struct gpio_chip *chip = achip->chip;
1118 acpi_handle handle = ACPI_HANDLE(chip->parent);
1121 INIT_LIST_HEAD(&achip->conns);
1122 mutex_init(&achip->conn_lock);
1123 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1124 acpi_gpio_adr_space_handler,
1126 if (ACPI_FAILURE(status))
1127 dev_err(chip->parent,
1128 "Failed to install GPIO OpRegion handler\n");
1131 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1133 struct gpio_chip *chip = achip->chip;
1134 acpi_handle handle = ACPI_HANDLE(chip->parent);
1135 struct acpi_gpio_connection *conn, *tmp;
1138 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1139 acpi_gpio_adr_space_handler);
1140 if (ACPI_FAILURE(status)) {
1141 dev_err(chip->parent,
1142 "Failed to remove GPIO OpRegion handler\n");
1146 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1147 gpiochip_free_own_desc(conn->desc);
1148 list_del(&conn->node);
1153 static struct gpio_desc *
1154 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1155 struct fwnode_handle *fwnode,
1157 unsigned long *lflags,
1158 enum gpiod_flags *dflags)
1160 struct gpio_chip *chip = achip->chip;
1161 struct gpio_desc *desc;
1165 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1166 *dflags = GPIOD_ASIS;
1169 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1172 return ERR_PTR(ret);
1174 desc = gpiochip_get_desc(chip, gpios[0]);
1179 *lflags |= GPIO_ACTIVE_LOW;
1181 if (fwnode_property_present(fwnode, "input"))
1182 *dflags |= GPIOD_IN;
1183 else if (fwnode_property_present(fwnode, "output-low"))
1184 *dflags |= GPIOD_OUT_LOW;
1185 else if (fwnode_property_present(fwnode, "output-high"))
1186 *dflags |= GPIOD_OUT_HIGH;
1188 return ERR_PTR(-EINVAL);
1190 fwnode_property_read_string(fwnode, "line-name", name);
1195 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1197 struct gpio_chip *chip = achip->chip;
1198 struct fwnode_handle *fwnode;
1200 device_for_each_child_node(chip->parent, fwnode) {
1201 unsigned long lflags;
1202 enum gpiod_flags dflags;
1203 struct gpio_desc *desc;
1207 if (!fwnode_property_present(fwnode, "gpio-hog"))
1210 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1215 ret = gpiod_hog(desc, name, lflags, dflags);
1217 dev_err(chip->parent, "Failed to hog GPIO\n");
1218 fwnode_handle_put(fwnode);
1224 void acpi_gpiochip_add(struct gpio_chip *chip)
1226 struct acpi_gpio_chip *acpi_gpio;
1230 if (!chip || !chip->parent)
1233 handle = ACPI_HANDLE(chip->parent);
1237 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1239 dev_err(chip->parent,
1240 "Failed to allocate memory for ACPI GPIO chip\n");
1244 acpi_gpio->chip = chip;
1245 INIT_LIST_HEAD(&acpi_gpio->events);
1246 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1248 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1249 if (ACPI_FAILURE(status)) {
1250 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1255 acpi_gpiochip_request_regions(acpi_gpio);
1256 acpi_gpiochip_scan_gpios(acpi_gpio);
1257 acpi_walk_dep_device_list(handle);
1260 void acpi_gpiochip_remove(struct gpio_chip *chip)
1262 struct acpi_gpio_chip *acpi_gpio;
1266 if (!chip || !chip->parent)
1269 handle = ACPI_HANDLE(chip->parent);
1273 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1274 if (ACPI_FAILURE(status)) {
1275 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1279 acpi_gpiochip_free_regions(acpi_gpio);
1281 acpi_detach_data(handle, acpi_gpio_chip_dh);
1285 static int acpi_gpio_package_count(const union acpi_object *obj)
1287 const union acpi_object *element = obj->package.elements;
1288 const union acpi_object *end = element + obj->package.count;
1289 unsigned int count = 0;
1291 while (element < end) {
1292 switch (element->type) {
1293 case ACPI_TYPE_LOCAL_REFERENCE:
1296 case ACPI_TYPE_INTEGER:
1309 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1311 unsigned int *count = data;
1313 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1314 *count += ares->data.gpio.pin_table_length;
1320 * acpi_gpio_count - count the GPIOs associated with a device / function
1321 * @dev: GPIO consumer, can be %NULL for system-global GPIOs
1322 * @con_id: function within the GPIO consumer
1325 * The number of GPIOs associated with a device / function or %-ENOENT,
1326 * if no GPIO has been assigned to the requested function.
1328 int acpi_gpio_count(struct device *dev, const char *con_id)
1330 struct acpi_device *adev = ACPI_COMPANION(dev);
1331 const union acpi_object *obj;
1332 const struct acpi_gpio_mapping *gm;
1333 int count = -ENOENT;
1338 /* Try first from _DSD */
1339 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1341 snprintf(propname, sizeof(propname), "%s-%s",
1342 con_id, gpio_suffixes[i]);
1344 snprintf(propname, sizeof(propname), "%s",
1347 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1350 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1352 else if (obj->type == ACPI_TYPE_PACKAGE)
1353 count = acpi_gpio_package_count(obj);
1354 } else if (adev->driver_gpios) {
1355 for (gm = adev->driver_gpios; gm->name; gm++)
1356 if (strcmp(propname, gm->name) == 0) {
1365 /* Then from plain _CRS GPIOs */
1367 struct list_head resource_list;
1368 unsigned int crs_count = 0;
1370 if (!acpi_can_fallback_to_crs(adev, con_id))
1373 INIT_LIST_HEAD(&resource_list);
1374 acpi_dev_get_resources(adev, &resource_list,
1375 acpi_find_gpio_count, &crs_count);
1376 acpi_dev_free_resource_list(&resource_list);
1380 return count ? count : -ENOENT;
1383 /* Run deferred acpi_gpiochip_request_irqs() */
1384 static int __init acpi_gpio_handle_deferred_request_irqs(void)
1386 struct acpi_gpio_chip *acpi_gpio, *tmp;
1388 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1389 list_for_each_entry_safe(acpi_gpio, tmp,
1390 &acpi_gpio_deferred_req_irqs_list,
1391 deferred_req_irqs_list_entry)
1392 acpi_gpiochip_request_irqs(acpi_gpio);
1394 acpi_gpio_deferred_req_irqs_done = true;
1395 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1399 /* We must use _sync so that this runs after the first deferred_probe run */
1400 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1402 static const struct dmi_system_id gpiolib_acpi_quirks[] __initconst = {
1405 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1406 * a non existing micro-USB-B connector which puts the HDMI
1407 * DDC pins in GPIO mode, breaking HDMI support.
1410 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1411 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1413 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1414 .no_edge_events_on_boot = true,
1419 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1420 * instead of controlling the actual micro-USB-B turns the 5V
1421 * boost for its USB-A connector off. The actual micro-USB-B
1422 * connector is wired for charging only.
1425 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1426 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1428 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1429 .no_edge_events_on_boot = true,
1434 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1435 * external embedded-controller connected via I2C + an ACPI GPIO
1436 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1437 * When suspending by closing the LID, the power to the USB
1438 * keyboard is turned off, causing INT0002 ACPI events to
1439 * trigger once the XHCI controller notices the keyboard is
1440 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1441 * EC wakes breaks wakeup when opening the lid, the user needs
1442 * to press the power-button to wakeup the system. The
1443 * alternative is suspend simply not working, which is worse.
1446 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1447 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1449 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1450 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1455 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1456 * external embedded-controller connected via I2C + an ACPI GPIO
1457 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1460 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1461 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1462 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1464 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1465 .ignore_wake = "INT33FC:02@28",
1470 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1471 * external embedded-controller connected via I2C + an ACPI GPIO
1472 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1475 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1476 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1477 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1479 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1480 .ignore_wake = "INT33FF:01@0",
1483 {} /* Terminating entry */
1486 static int __init acpi_gpio_setup_params(void)
1488 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1489 const struct dmi_system_id *id;
1491 id = dmi_first_match(gpiolib_acpi_quirks);
1493 quirk = id->driver_data;
1495 if (run_edge_events_on_boot < 0) {
1496 if (quirk && quirk->no_edge_events_on_boot)
1497 run_edge_events_on_boot = 0;
1499 run_edge_events_on_boot = 1;
1502 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1503 ignore_wake = quirk->ignore_wake;
1508 /* Directly after dmi_setup() which runs as core_initcall() */
1509 postcore_initcall(acpi_gpio_setup_params);