Linux 4.19.133
[linux/fpc-iii.git] / drivers / gpio / gpiolib-acpi.c
blob18f5973b9697f7f67028eddcf0067c970602983a
1 /*
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/dmi.h>
14 #include <linux/errno.h>
15 #include <linux/gpio.h>
16 #include <linux/gpio/consumer.h>
17 #include <linux/gpio/driver.h>
18 #include <linux/gpio/machine.h>
19 #include <linux/export.h>
20 #include <linux/acpi.h>
21 #include <linux/interrupt.h>
22 #include <linux/mutex.h>
23 #include <linux/pinctrl/pinctrl.h>
25 #include "gpiolib.h"
27 static int run_edge_events_on_boot = -1;
28 module_param(run_edge_events_on_boot, int, 0444);
29 MODULE_PARM_DESC(run_edge_events_on_boot,
30 "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");
32 static char *ignore_wake;
33 module_param(ignore_wake, charp, 0444);
34 MODULE_PARM_DESC(ignore_wake,
35 "controller@pin combos on which to ignore the ACPI wake flag "
36 "ignore_wake=controller@pin[,controller@pin[,...]]");
38 struct acpi_gpiolib_dmi_quirk {
39 bool no_edge_events_on_boot;
40 char *ignore_wake;
43 /**
44 * struct acpi_gpio_event - ACPI GPIO event handler data
46 * @node: list-entry of the events list of the struct acpi_gpio_chip
47 * @handle: handle of ACPI method to execute when the IRQ triggers
48 * @handler: irq_handler to pass to request_irq when requesting the IRQ
49 * @pin: GPIO pin number on the gpio_chip
50 * @irq: Linux IRQ number for the event, for request_ / free_irq
51 * @irqflags: flags to pass to request_irq when requesting the IRQ
52 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
53 * @is_requested: True if request_irq has been done
54 * @desc: gpio_desc for the GPIO pin for this event
56 struct acpi_gpio_event {
57 struct list_head node;
58 acpi_handle handle;
59 irq_handler_t handler;
60 unsigned int pin;
61 unsigned int irq;
62 unsigned long irqflags;
63 bool irq_is_wake;
64 bool irq_requested;
65 struct gpio_desc *desc;
68 struct acpi_gpio_connection {
69 struct list_head node;
70 unsigned int pin;
71 struct gpio_desc *desc;
74 struct acpi_gpio_chip {
76 * ACPICA requires that the first field of the context parameter
77 * passed to acpi_install_address_space_handler() is large enough
78 * to hold struct acpi_connection_info.
80 struct acpi_connection_info conn_info;
81 struct list_head conns;
82 struct mutex conn_lock;
83 struct gpio_chip *chip;
84 struct list_head events;
85 struct list_head deferred_req_irqs_list_entry;
89 * For gpiochips which call acpi_gpiochip_request_interrupts() before late_init
90 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
91 * late_initcall_sync handler, so that other builtin drivers can register their
92 * OpRegions before the event handlers can run. This list contains gpiochips
93 * for which the acpi_gpiochip_request_irqs() call has been deferred.
95 static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
96 static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
97 static bool acpi_gpio_deferred_req_irqs_done;
99 static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
101 if (!gc->parent)
102 return false;
104 return ACPI_HANDLE(gc->parent) == data;
108 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
109 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
110 * @pin: ACPI GPIO pin number (0-based, controller-relative)
112 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
113 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
114 * controller does not have gpiochip registered at the moment. This is to
115 * support probe deferral.
117 static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
119 struct gpio_chip *chip;
120 acpi_handle handle;
121 acpi_status status;
123 status = acpi_get_handle(NULL, path, &handle);
124 if (ACPI_FAILURE(status))
125 return ERR_PTR(-ENODEV);
127 chip = gpiochip_find(handle, acpi_gpiochip_find);
128 if (!chip)
129 return ERR_PTR(-EPROBE_DEFER);
131 return gpiochip_get_desc(chip, pin);
134 static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
136 struct acpi_gpio_event *event = data;
138 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
140 return IRQ_HANDLED;
143 static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
145 struct acpi_gpio_event *event = data;
147 acpi_execute_simple_method(event->handle, NULL, event->pin);
149 return IRQ_HANDLED;
152 static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
154 /* The address of this function is used as a key. */
157 bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
158 struct acpi_resource_gpio **agpio)
160 struct acpi_resource_gpio *gpio;
162 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
163 return false;
165 gpio = &ares->data.gpio;
166 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
167 return false;
169 *agpio = gpio;
170 return true;
172 EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
174 static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
175 struct acpi_gpio_event *event)
177 int ret, value;
179 ret = request_threaded_irq(event->irq, NULL, event->handler,
180 event->irqflags, "ACPI:Event", event);
181 if (ret) {
182 dev_err(acpi_gpio->chip->parent,
183 "Failed to setup interrupt handler for %d\n",
184 event->irq);
185 return;
188 if (event->irq_is_wake)
189 enable_irq_wake(event->irq);
191 event->irq_requested = true;
193 /* Make sure we trigger the initial state of edge-triggered IRQs */
194 if (run_edge_events_on_boot &&
195 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
196 value = gpiod_get_raw_value_cansleep(event->desc);
197 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
198 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
199 event->handler(event->irq, event);
203 static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
205 struct acpi_gpio_event *event;
207 list_for_each_entry(event, &acpi_gpio->events, node)
208 acpi_gpiochip_request_irq(acpi_gpio, event);
211 static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
213 const char *controller, *pin_str;
214 int len, pin;
215 char *endp;
217 controller = ignore_wake;
218 while (controller) {
219 pin_str = strchr(controller, '@');
220 if (!pin_str)
221 goto err;
223 len = pin_str - controller;
224 if (len == strlen(controller_in) &&
225 strncmp(controller, controller_in, len) == 0) {
226 pin = simple_strtoul(pin_str + 1, &endp, 10);
227 if (*endp != 0 && *endp != ',')
228 goto err;
230 if (pin == pin_in)
231 return true;
234 controller = strchr(controller, ',');
235 if (controller)
236 controller++;
239 return false;
240 err:
241 pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
242 ignore_wake);
243 return false;
246 static bool acpi_gpio_irq_is_wake(struct device *parent,
247 struct acpi_resource_gpio *agpio)
249 int pin = agpio->pin_table[0];
251 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
252 return false;
254 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
255 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
256 return false;
259 return true;
262 static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
263 void *context)
265 struct acpi_gpio_chip *acpi_gpio = context;
266 struct gpio_chip *chip = acpi_gpio->chip;
267 struct acpi_resource_gpio *agpio;
268 acpi_handle handle, evt_handle;
269 struct acpi_gpio_event *event;
270 irq_handler_t handler = NULL;
271 struct gpio_desc *desc;
272 int ret, pin, irq;
274 if (!acpi_gpio_get_irq_resource(ares, &agpio))
275 return AE_OK;
277 handle = ACPI_HANDLE(chip->parent);
278 pin = agpio->pin_table[0];
280 if (pin <= 255) {
281 char ev_name[5];
282 sprintf(ev_name, "_%c%02hhX",
283 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
284 pin);
285 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
286 handler = acpi_gpio_irq_handler;
288 if (!handler) {
289 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
290 handler = acpi_gpio_irq_handler_evt;
292 if (!handler)
293 return AE_OK;
295 desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event");
296 if (IS_ERR(desc)) {
297 dev_err(chip->parent, "Failed to request GPIO\n");
298 return AE_ERROR;
301 gpiod_direction_input(desc);
303 ret = gpiochip_lock_as_irq(chip, pin);
304 if (ret) {
305 dev_err(chip->parent, "Failed to lock GPIO as interrupt\n");
306 goto fail_free_desc;
309 irq = gpiod_to_irq(desc);
310 if (irq < 0) {
311 dev_err(chip->parent, "Failed to translate GPIO to IRQ\n");
312 goto fail_unlock_irq;
315 event = kzalloc(sizeof(*event), GFP_KERNEL);
316 if (!event)
317 goto fail_unlock_irq;
319 event->irqflags = IRQF_ONESHOT;
320 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
321 if (agpio->polarity == ACPI_ACTIVE_HIGH)
322 event->irqflags |= IRQF_TRIGGER_HIGH;
323 else
324 event->irqflags |= IRQF_TRIGGER_LOW;
325 } else {
326 switch (agpio->polarity) {
327 case ACPI_ACTIVE_HIGH:
328 event->irqflags |= IRQF_TRIGGER_RISING;
329 break;
330 case ACPI_ACTIVE_LOW:
331 event->irqflags |= IRQF_TRIGGER_FALLING;
332 break;
333 default:
334 event->irqflags |= IRQF_TRIGGER_RISING |
335 IRQF_TRIGGER_FALLING;
336 break;
340 event->handle = evt_handle;
341 event->handler = handler;
342 event->irq = irq;
343 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
344 event->pin = pin;
345 event->desc = desc;
347 list_add_tail(&event->node, &acpi_gpio->events);
349 return AE_OK;
351 fail_unlock_irq:
352 gpiochip_unlock_as_irq(chip, pin);
353 fail_free_desc:
354 gpiochip_free_own_desc(desc);
356 return AE_ERROR;
360 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
361 * @chip: GPIO chip
363 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
364 * handled by ACPI event methods which need to be called from the GPIO
365 * chip's interrupt handler. acpi_gpiochip_request_interrupts finds out which
366 * gpio pins have acpi event methods and assigns interrupt handlers that calls
367 * the acpi event methods for those pins.
369 void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
371 struct acpi_gpio_chip *acpi_gpio;
372 acpi_handle handle;
373 acpi_status status;
374 bool defer;
376 if (!chip->parent || !chip->to_irq)
377 return;
379 handle = ACPI_HANDLE(chip->parent);
380 if (!handle)
381 return;
383 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
384 if (ACPI_FAILURE(status))
385 return;
387 acpi_walk_resources(handle, "_AEI",
388 acpi_gpiochip_alloc_event, acpi_gpio);
390 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
391 defer = !acpi_gpio_deferred_req_irqs_done;
392 if (defer)
393 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
394 &acpi_gpio_deferred_req_irqs_list);
395 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
397 if (defer)
398 return;
400 acpi_gpiochip_request_irqs(acpi_gpio);
402 EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
405 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
406 * @chip: GPIO chip
408 * Free interrupts associated with GPIO ACPI event method for the given
409 * GPIO chip.
411 void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
413 struct acpi_gpio_chip *acpi_gpio;
414 struct acpi_gpio_event *event, *ep;
415 acpi_handle handle;
416 acpi_status status;
418 if (!chip->parent || !chip->to_irq)
419 return;
421 handle = ACPI_HANDLE(chip->parent);
422 if (!handle)
423 return;
425 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
426 if (ACPI_FAILURE(status))
427 return;
429 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
430 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
431 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
432 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
434 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
435 struct gpio_desc *desc;
437 if (event->irq_requested) {
438 if (event->irq_is_wake)
439 disable_irq_wake(event->irq);
441 free_irq(event->irq, event);
444 desc = event->desc;
445 if (WARN_ON(IS_ERR(desc)))
446 continue;
447 gpiochip_unlock_as_irq(chip, event->pin);
448 gpiochip_free_own_desc(desc);
449 list_del(&event->node);
450 kfree(event);
453 EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
455 int acpi_dev_add_driver_gpios(struct acpi_device *adev,
456 const struct acpi_gpio_mapping *gpios)
458 if (adev && gpios) {
459 adev->driver_gpios = gpios;
460 return 0;
462 return -EINVAL;
464 EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
466 static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
468 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
471 int devm_acpi_dev_add_driver_gpios(struct device *dev,
472 const struct acpi_gpio_mapping *gpios)
474 void *res;
475 int ret;
477 res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
478 if (!res)
479 return -ENOMEM;
481 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
482 if (ret) {
483 devres_free(res);
484 return ret;
486 devres_add(dev, res);
487 return 0;
489 EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
491 void devm_acpi_dev_remove_driver_gpios(struct device *dev)
493 WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
495 EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
497 static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
498 const char *name, int index,
499 struct fwnode_reference_args *args,
500 unsigned int *quirks)
502 const struct acpi_gpio_mapping *gm;
504 if (!adev->driver_gpios)
505 return false;
507 for (gm = adev->driver_gpios; gm->name; gm++)
508 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
509 const struct acpi_gpio_params *par = gm->data + index;
511 args->fwnode = acpi_fwnode_handle(adev);
512 args->args[0] = par->crs_entry_index;
513 args->args[1] = par->line_index;
514 args->args[2] = par->active_low;
515 args->nargs = 3;
517 *quirks = gm->quirks;
518 return true;
521 return false;
524 static enum gpiod_flags
525 acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio)
527 bool pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;
529 switch (agpio->io_restriction) {
530 case ACPI_IO_RESTRICT_INPUT:
531 return GPIOD_IN;
532 case ACPI_IO_RESTRICT_OUTPUT:
534 * ACPI GPIO resources don't contain an initial value for the
535 * GPIO. Therefore we deduce that value from the pull field
536 * instead. If the pin is pulled up we assume default to be
537 * high, otherwise low.
539 return pull_up ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
540 default:
542 * Assume that the BIOS has configured the direction and pull
543 * accordingly.
545 return GPIOD_ASIS;
549 static int
550 __acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
552 int ret = 0;
555 * Check if the BIOS has IoRestriction with explicitly set direction
556 * and update @flags accordingly. Otherwise use whatever caller asked
557 * for.
559 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
560 enum gpiod_flags diff = *flags ^ update;
563 * Check if caller supplied incompatible GPIO initialization
564 * flags.
566 * Return %-EINVAL to notify that firmware has different
567 * settings and we are going to use them.
569 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
570 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
571 ret = -EINVAL;
572 *flags = update;
574 return ret;
578 acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
580 struct device *dev = &info->adev->dev;
581 enum gpiod_flags old = *flags;
582 int ret;
584 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
585 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
586 if (ret)
587 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
588 } else {
589 if (ret)
590 dev_dbg(dev, "Override GPIO initialization flags\n");
591 *flags = old;
594 return ret;
597 struct acpi_gpio_lookup {
598 struct acpi_gpio_info info;
599 int index;
600 int pin_index;
601 bool active_low;
602 struct gpio_desc *desc;
603 int n;
606 static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
608 struct acpi_gpio_lookup *lookup = data;
610 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
611 return 1;
613 if (lookup->n++ == lookup->index && !lookup->desc) {
614 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
615 int pin_index = lookup->pin_index;
617 if (pin_index >= agpio->pin_table_length)
618 return 1;
620 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
621 agpio->pin_table[pin_index]);
622 lookup->info.gpioint =
623 agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
626 * Polarity and triggering are only specified for GpioInt
627 * resource.
628 * Note: we expect here:
629 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
630 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
632 if (lookup->info.gpioint) {
633 lookup->info.flags = GPIOD_IN;
634 lookup->info.polarity = agpio->polarity;
635 lookup->info.triggering = agpio->triggering;
636 } else {
637 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio);
638 lookup->info.polarity = lookup->active_low;
642 return 1;
645 static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
646 struct acpi_gpio_info *info)
648 struct acpi_device *adev = lookup->info.adev;
649 struct list_head res_list;
650 int ret;
652 INIT_LIST_HEAD(&res_list);
654 ret = acpi_dev_get_resources(adev, &res_list,
655 acpi_populate_gpio_lookup,
656 lookup);
657 if (ret < 0)
658 return ret;
660 acpi_dev_free_resource_list(&res_list);
662 if (!lookup->desc)
663 return -ENOENT;
665 if (info)
666 *info = lookup->info;
667 return 0;
670 static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
671 const char *propname, int index,
672 struct acpi_gpio_lookup *lookup)
674 struct fwnode_reference_args args;
675 unsigned int quirks = 0;
676 int ret;
678 memset(&args, 0, sizeof(args));
679 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
680 &args);
681 if (ret) {
682 struct acpi_device *adev = to_acpi_device_node(fwnode);
684 if (!adev)
685 return ret;
687 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
688 &quirks))
689 return ret;
692 * The property was found and resolved, so need to lookup the GPIO based
693 * on returned args.
695 if (!to_acpi_device_node(args.fwnode))
696 return -EINVAL;
697 if (args.nargs != 3)
698 return -EPROTO;
700 lookup->index = args.args[0];
701 lookup->pin_index = args.args[1];
702 lookup->active_low = !!args.args[2];
704 lookup->info.adev = to_acpi_device_node(args.fwnode);
705 lookup->info.quirks = quirks;
707 return 0;
711 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
712 * @adev: pointer to a ACPI device to get GPIO from
713 * @propname: Property name of the GPIO (optional)
714 * @index: index of GpioIo/GpioInt resource (starting from %0)
715 * @info: info pointer to fill in (optional)
717 * Function goes through ACPI resources for @adev and based on @index looks
718 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
719 * and returns it. @index matches GpioIo/GpioInt resources only so if there
720 * are total %3 GPIO resources, the index goes from %0 to %2.
722 * If @propname is specified the GPIO is looked using device property. In
723 * that case @index is used to select the GPIO entry in the property value
724 * (in case of multiple).
726 * If the GPIO cannot be translated or there is an error an ERR_PTR is
727 * returned.
729 * Note: if the GPIO resource has multiple entries in the pin list, this
730 * function only returns the first.
732 static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
733 const char *propname, int index,
734 struct acpi_gpio_info *info)
736 struct acpi_gpio_lookup lookup;
737 int ret;
739 if (!adev)
740 return ERR_PTR(-ENODEV);
742 memset(&lookup, 0, sizeof(lookup));
743 lookup.index = index;
745 if (propname) {
746 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
748 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
749 propname, index, &lookup);
750 if (ret)
751 return ERR_PTR(ret);
753 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
754 dev_name(&lookup.info.adev->dev), lookup.index,
755 lookup.pin_index, lookup.active_low);
756 } else {
757 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
758 lookup.info.adev = adev;
761 ret = acpi_gpio_resource_lookup(&lookup, info);
762 return ret ? ERR_PTR(ret) : lookup.desc;
765 struct gpio_desc *acpi_find_gpio(struct device *dev,
766 const char *con_id,
767 unsigned int idx,
768 enum gpiod_flags *dflags,
769 enum gpio_lookup_flags *lookupflags)
771 struct acpi_device *adev = ACPI_COMPANION(dev);
772 struct acpi_gpio_info info;
773 struct gpio_desc *desc;
774 char propname[32];
775 int i;
777 /* Try first from _DSD */
778 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
779 if (con_id) {
780 snprintf(propname, sizeof(propname), "%s-%s",
781 con_id, gpio_suffixes[i]);
782 } else {
783 snprintf(propname, sizeof(propname), "%s",
784 gpio_suffixes[i]);
787 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
788 if (!IS_ERR(desc))
789 break;
790 if (PTR_ERR(desc) == -EPROBE_DEFER)
791 return ERR_CAST(desc);
794 /* Then from plain _CRS GPIOs */
795 if (IS_ERR(desc)) {
796 if (!acpi_can_fallback_to_crs(adev, con_id))
797 return ERR_PTR(-ENOENT);
799 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
800 if (IS_ERR(desc))
801 return desc;
804 if (info.gpioint &&
805 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
806 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
807 return ERR_PTR(-ENOENT);
810 if (info.polarity == GPIO_ACTIVE_LOW)
811 *lookupflags |= GPIO_ACTIVE_LOW;
813 acpi_gpio_update_gpiod_flags(dflags, &info);
814 return desc;
818 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
819 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
820 * @propname: Property name of the GPIO
821 * @index: index of GpioIo/GpioInt resource (starting from %0)
822 * @info: info pointer to fill in (optional)
824 * If @fwnode is an ACPI device object, call %acpi_get_gpiod_by_index() for it.
825 * Otherwise (ie. it is a data-only non-device object), use the property-based
826 * GPIO lookup to get to the GPIO resource with the relevant information and use
827 * that to obtain the GPIO descriptor to return.
829 struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
830 const char *propname, int index,
831 struct acpi_gpio_info *info)
833 struct acpi_gpio_lookup lookup;
834 struct acpi_device *adev;
835 int ret;
837 adev = to_acpi_device_node(fwnode);
838 if (adev)
839 return acpi_get_gpiod_by_index(adev, propname, index, info);
841 if (!is_acpi_data_node(fwnode))
842 return ERR_PTR(-ENODEV);
844 if (!propname)
845 return ERR_PTR(-EINVAL);
847 memset(&lookup, 0, sizeof(lookup));
848 lookup.index = index;
850 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
851 if (ret)
852 return ERR_PTR(ret);
854 ret = acpi_gpio_resource_lookup(&lookup, info);
855 return ret ? ERR_PTR(ret) : lookup.desc;
859 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
860 * @adev: pointer to a ACPI device to get IRQ from
861 * @index: index of GpioInt resource (starting from %0)
863 * If the device has one or more GpioInt resources, this function can be
864 * used to translate from the GPIO offset in the resource to the Linux IRQ
865 * number.
867 * The function is idempotent, though each time it runs it will configure GPIO
868 * pin direction according to the flags in GpioInt resource.
870 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
872 int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
874 int idx, i;
875 unsigned int irq_flags;
876 int ret;
878 for (i = 0, idx = 0; idx <= index; i++) {
879 struct acpi_gpio_info info;
880 struct gpio_desc *desc;
882 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
884 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
885 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
886 return PTR_ERR(desc);
888 if (info.gpioint && idx++ == index) {
889 char label[32];
890 int irq;
892 if (IS_ERR(desc))
893 return PTR_ERR(desc);
895 irq = gpiod_to_irq(desc);
896 if (irq < 0)
897 return irq;
899 snprintf(label, sizeof(label), "GpioInt() %d", index);
900 ret = gpiod_configure_flags(desc, label, 0, info.flags);
901 if (ret < 0)
902 return ret;
904 irq_flags = acpi_dev_get_irq_type(info.triggering,
905 info.polarity);
907 /* Set type if specified and different than the current one */
908 if (irq_flags != IRQ_TYPE_NONE &&
909 irq_flags != irq_get_trigger_type(irq))
910 irq_set_irq_type(irq, irq_flags);
912 return irq;
916 return -ENOENT;
918 EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
920 static acpi_status
921 acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
922 u32 bits, u64 *value, void *handler_context,
923 void *region_context)
925 struct acpi_gpio_chip *achip = region_context;
926 struct gpio_chip *chip = achip->chip;
927 struct acpi_resource_gpio *agpio;
928 struct acpi_resource *ares;
929 int pin_index = (int)address;
930 acpi_status status;
931 int length;
932 int i;
934 status = acpi_buffer_to_resource(achip->conn_info.connection,
935 achip->conn_info.length, &ares);
936 if (ACPI_FAILURE(status))
937 return status;
939 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
940 ACPI_FREE(ares);
941 return AE_BAD_PARAMETER;
944 agpio = &ares->data.gpio;
946 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
947 function == ACPI_WRITE)) {
948 ACPI_FREE(ares);
949 return AE_BAD_PARAMETER;
952 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
953 for (i = pin_index; i < length; ++i) {
954 int pin = agpio->pin_table[i];
955 struct acpi_gpio_connection *conn;
956 struct gpio_desc *desc;
957 bool found;
959 mutex_lock(&achip->conn_lock);
961 found = false;
962 list_for_each_entry(conn, &achip->conns, node) {
963 if (conn->pin == pin) {
964 found = true;
965 desc = conn->desc;
966 break;
971 * The same GPIO can be shared between operation region and
972 * event but only if the access here is ACPI_READ. In that
973 * case we "borrow" the event GPIO instead.
975 if (!found && agpio->sharable == ACPI_SHARED &&
976 function == ACPI_READ) {
977 struct acpi_gpio_event *event;
979 list_for_each_entry(event, &achip->events, node) {
980 if (event->pin == pin) {
981 desc = event->desc;
982 found = true;
983 break;
988 if (!found) {
989 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio);
990 const char *label = "ACPI:OpRegion";
991 int err;
993 desc = gpiochip_request_own_desc(chip, pin, label);
994 if (IS_ERR(desc)) {
995 status = AE_ERROR;
996 mutex_unlock(&achip->conn_lock);
997 goto out;
1000 err = gpiod_configure_flags(desc, label, 0, flags);
1001 if (err < 0) {
1002 status = AE_NOT_CONFIGURED;
1003 gpiochip_free_own_desc(desc);
1004 mutex_unlock(&achip->conn_lock);
1005 goto out;
1008 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1009 if (!conn) {
1010 status = AE_NO_MEMORY;
1011 gpiochip_free_own_desc(desc);
1012 mutex_unlock(&achip->conn_lock);
1013 goto out;
1016 conn->pin = pin;
1017 conn->desc = desc;
1018 list_add_tail(&conn->node, &achip->conns);
1021 mutex_unlock(&achip->conn_lock);
1023 if (function == ACPI_WRITE)
1024 gpiod_set_raw_value_cansleep(desc,
1025 !!((1 << i) & *value));
1026 else
1027 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1030 out:
1031 ACPI_FREE(ares);
1032 return status;
1035 static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1037 struct gpio_chip *chip = achip->chip;
1038 acpi_handle handle = ACPI_HANDLE(chip->parent);
1039 acpi_status status;
1041 INIT_LIST_HEAD(&achip->conns);
1042 mutex_init(&achip->conn_lock);
1043 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1044 acpi_gpio_adr_space_handler,
1045 NULL, achip);
1046 if (ACPI_FAILURE(status))
1047 dev_err(chip->parent,
1048 "Failed to install GPIO OpRegion handler\n");
1051 static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1053 struct gpio_chip *chip = achip->chip;
1054 acpi_handle handle = ACPI_HANDLE(chip->parent);
1055 struct acpi_gpio_connection *conn, *tmp;
1056 acpi_status status;
1058 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1059 acpi_gpio_adr_space_handler);
1060 if (ACPI_FAILURE(status)) {
1061 dev_err(chip->parent,
1062 "Failed to remove GPIO OpRegion handler\n");
1063 return;
1066 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1067 gpiochip_free_own_desc(conn->desc);
1068 list_del(&conn->node);
1069 kfree(conn);
1073 static struct gpio_desc *acpi_gpiochip_parse_own_gpio(
1074 struct acpi_gpio_chip *achip, struct fwnode_handle *fwnode,
1075 const char **name, unsigned int *lflags, unsigned int *dflags)
1077 struct gpio_chip *chip = achip->chip;
1078 struct gpio_desc *desc;
1079 u32 gpios[2];
1080 int ret;
1082 *lflags = 0;
1083 *dflags = 0;
1084 *name = NULL;
1086 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1087 ARRAY_SIZE(gpios));
1088 if (ret < 0)
1089 return ERR_PTR(ret);
1091 desc = gpiochip_get_desc(chip, gpios[0]);
1092 if (IS_ERR(desc))
1093 return desc;
1095 if (gpios[1])
1096 *lflags |= GPIO_ACTIVE_LOW;
1098 if (fwnode_property_present(fwnode, "input"))
1099 *dflags |= GPIOD_IN;
1100 else if (fwnode_property_present(fwnode, "output-low"))
1101 *dflags |= GPIOD_OUT_LOW;
1102 else if (fwnode_property_present(fwnode, "output-high"))
1103 *dflags |= GPIOD_OUT_HIGH;
1104 else
1105 return ERR_PTR(-EINVAL);
1107 fwnode_property_read_string(fwnode, "line-name", name);
1109 return desc;
1112 static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1114 struct gpio_chip *chip = achip->chip;
1115 struct fwnode_handle *fwnode;
1117 device_for_each_child_node(chip->parent, fwnode) {
1118 unsigned int lflags, dflags;
1119 struct gpio_desc *desc;
1120 const char *name;
1121 int ret;
1123 if (!fwnode_property_present(fwnode, "gpio-hog"))
1124 continue;
1126 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1127 &lflags, &dflags);
1128 if (IS_ERR(desc))
1129 continue;
1131 ret = gpiod_hog(desc, name, lflags, dflags);
1132 if (ret) {
1133 dev_err(chip->parent, "Failed to hog GPIO\n");
1134 fwnode_handle_put(fwnode);
1135 return;
1140 void acpi_gpiochip_add(struct gpio_chip *chip)
1142 struct acpi_gpio_chip *acpi_gpio;
1143 acpi_handle handle;
1144 acpi_status status;
1146 if (!chip || !chip->parent)
1147 return;
1149 handle = ACPI_HANDLE(chip->parent);
1150 if (!handle)
1151 return;
1153 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1154 if (!acpi_gpio) {
1155 dev_err(chip->parent,
1156 "Failed to allocate memory for ACPI GPIO chip\n");
1157 return;
1160 acpi_gpio->chip = chip;
1161 INIT_LIST_HEAD(&acpi_gpio->events);
1162 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1164 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1165 if (ACPI_FAILURE(status)) {
1166 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1167 kfree(acpi_gpio);
1168 return;
1171 if (!chip->names)
1172 devprop_gpiochip_set_names(chip, dev_fwnode(chip->parent));
1174 acpi_gpiochip_request_regions(acpi_gpio);
1175 acpi_gpiochip_scan_gpios(acpi_gpio);
1176 acpi_walk_dep_device_list(handle);
1179 void acpi_gpiochip_remove(struct gpio_chip *chip)
1181 struct acpi_gpio_chip *acpi_gpio;
1182 acpi_handle handle;
1183 acpi_status status;
1185 if (!chip || !chip->parent)
1186 return;
1188 handle = ACPI_HANDLE(chip->parent);
1189 if (!handle)
1190 return;
1192 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1193 if (ACPI_FAILURE(status)) {
1194 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1195 return;
1198 acpi_gpiochip_free_regions(acpi_gpio);
1200 acpi_detach_data(handle, acpi_gpio_chip_dh);
1201 kfree(acpi_gpio);
1204 static int acpi_gpio_package_count(const union acpi_object *obj)
1206 const union acpi_object *element = obj->package.elements;
1207 const union acpi_object *end = element + obj->package.count;
1208 unsigned int count = 0;
1210 while (element < end) {
1211 switch (element->type) {
1212 case ACPI_TYPE_LOCAL_REFERENCE:
1213 element += 3;
1214 /* Fallthrough */
1215 case ACPI_TYPE_INTEGER:
1216 element++;
1217 count++;
1218 break;
1220 default:
1221 return -EPROTO;
1225 return count;
1228 static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1230 unsigned int *count = data;
1232 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1233 *count += ares->data.gpio.pin_table_length;
1235 return 1;
1239 * acpi_gpio_count - return the number of GPIOs associated with a
1240 * device / function or -ENOENT if no GPIO has been
1241 * assigned to the requested function.
1242 * @dev: GPIO consumer, can be NULL for system-global GPIOs
1243 * @con_id: function within the GPIO consumer
1245 int acpi_gpio_count(struct device *dev, const char *con_id)
1247 struct acpi_device *adev = ACPI_COMPANION(dev);
1248 const union acpi_object *obj;
1249 const struct acpi_gpio_mapping *gm;
1250 int count = -ENOENT;
1251 int ret;
1252 char propname[32];
1253 unsigned int i;
1255 /* Try first from _DSD */
1256 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1257 if (con_id)
1258 snprintf(propname, sizeof(propname), "%s-%s",
1259 con_id, gpio_suffixes[i]);
1260 else
1261 snprintf(propname, sizeof(propname), "%s",
1262 gpio_suffixes[i]);
1264 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1265 &obj);
1266 if (ret == 0) {
1267 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1268 count = 1;
1269 else if (obj->type == ACPI_TYPE_PACKAGE)
1270 count = acpi_gpio_package_count(obj);
1271 } else if (adev->driver_gpios) {
1272 for (gm = adev->driver_gpios; gm->name; gm++)
1273 if (strcmp(propname, gm->name) == 0) {
1274 count = gm->size;
1275 break;
1278 if (count > 0)
1279 break;
1282 /* Then from plain _CRS GPIOs */
1283 if (count < 0) {
1284 struct list_head resource_list;
1285 unsigned int crs_count = 0;
1287 if (!acpi_can_fallback_to_crs(adev, con_id))
1288 return count;
1290 INIT_LIST_HEAD(&resource_list);
1291 acpi_dev_get_resources(adev, &resource_list,
1292 acpi_find_gpio_count, &crs_count);
1293 acpi_dev_free_resource_list(&resource_list);
1294 if (crs_count > 0)
1295 count = crs_count;
1297 return count ? count : -ENOENT;
1300 bool acpi_can_fallback_to_crs(struct acpi_device *adev, const char *con_id)
1302 /* Never allow fallback if the device has properties */
1303 if (adev->data.properties || adev->driver_gpios)
1304 return false;
1306 return con_id == NULL;
1309 /* Run deferred acpi_gpiochip_request_irqs() */
1310 static int acpi_gpio_handle_deferred_request_irqs(void)
1312 struct acpi_gpio_chip *acpi_gpio, *tmp;
1314 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1315 list_for_each_entry_safe(acpi_gpio, tmp,
1316 &acpi_gpio_deferred_req_irqs_list,
1317 deferred_req_irqs_list_entry)
1318 acpi_gpiochip_request_irqs(acpi_gpio);
1320 acpi_gpio_deferred_req_irqs_done = true;
1321 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1323 return 0;
1325 /* We must use _sync so that this runs after the first deferred_probe run */
1326 late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1328 static const struct dmi_system_id gpiolib_acpi_quirks[] = {
1331 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1332 * a non existing micro-USB-B connector which puts the HDMI
1333 * DDC pins in GPIO mode, breaking HDMI support.
1335 .matches = {
1336 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1337 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1339 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1340 .no_edge_events_on_boot = true,
1345 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1346 * instead of controlling the actual micro-USB-B turns the 5V
1347 * boost for its USB-A connector off. The actual micro-USB-B
1348 * connector is wired for charging only.
1350 .matches = {
1351 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1352 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1354 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1355 .no_edge_events_on_boot = true,
1360 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1361 * external embedded-controller connected via I2C + an ACPI GPIO
1362 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1363 * When suspending by closing the LID, the power to the USB
1364 * keyboard is turned off, causing INT0002 ACPI events to
1365 * trigger once the XHCI controller notices the keyboard is
1366 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1367 * EC wakes breaks wakeup when opening the lid, the user needs
1368 * to press the power-button to wakeup the system. The
1369 * alternative is suspend simply not working, which is worse.
1371 .matches = {
1372 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1373 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1375 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1376 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1381 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1382 * external embedded-controller connected via I2C + an ACPI GPIO
1383 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1385 .matches = {
1386 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1387 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1388 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1390 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1391 .ignore_wake = "INT33FC:02@28",
1396 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1397 * external embedded-controller connected via I2C + an ACPI GPIO
1398 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1400 .matches = {
1401 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1402 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1403 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1405 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1406 .ignore_wake = "INT33FF:01@0",
1409 {} /* Terminating entry */
1412 static int acpi_gpio_setup_params(void)
1414 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1415 const struct dmi_system_id *id;
1417 id = dmi_first_match(gpiolib_acpi_quirks);
1418 if (id)
1419 quirk = id->driver_data;
1421 if (run_edge_events_on_boot < 0) {
1422 if (quirk && quirk->no_edge_events_on_boot)
1423 run_edge_events_on_boot = 0;
1424 else
1425 run_edge_events_on_boot = 1;
1428 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1429 ignore_wake = quirk->ignore_wake;
1431 return 0;
1434 /* Directly after dmi_setup() which runs as core_initcall() */
1435 postcore_initcall(acpi_gpio_setup_params);