blob: bff29bb0a3fe8eb8708722361832a03460d73d3e [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
71 * controller uses pin controller and the mapping is not contigous the
72 * 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 Westerberg936e15d2013-10-10 11:01:08 +0300117 * Returns GPIO descriptor to use with Linux generic GPIO API, or ERR_PTR
118 * error value
Mathias Nymane29482e2012-11-30 12:37:36 +0100119 */
120
Mika Westerberg936e15d2013-10-10 11:01:08 +0300121static struct gpio_desc *acpi_get_gpiod(char *path, int pin)
Mathias Nymane29482e2012-11-30 12:37:36 +0100122{
123 struct gpio_chip *chip;
124 acpi_handle handle;
125 acpi_status status;
Mika Westerberg354567e2014-11-03 13:01:32 +0200126 int offset;
Mathias Nymane29482e2012-11-30 12:37:36 +0100127
128 status = acpi_get_handle(NULL, path, &handle);
129 if (ACPI_FAILURE(status))
Mika Westerberg936e15d2013-10-10 11:01:08 +0300130 return ERR_PTR(-ENODEV);
Mathias Nymane29482e2012-11-30 12:37:36 +0100131
132 chip = gpiochip_find(handle, acpi_gpiochip_find);
133 if (!chip)
Mika Westerberg936e15d2013-10-10 11:01:08 +0300134 return ERR_PTR(-ENODEV);
Mathias Nymane29482e2012-11-30 12:37:36 +0100135
Mika Westerberg354567e2014-11-03 13:01:32 +0200136 offset = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
137 if (offset < 0)
138 return ERR_PTR(offset);
Mathias Nymane29482e2012-11-30 12:37:36 +0100139
Mika Westerberg354567e2014-11-03 13:01:32 +0200140 return gpiochip_get_desc(chip, offset);
Mathias Nymane29482e2012-11-30 12:37:36 +0100141}
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200142
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200143static irqreturn_t acpi_gpio_irq_handler(int irq, void *data)
144{
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200145 struct acpi_gpio_event *event = data;
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200146
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200147 acpi_evaluate_object(event->handle, NULL, NULL, NULL);
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200148
149 return IRQ_HANDLED;
150}
151
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200152static irqreturn_t acpi_gpio_irq_handler_evt(int irq, void *data)
153{
Mika Westerberg4b01a142014-03-10 14:54:52 +0200154 struct acpi_gpio_event *event = data;
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200155
Mika Westerberg4b01a142014-03-10 14:54:52 +0200156 acpi_execute_simple_method(event->handle, NULL, event->pin);
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200157
158 return IRQ_HANDLED;
159}
160
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200161static void acpi_gpio_chip_dh(acpi_handle handle, void *data)
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200162{
163 /* The address of this function is used as a key. */
164}
165
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200166static acpi_status acpi_gpiochip_request_interrupt(struct acpi_resource *ares,
167 void *context)
168{
169 struct acpi_gpio_chip *acpi_gpio = context;
170 struct gpio_chip *chip = acpi_gpio->chip;
171 struct acpi_resource_gpio *agpio;
172 acpi_handle handle, evt_handle;
173 struct acpi_gpio_event *event;
174 irq_handler_t handler = NULL;
175 struct gpio_desc *desc;
176 unsigned long irqflags;
177 int ret, pin, irq;
178
179 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
180 return AE_OK;
181
182 agpio = &ares->data.gpio;
183 if (agpio->connection_type != ACPI_RESOURCE_GPIO_TYPE_INT)
184 return AE_OK;
185
186 handle = ACPI_HANDLE(chip->dev);
187 pin = agpio->pin_table[0];
188
189 if (pin <= 255) {
190 char ev_name[5];
191 sprintf(ev_name, "_%c%02X",
192 agpio->triggering == ACPI_EDGE_SENSITIVE ? 'E' : 'L',
193 pin);
194 if (ACPI_SUCCESS(acpi_get_handle(handle, ev_name, &evt_handle)))
195 handler = acpi_gpio_irq_handler;
196 }
197 if (!handler) {
198 if (ACPI_SUCCESS(acpi_get_handle(handle, "_EVT", &evt_handle)))
199 handler = acpi_gpio_irq_handler_evt;
200 }
201 if (!handler)
202 return AE_BAD_PARAMETER;
203
qipeng.zha4de60972015-03-11 01:15:38 +0800204 pin = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
205 if (pin < 0)
206 return AE_BAD_PARAMETER;
207
Alexandre Courbotabdc08a2014-08-19 10:06:09 -0700208 desc = gpiochip_request_own_desc(chip, pin, "ACPI:Event");
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200209 if (IS_ERR(desc)) {
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200210 dev_err(chip->dev, "Failed to request GPIO\n");
211 return AE_ERROR;
212 }
213
214 gpiod_direction_input(desc);
215
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900216 ret = gpiochip_lock_as_irq(chip, pin);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200217 if (ret) {
218 dev_err(chip->dev, "Failed to lock GPIO as interrupt\n");
219 goto fail_free_desc;
220 }
221
222 irq = gpiod_to_irq(desc);
223 if (irq < 0) {
224 dev_err(chip->dev, "Failed to translate GPIO to IRQ\n");
225 goto fail_unlock_irq;
226 }
227
228 irqflags = IRQF_ONESHOT;
229 if (agpio->triggering == ACPI_LEVEL_SENSITIVE) {
230 if (agpio->polarity == ACPI_ACTIVE_HIGH)
231 irqflags |= IRQF_TRIGGER_HIGH;
232 else
233 irqflags |= IRQF_TRIGGER_LOW;
234 } else {
235 switch (agpio->polarity) {
236 case ACPI_ACTIVE_HIGH:
237 irqflags |= IRQF_TRIGGER_RISING;
238 break;
239 case ACPI_ACTIVE_LOW:
240 irqflags |= IRQF_TRIGGER_FALLING;
241 break;
242 default:
243 irqflags |= IRQF_TRIGGER_RISING |
244 IRQF_TRIGGER_FALLING;
245 break;
246 }
247 }
248
249 event = kzalloc(sizeof(*event), GFP_KERNEL);
250 if (!event)
251 goto fail_unlock_irq;
252
253 event->handle = evt_handle;
254 event->irq = irq;
255 event->pin = pin;
Alexandre Courbote46cf322014-08-19 10:06:08 -0700256 event->desc = desc;
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200257
258 ret = request_threaded_irq(event->irq, NULL, handler, irqflags,
259 "ACPI:Event", event);
260 if (ret) {
261 dev_err(chip->dev, "Failed to setup interrupt handler for %d\n",
262 event->irq);
263 goto fail_free_event;
264 }
265
266 list_add_tail(&event->node, &acpi_gpio->events);
267 return AE_OK;
268
269fail_free_event:
270 kfree(event);
271fail_unlock_irq:
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900272 gpiochip_unlock_as_irq(chip, pin);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200273fail_free_desc:
274 gpiochip_free_own_desc(desc);
275
276 return AE_ERROR;
277}
278
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200279/**
280 * acpi_gpiochip_request_interrupts() - Register isr for gpio chip ACPI events
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300281 * @chip: GPIO chip
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200282 *
283 * ACPI5 platforms can use GPIO signaled ACPI events. These GPIO interrupts are
284 * handled by ACPI event methods which need to be called from the GPIO
285 * chip's interrupt handler. acpi_gpiochip_request_interrupts finds out which
286 * gpio pins have acpi event methods and assigns interrupt handlers that calls
287 * the acpi event methods for those pins.
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200288 */
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300289void acpi_gpiochip_request_interrupts(struct gpio_chip *chip)
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200290{
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300291 struct acpi_gpio_chip *acpi_gpio;
292 acpi_handle handle;
293 acpi_status status;
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200294
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300295 if (!chip->dev || !chip->to_irq)
296 return;
297
298 handle = ACPI_HANDLE(chip->dev);
299 if (!handle)
300 return;
301
302 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
303 if (ACPI_FAILURE(status))
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200304 return;
305
Mika Westerberg4b01a142014-03-10 14:54:52 +0200306 INIT_LIST_HEAD(&acpi_gpio->events);
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}
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200310
Mika Westerberg70b53412013-10-10 11:01:07 +0300311/**
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200312 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300313 * @chip: GPIO chip
Mika Westerberg70b53412013-10-10 11:01:07 +0300314 *
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200315 * Free interrupts associated with GPIO ACPI event method for the given
316 * GPIO chip.
Mika Westerberg70b53412013-10-10 11:01:07 +0300317 */
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300318void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
Mika Westerberg70b53412013-10-10 11:01:07 +0300319{
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300320 struct acpi_gpio_chip *acpi_gpio;
Mika Westerberg4b01a142014-03-10 14:54:52 +0200321 struct acpi_gpio_event *event, *ep;
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300322 acpi_handle handle;
323 acpi_status status;
Mika Westerberg70b53412013-10-10 11:01:07 +0300324
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300325 if (!chip->dev || !chip->to_irq)
326 return;
327
328 handle = ACPI_HANDLE(chip->dev);
329 if (!handle)
330 return;
331
332 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
333 if (ACPI_FAILURE(status))
Mika Westerberg70b53412013-10-10 11:01:07 +0300334 return;
335
Mika Westerberg4b01a142014-03-10 14:54:52 +0200336 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200337 struct gpio_desc *desc;
338
339 free_irq(event->irq, event);
Alexandre Courbote46cf322014-08-19 10:06:08 -0700340 desc = event->desc;
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200341 if (WARN_ON(IS_ERR(desc)))
342 continue;
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900343 gpiochip_unlock_as_irq(chip, event->pin);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200344 gpiochip_free_own_desc(desc);
Mika Westerberg4b01a142014-03-10 14:54:52 +0200345 list_del(&event->node);
346 kfree(event);
Mika Westerberg70b53412013-10-10 11:01:07 +0300347 }
Mika Westerberg70b53412013-10-10 11:01:07 +0300348}
Mika Westerberg70b53412013-10-10 11:01:07 +0300349
Rafael J. Wysockif028d522014-11-03 23:39:41 +0100350int acpi_dev_add_driver_gpios(struct acpi_device *adev,
351 const struct acpi_gpio_mapping *gpios)
352{
353 if (adev && gpios) {
354 adev->driver_gpios = gpios;
355 return 0;
356 }
357 return -EINVAL;
358}
359EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
360
361static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
362 const char *name, int index,
363 struct acpi_reference_args *args)
364{
365 const struct acpi_gpio_mapping *gm;
366
367 if (!adev->driver_gpios)
368 return false;
369
370 for (gm = adev->driver_gpios; gm->name; gm++)
371 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
372 const struct acpi_gpio_params *par = gm->data + index;
373
374 args->adev = adev;
375 args->args[0] = par->crs_entry_index;
376 args->args[1] = par->line_index;
377 args->args[2] = par->active_low;
378 args->nargs = 3;
379 return true;
380 }
381
382 return false;
383}
384
Mika Westerberg12028d22013-04-03 13:56:54 +0300385struct acpi_gpio_lookup {
386 struct acpi_gpio_info info;
387 int index;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100388 int pin_index;
Mika Westerberg936e15d2013-10-10 11:01:08 +0300389 struct gpio_desc *desc;
Mika Westerberg12028d22013-04-03 13:56:54 +0300390 int n;
391};
392
393static int acpi_find_gpio(struct acpi_resource *ares, void *data)
394{
395 struct acpi_gpio_lookup *lookup = data;
396
397 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
398 return 1;
399
Mika Westerberg936e15d2013-10-10 11:01:08 +0300400 if (lookup->n++ == lookup->index && !lookup->desc) {
Mika Westerberg12028d22013-04-03 13:56:54 +0300401 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100402 int pin_index = lookup->pin_index;
403
404 if (pin_index >= agpio->pin_table_length)
405 return 1;
Mika Westerberg12028d22013-04-03 13:56:54 +0300406
Mika Westerberg936e15d2013-10-10 11:01:08 +0300407 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100408 agpio->pin_table[pin_index]);
Mika Westerberg12028d22013-04-03 13:56:54 +0300409 lookup->info.gpioint =
410 agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100411
412 /*
413 * ActiveLow is only specified for GpioInt resource. If
414 * GpioIo is used then the only way to set the flag is
415 * to use _DSD "gpios" property.
416 */
417 if (lookup->info.gpioint)
418 lookup->info.active_low =
419 agpio->polarity == ACPI_ACTIVE_LOW;
Mika Westerberg12028d22013-04-03 13:56:54 +0300420 }
421
422 return 1;
423}
424
425/**
Mika Westerberg936e15d2013-10-10 11:01:08 +0300426 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100427 * @adev: pointer to a ACPI device to get GPIO from
428 * @propname: Property name of the GPIO (optional)
Mika Westerberg12028d22013-04-03 13:56:54 +0300429 * @index: index of GpioIo/GpioInt resource (starting from %0)
430 * @info: info pointer to fill in (optional)
431 *
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100432 * Function goes through ACPI resources for @adev and based on @index looks
Mika Westerberg936e15d2013-10-10 11:01:08 +0300433 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
Mika Westerberg12028d22013-04-03 13:56:54 +0300434 * and returns it. @index matches GpioIo/GpioInt resources only so if there
435 * are total %3 GPIO resources, the index goes from %0 to %2.
436 *
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100437 * If @propname is specified the GPIO is looked using device property. In
438 * that case @index is used to select the GPIO entry in the property value
439 * (in case of multiple).
440 *
Mika Westerberg936e15d2013-10-10 11:01:08 +0300441 * If the GPIO cannot be translated or there is an error an ERR_PTR is
Mika Westerberg12028d22013-04-03 13:56:54 +0300442 * returned.
443 *
444 * Note: if the GPIO resource has multiple entries in the pin list, this
445 * function only returns the first.
446 */
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100447struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
448 const char *propname, int index,
Mika Westerberg936e15d2013-10-10 11:01:08 +0300449 struct acpi_gpio_info *info)
Mika Westerberg12028d22013-04-03 13:56:54 +0300450{
451 struct acpi_gpio_lookup lookup;
452 struct list_head resource_list;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100453 bool active_low = false;
Mika Westerberg12028d22013-04-03 13:56:54 +0300454 int ret;
455
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100456 if (!adev)
Mika Westerberg936e15d2013-10-10 11:01:08 +0300457 return ERR_PTR(-ENODEV);
Mika Westerberg12028d22013-04-03 13:56:54 +0300458
459 memset(&lookup, 0, sizeof(lookup));
460 lookup.index = index;
Mika Westerberg12028d22013-04-03 13:56:54 +0300461
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100462 if (propname) {
463 struct acpi_reference_args args;
464
465 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
466
467 memset(&args, 0, sizeof(args));
Rafael J. Wysocki60ba0322014-11-05 00:29:07 +0100468 ret = acpi_dev_get_property_reference(adev, propname,
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100469 index, &args);
Rafael J. Wysockif028d522014-11-03 23:39:41 +0100470 if (ret) {
471 bool found = acpi_get_driver_gpio_data(adev, propname,
472 index, &args);
473 if (!found)
474 return ERR_PTR(ret);
475 }
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100476
477 /*
478 * The property was found and resolved so need to
479 * lookup the GPIO based on returned args instead.
480 */
481 adev = args.adev;
482 if (args.nargs >= 2) {
483 lookup.index = args.args[0];
484 lookup.pin_index = args.args[1];
485 /*
486 * 3rd argument, if present is used to
487 * specify active_low.
488 */
489 if (args.nargs >= 3)
490 active_low = !!args.args[2];
491 }
492
493 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %zd %llu %llu %llu\n",
494 dev_name(&adev->dev), args.nargs,
495 args.args[0], args.args[1], args.args[2]);
496 } else {
497 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
498 }
499
Mika Westerberg12028d22013-04-03 13:56:54 +0300500 INIT_LIST_HEAD(&resource_list);
501 ret = acpi_dev_get_resources(adev, &resource_list, acpi_find_gpio,
502 &lookup);
503 if (ret < 0)
Mika Westerberg936e15d2013-10-10 11:01:08 +0300504 return ERR_PTR(ret);
Mika Westerberg12028d22013-04-03 13:56:54 +0300505
506 acpi_dev_free_resource_list(&resource_list);
507
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100508 if (lookup.desc && info) {
Mika Westerberg12028d22013-04-03 13:56:54 +0300509 *info = lookup.info;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100510 if (active_low)
511 info->active_low = active_low;
512 }
Mika Westerberg12028d22013-04-03 13:56:54 +0300513
Mika Westerberga00580c2013-12-10 12:00:27 +0200514 return lookup.desc ? lookup.desc : ERR_PTR(-ENOENT);
Mika Westerberg12028d22013-04-03 13:56:54 +0300515}
Mika Westerberg664e3e52014-01-08 12:40:54 +0200516
Mika Westerbergc884fbd2015-05-06 13:29:06 +0300517/**
518 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
519 * @adev: pointer to a ACPI device to get IRQ from
520 * @index: index of GpioInt resource (starting from %0)
521 *
522 * If the device has one or more GpioInt resources, this function can be
523 * used to translate from the GPIO offset in the resource to the Linux IRQ
524 * number.
525 *
526 * Return: Linux IRQ number (>%0) on success, negative errno on failure.
527 */
528int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
529{
530 int idx, i;
531
532 for (i = 0, idx = 0; idx <= index; i++) {
533 struct acpi_gpio_info info;
534 struct gpio_desc *desc;
535
536 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
537 if (IS_ERR(desc))
538 break;
539 if (info.gpioint && idx++ == index)
540 return gpiod_to_irq(desc);
541 }
542 return -ENOENT;
543}
544EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
545
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200546static acpi_status
547acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
548 u32 bits, u64 *value, void *handler_context,
549 void *region_context)
550{
551 struct acpi_gpio_chip *achip = region_context;
552 struct gpio_chip *chip = achip->chip;
553 struct acpi_resource_gpio *agpio;
554 struct acpi_resource *ares;
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800555 int pin_index = (int)address;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200556 acpi_status status;
557 bool pull_up;
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800558 int length;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200559 int i;
560
561 status = acpi_buffer_to_resource(achip->conn_info.connection,
562 achip->conn_info.length, &ares);
563 if (ACPI_FAILURE(status))
564 return status;
565
566 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
567 ACPI_FREE(ares);
568 return AE_BAD_PARAMETER;
569 }
570
571 agpio = &ares->data.gpio;
572 pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;
573
574 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
575 function == ACPI_WRITE)) {
576 ACPI_FREE(ares);
577 return AE_BAD_PARAMETER;
578 }
579
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800580 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
581 for (i = pin_index; i < length; ++i) {
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200582 unsigned pin = agpio->pin_table[i];
583 struct acpi_gpio_connection *conn;
584 struct gpio_desc *desc;
585 bool found;
586
qipeng.zha4de60972015-03-11 01:15:38 +0800587 pin = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
588 if (pin < 0) {
589 status = AE_BAD_PARAMETER;
590 goto out;
591 }
592
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200593 mutex_lock(&achip->conn_lock);
594
595 found = false;
596 list_for_each_entry(conn, &achip->conns, node) {
Alexandre Courbote46cf322014-08-19 10:06:08 -0700597 if (conn->pin == pin) {
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200598 found = true;
Alexandre Courbote46cf322014-08-19 10:06:08 -0700599 desc = conn->desc;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200600 break;
601 }
602 }
603 if (!found) {
Alexandre Courbotabdc08a2014-08-19 10:06:09 -0700604 desc = gpiochip_request_own_desc(chip, pin,
605 "ACPI:OpRegion");
Alexandre Courbote46cf322014-08-19 10:06:08 -0700606 if (IS_ERR(desc)) {
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200607 status = AE_ERROR;
608 mutex_unlock(&achip->conn_lock);
609 goto out;
610 }
611
612 switch (agpio->io_restriction) {
613 case ACPI_IO_RESTRICT_INPUT:
614 gpiod_direction_input(desc);
615 break;
616 case ACPI_IO_RESTRICT_OUTPUT:
617 /*
618 * ACPI GPIO resources don't contain an
619 * initial value for the GPIO. Therefore we
620 * deduce that value from the pull field
621 * instead. If the pin is pulled up we
622 * assume default to be high, otherwise
623 * low.
624 */
625 gpiod_direction_output(desc, pull_up);
626 break;
627 default:
628 /*
629 * Assume that the BIOS has configured the
630 * direction and pull accordingly.
631 */
632 break;
633 }
634
635 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
636 if (!conn) {
637 status = AE_NO_MEMORY;
638 gpiochip_free_own_desc(desc);
639 mutex_unlock(&achip->conn_lock);
640 goto out;
641 }
642
Alexandre Courbote46cf322014-08-19 10:06:08 -0700643 conn->pin = pin;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200644 conn->desc = desc;
645 list_add_tail(&conn->node, &achip->conns);
646 }
647
648 mutex_unlock(&achip->conn_lock);
649
650 if (function == ACPI_WRITE)
Aaron Ludc62b562014-05-20 17:07:38 +0800651 gpiod_set_raw_value_cansleep(desc,
652 !!((1 << i) & *value));
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200653 else
Aaron Ludc62b562014-05-20 17:07:38 +0800654 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200655 }
656
657out:
658 ACPI_FREE(ares);
659 return status;
660}
661
662static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
663{
664 struct gpio_chip *chip = achip->chip;
665 acpi_handle handle = ACPI_HANDLE(chip->dev);
666 acpi_status status;
667
668 INIT_LIST_HEAD(&achip->conns);
669 mutex_init(&achip->conn_lock);
670 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
671 acpi_gpio_adr_space_handler,
672 NULL, achip);
673 if (ACPI_FAILURE(status))
674 dev_err(chip->dev, "Failed to install GPIO OpRegion handler\n");
675}
676
677static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
678{
679 struct gpio_chip *chip = achip->chip;
680 acpi_handle handle = ACPI_HANDLE(chip->dev);
681 struct acpi_gpio_connection *conn, *tmp;
682 acpi_status status;
683
684 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
685 acpi_gpio_adr_space_handler);
686 if (ACPI_FAILURE(status)) {
687 dev_err(chip->dev, "Failed to remove GPIO OpRegion handler\n");
688 return;
689 }
690
691 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
692 gpiochip_free_own_desc(conn->desc);
693 list_del(&conn->node);
694 kfree(conn);
695 }
696}
697
Mika Westerberg664e3e52014-01-08 12:40:54 +0200698void acpi_gpiochip_add(struct gpio_chip *chip)
699{
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200700 struct acpi_gpio_chip *acpi_gpio;
701 acpi_handle handle;
702 acpi_status status;
703
Mika Westerberge9595f82014-03-31 15:16:49 +0300704 if (!chip || !chip->dev)
705 return;
706
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200707 handle = ACPI_HANDLE(chip->dev);
708 if (!handle)
709 return;
710
711 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
712 if (!acpi_gpio) {
713 dev_err(chip->dev,
714 "Failed to allocate memory for ACPI GPIO chip\n");
715 return;
716 }
717
718 acpi_gpio->chip = chip;
719
720 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
721 if (ACPI_FAILURE(status)) {
722 dev_err(chip->dev, "Failed to attach ACPI GPIO chip\n");
723 kfree(acpi_gpio);
724 return;
725 }
726
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200727 acpi_gpiochip_request_regions(acpi_gpio);
Mika Westerberg664e3e52014-01-08 12:40:54 +0200728}
729
730void acpi_gpiochip_remove(struct gpio_chip *chip)
731{
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200732 struct acpi_gpio_chip *acpi_gpio;
733 acpi_handle handle;
734 acpi_status status;
735
Mika Westerberge9595f82014-03-31 15:16:49 +0300736 if (!chip || !chip->dev)
737 return;
738
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200739 handle = ACPI_HANDLE(chip->dev);
740 if (!handle)
741 return;
742
743 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
744 if (ACPI_FAILURE(status)) {
745 dev_warn(chip->dev, "Failed to retrieve ACPI GPIO chip\n");
746 return;
747 }
748
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200749 acpi_gpiochip_free_regions(acpi_gpio);
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200750
751 acpi_detach_data(handle, acpi_gpio_chip_dh);
752 kfree(acpi_gpio);
Mika Westerberg664e3e52014-01-08 12:40:54 +0200753}
Rojhalat Ibrahim66858522015-02-11 17:27:58 +0100754
755static unsigned int acpi_gpio_package_count(const union acpi_object *obj)
756{
757 const union acpi_object *element = obj->package.elements;
758 const union acpi_object *end = element + obj->package.count;
759 unsigned int count = 0;
760
761 while (element < end) {
762 if (element->type == ACPI_TYPE_LOCAL_REFERENCE)
763 count++;
764
765 element++;
766 }
767 return count;
768}
769
770static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
771{
772 unsigned int *count = data;
773
774 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
775 *count += ares->data.gpio.pin_table_length;
776
777 return 1;
778}
779
780/**
781 * acpi_gpio_count - return the number of GPIOs associated with a
782 * device / function or -ENOENT if no GPIO has been
783 * assigned to the requested function.
784 * @dev: GPIO consumer, can be NULL for system-global GPIOs
785 * @con_id: function within the GPIO consumer
786 */
787int acpi_gpio_count(struct device *dev, const char *con_id)
788{
789 struct acpi_device *adev = ACPI_COMPANION(dev);
790 const union acpi_object *obj;
791 const struct acpi_gpio_mapping *gm;
792 int count = -ENOENT;
793 int ret;
794 char propname[32];
795 unsigned int i;
796
797 /* Try first from _DSD */
798 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
799 if (con_id && strcmp(con_id, "gpios"))
800 snprintf(propname, sizeof(propname), "%s-%s",
801 con_id, gpio_suffixes[i]);
802 else
803 snprintf(propname, sizeof(propname), "%s",
804 gpio_suffixes[i]);
805
806 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
807 &obj);
808 if (ret == 0) {
809 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
810 count = 1;
811 else if (obj->type == ACPI_TYPE_PACKAGE)
812 count = acpi_gpio_package_count(obj);
813 } else if (adev->driver_gpios) {
814 for (gm = adev->driver_gpios; gm->name; gm++)
815 if (strcmp(propname, gm->name) == 0) {
816 count = gm->size;
817 break;
818 }
819 }
820 if (count >= 0)
821 break;
822 }
823
824 /* Then from plain _CRS GPIOs */
825 if (count < 0) {
826 struct list_head resource_list;
827 unsigned int crs_count = 0;
828
829 INIT_LIST_HEAD(&resource_list);
830 acpi_dev_get_resources(adev, &resource_list,
831 acpi_find_gpio_count, &crs_count);
832 acpi_dev_free_resource_list(&resource_list);
833 if (crs_count > 0)
834 count = crs_count;
835 }
836 return count;
837}