blob: bb3195d5e3af003c748f948b86c91403c17e94dd [file] [log] [blame]
David Brownelld2876d02008-02-04 22:28:20 -08001#include <linux/kernel.h>
2#include <linux/module.h>
Daniel Glöcknerff77c352009-09-22 16:46:38 -07003#include <linux/interrupt.h>
David Brownelld2876d02008-02-04 22:28:20 -08004#include <linux/irq.h>
5#include <linux/spinlock.h>
Alexandre Courbot1a989d02013-02-03 01:29:24 +09006#include <linux/list.h>
David Brownelld8f388d82008-07-25 01:46:07 -07007#include <linux/device.h>
8#include <linux/err.h>
9#include <linux/debugfs.h>
10#include <linux/seq_file.h>
11#include <linux/gpio.h>
Anton Vorontsov391c9702010-06-08 07:48:17 -060012#include <linux/of_gpio.h>
Daniel Glöcknerff77c352009-09-22 16:46:38 -070013#include <linux/idr.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090014#include <linux/slab.h>
Rafael J. Wysocki7b199812013-11-11 22:41:56 +010015#include <linux/acpi.h>
Alexandre Courbot53e7cac2013-11-16 21:44:52 +090016#include <linux/gpio/driver.h>
Linus Walleij0a6d3152014-07-24 20:08:55 +020017#include <linux/gpio/machine.h>
Jonas Gorskic771c2f2015-10-11 17:34:15 +020018#include <linux/pinctrl/consumer.h>
Linus Walleijff2b1352015-10-20 11:10:38 +020019#include <linux/idr.h>
Linus Walleij3c702e92015-10-21 15:29:53 +020020#include <linux/cdev.h>
21#include <linux/fs.h>
22#include <linux/uaccess.h>
23#include <uapi/linux/gpio.h>
David Brownelld2876d02008-02-04 22:28:20 -080024
Mika Westerberg664e3e52014-01-08 12:40:54 +020025#include "gpiolib.h"
26
Uwe Kleine-König3f397c212011-05-20 00:40:19 -060027#define CREATE_TRACE_POINTS
28#include <trace/events/gpio.h>
David Brownelld2876d02008-02-04 22:28:20 -080029
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070030/* Implementation infrastructure for GPIO interfaces.
David Brownelld2876d02008-02-04 22:28:20 -080031 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070032 * The GPIO programming interface allows for inlining speed-critical
33 * get/set operations for common cases, so that access to SOC-integrated
34 * GPIOs can sometimes cost only an instruction or two per bit.
David Brownelld2876d02008-02-04 22:28:20 -080035 */
36
37
38/* When debugging, extend minimal trust to callers and platform code.
39 * Also emit diagnostic messages that may help initial bringup, when
40 * board setup or driver bugs are most common.
41 *
42 * Otherwise, minimize overhead in what may be bitbanging codepaths.
43 */
44#ifdef DEBUG
45#define extra_checks 1
46#else
47#define extra_checks 0
48#endif
49
Linus Walleijff2b1352015-10-20 11:10:38 +020050/* Device and char device-related information */
51static DEFINE_IDA(gpio_ida);
Linus Walleij3c702e92015-10-21 15:29:53 +020052static dev_t gpio_devt;
53#define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
54static struct bus_type gpio_bus_type = {
55 .name = "gpio",
56};
Linus Walleijff2b1352015-10-20 11:10:38 +020057
David Brownelld2876d02008-02-04 22:28:20 -080058/* gpio_lock prevents conflicts during gpio_desc[] table updates.
59 * While any GPIO is requested, its gpio_chip is not removable;
60 * each GPIO's "requested" flag serves as a lock and refcount.
61 */
Alexandre Courbot0eb4c6c2014-07-01 14:45:15 +090062DEFINE_SPINLOCK(gpio_lock);
David Brownelld2876d02008-02-04 22:28:20 -080063
Alexandre Courbotbae48da2013-10-17 10:21:38 -070064static DEFINE_MUTEX(gpio_lookup_lock);
65static LIST_HEAD(gpio_lookup_list);
Linus Walleijff2b1352015-10-20 11:10:38 +020066LIST_HEAD(gpio_devices);
Johan Hovold6d867502015-05-04 17:23:25 +020067
68static void gpiochip_free_hogs(struct gpio_chip *chip);
69static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
70
71
David Brownelld2876d02008-02-04 22:28:20 -080072static inline void desc_set_label(struct gpio_desc *d, const char *label)
73{
David Brownelld2876d02008-02-04 22:28:20 -080074 d->label = label;
David Brownelld2876d02008-02-04 22:28:20 -080075}
76
Alexandre Courbot372e7222013-02-03 01:29:29 +090077/**
78 * Convert a GPIO number to its descriptor
79 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070080struct gpio_desc *gpio_to_desc(unsigned gpio)
Alexandre Courbot372e7222013-02-03 01:29:29 +090081{
Linus Walleijff2b1352015-10-20 11:10:38 +020082 struct gpio_device *gdev;
Alexandre Courbot14e85c02014-11-19 16:51:27 +090083 unsigned long flags;
84
85 spin_lock_irqsave(&gpio_lock, flags);
86
Linus Walleijff2b1352015-10-20 11:10:38 +020087 list_for_each_entry(gdev, &gpio_devices, list) {
Linus Walleijfdeb8e12016-02-10 10:57:36 +010088 if (gdev->base <= gpio &&
89 gdev->base + gdev->ngpio > gpio) {
Alexandre Courbot14e85c02014-11-19 16:51:27 +090090 spin_unlock_irqrestore(&gpio_lock, flags);
Linus Walleijfdeb8e12016-02-10 10:57:36 +010091 return &gdev->descs[gpio - gdev->base];
Alexandre Courbot14e85c02014-11-19 16:51:27 +090092 }
93 }
94
95 spin_unlock_irqrestore(&gpio_lock, flags);
96
Alexandre Courbot0e9a5ed2014-12-02 23:15:05 +090097 if (!gpio_is_valid(gpio))
98 WARN(1, "invalid GPIO %d\n", gpio);
99
Alexandre Courbot14e85c02014-11-19 16:51:27 +0900100 return NULL;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900101}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700102EXPORT_SYMBOL_GPL(gpio_to_desc);
Alexandre Courbot372e7222013-02-03 01:29:29 +0900103
104/**
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +0900105 * Get the GPIO descriptor corresponding to the given hw number for this chip.
Linus Walleijd468bf92013-09-24 11:54:38 +0200106 */
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +0900107struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
108 u16 hwnum)
Linus Walleijd468bf92013-09-24 11:54:38 +0200109{
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100110 struct gpio_device *gdev = chip->gpiodev;
111
112 if (hwnum >= gdev->ngpio)
Alexandre Courbotb7d0a282013-12-03 12:31:11 +0900113 return ERR_PTR(-EINVAL);
Linus Walleijd468bf92013-09-24 11:54:38 +0200114
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100115 return &gdev->descs[hwnum];
Linus Walleijd468bf92013-09-24 11:54:38 +0200116}
Alexandre Courbot372e7222013-02-03 01:29:29 +0900117
118/**
119 * Convert a GPIO descriptor to the integer namespace.
120 * This should disappear in the future but is needed since we still
121 * use GPIO numbers for error messages and sysfs nodes
122 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700123int desc_to_gpio(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +0900124{
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100125 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
Alexandre Courbot372e7222013-02-03 01:29:29 +0900126}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700127EXPORT_SYMBOL_GPL(desc_to_gpio);
Alexandre Courbot372e7222013-02-03 01:29:29 +0900128
129
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700130/**
131 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
132 * @desc: descriptor to return the chip of
133 */
134struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +0900135{
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100136 if (!desc || !desc->gdev || !desc->gdev->chip)
137 return NULL;
138 return desc->gdev->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900139}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700140EXPORT_SYMBOL_GPL(gpiod_to_chip);
David Brownelld2876d02008-02-04 22:28:20 -0800141
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700142/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
143static int gpiochip_find_base(int ngpio)
144{
Linus Walleijff2b1352015-10-20 11:10:38 +0200145 struct gpio_device *gdev;
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900146 int base = ARCH_NR_GPIOS - ngpio;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700147
Linus Walleijff2b1352015-10-20 11:10:38 +0200148 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900149 /* found a free space? */
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100150 if (gdev->base + gdev->ngpio <= base)
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900151 break;
152 else
153 /* nope, check the space right before the chip */
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100154 base = gdev->base - ngpio;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700155 }
156
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900157 if (gpio_is_valid(base)) {
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700158 pr_debug("%s: found new base at %d\n", __func__, base);
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900159 return base;
160 } else {
161 pr_err("%s: cannot find free range\n", __func__);
162 return -ENOSPC;
Anton Vorontsov169b6a72008-04-28 02:14:47 -0700163 }
Anton Vorontsov169b6a72008-04-28 02:14:47 -0700164}
165
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700166/**
167 * gpiod_get_direction - return the current direction of a GPIO
168 * @desc: GPIO to get the direction of
169 *
170 * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error.
171 *
172 * This function may sleep if gpiod_cansleep() is true.
173 */
Alexandre Courbot8e53b0f2014-11-25 17:16:31 +0900174int gpiod_get_direction(struct gpio_desc *desc)
Mathias Nyman80b0a602012-10-24 17:25:27 +0300175{
176 struct gpio_chip *chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900177 unsigned offset;
Mathias Nyman80b0a602012-10-24 17:25:27 +0300178 int status = -EINVAL;
179
Alexandre Courbot372e7222013-02-03 01:29:29 +0900180 chip = gpiod_to_chip(desc);
181 offset = gpio_chip_hwgpio(desc);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300182
183 if (!chip->get_direction)
184 return status;
185
Alexandre Courbot372e7222013-02-03 01:29:29 +0900186 status = chip->get_direction(chip, offset);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300187 if (status > 0) {
188 /* GPIOF_DIR_IN, or other positive */
189 status = 1;
Alexandre Courbot8e53b0f2014-11-25 17:16:31 +0900190 clear_bit(FLAG_IS_OUT, &desc->flags);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300191 }
192 if (status == 0) {
193 /* GPIOF_DIR_OUT */
Alexandre Courbot8e53b0f2014-11-25 17:16:31 +0900194 set_bit(FLAG_IS_OUT, &desc->flags);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300195 }
196 return status;
197}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700198EXPORT_SYMBOL_GPL(gpiod_get_direction);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300199
Alexandre Courbot1a989d02013-02-03 01:29:24 +0900200/*
201 * Add a new chip to the global chips list, keeping the list of chips sorted
Bamvor Jian Zhangef7c7552015-11-16 13:02:46 +0800202 * by range(means [base, base + ngpio - 1]) order.
Alexandre Courbot1a989d02013-02-03 01:29:24 +0900203 *
204 * Return -EBUSY if the new chip overlaps with some other chip's integer
205 * space.
206 */
Linus Walleijff2b1352015-10-20 11:10:38 +0200207static int gpiodev_add_to_list(struct gpio_device *gdev)
Alexandre Courbot1a989d02013-02-03 01:29:24 +0900208{
Bamvor Jian Zhanga961f9b2016-02-26 22:37:14 +0800209 struct gpio_device *prev, *next;
Linus Walleijff2b1352015-10-20 11:10:38 +0200210
211 if (list_empty(&gpio_devices)) {
Bamvor Jian Zhanga961f9b2016-02-26 22:37:14 +0800212 /* initial entry in list */
Linus Walleijff2b1352015-10-20 11:10:38 +0200213 list_add_tail(&gdev->list, &gpio_devices);
Sudip Mukherjeee28ecca2015-12-27 19:06:50 +0530214 return 0;
Alexandre Courbot1a989d02013-02-03 01:29:24 +0900215 }
216
Bamvor Jian Zhanga961f9b2016-02-26 22:37:14 +0800217 next = list_entry(gpio_devices.next, struct gpio_device, list);
218 if (gdev->base + gdev->ngpio <= next->base) {
219 /* add before first entry */
220 list_add(&gdev->list, &gpio_devices);
Julien Grossholtz96098df2016-01-07 16:46:45 -0500221 return 0;
222 }
Alexandre Courbot1a989d02013-02-03 01:29:24 +0900223
Bamvor Jian Zhanga961f9b2016-02-26 22:37:14 +0800224 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
225 if (prev->base + prev->ngpio <= gdev->base) {
226 /* add behind last entry */
227 list_add_tail(&gdev->list, &gpio_devices);
228 return 0;
229 }
Bamvor Jian Zhangef7c7552015-11-16 13:02:46 +0800230
Bamvor Jian Zhanga961f9b2016-02-26 22:37:14 +0800231 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
232 /* at the end of the list */
233 if (&next->list == &gpio_devices)
234 break;
235
236 /* add between prev and next */
237 if (prev->base + prev->ngpio <= gdev->base
238 && gdev->base + gdev->ngpio <= next->base) {
239 list_add(&gdev->list, &prev->list);
240 return 0;
241 }
242 }
243
244 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
245 return -EBUSY;
Alexandre Courbot1a989d02013-02-03 01:29:24 +0900246}
247
Linus Walleijf881bab02015-09-23 16:20:43 -0700248/**
249 * Convert a GPIO name to its descriptor
250 */
251static struct gpio_desc *gpio_name_to_desc(const char * const name)
252{
Linus Walleijff2b1352015-10-20 11:10:38 +0200253 struct gpio_device *gdev;
Linus Walleijf881bab02015-09-23 16:20:43 -0700254 unsigned long flags;
255
256 spin_lock_irqsave(&gpio_lock, flags);
257
Linus Walleijff2b1352015-10-20 11:10:38 +0200258 list_for_each_entry(gdev, &gpio_devices, list) {
Linus Walleijf881bab02015-09-23 16:20:43 -0700259 int i;
260
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100261 for (i = 0; i != gdev->ngpio; ++i) {
262 struct gpio_desc *desc = &gdev->descs[i];
Linus Walleijf881bab02015-09-23 16:20:43 -0700263
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100264 if (!desc->name || !name)
Linus Walleijf881bab02015-09-23 16:20:43 -0700265 continue;
266
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100267 if (!strcmp(desc->name, name)) {
Linus Walleijf881bab02015-09-23 16:20:43 -0700268 spin_unlock_irqrestore(&gpio_lock, flags);
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100269 return desc;
Linus Walleijf881bab02015-09-23 16:20:43 -0700270 }
271 }
272 }
273
274 spin_unlock_irqrestore(&gpio_lock, flags);
275
276 return NULL;
277}
278
Markus Pargmann5f3ca732015-08-14 16:11:00 +0200279/*
280 * Takes the names from gc->names and checks if they are all unique. If they
281 * are, they are assigned to their gpio descriptors.
282 *
Bamvor Jian Zhanged379152015-11-14 16:43:20 +0800283 * Warning if one of the names is already used for a different GPIO.
Markus Pargmann5f3ca732015-08-14 16:11:00 +0200284 */
285static int gpiochip_set_desc_names(struct gpio_chip *gc)
286{
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100287 struct gpio_device *gdev = gc->gpiodev;
Markus Pargmann5f3ca732015-08-14 16:11:00 +0200288 int i;
289
290 if (!gc->names)
291 return 0;
292
293 /* First check all names if they are unique */
294 for (i = 0; i != gc->ngpio; ++i) {
295 struct gpio_desc *gpio;
296
297 gpio = gpio_name_to_desc(gc->names[i]);
Linus Walleijf881bab02015-09-23 16:20:43 -0700298 if (gpio)
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100299 dev_warn(&gdev->dev,
Linus Walleij34ffd852015-10-20 11:31:54 +0200300 "Detected name collision for GPIO name '%s'\n",
Linus Walleijf881bab02015-09-23 16:20:43 -0700301 gc->names[i]);
Markus Pargmann5f3ca732015-08-14 16:11:00 +0200302 }
303
304 /* Then add all names to the GPIO descriptors */
305 for (i = 0; i != gc->ngpio; ++i)
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100306 gdev->descs[i].name = gc->names[i];
Markus Pargmann5f3ca732015-08-14 16:11:00 +0200307
308 return 0;
309}
310
Linus Walleij3c702e92015-10-21 15:29:53 +0200311/**
312 * gpio_ioctl() - ioctl handler for the GPIO chardev
313 */
314static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
315{
316 struct gpio_device *gdev = filp->private_data;
317 struct gpio_chip *chip = gdev->chip;
318 int __user *ip = (int __user *)arg;
Linus Walleij3c702e92015-10-21 15:29:53 +0200319
320 /* We fail any subsequent ioctl():s when the chip is gone */
321 if (!chip)
322 return -ENODEV;
323
Linus Walleij521a2ad2016-02-12 22:25:22 +0100324 /* Fill in the struct and pass to userspace */
Linus Walleij3c702e92015-10-21 15:29:53 +0200325 if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
Linus Walleij521a2ad2016-02-12 22:25:22 +0100326 struct gpiochip_info chipinfo;
327
Linus Walleij3c702e92015-10-21 15:29:53 +0200328 strncpy(chipinfo.name, dev_name(&gdev->dev),
329 sizeof(chipinfo.name));
330 chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
Linus Walleijdf4878e2016-02-12 14:48:23 +0100331 strncpy(chipinfo.label, gdev->label,
332 sizeof(chipinfo.label));
333 chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100334 chipinfo.lines = gdev->ngpio;
Linus Walleij3c702e92015-10-21 15:29:53 +0200335 if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
336 return -EFAULT;
337 return 0;
Linus Walleij521a2ad2016-02-12 22:25:22 +0100338 } else if (cmd == GPIO_GET_LINEINFO_IOCTL) {
339 struct gpioline_info lineinfo;
340 struct gpio_desc *desc;
341
342 if (copy_from_user(&lineinfo, ip, sizeof(lineinfo)))
343 return -EFAULT;
344 if (lineinfo.line_offset > gdev->ngpio)
345 return -EINVAL;
346
347 desc = &gdev->descs[lineinfo.line_offset];
348 if (desc->name) {
349 strncpy(lineinfo.name, desc->name,
350 sizeof(lineinfo.name));
351 lineinfo.name[sizeof(lineinfo.name)-1] = '\0';
352 } else {
353 lineinfo.name[0] = '\0';
354 }
355 if (desc->label) {
Linus Walleij214338e2016-02-25 21:01:48 +0100356 strncpy(lineinfo.consumer, desc->label,
357 sizeof(lineinfo.consumer));
358 lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
Linus Walleij521a2ad2016-02-12 22:25:22 +0100359 } else {
Linus Walleij214338e2016-02-25 21:01:48 +0100360 lineinfo.consumer[0] = '\0';
Linus Walleij521a2ad2016-02-12 22:25:22 +0100361 }
362
363 /*
364 * Userspace only need to know that the kernel is using
365 * this GPIO so it can't use it.
366 */
367 lineinfo.flags = 0;
Linus Walleij9d8cc892016-02-22 13:44:53 +0100368 if (test_bit(FLAG_REQUESTED, &desc->flags) ||
369 test_bit(FLAG_IS_HOGGED, &desc->flags) ||
370 test_bit(FLAG_USED_AS_IRQ, &desc->flags) ||
371 test_bit(FLAG_EXPORT, &desc->flags) ||
372 test_bit(FLAG_SYSFS, &desc->flags))
Linus Walleij521a2ad2016-02-12 22:25:22 +0100373 lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
Linus Walleij9d8cc892016-02-22 13:44:53 +0100374 if (test_bit(FLAG_IS_OUT, &desc->flags))
Linus Walleij521a2ad2016-02-12 22:25:22 +0100375 lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
Linus Walleij9d8cc892016-02-22 13:44:53 +0100376 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
Linus Walleij521a2ad2016-02-12 22:25:22 +0100377 lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
Linus Walleij9d8cc892016-02-22 13:44:53 +0100378 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
Linus Walleij521a2ad2016-02-12 22:25:22 +0100379 lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
Linus Walleij9d8cc892016-02-22 13:44:53 +0100380 if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
Linus Walleij521a2ad2016-02-12 22:25:22 +0100381 lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;
382
383 if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
384 return -EFAULT;
385 return 0;
Linus Walleij3c702e92015-10-21 15:29:53 +0200386 }
387 return -EINVAL;
388}
389
390/**
391 * gpio_chrdev_open() - open the chardev for ioctl operations
392 * @inode: inode for this chardev
393 * @filp: file struct for storing private data
394 * Returns 0 on success
395 */
396static int gpio_chrdev_open(struct inode *inode, struct file *filp)
397{
398 struct gpio_device *gdev = container_of(inode->i_cdev,
399 struct gpio_device, chrdev);
400
401 /* Fail on open if the backing gpiochip is gone */
402 if (!gdev || !gdev->chip)
403 return -ENODEV;
404 get_device(&gdev->dev);
405 filp->private_data = gdev;
406 return 0;
407}
408
409/**
410 * gpio_chrdev_release() - close chardev after ioctl operations
411 * @inode: inode for this chardev
412 * @filp: file struct for storing private data
413 * Returns 0 on success
414 */
415static int gpio_chrdev_release(struct inode *inode, struct file *filp)
416{
417 struct gpio_device *gdev = container_of(inode->i_cdev,
418 struct gpio_device, chrdev);
419
420 if (!gdev)
421 return -ENODEV;
422 put_device(&gdev->dev);
423 return 0;
424}
425
426
427static const struct file_operations gpio_fileops = {
428 .release = gpio_chrdev_release,
429 .open = gpio_chrdev_open,
430 .owner = THIS_MODULE,
431 .llseek = noop_llseek,
432 .unlocked_ioctl = gpio_ioctl,
433 .compat_ioctl = gpio_ioctl,
434};
435
Linus Walleijff2b1352015-10-20 11:10:38 +0200436static void gpiodevice_release(struct device *dev)
437{
438 struct gpio_device *gdev = dev_get_drvdata(dev);
439
Linus Walleij3c702e92015-10-21 15:29:53 +0200440 cdev_del(&gdev->chrdev);
Linus Walleijff2b1352015-10-20 11:10:38 +0200441 list_del(&gdev->list);
442 ida_simple_remove(&gpio_ida, gdev->id);
Linus Walleij9efd9e62016-02-09 14:27:42 +0100443 kfree(gdev);
Linus Walleijff2b1352015-10-20 11:10:38 +0200444}
445
Anton Vorontsov169b6a72008-04-28 02:14:47 -0700446/**
Linus Walleijb08ea352015-12-03 15:14:13 +0100447 * gpiochip_add_data() - register a gpio_chip
David Brownelld2876d02008-02-04 22:28:20 -0800448 * @chip: the chip to register, with chip->base initialized
Alexandre Courbot14e85c02014-11-19 16:51:27 +0900449 * Context: potentially before irqs will work
David Brownelld2876d02008-02-04 22:28:20 -0800450 *
451 * Returns a negative errno if the chip can't be registered, such as
452 * because the chip->base is invalid or already associated with a
453 * different chip. Otherwise it returns zero as a success code.
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700454 *
Linus Walleijb08ea352015-12-03 15:14:13 +0100455 * When gpiochip_add_data() is called very early during boot, so that GPIOs
Bamvor Jian Zhangc88402c2015-11-18 17:07:07 +0800456 * can be freely used, the chip->parent device must be registered before
David Brownelld8f388d82008-07-25 01:46:07 -0700457 * the gpio framework's arch_initcall(). Otherwise sysfs initialization
458 * for GPIOs will fail rudely.
459 *
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700460 * If chip->base is negative, this requests dynamic assignment of
461 * a range of valid GPIOs.
David Brownelld2876d02008-02-04 22:28:20 -0800462 */
Linus Walleijb08ea352015-12-03 15:14:13 +0100463int gpiochip_add_data(struct gpio_chip *chip, void *data)
David Brownelld2876d02008-02-04 22:28:20 -0800464{
465 unsigned long flags;
466 int status = 0;
Linus Walleijff2b1352015-10-20 11:10:38 +0200467 unsigned i;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700468 int base = chip->base;
Linus Walleijff2b1352015-10-20 11:10:38 +0200469 struct gpio_device *gdev;
David Brownelld2876d02008-02-04 22:28:20 -0800470
Linus Walleijff2b1352015-10-20 11:10:38 +0200471 /*
472 * First: allocate and populate the internal stat container, and
473 * set up the struct device.
474 */
Josh Cartwright969f07b2016-02-17 16:44:15 -0600475 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
Linus Walleijff2b1352015-10-20 11:10:38 +0200476 if (!gdev)
Alexandre Courbot14e85c02014-11-19 16:51:27 +0900477 return -ENOMEM;
Linus Walleij3c702e92015-10-21 15:29:53 +0200478 gdev->dev.bus = &gpio_bus_type;
Linus Walleijff2b1352015-10-20 11:10:38 +0200479 gdev->chip = chip;
480 chip->gpiodev = gdev;
481 if (chip->parent) {
482 gdev->dev.parent = chip->parent;
483 gdev->dev.of_node = chip->parent->of_node;
484 } else {
485#ifdef CONFIG_OF_GPIO
486 /* If the gpiochip has an assigned OF node this takes precedence */
487 if (chip->of_node)
488 gdev->dev.of_node = chip->of_node;
489#endif
490 }
491 gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
492 if (gdev->id < 0) {
493 status = gdev->id;
494 goto err_free_gdev;
495 }
496 dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
497 device_initialize(&gdev->dev);
498 dev_set_drvdata(&gdev->dev, gdev);
499 if (chip->parent && chip->parent->driver)
500 gdev->owner = chip->parent->driver->owner;
501 else if (chip->owner)
502 /* TODO: remove chip->owner */
503 gdev->owner = chip->owner;
504 else
505 gdev->owner = THIS_MODULE;
David Brownelld2876d02008-02-04 22:28:20 -0800506
Linus Walleij1c3cdb12016-02-09 13:51:59 +0100507 gdev->descs = devm_kcalloc(&gdev->dev, chip->ngpio,
508 sizeof(gdev->descs[0]), GFP_KERNEL);
509 if (!gdev->descs) {
Linus Walleijff2b1352015-10-20 11:10:38 +0200510 status = -ENOMEM;
511 goto err_free_gdev;
512 }
513
Bamvor Jian Zhang5ed41cc2015-11-16 13:02:47 +0800514 if (chip->ngpio == 0) {
515 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
Linus Walleijff2b1352015-10-20 11:10:38 +0200516 status = -EINVAL;
Linus Walleij1c3cdb12016-02-09 13:51:59 +0100517 goto err_free_gdev;
Bamvor Jian Zhang5ed41cc2015-11-16 13:02:47 +0800518 }
Linus Walleijdf4878e2016-02-12 14:48:23 +0100519
520 if (chip->label)
521 gdev->label = devm_kstrdup(&gdev->dev, chip->label, GFP_KERNEL);
522 else
523 gdev->label = devm_kstrdup(&gdev->dev, "unknown", GFP_KERNEL);
524 if (!gdev->label) {
525 status = -ENOMEM;
526 goto err_free_gdev;
527 }
528
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100529 gdev->ngpio = chip->ngpio;
Linus Walleij43c54ec2016-02-11 11:37:48 +0100530 gdev->data = data;
Bamvor Jian Zhang5ed41cc2015-11-16 13:02:47 +0800531
David Brownelld2876d02008-02-04 22:28:20 -0800532 spin_lock_irqsave(&gpio_lock, flags);
533
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100534 /*
535 * TODO: this allocates a Linux GPIO number base in the global
536 * GPIO numberspace for this chip. In the long run we want to
537 * get *rid* of this numberspace and use only descriptors, but
538 * it may be a pipe dream. It will not happen before we get rid
539 * of the sysfs interface anyways.
540 */
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700541 if (base < 0) {
542 base = gpiochip_find_base(chip->ngpio);
543 if (base < 0) {
544 status = base;
Johan Hovold225fce82015-01-12 17:12:25 +0100545 spin_unlock_irqrestore(&gpio_lock, flags);
Linus Walleij1c3cdb12016-02-09 13:51:59 +0100546 goto err_free_gdev;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700547 }
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100548 /*
549 * TODO: it should not be necessary to reflect the assigned
550 * base outside of the GPIO subsystem. Go over drivers and
551 * see if anyone makes use of this, else drop this and assign
552 * a poison instead.
553 */
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700554 chip->base = base;
555 }
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100556 gdev->base = base;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700557
Linus Walleijff2b1352015-10-20 11:10:38 +0200558 status = gpiodev_add_to_list(gdev);
Johan Hovold05aa5202015-01-12 17:12:26 +0100559 if (status) {
560 spin_unlock_irqrestore(&gpio_lock, flags);
Linus Walleij1c3cdb12016-02-09 13:51:59 +0100561 goto err_free_gdev;
Johan Hovold05aa5202015-01-12 17:12:26 +0100562 }
Alexandre Courbot1a989d02013-02-03 01:29:24 +0900563
Linus Walleijff2b1352015-10-20 11:10:38 +0200564 for (i = 0; i < chip->ngpio; i++) {
Linus Walleij1c3cdb12016-02-09 13:51:59 +0100565 struct gpio_desc *desc = &gdev->descs[i];
David Brownelld8f388d82008-07-25 01:46:07 -0700566
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100567 desc->gdev = gdev;
Johan Hovold05aa5202015-01-12 17:12:26 +0100568
569 /* REVISIT: most hardware initializes GPIOs as inputs (often
570 * with pullups enabled) so power usage is minimized. Linux
571 * code should set the gpio direction first thing; but until
572 * it does, and in case chip->get_direction is not set, we may
573 * expose the wrong direction in sysfs.
574 */
575 desc->flags = !chip->direction_input ? (1 << FLAG_IS_OUT) : 0;
David Brownelld2876d02008-02-04 22:28:20 -0800576 }
Alexandre Courbot14e85c02014-11-19 16:51:27 +0900577
Zhangfei Gao3bae4812013-06-09 11:08:32 +0800578 spin_unlock_irqrestore(&gpio_lock, flags);
579
Shiraz Hashimf23f1512012-10-27 15:21:36 +0530580#ifdef CONFIG_PINCTRL
Linus Walleij20ec3e32016-02-11 11:03:06 +0100581 INIT_LIST_HEAD(&gdev->pin_ranges);
Shiraz Hashimf23f1512012-10-27 15:21:36 +0530582#endif
583
Markus Pargmann5f3ca732015-08-14 16:11:00 +0200584 status = gpiochip_set_desc_names(chip);
585 if (status)
586 goto err_remove_from_list;
587
Tomeu Vizoso28355f82015-07-14 10:29:54 +0200588 status = of_gpiochip_add(chip);
589 if (status)
590 goto err_remove_chip;
591
Mika Westerberg664e3e52014-01-08 12:40:54 +0200592 acpi_gpiochip_add(chip);
Anton Vorontsov391c9702010-06-08 07:48:17 -0600593
Linus Walleij3c702e92015-10-21 15:29:53 +0200594 /*
595 * By first adding the chardev, and then adding the device,
596 * we get a device node entry in sysfs under
597 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
598 * coldplug of device nodes and other udev business.
599 */
600 cdev_init(&gdev->chrdev, &gpio_fileops);
601 gdev->chrdev.owner = THIS_MODULE;
602 gdev->chrdev.kobj.parent = &gdev->dev.kobj;
603 gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id);
604 status = cdev_add(&gdev->chrdev, gdev->dev.devt, 1);
605 if (status < 0)
606 chip_warn(chip, "failed to add char device %d:%d\n",
607 MAJOR(gpio_devt), gdev->id);
608 else
609 chip_dbg(chip, "added GPIO chardev (%d:%d)\n",
610 MAJOR(gpio_devt), gdev->id);
Linus Walleijff2b1352015-10-20 11:10:38 +0200611 status = device_add(&gdev->dev);
Johan Hovold225fce82015-01-12 17:12:25 +0100612 if (status)
Linus Walleij3c702e92015-10-21 15:29:53 +0200613 goto err_remove_chardev;
Anton Vorontsovcedb1882010-06-08 07:48:15 -0600614
Linus Walleijafbc4f32016-02-09 13:21:06 +0100615 status = gpiochip_sysfs_register(gdev);
Linus Walleijff2b1352015-10-20 11:10:38 +0200616 if (status)
617 goto err_remove_device;
618
619 /* From this point, the .release() function cleans up gpio_device */
620 gdev->dev.release = gpiodevice_release;
621 get_device(&gdev->dev);
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100622 pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n",
623 __func__, gdev->base, gdev->base + gdev->ngpio - 1,
624 dev_name(&gdev->dev), chip->label ? : "generic");
Grant Likely64842aa2011-11-06 11:36:18 -0700625
Anton Vorontsovcedb1882010-06-08 07:48:15 -0600626 return 0;
Zhangfei Gao3bae4812013-06-09 11:08:32 +0800627
Linus Walleijff2b1352015-10-20 11:10:38 +0200628err_remove_device:
629 device_del(&gdev->dev);
Linus Walleij3c702e92015-10-21 15:29:53 +0200630err_remove_chardev:
631 cdev_del(&gdev->chrdev);
Johan Hovold225fce82015-01-12 17:12:25 +0100632err_remove_chip:
633 acpi_gpiochip_remove(chip);
Johan Hovold6d867502015-05-04 17:23:25 +0200634 gpiochip_free_hogs(chip);
Johan Hovold225fce82015-01-12 17:12:25 +0100635 of_gpiochip_remove(chip);
Markus Pargmann5f3ca732015-08-14 16:11:00 +0200636err_remove_from_list:
Johan Hovold225fce82015-01-12 17:12:25 +0100637 spin_lock_irqsave(&gpio_lock, flags);
Linus Walleijff2b1352015-10-20 11:10:38 +0200638 list_del(&gdev->list);
Zhangfei Gao3bae4812013-06-09 11:08:32 +0800639 spin_unlock_irqrestore(&gpio_lock, flags);
Linus Walleijff2b1352015-10-20 11:10:38 +0200640err_free_gdev:
641 ida_simple_remove(&gpio_ida, gdev->id);
David Brownelld2876d02008-02-04 22:28:20 -0800642 /* failures here can mean systems won't boot... */
Andy Shevchenko7589e592013-12-05 11:26:23 +0200643 pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100644 gdev->base, gdev->base + gdev->ngpio - 1,
645 chip->label ? : "generic");
646 kfree(gdev);
David Brownelld2876d02008-02-04 22:28:20 -0800647 return status;
648}
Linus Walleijb08ea352015-12-03 15:14:13 +0100649EXPORT_SYMBOL_GPL(gpiochip_add_data);
David Brownelld2876d02008-02-04 22:28:20 -0800650
651/**
Linus Walleij43c54ec2016-02-11 11:37:48 +0100652 * gpiochip_get_data() - get per-subdriver data for the chip
653 */
654void *gpiochip_get_data(struct gpio_chip *chip)
655{
656 return chip->gpiodev->data;
657}
658EXPORT_SYMBOL_GPL(gpiochip_get_data);
659
660/**
David Brownelld2876d02008-02-04 22:28:20 -0800661 * gpiochip_remove() - unregister a gpio_chip
662 * @chip: the chip to unregister
663 *
664 * A gpio_chip with any GPIOs still requested may not be removed.
665 */
abdoulaye berthee1db1702014-07-05 18:28:50 +0200666void gpiochip_remove(struct gpio_chip *chip)
David Brownelld2876d02008-02-04 22:28:20 -0800667{
Linus Walleijff2b1352015-10-20 11:10:38 +0200668 struct gpio_device *gdev = chip->gpiodev;
Johan Hovoldfab28b82015-05-04 17:10:27 +0200669 struct gpio_desc *desc;
David Brownelld2876d02008-02-04 22:28:20 -0800670 unsigned long flags;
Linus Walleij1c3cdb12016-02-09 13:51:59 +0100671 unsigned i;
Johan Hovoldfab28b82015-05-04 17:10:27 +0200672 bool requested = false;
David Brownelld2876d02008-02-04 22:28:20 -0800673
Linus Walleijff2b1352015-10-20 11:10:38 +0200674 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
Linus Walleijafbc4f32016-02-09 13:21:06 +0100675 gpiochip_sysfs_unregister(gdev);
Bamvor Jian Zhangbd203bd2016-02-20 13:13:19 +0800676 /* Numb the device, cancelling all outstanding operations */
677 gdev->chip = NULL;
Johan Hovold00acc3d2015-01-12 17:12:27 +0100678 gpiochip_irqchip_remove(chip);
Mika Westerberg6072b9d2014-03-10 14:54:53 +0200679 acpi_gpiochip_remove(chip);
Linus Walleij9ef0d6f2012-11-06 15:15:44 +0100680 gpiochip_remove_pin_ranges(chip);
Benoit Parrotf625d462015-02-02 11:44:44 -0600681 gpiochip_free_hogs(chip);
Anton Vorontsov391c9702010-06-08 07:48:17 -0600682 of_gpiochip_remove(chip);
Linus Walleij43c54ec2016-02-11 11:37:48 +0100683 /*
684 * We accept no more calls into the driver from this point, so
685 * NULL the driver data pointer
686 */
687 gdev->data = NULL;
Anton Vorontsov391c9702010-06-08 07:48:17 -0600688
Johan Hovold6798aca2015-01-12 17:12:28 +0100689 spin_lock_irqsave(&gpio_lock, flags);
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100690 for (i = 0; i < gdev->ngpio; i++) {
Linus Walleij1c3cdb12016-02-09 13:51:59 +0100691 desc = &gdev->descs[i];
Johan Hovoldfab28b82015-05-04 17:10:27 +0200692 if (test_bit(FLAG_REQUESTED, &desc->flags))
693 requested = true;
David Brownelld2876d02008-02-04 22:28:20 -0800694 }
David Brownelld2876d02008-02-04 22:28:20 -0800695 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbot14e85c02014-11-19 16:51:27 +0900696
Johan Hovoldfab28b82015-05-04 17:10:27 +0200697 if (requested)
Linus Walleijfdeb8e12016-02-10 10:57:36 +0100698 dev_crit(&gdev->dev,
Linus Walleij58383c782015-11-04 09:56:26 +0100699 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
Johan Hovoldfab28b82015-05-04 17:10:27 +0200700
Linus Walleijff2b1352015-10-20 11:10:38 +0200701 /*
702 * The gpiochip side puts its use of the device to rest here:
703 * if there are no userspace clients, the chardev and device will
704 * be removed, else it will be dangling until the last user is
705 * gone.
706 */
707 put_device(&gdev->dev);
David Brownelld2876d02008-02-04 22:28:20 -0800708}
709EXPORT_SYMBOL_GPL(gpiochip_remove);
710
Laxman Dewangan0cf32922016-02-15 16:32:09 +0530711static void devm_gpio_chip_release(struct device *dev, void *res)
712{
713 struct gpio_chip *chip = *(struct gpio_chip **)res;
714
715 gpiochip_remove(chip);
716}
717
718static int devm_gpio_chip_match(struct device *dev, void *res, void *data)
719
720{
721 struct gpio_chip **r = res;
722
723 if (!r || !*r) {
724 WARN_ON(!r || !*r);
725 return 0;
726 }
727
728 return *r == data;
729}
730
731/**
732 * devm_gpiochip_add_data() - Resource manager piochip_add_data()
733 * @dev: the device pointer on which irq_chip belongs to.
734 * @chip: the chip to register, with chip->base initialized
735 * Context: potentially before irqs will work
736 *
737 * Returns a negative errno if the chip can't be registered, such as
738 * because the chip->base is invalid or already associated with a
739 * different chip. Otherwise it returns zero as a success code.
740 *
741 * The gpio chip automatically be released when the device is unbound.
742 */
743int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
744 void *data)
745{
746 struct gpio_chip **ptr;
747 int ret;
748
749 ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
750 GFP_KERNEL);
751 if (!ptr)
752 return -ENOMEM;
753
754 ret = gpiochip_add_data(chip, data);
755 if (ret < 0) {
756 devres_free(ptr);
757 return ret;
758 }
759
760 *ptr = chip;
761 devres_add(dev, ptr);
762
763 return 0;
764}
765EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);
766
767/**
768 * devm_gpiochip_remove() - Resource manager of gpiochip_remove()
769 * @dev: device for which which resource was allocated
770 * @chip: the chip to remove
771 *
772 * A gpio_chip with any GPIOs still requested may not be removed.
773 */
774void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip)
775{
776 int ret;
777
778 ret = devres_release(dev, devm_gpio_chip_release,
779 devm_gpio_chip_match, chip);
780 if (!ret)
781 WARN_ON(ret);
782}
783EXPORT_SYMBOL_GPL(devm_gpiochip_remove);
784
Grant Likely594fa262010-06-08 07:48:16 -0600785/**
786 * gpiochip_find() - iterator for locating a specific gpio_chip
787 * @data: data to pass to match function
788 * @callback: Callback function to check gpio_chip
789 *
790 * Similar to bus_find_device. It returns a reference to a gpio_chip as
791 * determined by a user supplied @match callback. The callback should return
792 * 0 if the device doesn't match and non-zero if it does. If the callback is
793 * non-zero, this function will return to the caller and not iterate over any
794 * more gpio_chips.
795 */
Grant Likely07ce8ec2012-05-18 23:01:05 -0600796struct gpio_chip *gpiochip_find(void *data,
Grant Likely6e2cf652012-03-02 15:56:03 -0700797 int (*match)(struct gpio_chip *chip,
Grant Likely3d0f7cf2012-05-17 13:54:40 -0600798 void *data))
Grant Likely594fa262010-06-08 07:48:16 -0600799{
Linus Walleijff2b1352015-10-20 11:10:38 +0200800 struct gpio_device *gdev;
Alexandre Courbot125eef92013-02-03 01:29:26 +0900801 struct gpio_chip *chip;
Grant Likely594fa262010-06-08 07:48:16 -0600802 unsigned long flags;
Grant Likely594fa262010-06-08 07:48:16 -0600803
804 spin_lock_irqsave(&gpio_lock, flags);
Linus Walleijff2b1352015-10-20 11:10:38 +0200805 list_for_each_entry(gdev, &gpio_devices, list)
806 if (match(gdev->chip, data))
Grant Likely594fa262010-06-08 07:48:16 -0600807 break;
Alexandre Courbot125eef92013-02-03 01:29:26 +0900808
809 /* No match? */
Linus Walleijff2b1352015-10-20 11:10:38 +0200810 if (&gdev->list == &gpio_devices)
Alexandre Courbot125eef92013-02-03 01:29:26 +0900811 chip = NULL;
Linus Walleijff2b1352015-10-20 11:10:38 +0200812 else
813 chip = gdev->chip;
814
Grant Likely594fa262010-06-08 07:48:16 -0600815 spin_unlock_irqrestore(&gpio_lock, flags);
816
817 return chip;
818}
Jean Delvare8fa0c9b2011-05-20 00:40:18 -0600819EXPORT_SYMBOL_GPL(gpiochip_find);
David Brownelld2876d02008-02-04 22:28:20 -0800820
Alexandre Courbot79697ef2013-11-16 21:39:32 +0900821static int gpiochip_match_name(struct gpio_chip *chip, void *data)
822{
823 const char *name = data;
824
825 return !strcmp(chip->label, name);
826}
827
828static struct gpio_chip *find_chip_by_name(const char *name)
829{
830 return gpiochip_find((void *)name, gpiochip_match_name);
831}
832
Linus Walleij14250522014-03-25 10:40:18 +0100833#ifdef CONFIG_GPIOLIB_IRQCHIP
834
835/*
836 * The following is irqchip helper code for gpiochips.
837 */
838
839/**
Linus Walleij3f97d5fc2014-09-26 14:19:52 +0200840 * gpiochip_set_chained_irqchip() - sets a chained irqchip to a gpiochip
841 * @gpiochip: the gpiochip to set the irqchip chain to
842 * @irqchip: the irqchip to chain to the gpiochip
Linus Walleij14250522014-03-25 10:40:18 +0100843 * @parent_irq: the irq number corresponding to the parent IRQ for this
844 * chained irqchip
845 * @parent_handler: the parent interrupt handler for the accumulated IRQ
Linus Walleij3f97d5fc2014-09-26 14:19:52 +0200846 * coming out of the gpiochip. If the interrupt is nested rather than
847 * cascaded, pass NULL in this handler argument
Linus Walleij14250522014-03-25 10:40:18 +0100848 */
849void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
850 struct irq_chip *irqchip,
851 int parent_irq,
852 irq_flow_handler_t parent_handler)
853{
Linus Walleij83141a72014-09-26 13:50:12 +0200854 unsigned int offset;
855
Linus Walleij83141a72014-09-26 13:50:12 +0200856 if (!gpiochip->irqdomain) {
857 chip_err(gpiochip, "called %s before setting up irqchip\n",
858 __func__);
Linus Walleij1c8732b2014-04-09 13:34:39 +0200859 return;
860 }
861
Linus Walleij3f97d5fc2014-09-26 14:19:52 +0200862 if (parent_handler) {
863 if (gpiochip->can_sleep) {
864 chip_err(gpiochip,
865 "you cannot have chained interrupts on a "
866 "chip that may sleep\n");
867 return;
868 }
Linus Walleij3f97d5fc2014-09-26 14:19:52 +0200869 /*
870 * The parent irqchip is already using the chip_data for this
871 * irqchip, so our callbacks simply use the handler_data.
872 */
Thomas Gleixnerf7f87752015-06-21 21:10:48 +0200873 irq_set_chained_handler_and_data(parent_irq, parent_handler,
874 gpiochip);
Dmitry Eremin-Solenikov25e4fe92015-05-12 20:12:23 +0300875
876 gpiochip->irq_parent = parent_irq;
Linus Walleij3f97d5fc2014-09-26 14:19:52 +0200877 }
Linus Walleij83141a72014-09-26 13:50:12 +0200878
879 /* Set the parent IRQ for all affected IRQs */
880 for (offset = 0; offset < gpiochip->ngpio; offset++)
881 irq_set_parent(irq_find_mapping(gpiochip->irqdomain, offset),
882 parent_irq);
Linus Walleij14250522014-03-25 10:40:18 +0100883}
884EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
885
886/**
887 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
888 * @d: the irqdomain used by this irqchip
889 * @irq: the global irq number used by this GPIO irqchip irq
890 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
891 *
892 * This function will set up the mapping for a certain IRQ line on a
893 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
894 * stored inside the gpiochip.
895 */
896static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
897 irq_hw_number_t hwirq)
898{
899 struct gpio_chip *chip = d->host_data;
900
Linus Walleij14250522014-03-25 10:40:18 +0100901 irq_set_chip_data(irq, chip);
Grygorii Strashkoa0a8bcf2015-08-17 15:35:23 +0300902 /*
903 * This lock class tells lockdep that GPIO irqs are in a different
904 * category than their parents, so it won't report false recursion.
905 */
906 irq_set_lockdep_class(irq, chip->lock_key);
Linus Walleij7633fb92014-04-09 13:20:38 +0200907 irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
Linus Walleij1c8732b2014-04-09 13:34:39 +0200908 /* Chips that can sleep need nested thread handlers */
Octavian Purdila295494a2014-09-19 23:22:44 +0300909 if (chip->can_sleep && !chip->irq_not_threaded)
Linus Walleij1c8732b2014-04-09 13:34:39 +0200910 irq_set_nested_thread(irq, 1);
Linus Walleij14250522014-03-25 10:40:18 +0100911 irq_set_noprobe(irq);
Rob Herring23393d42015-07-27 15:55:16 -0500912
Linus Walleij1333b902014-04-23 16:45:12 +0200913 /*
914 * No set-up of the hardware will happen if IRQ_TYPE_NONE
915 * is passed as default type.
916 */
917 if (chip->irq_default_type != IRQ_TYPE_NONE)
918 irq_set_irq_type(irq, chip->irq_default_type);
Linus Walleij14250522014-03-25 10:40:18 +0100919
920 return 0;
921}
922
Linus Walleijc3626fd2014-03-28 20:42:01 +0100923static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
924{
Linus Walleij1c8732b2014-04-09 13:34:39 +0200925 struct gpio_chip *chip = d->host_data;
926
Linus Walleij1c8732b2014-04-09 13:34:39 +0200927 if (chip->can_sleep)
928 irq_set_nested_thread(irq, 0);
Linus Walleijc3626fd2014-03-28 20:42:01 +0100929 irq_set_chip_and_handler(irq, NULL, NULL);
930 irq_set_chip_data(irq, NULL);
931}
932
Linus Walleij14250522014-03-25 10:40:18 +0100933static const struct irq_domain_ops gpiochip_domain_ops = {
934 .map = gpiochip_irq_map,
Linus Walleijc3626fd2014-03-28 20:42:01 +0100935 .unmap = gpiochip_irq_unmap,
Linus Walleij14250522014-03-25 10:40:18 +0100936 /* Virtually all GPIO irqchips are twocell:ed */
937 .xlate = irq_domain_xlate_twocell,
938};
939
940static int gpiochip_irq_reqres(struct irq_data *d)
941{
942 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
943
Linus Walleijff2b1352015-10-20 11:10:38 +0200944 if (!try_module_get(chip->gpiodev->owner))
Grygorii Strashko5b76e792015-06-25 20:30:50 +0300945 return -ENODEV;
946
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900947 if (gpiochip_lock_as_irq(chip, d->hwirq)) {
Linus Walleij14250522014-03-25 10:40:18 +0100948 chip_err(chip,
949 "unable to lock HW IRQ %lu for IRQ\n",
950 d->hwirq);
Linus Walleijff2b1352015-10-20 11:10:38 +0200951 module_put(chip->gpiodev->owner);
Linus Walleij14250522014-03-25 10:40:18 +0100952 return -EINVAL;
953 }
954 return 0;
955}
956
957static void gpiochip_irq_relres(struct irq_data *d)
958{
959 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
960
Alexandre Courbote3a2e872014-10-23 17:27:07 +0900961 gpiochip_unlock_as_irq(chip, d->hwirq);
Linus Walleijff2b1352015-10-20 11:10:38 +0200962 module_put(chip->gpiodev->owner);
Linus Walleij14250522014-03-25 10:40:18 +0100963}
964
965static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
966{
967 return irq_find_mapping(chip->irqdomain, offset);
968}
969
970/**
971 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
972 * @gpiochip: the gpiochip to remove the irqchip from
973 *
974 * This is called only from gpiochip_remove()
975 */
976static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
977{
Linus Walleijc3626fd2014-03-28 20:42:01 +0100978 unsigned int offset;
979
Mika Westerbergafa82fa2014-07-25 09:54:48 +0300980 acpi_gpiochip_free_interrupts(gpiochip);
981
Dmitry Eremin-Solenikov25e4fe92015-05-12 20:12:23 +0300982 if (gpiochip->irq_parent) {
983 irq_set_chained_handler(gpiochip->irq_parent, NULL);
984 irq_set_handler_data(gpiochip->irq_parent, NULL);
985 }
986
Linus Walleijc3626fd2014-03-28 20:42:01 +0100987 /* Remove all IRQ mappings and delete the domain */
988 if (gpiochip->irqdomain) {
989 for (offset = 0; offset < gpiochip->ngpio; offset++)
Grygorii Strashkoe3893382014-09-25 19:09:23 +0300990 irq_dispose_mapping(
991 irq_find_mapping(gpiochip->irqdomain, offset));
Linus Walleij14250522014-03-25 10:40:18 +0100992 irq_domain_remove(gpiochip->irqdomain);
Linus Walleijc3626fd2014-03-28 20:42:01 +0100993 }
Linus Walleij14250522014-03-25 10:40:18 +0100994
995 if (gpiochip->irqchip) {
996 gpiochip->irqchip->irq_request_resources = NULL;
997 gpiochip->irqchip->irq_release_resources = NULL;
998 gpiochip->irqchip = NULL;
999 }
1000}
1001
1002/**
1003 * gpiochip_irqchip_add() - adds an irqchip to a gpiochip
1004 * @gpiochip: the gpiochip to add the irqchip to
1005 * @irqchip: the irqchip to add to the gpiochip
1006 * @first_irq: if not dynamically assigned, the base (first) IRQ to
1007 * allocate gpiochip irqs from
1008 * @handler: the irq handler to use (often a predefined irq core function)
Linus Walleij1333b902014-04-23 16:45:12 +02001009 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
1010 * to have the core avoid setting up any default type in the hardware.
Grygorii Strashkoa0a8bcf2015-08-17 15:35:23 +03001011 * @lock_key: lockdep class
Linus Walleij14250522014-03-25 10:40:18 +01001012 *
1013 * This function closely associates a certain irqchip with a certain
1014 * gpiochip, providing an irq domain to translate the local IRQs to
1015 * global irqs in the gpiolib core, and making sure that the gpiochip
1016 * is passed as chip data to all related functions. Driver callbacks
Linus Walleij09dd5f92015-12-07 15:31:58 +01001017 * need to use gpiochip_get_data() to get their local state containers back
Linus Walleij14250522014-03-25 10:40:18 +01001018 * from the gpiochip passed as chip data. An irqdomain will be stored
1019 * in the gpiochip that shall be used by the driver to handle IRQ number
1020 * translation. The gpiochip will need to be initialized and registered
1021 * before calling this function.
1022 *
Linus Walleijc3626fd2014-03-28 20:42:01 +01001023 * This function will handle two cell:ed simple IRQs and assumes all
1024 * the pins on the gpiochip can generate a unique IRQ. Everything else
Linus Walleij14250522014-03-25 10:40:18 +01001025 * need to be open coded.
1026 */
Grygorii Strashkoa0a8bcf2015-08-17 15:35:23 +03001027int _gpiochip_irqchip_add(struct gpio_chip *gpiochip,
1028 struct irq_chip *irqchip,
1029 unsigned int first_irq,
1030 irq_flow_handler_t handler,
1031 unsigned int type,
1032 struct lock_class_key *lock_key)
Linus Walleij14250522014-03-25 10:40:18 +01001033{
1034 struct device_node *of_node;
1035 unsigned int offset;
Linus Walleijc3626fd2014-03-28 20:42:01 +01001036 unsigned irq_base = 0;
Linus Walleij14250522014-03-25 10:40:18 +01001037
1038 if (!gpiochip || !irqchip)
1039 return -EINVAL;
1040
Linus Walleij58383c782015-11-04 09:56:26 +01001041 if (!gpiochip->parent) {
Linus Walleij14250522014-03-25 10:40:18 +01001042 pr_err("missing gpiochip .dev parent pointer\n");
1043 return -EINVAL;
1044 }
Linus Walleij58383c782015-11-04 09:56:26 +01001045 of_node = gpiochip->parent->of_node;
Linus Walleij14250522014-03-25 10:40:18 +01001046#ifdef CONFIG_OF_GPIO
1047 /*
Colin Cronin20a8a962015-05-18 11:41:43 -07001048 * If the gpiochip has an assigned OF node this takes precedence
Bamvor Jian Zhangc88402c2015-11-18 17:07:07 +08001049 * FIXME: get rid of this and use gpiochip->parent->of_node
1050 * everywhere
Linus Walleij14250522014-03-25 10:40:18 +01001051 */
1052 if (gpiochip->of_node)
1053 of_node = gpiochip->of_node;
1054#endif
1055 gpiochip->irqchip = irqchip;
1056 gpiochip->irq_handler = handler;
1057 gpiochip->irq_default_type = type;
1058 gpiochip->to_irq = gpiochip_to_irq;
Grygorii Strashkoa0a8bcf2015-08-17 15:35:23 +03001059 gpiochip->lock_key = lock_key;
Linus Walleij14250522014-03-25 10:40:18 +01001060 gpiochip->irqdomain = irq_domain_add_simple(of_node,
1061 gpiochip->ngpio, first_irq,
1062 &gpiochip_domain_ops, gpiochip);
1063 if (!gpiochip->irqdomain) {
1064 gpiochip->irqchip = NULL;
1065 return -EINVAL;
1066 }
Rabin Vincent8b67a1f2015-07-31 14:48:56 +02001067
1068 /*
1069 * It is possible for a driver to override this, but only if the
1070 * alternative functions are both implemented.
1071 */
1072 if (!irqchip->irq_request_resources &&
1073 !irqchip->irq_release_resources) {
1074 irqchip->irq_request_resources = gpiochip_irq_reqres;
1075 irqchip->irq_release_resources = gpiochip_irq_relres;
1076 }
Linus Walleij14250522014-03-25 10:40:18 +01001077
1078 /*
1079 * Prepare the mapping since the irqchip shall be orthogonal to
1080 * any gpiochip calls. If the first_irq was zero, this is
1081 * necessary to allocate descriptors for all IRQs.
1082 */
Linus Walleijc3626fd2014-03-28 20:42:01 +01001083 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1084 irq_base = irq_create_mapping(gpiochip->irqdomain, offset);
1085 if (offset == 0)
1086 /*
1087 * Store the base into the gpiochip to be used when
1088 * unmapping the irqs.
1089 */
1090 gpiochip->irq_base = irq_base;
1091 }
Linus Walleij14250522014-03-25 10:40:18 +01001092
Mika Westerbergafa82fa2014-07-25 09:54:48 +03001093 acpi_gpiochip_request_interrupts(gpiochip);
1094
Linus Walleij14250522014-03-25 10:40:18 +01001095 return 0;
1096}
Grygorii Strashkoa0a8bcf2015-08-17 15:35:23 +03001097EXPORT_SYMBOL_GPL(_gpiochip_irqchip_add);
Linus Walleij14250522014-03-25 10:40:18 +01001098
1099#else /* CONFIG_GPIOLIB_IRQCHIP */
1100
1101static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
1102
1103#endif /* CONFIG_GPIOLIB_IRQCHIP */
1104
Jonas Gorskic771c2f2015-10-11 17:34:15 +02001105/**
1106 * gpiochip_generic_request() - request the gpio function for a pin
1107 * @chip: the gpiochip owning the GPIO
1108 * @offset: the offset of the GPIO to request for GPIO function
1109 */
1110int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
1111{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001112 return pinctrl_request_gpio(chip->gpiodev->base + offset);
Jonas Gorskic771c2f2015-10-11 17:34:15 +02001113}
1114EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1115
1116/**
1117 * gpiochip_generic_free() - free the gpio function from a pin
1118 * @chip: the gpiochip to request the gpio function for
1119 * @offset: the offset of the GPIO to free from GPIO function
1120 */
1121void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
1122{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001123 pinctrl_free_gpio(chip->gpiodev->base + offset);
Jonas Gorskic771c2f2015-10-11 17:34:15 +02001124}
1125EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1126
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301127#ifdef CONFIG_PINCTRL
Linus Walleij165adc92012-11-06 14:49:39 +01001128
Linus Walleij3f0f8672012-11-20 12:40:15 +01001129/**
Christian Ruppert586a87e2013-10-15 15:37:54 +02001130 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1131 * @chip: the gpiochip to add the range for
Tomeu Vizosod32651f2015-06-17 15:42:11 +02001132 * @pctldev: the pin controller to map to
Christian Ruppert586a87e2013-10-15 15:37:54 +02001133 * @gpio_offset: the start offset in the current gpio_chip number space
1134 * @pin_group: name of the pin group inside the pin controller
1135 */
1136int gpiochip_add_pingroup_range(struct gpio_chip *chip,
1137 struct pinctrl_dev *pctldev,
1138 unsigned int gpio_offset, const char *pin_group)
1139{
1140 struct gpio_pin_range *pin_range;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001141 struct gpio_device *gdev = chip->gpiodev;
Christian Ruppert586a87e2013-10-15 15:37:54 +02001142 int ret;
1143
1144 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1145 if (!pin_range) {
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001146 chip_err(chip, "failed to allocate pin ranges\n");
Christian Ruppert586a87e2013-10-15 15:37:54 +02001147 return -ENOMEM;
1148 }
1149
1150 /* Use local offset as range ID */
1151 pin_range->range.id = gpio_offset;
1152 pin_range->range.gc = chip;
1153 pin_range->range.name = chip->label;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001154 pin_range->range.base = gdev->base + gpio_offset;
Christian Ruppert586a87e2013-10-15 15:37:54 +02001155 pin_range->pctldev = pctldev;
1156
1157 ret = pinctrl_get_group_pins(pctldev, pin_group,
1158 &pin_range->range.pins,
1159 &pin_range->range.npins);
Michal Nazarewicz61c63752013-11-13 21:20:39 +01001160 if (ret < 0) {
1161 kfree(pin_range);
Christian Ruppert586a87e2013-10-15 15:37:54 +02001162 return ret;
Michal Nazarewicz61c63752013-11-13 21:20:39 +01001163 }
Christian Ruppert586a87e2013-10-15 15:37:54 +02001164
1165 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1166
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001167 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1168 gpio_offset, gpio_offset + pin_range->range.npins - 1,
Christian Ruppert586a87e2013-10-15 15:37:54 +02001169 pinctrl_dev_get_devname(pctldev), pin_group);
1170
Linus Walleij20ec3e32016-02-11 11:03:06 +01001171 list_add_tail(&pin_range->node, &gdev->pin_ranges);
Christian Ruppert586a87e2013-10-15 15:37:54 +02001172
1173 return 0;
1174}
1175EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1176
1177/**
Linus Walleij3f0f8672012-11-20 12:40:15 +01001178 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1179 * @chip: the gpiochip to add the range for
1180 * @pinctrl_name: the dev_name() of the pin controller to map to
Linus Walleij316511c2012-11-21 08:48:09 +01001181 * @gpio_offset: the start offset in the current gpio_chip number space
1182 * @pin_offset: the start offset in the pin controller number space
Linus Walleij3f0f8672012-11-20 12:40:15 +01001183 * @npins: the number of pins from the offset of each pin space (GPIO and
1184 * pin controller) to accumulate in this range
1185 */
Linus Walleij1e63d7b2012-11-06 16:03:35 +01001186int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
Linus Walleij316511c2012-11-21 08:48:09 +01001187 unsigned int gpio_offset, unsigned int pin_offset,
Linus Walleij3f0f8672012-11-20 12:40:15 +01001188 unsigned int npins)
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301189{
1190 struct gpio_pin_range *pin_range;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001191 struct gpio_device *gdev = chip->gpiodev;
Axel Linb4d4b1f2012-11-21 14:33:56 +08001192 int ret;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301193
Linus Walleij3f0f8672012-11-20 12:40:15 +01001194 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301195 if (!pin_range) {
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001196 chip_err(chip, "failed to allocate pin ranges\n");
Linus Walleij1e63d7b2012-11-06 16:03:35 +01001197 return -ENOMEM;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301198 }
1199
Linus Walleij3f0f8672012-11-20 12:40:15 +01001200 /* Use local offset as range ID */
Linus Walleij316511c2012-11-21 08:48:09 +01001201 pin_range->range.id = gpio_offset;
Linus Walleij3f0f8672012-11-20 12:40:15 +01001202 pin_range->range.gc = chip;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301203 pin_range->range.name = chip->label;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001204 pin_range->range.base = gdev->base + gpio_offset;
Linus Walleij316511c2012-11-21 08:48:09 +01001205 pin_range->range.pin_base = pin_offset;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301206 pin_range->range.npins = npins;
Linus Walleij192c3692012-11-20 14:03:37 +01001207 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301208 &pin_range->range);
Linus Walleij8f23ca12012-11-20 14:56:25 +01001209 if (IS_ERR(pin_range->pctldev)) {
Axel Linb4d4b1f2012-11-21 14:33:56 +08001210 ret = PTR_ERR(pin_range->pctldev);
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001211 chip_err(chip, "could not create pin range\n");
Linus Walleij3f0f8672012-11-20 12:40:15 +01001212 kfree(pin_range);
Axel Linb4d4b1f2012-11-21 14:33:56 +08001213 return ret;
Linus Walleij3f0f8672012-11-20 12:40:15 +01001214 }
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001215 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1216 gpio_offset, gpio_offset + npins - 1,
Linus Walleij316511c2012-11-21 08:48:09 +01001217 pinctl_name,
1218 pin_offset, pin_offset + npins - 1);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301219
Linus Walleij20ec3e32016-02-11 11:03:06 +01001220 list_add_tail(&pin_range->node, &gdev->pin_ranges);
Linus Walleij1e63d7b2012-11-06 16:03:35 +01001221
1222 return 0;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301223}
Linus Walleij165adc92012-11-06 14:49:39 +01001224EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301225
Linus Walleij3f0f8672012-11-20 12:40:15 +01001226/**
1227 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1228 * @chip: the chip to remove all the mappings for
1229 */
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301230void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
1231{
1232 struct gpio_pin_range *pin_range, *tmp;
Linus Walleij20ec3e32016-02-11 11:03:06 +01001233 struct gpio_device *gdev = chip->gpiodev;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301234
Linus Walleij20ec3e32016-02-11 11:03:06 +01001235 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301236 list_del(&pin_range->node);
1237 pinctrl_remove_gpio_range(pin_range->pctldev,
1238 &pin_range->range);
Linus Walleij3f0f8672012-11-20 12:40:15 +01001239 kfree(pin_range);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301240 }
1241}
Linus Walleij165adc92012-11-06 14:49:39 +01001242EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1243
1244#endif /* CONFIG_PINCTRL */
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301245
David Brownelld2876d02008-02-04 22:28:20 -08001246/* These "optional" allocation calls help prevent drivers from stomping
1247 * on each other, and help provide better diagnostics in debugfs.
1248 * They're called even less than the "set direction" calls.
1249 */
Mika Westerberg77c2d792014-03-10 14:54:50 +02001250static int __gpiod_request(struct gpio_desc *desc, const char *label)
David Brownelld2876d02008-02-04 22:28:20 -08001251{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001252 struct gpio_chip *chip = desc->gdev->chip;
Mika Westerberg77c2d792014-03-10 14:54:50 +02001253 int status;
David Brownelld2876d02008-02-04 22:28:20 -08001254 unsigned long flags;
1255
1256 spin_lock_irqsave(&gpio_lock, flags);
1257
David Brownelld2876d02008-02-04 22:28:20 -08001258 /* NOTE: gpio_request() can be called in early boot,
David Brownell35e8bb52008-10-15 22:03:16 -07001259 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
David Brownelld2876d02008-02-04 22:28:20 -08001260 */
1261
1262 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1263 desc_set_label(desc, label ? : "?");
1264 status = 0;
Guennadi Liakhovetski438d8902008-04-28 02:14:44 -07001265 } else {
David Brownelld2876d02008-02-04 22:28:20 -08001266 status = -EBUSY;
Magnus Damm7460db52009-01-29 14:25:12 -08001267 goto done;
David Brownell35e8bb52008-10-15 22:03:16 -07001268 }
1269
1270 if (chip->request) {
1271 /* chip->request may sleep */
1272 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001273 status = chip->request(chip, gpio_chip_hwgpio(desc));
David Brownell35e8bb52008-10-15 22:03:16 -07001274 spin_lock_irqsave(&gpio_lock, flags);
1275
1276 if (status < 0) {
1277 desc_set_label(desc, NULL);
David Brownell35e8bb52008-10-15 22:03:16 -07001278 clear_bit(FLAG_REQUESTED, &desc->flags);
Mathias Nyman80b0a602012-10-24 17:25:27 +03001279 goto done;
David Brownell35e8bb52008-10-15 22:03:16 -07001280 }
Guennadi Liakhovetski438d8902008-04-28 02:14:44 -07001281 }
Mathias Nyman80b0a602012-10-24 17:25:27 +03001282 if (chip->get_direction) {
1283 /* chip->get_direction may sleep */
1284 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001285 gpiod_get_direction(desc);
Mathias Nyman80b0a602012-10-24 17:25:27 +03001286 spin_lock_irqsave(&gpio_lock, flags);
1287 }
David Brownelld2876d02008-02-04 22:28:20 -08001288done:
Laurent Pinchart923b93e2015-10-13 00:20:20 +03001289 if (status < 0) {
1290 /* Clear flags that might have been set by the caller before
1291 * requesting the GPIO.
1292 */
1293 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1294 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1295 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1296 }
Mika Westerberg77c2d792014-03-10 14:54:50 +02001297 spin_unlock_irqrestore(&gpio_lock, flags);
1298 return status;
1299}
1300
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001301/*
1302 * This descriptor validation needs to be inserted verbatim into each
1303 * function taking a descriptor, so we need to use a preprocessor
1304 * macro to avoid endless duplication.
1305 */
1306#define VALIDATE_DESC(desc) do { \
1307 if (!desc || !desc->gdev) { \
1308 pr_warn("%s: invalid GPIO\n", __func__); \
1309 return -EINVAL; \
1310 } \
1311 if ( !desc->gdev->chip ) { \
1312 dev_warn(&desc->gdev->dev, \
1313 "%s: backing chip is gone\n", __func__); \
1314 return 0; \
1315 } } while (0)
1316
1317#define VALIDATE_DESC_VOID(desc) do { \
1318 if (!desc || !desc->gdev) { \
1319 pr_warn("%s: invalid GPIO\n", __func__); \
1320 return; \
1321 } \
1322 if (!desc->gdev->chip) { \
1323 dev_warn(&desc->gdev->dev, \
1324 "%s: backing chip is gone\n", __func__); \
1325 return; \
1326 } } while (0)
1327
1328
Alexandre Courbot0eb4c6c2014-07-01 14:45:15 +09001329int gpiod_request(struct gpio_desc *desc, const char *label)
Mika Westerberg77c2d792014-03-10 14:54:50 +02001330{
1331 int status = -EPROBE_DEFER;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001332 struct gpio_device *gdev;
Mika Westerberg77c2d792014-03-10 14:54:50 +02001333
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001334 VALIDATE_DESC(desc);
1335 gdev = desc->gdev;
Mika Westerberg77c2d792014-03-10 14:54:50 +02001336
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001337 if (try_module_get(gdev->owner)) {
Mika Westerberg77c2d792014-03-10 14:54:50 +02001338 status = __gpiod_request(desc, label);
1339 if (status < 0)
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001340 module_put(gdev->owner);
Linus Walleij33a68e82016-02-11 10:28:44 +01001341 else
1342 get_device(&gdev->dev);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001343 }
1344
David Brownelld2876d02008-02-04 22:28:20 -08001345 if (status)
Andy Shevchenko7589e592013-12-05 11:26:23 +02001346 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001347
David Brownelld2876d02008-02-04 22:28:20 -08001348 return status;
1349}
Alexandre Courbot372e7222013-02-03 01:29:29 +09001350
Mika Westerberg77c2d792014-03-10 14:54:50 +02001351static bool __gpiod_free(struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08001352{
Mika Westerberg77c2d792014-03-10 14:54:50 +02001353 bool ret = false;
David Brownelld2876d02008-02-04 22:28:20 -08001354 unsigned long flags;
David Brownell35e8bb52008-10-15 22:03:16 -07001355 struct gpio_chip *chip;
David Brownelld2876d02008-02-04 22:28:20 -08001356
Uwe Kleine-König3d599d12008-10-15 22:03:12 -07001357 might_sleep();
1358
Alexandre Courbot372e7222013-02-03 01:29:29 +09001359 gpiod_unexport(desc);
David Brownelld8f388d82008-07-25 01:46:07 -07001360
David Brownelld2876d02008-02-04 22:28:20 -08001361 spin_lock_irqsave(&gpio_lock, flags);
1362
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001363 chip = desc->gdev->chip;
David Brownell35e8bb52008-10-15 22:03:16 -07001364 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
1365 if (chip->free) {
1366 spin_unlock_irqrestore(&gpio_lock, flags);
David Brownell9c4ba942010-08-10 18:02:24 -07001367 might_sleep_if(chip->can_sleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001368 chip->free(chip, gpio_chip_hwgpio(desc));
David Brownell35e8bb52008-10-15 22:03:16 -07001369 spin_lock_irqsave(&gpio_lock, flags);
1370 }
David Brownelld2876d02008-02-04 22:28:20 -08001371 desc_set_label(desc, NULL);
Jani Nikula07697462009-12-15 16:46:20 -08001372 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
David Brownell35e8bb52008-10-15 22:03:16 -07001373 clear_bit(FLAG_REQUESTED, &desc->flags);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301374 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301375 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
Benoit Parrotf625d462015-02-02 11:44:44 -06001376 clear_bit(FLAG_IS_HOGGED, &desc->flags);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001377 ret = true;
1378 }
David Brownelld2876d02008-02-04 22:28:20 -08001379
1380 spin_unlock_irqrestore(&gpio_lock, flags);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001381 return ret;
1382}
1383
Alexandre Courbot0eb4c6c2014-07-01 14:45:15 +09001384void gpiod_free(struct gpio_desc *desc)
Mika Westerberg77c2d792014-03-10 14:54:50 +02001385{
Linus Walleij33a68e82016-02-11 10:28:44 +01001386 if (desc && desc->gdev && __gpiod_free(desc)) {
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001387 module_put(desc->gdev->owner);
Linus Walleij33a68e82016-02-11 10:28:44 +01001388 put_device(&desc->gdev->dev);
1389 } else {
Mika Westerberg77c2d792014-03-10 14:54:50 +02001390 WARN_ON(extra_checks);
Linus Walleij33a68e82016-02-11 10:28:44 +01001391 }
David Brownelld2876d02008-02-04 22:28:20 -08001392}
Alexandre Courbot372e7222013-02-03 01:29:29 +09001393
David Brownelld2876d02008-02-04 22:28:20 -08001394/**
1395 * gpiochip_is_requested - return string iff signal was requested
1396 * @chip: controller managing the signal
1397 * @offset: of signal within controller's 0..(ngpio - 1) range
1398 *
1399 * Returns NULL if the GPIO is not currently requested, else a string.
Alexandre Courbot9c8318f2014-07-01 14:45:14 +09001400 * The string returned is the label passed to gpio_request(); if none has been
1401 * passed it is a meaningless, non-NULL constant.
David Brownelld2876d02008-02-04 22:28:20 -08001402 *
1403 * This function is for use by GPIO controller drivers. The label can
1404 * help with diagnostics, and knowing that the signal is used as a GPIO
1405 * can help avoid accidentally multiplexing it to another controller.
1406 */
1407const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
1408{
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001409 struct gpio_desc *desc;
David Brownelld2876d02008-02-04 22:28:20 -08001410
Dirk Behme48b59532015-08-18 18:02:32 +02001411 if (offset >= chip->ngpio)
David Brownelld2876d02008-02-04 22:28:20 -08001412 return NULL;
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001413
Linus Walleij1c3cdb12016-02-09 13:51:59 +01001414 desc = &chip->gpiodev->descs[offset];
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001415
Alexandre Courbot372e7222013-02-03 01:29:29 +09001416 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
David Brownelld2876d02008-02-04 22:28:20 -08001417 return NULL;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001418 return desc->label;
David Brownelld2876d02008-02-04 22:28:20 -08001419}
1420EXPORT_SYMBOL_GPL(gpiochip_is_requested);
1421
Mika Westerberg77c2d792014-03-10 14:54:50 +02001422/**
1423 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
1424 * @desc: GPIO descriptor to request
1425 * @label: label for the GPIO
1426 *
1427 * Function allows GPIO chip drivers to request and use their own GPIO
1428 * descriptors via gpiolib API. Difference to gpiod_request() is that this
1429 * function will not increase reference count of the GPIO chip module. This
1430 * allows the GPIO chip module to be unloaded as needed (we assume that the
1431 * GPIO chip driver handles freeing the GPIOs it has requested).
1432 */
Alexandre Courbotabdc08a2014-08-19 10:06:09 -07001433struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
1434 const char *label)
Mika Westerberg77c2d792014-03-10 14:54:50 +02001435{
Alexandre Courbotabdc08a2014-08-19 10:06:09 -07001436 struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
1437 int err;
Mika Westerberg77c2d792014-03-10 14:54:50 +02001438
Alexandre Courbotabdc08a2014-08-19 10:06:09 -07001439 if (IS_ERR(desc)) {
1440 chip_err(chip, "failed to get GPIO descriptor\n");
1441 return desc;
1442 }
1443
1444 err = __gpiod_request(desc, label);
1445 if (err < 0)
1446 return ERR_PTR(err);
1447
1448 return desc;
Mika Westerberg77c2d792014-03-10 14:54:50 +02001449}
Guenter Roeckf7d4ad92014-07-22 08:01:01 -07001450EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001451
1452/**
1453 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
1454 * @desc: GPIO descriptor to free
1455 *
1456 * Function frees the given GPIO requested previously with
1457 * gpiochip_request_own_desc().
1458 */
1459void gpiochip_free_own_desc(struct gpio_desc *desc)
1460{
1461 if (desc)
1462 __gpiod_free(desc);
1463}
Guenter Roeckf7d4ad92014-07-22 08:01:01 -07001464EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
David Brownelld2876d02008-02-04 22:28:20 -08001465
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001466/*
1467 * Drivers MUST set GPIO direction before making get/set calls. In
David Brownelld2876d02008-02-04 22:28:20 -08001468 * some cases this is done in early boot, before IRQs are enabled.
1469 *
1470 * As a rule these aren't called more than once (except for drivers
1471 * using the open-drain emulation idiom) so these are natural places
1472 * to accumulate extra debugging checks. Note that we can't (yet)
1473 * rely on gpio_request() having been called beforehand.
1474 */
1475
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001476/**
1477 * gpiod_direction_input - set the GPIO direction to input
1478 * @desc: GPIO to set to input
1479 *
1480 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
1481 * be called safely on it.
1482 *
1483 * Return 0 in case of success, else an error code.
1484 */
1485int gpiod_direction_input(struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08001486{
David Brownelld2876d02008-02-04 22:28:20 -08001487 struct gpio_chip *chip;
David Brownelld2876d02008-02-04 22:28:20 -08001488 int status = -EINVAL;
1489
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001490 VALIDATE_DESC(desc);
1491 chip = desc->gdev->chip;
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09001492
Linus Walleijbe1a4b12013-08-30 09:41:45 +02001493 if (!chip->get || !chip->direction_input) {
Mark Brown6424de52013-09-09 10:33:49 +01001494 gpiod_warn(desc,
1495 "%s: missing get() or direction_input() operations\n",
Andy Shevchenko7589e592013-12-05 11:26:23 +02001496 __func__);
Linus Walleijbe1a4b12013-08-30 09:41:45 +02001497 return -EIO;
1498 }
1499
Alexandre Courbotd82da792014-07-22 16:17:43 +09001500 status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
David Brownelld2876d02008-02-04 22:28:20 -08001501 if (status == 0)
1502 clear_bit(FLAG_IS_OUT, &desc->flags);
Uwe Kleine-König3f397c212011-05-20 00:40:19 -06001503
Alexandre Courbot372e7222013-02-03 01:29:29 +09001504 trace_gpio_direction(desc_to_gpio(desc), 1, status);
Alexandre Courbotd82da792014-07-22 16:17:43 +09001505
David Brownelld2876d02008-02-04 22:28:20 -08001506 return status;
1507}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001508EXPORT_SYMBOL_GPL(gpiod_direction_input);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001509
Philipp Zabelef70bbe2014-01-07 12:34:11 +01001510static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
David Brownelld2876d02008-02-04 22:28:20 -08001511{
Linus Walleijc663e5f2016-03-22 10:51:16 +01001512 struct gpio_chip *gc = desc->gdev->chip;
1513 int ret;
David Brownelld2876d02008-02-04 22:28:20 -08001514
Linus Walleijd468bf92013-09-24 11:54:38 +02001515 /* GPIOs used for IRQs shall not be set as output */
1516 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
1517 gpiod_err(desc,
1518 "%s: tried to set a GPIO tied to an IRQ as output\n",
1519 __func__);
1520 return -EIO;
1521 }
1522
Linus Walleijc663e5f2016-03-22 10:51:16 +01001523 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
1524 /* First see if we can enable open drain in hardware */
1525 if (gc->set_single_ended) {
1526 ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
1527 LINE_MODE_OPEN_DRAIN);
1528 if (!ret)
1529 goto set_output_value;
1530 }
1531 /* Emulate open drain by not actively driving the line high */
1532 if (value)
1533 return gpiod_direction_input(desc);
1534 }
1535 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
1536 if (gc->set_single_ended) {
1537 ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
1538 LINE_MODE_OPEN_SOURCE);
1539 if (!ret)
1540 goto set_output_value;
1541 }
1542 /* Emulate open source by not actively driving the line low */
1543 if (!value)
1544 return gpiod_direction_input(desc);
1545 } else {
1546 /* Make sure to disable open drain/source hardware, if any */
1547 if (gc->set_single_ended)
1548 gc->set_single_ended(gc,
1549 gpio_chip_hwgpio(desc),
1550 LINE_MODE_PUSH_PULL);
1551 }
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301552
Linus Walleijc663e5f2016-03-22 10:51:16 +01001553set_output_value:
1554 if (!gc->set || !gc->direction_output) {
Mark Brown6424de52013-09-09 10:33:49 +01001555 gpiod_warn(desc,
1556 "%s: missing set() or direction_output() operations\n",
1557 __func__);
Linus Walleijbe1a4b12013-08-30 09:41:45 +02001558 return -EIO;
1559 }
1560
Linus Walleijc663e5f2016-03-22 10:51:16 +01001561 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), value);
1562 if (!ret)
David Brownelld2876d02008-02-04 22:28:20 -08001563 set_bit(FLAG_IS_OUT, &desc->flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001564 trace_gpio_value(desc_to_gpio(desc), 0, value);
Linus Walleijc663e5f2016-03-22 10:51:16 +01001565 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
1566 return ret;
David Brownelld2876d02008-02-04 22:28:20 -08001567}
Philipp Zabelef70bbe2014-01-07 12:34:11 +01001568
1569/**
1570 * gpiod_direction_output_raw - set the GPIO direction to output
1571 * @desc: GPIO to set to output
1572 * @value: initial output value of the GPIO
1573 *
1574 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
1575 * be called safely on it. The initial value of the output must be specified
1576 * as raw value on the physical line without regard for the ACTIVE_LOW status.
1577 *
1578 * Return 0 in case of success, else an error code.
1579 */
1580int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
1581{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001582 VALIDATE_DESC(desc);
Philipp Zabelef70bbe2014-01-07 12:34:11 +01001583 return _gpiod_direction_output_raw(desc, value);
1584}
1585EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
1586
1587/**
Rahul Bedarkar90df4fe2014-02-08 11:55:25 +05301588 * gpiod_direction_output - set the GPIO direction to output
Philipp Zabelef70bbe2014-01-07 12:34:11 +01001589 * @desc: GPIO to set to output
1590 * @value: initial output value of the GPIO
1591 *
1592 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
1593 * be called safely on it. The initial value of the output must be specified
1594 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
1595 * account.
1596 *
1597 * Return 0 in case of success, else an error code.
1598 */
1599int gpiod_direction_output(struct gpio_desc *desc, int value)
1600{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001601 VALIDATE_DESC(desc);
Philipp Zabelef70bbe2014-01-07 12:34:11 +01001602 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1603 value = !value;
1604 return _gpiod_direction_output_raw(desc, value);
1605}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001606EXPORT_SYMBOL_GPL(gpiod_direction_output);
David Brownelld2876d02008-02-04 22:28:20 -08001607
Felipe Balbic4b5be92010-05-26 14:42:23 -07001608/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001609 * gpiod_set_debounce - sets @debounce time for a @gpio
Felipe Balbic4b5be92010-05-26 14:42:23 -07001610 * @gpio: the gpio to set debounce time
1611 * @debounce: debounce time is microseconds
Linus Walleij65d87652013-09-04 14:17:08 +02001612 *
1613 * returns -ENOTSUPP if the controller does not support setting
1614 * debounce.
Felipe Balbic4b5be92010-05-26 14:42:23 -07001615 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001616int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
Felipe Balbic4b5be92010-05-26 14:42:23 -07001617{
Felipe Balbic4b5be92010-05-26 14:42:23 -07001618 struct gpio_chip *chip;
Felipe Balbic4b5be92010-05-26 14:42:23 -07001619
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001620 VALIDATE_DESC(desc);
1621 chip = desc->gdev->chip;
Linus Walleijbe1a4b12013-08-30 09:41:45 +02001622 if (!chip->set || !chip->set_debounce) {
Mark Brown6424de52013-09-09 10:33:49 +01001623 gpiod_dbg(desc,
1624 "%s: missing set() or set_debounce() operations\n",
1625 __func__);
Linus Walleij65d87652013-09-04 14:17:08 +02001626 return -ENOTSUPP;
Linus Walleijbe1a4b12013-08-30 09:41:45 +02001627 }
1628
Alexandre Courbotd82da792014-07-22 16:17:43 +09001629 return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce);
Felipe Balbic4b5be92010-05-26 14:42:23 -07001630}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001631EXPORT_SYMBOL_GPL(gpiod_set_debounce);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001632
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001633/**
1634 * gpiod_is_active_low - test whether a GPIO is active-low or not
1635 * @desc: the gpio descriptor to test
1636 *
1637 * Returns 1 if the GPIO is active-low, 0 otherwise.
1638 */
1639int gpiod_is_active_low(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001640{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001641 VALIDATE_DESC(desc);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001642 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001643}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001644EXPORT_SYMBOL_GPL(gpiod_is_active_low);
David Brownelld2876d02008-02-04 22:28:20 -08001645
1646/* I/O calls are only valid after configuration completed; the relevant
1647 * "is this a valid GPIO" error checks should already have been done.
1648 *
1649 * "Get" operations are often inlinable as reading a pin value register,
1650 * and masking the relevant bit in that register.
1651 *
1652 * When "set" operations are inlinable, they involve writing that mask to
1653 * one register to set a low value, or a different register to set it high.
1654 * Otherwise locking is needed, so there may be little value to inlining.
1655 *
1656 *------------------------------------------------------------------------
1657 *
1658 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
1659 * have requested the GPIO. That can include implicit requesting by
1660 * a direction setting call. Marking a gpio as requested locks its chip
1661 * in memory, guaranteeing that these table lookups need no more locking
1662 * and that gpiochip_remove() will fail.
1663 *
1664 * REVISIT when debugging, consider adding some instrumentation to ensure
1665 * that the GPIO was actually requested.
1666 */
1667
Bjorn Anderssone20538b2015-08-28 09:44:18 -07001668static int _gpiod_get_raw_value(const struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08001669{
1670 struct gpio_chip *chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001671 int offset;
Bjorn Anderssone20538b2015-08-28 09:44:18 -07001672 int value;
David Brownelld2876d02008-02-04 22:28:20 -08001673
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001674 chip = desc->gdev->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001675 offset = gpio_chip_hwgpio(desc);
Bjorn Anderssone20538b2015-08-28 09:44:18 -07001676 value = chip->get ? chip->get(chip, offset) : -EIO;
Linus Walleij723a6302015-12-21 23:10:12 +01001677 value = value < 0 ? value : !!value;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001678 trace_gpio_value(desc_to_gpio(desc), 1, value);
Uwe Kleine-König3f397c212011-05-20 00:40:19 -06001679 return value;
David Brownelld2876d02008-02-04 22:28:20 -08001680}
Alexandre Courbot372e7222013-02-03 01:29:29 +09001681
David Brownelld2876d02008-02-04 22:28:20 -08001682/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001683 * gpiod_get_raw_value() - return a gpio's raw value
1684 * @desc: gpio whose value will be returned
David Brownelld2876d02008-02-04 22:28:20 -08001685 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001686 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
Bjorn Anderssone20538b2015-08-28 09:44:18 -07001687 * its ACTIVE_LOW status, or negative errno on failure.
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001688 *
1689 * This function should be called from contexts where we cannot sleep, and will
1690 * complain if the GPIO chip functions potentially sleep.
David Brownelld2876d02008-02-04 22:28:20 -08001691 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001692int gpiod_get_raw_value(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001693{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001694 VALIDATE_DESC(desc);
David Brownelld2876d02008-02-04 22:28:20 -08001695 /* Should be using gpio_get_value_cansleep() */
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001696 WARN_ON(desc->gdev->chip->can_sleep);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001697 return _gpiod_get_raw_value(desc);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001698}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001699EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
David Brownelld2876d02008-02-04 22:28:20 -08001700
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001701/**
1702 * gpiod_get_value() - return a gpio's value
1703 * @desc: gpio whose value will be returned
1704 *
1705 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
Bjorn Anderssone20538b2015-08-28 09:44:18 -07001706 * account, or negative errno on failure.
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001707 *
1708 * This function should be called from contexts where we cannot sleep, and will
1709 * complain if the GPIO chip functions potentially sleep.
1710 */
1711int gpiod_get_value(const struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08001712{
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001713 int value;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001714
1715 VALIDATE_DESC(desc);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001716 /* Should be using gpio_get_value_cansleep() */
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001717 WARN_ON(desc->gdev->chip->can_sleep);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001718
1719 value = _gpiod_get_raw_value(desc);
Bjorn Anderssone20538b2015-08-28 09:44:18 -07001720 if (value < 0)
1721 return value;
1722
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001723 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1724 value = !value;
1725
1726 return value;
David Brownelld2876d02008-02-04 22:28:20 -08001727}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001728EXPORT_SYMBOL_GPL(gpiod_get_value);
David Brownelld2876d02008-02-04 22:28:20 -08001729
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301730/*
1731 * _gpio_set_open_drain_value() - Set the open drain gpio's value.
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001732 * @desc: gpio descriptor whose state need to be set.
Colin Cronin20a8a962015-05-18 11:41:43 -07001733 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301734 */
Alexandre Courbot23600962014-03-11 15:52:09 +09001735static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301736{
1737 int err = 0;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001738 struct gpio_chip *chip = desc->gdev->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001739 int offset = gpio_chip_hwgpio(desc);
1740
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301741 if (value) {
Alexandre Courbot372e7222013-02-03 01:29:29 +09001742 err = chip->direction_input(chip, offset);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301743 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001744 clear_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301745 } else {
Alexandre Courbot372e7222013-02-03 01:29:29 +09001746 err = chip->direction_output(chip, offset, 0);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301747 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001748 set_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301749 }
Alexandre Courbot372e7222013-02-03 01:29:29 +09001750 trace_gpio_direction(desc_to_gpio(desc), value, err);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301751 if (err < 0)
Mark Brown6424de52013-09-09 10:33:49 +01001752 gpiod_err(desc,
1753 "%s: Error in set_value for open drain err %d\n",
1754 __func__, err);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301755}
1756
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301757/*
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001758 * _gpio_set_open_source_value() - Set the open source gpio's value.
1759 * @desc: gpio descriptor whose state need to be set.
Colin Cronin20a8a962015-05-18 11:41:43 -07001760 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301761 */
Alexandre Courbot23600962014-03-11 15:52:09 +09001762static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301763{
1764 int err = 0;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001765 struct gpio_chip *chip = desc->gdev->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001766 int offset = gpio_chip_hwgpio(desc);
1767
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301768 if (value) {
Alexandre Courbot372e7222013-02-03 01:29:29 +09001769 err = chip->direction_output(chip, offset, 1);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301770 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001771 set_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301772 } else {
Alexandre Courbot372e7222013-02-03 01:29:29 +09001773 err = chip->direction_input(chip, offset);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301774 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001775 clear_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301776 }
Alexandre Courbot372e7222013-02-03 01:29:29 +09001777 trace_gpio_direction(desc_to_gpio(desc), !value, err);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301778 if (err < 0)
Mark Brown6424de52013-09-09 10:33:49 +01001779 gpiod_err(desc,
1780 "%s: Error in set_value for open source err %d\n",
1781 __func__, err);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301782}
1783
Alexandre Courbot23600962014-03-11 15:52:09 +09001784static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
David Brownelld2876d02008-02-04 22:28:20 -08001785{
1786 struct gpio_chip *chip;
1787
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001788 chip = desc->gdev->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001789 trace_gpio_value(desc_to_gpio(desc), 0, value);
1790 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
1791 _gpio_set_open_drain_value(desc, value);
1792 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
1793 _gpio_set_open_source_value(desc, value);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301794 else
Alexandre Courbot372e7222013-02-03 01:29:29 +09001795 chip->set(chip, gpio_chip_hwgpio(desc), value);
1796}
1797
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001798/*
1799 * set multiple outputs on the same chip;
1800 * use the chip's set_multiple function if available;
1801 * otherwise set the outputs sequentially;
1802 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
1803 * defines which outputs are to be changed
1804 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
1805 * defines the values the outputs specified by mask are to be set to
1806 */
1807static void gpio_chip_set_multiple(struct gpio_chip *chip,
1808 unsigned long *mask, unsigned long *bits)
1809{
1810 if (chip->set_multiple) {
1811 chip->set_multiple(chip, mask, bits);
1812 } else {
1813 int i;
1814 for (i = 0; i < chip->ngpio; i++) {
1815 if (mask[BIT_WORD(i)] == 0) {
1816 /* no more set bits in this mask word;
1817 * skip ahead to the next word */
1818 i = (BIT_WORD(i) + 1) * BITS_PER_LONG - 1;
1819 continue;
1820 }
1821 /* set outputs if the corresponding mask bit is set */
Daniel Lockyer38e003f2015-06-10 14:26:27 +01001822 if (__test_and_clear_bit(i, mask))
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001823 chip->set(chip, i, test_bit(i, bits));
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001824 }
1825 }
1826}
1827
Linus Walleij44c72882016-04-24 11:36:59 +02001828void gpiod_set_array_value_complex(bool raw, bool can_sleep,
1829 unsigned int array_size,
1830 struct gpio_desc **desc_array,
1831 int *value_array)
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001832{
1833 int i = 0;
1834
1835 while (i < array_size) {
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001836 struct gpio_chip *chip = desc_array[i]->gdev->chip;
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001837 unsigned long mask[BITS_TO_LONGS(chip->ngpio)];
1838 unsigned long bits[BITS_TO_LONGS(chip->ngpio)];
1839 int count = 0;
1840
Daniel Lockyer38e003f2015-06-10 14:26:27 +01001841 if (!can_sleep)
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001842 WARN_ON(chip->can_sleep);
Daniel Lockyer38e003f2015-06-10 14:26:27 +01001843
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001844 memset(mask, 0, sizeof(mask));
1845 do {
1846 struct gpio_desc *desc = desc_array[i];
1847 int hwgpio = gpio_chip_hwgpio(desc);
1848 int value = value_array[i];
1849
1850 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1851 value = !value;
1852 trace_gpio_value(desc_to_gpio(desc), 0, value);
1853 /*
1854 * collect all normal outputs belonging to the same chip
1855 * open drain and open source outputs are set individually
1856 */
1857 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
Daniel Lockyer38e003f2015-06-10 14:26:27 +01001858 _gpio_set_open_drain_value(desc, value);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001859 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
1860 _gpio_set_open_source_value(desc, value);
1861 } else {
1862 __set_bit(hwgpio, mask);
Daniel Lockyer38e003f2015-06-10 14:26:27 +01001863 if (value)
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001864 __set_bit(hwgpio, bits);
Daniel Lockyer38e003f2015-06-10 14:26:27 +01001865 else
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001866 __clear_bit(hwgpio, bits);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001867 count++;
1868 }
1869 i++;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001870 } while ((i < array_size) &&
1871 (desc_array[i]->gdev->chip == chip));
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001872 /* push collected bits to outputs */
Daniel Lockyer38e003f2015-06-10 14:26:27 +01001873 if (count != 0)
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001874 gpio_chip_set_multiple(chip, mask, bits);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001875 }
1876}
1877
David Brownelld2876d02008-02-04 22:28:20 -08001878/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001879 * gpiod_set_raw_value() - assign a gpio's raw value
1880 * @desc: gpio whose value will be assigned
David Brownelld2876d02008-02-04 22:28:20 -08001881 * @value: value to assign
David Brownelld2876d02008-02-04 22:28:20 -08001882 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001883 * Set the raw value of the GPIO, i.e. the value of its physical line without
1884 * regard for its ACTIVE_LOW status.
1885 *
1886 * This function should be called from contexts where we cannot sleep, and will
1887 * complain if the GPIO chip functions potentially sleep.
David Brownelld2876d02008-02-04 22:28:20 -08001888 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001889void gpiod_set_raw_value(struct gpio_desc *desc, int value)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001890{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001891 VALIDATE_DESC_VOID(desc);
Geert Uytterhoeven1cfab8f2016-03-14 16:24:12 +01001892 /* Should be using gpiod_set_value_cansleep() */
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001893 WARN_ON(desc->gdev->chip->can_sleep);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001894 _gpiod_set_raw_value(desc, value);
David Brownelld2876d02008-02-04 22:28:20 -08001895}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001896EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
David Brownelld2876d02008-02-04 22:28:20 -08001897
1898/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001899 * gpiod_set_value() - assign a gpio's value
1900 * @desc: gpio whose value will be assigned
1901 * @value: value to assign
David Brownelld2876d02008-02-04 22:28:20 -08001902 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001903 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
1904 * account
1905 *
1906 * This function should be called from contexts where we cannot sleep, and will
1907 * complain if the GPIO chip functions potentially sleep.
David Brownelld2876d02008-02-04 22:28:20 -08001908 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001909void gpiod_set_value(struct gpio_desc *desc, int value)
1910{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001911 VALIDATE_DESC_VOID(desc);
Geert Uytterhoeven1cfab8f2016-03-14 16:24:12 +01001912 /* Should be using gpiod_set_value_cansleep() */
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001913 WARN_ON(desc->gdev->chip->can_sleep);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001914 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1915 value = !value;
1916 _gpiod_set_raw_value(desc, value);
1917}
1918EXPORT_SYMBOL_GPL(gpiod_set_value);
1919
1920/**
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02001921 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001922 * @array_size: number of elements in the descriptor / value arrays
1923 * @desc_array: array of GPIO descriptors whose values will be assigned
1924 * @value_array: array of values to assign
1925 *
1926 * Set the raw values of the GPIOs, i.e. the values of the physical lines
1927 * without regard for their ACTIVE_LOW status.
1928 *
1929 * This function should be called from contexts where we cannot sleep, and will
1930 * complain if the GPIO chip functions potentially sleep.
1931 */
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02001932void gpiod_set_raw_array_value(unsigned int array_size,
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001933 struct gpio_desc **desc_array, int *value_array)
1934{
1935 if (!desc_array)
1936 return;
Linus Walleij44c72882016-04-24 11:36:59 +02001937 gpiod_set_array_value_complex(true, false, array_size, desc_array,
1938 value_array);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001939}
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02001940EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001941
1942/**
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02001943 * gpiod_set_array_value() - assign values to an array of GPIOs
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001944 * @array_size: number of elements in the descriptor / value arrays
1945 * @desc_array: array of GPIO descriptors whose values will be assigned
1946 * @value_array: array of values to assign
1947 *
1948 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
1949 * into account.
1950 *
1951 * This function should be called from contexts where we cannot sleep, and will
1952 * complain if the GPIO chip functions potentially sleep.
1953 */
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02001954void gpiod_set_array_value(unsigned int array_size,
1955 struct gpio_desc **desc_array, int *value_array)
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001956{
1957 if (!desc_array)
1958 return;
Linus Walleij44c72882016-04-24 11:36:59 +02001959 gpiod_set_array_value_complex(false, false, array_size, desc_array,
1960 value_array);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001961}
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02001962EXPORT_SYMBOL_GPL(gpiod_set_array_value);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01001963
1964/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001965 * gpiod_cansleep() - report whether gpio value access may sleep
1966 * @desc: gpio to check
1967 *
1968 */
1969int gpiod_cansleep(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001970{
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001971 VALIDATE_DESC(desc);
1972 return desc->gdev->chip->can_sleep;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001973}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001974EXPORT_SYMBOL_GPL(gpiod_cansleep);
David Brownelld2876d02008-02-04 22:28:20 -08001975
David Brownell0f6d5042008-10-15 22:03:14 -07001976/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001977 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
1978 * @desc: gpio whose IRQ will be returned (already requested)
David Brownell0f6d5042008-10-15 22:03:14 -07001979 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001980 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
1981 * error.
David Brownell0f6d5042008-10-15 22:03:14 -07001982 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001983int gpiod_to_irq(const struct gpio_desc *desc)
David Brownell0f6d5042008-10-15 22:03:14 -07001984{
1985 struct gpio_chip *chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001986 int offset;
David Brownell0f6d5042008-10-15 22:03:14 -07001987
Linus Walleijfdeb8e12016-02-10 10:57:36 +01001988 VALIDATE_DESC(desc);
1989 chip = desc->gdev->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001990 offset = gpio_chip_hwgpio(desc);
1991 return chip->to_irq ? chip->to_irq(chip, offset) : -ENXIO;
1992}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001993EXPORT_SYMBOL_GPL(gpiod_to_irq);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001994
Linus Walleijd468bf92013-09-24 11:54:38 +02001995/**
Alexandre Courbote3a2e872014-10-23 17:27:07 +09001996 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
Alexandre Courbotd74be6d2014-07-22 16:17:42 +09001997 * @chip: the chip the GPIO to lock belongs to
1998 * @offset: the offset of the GPIO to lock as IRQ
Linus Walleijd468bf92013-09-24 11:54:38 +02001999 *
2000 * This is used directly by GPIO drivers that want to lock down
Linus Walleijf438acd2014-03-07 10:12:49 +08002001 * a certain GPIO line to be used for IRQs.
David Brownelld2876d02008-02-04 22:28:20 -08002002 */
Alexandre Courbote3a2e872014-10-23 17:27:07 +09002003int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
David Brownelld2876d02008-02-04 22:28:20 -08002004{
Alexandre Courbotd74be6d2014-07-22 16:17:42 +09002005 if (offset >= chip->ngpio)
Linus Walleijd468bf92013-09-24 11:54:38 +02002006 return -EINVAL;
2007
Linus Walleij1c3cdb12016-02-09 13:51:59 +01002008 if (test_bit(FLAG_IS_OUT, &chip->gpiodev->descs[offset].flags)) {
Alexandre Courbotd74be6d2014-07-22 16:17:42 +09002009 chip_err(chip,
Linus Walleijd468bf92013-09-24 11:54:38 +02002010 "%s: tried to flag a GPIO set as output for IRQ\n",
2011 __func__);
2012 return -EIO;
2013 }
2014
Linus Walleij1c3cdb12016-02-09 13:51:59 +01002015 set_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
Linus Walleijd468bf92013-09-24 11:54:38 +02002016 return 0;
2017}
Alexandre Courbote3a2e872014-10-23 17:27:07 +09002018EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
Linus Walleijd468bf92013-09-24 11:54:38 +02002019
Linus Walleijd468bf92013-09-24 11:54:38 +02002020/**
Alexandre Courbote3a2e872014-10-23 17:27:07 +09002021 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
Alexandre Courbotd74be6d2014-07-22 16:17:42 +09002022 * @chip: the chip the GPIO to lock belongs to
2023 * @offset: the offset of the GPIO to lock as IRQ
Linus Walleijd468bf92013-09-24 11:54:38 +02002024 *
2025 * This is used directly by GPIO drivers that want to indicate
2026 * that a certain GPIO is no longer used exclusively for IRQ.
2027 */
Alexandre Courbote3a2e872014-10-23 17:27:07 +09002028void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
Linus Walleijd468bf92013-09-24 11:54:38 +02002029{
Alexandre Courbotd74be6d2014-07-22 16:17:42 +09002030 if (offset >= chip->ngpio)
Linus Walleijd468bf92013-09-24 11:54:38 +02002031 return;
2032
Linus Walleij1c3cdb12016-02-09 13:51:59 +01002033 clear_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
Linus Walleijd468bf92013-09-24 11:54:38 +02002034}
Alexandre Courbote3a2e872014-10-23 17:27:07 +09002035EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
Linus Walleijd468bf92013-09-24 11:54:38 +02002036
Linus Walleij6cee3822016-02-11 20:16:45 +01002037bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
2038{
2039 if (offset >= chip->ngpio)
2040 return false;
2041
2042 return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
2043}
2044EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
2045
Linus Walleij143b65d2016-02-16 15:41:42 +01002046bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
2047{
2048 if (offset >= chip->ngpio)
2049 return false;
2050
2051 return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
2052}
2053EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
2054
2055bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
2056{
2057 if (offset >= chip->ngpio)
2058 return false;
2059
2060 return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
2061}
2062EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
2063
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002064/**
2065 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
2066 * @desc: gpio whose value will be returned
2067 *
2068 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
Bjorn Anderssone20538b2015-08-28 09:44:18 -07002069 * its ACTIVE_LOW status, or negative errno on failure.
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002070 *
2071 * This function is to be called from contexts that can sleep.
David Brownelld2876d02008-02-04 22:28:20 -08002072 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002073int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08002074{
David Brownelld2876d02008-02-04 22:28:20 -08002075 might_sleep_if(extra_checks);
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002076 VALIDATE_DESC(desc);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002077 return _gpiod_get_raw_value(desc);
David Brownelld2876d02008-02-04 22:28:20 -08002078}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002079EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002080
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002081/**
2082 * gpiod_get_value_cansleep() - return a gpio's value
2083 * @desc: gpio whose value will be returned
2084 *
2085 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
Bjorn Anderssone20538b2015-08-28 09:44:18 -07002086 * account, or negative errno on failure.
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002087 *
2088 * This function is to be called from contexts that can sleep.
2089 */
2090int gpiod_get_value_cansleep(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002091{
David Brownelld2876d02008-02-04 22:28:20 -08002092 int value;
David Brownelld2876d02008-02-04 22:28:20 -08002093
2094 might_sleep_if(extra_checks);
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002095 VALIDATE_DESC(desc);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002096 value = _gpiod_get_raw_value(desc);
Bjorn Anderssone20538b2015-08-28 09:44:18 -07002097 if (value < 0)
2098 return value;
2099
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002100 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2101 value = !value;
2102
David Brownelld2876d02008-02-04 22:28:20 -08002103 return value;
2104}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002105EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002106
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002107/**
2108 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
2109 * @desc: gpio whose value will be assigned
2110 * @value: value to assign
2111 *
2112 * Set the raw value of the GPIO, i.e. the value of its physical line without
2113 * regard for its ACTIVE_LOW status.
2114 *
2115 * This function is to be called from contexts that can sleep.
2116 */
2117void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002118{
David Brownelld2876d02008-02-04 22:28:20 -08002119 might_sleep_if(extra_checks);
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002120 VALIDATE_DESC_VOID(desc);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002121 _gpiod_set_raw_value(desc, value);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002122}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002123EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002124
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002125/**
2126 * gpiod_set_value_cansleep() - assign a gpio's value
2127 * @desc: gpio whose value will be assigned
2128 * @value: value to assign
2129 *
2130 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2131 * account
2132 *
2133 * This function is to be called from contexts that can sleep.
2134 */
2135void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002136{
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002137 might_sleep_if(extra_checks);
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002138 VALIDATE_DESC_VOID(desc);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002139 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2140 value = !value;
2141 _gpiod_set_raw_value(desc, value);
David Brownelld2876d02008-02-04 22:28:20 -08002142}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002143EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
David Brownelld2876d02008-02-04 22:28:20 -08002144
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002145/**
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02002146 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002147 * @array_size: number of elements in the descriptor / value arrays
2148 * @desc_array: array of GPIO descriptors whose values will be assigned
2149 * @value_array: array of values to assign
2150 *
2151 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2152 * without regard for their ACTIVE_LOW status.
2153 *
2154 * This function is to be called from contexts that can sleep.
2155 */
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02002156void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
2157 struct gpio_desc **desc_array,
2158 int *value_array)
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002159{
2160 might_sleep_if(extra_checks);
2161 if (!desc_array)
2162 return;
Linus Walleij44c72882016-04-24 11:36:59 +02002163 gpiod_set_array_value_complex(true, true, array_size, desc_array,
2164 value_array);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002165}
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02002166EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002167
2168/**
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02002169 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002170 * @array_size: number of elements in the descriptor / value arrays
2171 * @desc_array: array of GPIO descriptors whose values will be assigned
2172 * @value_array: array of values to assign
2173 *
2174 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2175 * into account.
2176 *
2177 * This function is to be called from contexts that can sleep.
2178 */
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02002179void gpiod_set_array_value_cansleep(unsigned int array_size,
2180 struct gpio_desc **desc_array,
2181 int *value_array)
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002182{
2183 might_sleep_if(extra_checks);
2184 if (!desc_array)
2185 return;
Linus Walleij44c72882016-04-24 11:36:59 +02002186 gpiod_set_array_value_complex(false, true, array_size, desc_array,
2187 value_array);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002188}
Rojhalat Ibrahim3fff99b2015-05-13 11:04:56 +02002189EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
Rojhalat Ibrahim5f424242014-11-04 17:12:06 +01002190
2191/**
Alexandre Courbotad824782013-12-03 12:20:11 +09002192 * gpiod_add_lookup_table() - register GPIO device consumers
2193 * @table: table of consumers to register
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002194 */
Alexandre Courbotad824782013-12-03 12:20:11 +09002195void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002196{
2197 mutex_lock(&gpio_lookup_lock);
2198
Alexandre Courbotad824782013-12-03 12:20:11 +09002199 list_add_tail(&table->list, &gpio_lookup_list);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002200
2201 mutex_unlock(&gpio_lookup_lock);
David Brownelld2876d02008-02-04 22:28:20 -08002202}
2203
Shobhit Kumarbe9015a2015-06-26 14:32:04 +05302204/**
2205 * gpiod_remove_lookup_table() - unregister GPIO device consumers
2206 * @table: table of consumers to unregister
2207 */
2208void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
2209{
2210 mutex_lock(&gpio_lookup_lock);
2211
2212 list_del(&table->list);
2213
2214 mutex_unlock(&gpio_lookup_lock);
2215}
2216
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002217static struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002218 unsigned int idx,
2219 enum gpio_lookup_flags *flags)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002220{
2221 char prop_name[32]; /* 32 is max size of property name */
2222 enum of_gpio_flags of_flags;
2223 struct gpio_desc *desc;
Thierry Redingdd34c372014-04-23 17:28:09 +02002224 unsigned int i;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002225
Rojhalat Ibrahim7f2e5532015-02-11 17:27:55 +01002226 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
Thierry Redingdd34c372014-04-23 17:28:09 +02002227 if (con_id)
Olliver Schinagl9e089242015-01-21 22:33:45 +01002228 snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
Rojhalat Ibrahim7f2e5532015-02-11 17:27:55 +01002229 gpio_suffixes[i]);
Thierry Redingdd34c372014-04-23 17:28:09 +02002230 else
Olliver Schinagl9e089242015-01-21 22:33:45 +01002231 snprintf(prop_name, sizeof(prop_name), "%s",
Rojhalat Ibrahim7f2e5532015-02-11 17:27:55 +01002232 gpio_suffixes[i]);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002233
Thierry Redingdd34c372014-04-23 17:28:09 +02002234 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
2235 &of_flags);
Tony Lindgren06fc3b72014-06-02 16:13:46 -07002236 if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER))
Thierry Redingdd34c372014-04-23 17:28:09 +02002237 break;
2238 }
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002239
2240 if (IS_ERR(desc))
2241 return desc;
2242
2243 if (of_flags & OF_GPIO_ACTIVE_LOW)
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002244 *flags |= GPIO_ACTIVE_LOW;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002245
Laurent Pinchart90b665f2015-10-13 00:20:21 +03002246 if (of_flags & OF_GPIO_SINGLE_ENDED) {
2247 if (of_flags & OF_GPIO_ACTIVE_LOW)
2248 *flags |= GPIO_OPEN_DRAIN;
2249 else
2250 *flags |= GPIO_OPEN_SOURCE;
2251 }
2252
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002253 return desc;
2254}
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002255
Mika Westerberg81f59e92013-10-10 11:01:09 +03002256static struct gpio_desc *acpi_find_gpio(struct device *dev, const char *con_id,
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002257 unsigned int idx,
2258 enum gpio_lookup_flags *flags)
Mika Westerberg81f59e92013-10-10 11:01:09 +03002259{
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002260 struct acpi_device *adev = ACPI_COMPANION(dev);
Mika Westerberge01f4402013-10-10 11:01:10 +03002261 struct acpi_gpio_info info;
2262 struct gpio_desc *desc;
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002263 char propname[32];
2264 int i;
Mika Westerberge01f4402013-10-10 11:01:10 +03002265
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002266 /* Try first from _DSD */
Rojhalat Ibrahim7f2e5532015-02-11 17:27:55 +01002267 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002268 if (con_id && strcmp(con_id, "gpios")) {
2269 snprintf(propname, sizeof(propname), "%s-%s",
Rojhalat Ibrahim7f2e5532015-02-11 17:27:55 +01002270 con_id, gpio_suffixes[i]);
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002271 } else {
2272 snprintf(propname, sizeof(propname), "%s",
Rojhalat Ibrahim7f2e5532015-02-11 17:27:55 +01002273 gpio_suffixes[i]);
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002274 }
Mika Westerberge01f4402013-10-10 11:01:10 +03002275
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002276 desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
2277 if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER))
2278 break;
2279 }
2280
2281 /* Then from plain _CRS GPIOs */
2282 if (IS_ERR(desc)) {
Dmitry Torokhov10cf4892015-11-11 11:45:30 -08002283 if (!acpi_can_fallback_to_crs(adev, con_id))
2284 return ERR_PTR(-ENOENT);
2285
Mika Westerberg0d9a6932014-10-29 15:41:01 +01002286 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
2287 if (IS_ERR(desc))
2288 return desc;
2289 }
2290
Christophe RICARD52044722015-12-23 23:25:34 +01002291 if (info.polarity == GPIO_ACTIVE_LOW)
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002292 *flags |= GPIO_ACTIVE_LOW;
Mika Westerberge01f4402013-10-10 11:01:10 +03002293
2294 return desc;
Mika Westerberg81f59e92013-10-10 11:01:09 +03002295}
2296
Alexandre Courbotad824782013-12-03 12:20:11 +09002297static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
2298{
2299 const char *dev_id = dev ? dev_name(dev) : NULL;
2300 struct gpiod_lookup_table *table;
2301
2302 mutex_lock(&gpio_lookup_lock);
2303
2304 list_for_each_entry(table, &gpio_lookup_list, list) {
2305 if (table->dev_id && dev_id) {
2306 /*
2307 * Valid strings on both ends, must be identical to have
2308 * a match
2309 */
2310 if (!strcmp(table->dev_id, dev_id))
2311 goto found;
2312 } else {
2313 /*
2314 * One of the pointers is NULL, so both must be to have
2315 * a match
2316 */
2317 if (dev_id == table->dev_id)
2318 goto found;
2319 }
2320 }
2321 table = NULL;
2322
2323found:
2324 mutex_unlock(&gpio_lookup_lock);
2325 return table;
2326}
2327
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002328static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002329 unsigned int idx,
2330 enum gpio_lookup_flags *flags)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002331{
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002332 struct gpio_desc *desc = ERR_PTR(-ENOENT);
Alexandre Courbotad824782013-12-03 12:20:11 +09002333 struct gpiod_lookup_table *table;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002334 struct gpiod_lookup *p;
2335
Alexandre Courbotad824782013-12-03 12:20:11 +09002336 table = gpiod_find_lookup_table(dev);
2337 if (!table)
2338 return desc;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002339
Alexandre Courbotad824782013-12-03 12:20:11 +09002340 for (p = &table->table[0]; p->chip_label; p++) {
2341 struct gpio_chip *chip;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002342
Alexandre Courbotad824782013-12-03 12:20:11 +09002343 /* idx must always match exactly */
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002344 if (p->idx != idx)
2345 continue;
2346
Alexandre Courbotad824782013-12-03 12:20:11 +09002347 /* If the lookup entry has a con_id, require exact match */
2348 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
2349 continue;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002350
Alexandre Courbotad824782013-12-03 12:20:11 +09002351 chip = find_chip_by_name(p->chip_label);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002352
Alexandre Courbotad824782013-12-03 12:20:11 +09002353 if (!chip) {
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002354 dev_err(dev, "cannot find GPIO chip %s\n",
2355 p->chip_label);
2356 return ERR_PTR(-ENODEV);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002357 }
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002358
Alexandre Courbotad824782013-12-03 12:20:11 +09002359 if (chip->ngpio <= p->chip_hwnum) {
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002360 dev_err(dev,
2361 "requested GPIO %d is out of range [0..%d] for chip %s\n",
2362 idx, chip->ngpio, chip->label);
2363 return ERR_PTR(-EINVAL);
Alexandre Courbotad824782013-12-03 12:20:11 +09002364 }
2365
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +09002366 desc = gpiochip_get_desc(chip, p->chip_hwnum);
Alexandre Courbotad824782013-12-03 12:20:11 +09002367 *flags = p->flags;
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002368
2369 return desc;
Alexandre Courbotad824782013-12-03 12:20:11 +09002370 }
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002371
2372 return desc;
2373}
2374
Rojhalat Ibrahim66858522015-02-11 17:27:58 +01002375static int dt_gpio_count(struct device *dev, const char *con_id)
2376{
2377 int ret;
2378 char propname[32];
2379 unsigned int i;
2380
2381 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
2382 if (con_id)
2383 snprintf(propname, sizeof(propname), "%s-%s",
2384 con_id, gpio_suffixes[i]);
2385 else
2386 snprintf(propname, sizeof(propname), "%s",
2387 gpio_suffixes[i]);
2388
2389 ret = of_gpio_named_count(dev->of_node, propname);
2390 if (ret >= 0)
2391 break;
2392 }
2393 return ret;
2394}
2395
2396static int platform_gpio_count(struct device *dev, const char *con_id)
2397{
2398 struct gpiod_lookup_table *table;
2399 struct gpiod_lookup *p;
2400 unsigned int count = 0;
2401
2402 table = gpiod_find_lookup_table(dev);
2403 if (!table)
2404 return -ENOENT;
2405
2406 for (p = &table->table[0]; p->chip_label; p++) {
2407 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
2408 (!con_id && !p->con_id))
2409 count++;
2410 }
2411 if (!count)
2412 return -ENOENT;
2413
2414 return count;
2415}
2416
2417/**
2418 * gpiod_count - return the number of GPIOs associated with a device / function
2419 * or -ENOENT if no GPIO has been assigned to the requested function
2420 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2421 * @con_id: function within the GPIO consumer
2422 */
2423int gpiod_count(struct device *dev, const char *con_id)
2424{
2425 int count = -ENOENT;
2426
2427 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
2428 count = dt_gpio_count(dev, con_id);
2429 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
2430 count = acpi_gpio_count(dev, con_id);
2431
2432 if (count < 0)
2433 count = platform_gpio_count(dev, con_id);
2434
2435 return count;
2436}
2437EXPORT_SYMBOL_GPL(gpiod_count);
2438
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002439/**
Thierry Reding08791622014-04-25 16:54:22 +02002440 * gpiod_get - obtain a GPIO for a given GPIO function
Alexandre Courbotad824782013-12-03 12:20:11 +09002441 * @dev: GPIO consumer, can be NULL for system-global GPIOs
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002442 * @con_id: function within the GPIO consumer
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002443 * @flags: optional GPIO initialization flags
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002444 *
2445 * Return the GPIO descriptor corresponding to the function con_id of device
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002446 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
Colin Cronin20a8a962015-05-18 11:41:43 -07002447 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002448 */
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002449struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002450 enum gpiod_flags flags)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002451{
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002452 return gpiod_get_index(dev, con_id, 0, flags);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002453}
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002454EXPORT_SYMBOL_GPL(gpiod_get);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002455
2456/**
Thierry Reding29a1f2332014-04-25 17:10:06 +02002457 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
2458 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2459 * @con_id: function within the GPIO consumer
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002460 * @flags: optional GPIO initialization flags
Thierry Reding29a1f2332014-04-25 17:10:06 +02002461 *
2462 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
2463 * the requested function it will return NULL. This is convenient for drivers
2464 * that need to handle optional GPIOs.
2465 */
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002466struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002467 const char *con_id,
2468 enum gpiod_flags flags)
Thierry Reding29a1f2332014-04-25 17:10:06 +02002469{
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002470 return gpiod_get_index_optional(dev, con_id, 0, flags);
Thierry Reding29a1f2332014-04-25 17:10:06 +02002471}
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002472EXPORT_SYMBOL_GPL(gpiod_get_optional);
Thierry Reding29a1f2332014-04-25 17:10:06 +02002473
Laurent Pinchart923b93e2015-10-13 00:20:20 +03002474/**
2475 * gpiod_parse_flags - helper function to parse GPIO lookup flags
2476 * @desc: gpio to be setup
2477 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
2478 * of_get_gpio_hog()
2479 *
2480 * Set the GPIO descriptor flags based on the given GPIO lookup flags.
2481 */
2482static void gpiod_parse_flags(struct gpio_desc *desc, unsigned long lflags)
2483{
2484 if (lflags & GPIO_ACTIVE_LOW)
2485 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
2486 if (lflags & GPIO_OPEN_DRAIN)
2487 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
2488 if (lflags & GPIO_OPEN_SOURCE)
2489 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
2490}
Benoit Parrotf625d462015-02-02 11:44:44 -06002491
2492/**
2493 * gpiod_configure_flags - helper function to configure a given GPIO
2494 * @desc: gpio whose value will be assigned
2495 * @con_id: function within the GPIO consumer
Benoit Parrotf625d462015-02-02 11:44:44 -06002496 * @dflags: gpiod_flags - optional GPIO initialization flags
2497 *
2498 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
2499 * requested function and/or index, or another IS_ERR() code if an error
2500 * occurred while trying to acquire the GPIO.
2501 */
2502static int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
Laurent Pinchart923b93e2015-10-13 00:20:20 +03002503 enum gpiod_flags dflags)
Benoit Parrotf625d462015-02-02 11:44:44 -06002504{
2505 int status;
2506
Benoit Parrotf625d462015-02-02 11:44:44 -06002507 /* No particular flag request, return here... */
2508 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
2509 pr_debug("no flags found for %s\n", con_id);
2510 return 0;
2511 }
2512
2513 /* Process flags */
2514 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
2515 status = gpiod_direction_output(desc,
2516 dflags & GPIOD_FLAGS_BIT_DIR_VAL);
2517 else
2518 status = gpiod_direction_input(desc);
2519
2520 return status;
2521}
2522
Thierry Reding29a1f2332014-04-25 17:10:06 +02002523/**
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002524 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
Andy Shevchenkofdd6a5f2013-12-05 11:26:26 +02002525 * @dev: GPIO consumer, can be NULL for system-global GPIOs
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002526 * @con_id: function within the GPIO consumer
2527 * @idx: index of the GPIO to obtain in the consumer
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002528 * @flags: optional GPIO initialization flags
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002529 *
2530 * This variant of gpiod_get() allows to access GPIOs other than the first
2531 * defined one for functions that define several GPIOs.
2532 *
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002533 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
2534 * requested function and/or index, or another IS_ERR() code if an error
Colin Cronin20a8a962015-05-18 11:41:43 -07002535 * occurred while trying to acquire the GPIO.
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002536 */
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002537struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002538 const char *con_id,
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002539 unsigned int idx,
2540 enum gpiod_flags flags)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002541{
Alexandre Courbot35c5d7f2013-11-23 19:34:50 +09002542 struct gpio_desc *desc = NULL;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002543 int status;
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002544 enum gpio_lookup_flags lookupflags = 0;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002545
2546 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
2547
Rafael J. Wysocki4d8440b2015-03-10 23:08:57 +01002548 if (dev) {
2549 /* Using device tree? */
2550 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
2551 dev_dbg(dev, "using device tree for GPIO lookup\n");
2552 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
2553 } else if (ACPI_COMPANION(dev)) {
2554 dev_dbg(dev, "using ACPI for GPIO lookup\n");
2555 desc = acpi_find_gpio(dev, con_id, idx, &lookupflags);
2556 }
Alexandre Courbot35c5d7f2013-11-23 19:34:50 +09002557 }
2558
2559 /*
2560 * Either we are not using DT or ACPI, or their lookup did not return
2561 * a result. In that case, use platform lookup as a fallback.
2562 */
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002563 if (!desc || desc == ERR_PTR(-ENOENT)) {
Alexander Shiyan43a87852014-09-19 11:39:25 +04002564 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002565 desc = gpiod_find(dev, con_id, idx, &lookupflags);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002566 }
2567
2568 if (IS_ERR(desc)) {
Heikki Krogerus351cfe02013-11-29 15:47:34 +02002569 dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002570 return desc;
2571 }
2572
Laurent Pinchart923b93e2015-10-13 00:20:20 +03002573 gpiod_parse_flags(desc, lookupflags);
2574
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002575 status = gpiod_request(desc, con_id);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002576 if (status < 0)
2577 return ERR_PTR(status);
2578
Laurent Pinchart923b93e2015-10-13 00:20:20 +03002579 status = gpiod_configure_flags(desc, con_id, flags);
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002580 if (status < 0) {
2581 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
2582 gpiod_put(desc);
2583 return ERR_PTR(status);
2584 }
2585
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002586 return desc;
2587}
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002588EXPORT_SYMBOL_GPL(gpiod_get_index);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002589
2590/**
Mika Westerberg40b73182014-10-21 13:33:59 +02002591 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
2592 * @fwnode: handle of the firmware node
2593 * @propname: name of the firmware property representing the GPIO
2594 *
2595 * This function can be used for drivers that get their configuration
2596 * from firmware.
2597 *
2598 * Function properly finds the corresponding GPIO using whatever is the
2599 * underlying firmware interface and then makes sure that the GPIO
2600 * descriptor is requested before it is returned to the caller.
2601 *
2602 * In case of error an ERR_PTR() is returned.
2603 */
2604struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
2605 const char *propname)
2606{
2607 struct gpio_desc *desc = ERR_PTR(-ENODEV);
2608 bool active_low = false;
Laurent Pinchart90b665f2015-10-13 00:20:21 +03002609 bool single_ended = false;
Mika Westerberg40b73182014-10-21 13:33:59 +02002610 int ret;
2611
2612 if (!fwnode)
2613 return ERR_PTR(-EINVAL);
2614
2615 if (is_of_node(fwnode)) {
2616 enum of_gpio_flags flags;
2617
Alexander Sverdlinc181fb32015-06-22 22:38:53 +02002618 desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname, 0,
Mika Westerberg40b73182014-10-21 13:33:59 +02002619 &flags);
Laurent Pinchart90b665f2015-10-13 00:20:21 +03002620 if (!IS_ERR(desc)) {
Mika Westerberg40b73182014-10-21 13:33:59 +02002621 active_low = flags & OF_GPIO_ACTIVE_LOW;
Laurent Pinchart90b665f2015-10-13 00:20:21 +03002622 single_ended = flags & OF_GPIO_SINGLE_ENDED;
2623 }
Mika Westerberg40b73182014-10-21 13:33:59 +02002624 } else if (is_acpi_node(fwnode)) {
2625 struct acpi_gpio_info info;
2626
Rafael J. Wysocki504a3372015-08-27 04:42:33 +02002627 desc = acpi_node_get_gpiod(fwnode, propname, 0, &info);
Mika Westerberg40b73182014-10-21 13:33:59 +02002628 if (!IS_ERR(desc))
Christophe RICARD52044722015-12-23 23:25:34 +01002629 active_low = info.polarity == GPIO_ACTIVE_LOW;
Mika Westerberg40b73182014-10-21 13:33:59 +02002630 }
2631
2632 if (IS_ERR(desc))
2633 return desc;
2634
Mika Westerberg40b73182014-10-21 13:33:59 +02002635 if (active_low)
2636 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
2637
Laurent Pinchart90b665f2015-10-13 00:20:21 +03002638 if (single_ended) {
2639 if (active_low)
2640 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
2641 else
2642 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
2643 }
2644
Laurent Pinchart923b93e2015-10-13 00:20:20 +03002645 ret = gpiod_request(desc, NULL);
2646 if (ret)
2647 return ERR_PTR(ret);
2648
Mika Westerberg40b73182014-10-21 13:33:59 +02002649 return desc;
2650}
2651EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
2652
2653/**
Thierry Reding29a1f2332014-04-25 17:10:06 +02002654 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
2655 * function
2656 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2657 * @con_id: function within the GPIO consumer
2658 * @index: index of the GPIO to obtain in the consumer
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002659 * @flags: optional GPIO initialization flags
Thierry Reding29a1f2332014-04-25 17:10:06 +02002660 *
2661 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
2662 * specified index was assigned to the requested function it will return NULL.
2663 * This is convenient for drivers that need to handle optional GPIOs.
2664 */
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002665struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
Thierry Reding29a1f2332014-04-25 17:10:06 +02002666 const char *con_id,
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002667 unsigned int index,
2668 enum gpiod_flags flags)
Thierry Reding29a1f2332014-04-25 17:10:06 +02002669{
2670 struct gpio_desc *desc;
2671
Alexandre Courbot39b2bbe2014-07-25 23:38:36 +09002672 desc = gpiod_get_index(dev, con_id, index, flags);
Thierry Reding29a1f2332014-04-25 17:10:06 +02002673 if (IS_ERR(desc)) {
2674 if (PTR_ERR(desc) == -ENOENT)
2675 return NULL;
2676 }
2677
2678 return desc;
2679}
Uwe Kleine-Königb17d1bf2015-02-11 11:52:37 +01002680EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
Thierry Reding29a1f2332014-04-25 17:10:06 +02002681
2682/**
Benoit Parrotf625d462015-02-02 11:44:44 -06002683 * gpiod_hog - Hog the specified GPIO desc given the provided flags
2684 * @desc: gpio whose value will be assigned
2685 * @name: gpio line name
2686 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
2687 * of_get_gpio_hog()
2688 * @dflags: gpiod_flags - optional GPIO initialization flags
2689 */
2690int gpiod_hog(struct gpio_desc *desc, const char *name,
2691 unsigned long lflags, enum gpiod_flags dflags)
2692{
2693 struct gpio_chip *chip;
2694 struct gpio_desc *local_desc;
2695 int hwnum;
2696 int status;
2697
2698 chip = gpiod_to_chip(desc);
2699 hwnum = gpio_chip_hwgpio(desc);
2700
Laurent Pinchart923b93e2015-10-13 00:20:20 +03002701 gpiod_parse_flags(desc, lflags);
2702
Benoit Parrotf625d462015-02-02 11:44:44 -06002703 local_desc = gpiochip_request_own_desc(chip, hwnum, name);
2704 if (IS_ERR(local_desc)) {
Laxman Dewanganc31a5712016-03-11 19:13:21 +05302705 status = PTR_ERR(local_desc);
2706 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
2707 name, chip->label, hwnum, status);
2708 return status;
Benoit Parrotf625d462015-02-02 11:44:44 -06002709 }
2710
Laurent Pinchart923b93e2015-10-13 00:20:20 +03002711 status = gpiod_configure_flags(desc, name, dflags);
Benoit Parrotf625d462015-02-02 11:44:44 -06002712 if (status < 0) {
Laxman Dewanganc31a5712016-03-11 19:13:21 +05302713 pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n",
2714 name, chip->label, hwnum, status);
Benoit Parrotf625d462015-02-02 11:44:44 -06002715 gpiochip_free_own_desc(desc);
2716 return status;
2717 }
2718
2719 /* Mark GPIO as hogged so it can be identified and removed later */
2720 set_bit(FLAG_IS_HOGGED, &desc->flags);
2721
2722 pr_info("GPIO line %d (%s) hogged as %s%s\n",
2723 desc_to_gpio(desc), name,
2724 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
2725 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
2726 (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
2727
2728 return 0;
2729}
2730
2731/**
2732 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
2733 * @chip: gpio chip to act on
2734 *
2735 * This is only used by of_gpiochip_remove to free hogged gpios
2736 */
2737static void gpiochip_free_hogs(struct gpio_chip *chip)
2738{
2739 int id;
2740
2741 for (id = 0; id < chip->ngpio; id++) {
Linus Walleij1c3cdb12016-02-09 13:51:59 +01002742 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
2743 gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
Benoit Parrotf625d462015-02-02 11:44:44 -06002744 }
2745}
2746
2747/**
Rojhalat Ibrahim66858522015-02-11 17:27:58 +01002748 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
2749 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2750 * @con_id: function within the GPIO consumer
2751 * @flags: optional GPIO initialization flags
2752 *
2753 * This function acquires all the GPIOs defined under a given function.
2754 *
2755 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
2756 * no GPIO has been assigned to the requested function, or another IS_ERR()
2757 * code if an error occurred while trying to acquire the GPIOs.
2758 */
2759struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
2760 const char *con_id,
2761 enum gpiod_flags flags)
2762{
2763 struct gpio_desc *desc;
2764 struct gpio_descs *descs;
2765 int count;
2766
2767 count = gpiod_count(dev, con_id);
2768 if (count < 0)
2769 return ERR_PTR(count);
2770
2771 descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count,
2772 GFP_KERNEL);
2773 if (!descs)
2774 return ERR_PTR(-ENOMEM);
2775
2776 for (descs->ndescs = 0; descs->ndescs < count; ) {
2777 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
2778 if (IS_ERR(desc)) {
2779 gpiod_put_array(descs);
2780 return ERR_CAST(desc);
2781 }
2782 descs->desc[descs->ndescs] = desc;
2783 descs->ndescs++;
2784 }
2785 return descs;
2786}
2787EXPORT_SYMBOL_GPL(gpiod_get_array);
2788
2789/**
2790 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
2791 * function
2792 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2793 * @con_id: function within the GPIO consumer
2794 * @flags: optional GPIO initialization flags
2795 *
2796 * This is equivalent to gpiod_get_array(), except that when no GPIO was
2797 * assigned to the requested function it will return NULL.
2798 */
2799struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
2800 const char *con_id,
2801 enum gpiod_flags flags)
2802{
2803 struct gpio_descs *descs;
2804
2805 descs = gpiod_get_array(dev, con_id, flags);
2806 if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
2807 return NULL;
2808
2809 return descs;
2810}
2811EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
2812
2813/**
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002814 * gpiod_put - dispose of a GPIO descriptor
2815 * @desc: GPIO descriptor to dispose of
2816 *
2817 * No descriptor can be used after gpiod_put() has been called on it.
2818 */
2819void gpiod_put(struct gpio_desc *desc)
2820{
2821 gpiod_free(desc);
2822}
2823EXPORT_SYMBOL_GPL(gpiod_put);
David Brownelld2876d02008-02-04 22:28:20 -08002824
Rojhalat Ibrahim66858522015-02-11 17:27:58 +01002825/**
2826 * gpiod_put_array - dispose of multiple GPIO descriptors
2827 * @descs: struct gpio_descs containing an array of descriptors
2828 */
2829void gpiod_put_array(struct gpio_descs *descs)
2830{
2831 unsigned int i;
2832
2833 for (i = 0; i < descs->ndescs; i++)
2834 gpiod_put(descs->desc[i]);
2835
2836 kfree(descs);
2837}
2838EXPORT_SYMBOL_GPL(gpiod_put_array);
2839
Linus Walleij3c702e92015-10-21 15:29:53 +02002840static int __init gpiolib_dev_init(void)
2841{
2842 int ret;
2843
2844 /* Register GPIO sysfs bus */
2845 ret = bus_register(&gpio_bus_type);
2846 if (ret < 0) {
2847 pr_err("gpiolib: could not register GPIO bus type\n");
2848 return ret;
2849 }
2850
2851 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
2852 if (ret < 0) {
2853 pr_err("gpiolib: failed to allocate char dev region\n");
2854 bus_unregister(&gpio_bus_type);
2855 }
2856 return ret;
2857}
2858core_initcall(gpiolib_dev_init);
2859
David Brownelld2876d02008-02-04 22:28:20 -08002860#ifdef CONFIG_DEBUG_FS
2861
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002862static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
David Brownelld2876d02008-02-04 22:28:20 -08002863{
2864 unsigned i;
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002865 struct gpio_chip *chip = gdev->chip;
2866 unsigned gpio = gdev->base;
2867 struct gpio_desc *gdesc = &gdev->descs[0];
David Brownelld2876d02008-02-04 22:28:20 -08002868 int is_out;
Linus Walleijd468bf92013-09-24 11:54:38 +02002869 int is_irq;
David Brownelld2876d02008-02-04 22:28:20 -08002870
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002871 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
Markus Pargmannced433e2015-08-14 16:11:02 +02002872 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
2873 if (gdesc->name) {
2874 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
2875 gpio, gdesc->name);
2876 }
David Brownelld2876d02008-02-04 22:28:20 -08002877 continue;
Markus Pargmannced433e2015-08-14 16:11:02 +02002878 }
David Brownelld2876d02008-02-04 22:28:20 -08002879
Alexandre Courbot372e7222013-02-03 01:29:29 +09002880 gpiod_get_direction(gdesc);
David Brownelld2876d02008-02-04 22:28:20 -08002881 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
Linus Walleijd468bf92013-09-24 11:54:38 +02002882 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
Markus Pargmannced433e2015-08-14 16:11:02 +02002883 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
2884 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
David Brownelld2876d02008-02-04 22:28:20 -08002885 is_out ? "out" : "in ",
2886 chip->get
2887 ? (chip->get(chip, i) ? "hi" : "lo")
Linus Walleijd468bf92013-09-24 11:54:38 +02002888 : "? ",
2889 is_irq ? "IRQ" : " ");
David Brownelld2876d02008-02-04 22:28:20 -08002890 seq_printf(s, "\n");
2891 }
2892}
2893
Thierry Redingf9c4a312012-04-12 13:26:01 +02002894static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
David Brownelld2876d02008-02-04 22:28:20 -08002895{
Grant Likely362432a2013-02-09 09:41:49 +00002896 unsigned long flags;
Linus Walleijff2b1352015-10-20 11:10:38 +02002897 struct gpio_device *gdev = NULL;
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002898 loff_t index = *pos;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002899
2900 s->private = "";
2901
Grant Likely362432a2013-02-09 09:41:49 +00002902 spin_lock_irqsave(&gpio_lock, flags);
Linus Walleijff2b1352015-10-20 11:10:38 +02002903 list_for_each_entry(gdev, &gpio_devices, list)
Grant Likely362432a2013-02-09 09:41:49 +00002904 if (index-- == 0) {
2905 spin_unlock_irqrestore(&gpio_lock, flags);
Linus Walleijff2b1352015-10-20 11:10:38 +02002906 return gdev;
Grant Likely362432a2013-02-09 09:41:49 +00002907 }
2908 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002909
2910 return NULL;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002911}
2912
2913static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
2914{
Grant Likely362432a2013-02-09 09:41:49 +00002915 unsigned long flags;
Linus Walleijff2b1352015-10-20 11:10:38 +02002916 struct gpio_device *gdev = v;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002917 void *ret = NULL;
2918
Grant Likely362432a2013-02-09 09:41:49 +00002919 spin_lock_irqsave(&gpio_lock, flags);
Linus Walleijff2b1352015-10-20 11:10:38 +02002920 if (list_is_last(&gdev->list, &gpio_devices))
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002921 ret = NULL;
2922 else
Linus Walleijff2b1352015-10-20 11:10:38 +02002923 ret = list_entry(gdev->list.next, struct gpio_device, list);
Grant Likely362432a2013-02-09 09:41:49 +00002924 spin_unlock_irqrestore(&gpio_lock, flags);
Thierry Redingf9c4a312012-04-12 13:26:01 +02002925
2926 s->private = "\n";
2927 ++*pos;
2928
2929 return ret;
2930}
2931
2932static void gpiolib_seq_stop(struct seq_file *s, void *v)
2933{
2934}
2935
2936static int gpiolib_seq_show(struct seq_file *s, void *v)
2937{
Linus Walleijff2b1352015-10-20 11:10:38 +02002938 struct gpio_device *gdev = v;
2939 struct gpio_chip *chip = gdev->chip;
2940 struct device *parent;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002941
Linus Walleijff2b1352015-10-20 11:10:38 +02002942 if (!chip) {
2943 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
2944 dev_name(&gdev->dev));
2945 return 0;
2946 }
2947
2948 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
2949 dev_name(&gdev->dev),
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002950 gdev->base, gdev->base + gdev->ngpio - 1);
Linus Walleijff2b1352015-10-20 11:10:38 +02002951 parent = chip->parent;
2952 if (parent)
2953 seq_printf(s, ", parent: %s/%s",
2954 parent->bus ? parent->bus->name : "no-bus",
2955 dev_name(parent));
Thierry Redingf9c4a312012-04-12 13:26:01 +02002956 if (chip->label)
2957 seq_printf(s, ", %s", chip->label);
2958 if (chip->can_sleep)
2959 seq_printf(s, ", can sleep");
2960 seq_printf(s, ":\n");
2961
2962 if (chip->dbg_show)
2963 chip->dbg_show(s, chip);
2964 else
Linus Walleijfdeb8e12016-02-10 10:57:36 +01002965 gpiolib_dbg_show(s, gdev);
Thierry Redingf9c4a312012-04-12 13:26:01 +02002966
David Brownelld2876d02008-02-04 22:28:20 -08002967 return 0;
2968}
2969
Thierry Redingf9c4a312012-04-12 13:26:01 +02002970static const struct seq_operations gpiolib_seq_ops = {
2971 .start = gpiolib_seq_start,
2972 .next = gpiolib_seq_next,
2973 .stop = gpiolib_seq_stop,
2974 .show = gpiolib_seq_show,
2975};
2976
David Brownelld2876d02008-02-04 22:28:20 -08002977static int gpiolib_open(struct inode *inode, struct file *file)
2978{
Thierry Redingf9c4a312012-04-12 13:26:01 +02002979 return seq_open(file, &gpiolib_seq_ops);
David Brownelld2876d02008-02-04 22:28:20 -08002980}
2981
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002982static const struct file_operations gpiolib_operations = {
Thierry Redingf9c4a312012-04-12 13:26:01 +02002983 .owner = THIS_MODULE,
David Brownelld2876d02008-02-04 22:28:20 -08002984 .open = gpiolib_open,
2985 .read = seq_read,
2986 .llseek = seq_lseek,
Thierry Redingf9c4a312012-04-12 13:26:01 +02002987 .release = seq_release,
David Brownelld2876d02008-02-04 22:28:20 -08002988};
2989
2990static int __init gpiolib_debugfs_init(void)
2991{
2992 /* /sys/kernel/debug/gpio */
2993 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
2994 NULL, NULL, &gpiolib_operations);
2995 return 0;
2996}
2997subsys_initcall(gpiolib_debugfs_init);
2998
2999#endif /* DEBUG_FS */