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