blob: a38cf16a582874eeb2592d4abfeaedd1053f6ee5 [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
Mika Westerberg4b01a142014-03-10 14:54:52 +0200307 INIT_LIST_HEAD(&acpi_gpio->events);
Rafael J. Wysocki1ecb0162015-03-10 23:10:01 +0100308 acpi_walk_resources(handle, "_AEI",
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200309 acpi_gpiochip_request_interrupt, acpi_gpio);
Mathias Nyman0d1c28a2013-01-28 16:23:10 +0200310}
Hanjun Guo2b528ff2015-06-10 17:12:07 +0800311EXPORT_SYMBOL_GPL(acpi_gpiochip_request_interrupts);
Rafael J. Wysocki7fc7acb2013-04-09 15:57:25 +0200312
Mika Westerberg70b534112013-10-10 11:01:07 +0300313/**
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200314 * acpi_gpiochip_free_interrupts() - Free GPIO ACPI event interrupts.
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300315 * @chip: GPIO chip
Mika Westerberg70b534112013-10-10 11:01:07 +0300316 *
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200317 * Free interrupts associated with GPIO ACPI event method for the given
318 * GPIO chip.
Mika Westerberg70b534112013-10-10 11:01:07 +0300319 */
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300320void acpi_gpiochip_free_interrupts(struct gpio_chip *chip)
Mika Westerberg70b534112013-10-10 11:01:07 +0300321{
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300322 struct acpi_gpio_chip *acpi_gpio;
Mika Westerberg4b01a142014-03-10 14:54:52 +0200323 struct acpi_gpio_event *event, *ep;
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300324 acpi_handle handle;
325 acpi_status status;
Mika Westerberg70b534112013-10-10 11:01:07 +0300326
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300327 if (!chip->dev || !chip->to_irq)
328 return;
329
330 handle = ACPI_HANDLE(chip->dev);
331 if (!handle)
332 return;
333
334 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
335 if (ACPI_FAILURE(status))
Mika Westerberg70b534112013-10-10 11:01:07 +0300336 return;
337
Mika Westerberg4b01a142014-03-10 14:54:52 +0200338 list_for_each_entry_safe_reverse(event, ep, &acpi_gpio->events, node) {
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200339 struct gpio_desc *desc;
340
341 free_irq(event->irq, event);
Alexandre Courbote46cf322014-08-19 10:06:08 -0700342 desc = event->desc;
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200343 if (WARN_ON(IS_ERR(desc)))
344 continue;
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900345 gpiochip_unlock_as_irq(chip, event->pin);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200346 gpiochip_free_own_desc(desc);
Mika Westerberg4b01a142014-03-10 14:54:52 +0200347 list_del(&event->node);
348 kfree(event);
Mika Westerberg70b534112013-10-10 11:01:07 +0300349 }
Mika Westerberg70b534112013-10-10 11:01:07 +0300350}
Hanjun Guo2b528ff2015-06-10 17:12:07 +0800351EXPORT_SYMBOL_GPL(acpi_gpiochip_free_interrupts);
Mika Westerberg70b534112013-10-10 11:01:07 +0300352
Rafael J. Wysockif028d522014-11-03 23:39:41 +0100353int acpi_dev_add_driver_gpios(struct acpi_device *adev,
354 const struct acpi_gpio_mapping *gpios)
355{
356 if (adev && gpios) {
357 adev->driver_gpios = gpios;
358 return 0;
359 }
360 return -EINVAL;
361}
362EXPORT_SYMBOL_GPL(acpi_dev_add_driver_gpios);
363
364static bool acpi_get_driver_gpio_data(struct acpi_device *adev,
365 const char *name, int index,
366 struct acpi_reference_args *args)
367{
368 const struct acpi_gpio_mapping *gm;
369
370 if (!adev->driver_gpios)
371 return false;
372
373 for (gm = adev->driver_gpios; gm->name; gm++)
374 if (!strcmp(name, gm->name) && gm->data && index < gm->size) {
375 const struct acpi_gpio_params *par = gm->data + index;
376
377 args->adev = adev;
378 args->args[0] = par->crs_entry_index;
379 args->args[1] = par->line_index;
380 args->args[2] = par->active_low;
381 args->nargs = 3;
382 return true;
383 }
384
385 return false;
386}
387
Mika Westerberg12028d22013-04-03 13:56:54 +0300388struct acpi_gpio_lookup {
389 struct acpi_gpio_info info;
390 int index;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100391 int pin_index;
Rafael J. Wysockid0795242015-08-27 04:41:33 +0200392 bool active_low;
393 struct acpi_device *adev;
Mika Westerberg936e15d2013-10-10 11:01:08 +0300394 struct gpio_desc *desc;
Mika Westerberg12028d22013-04-03 13:56:54 +0300395 int n;
396};
397
398static int acpi_find_gpio(struct acpi_resource *ares, void *data)
399{
400 struct acpi_gpio_lookup *lookup = data;
401
402 if (ares->type != ACPI_RESOURCE_TYPE_GPIO)
403 return 1;
404
Mika Westerberg936e15d2013-10-10 11:01:08 +0300405 if (lookup->n++ == lookup->index && !lookup->desc) {
Mika Westerberg12028d22013-04-03 13:56:54 +0300406 const struct acpi_resource_gpio *agpio = &ares->data.gpio;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100407 int pin_index = lookup->pin_index;
408
409 if (pin_index >= agpio->pin_table_length)
410 return 1;
Mika Westerberg12028d22013-04-03 13:56:54 +0300411
Mika Westerberg936e15d2013-10-10 11:01:08 +0300412 lookup->desc = acpi_get_gpiod(agpio->resource_source.string_ptr,
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100413 agpio->pin_table[pin_index]);
Mika Westerberg12028d22013-04-03 13:56:54 +0300414 lookup->info.gpioint =
415 agpio->connection_type == ACPI_RESOURCE_GPIO_TYPE_INT;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100416
417 /*
418 * ActiveLow is only specified for GpioInt resource. If
419 * GpioIo is used then the only way to set the flag is
420 * to use _DSD "gpios" property.
421 */
422 if (lookup->info.gpioint)
423 lookup->info.active_low =
424 agpio->polarity == ACPI_ACTIVE_LOW;
Mika Westerberg12028d22013-04-03 13:56:54 +0300425 }
426
427 return 1;
428}
429
Rafael J. Wysockid0795242015-08-27 04:41:33 +0200430static int acpi_gpio_resource_lookup(struct acpi_gpio_lookup *lookup,
431 struct acpi_gpio_info *info)
432{
433 struct list_head res_list;
434 int ret;
435
436 INIT_LIST_HEAD(&res_list);
437
438 ret = acpi_dev_get_resources(lookup->adev, &res_list, acpi_find_gpio,
439 lookup);
440 if (ret < 0)
441 return ret;
442
443 acpi_dev_free_resource_list(&res_list);
444
445 if (!lookup->desc)
446 return -ENOENT;
447
448 if (info) {
449 *info = lookup->info;
450 if (lookup->active_low)
451 info->active_low = lookup->active_low;
452 }
453 return 0;
454}
455
456static int acpi_gpio_property_lookup(struct acpi_device *adev,
457 const char *propname, int index,
458 struct acpi_gpio_lookup *lookup)
459{
460 struct acpi_reference_args args;
461 int ret;
462
463 memset(&args, 0, sizeof(args));
464 ret = acpi_dev_get_property_reference(adev, propname, index, &args);
465 if (ret && !acpi_get_driver_gpio_data(adev, propname, index, &args))
466 return ret;
467
468 /*
469 * The property was found and resolved, so need to lookup the GPIO based
470 * on returned args.
471 */
472 lookup->adev = args.adev;
473 if (args.nargs >= 2) {
474 lookup->index = args.args[0];
475 lookup->pin_index = args.args[1];
476 /* 3rd argument, if present is used to specify active_low. */
477 if (args.nargs >= 3)
478 lookup->active_low = !!args.args[2];
479 }
480 return 0;
481}
482
Mika Westerberg12028d22013-04-03 13:56:54 +0300483/**
Mika Westerberg936e15d2013-10-10 11:01:08 +0300484 * acpi_get_gpiod_by_index() - get a GPIO descriptor from device resources
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100485 * @adev: pointer to a ACPI device to get GPIO from
486 * @propname: Property name of the GPIO (optional)
Mika Westerberg12028d22013-04-03 13:56:54 +0300487 * @index: index of GpioIo/GpioInt resource (starting from %0)
488 * @info: info pointer to fill in (optional)
489 *
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100490 * Function goes through ACPI resources for @adev and based on @index looks
Mika Westerberg936e15d2013-10-10 11:01:08 +0300491 * up a GpioIo/GpioInt resource, translates it to the Linux GPIO descriptor,
Mika Westerberg12028d22013-04-03 13:56:54 +0300492 * and returns it. @index matches GpioIo/GpioInt resources only so if there
493 * are total %3 GPIO resources, the index goes from %0 to %2.
494 *
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100495 * If @propname is specified the GPIO is looked using device property. In
496 * that case @index is used to select the GPIO entry in the property value
497 * (in case of multiple).
498 *
Mika Westerberg936e15d2013-10-10 11:01:08 +0300499 * If the GPIO cannot be translated or there is an error an ERR_PTR is
Mika Westerberg12028d22013-04-03 13:56:54 +0300500 * returned.
501 *
502 * Note: if the GPIO resource has multiple entries in the pin list, this
503 * function only returns the first.
504 */
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100505struct gpio_desc *acpi_get_gpiod_by_index(struct acpi_device *adev,
506 const char *propname, int index,
Mika Westerberg936e15d2013-10-10 11:01:08 +0300507 struct acpi_gpio_info *info)
Mika Westerberg12028d22013-04-03 13:56:54 +0300508{
509 struct acpi_gpio_lookup lookup;
Mika Westerberg12028d22013-04-03 13:56:54 +0300510 int ret;
511
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100512 if (!adev)
Mika Westerberg936e15d2013-10-10 11:01:08 +0300513 return ERR_PTR(-ENODEV);
Mika Westerberg12028d22013-04-03 13:56:54 +0300514
515 memset(&lookup, 0, sizeof(lookup));
516 lookup.index = index;
Mika Westerberg12028d22013-04-03 13:56:54 +0300517
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100518 if (propname) {
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100519 dev_dbg(&adev->dev, "GPIO: looking up %s\n", propname);
520
Rafael J. Wysockid0795242015-08-27 04:41:33 +0200521 ret = acpi_gpio_property_lookup(adev, propname, index, &lookup);
522 if (ret)
523 return ERR_PTR(ret);
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100524
Rafael J. Wysockid0795242015-08-27 04:41:33 +0200525 dev_dbg(&adev->dev, "GPIO: _DSD returned %s %d %d %u\n",
526 dev_name(&lookup.adev->dev), lookup.index,
527 lookup.pin_index, lookup.active_low);
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100528 } else {
529 dev_dbg(&adev->dev, "GPIO: looking up %d in _CRS\n", index);
Rafael J. Wysockid0795242015-08-27 04:41:33 +0200530 lookup.adev = adev;
Mika Westerberg0d9a6932014-10-29 15:41:01 +0100531 }
532
Rafael J. Wysockid0795242015-08-27 04:41:33 +0200533 ret = acpi_gpio_resource_lookup(&lookup, info);
534 return ret ? ERR_PTR(ret) : lookup.desc;
Mika Westerberg12028d22013-04-03 13:56:54 +0300535}
Mika Westerberg664e3e52014-01-08 12:40:54 +0200536
Mika Westerbergc884fbd2015-05-06 13:29:06 +0300537/**
538 * acpi_dev_gpio_irq_get() - Find GpioInt and translate it to Linux IRQ number
539 * @adev: pointer to a ACPI device to get IRQ from
540 * @index: index of GpioInt resource (starting from %0)
541 *
542 * If the device has one or more GpioInt resources, this function can be
543 * used to translate from the GPIO offset in the resource to the Linux IRQ
544 * number.
545 *
546 * Return: Linux IRQ number (>%0) on success, negative errno on failure.
547 */
548int acpi_dev_gpio_irq_get(struct acpi_device *adev, int index)
549{
550 int idx, i;
551
552 for (i = 0, idx = 0; idx <= index; i++) {
553 struct acpi_gpio_info info;
554 struct gpio_desc *desc;
555
556 desc = acpi_get_gpiod_by_index(adev, NULL, i, &info);
557 if (IS_ERR(desc))
558 break;
559 if (info.gpioint && idx++ == index)
560 return gpiod_to_irq(desc);
561 }
562 return -ENOENT;
563}
564EXPORT_SYMBOL_GPL(acpi_dev_gpio_irq_get);
565
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200566static acpi_status
567acpi_gpio_adr_space_handler(u32 function, acpi_physical_address address,
568 u32 bits, u64 *value, void *handler_context,
569 void *region_context)
570{
571 struct acpi_gpio_chip *achip = region_context;
572 struct gpio_chip *chip = achip->chip;
573 struct acpi_resource_gpio *agpio;
574 struct acpi_resource *ares;
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800575 int pin_index = (int)address;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200576 acpi_status status;
577 bool pull_up;
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800578 int length;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200579 int i;
580
581 status = acpi_buffer_to_resource(achip->conn_info.connection,
582 achip->conn_info.length, &ares);
583 if (ACPI_FAILURE(status))
584 return status;
585
586 if (WARN_ON(ares->type != ACPI_RESOURCE_TYPE_GPIO)) {
587 ACPI_FREE(ares);
588 return AE_BAD_PARAMETER;
589 }
590
591 agpio = &ares->data.gpio;
592 pull_up = agpio->pin_config == ACPI_PIN_CONFIG_PULLUP;
593
594 if (WARN_ON(agpio->io_restriction == ACPI_IO_RESTRICT_INPUT &&
595 function == ACPI_WRITE)) {
596 ACPI_FREE(ares);
597 return AE_BAD_PARAMETER;
598 }
599
Srinivas Pandruvadac15d8212014-09-23 10:35:54 +0800600 length = min(agpio->pin_table_length, (u16)(pin_index + bits));
601 for (i = pin_index; i < length; ++i) {
Qipeng Zhaa4811622015-04-10 06:25:10 +0800602 int pin = agpio->pin_table[i];
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200603 struct acpi_gpio_connection *conn;
604 struct gpio_desc *desc;
605 bool found;
606
qipeng.zha4de60972015-03-11 01:15:38 +0800607 pin = acpi_gpiochip_pin_to_gpio_offset(chip, pin);
608 if (pin < 0) {
609 status = AE_BAD_PARAMETER;
610 goto out;
611 }
612
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200613 mutex_lock(&achip->conn_lock);
614
615 found = false;
616 list_for_each_entry(conn, &achip->conns, node) {
Alexandre Courbote46cf322014-08-19 10:06:08 -0700617 if (conn->pin == pin) {
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200618 found = true;
Alexandre Courbote46cf322014-08-19 10:06:08 -0700619 desc = conn->desc;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200620 break;
621 }
622 }
623 if (!found) {
Alexandre Courbotabdc08a2014-08-19 10:06:09 -0700624 desc = gpiochip_request_own_desc(chip, pin,
625 "ACPI:OpRegion");
Alexandre Courbote46cf322014-08-19 10:06:08 -0700626 if (IS_ERR(desc)) {
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200627 status = AE_ERROR;
628 mutex_unlock(&achip->conn_lock);
629 goto out;
630 }
631
632 switch (agpio->io_restriction) {
633 case ACPI_IO_RESTRICT_INPUT:
634 gpiod_direction_input(desc);
635 break;
636 case ACPI_IO_RESTRICT_OUTPUT:
637 /*
638 * ACPI GPIO resources don't contain an
639 * initial value for the GPIO. Therefore we
640 * deduce that value from the pull field
641 * instead. If the pin is pulled up we
642 * assume default to be high, otherwise
643 * low.
644 */
645 gpiod_direction_output(desc, pull_up);
646 break;
647 default:
648 /*
649 * Assume that the BIOS has configured the
650 * direction and pull accordingly.
651 */
652 break;
653 }
654
655 conn = kzalloc(sizeof(*conn), GFP_KERNEL);
656 if (!conn) {
657 status = AE_NO_MEMORY;
658 gpiochip_free_own_desc(desc);
659 mutex_unlock(&achip->conn_lock);
660 goto out;
661 }
662
Alexandre Courbote46cf322014-08-19 10:06:08 -0700663 conn->pin = pin;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200664 conn->desc = desc;
665 list_add_tail(&conn->node, &achip->conns);
666 }
667
668 mutex_unlock(&achip->conn_lock);
669
670 if (function == ACPI_WRITE)
Aaron Ludc62b562014-05-20 17:07:38 +0800671 gpiod_set_raw_value_cansleep(desc,
672 !!((1 << i) & *value));
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200673 else
Aaron Ludc62b562014-05-20 17:07:38 +0800674 *value |= (u64)gpiod_get_raw_value_cansleep(desc) << i;
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200675 }
676
677out:
678 ACPI_FREE(ares);
679 return status;
680}
681
682static void acpi_gpiochip_request_regions(struct acpi_gpio_chip *achip)
683{
684 struct gpio_chip *chip = achip->chip;
685 acpi_handle handle = ACPI_HANDLE(chip->dev);
686 acpi_status status;
687
688 INIT_LIST_HEAD(&achip->conns);
689 mutex_init(&achip->conn_lock);
690 status = acpi_install_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
691 acpi_gpio_adr_space_handler,
692 NULL, achip);
693 if (ACPI_FAILURE(status))
694 dev_err(chip->dev, "Failed to install GPIO OpRegion handler\n");
695}
696
697static void acpi_gpiochip_free_regions(struct acpi_gpio_chip *achip)
698{
699 struct gpio_chip *chip = achip->chip;
700 acpi_handle handle = ACPI_HANDLE(chip->dev);
701 struct acpi_gpio_connection *conn, *tmp;
702 acpi_status status;
703
704 status = acpi_remove_address_space_handler(handle, ACPI_ADR_SPACE_GPIO,
705 acpi_gpio_adr_space_handler);
706 if (ACPI_FAILURE(status)) {
707 dev_err(chip->dev, "Failed to remove GPIO OpRegion handler\n");
708 return;
709 }
710
711 list_for_each_entry_safe_reverse(conn, tmp, &achip->conns, node) {
712 gpiochip_free_own_desc(conn->desc);
713 list_del(&conn->node);
714 kfree(conn);
715 }
716}
717
Mika Westerberg664e3e52014-01-08 12:40:54 +0200718void acpi_gpiochip_add(struct gpio_chip *chip)
719{
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200720 struct acpi_gpio_chip *acpi_gpio;
721 acpi_handle handle;
722 acpi_status status;
723
Mika Westerberge9595f82014-03-31 15:16:49 +0300724 if (!chip || !chip->dev)
725 return;
726
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200727 handle = ACPI_HANDLE(chip->dev);
728 if (!handle)
729 return;
730
731 acpi_gpio = kzalloc(sizeof(*acpi_gpio), GFP_KERNEL);
732 if (!acpi_gpio) {
733 dev_err(chip->dev,
734 "Failed to allocate memory for ACPI GPIO chip\n");
735 return;
736 }
737
738 acpi_gpio->chip = chip;
739
740 status = acpi_attach_data(handle, acpi_gpio_chip_dh, acpi_gpio);
741 if (ACPI_FAILURE(status)) {
742 dev_err(chip->dev, "Failed to attach ACPI GPIO chip\n");
743 kfree(acpi_gpio);
744 return;
745 }
746
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200747 acpi_gpiochip_request_regions(acpi_gpio);
Mika Westerberg664e3e52014-01-08 12:40:54 +0200748}
749
750void acpi_gpiochip_remove(struct gpio_chip *chip)
751{
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200752 struct acpi_gpio_chip *acpi_gpio;
753 acpi_handle handle;
754 acpi_status status;
755
Mika Westerberge9595f82014-03-31 15:16:49 +0300756 if (!chip || !chip->dev)
757 return;
758
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200759 handle = ACPI_HANDLE(chip->dev);
760 if (!handle)
761 return;
762
763 status = acpi_get_data(handle, acpi_gpio_chip_dh, (void **)&acpi_gpio);
764 if (ACPI_FAILURE(status)) {
765 dev_warn(chip->dev, "Failed to retrieve ACPI GPIO chip\n");
766 return;
767 }
768
Mika Westerberg473ed7b2014-03-14 17:58:07 +0200769 acpi_gpiochip_free_regions(acpi_gpio);
Mika Westerbergaa92b6f2014-03-10 14:54:51 +0200770
771 acpi_detach_data(handle, acpi_gpio_chip_dh);
772 kfree(acpi_gpio);
Mika Westerberg664e3e52014-01-08 12:40:54 +0200773}
Rojhalat Ibrahim66858522015-02-11 17:27:58 +0100774
775static unsigned int acpi_gpio_package_count(const union acpi_object *obj)
776{
777 const union acpi_object *element = obj->package.elements;
778 const union acpi_object *end = element + obj->package.count;
779 unsigned int count = 0;
780
781 while (element < end) {
782 if (element->type == ACPI_TYPE_LOCAL_REFERENCE)
783 count++;
784
785 element++;
786 }
787 return count;
788}
789
790static int acpi_find_gpio_count(struct acpi_resource *ares, void *data)
791{
792 unsigned int *count = data;
793
794 if (ares->type == ACPI_RESOURCE_TYPE_GPIO)
795 *count += ares->data.gpio.pin_table_length;
796
797 return 1;
798}
799
800/**
801 * acpi_gpio_count - return the number of GPIOs associated with a
802 * device / function or -ENOENT if no GPIO has been
803 * assigned to the requested function.
804 * @dev: GPIO consumer, can be NULL for system-global GPIOs
805 * @con_id: function within the GPIO consumer
806 */
807int acpi_gpio_count(struct device *dev, const char *con_id)
808{
809 struct acpi_device *adev = ACPI_COMPANION(dev);
810 const union acpi_object *obj;
811 const struct acpi_gpio_mapping *gm;
812 int count = -ENOENT;
813 int ret;
814 char propname[32];
815 unsigned int i;
816
817 /* Try first from _DSD */
818 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
819 if (con_id && strcmp(con_id, "gpios"))
820 snprintf(propname, sizeof(propname), "%s-%s",
821 con_id, gpio_suffixes[i]);
822 else
823 snprintf(propname, sizeof(propname), "%s",
824 gpio_suffixes[i]);
825
826 ret = acpi_dev_get_property(adev, propname, ACPI_TYPE_ANY,
827 &obj);
828 if (ret == 0) {
829 if (obj->type == ACPI_TYPE_LOCAL_REFERENCE)
830 count = 1;
831 else if (obj->type == ACPI_TYPE_PACKAGE)
832 count = acpi_gpio_package_count(obj);
833 } else if (adev->driver_gpios) {
834 for (gm = adev->driver_gpios; gm->name; gm++)
835 if (strcmp(propname, gm->name) == 0) {
836 count = gm->size;
837 break;
838 }
839 }
840 if (count >= 0)
841 break;
842 }
843
844 /* Then from plain _CRS GPIOs */
845 if (count < 0) {
846 struct list_head resource_list;
847 unsigned int crs_count = 0;
848
849 INIT_LIST_HEAD(&resource_list);
850 acpi_dev_get_resources(adev, &resource_list,
851 acpi_find_gpio_count, &crs_count);
852 acpi_dev_free_resource_list(&resource_list);
853 if (crs_count > 0)
854 count = crs_count;
855 }
856 return count;
857}