gpio: of: Scan available child node for gpio-hog
[deliverable/linux.git] / drivers / gpio / gpiolib.c
CommitLineData
d2876d08
DB
1#include <linux/kernel.h>
2#include <linux/module.h>
ff77c352 3#include <linux/interrupt.h>
d2876d08
DB
4#include <linux/irq.h>
5#include <linux/spinlock.h>
1a989d0f 6#include <linux/list.h>
d8f388d8
DB
7#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>
391c970c 12#include <linux/of_gpio.h>
ff77c352 13#include <linux/idr.h>
5a0e3ad6 14#include <linux/slab.h>
7b199811 15#include <linux/acpi.h>
53e7cac3 16#include <linux/gpio/driver.h>
0a6d3158 17#include <linux/gpio/machine.h>
c771c2f4 18#include <linux/pinctrl/consumer.h>
ff2b1359 19#include <linux/idr.h>
3c702e99
LW
20#include <linux/cdev.h>
21#include <linux/fs.h>
22#include <linux/uaccess.h>
23#include <uapi/linux/gpio.h>
d2876d08 24
664e3e5a
MW
25#include "gpiolib.h"
26
3f397c21
UKK
27#define CREATE_TRACE_POINTS
28#include <trace/events/gpio.h>
d2876d08 29
79a9becd 30/* Implementation infrastructure for GPIO interfaces.
d2876d08 31 *
79a9becd
AC
32 * 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.
d2876d08
DB
35 */
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
ff2b1359
LW
50/* Device and char device-related information */
51static DEFINE_IDA(gpio_ida);
3c702e99
LW
52static 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};
ff2b1359 57
d2876d08
DB
58/* 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 */
0eb4c6c2 62DEFINE_SPINLOCK(gpio_lock);
d2876d08 63
bae48da2
AC
64static DEFINE_MUTEX(gpio_lookup_lock);
65static LIST_HEAD(gpio_lookup_list);
ff2b1359 66LIST_HEAD(gpio_devices);
6d86750c
JH
67
68static void gpiochip_free_hogs(struct gpio_chip *chip);
69static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
70
71
d2876d08
DB
72static inline void desc_set_label(struct gpio_desc *d, const char *label)
73{
d2876d08 74 d->label = label;
d2876d08
DB
75}
76
372e722e
AC
77/**
78 * Convert a GPIO number to its descriptor
79 */
79a9becd 80struct gpio_desc *gpio_to_desc(unsigned gpio)
372e722e 81{
ff2b1359 82 struct gpio_device *gdev;
14e85c0e
AC
83 unsigned long flags;
84
85 spin_lock_irqsave(&gpio_lock, flags);
86
ff2b1359 87 list_for_each_entry(gdev, &gpio_devices, list) {
fdeb8e15
LW
88 if (gdev->base <= gpio &&
89 gdev->base + gdev->ngpio > gpio) {
14e85c0e 90 spin_unlock_irqrestore(&gpio_lock, flags);
fdeb8e15 91 return &gdev->descs[gpio - gdev->base];
14e85c0e
AC
92 }
93 }
94
95 spin_unlock_irqrestore(&gpio_lock, flags);
96
0e9a5edf
AC
97 if (!gpio_is_valid(gpio))
98 WARN(1, "invalid GPIO %d\n", gpio);
99
14e85c0e 100 return NULL;
372e722e 101}
79a9becd 102EXPORT_SYMBOL_GPL(gpio_to_desc);
372e722e 103
d468bf9e 104/**
bb1e88cc 105 * Get the GPIO descriptor corresponding to the given hw number for this chip.
d468bf9e 106 */
bb1e88cc
AC
107struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
108 u16 hwnum)
d468bf9e 109{
fdeb8e15
LW
110 struct gpio_device *gdev = chip->gpiodev;
111
112 if (hwnum >= gdev->ngpio)
b7d0a28a 113 return ERR_PTR(-EINVAL);
d468bf9e 114
fdeb8e15 115 return &gdev->descs[hwnum];
d468bf9e 116}
372e722e
AC
117
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 */
79a9becd 123int desc_to_gpio(const struct gpio_desc *desc)
372e722e 124{
fdeb8e15 125 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
372e722e 126}
79a9becd 127EXPORT_SYMBOL_GPL(desc_to_gpio);
372e722e
AC
128
129
79a9becd
AC
130/**
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)
372e722e 135{
fdeb8e15
LW
136 if (!desc || !desc->gdev || !desc->gdev->chip)
137 return NULL;
138 return desc->gdev->chip;
372e722e 139}
79a9becd 140EXPORT_SYMBOL_GPL(gpiod_to_chip);
d2876d08 141
8d0aab2f
AV
142/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
143static int gpiochip_find_base(int ngpio)
144{
ff2b1359 145 struct gpio_device *gdev;
83cabe33 146 int base = ARCH_NR_GPIOS - ngpio;
8d0aab2f 147
ff2b1359 148 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
83cabe33 149 /* found a free space? */
fdeb8e15 150 if (gdev->base + gdev->ngpio <= base)
83cabe33
AC
151 break;
152 else
153 /* nope, check the space right before the chip */
fdeb8e15 154 base = gdev->base - ngpio;
8d0aab2f
AV
155 }
156
83cabe33 157 if (gpio_is_valid(base)) {
8d0aab2f 158 pr_debug("%s: found new base at %d\n", __func__, base);
83cabe33
AC
159 return base;
160 } else {
161 pr_err("%s: cannot find free range\n", __func__);
162 return -ENOSPC;
169b6a7a 163 }
169b6a7a
AV
164}
165
79a9becd
AC
166/**
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 */
8e53b0f1 174int gpiod_get_direction(struct gpio_desc *desc)
80b0a602
MN
175{
176 struct gpio_chip *chip;
372e722e 177 unsigned offset;
80b0a602
MN
178 int status = -EINVAL;
179
372e722e
AC
180 chip = gpiod_to_chip(desc);
181 offset = gpio_chip_hwgpio(desc);
80b0a602
MN
182
183 if (!chip->get_direction)
184 return status;
185
372e722e 186 status = chip->get_direction(chip, offset);
80b0a602
MN
187 if (status > 0) {
188 /* GPIOF_DIR_IN, or other positive */
189 status = 1;
8e53b0f1 190 clear_bit(FLAG_IS_OUT, &desc->flags);
80b0a602
MN
191 }
192 if (status == 0) {
193 /* GPIOF_DIR_OUT */
8e53b0f1 194 set_bit(FLAG_IS_OUT, &desc->flags);
80b0a602
MN
195 }
196 return status;
197}
79a9becd 198EXPORT_SYMBOL_GPL(gpiod_get_direction);
80b0a602 199
1a989d0f
AC
200/*
201 * Add a new chip to the global chips list, keeping the list of chips sorted
ef7c7553 202 * by range(means [base, base + ngpio - 1]) order.
1a989d0f
AC
203 *
204 * Return -EBUSY if the new chip overlaps with some other chip's integer
205 * space.
206 */
ff2b1359 207static int gpiodev_add_to_list(struct gpio_device *gdev)
1a989d0f 208{
a961f9b4 209 struct gpio_device *prev, *next;
1a989d0f 210
ff2b1359 211 if (list_empty(&gpio_devices)) {
a961f9b4 212 /* initial entry in list */
ff2b1359 213 list_add_tail(&gdev->list, &gpio_devices);
e28ecca6 214 return 0;
1a989d0f
AC
215 }
216
a961f9b4
BJZ
217 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);
221 return 0;
1a989d0f
AC
222 }
223
a961f9b4
BJZ
224 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);
96098df1 228 return 0;
1a989d0f
AC
229 }
230
a961f9b4
BJZ
231 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;
1a989d0f 235
a961f9b4
BJZ
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;
1a989d0f
AC
246}
247
f881bab0
LW
248/**
249 * Convert a GPIO name to its descriptor
250 */
251static struct gpio_desc *gpio_name_to_desc(const char * const name)
252{
ff2b1359 253 struct gpio_device *gdev;
f881bab0
LW
254 unsigned long flags;
255
256 spin_lock_irqsave(&gpio_lock, flags);
257
ff2b1359 258 list_for_each_entry(gdev, &gpio_devices, list) {
f881bab0
LW
259 int i;
260
fdeb8e15
LW
261 for (i = 0; i != gdev->ngpio; ++i) {
262 struct gpio_desc *desc = &gdev->descs[i];
f881bab0 263
fdeb8e15 264 if (!desc->name || !name)
f881bab0
LW
265 continue;
266
fdeb8e15 267 if (!strcmp(desc->name, name)) {
f881bab0 268 spin_unlock_irqrestore(&gpio_lock, flags);
fdeb8e15 269 return desc;
f881bab0
LW
270 }
271 }
272 }
273
274 spin_unlock_irqrestore(&gpio_lock, flags);
275
276 return NULL;
277}
278
5f3ca732
MP
279/*
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 *
ed37915c 283 * Warning if one of the names is already used for a different GPIO.
5f3ca732
MP
284 */
285static int gpiochip_set_desc_names(struct gpio_chip *gc)
286{
fdeb8e15 287 struct gpio_device *gdev = gc->gpiodev;
5f3ca732
MP
288 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]);
f881bab0 298 if (gpio)
fdeb8e15 299 dev_warn(&gdev->dev,
34ffd85d 300 "Detected name collision for GPIO name '%s'\n",
f881bab0 301 gc->names[i]);
5f3ca732
MP
302 }
303
304 /* Then add all names to the GPIO descriptors */
305 for (i = 0; i != gc->ngpio; ++i)
fdeb8e15 306 gdev->descs[i].name = gc->names[i];
5f3ca732
MP
307
308 return 0;
309}
310
3c702e99
LW
311/**
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;
3c702e99
LW
319
320 /* We fail any subsequent ioctl():s when the chip is gone */
321 if (!chip)
322 return -ENODEV;
323
521a2ad6 324 /* Fill in the struct and pass to userspace */
3c702e99 325 if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
521a2ad6
LW
326 struct gpiochip_info chipinfo;
327
3c702e99
LW
328 strncpy(chipinfo.name, dev_name(&gdev->dev),
329 sizeof(chipinfo.name));
330 chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
df4878e9
LW
331 strncpy(chipinfo.label, gdev->label,
332 sizeof(chipinfo.label));
333 chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
fdeb8e15 334 chipinfo.lines = gdev->ngpio;
3c702e99
LW
335 if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
336 return -EFAULT;
337 return 0;
521a2ad6
LW
338 } 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) {
214338e3
LW
356 strncpy(lineinfo.consumer, desc->label,
357 sizeof(lineinfo.consumer));
358 lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
521a2ad6 359 } else {
214338e3 360 lineinfo.consumer[0] = '\0';
521a2ad6
LW
361 }
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;
9d8cc89c
LW
368 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))
521a2ad6 373 lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
9d8cc89c 374 if (test_bit(FLAG_IS_OUT, &desc->flags))
521a2ad6 375 lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
9d8cc89c 376 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
521a2ad6 377 lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
9d8cc89c 378 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
521a2ad6 379 lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
9d8cc89c 380 if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
521a2ad6
LW
381 lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;
382
383 if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
384 return -EFAULT;
385 return 0;
3c702e99
LW
386 }
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
ff2b1359
LW
436static void gpiodevice_release(struct device *dev)
437{
438 struct gpio_device *gdev = dev_get_drvdata(dev);
439
3c702e99 440 cdev_del(&gdev->chrdev);
ff2b1359
LW
441 list_del(&gdev->list);
442 ida_simple_remove(&gpio_ida, gdev->id);
9efd9e69 443 kfree(gdev);
ff2b1359
LW
444}
445
d2876d08 446/**
b08ea35a 447 * gpiochip_add_data() - register a gpio_chip
d2876d08 448 * @chip: the chip to register, with chip->base initialized
14e85c0e 449 * Context: potentially before irqs will work
d2876d08
DB
450 *
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.
8d0aab2f 454 *
b08ea35a 455 * When gpiochip_add_data() is called very early during boot, so that GPIOs
c88402c2 456 * can be freely used, the chip->parent device must be registered before
d8f388d8
DB
457 * the gpio framework's arch_initcall(). Otherwise sysfs initialization
458 * for GPIOs will fail rudely.
459 *
8d0aab2f
AV
460 * If chip->base is negative, this requests dynamic assignment of
461 * a range of valid GPIOs.
d2876d08 462 */
b08ea35a 463int gpiochip_add_data(struct gpio_chip *chip, void *data)
d2876d08
DB
464{
465 unsigned long flags;
466 int status = 0;
ff2b1359 467 unsigned i;
8d0aab2f 468 int base = chip->base;
ff2b1359 469 struct gpio_device *gdev;
d2876d08 470
ff2b1359
LW
471 /*
472 * First: allocate and populate the internal stat container, and
473 * set up the struct device.
474 */
969f07b4 475 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
ff2b1359 476 if (!gdev)
14e85c0e 477 return -ENOMEM;
3c702e99 478 gdev->dev.bus = &gpio_bus_type;
ff2b1359
LW
479 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;
d2876d08 506
1c3cdb18
LW
507 gdev->descs = devm_kcalloc(&gdev->dev, chip->ngpio,
508 sizeof(gdev->descs[0]), GFP_KERNEL);
509 if (!gdev->descs) {
ff2b1359
LW
510 status = -ENOMEM;
511 goto err_free_gdev;
512 }
513
5ed41cc4
BJZ
514 if (chip->ngpio == 0) {
515 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
ff2b1359 516 status = -EINVAL;
1c3cdb18 517 goto err_free_gdev;
5ed41cc4 518 }
df4878e9
LW
519
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
fdeb8e15 529 gdev->ngpio = chip->ngpio;
43c54eca 530 gdev->data = data;
5ed41cc4 531
d2876d08
DB
532 spin_lock_irqsave(&gpio_lock, flags);
533
fdeb8e15
LW
534 /*
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 */
8d0aab2f
AV
541 if (base < 0) {
542 base = gpiochip_find_base(chip->ngpio);
543 if (base < 0) {
544 status = base;
225fce83 545 spin_unlock_irqrestore(&gpio_lock, flags);
1c3cdb18 546 goto err_free_gdev;
8d0aab2f 547 }
fdeb8e15
LW
548 /*
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 */
8d0aab2f
AV
554 chip->base = base;
555 }
fdeb8e15 556 gdev->base = base;
8d0aab2f 557
ff2b1359 558 status = gpiodev_add_to_list(gdev);
05aa5203
JH
559 if (status) {
560 spin_unlock_irqrestore(&gpio_lock, flags);
1c3cdb18 561 goto err_free_gdev;
05aa5203 562 }
1a989d0f 563
ff2b1359 564 for (i = 0; i < chip->ngpio; i++) {
1c3cdb18 565 struct gpio_desc *desc = &gdev->descs[i];
05aa5203 566
fdeb8e15 567 desc->gdev = gdev;
05aa5203
JH
568
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;
d2876d08 576 }
14e85c0e 577
3bae4811
ZG
578 spin_unlock_irqrestore(&gpio_lock, flags);
579
f23f1516 580#ifdef CONFIG_PINCTRL
20ec3e39 581 INIT_LIST_HEAD(&gdev->pin_ranges);
f23f1516
SH
582#endif
583
5f3ca732
MP
584 status = gpiochip_set_desc_names(chip);
585 if (status)
586 goto err_remove_from_list;
587
28355f81
TV
588 status = of_gpiochip_add(chip);
589 if (status)
590 goto err_remove_chip;
591
664e3e5a 592 acpi_gpiochip_add(chip);
391c970c 593
3c702e99
LW
594 /*
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);
ff2b1359 611 status = device_add(&gdev->dev);
225fce83 612 if (status)
3c702e99 613 goto err_remove_chardev;
cedb1881 614
afbc4f31 615 status = gpiochip_sysfs_register(gdev);
ff2b1359
LW
616 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);
fdeb8e15
LW
622 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");
64842aad 625
cedb1881 626 return 0;
3bae4811 627
ff2b1359
LW
628err_remove_device:
629 device_del(&gdev->dev);
3c702e99
LW
630err_remove_chardev:
631 cdev_del(&gdev->chrdev);
225fce83
JH
632err_remove_chip:
633 acpi_gpiochip_remove(chip);
6d86750c 634 gpiochip_free_hogs(chip);
225fce83 635 of_gpiochip_remove(chip);
5f3ca732 636err_remove_from_list:
225fce83 637 spin_lock_irqsave(&gpio_lock, flags);
ff2b1359 638 list_del(&gdev->list);
3bae4811 639 spin_unlock_irqrestore(&gpio_lock, flags);
ff2b1359
LW
640err_free_gdev:
641 ida_simple_remove(&gpio_ida, gdev->id);
d2876d08 642 /* failures here can mean systems won't boot... */
7589e59f 643 pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
fdeb8e15
LW
644 gdev->base, gdev->base + gdev->ngpio - 1,
645 chip->label ? : "generic");
646 kfree(gdev);
d2876d08
DB
647 return status;
648}
b08ea35a 649EXPORT_SYMBOL_GPL(gpiochip_add_data);
d2876d08 650
43c54eca
LW
651/**
652 * 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
d2876d08
DB
660/**
661 * 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 */
e1db1706 666void gpiochip_remove(struct gpio_chip *chip)
d2876d08 667{
ff2b1359 668 struct gpio_device *gdev = chip->gpiodev;
fab28b89 669 struct gpio_desc *desc;
d2876d08 670 unsigned long flags;
1c3cdb18 671 unsigned i;
fab28b89 672 bool requested = false;
d2876d08 673
ff2b1359 674 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
afbc4f31 675 gpiochip_sysfs_unregister(gdev);
bd203bd5
BJZ
676 /* Numb the device, cancelling all outstanding operations */
677 gdev->chip = NULL;
00acc3dc 678 gpiochip_irqchip_remove(chip);
6072b9dc 679 acpi_gpiochip_remove(chip);
9ef0d6f7 680 gpiochip_remove_pin_ranges(chip);
f625d460 681 gpiochip_free_hogs(chip);
391c970c 682 of_gpiochip_remove(chip);
43c54eca
LW
683 /*
684 * We accept no more calls into the driver from this point, so
685 * NULL the driver data pointer
686 */
687 gdev->data = NULL;
391c970c 688
6798acaa 689 spin_lock_irqsave(&gpio_lock, flags);
fdeb8e15 690 for (i = 0; i < gdev->ngpio; i++) {
1c3cdb18 691 desc = &gdev->descs[i];
fab28b89
JH
692 if (test_bit(FLAG_REQUESTED, &desc->flags))
693 requested = true;
d2876d08 694 }
d2876d08 695 spin_unlock_irqrestore(&gpio_lock, flags);
14e85c0e 696
fab28b89 697 if (requested)
fdeb8e15 698 dev_crit(&gdev->dev,
58383c78 699 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
fab28b89 700
ff2b1359
LW
701 /*
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);
d2876d08
DB
708}
709EXPORT_SYMBOL_GPL(gpiochip_remove);
710
0cf3292c
LD
711static 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
594fa265
GL
785/**
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 */
07ce8ec7 796struct gpio_chip *gpiochip_find(void *data,
6e2cf651 797 int (*match)(struct gpio_chip *chip,
3d0f7cf0 798 void *data))
594fa265 799{
ff2b1359 800 struct gpio_device *gdev;
125eef96 801 struct gpio_chip *chip;
594fa265 802 unsigned long flags;
594fa265
GL
803
804 spin_lock_irqsave(&gpio_lock, flags);
ff2b1359
LW
805 list_for_each_entry(gdev, &gpio_devices, list)
806 if (match(gdev->chip, data))
594fa265 807 break;
125eef96
AC
808
809 /* No match? */
ff2b1359 810 if (&gdev->list == &gpio_devices)
125eef96 811 chip = NULL;
ff2b1359
LW
812 else
813 chip = gdev->chip;
814
594fa265
GL
815 spin_unlock_irqrestore(&gpio_lock, flags);
816
817 return chip;
818}
8fa0c9bf 819EXPORT_SYMBOL_GPL(gpiochip_find);
d2876d08 820
79697ef9
AC
821static 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
14250520
LW
833#ifdef CONFIG_GPIOLIB_IRQCHIP
834
835/*
836 * The following is irqchip helper code for gpiochips.
837 */
838
839/**
3f97d5fc
LW
840 * 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
14250520
LW
843 * @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
3f97d5fc
LW
846 * coming out of the gpiochip. If the interrupt is nested rather than
847 * cascaded, pass NULL in this handler argument
14250520
LW
848 */
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{
83141a77
LW
854 unsigned int offset;
855
83141a77
LW
856 if (!gpiochip->irqdomain) {
857 chip_err(gpiochip, "called %s before setting up irqchip\n",
858 __func__);
1c8732bb
LW
859 return;
860 }
861
3f97d5fc
LW
862 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 }
3f97d5fc
LW
869 /*
870 * The parent irqchip is already using the chip_data for this
871 * irqchip, so our callbacks simply use the handler_data.
872 */
f7f87753
TG
873 irq_set_chained_handler_and_data(parent_irq, parent_handler,
874 gpiochip);
25e4fe92
DES
875
876 gpiochip->irq_parent = parent_irq;
3f97d5fc 877 }
83141a77
LW
878
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);
14250520
LW
883}
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
14250520 901 irq_set_chip_data(irq, chip);
a0a8bcf4
GS
902 /*
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);
7633fb95 907 irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
1c8732bb 908 /* Chips that can sleep need nested thread handlers */
295494af 909 if (chip->can_sleep && !chip->irq_not_threaded)
1c8732bb 910 irq_set_nested_thread(irq, 1);
14250520 911 irq_set_noprobe(irq);
23393d49 912
1333b90f
LW
913 /*
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);
14250520
LW
919
920 return 0;
921}
922
c3626fde
LW
923static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
924{
1c8732bb
LW
925 struct gpio_chip *chip = d->host_data;
926
1c8732bb
LW
927 if (chip->can_sleep)
928 irq_set_nested_thread(irq, 0);
c3626fde
LW
929 irq_set_chip_and_handler(irq, NULL, NULL);
930 irq_set_chip_data(irq, NULL);
931}
932
14250520
LW
933static const struct irq_domain_ops gpiochip_domain_ops = {
934 .map = gpiochip_irq_map,
c3626fde 935 .unmap = gpiochip_irq_unmap,
14250520
LW
936 /* 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
ff2b1359 944 if (!try_module_get(chip->gpiodev->owner))
5b76e79c
GS
945 return -ENODEV;
946
e3a2e878 947 if (gpiochip_lock_as_irq(chip, d->hwirq)) {
14250520
LW
948 chip_err(chip,
949 "unable to lock HW IRQ %lu for IRQ\n",
950 d->hwirq);
ff2b1359 951 module_put(chip->gpiodev->owner);
14250520
LW
952 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
e3a2e878 961 gpiochip_unlock_as_irq(chip, d->hwirq);
ff2b1359 962 module_put(chip->gpiodev->owner);
14250520
LW
963}
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{
c3626fde
LW
978 unsigned int offset;
979
afa82fab
MW
980 acpi_gpiochip_free_interrupts(gpiochip);
981
25e4fe92
DES
982 if (gpiochip->irq_parent) {
983 irq_set_chained_handler(gpiochip->irq_parent, NULL);
984 irq_set_handler_data(gpiochip->irq_parent, NULL);
985 }
986
c3626fde
LW
987 /* Remove all IRQ mappings and delete the domain */
988 if (gpiochip->irqdomain) {
989 for (offset = 0; offset < gpiochip->ngpio; offset++)
e3893386
GS
990 irq_dispose_mapping(
991 irq_find_mapping(gpiochip->irqdomain, offset));
14250520 992 irq_domain_remove(gpiochip->irqdomain);
c3626fde 993 }
14250520
LW
994
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)
1333b90f
LW
1009 * @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.
a0a8bcf4 1011 * @lock_key: lockdep class
14250520
LW
1012 *
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
09dd5f9e 1017 * need to use gpiochip_get_data() to get their local state containers back
14250520
LW
1018 * 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 *
c3626fde
LW
1023 * 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
14250520
LW
1025 * need to be open coded.
1026 */
a0a8bcf4
GS
1027int _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)
14250520
LW
1033{
1034 struct device_node *of_node;
1035 unsigned int offset;
c3626fde 1036 unsigned irq_base = 0;
14250520
LW
1037
1038 if (!gpiochip || !irqchip)
1039 return -EINVAL;
1040
58383c78 1041 if (!gpiochip->parent) {
14250520
LW
1042 pr_err("missing gpiochip .dev parent pointer\n");
1043 return -EINVAL;
1044 }
58383c78 1045 of_node = gpiochip->parent->of_node;
14250520
LW
1046#ifdef CONFIG_OF_GPIO
1047 /*
20a8a968 1048 * If the gpiochip has an assigned OF node this takes precedence
c88402c2
BJZ
1049 * FIXME: get rid of this and use gpiochip->parent->of_node
1050 * everywhere
14250520
LW
1051 */
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;
a0a8bcf4 1059 gpiochip->lock_key = lock_key;
14250520
LW
1060 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 }
8b67a1f0
RV
1067
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 }
14250520
LW
1077
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 */
c3626fde
LW
1083 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 }
14250520 1092
afa82fab
MW
1093 acpi_gpiochip_request_interrupts(gpiochip);
1094
14250520
LW
1095 return 0;
1096}
a0a8bcf4 1097EXPORT_SYMBOL_GPL(_gpiochip_irqchip_add);
14250520
LW
1098
1099#else /* CONFIG_GPIOLIB_IRQCHIP */
1100
1101static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
1102
1103#endif /* CONFIG_GPIOLIB_IRQCHIP */
1104
c771c2f4
JG
1105/**
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{
fdeb8e15 1112 return pinctrl_request_gpio(chip->gpiodev->base + offset);
c771c2f4
JG
1113}
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{
fdeb8e15 1123 pinctrl_free_gpio(chip->gpiodev->base + offset);
c771c2f4
JG
1124}
1125EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1126
f23f1516 1127#ifdef CONFIG_PINCTRL
165adc9c 1128
586a87e6
CR
1129/**
1130 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1131 * @chip: the gpiochip to add the range for
d32651f6 1132 * @pctldev: the pin controller to map to
586a87e6
CR
1133 * @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;
fdeb8e15 1141 struct gpio_device *gdev = chip->gpiodev;
586a87e6
CR
1142 int ret;
1143
1144 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1145 if (!pin_range) {
1a2a99c6 1146 chip_err(chip, "failed to allocate pin ranges\n");
586a87e6
CR
1147 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;
fdeb8e15 1154 pin_range->range.base = gdev->base + gpio_offset;
586a87e6
CR
1155 pin_range->pctldev = pctldev;
1156
1157 ret = pinctrl_get_group_pins(pctldev, pin_group,
1158 &pin_range->range.pins,
1159 &pin_range->range.npins);
61c6375d
MN
1160 if (ret < 0) {
1161 kfree(pin_range);
586a87e6 1162 return ret;
61c6375d 1163 }
586a87e6
CR
1164
1165 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1166
1a2a99c6
AS
1167 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1168 gpio_offset, gpio_offset + pin_range->range.npins - 1,
586a87e6
CR
1169 pinctrl_dev_get_devname(pctldev), pin_group);
1170
20ec3e39 1171 list_add_tail(&pin_range->node, &gdev->pin_ranges);
586a87e6
CR
1172
1173 return 0;
1174}
1175EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1176
3f0f8670
LW
1177/**
1178 * 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
316511c0
LW
1181 * @gpio_offset: the start offset in the current gpio_chip number space
1182 * @pin_offset: the start offset in the pin controller number space
3f0f8670
LW
1183 * @npins: the number of pins from the offset of each pin space (GPIO and
1184 * pin controller) to accumulate in this range
1185 */
1e63d7b9 1186int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
316511c0 1187 unsigned int gpio_offset, unsigned int pin_offset,
3f0f8670 1188 unsigned int npins)
f23f1516
SH
1189{
1190 struct gpio_pin_range *pin_range;
fdeb8e15 1191 struct gpio_device *gdev = chip->gpiodev;
b4d4b1f0 1192 int ret;
f23f1516 1193
3f0f8670 1194 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
f23f1516 1195 if (!pin_range) {
1a2a99c6 1196 chip_err(chip, "failed to allocate pin ranges\n");
1e63d7b9 1197 return -ENOMEM;
f23f1516
SH
1198 }
1199
3f0f8670 1200 /* Use local offset as range ID */
316511c0 1201 pin_range->range.id = gpio_offset;
3f0f8670 1202 pin_range->range.gc = chip;
f23f1516 1203 pin_range->range.name = chip->label;
fdeb8e15 1204 pin_range->range.base = gdev->base + gpio_offset;
316511c0 1205 pin_range->range.pin_base = pin_offset;
f23f1516 1206 pin_range->range.npins = npins;
192c369c 1207 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
f23f1516 1208 &pin_range->range);
8f23ca1a 1209 if (IS_ERR(pin_range->pctldev)) {
b4d4b1f0 1210 ret = PTR_ERR(pin_range->pctldev);
1a2a99c6 1211 chip_err(chip, "could not create pin range\n");
3f0f8670 1212 kfree(pin_range);
b4d4b1f0 1213 return ret;
3f0f8670 1214 }
1a2a99c6
AS
1215 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1216 gpio_offset, gpio_offset + npins - 1,
316511c0
LW
1217 pinctl_name,
1218 pin_offset, pin_offset + npins - 1);
f23f1516 1219
20ec3e39 1220 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1e63d7b9
LW
1221
1222 return 0;
f23f1516 1223}
165adc9c 1224EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
f23f1516 1225
3f0f8670
LW
1226/**
1227 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1228 * @chip: the chip to remove all the mappings for
1229 */
f23f1516
SH
1230void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
1231{
1232 struct gpio_pin_range *pin_range, *tmp;
20ec3e39 1233 struct gpio_device *gdev = chip->gpiodev;
f23f1516 1234
20ec3e39 1235 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
f23f1516
SH
1236 list_del(&pin_range->node);
1237 pinctrl_remove_gpio_range(pin_range->pctldev,
1238 &pin_range->range);
3f0f8670 1239 kfree(pin_range);
f23f1516
SH
1240 }
1241}
165adc9c
LW
1242EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1243
1244#endif /* CONFIG_PINCTRL */
f23f1516 1245
d2876d08
DB
1246/* 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 */
77c2d792 1250static int __gpiod_request(struct gpio_desc *desc, const char *label)
d2876d08 1251{
fdeb8e15 1252 struct gpio_chip *chip = desc->gdev->chip;
77c2d792 1253 int status;
d2876d08
DB
1254 unsigned long flags;
1255
bcabdef1
AC
1256 spin_lock_irqsave(&gpio_lock, flags);
1257
d2876d08 1258 /* NOTE: gpio_request() can be called in early boot,
35e8bb51 1259 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
d2876d08
DB
1260 */
1261
1262 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1263 desc_set_label(desc, label ? : "?");
1264 status = 0;
438d8908 1265 } else {
d2876d08 1266 status = -EBUSY;
7460db56 1267 goto done;
35e8bb51
DB
1268 }
1269
1270 if (chip->request) {
1271 /* chip->request may sleep */
1272 spin_unlock_irqrestore(&gpio_lock, flags);
372e722e 1273 status = chip->request(chip, gpio_chip_hwgpio(desc));
35e8bb51
DB
1274 spin_lock_irqsave(&gpio_lock, flags);
1275
1276 if (status < 0) {
1277 desc_set_label(desc, NULL);
35e8bb51 1278 clear_bit(FLAG_REQUESTED, &desc->flags);
80b0a602 1279 goto done;
35e8bb51 1280 }
438d8908 1281 }
80b0a602
MN
1282 if (chip->get_direction) {
1283 /* chip->get_direction may sleep */
1284 spin_unlock_irqrestore(&gpio_lock, flags);
372e722e 1285 gpiod_get_direction(desc);
80b0a602
MN
1286 spin_lock_irqsave(&gpio_lock, flags);
1287 }
77c2d792 1288done:
923b93e4
LP
1289 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 }
77c2d792
MW
1297 spin_unlock_irqrestore(&gpio_lock, flags);
1298 return status;
1299}
1300
fdeb8e15
LW
1301/*
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
0eb4c6c2 1329int gpiod_request(struct gpio_desc *desc, const char *label)
77c2d792
MW
1330{
1331 int status = -EPROBE_DEFER;
fdeb8e15 1332 struct gpio_device *gdev;
77c2d792 1333
fdeb8e15
LW
1334 VALIDATE_DESC(desc);
1335 gdev = desc->gdev;
77c2d792 1336
fdeb8e15 1337 if (try_module_get(gdev->owner)) {
77c2d792
MW
1338 status = __gpiod_request(desc, label);
1339 if (status < 0)
fdeb8e15 1340 module_put(gdev->owner);
33a68e86
LW
1341 else
1342 get_device(&gdev->dev);
77c2d792
MW
1343 }
1344
d2876d08 1345 if (status)
7589e59f 1346 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
77c2d792 1347
d2876d08
DB
1348 return status;
1349}
372e722e 1350
77c2d792 1351static bool __gpiod_free(struct gpio_desc *desc)
d2876d08 1352{
77c2d792 1353 bool ret = false;
d2876d08 1354 unsigned long flags;
35e8bb51 1355 struct gpio_chip *chip;
d2876d08 1356
3d599d1c
UKK
1357 might_sleep();
1358
372e722e 1359 gpiod_unexport(desc);
d8f388d8 1360
d2876d08
DB
1361 spin_lock_irqsave(&gpio_lock, flags);
1362
fdeb8e15 1363 chip = desc->gdev->chip;
35e8bb51
DB
1364 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
1365 if (chip->free) {
1366 spin_unlock_irqrestore(&gpio_lock, flags);
9c4ba946 1367 might_sleep_if(chip->can_sleep);
372e722e 1368 chip->free(chip, gpio_chip_hwgpio(desc));
35e8bb51
DB
1369 spin_lock_irqsave(&gpio_lock, flags);
1370 }
d2876d08 1371 desc_set_label(desc, NULL);
07697461 1372 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
35e8bb51 1373 clear_bit(FLAG_REQUESTED, &desc->flags);
aca5ce14 1374 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
25553ff0 1375 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
f625d460 1376 clear_bit(FLAG_IS_HOGGED, &desc->flags);
77c2d792
MW
1377 ret = true;
1378 }
d2876d08
DB
1379
1380 spin_unlock_irqrestore(&gpio_lock, flags);
77c2d792
MW
1381 return ret;
1382}
1383
0eb4c6c2 1384void gpiod_free(struct gpio_desc *desc)
77c2d792 1385{
33a68e86 1386 if (desc && desc->gdev && __gpiod_free(desc)) {
fdeb8e15 1387 module_put(desc->gdev->owner);
33a68e86
LW
1388 put_device(&desc->gdev->dev);
1389 } else {
77c2d792 1390 WARN_ON(extra_checks);
33a68e86 1391 }
d2876d08 1392}
372e722e 1393
d2876d08
DB
1394/**
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.
9c8318ff
AC
1400 * The string returned is the label passed to gpio_request(); if none has been
1401 * passed it is a meaningless, non-NULL constant.
d2876d08
DB
1402 *
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{
6c0b4e6c 1409 struct gpio_desc *desc;
d2876d08 1410
48b5953e 1411 if (offset >= chip->ngpio)
d2876d08 1412 return NULL;
6c0b4e6c 1413
1c3cdb18 1414 desc = &chip->gpiodev->descs[offset];
6c0b4e6c 1415
372e722e 1416 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
d2876d08 1417 return NULL;
372e722e 1418 return desc->label;
d2876d08
DB
1419}
1420EXPORT_SYMBOL_GPL(gpiochip_is_requested);
1421
77c2d792
MW
1422/**
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 */
abdc08a3
AC
1433struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
1434 const char *label)
77c2d792 1435{
abdc08a3
AC
1436 struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
1437 int err;
77c2d792 1438
abdc08a3
AC
1439 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);
77c2d792 1447
abdc08a3 1448 return desc;
77c2d792 1449}
f7d4ad98 1450EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
77c2d792
MW
1451
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}
f7d4ad98 1464EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
d2876d08 1465
fdeb8e15
LW
1466/*
1467 * Drivers MUST set GPIO direction before making get/set calls. In
d2876d08
DB
1468 * 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
79a9becd
AC
1476/**
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)
d2876d08 1486{
d2876d08 1487 struct gpio_chip *chip;
d2876d08
DB
1488 int status = -EINVAL;
1489
fdeb8e15
LW
1490 VALIDATE_DESC(desc);
1491 chip = desc->gdev->chip;
bcabdef1 1492
be1a4b13 1493 if (!chip->get || !chip->direction_input) {
6424de5a
MB
1494 gpiod_warn(desc,
1495 "%s: missing get() or direction_input() operations\n",
7589e59f 1496 __func__);
be1a4b13
LW
1497 return -EIO;
1498 }
1499
d82da797 1500 status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
d2876d08
DB
1501 if (status == 0)
1502 clear_bit(FLAG_IS_OUT, &desc->flags);
3f397c21 1503
372e722e 1504 trace_gpio_direction(desc_to_gpio(desc), 1, status);
d82da797 1505
d2876d08
DB
1506 return status;
1507}
79a9becd 1508EXPORT_SYMBOL_GPL(gpiod_direction_input);
372e722e 1509
ef70bbe1 1510static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
d2876d08 1511{
c663e5f5
LW
1512 struct gpio_chip *gc = desc->gdev->chip;
1513 int ret;
d2876d08 1514
d468bf9e
LW
1515 /* 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
c663e5f5
LW
1523 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 }
25553ff0 1552
c663e5f5
LW
1553set_output_value:
1554 if (!gc->set || !gc->direction_output) {
6424de5a
MB
1555 gpiod_warn(desc,
1556 "%s: missing set() or direction_output() operations\n",
1557 __func__);
be1a4b13
LW
1558 return -EIO;
1559 }
1560
c663e5f5
LW
1561 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), value);
1562 if (!ret)
d2876d08 1563 set_bit(FLAG_IS_OUT, &desc->flags);
372e722e 1564 trace_gpio_value(desc_to_gpio(desc), 0, value);
c663e5f5
LW
1565 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
1566 return ret;
d2876d08 1567}
ef70bbe1
PZ
1568
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{
fdeb8e15 1582 VALIDATE_DESC(desc);
ef70bbe1
PZ
1583 return _gpiod_direction_output_raw(desc, value);
1584}
1585EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
1586
1587/**
90df4fe0 1588 * gpiod_direction_output - set the GPIO direction to output
ef70bbe1
PZ
1589 * @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{
fdeb8e15 1601 VALIDATE_DESC(desc);
ef70bbe1
PZ
1602 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1603 value = !value;
1604 return _gpiod_direction_output_raw(desc, value);
1605}
79a9becd 1606EXPORT_SYMBOL_GPL(gpiod_direction_output);
d2876d08 1607
c4b5be98 1608/**
79a9becd 1609 * gpiod_set_debounce - sets @debounce time for a @gpio
c4b5be98
FB
1610 * @gpio: the gpio to set debounce time
1611 * @debounce: debounce time is microseconds
65d87656
LW
1612 *
1613 * returns -ENOTSUPP if the controller does not support setting
1614 * debounce.
c4b5be98 1615 */
79a9becd 1616int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
c4b5be98 1617{
c4b5be98 1618 struct gpio_chip *chip;
c4b5be98 1619
fdeb8e15
LW
1620 VALIDATE_DESC(desc);
1621 chip = desc->gdev->chip;
be1a4b13 1622 if (!chip->set || !chip->set_debounce) {
6424de5a
MB
1623 gpiod_dbg(desc,
1624 "%s: missing set() or set_debounce() operations\n",
1625 __func__);
65d87656 1626 return -ENOTSUPP;
be1a4b13
LW
1627 }
1628
d82da797 1629 return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce);
c4b5be98 1630}
79a9becd 1631EXPORT_SYMBOL_GPL(gpiod_set_debounce);
372e722e 1632
79a9becd
AC
1633/**
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)
372e722e 1640{
fdeb8e15 1641 VALIDATE_DESC(desc);
79a9becd 1642 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
372e722e 1643}
79a9becd 1644EXPORT_SYMBOL_GPL(gpiod_is_active_low);
d2876d08
DB
1645
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
e20538b8 1668static int _gpiod_get_raw_value(const struct gpio_desc *desc)
d2876d08
DB
1669{
1670 struct gpio_chip *chip;
372e722e 1671 int offset;
e20538b8 1672 int value;
d2876d08 1673
fdeb8e15 1674 chip = desc->gdev->chip;
372e722e 1675 offset = gpio_chip_hwgpio(desc);
e20538b8 1676 value = chip->get ? chip->get(chip, offset) : -EIO;
723a6303 1677 value = value < 0 ? value : !!value;
372e722e 1678 trace_gpio_value(desc_to_gpio(desc), 1, value);
3f397c21 1679 return value;
d2876d08 1680}
372e722e 1681
d2876d08 1682/**
79a9becd
AC
1683 * gpiod_get_raw_value() - return a gpio's raw value
1684 * @desc: gpio whose value will be returned
d2876d08 1685 *
79a9becd 1686 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
e20538b8 1687 * its ACTIVE_LOW status, or negative errno on failure.
79a9becd
AC
1688 *
1689 * This function should be called from contexts where we cannot sleep, and will
1690 * complain if the GPIO chip functions potentially sleep.
d2876d08 1691 */
79a9becd 1692int gpiod_get_raw_value(const struct gpio_desc *desc)
d2876d08 1693{
fdeb8e15 1694 VALIDATE_DESC(desc);
e4e449e8 1695 /* Should be using gpio_get_value_cansleep() */
fdeb8e15 1696 WARN_ON(desc->gdev->chip->can_sleep);
79a9becd 1697 return _gpiod_get_raw_value(desc);
d2876d08 1698}
79a9becd 1699EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
372e722e 1700
79a9becd
AC
1701/**
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
e20538b8 1706 * account, or negative errno on failure.
79a9becd
AC
1707 *
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)
372e722e 1712{
79a9becd 1713 int value;
fdeb8e15
LW
1714
1715 VALIDATE_DESC(desc);
79a9becd 1716 /* Should be using gpio_get_value_cansleep() */
fdeb8e15 1717 WARN_ON(desc->gdev->chip->can_sleep);
79a9becd
AC
1718
1719 value = _gpiod_get_raw_value(desc);
e20538b8
BA
1720 if (value < 0)
1721 return value;
1722
79a9becd
AC
1723 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1724 value = !value;
1725
1726 return value;
372e722e 1727}
79a9becd 1728EXPORT_SYMBOL_GPL(gpiod_get_value);
d2876d08 1729
aca5ce14
LD
1730/*
1731 * _gpio_set_open_drain_value() - Set the open drain gpio's value.
79a9becd 1732 * @desc: gpio descriptor whose state need to be set.
20a8a968 1733 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
aca5ce14 1734 */
23600969 1735static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
aca5ce14
LD
1736{
1737 int err = 0;
fdeb8e15 1738 struct gpio_chip *chip = desc->gdev->chip;
372e722e
AC
1739 int offset = gpio_chip_hwgpio(desc);
1740
aca5ce14 1741 if (value) {
372e722e 1742 err = chip->direction_input(chip, offset);
aca5ce14 1743 if (!err)
372e722e 1744 clear_bit(FLAG_IS_OUT, &desc->flags);
aca5ce14 1745 } else {
372e722e 1746 err = chip->direction_output(chip, offset, 0);
aca5ce14 1747 if (!err)
372e722e 1748 set_bit(FLAG_IS_OUT, &desc->flags);
aca5ce14 1749 }
372e722e 1750 trace_gpio_direction(desc_to_gpio(desc), value, err);
aca5ce14 1751 if (err < 0)
6424de5a
MB
1752 gpiod_err(desc,
1753 "%s: Error in set_value for open drain err %d\n",
1754 __func__, err);
aca5ce14
LD
1755}
1756
25553ff0 1757/*
79a9becd
AC
1758 * _gpio_set_open_source_value() - Set the open source gpio's value.
1759 * @desc: gpio descriptor whose state need to be set.
20a8a968 1760 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
25553ff0 1761 */
23600969 1762static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
25553ff0
LD
1763{
1764 int err = 0;
fdeb8e15 1765 struct gpio_chip *chip = desc->gdev->chip;
372e722e
AC
1766 int offset = gpio_chip_hwgpio(desc);
1767
25553ff0 1768 if (value) {
372e722e 1769 err = chip->direction_output(chip, offset, 1);
25553ff0 1770 if (!err)
372e722e 1771 set_bit(FLAG_IS_OUT, &desc->flags);
25553ff0 1772 } else {
372e722e 1773 err = chip->direction_input(chip, offset);
25553ff0 1774 if (!err)
372e722e 1775 clear_bit(FLAG_IS_OUT, &desc->flags);
25553ff0 1776 }
372e722e 1777 trace_gpio_direction(desc_to_gpio(desc), !value, err);
25553ff0 1778 if (err < 0)
6424de5a
MB
1779 gpiod_err(desc,
1780 "%s: Error in set_value for open source err %d\n",
1781 __func__, err);
25553ff0
LD
1782}
1783
23600969 1784static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
d2876d08
DB
1785{
1786 struct gpio_chip *chip;
1787
fdeb8e15 1788 chip = desc->gdev->chip;
372e722e
AC
1789 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);
aca5ce14 1794 else
372e722e
AC
1795 chip->set(chip, gpio_chip_hwgpio(desc), value);
1796}
1797
5f424243
RI
1798/*
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 */
38e003f4 1822 if (__test_and_clear_bit(i, mask))
5f424243 1823 chip->set(chip, i, test_bit(i, bits));
5f424243
RI
1824 }
1825 }
1826}
1827
3fff99bc
RI
1828static void gpiod_set_array_value_priv(bool raw, bool can_sleep,
1829 unsigned int array_size,
1830 struct gpio_desc **desc_array,
1831 int *value_array)
5f424243
RI
1832{
1833 int i = 0;
1834
1835 while (i < array_size) {
fdeb8e15 1836 struct gpio_chip *chip = desc_array[i]->gdev->chip;
5f424243
RI
1837 unsigned long mask[BITS_TO_LONGS(chip->ngpio)];
1838 unsigned long bits[BITS_TO_LONGS(chip->ngpio)];
1839 int count = 0;
1840
38e003f4 1841 if (!can_sleep)
5f424243 1842 WARN_ON(chip->can_sleep);
38e003f4 1843
5f424243
RI
1844 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)) {
38e003f4 1858 _gpio_set_open_drain_value(desc, value);
5f424243
RI
1859 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
1860 _gpio_set_open_source_value(desc, value);
1861 } else {
1862 __set_bit(hwgpio, mask);
38e003f4 1863 if (value)
5f424243 1864 __set_bit(hwgpio, bits);
38e003f4 1865 else
5f424243 1866 __clear_bit(hwgpio, bits);
5f424243
RI
1867 count++;
1868 }
1869 i++;
fdeb8e15
LW
1870 } while ((i < array_size) &&
1871 (desc_array[i]->gdev->chip == chip));
5f424243 1872 /* push collected bits to outputs */
38e003f4 1873 if (count != 0)
5f424243 1874 gpio_chip_set_multiple(chip, mask, bits);
5f424243
RI
1875 }
1876}
1877
d2876d08 1878/**
79a9becd
AC
1879 * gpiod_set_raw_value() - assign a gpio's raw value
1880 * @desc: gpio whose value will be assigned
d2876d08 1881 * @value: value to assign
d2876d08 1882 *
79a9becd
AC
1883 * 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.
d2876d08 1888 */
79a9becd 1889void gpiod_set_raw_value(struct gpio_desc *desc, int value)
372e722e 1890{
fdeb8e15 1891 VALIDATE_DESC_VOID(desc);
1cfab8f8 1892 /* Should be using gpiod_set_value_cansleep() */
fdeb8e15 1893 WARN_ON(desc->gdev->chip->can_sleep);
79a9becd 1894 _gpiod_set_raw_value(desc, value);
d2876d08 1895}
79a9becd 1896EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
d2876d08
DB
1897
1898/**
79a9becd
AC
1899 * gpiod_set_value() - assign a gpio's value
1900 * @desc: gpio whose value will be assigned
1901 * @value: value to assign
1902 *
1903 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
1904 * account
d2876d08 1905 *
79a9becd
AC
1906 * This function should be called from contexts where we cannot sleep, and will
1907 * complain if the GPIO chip functions potentially sleep.
d2876d08 1908 */
79a9becd 1909void gpiod_set_value(struct gpio_desc *desc, int value)
d2876d08 1910{
fdeb8e15 1911 VALIDATE_DESC_VOID(desc);
1cfab8f8 1912 /* Should be using gpiod_set_value_cansleep() */
fdeb8e15 1913 WARN_ON(desc->gdev->chip->can_sleep);
79a9becd
AC
1914 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1915 value = !value;
1916 _gpiod_set_raw_value(desc, value);
372e722e 1917}
79a9becd 1918EXPORT_SYMBOL_GPL(gpiod_set_value);
d2876d08 1919
5f424243 1920/**
3fff99bc 1921 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
5f424243
RI
1922 * @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 */
3fff99bc 1932void gpiod_set_raw_array_value(unsigned int array_size,
5f424243
RI
1933 struct gpio_desc **desc_array, int *value_array)
1934{
1935 if (!desc_array)
1936 return;
3fff99bc
RI
1937 gpiod_set_array_value_priv(true, false, array_size, desc_array,
1938 value_array);
5f424243 1939}
3fff99bc 1940EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
5f424243
RI
1941
1942/**
3fff99bc 1943 * gpiod_set_array_value() - assign values to an array of GPIOs
5f424243
RI
1944 * @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 */
3fff99bc
RI
1954void gpiod_set_array_value(unsigned int array_size,
1955 struct gpio_desc **desc_array, int *value_array)
5f424243
RI
1956{
1957 if (!desc_array)
1958 return;
3fff99bc
RI
1959 gpiod_set_array_value_priv(false, false, array_size, desc_array,
1960 value_array);
5f424243 1961}
3fff99bc 1962EXPORT_SYMBOL_GPL(gpiod_set_array_value);
5f424243 1963
d2876d08 1964/**
79a9becd
AC
1965 * gpiod_cansleep() - report whether gpio value access may sleep
1966 * @desc: gpio to check
d2876d08 1967 *
d2876d08 1968 */
79a9becd 1969int gpiod_cansleep(const struct gpio_desc *desc)
372e722e 1970{
fdeb8e15
LW
1971 VALIDATE_DESC(desc);
1972 return desc->gdev->chip->can_sleep;
d2876d08 1973}
79a9becd 1974EXPORT_SYMBOL_GPL(gpiod_cansleep);
d2876d08 1975
0f6d504e 1976/**
79a9becd
AC
1977 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
1978 * @desc: gpio whose IRQ will be returned (already requested)
0f6d504e 1979 *
79a9becd
AC
1980 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
1981 * error.
0f6d504e 1982 */
79a9becd 1983int gpiod_to_irq(const struct gpio_desc *desc)
0f6d504e
DB
1984{
1985 struct gpio_chip *chip;
372e722e 1986 int offset;
0f6d504e 1987
fdeb8e15
LW
1988 VALIDATE_DESC(desc);
1989 chip = desc->gdev->chip;
372e722e
AC
1990 offset = gpio_chip_hwgpio(desc);
1991 return chip->to_irq ? chip->to_irq(chip, offset) : -ENXIO;
0f6d504e 1992}
79a9becd 1993EXPORT_SYMBOL_GPL(gpiod_to_irq);
0f6d504e 1994
d468bf9e 1995/**
e3a2e878 1996 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
d74be6df
AC
1997 * @chip: the chip the GPIO to lock belongs to
1998 * @offset: the offset of the GPIO to lock as IRQ
d468bf9e
LW
1999 *
2000 * This is used directly by GPIO drivers that want to lock down
f438acdf 2001 * a certain GPIO line to be used for IRQs.
d468bf9e 2002 */
e3a2e878 2003int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
372e722e 2004{
d74be6df 2005 if (offset >= chip->ngpio)
d468bf9e
LW
2006 return -EINVAL;
2007
1c3cdb18 2008 if (test_bit(FLAG_IS_OUT, &chip->gpiodev->descs[offset].flags)) {
d74be6df 2009 chip_err(chip,
d468bf9e
LW
2010 "%s: tried to flag a GPIO set as output for IRQ\n",
2011 __func__);
2012 return -EIO;
2013 }
2014
1c3cdb18 2015 set_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
d468bf9e 2016 return 0;
372e722e 2017}
e3a2e878 2018EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
d2876d08 2019
d468bf9e 2020/**
e3a2e878 2021 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
d74be6df
AC
2022 * @chip: the chip the GPIO to lock belongs to
2023 * @offset: the offset of the GPIO to lock as IRQ
d468bf9e
LW
2024 *
2025 * This is used directly by GPIO drivers that want to indicate
2026 * that a certain GPIO is no longer used exclusively for IRQ.
d2876d08 2027 */
e3a2e878 2028void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
d468bf9e 2029{
d74be6df 2030 if (offset >= chip->ngpio)
d468bf9e 2031 return;
d2876d08 2032
1c3cdb18 2033 clear_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
d468bf9e 2034}
e3a2e878 2035EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
d468bf9e 2036
6cee3821
LW
2037bool 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
143b65d6
LW
2046bool 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
79a9becd
AC
2064/**
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
e20538b8 2069 * its ACTIVE_LOW status, or negative errno on failure.
79a9becd
AC
2070 *
2071 * This function is to be called from contexts that can sleep.
d2876d08 2072 */
79a9becd 2073int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
d2876d08 2074{
d2876d08 2075 might_sleep_if(extra_checks);
fdeb8e15 2076 VALIDATE_DESC(desc);
79a9becd 2077 return _gpiod_get_raw_value(desc);
d2876d08 2078}
79a9becd 2079EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
372e722e 2080
79a9becd
AC
2081/**
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
e20538b8 2086 * account, or negative errno on failure.
79a9becd
AC
2087 *
2088 * This function is to be called from contexts that can sleep.
2089 */
2090int gpiod_get_value_cansleep(const struct gpio_desc *desc)
d2876d08 2091{
3f397c21 2092 int value;
d2876d08
DB
2093
2094 might_sleep_if(extra_checks);
fdeb8e15 2095 VALIDATE_DESC(desc);
79a9becd 2096 value = _gpiod_get_raw_value(desc);
e20538b8
BA
2097 if (value < 0)
2098 return value;
2099
79a9becd
AC
2100 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2101 value = !value;
2102
3f397c21 2103 return value;
d2876d08 2104}
79a9becd 2105EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
372e722e 2106
79a9becd
AC
2107/**
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)
372e722e 2118{
d2876d08 2119 might_sleep_if(extra_checks);
fdeb8e15 2120 VALIDATE_DESC_VOID(desc);
79a9becd 2121 _gpiod_set_raw_value(desc, value);
372e722e 2122}
79a9becd 2123EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
d2876d08 2124
79a9becd
AC
2125/**
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)
d2876d08 2136{
d2876d08 2137 might_sleep_if(extra_checks);
fdeb8e15 2138 VALIDATE_DESC_VOID(desc);
79a9becd
AC
2139 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2140 value = !value;
2141 _gpiod_set_raw_value(desc, value);
372e722e 2142}
79a9becd 2143EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
d2876d08 2144
5f424243 2145/**
3fff99bc 2146 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
5f424243
RI
2147 * @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 */
3fff99bc
RI
2156void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
2157 struct gpio_desc **desc_array,
2158 int *value_array)
5f424243
RI
2159{
2160 might_sleep_if(extra_checks);
2161 if (!desc_array)
2162 return;
3fff99bc
RI
2163 gpiod_set_array_value_priv(true, true, array_size, desc_array,
2164 value_array);
5f424243 2165}
3fff99bc 2166EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
5f424243
RI
2167
2168/**
3fff99bc 2169 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
5f424243
RI
2170 * @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 */
3fff99bc
RI
2179void gpiod_set_array_value_cansleep(unsigned int array_size,
2180 struct gpio_desc **desc_array,
2181 int *value_array)
5f424243
RI
2182{
2183 might_sleep_if(extra_checks);
2184 if (!desc_array)
2185 return;
3fff99bc
RI
2186 gpiod_set_array_value_priv(false, true, array_size, desc_array,
2187 value_array);
5f424243 2188}
3fff99bc 2189EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
5f424243 2190
bae48da2 2191/**
ad824783
AC
2192 * gpiod_add_lookup_table() - register GPIO device consumers
2193 * @table: table of consumers to register
bae48da2 2194 */
ad824783 2195void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
bae48da2
AC
2196{
2197 mutex_lock(&gpio_lookup_lock);
2198
ad824783 2199 list_add_tail(&table->list, &gpio_lookup_list);
bae48da2
AC
2200
2201 mutex_unlock(&gpio_lookup_lock);
2202}
2203
be9015ab
SK
2204/**
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
bae48da2 2217static struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
53e7cac3
AC
2218 unsigned int idx,
2219 enum gpio_lookup_flags *flags)
bae48da2
AC
2220{
2221 char prop_name[32]; /* 32 is max size of property name */
2222 enum of_gpio_flags of_flags;
2223 struct gpio_desc *desc;
dd34c37a 2224 unsigned int i;
bae48da2 2225
7f2e553a 2226 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
dd34c37a 2227 if (con_id)
9e089246 2228 snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
7f2e553a 2229 gpio_suffixes[i]);
dd34c37a 2230 else
9e089246 2231 snprintf(prop_name, sizeof(prop_name), "%s",
7f2e553a 2232 gpio_suffixes[i]);
bae48da2 2233
dd34c37a
TR
2234 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
2235 &of_flags);
06fc3b70 2236 if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER))
dd34c37a
TR
2237 break;
2238 }
bae48da2
AC
2239
2240 if (IS_ERR(desc))
2241 return desc;
2242
2243 if (of_flags & OF_GPIO_ACTIVE_LOW)
53e7cac3 2244 *flags |= GPIO_ACTIVE_LOW;
bae48da2 2245
90b665f6
LP
2246 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
bae48da2
AC
2253 return desc;
2254}
d2876d08 2255
81f59e9d 2256static struct gpio_desc *acpi_find_gpio(struct device *dev, const char *con_id,
53e7cac3
AC
2257 unsigned int idx,
2258 enum gpio_lookup_flags *flags)
372e722e 2259{
0d9a693c 2260 struct acpi_device *adev = ACPI_COMPANION(dev);
e01f440a
MW
2261 struct acpi_gpio_info info;
2262 struct gpio_desc *desc;
0d9a693c
MW
2263 char propname[32];
2264 int i;
e01f440a 2265
0d9a693c 2266 /* Try first from _DSD */
7f2e553a 2267 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
0d9a693c
MW
2268 if (con_id && strcmp(con_id, "gpios")) {
2269 snprintf(propname, sizeof(propname), "%s-%s",
7f2e553a 2270 con_id, gpio_suffixes[i]);
0d9a693c
MW
2271 } else {
2272 snprintf(propname, sizeof(propname), "%s",
7f2e553a 2273 gpio_suffixes[i]);
0d9a693c
MW
2274 }
2275
2276 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)) {
10cf4899
DT
2283 if (!acpi_can_fallback_to_crs(adev, con_id))
2284 return ERR_PTR(-ENOENT);
2285
0d9a693c
MW
2286 desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
2287 if (IS_ERR(desc))
2288 return desc;
2289 }
e01f440a 2290
52044723 2291 if (info.polarity == GPIO_ACTIVE_LOW)
53e7cac3 2292 *flags |= GPIO_ACTIVE_LOW;
e01f440a
MW
2293
2294 return desc;
81f59e9d
MW
2295}
2296
ad824783 2297static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
bae48da2
AC
2298{
2299 const char *dev_id = dev ? dev_name(dev) : NULL;
ad824783 2300 struct gpiod_lookup_table *table;
bae48da2
AC
2301
2302 mutex_lock(&gpio_lookup_lock);
2303
ad824783
AC
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;
bae48da2 2322
ad824783
AC
2323found:
2324 mutex_unlock(&gpio_lookup_lock);
2325 return table;
2326}
bae48da2 2327
ad824783
AC
2328static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
2329 unsigned int idx,
2330 enum gpio_lookup_flags *flags)
2331{
2a3cf6a3 2332 struct gpio_desc *desc = ERR_PTR(-ENOENT);
ad824783
AC
2333 struct gpiod_lookup_table *table;
2334 struct gpiod_lookup *p;
bae48da2 2335
ad824783
AC
2336 table = gpiod_find_lookup_table(dev);
2337 if (!table)
2338 return desc;
bae48da2 2339
ad824783
AC
2340 for (p = &table->table[0]; p->chip_label; p++) {
2341 struct gpio_chip *chip;
bae48da2 2342
ad824783 2343 /* idx must always match exactly */
bae48da2
AC
2344 if (p->idx != idx)
2345 continue;
2346
ad824783
AC
2347 /* 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;
bae48da2 2350
ad824783 2351 chip = find_chip_by_name(p->chip_label);
bae48da2 2352
ad824783 2353 if (!chip) {
2a3cf6a3
AC
2354 dev_err(dev, "cannot find GPIO chip %s\n",
2355 p->chip_label);
2356 return ERR_PTR(-ENODEV);
ad824783 2357 }
bae48da2 2358
ad824783 2359 if (chip->ngpio <= p->chip_hwnum) {
2a3cf6a3
AC
2360 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);
bae48da2 2364 }
bae48da2 2365
bb1e88cc 2366 desc = gpiochip_get_desc(chip, p->chip_hwnum);
ad824783 2367 *flags = p->flags;
bae48da2 2368
2a3cf6a3 2369 return desc;
bae48da2
AC
2370 }
2371
bae48da2
AC
2372 return desc;
2373}
2374
66858527
RI
2375static 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
bae48da2 2439/**
0879162f 2440 * gpiod_get - obtain a GPIO for a given GPIO function
ad824783 2441 * @dev: GPIO consumer, can be NULL for system-global GPIOs
bae48da2 2442 * @con_id: function within the GPIO consumer
39b2bbe3 2443 * @flags: optional GPIO initialization flags
bae48da2
AC
2444 *
2445 * Return the GPIO descriptor corresponding to the function con_id of device
2a3cf6a3 2446 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
20a8a968 2447 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
bae48da2 2448 */
b17d1bf1 2449struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
39b2bbe3 2450 enum gpiod_flags flags)
bae48da2 2451{
39b2bbe3 2452 return gpiod_get_index(dev, con_id, 0, flags);
bae48da2 2453}
b17d1bf1 2454EXPORT_SYMBOL_GPL(gpiod_get);
bae48da2 2455
29a1f233
TR
2456/**
2457 * 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
39b2bbe3 2460 * @flags: optional GPIO initialization flags
29a1f233
TR
2461 *
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 */
b17d1bf1 2466struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
39b2bbe3
AC
2467 const char *con_id,
2468 enum gpiod_flags flags)
29a1f233 2469{
39b2bbe3 2470 return gpiod_get_index_optional(dev, con_id, 0, flags);
29a1f233 2471}
b17d1bf1 2472EXPORT_SYMBOL_GPL(gpiod_get_optional);
29a1f233 2473
923b93e4
LP
2474/**
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}
f625d460
BP
2491
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
f625d460
BP
2496 * @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,
923b93e4 2503 enum gpiod_flags dflags)
f625d460
BP
2504{
2505 int status;
2506
f625d460
BP
2507 /* 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
bae48da2
AC
2523/**
2524 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
fdd6a5fe 2525 * @dev: GPIO consumer, can be NULL for system-global GPIOs
bae48da2
AC
2526 * @con_id: function within the GPIO consumer
2527 * @idx: index of the GPIO to obtain in the consumer
39b2bbe3 2528 * @flags: optional GPIO initialization flags
bae48da2
AC
2529 *
2530 * This variant of gpiod_get() allows to access GPIOs other than the first
2531 * defined one for functions that define several GPIOs.
2532 *
2a3cf6a3
AC
2533 * 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
20a8a968 2535 * occurred while trying to acquire the GPIO.
bae48da2 2536 */
b17d1bf1 2537struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
bae48da2 2538 const char *con_id,
39b2bbe3
AC
2539 unsigned int idx,
2540 enum gpiod_flags flags)
bae48da2 2541{
35c5d7fd 2542 struct gpio_desc *desc = NULL;
bae48da2 2543 int status;
39b2bbe3 2544 enum gpio_lookup_flags lookupflags = 0;
bae48da2
AC
2545
2546 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
2547
4d8440b9
RW
2548 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 }
35c5d7fd
AC
2557 }
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 */
2a3cf6a3 2563 if (!desc || desc == ERR_PTR(-ENOENT)) {
43a8785a 2564 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
39b2bbe3 2565 desc = gpiod_find(dev, con_id, idx, &lookupflags);
bae48da2
AC
2566 }
2567
2568 if (IS_ERR(desc)) {
351cfe0f 2569 dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
bae48da2
AC
2570 return desc;
2571 }
2572
923b93e4
LP
2573 gpiod_parse_flags(desc, lookupflags);
2574
bae48da2 2575 status = gpiod_request(desc, con_id);
bae48da2
AC
2576 if (status < 0)
2577 return ERR_PTR(status);
2578
923b93e4 2579 status = gpiod_configure_flags(desc, con_id, flags);
39b2bbe3
AC
2580 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
bae48da2
AC
2586 return desc;
2587}
b17d1bf1 2588EXPORT_SYMBOL_GPL(gpiod_get_index);
bae48da2 2589
40b73183
MW
2590/**
2591 * 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;
90b665f6 2609 bool single_ended = false;
40b73183
MW
2610 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
c181fb3e 2618 desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname, 0,
40b73183 2619 &flags);
90b665f6 2620 if (!IS_ERR(desc)) {
40b73183 2621 active_low = flags & OF_GPIO_ACTIVE_LOW;
90b665f6
LP
2622 single_ended = flags & OF_GPIO_SINGLE_ENDED;
2623 }
40b73183
MW
2624 } else if (is_acpi_node(fwnode)) {
2625 struct acpi_gpio_info info;
2626
504a3374 2627 desc = acpi_node_get_gpiod(fwnode, propname, 0, &info);
40b73183 2628 if (!IS_ERR(desc))
52044723 2629 active_low = info.polarity == GPIO_ACTIVE_LOW;
40b73183
MW
2630 }
2631
2632 if (IS_ERR(desc))
2633 return desc;
2634
40b73183
MW
2635 if (active_low)
2636 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
2637
90b665f6
LP
2638 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
923b93e4
LP
2645 ret = gpiod_request(desc, NULL);
2646 if (ret)
2647 return ERR_PTR(ret);
2648
40b73183
MW
2649 return desc;
2650}
2651EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
2652
29a1f233
TR
2653/**
2654 * 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
39b2bbe3 2659 * @flags: optional GPIO initialization flags
29a1f233
TR
2660 *
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 */
b17d1bf1 2665struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
29a1f233 2666 const char *con_id,
39b2bbe3
AC
2667 unsigned int index,
2668 enum gpiod_flags flags)
29a1f233
TR
2669{
2670 struct gpio_desc *desc;
2671
39b2bbe3 2672 desc = gpiod_get_index(dev, con_id, index, flags);
29a1f233
TR
2673 if (IS_ERR(desc)) {
2674 if (PTR_ERR(desc) == -ENOENT)
2675 return NULL;
2676 }
2677
2678 return desc;
2679}
b17d1bf1 2680EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
29a1f233 2681
f625d460
BP
2682/**
2683 * 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
923b93e4
LP
2701 gpiod_parse_flags(desc, lflags);
2702
f625d460
BP
2703 local_desc = gpiochip_request_own_desc(chip, hwnum, name);
2704 if (IS_ERR(local_desc)) {
a713890d
LW
2705 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed\n",
2706 name, chip->label, hwnum);
f625d460
BP
2707 return PTR_ERR(local_desc);
2708 }
2709
923b93e4 2710 status = gpiod_configure_flags(desc, name, dflags);
f625d460 2711 if (status < 0) {
a713890d
LW
2712 pr_err("setup of hog GPIO %s (chip %s, offset %d) failed\n",
2713 name, chip->label, hwnum);
f625d460
BP
2714 gpiochip_free_own_desc(desc);
2715 return status;
2716 }
2717
2718 /* Mark GPIO as hogged so it can be identified and removed later */
2719 set_bit(FLAG_IS_HOGGED, &desc->flags);
2720
2721 pr_info("GPIO line %d (%s) hogged as %s%s\n",
2722 desc_to_gpio(desc), name,
2723 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
2724 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
2725 (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
2726
2727 return 0;
2728}
2729
2730/**
2731 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
2732 * @chip: gpio chip to act on
2733 *
2734 * This is only used by of_gpiochip_remove to free hogged gpios
2735 */
2736static void gpiochip_free_hogs(struct gpio_chip *chip)
2737{
2738 int id;
2739
2740 for (id = 0; id < chip->ngpio; id++) {
1c3cdb18
LW
2741 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
2742 gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
f625d460
BP
2743 }
2744}
2745
66858527
RI
2746/**
2747 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
2748 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2749 * @con_id: function within the GPIO consumer
2750 * @flags: optional GPIO initialization flags
2751 *
2752 * This function acquires all the GPIOs defined under a given function.
2753 *
2754 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
2755 * no GPIO has been assigned to the requested function, or another IS_ERR()
2756 * code if an error occurred while trying to acquire the GPIOs.
2757 */
2758struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
2759 const char *con_id,
2760 enum gpiod_flags flags)
2761{
2762 struct gpio_desc *desc;
2763 struct gpio_descs *descs;
2764 int count;
2765
2766 count = gpiod_count(dev, con_id);
2767 if (count < 0)
2768 return ERR_PTR(count);
2769
2770 descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count,
2771 GFP_KERNEL);
2772 if (!descs)
2773 return ERR_PTR(-ENOMEM);
2774
2775 for (descs->ndescs = 0; descs->ndescs < count; ) {
2776 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
2777 if (IS_ERR(desc)) {
2778 gpiod_put_array(descs);
2779 return ERR_CAST(desc);
2780 }
2781 descs->desc[descs->ndescs] = desc;
2782 descs->ndescs++;
2783 }
2784 return descs;
2785}
2786EXPORT_SYMBOL_GPL(gpiod_get_array);
2787
2788/**
2789 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
2790 * function
2791 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2792 * @con_id: function within the GPIO consumer
2793 * @flags: optional GPIO initialization flags
2794 *
2795 * This is equivalent to gpiod_get_array(), except that when no GPIO was
2796 * assigned to the requested function it will return NULL.
2797 */
2798struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
2799 const char *con_id,
2800 enum gpiod_flags flags)
2801{
2802 struct gpio_descs *descs;
2803
2804 descs = gpiod_get_array(dev, con_id, flags);
2805 if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
2806 return NULL;
2807
2808 return descs;
2809}
2810EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
2811
bae48da2
AC
2812/**
2813 * gpiod_put - dispose of a GPIO descriptor
2814 * @desc: GPIO descriptor to dispose of
2815 *
2816 * No descriptor can be used after gpiod_put() has been called on it.
2817 */
2818void gpiod_put(struct gpio_desc *desc)
2819{
2820 gpiod_free(desc);
372e722e 2821}
bae48da2 2822EXPORT_SYMBOL_GPL(gpiod_put);
d2876d08 2823
66858527
RI
2824/**
2825 * gpiod_put_array - dispose of multiple GPIO descriptors
2826 * @descs: struct gpio_descs containing an array of descriptors
2827 */
2828void gpiod_put_array(struct gpio_descs *descs)
2829{
2830 unsigned int i;
2831
2832 for (i = 0; i < descs->ndescs; i++)
2833 gpiod_put(descs->desc[i]);
2834
2835 kfree(descs);
2836}
2837EXPORT_SYMBOL_GPL(gpiod_put_array);
2838
3c702e99
LW
2839static int __init gpiolib_dev_init(void)
2840{
2841 int ret;
2842
2843 /* Register GPIO sysfs bus */
2844 ret = bus_register(&gpio_bus_type);
2845 if (ret < 0) {
2846 pr_err("gpiolib: could not register GPIO bus type\n");
2847 return ret;
2848 }
2849
2850 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
2851 if (ret < 0) {
2852 pr_err("gpiolib: failed to allocate char dev region\n");
2853 bus_unregister(&gpio_bus_type);
2854 }
2855 return ret;
2856}
2857core_initcall(gpiolib_dev_init);
2858
d2876d08
DB
2859#ifdef CONFIG_DEBUG_FS
2860
fdeb8e15 2861static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
d2876d08
DB
2862{
2863 unsigned i;
fdeb8e15
LW
2864 struct gpio_chip *chip = gdev->chip;
2865 unsigned gpio = gdev->base;
2866 struct gpio_desc *gdesc = &gdev->descs[0];
d2876d08 2867 int is_out;
d468bf9e 2868 int is_irq;
d2876d08 2869
fdeb8e15 2870 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
ced433e2
MP
2871 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
2872 if (gdesc->name) {
2873 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
2874 gpio, gdesc->name);
2875 }
d2876d08 2876 continue;
ced433e2 2877 }
d2876d08 2878
372e722e 2879 gpiod_get_direction(gdesc);
d2876d08 2880 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
d468bf9e 2881 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
ced433e2
MP
2882 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
2883 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
d2876d08
DB
2884 is_out ? "out" : "in ",
2885 chip->get
2886 ? (chip->get(chip, i) ? "hi" : "lo")
d468bf9e
LW
2887 : "? ",
2888 is_irq ? "IRQ" : " ");
d2876d08
DB
2889 seq_printf(s, "\n");
2890 }
2891}
2892
f9c4a31f 2893static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
d2876d08 2894{
362432ae 2895 unsigned long flags;
ff2b1359 2896 struct gpio_device *gdev = NULL;
cb1650d4 2897 loff_t index = *pos;
d2876d08 2898
f9c4a31f 2899 s->private = "";
d2876d08 2900
362432ae 2901 spin_lock_irqsave(&gpio_lock, flags);
ff2b1359 2902 list_for_each_entry(gdev, &gpio_devices, list)
362432ae
GL
2903 if (index-- == 0) {
2904 spin_unlock_irqrestore(&gpio_lock, flags);
ff2b1359 2905 return gdev;
f9c4a31f 2906 }
362432ae 2907 spin_unlock_irqrestore(&gpio_lock, flags);
f9c4a31f 2908
cb1650d4 2909 return NULL;
f9c4a31f
TR
2910}
2911
2912static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
2913{
362432ae 2914 unsigned long flags;
ff2b1359 2915 struct gpio_device *gdev = v;
f9c4a31f
TR
2916 void *ret = NULL;
2917
362432ae 2918 spin_lock_irqsave(&gpio_lock, flags);
ff2b1359 2919 if (list_is_last(&gdev->list, &gpio_devices))
cb1650d4
AC
2920 ret = NULL;
2921 else
ff2b1359 2922 ret = list_entry(gdev->list.next, struct gpio_device, list);
362432ae 2923 spin_unlock_irqrestore(&gpio_lock, flags);
f9c4a31f
TR
2924
2925 s->private = "\n";
2926 ++*pos;
2927
2928 return ret;
2929}
2930
2931static void gpiolib_seq_stop(struct seq_file *s, void *v)
2932{
2933}
2934
2935static int gpiolib_seq_show(struct seq_file *s, void *v)
2936{
ff2b1359
LW
2937 struct gpio_device *gdev = v;
2938 struct gpio_chip *chip = gdev->chip;
2939 struct device *parent;
2940
2941 if (!chip) {
2942 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
2943 dev_name(&gdev->dev));
2944 return 0;
2945 }
f9c4a31f 2946
ff2b1359
LW
2947 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
2948 dev_name(&gdev->dev),
fdeb8e15 2949 gdev->base, gdev->base + gdev->ngpio - 1);
ff2b1359
LW
2950 parent = chip->parent;
2951 if (parent)
2952 seq_printf(s, ", parent: %s/%s",
2953 parent->bus ? parent->bus->name : "no-bus",
2954 dev_name(parent));
f9c4a31f
TR
2955 if (chip->label)
2956 seq_printf(s, ", %s", chip->label);
2957 if (chip->can_sleep)
2958 seq_printf(s, ", can sleep");
2959 seq_printf(s, ":\n");
2960
2961 if (chip->dbg_show)
2962 chip->dbg_show(s, chip);
2963 else
fdeb8e15 2964 gpiolib_dbg_show(s, gdev);
f9c4a31f 2965
d2876d08
DB
2966 return 0;
2967}
2968
f9c4a31f
TR
2969static const struct seq_operations gpiolib_seq_ops = {
2970 .start = gpiolib_seq_start,
2971 .next = gpiolib_seq_next,
2972 .stop = gpiolib_seq_stop,
2973 .show = gpiolib_seq_show,
2974};
2975
d2876d08
DB
2976static int gpiolib_open(struct inode *inode, struct file *file)
2977{
f9c4a31f 2978 return seq_open(file, &gpiolib_seq_ops);
d2876d08
DB
2979}
2980
828c0950 2981static const struct file_operations gpiolib_operations = {
f9c4a31f 2982 .owner = THIS_MODULE,
d2876d08
DB
2983 .open = gpiolib_open,
2984 .read = seq_read,
2985 .llseek = seq_lseek,
f9c4a31f 2986 .release = seq_release,
d2876d08
DB
2987};
2988
2989static int __init gpiolib_debugfs_init(void)
2990{
2991 /* /sys/kernel/debug/gpio */
2992 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
2993 NULL, NULL, &gpiolib_operations);
2994 return 0;
2995}
2996subsys_initcall(gpiolib_debugfs_init);
2997
2998#endif /* DEBUG_FS */
This page took 0.719922 seconds and 5 git commands to generate.