2 * ACPI helpers for GPIO API
4 * Copyright (C) 2012, Intel Corporation
5 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
6 * Mika Westerberg <mika.westerberg@linux.intel.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/errno.h>
14 #include <linux/gpio.h>
15 #include <linux/gpio/consumer.h>
16 #include <linux/gpio/driver.h>
17 #include <linux/gpio/machine.h>
18 #include <linux/export.h>
19 #include <linux/acpi.h>
20 #include <linux/interrupt.h>
21 #include <linux/mutex.h>
22 #include <linux/pinctrl/pinctrl.h>
26 struct acpi_gpio_event
{
27 struct list_head node
;
31 struct gpio_desc
*desc
;
34 struct acpi_gpio_connection
{
35 struct list_head node
;
37 struct gpio_desc
*desc
;
40 struct acpi_gpio_chip
{
42 * ACPICA requires that the first field of the context parameter
43 * passed to acpi_install_address_space_handler() is large enough
44 * to hold struct acpi_connection_info.
46 struct acpi_connection_info conn_info
;
47 struct list_head conns
;
48 struct mutex conn_lock
;
49 struct gpio_chip
*chip
;
50 struct list_head events
;
53 static int acpi_gpiochip_find(struct gpio_chip
*gc
, void *data
)
58 return ACPI_HANDLE(gc
->parent
) == data
;
63 * acpi_gpiochip_pin_to_gpio_offset() - translates ACPI GPIO to Linux GPIO
65 * @pin: ACPI GPIO pin number from GpioIo/GpioInt resource
67 * Function takes ACPI GpioIo/GpioInt pin number as a parameter and
68 * translates it to a corresponding offset suitable to be passed to a
69 * GPIO controller driver.
71 * Typically the returned offset is same as @pin, but if the GPIO
72 * controller uses pin controller and the mapping is not contiguous the
73 * offset might be different.
75 static int acpi_gpiochip_pin_to_gpio_offset(struct gpio_device
*gdev
, int pin
)
77 struct gpio_pin_range
*pin_range
;
79 /* If there are no ranges in this chip, use 1:1 mapping */
80 if (list_empty(&gdev
->pin_ranges
))
83 list_for_each_entry(pin_range
, &gdev
->pin_ranges
, node
) {
84 const struct pinctrl_gpio_range
*range
= &pin_range
->range
;
88 for (i
= 0; i
< range
->npins
; i
++) {
89 if (range
->pins
[i
] == pin
)
90 return range
->base
+ i
- gdev
->base
;
93 if (pin
>= range
->pin_base
&&
94 pin
< range
->pin_base
+ range
->npins
) {
97 gpio_base
= range
->base
- gdev
->base
;
98 return gpio_base
+ pin
- range
->pin_base
;
106 static inline int acpi_gpiochip_pin_to_gpio_offset(struct gpio_device
*gdev
,
114 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
115 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
116 * @pin: ACPI GPIO pin number (0-based, controller-relative)
118 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
119 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
120 * controller does not have gpiochip registered at the moment. This is to
121 * support probe deferral.
123 static struct gpio_desc
*acpi_get_gpiod(char *path
, int pin
)
125 struct gpio_chip
*chip
;
130 status
= acpi_get_handle(NULL
, path
, &handle
);
131 if (ACPI_FAILURE(status
))
132 return ERR_PTR(-ENODEV
);
134 chip
= gpiochip_find(handle
, acpi_gpiochip_find
);
136 return ERR_PTR(-EPROBE_DEFER
);
138 offset
= acpi_gpiochip_pin_to_gpio_offset(chip
->gpiodev
, pin
);
140 return ERR_PTR(offset
);
142 return gpiochip_get_desc(chip
, offset
);
145 static irqreturn_t
acpi_gpio_irq_handler(int irq
, void *data
)
147 struct acpi_gpio_event
*event
= data
;
149 acpi_evaluate_object(event
->handle
, NULL
, NULL
, NULL
);
154 static irqreturn_t
acpi_gpio_irq_handler_evt(int irq
, void *data
)
156 struct acpi_gpio_event
*event
= data
;
158 acpi_execute_simple_method(event
->handle
, NULL
, event
->pin
);
163 static void acpi_gpio_chip_dh(acpi_handle handle
, void *data
)
165 /* The address of this function is used as a key. */
168 static acpi_status
acpi_gpiochip_request_interrupt(struct acpi_resource
*ares
,
171 struct acpi_gpio_chip
*acpi_gpio
= context
;
172 struct gpio_chip
*chip
= acpi_gpio
->chip
;
173 struct acpi_resource_gpio
*agpio
;
174 acpi_handle handle
, evt_handle
;
175 struct acpi_gpio_event
*event
;
176 irq_handler_t handler
= NULL
;
177 struct gpio_desc
*desc
;
178 unsigned long irqflags
;
181 if (ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)
184 agpio
= &ares
->data
.gpio
;
185 if (agpio
->connection_type
!= ACPI_RESOURCE_GPIO_TYPE_INT
)
188 handle
= ACPI_HANDLE(chip
->parent
);
189 pin
= agpio
->pin_table
[0];
193 sprintf(ev_name
, "_%c%02X",
194 agpio
->triggering
== ACPI_EDGE_SENSITIVE
? 'E' : 'L',
196 if (ACPI_SUCCESS(acpi_get_handle(handle
, ev_name
, &evt_handle
)))
197 handler
= acpi_gpio_irq_handler
;
200 if (ACPI_SUCCESS(acpi_get_handle(handle
, "_EVT", &evt_handle
)))
201 handler
= acpi_gpio_irq_handler_evt
;
204 return AE_BAD_PARAMETER
;
206 pin
= acpi_gpiochip_pin_to_gpio_offset(chip
->gpiodev
, pin
);
208 return AE_BAD_PARAMETER
;
210 desc
= gpiochip_request_own_desc(chip
, pin
, "ACPI:Event");
212 dev_err(chip
->parent
, "Failed to request GPIO\n");
216 gpiod_direction_input(desc
);
218 ret
= gpiochip_lock_as_irq(chip
, pin
);
220 dev_err(chip
->parent
, "Failed to lock GPIO as interrupt\n");
224 irq
= gpiod_to_irq(desc
);
226 dev_err(chip
->parent
, "Failed to translate GPIO to IRQ\n");
227 goto fail_unlock_irq
;
230 irqflags
= IRQF_ONESHOT
;
231 if (agpio
->triggering
== ACPI_LEVEL_SENSITIVE
) {
232 if (agpio
->polarity
== ACPI_ACTIVE_HIGH
)
233 irqflags
|= IRQF_TRIGGER_HIGH
;
235 irqflags
|= IRQF_TRIGGER_LOW
;
237 switch (agpio
->polarity
) {
238 case ACPI_ACTIVE_HIGH
:
239 irqflags
|= IRQF_TRIGGER_RISING
;
241 case ACPI_ACTIVE_LOW
:
242 irqflags
|= IRQF_TRIGGER_FALLING
;
245 irqflags
|= IRQF_TRIGGER_RISING
|
246 IRQF_TRIGGER_FALLING
;
251 event
= kzalloc(sizeof(*event
), GFP_KERNEL
);
253 goto fail_unlock_irq
;
255 event
->handle
= evt_handle
;
260 ret
= request_threaded_irq(event
->irq
, NULL
, handler
, irqflags
,
261 "ACPI:Event", event
);
263 dev_err(chip
->parent
,
264 "Failed to setup interrupt handler for %d\n",
266 goto fail_free_event
;
269 if (agpio
->wake_capable
== ACPI_WAKE_CAPABLE
)
270 enable_irq_wake(irq
);
272 list_add_tail(&event
->node
, &acpi_gpio
->events
);
278 gpiochip_unlock_as_irq(chip
, pin
);
280 gpiochip_free_own_desc(desc
);
286 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
289 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
290 * handled by ACPI event methods which need to be called from the GPIO
291 * chip's interrupt handler. acpi_gpiochip_request_interrupts finds out which
292 * gpio pins have acpi event methods and assigns interrupt handlers that calls
293 * the acpi event methods for those pins.
295 void acpi_gpiochip_request_interrupts(struct gpio_chip
*chip
)
297 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_request_interrupt
, acpi_gpio
);
315 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts
);
318 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
321 * Free interrupts associated with GPIO ACPI event method for the given
324 void acpi_gpiochip_free_interrupts(struct gpio_chip
*chip
)
326 struct acpi_gpio_chip
*acpi_gpio
;
327 struct acpi_gpio_event
*event
, *ep
;
331 if (!chip
->parent
|| !chip
->to_irq
)
334 handle
= ACPI_HANDLE(chip
->parent
);
338 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
339 if (ACPI_FAILURE(status
))
342 list_for_each_entry_safe_reverse(event
, ep
, &acpi_gpio
->events
, node
) {
343 struct gpio_desc
*desc
;
345 if (irqd_is_wakeup_set(irq_get_irq_data(event
->irq
)))
346 disable_irq_wake(event
->irq
);
348 free_irq(event
->irq
, event
);
350 if (WARN_ON(IS_ERR(desc
)))
352 gpiochip_unlock_as_irq(chip
, event
->pin
);
353 gpiochip_free_own_desc(desc
);
354 list_del(&event
->node
);
358 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts
);
360 int acpi_dev_add_driver_gpios(struct acpi_device
*adev
,
361 const struct acpi_gpio_mapping
*gpios
)
364 adev
->driver_gpios
= gpios
;
369 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios
);
371 static void devm_acpi_dev_release_driver_gpios(struct device
*dev
, void *res
)
373 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev
));
376 int devm_acpi_dev_add_driver_gpios(struct device
*dev
,
377 const struct acpi_gpio_mapping
*gpios
)
382 res
= devres_alloc(devm_acpi_dev_release_driver_gpios
, 0, GFP_KERNEL
);
386 ret
= acpi_dev_add_driver_gpios(ACPI_COMPANION(dev
), gpios
);
391 devres_add(dev
, res
);
394 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios
);
396 void devm_acpi_dev_remove_driver_gpios(struct device
*dev
)
398 WARN_ON(devres_release(dev
, devm_acpi_dev_release_driver_gpios
, NULL
, NULL
));
400 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios
);
402 static bool acpi_get_driver_gpio_data(struct acpi_device
*adev
,
403 const char *name
, int index
,
404 struct acpi_reference_args
*args
)
406 const struct acpi_gpio_mapping
*gm
;
408 if (!adev
->driver_gpios
)
411 for (gm
= adev
->driver_gpios
; gm
->name
; gm
++)
412 if (!strcmp(name
, gm
->name
) && gm
->data
&& index
< gm
->size
) {
413 const struct acpi_gpio_params
*par
= gm
->data
+ index
;
416 args
->args
[0] = par
->crs_entry_index
;
417 args
->args
[1] = par
->line_index
;
418 args
->args
[2] = par
->active_low
;
426 static enum gpiod_flags
427 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio
*agpio
)
429 bool pull_up
= agpio
->pin_config
== ACPI_PIN_CONFIG_PULLUP
;
431 switch (agpio
->io_restriction
) {
432 case ACPI_IO_RESTRICT_INPUT
:
434 case ACPI_IO_RESTRICT_OUTPUT
:
436 * ACPI GPIO resources don't contain an initial value for the
437 * GPIO. Therefore we deduce that value from the pull field
438 * instead. If the pin is pulled up we assume default to be
439 * high, otherwise low.
441 return pull_up
? GPIOD_OUT_HIGH
: GPIOD_OUT_LOW
;
444 * Assume that the BIOS has configured the direction and pull
452 acpi_gpio_update_gpiod_flags(enum gpiod_flags
*flags
, enum gpiod_flags update
)
457 * Check if the BIOS has IoRestriction with explicitly set direction
458 * and update @flags accordingly. Otherwise use whatever caller asked
461 if (update
& GPIOD_FLAGS_BIT_DIR_SET
) {
462 enum gpiod_flags diff
= *flags
^ update
;
465 * Check if caller supplied incompatible GPIO initialization
468 * Return %-EINVAL to notify that firmware has different
469 * settings and we are going to use them.
471 if (((*flags
& GPIOD_FLAGS_BIT_DIR_SET
) && (diff
& GPIOD_FLAGS_BIT_DIR_OUT
)) ||
472 ((*flags
& GPIOD_FLAGS_BIT_DIR_OUT
) && (diff
& GPIOD_FLAGS_BIT_DIR_VAL
)))
479 struct acpi_gpio_lookup
{
480 struct acpi_gpio_info info
;
484 struct acpi_device
*adev
;
485 struct gpio_desc
*desc
;
489 static int acpi_populate_gpio_lookup(struct acpi_resource
*ares
, void *data
)
491 struct acpi_gpio_lookup
*lookup
= data
;
493 if (ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)
496 if (lookup
->n
++ == lookup
->index
&& !lookup
->desc
) {
497 const struct acpi_resource_gpio
*agpio
= &ares
->data
.gpio
;
498 int pin_index
= lookup
->pin_index
;
500 if (pin_index
>= agpio
->pin_table_length
)
503 lookup
->desc
= acpi_get_gpiod(agpio
->resource_source
.string_ptr
,
504 agpio
->pin_table
[pin_index
]);
505 lookup
->info
.gpioint
=
506 agpio
->connection_type
== ACPI_RESOURCE_GPIO_TYPE_INT
;
509 * Polarity and triggering are only specified for GpioInt
511 * Note: we expect here:
512 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
513 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
515 if (lookup
->info
.gpioint
) {
516 lookup
->info
.flags
= GPIOD_IN
;
517 lookup
->info
.polarity
= agpio
->polarity
;
518 lookup
->info
.triggering
= agpio
->triggering
;
520 lookup
->info
.flags
= acpi_gpio_to_gpiod_flags(agpio
);
528 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup
*lookup
,
529 struct acpi_gpio_info
*info
)
531 struct list_head res_list
;
534 INIT_LIST_HEAD(&res_list
);
536 ret
= acpi_dev_get_resources(lookup
->adev
, &res_list
,
537 acpi_populate_gpio_lookup
,
542 acpi_dev_free_resource_list(&res_list
);
548 *info
= lookup
->info
;
549 if (lookup
->active_low
)
550 info
->polarity
= lookup
->active_low
;
555 static int acpi_gpio_property_lookup(struct fwnode_handle
*fwnode
,
556 const char *propname
, int index
,
557 struct acpi_gpio_lookup
*lookup
)
559 struct acpi_reference_args args
;
562 memset(&args
, 0, sizeof(args
));
563 ret
= __acpi_node_get_property_reference(fwnode
, propname
, index
, 3,
566 struct acpi_device
*adev
= to_acpi_device_node(fwnode
);
571 if (!acpi_get_driver_gpio_data(adev
, propname
, index
, &args
))
575 * The property was found and resolved, so need to lookup the GPIO based
578 lookup
->adev
= args
.adev
;
582 lookup
->index
= args
.args
[0];
583 lookup
->pin_index
= args
.args
[1];
584 lookup
->active_low
= !!args
.args
[2];
590 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
591 * @adev: pointer to a ACPI device to get GPIO from
592 * @propname: Property name of the GPIO (optional)
593 * @index: index of GpioIo/GpioInt resource (starting from %0)
594 * @info: info pointer to fill in (optional)
596 * Function goes through ACPI resources for @adev and based on @index looks
597 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
598 * and returns it. @index matches GpioIo/GpioInt resources only so if there
599 * are total %3 GPIO resources, the index goes from %0 to %2.
601 * If @propname is specified the GPIO is looked using device property. In
602 * that case @index is used to select the GPIO entry in the property value
603 * (in case of multiple).
605 * If the GPIO cannot be translated or there is an error an ERR_PTR is
608 * Note: if the GPIO resource has multiple entries in the pin list, this
609 * function only returns the first.
611 static struct gpio_desc
*acpi_get_gpiod_by_index(struct acpi_device
*adev
,
612 const char *propname
, int index
,
613 struct acpi_gpio_info
*info
)
615 struct acpi_gpio_lookup lookup
;
619 return ERR_PTR(-ENODEV
);
621 memset(&lookup
, 0, sizeof(lookup
));
622 lookup
.index
= index
;
625 dev_dbg(&adev
->dev
, "GPIO: looking up %s\n", propname
);
627 ret
= acpi_gpio_property_lookup(acpi_fwnode_handle(adev
),
628 propname
, index
, &lookup
);
632 dev_dbg(&adev
->dev
, "GPIO: _DSD returned %s %d %d %u\n",
633 dev_name(&lookup
.adev
->dev
), lookup
.index
,
634 lookup
.pin_index
, lookup
.active_low
);
636 dev_dbg(&adev
->dev
, "GPIO: looking up %d in _CRS\n", index
);
640 ret
= acpi_gpio_resource_lookup(&lookup
, info
);
641 return ret
? ERR_PTR(ret
) : lookup
.desc
;
644 struct gpio_desc
*acpi_find_gpio(struct device
*dev
,
647 enum gpiod_flags
*dflags
,
648 enum gpio_lookup_flags
*lookupflags
)
650 struct acpi_device
*adev
= ACPI_COMPANION(dev
);
651 struct acpi_gpio_info info
;
652 struct gpio_desc
*desc
;
657 /* Try first from _DSD */
658 for (i
= 0; i
< ARRAY_SIZE(gpio_suffixes
); i
++) {
660 snprintf(propname
, sizeof(propname
), "%s-%s",
661 con_id
, gpio_suffixes
[i
]);
663 snprintf(propname
, sizeof(propname
), "%s",
667 desc
= acpi_get_gpiod_by_index(adev
, propname
, idx
, &info
);
670 if (PTR_ERR(desc
) == -EPROBE_DEFER
)
671 return ERR_CAST(desc
);
674 /* Then from plain _CRS GPIOs */
676 if (!acpi_can_fallback_to_crs(adev
, con_id
))
677 return ERR_PTR(-ENOENT
);
679 desc
= acpi_get_gpiod_by_index(adev
, NULL
, idx
, &info
);
685 (*dflags
== GPIOD_OUT_LOW
|| *dflags
== GPIOD_OUT_HIGH
)) {
686 dev_dbg(dev
, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
687 return ERR_PTR(-ENOENT
);
690 if (info
.polarity
== GPIO_ACTIVE_LOW
)
691 *lookupflags
|= GPIO_ACTIVE_LOW
;
693 err
= acpi_gpio_update_gpiod_flags(dflags
, info
.flags
);
695 dev_dbg(dev
, "Override GPIO initialization flags\n");
701 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
702 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
703 * @propname: Property name of the GPIO
704 * @index: index of GpioIo/GpioInt resource (starting from %0)
705 * @info: info pointer to fill in (optional)
707 * If @fwnode is an ACPI device object, call %acpi_get_gpiod_by_index() for it.
708 * Otherwise (ie. it is a data-only non-device object), use the property-based
709 * GPIO lookup to get to the GPIO resource with the relevant information and use
710 * that to obtain the GPIO descriptor to return.
712 struct gpio_desc
*acpi_node_get_gpiod(struct fwnode_handle
*fwnode
,
713 const char *propname
, int index
,
714 struct acpi_gpio_info
*info
)
716 struct acpi_gpio_lookup lookup
;
717 struct acpi_device
*adev
;
720 adev
= to_acpi_device_node(fwnode
);
722 return acpi_get_gpiod_by_index(adev
, propname
, index
, info
);
724 if (!is_acpi_data_node(fwnode
))
725 return ERR_PTR(-ENODEV
);
728 return ERR_PTR(-EINVAL
);
730 memset(&lookup
, 0, sizeof(lookup
));
731 lookup
.index
= index
;
733 ret
= acpi_gpio_property_lookup(fwnode
, propname
, index
, &lookup
);
737 ret
= acpi_gpio_resource_lookup(&lookup
, info
);
738 return ret
? ERR_PTR(ret
) : lookup
.desc
;
742 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
743 * @adev: pointer to a ACPI device to get IRQ from
744 * @index: index of GpioInt resource (starting from %0)
746 * If the device has one or more GpioInt resources, this function can be
747 * used to translate from the GPIO offset in the resource to the Linux IRQ
750 * The function is idempotent, though each time it runs it will configure GPIO
751 * pin direction according to the flags in GpioInt resource.
753 * Return: Linux IRQ number (>%0) on success, negative errno on failure.
755 int acpi_dev_gpio_irq_get(struct acpi_device
*adev
, int index
)
758 unsigned int irq_flags
;
761 for (i
= 0, idx
= 0; idx
<= index
; i
++) {
762 struct acpi_gpio_info info
;
763 struct gpio_desc
*desc
;
765 desc
= acpi_get_gpiod_by_index(adev
, NULL
, i
, &info
);
767 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
768 if (IS_ERR(desc
) && PTR_ERR(desc
) != -EPROBE_DEFER
)
769 return PTR_ERR(desc
);
771 if (info
.gpioint
&& idx
++ == index
) {
776 return PTR_ERR(desc
);
778 irq
= gpiod_to_irq(desc
);
782 snprintf(label
, sizeof(label
), "GpioInt() %d", index
);
783 ret
= gpiod_configure_flags(desc
, label
, 0, info
.flags
);
787 irq_flags
= acpi_dev_get_irq_type(info
.triggering
,
790 /* Set type if specified and different than the current one */
791 if (irq_flags
!= IRQ_TYPE_NONE
&&
792 irq_flags
!= irq_get_trigger_type(irq
))
793 irq_set_irq_type(irq
, irq_flags
);
801 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get
);
804 acpi_gpio_adr_space_handler(u32 function
, acpi_physical_address address
,
805 u32 bits
, u64
*value
, void *handler_context
,
806 void *region_context
)
808 struct acpi_gpio_chip
*achip
= region_context
;
809 struct gpio_chip
*chip
= achip
->chip
;
810 struct acpi_resource_gpio
*agpio
;
811 struct acpi_resource
*ares
;
812 int pin_index
= (int)address
;
817 status
= acpi_buffer_to_resource(achip
->conn_info
.connection
,
818 achip
->conn_info
.length
, &ares
);
819 if (ACPI_FAILURE(status
))
822 if (WARN_ON(ares
->type
!= ACPI_RESOURCE_TYPE_GPIO
)) {
824 return AE_BAD_PARAMETER
;
827 agpio
= &ares
->data
.gpio
;
829 if (WARN_ON(agpio
->io_restriction
== ACPI_IO_RESTRICT_INPUT
&&
830 function
== ACPI_WRITE
)) {
832 return AE_BAD_PARAMETER
;
835 length
= min(agpio
->pin_table_length
, (u16
)(pin_index
+ bits
));
836 for (i
= pin_index
; i
< length
; ++i
) {
837 int pin
= agpio
->pin_table
[i
];
838 struct acpi_gpio_connection
*conn
;
839 struct gpio_desc
*desc
;
842 pin
= acpi_gpiochip_pin_to_gpio_offset(chip
->gpiodev
, pin
);
844 status
= AE_BAD_PARAMETER
;
848 mutex_lock(&achip
->conn_lock
);
851 list_for_each_entry(conn
, &achip
->conns
, node
) {
852 if (conn
->pin
== pin
) {
860 * The same GPIO can be shared between operation region and
861 * event but only if the access here is ACPI_READ. In that
862 * case we "borrow" the event GPIO instead.
864 if (!found
&& agpio
->sharable
== ACPI_SHARED
&&
865 function
== ACPI_READ
) {
866 struct acpi_gpio_event
*event
;
868 list_for_each_entry(event
, &achip
->events
, node
) {
869 if (event
->pin
== pin
) {
878 enum gpiod_flags flags
= acpi_gpio_to_gpiod_flags(agpio
);
879 const char *label
= "ACPI:OpRegion";
882 desc
= gpiochip_request_own_desc(chip
, pin
, label
);
885 mutex_unlock(&achip
->conn_lock
);
889 err
= gpiod_configure_flags(desc
, label
, 0, flags
);
891 status
= AE_NOT_CONFIGURED
;
892 gpiochip_free_own_desc(desc
);
893 mutex_unlock(&achip
->conn_lock
);
897 conn
= kzalloc(sizeof(*conn
), GFP_KERNEL
);
899 status
= AE_NO_MEMORY
;
900 gpiochip_free_own_desc(desc
);
901 mutex_unlock(&achip
->conn_lock
);
907 list_add_tail(&conn
->node
, &achip
->conns
);
910 mutex_unlock(&achip
->conn_lock
);
912 if (function
== ACPI_WRITE
)
913 gpiod_set_raw_value_cansleep(desc
,
914 !!((1 << i
) & *value
));
916 *value
|= (u64
)gpiod_get_raw_value_cansleep(desc
) << i
;
924 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip
*achip
)
926 struct gpio_chip
*chip
= achip
->chip
;
927 acpi_handle handle
= ACPI_HANDLE(chip
->parent
);
930 INIT_LIST_HEAD(&achip
->conns
);
931 mutex_init(&achip
->conn_lock
);
932 status
= acpi_install_address_space_handler(handle
, ACPI_ADR_SPACE_GPIO
,
933 acpi_gpio_adr_space_handler
,
935 if (ACPI_FAILURE(status
))
936 dev_err(chip
->parent
,
937 "Failed to install GPIO OpRegion handler\n");
940 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip
*achip
)
942 struct gpio_chip
*chip
= achip
->chip
;
943 acpi_handle handle
= ACPI_HANDLE(chip
->parent
);
944 struct acpi_gpio_connection
*conn
, *tmp
;
947 status
= acpi_remove_address_space_handler(handle
, ACPI_ADR_SPACE_GPIO
,
948 acpi_gpio_adr_space_handler
);
949 if (ACPI_FAILURE(status
)) {
950 dev_err(chip
->parent
,
951 "Failed to remove GPIO OpRegion handler\n");
955 list_for_each_entry_safe_reverse(conn
, tmp
, &achip
->conns
, node
) {
956 gpiochip_free_own_desc(conn
->desc
);
957 list_del(&conn
->node
);
962 static struct gpio_desc
*acpi_gpiochip_parse_own_gpio(
963 struct acpi_gpio_chip
*achip
, struct fwnode_handle
*fwnode
,
964 const char **name
, unsigned int *lflags
, unsigned int *dflags
)
966 struct gpio_chip
*chip
= achip
->chip
;
967 struct gpio_desc
*desc
;
975 ret
= fwnode_property_read_u32_array(fwnode
, "gpios", gpios
,
980 ret
= acpi_gpiochip_pin_to_gpio_offset(chip
->gpiodev
, gpios
[0]);
984 desc
= gpiochip_get_desc(chip
, ret
);
989 *lflags
|= GPIO_ACTIVE_LOW
;
991 if (fwnode_property_present(fwnode
, "input"))
993 else if (fwnode_property_present(fwnode
, "output-low"))
994 *dflags
|= GPIOD_OUT_LOW
;
995 else if (fwnode_property_present(fwnode
, "output-high"))
996 *dflags
|= GPIOD_OUT_HIGH
;
998 return ERR_PTR(-EINVAL
);
1000 fwnode_property_read_string(fwnode
, "line-name", name
);
1005 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip
*achip
)
1007 struct gpio_chip
*chip
= achip
->chip
;
1008 struct fwnode_handle
*fwnode
;
1010 device_for_each_child_node(chip
->parent
, fwnode
) {
1011 unsigned int lflags
, dflags
;
1012 struct gpio_desc
*desc
;
1016 if (!fwnode_property_present(fwnode
, "gpio-hog"))
1019 desc
= acpi_gpiochip_parse_own_gpio(achip
, fwnode
, &name
,
1024 ret
= gpiod_hog(desc
, name
, lflags
, dflags
);
1026 dev_err(chip
->parent
, "Failed to hog GPIO\n");
1027 fwnode_handle_put(fwnode
);
1033 void acpi_gpiochip_add(struct gpio_chip
*chip
)
1035 struct acpi_gpio_chip
*acpi_gpio
;
1039 if (!chip
|| !chip
->parent
)
1042 handle
= ACPI_HANDLE(chip
->parent
);
1046 acpi_gpio
= kzalloc(sizeof(*acpi_gpio
), GFP_KERNEL
);
1048 dev_err(chip
->parent
,
1049 "Failed to allocate memory for ACPI GPIO chip\n");
1053 acpi_gpio
->chip
= chip
;
1054 INIT_LIST_HEAD(&acpi_gpio
->events
);
1056 status
= acpi_attach_data(handle
, acpi_gpio_chip_dh
, acpi_gpio
);
1057 if (ACPI_FAILURE(status
)) {
1058 dev_err(chip
->parent
, "Failed to attach ACPI GPIO chip\n");
1064 devprop_gpiochip_set_names(chip
);
1066 acpi_gpiochip_request_regions(acpi_gpio
);
1067 acpi_gpiochip_scan_gpios(acpi_gpio
);
1068 acpi_walk_dep_device_list(handle
);
1071 void acpi_gpiochip_remove(struct gpio_chip
*chip
)
1073 struct acpi_gpio_chip
*acpi_gpio
;
1077 if (!chip
|| !chip
->parent
)
1080 handle
= ACPI_HANDLE(chip
->parent
);
1084 status
= acpi_get_data(handle
, acpi_gpio_chip_dh
, (void **)&acpi_gpio
);
1085 if (ACPI_FAILURE(status
)) {
1086 dev_warn(chip
->parent
, "Failed to retrieve ACPI GPIO chip\n");
1090 acpi_gpiochip_free_regions(acpi_gpio
);
1092 acpi_detach_data(handle
, acpi_gpio_chip_dh
);
1096 static int acpi_gpio_package_count(const union acpi_object
*obj
)
1098 const union acpi_object
*element
= obj
->package
.elements
;
1099 const union acpi_object
*end
= element
+ obj
->package
.count
;
1100 unsigned int count
= 0;
1102 while (element
< end
) {
1103 switch (element
->type
) {
1104 case ACPI_TYPE_LOCAL_REFERENCE
:
1107 case ACPI_TYPE_INTEGER
:
1120 static int acpi_find_gpio_count(struct acpi_resource
*ares
, void *data
)
1122 unsigned int *count
= data
;
1124 if (ares
->type
== ACPI_RESOURCE_TYPE_GPIO
)
1125 *count
+= ares
->data
.gpio
.pin_table_length
;
1131 * acpi_gpio_count - return the number of GPIOs associated with a
1132 * device / function or -ENOENT if no GPIO has been
1133 * assigned to the requested function.
1134 * @dev: GPIO consumer, can be NULL for system-global GPIOs
1135 * @con_id: function within the GPIO consumer
1137 int acpi_gpio_count(struct device
*dev
, const char *con_id
)
1139 struct acpi_device
*adev
= ACPI_COMPANION(dev
);
1140 const union acpi_object
*obj
;
1141 const struct acpi_gpio_mapping
*gm
;
1142 int count
= -ENOENT
;
1147 /* Try first from _DSD */
1148 for (i
= 0; i
< ARRAY_SIZE(gpio_suffixes
); i
++) {
1150 snprintf(propname
, sizeof(propname
), "%s-%s",
1151 con_id
, gpio_suffixes
[i
]);
1153 snprintf(propname
, sizeof(propname
), "%s",
1156 ret
= acpi_dev_get_property(adev
, propname
, ACPI_TYPE_ANY
,
1159 if (obj
->type
== ACPI_TYPE_LOCAL_REFERENCE
)
1161 else if (obj
->type
== ACPI_TYPE_PACKAGE
)
1162 count
= acpi_gpio_package_count(obj
);
1163 } else if (adev
->driver_gpios
) {
1164 for (gm
= adev
->driver_gpios
; gm
->name
; gm
++)
1165 if (strcmp(propname
, gm
->name
) == 0) {
1174 /* Then from plain _CRS GPIOs */
1176 struct list_head resource_list
;
1177 unsigned int crs_count
= 0;
1179 if (!acpi_can_fallback_to_crs(adev
, con_id
))
1182 INIT_LIST_HEAD(&resource_list
);
1183 acpi_dev_get_resources(adev
, &resource_list
,
1184 acpi_find_gpio_count
, &crs_count
);
1185 acpi_dev_free_resource_list(&resource_list
);
1189 return count
? count
: -ENOENT
;
1192 bool acpi_can_fallback_to_crs(struct acpi_device
*adev
, const char *con_id
)
1194 /* Never allow fallback if the device has properties */
1195 if (adev
->data
.properties
|| adev
->driver_gpios
)
1198 return con_id
== NULL
;