Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * ACPI helpers for GPIO API
4 *
5 * Copyright (C) 2012, Intel Corporation
6 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
7 * Mika Westerberg <mika.westerberg@linux.intel.com>
8 */
9
10#include <linux/acpi.h>
11#include <linux/dmi.h>
12#include <linux/errno.h>
13#include <linux/export.h>
14#include <linux/interrupt.h>
15#include <linux/irq.h>
16#include <linux/mutex.h>
17#include <linux/pinctrl/pinctrl.h>
18
19#include <linux/gpio/consumer.h>
20#include <linux/gpio/driver.h>
21#include <linux/gpio/machine.h>
22
23#include "gpiolib.h"
24#include "gpiolib-acpi.h"
25
26static int run_edge_events_on_boot = -1;
27module_param(run_edge_events_on_boot, int, 0444);
28MODULE_PARM_DESC(run_edge_events_on_boot,
29 "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");
30
31static char *ignore_wake;
32module_param(ignore_wake, charp, 0444);
33MODULE_PARM_DESC(ignore_wake,
34 "controller@pin combos on which to ignore the ACPI wake flag "
35 "ignore_wake=controller@pin[,controller@pin[,...]]");
36
37static char *ignore_interrupt;
38module_param(ignore_interrupt, charp, 0444);
39MODULE_PARM_DESC(ignore_interrupt,
40 "controller@pin combos on which to ignore interrupt "
41 "ignore_interrupt=controller@pin[,controller@pin[,...]]");
42
43struct acpi_gpiolib_dmi_quirk {
44 bool no_edge_events_on_boot;
45 char *ignore_wake;
46 char *ignore_interrupt;
47};
48
49/**
50 * struct acpi_gpio_event - ACPI GPIO event handler data
51 *
52 * @node: list-entry of the events list of the struct acpi_gpio_chip
53 * @handle: handle of ACPI method to execute when the IRQ triggers
54 * @handler: handler function to pass to request_irq() when requesting the IRQ
55 * @pin: GPIO pin number on the struct gpio_chip
56 * @irq: Linux IRQ number for the event, for request_irq() / free_irq()
57 * @irqflags: flags to pass to request_irq() when requesting the IRQ
58 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
59 * @irq_requested:True if request_irq() has been done
60 * @desc: struct gpio_desc for the GPIO pin for this event
61 */
62struct acpi_gpio_event {
63 struct list_head node;
64 acpi_handle handle;
65 irq_handler_t handler;
66 unsigned int pin;
67 unsigned int irq;
68 unsigned long irqflags;
69 bool irq_is_wake;
70 bool irq_requested;
71 struct gpio_desc *desc;
72};
73
74struct acpi_gpio_connection {
75 struct list_head node;
76 unsigned int pin;
77 struct gpio_desc *desc;
78};
79
80struct acpi_gpio_chip {
81 /*
82 * ACPICA requires that the first field of the context parameter
83 * passed to acpi_install_address_space_handler() is large enough
84 * to hold struct acpi_connection_info.
85 */
86 struct acpi_connection_info conn_info;
87 struct list_head conns;
88 struct mutex conn_lock;
89 struct gpio_chip *chip;
90 struct list_head events;
91 struct list_head deferred_req_irqs_list_entry;
92};
93
94/**
95 * struct acpi_gpio_info - ACPI GPIO specific information
96 * @adev: reference to ACPI device which consumes GPIO resource
97 * @flags: GPIO initialization flags
98 * @gpioint: if %true this GPIO is of type GpioInt otherwise type is GpioIo
99 * @pin_config: pin bias as provided by ACPI
100 * @polarity: interrupt polarity as provided by ACPI
101 * @triggering: triggering type as provided by ACPI
102 * @wake_capable: wake capability as provided by ACPI
103 * @debounce: debounce timeout as provided by ACPI
104 * @quirks: Linux specific quirks as provided by struct acpi_gpio_mapping
105 */
106struct acpi_gpio_info {
107 struct acpi_device *adev;
108 enum gpiod_flags flags;
109 bool gpioint;
110 int pin_config;
111 int polarity;
112 int triggering;
113 bool wake_capable;
114 unsigned int debounce;
115 unsigned int quirks;
116};
117
118/*
119 * For GPIO chips which call acpi_gpiochip_request_interrupts() before late_init
120 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
121 * late_initcall_sync() handler, so that other builtin drivers can register their
122 * OpRegions before the event handlers can run. This list contains GPIO chips
123 * for which the acpi_gpiochip_request_irqs() call has been deferred.
124 */
125static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
126static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
127static bool acpi_gpio_deferred_req_irqs_done;
128
129static int acpi_gpiochip_find(struct gpio_chip *gc, const void *data)
130{
131 /* First check the actual GPIO device */
132 if (device_match_acpi_handle(&gc->gpiodev->dev, data))
133 return true;
134
135 /*
136 * When the ACPI device is artificially split to the banks of GPIOs,
137 * where each of them is represented by a separate GPIO device,
138 * the firmware node of the physical device may not be shared among
139 * the banks as they may require different values for the same property,
140 * e.g., number of GPIOs in a certain bank. In such case the ACPI handle
141 * of a GPIO device is NULL and can not be used. Hence we have to check
142 * the parent device to be sure that there is no match before bailing
143 * out.
144 */
145 if (gc->parent)
146 return device_match_acpi_handle(gc->parent, data);
147
148 return false;
149}
150
151/**
152 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
153 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
154 * @pin: ACPI GPIO pin number (0-based, controller-relative)
155 *
156 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
157 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
158 * controller does not have GPIO chip registered at the moment. This is to
159 * support probe deferral.
160 */
161static struct gpio_desc *acpi_get_gpiod(char *path, unsigned int pin)
162{
163 acpi_handle handle;
164 acpi_status status;
165
166 status = acpi_get_handle(NULL, path, &handle);
167 if (ACPI_FAILURE(status))
168 return ERR_PTR(-ENODEV);
169
170 struct gpio_device *gdev __free(gpio_device_put) =
171 gpio_device_find(handle, acpi_gpiochip_find);
172 if (!gdev)
173 return ERR_PTR(-EPROBE_DEFER);
174
175 /*
176 * FIXME: keep track of the reference to the GPIO device somehow
177 * instead of putting it here.
178 */
179 return gpio_device_get_desc(gdev, pin);
180}
181
182static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
183{
184 struct acpi_gpio_event *event = data;
185
186 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
187
188 return IRQ_HANDLED;
189}
190
191static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
192{
193 struct acpi_gpio_event *event = data;
194
195 acpi_execute_simple_method(event->handle, NULL, event->pin);
196
197 return IRQ_HANDLED;
198}
199
200static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
201{
202 /* The address of this function is used as a key. */
203}
204
205bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
206 struct acpi_resource_gpio **agpio)
207{
208 struct acpi_resource_gpio *gpio;
209
210 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
211 return false;
212
213 gpio = &ares->data.gpio;
214 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
215 return false;
216
217 *agpio = gpio;
218 return true;
219}
220EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
221
222/**
223 * acpi_gpio_get_io_resource - Fetch details of an ACPI resource if it is a GPIO
224 * I/O resource or return False if not.
225 * @ares: Pointer to the ACPI resource to fetch
226 * @agpio: Pointer to a &struct acpi_resource_gpio to store the output pointer
227 */
228bool acpi_gpio_get_io_resource(struct acpi_resource *ares,
229 struct acpi_resource_gpio **agpio)
230{
231 struct acpi_resource_gpio *gpio;
232
233 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
234 return false;
235
236 gpio = &ares->data.gpio;
237 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_IO)
238 return false;
239
240 *agpio = gpio;
241 return true;
242}
243EXPORT_SYMBOL_GPL(acpi_gpio_get_io_resource);
244
245static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
246 struct acpi_gpio_event *event)
247{
248 struct device *parent = acpi_gpio->chip->parent;
249 int ret, value;
250
251 ret = request_threaded_irq(event->irq, NULL, event->handler,
252 event->irqflags | IRQF_ONESHOT, "ACPI:Event", event);
253 if (ret) {
254 dev_err(parent, "Failed to setup interrupt handler for %d\n", event->irq);
255 return;
256 }
257
258 if (event->irq_is_wake)
259 enable_irq_wake(event->irq);
260
261 event->irq_requested = true;
262
263 /* Make sure we trigger the initial state of edge-triggered IRQs */
264 if (run_edge_events_on_boot &&
265 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
266 value = gpiod_get_raw_value_cansleep(event->desc);
267 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
268 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
269 event->handler(event->irq, event);
270 }
271}
272
273static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
274{
275 struct acpi_gpio_event *event;
276
277 list_for_each_entry(event, &acpi_gpio->events, node)
278 acpi_gpiochip_request_irq(acpi_gpio, event);
279}
280
281static enum gpiod_flags
282acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio, int polarity)
283{
284 /* GpioInt() implies input configuration */
285 if (agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT)
286 return GPIOD_IN;
287
288 switch (agpio->io_restriction) {
289 case ACPI_IO_RESTRICT_INPUT:
290 return GPIOD_IN;
291 case ACPI_IO_RESTRICT_OUTPUT:
292 /*
293 * ACPI GPIO resources don't contain an initial value for the
294 * GPIO. Therefore we deduce that value from the pull field
295 * and the polarity instead. If the pin is pulled up we assume
296 * default to be high, if it is pulled down we assume default
297 * to be low, otherwise we leave pin untouched. For active low
298 * polarity values will be switched. See also
299 * Documentation/firmware-guide/acpi/gpio-properties.rst.
300 */
301 switch (agpio->pin_config) {
302 case ACPI_PIN_CONFIG_PULLUP:
303 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_LOW : GPIOD_OUT_HIGH;
304 case ACPI_PIN_CONFIG_PULLDOWN:
305 return polarity == GPIO_ACTIVE_LOW ? GPIOD_OUT_HIGH : GPIOD_OUT_LOW;
306 default:
307 break;
308 }
309 break;
310 default:
311 break;
312 }
313
314 /*
315 * Assume that the BIOS has configured the direction and pull
316 * accordingly.
317 */
318 return GPIOD_ASIS;
319}
320
321static struct gpio_desc *acpi_request_own_gpiod(struct gpio_chip *chip,
322 struct acpi_resource_gpio *agpio,
323 unsigned int index,
324 const char *label)
325{
326 int polarity = GPIO_ACTIVE_HIGH;
327 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio, polarity);
328 unsigned int pin = agpio->pin_table[index];
329 struct gpio_desc *desc;
330 int ret;
331
332 desc = gpiochip_request_own_desc(chip, pin, label, polarity, flags);
333 if (IS_ERR(desc))
334 return desc;
335
336 /* ACPI uses hundredths of milliseconds units */
337 ret = gpio_set_debounce_timeout(desc, agpio->debounce_timeout * 10);
338 if (ret)
339 dev_warn(chip->parent,
340 "Failed to set debounce-timeout for pin 0x%04X, err %d\n",
341 pin, ret);
342
343 return desc;
344}
345
346static bool acpi_gpio_in_ignore_list(const char *ignore_list, const char *controller_in,
347 unsigned int pin_in)
348{
349 const char *controller, *pin_str;
350 unsigned int pin;
351 char *endp;
352 int len;
353
354 controller = ignore_list;
355 while (controller) {
356 pin_str = strchr(controller, '@');
357 if (!pin_str)
358 goto err;
359
360 len = pin_str - controller;
361 if (len == strlen(controller_in) &&
362 strncmp(controller, controller_in, len) == 0) {
363 pin = simple_strtoul(pin_str + 1, &endp, 10);
364 if (*endp != 0 && *endp != ',')
365 goto err;
366
367 if (pin == pin_in)
368 return true;
369 }
370
371 controller = strchr(controller, ',');
372 if (controller)
373 controller++;
374 }
375
376 return false;
377err:
378 pr_err_once("Error: Invalid value for gpiolib_acpi.ignore_...: %s\n", ignore_list);
379 return false;
380}
381
382static bool acpi_gpio_irq_is_wake(struct device *parent,
383 const struct acpi_resource_gpio *agpio)
384{
385 unsigned int pin = agpio->pin_table[0];
386
387 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
388 return false;
389
390 if (acpi_gpio_in_ignore_list(ignore_wake, dev_name(parent), pin)) {
391 dev_info(parent, "Ignoring wakeup on pin %u\n", pin);
392 return false;
393 }
394
395 return true;
396}
397
398/* Always returns AE_OK so that we keep looping over the resources */
399static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
400 void *context)
401{
402 struct acpi_gpio_chip *acpi_gpio = context;
403 struct gpio_chip *chip = acpi_gpio->chip;
404 struct acpi_resource_gpio *agpio;
405 acpi_handle handle, evt_handle;
406 struct acpi_gpio_event *event;
407 irq_handler_t handler = NULL;
408 struct gpio_desc *desc;
409 unsigned int pin;
410 int ret, irq;
411
412 if (!acpi_gpio_get_irq_resource(ares, &agpio))
413 return AE_OK;
414
415 handle = ACPI_HANDLE(chip->parent);
416 pin = agpio->pin_table[0];
417
418 if (pin <= 255) {
419 char ev_name[8];
420 sprintf(ev_name, "_%c%02X",
421 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
422 pin);
423 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
424 handler = acpi_gpio_irq_handler;
425 }
426 if (!handler) {
427 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
428 handler = acpi_gpio_irq_handler_evt;
429 }
430 if (!handler)
431 return AE_OK;
432
433 if (acpi_gpio_in_ignore_list(ignore_interrupt, dev_name(chip->parent), pin)) {
434 dev_info(chip->parent, "Ignoring interrupt on pin %u\n", pin);
435 return AE_OK;
436 }
437
438 desc = acpi_request_own_gpiod(chip, agpio, 0, "ACPI:Event");
439 if (IS_ERR(desc)) {
440 dev_err(chip->parent,
441 "Failed to request GPIO for pin 0x%04X, err %ld\n",
442 pin, PTR_ERR(desc));
443 return AE_OK;
444 }
445
446 ret = gpiochip_lock_as_irq(chip, pin);
447 if (ret) {
448 dev_err(chip->parent,
449 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
450 pin, ret);
451 goto fail_free_desc;
452 }
453
454 irq = gpiod_to_irq(desc);
455 if (irq < 0) {
456 dev_err(chip->parent,
457 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
458 pin, irq);
459 goto fail_unlock_irq;
460 }
461
462 event = kzalloc(sizeof(*event), GFP_KERNEL);
463 if (!event)
464 goto fail_unlock_irq;
465
466 event->irqflags = IRQF_ONESHOT;
467 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
468 if (agpio->polarity == ACPI_ACTIVE_HIGH)
469 event->irqflags |= IRQF_TRIGGER_HIGH;
470 else
471 event->irqflags |= IRQF_TRIGGER_LOW;
472 } else {
473 switch (agpio->polarity) {
474 case ACPI_ACTIVE_HIGH:
475 event->irqflags |= IRQF_TRIGGER_RISING;
476 break;
477 case ACPI_ACTIVE_LOW:
478 event->irqflags |= IRQF_TRIGGER_FALLING;
479 break;
480 default:
481 event->irqflags |= IRQF_TRIGGER_RISING |
482 IRQF_TRIGGER_FALLING;
483 break;
484 }
485 }
486
487 event->handle = evt_handle;
488 event->handler = handler;
489 event->irq = irq;
490 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
491 event->pin = pin;
492 event->desc = desc;
493
494 list_add_tail(&event->node, &acpi_gpio->events);
495
496 return AE_OK;
497
498fail_unlock_irq:
499 gpiochip_unlock_as_irq(chip, pin);
500fail_free_desc:
501 gpiochip_free_own_desc(desc);
502
503 return AE_OK;
504}
505
506/**
507 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
508 * @chip: GPIO chip
509 *
510 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
511 * handled by ACPI event methods which need to be called from the GPIO
512 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
513 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
514 * the ACPI event methods for those pins.
515 */
516void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
517{
518 struct acpi_gpio_chip *acpi_gpio;
519 acpi_handle handle;
520 acpi_status status;
521 bool defer;
522
523 if (!chip->parent || !chip->to_irq)
524 return;
525
526 handle = ACPI_HANDLE(chip->parent);
527 if (!handle)
528 return;
529
530 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
531 if (ACPI_FAILURE(status))
532 return;
533
534 if (acpi_quirk_skip_gpio_event_handlers())
535 return;
536
537 acpi_walk_resources(handle, METHOD_NAME__AEI,
538 acpi_gpiochip_alloc_event, acpi_gpio);
539
540 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
541 defer = !acpi_gpio_deferred_req_irqs_done;
542 if (defer)
543 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
544 &acpi_gpio_deferred_req_irqs_list);
545 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
546
547 if (defer)
548 return;
549
550 acpi_gpiochip_request_irqs(acpi_gpio);
551}
552EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
553
554/**
555 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
556 * @chip: GPIO chip
557 *
558 * Free interrupts associated with GPIO ACPI event method for the given
559 * GPIO chip.
560 */
561void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
562{
563 struct acpi_gpio_chip *acpi_gpio;
564 struct acpi_gpio_event *event, *ep;
565 acpi_handle handle;
566 acpi_status status;
567
568 if (!chip->parent || !chip->to_irq)
569 return;
570
571 handle = ACPI_HANDLE(chip->parent);
572 if (!handle)
573 return;
574
575 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
576 if (ACPI_FAILURE(status))
577 return;
578
579 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
580 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
581 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
582 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
583
584 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
585 if (event->irq_requested) {
586 if (event->irq_is_wake)
587 disable_irq_wake(event->irq);
588
589 free_irq(event->irq, event);
590 }
591
592 gpiochip_unlock_as_irq(chip, event->pin);
593 gpiochip_free_own_desc(event->desc);
594 list_del(&event->node);
595 kfree(event);
596 }
597}
598EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
599
600int acpi_dev_add_driver_gpios(struct acpi_device *adev,
601 const struct acpi_gpio_mapping *gpios)
602{
603 if (adev && gpios) {
604 adev->driver_gpios = gpios;
605 return 0;
606 }
607 return -EINVAL;
608}
609EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
610
611void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
612{
613 if (adev)
614 adev->driver_gpios = NULL;
615}
616EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
617
618static void acpi_dev_release_driver_gpios(void *adev)
619{
620 acpi_dev_remove_driver_gpios(adev);
621}
622
623int devm_acpi_dev_add_driver_gpios(struct device *dev,
624 const struct acpi_gpio_mapping *gpios)
625{
626 struct acpi_device *adev = ACPI_COMPANION(dev);
627 int ret;
628
629 ret = acpi_dev_add_driver_gpios(adev, gpios);
630 if (ret)
631 return ret;
632
633 return devm_add_action_or_reset(dev, acpi_dev_release_driver_gpios, adev);
634}
635EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
636
637static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
638 const char *name, int index,
639 struct fwnode_reference_args *args,
640 unsigned int *quirks)
641{
642 const struct acpi_gpio_mapping *gm;
643
644 if (!adev || !adev->driver_gpios)
645 return false;
646
647 for (gm = adev->driver_gpios; gm->name; gm++)
648 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
649 const struct acpi_gpio_params *par = gm->data + index;
650
651 args->fwnode = acpi_fwnode_handle(adev);
652 args->args[0] = par->crs_entry_index;
653 args->args[1] = par->line_index;
654 args->args[2] = par->active_low;
655 args->nargs = 3;
656
657 *quirks = gm->quirks;
658 return true;
659 }
660
661 return false;
662}
663
664static int
665__acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
666{
667 const enum gpiod_flags mask =
668 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
669 GPIOD_FLAGS_BIT_DIR_VAL;
670 int ret = 0;
671
672 /*
673 * Check if the BIOS has IoRestriction with explicitly set direction
674 * and update @flags accordingly. Otherwise use whatever caller asked
675 * for.
676 */
677 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
678 enum gpiod_flags diff = *flags ^ update;
679
680 /*
681 * Check if caller supplied incompatible GPIO initialization
682 * flags.
683 *
684 * Return %-EINVAL to notify that firmware has different
685 * settings and we are going to use them.
686 */
687 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
688 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
689 ret = -EINVAL;
690 *flags = (*flags & ~mask) | (update & mask);
691 }
692 return ret;
693}
694
695static int acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags,
696 struct acpi_gpio_info *info)
697{
698 struct device *dev = &info->adev->dev;
699 enum gpiod_flags old = *flags;
700 int ret;
701
702 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
703 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
704 if (ret)
705 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
706 } else {
707 if (ret)
708 dev_dbg(dev, "Override GPIO initialization flags\n");
709 *flags = old;
710 }
711
712 return ret;
713}
714
715static int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
716 struct acpi_gpio_info *info)
717{
718 switch (info->pin_config) {
719 case ACPI_PIN_CONFIG_PULLUP:
720 *lookupflags |= GPIO_PULL_UP;
721 break;
722 case ACPI_PIN_CONFIG_PULLDOWN:
723 *lookupflags |= GPIO_PULL_DOWN;
724 break;
725 case ACPI_PIN_CONFIG_NOPULL:
726 *lookupflags |= GPIO_PULL_DISABLE;
727 break;
728 default:
729 break;
730 }
731
732 if (info->polarity == GPIO_ACTIVE_LOW)
733 *lookupflags |= GPIO_ACTIVE_LOW;
734
735 return 0;
736}
737
738struct acpi_gpio_lookup {
739 struct acpi_gpio_info info;
740 int index;
741 u16 pin_index;
742 bool active_low;
743 struct gpio_desc *desc;
744 int n;
745};
746
747static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
748{
749 struct acpi_gpio_lookup *lookup = data;
750
751 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
752 return 1;
753
754 if (!lookup->desc) {
755 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
756 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
757 struct gpio_desc *desc;
758 u16 pin_index;
759
760 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
761 lookup->index++;
762
763 if (lookup->n++ != lookup->index)
764 return 1;
765
766 pin_index = lookup->pin_index;
767 if (pin_index >= agpio->pin_table_length)
768 return 1;
769
770 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER)
771 desc = gpio_to_desc(agpio->pin_table[pin_index]);
772 else
773 desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
774 agpio->pin_table[pin_index]);
775 lookup->desc = desc;
776 lookup->info.pin_config = agpio->pin_config;
777 lookup->info.debounce = agpio->debounce_timeout;
778 lookup->info.gpioint = gpioint;
779 lookup->info.wake_capable = acpi_gpio_irq_is_wake(&lookup->info.adev->dev, agpio);
780
781 /*
782 * Polarity and triggering are only specified for GpioInt
783 * resource.
784 * Note: we expect here:
785 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
786 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
787 */
788 if (lookup->info.gpioint) {
789 lookup->info.polarity = agpio->polarity;
790 lookup->info.triggering = agpio->triggering;
791 } else {
792 lookup->info.polarity = lookup->active_low;
793 }
794
795 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio, lookup->info.polarity);
796 }
797
798 return 1;
799}
800
801static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
802 struct acpi_gpio_info *info)
803{
804 struct acpi_device *adev = lookup->info.adev;
805 struct list_head res_list;
806 int ret;
807
808 INIT_LIST_HEAD(&res_list);
809
810 ret = acpi_dev_get_resources(adev, &res_list,
811 acpi_populate_gpio_lookup,
812 lookup);
813 if (ret < 0)
814 return ret;
815
816 acpi_dev_free_resource_list(&res_list);
817
818 if (!lookup->desc)
819 return -ENOENT;
820
821 if (info)
822 *info = lookup->info;
823 return 0;
824}
825
826static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
827 const char *propname, int index,
828 struct acpi_gpio_lookup *lookup)
829{
830 struct fwnode_reference_args args;
831 unsigned int quirks = 0;
832 int ret;
833
834 memset(&args, 0, sizeof(args));
835 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
836 &args);
837 if (ret) {
838 struct acpi_device *adev;
839
840 adev = to_acpi_device_node(fwnode);
841 if (!acpi_get_driver_gpio_data(adev, propname, index, &args, &quirks))
842 return ret;
843 }
844 /*
845 * The property was found and resolved, so need to lookup the GPIO based
846 * on returned args.
847 */
848 if (!to_acpi_device_node(args.fwnode))
849 return -EINVAL;
850 if (args.nargs != 3)
851 return -EPROTO;
852
853 lookup->index = args.args[0];
854 lookup->pin_index = args.args[1];
855 lookup->active_low = !!args.args[2];
856
857 lookup->info.adev = to_acpi_device_node(args.fwnode);
858 lookup->info.quirks = quirks;
859
860 return 0;
861}
862
863/**
864 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
865 * @adev: pointer to a ACPI device to get GPIO from
866 * @propname: Property name of the GPIO (optional)
867 * @index: index of GpioIo/GpioInt resource (starting from %0)
868 * @info: info pointer to fill in (optional)
869 *
870 * Function goes through ACPI resources for @adev and based on @index looks
871 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
872 * and returns it. @index matches GpioIo/GpioInt resources only so if there
873 * are total %3 GPIO resources, the index goes from %0 to %2.
874 *
875 * If @propname is specified the GPIO is looked using device property. In
876 * that case @index is used to select the GPIO entry in the property value
877 * (in case of multiple).
878 *
879 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
880 * returned.
881 *
882 * Note: if the GPIO resource has multiple entries in the pin list, this
883 * function only returns the first.
884 */
885static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
886 const char *propname,
887 int index,
888 struct acpi_gpio_info *info)
889{
890 struct acpi_gpio_lookup lookup;
891 int ret;
892
893 if (!adev)
894 return ERR_PTR(-ENODEV);
895
896 memset(&lookup, 0, sizeof(lookup));
897 lookup.index = index;
898
899 if (propname) {
900 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
901
902 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
903 propname, index, &lookup);
904 if (ret)
905 return ERR_PTR(ret);
906
907 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %u %u\n",
908 dev_name(&lookup.info.adev->dev), lookup.index,
909 lookup.pin_index, lookup.active_low);
910 } else {
911 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
912 lookup.info.adev = adev;
913 }
914
915 ret = acpi_gpio_resource_lookup(&lookup, info);
916 return ret ? ERR_PTR(ret) : lookup.desc;
917}
918
919/**
920 * acpi_get_gpiod_from_data() - get a GPIO descriptor from ACPI data node
921 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
922 * @propname: Property name of the GPIO
923 * @index: index of GpioIo/GpioInt resource (starting from %0)
924 * @info: info pointer to fill in (optional)
925 *
926 * This function uses the property-based GPIO lookup to get to the GPIO
927 * resource with the relevant information from a data-only ACPI firmware node
928 * and uses that to obtain the GPIO descriptor to return.
929 *
930 * If the GPIO cannot be translated or there is an error an ERR_PTR is
931 * returned.
932 */
933static struct gpio_desc *acpi_get_gpiod_from_data(struct fwnode_handle *fwnode,
934 const char *propname,
935 int index,
936 struct acpi_gpio_info *info)
937{
938 struct acpi_gpio_lookup lookup;
939 int ret;
940
941 if (!is_acpi_data_node(fwnode))
942 return ERR_PTR(-ENODEV);
943
944 if (!propname)
945 return ERR_PTR(-EINVAL);
946
947 memset(&lookup, 0, sizeof(lookup));
948 lookup.index = index;
949
950 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
951 if (ret)
952 return ERR_PTR(ret);
953
954 ret = acpi_gpio_resource_lookup(&lookup, info);
955 return ret ? ERR_PTR(ret) : lookup.desc;
956}
957
958static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
959 const char *con_id)
960{
961 /* Never allow fallback if the device has properties */
962 if (acpi_dev_has_props(adev) || adev->driver_gpios)
963 return false;
964
965 return con_id == NULL;
966}
967
968struct gpio_desc *acpi_find_gpio(struct fwnode_handle *fwnode,
969 const char *con_id,
970 unsigned int idx,
971 enum gpiod_flags *dflags,
972 unsigned long *lookupflags)
973{
974 struct acpi_device *adev = to_acpi_device_node(fwnode);
975 struct acpi_gpio_info info;
976 struct gpio_desc *desc;
977 char propname[32];
978 int i;
979
980 /* Try first from _DSD */
981 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
982 if (con_id) {
983 snprintf(propname, sizeof(propname), "%s-%s",
984 con_id, gpio_suffixes[i]);
985 } else {
986 snprintf(propname, sizeof(propname), "%s",
987 gpio_suffixes[i]);
988 }
989
990 if (adev)
991 desc = acpi_get_gpiod_by_index(adev,
992 propname, idx, &info);
993 else
994 desc = acpi_get_gpiod_from_data(fwnode,
995 propname, idx, &info);
996 if (!IS_ERR(desc))
997 break;
998 if (PTR_ERR(desc) == -EPROBE_DEFER)
999 return ERR_CAST(desc);
1000 }
1001
1002 /* Then from plain _CRS GPIOs */
1003 if (IS_ERR(desc)) {
1004 if (!adev || !acpi_can_fallback_to_crs(adev, con_id))
1005 return ERR_PTR(-ENOENT);
1006
1007 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
1008 if (IS_ERR(desc))
1009 return desc;
1010 }
1011
1012 if (info.gpioint &&
1013 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
1014 dev_dbg(&adev->dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
1015 return ERR_PTR(-ENOENT);
1016 }
1017
1018 acpi_gpio_update_gpiod_flags(dflags, &info);
1019 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
1020 return desc;
1021}
1022
1023/**
1024 * acpi_dev_gpio_irq_wake_get_by() - Find GpioInt and translate it to Linux IRQ number
1025 * @adev: pointer to a ACPI device to get IRQ from
1026 * @name: optional name of GpioInt resource
1027 * @index: index of GpioInt resource (starting from %0)
1028 * @wake_capable: Set to true if the IRQ is wake capable
1029 *
1030 * If the device has one or more GpioInt resources, this function can be
1031 * used to translate from the GPIO offset in the resource to the Linux IRQ
1032 * number.
1033 *
1034 * The function is idempotent, though each time it runs it will configure GPIO
1035 * pin direction according to the flags in GpioInt resource.
1036 *
1037 * The function takes optional @name parameter. If the resource has a property
1038 * name, then only those will be taken into account.
1039 *
1040 * The GPIO is considered wake capable if the GpioInt resource specifies
1041 * SharedAndWake or ExclusiveAndWake.
1042 *
1043 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
1044 */
1045int acpi_dev_gpio_irq_wake_get_by(struct acpi_device *adev, const char *name, int index,
1046 bool *wake_capable)
1047{
1048 int idx, i;
1049 unsigned int irq_flags;
1050 int ret;
1051
1052 for (i = 0, idx = 0; idx <= index; i++) {
1053 struct acpi_gpio_info info;
1054 struct gpio_desc *desc;
1055
1056 desc = acpi_get_gpiod_by_index(adev, name, i, &info);
1057
1058 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
1059 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
1060 return PTR_ERR(desc);
1061
1062 if (info.gpioint && idx++ == index) {
1063 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1064 enum gpiod_flags dflags = GPIOD_ASIS;
1065 char label[32];
1066 int irq;
1067
1068 if (IS_ERR(desc))
1069 return PTR_ERR(desc);
1070
1071 irq = gpiod_to_irq(desc);
1072 if (irq < 0)
1073 return irq;
1074
1075 acpi_gpio_update_gpiod_flags(&dflags, &info);
1076 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
1077
1078 snprintf(label, sizeof(label), "GpioInt() %d", index);
1079 ret = gpiod_configure_flags(desc, label, lflags, dflags);
1080 if (ret < 0)
1081 return ret;
1082
1083 /* ACPI uses hundredths of milliseconds units */
1084 ret = gpio_set_debounce_timeout(desc, info.debounce * 10);
1085 if (ret)
1086 return ret;
1087
1088 irq_flags = acpi_dev_get_irq_type(info.triggering,
1089 info.polarity);
1090
1091 /*
1092 * If the IRQ is not already in use then set type
1093 * if specified and different than the current one.
1094 */
1095 if (can_request_irq(irq, irq_flags)) {
1096 if (irq_flags != IRQ_TYPE_NONE &&
1097 irq_flags != irq_get_trigger_type(irq))
1098 irq_set_irq_type(irq, irq_flags);
1099 } else {
1100 dev_dbg(&adev->dev, "IRQ %d already in use\n", irq);
1101 }
1102
1103 /* avoid suspend issues with GPIOs when systems are using S3 */
1104 if (wake_capable && acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)
1105 *wake_capable = info.wake_capable;
1106
1107 return irq;
1108 }
1109
1110 }
1111 return -ENOENT;
1112}
1113EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_wake_get_by);
1114
1115static acpi_status
1116acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
1117 u32 bits, u64 *value, void *handler_context,
1118 void *region_context)
1119{
1120 struct acpi_gpio_chip *achip = region_context;
1121 struct gpio_chip *chip = achip->chip;
1122 struct acpi_resource_gpio *agpio;
1123 struct acpi_resource *ares;
1124 u16 pin_index = address;
1125 acpi_status status;
1126 int length;
1127 int i;
1128
1129 status = acpi_buffer_to_resource(achip->conn_info.connection,
1130 achip->conn_info.length, &ares);
1131 if (ACPI_FAILURE(status))
1132 return status;
1133
1134 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
1135 ACPI_FREE(ares);
1136 return AE_BAD_PARAMETER;
1137 }
1138
1139 agpio = &ares->data.gpio;
1140
1141 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
1142 function == ACPI_WRITE)) {
1143 ACPI_FREE(ares);
1144 return AE_BAD_PARAMETER;
1145 }
1146
1147 length = min_t(u16, agpio->pin_table_length, pin_index + bits);
1148 for (i = pin_index; i < length; ++i) {
1149 unsigned int pin = agpio->pin_table[i];
1150 struct acpi_gpio_connection *conn;
1151 struct gpio_desc *desc;
1152 bool found;
1153
1154 mutex_lock(&achip->conn_lock);
1155
1156 found = false;
1157 list_for_each_entry(conn, &achip->conns, node) {
1158 if (conn->pin == pin) {
1159 found = true;
1160 desc = conn->desc;
1161 break;
1162 }
1163 }
1164
1165 /*
1166 * The same GPIO can be shared between operation region and
1167 * event but only if the access here is ACPI_READ. In that
1168 * case we "borrow" the event GPIO instead.
1169 */
1170 if (!found && agpio->shareable == ACPI_SHARED &&
1171 function == ACPI_READ) {
1172 struct acpi_gpio_event *event;
1173
1174 list_for_each_entry(event, &achip->events, node) {
1175 if (event->pin == pin) {
1176 desc = event->desc;
1177 found = true;
1178 break;
1179 }
1180 }
1181 }
1182
1183 if (!found) {
1184 desc = acpi_request_own_gpiod(chip, agpio, i, "ACPI:OpRegion");
1185 if (IS_ERR(desc)) {
1186 mutex_unlock(&achip->conn_lock);
1187 status = AE_ERROR;
1188 goto out;
1189 }
1190
1191 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1192 if (!conn) {
1193 gpiochip_free_own_desc(desc);
1194 mutex_unlock(&achip->conn_lock);
1195 status = AE_NO_MEMORY;
1196 goto out;
1197 }
1198
1199 conn->pin = pin;
1200 conn->desc = desc;
1201 list_add_tail(&conn->node, &achip->conns);
1202 }
1203
1204 mutex_unlock(&achip->conn_lock);
1205
1206 if (function == ACPI_WRITE)
1207 gpiod_set_raw_value_cansleep(desc, !!(*value & BIT(i)));
1208 else
1209 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1210 }
1211
1212out:
1213 ACPI_FREE(ares);
1214 return status;
1215}
1216
1217static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1218{
1219 struct gpio_chip *chip = achip->chip;
1220 acpi_handle handle = ACPI_HANDLE(chip->parent);
1221 acpi_status status;
1222
1223 INIT_LIST_HEAD(&achip->conns);
1224 mutex_init(&achip->conn_lock);
1225 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1226 acpi_gpio_adr_space_handler,
1227 NULL, achip);
1228 if (ACPI_FAILURE(status))
1229 dev_err(chip->parent,
1230 "Failed to install GPIO OpRegion handler\n");
1231}
1232
1233static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1234{
1235 struct gpio_chip *chip = achip->chip;
1236 acpi_handle handle = ACPI_HANDLE(chip->parent);
1237 struct acpi_gpio_connection *conn, *tmp;
1238 acpi_status status;
1239
1240 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1241 acpi_gpio_adr_space_handler);
1242 if (ACPI_FAILURE(status)) {
1243 dev_err(chip->parent,
1244 "Failed to remove GPIO OpRegion handler\n");
1245 return;
1246 }
1247
1248 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1249 gpiochip_free_own_desc(conn->desc);
1250 list_del(&conn->node);
1251 kfree(conn);
1252 }
1253}
1254
1255static struct gpio_desc *
1256acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1257 struct fwnode_handle *fwnode,
1258 const char **name,
1259 unsigned long *lflags,
1260 enum gpiod_flags *dflags)
1261{
1262 struct gpio_chip *chip = achip->chip;
1263 struct gpio_desc *desc;
1264 u32 gpios[2];
1265 int ret;
1266
1267 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1268 *dflags = GPIOD_ASIS;
1269 *name = NULL;
1270
1271 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1272 ARRAY_SIZE(gpios));
1273 if (ret < 0)
1274 return ERR_PTR(ret);
1275
1276 desc = gpiochip_get_desc(chip, gpios[0]);
1277 if (IS_ERR(desc))
1278 return desc;
1279
1280 if (gpios[1])
1281 *lflags |= GPIO_ACTIVE_LOW;
1282
1283 if (fwnode_property_present(fwnode, "input"))
1284 *dflags |= GPIOD_IN;
1285 else if (fwnode_property_present(fwnode, "output-low"))
1286 *dflags |= GPIOD_OUT_LOW;
1287 else if (fwnode_property_present(fwnode, "output-high"))
1288 *dflags |= GPIOD_OUT_HIGH;
1289 else
1290 return ERR_PTR(-EINVAL);
1291
1292 fwnode_property_read_string(fwnode, "line-name", name);
1293
1294 return desc;
1295}
1296
1297static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1298{
1299 struct gpio_chip *chip = achip->chip;
1300 struct fwnode_handle *fwnode;
1301
1302 device_for_each_child_node(chip->parent, fwnode) {
1303 unsigned long lflags;
1304 enum gpiod_flags dflags;
1305 struct gpio_desc *desc;
1306 const char *name;
1307 int ret;
1308
1309 if (!fwnode_property_present(fwnode, "gpio-hog"))
1310 continue;
1311
1312 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1313 &lflags, &dflags);
1314 if (IS_ERR(desc))
1315 continue;
1316
1317 ret = gpiod_hog(desc, name, lflags, dflags);
1318 if (ret) {
1319 dev_err(chip->parent, "Failed to hog GPIO\n");
1320 fwnode_handle_put(fwnode);
1321 return;
1322 }
1323 }
1324}
1325
1326void acpi_gpiochip_add(struct gpio_chip *chip)
1327{
1328 struct acpi_gpio_chip *acpi_gpio;
1329 struct acpi_device *adev;
1330 acpi_status status;
1331
1332 if (!chip || !chip->parent)
1333 return;
1334
1335 adev = ACPI_COMPANION(chip->parent);
1336 if (!adev)
1337 return;
1338
1339 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1340 if (!acpi_gpio) {
1341 dev_err(chip->parent,
1342 "Failed to allocate memory for ACPI GPIO chip\n");
1343 return;
1344 }
1345
1346 acpi_gpio->chip = chip;
1347 INIT_LIST_HEAD(&acpi_gpio->events);
1348 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1349
1350 status = acpi_attach_data(adev->handle, acpi_gpio_chip_dh, acpi_gpio);
1351 if (ACPI_FAILURE(status)) {
1352 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1353 kfree(acpi_gpio);
1354 return;
1355 }
1356
1357 acpi_gpiochip_request_regions(acpi_gpio);
1358 acpi_gpiochip_scan_gpios(acpi_gpio);
1359 acpi_dev_clear_dependencies(adev);
1360}
1361
1362void acpi_gpiochip_remove(struct gpio_chip *chip)
1363{
1364 struct acpi_gpio_chip *acpi_gpio;
1365 acpi_handle handle;
1366 acpi_status status;
1367
1368 if (!chip || !chip->parent)
1369 return;
1370
1371 handle = ACPI_HANDLE(chip->parent);
1372 if (!handle)
1373 return;
1374
1375 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1376 if (ACPI_FAILURE(status)) {
1377 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1378 return;
1379 }
1380
1381 acpi_gpiochip_free_regions(acpi_gpio);
1382
1383 acpi_detach_data(handle, acpi_gpio_chip_dh);
1384 kfree(acpi_gpio);
1385}
1386
1387static int acpi_gpio_package_count(const union acpi_object *obj)
1388{
1389 const union acpi_object *element = obj->package.elements;
1390 const union acpi_object *end = element + obj->package.count;
1391 unsigned int count = 0;
1392
1393 while (element < end) {
1394 switch (element->type) {
1395 case ACPI_TYPE_LOCAL_REFERENCE:
1396 element += 3;
1397 fallthrough;
1398 case ACPI_TYPE_INTEGER:
1399 element++;
1400 count++;
1401 break;
1402
1403 default:
1404 return -EPROTO;
1405 }
1406 }
1407
1408 return count;
1409}
1410
1411static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1412{
1413 unsigned int *count = data;
1414
1415 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1416 *count += ares->data.gpio.pin_table_length;
1417
1418 return 1;
1419}
1420
1421/**
1422 * acpi_gpio_count - count the GPIOs associated with a firmware node / function
1423 * @fwnode: firmware node of the GPIO consumer
1424 * @con_id: function within the GPIO consumer
1425 *
1426 * Return:
1427 * The number of GPIOs associated with a firmware node / function or %-ENOENT,
1428 * if no GPIO has been assigned to the requested function.
1429 */
1430int acpi_gpio_count(const struct fwnode_handle *fwnode, const char *con_id)
1431{
1432 struct acpi_device *adev = to_acpi_device_node(fwnode);
1433 const union acpi_object *obj;
1434 const struct acpi_gpio_mapping *gm;
1435 int count = -ENOENT;
1436 int ret;
1437 char propname[32];
1438 unsigned int i;
1439
1440 /* Try first from _DSD */
1441 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1442 if (con_id)
1443 snprintf(propname, sizeof(propname), "%s-%s",
1444 con_id, gpio_suffixes[i]);
1445 else
1446 snprintf(propname, sizeof(propname), "%s",
1447 gpio_suffixes[i]);
1448
1449 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY, &obj);
1450 if (ret == 0) {
1451 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1452 count = 1;
1453 else if (obj->type == ACPI_TYPE_PACKAGE)
1454 count = acpi_gpio_package_count(obj);
1455 } else if (adev->driver_gpios) {
1456 for (gm = adev->driver_gpios; gm->name; gm++)
1457 if (strcmp(propname, gm->name) == 0) {
1458 count = gm->size;
1459 break;
1460 }
1461 }
1462 if (count > 0)
1463 break;
1464 }
1465
1466 /* Then from plain _CRS GPIOs */
1467 if (count < 0) {
1468 struct list_head resource_list;
1469 unsigned int crs_count = 0;
1470
1471 if (!acpi_can_fallback_to_crs(adev, con_id))
1472 return count;
1473
1474 INIT_LIST_HEAD(&resource_list);
1475 acpi_dev_get_resources(adev, &resource_list,
1476 acpi_find_gpio_count, &crs_count);
1477 acpi_dev_free_resource_list(&resource_list);
1478 if (crs_count > 0)
1479 count = crs_count;
1480 }
1481 return count ? count : -ENOENT;
1482}
1483
1484/* Run deferred acpi_gpiochip_request_irqs() */
1485static int __init acpi_gpio_handle_deferred_request_irqs(void)
1486{
1487 struct acpi_gpio_chip *acpi_gpio, *tmp;
1488
1489 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1490 list_for_each_entry_safe(acpi_gpio, tmp,
1491 &acpi_gpio_deferred_req_irqs_list,
1492 deferred_req_irqs_list_entry)
1493 acpi_gpiochip_request_irqs(acpi_gpio);
1494
1495 acpi_gpio_deferred_req_irqs_done = true;
1496 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1497
1498 return 0;
1499}
1500/* We must use _sync so that this runs after the first deferred_probe run */
1501late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1502
1503static const struct dmi_system_id gpiolib_acpi_quirks[] __initconst = {
1504 {
1505 /*
1506 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1507 * a non existing micro-USB-B connector which puts the HDMI
1508 * DDC pins in GPIO mode, breaking HDMI support.
1509 */
1510 .matches = {
1511 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1512 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1513 },
1514 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1515 .no_edge_events_on_boot = true,
1516 },
1517 },
1518 {
1519 /*
1520 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1521 * instead of controlling the actual micro-USB-B turns the 5V
1522 * boost for its USB-A connector off. The actual micro-USB-B
1523 * connector is wired for charging only.
1524 */
1525 .matches = {
1526 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1527 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1528 },
1529 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1530 .no_edge_events_on_boot = true,
1531 },
1532 },
1533 {
1534 /*
1535 * The Dell Venue 10 Pro 5055, with Bay Trail SoC + TI PMIC uses an
1536 * external embedded-controller connected via I2C + an ACPI GPIO
1537 * event handler on INT33FFC:02 pin 12, causing spurious wakeups.
1538 */
1539 .matches = {
1540 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."),
1541 DMI_MATCH(DMI_PRODUCT_NAME, "Venue 10 Pro 5055"),
1542 },
1543 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1544 .ignore_wake = "INT33FC:02@12",
1545 },
1546 },
1547 {
1548 /*
1549 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1550 * external embedded-controller connected via I2C + an ACPI GPIO
1551 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1552 * When suspending by closing the LID, the power to the USB
1553 * keyboard is turned off, causing INT0002 ACPI events to
1554 * trigger once the XHCI controller notices the keyboard is
1555 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1556 * EC wakes breaks wakeup when opening the lid, the user needs
1557 * to press the power-button to wakeup the system. The
1558 * alternative is suspend simply not working, which is worse.
1559 */
1560 .matches = {
1561 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1562 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1563 },
1564 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1565 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1566 },
1567 },
1568 {
1569 /*
1570 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1571 * external embedded-controller connected via I2C + an ACPI GPIO
1572 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1573 */
1574 .matches = {
1575 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1576 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1577 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1578 },
1579 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1580 .ignore_wake = "INT33FC:02@28",
1581 },
1582 },
1583 {
1584 /*
1585 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1586 * external embedded-controller connected via I2C + an ACPI GPIO
1587 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1588 */
1589 .matches = {
1590 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1591 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1592 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1593 },
1594 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1595 .ignore_wake = "INT33FF:01@0",
1596 },
1597 },
1598 {
1599 /*
1600 * Interrupt storm caused from edge triggered floating pin
1601 * Found in BIOS UX325UAZ.300
1602 * https://bugzilla.kernel.org/show_bug.cgi?id=216208
1603 */
1604 .matches = {
1605 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
1606 DMI_MATCH(DMI_PRODUCT_NAME, "ZenBook UX325UAZ_UM325UAZ"),
1607 },
1608 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1609 .ignore_interrupt = "AMDI0030:00@18",
1610 },
1611 },
1612 {
1613 /*
1614 * Spurious wakeups from TP_ATTN# pin
1615 * Found in BIOS 1.7.8
1616 * https://gitlab.freedesktop.org/drm/amd/-/issues/1722#note_1720627
1617 */
1618 .matches = {
1619 DMI_MATCH(DMI_BOARD_NAME, "NL5xNU"),
1620 },
1621 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1622 .ignore_wake = "ELAN0415:00@9",
1623 },
1624 },
1625 {
1626 /*
1627 * Spurious wakeups from TP_ATTN# pin
1628 * Found in BIOS 1.7.8
1629 * https://gitlab.freedesktop.org/drm/amd/-/issues/1722#note_1720627
1630 */
1631 .matches = {
1632 DMI_MATCH(DMI_BOARD_NAME, "NL5xRU"),
1633 },
1634 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1635 .ignore_wake = "ELAN0415:00@9",
1636 },
1637 },
1638 {
1639 /*
1640 * Spurious wakeups from TP_ATTN# pin
1641 * Found in BIOS 1.7.7
1642 */
1643 .matches = {
1644 DMI_MATCH(DMI_BOARD_NAME, "NH5xAx"),
1645 },
1646 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1647 .ignore_wake = "SYNA1202:00@16",
1648 },
1649 },
1650 {
1651 /*
1652 * On the Peaq C1010 2-in-1 INT33FC:00 pin 3 is connected to
1653 * a "dolby" button. At the ACPI level an _AEI event-handler
1654 * is connected which sets an ACPI variable to 1 on both
1655 * edges. This variable can be polled + cleared to 0 using
1656 * WMI. But since the variable is set on both edges the WMI
1657 * interface is pretty useless even when polling.
1658 * So instead the x86-android-tablets code instantiates
1659 * a gpio-keys platform device for it.
1660 * Ignore the _AEI handler for the pin, so that it is not busy.
1661 */
1662 .matches = {
1663 DMI_MATCH(DMI_SYS_VENDOR, "PEAQ"),
1664 DMI_MATCH(DMI_PRODUCT_NAME, "PEAQ PMM C1010 MD99187"),
1665 },
1666 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1667 .ignore_interrupt = "INT33FC:00@3",
1668 },
1669 },
1670 {
1671 /*
1672 * Spurious wakeups from TP_ATTN# pin
1673 * Found in BIOS 0.35
1674 * https://gitlab.freedesktop.org/drm/amd/-/issues/3073
1675 */
1676 .matches = {
1677 DMI_MATCH(DMI_SYS_VENDOR, "GPD"),
1678 DMI_MATCH(DMI_PRODUCT_NAME, "G1619-04"),
1679 },
1680 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1681 .ignore_wake = "PNP0C50:00@8",
1682 },
1683 },
1684 {} /* Terminating entry */
1685};
1686
1687static int __init acpi_gpio_setup_params(void)
1688{
1689 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1690 const struct dmi_system_id *id;
1691
1692 id = dmi_first_match(gpiolib_acpi_quirks);
1693 if (id)
1694 quirk = id->driver_data;
1695
1696 if (run_edge_events_on_boot < 0) {
1697 if (quirk && quirk->no_edge_events_on_boot)
1698 run_edge_events_on_boot = 0;
1699 else
1700 run_edge_events_on_boot = 1;
1701 }
1702
1703 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1704 ignore_wake = quirk->ignore_wake;
1705
1706 if (ignore_interrupt == NULL && quirk && quirk->ignore_interrupt)
1707 ignore_interrupt = quirk->ignore_interrupt;
1708
1709 return 0;
1710}
1711
1712/* Directly after dmi_setup() which runs as core_initcall() */
1713postcore_initcall(acpi_gpio_setup_params);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * ACPI helpers for GPIO API
4 *
5 * Copyright (C) 2012, Intel Corporation
6 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
7 * Mika Westerberg <mika.westerberg@linux.intel.com>
8 */
9
10#include <linux/dmi.h>
11#include <linux/errno.h>
12#include <linux/gpio/consumer.h>
13#include <linux/gpio/driver.h>
14#include <linux/gpio/machine.h>
15#include <linux/export.h>
16#include <linux/acpi.h>
17#include <linux/interrupt.h>
18#include <linux/mutex.h>
19#include <linux/pinctrl/pinctrl.h>
20
21#include "gpiolib.h"
22#include "gpiolib-acpi.h"
23
24static int run_edge_events_on_boot = -1;
25module_param(run_edge_events_on_boot, int, 0444);
26MODULE_PARM_DESC(run_edge_events_on_boot,
27 "Run edge _AEI event-handlers at boot: 0=no, 1=yes, -1=auto");
28
29static char *ignore_wake;
30module_param(ignore_wake, charp, 0444);
31MODULE_PARM_DESC(ignore_wake,
32 "controller@pin combos on which to ignore the ACPI wake flag "
33 "ignore_wake=controller@pin[,controller@pin[,...]]");
34
35struct acpi_gpiolib_dmi_quirk {
36 bool no_edge_events_on_boot;
37 char *ignore_wake;
38};
39
40/**
41 * struct acpi_gpio_event - ACPI GPIO event handler data
42 *
43 * @node: list-entry of the events list of the struct acpi_gpio_chip
44 * @handle: handle of ACPI method to execute when the IRQ triggers
45 * @handler: handler function to pass to request_irq() when requesting the IRQ
46 * @pin: GPIO pin number on the struct gpio_chip
47 * @irq: Linux IRQ number for the event, for request_irq() / free_irq()
48 * @irqflags: flags to pass to request_irq() when requesting the IRQ
49 * @irq_is_wake: If the ACPI flags indicate the IRQ is a wakeup source
50 * @irq_requested:True if request_irq() has been done
51 * @desc: struct gpio_desc for the GPIO pin for this event
52 */
53struct acpi_gpio_event {
54 struct list_head node;
55 acpi_handle handle;
56 irq_handler_t handler;
57 unsigned int pin;
58 unsigned int irq;
59 unsigned long irqflags;
60 bool irq_is_wake;
61 bool irq_requested;
62 struct gpio_desc *desc;
63};
64
65struct acpi_gpio_connection {
66 struct list_head node;
67 unsigned int pin;
68 struct gpio_desc *desc;
69};
70
71struct acpi_gpio_chip {
72 /*
73 * ACPICA requires that the first field of the context parameter
74 * passed to acpi_install_address_space_handler() is large enough
75 * to hold struct acpi_connection_info.
76 */
77 struct acpi_connection_info conn_info;
78 struct list_head conns;
79 struct mutex conn_lock;
80 struct gpio_chip *chip;
81 struct list_head events;
82 struct list_head deferred_req_irqs_list_entry;
83};
84
85/*
86 * For GPIO chips which call acpi_gpiochip_request_interrupts() before late_init
87 * (so builtin drivers) we register the ACPI GpioInt IRQ handlers from a
88 * late_initcall_sync() handler, so that other builtin drivers can register their
89 * OpRegions before the event handlers can run. This list contains GPIO chips
90 * for which the acpi_gpiochip_request_irqs() call has been deferred.
91 */
92static DEFINE_MUTEX(acpi_gpio_deferred_req_irqs_lock);
93static LIST_HEAD(acpi_gpio_deferred_req_irqs_list);
94static bool acpi_gpio_deferred_req_irqs_done;
95
96static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
97{
98 if (!gc->parent)
99 return false;
100
101 return ACPI_HANDLE(gc->parent) == data;
102}
103
104/**
105 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
106 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
107 * @pin: ACPI GPIO pin number (0-based, controller-relative)
108 *
109 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
110 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
111 * controller does not have GPIO chip registered at the moment. This is to
112 * support probe deferral.
113 */
114static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
115{
116 struct gpio_chip *chip;
117 acpi_handle handle;
118 acpi_status status;
119
120 status = acpi_get_handle(NULL, path, &handle);
121 if (ACPI_FAILURE(status))
122 return ERR_PTR(-ENODEV);
123
124 chip = gpiochip_find(handle, acpi_gpiochip_find);
125 if (!chip)
126 return ERR_PTR(-EPROBE_DEFER);
127
128 return gpiochip_get_desc(chip, pin);
129}
130
131static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
132{
133 struct acpi_gpio_event *event = data;
134
135 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
136
137 return IRQ_HANDLED;
138}
139
140static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
141{
142 struct acpi_gpio_event *event = data;
143
144 acpi_execute_simple_method(event->handle, NULL, event->pin);
145
146 return IRQ_HANDLED;
147}
148
149static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
150{
151 /* The address of this function is used as a key. */
152}
153
154bool acpi_gpio_get_irq_resource(struct acpi_resource *ares,
155 struct acpi_resource_gpio **agpio)
156{
157 struct acpi_resource_gpio *gpio;
158
159 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
160 return false;
161
162 gpio = &ares->data.gpio;
163 if (gpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
164 return false;
165
166 *agpio = gpio;
167 return true;
168}
169EXPORT_SYMBOL_GPL(acpi_gpio_get_irq_resource);
170
171static void acpi_gpiochip_request_irq(struct acpi_gpio_chip *acpi_gpio,
172 struct acpi_gpio_event *event)
173{
174 int ret, value;
175
176 ret = request_threaded_irq(event->irq, NULL, event->handler,
177 event->irqflags, "ACPI:Event", event);
178 if (ret) {
179 dev_err(acpi_gpio->chip->parent,
180 "Failed to setup interrupt handler for %d\n",
181 event->irq);
182 return;
183 }
184
185 if (event->irq_is_wake)
186 enable_irq_wake(event->irq);
187
188 event->irq_requested = true;
189
190 /* Make sure we trigger the initial state of edge-triggered IRQs */
191 if (run_edge_events_on_boot &&
192 (event->irqflags & (IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING))) {
193 value = gpiod_get_raw_value_cansleep(event->desc);
194 if (((event->irqflags & IRQF_TRIGGER_RISING) && value == 1) ||
195 ((event->irqflags & IRQF_TRIGGER_FALLING) && value == 0))
196 event->handler(event->irq, event);
197 }
198}
199
200static void acpi_gpiochip_request_irqs(struct acpi_gpio_chip *acpi_gpio)
201{
202 struct acpi_gpio_event *event;
203
204 list_for_each_entry(event, &acpi_gpio->events, node)
205 acpi_gpiochip_request_irq(acpi_gpio, event);
206}
207
208static bool acpi_gpio_in_ignore_list(const char *controller_in, int pin_in)
209{
210 const char *controller, *pin_str;
211 int len, pin;
212 char *endp;
213
214 controller = ignore_wake;
215 while (controller) {
216 pin_str = strchr(controller, '@');
217 if (!pin_str)
218 goto err;
219
220 len = pin_str - controller;
221 if (len == strlen(controller_in) &&
222 strncmp(controller, controller_in, len) == 0) {
223 pin = simple_strtoul(pin_str + 1, &endp, 10);
224 if (*endp != 0 && *endp != ',')
225 goto err;
226
227 if (pin == pin_in)
228 return true;
229 }
230
231 controller = strchr(controller, ',');
232 if (controller)
233 controller++;
234 }
235
236 return false;
237err:
238 pr_err_once("Error invalid value for gpiolib_acpi.ignore_wake: %s\n",
239 ignore_wake);
240 return false;
241}
242
243static bool acpi_gpio_irq_is_wake(struct device *parent,
244 struct acpi_resource_gpio *agpio)
245{
246 int pin = agpio->pin_table[0];
247
248 if (agpio->wake_capable != ACPI_WAKE_CAPABLE)
249 return false;
250
251 if (acpi_gpio_in_ignore_list(dev_name(parent), pin)) {
252 dev_info(parent, "Ignoring wakeup on pin %d\n", pin);
253 return false;
254 }
255
256 return true;
257}
258
259/* Always returns AE_OK so that we keep looping over the resources */
260static acpi_status acpi_gpiochip_alloc_event(struct acpi_resource *ares,
261 void *context)
262{
263 struct acpi_gpio_chip *acpi_gpio = context;
264 struct gpio_chip *chip = acpi_gpio->chip;
265 struct acpi_resource_gpio *agpio;
266 acpi_handle handle, evt_handle;
267 struct acpi_gpio_event *event;
268 irq_handler_t handler = NULL;
269 struct gpio_desc *desc;
270 int ret, pin, irq;
271
272 if (!acpi_gpio_get_irq_resource(ares, &agpio))
273 return AE_OK;
274
275 handle = ACPI_HANDLE(chip->parent);
276 pin = agpio->pin_table[0];
277
278 if (pin <= 255) {
279 char ev_name[5];
280 sprintf(ev_name, "_%c%02hhX",
281 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
282 pin);
283 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
284 handler = acpi_gpio_irq_handler;
285 }
286 if (!handler) {
287 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
288 handler = acpi_gpio_irq_handler_evt;
289 }
290 if (!handler)
291 return AE_OK;
292
293 desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event",
294 GPIO_ACTIVE_HIGH, GPIOD_IN);
295 if (IS_ERR(desc)) {
296 dev_err(chip->parent,
297 "Failed to request GPIO for pin 0x%04X, err %ld\n",
298 pin, PTR_ERR(desc));
299 return AE_OK;
300 }
301
302 ret = gpiochip_lock_as_irq(chip, pin);
303 if (ret) {
304 dev_err(chip->parent,
305 "Failed to lock GPIO pin 0x%04X as interrupt, err %d\n",
306 pin, ret);
307 goto fail_free_desc;
308 }
309
310 irq = gpiod_to_irq(desc);
311 if (irq < 0) {
312 dev_err(chip->parent,
313 "Failed to translate GPIO pin 0x%04X to IRQ, err %d\n",
314 pin, irq);
315 goto fail_unlock_irq;
316 }
317
318 event = kzalloc(sizeof(*event), GFP_KERNEL);
319 if (!event)
320 goto fail_unlock_irq;
321
322 event->irqflags = IRQF_ONESHOT;
323 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
324 if (agpio->polarity == ACPI_ACTIVE_HIGH)
325 event->irqflags |= IRQF_TRIGGER_HIGH;
326 else
327 event->irqflags |= IRQF_TRIGGER_LOW;
328 } else {
329 switch (agpio->polarity) {
330 case ACPI_ACTIVE_HIGH:
331 event->irqflags |= IRQF_TRIGGER_RISING;
332 break;
333 case ACPI_ACTIVE_LOW:
334 event->irqflags |= IRQF_TRIGGER_FALLING;
335 break;
336 default:
337 event->irqflags |= IRQF_TRIGGER_RISING |
338 IRQF_TRIGGER_FALLING;
339 break;
340 }
341 }
342
343 event->handle = evt_handle;
344 event->handler = handler;
345 event->irq = irq;
346 event->irq_is_wake = acpi_gpio_irq_is_wake(chip->parent, agpio);
347 event->pin = pin;
348 event->desc = desc;
349
350 list_add_tail(&event->node, &acpi_gpio->events);
351
352 return AE_OK;
353
354fail_unlock_irq:
355 gpiochip_unlock_as_irq(chip, pin);
356fail_free_desc:
357 gpiochip_free_own_desc(desc);
358
359 return AE_OK;
360}
361
362/**
363 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
364 * @chip: GPIO chip
365 *
366 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
367 * handled by ACPI event methods which need to be called from the GPIO
368 * chip's interrupt handler. acpi_gpiochip_request_interrupts() finds out which
369 * GPIO pins have ACPI event methods and assigns interrupt handlers that calls
370 * the ACPI event methods for those pins.
371 */
372void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
373{
374 struct acpi_gpio_chip *acpi_gpio;
375 acpi_handle handle;
376 acpi_status status;
377 bool defer;
378
379 if (!chip->parent || !chip->to_irq)
380 return;
381
382 handle = ACPI_HANDLE(chip->parent);
383 if (!handle)
384 return;
385
386 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
387 if (ACPI_FAILURE(status))
388 return;
389
390 acpi_walk_resources(handle, "_AEI",
391 acpi_gpiochip_alloc_event, acpi_gpio);
392
393 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
394 defer = !acpi_gpio_deferred_req_irqs_done;
395 if (defer)
396 list_add(&acpi_gpio->deferred_req_irqs_list_entry,
397 &acpi_gpio_deferred_req_irqs_list);
398 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
399
400 if (defer)
401 return;
402
403 acpi_gpiochip_request_irqs(acpi_gpio);
404}
405EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
406
407/**
408 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
409 * @chip: GPIO chip
410 *
411 * Free interrupts associated with GPIO ACPI event method for the given
412 * GPIO chip.
413 */
414void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
415{
416 struct acpi_gpio_chip *acpi_gpio;
417 struct acpi_gpio_event *event, *ep;
418 acpi_handle handle;
419 acpi_status status;
420
421 if (!chip->parent || !chip->to_irq)
422 return;
423
424 handle = ACPI_HANDLE(chip->parent);
425 if (!handle)
426 return;
427
428 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
429 if (ACPI_FAILURE(status))
430 return;
431
432 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
433 if (!list_empty(&acpi_gpio->deferred_req_irqs_list_entry))
434 list_del_init(&acpi_gpio->deferred_req_irqs_list_entry);
435 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
436
437 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
438 if (event->irq_requested) {
439 if (event->irq_is_wake)
440 disable_irq_wake(event->irq);
441
442 free_irq(event->irq, event);
443 }
444
445 gpiochip_unlock_as_irq(chip, event->pin);
446 gpiochip_free_own_desc(event->desc);
447 list_del(&event->node);
448 kfree(event);
449 }
450}
451EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
452
453int acpi_dev_add_driver_gpios(struct acpi_device *adev,
454 const struct acpi_gpio_mapping *gpios)
455{
456 if (adev && gpios) {
457 adev->driver_gpios = gpios;
458 return 0;
459 }
460 return -EINVAL;
461}
462EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
463
464void acpi_dev_remove_driver_gpios(struct acpi_device *adev)
465{
466 if (adev)
467 adev->driver_gpios = NULL;
468}
469EXPORT_SYMBOL_GPL(acpi_dev_remove_driver_gpios);
470
471static void devm_acpi_dev_release_driver_gpios(struct device *dev, void *res)
472{
473 acpi_dev_remove_driver_gpios(ACPI_COMPANION(dev));
474}
475
476int devm_acpi_dev_add_driver_gpios(struct device *dev,
477 const struct acpi_gpio_mapping *gpios)
478{
479 void *res;
480 int ret;
481
482 res = devres_alloc(devm_acpi_dev_release_driver_gpios, 0, GFP_KERNEL);
483 if (!res)
484 return -ENOMEM;
485
486 ret = acpi_dev_add_driver_gpios(ACPI_COMPANION(dev), gpios);
487 if (ret) {
488 devres_free(res);
489 return ret;
490 }
491 devres_add(dev, res);
492 return 0;
493}
494EXPORT_SYMBOL_GPL(devm_acpi_dev_add_driver_gpios);
495
496void devm_acpi_dev_remove_driver_gpios(struct device *dev)
497{
498 WARN_ON(devres_release(dev, devm_acpi_dev_release_driver_gpios, NULL, NULL));
499}
500EXPORT_SYMBOL_GPL(devm_acpi_dev_remove_driver_gpios);
501
502static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
503 const char *name, int index,
504 struct fwnode_reference_args *args,
505 unsigned int *quirks)
506{
507 const struct acpi_gpio_mapping *gm;
508
509 if (!adev->driver_gpios)
510 return false;
511
512 for (gm = adev->driver_gpios; gm->name; gm++)
513 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
514 const struct acpi_gpio_params *par = gm->data + index;
515
516 args->fwnode = acpi_fwnode_handle(adev);
517 args->args[0] = par->crs_entry_index;
518 args->args[1] = par->line_index;
519 args->args[2] = par->active_low;
520 args->nargs = 3;
521
522 *quirks = gm->quirks;
523 return true;
524 }
525
526 return false;
527}
528
529static enum gpiod_flags
530acpi_gpio_to_gpiod_flags(const struct acpi_resource_gpio *agpio)
531{
532 switch (agpio->io_restriction) {
533 case ACPI_IO_RESTRICT_INPUT:
534 return GPIOD_IN;
535 case ACPI_IO_RESTRICT_OUTPUT:
536 /*
537 * ACPI GPIO resources don't contain an initial value for the
538 * GPIO. Therefore we deduce that value from the pull field
539 * instead. If the pin is pulled up we assume default to be
540 * high, if it is pulled down we assume default to be low,
541 * otherwise we leave pin untouched.
542 */
543 switch (agpio->pin_config) {
544 case ACPI_PIN_CONFIG_PULLUP:
545 return GPIOD_OUT_HIGH;
546 case ACPI_PIN_CONFIG_PULLDOWN:
547 return GPIOD_OUT_LOW;
548 default:
549 break;
550 }
551 default:
552 break;
553 }
554
555 /*
556 * Assume that the BIOS has configured the direction and pull
557 * accordingly.
558 */
559 return GPIOD_ASIS;
560}
561
562static int
563__acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, enum gpiod_flags update)
564{
565 const enum gpiod_flags mask =
566 GPIOD_FLAGS_BIT_DIR_SET | GPIOD_FLAGS_BIT_DIR_OUT |
567 GPIOD_FLAGS_BIT_DIR_VAL;
568 int ret = 0;
569
570 /*
571 * Check if the BIOS has IoRestriction with explicitly set direction
572 * and update @flags accordingly. Otherwise use whatever caller asked
573 * for.
574 */
575 if (update & GPIOD_FLAGS_BIT_DIR_SET) {
576 enum gpiod_flags diff = *flags ^ update;
577
578 /*
579 * Check if caller supplied incompatible GPIO initialization
580 * flags.
581 *
582 * Return %-EINVAL to notify that firmware has different
583 * settings and we are going to use them.
584 */
585 if (((*flags & GPIOD_FLAGS_BIT_DIR_SET) && (diff & GPIOD_FLAGS_BIT_DIR_OUT)) ||
586 ((*flags & GPIOD_FLAGS_BIT_DIR_OUT) && (diff & GPIOD_FLAGS_BIT_DIR_VAL)))
587 ret = -EINVAL;
588 *flags = (*flags & ~mask) | (update & mask);
589 }
590 return ret;
591}
592
593int
594acpi_gpio_update_gpiod_flags(enum gpiod_flags *flags, struct acpi_gpio_info *info)
595{
596 struct device *dev = &info->adev->dev;
597 enum gpiod_flags old = *flags;
598 int ret;
599
600 ret = __acpi_gpio_update_gpiod_flags(&old, info->flags);
601 if (info->quirks & ACPI_GPIO_QUIRK_NO_IO_RESTRICTION) {
602 if (ret)
603 dev_warn(dev, FW_BUG "GPIO not in correct mode, fixing\n");
604 } else {
605 if (ret)
606 dev_dbg(dev, "Override GPIO initialization flags\n");
607 *flags = old;
608 }
609
610 return ret;
611}
612
613int acpi_gpio_update_gpiod_lookup_flags(unsigned long *lookupflags,
614 struct acpi_gpio_info *info)
615{
616 switch (info->pin_config) {
617 case ACPI_PIN_CONFIG_PULLUP:
618 *lookupflags |= GPIO_PULL_UP;
619 break;
620 case ACPI_PIN_CONFIG_PULLDOWN:
621 *lookupflags |= GPIO_PULL_DOWN;
622 break;
623 default:
624 break;
625 }
626
627 if (info->polarity == GPIO_ACTIVE_LOW)
628 *lookupflags |= GPIO_ACTIVE_LOW;
629
630 return 0;
631}
632
633struct acpi_gpio_lookup {
634 struct acpi_gpio_info info;
635 int index;
636 int pin_index;
637 bool active_low;
638 struct gpio_desc *desc;
639 int n;
640};
641
642static int acpi_populate_gpio_lookup(struct acpi_resource *ares, void *data)
643{
644 struct acpi_gpio_lookup *lookup = data;
645
646 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
647 return 1;
648
649 if (!lookup->desc) {
650 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
651 bool gpioint = agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
652 int pin_index;
653
654 if (lookup->info.quirks & ACPI_GPIO_QUIRK_ONLY_GPIOIO && gpioint)
655 lookup->index++;
656
657 if (lookup->n++ != lookup->index)
658 return 1;
659
660 pin_index = lookup->pin_index;
661 if (pin_index >= agpio->pin_table_length)
662 return 1;
663
664 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
665 agpio->pin_table[pin_index]);
666 lookup->info.pin_config = agpio->pin_config;
667 lookup->info.gpioint = gpioint;
668
669 /*
670 * Polarity and triggering are only specified for GpioInt
671 * resource.
672 * Note: we expect here:
673 * - ACPI_ACTIVE_LOW == GPIO_ACTIVE_LOW
674 * - ACPI_ACTIVE_HIGH == GPIO_ACTIVE_HIGH
675 */
676 if (lookup->info.gpioint) {
677 lookup->info.flags = GPIOD_IN;
678 lookup->info.polarity = agpio->polarity;
679 lookup->info.triggering = agpio->triggering;
680 } else {
681 lookup->info.flags = acpi_gpio_to_gpiod_flags(agpio);
682 lookup->info.polarity = lookup->active_low;
683 }
684 }
685
686 return 1;
687}
688
689static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
690 struct acpi_gpio_info *info)
691{
692 struct acpi_device *adev = lookup->info.adev;
693 struct list_head res_list;
694 int ret;
695
696 INIT_LIST_HEAD(&res_list);
697
698 ret = acpi_dev_get_resources(adev, &res_list,
699 acpi_populate_gpio_lookup,
700 lookup);
701 if (ret < 0)
702 return ret;
703
704 acpi_dev_free_resource_list(&res_list);
705
706 if (!lookup->desc)
707 return -ENOENT;
708
709 if (info)
710 *info = lookup->info;
711 return 0;
712}
713
714static int acpi_gpio_property_lookup(struct fwnode_handle *fwnode,
715 const char *propname, int index,
716 struct acpi_gpio_lookup *lookup)
717{
718 struct fwnode_reference_args args;
719 unsigned int quirks = 0;
720 int ret;
721
722 memset(&args, 0, sizeof(args));
723 ret = __acpi_node_get_property_reference(fwnode, propname, index, 3,
724 &args);
725 if (ret) {
726 struct acpi_device *adev = to_acpi_device_node(fwnode);
727
728 if (!adev)
729 return ret;
730
731 if (!acpi_get_driver_gpio_data(adev, propname, index, &args,
732 &quirks))
733 return ret;
734 }
735 /*
736 * The property was found and resolved, so need to lookup the GPIO based
737 * on returned args.
738 */
739 if (!to_acpi_device_node(args.fwnode))
740 return -EINVAL;
741 if (args.nargs != 3)
742 return -EPROTO;
743
744 lookup->index = args.args[0];
745 lookup->pin_index = args.args[1];
746 lookup->active_low = !!args.args[2];
747
748 lookup->info.adev = to_acpi_device_node(args.fwnode);
749 lookup->info.quirks = quirks;
750
751 return 0;
752}
753
754/**
755 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
756 * @adev: pointer to a ACPI device to get GPIO from
757 * @propname: Property name of the GPIO (optional)
758 * @index: index of GpioIo/GpioInt resource (starting from %0)
759 * @info: info pointer to fill in (optional)
760 *
761 * Function goes through ACPI resources for @adev and based on @index looks
762 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
763 * and returns it. @index matches GpioIo/GpioInt resources only so if there
764 * are total %3 GPIO resources, the index goes from %0 to %2.
765 *
766 * If @propname is specified the GPIO is looked using device property. In
767 * that case @index is used to select the GPIO entry in the property value
768 * (in case of multiple).
769 *
770 * If the GPIO cannot be translated or there is an error, an ERR_PTR is
771 * returned.
772 *
773 * Note: if the GPIO resource has multiple entries in the pin list, this
774 * function only returns the first.
775 */
776static struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
777 const char *propname, int index,
778 struct acpi_gpio_info *info)
779{
780 struct acpi_gpio_lookup lookup;
781 int ret;
782
783 if (!adev)
784 return ERR_PTR(-ENODEV);
785
786 memset(&lookup, 0, sizeof(lookup));
787 lookup.index = index;
788
789 if (propname) {
790 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
791
792 ret = acpi_gpio_property_lookup(acpi_fwnode_handle(adev),
793 propname, index, &lookup);
794 if (ret)
795 return ERR_PTR(ret);
796
797 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
798 dev_name(&lookup.info.adev->dev), lookup.index,
799 lookup.pin_index, lookup.active_low);
800 } else {
801 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
802 lookup.info.adev = adev;
803 }
804
805 ret = acpi_gpio_resource_lookup(&lookup, info);
806 return ret ? ERR_PTR(ret) : lookup.desc;
807}
808
809static bool acpi_can_fallback_to_crs(struct acpi_device *adev,
810 const char *con_id)
811{
812 /* Never allow fallback if the device has properties */
813 if (acpi_dev_has_props(adev) || adev->driver_gpios)
814 return false;
815
816 return con_id == NULL;
817}
818
819struct gpio_desc *acpi_find_gpio(struct device *dev,
820 const char *con_id,
821 unsigned int idx,
822 enum gpiod_flags *dflags,
823 unsigned long *lookupflags)
824{
825 struct acpi_device *adev = ACPI_COMPANION(dev);
826 struct acpi_gpio_info info;
827 struct gpio_desc *desc;
828 char propname[32];
829 int i;
830
831 /* Try first from _DSD */
832 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
833 if (con_id) {
834 snprintf(propname, sizeof(propname), "%s-%s",
835 con_id, gpio_suffixes[i]);
836 } else {
837 snprintf(propname, sizeof(propname), "%s",
838 gpio_suffixes[i]);
839 }
840
841 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
842 if (!IS_ERR(desc))
843 break;
844 if (PTR_ERR(desc) == -EPROBE_DEFER)
845 return ERR_CAST(desc);
846 }
847
848 /* Then from plain _CRS GPIOs */
849 if (IS_ERR(desc)) {
850 if (!acpi_can_fallback_to_crs(adev, con_id))
851 return ERR_PTR(-ENOENT);
852
853 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
854 if (IS_ERR(desc))
855 return desc;
856 }
857
858 if (info.gpioint &&
859 (*dflags == GPIOD_OUT_LOW || *dflags == GPIOD_OUT_HIGH)) {
860 dev_dbg(dev, "refusing GpioInt() entry when doing GPIOD_OUT_* lookup\n");
861 return ERR_PTR(-ENOENT);
862 }
863
864 acpi_gpio_update_gpiod_flags(dflags, &info);
865 acpi_gpio_update_gpiod_lookup_flags(lookupflags, &info);
866 return desc;
867}
868
869/**
870 * acpi_node_get_gpiod() - get a GPIO descriptor from ACPI resources
871 * @fwnode: pointer to an ACPI firmware node to get the GPIO information from
872 * @propname: Property name of the GPIO
873 * @index: index of GpioIo/GpioInt resource (starting from %0)
874 * @info: info pointer to fill in (optional)
875 *
876 * If @fwnode is an ACPI device object, call acpi_get_gpiod_by_index() for it.
877 * Otherwise (i.e. it is a data-only non-device object), use the property-based
878 * GPIO lookup to get to the GPIO resource with the relevant information and use
879 * that to obtain the GPIO descriptor to return.
880 *
881 * If the GPIO cannot be translated or there is an error an ERR_PTR is
882 * returned.
883 */
884struct gpio_desc *acpi_node_get_gpiod(struct fwnode_handle *fwnode,
885 const char *propname, int index,
886 struct acpi_gpio_info *info)
887{
888 struct acpi_gpio_lookup lookup;
889 struct acpi_device *adev;
890 int ret;
891
892 adev = to_acpi_device_node(fwnode);
893 if (adev)
894 return acpi_get_gpiod_by_index(adev, propname, index, info);
895
896 if (!is_acpi_data_node(fwnode))
897 return ERR_PTR(-ENODEV);
898
899 if (!propname)
900 return ERR_PTR(-EINVAL);
901
902 memset(&lookup, 0, sizeof(lookup));
903 lookup.index = index;
904
905 ret = acpi_gpio_property_lookup(fwnode, propname, index, &lookup);
906 if (ret)
907 return ERR_PTR(ret);
908
909 ret = acpi_gpio_resource_lookup(&lookup, info);
910 return ret ? ERR_PTR(ret) : lookup.desc;
911}
912
913/**
914 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
915 * @adev: pointer to a ACPI device to get IRQ from
916 * @index: index of GpioInt resource (starting from %0)
917 *
918 * If the device has one or more GpioInt resources, this function can be
919 * used to translate from the GPIO offset in the resource to the Linux IRQ
920 * number.
921 *
922 * The function is idempotent, though each time it runs it will configure GPIO
923 * pin direction according to the flags in GpioInt resource.
924 *
925 * Return: Linux IRQ number (> %0) on success, negative errno on failure.
926 */
927int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
928{
929 int idx, i;
930 unsigned int irq_flags;
931 int ret;
932
933 for (i = 0, idx = 0; idx <= index; i++) {
934 struct acpi_gpio_info info;
935 struct gpio_desc *desc;
936
937 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
938
939 /* Ignore -EPROBE_DEFER, it only matters if idx matches */
940 if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
941 return PTR_ERR(desc);
942
943 if (info.gpioint && idx++ == index) {
944 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
945 char label[32];
946 int irq;
947
948 if (IS_ERR(desc))
949 return PTR_ERR(desc);
950
951 irq = gpiod_to_irq(desc);
952 if (irq < 0)
953 return irq;
954
955 snprintf(label, sizeof(label), "GpioInt() %d", index);
956 ret = gpiod_configure_flags(desc, label, lflags, info.flags);
957 if (ret < 0)
958 return ret;
959
960 irq_flags = acpi_dev_get_irq_type(info.triggering,
961 info.polarity);
962
963 /* Set type if specified and different than the current one */
964 if (irq_flags != IRQ_TYPE_NONE &&
965 irq_flags != irq_get_trigger_type(irq))
966 irq_set_irq_type(irq, irq_flags);
967
968 return irq;
969 }
970
971 }
972 return -ENOENT;
973}
974EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
975
976static acpi_status
977acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
978 u32 bits, u64 *value, void *handler_context,
979 void *region_context)
980{
981 struct acpi_gpio_chip *achip = region_context;
982 struct gpio_chip *chip = achip->chip;
983 struct acpi_resource_gpio *agpio;
984 struct acpi_resource *ares;
985 int pin_index = (int)address;
986 acpi_status status;
987 int length;
988 int i;
989
990 status = acpi_buffer_to_resource(achip->conn_info.connection,
991 achip->conn_info.length, &ares);
992 if (ACPI_FAILURE(status))
993 return status;
994
995 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
996 ACPI_FREE(ares);
997 return AE_BAD_PARAMETER;
998 }
999
1000 agpio = &ares->data.gpio;
1001
1002 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
1003 function == ACPI_WRITE)) {
1004 ACPI_FREE(ares);
1005 return AE_BAD_PARAMETER;
1006 }
1007
1008 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
1009 for (i = pin_index; i < length; ++i) {
1010 int pin = agpio->pin_table[i];
1011 struct acpi_gpio_connection *conn;
1012 struct gpio_desc *desc;
1013 bool found;
1014
1015 mutex_lock(&achip->conn_lock);
1016
1017 found = false;
1018 list_for_each_entry(conn, &achip->conns, node) {
1019 if (conn->pin == pin) {
1020 found = true;
1021 desc = conn->desc;
1022 break;
1023 }
1024 }
1025
1026 /*
1027 * The same GPIO can be shared between operation region and
1028 * event but only if the access here is ACPI_READ. In that
1029 * case we "borrow" the event GPIO instead.
1030 */
1031 if (!found && agpio->shareable == ACPI_SHARED &&
1032 function == ACPI_READ) {
1033 struct acpi_gpio_event *event;
1034
1035 list_for_each_entry(event, &achip->events, node) {
1036 if (event->pin == pin) {
1037 desc = event->desc;
1038 found = true;
1039 break;
1040 }
1041 }
1042 }
1043
1044 if (!found) {
1045 enum gpiod_flags flags = acpi_gpio_to_gpiod_flags(agpio);
1046 const char *label = "ACPI:OpRegion";
1047
1048 desc = gpiochip_request_own_desc(chip, pin, label,
1049 GPIO_ACTIVE_HIGH,
1050 flags);
1051 if (IS_ERR(desc)) {
1052 status = AE_ERROR;
1053 mutex_unlock(&achip->conn_lock);
1054 goto out;
1055 }
1056
1057 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
1058 if (!conn) {
1059 status = AE_NO_MEMORY;
1060 gpiochip_free_own_desc(desc);
1061 mutex_unlock(&achip->conn_lock);
1062 goto out;
1063 }
1064
1065 conn->pin = pin;
1066 conn->desc = desc;
1067 list_add_tail(&conn->node, &achip->conns);
1068 }
1069
1070 mutex_unlock(&achip->conn_lock);
1071
1072 if (function == ACPI_WRITE)
1073 gpiod_set_raw_value_cansleep(desc,
1074 !!((1 << i) & *value));
1075 else
1076 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
1077 }
1078
1079out:
1080 ACPI_FREE(ares);
1081 return status;
1082}
1083
1084static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
1085{
1086 struct gpio_chip *chip = achip->chip;
1087 acpi_handle handle = ACPI_HANDLE(chip->parent);
1088 acpi_status status;
1089
1090 INIT_LIST_HEAD(&achip->conns);
1091 mutex_init(&achip->conn_lock);
1092 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1093 acpi_gpio_adr_space_handler,
1094 NULL, achip);
1095 if (ACPI_FAILURE(status))
1096 dev_err(chip->parent,
1097 "Failed to install GPIO OpRegion handler\n");
1098}
1099
1100static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
1101{
1102 struct gpio_chip *chip = achip->chip;
1103 acpi_handle handle = ACPI_HANDLE(chip->parent);
1104 struct acpi_gpio_connection *conn, *tmp;
1105 acpi_status status;
1106
1107 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
1108 acpi_gpio_adr_space_handler);
1109 if (ACPI_FAILURE(status)) {
1110 dev_err(chip->parent,
1111 "Failed to remove GPIO OpRegion handler\n");
1112 return;
1113 }
1114
1115 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
1116 gpiochip_free_own_desc(conn->desc);
1117 list_del(&conn->node);
1118 kfree(conn);
1119 }
1120}
1121
1122static struct gpio_desc *
1123acpi_gpiochip_parse_own_gpio(struct acpi_gpio_chip *achip,
1124 struct fwnode_handle *fwnode,
1125 const char **name,
1126 unsigned long *lflags,
1127 enum gpiod_flags *dflags)
1128{
1129 struct gpio_chip *chip = achip->chip;
1130 struct gpio_desc *desc;
1131 u32 gpios[2];
1132 int ret;
1133
1134 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
1135 *dflags = 0;
1136 *name = NULL;
1137
1138 ret = fwnode_property_read_u32_array(fwnode, "gpios", gpios,
1139 ARRAY_SIZE(gpios));
1140 if (ret < 0)
1141 return ERR_PTR(ret);
1142
1143 desc = gpiochip_get_desc(chip, gpios[0]);
1144 if (IS_ERR(desc))
1145 return desc;
1146
1147 if (gpios[1])
1148 *lflags |= GPIO_ACTIVE_LOW;
1149
1150 if (fwnode_property_present(fwnode, "input"))
1151 *dflags |= GPIOD_IN;
1152 else if (fwnode_property_present(fwnode, "output-low"))
1153 *dflags |= GPIOD_OUT_LOW;
1154 else if (fwnode_property_present(fwnode, "output-high"))
1155 *dflags |= GPIOD_OUT_HIGH;
1156 else
1157 return ERR_PTR(-EINVAL);
1158
1159 fwnode_property_read_string(fwnode, "line-name", name);
1160
1161 return desc;
1162}
1163
1164static void acpi_gpiochip_scan_gpios(struct acpi_gpio_chip *achip)
1165{
1166 struct gpio_chip *chip = achip->chip;
1167 struct fwnode_handle *fwnode;
1168
1169 device_for_each_child_node(chip->parent, fwnode) {
1170 unsigned long lflags;
1171 enum gpiod_flags dflags;
1172 struct gpio_desc *desc;
1173 const char *name;
1174 int ret;
1175
1176 if (!fwnode_property_present(fwnode, "gpio-hog"))
1177 continue;
1178
1179 desc = acpi_gpiochip_parse_own_gpio(achip, fwnode, &name,
1180 &lflags, &dflags);
1181 if (IS_ERR(desc))
1182 continue;
1183
1184 ret = gpiod_hog(desc, name, lflags, dflags);
1185 if (ret) {
1186 dev_err(chip->parent, "Failed to hog GPIO\n");
1187 fwnode_handle_put(fwnode);
1188 return;
1189 }
1190 }
1191}
1192
1193void acpi_gpiochip_add(struct gpio_chip *chip)
1194{
1195 struct acpi_gpio_chip *acpi_gpio;
1196 acpi_handle handle;
1197 acpi_status status;
1198
1199 if (!chip || !chip->parent)
1200 return;
1201
1202 handle = ACPI_HANDLE(chip->parent);
1203 if (!handle)
1204 return;
1205
1206 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
1207 if (!acpi_gpio) {
1208 dev_err(chip->parent,
1209 "Failed to allocate memory for ACPI GPIO chip\n");
1210 return;
1211 }
1212
1213 acpi_gpio->chip = chip;
1214 INIT_LIST_HEAD(&acpi_gpio->events);
1215 INIT_LIST_HEAD(&acpi_gpio->deferred_req_irqs_list_entry);
1216
1217 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
1218 if (ACPI_FAILURE(status)) {
1219 dev_err(chip->parent, "Failed to attach ACPI GPIO chip\n");
1220 kfree(acpi_gpio);
1221 return;
1222 }
1223
1224 if (!chip->names)
1225 devprop_gpiochip_set_names(chip, dev_fwnode(chip->parent));
1226
1227 acpi_gpiochip_request_regions(acpi_gpio);
1228 acpi_gpiochip_scan_gpios(acpi_gpio);
1229 acpi_walk_dep_device_list(handle);
1230}
1231
1232void acpi_gpiochip_remove(struct gpio_chip *chip)
1233{
1234 struct acpi_gpio_chip *acpi_gpio;
1235 acpi_handle handle;
1236 acpi_status status;
1237
1238 if (!chip || !chip->parent)
1239 return;
1240
1241 handle = ACPI_HANDLE(chip->parent);
1242 if (!handle)
1243 return;
1244
1245 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
1246 if (ACPI_FAILURE(status)) {
1247 dev_warn(chip->parent, "Failed to retrieve ACPI GPIO chip\n");
1248 return;
1249 }
1250
1251 acpi_gpiochip_free_regions(acpi_gpio);
1252
1253 acpi_detach_data(handle, acpi_gpio_chip_dh);
1254 kfree(acpi_gpio);
1255}
1256
1257static int acpi_gpio_package_count(const union acpi_object *obj)
1258{
1259 const union acpi_object *element = obj->package.elements;
1260 const union acpi_object *end = element + obj->package.count;
1261 unsigned int count = 0;
1262
1263 while (element < end) {
1264 switch (element->type) {
1265 case ACPI_TYPE_LOCAL_REFERENCE:
1266 element += 3;
1267 fallthrough;
1268 case ACPI_TYPE_INTEGER:
1269 element++;
1270 count++;
1271 break;
1272
1273 default:
1274 return -EPROTO;
1275 }
1276 }
1277
1278 return count;
1279}
1280
1281static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
1282{
1283 unsigned int *count = data;
1284
1285 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
1286 *count += ares->data.gpio.pin_table_length;
1287
1288 return 1;
1289}
1290
1291/**
1292 * acpi_gpio_count - count the GPIOs associated with a device / function
1293 * @dev: GPIO consumer, can be %NULL for system-global GPIOs
1294 * @con_id: function within the GPIO consumer
1295 *
1296 * Return:
1297 * The number of GPIOs associated with a device / function or %-ENOENT,
1298 * if no GPIO has been assigned to the requested function.
1299 */
1300int acpi_gpio_count(struct device *dev, const char *con_id)
1301{
1302 struct acpi_device *adev = ACPI_COMPANION(dev);
1303 const union acpi_object *obj;
1304 const struct acpi_gpio_mapping *gm;
1305 int count = -ENOENT;
1306 int ret;
1307 char propname[32];
1308 unsigned int i;
1309
1310 /* Try first from _DSD */
1311 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
1312 if (con_id)
1313 snprintf(propname, sizeof(propname), "%s-%s",
1314 con_id, gpio_suffixes[i]);
1315 else
1316 snprintf(propname, sizeof(propname), "%s",
1317 gpio_suffixes[i]);
1318
1319 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
1320 &obj);
1321 if (ret == 0) {
1322 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
1323 count = 1;
1324 else if (obj->type == ACPI_TYPE_PACKAGE)
1325 count = acpi_gpio_package_count(obj);
1326 } else if (adev->driver_gpios) {
1327 for (gm = adev->driver_gpios; gm->name; gm++)
1328 if (strcmp(propname, gm->name) == 0) {
1329 count = gm->size;
1330 break;
1331 }
1332 }
1333 if (count > 0)
1334 break;
1335 }
1336
1337 /* Then from plain _CRS GPIOs */
1338 if (count < 0) {
1339 struct list_head resource_list;
1340 unsigned int crs_count = 0;
1341
1342 if (!acpi_can_fallback_to_crs(adev, con_id))
1343 return count;
1344
1345 INIT_LIST_HEAD(&resource_list);
1346 acpi_dev_get_resources(adev, &resource_list,
1347 acpi_find_gpio_count, &crs_count);
1348 acpi_dev_free_resource_list(&resource_list);
1349 if (crs_count > 0)
1350 count = crs_count;
1351 }
1352 return count ? count : -ENOENT;
1353}
1354
1355/* Run deferred acpi_gpiochip_request_irqs() */
1356static int __init acpi_gpio_handle_deferred_request_irqs(void)
1357{
1358 struct acpi_gpio_chip *acpi_gpio, *tmp;
1359
1360 mutex_lock(&acpi_gpio_deferred_req_irqs_lock);
1361 list_for_each_entry_safe(acpi_gpio, tmp,
1362 &acpi_gpio_deferred_req_irqs_list,
1363 deferred_req_irqs_list_entry)
1364 acpi_gpiochip_request_irqs(acpi_gpio);
1365
1366 acpi_gpio_deferred_req_irqs_done = true;
1367 mutex_unlock(&acpi_gpio_deferred_req_irqs_lock);
1368
1369 return 0;
1370}
1371/* We must use _sync so that this runs after the first deferred_probe run */
1372late_initcall_sync(acpi_gpio_handle_deferred_request_irqs);
1373
1374static const struct dmi_system_id gpiolib_acpi_quirks[] __initconst = {
1375 {
1376 /*
1377 * The Minix Neo Z83-4 has a micro-USB-B id-pin handler for
1378 * a non existing micro-USB-B connector which puts the HDMI
1379 * DDC pins in GPIO mode, breaking HDMI support.
1380 */
1381 .matches = {
1382 DMI_MATCH(DMI_SYS_VENDOR, "MINIX"),
1383 DMI_MATCH(DMI_PRODUCT_NAME, "Z83-4"),
1384 },
1385 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1386 .no_edge_events_on_boot = true,
1387 },
1388 },
1389 {
1390 /*
1391 * The Terra Pad 1061 has a micro-USB-B id-pin handler, which
1392 * instead of controlling the actual micro-USB-B turns the 5V
1393 * boost for its USB-A connector off. The actual micro-USB-B
1394 * connector is wired for charging only.
1395 */
1396 .matches = {
1397 DMI_MATCH(DMI_SYS_VENDOR, "Wortmann_AG"),
1398 DMI_MATCH(DMI_PRODUCT_NAME, "TERRA_PAD_1061"),
1399 },
1400 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1401 .no_edge_events_on_boot = true,
1402 },
1403 },
1404 {
1405 /*
1406 * HP X2 10 models with Cherry Trail SoC + TI PMIC use an
1407 * external embedded-controller connected via I2C + an ACPI GPIO
1408 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1409 * When suspending by closing the LID, the power to the USB
1410 * keyboard is turned off, causing INT0002 ACPI events to
1411 * trigger once the XHCI controller notices the keyboard is
1412 * gone. So INT0002 events cause spurious wakeups too. Ignoring
1413 * EC wakes breaks wakeup when opening the lid, the user needs
1414 * to press the power-button to wakeup the system. The
1415 * alternative is suspend simply not working, which is worse.
1416 */
1417 .matches = {
1418 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1419 DMI_MATCH(DMI_PRODUCT_NAME, "HP x2 Detachable 10-p0XX"),
1420 },
1421 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1422 .ignore_wake = "INT33FF:01@0,INT0002:00@2",
1423 },
1424 },
1425 {
1426 /*
1427 * HP X2 10 models with Bay Trail SoC + AXP288 PMIC use an
1428 * external embedded-controller connected via I2C + an ACPI GPIO
1429 * event handler on INT33FC:02 pin 28, causing spurious wakeups.
1430 */
1431 .matches = {
1432 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
1433 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1434 DMI_MATCH(DMI_BOARD_NAME, "815D"),
1435 },
1436 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1437 .ignore_wake = "INT33FC:02@28",
1438 },
1439 },
1440 {
1441 /*
1442 * HP X2 10 models with Cherry Trail SoC + AXP288 PMIC use an
1443 * external embedded-controller connected via I2C + an ACPI GPIO
1444 * event handler on INT33FF:01 pin 0, causing spurious wakeups.
1445 */
1446 .matches = {
1447 DMI_MATCH(DMI_SYS_VENDOR, "HP"),
1448 DMI_MATCH(DMI_PRODUCT_NAME, "HP Pavilion x2 Detachable"),
1449 DMI_MATCH(DMI_BOARD_NAME, "813E"),
1450 },
1451 .driver_data = &(struct acpi_gpiolib_dmi_quirk) {
1452 .ignore_wake = "INT33FF:01@0",
1453 },
1454 },
1455 {} /* Terminating entry */
1456};
1457
1458static int __init acpi_gpio_setup_params(void)
1459{
1460 const struct acpi_gpiolib_dmi_quirk *quirk = NULL;
1461 const struct dmi_system_id *id;
1462
1463 id = dmi_first_match(gpiolib_acpi_quirks);
1464 if (id)
1465 quirk = id->driver_data;
1466
1467 if (run_edge_events_on_boot < 0) {
1468 if (quirk && quirk->no_edge_events_on_boot)
1469 run_edge_events_on_boot = 0;
1470 else
1471 run_edge_events_on_boot = 1;
1472 }
1473
1474 if (ignore_wake == NULL && quirk && quirk->ignore_wake)
1475 ignore_wake = quirk->ignore_wake;
1476
1477 return 0;
1478}
1479
1480/* Directly after dmi_setup() which runs as core_initcall() */
1481postcore_initcall(acpi_gpio_setup_params);