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