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/acpi.h>
11 #include <linux/dmi.h>
12 #include <linux/errno.h>
13 #include <linux/export.h>
14 #include <linux/interrupt.h>
15 #include <linux/irq.h>
16 #include <linux/mutex.h>
17 #include <linux/pinctrl/pinctrl.h>
19 #include <linux/gpio/consumer.h>
20 #include <linux/gpio/driver.h>
21 #include <linux/gpio/machine.h>
24 #include "gpiolib-acpi.h"
26 static int run_edge_events_on_boot
= -1;
27 module_param(run_edge_events_on_boot
, int, 0444);
28 MODULE_PARM_DESC(run_edge_events_on_boot
,
29 "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");
31 static char *ignore_wake
;
32 module_param(ignore_wake
, charp
, 0444);
33 MODULE_PARM_DESC(ignore_wake
,
34 "controller@pin combos on which to ignore the ACPI wake flag "
35 "ignore_wake=controller@pin[,controller@pin[,...]]");
37 static char *ignore_interrupt
;
38 module_param(ignore_interrupt
, charp
, 0444);
39 MODULE_PARM_DESC(ignore_interrupt
,
40 "controller@pin combos on which to ignore interrupt "
41 "ignore_interrupt=controller@pin[,controller@pin[,...]]");
43 struct acpi_gpiolib_dmi_quirk
{
44 bool no_edge_events_on_boot
;
46 char *ignore_interrupt
;
50 * struct acpi_gpio_event - ACPI GPIO event handler data
52 * @node: list-entry of the events list of the struct acpi_gpio_chip
53 * @handle: handle of ACPI method to execute when the IRQ triggers
54 * @handler: handler function to pass to request_irq() when requesting the IRQ
55 * @pin: GPIO pin number on the struct gpio_chip
56 * @irq: Linux IRQ number for the event, for request_irq() / free_irq()
57 * @irqflags: flags to pass to request_irq() when requesting the IRQ
58 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
59 * @irq_requested:True if request_irq() has been done
60 * @desc: struct gpio_desc for the GPIO pin for this event
62 struct acpi_gpio_event
{
63 struct list_head node
;
65 irq_handler_t handler
;
68 unsigned long irqflags
;
71 struct gpio_desc
*desc
;
74 struct acpi_gpio_connection
{
75 struct list_head node
;
77 struct gpio_desc
*desc
;
80 struct acpi_gpio_chip
{
82 * ACPICA requires that the first field of the context parameter
83 * passed to acpi_install_address_space_handler() is large enough
84 * to hold struct acpi_connection_info.
86 struct acpi_connection_info conn_info
;
87 struct list_head conns
;
88 struct mutex conn_lock
;
89 struct gpio_chip
*chip
;
90 struct list_head events
;
91 struct list_head deferred_req_irqs_list_entry
;
95 * struct acpi_gpio_info - ACPI GPIO specific information
96 * @adev: reference to ACPI device which consumes GPIO resource
97 * @flags: GPIO initialization flags
98 * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
99 * @pin_config: pin bias as provided by ACPI
100 * @polarity: interrupt polarity as provided by ACPI
101 * @triggering: triggering type as provided by ACPI
102 * @wake_capable: wake capability as provided by ACPI
103 * @debounce: debounce timeout as provided by ACPI
104 * @quirks: Linux specific quirks as provided by struct acpi_gpio_mapping
106 struct acpi_gpio_info
{
107 struct acpi_device
*adev
;
108 enum gpiod_flags flags
;
114 unsigned int debounce
;
119 * For GPIO chips which call acpi_gpiochip_request_interrupts() before late_init
120 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
121 * late_initcall_sync() handler, so that other builtin drivers can register their
122 * OpRegions before the event handlers can run. This list contains GPIO chips
123 * for which the acpi_gpiochip_request_irqs() call has been deferred.
125 static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock
);
126 static LIST_HEAD(acpi_gpio_deferred_req_irqs_list
);
127 static bool acpi_gpio_deferred_req_irqs_done
;
129 static int acpi_gpiochip_find(struct gpio_chip
*gc
, const void *data
)
131 /* First check the actual GPIO device */
132 if (device_match_acpi_handle(&gc
->gpiodev
->dev
, data
))
136 * When the ACPI device is artificially split to the banks of GPIOs,
137 * where each of them is represented by a separate GPIO device,
138 * the firmware node of the physical device may not be shared among
139 * the banks as they may require different values for the same property,
140 * e.g., number of GPIOs in a certain bank. In such case the ACPI handle
141 * of a GPIO device is NULL and can not be used. Hence we have to check
142 * the parent device to be sure that there is no match before bailing
146 return device_match_acpi_handle(gc
->parent
, data
);
152 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
153 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
154 * @pin: ACPI GPIO pin number (0-based, controller-relative)
157 * GPIO descriptor to use with Linux generic GPIO API.
158 * If the GPIO cannot be translated or there is an error an ERR_PTR is
161 * Specifically returns %-EPROBE_DEFER if the referenced GPIO
162 * controller does not have GPIO chip registered at the moment. This is to
163 * support probe deferral.
165 static struct gpio_desc
*acpi_get_gpiod(char *path
, unsigned int pin
)
170 status
= acpi_get_handle(NULL
, path
, &handle
);
171 if (ACPI_FAILURE(status
))
172 return ERR_PTR(-ENODEV
);
174 struct gpio_device
*gdev
__free(gpio_device_put
) =
175 gpio_device_find(handle
, acpi_gpiochip_find
);
177 return ERR_PTR(-EPROBE_DEFER
);
180 * FIXME: keep track of the reference to the GPIO device somehow
181 * instead of putting it here.
183 return gpio_device_get_desc(gdev
, pin
);
186 static irqreturn_t
acpi_gpio_irq_handler(int irq
, void *data
)
188 struct acpi_gpio_event
*event
= data
;
190 acpi_evaluate_object(event
->handle
, NULL
, NULL
, NULL
);
195 static irqreturn_t
acpi_gpio_irq_handler_evt(int irq
, void *data
)
197 struct acpi_gpio_event
*event
= data
;
199 acpi_execute_simple_method(event
->handle
, NULL
, event
->pin
);
204 static void acpi_gpio_chip_dh(acpi_handle handle
, void *data
)
206 /* The address of this function is used as a key. */
209 bool acpi_gpio_get_irq_resource(struct acpi_resource
*ares
,
210 struct acpi_resource_gpio
**agpio
)
212 struct acpi_resource_gpio
*gpio
;
214 if (ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)
217 gpio
= &ares
->data
.gpio
;
218 if (gpio
->connection_type
!= ACPI_RESOURCE_GPIO_TYPE_INT
)
224 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource
);
227 * acpi_gpio_get_io_resource - Fetch details of an ACPI resource if it is a GPIO
228 * I/O resource or return False if not.
229 * @ares: Pointer to the ACPI resource to fetch
230 * @agpio: Pointer to a &struct acpi_resource_gpio to store the output pointer
233 * %true if GpioIo resource is found, %false otherwise.
235 bool acpi_gpio_get_io_resource(struct acpi_resource
*ares
,
236 struct acpi_resource_gpio
**agpio
)
238 struct acpi_resource_gpio
*gpio
;
240 if (ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)
243 gpio
= &ares
->data
.gpio
;
244 if (gpio
->connection_type
!= ACPI_RESOURCE_GPIO_TYPE_IO
)
250 EXPORT_SYMBOL_GPL(acpi_gpio_get_io_resource
);
252 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip
*acpi_gpio
,
253 struct acpi_gpio_event
*event
)
255 struct device
*parent
= acpi_gpio
->chip
->parent
;
258 ret
= request_threaded_irq(event
->irq
, NULL
, event
->handler
,
259 event
->irqflags
| IRQF_ONESHOT
, "ACPI:Event", event
);
261 dev_err(parent
, "Failed to setup interrupt handler for %d\n", event
->irq
);
265 if (event
->irq_is_wake
)
266 enable_irq_wake(event
->irq
);
268 event
->irq_requested
= true;
270 /* Make sure we trigger the initial state of edge-triggered IRQs */
271 if (run_edge_events_on_boot
&&
272 (event
->irqflags
& (IRQF_TRIGGER_RISING
| IRQF_TRIGGER_FALLING
))) {
273 value
= gpiod_get_raw_value_cansleep(event
->desc
);
274 if (((event
->irqflags
& IRQF_TRIGGER_RISING
) && value
== 1) ||
275 ((event
->irqflags
& IRQF_TRIGGER_FALLING
) && value
== 0))
276 event
->handler(event
->irq
, event
);
280 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip
*acpi_gpio
)
282 struct acpi_gpio_event
*event
;
284 list_for_each_entry(event
, &acpi_gpio
->events
, node
)
285 acpi_gpiochip_request_irq(acpi_gpio
, event
);
288 static enum gpiod_flags
289 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio
*agpio
, int polarity
)
291 /* GpioInt() implies input configuration */
292 if (agpio
->connection_type
== ACPI_RESOURCE_GPIO_TYPE_INT
)
295 switch (agpio
->io_restriction
) {
296 case ACPI_IO_RESTRICT_INPUT
:
298 case ACPI_IO_RESTRICT_OUTPUT
:
300 * ACPI GPIO resources don't contain an initial value for the
301 * GPIO. Therefore we deduce that value from the pull field
302 * and the polarity instead. If the pin is pulled up we assume
303 * default to be high, if it is pulled down we assume default
304 * to be low, otherwise we leave pin untouched. For active low
305 * polarity values will be switched. See also
306 * Documentation/firmware-guide/acpi/gpio-properties.rst.
308 switch (agpio
->pin_config
) {
309 case ACPI_PIN_CONFIG_PULLUP
:
310 return polarity
== GPIO_ACTIVE_LOW
? GPIOD_OUT_LOW
: GPIOD_OUT_HIGH
;
311 case ACPI_PIN_CONFIG_PULLDOWN
:
312 return polarity
== GPIO_ACTIVE_LOW
? GPIOD_OUT_HIGH
: GPIOD_OUT_LOW
;
322 * Assume that the BIOS has configured the direction and pull
328 static struct gpio_desc
*acpi_request_own_gpiod(struct gpio_chip
*chip
,
329 struct acpi_resource_gpio
*agpio
,
333 int polarity
= GPIO_ACTIVE_HIGH
;
334 enum gpiod_flags flags
= acpi_gpio_to_gpiod_flags(agpio
, polarity
);
335 unsigned int pin
= agpio
->pin_table
[index
];
336 struct gpio_desc
*desc
;
339 desc
= gpiochip_request_own_desc(chip
, pin
, label
, polarity
, flags
);
343 /* ACPI uses hundredths of milliseconds units */
344 ret
= gpio_set_debounce_timeout(desc
, agpio
->debounce_timeout
* 10);
346 dev_warn(chip
->parent
,
347 "Failed to set debounce-timeout for pin 0x%04X, err %d\n",
353 static bool acpi_gpio_in_ignore_list(const char *ignore_list
, const char *controller_in
,
356 const char *controller
, *pin_str
;
361 controller
= ignore_list
;
363 pin_str
= strchr(controller
, '@');
367 len
= pin_str
- controller
;
368 if (len
== strlen(controller_in
) &&
369 strncmp(controller
, controller_in
, len
) == 0) {
370 pin
= simple_strtoul(pin_str
+ 1, &endp
, 10);
371 if (*endp
!= 0 && *endp
!= ',')
378 controller
= strchr(controller
, ',');
385 pr_err_once("Error: Invalid value for gpiolib_acpi.ignore_...: %s\n", ignore_list
);
389 static bool acpi_gpio_irq_is_wake(struct device
*parent
,
390 const struct acpi_resource_gpio
*agpio
)
392 unsigned int pin
= agpio
->pin_table
[0];
394 if (agpio
->wake_capable
!= ACPI_WAKE_CAPABLE
)
397 if (acpi_gpio_in_ignore_list(ignore_wake
, dev_name(parent
), pin
)) {
398 dev_info(parent
, "Ignoring wakeup on pin %u\n", pin
);
405 /* Always returns AE_OK so that we keep looping over the resources */
406 static acpi_status
acpi_gpiochip_alloc_event(struct acpi_resource
*ares
,
409 struct acpi_gpio_chip
*acpi_gpio
= context
;
410 struct gpio_chip
*chip
= acpi_gpio
->chip
;
411 struct acpi_resource_gpio
*agpio
;
412 acpi_handle handle
, evt_handle
;
413 struct acpi_gpio_event
*event
;
414 irq_handler_t handler
= NULL
;
415 struct gpio_desc
*desc
;
419 if (!acpi_gpio_get_irq_resource(ares
, &agpio
))
422 handle
= ACPI_HANDLE(chip
->parent
);
423 pin
= agpio
->pin_table
[0];
427 sprintf(ev_name
, "_%c%02X",
428 agpio
->triggering
== ACPI_EDGE_SENSITIVE
? 'E' : 'L',
430 if (ACPI_SUCCESS(acpi_get_handle(handle
, ev_name
, &evt_handle
)))
431 handler
= acpi_gpio_irq_handler
;
434 if (ACPI_SUCCESS(acpi_get_handle(handle
, "_EVT", &evt_handle
)))
435 handler
= acpi_gpio_irq_handler_evt
;
440 if (acpi_gpio_in_ignore_list(ignore_interrupt
, dev_name(chip
->parent
), pin
)) {
441 dev_info(chip
->parent
, "Ignoring interrupt on pin %u\n", pin
);
445 desc
= acpi_request_own_gpiod(chip
, agpio
, 0, "ACPI:Event");
447 dev_err(chip
->parent
,
448 "Failed to request GPIO for pin 0x%04X, err %ld\n",
453 ret
= gpiochip_lock_as_irq(chip
, pin
);
455 dev_err(chip
->parent
,
456 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
461 irq
= gpiod_to_irq(desc
);
463 dev_err(chip
->parent
,
464 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
466 goto fail_unlock_irq
;
469 event
= kzalloc(sizeof(*event
), GFP_KERNEL
);
471 goto fail_unlock_irq
;
473 event
->irqflags
= IRQF_ONESHOT
;
474 if (agpio
->triggering
== ACPI_LEVEL_SENSITIVE
) {
475 if (agpio
->polarity
== ACPI_ACTIVE_HIGH
)
476 event
->irqflags
|= IRQF_TRIGGER_HIGH
;
478 event
->irqflags
|= IRQF_TRIGGER_LOW
;
480 switch (agpio
->polarity
) {
481 case ACPI_ACTIVE_HIGH
:
482 event
->irqflags
|= IRQF_TRIGGER_RISING
;
484 case ACPI_ACTIVE_LOW
:
485 event
->irqflags
|= IRQF_TRIGGER_FALLING
;
488 event
->irqflags
|= IRQF_TRIGGER_RISING
|
489 IRQF_TRIGGER_FALLING
;
494 event
->handle
= evt_handle
;
495 event
->handler
= handler
;
497 event
->irq_is_wake
= acpi_gpio_irq_is_wake(chip
->parent
, agpio
);
501 list_add_tail(&event
->node
, &acpi_gpio
->events
);
506 gpiochip_unlock_as_irq(chip
, pin
);
508 gpiochip_free_own_desc(desc
);
514 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
517 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
518 * handled by ACPI event methods which need to be called from the GPIO
519 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
520 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
521 * the ACPI event methods for those pins.
523 void acpi_gpiochip_request_interrupts(struct gpio_chip
*chip
)
525 struct acpi_gpio_chip
*acpi_gpio
;
530 if (!chip
->parent
|| !chip
->to_irq
)
533 handle
= ACPI_HANDLE(chip
->parent
);
537 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
538 if (ACPI_FAILURE(status
))
541 if (acpi_quirk_skip_gpio_event_handlers())
544 acpi_walk_resources(handle
, METHOD_NAME__AEI
,
545 acpi_gpiochip_alloc_event
, acpi_gpio
);
547 mutex_lock(&acpi_gpio_deferred_req_irqs_lock
);
548 defer
= !acpi_gpio_deferred_req_irqs_done
;
550 list_add(&acpi_gpio
->deferred_req_irqs_list_entry
,
551 &acpi_gpio_deferred_req_irqs_list
);
552 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock
);
557 acpi_gpiochip_request_irqs(acpi_gpio
);
559 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts
);
562 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
565 * Free interrupts associated with GPIO ACPI event method for the given
568 void acpi_gpiochip_free_interrupts(struct gpio_chip
*chip
)
570 struct acpi_gpio_chip
*acpi_gpio
;
571 struct acpi_gpio_event
*event
, *ep
;
575 if (!chip
->parent
|| !chip
->to_irq
)
578 handle
= ACPI_HANDLE(chip
->parent
);
582 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
583 if (ACPI_FAILURE(status
))
586 mutex_lock(&acpi_gpio_deferred_req_irqs_lock
);
587 if (!list_empty(&acpi_gpio
->deferred_req_irqs_list_entry
))
588 list_del_init(&acpi_gpio
->deferred_req_irqs_list_entry
);
589 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock
);
591 list_for_each_entry_safe_reverse(event
, ep
, &acpi_gpio
->events
, node
) {
592 if (event
->irq_requested
) {
593 if (event
->irq_is_wake
)
594 disable_irq_wake(event
->irq
);
596 free_irq(event
->irq
, event
);
599 gpiochip_unlock_as_irq(chip
, event
->pin
);
600 gpiochip_free_own_desc(event
->desc
);
601 list_del(&event
->node
);
605 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts
);
607 int acpi_dev_add_driver_gpios(struct acpi_device
*adev
,
608 const struct acpi_gpio_mapping
*gpios
)
611 adev
->driver_gpios
= gpios
;
616 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios
);
618 void acpi_dev_remove_driver_gpios(struct acpi_device
*adev
)
621 adev
->driver_gpios
= NULL
;
623 EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios
);
625 static void acpi_dev_release_driver_gpios(void *adev
)
627 acpi_dev_remove_driver_gpios(adev
);
630 int devm_acpi_dev_add_driver_gpios(struct device
*dev
,
631 const struct acpi_gpio_mapping
*gpios
)
633 struct acpi_device
*adev
= ACPI_COMPANION(dev
);
636 ret
= acpi_dev_add_driver_gpios(adev
, gpios
);
640 return devm_add_action_or_reset(dev
, acpi_dev_release_driver_gpios
, adev
);
642 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios
);
644 static bool acpi_get_driver_gpio_data(struct acpi_device
*adev
,
645 const char *name
, int index
,
646 struct fwnode_reference_args
*args
,
647 unsigned int *quirks
)
649 const struct acpi_gpio_mapping
*gm
;
651 if (!adev
|| !adev
->driver_gpios
)
654 for (gm
= adev
->driver_gpios
; gm
->name
; gm
++)
655 if (!strcmp(name
, gm
->name
) && gm
->data
&& index
< gm
->size
) {
656 const struct acpi_gpio_params
*par
= gm
->data
+ index
;
658 args
->fwnode
= acpi_fwnode_handle(adev
);
659 args
->args
[0] = par
->crs_entry_index
;
660 args
->args
[1] = par
->line_index
;
661 args
->args
[2] = par
->active_low
;
664 *quirks
= gm
->quirks
;
672 __acpi_gpio_update_gpiod_flags(enum gpiod_flags
*flags
, enum gpiod_flags update
)
674 const enum gpiod_flags mask
=
675 GPIOD_FLAGS_BIT_DIR_SET
| GPIOD_FLAGS_BIT_DIR_OUT
|
676 GPIOD_FLAGS_BIT_DIR_VAL
;
680 * Check if the BIOS has IoRestriction with explicitly set direction
681 * and update @flags accordingly. Otherwise use whatever caller asked
684 if (update
& GPIOD_FLAGS_BIT_DIR_SET
) {
685 enum gpiod_flags diff
= *flags
^ update
;
688 * Check if caller supplied incompatible GPIO initialization
691 * Return %-EINVAL to notify that firmware has different
692 * settings and we are going to use them.
694 if (((*flags
& GPIOD_FLAGS_BIT_DIR_SET
) && (diff
& GPIOD_FLAGS_BIT_DIR_OUT
)) ||
695 ((*flags
& GPIOD_FLAGS_BIT_DIR_OUT
) && (diff
& GPIOD_FLAGS_BIT_DIR_VAL
)))
697 *flags
= (*flags
& ~mask
) | (update
& mask
);
702 static int acpi_gpio_update_gpiod_flags(enum gpiod_flags
*flags
,
703 struct acpi_gpio_info
*info
)
705 struct device
*dev
= &info
->adev
->dev
;
706 enum gpiod_flags old
= *flags
;
709 ret
= __acpi_gpio_update_gpiod_flags(&old
, info
->flags
);
710 if (info
->quirks
& ACPI_GPIO_QUIRK_NO_IO_RESTRICTION
) {
712 dev_warn(dev
, FW_BUG
"GPIO not in correct mode, fixing\n");
715 dev_dbg(dev
, "Override GPIO initialization flags\n");
722 static int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags
,
723 struct acpi_gpio_info
*info
)
725 switch (info
->pin_config
) {
726 case ACPI_PIN_CONFIG_PULLUP
:
727 *lookupflags
|= GPIO_PULL_UP
;
729 case ACPI_PIN_CONFIG_PULLDOWN
:
730 *lookupflags
|= GPIO_PULL_DOWN
;
732 case ACPI_PIN_CONFIG_NOPULL
:
733 *lookupflags
|= GPIO_PULL_DISABLE
;
739 if (info
->polarity
== GPIO_ACTIVE_LOW
)
740 *lookupflags
|= GPIO_ACTIVE_LOW
;
745 struct acpi_gpio_lookup
{
746 struct acpi_gpio_info info
;
750 struct gpio_desc
*desc
;
754 static int acpi_populate_gpio_lookup(struct acpi_resource
*ares
, void *data
)
756 struct acpi_gpio_lookup
*lookup
= data
;
758 if (ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)
762 const struct acpi_resource_gpio
*agpio
= &ares
->data
.gpio
;
763 bool gpioint
= agpio
->connection_type
== ACPI_RESOURCE_GPIO_TYPE_INT
;
764 struct gpio_desc
*desc
;
767 if (lookup
->info
.quirks
& ACPI_GPIO_QUIRK_ONLY_GPIOIO
&& gpioint
)
770 if (lookup
->n
++ != lookup
->index
)
773 pin_index
= lookup
->pin_index
;
774 if (pin_index
>= agpio
->pin_table_length
)
777 if (lookup
->info
.quirks
& ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER
)
778 desc
= gpio_to_desc(agpio
->pin_table
[pin_index
]);
780 desc
= acpi_get_gpiod(agpio
->resource_source
.string_ptr
,
781 agpio
->pin_table
[pin_index
]);
783 lookup
->info
.pin_config
= agpio
->pin_config
;
784 lookup
->info
.debounce
= agpio
->debounce_timeout
;
785 lookup
->info
.gpioint
= gpioint
;
786 lookup
->info
.wake_capable
= acpi_gpio_irq_is_wake(&lookup
->info
.adev
->dev
, agpio
);
789 * Polarity and triggering are only specified for GpioInt
791 * Note: we expect here:
792 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
793 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
795 if (lookup
->info
.gpioint
) {
796 lookup
->info
.polarity
= agpio
->polarity
;
797 lookup
->info
.triggering
= agpio
->triggering
;
799 lookup
->info
.polarity
= lookup
->active_low
;
802 lookup
->info
.flags
= acpi_gpio_to_gpiod_flags(agpio
, lookup
->info
.polarity
);
808 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup
*lookup
,
809 struct acpi_gpio_info
*info
)
811 struct acpi_device
*adev
= lookup
->info
.adev
;
812 struct list_head res_list
;
815 INIT_LIST_HEAD(&res_list
);
817 ret
= acpi_dev_get_resources(adev
, &res_list
,
818 acpi_populate_gpio_lookup
,
823 acpi_dev_free_resource_list(&res_list
);
829 *info
= lookup
->info
;
833 static int acpi_gpio_property_lookup(struct fwnode_handle
*fwnode
,
834 const char *propname
, int index
,
835 struct acpi_gpio_lookup
*lookup
)
837 struct fwnode_reference_args args
;
838 unsigned int quirks
= 0;
841 memset(&args
, 0, sizeof(args
));
842 ret
= __acpi_node_get_property_reference(fwnode
, propname
, index
, 3,
845 struct acpi_device
*adev
;
847 adev
= to_acpi_device_node(fwnode
);
848 if (!acpi_get_driver_gpio_data(adev
, propname
, index
, &args
, &quirks
))
852 * The property was found and resolved, so need to lookup the GPIO based
855 if (!to_acpi_device_node(args
.fwnode
))
860 lookup
->index
= args
.args
[0];
861 lookup
->pin_index
= args
.args
[1];
862 lookup
->active_low
= !!args
.args
[2];
864 lookup
->info
.adev
= to_acpi_device_node(args
.fwnode
);
865 lookup
->info
.quirks
= quirks
;
871 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
872 * @adev: pointer to a ACPI device to get GPIO from
873 * @propname: Property name of the GPIO (optional)
874 * @index: index of GpioIo/GpioInt resource (starting from %0)
875 * @info: info pointer to fill in (optional)
877 * Function goes through ACPI resources for @adev and based on @index looks
878 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
879 * and returns it. @index matches GpioIo/GpioInt resources only so if there
880 * are total %3 GPIO resources, the index goes from %0 to %2.
882 * If @propname is specified the GPIO is looked using device property. In
883 * that case @index is used to select the GPIO entry in the property value
884 * (in case of multiple).
887 * GPIO descriptor to use with Linux generic GPIO API.
888 * If the GPIO cannot be translated or there is an error an ERR_PTR is
891 * Note: if the GPIO resource has multiple entries in the pin list, this
892 * function only returns the first.
894 static struct gpio_desc
*acpi_get_gpiod_by_index(struct acpi_device
*adev
,
895 const char *propname
,
897 struct acpi_gpio_info
*info
)
899 struct acpi_gpio_lookup lookup
;
902 memset(&lookup
, 0, sizeof(lookup
));
903 lookup
.index
= index
;
906 dev_dbg(&adev
->dev
, "GPIO: looking up %s\n", propname
);
908 ret
= acpi_gpio_property_lookup(acpi_fwnode_handle(adev
),
909 propname
, index
, &lookup
);
913 dev_dbg(&adev
->dev
, "GPIO: _DSD returned %s %d %u %u\n",
914 dev_name(&lookup
.info
.adev
->dev
), lookup
.index
,
915 lookup
.pin_index
, lookup
.active_low
);
917 dev_dbg(&adev
->dev
, "GPIO: looking up %d in _CRS\n", index
);
918 lookup
.info
.adev
= adev
;
921 ret
= acpi_gpio_resource_lookup(&lookup
, info
);
922 return ret
? ERR_PTR(ret
) : lookup
.desc
;
926 * acpi_get_gpiod_from_data() - get a GPIO descriptor from ACPI data node
927 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
928 * @propname: Property name of the GPIO
929 * @index: index of GpioIo/GpioInt resource (starting from %0)
930 * @info: info pointer to fill in (optional)
932 * This function uses the property-based GPIO lookup to get to the GPIO
933 * resource with the relevant information from a data-only ACPI firmware node
934 * and uses that to obtain the GPIO descriptor to return.
937 * GPIO descriptor to use with Linux generic GPIO API.
938 * If the GPIO cannot be translated or there is an error an ERR_PTR is
941 static struct gpio_desc
*acpi_get_gpiod_from_data(struct fwnode_handle
*fwnode
,
942 const char *propname
,
944 struct acpi_gpio_info
*info
)
946 struct acpi_gpio_lookup lookup
;
949 if (!is_acpi_data_node(fwnode
))
950 return ERR_PTR(-ENODEV
);
953 return ERR_PTR(-EINVAL
);
955 memset(&lookup
, 0, sizeof(lookup
));
956 lookup
.index
= index
;
958 ret
= acpi_gpio_property_lookup(fwnode
, propname
, index
, &lookup
);
962 ret
= acpi_gpio_resource_lookup(&lookup
, info
);
963 return ret
? ERR_PTR(ret
) : lookup
.desc
;
966 static bool acpi_can_fallback_to_crs(struct acpi_device
*adev
,
969 /* If there is no ACPI device, there is no _CRS to fall back to */
973 /* Never allow fallback if the device has properties */
974 if (acpi_dev_has_props(adev
) || adev
->driver_gpios
)
977 return con_id
== NULL
;
980 static struct gpio_desc
*
981 __acpi_find_gpio(struct fwnode_handle
*fwnode
, const char *con_id
, unsigned int idx
,
982 bool can_fallback
, struct acpi_gpio_info
*info
)
984 struct acpi_device
*adev
= to_acpi_device_node(fwnode
);
985 struct gpio_desc
*desc
;
988 /* Try first from _DSD */
989 for_each_gpio_property_name(propname
, con_id
) {
991 desc
= acpi_get_gpiod_by_index(adev
,
992 propname
, idx
, info
);
994 desc
= acpi_get_gpiod_from_data(fwnode
,
995 propname
, idx
, info
);
996 if (PTR_ERR(desc
) == -EPROBE_DEFER
)
997 return ERR_CAST(desc
);
1003 /* Then from plain _CRS GPIOs */
1005 return acpi_get_gpiod_by_index(adev
, NULL
, idx
, info
);
1007 return ERR_PTR(-ENOENT
);
1010 struct gpio_desc
*acpi_find_gpio(struct fwnode_handle
*fwnode
,
1013 enum gpiod_flags
*dflags
,
1014 unsigned long *lookupflags
)
1016 struct acpi_device
*adev
= to_acpi_device_node(fwnode
);
1017 bool can_fallback
= acpi_can_fallback_to_crs(adev
, con_id
);
1018 struct acpi_gpio_info info
;
1019 struct gpio_desc
*desc
;
1021 desc
= __acpi_find_gpio(fwnode
, con_id
, idx
, can_fallback
, &info
);
1026 (*dflags
== GPIOD_OUT_LOW
|| *dflags
== GPIOD_OUT_HIGH
)) {
1027 dev_dbg(&adev
->dev
, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
1028 return ERR_PTR(-ENOENT
);
1031 acpi_gpio_update_gpiod_flags(dflags
, &info
);
1032 acpi_gpio_update_gpiod_lookup_flags(lookupflags
, &info
);
1037 * acpi_dev_gpio_irq_wake_get_by() - Find GpioInt and translate it to Linux IRQ number
1038 * @adev: pointer to a ACPI device to get IRQ from
1039 * @con_id: optional name of GpioInt resource
1040 * @index: index of GpioInt resource (starting from %0)
1041 * @wake_capable: Set to true if the IRQ is wake capable
1043 * If the device has one or more GpioInt resources, this function can be
1044 * used to translate from the GPIO offset in the resource to the Linux IRQ
1047 * The function is idempotent, though each time it runs it will configure GPIO
1048 * pin direction according to the flags in GpioInt resource.
1050 * The function takes optional @con_id parameter. If the resource has
1051 * a @con_id in a property, then only those will be taken into account.
1053 * The GPIO is considered wake capable if the GpioInt resource specifies
1054 * SharedAndWake or ExclusiveAndWake.
1057 * Linux IRQ number (> 0) on success, negative errno on failure.
1059 int acpi_dev_gpio_irq_wake_get_by(struct acpi_device
*adev
, const char *con_id
, int index
,
1062 struct fwnode_handle
*fwnode
= acpi_fwnode_handle(adev
);
1064 unsigned int irq_flags
;
1067 for (i
= 0, idx
= 0; idx
<= index
; i
++) {
1068 struct acpi_gpio_info info
;
1069 struct gpio_desc
*desc
;
1071 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
1072 desc
= __acpi_find_gpio(fwnode
, con_id
, i
, true, &info
);
1073 if (IS_ERR(desc
) && PTR_ERR(desc
) != -EPROBE_DEFER
)
1074 return PTR_ERR(desc
);
1076 if (info
.gpioint
&& idx
++ == index
) {
1077 unsigned long lflags
= GPIO_LOOKUP_FLAGS_DEFAULT
;
1078 enum gpiod_flags dflags
= GPIOD_ASIS
;
1083 return PTR_ERR(desc
);
1085 irq
= gpiod_to_irq(desc
);
1089 acpi_gpio_update_gpiod_flags(&dflags
, &info
);
1090 acpi_gpio_update_gpiod_lookup_flags(&lflags
, &info
);
1092 snprintf(label
, sizeof(label
), "%pfwP GpioInt(%d)", fwnode
, index
);
1093 ret
= gpiod_set_consumer_name(desc
, con_id
?: label
);
1097 ret
= gpiod_configure_flags(desc
, label
, lflags
, dflags
);
1101 /* ACPI uses hundredths of milliseconds units */
1102 ret
= gpio_set_debounce_timeout(desc
, info
.debounce
* 10);
1106 irq_flags
= acpi_dev_get_irq_type(info
.triggering
,
1110 * If the IRQ is not already in use then set type
1111 * if specified and different than the current one.
1113 if (can_request_irq(irq
, irq_flags
)) {
1114 if (irq_flags
!= IRQ_TYPE_NONE
&&
1115 irq_flags
!= irq_get_trigger_type(irq
))
1116 irq_set_irq_type(irq
, irq_flags
);
1118 dev_dbg(&adev
->dev
, "IRQ %d already in use\n", irq
);
1121 /* avoid suspend issues with GPIOs when systems are using S3 */
1122 if (wake_capable
&& acpi_gbl_FADT
.flags
& ACPI_FADT_LOW_POWER_S0
)
1123 *wake_capable
= info
.wake_capable
;
1131 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_wake_get_by
);
1134 acpi_gpio_adr_space_handler(u32 function
, acpi_physical_address address
,
1135 u32 bits
, u64
*value
, void *handler_context
,
1136 void *region_context
)
1138 struct acpi_gpio_chip
*achip
= region_context
;
1139 struct gpio_chip
*chip
= achip
->chip
;
1140 struct acpi_resource_gpio
*agpio
;
1141 struct acpi_resource
*ares
;
1142 u16 pin_index
= address
;
1147 status
= acpi_buffer_to_resource(achip
->conn_info
.connection
,
1148 achip
->conn_info
.length
, &ares
);
1149 if (ACPI_FAILURE(status
))
1152 if (WARN_ON(ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)) {
1154 return AE_BAD_PARAMETER
;
1157 agpio
= &ares
->data
.gpio
;
1159 if (WARN_ON(agpio
->io_restriction
== ACPI_IO_RESTRICT_INPUT
&&
1160 function
== ACPI_WRITE
)) {
1162 return AE_BAD_PARAMETER
;
1165 length
= min_t(u16
, agpio
->pin_table_length
, pin_index
+ bits
);
1166 for (i
= pin_index
; i
< length
; ++i
) {
1167 unsigned int pin
= agpio
->pin_table
[i
];
1168 struct acpi_gpio_connection
*conn
;
1169 struct gpio_desc
*desc
;
1172 mutex_lock(&achip
->conn_lock
);
1175 list_for_each_entry(conn
, &achip
->conns
, node
) {
1176 if (conn
->pin
== pin
) {
1184 * The same GPIO can be shared between operation region and
1185 * event but only if the access here is ACPI_READ. In that
1186 * case we "borrow" the event GPIO instead.
1188 if (!found
&& agpio
->shareable
== ACPI_SHARED
&&
1189 function
== ACPI_READ
) {
1190 struct acpi_gpio_event
*event
;
1192 list_for_each_entry(event
, &achip
->events
, node
) {
1193 if (event
->pin
== pin
) {
1202 desc
= acpi_request_own_gpiod(chip
, agpio
, i
, "ACPI:OpRegion");
1204 mutex_unlock(&achip
->conn_lock
);
1209 conn
= kzalloc(sizeof(*conn
), GFP_KERNEL
);
1211 gpiochip_free_own_desc(desc
);
1212 mutex_unlock(&achip
->conn_lock
);
1213 status
= AE_NO_MEMORY
;
1219 list_add_tail(&conn
->node
, &achip
->conns
);
1222 mutex_unlock(&achip
->conn_lock
);
1224 if (function
== ACPI_WRITE
)
1225 gpiod_set_raw_value_cansleep(desc
, !!(*value
& BIT(i
)));
1227 *value
|= (u64
)gpiod_get_raw_value_cansleep(desc
) << i
;
1235 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip
*achip
)
1237 struct gpio_chip
*chip
= achip
->chip
;
1238 acpi_handle handle
= ACPI_HANDLE(chip
->parent
);
1241 INIT_LIST_HEAD(&achip
->conns
);
1242 mutex_init(&achip
->conn_lock
);
1243 status
= acpi_install_address_space_handler(handle
, ACPI_ADR_SPACE_GPIO
,
1244 acpi_gpio_adr_space_handler
,
1246 if (ACPI_FAILURE(status
))
1247 dev_err(chip
->parent
,
1248 "Failed to install GPIO OpRegion handler\n");
1251 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip
*achip
)
1253 struct gpio_chip
*chip
= achip
->chip
;
1254 acpi_handle handle
= ACPI_HANDLE(chip
->parent
);
1255 struct acpi_gpio_connection
*conn
, *tmp
;
1258 status
= acpi_remove_address_space_handler(handle
, ACPI_ADR_SPACE_GPIO
,
1259 acpi_gpio_adr_space_handler
);
1260 if (ACPI_FAILURE(status
)) {
1261 dev_err(chip
->parent
,
1262 "Failed to remove GPIO OpRegion handler\n");
1266 list_for_each_entry_safe_reverse(conn
, tmp
, &achip
->conns
, node
) {
1267 gpiochip_free_own_desc(conn
->desc
);
1268 list_del(&conn
->node
);
1273 static struct gpio_desc
*
1274 acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip
*achip
,
1275 struct fwnode_handle
*fwnode
,
1277 unsigned long *lflags
,
1278 enum gpiod_flags
*dflags
)
1280 struct gpio_chip
*chip
= achip
->chip
;
1281 struct gpio_desc
*desc
;
1285 *lflags
= GPIO_LOOKUP_FLAGS_DEFAULT
;
1286 *dflags
= GPIOD_ASIS
;
1289 ret
= fwnode_property_read_u32_array(fwnode
, "gpios", gpios
,
1292 return ERR_PTR(ret
);
1294 desc
= gpiochip_get_desc(chip
, gpios
[0]);
1299 *lflags
|= GPIO_ACTIVE_LOW
;
1301 if (fwnode_property_present(fwnode
, "input"))
1302 *dflags
|= GPIOD_IN
;
1303 else if (fwnode_property_present(fwnode
, "output-low"))
1304 *dflags
|= GPIOD_OUT_LOW
;
1305 else if (fwnode_property_present(fwnode
, "output-high"))
1306 *dflags
|= GPIOD_OUT_HIGH
;
1308 return ERR_PTR(-EINVAL
);
1310 fwnode_property_read_string(fwnode
, "line-name", name
);
1315 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip
*achip
)
1317 struct gpio_chip
*chip
= achip
->chip
;
1318 struct fwnode_handle
*fwnode
;
1320 device_for_each_child_node(chip
->parent
, fwnode
) {
1321 unsigned long lflags
;
1322 enum gpiod_flags dflags
;
1323 struct gpio_desc
*desc
;
1327 if (!fwnode_property_present(fwnode
, "gpio-hog"))
1330 desc
= acpi_gpiochip_parse_own_gpio(achip
, fwnode
, &name
,
1335 ret
= gpiod_hog(desc
, name
, lflags
, dflags
);
1337 dev_err(chip
->parent
, "Failed to hog GPIO\n");
1338 fwnode_handle_put(fwnode
);
1344 void acpi_gpiochip_add(struct gpio_chip
*chip
)
1346 struct acpi_gpio_chip
*acpi_gpio
;
1347 struct acpi_device
*adev
;
1350 if (!chip
|| !chip
->parent
)
1353 adev
= ACPI_COMPANION(chip
->parent
);
1357 acpi_gpio
= kzalloc(sizeof(*acpi_gpio
), GFP_KERNEL
);
1359 dev_err(chip
->parent
,
1360 "Failed to allocate memory for ACPI GPIO chip\n");
1364 acpi_gpio
->chip
= chip
;
1365 INIT_LIST_HEAD(&acpi_gpio
->events
);
1366 INIT_LIST_HEAD(&acpi_gpio
->deferred_req_irqs_list_entry
);
1368 status
= acpi_attach_data(adev
->handle
, acpi_gpio_chip_dh
, acpi_gpio
);
1369 if (ACPI_FAILURE(status
)) {
1370 dev_err(chip
->parent
, "Failed to attach ACPI GPIO chip\n");
1375 acpi_gpiochip_request_regions(acpi_gpio
);
1376 acpi_gpiochip_scan_gpios(acpi_gpio
);
1377 acpi_dev_clear_dependencies(adev
);
1380 void acpi_gpiochip_remove(struct gpio_chip
*chip
)
1382 struct acpi_gpio_chip
*acpi_gpio
;
1386 if (!chip
|| !chip
->parent
)
1389 handle
= ACPI_HANDLE(chip
->parent
);
1393 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
1394 if (ACPI_FAILURE(status
)) {
1395 dev_warn(chip
->parent
, "Failed to retrieve ACPI GPIO chip\n");
1399 acpi_gpiochip_free_regions(acpi_gpio
);
1401 acpi_detach_data(handle
, acpi_gpio_chip_dh
);
1405 static int acpi_gpio_package_count(const union acpi_object
*obj
)
1407 const union acpi_object
*element
= obj
->package
.elements
;
1408 const union acpi_object
*end
= element
+ obj
->package
.count
;
1409 unsigned int count
= 0;
1411 while (element
< end
) {
1412 switch (element
->type
) {
1413 case ACPI_TYPE_LOCAL_REFERENCE
:
1416 case ACPI_TYPE_INTEGER
:
1429 static int acpi_find_gpio_count(struct acpi_resource
*ares
, void *data
)
1431 unsigned int *count
= data
;
1433 if (ares
->type
== ACPI_RESOURCE_TYPE_GPIO
)
1434 *count
+= ares
->data
.gpio
.pin_table_length
;
1440 * acpi_gpio_count - count the GPIOs associated with a firmware node / function
1441 * @fwnode: firmware node of the GPIO consumer
1442 * @con_id: function within the GPIO consumer
1445 * The number of GPIOs associated with a firmware node / function or %-ENOENT,
1446 * if no GPIO has been assigned to the requested function.
1448 int acpi_gpio_count(const struct fwnode_handle
*fwnode
, const char *con_id
)
1450 struct acpi_device
*adev
= to_acpi_device_node(fwnode
);
1451 const union acpi_object
*obj
;
1452 const struct acpi_gpio_mapping
*gm
;
1453 int count
= -ENOENT
;
1457 /* Try first from _DSD */
1458 for_each_gpio_property_name(propname
, con_id
) {
1459 ret
= acpi_dev_get_property(adev
, propname
, ACPI_TYPE_ANY
, &obj
);
1461 if (obj
->type
== ACPI_TYPE_LOCAL_REFERENCE
)
1463 else if (obj
->type
== ACPI_TYPE_PACKAGE
)
1464 count
= acpi_gpio_package_count(obj
);
1465 } else if (adev
->driver_gpios
) {
1466 for (gm
= adev
->driver_gpios
; gm
->name
; gm
++)
1467 if (strcmp(propname
, gm
->name
) == 0) {
1476 /* Then from plain _CRS GPIOs */
1478 struct list_head resource_list
;
1479 unsigned int crs_count
= 0;
1481 if (!acpi_can_fallback_to_crs(adev
, con_id
))
1484 INIT_LIST_HEAD(&resource_list
);
1485 acpi_dev_get_resources(adev
, &resource_list
,
1486 acpi_find_gpio_count
, &crs_count
);
1487 acpi_dev_free_resource_list(&resource_list
);
1491 return count
? count
: -ENOENT
;
1494 /* Run deferred acpi_gpiochip_request_irqs() */
1495 static int __init
acpi_gpio_handle_deferred_request_irqs(void)
1497 struct acpi_gpio_chip
*acpi_gpio
, *tmp
;
1499 mutex_lock(&acpi_gpio_deferred_req_irqs_lock
);
1500 list_for_each_entry_safe(acpi_gpio
, tmp
,
1501 &acpi_gpio_deferred_req_irqs_list
,
1502 deferred_req_irqs_list_entry
)
1503 acpi_gpiochip_request_irqs(acpi_gpio
);
1505 acpi_gpio_deferred_req_irqs_done
= true;
1506 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock
);
1510 /* We must use _sync so that this runs after the first deferred_probe run */
1511 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs
);
1513 static const struct dmi_system_id gpiolib_acpi_quirks
[] __initconst
= {
1516 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1517 * a non existing micro-USB-B connector which puts the HDMI
1518 * DDC pins in GPIO mode, breaking HDMI support.
1521 DMI_MATCH(DMI_SYS_VENDOR
, "MINIX"),
1522 DMI_MATCH(DMI_PRODUCT_NAME
, "Z83-4"),
1524 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1525 .no_edge_events_on_boot
= true,
1530 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1531 * instead of controlling the actual micro-USB-B turns the 5V
1532 * boost for its USB-A connector off. The actual micro-USB-B
1533 * connector is wired for charging only.
1536 DMI_MATCH(DMI_SYS_VENDOR
, "Wortmann_AG"),
1537 DMI_MATCH(DMI_PRODUCT_NAME
, "TERRA_PAD_1061"),
1539 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1540 .no_edge_events_on_boot
= true,
1545 * The Dell Venue 10 Pro 5055, with Bay Trail SoC + TI PMIC uses an
1546 * external embedded-controller connected via I2C + an ACPI GPIO
1547 * event handler on INT33FFC:02 pin 12, causing spurious wakeups.
1550 DMI_MATCH(DMI_SYS_VENDOR
, "Dell Inc."),
1551 DMI_MATCH(DMI_PRODUCT_NAME
, "Venue 10 Pro 5055"),
1553 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1554 .ignore_wake
= "INT33FC:02@12",
1559 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1560 * external embedded-controller connected via I2C + an ACPI GPIO
1561 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1562 * When suspending by closing the LID, the power to the USB
1563 * keyboard is turned off, causing INT0002 ACPI events to
1564 * trigger once the XHCI controller notices the keyboard is
1565 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1566 * EC wakes breaks wakeup when opening the lid, the user needs
1567 * to press the power-button to wakeup the system. The
1568 * alternative is suspend simply not working, which is worse.
1571 DMI_MATCH(DMI_SYS_VENDOR
, "HP"),
1572 DMI_MATCH(DMI_PRODUCT_NAME
, "HP x2 Detachable 10-p0XX"),
1574 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1575 .ignore_wake
= "INT33FF:01@0,INT0002:00@2",
1580 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1581 * external embedded-controller connected via I2C + an ACPI GPIO
1582 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1585 DMI_MATCH(DMI_SYS_VENDOR
, "Hewlett-Packard"),
1586 DMI_MATCH(DMI_PRODUCT_NAME
, "HP Pavilion x2 Detachable"),
1587 DMI_MATCH(DMI_BOARD_NAME
, "815D"),
1589 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1590 .ignore_wake
= "INT33FC:02@28",
1595 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1596 * external embedded-controller connected via I2C + an ACPI GPIO
1597 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1600 DMI_MATCH(DMI_SYS_VENDOR
, "HP"),
1601 DMI_MATCH(DMI_PRODUCT_NAME
, "HP Pavilion x2 Detachable"),
1602 DMI_MATCH(DMI_BOARD_NAME
, "813E"),
1604 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1605 .ignore_wake
= "INT33FF:01@0",
1610 * Interrupt storm caused from edge triggered floating pin
1611 * Found in BIOS UX325UAZ.300
1612 * https://bugzilla.kernel.org/show_bug.cgi?id=216208
1615 DMI_MATCH(DMI_SYS_VENDOR
, "ASUSTeK COMPUTER INC."),
1616 DMI_MATCH(DMI_PRODUCT_NAME
, "ZenBook UX325UAZ_UM325UAZ"),
1618 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1619 .ignore_interrupt
= "AMDI0030:00@18",
1624 * Spurious wakeups from TP_ATTN# pin
1625 * Found in BIOS 1.7.8
1626 * https://gitlab.freedesktop.org/drm/amd/-/issues/1722#note_1720627
1629 DMI_MATCH(DMI_BOARD_NAME
, "NL5xNU"),
1631 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1632 .ignore_wake
= "ELAN0415:00@9",
1637 * Spurious wakeups from TP_ATTN# pin
1638 * Found in BIOS 1.7.8
1639 * https://gitlab.freedesktop.org/drm/amd/-/issues/1722#note_1720627
1642 DMI_MATCH(DMI_BOARD_NAME
, "NL5xRU"),
1644 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1645 .ignore_wake
= "ELAN0415:00@9",
1650 * Spurious wakeups from TP_ATTN# pin
1651 * Found in BIOS 1.7.7
1654 DMI_MATCH(DMI_BOARD_NAME
, "NH5xAx"),
1656 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1657 .ignore_wake
= "SYNA1202:00@16",
1662 * On the Peaq C1010 2-in-1 INT33FC:00 pin 3 is connected to
1663 * a "dolby" button. At the ACPI level an _AEI event-handler
1664 * is connected which sets an ACPI variable to 1 on both
1665 * edges. This variable can be polled + cleared to 0 using
1666 * WMI. But since the variable is set on both edges the WMI
1667 * interface is pretty useless even when polling.
1668 * So instead the x86-android-tablets code instantiates
1669 * a gpio-keys platform device for it.
1670 * Ignore the _AEI handler for the pin, so that it is not busy.
1673 DMI_MATCH(DMI_SYS_VENDOR
, "PEAQ"),
1674 DMI_MATCH(DMI_PRODUCT_NAME
, "PEAQ PMM C1010 MD99187"),
1676 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1677 .ignore_interrupt
= "INT33FC:00@3",
1682 * Spurious wakeups from TP_ATTN# pin
1683 * Found in BIOS 0.35
1684 * https://gitlab.freedesktop.org/drm/amd/-/issues/3073
1687 DMI_MATCH(DMI_SYS_VENDOR
, "GPD"),
1688 DMI_MATCH(DMI_PRODUCT_NAME
, "G1619-04"),
1690 .driver_data
= &(struct acpi_gpiolib_dmi_quirk
) {
1691 .ignore_wake
= "PNP0C50:00@8",
1694 {} /* Terminating entry */
1697 static int __init
acpi_gpio_setup_params(void)
1699 const struct acpi_gpiolib_dmi_quirk
*quirk
= NULL
;
1700 const struct dmi_system_id
*id
;
1702 id
= dmi_first_match(gpiolib_acpi_quirks
);
1704 quirk
= id
->driver_data
;
1706 if (run_edge_events_on_boot
< 0) {
1707 if (quirk
&& quirk
->no_edge_events_on_boot
)
1708 run_edge_events_on_boot
= 0;
1710 run_edge_events_on_boot
= 1;
1713 if (ignore_wake
== NULL
&& quirk
&& quirk
->ignore_wake
)
1714 ignore_wake
= quirk
->ignore_wake
;
1716 if (ignore_interrupt
== NULL
&& quirk
&& quirk
->ignore_interrupt
)
1717 ignore_interrupt
= quirk
->ignore_interrupt
;
1722 /* Directly after dmi_setup() which runs as core_initcall() */
1723 postcore_initcall(acpi_gpio_setup_params
);