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