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