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