blob: bbcac3af2a7ab84804fa862fe6a31869ca35aca3 [file] [log] [blame]
Mathias Nymane29482e2012-11-30 12:37:36 +01001/*
2 * ACPI helpers for GPIO API
3 *
4 * Copyright (C) 2012, Intel Corporation
5 * Authors: Mathias Nyman <mathias.nyman@linux.intel.com>
6 * Mika Westerberg <mika.westerberg@linux.intel.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12
13#include <linux/errno.h>
Mika Westerberg354567e2014-11-03 13:01:32 +020014#include <linux/gpio.h>
Mika Westerberg936e15d2013-10-10 11:01:08 +030015#include <linux/gpio/consumer.h>
Mika Westerberg5ccff852014-01-08 12:40:56 +020016#include <linux/gpio/driver.h>
Mathias Nymane29482e2012-11-30 12:37:36 +010017#include <linux/export.h>
Mathias Nymane29482e2012-11-30 12:37:36 +010018#include <linux/acpi.h>
Mathias Nyman0d1c28a2013-01-28 16:23:10 +020019#include <linux/interrupt.h>
Mika Westerberg473ed7b2014-03-14 17:58:07 +020020#include <linux/mutex.h>
Mika Westerberg354567e2014-11-03 13:01:32 +020021#include <linux/pinctrl/pinctrl.h>
Mathias Nymane29482e2012-11-30 12:37:36 +010022
Mika Westerberg5ccff852014-01-08 12:40:56 +020023#include "gpiolib.h"
24
Mika Westerberg4b01a142014-03-10 14:54:52 +020025struct acpi_gpio_event {
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +020026 struct list_head node;
Mika Westerberg4b01a142014-03-10 14:54:52 +020027 acpi_handle handle;
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +020028 unsigned int pin;
29 unsigned int irq;
Alexandre Courbote46cf322014-08-19 10:06:08 -070030 struct gpio_desc *desc;
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +020031};
32
Mika Westerberg473ed7b2014-03-14 17:58:07 +020033struct acpi_gpio_connection {
34 struct list_head node;
Alexandre Courbote46cf322014-08-19 10:06:08 -070035 unsigned int pin;
Mika Westerberg473ed7b2014-03-14 17:58:07 +020036 struct gpio_desc *desc;
37};
38
Mika Westerbergaa92b6f2014-03-10 14:54:51 +020039struct acpi_gpio_chip {
Mika Westerberg473ed7b2014-03-14 17:58:07 +020040 /*
41 * ACPICA requires that the first field of the context parameter
42 * passed to acpi_install_address_space_handler() is large enough
43 * to hold struct acpi_connection_info.
44 */
45 struct acpi_connection_info conn_info;
46 struct list_head conns;
47 struct mutex conn_lock;
Mika Westerbergaa92b6f2014-03-10 14:54:51 +020048 struct gpio_chip *chip;
Mika Westerberg4b01a142014-03-10 14:54:52 +020049 struct list_head events;
Mika Westerbergaa92b6f2014-03-10 14:54:51 +020050};
51
Mathias Nymane29482e2012-11-30 12:37:36 +010052static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)
53{
54 if (!gc->dev)
55 return false;
56
57 return ACPI_HANDLE(gc->dev) == data;
58}
59
Mika Westerberg354567e2014-11-03 13:01:32 +020060#ifdef CONFIG_PINCTRL
61/**
62 * acpi_gpiochip_pin_to_gpio_offset() - translates ACPI GPIO to Linux GPIO
63 * @chip: GPIO chip
64 * @pin: ACPI GPIO pin number from GpioIo/GpioInt resource
65 *
66 * Function takes ACPI GpioIo/GpioInt pin number as a parameter and
67 * translates it to a corresponding offset suitable to be passed to a
68 * GPIO controller driver.
69 *
70 * Typically the returned offset is same as @pin, but if the GPIO
Masahiro Yamadae1c05062015-07-07 10:14:59 +090071 * controller uses pin controller and the mapping is not contiguous the
Mika Westerberg354567e2014-11-03 13:01:32 +020072 * offset might be different.
73 */
74static int acpi_gpiochip_pin_to_gpio_offset(struct gpio_chip *chip, int pin)
75{
76 struct gpio_pin_range *pin_range;
77
78 /* If there are no ranges in this chip, use 1:1 mapping */
79 if (list_empty(&chip->pin_ranges))
80 return pin;
81
82 list_for_each_entry(pin_range, &chip->pin_ranges, node) {
83 const struct pinctrl_gpio_range *range = &pin_range->range;
84 int i;
85
86 if (range->pins) {
87 for (i = 0; i < range->npins; i++) {
88 if (range->pins[i] == pin)
89 return range->base + i - chip->base;
90 }
91 } else {
92 if (pin >= range->pin_base &&
93 pin < range->pin_base + range->npins) {
94 unsigned gpio_base;
95
96 gpio_base = range->base - chip->base;
97 return gpio_base + pin - range->pin_base;
98 }
99 }
100 }
101
102 return -EINVAL;
103}
104#else
105static inline int acpi_gpiochip_pin_to_gpio_offset(struct gpio_chip *chip,
106 int pin)
107{
108 return pin;
109}
110#endif
111
Mathias Nymane29482e2012-11-30 12:37:36 +0100112/**
Mika Westerberg936e15d2013-10-10 11:01:08 +0300113 * acpi_get_gpiod() - Translate ACPI GPIO pin to GPIO descriptor usable with GPIO API
Mathias Nymane29482e2012-11-30 12:37:36 +0100114 * @path: ACPI GPIO controller full path name, (e.g. "\\_SB.GPO1")
115 * @pin: ACPI GPIO pin number (0-based, controller-relative)
116 *
Mika Westerbergf35bbf62015-06-10 16:05:05 +0300117 * Return: GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
118 * error value. Specifically returns %-EPROBE_DEFER if the referenced GPIO
119 * controller does not have gpiochip registered at the moment. This is to
120 * support probe deferral.
Mathias Nymane29482e2012-11-30 12:37:36 +0100121 */
Mika Westerberg936e15d2013-10-10 11:01:08 +0300122static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
Mathias Nymane29482e2012-11-30 12:37:36 +0100123{
124 struct gpio_chip *chip;
125 acpi_handle handle;
126 acpi_status status;
Mika Westerberg354567e2014-11-03 13:01:32 +0200127 int offset;
Mathias Nymane29482e2012-11-30 12:37:36 +0100128
129 status = acpi_get_handle(NULL, path, &handle);
130 if (ACPI_FAILURE(status))
Mika Westerberg936e15d2013-10-10 11:01:08 +0300131 return ERR_PTR(-ENODEV);
Mathias Nymane29482e2012-11-30 12:37:36 +0100132
133 chip = gpiochip_find(handle, acpi_gpiochip_find);
134 if (!chip)
Mika Westerbergf35bbf62015-06-10 16:05:05 +0300135 return ERR_PTR(-EPROBE_DEFER);
Mathias Nymane29482e2012-11-30 12:37:36 +0100136
Mika Westerberg354567e2014-11-03 13:01:32 +0200137 offset = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
138 if (offset < 0)
139 return ERR_PTR(offset);
Mathias Nymane29482e2012-11-30 12:37:36 +0100140
Mika Westerberg354567e2014-11-03 13:01:32 +0200141 return gpiochip_get_desc(chip, offset);
Mathias Nymane29482e2012-11-30 12:37:36 +0100142}
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200143
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200144static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
145{
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200146 struct acpi_gpio_event *event = data;
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200147
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200148 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200149
150 return IRQ_HANDLED;
151}
152
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200153static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
154{
Mika Westerberg4b01a142014-03-10 14:54:52 +0200155 struct acpi_gpio_event *event = data;
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200156
Mika Westerberg4b01a142014-03-10 14:54:52 +0200157 acpi_execute_simple_method(event->handle, NULL, event->pin);
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200158
159 return IRQ_HANDLED;
160}
161
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200162static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200163{
164 /* The address of this function is used as a key. */
165}
166
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200167static acpi_status acpi_gpiochip_request_interrupt(struct acpi_resource *ares,
168 void *context)
169{
170 struct acpi_gpio_chip *acpi_gpio = context;
171 struct gpio_chip *chip = acpi_gpio->chip;
172 struct acpi_resource_gpio *agpio;
173 acpi_handle handle, evt_handle;
174 struct acpi_gpio_event *event;
175 irq_handler_t handler = NULL;
176 struct gpio_desc *desc;
177 unsigned long irqflags;
178 int ret, pin, irq;
179
180 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
181 return AE_OK;
182
183 agpio = &ares->data.gpio;
184 if (agpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
185 return AE_OK;
186
187 handle = ACPI_HANDLE(chip->dev);
188 pin = agpio->pin_table[0];
189
190 if (pin <= 255) {
191 char ev_name[5];
192 sprintf(ev_name, "_%c%02X",
193 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
194 pin);
195 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
196 handler = acpi_gpio_irq_handler;
197 }
198 if (!handler) {
199 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
200 handler = acpi_gpio_irq_handler_evt;
201 }
202 if (!handler)
203 return AE_BAD_PARAMETER;
204
qipeng.zha4de60972015-03-11 01:15:38 +0800205 pin = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
206 if (pin < 0)
207 return AE_BAD_PARAMETER;
208
Alexandre Courbotabdc08a2014-08-19 10:06:09 -0700209 desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event");
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200210 if (IS_ERR(desc)) {
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200211 dev_err(chip->dev, "Failed to request GPIO\n");
212 return AE_ERROR;
213 }
214
215 gpiod_direction_input(desc);
216
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900217 ret = gpiochip_lock_as_irq(chip, pin);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200218 if (ret) {
219 dev_err(chip->dev, "Failed to lock GPIO as interrupt\n");
220 goto fail_free_desc;
221 }
222
223 irq = gpiod_to_irq(desc);
224 if (irq < 0) {
225 dev_err(chip->dev, "Failed to translate GPIO to IRQ\n");
226 goto fail_unlock_irq;
227 }
228
229 irqflags = IRQF_ONESHOT;
230 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
231 if (agpio->polarity == ACPI_ACTIVE_HIGH)
232 irqflags |= IRQF_TRIGGER_HIGH;
233 else
234 irqflags |= IRQF_TRIGGER_LOW;
235 } else {
236 switch (agpio->polarity) {
237 case ACPI_ACTIVE_HIGH:
238 irqflags |= IRQF_TRIGGER_RISING;
239 break;
240 case ACPI_ACTIVE_LOW:
241 irqflags |= IRQF_TRIGGER_FALLING;
242 break;
243 default:
244 irqflags |= IRQF_TRIGGER_RISING |
245 IRQF_TRIGGER_FALLING;
246 break;
247 }
248 }
249
250 event = kzalloc(sizeof(*event), GFP_KERNEL);
251 if (!event)
252 goto fail_unlock_irq;
253
254 event->handle = evt_handle;
255 event->irq = irq;
256 event->pin = pin;
Alexandre Courbote46cf322014-08-19 10:06:08 -0700257 event->desc = desc;
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200258
259 ret = request_threaded_irq(event->irq, NULL, handler, irqflags,
260 "ACPI:Event", event);
261 if (ret) {
262 dev_err(chip->dev, "Failed to setup interrupt handler for %d\n",
263 event->irq);
264 goto fail_free_event;
265 }
266
267 list_add_tail(&event->node, &acpi_gpio->events);
268 return AE_OK;
269
270fail_free_event:
271 kfree(event);
272fail_unlock_irq:
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900273 gpiochip_unlock_as_irq(chip, pin);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200274fail_free_desc:
275 gpiochip_free_own_desc(desc);
276
277 return AE_ERROR;
278}
279
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200280/**
281 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300282 * @chip: GPIO chip
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200283 *
284 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
285 * handled by ACPI event methods which need to be called from the GPIO
286 * chip's interrupt handler. acpi_gpiochip_request_interrupts finds out which
287 * gpio pins have acpi event methods and assigns interrupt handlers that calls
288 * the acpi event methods for those pins.
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200289 */
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300290void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200291{
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300292 struct acpi_gpio_chip *acpi_gpio;
293 acpi_handle handle;
294 acpi_status status;
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200295
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300296 if (!chip->dev || !chip->to_irq)
297 return;
298
299 handle = ACPI_HANDLE(chip->dev);
300 if (!handle)
301 return;
302
303 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
304 if (ACPI_FAILURE(status))
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200305 return;
306
Rafael J. Wysocki1ecb0162015-03-10 23:10:01 +0100307 acpi_walk_resources(handle, "_AEI",
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200308 acpi_gpiochip_request_interrupt, acpi_gpio);
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200309}
Hanjun Guo2b528ff2015-06-10 17:12:07 +0800310EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200311
Mika Westerberg70b53412013-10-10 11:01:07 +0300312/**
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200313 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300314 * @chip: GPIO chip
Mika Westerberg70b53412013-10-10 11:01:07 +0300315 *
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200316 * Free interrupts associated with GPIO ACPI event method for the given
317 * GPIO chip.
Mika Westerberg70b53412013-10-10 11:01:07 +0300318 */
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300319void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
Mika Westerberg70b53412013-10-10 11:01:07 +0300320{
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300321 struct acpi_gpio_chip *acpi_gpio;
Mika Westerberg4b01a142014-03-10 14:54:52 +0200322 struct acpi_gpio_event *event, *ep;
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300323 acpi_handle handle;
324 acpi_status status;
Mika Westerberg70b53412013-10-10 11:01:07 +0300325
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300326 if (!chip->dev || !chip->to_irq)
327 return;
328
329 handle = ACPI_HANDLE(chip->dev);
330 if (!handle)
331 return;
332
333 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
334 if (ACPI_FAILURE(status))
Mika Westerberg70b53412013-10-10 11:01:07 +0300335 return;
336
Mika Westerberg4b01a142014-03-10 14:54:52 +0200337 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200338 struct gpio_desc *desc;
339
340 free_irq(event->irq, event);
Alexandre Courbote46cf322014-08-19 10:06:08 -0700341 desc = event->desc;
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200342 if (WARN_ON(IS_ERR(desc)))
343 continue;
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900344 gpiochip_unlock_as_irq(chip, event->pin);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200345 gpiochip_free_own_desc(desc);
Mika Westerberg4b01a142014-03-10 14:54:52 +0200346 list_del(&event->node);
347 kfree(event);
Mika Westerberg70b53412013-10-10 11:01:07 +0300348 }
Mika Westerberg70b53412013-10-10 11:01:07 +0300349}
Hanjun Guo2b528ff2015-06-10 17:12:07 +0800350EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
Mika Westerberg70b53412013-10-10 11:01:07 +0300351
Rafael J. Wysockif028d522014-11-03 23:39:41 +0100352int acpi_dev_add_driver_gpios(struct acpi_device *adev,
353 const struct acpi_gpio_mapping *gpios)
354{
355 if (adev && gpios) {
356 adev->driver_gpios = gpios;
357 return 0;
358 }
359 return -EINVAL;
360}
361EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
362
363static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
364 const char *name, int index,
365 struct acpi_reference_args *args)
366{
367 const struct acpi_gpio_mapping *gm;
368
369 if (!adev->driver_gpios)
370 return false;
371
372 for (gm = adev->driver_gpios; gm->name; gm++)
373 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
374 const struct acpi_gpio_params *par = gm->data + index;
375
376 args->adev = adev;
377 args->args[0] = par->crs_entry_index;
378 args->args[1] = par->line_index;
379 args->args[2] = par->active_low;
380 args->nargs = 3;
381 return true;
382 }
383
384 return false;
385}
386
Mika Westerberg12028d22013-04-03 13:56:54 +0300387struct acpi_gpio_lookup {
388 struct acpi_gpio_info info;
389 int index;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100390 int pin_index;
Mika Westerberg936e15d2013-10-10 11:01:08 +0300391 struct gpio_desc *desc;
Mika Westerberg12028d22013-04-03 13:56:54 +0300392 int n;
393};
394
395static int acpi_find_gpio(struct acpi_resource *ares, void *data)
396{
397 struct acpi_gpio_lookup *lookup = data;
398
399 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
400 return 1;
401
Mika Westerberg936e15d2013-10-10 11:01:08 +0300402 if (lookup->n++ == lookup->index && !lookup->desc) {
Mika Westerberg12028d22013-04-03 13:56:54 +0300403 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100404 int pin_index = lookup->pin_index;
405
406 if (pin_index >= agpio->pin_table_length)
407 return 1;
Mika Westerberg12028d22013-04-03 13:56:54 +0300408
Mika Westerberg936e15d2013-10-10 11:01:08 +0300409 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100410 agpio->pin_table[pin_index]);
Mika Westerberg12028d22013-04-03 13:56:54 +0300411 lookup->info.gpioint =
412 agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100413
414 /*
415 * ActiveLow is only specified for GpioInt resource. If
416 * GpioIo is used then the only way to set the flag is
417 * to use _DSD "gpios" property.
418 */
419 if (lookup->info.gpioint)
420 lookup->info.active_low =
421 agpio->polarity == ACPI_ACTIVE_LOW;
Mika Westerberg12028d22013-04-03 13:56:54 +0300422 }
423
424 return 1;
425}
426
427/**
Mika Westerberg936e15d2013-10-10 11:01:08 +0300428 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100429 * @adev: pointer to a ACPI device to get GPIO from
430 * @propname: Property name of the GPIO (optional)
Mika Westerberg12028d22013-04-03 13:56:54 +0300431 * @index: index of GpioIo/GpioInt resource (starting from %0)
432 * @info: info pointer to fill in (optional)
433 *
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100434 * Function goes through ACPI resources for @adev and based on @index looks
Mika Westerberg936e15d2013-10-10 11:01:08 +0300435 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
Mika Westerberg12028d22013-04-03 13:56:54 +0300436 * and returns it. @index matches GpioIo/GpioInt resources only so if there
437 * are total %3 GPIO resources, the index goes from %0 to %2.
438 *
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100439 * If @propname is specified the GPIO is looked using device property. In
440 * that case @index is used to select the GPIO entry in the property value
441 * (in case of multiple).
442 *
Mika Westerberg936e15d2013-10-10 11:01:08 +0300443 * If the GPIO cannot be translated or there is an error an ERR_PTR is
Mika Westerberg12028d22013-04-03 13:56:54 +0300444 * returned.
445 *
446 * Note: if the GPIO resource has multiple entries in the pin list, this
447 * function only returns the first.
448 */
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100449struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
450 const char *propname, int index,
Mika Westerberg936e15d2013-10-10 11:01:08 +0300451 struct acpi_gpio_info *info)
Mika Westerberg12028d22013-04-03 13:56:54 +0300452{
453 struct acpi_gpio_lookup lookup;
454 struct list_head resource_list;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100455 bool active_low = false;
Mika Westerberg12028d22013-04-03 13:56:54 +0300456 int ret;
457
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100458 if (!adev)
Mika Westerberg936e15d2013-10-10 11:01:08 +0300459 return ERR_PTR(-ENODEV);
Mika Westerberg12028d22013-04-03 13:56:54 +0300460
461 memset(&lookup, 0, sizeof(lookup));
462 lookup.index = index;
Mika Westerberg12028d22013-04-03 13:56:54 +0300463
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100464 if (propname) {
465 struct acpi_reference_args args;
466
467 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
468
469 memset(&args, 0, sizeof(args));
Rafael J. Wysocki60ba0322014-11-05 00:29:07 +0100470 ret = acpi_dev_get_property_reference(adev, propname,
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100471 index, &args);
Rafael J. Wysockif028d522014-11-03 23:39:41 +0100472 if (ret) {
473 bool found = acpi_get_driver_gpio_data(adev, propname,
474 index, &args);
475 if (!found)
476 return ERR_PTR(ret);
477 }
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100478
479 /*
480 * The property was found and resolved so need to
481 * lookup the GPIO based on returned args instead.
482 */
483 adev = args.adev;
484 if (args.nargs >= 2) {
485 lookup.index = args.args[0];
486 lookup.pin_index = args.args[1];
487 /*
488 * 3rd argument, if present is used to
489 * specify active_low.
490 */
491 if (args.nargs >= 3)
492 active_low = !!args.args[2];
493 }
494
495 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %zd %llu %llu %llu\n",
496 dev_name(&adev->dev), args.nargs,
497 args.args[0], args.args[1], args.args[2]);
498 } else {
499 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
500 }
501
Mika Westerberg12028d22013-04-03 13:56:54 +0300502 INIT_LIST_HEAD(&resource_list);
503 ret = acpi_dev_get_resources(adev, &resource_list, acpi_find_gpio,
504 &lookup);
505 if (ret < 0)
Mika Westerberg936e15d2013-10-10 11:01:08 +0300506 return ERR_PTR(ret);
Mika Westerberg12028d22013-04-03 13:56:54 +0300507
508 acpi_dev_free_resource_list(&resource_list);
509
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100510 if (lookup.desc && info) {
Mika Westerberg12028d22013-04-03 13:56:54 +0300511 *info = lookup.info;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100512 if (active_low)
513 info->active_low = active_low;
514 }
Mika Westerberg12028d22013-04-03 13:56:54 +0300515
Mika Westerberga00580c2013-12-10 12:00:27 +0200516 return lookup.desc ? lookup.desc : ERR_PTR(-ENOENT);
Mika Westerberg12028d22013-04-03 13:56:54 +0300517}
Mika Westerberg664e3e52014-01-08 12:40:54 +0200518
Mika Westerbergc884fbd2015-05-06 13:29:06 +0300519/**
520 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
521 * @adev: pointer to a ACPI device to get IRQ from
522 * @index: index of GpioInt resource (starting from %0)
523 *
524 * If the device has one or more GpioInt resources, this function can be
525 * used to translate from the GPIO offset in the resource to the Linux IRQ
526 * number.
527 *
528 * Return: Linux IRQ number (>%0) on success, negative errno on failure.
529 */
530int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
531{
532 int idx, i;
533
534 for (i = 0, idx = 0; idx <= index; i++) {
535 struct acpi_gpio_info info;
536 struct gpio_desc *desc;
537
538 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
539 if (IS_ERR(desc))
540 break;
541 if (info.gpioint && idx++ == index)
542 return gpiod_to_irq(desc);
543 }
544 return -ENOENT;
545}
546EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
547
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200548static acpi_status
549acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
550 u32 bits, u64 *value, void *handler_context,
551 void *region_context)
552{
553 struct acpi_gpio_chip *achip = region_context;
554 struct gpio_chip *chip = achip->chip;
555 struct acpi_resource_gpio *agpio;
556 struct acpi_resource *ares;
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800557 int pin_index = (int)address;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200558 acpi_status status;
559 bool pull_up;
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800560 int length;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200561 int i;
562
563 status = acpi_buffer_to_resource(achip->conn_info.connection,
564 achip->conn_info.length, &ares);
565 if (ACPI_FAILURE(status))
566 return status;
567
568 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
569 ACPI_FREE(ares);
570 return AE_BAD_PARAMETER;
571 }
572
573 agpio = &ares->data.gpio;
574 pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;
575
576 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
577 function == ACPI_WRITE)) {
578 ACPI_FREE(ares);
579 return AE_BAD_PARAMETER;
580 }
581
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800582 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
583 for (i = pin_index; i < length; ++i) {
Qipeng Zhaa4811622015-04-10 06:25:10 +0800584 int pin = agpio->pin_table[i];
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200585 struct acpi_gpio_connection *conn;
586 struct gpio_desc *desc;
587 bool found;
588
qipeng.zha4de60972015-03-11 01:15:38 +0800589 pin = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
590 if (pin < 0) {
591 status = AE_BAD_PARAMETER;
592 goto out;
593 }
594
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200595 mutex_lock(&achip->conn_lock);
596
597 found = false;
598 list_for_each_entry(conn, &achip->conns, node) {
Alexandre Courbote46cf322014-08-19 10:06:08 -0700599 if (conn->pin == pin) {
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200600 found = true;
Alexandre Courbote46cf322014-08-19 10:06:08 -0700601 desc = conn->desc;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200602 break;
603 }
604 }
Mika Westerbergc103a102015-10-30 12:02:05 +0200605
606 /*
607 * The same GPIO can be shared between operation region and
608 * event but only if the access here is ACPI_READ. In that
609 * case we "borrow" the event GPIO instead.
610 */
611 if (!found && agpio->sharable == ACPI_SHARED &&
612 function == ACPI_READ) {
613 struct acpi_gpio_event *event;
614
615 list_for_each_entry(event, &achip->events, node) {
616 if (event->pin == pin) {
617 desc = event->desc;
618 found = true;
619 break;
620 }
621 }
622 }
623
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200624 if (!found) {
Alexandre Courbotabdc08a2014-08-19 10:06:09 -0700625 desc = gpiochip_request_own_desc(chip, pin,
626 "ACPI:OpRegion");
Alexandre Courbote46cf322014-08-19 10:06:08 -0700627 if (IS_ERR(desc)) {
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200628 status = AE_ERROR;
629 mutex_unlock(&achip->conn_lock);
630 goto out;
631 }
632
633 switch (agpio->io_restriction) {
634 case ACPI_IO_RESTRICT_INPUT:
635 gpiod_direction_input(desc);
636 break;
637 case ACPI_IO_RESTRICT_OUTPUT:
638 /*
639 * ACPI GPIO resources don't contain an
640 * initial value for the GPIO. Therefore we
641 * deduce that value from the pull field
642 * instead. If the pin is pulled up we
643 * assume default to be high, otherwise
644 * low.
645 */
646 gpiod_direction_output(desc, pull_up);
647 break;
648 default:
649 /*
650 * Assume that the BIOS has configured the
651 * direction and pull accordingly.
652 */
653 break;
654 }
655
656 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
657 if (!conn) {
658 status = AE_NO_MEMORY;
659 gpiochip_free_own_desc(desc);
660 mutex_unlock(&achip->conn_lock);
661 goto out;
662 }
663
Alexandre Courbote46cf322014-08-19 10:06:08 -0700664 conn->pin = pin;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200665 conn->desc = desc;
666 list_add_tail(&conn->node, &achip->conns);
667 }
668
669 mutex_unlock(&achip->conn_lock);
670
671 if (function == ACPI_WRITE)
Aaron Ludc62b562014-05-20 17:07:38 +0800672 gpiod_set_raw_value_cansleep(desc,
673 !!((1 << i) & *value));
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200674 else
Aaron Ludc62b562014-05-20 17:07:38 +0800675 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200676 }
677
678out:
679 ACPI_FREE(ares);
680 return status;
681}
682
683static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
684{
685 struct gpio_chip *chip = achip->chip;
686 acpi_handle handle = ACPI_HANDLE(chip->dev);
687 acpi_status status;
688
689 INIT_LIST_HEAD(&achip->conns);
690 mutex_init(&achip->conn_lock);
691 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
692 acpi_gpio_adr_space_handler,
693 NULL, achip);
694 if (ACPI_FAILURE(status))
695 dev_err(chip->dev, "Failed to install GPIO OpRegion handler\n");
696}
697
698static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
699{
700 struct gpio_chip *chip = achip->chip;
701 acpi_handle handle = ACPI_HANDLE(chip->dev);
702 struct acpi_gpio_connection *conn, *tmp;
703 acpi_status status;
704
705 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
706 acpi_gpio_adr_space_handler);
707 if (ACPI_FAILURE(status)) {
708 dev_err(chip->dev, "Failed to remove GPIO OpRegion handler\n");
709 return;
710 }
711
712 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
713 gpiochip_free_own_desc(conn->desc);
714 list_del(&conn->node);
715 kfree(conn);
716 }
717}
718
Mika Westerberg664e3e52014-01-08 12:40:54 +0200719void acpi_gpiochip_add(struct gpio_chip *chip)
720{
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200721 struct acpi_gpio_chip *acpi_gpio;
722 acpi_handle handle;
723 acpi_status status;
724
Mika Westerberge9595f82014-03-31 15:16:49 +0300725 if (!chip || !chip->dev)
726 return;
727
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200728 handle = ACPI_HANDLE(chip->dev);
729 if (!handle)
730 return;
731
732 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
733 if (!acpi_gpio) {
734 dev_err(chip->dev,
735 "Failed to allocate memory for ACPI GPIO chip\n");
736 return;
737 }
738
739 acpi_gpio->chip = chip;
Mika Westerbergc103a102015-10-30 12:02:05 +0200740 INIT_LIST_HEAD(&acpi_gpio->events);
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200741
742 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
743 if (ACPI_FAILURE(status)) {
744 dev_err(chip->dev, "Failed to attach ACPI GPIO chip\n");
745 kfree(acpi_gpio);
746 return;
747 }
748
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200749 acpi_gpiochip_request_regions(acpi_gpio);
Mika Westerberg664e3e52014-01-08 12:40:54 +0200750}
751
752void acpi_gpiochip_remove(struct gpio_chip *chip)
753{
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200754 struct acpi_gpio_chip *acpi_gpio;
755 acpi_handle handle;
756 acpi_status status;
757
Mika Westerberge9595f82014-03-31 15:16:49 +0300758 if (!chip || !chip->dev)
759 return;
760
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200761 handle = ACPI_HANDLE(chip->dev);
762 if (!handle)
763 return;
764
765 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
766 if (ACPI_FAILURE(status)) {
767 dev_warn(chip->dev, "Failed to retrieve ACPI GPIO chip\n");
768 return;
769 }
770
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200771 acpi_gpiochip_free_regions(acpi_gpio);
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200772
773 acpi_detach_data(handle, acpi_gpio_chip_dh);
774 kfree(acpi_gpio);
Mika Westerberg664e3e52014-01-08 12:40:54 +0200775}
Rojhalat Ibrahim66858522015-02-11 17:27:58 +0100776
777static unsigned int acpi_gpio_package_count(const union acpi_object *obj)
778{
779 const union acpi_object *element = obj->package.elements;
780 const union acpi_object *end = element + obj->package.count;
781 unsigned int count = 0;
782
783 while (element < end) {
784 if (element->type == ACPI_TYPE_LOCAL_REFERENCE)
785 count++;
786
787 element++;
788 }
789 return count;
790}
791
792static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
793{
794 unsigned int *count = data;
795
796 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
797 *count += ares->data.gpio.pin_table_length;
798
799 return 1;
800}
801
802/**
803 * acpi_gpio_count - return the number of GPIOs associated with a
804 * device / function or -ENOENT if no GPIO has been
805 * assigned to the requested function.
806 * @dev: GPIO consumer, can be NULL for system-global GPIOs
807 * @con_id: function within the GPIO consumer
808 */
809int acpi_gpio_count(struct device *dev, const char *con_id)
810{
811 struct acpi_device *adev = ACPI_COMPANION(dev);
812 const union acpi_object *obj;
813 const struct acpi_gpio_mapping *gm;
814 int count = -ENOENT;
815 int ret;
816 char propname[32];
817 unsigned int i;
818
819 /* Try first from _DSD */
820 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
821 if (con_id && strcmp(con_id, "gpios"))
822 snprintf(propname, sizeof(propname), "%s-%s",
823 con_id, gpio_suffixes[i]);
824 else
825 snprintf(propname, sizeof(propname), "%s",
826 gpio_suffixes[i]);
827
828 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
829 &obj);
830 if (ret == 0) {
831 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
832 count = 1;
833 else if (obj->type == ACPI_TYPE_PACKAGE)
834 count = acpi_gpio_package_count(obj);
835 } else if (adev->driver_gpios) {
836 for (gm = adev->driver_gpios; gm->name; gm++)
837 if (strcmp(propname, gm->name) == 0) {
838 count = gm->size;
839 break;
840 }
841 }
842 if (count >= 0)
843 break;
844 }
845
846 /* Then from plain _CRS GPIOs */
847 if (count < 0) {
848 struct list_head resource_list;
849 unsigned int crs_count = 0;
850
851 INIT_LIST_HEAD(&resource_list);
852 acpi_dev_get_resources(adev, &resource_list,
853 acpi_find_gpio_count, &crs_count);
854 acpi_dev_free_resource_list(&resource_list);
855 if (crs_count > 0)
856 count = crs_count;
857 }
858 return count;
859}