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