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");
30 * struct acpi_gpio_event - ACPI GPIO event handler data
32 * @node: list-entry of the events list of the struct acpi_gpio_chip
33 * @handle: handle of ACPI method to execute when the IRQ triggers
34 * @handler: handler function to pass to request_irq() when requesting the IRQ
35 * @pin: GPIO pin number on the struct gpio_chip
36 * @irq: Linux IRQ number for the event, for request_irq() / free_irq()
37 * @irqflags: flags to pass to request_irq() when requesting the IRQ
38 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
39 * @irq_requested:True if request_irq() has been done
40 * @desc: struct gpio_desc for the GPIO pin for this event
42 struct acpi_gpio_event {
43 struct list_head node;
45 irq_handler_t handler;
48 unsigned long irqflags;
51 struct gpio_desc *desc;
54 struct acpi_gpio_connection {
55 struct list_head node;
57 struct gpio_desc *desc;
60 struct acpi_gpio_chip {
62 * ACPICA requires that the first field of the context parameter
63 * passed to acpi_install_address_space_handler() is large enough
64 * to hold struct acpi_connection_info.
66 struct acpi_connection_info conn_info;
67 struct list_head conns;
68 struct mutex conn_lock;
69 struct gpio_chip *chip;
70 struct list_head events;
71 struct list_head deferred_req_irqs_list_entry;
75 * For GPIO chips which call acpi_gpiochip_request_interrupts() before late_init
76 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
77 * late_initcall_sync() handler, so that other builtin drivers can register their
78 * OpRegions before the event handlers can run. This list contains GPIO chips
79 * for which the acpi_gpiochip_request_irqs() call has been deferred.
81 static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
82 static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
83 static bool acpi_gpio_deferred_req_irqs_done;
85 static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
90 return ACPI_HANDLE(gc->parent) == data;
94 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
95 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
96 * @pin: ACPI GPIO pin number (0-based, controller-relative)
98 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
99 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
100 * controller does not have GPIO chip registered at the moment. This is to
101 * support probe deferral.
103 static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
105 struct gpio_chip *chip;
109 status = acpi_get_handle(NULL, path, &handle);
110 if (ACPI_FAILURE(status))
111 return ERR_PTR(-ENODEV);
113 chip = gpiochip_find(handle, acpi_gpiochip_find);
115 return ERR_PTR(-EPROBE_DEFER);
117 return gpiochip_get_desc(chip, pin);
120 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
122 struct acpi_gpio_event *event = data;
124 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
129 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
131 struct acpi_gpio_event *event = data;
133 acpi_execute_simple_method(event->handle, NULL, event->pin);
138 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
140 /* The address of this function is used as a key. */
143 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
144 struct acpi_resource_gpio **agpio)
146 struct acpi_resource_gpio *gpio;
148 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
151 gpio = &ares->data.gpio;
152 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
158 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
160 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
161 struct acpi_gpio_event *event)
165 ret = request_threaded_irq(event->irq, NULL, event->handler,
166 event->irqflags, "ACPI:Event", event);
168 dev_err(acpi_gpio->chip->parent,
169 "Failed to setup interrupt handler for %d\n",
174 if (event->irq_is_wake)
175 enable_irq_wake(event->irq);
177 event->irq_requested = true;
179 /* Make sure we trigger the initial state of edge-triggered IRQs */
180 if (run_edge_events_on_boot &&
181 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
182 value = gpiod_get_raw_value_cansleep(event->desc);
183 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
184 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
185 event->handler(event->irq, event);
189 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
191 struct acpi_gpio_event *event;
193 list_for_each_entry(event, &acpi_gpio->events, node)
194 acpi_gpiochip_request_irq(acpi_gpio, event);
197 /* Always returns AE_OK so that we keep looping over the resources */
198 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
201 struct acpi_gpio_chip *acpi_gpio = context;
202 struct gpio_chip *chip = acpi_gpio->chip;
203 struct acpi_resource_gpio *agpio;
204 acpi_handle handle, evt_handle;
205 struct acpi_gpio_event *event;
206 irq_handler_t handler = NULL;
207 struct gpio_desc *desc;
210 if (!acpi_gpio_get_irq_resource(ares, &agpio))
213 handle = ACPI_HANDLE(chip->parent);
214 pin = agpio->pin_table[0];
218 sprintf(ev_name, "_%c%02hhX",
219 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
221 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
222 handler = acpi_gpio_irq_handler;
225 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
226 handler = acpi_gpio_irq_handler_evt;
231 desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event",
232 GPIO_ACTIVE_HIGH, GPIOD_IN);
234 dev_err(chip->parent,
235 "Failed to request GPIO for pin 0x%04X, err %ld\n",
240 ret = gpiochip_lock_as_irq(chip, pin);
242 dev_err(chip->parent,
243 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
248 irq = gpiod_to_irq(desc);
250 dev_err(chip->parent,
251 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
253 goto fail_unlock_irq;
256 event = kzalloc(sizeof(*event), GFP_KERNEL);
258 goto fail_unlock_irq;
260 event->irqflags = IRQF_ONESHOT;
261 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
262 if (agpio->polarity == ACPI_ACTIVE_HIGH)
263 event->irqflags |= IRQF_TRIGGER_HIGH;
265 event->irqflags |= IRQF_TRIGGER_LOW;
267 switch (agpio->polarity) {
268 case ACPI_ACTIVE_HIGH:
269 event->irqflags |= IRQF_TRIGGER_RISING;
271 case ACPI_ACTIVE_LOW:
272 event->irqflags |= IRQF_TRIGGER_FALLING;
275 event->irqflags |= IRQF_TRIGGER_RISING |
276 IRQF_TRIGGER_FALLING;
281 event->handle = evt_handle;
282 event->handler = handler;
284 event->irq_is_wake = agpio->wake_capable == ACPI_WAKE_CAPABLE;
288 list_add_tail(&event->node, &acpi_gpio->events);
293 gpiochip_unlock_as_irq(chip, pin);
295 gpiochip_free_own_desc(desc);
301 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
304 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
305 * handled by ACPI event methods which need to be called from the GPIO
306 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
307 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
308 * the ACPI event methods for those pins.
310 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
312 struct acpi_gpio_chip *acpi_gpio;
317 if (!chip->parent || !chip->to_irq)
320 handle = ACPI_HANDLE(chip->parent);
324 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
325 if (ACPI_FAILURE(status))
328 acpi_walk_resources(handle, "_AEI",
329 acpi_gpiochip_alloc_event, acpi_gpio);
331 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
332 defer = !acpi_gpio_deferred_req_irqs_done;
334 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
335 &acpi_gpio_deferred_req_irqs_list);
336 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
341 acpi_gpiochip_request_irqs(acpi_gpio);
343 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
346 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
349 * Free interrupts associated with GPIO ACPI event method for the given
352 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
354 struct acpi_gpio_chip *acpi_gpio;
355 struct acpi_gpio_event *event, *ep;
359 if (!chip->parent || !chip->to_irq)
362 handle = ACPI_HANDLE(chip->parent);
366 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
367 if (ACPI_FAILURE(status))
370 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
371 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
372 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
373 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
375 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
376 if (event->irq_requested) {
377 if (event->irq_is_wake)
378 disable_irq_wake(event->irq);
380 free_irq(event->irq, event);
383 gpiochip_unlock_as_irq(chip, event->pin);
384 gpiochip_free_own_desc(event->desc);
385 list_del(&event->node);
389 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
391 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
392 const struct acpi_gpio_mapping *gpios)
395 adev->driver_gpios = gpios;
400 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
402 void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
405 adev->driver_gpios = NULL;
407 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
409 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
411 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
414 int devm_acpi_dev_add_driver_gpios(struct device *dev,
415 const struct acpi_gpio_mapping *gpios)
420 res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
424 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
429 devres_add(dev, res);
432 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
434 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
436 WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
438 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
440 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
441 const char *name, int index,
442 struct fwnode_reference_args *args,
443 unsigned int *quirks)
445 const struct acpi_gpio_mapping *gm;
447 if (!adev->driver_gpios)
450 for (gm = adev->driver_gpios; gm->name; gm++)
451 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
452 const struct acpi_gpio_params *par = gm->data + index;
454 args->fwnode = acpi_fwnode_handle(adev);
455 args->args[0] = par->crs_entry_index;
456 args->args[1] = par->line_index;
457 args->args[2] = par->active_low;
460 *quirks = gm->quirks;
467 static enum gpiod_flags
468 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio)
470 switch (agpio->io_restriction) {
471 case ACPI_IO_RESTRICT_INPUT:
473 case ACPI_IO_RESTRICT_OUTPUT:
475 * ACPI GPIO resources don't contain an initial value for the
476 * GPIO. Therefore we deduce that value from the pull field
477 * instead. If the pin is pulled up we assume default to be
478 * high, if it is pulled down we assume default to be low,
479 * otherwise we leave pin untouched.
481 switch (agpio->pin_config) {
482 case ACPI_PIN_CONFIG_PULLUP:
483 return GPIOD_OUT_HIGH;
484 case ACPI_PIN_CONFIG_PULLDOWN:
485 return GPIOD_OUT_LOW;
494 * Assume that the BIOS has configured the direction and pull
501 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
503 const enum gpiod_flags mask =
504 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
505 GPIOD_FLAGS_BIT_DIR_VAL;
509 * Check if the BIOS has IoRestriction with explicitly set direction
510 * and update @flags accordingly. Otherwise use whatever caller asked
513 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
514 enum gpiod_flags diff = *flags ^ update;
517 * Check if caller supplied incompatible GPIO initialization
520 * Return %-EINVAL to notify that firmware has different
521 * settings and we are going to use them.
523 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
524 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
526 *flags = (*flags & ~mask) | (update & mask);
532 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
534 struct device *dev = &info->adev->dev;
535 enum gpiod_flags old = *flags;
538 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
539 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
541 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
544 dev_dbg(dev, "Override GPIO initialization flags\n");
551 int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
552 struct acpi_gpio_info *info)
554 switch (info->pin_config) {
555 case ACPI_PIN_CONFIG_PULLUP:
556 *lookupflags |= GPIO_PULL_UP;
558 case ACPI_PIN_CONFIG_PULLDOWN:
559 *lookupflags |= GPIO_PULL_DOWN;
565 if (info->polarity == GPIO_ACTIVE_LOW)
566 *lookupflags |= GPIO_ACTIVE_LOW;
571 struct acpi_gpio_lookup {
572 struct acpi_gpio_info info;
576 struct gpio_desc *desc;
580 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
582 struct acpi_gpio_lookup *lookup = data;
584 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
588 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
589 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
592 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
595 if (lookup->n++ != lookup->index)
598 pin_index = lookup->pin_index;
599 if (pin_index >= agpio->pin_table_length)
602 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
603 agpio->pin_table[pin_index]);
604 lookup->info.pin_config = agpio->pin_config;
605 lookup->info.gpioint = gpioint;
608 * Polarity and triggering are only specified for GpioInt
610 * Note: we expect here:
611 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
612 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
614 if (lookup->info.gpioint) {
615 lookup->info.flags = GPIOD_IN;
616 lookup->info.polarity = agpio->polarity;
617 lookup->info.triggering = agpio->triggering;
619 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio);
620 lookup->info.polarity = lookup->active_low;
627 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
628 struct acpi_gpio_info *info)
630 struct acpi_device *adev = lookup->info.adev;
631 struct list_head res_list;
634 INIT_LIST_HEAD(&res_list);
636 ret = acpi_dev_get_resources(adev, &res_list,
637 acpi_populate_gpio_lookup,
642 acpi_dev_free_resource_list(&res_list);
648 *info = lookup->info;
652 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
653 const char *propname, int index,
654 struct acpi_gpio_lookup *lookup)
656 struct fwnode_reference_args args;
657 unsigned int quirks = 0;
660 memset(&args, 0, sizeof(args));
661 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
664 struct acpi_device *adev = to_acpi_device_node(fwnode);
669 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
674 * The property was found and resolved, so need to lookup the GPIO based
677 if (!to_acpi_device_node(args.fwnode))
682 lookup->index = args.args[0];
683 lookup->pin_index = args.args[1];
684 lookup->active_low = !!args.args[2];
686 lookup->info.adev = to_acpi_device_node(args.fwnode);
687 lookup->info.quirks = quirks;
693 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
694 * @adev: pointer to a ACPI device to get GPIO from
695 * @propname: Property name of the GPIO (optional)
696 * @index: index of GpioIo/GpioInt resource (starting from %0)
697 * @info: info pointer to fill in (optional)
699 * Function goes through ACPI resources for @adev and based on @index looks
700 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
701 * and returns it. @index matches GpioIo/GpioInt resources only so if there
702 * are total %3 GPIO resources, the index goes from %0 to %2.
704 * If @propname is specified the GPIO is looked using device property. In
705 * that case @index is used to select the GPIO entry in the property value
706 * (in case of multiple).
708 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
711 * Note: if the GPIO resource has multiple entries in the pin list, this
712 * function only returns the first.
714 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
715 const char *propname, int index,
716 struct acpi_gpio_info *info)
718 struct acpi_gpio_lookup lookup;
722 return ERR_PTR(-ENODEV);
724 memset(&lookup, 0, sizeof(lookup));
725 lookup.index = index;
728 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
730 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
731 propname, index, &lookup);
735 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
736 dev_name(&lookup.info.adev->dev), lookup.index,
737 lookup.pin_index, lookup.active_low);
739 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
740 lookup.info.adev = adev;
743 ret = acpi_gpio_resource_lookup(&lookup, info);
744 return ret ? ERR_PTR(ret) : lookup.desc;
747 static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
750 /* Never allow fallback if the device has properties */
751 if (acpi_dev_has_props(adev) || adev->driver_gpios)
754 return con_id == NULL;
757 struct gpio_desc *acpi_find_gpio(struct device *dev,
760 enum gpiod_flags *dflags,
761 unsigned long *lookupflags)
763 struct acpi_device *adev = ACPI_COMPANION(dev);
764 struct acpi_gpio_info info;
765 struct gpio_desc *desc;
769 /* Try first from _DSD */
770 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
772 snprintf(propname, sizeof(propname), "%s-%s",
773 con_id, gpio_suffixes[i]);
775 snprintf(propname, sizeof(propname), "%s",
779 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
782 if (PTR_ERR(desc) == -EPROBE_DEFER)
783 return ERR_CAST(desc);
786 /* Then from plain _CRS GPIOs */
788 if (!acpi_can_fallback_to_crs(adev, con_id))
789 return ERR_PTR(-ENOENT);
791 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
797 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
798 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
799 return ERR_PTR(-ENOENT);
802 acpi_gpio_update_gpiod_flags(dflags, &info);
803 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
808 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
809 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
810 * @propname: Property name of the GPIO
811 * @index: index of GpioIo/GpioInt resource (starting from %0)
812 * @info: info pointer to fill in (optional)
814 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
815 * Otherwise (i.e. it is a data-only non-device object), use the property-based
816 * GPIO lookup to get to the GPIO resource with the relevant information and use
817 * that to obtain the GPIO descriptor to return.
819 * If the GPIO cannot be translated or there is an error an ERR_PTR is
822 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
823 const char *propname, int index,
824 struct acpi_gpio_info *info)
826 struct acpi_gpio_lookup lookup;
827 struct acpi_device *adev;
830 adev = to_acpi_device_node(fwnode);
832 return acpi_get_gpiod_by_index(adev, propname, index, info);
834 if (!is_acpi_data_node(fwnode))
835 return ERR_PTR(-ENODEV);
838 return ERR_PTR(-EINVAL);
840 memset(&lookup, 0, sizeof(lookup));
841 lookup.index = index;
843 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
847 ret = acpi_gpio_resource_lookup(&lookup, info);
848 return ret ? ERR_PTR(ret) : lookup.desc;
852 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
853 * @adev: pointer to a ACPI device to get IRQ from
854 * @index: index of GpioInt resource (starting from %0)
856 * If the device has one or more GpioInt resources, this function can be
857 * used to translate from the GPIO offset in the resource to the Linux IRQ
860 * The function is idempotent, though each time it runs it will configure GPIO
861 * pin direction according to the flags in GpioInt resource.
863 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
865 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
868 unsigned int irq_flags;
871 for (i = 0, idx = 0; idx <= index; i++) {
872 struct acpi_gpio_info info;
873 struct gpio_desc *desc;
875 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
877 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
878 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
879 return PTR_ERR(desc);
881 if (info.gpioint && idx++ == index) {
882 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
887 return PTR_ERR(desc);
889 irq = gpiod_to_irq(desc);
893 snprintf(label, sizeof(label), "GpioInt() %d", index);
894 ret = gpiod_configure_flags(desc, label, lflags, info.flags);
898 irq_flags = acpi_dev_get_irq_type(info.triggering,
901 /* Set type if specified and different than the current one */
902 if (irq_flags != IRQ_TYPE_NONE &&
903 irq_flags != irq_get_trigger_type(irq))
904 irq_set_irq_type(irq, irq_flags);
912 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
915 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
916 u32 bits, u64 *value, void *handler_context,
917 void *region_context)
919 struct acpi_gpio_chip *achip = region_context;
920 struct gpio_chip *chip = achip->chip;
921 struct acpi_resource_gpio *agpio;
922 struct acpi_resource *ares;
923 int pin_index = (int)address;
928 status = acpi_buffer_to_resource(achip->conn_info.connection,
929 achip->conn_info.length, &ares);
930 if (ACPI_FAILURE(status))
933 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
935 return AE_BAD_PARAMETER;
938 agpio = &ares->data.gpio;
940 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
941 function == ACPI_WRITE)) {
943 return AE_BAD_PARAMETER;
946 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
947 for (i = pin_index; i < length; ++i) {
948 int pin = agpio->pin_table[i];
949 struct acpi_gpio_connection *conn;
950 struct gpio_desc *desc;
953 mutex_lock(&achip->conn_lock);
956 list_for_each_entry(conn, &achip->conns, node) {
957 if (conn->pin == pin) {
965 * The same GPIO can be shared between operation region and
966 * event but only if the access here is ACPI_READ. In that
967 * case we "borrow" the event GPIO instead.
969 if (!found && agpio->shareable == ACPI_SHARED &&
970 function == ACPI_READ) {
971 struct acpi_gpio_event *event;
973 list_for_each_entry(event, &achip->events, node) {
974 if (event->pin == pin) {
983 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio);
984 const char *label = "ACPI:OpRegion";
986 desc = gpiochip_request_own_desc(chip, pin, label,
991 mutex_unlock(&achip->conn_lock);
995 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
997 status = AE_NO_MEMORY;
998 gpiochip_free_own_desc(desc);
999 mutex_unlock(&achip->conn_lock);
1005 list_add_tail(&conn->node, &achip->conns);
1008 mutex_unlock(&achip->conn_lock);
1010 if (function == ACPI_WRITE)
1011 gpiod_set_raw_value_cansleep(desc,
1012 !!((1 << i) & *value));
1014 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1022 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1024 struct gpio_chip *chip = achip->chip;
1025 acpi_handle handle = ACPI_HANDLE(chip->parent);
1028 INIT_LIST_HEAD(&achip->conns);
1029 mutex_init(&achip->conn_lock);
1030 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1031 acpi_gpio_adr_space_handler,
1033 if (ACPI_FAILURE(status))
1034 dev_err(chip->parent,
1035 "Failed to install GPIO OpRegion handler\n");
1038 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1040 struct gpio_chip *chip = achip->chip;
1041 acpi_handle handle = ACPI_HANDLE(chip->parent);
1042 struct acpi_gpio_connection *conn, *tmp;
1045 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1046 acpi_gpio_adr_space_handler);
1047 if (ACPI_FAILURE(status)) {
1048 dev_err(chip->parent,
1049 "Failed to remove GPIO OpRegion handler\n");
1053 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1054 gpiochip_free_own_desc(conn->desc);
1055 list_del(&conn->node);
1060 static struct gpio_desc *
1061 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1062 struct fwnode_handle *fwnode,
1064 unsigned long *lflags,
1065 enum gpiod_flags *dflags)
1067 struct gpio_chip *chip = achip->chip;
1068 struct gpio_desc *desc;
1072 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1076 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1079 return ERR_PTR(ret);
1081 desc = gpiochip_get_desc(chip, gpios[0]);
1086 *lflags |= GPIO_ACTIVE_LOW;
1088 if (fwnode_property_present(fwnode, "input"))
1089 *dflags |= GPIOD_IN;
1090 else if (fwnode_property_present(fwnode, "output-low"))
1091 *dflags |= GPIOD_OUT_LOW;
1092 else if (fwnode_property_present(fwnode, "output-high"))
1093 *dflags |= GPIOD_OUT_HIGH;
1095 return ERR_PTR(-EINVAL);
1097 fwnode_property_read_string(fwnode, "line-name", name);
1102 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1104 struct gpio_chip *chip = achip->chip;
1105 struct fwnode_handle *fwnode;
1107 device_for_each_child_node(chip->parent, fwnode) {
1108 unsigned long lflags;
1109 enum gpiod_flags dflags;
1110 struct gpio_desc *desc;
1114 if (!fwnode_property_present(fwnode, "gpio-hog"))
1117 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1122 ret = gpiod_hog(desc, name, lflags, dflags);
1124 dev_err(chip->parent, "Failed to hog GPIO\n");
1125 fwnode_handle_put(fwnode);
1131 void acpi_gpiochip_add(struct gpio_chip *chip)
1133 struct acpi_gpio_chip *acpi_gpio;
1137 if (!chip || !chip->parent)
1140 handle = ACPI_HANDLE(chip->parent);
1144 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1146 dev_err(chip->parent,
1147 "Failed to allocate memory for ACPI GPIO chip\n");
1151 acpi_gpio->chip = chip;
1152 INIT_LIST_HEAD(&acpi_gpio->events);
1153 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1155 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1156 if (ACPI_FAILURE(status)) {
1157 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1163 devprop_gpiochip_set_names(chip, dev_fwnode(chip->parent));
1165 acpi_gpiochip_request_regions(acpi_gpio);
1166 acpi_gpiochip_scan_gpios(acpi_gpio);
1167 acpi_walk_dep_device_list(handle);
1170 void acpi_gpiochip_remove(struct gpio_chip *chip)
1172 struct acpi_gpio_chip *acpi_gpio;
1176 if (!chip || !chip->parent)
1179 handle = ACPI_HANDLE(chip->parent);
1183 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1184 if (ACPI_FAILURE(status)) {
1185 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1189 acpi_gpiochip_free_regions(acpi_gpio);
1191 acpi_detach_data(handle, acpi_gpio_chip_dh);
1195 static int acpi_gpio_package_count(const union acpi_object *obj)
1197 const union acpi_object *element = obj->package.elements;
1198 const union acpi_object *end = element + obj->package.count;
1199 unsigned int count = 0;
1201 while (element < end) {
1202 switch (element->type) {
1203 case ACPI_TYPE_LOCAL_REFERENCE:
1206 case ACPI_TYPE_INTEGER:
1219 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1221 unsigned int *count = data;
1223 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1224 *count += ares->data.gpio.pin_table_length;
1230 * acpi_gpio_count - count the GPIOs associated with a device / function
1231 * @dev: GPIO consumer, can be %NULL for system-global GPIOs
1232 * @con_id: function within the GPIO consumer
1235 * The number of GPIOs associated with a device / function or %-ENOENT,
1236 * if no GPIO has been assigned to the requested function.
1238 int acpi_gpio_count(struct device *dev, const char *con_id)
1240 struct acpi_device *adev = ACPI_COMPANION(dev);
1241 const union acpi_object *obj;
1242 const struct acpi_gpio_mapping *gm;
1243 int count = -ENOENT;
1248 /* Try first from _DSD */
1249 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1251 snprintf(propname, sizeof(propname), "%s-%s",
1252 con_id, gpio_suffixes[i]);
1254 snprintf(propname, sizeof(propname), "%s",
1257 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1260 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1262 else if (obj->type == ACPI_TYPE_PACKAGE)
1263 count = acpi_gpio_package_count(obj);
1264 } else if (adev->driver_gpios) {
1265 for (gm = adev->driver_gpios; gm->name; gm++)
1266 if (strcmp(propname, gm->name) == 0) {
1275 /* Then from plain _CRS GPIOs */
1277 struct list_head resource_list;
1278 unsigned int crs_count = 0;
1280 if (!acpi_can_fallback_to_crs(adev, con_id))
1283 INIT_LIST_HEAD(&resource_list);
1284 acpi_dev_get_resources(adev, &resource_list,
1285 acpi_find_gpio_count, &crs_count);
1286 acpi_dev_free_resource_list(&resource_list);
1290 return count ? count : -ENOENT;
1293 /* Run deferred acpi_gpiochip_request_irqs() */
1294 static int acpi_gpio_handle_deferred_request_irqs(void)
1296 struct acpi_gpio_chip *acpi_gpio, *tmp;
1298 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1299 list_for_each_entry_safe(acpi_gpio, tmp,
1300 &acpi_gpio_deferred_req_irqs_list,
1301 deferred_req_irqs_list_entry)
1302 acpi_gpiochip_request_irqs(acpi_gpio);
1304 acpi_gpio_deferred_req_irqs_done = true;
1305 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1309 /* We must use _sync so that this runs after the first deferred_probe run */
1310 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1312 static const struct dmi_system_id run_edge_events_on_boot_blacklist[] = {
1315 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1316 * a non existing micro-USB-B connector which puts the HDMI
1317 * DDC pins in GPIO mode, breaking HDMI support.
1320 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1321 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1326 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1327 * instead of controlling the actual micro-USB-B turns the 5V
1328 * boost for its USB-A connector off. The actual micro-USB-B
1329 * connector is wired for charging only.
1332 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1333 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1336 {} /* Terminating entry */
1339 static int acpi_gpio_setup_params(void)
1341 if (run_edge_events_on_boot < 0) {
1342 if (dmi_check_system(run_edge_events_on_boot_blacklist))
1343 run_edge_events_on_boot = 0;
1345 run_edge_events_on_boot = 1;
1351 /* Directly after dmi_setup() which runs as core_initcall() */
1352 postcore_initcall(acpi_gpio_setup_params);