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/errno.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/gpio/driver.h>
13 #include <linux/gpio/machine.h>
14 #include <linux/export.h>
15 #include <linux/acpi.h>
16 #include <linux/interrupt.h>
17 #include <linux/mutex.h>
18 #include <linux/pinctrl/pinctrl.h>
23 * struct acpi_gpio_event - ACPI GPIO event handler data
25 * @node: list-entry of the events list of the struct acpi_gpio_chip
26 * @handle: handle of ACPI method to execute when the IRQ triggers
27 * @handler: irq_handler to pass to request_irq when requesting the IRQ
28 * @pin: GPIO pin number on the gpio_chip
29 * @irq: Linux IRQ number for the event, for request_ / free_irq
30 * @irqflags: flags to pass to request_irq when requesting the IRQ
31 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
32 * @irq_requested:True if request_irq has been done
33 * @desc: gpio_desc for the GPIO pin for this event
35 struct acpi_gpio_event
{
36 struct list_head node
;
38 irq_handler_t handler
;
41 unsigned long irqflags
;
44 struct gpio_desc
*desc
;
47 struct acpi_gpio_connection
{
48 struct list_head node
;
50 struct gpio_desc
*desc
;
53 struct acpi_gpio_chip
{
55 * ACPICA requires that the first field of the context parameter
56 * passed to acpi_install_address_space_handler() is large enough
57 * to hold struct acpi_connection_info.
59 struct acpi_connection_info conn_info
;
60 struct list_head conns
;
61 struct mutex conn_lock
;
62 struct gpio_chip
*chip
;
63 struct list_head events
;
64 struct list_head deferred_req_irqs_list_entry
;
68 * For gpiochips which call acpi_gpiochip_request_interrupts() before late_init
69 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
70 * late_initcall_sync handler, so that other builtin drivers can register their
71 * OpRegions before the event handlers can run. This list contains gpiochips
72 * for which the acpi_gpiochip_request_irqs() call has been deferred.
74 static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock
);
75 static LIST_HEAD(acpi_gpio_deferred_req_irqs_list
);
76 static bool acpi_gpio_deferred_req_irqs_done
;
78 static int acpi_gpiochip_find(struct gpio_chip
*gc
, void *data
)
83 return ACPI_HANDLE(gc
->parent
) == data
;
87 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
88 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
89 * @pin: ACPI GPIO pin number (0-based, controller-relative)
91 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
92 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
93 * controller does not have gpiochip registered at the moment. This is to
94 * support probe deferral.
96 static struct gpio_desc
*acpi_get_gpiod(char *path
, int pin
)
98 struct gpio_chip
*chip
;
102 status
= acpi_get_handle(NULL
, path
, &handle
);
103 if (ACPI_FAILURE(status
))
104 return ERR_PTR(-ENODEV
);
106 chip
= gpiochip_find(handle
, acpi_gpiochip_find
);
108 return ERR_PTR(-EPROBE_DEFER
);
110 return gpiochip_get_desc(chip
, pin
);
113 static irqreturn_t
acpi_gpio_irq_handler(int irq
, void *data
)
115 struct acpi_gpio_event
*event
= data
;
117 acpi_evaluate_object(event
->handle
, NULL
, NULL
, NULL
);
122 static irqreturn_t
acpi_gpio_irq_handler_evt(int irq
, void *data
)
124 struct acpi_gpio_event
*event
= data
;
126 acpi_execute_simple_method(event
->handle
, NULL
, event
->pin
);
131 static void acpi_gpio_chip_dh(acpi_handle handle
, void *data
)
133 /* The address of this function is used as a key. */
136 bool acpi_gpio_get_irq_resource(struct acpi_resource
*ares
,
137 struct acpi_resource_gpio
**agpio
)
139 struct acpi_resource_gpio
*gpio
;
141 if (ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)
144 gpio
= &ares
->data
.gpio
;
145 if (gpio
->connection_type
!= ACPI_RESOURCE_GPIO_TYPE_INT
)
151 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource
);
153 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip
*acpi_gpio
,
154 struct acpi_gpio_event
*event
)
158 ret
= request_threaded_irq(event
->irq
, NULL
, event
->handler
,
159 event
->irqflags
, "ACPI:Event", event
);
161 dev_err(acpi_gpio
->chip
->parent
,
162 "Failed to setup interrupt handler for %d\n",
167 if (event
->irq_is_wake
)
168 enable_irq_wake(event
->irq
);
170 event
->irq_requested
= true;
172 /* Make sure we trigger the initial state of edge-triggered IRQs */
173 value
= gpiod_get_raw_value_cansleep(event
->desc
);
174 if (((event
->irqflags
& IRQF_TRIGGER_RISING
) && value
== 1) ||
175 ((event
->irqflags
& IRQF_TRIGGER_FALLING
) && value
== 0))
176 event
->handler(event
->irq
, event
);
179 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip
*acpi_gpio
)
181 struct acpi_gpio_event
*event
;
183 list_for_each_entry(event
, &acpi_gpio
->events
, node
)
184 acpi_gpiochip_request_irq(acpi_gpio
, event
);
187 static acpi_status
acpi_gpiochip_alloc_event(struct acpi_resource
*ares
,
190 struct acpi_gpio_chip
*acpi_gpio
= context
;
191 struct gpio_chip
*chip
= acpi_gpio
->chip
;
192 struct acpi_resource_gpio
*agpio
;
193 acpi_handle handle
, evt_handle
;
194 struct acpi_gpio_event
*event
;
195 irq_handler_t handler
= NULL
;
196 struct gpio_desc
*desc
;
199 if (!acpi_gpio_get_irq_resource(ares
, &agpio
))
202 handle
= ACPI_HANDLE(chip
->parent
);
203 pin
= agpio
->pin_table
[0];
207 sprintf(ev_name
, "_%c%02hhX",
208 agpio
->triggering
== ACPI_EDGE_SENSITIVE
? 'E' : 'L',
210 if (ACPI_SUCCESS(acpi_get_handle(handle
, ev_name
, &evt_handle
)))
211 handler
= acpi_gpio_irq_handler
;
214 if (ACPI_SUCCESS(acpi_get_handle(handle
, "_EVT", &evt_handle
)))
215 handler
= acpi_gpio_irq_handler_evt
;
220 desc
= gpiochip_request_own_desc(chip
, pin
, "ACPI:Event", 0);
222 dev_err(chip
->parent
, "Failed to request GPIO\n");
226 gpiod_direction_input(desc
);
228 ret
= gpiochip_lock_as_irq(chip
, pin
);
230 dev_err(chip
->parent
, "Failed to lock GPIO as interrupt\n");
234 irq
= gpiod_to_irq(desc
);
236 dev_err(chip
->parent
, "Failed to translate GPIO to IRQ\n");
237 goto fail_unlock_irq
;
240 event
= kzalloc(sizeof(*event
), GFP_KERNEL
);
242 goto fail_unlock_irq
;
244 event
->irqflags
= IRQF_ONESHOT
;
245 if (agpio
->triggering
== ACPI_LEVEL_SENSITIVE
) {
246 if (agpio
->polarity
== ACPI_ACTIVE_HIGH
)
247 event
->irqflags
|= IRQF_TRIGGER_HIGH
;
249 event
->irqflags
|= IRQF_TRIGGER_LOW
;
251 switch (agpio
->polarity
) {
252 case ACPI_ACTIVE_HIGH
:
253 event
->irqflags
|= IRQF_TRIGGER_RISING
;
255 case ACPI_ACTIVE_LOW
:
256 event
->irqflags
|= IRQF_TRIGGER_FALLING
;
259 event
->irqflags
|= IRQF_TRIGGER_RISING
|
260 IRQF_TRIGGER_FALLING
;
265 event
->handle
= evt_handle
;
266 event
->handler
= handler
;
268 event
->irq_is_wake
= agpio
->wake_capable
== ACPI_WAKE_CAPABLE
;
272 list_add_tail(&event
->node
, &acpi_gpio
->events
);
277 gpiochip_unlock_as_irq(chip
, pin
);
279 gpiochip_free_own_desc(desc
);
285 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
288 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
289 * handled by ACPI event methods which need to be called from the GPIO
290 * chip's interrupt handler. acpi_gpiochip_request_interrupts finds out which
291 * gpio pins have acpi event methods and assigns interrupt handlers that calls
292 * the acpi event methods for those pins.
294 void acpi_gpiochip_request_interrupts(struct gpio_chip
*chip
)
296 struct acpi_gpio_chip
*acpi_gpio
;
301 if (!chip
->parent
|| !chip
->to_irq
)
304 handle
= ACPI_HANDLE(chip
->parent
);
308 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
309 if (ACPI_FAILURE(status
))
312 acpi_walk_resources(handle
, "_AEI",
313 acpi_gpiochip_alloc_event
, acpi_gpio
);
315 mutex_lock(&acpi_gpio_deferred_req_irqs_lock
);
316 defer
= !acpi_gpio_deferred_req_irqs_done
;
318 list_add(&acpi_gpio
->deferred_req_irqs_list_entry
,
319 &acpi_gpio_deferred_req_irqs_list
);
320 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock
);
325 acpi_gpiochip_request_irqs(acpi_gpio
);
327 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts
);
330 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
333 * Free interrupts associated with GPIO ACPI event method for the given
336 void acpi_gpiochip_free_interrupts(struct gpio_chip
*chip
)
338 struct acpi_gpio_chip
*acpi_gpio
;
339 struct acpi_gpio_event
*event
, *ep
;
343 if (!chip
->parent
|| !chip
->to_irq
)
346 handle
= ACPI_HANDLE(chip
->parent
);
350 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
351 if (ACPI_FAILURE(status
))
354 mutex_lock(&acpi_gpio_deferred_req_irqs_lock
);
355 if (!list_empty(&acpi_gpio
->deferred_req_irqs_list_entry
))
356 list_del_init(&acpi_gpio
->deferred_req_irqs_list_entry
);
357 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock
);
359 list_for_each_entry_safe_reverse(event
, ep
, &acpi_gpio
->events
, node
) {
360 if (event
->irq_requested
) {
361 if (event
->irq_is_wake
)
362 disable_irq_wake(event
->irq
);
364 free_irq(event
->irq
, event
);
367 gpiochip_unlock_as_irq(chip
, event
->pin
);
368 gpiochip_free_own_desc(event
->desc
);
369 list_del(&event
->node
);
373 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts
);
375 int acpi_dev_add_driver_gpios(struct acpi_device
*adev
,
376 const struct acpi_gpio_mapping
*gpios
)
379 adev
->driver_gpios
= gpios
;
384 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios
);
386 static void devm_acpi_dev_release_driver_gpios(struct device
*dev
, void *res
)
388 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev
));
391 int devm_acpi_dev_add_driver_gpios(struct device
*dev
,
392 const struct acpi_gpio_mapping
*gpios
)
397 res
= devres_alloc(devm_acpi_dev_release_driver_gpios
, 0, GFP_KERNEL
);
401 ret
= acpi_dev_add_driver_gpios(ACPI_COMPANION(dev
), gpios
);
406 devres_add(dev
, res
);
409 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios
);
411 void devm_acpi_dev_remove_driver_gpios(struct device
*dev
)
413 WARN_ON(devres_release(dev
, devm_acpi_dev_release_driver_gpios
, NULL
, NULL
));
415 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios
);
417 static bool acpi_get_driver_gpio_data(struct acpi_device
*adev
,
418 const char *name
, int index
,
419 struct fwnode_reference_args
*args
,
420 unsigned int *quirks
)
422 const struct acpi_gpio_mapping
*gm
;
424 if (!adev
->driver_gpios
)
427 for (gm
= adev
->driver_gpios
; gm
->name
; gm
++)
428 if (!strcmp(name
, gm
->name
) && gm
->data
&& index
< gm
->size
) {
429 const struct acpi_gpio_params
*par
= gm
->data
+ index
;
431 args
->fwnode
= acpi_fwnode_handle(adev
);
432 args
->args
[0] = par
->crs_entry_index
;
433 args
->args
[1] = par
->line_index
;
434 args
->args
[2] = par
->active_low
;
437 *quirks
= gm
->quirks
;
444 static enum gpiod_flags
445 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio
*agpio
)
447 bool pull_up
= agpio
->pin_config
== ACPI_PIN_CONFIG_PULLUP
;
449 switch (agpio
->io_restriction
) {
450 case ACPI_IO_RESTRICT_INPUT
:
452 case ACPI_IO_RESTRICT_OUTPUT
:
454 * ACPI GPIO resources don't contain an initial value for the
455 * GPIO. Therefore we deduce that value from the pull field
456 * instead. If the pin is pulled up we assume default to be
457 * high, otherwise low.
459 return pull_up
? GPIOD_OUT_HIGH
: GPIOD_OUT_LOW
;
462 * Assume that the BIOS has configured the direction and pull
470 __acpi_gpio_update_gpiod_flags(enum gpiod_flags
*flags
, enum gpiod_flags update
)
472 const enum gpiod_flags mask
=
473 GPIOD_FLAGS_BIT_DIR_SET
| GPIOD_FLAGS_BIT_DIR_OUT
|
474 GPIOD_FLAGS_BIT_DIR_VAL
;
478 * Check if the BIOS has IoRestriction with explicitly set direction
479 * and update @flags accordingly. Otherwise use whatever caller asked
482 if (update
& GPIOD_FLAGS_BIT_DIR_SET
) {
483 enum gpiod_flags diff
= *flags
^ update
;
486 * Check if caller supplied incompatible GPIO initialization
489 * Return %-EINVAL to notify that firmware has different
490 * settings and we are going to use them.
492 if (((*flags
& GPIOD_FLAGS_BIT_DIR_SET
) && (diff
& GPIOD_FLAGS_BIT_DIR_OUT
)) ||
493 ((*flags
& GPIOD_FLAGS_BIT_DIR_OUT
) && (diff
& GPIOD_FLAGS_BIT_DIR_VAL
)))
495 *flags
= (*flags
& ~mask
) | (update
& mask
);
501 acpi_gpio_update_gpiod_flags(enum gpiod_flags
*flags
, struct acpi_gpio_info
*info
)
503 struct device
*dev
= &info
->adev
->dev
;
504 enum gpiod_flags old
= *flags
;
507 ret
= __acpi_gpio_update_gpiod_flags(&old
, info
->flags
);
508 if (info
->quirks
& ACPI_GPIO_QUIRK_NO_IO_RESTRICTION
) {
510 dev_warn(dev
, FW_BUG
"GPIO not in correct mode, fixing\n");
513 dev_dbg(dev
, "Override GPIO initialization flags\n");
520 struct acpi_gpio_lookup
{
521 struct acpi_gpio_info info
;
525 struct gpio_desc
*desc
;
529 static int acpi_populate_gpio_lookup(struct acpi_resource
*ares
, void *data
)
531 struct acpi_gpio_lookup
*lookup
= data
;
533 if (ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)
537 const struct acpi_resource_gpio
*agpio
= &ares
->data
.gpio
;
538 bool gpioint
= agpio
->connection_type
== ACPI_RESOURCE_GPIO_TYPE_INT
;
541 if (lookup
->info
.quirks
& ACPI_GPIO_QUIRK_ONLY_GPIOIO
&& gpioint
)
544 if (lookup
->n
++ != lookup
->index
)
547 pin_index
= lookup
->pin_index
;
548 if (pin_index
>= agpio
->pin_table_length
)
551 lookup
->desc
= acpi_get_gpiod(agpio
->resource_source
.string_ptr
,
552 agpio
->pin_table
[pin_index
]);
553 lookup
->info
.gpioint
= gpioint
;
556 * Polarity and triggering are only specified for GpioInt
558 * Note: we expect here:
559 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
560 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
562 if (lookup
->info
.gpioint
) {
563 lookup
->info
.flags
= GPIOD_IN
;
564 lookup
->info
.polarity
= agpio
->polarity
;
565 lookup
->info
.triggering
= agpio
->triggering
;
567 lookup
->info
.flags
= acpi_gpio_to_gpiod_flags(agpio
);
568 lookup
->info
.polarity
= lookup
->active_low
;
575 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup
*lookup
,
576 struct acpi_gpio_info
*info
)
578 struct acpi_device
*adev
= lookup
->info
.adev
;
579 struct list_head res_list
;
582 INIT_LIST_HEAD(&res_list
);
584 ret
= acpi_dev_get_resources(adev
, &res_list
,
585 acpi_populate_gpio_lookup
,
590 acpi_dev_free_resource_list(&res_list
);
596 *info
= lookup
->info
;
600 static int acpi_gpio_property_lookup(struct fwnode_handle
*fwnode
,
601 const char *propname
, int index
,
602 struct acpi_gpio_lookup
*lookup
)
604 struct fwnode_reference_args args
;
605 unsigned int quirks
= 0;
608 memset(&args
, 0, sizeof(args
));
609 ret
= __acpi_node_get_property_reference(fwnode
, propname
, index
, 3,
612 struct acpi_device
*adev
= to_acpi_device_node(fwnode
);
617 if (!acpi_get_driver_gpio_data(adev
, propname
, index
, &args
,
622 * The property was found and resolved, so need to lookup the GPIO based
625 if (!to_acpi_device_node(args
.fwnode
))
630 lookup
->index
= args
.args
[0];
631 lookup
->pin_index
= args
.args
[1];
632 lookup
->active_low
= !!args
.args
[2];
634 lookup
->info
.adev
= to_acpi_device_node(args
.fwnode
);
635 lookup
->info
.quirks
= quirks
;
641 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
642 * @adev: pointer to a ACPI device to get GPIO from
643 * @propname: Property name of the GPIO (optional)
644 * @index: index of GpioIo/GpioInt resource (starting from %0)
645 * @info: info pointer to fill in (optional)
647 * Function goes through ACPI resources for @adev and based on @index looks
648 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
649 * and returns it. @index matches GpioIo/GpioInt resources only so if there
650 * are total %3 GPIO resources, the index goes from %0 to %2.
652 * If @propname is specified the GPIO is looked using device property. In
653 * that case @index is used to select the GPIO entry in the property value
654 * (in case of multiple).
656 * If the GPIO cannot be translated or there is an error an ERR_PTR is
659 * Note: if the GPIO resource has multiple entries in the pin list, this
660 * function only returns the first.
662 static struct gpio_desc
*acpi_get_gpiod_by_index(struct acpi_device
*adev
,
663 const char *propname
, int index
,
664 struct acpi_gpio_info
*info
)
666 struct acpi_gpio_lookup lookup
;
670 return ERR_PTR(-ENODEV
);
672 memset(&lookup
, 0, sizeof(lookup
));
673 lookup
.index
= index
;
676 dev_dbg(&adev
->dev
, "GPIO: looking up %s\n", propname
);
678 ret
= acpi_gpio_property_lookup(acpi_fwnode_handle(adev
),
679 propname
, index
, &lookup
);
683 dev_dbg(&adev
->dev
, "GPIO: _DSD returned %s %d %d %u\n",
684 dev_name(&lookup
.info
.adev
->dev
), lookup
.index
,
685 lookup
.pin_index
, lookup
.active_low
);
687 dev_dbg(&adev
->dev
, "GPIO: looking up %d in _CRS\n", index
);
688 lookup
.info
.adev
= adev
;
691 ret
= acpi_gpio_resource_lookup(&lookup
, info
);
692 return ret
? ERR_PTR(ret
) : lookup
.desc
;
695 struct gpio_desc
*acpi_find_gpio(struct device
*dev
,
698 enum gpiod_flags
*dflags
,
699 enum gpio_lookup_flags
*lookupflags
)
701 struct acpi_device
*adev
= ACPI_COMPANION(dev
);
702 struct acpi_gpio_info info
;
703 struct gpio_desc
*desc
;
707 /* Try first from _DSD */
708 for (i
= 0; i
< ARRAY_SIZE(gpio_suffixes
); i
++) {
710 snprintf(propname
, sizeof(propname
), "%s-%s",
711 con_id
, gpio_suffixes
[i
]);
713 snprintf(propname
, sizeof(propname
), "%s",
717 desc
= acpi_get_gpiod_by_index(adev
, propname
, idx
, &info
);
720 if (PTR_ERR(desc
) == -EPROBE_DEFER
)
721 return ERR_CAST(desc
);
724 /* Then from plain _CRS GPIOs */
726 if (!acpi_can_fallback_to_crs(adev
, con_id
))
727 return ERR_PTR(-ENOENT
);
729 desc
= acpi_get_gpiod_by_index(adev
, NULL
, idx
, &info
);
735 (*dflags
== GPIOD_OUT_LOW
|| *dflags
== GPIOD_OUT_HIGH
)) {
736 dev_dbg(dev
, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
737 return ERR_PTR(-ENOENT
);
740 if (info
.polarity
== GPIO_ACTIVE_LOW
)
741 *lookupflags
|= GPIO_ACTIVE_LOW
;
743 acpi_gpio_update_gpiod_flags(dflags
, &info
);
748 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
749 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
750 * @propname: Property name of the GPIO
751 * @index: index of GpioIo/GpioInt resource (starting from %0)
752 * @info: info pointer to fill in (optional)
754 * If @fwnode is an ACPI device object, call %acpi_get_gpiod_by_index() for it.
755 * Otherwise (ie. it is a data-only non-device object), use the property-based
756 * GPIO lookup to get to the GPIO resource with the relevant information and use
757 * that to obtain the GPIO descriptor to return.
759 struct gpio_desc
*acpi_node_get_gpiod(struct fwnode_handle
*fwnode
,
760 const char *propname
, int index
,
761 struct acpi_gpio_info
*info
)
763 struct acpi_gpio_lookup lookup
;
764 struct acpi_device
*adev
;
767 adev
= to_acpi_device_node(fwnode
);
769 return acpi_get_gpiod_by_index(adev
, propname
, index
, info
);
771 if (!is_acpi_data_node(fwnode
))
772 return ERR_PTR(-ENODEV
);
775 return ERR_PTR(-EINVAL
);
777 memset(&lookup
, 0, sizeof(lookup
));
778 lookup
.index
= index
;
780 ret
= acpi_gpio_property_lookup(fwnode
, propname
, index
, &lookup
);
784 ret
= acpi_gpio_resource_lookup(&lookup
, info
);
785 return ret
? ERR_PTR(ret
) : lookup
.desc
;
789 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
790 * @adev: pointer to a ACPI device to get IRQ from
791 * @index: index of GpioInt resource (starting from %0)
793 * If the device has one or more GpioInt resources, this function can be
794 * used to translate from the GPIO offset in the resource to the Linux IRQ
797 * The function is idempotent, though each time it runs it will configure GPIO
798 * pin direction according to the flags in GpioInt resource.
800 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
802 int acpi_dev_gpio_irq_get(struct acpi_device
*adev
, int index
)
805 unsigned int irq_flags
;
808 for (i
= 0, idx
= 0; idx
<= index
; i
++) {
809 struct acpi_gpio_info info
;
810 struct gpio_desc
*desc
;
812 desc
= acpi_get_gpiod_by_index(adev
, NULL
, i
, &info
);
814 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
815 if (IS_ERR(desc
) && PTR_ERR(desc
) != -EPROBE_DEFER
)
816 return PTR_ERR(desc
);
818 if (info
.gpioint
&& idx
++ == index
) {
823 return PTR_ERR(desc
);
825 irq
= gpiod_to_irq(desc
);
829 snprintf(label
, sizeof(label
), "GpioInt() %d", index
);
830 ret
= gpiod_configure_flags(desc
, label
, 0, info
.flags
);
834 irq_flags
= acpi_dev_get_irq_type(info
.triggering
,
837 /* Set type if specified and different than the current one */
838 if (irq_flags
!= IRQ_TYPE_NONE
&&
839 irq_flags
!= irq_get_trigger_type(irq
))
840 irq_set_irq_type(irq
, irq_flags
);
848 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get
);
851 acpi_gpio_adr_space_handler(u32 function
, acpi_physical_address address
,
852 u32 bits
, u64
*value
, void *handler_context
,
853 void *region_context
)
855 struct acpi_gpio_chip
*achip
= region_context
;
856 struct gpio_chip
*chip
= achip
->chip
;
857 struct acpi_resource_gpio
*agpio
;
858 struct acpi_resource
*ares
;
859 int pin_index
= (int)address
;
864 status
= acpi_buffer_to_resource(achip
->conn_info
.connection
,
865 achip
->conn_info
.length
, &ares
);
866 if (ACPI_FAILURE(status
))
869 if (WARN_ON(ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)) {
871 return AE_BAD_PARAMETER
;
874 agpio
= &ares
->data
.gpio
;
876 if (WARN_ON(agpio
->io_restriction
== ACPI_IO_RESTRICT_INPUT
&&
877 function
== ACPI_WRITE
)) {
879 return AE_BAD_PARAMETER
;
882 length
= min(agpio
->pin_table_length
, (u16
)(pin_index
+ bits
));
883 for (i
= pin_index
; i
< length
; ++i
) {
884 int pin
= agpio
->pin_table
[i
];
885 struct acpi_gpio_connection
*conn
;
886 struct gpio_desc
*desc
;
889 mutex_lock(&achip
->conn_lock
);
892 list_for_each_entry(conn
, &achip
->conns
, node
) {
893 if (conn
->pin
== pin
) {
901 * The same GPIO can be shared between operation region and
902 * event but only if the access here is ACPI_READ. In that
903 * case we "borrow" the event GPIO instead.
905 if (!found
&& agpio
->shareable
== ACPI_SHARED
&&
906 function
== ACPI_READ
) {
907 struct acpi_gpio_event
*event
;
909 list_for_each_entry(event
, &achip
->events
, node
) {
910 if (event
->pin
== pin
) {
919 enum gpiod_flags flags
= acpi_gpio_to_gpiod_flags(agpio
);
920 const char *label
= "ACPI:OpRegion";
922 desc
= gpiochip_request_own_desc(chip
, pin
, label
,
926 mutex_unlock(&achip
->conn_lock
);
930 conn
= kzalloc(sizeof(*conn
), GFP_KERNEL
);
932 status
= AE_NO_MEMORY
;
933 gpiochip_free_own_desc(desc
);
934 mutex_unlock(&achip
->conn_lock
);
940 list_add_tail(&conn
->node
, &achip
->conns
);
943 mutex_unlock(&achip
->conn_lock
);
945 if (function
== ACPI_WRITE
)
946 gpiod_set_raw_value_cansleep(desc
,
947 !!((1 << i
) & *value
));
949 *value
|= (u64
)gpiod_get_raw_value_cansleep(desc
) << i
;
957 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip
*achip
)
959 struct gpio_chip
*chip
= achip
->chip
;
960 acpi_handle handle
= ACPI_HANDLE(chip
->parent
);
963 INIT_LIST_HEAD(&achip
->conns
);
964 mutex_init(&achip
->conn_lock
);
965 status
= acpi_install_address_space_handler(handle
, ACPI_ADR_SPACE_GPIO
,
966 acpi_gpio_adr_space_handler
,
968 if (ACPI_FAILURE(status
))
969 dev_err(chip
->parent
,
970 "Failed to install GPIO OpRegion handler\n");
973 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip
*achip
)
975 struct gpio_chip
*chip
= achip
->chip
;
976 acpi_handle handle
= ACPI_HANDLE(chip
->parent
);
977 struct acpi_gpio_connection
*conn
, *tmp
;
980 status
= acpi_remove_address_space_handler(handle
, ACPI_ADR_SPACE_GPIO
,
981 acpi_gpio_adr_space_handler
);
982 if (ACPI_FAILURE(status
)) {
983 dev_err(chip
->parent
,
984 "Failed to remove GPIO OpRegion handler\n");
988 list_for_each_entry_safe_reverse(conn
, tmp
, &achip
->conns
, node
) {
989 gpiochip_free_own_desc(conn
->desc
);
990 list_del(&conn
->node
);
995 static struct gpio_desc
*acpi_gpiochip_parse_own_gpio(
996 struct acpi_gpio_chip
*achip
, struct fwnode_handle
*fwnode
,
997 const char **name
, unsigned int *lflags
, unsigned int *dflags
)
999 struct gpio_chip
*chip
= achip
->chip
;
1000 struct gpio_desc
*desc
;
1008 ret
= fwnode_property_read_u32_array(fwnode
, "gpios", gpios
,
1011 return ERR_PTR(ret
);
1013 desc
= gpiochip_get_desc(chip
, gpios
[0]);
1018 *lflags
|= GPIO_ACTIVE_LOW
;
1020 if (fwnode_property_present(fwnode
, "input"))
1021 *dflags
|= GPIOD_IN
;
1022 else if (fwnode_property_present(fwnode
, "output-low"))
1023 *dflags
|= GPIOD_OUT_LOW
;
1024 else if (fwnode_property_present(fwnode
, "output-high"))
1025 *dflags
|= GPIOD_OUT_HIGH
;
1027 return ERR_PTR(-EINVAL
);
1029 fwnode_property_read_string(fwnode
, "line-name", name
);
1034 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip
*achip
)
1036 struct gpio_chip
*chip
= achip
->chip
;
1037 struct fwnode_handle
*fwnode
;
1039 device_for_each_child_node(chip
->parent
, fwnode
) {
1040 unsigned int lflags
, dflags
;
1041 struct gpio_desc
*desc
;
1045 if (!fwnode_property_present(fwnode
, "gpio-hog"))
1048 desc
= acpi_gpiochip_parse_own_gpio(achip
, fwnode
, &name
,
1053 ret
= gpiod_hog(desc
, name
, lflags
, dflags
);
1055 dev_err(chip
->parent
, "Failed to hog GPIO\n");
1056 fwnode_handle_put(fwnode
);
1062 void acpi_gpiochip_add(struct gpio_chip
*chip
)
1064 struct acpi_gpio_chip
*acpi_gpio
;
1068 if (!chip
|| !chip
->parent
)
1071 handle
= ACPI_HANDLE(chip
->parent
);
1075 acpi_gpio
= kzalloc(sizeof(*acpi_gpio
), GFP_KERNEL
);
1077 dev_err(chip
->parent
,
1078 "Failed to allocate memory for ACPI GPIO chip\n");
1082 acpi_gpio
->chip
= chip
;
1083 INIT_LIST_HEAD(&acpi_gpio
->events
);
1084 INIT_LIST_HEAD(&acpi_gpio
->deferred_req_irqs_list_entry
);
1086 status
= acpi_attach_data(handle
, acpi_gpio_chip_dh
, acpi_gpio
);
1087 if (ACPI_FAILURE(status
)) {
1088 dev_err(chip
->parent
, "Failed to attach ACPI GPIO chip\n");
1094 devprop_gpiochip_set_names(chip
, dev_fwnode(chip
->parent
));
1096 acpi_gpiochip_request_regions(acpi_gpio
);
1097 acpi_gpiochip_scan_gpios(acpi_gpio
);
1098 acpi_walk_dep_device_list(handle
);
1101 void acpi_gpiochip_remove(struct gpio_chip
*chip
)
1103 struct acpi_gpio_chip
*acpi_gpio
;
1107 if (!chip
|| !chip
->parent
)
1110 handle
= ACPI_HANDLE(chip
->parent
);
1114 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
1115 if (ACPI_FAILURE(status
)) {
1116 dev_warn(chip
->parent
, "Failed to retrieve ACPI GPIO chip\n");
1120 acpi_gpiochip_free_regions(acpi_gpio
);
1122 acpi_detach_data(handle
, acpi_gpio_chip_dh
);
1126 static int acpi_gpio_package_count(const union acpi_object
*obj
)
1128 const union acpi_object
*element
= obj
->package
.elements
;
1129 const union acpi_object
*end
= element
+ obj
->package
.count
;
1130 unsigned int count
= 0;
1132 while (element
< end
) {
1133 switch (element
->type
) {
1134 case ACPI_TYPE_LOCAL_REFERENCE
:
1137 case ACPI_TYPE_INTEGER
:
1150 static int acpi_find_gpio_count(struct acpi_resource
*ares
, void *data
)
1152 unsigned int *count
= data
;
1154 if (ares
->type
== ACPI_RESOURCE_TYPE_GPIO
)
1155 *count
+= ares
->data
.gpio
.pin_table_length
;
1161 * acpi_gpio_count - return the number of GPIOs associated with a
1162 * device / function or -ENOENT if no GPIO has been
1163 * assigned to the requested function.
1164 * @dev: GPIO consumer, can be NULL for system-global GPIOs
1165 * @con_id: function within the GPIO consumer
1167 int acpi_gpio_count(struct device
*dev
, const char *con_id
)
1169 struct acpi_device
*adev
= ACPI_COMPANION(dev
);
1170 const union acpi_object
*obj
;
1171 const struct acpi_gpio_mapping
*gm
;
1172 int count
= -ENOENT
;
1177 /* Try first from _DSD */
1178 for (i
= 0; i
< ARRAY_SIZE(gpio_suffixes
); i
++) {
1180 snprintf(propname
, sizeof(propname
), "%s-%s",
1181 con_id
, gpio_suffixes
[i
]);
1183 snprintf(propname
, sizeof(propname
), "%s",
1186 ret
= acpi_dev_get_property(adev
, propname
, ACPI_TYPE_ANY
,
1189 if (obj
->type
== ACPI_TYPE_LOCAL_REFERENCE
)
1191 else if (obj
->type
== ACPI_TYPE_PACKAGE
)
1192 count
= acpi_gpio_package_count(obj
);
1193 } else if (adev
->driver_gpios
) {
1194 for (gm
= adev
->driver_gpios
; gm
->name
; gm
++)
1195 if (strcmp(propname
, gm
->name
) == 0) {
1204 /* Then from plain _CRS GPIOs */
1206 struct list_head resource_list
;
1207 unsigned int crs_count
= 0;
1209 if (!acpi_can_fallback_to_crs(adev
, con_id
))
1212 INIT_LIST_HEAD(&resource_list
);
1213 acpi_dev_get_resources(adev
, &resource_list
,
1214 acpi_find_gpio_count
, &crs_count
);
1215 acpi_dev_free_resource_list(&resource_list
);
1219 return count
? count
: -ENOENT
;
1222 bool acpi_can_fallback_to_crs(struct acpi_device
*adev
, const char *con_id
)
1224 /* Never allow fallback if the device has properties */
1225 if (acpi_dev_has_props(adev
) || adev
->driver_gpios
)
1228 return con_id
== NULL
;
1231 /* Run deferred acpi_gpiochip_request_irqs() */
1232 static int acpi_gpio_handle_deferred_request_irqs(void)
1234 struct acpi_gpio_chip
*acpi_gpio
, *tmp
;
1236 mutex_lock(&acpi_gpio_deferred_req_irqs_lock
);
1237 list_for_each_entry_safe(acpi_gpio
, tmp
,
1238 &acpi_gpio_deferred_req_irqs_list
,
1239 deferred_req_irqs_list_entry
)
1240 acpi_gpiochip_request_irqs(acpi_gpio
);
1242 acpi_gpio_deferred_req_irqs_done
= true;
1243 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock
);
1247 /* We must use _sync so that this runs after the first deferred_probe run */
1248 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs
);