Loading...
1#include <linux/kernel.h>
2#include <linux/module.h>
3#include <linux/interrupt.h>
4#include <linux/irq.h>
5#include <linux/spinlock.h>
6#include <linux/device.h>
7#include <linux/err.h>
8#include <linux/debugfs.h>
9#include <linux/seq_file.h>
10#include <linux/gpio.h>
11#include <linux/of_gpio.h>
12#include <linux/idr.h>
13#include <linux/slab.h>
14
15#define CREATE_TRACE_POINTS
16#include <trace/events/gpio.h>
17
18/* Optional implementation infrastructure for GPIO interfaces.
19 *
20 * Platforms may want to use this if they tend to use very many GPIOs
21 * that aren't part of a System-On-Chip core; or across I2C/SPI/etc.
22 *
23 * When kernel footprint or instruction count is an issue, simpler
24 * implementations may be preferred. The GPIO programming interface
25 * allows for inlining speed-critical get/set operations for common
26 * cases, so that access to SOC-integrated GPIOs can sometimes cost
27 * only an instruction or two per bit.
28 */
29
30
31/* When debugging, extend minimal trust to callers and platform code.
32 * Also emit diagnostic messages that may help initial bringup, when
33 * board setup or driver bugs are most common.
34 *
35 * Otherwise, minimize overhead in what may be bitbanging codepaths.
36 */
37#ifdef DEBUG
38#define extra_checks 1
39#else
40#define extra_checks 0
41#endif
42
43/* gpio_lock prevents conflicts during gpio_desc[] table updates.
44 * While any GPIO is requested, its gpio_chip is not removable;
45 * each GPIO's "requested" flag serves as a lock and refcount.
46 */
47static DEFINE_SPINLOCK(gpio_lock);
48
49struct gpio_desc {
50 struct gpio_chip *chip;
51 unsigned long flags;
52/* flag symbols are bit numbers */
53#define FLAG_REQUESTED 0
54#define FLAG_IS_OUT 1
55#define FLAG_RESERVED 2
56#define FLAG_EXPORT 3 /* protected by sysfs_lock */
57#define FLAG_SYSFS 4 /* exported via /sys/class/gpio/control */
58#define FLAG_TRIG_FALL 5 /* trigger on falling edge */
59#define FLAG_TRIG_RISE 6 /* trigger on rising edge */
60#define FLAG_ACTIVE_LOW 7 /* sysfs value has active low */
61#define FLAG_OPEN_DRAIN 8 /* Gpio is open drain type */
62#define FLAG_OPEN_SOURCE 9 /* Gpio is open source type */
63
64#define ID_SHIFT 16 /* add new flags before this one */
65
66#define GPIO_FLAGS_MASK ((1 << ID_SHIFT) - 1)
67#define GPIO_TRIGGER_MASK (BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE))
68
69#ifdef CONFIG_DEBUG_FS
70 const char *label;
71#endif
72};
73static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];
74
75#ifdef CONFIG_GPIO_SYSFS
76static DEFINE_IDR(dirent_idr);
77#endif
78
79static inline void desc_set_label(struct gpio_desc *d, const char *label)
80{
81#ifdef CONFIG_DEBUG_FS
82 d->label = label;
83#endif
84}
85
86/* Warn when drivers omit gpio_request() calls -- legal but ill-advised
87 * when setting direction, and otherwise illegal. Until board setup code
88 * and drivers use explicit requests everywhere (which won't happen when
89 * those calls have no teeth) we can't avoid autorequesting. This nag
90 * message should motivate switching to explicit requests... so should
91 * the weaker cleanup after faults, compared to gpio_request().
92 *
93 * NOTE: the autorequest mechanism is going away; at this point it's
94 * only "legal" in the sense that (old) code using it won't break yet,
95 * but instead only triggers a WARN() stack dump.
96 */
97static int gpio_ensure_requested(struct gpio_desc *desc, unsigned offset)
98{
99 const struct gpio_chip *chip = desc->chip;
100 const int gpio = chip->base + offset;
101
102 if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
103 "autorequest GPIO-%d\n", gpio)) {
104 if (!try_module_get(chip->owner)) {
105 pr_err("GPIO-%d: module can't be gotten \n", gpio);
106 clear_bit(FLAG_REQUESTED, &desc->flags);
107 /* lose */
108 return -EIO;
109 }
110 desc_set_label(desc, "[auto]");
111 /* caller must chip->request() w/o spinlock */
112 if (chip->request)
113 return 1;
114 }
115 return 0;
116}
117
118/* caller holds gpio_lock *OR* gpio is marked as requested */
119struct gpio_chip *gpio_to_chip(unsigned gpio)
120{
121 return gpio_desc[gpio].chip;
122}
123
124/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
125static int gpiochip_find_base(int ngpio)
126{
127 int i;
128 int spare = 0;
129 int base = -ENOSPC;
130
131 for (i = ARCH_NR_GPIOS - 1; i >= 0 ; i--) {
132 struct gpio_desc *desc = &gpio_desc[i];
133 struct gpio_chip *chip = desc->chip;
134
135 if (!chip && !test_bit(FLAG_RESERVED, &desc->flags)) {
136 spare++;
137 if (spare == ngpio) {
138 base = i;
139 break;
140 }
141 } else {
142 spare = 0;
143 if (chip)
144 i -= chip->ngpio - 1;
145 }
146 }
147
148 if (gpio_is_valid(base))
149 pr_debug("%s: found new base at %d\n", __func__, base);
150 return base;
151}
152
153/**
154 * gpiochip_reserve() - reserve range of gpios to use with platform code only
155 * @start: starting gpio number
156 * @ngpio: number of gpios to reserve
157 * Context: platform init, potentially before irqs or kmalloc will work
158 *
159 * Returns a negative errno if any gpio within the range is already reserved
160 * or registered, else returns zero as a success code. Use this function
161 * to mark a range of gpios as unavailable for dynamic gpio number allocation,
162 * for example because its driver support is not yet loaded.
163 */
164int __init gpiochip_reserve(int start, int ngpio)
165{
166 int ret = 0;
167 unsigned long flags;
168 int i;
169
170 if (!gpio_is_valid(start) || !gpio_is_valid(start + ngpio - 1))
171 return -EINVAL;
172
173 spin_lock_irqsave(&gpio_lock, flags);
174
175 for (i = start; i < start + ngpio; i++) {
176 struct gpio_desc *desc = &gpio_desc[i];
177
178 if (desc->chip || test_bit(FLAG_RESERVED, &desc->flags)) {
179 ret = -EBUSY;
180 goto err;
181 }
182
183 set_bit(FLAG_RESERVED, &desc->flags);
184 }
185
186 pr_debug("%s: reserved gpios from %d to %d\n",
187 __func__, start, start + ngpio - 1);
188err:
189 spin_unlock_irqrestore(&gpio_lock, flags);
190
191 return ret;
192}
193
194#ifdef CONFIG_GPIO_SYSFS
195
196/* lock protects against unexport_gpio() being called while
197 * sysfs files are active.
198 */
199static DEFINE_MUTEX(sysfs_lock);
200
201/*
202 * /sys/class/gpio/gpioN... only for GPIOs that are exported
203 * /direction
204 * * MAY BE OMITTED if kernel won't allow direction changes
205 * * is read/write as "in" or "out"
206 * * may also be written as "high" or "low", initializing
207 * output value as specified ("out" implies "low")
208 * /value
209 * * always readable, subject to hardware behavior
210 * * may be writable, as zero/nonzero
211 * /edge
212 * * configures behavior of poll(2) on /value
213 * * available only if pin can generate IRQs on input
214 * * is read/write as "none", "falling", "rising", or "both"
215 * /active_low
216 * * configures polarity of /value
217 * * is read/write as zero/nonzero
218 * * also affects existing and subsequent "falling" and "rising"
219 * /edge configuration
220 */
221
222static ssize_t gpio_direction_show(struct device *dev,
223 struct device_attribute *attr, char *buf)
224{
225 const struct gpio_desc *desc = dev_get_drvdata(dev);
226 ssize_t status;
227
228 mutex_lock(&sysfs_lock);
229
230 if (!test_bit(FLAG_EXPORT, &desc->flags))
231 status = -EIO;
232 else
233 status = sprintf(buf, "%s\n",
234 test_bit(FLAG_IS_OUT, &desc->flags)
235 ? "out" : "in");
236
237 mutex_unlock(&sysfs_lock);
238 return status;
239}
240
241static ssize_t gpio_direction_store(struct device *dev,
242 struct device_attribute *attr, const char *buf, size_t size)
243{
244 const struct gpio_desc *desc = dev_get_drvdata(dev);
245 unsigned gpio = desc - gpio_desc;
246 ssize_t status;
247
248 mutex_lock(&sysfs_lock);
249
250 if (!test_bit(FLAG_EXPORT, &desc->flags))
251 status = -EIO;
252 else if (sysfs_streq(buf, "high"))
253 status = gpio_direction_output(gpio, 1);
254 else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
255 status = gpio_direction_output(gpio, 0);
256 else if (sysfs_streq(buf, "in"))
257 status = gpio_direction_input(gpio);
258 else
259 status = -EINVAL;
260
261 mutex_unlock(&sysfs_lock);
262 return status ? : size;
263}
264
265static /* const */ DEVICE_ATTR(direction, 0644,
266 gpio_direction_show, gpio_direction_store);
267
268static ssize_t gpio_value_show(struct device *dev,
269 struct device_attribute *attr, char *buf)
270{
271 const struct gpio_desc *desc = dev_get_drvdata(dev);
272 unsigned gpio = desc - gpio_desc;
273 ssize_t status;
274
275 mutex_lock(&sysfs_lock);
276
277 if (!test_bit(FLAG_EXPORT, &desc->flags)) {
278 status = -EIO;
279 } else {
280 int value;
281
282 value = !!gpio_get_value_cansleep(gpio);
283 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
284 value = !value;
285
286 status = sprintf(buf, "%d\n", value);
287 }
288
289 mutex_unlock(&sysfs_lock);
290 return status;
291}
292
293static ssize_t gpio_value_store(struct device *dev,
294 struct device_attribute *attr, const char *buf, size_t size)
295{
296 const struct gpio_desc *desc = dev_get_drvdata(dev);
297 unsigned gpio = desc - gpio_desc;
298 ssize_t status;
299
300 mutex_lock(&sysfs_lock);
301
302 if (!test_bit(FLAG_EXPORT, &desc->flags))
303 status = -EIO;
304 else if (!test_bit(FLAG_IS_OUT, &desc->flags))
305 status = -EPERM;
306 else {
307 long value;
308
309 status = strict_strtol(buf, 0, &value);
310 if (status == 0) {
311 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
312 value = !value;
313 gpio_set_value_cansleep(gpio, value != 0);
314 status = size;
315 }
316 }
317
318 mutex_unlock(&sysfs_lock);
319 return status;
320}
321
322static const DEVICE_ATTR(value, 0644,
323 gpio_value_show, gpio_value_store);
324
325static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
326{
327 struct sysfs_dirent *value_sd = priv;
328
329 sysfs_notify_dirent(value_sd);
330 return IRQ_HANDLED;
331}
332
333static int gpio_setup_irq(struct gpio_desc *desc, struct device *dev,
334 unsigned long gpio_flags)
335{
336 struct sysfs_dirent *value_sd;
337 unsigned long irq_flags;
338 int ret, irq, id;
339
340 if ((desc->flags & GPIO_TRIGGER_MASK) == gpio_flags)
341 return 0;
342
343 irq = gpio_to_irq(desc - gpio_desc);
344 if (irq < 0)
345 return -EIO;
346
347 id = desc->flags >> ID_SHIFT;
348 value_sd = idr_find(&dirent_idr, id);
349 if (value_sd)
350 free_irq(irq, value_sd);
351
352 desc->flags &= ~GPIO_TRIGGER_MASK;
353
354 if (!gpio_flags) {
355 ret = 0;
356 goto free_id;
357 }
358
359 irq_flags = IRQF_SHARED;
360 if (test_bit(FLAG_TRIG_FALL, &gpio_flags))
361 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
362 IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
363 if (test_bit(FLAG_TRIG_RISE, &gpio_flags))
364 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
365 IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
366
367 if (!value_sd) {
368 value_sd = sysfs_get_dirent(dev->kobj.sd, NULL, "value");
369 if (!value_sd) {
370 ret = -ENODEV;
371 goto err_out;
372 }
373
374 do {
375 ret = -ENOMEM;
376 if (idr_pre_get(&dirent_idr, GFP_KERNEL))
377 ret = idr_get_new_above(&dirent_idr, value_sd,
378 1, &id);
379 } while (ret == -EAGAIN);
380
381 if (ret)
382 goto free_sd;
383
384 desc->flags &= GPIO_FLAGS_MASK;
385 desc->flags |= (unsigned long)id << ID_SHIFT;
386
387 if (desc->flags >> ID_SHIFT != id) {
388 ret = -ERANGE;
389 goto free_id;
390 }
391 }
392
393 ret = request_any_context_irq(irq, gpio_sysfs_irq, irq_flags,
394 "gpiolib", value_sd);
395 if (ret < 0)
396 goto free_id;
397
398 desc->flags |= gpio_flags;
399 return 0;
400
401free_id:
402 idr_remove(&dirent_idr, id);
403 desc->flags &= GPIO_FLAGS_MASK;
404free_sd:
405 if (value_sd)
406 sysfs_put(value_sd);
407err_out:
408 return ret;
409}
410
411static const struct {
412 const char *name;
413 unsigned long flags;
414} trigger_types[] = {
415 { "none", 0 },
416 { "falling", BIT(FLAG_TRIG_FALL) },
417 { "rising", BIT(FLAG_TRIG_RISE) },
418 { "both", BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE) },
419};
420
421static ssize_t gpio_edge_show(struct device *dev,
422 struct device_attribute *attr, char *buf)
423{
424 const struct gpio_desc *desc = dev_get_drvdata(dev);
425 ssize_t status;
426
427 mutex_lock(&sysfs_lock);
428
429 if (!test_bit(FLAG_EXPORT, &desc->flags))
430 status = -EIO;
431 else {
432 int i;
433
434 status = 0;
435 for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
436 if ((desc->flags & GPIO_TRIGGER_MASK)
437 == trigger_types[i].flags) {
438 status = sprintf(buf, "%s\n",
439 trigger_types[i].name);
440 break;
441 }
442 }
443
444 mutex_unlock(&sysfs_lock);
445 return status;
446}
447
448static ssize_t gpio_edge_store(struct device *dev,
449 struct device_attribute *attr, const char *buf, size_t size)
450{
451 struct gpio_desc *desc = dev_get_drvdata(dev);
452 ssize_t status;
453 int i;
454
455 for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
456 if (sysfs_streq(trigger_types[i].name, buf))
457 goto found;
458 return -EINVAL;
459
460found:
461 mutex_lock(&sysfs_lock);
462
463 if (!test_bit(FLAG_EXPORT, &desc->flags))
464 status = -EIO;
465 else {
466 status = gpio_setup_irq(desc, dev, trigger_types[i].flags);
467 if (!status)
468 status = size;
469 }
470
471 mutex_unlock(&sysfs_lock);
472
473 return status;
474}
475
476static DEVICE_ATTR(edge, 0644, gpio_edge_show, gpio_edge_store);
477
478static int sysfs_set_active_low(struct gpio_desc *desc, struct device *dev,
479 int value)
480{
481 int status = 0;
482
483 if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
484 return 0;
485
486 if (value)
487 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
488 else
489 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
490
491 /* reconfigure poll(2) support if enabled on one edge only */
492 if (dev != NULL && (!!test_bit(FLAG_TRIG_RISE, &desc->flags) ^
493 !!test_bit(FLAG_TRIG_FALL, &desc->flags))) {
494 unsigned long trigger_flags = desc->flags & GPIO_TRIGGER_MASK;
495
496 gpio_setup_irq(desc, dev, 0);
497 status = gpio_setup_irq(desc, dev, trigger_flags);
498 }
499
500 return status;
501}
502
503static ssize_t gpio_active_low_show(struct device *dev,
504 struct device_attribute *attr, char *buf)
505{
506 const struct gpio_desc *desc = dev_get_drvdata(dev);
507 ssize_t status;
508
509 mutex_lock(&sysfs_lock);
510
511 if (!test_bit(FLAG_EXPORT, &desc->flags))
512 status = -EIO;
513 else
514 status = sprintf(buf, "%d\n",
515 !!test_bit(FLAG_ACTIVE_LOW, &desc->flags));
516
517 mutex_unlock(&sysfs_lock);
518
519 return status;
520}
521
522static ssize_t gpio_active_low_store(struct device *dev,
523 struct device_attribute *attr, const char *buf, size_t size)
524{
525 struct gpio_desc *desc = dev_get_drvdata(dev);
526 ssize_t status;
527
528 mutex_lock(&sysfs_lock);
529
530 if (!test_bit(FLAG_EXPORT, &desc->flags)) {
531 status = -EIO;
532 } else {
533 long value;
534
535 status = strict_strtol(buf, 0, &value);
536 if (status == 0)
537 status = sysfs_set_active_low(desc, dev, value != 0);
538 }
539
540 mutex_unlock(&sysfs_lock);
541
542 return status ? : size;
543}
544
545static const DEVICE_ATTR(active_low, 0644,
546 gpio_active_low_show, gpio_active_low_store);
547
548static const struct attribute *gpio_attrs[] = {
549 &dev_attr_value.attr,
550 &dev_attr_active_low.attr,
551 NULL,
552};
553
554static const struct attribute_group gpio_attr_group = {
555 .attrs = (struct attribute **) gpio_attrs,
556};
557
558/*
559 * /sys/class/gpio/gpiochipN/
560 * /base ... matching gpio_chip.base (N)
561 * /label ... matching gpio_chip.label
562 * /ngpio ... matching gpio_chip.ngpio
563 */
564
565static ssize_t chip_base_show(struct device *dev,
566 struct device_attribute *attr, char *buf)
567{
568 const struct gpio_chip *chip = dev_get_drvdata(dev);
569
570 return sprintf(buf, "%d\n", chip->base);
571}
572static DEVICE_ATTR(base, 0444, chip_base_show, NULL);
573
574static ssize_t chip_label_show(struct device *dev,
575 struct device_attribute *attr, char *buf)
576{
577 const struct gpio_chip *chip = dev_get_drvdata(dev);
578
579 return sprintf(buf, "%s\n", chip->label ? : "");
580}
581static DEVICE_ATTR(label, 0444, chip_label_show, NULL);
582
583static ssize_t chip_ngpio_show(struct device *dev,
584 struct device_attribute *attr, char *buf)
585{
586 const struct gpio_chip *chip = dev_get_drvdata(dev);
587
588 return sprintf(buf, "%u\n", chip->ngpio);
589}
590static DEVICE_ATTR(ngpio, 0444, chip_ngpio_show, NULL);
591
592static const struct attribute *gpiochip_attrs[] = {
593 &dev_attr_base.attr,
594 &dev_attr_label.attr,
595 &dev_attr_ngpio.attr,
596 NULL,
597};
598
599static const struct attribute_group gpiochip_attr_group = {
600 .attrs = (struct attribute **) gpiochip_attrs,
601};
602
603/*
604 * /sys/class/gpio/export ... write-only
605 * integer N ... number of GPIO to export (full access)
606 * /sys/class/gpio/unexport ... write-only
607 * integer N ... number of GPIO to unexport
608 */
609static ssize_t export_store(struct class *class,
610 struct class_attribute *attr,
611 const char *buf, size_t len)
612{
613 long gpio;
614 int status;
615
616 status = strict_strtol(buf, 0, &gpio);
617 if (status < 0)
618 goto done;
619
620 /* No extra locking here; FLAG_SYSFS just signifies that the
621 * request and export were done by on behalf of userspace, so
622 * they may be undone on its behalf too.
623 */
624
625 status = gpio_request(gpio, "sysfs");
626 if (status < 0)
627 goto done;
628
629 status = gpio_export(gpio, true);
630 if (status < 0)
631 gpio_free(gpio);
632 else
633 set_bit(FLAG_SYSFS, &gpio_desc[gpio].flags);
634
635done:
636 if (status)
637 pr_debug("%s: status %d\n", __func__, status);
638 return status ? : len;
639}
640
641static ssize_t unexport_store(struct class *class,
642 struct class_attribute *attr,
643 const char *buf, size_t len)
644{
645 long gpio;
646 int status;
647
648 status = strict_strtol(buf, 0, &gpio);
649 if (status < 0)
650 goto done;
651
652 status = -EINVAL;
653
654 /* reject bogus commands (gpio_unexport ignores them) */
655 if (!gpio_is_valid(gpio))
656 goto done;
657
658 /* No extra locking here; FLAG_SYSFS just signifies that the
659 * request and export were done by on behalf of userspace, so
660 * they may be undone on its behalf too.
661 */
662 if (test_and_clear_bit(FLAG_SYSFS, &gpio_desc[gpio].flags)) {
663 status = 0;
664 gpio_free(gpio);
665 }
666done:
667 if (status)
668 pr_debug("%s: status %d\n", __func__, status);
669 return status ? : len;
670}
671
672static struct class_attribute gpio_class_attrs[] = {
673 __ATTR(export, 0200, NULL, export_store),
674 __ATTR(unexport, 0200, NULL, unexport_store),
675 __ATTR_NULL,
676};
677
678static struct class gpio_class = {
679 .name = "gpio",
680 .owner = THIS_MODULE,
681
682 .class_attrs = gpio_class_attrs,
683};
684
685
686/**
687 * gpio_export - export a GPIO through sysfs
688 * @gpio: gpio to make available, already requested
689 * @direction_may_change: true if userspace may change gpio direction
690 * Context: arch_initcall or later
691 *
692 * When drivers want to make a GPIO accessible to userspace after they
693 * have requested it -- perhaps while debugging, or as part of their
694 * public interface -- they may use this routine. If the GPIO can
695 * change direction (some can't) and the caller allows it, userspace
696 * will see "direction" sysfs attribute which may be used to change
697 * the gpio's direction. A "value" attribute will always be provided.
698 *
699 * Returns zero on success, else an error.
700 */
701int gpio_export(unsigned gpio, bool direction_may_change)
702{
703 unsigned long flags;
704 struct gpio_desc *desc;
705 int status = -EINVAL;
706 const char *ioname = NULL;
707
708 /* can't export until sysfs is available ... */
709 if (!gpio_class.p) {
710 pr_debug("%s: called too early!\n", __func__);
711 return -ENOENT;
712 }
713
714 if (!gpio_is_valid(gpio))
715 goto done;
716
717 mutex_lock(&sysfs_lock);
718
719 spin_lock_irqsave(&gpio_lock, flags);
720 desc = &gpio_desc[gpio];
721 if (test_bit(FLAG_REQUESTED, &desc->flags)
722 && !test_bit(FLAG_EXPORT, &desc->flags)) {
723 status = 0;
724 if (!desc->chip->direction_input
725 || !desc->chip->direction_output)
726 direction_may_change = false;
727 }
728 spin_unlock_irqrestore(&gpio_lock, flags);
729
730 if (desc->chip->names && desc->chip->names[gpio - desc->chip->base])
731 ioname = desc->chip->names[gpio - desc->chip->base];
732
733 if (status == 0) {
734 struct device *dev;
735
736 dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
737 desc, ioname ? ioname : "gpio%u", gpio);
738 if (!IS_ERR(dev)) {
739 status = sysfs_create_group(&dev->kobj,
740 &gpio_attr_group);
741
742 if (!status && direction_may_change)
743 status = device_create_file(dev,
744 &dev_attr_direction);
745
746 if (!status && gpio_to_irq(gpio) >= 0
747 && (direction_may_change
748 || !test_bit(FLAG_IS_OUT,
749 &desc->flags)))
750 status = device_create_file(dev,
751 &dev_attr_edge);
752
753 if (status != 0)
754 device_unregister(dev);
755 } else
756 status = PTR_ERR(dev);
757 if (status == 0)
758 set_bit(FLAG_EXPORT, &desc->flags);
759 }
760
761 mutex_unlock(&sysfs_lock);
762
763done:
764 if (status)
765 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
766
767 return status;
768}
769EXPORT_SYMBOL_GPL(gpio_export);
770
771static int match_export(struct device *dev, void *data)
772{
773 return dev_get_drvdata(dev) == data;
774}
775
776/**
777 * gpio_export_link - create a sysfs link to an exported GPIO node
778 * @dev: device under which to create symlink
779 * @name: name of the symlink
780 * @gpio: gpio to create symlink to, already exported
781 *
782 * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
783 * node. Caller is responsible for unlinking.
784 *
785 * Returns zero on success, else an error.
786 */
787int gpio_export_link(struct device *dev, const char *name, unsigned gpio)
788{
789 struct gpio_desc *desc;
790 int status = -EINVAL;
791
792 if (!gpio_is_valid(gpio))
793 goto done;
794
795 mutex_lock(&sysfs_lock);
796
797 desc = &gpio_desc[gpio];
798
799 if (test_bit(FLAG_EXPORT, &desc->flags)) {
800 struct device *tdev;
801
802 tdev = class_find_device(&gpio_class, NULL, desc, match_export);
803 if (tdev != NULL) {
804 status = sysfs_create_link(&dev->kobj, &tdev->kobj,
805 name);
806 } else {
807 status = -ENODEV;
808 }
809 }
810
811 mutex_unlock(&sysfs_lock);
812
813done:
814 if (status)
815 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
816
817 return status;
818}
819EXPORT_SYMBOL_GPL(gpio_export_link);
820
821
822/**
823 * gpio_sysfs_set_active_low - set the polarity of gpio sysfs value
824 * @gpio: gpio to change
825 * @value: non-zero to use active low, i.e. inverted values
826 *
827 * Set the polarity of /sys/class/gpio/gpioN/value sysfs attribute.
828 * The GPIO does not have to be exported yet. If poll(2) support has
829 * been enabled for either rising or falling edge, it will be
830 * reconfigured to follow the new polarity.
831 *
832 * Returns zero on success, else an error.
833 */
834int gpio_sysfs_set_active_low(unsigned gpio, int value)
835{
836 struct gpio_desc *desc;
837 struct device *dev = NULL;
838 int status = -EINVAL;
839
840 if (!gpio_is_valid(gpio))
841 goto done;
842
843 mutex_lock(&sysfs_lock);
844
845 desc = &gpio_desc[gpio];
846
847 if (test_bit(FLAG_EXPORT, &desc->flags)) {
848 dev = class_find_device(&gpio_class, NULL, desc, match_export);
849 if (dev == NULL) {
850 status = -ENODEV;
851 goto unlock;
852 }
853 }
854
855 status = sysfs_set_active_low(desc, dev, value);
856
857unlock:
858 mutex_unlock(&sysfs_lock);
859
860done:
861 if (status)
862 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
863
864 return status;
865}
866EXPORT_SYMBOL_GPL(gpio_sysfs_set_active_low);
867
868/**
869 * gpio_unexport - reverse effect of gpio_export()
870 * @gpio: gpio to make unavailable
871 *
872 * This is implicit on gpio_free().
873 */
874void gpio_unexport(unsigned gpio)
875{
876 struct gpio_desc *desc;
877 int status = 0;
878 struct device *dev = NULL;
879
880 if (!gpio_is_valid(gpio)) {
881 status = -EINVAL;
882 goto done;
883 }
884
885 mutex_lock(&sysfs_lock);
886
887 desc = &gpio_desc[gpio];
888
889 if (test_bit(FLAG_EXPORT, &desc->flags)) {
890
891 dev = class_find_device(&gpio_class, NULL, desc, match_export);
892 if (dev) {
893 gpio_setup_irq(desc, dev, 0);
894 clear_bit(FLAG_EXPORT, &desc->flags);
895 } else
896 status = -ENODEV;
897 }
898
899 mutex_unlock(&sysfs_lock);
900 if (dev) {
901 device_unregister(dev);
902 put_device(dev);
903 }
904done:
905 if (status)
906 pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
907}
908EXPORT_SYMBOL_GPL(gpio_unexport);
909
910static int gpiochip_export(struct gpio_chip *chip)
911{
912 int status;
913 struct device *dev;
914
915 /* Many systems register gpio chips for SOC support very early,
916 * before driver model support is available. In those cases we
917 * export this later, in gpiolib_sysfs_init() ... here we just
918 * verify that _some_ field of gpio_class got initialized.
919 */
920 if (!gpio_class.p)
921 return 0;
922
923 /* use chip->base for the ID; it's already known to be unique */
924 mutex_lock(&sysfs_lock);
925 dev = device_create(&gpio_class, chip->dev, MKDEV(0, 0), chip,
926 "gpiochip%d", chip->base);
927 if (!IS_ERR(dev)) {
928 status = sysfs_create_group(&dev->kobj,
929 &gpiochip_attr_group);
930 } else
931 status = PTR_ERR(dev);
932 chip->exported = (status == 0);
933 mutex_unlock(&sysfs_lock);
934
935 if (status) {
936 unsigned long flags;
937 unsigned gpio;
938
939 spin_lock_irqsave(&gpio_lock, flags);
940 gpio = chip->base;
941 while (gpio_desc[gpio].chip == chip)
942 gpio_desc[gpio++].chip = NULL;
943 spin_unlock_irqrestore(&gpio_lock, flags);
944
945 pr_debug("%s: chip %s status %d\n", __func__,
946 chip->label, status);
947 }
948
949 return status;
950}
951
952static void gpiochip_unexport(struct gpio_chip *chip)
953{
954 int status;
955 struct device *dev;
956
957 mutex_lock(&sysfs_lock);
958 dev = class_find_device(&gpio_class, NULL, chip, match_export);
959 if (dev) {
960 put_device(dev);
961 device_unregister(dev);
962 chip->exported = 0;
963 status = 0;
964 } else
965 status = -ENODEV;
966 mutex_unlock(&sysfs_lock);
967
968 if (status)
969 pr_debug("%s: chip %s status %d\n", __func__,
970 chip->label, status);
971}
972
973static int __init gpiolib_sysfs_init(void)
974{
975 int status;
976 unsigned long flags;
977 unsigned gpio;
978
979 status = class_register(&gpio_class);
980 if (status < 0)
981 return status;
982
983 /* Scan and register the gpio_chips which registered very
984 * early (e.g. before the class_register above was called).
985 *
986 * We run before arch_initcall() so chip->dev nodes can have
987 * registered, and so arch_initcall() can always gpio_export().
988 */
989 spin_lock_irqsave(&gpio_lock, flags);
990 for (gpio = 0; gpio < ARCH_NR_GPIOS; gpio++) {
991 struct gpio_chip *chip;
992
993 chip = gpio_desc[gpio].chip;
994 if (!chip || chip->exported)
995 continue;
996
997 spin_unlock_irqrestore(&gpio_lock, flags);
998 status = gpiochip_export(chip);
999 spin_lock_irqsave(&gpio_lock, flags);
1000 }
1001 spin_unlock_irqrestore(&gpio_lock, flags);
1002
1003
1004 return status;
1005}
1006postcore_initcall(gpiolib_sysfs_init);
1007
1008#else
1009static inline int gpiochip_export(struct gpio_chip *chip)
1010{
1011 return 0;
1012}
1013
1014static inline void gpiochip_unexport(struct gpio_chip *chip)
1015{
1016}
1017
1018#endif /* CONFIG_GPIO_SYSFS */
1019
1020/**
1021 * gpiochip_add() - register a gpio_chip
1022 * @chip: the chip to register, with chip->base initialized
1023 * Context: potentially before irqs or kmalloc will work
1024 *
1025 * Returns a negative errno if the chip can't be registered, such as
1026 * because the chip->base is invalid or already associated with a
1027 * different chip. Otherwise it returns zero as a success code.
1028 *
1029 * When gpiochip_add() is called very early during boot, so that GPIOs
1030 * can be freely used, the chip->dev device must be registered before
1031 * the gpio framework's arch_initcall(). Otherwise sysfs initialization
1032 * for GPIOs will fail rudely.
1033 *
1034 * If chip->base is negative, this requests dynamic assignment of
1035 * a range of valid GPIOs.
1036 */
1037int gpiochip_add(struct gpio_chip *chip)
1038{
1039 unsigned long flags;
1040 int status = 0;
1041 unsigned id;
1042 int base = chip->base;
1043
1044 if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
1045 && base >= 0) {
1046 status = -EINVAL;
1047 goto fail;
1048 }
1049
1050 spin_lock_irqsave(&gpio_lock, flags);
1051
1052 if (base < 0) {
1053 base = gpiochip_find_base(chip->ngpio);
1054 if (base < 0) {
1055 status = base;
1056 goto unlock;
1057 }
1058 chip->base = base;
1059 }
1060
1061 /* these GPIO numbers must not be managed by another gpio_chip */
1062 for (id = base; id < base + chip->ngpio; id++) {
1063 if (gpio_desc[id].chip != NULL) {
1064 status = -EBUSY;
1065 break;
1066 }
1067 }
1068 if (status == 0) {
1069 for (id = base; id < base + chip->ngpio; id++) {
1070 gpio_desc[id].chip = chip;
1071
1072 /* REVISIT: most hardware initializes GPIOs as
1073 * inputs (often with pullups enabled) so power
1074 * usage is minimized. Linux code should set the
1075 * gpio direction first thing; but until it does,
1076 * we may expose the wrong direction in sysfs.
1077 */
1078 gpio_desc[id].flags = !chip->direction_input
1079 ? (1 << FLAG_IS_OUT)
1080 : 0;
1081 }
1082 }
1083
1084 of_gpiochip_add(chip);
1085
1086unlock:
1087 spin_unlock_irqrestore(&gpio_lock, flags);
1088
1089 if (status)
1090 goto fail;
1091
1092 status = gpiochip_export(chip);
1093 if (status)
1094 goto fail;
1095
1096 pr_debug("gpiochip_add: registered GPIOs %d to %d on device: %s\n",
1097 chip->base, chip->base + chip->ngpio - 1,
1098 chip->label ? : "generic");
1099
1100 return 0;
1101fail:
1102 /* failures here can mean systems won't boot... */
1103 pr_err("gpiochip_add: gpios %d..%d (%s) failed to register\n",
1104 chip->base, chip->base + chip->ngpio - 1,
1105 chip->label ? : "generic");
1106 return status;
1107}
1108EXPORT_SYMBOL_GPL(gpiochip_add);
1109
1110/**
1111 * gpiochip_remove() - unregister a gpio_chip
1112 * @chip: the chip to unregister
1113 *
1114 * A gpio_chip with any GPIOs still requested may not be removed.
1115 */
1116int gpiochip_remove(struct gpio_chip *chip)
1117{
1118 unsigned long flags;
1119 int status = 0;
1120 unsigned id;
1121
1122 spin_lock_irqsave(&gpio_lock, flags);
1123
1124 of_gpiochip_remove(chip);
1125
1126 for (id = chip->base; id < chip->base + chip->ngpio; id++) {
1127 if (test_bit(FLAG_REQUESTED, &gpio_desc[id].flags)) {
1128 status = -EBUSY;
1129 break;
1130 }
1131 }
1132 if (status == 0) {
1133 for (id = chip->base; id < chip->base + chip->ngpio; id++)
1134 gpio_desc[id].chip = NULL;
1135 }
1136
1137 spin_unlock_irqrestore(&gpio_lock, flags);
1138
1139 if (status == 0)
1140 gpiochip_unexport(chip);
1141
1142 return status;
1143}
1144EXPORT_SYMBOL_GPL(gpiochip_remove);
1145
1146/**
1147 * gpiochip_find() - iterator for locating a specific gpio_chip
1148 * @data: data to pass to match function
1149 * @callback: Callback function to check gpio_chip
1150 *
1151 * Similar to bus_find_device. It returns a reference to a gpio_chip as
1152 * determined by a user supplied @match callback. The callback should return
1153 * 0 if the device doesn't match and non-zero if it does. If the callback is
1154 * non-zero, this function will return to the caller and not iterate over any
1155 * more gpio_chips.
1156 */
1157struct gpio_chip *gpiochip_find(void *data,
1158 int (*match)(struct gpio_chip *chip,
1159 void *data))
1160{
1161 struct gpio_chip *chip = NULL;
1162 unsigned long flags;
1163 int i;
1164
1165 spin_lock_irqsave(&gpio_lock, flags);
1166 for (i = 0; i < ARCH_NR_GPIOS; i++) {
1167 if (!gpio_desc[i].chip)
1168 continue;
1169
1170 if (match(gpio_desc[i].chip, data)) {
1171 chip = gpio_desc[i].chip;
1172 break;
1173 }
1174 }
1175 spin_unlock_irqrestore(&gpio_lock, flags);
1176
1177 return chip;
1178}
1179EXPORT_SYMBOL_GPL(gpiochip_find);
1180
1181/* These "optional" allocation calls help prevent drivers from stomping
1182 * on each other, and help provide better diagnostics in debugfs.
1183 * They're called even less than the "set direction" calls.
1184 */
1185int gpio_request(unsigned gpio, const char *label)
1186{
1187 struct gpio_desc *desc;
1188 struct gpio_chip *chip;
1189 int status = -EINVAL;
1190 unsigned long flags;
1191
1192 spin_lock_irqsave(&gpio_lock, flags);
1193
1194 if (!gpio_is_valid(gpio))
1195 goto done;
1196 desc = &gpio_desc[gpio];
1197 chip = desc->chip;
1198 if (chip == NULL)
1199 goto done;
1200
1201 if (!try_module_get(chip->owner))
1202 goto done;
1203
1204 /* NOTE: gpio_request() can be called in early boot,
1205 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1206 */
1207
1208 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1209 desc_set_label(desc, label ? : "?");
1210 status = 0;
1211 } else {
1212 status = -EBUSY;
1213 module_put(chip->owner);
1214 goto done;
1215 }
1216
1217 if (chip->request) {
1218 /* chip->request may sleep */
1219 spin_unlock_irqrestore(&gpio_lock, flags);
1220 status = chip->request(chip, gpio - chip->base);
1221 spin_lock_irqsave(&gpio_lock, flags);
1222
1223 if (status < 0) {
1224 desc_set_label(desc, NULL);
1225 module_put(chip->owner);
1226 clear_bit(FLAG_REQUESTED, &desc->flags);
1227 }
1228 }
1229
1230done:
1231 if (status)
1232 pr_debug("gpio_request: gpio-%d (%s) status %d\n",
1233 gpio, label ? : "?", status);
1234 spin_unlock_irqrestore(&gpio_lock, flags);
1235 return status;
1236}
1237EXPORT_SYMBOL_GPL(gpio_request);
1238
1239void gpio_free(unsigned gpio)
1240{
1241 unsigned long flags;
1242 struct gpio_desc *desc;
1243 struct gpio_chip *chip;
1244
1245 might_sleep();
1246
1247 if (!gpio_is_valid(gpio)) {
1248 WARN_ON(extra_checks);
1249 return;
1250 }
1251
1252 gpio_unexport(gpio);
1253
1254 spin_lock_irqsave(&gpio_lock, flags);
1255
1256 desc = &gpio_desc[gpio];
1257 chip = desc->chip;
1258 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
1259 if (chip->free) {
1260 spin_unlock_irqrestore(&gpio_lock, flags);
1261 might_sleep_if(chip->can_sleep);
1262 chip->free(chip, gpio - chip->base);
1263 spin_lock_irqsave(&gpio_lock, flags);
1264 }
1265 desc_set_label(desc, NULL);
1266 module_put(desc->chip->owner);
1267 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1268 clear_bit(FLAG_REQUESTED, &desc->flags);
1269 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1270 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1271 } else
1272 WARN_ON(extra_checks);
1273
1274 spin_unlock_irqrestore(&gpio_lock, flags);
1275}
1276EXPORT_SYMBOL_GPL(gpio_free);
1277
1278/**
1279 * gpio_request_one - request a single GPIO with initial configuration
1280 * @gpio: the GPIO number
1281 * @flags: GPIO configuration as specified by GPIOF_*
1282 * @label: a literal description string of this GPIO
1283 */
1284int gpio_request_one(unsigned gpio, unsigned long flags, const char *label)
1285{
1286 int err;
1287
1288 err = gpio_request(gpio, label);
1289 if (err)
1290 return err;
1291
1292 if (flags & GPIOF_OPEN_DRAIN)
1293 set_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags);
1294
1295 if (flags & GPIOF_OPEN_SOURCE)
1296 set_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags);
1297
1298 if (flags & GPIOF_DIR_IN)
1299 err = gpio_direction_input(gpio);
1300 else
1301 err = gpio_direction_output(gpio,
1302 (flags & GPIOF_INIT_HIGH) ? 1 : 0);
1303
1304 if (err)
1305 goto free_gpio;
1306
1307 if (flags & GPIOF_EXPORT) {
1308 err = gpio_export(gpio, flags & GPIOF_EXPORT_CHANGEABLE);
1309 if (err)
1310 goto free_gpio;
1311 }
1312
1313 return 0;
1314
1315 free_gpio:
1316 gpio_free(gpio);
1317 return err;
1318}
1319EXPORT_SYMBOL_GPL(gpio_request_one);
1320
1321/**
1322 * gpio_request_array - request multiple GPIOs in a single call
1323 * @array: array of the 'struct gpio'
1324 * @num: how many GPIOs in the array
1325 */
1326int gpio_request_array(const struct gpio *array, size_t num)
1327{
1328 int i, err;
1329
1330 for (i = 0; i < num; i++, array++) {
1331 err = gpio_request_one(array->gpio, array->flags, array->label);
1332 if (err)
1333 goto err_free;
1334 }
1335 return 0;
1336
1337err_free:
1338 while (i--)
1339 gpio_free((--array)->gpio);
1340 return err;
1341}
1342EXPORT_SYMBOL_GPL(gpio_request_array);
1343
1344/**
1345 * gpio_free_array - release multiple GPIOs in a single call
1346 * @array: array of the 'struct gpio'
1347 * @num: how many GPIOs in the array
1348 */
1349void gpio_free_array(const struct gpio *array, size_t num)
1350{
1351 while (num--)
1352 gpio_free((array++)->gpio);
1353}
1354EXPORT_SYMBOL_GPL(gpio_free_array);
1355
1356/**
1357 * gpiochip_is_requested - return string iff signal was requested
1358 * @chip: controller managing the signal
1359 * @offset: of signal within controller's 0..(ngpio - 1) range
1360 *
1361 * Returns NULL if the GPIO is not currently requested, else a string.
1362 * If debugfs support is enabled, the string returned is the label passed
1363 * to gpio_request(); otherwise it is a meaningless constant.
1364 *
1365 * This function is for use by GPIO controller drivers. The label can
1366 * help with diagnostics, and knowing that the signal is used as a GPIO
1367 * can help avoid accidentally multiplexing it to another controller.
1368 */
1369const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
1370{
1371 unsigned gpio = chip->base + offset;
1372
1373 if (!gpio_is_valid(gpio) || gpio_desc[gpio].chip != chip)
1374 return NULL;
1375 if (test_bit(FLAG_REQUESTED, &gpio_desc[gpio].flags) == 0)
1376 return NULL;
1377#ifdef CONFIG_DEBUG_FS
1378 return gpio_desc[gpio].label;
1379#else
1380 return "?";
1381#endif
1382}
1383EXPORT_SYMBOL_GPL(gpiochip_is_requested);
1384
1385
1386/* Drivers MUST set GPIO direction before making get/set calls. In
1387 * some cases this is done in early boot, before IRQs are enabled.
1388 *
1389 * As a rule these aren't called more than once (except for drivers
1390 * using the open-drain emulation idiom) so these are natural places
1391 * to accumulate extra debugging checks. Note that we can't (yet)
1392 * rely on gpio_request() having been called beforehand.
1393 */
1394
1395int gpio_direction_input(unsigned gpio)
1396{
1397 unsigned long flags;
1398 struct gpio_chip *chip;
1399 struct gpio_desc *desc = &gpio_desc[gpio];
1400 int status = -EINVAL;
1401
1402 spin_lock_irqsave(&gpio_lock, flags);
1403
1404 if (!gpio_is_valid(gpio))
1405 goto fail;
1406 chip = desc->chip;
1407 if (!chip || !chip->get || !chip->direction_input)
1408 goto fail;
1409 gpio -= chip->base;
1410 if (gpio >= chip->ngpio)
1411 goto fail;
1412 status = gpio_ensure_requested(desc, gpio);
1413 if (status < 0)
1414 goto fail;
1415
1416 /* now we know the gpio is valid and chip won't vanish */
1417
1418 spin_unlock_irqrestore(&gpio_lock, flags);
1419
1420 might_sleep_if(chip->can_sleep);
1421
1422 if (status) {
1423 status = chip->request(chip, gpio);
1424 if (status < 0) {
1425 pr_debug("GPIO-%d: chip request fail, %d\n",
1426 chip->base + gpio, status);
1427 /* and it's not available to anyone else ...
1428 * gpio_request() is the fully clean solution.
1429 */
1430 goto lose;
1431 }
1432 }
1433
1434 status = chip->direction_input(chip, gpio);
1435 if (status == 0)
1436 clear_bit(FLAG_IS_OUT, &desc->flags);
1437
1438 trace_gpio_direction(chip->base + gpio, 1, status);
1439lose:
1440 return status;
1441fail:
1442 spin_unlock_irqrestore(&gpio_lock, flags);
1443 if (status)
1444 pr_debug("%s: gpio-%d status %d\n",
1445 __func__, gpio, status);
1446 return status;
1447}
1448EXPORT_SYMBOL_GPL(gpio_direction_input);
1449
1450int gpio_direction_output(unsigned gpio, int value)
1451{
1452 unsigned long flags;
1453 struct gpio_chip *chip;
1454 struct gpio_desc *desc = &gpio_desc[gpio];
1455 int status = -EINVAL;
1456
1457 /* Open drain pin should not be driven to 1 */
1458 if (value && test_bit(FLAG_OPEN_DRAIN, &desc->flags))
1459 return gpio_direction_input(gpio);
1460
1461 /* Open source pin should not be driven to 0 */
1462 if (!value && test_bit(FLAG_OPEN_SOURCE, &desc->flags))
1463 return gpio_direction_input(gpio);
1464
1465 spin_lock_irqsave(&gpio_lock, flags);
1466
1467 if (!gpio_is_valid(gpio))
1468 goto fail;
1469 chip = desc->chip;
1470 if (!chip || !chip->set || !chip->direction_output)
1471 goto fail;
1472 gpio -= chip->base;
1473 if (gpio >= chip->ngpio)
1474 goto fail;
1475 status = gpio_ensure_requested(desc, gpio);
1476 if (status < 0)
1477 goto fail;
1478
1479 /* now we know the gpio is valid and chip won't vanish */
1480
1481 spin_unlock_irqrestore(&gpio_lock, flags);
1482
1483 might_sleep_if(chip->can_sleep);
1484
1485 if (status) {
1486 status = chip->request(chip, gpio);
1487 if (status < 0) {
1488 pr_debug("GPIO-%d: chip request fail, %d\n",
1489 chip->base + gpio, status);
1490 /* and it's not available to anyone else ...
1491 * gpio_request() is the fully clean solution.
1492 */
1493 goto lose;
1494 }
1495 }
1496
1497 status = chip->direction_output(chip, gpio, value);
1498 if (status == 0)
1499 set_bit(FLAG_IS_OUT, &desc->flags);
1500 trace_gpio_value(chip->base + gpio, 0, value);
1501 trace_gpio_direction(chip->base + gpio, 0, status);
1502lose:
1503 return status;
1504fail:
1505 spin_unlock_irqrestore(&gpio_lock, flags);
1506 if (status)
1507 pr_debug("%s: gpio-%d status %d\n",
1508 __func__, gpio, status);
1509 return status;
1510}
1511EXPORT_SYMBOL_GPL(gpio_direction_output);
1512
1513/**
1514 * gpio_set_debounce - sets @debounce time for a @gpio
1515 * @gpio: the gpio to set debounce time
1516 * @debounce: debounce time is microseconds
1517 */
1518int gpio_set_debounce(unsigned gpio, unsigned debounce)
1519{
1520 unsigned long flags;
1521 struct gpio_chip *chip;
1522 struct gpio_desc *desc = &gpio_desc[gpio];
1523 int status = -EINVAL;
1524
1525 spin_lock_irqsave(&gpio_lock, flags);
1526
1527 if (!gpio_is_valid(gpio))
1528 goto fail;
1529 chip = desc->chip;
1530 if (!chip || !chip->set || !chip->set_debounce)
1531 goto fail;
1532 gpio -= chip->base;
1533 if (gpio >= chip->ngpio)
1534 goto fail;
1535 status = gpio_ensure_requested(desc, gpio);
1536 if (status < 0)
1537 goto fail;
1538
1539 /* now we know the gpio is valid and chip won't vanish */
1540
1541 spin_unlock_irqrestore(&gpio_lock, flags);
1542
1543 might_sleep_if(chip->can_sleep);
1544
1545 return chip->set_debounce(chip, gpio, debounce);
1546
1547fail:
1548 spin_unlock_irqrestore(&gpio_lock, flags);
1549 if (status)
1550 pr_debug("%s: gpio-%d status %d\n",
1551 __func__, gpio, status);
1552
1553 return status;
1554}
1555EXPORT_SYMBOL_GPL(gpio_set_debounce);
1556
1557/* I/O calls are only valid after configuration completed; the relevant
1558 * "is this a valid GPIO" error checks should already have been done.
1559 *
1560 * "Get" operations are often inlinable as reading a pin value register,
1561 * and masking the relevant bit in that register.
1562 *
1563 * When "set" operations are inlinable, they involve writing that mask to
1564 * one register to set a low value, or a different register to set it high.
1565 * Otherwise locking is needed, so there may be little value to inlining.
1566 *
1567 *------------------------------------------------------------------------
1568 *
1569 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
1570 * have requested the GPIO. That can include implicit requesting by
1571 * a direction setting call. Marking a gpio as requested locks its chip
1572 * in memory, guaranteeing that these table lookups need no more locking
1573 * and that gpiochip_remove() will fail.
1574 *
1575 * REVISIT when debugging, consider adding some instrumentation to ensure
1576 * that the GPIO was actually requested.
1577 */
1578
1579/**
1580 * __gpio_get_value() - return a gpio's value
1581 * @gpio: gpio whose value will be returned
1582 * Context: any
1583 *
1584 * This is used directly or indirectly to implement gpio_get_value().
1585 * It returns the zero or nonzero value provided by the associated
1586 * gpio_chip.get() method; or zero if no such method is provided.
1587 */
1588int __gpio_get_value(unsigned gpio)
1589{
1590 struct gpio_chip *chip;
1591 int value;
1592
1593 chip = gpio_to_chip(gpio);
1594 /* Should be using gpio_get_value_cansleep() */
1595 WARN_ON(chip->can_sleep);
1596 value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
1597 trace_gpio_value(gpio, 1, value);
1598 return value;
1599}
1600EXPORT_SYMBOL_GPL(__gpio_get_value);
1601
1602/*
1603 * _gpio_set_open_drain_value() - Set the open drain gpio's value.
1604 * @gpio: Gpio whose state need to be set.
1605 * @chip: Gpio chip.
1606 * @value: Non-zero for setting it HIGH otherise it will set to LOW.
1607 */
1608static void _gpio_set_open_drain_value(unsigned gpio,
1609 struct gpio_chip *chip, int value)
1610{
1611 int err = 0;
1612 if (value) {
1613 err = chip->direction_input(chip, gpio - chip->base);
1614 if (!err)
1615 clear_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1616 } else {
1617 err = chip->direction_output(chip, gpio - chip->base, 0);
1618 if (!err)
1619 set_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1620 }
1621 trace_gpio_direction(gpio, value, err);
1622 if (err < 0)
1623 pr_err("%s: Error in set_value for open drain gpio%d err %d\n",
1624 __func__, gpio, err);
1625}
1626
1627/*
1628 * _gpio_set_open_source() - Set the open source gpio's value.
1629 * @gpio: Gpio whose state need to be set.
1630 * @chip: Gpio chip.
1631 * @value: Non-zero for setting it HIGH otherise it will set to LOW.
1632 */
1633static void _gpio_set_open_source_value(unsigned gpio,
1634 struct gpio_chip *chip, int value)
1635{
1636 int err = 0;
1637 if (value) {
1638 err = chip->direction_output(chip, gpio - chip->base, 1);
1639 if (!err)
1640 set_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1641 } else {
1642 err = chip->direction_input(chip, gpio - chip->base);
1643 if (!err)
1644 clear_bit(FLAG_IS_OUT, &gpio_desc[gpio].flags);
1645 }
1646 trace_gpio_direction(gpio, !value, err);
1647 if (err < 0)
1648 pr_err("%s: Error in set_value for open source gpio%d err %d\n",
1649 __func__, gpio, err);
1650}
1651
1652
1653/**
1654 * __gpio_set_value() - assign a gpio's value
1655 * @gpio: gpio whose value will be assigned
1656 * @value: value to assign
1657 * Context: any
1658 *
1659 * This is used directly or indirectly to implement gpio_set_value().
1660 * It invokes the associated gpio_chip.set() method.
1661 */
1662void __gpio_set_value(unsigned gpio, int value)
1663{
1664 struct gpio_chip *chip;
1665
1666 chip = gpio_to_chip(gpio);
1667 /* Should be using gpio_set_value_cansleep() */
1668 WARN_ON(chip->can_sleep);
1669 trace_gpio_value(gpio, 0, value);
1670 if (test_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags))
1671 _gpio_set_open_drain_value(gpio, chip, value);
1672 else if (test_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags))
1673 _gpio_set_open_source_value(gpio, chip, value);
1674 else
1675 chip->set(chip, gpio - chip->base, value);
1676}
1677EXPORT_SYMBOL_GPL(__gpio_set_value);
1678
1679/**
1680 * __gpio_cansleep() - report whether gpio value access will sleep
1681 * @gpio: gpio in question
1682 * Context: any
1683 *
1684 * This is used directly or indirectly to implement gpio_cansleep(). It
1685 * returns nonzero if access reading or writing the GPIO value can sleep.
1686 */
1687int __gpio_cansleep(unsigned gpio)
1688{
1689 struct gpio_chip *chip;
1690
1691 /* only call this on GPIOs that are valid! */
1692 chip = gpio_to_chip(gpio);
1693
1694 return chip->can_sleep;
1695}
1696EXPORT_SYMBOL_GPL(__gpio_cansleep);
1697
1698/**
1699 * __gpio_to_irq() - return the IRQ corresponding to a GPIO
1700 * @gpio: gpio whose IRQ will be returned (already requested)
1701 * Context: any
1702 *
1703 * This is used directly or indirectly to implement gpio_to_irq().
1704 * It returns the number of the IRQ signaled by this (input) GPIO,
1705 * or a negative errno.
1706 */
1707int __gpio_to_irq(unsigned gpio)
1708{
1709 struct gpio_chip *chip;
1710
1711 chip = gpio_to_chip(gpio);
1712 return chip->to_irq ? chip->to_irq(chip, gpio - chip->base) : -ENXIO;
1713}
1714EXPORT_SYMBOL_GPL(__gpio_to_irq);
1715
1716
1717
1718/* There's no value in making it easy to inline GPIO calls that may sleep.
1719 * Common examples include ones connected to I2C or SPI chips.
1720 */
1721
1722int gpio_get_value_cansleep(unsigned gpio)
1723{
1724 struct gpio_chip *chip;
1725 int value;
1726
1727 might_sleep_if(extra_checks);
1728 chip = gpio_to_chip(gpio);
1729 value = chip->get ? chip->get(chip, gpio - chip->base) : 0;
1730 trace_gpio_value(gpio, 1, value);
1731 return value;
1732}
1733EXPORT_SYMBOL_GPL(gpio_get_value_cansleep);
1734
1735void gpio_set_value_cansleep(unsigned gpio, int value)
1736{
1737 struct gpio_chip *chip;
1738
1739 might_sleep_if(extra_checks);
1740 chip = gpio_to_chip(gpio);
1741 trace_gpio_value(gpio, 0, value);
1742 if (test_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags))
1743 _gpio_set_open_drain_value(gpio, chip, value);
1744 else if (test_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags))
1745 _gpio_set_open_source_value(gpio, chip, value);
1746 else
1747 chip->set(chip, gpio - chip->base, value);
1748}
1749EXPORT_SYMBOL_GPL(gpio_set_value_cansleep);
1750
1751
1752#ifdef CONFIG_DEBUG_FS
1753
1754static void gpiolib_dbg_show(struct seq_file *s, struct gpio_chip *chip)
1755{
1756 unsigned i;
1757 unsigned gpio = chip->base;
1758 struct gpio_desc *gdesc = &gpio_desc[gpio];
1759 int is_out;
1760
1761 for (i = 0; i < chip->ngpio; i++, gpio++, gdesc++) {
1762 if (!test_bit(FLAG_REQUESTED, &gdesc->flags))
1763 continue;
1764
1765 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
1766 seq_printf(s, " gpio-%-3d (%-20.20s) %s %s",
1767 gpio, gdesc->label,
1768 is_out ? "out" : "in ",
1769 chip->get
1770 ? (chip->get(chip, i) ? "hi" : "lo")
1771 : "? ");
1772 seq_printf(s, "\n");
1773 }
1774}
1775
1776static int gpiolib_show(struct seq_file *s, void *unused)
1777{
1778 struct gpio_chip *chip = NULL;
1779 unsigned gpio;
1780 int started = 0;
1781
1782 /* REVISIT this isn't locked against gpio_chip removal ... */
1783
1784 for (gpio = 0; gpio_is_valid(gpio); gpio++) {
1785 struct device *dev;
1786
1787 if (chip == gpio_desc[gpio].chip)
1788 continue;
1789 chip = gpio_desc[gpio].chip;
1790 if (!chip)
1791 continue;
1792
1793 seq_printf(s, "%sGPIOs %d-%d",
1794 started ? "\n" : "",
1795 chip->base, chip->base + chip->ngpio - 1);
1796 dev = chip->dev;
1797 if (dev)
1798 seq_printf(s, ", %s/%s",
1799 dev->bus ? dev->bus->name : "no-bus",
1800 dev_name(dev));
1801 if (chip->label)
1802 seq_printf(s, ", %s", chip->label);
1803 if (chip->can_sleep)
1804 seq_printf(s, ", can sleep");
1805 seq_printf(s, ":\n");
1806
1807 started = 1;
1808 if (chip->dbg_show)
1809 chip->dbg_show(s, chip);
1810 else
1811 gpiolib_dbg_show(s, chip);
1812 }
1813 return 0;
1814}
1815
1816static int gpiolib_open(struct inode *inode, struct file *file)
1817{
1818 return single_open(file, gpiolib_show, NULL);
1819}
1820
1821static const struct file_operations gpiolib_operations = {
1822 .open = gpiolib_open,
1823 .read = seq_read,
1824 .llseek = seq_lseek,
1825 .release = single_release,
1826};
1827
1828static int __init gpiolib_debugfs_init(void)
1829{
1830 /* /sys/kernel/debug/gpio */
1831 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
1832 NULL, NULL, &gpiolib_operations);
1833 return 0;
1834}
1835subsys_initcall(gpiolib_debugfs_init);
1836
1837#endif /* DEBUG_FS */
1#include <linux/kernel.h>
2#include <linux/module.h>
3#include <linux/interrupt.h>
4#include <linux/irq.h>
5#include <linux/spinlock.h>
6#include <linux/list.h>
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>
12#include <linux/of_gpio.h>
13#include <linux/idr.h>
14#include <linux/slab.h>
15#include <linux/acpi.h>
16#include <linux/gpio/driver.h>
17#include <linux/gpio/machine.h>
18#include <linux/pinctrl/consumer.h>
19#include <linux/cdev.h>
20#include <linux/fs.h>
21#include <linux/uaccess.h>
22#include <linux/compat.h>
23#include <linux/anon_inodes.h>
24#include <linux/file.h>
25#include <linux/kfifo.h>
26#include <linux/poll.h>
27#include <linux/timekeeping.h>
28#include <uapi/linux/gpio.h>
29
30#include "gpiolib.h"
31
32#define CREATE_TRACE_POINTS
33#include <trace/events/gpio.h>
34
35/* Implementation infrastructure for GPIO interfaces.
36 *
37 * The GPIO programming interface allows for inlining speed-critical
38 * get/set operations for common cases, so that access to SOC-integrated
39 * GPIOs can sometimes cost only an instruction or two per bit.
40 */
41
42
43/* When debugging, extend minimal trust to callers and platform code.
44 * Also emit diagnostic messages that may help initial bringup, when
45 * board setup or driver bugs are most common.
46 *
47 * Otherwise, minimize overhead in what may be bitbanging codepaths.
48 */
49#ifdef DEBUG
50#define extra_checks 1
51#else
52#define extra_checks 0
53#endif
54
55/* Device and char device-related information */
56static DEFINE_IDA(gpio_ida);
57static dev_t gpio_devt;
58#define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
59static struct bus_type gpio_bus_type = {
60 .name = "gpio",
61};
62
63/* gpio_lock prevents conflicts during gpio_desc[] table updates.
64 * While any GPIO is requested, its gpio_chip is not removable;
65 * each GPIO's "requested" flag serves as a lock and refcount.
66 */
67DEFINE_SPINLOCK(gpio_lock);
68
69static DEFINE_MUTEX(gpio_lookup_lock);
70static LIST_HEAD(gpio_lookup_list);
71LIST_HEAD(gpio_devices);
72
73static void gpiochip_free_hogs(struct gpio_chip *chip);
74static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
75static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip);
76static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip);
77
78static bool gpiolib_initialized;
79
80static inline void desc_set_label(struct gpio_desc *d, const char *label)
81{
82 d->label = label;
83}
84
85/**
86 * Convert a GPIO number to its descriptor
87 */
88struct gpio_desc *gpio_to_desc(unsigned gpio)
89{
90 struct gpio_device *gdev;
91 unsigned long flags;
92
93 spin_lock_irqsave(&gpio_lock, flags);
94
95 list_for_each_entry(gdev, &gpio_devices, list) {
96 if (gdev->base <= gpio &&
97 gdev->base + gdev->ngpio > gpio) {
98 spin_unlock_irqrestore(&gpio_lock, flags);
99 return &gdev->descs[gpio - gdev->base];
100 }
101 }
102
103 spin_unlock_irqrestore(&gpio_lock, flags);
104
105 if (!gpio_is_valid(gpio))
106 WARN(1, "invalid GPIO %d\n", gpio);
107
108 return NULL;
109}
110EXPORT_SYMBOL_GPL(gpio_to_desc);
111
112/**
113 * Get the GPIO descriptor corresponding to the given hw number for this chip.
114 */
115struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
116 u16 hwnum)
117{
118 struct gpio_device *gdev = chip->gpiodev;
119
120 if (hwnum >= gdev->ngpio)
121 return ERR_PTR(-EINVAL);
122
123 return &gdev->descs[hwnum];
124}
125
126/**
127 * Convert a GPIO descriptor to the integer namespace.
128 * This should disappear in the future but is needed since we still
129 * use GPIO numbers for error messages and sysfs nodes
130 */
131int desc_to_gpio(const struct gpio_desc *desc)
132{
133 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
134}
135EXPORT_SYMBOL_GPL(desc_to_gpio);
136
137
138/**
139 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
140 * @desc: descriptor to return the chip of
141 */
142struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
143{
144 if (!desc || !desc->gdev || !desc->gdev->chip)
145 return NULL;
146 return desc->gdev->chip;
147}
148EXPORT_SYMBOL_GPL(gpiod_to_chip);
149
150/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
151static int gpiochip_find_base(int ngpio)
152{
153 struct gpio_device *gdev;
154 int base = ARCH_NR_GPIOS - ngpio;
155
156 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
157 /* found a free space? */
158 if (gdev->base + gdev->ngpio <= base)
159 break;
160 else
161 /* nope, check the space right before the chip */
162 base = gdev->base - ngpio;
163 }
164
165 if (gpio_is_valid(base)) {
166 pr_debug("%s: found new base at %d\n", __func__, base);
167 return base;
168 } else {
169 pr_err("%s: cannot find free range\n", __func__);
170 return -ENOSPC;
171 }
172}
173
174/**
175 * gpiod_get_direction - return the current direction of a GPIO
176 * @desc: GPIO to get the direction of
177 *
178 * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error.
179 *
180 * This function may sleep if gpiod_cansleep() is true.
181 */
182int gpiod_get_direction(struct gpio_desc *desc)
183{
184 struct gpio_chip *chip;
185 unsigned offset;
186 int status = -EINVAL;
187
188 chip = gpiod_to_chip(desc);
189 offset = gpio_chip_hwgpio(desc);
190
191 if (!chip->get_direction)
192 return status;
193
194 status = chip->get_direction(chip, offset);
195 if (status > 0) {
196 /* GPIOF_DIR_IN, or other positive */
197 status = 1;
198 clear_bit(FLAG_IS_OUT, &desc->flags);
199 }
200 if (status == 0) {
201 /* GPIOF_DIR_OUT */
202 set_bit(FLAG_IS_OUT, &desc->flags);
203 }
204 return status;
205}
206EXPORT_SYMBOL_GPL(gpiod_get_direction);
207
208/*
209 * Add a new chip to the global chips list, keeping the list of chips sorted
210 * by range(means [base, base + ngpio - 1]) order.
211 *
212 * Return -EBUSY if the new chip overlaps with some other chip's integer
213 * space.
214 */
215static int gpiodev_add_to_list(struct gpio_device *gdev)
216{
217 struct gpio_device *prev, *next;
218
219 if (list_empty(&gpio_devices)) {
220 /* initial entry in list */
221 list_add_tail(&gdev->list, &gpio_devices);
222 return 0;
223 }
224
225 next = list_entry(gpio_devices.next, struct gpio_device, list);
226 if (gdev->base + gdev->ngpio <= next->base) {
227 /* add before first entry */
228 list_add(&gdev->list, &gpio_devices);
229 return 0;
230 }
231
232 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
233 if (prev->base + prev->ngpio <= gdev->base) {
234 /* add behind last entry */
235 list_add_tail(&gdev->list, &gpio_devices);
236 return 0;
237 }
238
239 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
240 /* at the end of the list */
241 if (&next->list == &gpio_devices)
242 break;
243
244 /* add between prev and next */
245 if (prev->base + prev->ngpio <= gdev->base
246 && gdev->base + gdev->ngpio <= next->base) {
247 list_add(&gdev->list, &prev->list);
248 return 0;
249 }
250 }
251
252 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
253 return -EBUSY;
254}
255
256/**
257 * Convert a GPIO name to its descriptor
258 */
259static struct gpio_desc *gpio_name_to_desc(const char * const name)
260{
261 struct gpio_device *gdev;
262 unsigned long flags;
263
264 spin_lock_irqsave(&gpio_lock, flags);
265
266 list_for_each_entry(gdev, &gpio_devices, list) {
267 int i;
268
269 for (i = 0; i != gdev->ngpio; ++i) {
270 struct gpio_desc *desc = &gdev->descs[i];
271
272 if (!desc->name || !name)
273 continue;
274
275 if (!strcmp(desc->name, name)) {
276 spin_unlock_irqrestore(&gpio_lock, flags);
277 return desc;
278 }
279 }
280 }
281
282 spin_unlock_irqrestore(&gpio_lock, flags);
283
284 return NULL;
285}
286
287/*
288 * Takes the names from gc->names and checks if they are all unique. If they
289 * are, they are assigned to their gpio descriptors.
290 *
291 * Warning if one of the names is already used for a different GPIO.
292 */
293static int gpiochip_set_desc_names(struct gpio_chip *gc)
294{
295 struct gpio_device *gdev = gc->gpiodev;
296 int i;
297
298 if (!gc->names)
299 return 0;
300
301 /* First check all names if they are unique */
302 for (i = 0; i != gc->ngpio; ++i) {
303 struct gpio_desc *gpio;
304
305 gpio = gpio_name_to_desc(gc->names[i]);
306 if (gpio)
307 dev_warn(&gdev->dev,
308 "Detected name collision for GPIO name '%s'\n",
309 gc->names[i]);
310 }
311
312 /* Then add all names to the GPIO descriptors */
313 for (i = 0; i != gc->ngpio; ++i)
314 gdev->descs[i].name = gc->names[i];
315
316 return 0;
317}
318
319/*
320 * GPIO line handle management
321 */
322
323/**
324 * struct linehandle_state - contains the state of a userspace handle
325 * @gdev: the GPIO device the handle pertains to
326 * @label: consumer label used to tag descriptors
327 * @descs: the GPIO descriptors held by this handle
328 * @numdescs: the number of descriptors held in the descs array
329 */
330struct linehandle_state {
331 struct gpio_device *gdev;
332 const char *label;
333 struct gpio_desc *descs[GPIOHANDLES_MAX];
334 u32 numdescs;
335};
336
337#define GPIOHANDLE_REQUEST_VALID_FLAGS \
338 (GPIOHANDLE_REQUEST_INPUT | \
339 GPIOHANDLE_REQUEST_OUTPUT | \
340 GPIOHANDLE_REQUEST_ACTIVE_LOW | \
341 GPIOHANDLE_REQUEST_OPEN_DRAIN | \
342 GPIOHANDLE_REQUEST_OPEN_SOURCE)
343
344static long linehandle_ioctl(struct file *filep, unsigned int cmd,
345 unsigned long arg)
346{
347 struct linehandle_state *lh = filep->private_data;
348 void __user *ip = (void __user *)arg;
349 struct gpiohandle_data ghd;
350 int i;
351
352 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
353 int val;
354
355 memset(&ghd, 0, sizeof(ghd));
356
357 /* TODO: check if descriptors are really input */
358 for (i = 0; i < lh->numdescs; i++) {
359 val = gpiod_get_value_cansleep(lh->descs[i]);
360 if (val < 0)
361 return val;
362 ghd.values[i] = val;
363 }
364
365 if (copy_to_user(ip, &ghd, sizeof(ghd)))
366 return -EFAULT;
367
368 return 0;
369 } else if (cmd == GPIOHANDLE_SET_LINE_VALUES_IOCTL) {
370 int vals[GPIOHANDLES_MAX];
371
372 /* TODO: check if descriptors are really output */
373 if (copy_from_user(&ghd, ip, sizeof(ghd)))
374 return -EFAULT;
375
376 /* Clamp all values to [0,1] */
377 for (i = 0; i < lh->numdescs; i++)
378 vals[i] = !!ghd.values[i];
379
380 /* Reuse the array setting function */
381 gpiod_set_array_value_complex(false,
382 true,
383 lh->numdescs,
384 lh->descs,
385 vals);
386 return 0;
387 }
388 return -EINVAL;
389}
390
391#ifdef CONFIG_COMPAT
392static long linehandle_ioctl_compat(struct file *filep, unsigned int cmd,
393 unsigned long arg)
394{
395 return linehandle_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
396}
397#endif
398
399static int linehandle_release(struct inode *inode, struct file *filep)
400{
401 struct linehandle_state *lh = filep->private_data;
402 struct gpio_device *gdev = lh->gdev;
403 int i;
404
405 for (i = 0; i < lh->numdescs; i++)
406 gpiod_free(lh->descs[i]);
407 kfree(lh->label);
408 kfree(lh);
409 put_device(&gdev->dev);
410 return 0;
411}
412
413static const struct file_operations linehandle_fileops = {
414 .release = linehandle_release,
415 .owner = THIS_MODULE,
416 .llseek = noop_llseek,
417 .unlocked_ioctl = linehandle_ioctl,
418#ifdef CONFIG_COMPAT
419 .compat_ioctl = linehandle_ioctl_compat,
420#endif
421};
422
423static int linehandle_create(struct gpio_device *gdev, void __user *ip)
424{
425 struct gpiohandle_request handlereq;
426 struct linehandle_state *lh;
427 struct file *file;
428 int fd, i, ret;
429
430 if (copy_from_user(&handlereq, ip, sizeof(handlereq)))
431 return -EFAULT;
432 if ((handlereq.lines == 0) || (handlereq.lines > GPIOHANDLES_MAX))
433 return -EINVAL;
434
435 lh = kzalloc(sizeof(*lh), GFP_KERNEL);
436 if (!lh)
437 return -ENOMEM;
438 lh->gdev = gdev;
439 get_device(&gdev->dev);
440
441 /* Make sure this is terminated */
442 handlereq.consumer_label[sizeof(handlereq.consumer_label)-1] = '\0';
443 if (strlen(handlereq.consumer_label)) {
444 lh->label = kstrdup(handlereq.consumer_label,
445 GFP_KERNEL);
446 if (!lh->label) {
447 ret = -ENOMEM;
448 goto out_free_lh;
449 }
450 }
451
452 /* Request each GPIO */
453 for (i = 0; i < handlereq.lines; i++) {
454 u32 offset = handlereq.lineoffsets[i];
455 u32 lflags = handlereq.flags;
456 struct gpio_desc *desc;
457
458 if (offset >= gdev->ngpio) {
459 ret = -EINVAL;
460 goto out_free_descs;
461 }
462
463 /* Return an error if a unknown flag is set */
464 if (lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) {
465 ret = -EINVAL;
466 goto out_free_descs;
467 }
468
469 desc = &gdev->descs[offset];
470 ret = gpiod_request(desc, lh->label);
471 if (ret)
472 goto out_free_descs;
473 lh->descs[i] = desc;
474
475 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
476 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
477 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
478 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
479 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
480 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
481
482 /*
483 * Lines have to be requested explicitly for input
484 * or output, else the line will be treated "as is".
485 */
486 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
487 int val = !!handlereq.default_values[i];
488
489 ret = gpiod_direction_output(desc, val);
490 if (ret)
491 goto out_free_descs;
492 } else if (lflags & GPIOHANDLE_REQUEST_INPUT) {
493 ret = gpiod_direction_input(desc);
494 if (ret)
495 goto out_free_descs;
496 }
497 dev_dbg(&gdev->dev, "registered chardev handle for line %d\n",
498 offset);
499 }
500 /* Let i point at the last handle */
501 i--;
502 lh->numdescs = handlereq.lines;
503
504 fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
505 if (fd < 0) {
506 ret = fd;
507 goto out_free_descs;
508 }
509
510 file = anon_inode_getfile("gpio-linehandle",
511 &linehandle_fileops,
512 lh,
513 O_RDONLY | O_CLOEXEC);
514 if (IS_ERR(file)) {
515 ret = PTR_ERR(file);
516 goto out_put_unused_fd;
517 }
518
519 handlereq.fd = fd;
520 if (copy_to_user(ip, &handlereq, sizeof(handlereq))) {
521 /*
522 * fput() will trigger the release() callback, so do not go onto
523 * the regular error cleanup path here.
524 */
525 fput(file);
526 put_unused_fd(fd);
527 return -EFAULT;
528 }
529
530 fd_install(fd, file);
531
532 dev_dbg(&gdev->dev, "registered chardev handle for %d lines\n",
533 lh->numdescs);
534
535 return 0;
536
537out_put_unused_fd:
538 put_unused_fd(fd);
539out_free_descs:
540 for (; i >= 0; i--)
541 gpiod_free(lh->descs[i]);
542 kfree(lh->label);
543out_free_lh:
544 kfree(lh);
545 put_device(&gdev->dev);
546 return ret;
547}
548
549/*
550 * GPIO line event management
551 */
552
553/**
554 * struct lineevent_state - contains the state of a userspace event
555 * @gdev: the GPIO device the event pertains to
556 * @label: consumer label used to tag descriptors
557 * @desc: the GPIO descriptor held by this event
558 * @eflags: the event flags this line was requested with
559 * @irq: the interrupt that trigger in response to events on this GPIO
560 * @wait: wait queue that handles blocking reads of events
561 * @events: KFIFO for the GPIO events
562 * @read_lock: mutex lock to protect reads from colliding with adding
563 * new events to the FIFO
564 */
565struct lineevent_state {
566 struct gpio_device *gdev;
567 const char *label;
568 struct gpio_desc *desc;
569 u32 eflags;
570 int irq;
571 wait_queue_head_t wait;
572 DECLARE_KFIFO(events, struct gpioevent_data, 16);
573 struct mutex read_lock;
574};
575
576#define GPIOEVENT_REQUEST_VALID_FLAGS \
577 (GPIOEVENT_REQUEST_RISING_EDGE | \
578 GPIOEVENT_REQUEST_FALLING_EDGE)
579
580static unsigned int lineevent_poll(struct file *filep,
581 struct poll_table_struct *wait)
582{
583 struct lineevent_state *le = filep->private_data;
584 unsigned int events = 0;
585
586 poll_wait(filep, &le->wait, wait);
587
588 if (!kfifo_is_empty(&le->events))
589 events = POLLIN | POLLRDNORM;
590
591 return events;
592}
593
594
595static ssize_t lineevent_read(struct file *filep,
596 char __user *buf,
597 size_t count,
598 loff_t *f_ps)
599{
600 struct lineevent_state *le = filep->private_data;
601 unsigned int copied;
602 int ret;
603
604 if (count < sizeof(struct gpioevent_data))
605 return -EINVAL;
606
607 do {
608 if (kfifo_is_empty(&le->events)) {
609 if (filep->f_flags & O_NONBLOCK)
610 return -EAGAIN;
611
612 ret = wait_event_interruptible(le->wait,
613 !kfifo_is_empty(&le->events));
614 if (ret)
615 return ret;
616 }
617
618 if (mutex_lock_interruptible(&le->read_lock))
619 return -ERESTARTSYS;
620 ret = kfifo_to_user(&le->events, buf, count, &copied);
621 mutex_unlock(&le->read_lock);
622
623 if (ret)
624 return ret;
625
626 /*
627 * If we couldn't read anything from the fifo (a different
628 * thread might have been faster) we either return -EAGAIN if
629 * the file descriptor is non-blocking, otherwise we go back to
630 * sleep and wait for more data to arrive.
631 */
632 if (copied == 0 && (filep->f_flags & O_NONBLOCK))
633 return -EAGAIN;
634
635 } while (copied == 0);
636
637 return copied;
638}
639
640static int lineevent_release(struct inode *inode, struct file *filep)
641{
642 struct lineevent_state *le = filep->private_data;
643 struct gpio_device *gdev = le->gdev;
644
645 free_irq(le->irq, le);
646 gpiod_free(le->desc);
647 kfree(le->label);
648 kfree(le);
649 put_device(&gdev->dev);
650 return 0;
651}
652
653static long lineevent_ioctl(struct file *filep, unsigned int cmd,
654 unsigned long arg)
655{
656 struct lineevent_state *le = filep->private_data;
657 void __user *ip = (void __user *)arg;
658 struct gpiohandle_data ghd;
659
660 /*
661 * We can get the value for an event line but not set it,
662 * because it is input by definition.
663 */
664 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
665 int val;
666
667 memset(&ghd, 0, sizeof(ghd));
668
669 val = gpiod_get_value_cansleep(le->desc);
670 if (val < 0)
671 return val;
672 ghd.values[0] = val;
673
674 if (copy_to_user(ip, &ghd, sizeof(ghd)))
675 return -EFAULT;
676
677 return 0;
678 }
679 return -EINVAL;
680}
681
682#ifdef CONFIG_COMPAT
683static long lineevent_ioctl_compat(struct file *filep, unsigned int cmd,
684 unsigned long arg)
685{
686 return lineevent_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
687}
688#endif
689
690static const struct file_operations lineevent_fileops = {
691 .release = lineevent_release,
692 .read = lineevent_read,
693 .poll = lineevent_poll,
694 .owner = THIS_MODULE,
695 .llseek = noop_llseek,
696 .unlocked_ioctl = lineevent_ioctl,
697#ifdef CONFIG_COMPAT
698 .compat_ioctl = lineevent_ioctl_compat,
699#endif
700};
701
702static irqreturn_t lineevent_irq_thread(int irq, void *p)
703{
704 struct lineevent_state *le = p;
705 struct gpioevent_data ge;
706 int ret;
707
708 ge.timestamp = ktime_get_real_ns();
709
710 if (le->eflags & GPIOEVENT_REQUEST_BOTH_EDGES) {
711 int level = gpiod_get_value_cansleep(le->desc);
712
713 if (level)
714 /* Emit low-to-high event */
715 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
716 else
717 /* Emit high-to-low event */
718 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
719 } else if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE) {
720 /* Emit low-to-high event */
721 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
722 } else if (le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
723 /* Emit high-to-low event */
724 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
725 } else {
726 return IRQ_NONE;
727 }
728
729 ret = kfifo_put(&le->events, ge);
730 if (ret != 0)
731 wake_up_poll(&le->wait, POLLIN);
732
733 return IRQ_HANDLED;
734}
735
736static int lineevent_create(struct gpio_device *gdev, void __user *ip)
737{
738 struct gpioevent_request eventreq;
739 struct lineevent_state *le;
740 struct gpio_desc *desc;
741 struct file *file;
742 u32 offset;
743 u32 lflags;
744 u32 eflags;
745 int fd;
746 int ret;
747 int irqflags = 0;
748
749 if (copy_from_user(&eventreq, ip, sizeof(eventreq)))
750 return -EFAULT;
751
752 le = kzalloc(sizeof(*le), GFP_KERNEL);
753 if (!le)
754 return -ENOMEM;
755 le->gdev = gdev;
756 get_device(&gdev->dev);
757
758 /* Make sure this is terminated */
759 eventreq.consumer_label[sizeof(eventreq.consumer_label)-1] = '\0';
760 if (strlen(eventreq.consumer_label)) {
761 le->label = kstrdup(eventreq.consumer_label,
762 GFP_KERNEL);
763 if (!le->label) {
764 ret = -ENOMEM;
765 goto out_free_le;
766 }
767 }
768
769 offset = eventreq.lineoffset;
770 lflags = eventreq.handleflags;
771 eflags = eventreq.eventflags;
772
773 if (offset >= gdev->ngpio) {
774 ret = -EINVAL;
775 goto out_free_label;
776 }
777
778 /* Return an error if a unknown flag is set */
779 if ((lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) ||
780 (eflags & ~GPIOEVENT_REQUEST_VALID_FLAGS)) {
781 ret = -EINVAL;
782 goto out_free_label;
783 }
784
785 /* This is just wrong: we don't look for events on output lines */
786 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
787 ret = -EINVAL;
788 goto out_free_label;
789 }
790
791 desc = &gdev->descs[offset];
792 ret = gpiod_request(desc, le->label);
793 if (ret)
794 goto out_free_desc;
795 le->desc = desc;
796 le->eflags = eflags;
797
798 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
799 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
800 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
801 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
802 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
803 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
804
805 ret = gpiod_direction_input(desc);
806 if (ret)
807 goto out_free_desc;
808
809 le->irq = gpiod_to_irq(desc);
810 if (le->irq <= 0) {
811 ret = -ENODEV;
812 goto out_free_desc;
813 }
814
815 if (eflags & GPIOEVENT_REQUEST_RISING_EDGE)
816 irqflags |= IRQF_TRIGGER_RISING;
817 if (eflags & GPIOEVENT_REQUEST_FALLING_EDGE)
818 irqflags |= IRQF_TRIGGER_FALLING;
819 irqflags |= IRQF_ONESHOT;
820 irqflags |= IRQF_SHARED;
821
822 INIT_KFIFO(le->events);
823 init_waitqueue_head(&le->wait);
824 mutex_init(&le->read_lock);
825
826 /* Request a thread to read the events */
827 ret = request_threaded_irq(le->irq,
828 NULL,
829 lineevent_irq_thread,
830 irqflags,
831 le->label,
832 le);
833 if (ret)
834 goto out_free_desc;
835
836 fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
837 if (fd < 0) {
838 ret = fd;
839 goto out_free_irq;
840 }
841
842 file = anon_inode_getfile("gpio-event",
843 &lineevent_fileops,
844 le,
845 O_RDONLY | O_CLOEXEC);
846 if (IS_ERR(file)) {
847 ret = PTR_ERR(file);
848 goto out_put_unused_fd;
849 }
850
851 eventreq.fd = fd;
852 if (copy_to_user(ip, &eventreq, sizeof(eventreq))) {
853 /*
854 * fput() will trigger the release() callback, so do not go onto
855 * the regular error cleanup path here.
856 */
857 fput(file);
858 put_unused_fd(fd);
859 return -EFAULT;
860 }
861
862 fd_install(fd, file);
863
864 return 0;
865
866out_put_unused_fd:
867 put_unused_fd(fd);
868out_free_irq:
869 free_irq(le->irq, le);
870out_free_desc:
871 gpiod_free(le->desc);
872out_free_label:
873 kfree(le->label);
874out_free_le:
875 kfree(le);
876 put_device(&gdev->dev);
877 return ret;
878}
879
880/**
881 * gpio_ioctl() - ioctl handler for the GPIO chardev
882 */
883static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
884{
885 struct gpio_device *gdev = filp->private_data;
886 struct gpio_chip *chip = gdev->chip;
887 void __user *ip = (void __user *)arg;
888
889 /* We fail any subsequent ioctl():s when the chip is gone */
890 if (!chip)
891 return -ENODEV;
892
893 /* Fill in the struct and pass to userspace */
894 if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
895 struct gpiochip_info chipinfo;
896
897 memset(&chipinfo, 0, sizeof(chipinfo));
898
899 strncpy(chipinfo.name, dev_name(&gdev->dev),
900 sizeof(chipinfo.name));
901 chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
902 strncpy(chipinfo.label, gdev->label,
903 sizeof(chipinfo.label));
904 chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
905 chipinfo.lines = gdev->ngpio;
906 if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
907 return -EFAULT;
908 return 0;
909 } else if (cmd == GPIO_GET_LINEINFO_IOCTL) {
910 struct gpioline_info lineinfo;
911 struct gpio_desc *desc;
912
913 if (copy_from_user(&lineinfo, ip, sizeof(lineinfo)))
914 return -EFAULT;
915 if (lineinfo.line_offset >= gdev->ngpio)
916 return -EINVAL;
917
918 desc = &gdev->descs[lineinfo.line_offset];
919 if (desc->name) {
920 strncpy(lineinfo.name, desc->name,
921 sizeof(lineinfo.name));
922 lineinfo.name[sizeof(lineinfo.name)-1] = '\0';
923 } else {
924 lineinfo.name[0] = '\0';
925 }
926 if (desc->label) {
927 strncpy(lineinfo.consumer, desc->label,
928 sizeof(lineinfo.consumer));
929 lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
930 } else {
931 lineinfo.consumer[0] = '\0';
932 }
933
934 /*
935 * Userspace only need to know that the kernel is using
936 * this GPIO so it can't use it.
937 */
938 lineinfo.flags = 0;
939 if (test_bit(FLAG_REQUESTED, &desc->flags) ||
940 test_bit(FLAG_IS_HOGGED, &desc->flags) ||
941 test_bit(FLAG_USED_AS_IRQ, &desc->flags) ||
942 test_bit(FLAG_EXPORT, &desc->flags) ||
943 test_bit(FLAG_SYSFS, &desc->flags))
944 lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
945 if (test_bit(FLAG_IS_OUT, &desc->flags))
946 lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
947 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
948 lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
949 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
950 lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
951 if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
952 lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;
953
954 if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
955 return -EFAULT;
956 return 0;
957 } else if (cmd == GPIO_GET_LINEHANDLE_IOCTL) {
958 return linehandle_create(gdev, ip);
959 } else if (cmd == GPIO_GET_LINEEVENT_IOCTL) {
960 return lineevent_create(gdev, ip);
961 }
962 return -EINVAL;
963}
964
965#ifdef CONFIG_COMPAT
966static long gpio_ioctl_compat(struct file *filp, unsigned int cmd,
967 unsigned long arg)
968{
969 return gpio_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
970}
971#endif
972
973/**
974 * gpio_chrdev_open() - open the chardev for ioctl operations
975 * @inode: inode for this chardev
976 * @filp: file struct for storing private data
977 * Returns 0 on success
978 */
979static int gpio_chrdev_open(struct inode *inode, struct file *filp)
980{
981 struct gpio_device *gdev = container_of(inode->i_cdev,
982 struct gpio_device, chrdev);
983
984 /* Fail on open if the backing gpiochip is gone */
985 if (!gdev || !gdev->chip)
986 return -ENODEV;
987 get_device(&gdev->dev);
988 filp->private_data = gdev;
989
990 return nonseekable_open(inode, filp);
991}
992
993/**
994 * gpio_chrdev_release() - close chardev after ioctl operations
995 * @inode: inode for this chardev
996 * @filp: file struct for storing private data
997 * Returns 0 on success
998 */
999static int gpio_chrdev_release(struct inode *inode, struct file *filp)
1000{
1001 struct gpio_device *gdev = container_of(inode->i_cdev,
1002 struct gpio_device, chrdev);
1003
1004 if (!gdev)
1005 return -ENODEV;
1006 put_device(&gdev->dev);
1007 return 0;
1008}
1009
1010
1011static const struct file_operations gpio_fileops = {
1012 .release = gpio_chrdev_release,
1013 .open = gpio_chrdev_open,
1014 .owner = THIS_MODULE,
1015 .llseek = no_llseek,
1016 .unlocked_ioctl = gpio_ioctl,
1017#ifdef CONFIG_COMPAT
1018 .compat_ioctl = gpio_ioctl_compat,
1019#endif
1020};
1021
1022static void gpiodevice_release(struct device *dev)
1023{
1024 struct gpio_device *gdev = dev_get_drvdata(dev);
1025
1026 list_del(&gdev->list);
1027 ida_simple_remove(&gpio_ida, gdev->id);
1028 kfree(gdev->label);
1029 kfree(gdev->descs);
1030 kfree(gdev);
1031}
1032
1033static int gpiochip_setup_dev(struct gpio_device *gdev)
1034{
1035 int status;
1036
1037 cdev_init(&gdev->chrdev, &gpio_fileops);
1038 gdev->chrdev.owner = THIS_MODULE;
1039 gdev->chrdev.kobj.parent = &gdev->dev.kobj;
1040 gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id);
1041 status = cdev_add(&gdev->chrdev, gdev->dev.devt, 1);
1042 if (status < 0)
1043 chip_warn(gdev->chip, "failed to add char device %d:%d\n",
1044 MAJOR(gpio_devt), gdev->id);
1045 else
1046 chip_dbg(gdev->chip, "added GPIO chardev (%d:%d)\n",
1047 MAJOR(gpio_devt), gdev->id);
1048 status = device_add(&gdev->dev);
1049 if (status)
1050 goto err_remove_chardev;
1051
1052 status = gpiochip_sysfs_register(gdev);
1053 if (status)
1054 goto err_remove_device;
1055
1056 /* From this point, the .release() function cleans up gpio_device */
1057 gdev->dev.release = gpiodevice_release;
1058 pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n",
1059 __func__, gdev->base, gdev->base + gdev->ngpio - 1,
1060 dev_name(&gdev->dev), gdev->chip->label ? : "generic");
1061
1062 return 0;
1063
1064err_remove_device:
1065 device_del(&gdev->dev);
1066err_remove_chardev:
1067 cdev_del(&gdev->chrdev);
1068 return status;
1069}
1070
1071static void gpiochip_setup_devs(void)
1072{
1073 struct gpio_device *gdev;
1074 int err;
1075
1076 list_for_each_entry(gdev, &gpio_devices, list) {
1077 err = gpiochip_setup_dev(gdev);
1078 if (err)
1079 pr_err("%s: Failed to initialize gpio device (%d)\n",
1080 dev_name(&gdev->dev), err);
1081 }
1082}
1083
1084/**
1085 * gpiochip_add_data() - register a gpio_chip
1086 * @chip: the chip to register, with chip->base initialized
1087 * Context: potentially before irqs will work
1088 *
1089 * Returns a negative errno if the chip can't be registered, such as
1090 * because the chip->base is invalid or already associated with a
1091 * different chip. Otherwise it returns zero as a success code.
1092 *
1093 * When gpiochip_add_data() is called very early during boot, so that GPIOs
1094 * can be freely used, the chip->parent device must be registered before
1095 * the gpio framework's arch_initcall(). Otherwise sysfs initialization
1096 * for GPIOs will fail rudely.
1097 *
1098 * gpiochip_add_data() must only be called after gpiolib initialization,
1099 * ie after core_initcall().
1100 *
1101 * If chip->base is negative, this requests dynamic assignment of
1102 * a range of valid GPIOs.
1103 */
1104int gpiochip_add_data(struct gpio_chip *chip, void *data)
1105{
1106 unsigned long flags;
1107 int status = 0;
1108 unsigned i;
1109 int base = chip->base;
1110 struct gpio_device *gdev;
1111
1112 /*
1113 * First: allocate and populate the internal stat container, and
1114 * set up the struct device.
1115 */
1116 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
1117 if (!gdev)
1118 return -ENOMEM;
1119 gdev->dev.bus = &gpio_bus_type;
1120 gdev->chip = chip;
1121 chip->gpiodev = gdev;
1122 if (chip->parent) {
1123 gdev->dev.parent = chip->parent;
1124 gdev->dev.of_node = chip->parent->of_node;
1125 }
1126
1127#ifdef CONFIG_OF_GPIO
1128 /* If the gpiochip has an assigned OF node this takes precedence */
1129 if (chip->of_node)
1130 gdev->dev.of_node = chip->of_node;
1131#endif
1132
1133 gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
1134 if (gdev->id < 0) {
1135 status = gdev->id;
1136 goto err_free_gdev;
1137 }
1138 dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
1139 device_initialize(&gdev->dev);
1140 dev_set_drvdata(&gdev->dev, gdev);
1141 if (chip->parent && chip->parent->driver)
1142 gdev->owner = chip->parent->driver->owner;
1143 else if (chip->owner)
1144 /* TODO: remove chip->owner */
1145 gdev->owner = chip->owner;
1146 else
1147 gdev->owner = THIS_MODULE;
1148
1149 gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
1150 if (!gdev->descs) {
1151 status = -ENOMEM;
1152 goto err_free_gdev;
1153 }
1154
1155 if (chip->ngpio == 0) {
1156 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
1157 status = -EINVAL;
1158 goto err_free_descs;
1159 }
1160
1161 if (chip->label)
1162 gdev->label = kstrdup(chip->label, GFP_KERNEL);
1163 else
1164 gdev->label = kstrdup("unknown", GFP_KERNEL);
1165 if (!gdev->label) {
1166 status = -ENOMEM;
1167 goto err_free_descs;
1168 }
1169
1170 gdev->ngpio = chip->ngpio;
1171 gdev->data = data;
1172
1173 spin_lock_irqsave(&gpio_lock, flags);
1174
1175 /*
1176 * TODO: this allocates a Linux GPIO number base in the global
1177 * GPIO numberspace for this chip. In the long run we want to
1178 * get *rid* of this numberspace and use only descriptors, but
1179 * it may be a pipe dream. It will not happen before we get rid
1180 * of the sysfs interface anyways.
1181 */
1182 if (base < 0) {
1183 base = gpiochip_find_base(chip->ngpio);
1184 if (base < 0) {
1185 status = base;
1186 spin_unlock_irqrestore(&gpio_lock, flags);
1187 goto err_free_label;
1188 }
1189 /*
1190 * TODO: it should not be necessary to reflect the assigned
1191 * base outside of the GPIO subsystem. Go over drivers and
1192 * see if anyone makes use of this, else drop this and assign
1193 * a poison instead.
1194 */
1195 chip->base = base;
1196 }
1197 gdev->base = base;
1198
1199 status = gpiodev_add_to_list(gdev);
1200 if (status) {
1201 spin_unlock_irqrestore(&gpio_lock, flags);
1202 goto err_free_label;
1203 }
1204
1205 spin_unlock_irqrestore(&gpio_lock, flags);
1206
1207 for (i = 0; i < chip->ngpio; i++) {
1208 struct gpio_desc *desc = &gdev->descs[i];
1209
1210 desc->gdev = gdev;
1211 /*
1212 * REVISIT: most hardware initializes GPIOs as inputs
1213 * (often with pullups enabled) so power usage is
1214 * minimized. Linux code should set the gpio direction
1215 * first thing; but until it does, and in case
1216 * chip->get_direction is not set, we may expose the
1217 * wrong direction in sysfs.
1218 */
1219
1220 if (chip->get_direction) {
1221 /*
1222 * If we have .get_direction, set up the initial
1223 * direction flag from the hardware.
1224 */
1225 int dir = chip->get_direction(chip, i);
1226
1227 if (!dir)
1228 set_bit(FLAG_IS_OUT, &desc->flags);
1229 } else if (!chip->direction_input) {
1230 /*
1231 * If the chip lacks the .direction_input callback
1232 * we logically assume all lines are outputs.
1233 */
1234 set_bit(FLAG_IS_OUT, &desc->flags);
1235 }
1236 }
1237
1238#ifdef CONFIG_PINCTRL
1239 INIT_LIST_HEAD(&gdev->pin_ranges);
1240#endif
1241
1242 status = gpiochip_set_desc_names(chip);
1243 if (status)
1244 goto err_remove_from_list;
1245
1246 status = gpiochip_irqchip_init_valid_mask(chip);
1247 if (status)
1248 goto err_remove_from_list;
1249
1250 status = of_gpiochip_add(chip);
1251 if (status)
1252 goto err_remove_chip;
1253
1254 acpi_gpiochip_add(chip);
1255
1256 /*
1257 * By first adding the chardev, and then adding the device,
1258 * we get a device node entry in sysfs under
1259 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
1260 * coldplug of device nodes and other udev business.
1261 * We can do this only if gpiolib has been initialized.
1262 * Otherwise, defer until later.
1263 */
1264 if (gpiolib_initialized) {
1265 status = gpiochip_setup_dev(gdev);
1266 if (status)
1267 goto err_remove_chip;
1268 }
1269 return 0;
1270
1271err_remove_chip:
1272 acpi_gpiochip_remove(chip);
1273 gpiochip_free_hogs(chip);
1274 of_gpiochip_remove(chip);
1275 gpiochip_irqchip_free_valid_mask(chip);
1276err_remove_from_list:
1277 spin_lock_irqsave(&gpio_lock, flags);
1278 list_del(&gdev->list);
1279 spin_unlock_irqrestore(&gpio_lock, flags);
1280err_free_label:
1281 kfree(gdev->label);
1282err_free_descs:
1283 kfree(gdev->descs);
1284err_free_gdev:
1285 ida_simple_remove(&gpio_ida, gdev->id);
1286 /* failures here can mean systems won't boot... */
1287 pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
1288 gdev->base, gdev->base + gdev->ngpio - 1,
1289 chip->label ? : "generic");
1290 kfree(gdev);
1291 return status;
1292}
1293EXPORT_SYMBOL_GPL(gpiochip_add_data);
1294
1295/**
1296 * gpiochip_get_data() - get per-subdriver data for the chip
1297 */
1298void *gpiochip_get_data(struct gpio_chip *chip)
1299{
1300 return chip->gpiodev->data;
1301}
1302EXPORT_SYMBOL_GPL(gpiochip_get_data);
1303
1304/**
1305 * gpiochip_remove() - unregister a gpio_chip
1306 * @chip: the chip to unregister
1307 *
1308 * A gpio_chip with any GPIOs still requested may not be removed.
1309 */
1310void gpiochip_remove(struct gpio_chip *chip)
1311{
1312 struct gpio_device *gdev = chip->gpiodev;
1313 struct gpio_desc *desc;
1314 unsigned long flags;
1315 unsigned i;
1316 bool requested = false;
1317
1318 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1319 gpiochip_sysfs_unregister(gdev);
1320 gpiochip_free_hogs(chip);
1321 /* Numb the device, cancelling all outstanding operations */
1322 gdev->chip = NULL;
1323 gpiochip_irqchip_remove(chip);
1324 acpi_gpiochip_remove(chip);
1325 gpiochip_remove_pin_ranges(chip);
1326 of_gpiochip_remove(chip);
1327 /*
1328 * We accept no more calls into the driver from this point, so
1329 * NULL the driver data pointer
1330 */
1331 gdev->data = NULL;
1332
1333 spin_lock_irqsave(&gpio_lock, flags);
1334 for (i = 0; i < gdev->ngpio; i++) {
1335 desc = &gdev->descs[i];
1336 if (test_bit(FLAG_REQUESTED, &desc->flags))
1337 requested = true;
1338 }
1339 spin_unlock_irqrestore(&gpio_lock, flags);
1340
1341 if (requested)
1342 dev_crit(&gdev->dev,
1343 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
1344
1345 /*
1346 * The gpiochip side puts its use of the device to rest here:
1347 * if there are no userspace clients, the chardev and device will
1348 * be removed, else it will be dangling until the last user is
1349 * gone.
1350 */
1351 cdev_del(&gdev->chrdev);
1352 device_del(&gdev->dev);
1353 put_device(&gdev->dev);
1354}
1355EXPORT_SYMBOL_GPL(gpiochip_remove);
1356
1357static void devm_gpio_chip_release(struct device *dev, void *res)
1358{
1359 struct gpio_chip *chip = *(struct gpio_chip **)res;
1360
1361 gpiochip_remove(chip);
1362}
1363
1364static int devm_gpio_chip_match(struct device *dev, void *res, void *data)
1365
1366{
1367 struct gpio_chip **r = res;
1368
1369 if (!r || !*r) {
1370 WARN_ON(!r || !*r);
1371 return 0;
1372 }
1373
1374 return *r == data;
1375}
1376
1377/**
1378 * devm_gpiochip_add_data() - Resource manager piochip_add_data()
1379 * @dev: the device pointer on which irq_chip belongs to.
1380 * @chip: the chip to register, with chip->base initialized
1381 * Context: potentially before irqs will work
1382 *
1383 * Returns a negative errno if the chip can't be registered, such as
1384 * because the chip->base is invalid or already associated with a
1385 * different chip. Otherwise it returns zero as a success code.
1386 *
1387 * The gpio chip automatically be released when the device is unbound.
1388 */
1389int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
1390 void *data)
1391{
1392 struct gpio_chip **ptr;
1393 int ret;
1394
1395 ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
1396 GFP_KERNEL);
1397 if (!ptr)
1398 return -ENOMEM;
1399
1400 ret = gpiochip_add_data(chip, data);
1401 if (ret < 0) {
1402 devres_free(ptr);
1403 return ret;
1404 }
1405
1406 *ptr = chip;
1407 devres_add(dev, ptr);
1408
1409 return 0;
1410}
1411EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);
1412
1413/**
1414 * devm_gpiochip_remove() - Resource manager of gpiochip_remove()
1415 * @dev: device for which which resource was allocated
1416 * @chip: the chip to remove
1417 *
1418 * A gpio_chip with any GPIOs still requested may not be removed.
1419 */
1420void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip)
1421{
1422 int ret;
1423
1424 ret = devres_release(dev, devm_gpio_chip_release,
1425 devm_gpio_chip_match, chip);
1426 if (!ret)
1427 WARN_ON(ret);
1428}
1429EXPORT_SYMBOL_GPL(devm_gpiochip_remove);
1430
1431/**
1432 * gpiochip_find() - iterator for locating a specific gpio_chip
1433 * @data: data to pass to match function
1434 * @callback: Callback function to check gpio_chip
1435 *
1436 * Similar to bus_find_device. It returns a reference to a gpio_chip as
1437 * determined by a user supplied @match callback. The callback should return
1438 * 0 if the device doesn't match and non-zero if it does. If the callback is
1439 * non-zero, this function will return to the caller and not iterate over any
1440 * more gpio_chips.
1441 */
1442struct gpio_chip *gpiochip_find(void *data,
1443 int (*match)(struct gpio_chip *chip,
1444 void *data))
1445{
1446 struct gpio_device *gdev;
1447 struct gpio_chip *chip = NULL;
1448 unsigned long flags;
1449
1450 spin_lock_irqsave(&gpio_lock, flags);
1451 list_for_each_entry(gdev, &gpio_devices, list)
1452 if (gdev->chip && match(gdev->chip, data)) {
1453 chip = gdev->chip;
1454 break;
1455 }
1456
1457 spin_unlock_irqrestore(&gpio_lock, flags);
1458
1459 return chip;
1460}
1461EXPORT_SYMBOL_GPL(gpiochip_find);
1462
1463static int gpiochip_match_name(struct gpio_chip *chip, void *data)
1464{
1465 const char *name = data;
1466
1467 return !strcmp(chip->label, name);
1468}
1469
1470static struct gpio_chip *find_chip_by_name(const char *name)
1471{
1472 return gpiochip_find((void *)name, gpiochip_match_name);
1473}
1474
1475#ifdef CONFIG_GPIOLIB_IRQCHIP
1476
1477/*
1478 * The following is irqchip helper code for gpiochips.
1479 */
1480
1481static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1482{
1483 int i;
1484
1485 if (!gpiochip->irq_need_valid_mask)
1486 return 0;
1487
1488 gpiochip->irq_valid_mask = kcalloc(BITS_TO_LONGS(gpiochip->ngpio),
1489 sizeof(long), GFP_KERNEL);
1490 if (!gpiochip->irq_valid_mask)
1491 return -ENOMEM;
1492
1493 /* Assume by default all GPIOs are valid */
1494 for (i = 0; i < gpiochip->ngpio; i++)
1495 set_bit(i, gpiochip->irq_valid_mask);
1496
1497 return 0;
1498}
1499
1500static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1501{
1502 kfree(gpiochip->irq_valid_mask);
1503 gpiochip->irq_valid_mask = NULL;
1504}
1505
1506static bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
1507 unsigned int offset)
1508{
1509 /* No mask means all valid */
1510 if (likely(!gpiochip->irq_valid_mask))
1511 return true;
1512 return test_bit(offset, gpiochip->irq_valid_mask);
1513}
1514
1515/**
1516 * gpiochip_set_cascaded_irqchip() - connects a cascaded irqchip to a gpiochip
1517 * @gpiochip: the gpiochip to set the irqchip chain to
1518 * @irqchip: the irqchip to chain to the gpiochip
1519 * @parent_irq: the irq number corresponding to the parent IRQ for this
1520 * chained irqchip
1521 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1522 * coming out of the gpiochip. If the interrupt is nested rather than
1523 * cascaded, pass NULL in this handler argument
1524 */
1525static void gpiochip_set_cascaded_irqchip(struct gpio_chip *gpiochip,
1526 struct irq_chip *irqchip,
1527 int parent_irq,
1528 irq_flow_handler_t parent_handler)
1529{
1530 unsigned int offset;
1531
1532 if (!gpiochip->irqdomain) {
1533 chip_err(gpiochip, "called %s before setting up irqchip\n",
1534 __func__);
1535 return;
1536 }
1537
1538 if (parent_handler) {
1539 if (gpiochip->can_sleep) {
1540 chip_err(gpiochip,
1541 "you cannot have chained interrupts on a "
1542 "chip that may sleep\n");
1543 return;
1544 }
1545 /*
1546 * The parent irqchip is already using the chip_data for this
1547 * irqchip, so our callbacks simply use the handler_data.
1548 */
1549 irq_set_chained_handler_and_data(parent_irq, parent_handler,
1550 gpiochip);
1551
1552 gpiochip->irq_chained_parent = parent_irq;
1553 }
1554
1555 /* Set the parent IRQ for all affected IRQs */
1556 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1557 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1558 continue;
1559 irq_set_parent(irq_find_mapping(gpiochip->irqdomain, offset),
1560 parent_irq);
1561 }
1562}
1563
1564/**
1565 * gpiochip_set_chained_irqchip() - connects a chained irqchip to a gpiochip
1566 * @gpiochip: the gpiochip to set the irqchip chain to
1567 * @irqchip: the irqchip to chain to the gpiochip
1568 * @parent_irq: the irq number corresponding to the parent IRQ for this
1569 * chained irqchip
1570 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1571 * coming out of the gpiochip. If the interrupt is nested rather than
1572 * cascaded, pass NULL in this handler argument
1573 */
1574void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
1575 struct irq_chip *irqchip,
1576 int parent_irq,
1577 irq_flow_handler_t parent_handler)
1578{
1579 gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1580 parent_handler);
1581}
1582EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
1583
1584/**
1585 * gpiochip_set_nested_irqchip() - connects a nested irqchip to a gpiochip
1586 * @gpiochip: the gpiochip to set the irqchip nested handler to
1587 * @irqchip: the irqchip to nest to the gpiochip
1588 * @parent_irq: the irq number corresponding to the parent IRQ for this
1589 * nested irqchip
1590 */
1591void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip,
1592 struct irq_chip *irqchip,
1593 int parent_irq)
1594{
1595 if (!gpiochip->irq_nested) {
1596 chip_err(gpiochip, "tried to nest a chained gpiochip\n");
1597 return;
1598 }
1599 gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1600 NULL);
1601}
1602EXPORT_SYMBOL_GPL(gpiochip_set_nested_irqchip);
1603
1604/**
1605 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1606 * @d: the irqdomain used by this irqchip
1607 * @irq: the global irq number used by this GPIO irqchip irq
1608 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1609 *
1610 * This function will set up the mapping for a certain IRQ line on a
1611 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1612 * stored inside the gpiochip.
1613 */
1614static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1615 irq_hw_number_t hwirq)
1616{
1617 struct gpio_chip *chip = d->host_data;
1618
1619 irq_set_chip_data(irq, chip);
1620 /*
1621 * This lock class tells lockdep that GPIO irqs are in a different
1622 * category than their parents, so it won't report false recursion.
1623 */
1624 irq_set_lockdep_class(irq, chip->lock_key);
1625 irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
1626 /* Chips that use nested thread handlers have them marked */
1627 if (chip->irq_nested)
1628 irq_set_nested_thread(irq, 1);
1629 irq_set_noprobe(irq);
1630
1631 /*
1632 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1633 * is passed as default type.
1634 */
1635 if (chip->irq_default_type != IRQ_TYPE_NONE)
1636 irq_set_irq_type(irq, chip->irq_default_type);
1637
1638 return 0;
1639}
1640
1641static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1642{
1643 struct gpio_chip *chip = d->host_data;
1644
1645 if (chip->irq_nested)
1646 irq_set_nested_thread(irq, 0);
1647 irq_set_chip_and_handler(irq, NULL, NULL);
1648 irq_set_chip_data(irq, NULL);
1649}
1650
1651static const struct irq_domain_ops gpiochip_domain_ops = {
1652 .map = gpiochip_irq_map,
1653 .unmap = gpiochip_irq_unmap,
1654 /* Virtually all GPIO irqchips are twocell:ed */
1655 .xlate = irq_domain_xlate_twocell,
1656};
1657
1658static int gpiochip_irq_reqres(struct irq_data *d)
1659{
1660 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1661
1662 if (!try_module_get(chip->gpiodev->owner))
1663 return -ENODEV;
1664
1665 if (gpiochip_lock_as_irq(chip, d->hwirq)) {
1666 chip_err(chip,
1667 "unable to lock HW IRQ %lu for IRQ\n",
1668 d->hwirq);
1669 module_put(chip->gpiodev->owner);
1670 return -EINVAL;
1671 }
1672 return 0;
1673}
1674
1675static void gpiochip_irq_relres(struct irq_data *d)
1676{
1677 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1678
1679 gpiochip_unlock_as_irq(chip, d->hwirq);
1680 module_put(chip->gpiodev->owner);
1681}
1682
1683static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
1684{
1685 return irq_find_mapping(chip->irqdomain, offset);
1686}
1687
1688/**
1689 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1690 * @gpiochip: the gpiochip to remove the irqchip from
1691 *
1692 * This is called only from gpiochip_remove()
1693 */
1694static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
1695{
1696 unsigned int offset;
1697
1698 acpi_gpiochip_free_interrupts(gpiochip);
1699
1700 if (gpiochip->irq_chained_parent) {
1701 irq_set_chained_handler(gpiochip->irq_chained_parent, NULL);
1702 irq_set_handler_data(gpiochip->irq_chained_parent, NULL);
1703 }
1704
1705 /* Remove all IRQ mappings and delete the domain */
1706 if (gpiochip->irqdomain) {
1707 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1708 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1709 continue;
1710 irq_dispose_mapping(
1711 irq_find_mapping(gpiochip->irqdomain, offset));
1712 }
1713 irq_domain_remove(gpiochip->irqdomain);
1714 }
1715
1716 if (gpiochip->irqchip) {
1717 gpiochip->irqchip->irq_request_resources = NULL;
1718 gpiochip->irqchip->irq_release_resources = NULL;
1719 gpiochip->irqchip = NULL;
1720 }
1721
1722 gpiochip_irqchip_free_valid_mask(gpiochip);
1723}
1724
1725/**
1726 * gpiochip_irqchip_add_key() - adds an irqchip to a gpiochip
1727 * @gpiochip: the gpiochip to add the irqchip to
1728 * @irqchip: the irqchip to add to the gpiochip
1729 * @first_irq: if not dynamically assigned, the base (first) IRQ to
1730 * allocate gpiochip irqs from
1731 * @handler: the irq handler to use (often a predefined irq core function)
1732 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
1733 * to have the core avoid setting up any default type in the hardware.
1734 * @nested: whether this is a nested irqchip calling handle_nested_irq()
1735 * in its IRQ handler
1736 * @lock_key: lockdep class
1737 *
1738 * This function closely associates a certain irqchip with a certain
1739 * gpiochip, providing an irq domain to translate the local IRQs to
1740 * global irqs in the gpiolib core, and making sure that the gpiochip
1741 * is passed as chip data to all related functions. Driver callbacks
1742 * need to use gpiochip_get_data() to get their local state containers back
1743 * from the gpiochip passed as chip data. An irqdomain will be stored
1744 * in the gpiochip that shall be used by the driver to handle IRQ number
1745 * translation. The gpiochip will need to be initialized and registered
1746 * before calling this function.
1747 *
1748 * This function will handle two cell:ed simple IRQs and assumes all
1749 * the pins on the gpiochip can generate a unique IRQ. Everything else
1750 * need to be open coded.
1751 */
1752int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip,
1753 struct irq_chip *irqchip,
1754 unsigned int first_irq,
1755 irq_flow_handler_t handler,
1756 unsigned int type,
1757 bool nested,
1758 struct lock_class_key *lock_key)
1759{
1760 struct device_node *of_node;
1761 bool irq_base_set = false;
1762 unsigned int offset;
1763 unsigned irq_base = 0;
1764
1765 if (!gpiochip || !irqchip)
1766 return -EINVAL;
1767
1768 if (!gpiochip->parent) {
1769 pr_err("missing gpiochip .dev parent pointer\n");
1770 return -EINVAL;
1771 }
1772 gpiochip->irq_nested = nested;
1773 of_node = gpiochip->parent->of_node;
1774#ifdef CONFIG_OF_GPIO
1775 /*
1776 * If the gpiochip has an assigned OF node this takes precedence
1777 * FIXME: get rid of this and use gpiochip->parent->of_node
1778 * everywhere
1779 */
1780 if (gpiochip->of_node)
1781 of_node = gpiochip->of_node;
1782#endif
1783 /*
1784 * Specifying a default trigger is a terrible idea if DT or ACPI is
1785 * used to configure the interrupts, as you may end-up with
1786 * conflicting triggers. Tell the user, and reset to NONE.
1787 */
1788 if (WARN(of_node && type != IRQ_TYPE_NONE,
1789 "%s: Ignoring %d default trigger\n", of_node->full_name, type))
1790 type = IRQ_TYPE_NONE;
1791 if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
1792 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
1793 "Ignoring %d default trigger\n", type);
1794 type = IRQ_TYPE_NONE;
1795 }
1796
1797 gpiochip->irqchip = irqchip;
1798 gpiochip->irq_handler = handler;
1799 gpiochip->irq_default_type = type;
1800 gpiochip->to_irq = gpiochip_to_irq;
1801 gpiochip->lock_key = lock_key;
1802 gpiochip->irqdomain = irq_domain_add_simple(of_node,
1803 gpiochip->ngpio, first_irq,
1804 &gpiochip_domain_ops, gpiochip);
1805 if (!gpiochip->irqdomain) {
1806 gpiochip->irqchip = NULL;
1807 return -EINVAL;
1808 }
1809
1810 /*
1811 * It is possible for a driver to override this, but only if the
1812 * alternative functions are both implemented.
1813 */
1814 if (!irqchip->irq_request_resources &&
1815 !irqchip->irq_release_resources) {
1816 irqchip->irq_request_resources = gpiochip_irq_reqres;
1817 irqchip->irq_release_resources = gpiochip_irq_relres;
1818 }
1819
1820 /*
1821 * Prepare the mapping since the irqchip shall be orthogonal to
1822 * any gpiochip calls. If the first_irq was zero, this is
1823 * necessary to allocate descriptors for all IRQs.
1824 */
1825 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1826 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1827 continue;
1828 irq_base = irq_create_mapping(gpiochip->irqdomain, offset);
1829 if (!irq_base_set) {
1830 /*
1831 * Store the base into the gpiochip to be used when
1832 * unmapping the irqs.
1833 */
1834 gpiochip->irq_base = irq_base;
1835 irq_base_set = true;
1836 }
1837 }
1838
1839 acpi_gpiochip_request_interrupts(gpiochip);
1840
1841 return 0;
1842}
1843EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_key);
1844
1845#else /* CONFIG_GPIOLIB_IRQCHIP */
1846
1847static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
1848static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1849{
1850 return 0;
1851}
1852static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1853{ }
1854
1855#endif /* CONFIG_GPIOLIB_IRQCHIP */
1856
1857/**
1858 * gpiochip_generic_request() - request the gpio function for a pin
1859 * @chip: the gpiochip owning the GPIO
1860 * @offset: the offset of the GPIO to request for GPIO function
1861 */
1862int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
1863{
1864 return pinctrl_request_gpio(chip->gpiodev->base + offset);
1865}
1866EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1867
1868/**
1869 * gpiochip_generic_free() - free the gpio function from a pin
1870 * @chip: the gpiochip to request the gpio function for
1871 * @offset: the offset of the GPIO to free from GPIO function
1872 */
1873void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
1874{
1875 pinctrl_free_gpio(chip->gpiodev->base + offset);
1876}
1877EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1878
1879#ifdef CONFIG_PINCTRL
1880
1881/**
1882 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1883 * @chip: the gpiochip to add the range for
1884 * @pctldev: the pin controller to map to
1885 * @gpio_offset: the start offset in the current gpio_chip number space
1886 * @pin_group: name of the pin group inside the pin controller
1887 */
1888int gpiochip_add_pingroup_range(struct gpio_chip *chip,
1889 struct pinctrl_dev *pctldev,
1890 unsigned int gpio_offset, const char *pin_group)
1891{
1892 struct gpio_pin_range *pin_range;
1893 struct gpio_device *gdev = chip->gpiodev;
1894 int ret;
1895
1896 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1897 if (!pin_range) {
1898 chip_err(chip, "failed to allocate pin ranges\n");
1899 return -ENOMEM;
1900 }
1901
1902 /* Use local offset as range ID */
1903 pin_range->range.id = gpio_offset;
1904 pin_range->range.gc = chip;
1905 pin_range->range.name = chip->label;
1906 pin_range->range.base = gdev->base + gpio_offset;
1907 pin_range->pctldev = pctldev;
1908
1909 ret = pinctrl_get_group_pins(pctldev, pin_group,
1910 &pin_range->range.pins,
1911 &pin_range->range.npins);
1912 if (ret < 0) {
1913 kfree(pin_range);
1914 return ret;
1915 }
1916
1917 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1918
1919 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1920 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1921 pinctrl_dev_get_devname(pctldev), pin_group);
1922
1923 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1924
1925 return 0;
1926}
1927EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1928
1929/**
1930 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1931 * @chip: the gpiochip to add the range for
1932 * @pinctrl_name: the dev_name() of the pin controller to map to
1933 * @gpio_offset: the start offset in the current gpio_chip number space
1934 * @pin_offset: the start offset in the pin controller number space
1935 * @npins: the number of pins from the offset of each pin space (GPIO and
1936 * pin controller) to accumulate in this range
1937 */
1938int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
1939 unsigned int gpio_offset, unsigned int pin_offset,
1940 unsigned int npins)
1941{
1942 struct gpio_pin_range *pin_range;
1943 struct gpio_device *gdev = chip->gpiodev;
1944 int ret;
1945
1946 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1947 if (!pin_range) {
1948 chip_err(chip, "failed to allocate pin ranges\n");
1949 return -ENOMEM;
1950 }
1951
1952 /* Use local offset as range ID */
1953 pin_range->range.id = gpio_offset;
1954 pin_range->range.gc = chip;
1955 pin_range->range.name = chip->label;
1956 pin_range->range.base = gdev->base + gpio_offset;
1957 pin_range->range.pin_base = pin_offset;
1958 pin_range->range.npins = npins;
1959 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1960 &pin_range->range);
1961 if (IS_ERR(pin_range->pctldev)) {
1962 ret = PTR_ERR(pin_range->pctldev);
1963 chip_err(chip, "could not create pin range\n");
1964 kfree(pin_range);
1965 return ret;
1966 }
1967 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1968 gpio_offset, gpio_offset + npins - 1,
1969 pinctl_name,
1970 pin_offset, pin_offset + npins - 1);
1971
1972 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1973
1974 return 0;
1975}
1976EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1977
1978/**
1979 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1980 * @chip: the chip to remove all the mappings for
1981 */
1982void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
1983{
1984 struct gpio_pin_range *pin_range, *tmp;
1985 struct gpio_device *gdev = chip->gpiodev;
1986
1987 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1988 list_del(&pin_range->node);
1989 pinctrl_remove_gpio_range(pin_range->pctldev,
1990 &pin_range->range);
1991 kfree(pin_range);
1992 }
1993}
1994EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1995
1996#endif /* CONFIG_PINCTRL */
1997
1998/* These "optional" allocation calls help prevent drivers from stomping
1999 * on each other, and help provide better diagnostics in debugfs.
2000 * They're called even less than the "set direction" calls.
2001 */
2002static int __gpiod_request(struct gpio_desc *desc, const char *label)
2003{
2004 struct gpio_chip *chip = desc->gdev->chip;
2005 int status;
2006 unsigned long flags;
2007
2008 spin_lock_irqsave(&gpio_lock, flags);
2009
2010 /* NOTE: gpio_request() can be called in early boot,
2011 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
2012 */
2013
2014 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
2015 desc_set_label(desc, label ? : "?");
2016 status = 0;
2017 } else {
2018 status = -EBUSY;
2019 goto done;
2020 }
2021
2022 if (chip->request) {
2023 /* chip->request may sleep */
2024 spin_unlock_irqrestore(&gpio_lock, flags);
2025 status = chip->request(chip, gpio_chip_hwgpio(desc));
2026 spin_lock_irqsave(&gpio_lock, flags);
2027
2028 if (status < 0) {
2029 desc_set_label(desc, NULL);
2030 clear_bit(FLAG_REQUESTED, &desc->flags);
2031 goto done;
2032 }
2033 }
2034 if (chip->get_direction) {
2035 /* chip->get_direction may sleep */
2036 spin_unlock_irqrestore(&gpio_lock, flags);
2037 gpiod_get_direction(desc);
2038 spin_lock_irqsave(&gpio_lock, flags);
2039 }
2040done:
2041 spin_unlock_irqrestore(&gpio_lock, flags);
2042 return status;
2043}
2044
2045/*
2046 * This descriptor validation needs to be inserted verbatim into each
2047 * function taking a descriptor, so we need to use a preprocessor
2048 * macro to avoid endless duplication. If the desc is NULL it is an
2049 * optional GPIO and calls should just bail out.
2050 */
2051#define VALIDATE_DESC(desc) do { \
2052 if (!desc) \
2053 return 0; \
2054 if (IS_ERR(desc)) { \
2055 pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \
2056 return PTR_ERR(desc); \
2057 } \
2058 if (!desc->gdev) { \
2059 pr_warn("%s: invalid GPIO (no device)\n", __func__); \
2060 return -EINVAL; \
2061 } \
2062 if ( !desc->gdev->chip ) { \
2063 dev_warn(&desc->gdev->dev, \
2064 "%s: backing chip is gone\n", __func__); \
2065 return 0; \
2066 } } while (0)
2067
2068#define VALIDATE_DESC_VOID(desc) do { \
2069 if (!desc) \
2070 return; \
2071 if (IS_ERR(desc)) { \
2072 pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \
2073 return; \
2074 } \
2075 if (!desc->gdev) { \
2076 pr_warn("%s: invalid GPIO (no device)\n", __func__); \
2077 return; \
2078 } \
2079 if (!desc->gdev->chip) { \
2080 dev_warn(&desc->gdev->dev, \
2081 "%s: backing chip is gone\n", __func__); \
2082 return; \
2083 } } while (0)
2084
2085
2086int gpiod_request(struct gpio_desc *desc, const char *label)
2087{
2088 int status = -EPROBE_DEFER;
2089 struct gpio_device *gdev;
2090
2091 VALIDATE_DESC(desc);
2092 gdev = desc->gdev;
2093
2094 if (try_module_get(gdev->owner)) {
2095 status = __gpiod_request(desc, label);
2096 if (status < 0)
2097 module_put(gdev->owner);
2098 else
2099 get_device(&gdev->dev);
2100 }
2101
2102 if (status)
2103 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
2104
2105 return status;
2106}
2107
2108static bool __gpiod_free(struct gpio_desc *desc)
2109{
2110 bool ret = false;
2111 unsigned long flags;
2112 struct gpio_chip *chip;
2113
2114 might_sleep();
2115
2116 gpiod_unexport(desc);
2117
2118 spin_lock_irqsave(&gpio_lock, flags);
2119
2120 chip = desc->gdev->chip;
2121 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
2122 if (chip->free) {
2123 spin_unlock_irqrestore(&gpio_lock, flags);
2124 might_sleep_if(chip->can_sleep);
2125 chip->free(chip, gpio_chip_hwgpio(desc));
2126 spin_lock_irqsave(&gpio_lock, flags);
2127 }
2128 desc_set_label(desc, NULL);
2129 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2130 clear_bit(FLAG_REQUESTED, &desc->flags);
2131 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2132 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2133 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2134 ret = true;
2135 }
2136
2137 spin_unlock_irqrestore(&gpio_lock, flags);
2138 return ret;
2139}
2140
2141void gpiod_free(struct gpio_desc *desc)
2142{
2143 if (desc && desc->gdev && __gpiod_free(desc)) {
2144 module_put(desc->gdev->owner);
2145 put_device(&desc->gdev->dev);
2146 } else {
2147 WARN_ON(extra_checks);
2148 }
2149}
2150
2151/**
2152 * gpiochip_is_requested - return string iff signal was requested
2153 * @chip: controller managing the signal
2154 * @offset: of signal within controller's 0..(ngpio - 1) range
2155 *
2156 * Returns NULL if the GPIO is not currently requested, else a string.
2157 * The string returned is the label passed to gpio_request(); if none has been
2158 * passed it is a meaningless, non-NULL constant.
2159 *
2160 * This function is for use by GPIO controller drivers. The label can
2161 * help with diagnostics, and knowing that the signal is used as a GPIO
2162 * can help avoid accidentally multiplexing it to another controller.
2163 */
2164const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
2165{
2166 struct gpio_desc *desc;
2167
2168 if (offset >= chip->ngpio)
2169 return NULL;
2170
2171 desc = &chip->gpiodev->descs[offset];
2172
2173 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2174 return NULL;
2175 return desc->label;
2176}
2177EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2178
2179/**
2180 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2181 * @desc: GPIO descriptor to request
2182 * @label: label for the GPIO
2183 *
2184 * Function allows GPIO chip drivers to request and use their own GPIO
2185 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2186 * function will not increase reference count of the GPIO chip module. This
2187 * allows the GPIO chip module to be unloaded as needed (we assume that the
2188 * GPIO chip driver handles freeing the GPIOs it has requested).
2189 */
2190struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
2191 const char *label)
2192{
2193 struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
2194 int err;
2195
2196 if (IS_ERR(desc)) {
2197 chip_err(chip, "failed to get GPIO descriptor\n");
2198 return desc;
2199 }
2200
2201 err = __gpiod_request(desc, label);
2202 if (err < 0)
2203 return ERR_PTR(err);
2204
2205 return desc;
2206}
2207EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2208
2209/**
2210 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2211 * @desc: GPIO descriptor to free
2212 *
2213 * Function frees the given GPIO requested previously with
2214 * gpiochip_request_own_desc().
2215 */
2216void gpiochip_free_own_desc(struct gpio_desc *desc)
2217{
2218 if (desc)
2219 __gpiod_free(desc);
2220}
2221EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2222
2223/*
2224 * Drivers MUST set GPIO direction before making get/set calls. In
2225 * some cases this is done in early boot, before IRQs are enabled.
2226 *
2227 * As a rule these aren't called more than once (except for drivers
2228 * using the open-drain emulation idiom) so these are natural places
2229 * to accumulate extra debugging checks. Note that we can't (yet)
2230 * rely on gpio_request() having been called beforehand.
2231 */
2232
2233/**
2234 * gpiod_direction_input - set the GPIO direction to input
2235 * @desc: GPIO to set to input
2236 *
2237 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2238 * be called safely on it.
2239 *
2240 * Return 0 in case of success, else an error code.
2241 */
2242int gpiod_direction_input(struct gpio_desc *desc)
2243{
2244 struct gpio_chip *chip;
2245 int status = -EINVAL;
2246
2247 VALIDATE_DESC(desc);
2248 chip = desc->gdev->chip;
2249
2250 if (!chip->get || !chip->direction_input) {
2251 gpiod_warn(desc,
2252 "%s: missing get() or direction_input() operations\n",
2253 __func__);
2254 return -EIO;
2255 }
2256
2257 status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
2258 if (status == 0)
2259 clear_bit(FLAG_IS_OUT, &desc->flags);
2260
2261 trace_gpio_direction(desc_to_gpio(desc), 1, status);
2262
2263 return status;
2264}
2265EXPORT_SYMBOL_GPL(gpiod_direction_input);
2266
2267static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2268{
2269 struct gpio_chip *gc = desc->gdev->chip;
2270 int val = !!value;
2271 int ret;
2272
2273 /* GPIOs used for IRQs shall not be set as output */
2274 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
2275 gpiod_err(desc,
2276 "%s: tried to set a GPIO tied to an IRQ as output\n",
2277 __func__);
2278 return -EIO;
2279 }
2280
2281 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2282 /* First see if we can enable open drain in hardware */
2283 if (gc->set_single_ended) {
2284 ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
2285 LINE_MODE_OPEN_DRAIN);
2286 if (!ret)
2287 goto set_output_value;
2288 }
2289 /* Emulate open drain by not actively driving the line high */
2290 if (val)
2291 return gpiod_direction_input(desc);
2292 }
2293 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2294 if (gc->set_single_ended) {
2295 ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
2296 LINE_MODE_OPEN_SOURCE);
2297 if (!ret)
2298 goto set_output_value;
2299 }
2300 /* Emulate open source by not actively driving the line low */
2301 if (!val)
2302 return gpiod_direction_input(desc);
2303 } else {
2304 /* Make sure to disable open drain/source hardware, if any */
2305 if (gc->set_single_ended)
2306 gc->set_single_ended(gc,
2307 gpio_chip_hwgpio(desc),
2308 LINE_MODE_PUSH_PULL);
2309 }
2310
2311set_output_value:
2312 if (!gc->set || !gc->direction_output) {
2313 gpiod_warn(desc,
2314 "%s: missing set() or direction_output() operations\n",
2315 __func__);
2316 return -EIO;
2317 }
2318
2319 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2320 if (!ret)
2321 set_bit(FLAG_IS_OUT, &desc->flags);
2322 trace_gpio_value(desc_to_gpio(desc), 0, val);
2323 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2324 return ret;
2325}
2326
2327/**
2328 * gpiod_direction_output_raw - set the GPIO direction to output
2329 * @desc: GPIO to set to output
2330 * @value: initial output value of the GPIO
2331 *
2332 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2333 * be called safely on it. The initial value of the output must be specified
2334 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2335 *
2336 * Return 0 in case of success, else an error code.
2337 */
2338int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2339{
2340 VALIDATE_DESC(desc);
2341 return _gpiod_direction_output_raw(desc, value);
2342}
2343EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2344
2345/**
2346 * gpiod_direction_output - set the GPIO direction to output
2347 * @desc: GPIO to set to output
2348 * @value: initial output value of the GPIO
2349 *
2350 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2351 * be called safely on it. The initial value of the output must be specified
2352 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2353 * account.
2354 *
2355 * Return 0 in case of success, else an error code.
2356 */
2357int gpiod_direction_output(struct gpio_desc *desc, int value)
2358{
2359 VALIDATE_DESC(desc);
2360 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2361 value = !value;
2362 else
2363 value = !!value;
2364 return _gpiod_direction_output_raw(desc, value);
2365}
2366EXPORT_SYMBOL_GPL(gpiod_direction_output);
2367
2368/**
2369 * gpiod_set_debounce - sets @debounce time for a @gpio
2370 * @gpio: the gpio to set debounce time
2371 * @debounce: debounce time is microseconds
2372 *
2373 * returns -ENOTSUPP if the controller does not support setting
2374 * debounce.
2375 */
2376int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
2377{
2378 struct gpio_chip *chip;
2379
2380 VALIDATE_DESC(desc);
2381 chip = desc->gdev->chip;
2382 if (!chip->set || !chip->set_debounce) {
2383 gpiod_dbg(desc,
2384 "%s: missing set() or set_debounce() operations\n",
2385 __func__);
2386 return -ENOTSUPP;
2387 }
2388
2389 return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce);
2390}
2391EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2392
2393/**
2394 * gpiod_is_active_low - test whether a GPIO is active-low or not
2395 * @desc: the gpio descriptor to test
2396 *
2397 * Returns 1 if the GPIO is active-low, 0 otherwise.
2398 */
2399int gpiod_is_active_low(const struct gpio_desc *desc)
2400{
2401 VALIDATE_DESC(desc);
2402 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2403}
2404EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2405
2406/* I/O calls are only valid after configuration completed; the relevant
2407 * "is this a valid GPIO" error checks should already have been done.
2408 *
2409 * "Get" operations are often inlinable as reading a pin value register,
2410 * and masking the relevant bit in that register.
2411 *
2412 * When "set" operations are inlinable, they involve writing that mask to
2413 * one register to set a low value, or a different register to set it high.
2414 * Otherwise locking is needed, so there may be little value to inlining.
2415 *
2416 *------------------------------------------------------------------------
2417 *
2418 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2419 * have requested the GPIO. That can include implicit requesting by
2420 * a direction setting call. Marking a gpio as requested locks its chip
2421 * in memory, guaranteeing that these table lookups need no more locking
2422 * and that gpiochip_remove() will fail.
2423 *
2424 * REVISIT when debugging, consider adding some instrumentation to ensure
2425 * that the GPIO was actually requested.
2426 */
2427
2428static int _gpiod_get_raw_value(const struct gpio_desc *desc)
2429{
2430 struct gpio_chip *chip;
2431 int offset;
2432 int value;
2433
2434 chip = desc->gdev->chip;
2435 offset = gpio_chip_hwgpio(desc);
2436 value = chip->get ? chip->get(chip, offset) : -EIO;
2437 value = value < 0 ? value : !!value;
2438 trace_gpio_value(desc_to_gpio(desc), 1, value);
2439 return value;
2440}
2441
2442/**
2443 * gpiod_get_raw_value() - return a gpio's raw value
2444 * @desc: gpio whose value will be returned
2445 *
2446 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2447 * its ACTIVE_LOW status, or negative errno on failure.
2448 *
2449 * This function should be called from contexts where we cannot sleep, and will
2450 * complain if the GPIO chip functions potentially sleep.
2451 */
2452int gpiod_get_raw_value(const struct gpio_desc *desc)
2453{
2454 VALIDATE_DESC(desc);
2455 /* Should be using gpio_get_value_cansleep() */
2456 WARN_ON(desc->gdev->chip->can_sleep);
2457 return _gpiod_get_raw_value(desc);
2458}
2459EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2460
2461/**
2462 * gpiod_get_value() - return a gpio's value
2463 * @desc: gpio whose value will be returned
2464 *
2465 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2466 * account, or negative errno on failure.
2467 *
2468 * This function should be called from contexts where we cannot sleep, and will
2469 * complain if the GPIO chip functions potentially sleep.
2470 */
2471int gpiod_get_value(const struct gpio_desc *desc)
2472{
2473 int value;
2474
2475 VALIDATE_DESC(desc);
2476 /* Should be using gpio_get_value_cansleep() */
2477 WARN_ON(desc->gdev->chip->can_sleep);
2478
2479 value = _gpiod_get_raw_value(desc);
2480 if (value < 0)
2481 return value;
2482
2483 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2484 value = !value;
2485
2486 return value;
2487}
2488EXPORT_SYMBOL_GPL(gpiod_get_value);
2489
2490/*
2491 * _gpio_set_open_drain_value() - Set the open drain gpio's value.
2492 * @desc: gpio descriptor whose state need to be set.
2493 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2494 */
2495static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
2496{
2497 int err = 0;
2498 struct gpio_chip *chip = desc->gdev->chip;
2499 int offset = gpio_chip_hwgpio(desc);
2500
2501 if (value) {
2502 err = chip->direction_input(chip, offset);
2503 if (!err)
2504 clear_bit(FLAG_IS_OUT, &desc->flags);
2505 } else {
2506 err = chip->direction_output(chip, offset, 0);
2507 if (!err)
2508 set_bit(FLAG_IS_OUT, &desc->flags);
2509 }
2510 trace_gpio_direction(desc_to_gpio(desc), value, err);
2511 if (err < 0)
2512 gpiod_err(desc,
2513 "%s: Error in set_value for open drain err %d\n",
2514 __func__, err);
2515}
2516
2517/*
2518 * _gpio_set_open_source_value() - Set the open source gpio's value.
2519 * @desc: gpio descriptor whose state need to be set.
2520 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2521 */
2522static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
2523{
2524 int err = 0;
2525 struct gpio_chip *chip = desc->gdev->chip;
2526 int offset = gpio_chip_hwgpio(desc);
2527
2528 if (value) {
2529 err = chip->direction_output(chip, offset, 1);
2530 if (!err)
2531 set_bit(FLAG_IS_OUT, &desc->flags);
2532 } else {
2533 err = chip->direction_input(chip, offset);
2534 if (!err)
2535 clear_bit(FLAG_IS_OUT, &desc->flags);
2536 }
2537 trace_gpio_direction(desc_to_gpio(desc), !value, err);
2538 if (err < 0)
2539 gpiod_err(desc,
2540 "%s: Error in set_value for open source err %d\n",
2541 __func__, err);
2542}
2543
2544static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
2545{
2546 struct gpio_chip *chip;
2547
2548 chip = desc->gdev->chip;
2549 trace_gpio_value(desc_to_gpio(desc), 0, value);
2550 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2551 _gpio_set_open_drain_value(desc, value);
2552 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2553 _gpio_set_open_source_value(desc, value);
2554 else
2555 chip->set(chip, gpio_chip_hwgpio(desc), value);
2556}
2557
2558/*
2559 * set multiple outputs on the same chip;
2560 * use the chip's set_multiple function if available;
2561 * otherwise set the outputs sequentially;
2562 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2563 * defines which outputs are to be changed
2564 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2565 * defines the values the outputs specified by mask are to be set to
2566 */
2567static void gpio_chip_set_multiple(struct gpio_chip *chip,
2568 unsigned long *mask, unsigned long *bits)
2569{
2570 if (chip->set_multiple) {
2571 chip->set_multiple(chip, mask, bits);
2572 } else {
2573 int i;
2574 for (i = 0; i < chip->ngpio; i++) {
2575 if (mask[BIT_WORD(i)] == 0) {
2576 /* no more set bits in this mask word;
2577 * skip ahead to the next word */
2578 i = (BIT_WORD(i) + 1) * BITS_PER_LONG - 1;
2579 continue;
2580 }
2581 /* set outputs if the corresponding mask bit is set */
2582 if (__test_and_clear_bit(i, mask))
2583 chip->set(chip, i, test_bit(i, bits));
2584 }
2585 }
2586}
2587
2588void gpiod_set_array_value_complex(bool raw, bool can_sleep,
2589 unsigned int array_size,
2590 struct gpio_desc **desc_array,
2591 int *value_array)
2592{
2593 int i = 0;
2594
2595 while (i < array_size) {
2596 struct gpio_chip *chip = desc_array[i]->gdev->chip;
2597 unsigned long mask[BITS_TO_LONGS(chip->ngpio)];
2598 unsigned long bits[BITS_TO_LONGS(chip->ngpio)];
2599 int count = 0;
2600
2601 if (!can_sleep)
2602 WARN_ON(chip->can_sleep);
2603
2604 memset(mask, 0, sizeof(mask));
2605 do {
2606 struct gpio_desc *desc = desc_array[i];
2607 int hwgpio = gpio_chip_hwgpio(desc);
2608 int value = value_array[i];
2609
2610 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2611 value = !value;
2612 trace_gpio_value(desc_to_gpio(desc), 0, value);
2613 /*
2614 * collect all normal outputs belonging to the same chip
2615 * open drain and open source outputs are set individually
2616 */
2617 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2618 _gpio_set_open_drain_value(desc, value);
2619 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2620 _gpio_set_open_source_value(desc, value);
2621 } else {
2622 __set_bit(hwgpio, mask);
2623 if (value)
2624 __set_bit(hwgpio, bits);
2625 else
2626 __clear_bit(hwgpio, bits);
2627 count++;
2628 }
2629 i++;
2630 } while ((i < array_size) &&
2631 (desc_array[i]->gdev->chip == chip));
2632 /* push collected bits to outputs */
2633 if (count != 0)
2634 gpio_chip_set_multiple(chip, mask, bits);
2635 }
2636}
2637
2638/**
2639 * gpiod_set_raw_value() - assign a gpio's raw value
2640 * @desc: gpio whose value will be assigned
2641 * @value: value to assign
2642 *
2643 * Set the raw value of the GPIO, i.e. the value of its physical line without
2644 * regard for its ACTIVE_LOW status.
2645 *
2646 * This function should be called from contexts where we cannot sleep, and will
2647 * complain if the GPIO chip functions potentially sleep.
2648 */
2649void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2650{
2651 VALIDATE_DESC_VOID(desc);
2652 /* Should be using gpiod_set_value_cansleep() */
2653 WARN_ON(desc->gdev->chip->can_sleep);
2654 _gpiod_set_raw_value(desc, value);
2655}
2656EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2657
2658/**
2659 * gpiod_set_value() - assign a gpio's value
2660 * @desc: gpio whose value will be assigned
2661 * @value: value to assign
2662 *
2663 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2664 * account
2665 *
2666 * This function should be called from contexts where we cannot sleep, and will
2667 * complain if the GPIO chip functions potentially sleep.
2668 */
2669void gpiod_set_value(struct gpio_desc *desc, int value)
2670{
2671 VALIDATE_DESC_VOID(desc);
2672 /* Should be using gpiod_set_value_cansleep() */
2673 WARN_ON(desc->gdev->chip->can_sleep);
2674 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2675 value = !value;
2676 _gpiod_set_raw_value(desc, value);
2677}
2678EXPORT_SYMBOL_GPL(gpiod_set_value);
2679
2680/**
2681 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2682 * @array_size: number of elements in the descriptor / value arrays
2683 * @desc_array: array of GPIO descriptors whose values will be assigned
2684 * @value_array: array of values to assign
2685 *
2686 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2687 * without regard for their ACTIVE_LOW status.
2688 *
2689 * This function should be called from contexts where we cannot sleep, and will
2690 * complain if the GPIO chip functions potentially sleep.
2691 */
2692void gpiod_set_raw_array_value(unsigned int array_size,
2693 struct gpio_desc **desc_array, int *value_array)
2694{
2695 if (!desc_array)
2696 return;
2697 gpiod_set_array_value_complex(true, false, array_size, desc_array,
2698 value_array);
2699}
2700EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
2701
2702/**
2703 * gpiod_set_array_value() - assign values to an array of GPIOs
2704 * @array_size: number of elements in the descriptor / value arrays
2705 * @desc_array: array of GPIO descriptors whose values will be assigned
2706 * @value_array: array of values to assign
2707 *
2708 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2709 * into account.
2710 *
2711 * This function should be called from contexts where we cannot sleep, and will
2712 * complain if the GPIO chip functions potentially sleep.
2713 */
2714void gpiod_set_array_value(unsigned int array_size,
2715 struct gpio_desc **desc_array, int *value_array)
2716{
2717 if (!desc_array)
2718 return;
2719 gpiod_set_array_value_complex(false, false, array_size, desc_array,
2720 value_array);
2721}
2722EXPORT_SYMBOL_GPL(gpiod_set_array_value);
2723
2724/**
2725 * gpiod_cansleep() - report whether gpio value access may sleep
2726 * @desc: gpio to check
2727 *
2728 */
2729int gpiod_cansleep(const struct gpio_desc *desc)
2730{
2731 VALIDATE_DESC(desc);
2732 return desc->gdev->chip->can_sleep;
2733}
2734EXPORT_SYMBOL_GPL(gpiod_cansleep);
2735
2736/**
2737 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
2738 * @desc: gpio whose IRQ will be returned (already requested)
2739 *
2740 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
2741 * error.
2742 */
2743int gpiod_to_irq(const struct gpio_desc *desc)
2744{
2745 struct gpio_chip *chip;
2746 int offset;
2747
2748 /*
2749 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
2750 * requires this function to not return zero on an invalid descriptor
2751 * but rather a negative error number.
2752 */
2753 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
2754 return -EINVAL;
2755
2756 chip = desc->gdev->chip;
2757 offset = gpio_chip_hwgpio(desc);
2758 if (chip->to_irq) {
2759 int retirq = chip->to_irq(chip, offset);
2760
2761 /* Zero means NO_IRQ */
2762 if (!retirq)
2763 return -ENXIO;
2764
2765 return retirq;
2766 }
2767 return -ENXIO;
2768}
2769EXPORT_SYMBOL_GPL(gpiod_to_irq);
2770
2771/**
2772 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
2773 * @chip: the chip the GPIO to lock belongs to
2774 * @offset: the offset of the GPIO to lock as IRQ
2775 *
2776 * This is used directly by GPIO drivers that want to lock down
2777 * a certain GPIO line to be used for IRQs.
2778 */
2779int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
2780{
2781 struct gpio_desc *desc;
2782
2783 desc = gpiochip_get_desc(chip, offset);
2784 if (IS_ERR(desc))
2785 return PTR_ERR(desc);
2786
2787 /*
2788 * If it's fast: flush the direction setting if something changed
2789 * behind our back
2790 */
2791 if (!chip->can_sleep && chip->get_direction) {
2792 int dir = chip->get_direction(chip, offset);
2793
2794 if (dir)
2795 clear_bit(FLAG_IS_OUT, &desc->flags);
2796 else
2797 set_bit(FLAG_IS_OUT, &desc->flags);
2798 }
2799
2800 if (test_bit(FLAG_IS_OUT, &desc->flags)) {
2801 chip_err(chip,
2802 "%s: tried to flag a GPIO set as output for IRQ\n",
2803 __func__);
2804 return -EIO;
2805 }
2806
2807 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
2808
2809 /*
2810 * If the consumer has not set up a label (such as when the
2811 * IRQ is referenced from .to_irq()) we set up a label here
2812 * so it is clear this is used as an interrupt.
2813 */
2814 if (!desc->label)
2815 desc_set_label(desc, "interrupt");
2816
2817 return 0;
2818}
2819EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
2820
2821/**
2822 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
2823 * @chip: the chip the GPIO to lock belongs to
2824 * @offset: the offset of the GPIO to lock as IRQ
2825 *
2826 * This is used directly by GPIO drivers that want to indicate
2827 * that a certain GPIO is no longer used exclusively for IRQ.
2828 */
2829void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
2830{
2831 struct gpio_desc *desc;
2832
2833 desc = gpiochip_get_desc(chip, offset);
2834 if (IS_ERR(desc))
2835 return;
2836
2837 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
2838
2839 /* If we only had this marking, erase it */
2840 if (desc->label && !strcmp(desc->label, "interrupt"))
2841 desc_set_label(desc, NULL);
2842}
2843EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
2844
2845bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
2846{
2847 if (offset >= chip->ngpio)
2848 return false;
2849
2850 return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
2851}
2852EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
2853
2854bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
2855{
2856 if (offset >= chip->ngpio)
2857 return false;
2858
2859 return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
2860}
2861EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
2862
2863bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
2864{
2865 if (offset >= chip->ngpio)
2866 return false;
2867
2868 return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
2869}
2870EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
2871
2872/**
2873 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
2874 * @desc: gpio whose value will be returned
2875 *
2876 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2877 * its ACTIVE_LOW status, or negative errno on failure.
2878 *
2879 * This function is to be called from contexts that can sleep.
2880 */
2881int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
2882{
2883 might_sleep_if(extra_checks);
2884 VALIDATE_DESC(desc);
2885 return _gpiod_get_raw_value(desc);
2886}
2887EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
2888
2889/**
2890 * gpiod_get_value_cansleep() - return a gpio's value
2891 * @desc: gpio whose value will be returned
2892 *
2893 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2894 * account, or negative errno on failure.
2895 *
2896 * This function is to be called from contexts that can sleep.
2897 */
2898int gpiod_get_value_cansleep(const struct gpio_desc *desc)
2899{
2900 int value;
2901
2902 might_sleep_if(extra_checks);
2903 VALIDATE_DESC(desc);
2904 value = _gpiod_get_raw_value(desc);
2905 if (value < 0)
2906 return value;
2907
2908 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2909 value = !value;
2910
2911 return value;
2912}
2913EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
2914
2915/**
2916 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
2917 * @desc: gpio whose value will be assigned
2918 * @value: value to assign
2919 *
2920 * Set the raw value of the GPIO, i.e. the value of its physical line without
2921 * regard for its ACTIVE_LOW status.
2922 *
2923 * This function is to be called from contexts that can sleep.
2924 */
2925void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
2926{
2927 might_sleep_if(extra_checks);
2928 VALIDATE_DESC_VOID(desc);
2929 _gpiod_set_raw_value(desc, value);
2930}
2931EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
2932
2933/**
2934 * gpiod_set_value_cansleep() - assign a gpio's value
2935 * @desc: gpio whose value will be assigned
2936 * @value: value to assign
2937 *
2938 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2939 * account
2940 *
2941 * This function is to be called from contexts that can sleep.
2942 */
2943void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
2944{
2945 might_sleep_if(extra_checks);
2946 VALIDATE_DESC_VOID(desc);
2947 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2948 value = !value;
2949 _gpiod_set_raw_value(desc, value);
2950}
2951EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
2952
2953/**
2954 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
2955 * @array_size: number of elements in the descriptor / value arrays
2956 * @desc_array: array of GPIO descriptors whose values will be assigned
2957 * @value_array: array of values to assign
2958 *
2959 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2960 * without regard for their ACTIVE_LOW status.
2961 *
2962 * This function is to be called from contexts that can sleep.
2963 */
2964void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
2965 struct gpio_desc **desc_array,
2966 int *value_array)
2967{
2968 might_sleep_if(extra_checks);
2969 if (!desc_array)
2970 return;
2971 gpiod_set_array_value_complex(true, true, array_size, desc_array,
2972 value_array);
2973}
2974EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
2975
2976/**
2977 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
2978 * @array_size: number of elements in the descriptor / value arrays
2979 * @desc_array: array of GPIO descriptors whose values will be assigned
2980 * @value_array: array of values to assign
2981 *
2982 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2983 * into account.
2984 *
2985 * This function is to be called from contexts that can sleep.
2986 */
2987void gpiod_set_array_value_cansleep(unsigned int array_size,
2988 struct gpio_desc **desc_array,
2989 int *value_array)
2990{
2991 might_sleep_if(extra_checks);
2992 if (!desc_array)
2993 return;
2994 gpiod_set_array_value_complex(false, true, array_size, desc_array,
2995 value_array);
2996}
2997EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
2998
2999/**
3000 * gpiod_add_lookup_table() - register GPIO device consumers
3001 * @table: table of consumers to register
3002 */
3003void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3004{
3005 mutex_lock(&gpio_lookup_lock);
3006
3007 list_add_tail(&table->list, &gpio_lookup_list);
3008
3009 mutex_unlock(&gpio_lookup_lock);
3010}
3011
3012/**
3013 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3014 * @table: table of consumers to unregister
3015 */
3016void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3017{
3018 mutex_lock(&gpio_lookup_lock);
3019
3020 list_del(&table->list);
3021
3022 mutex_unlock(&gpio_lookup_lock);
3023}
3024
3025static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3026{
3027 const char *dev_id = dev ? dev_name(dev) : NULL;
3028 struct gpiod_lookup_table *table;
3029
3030 mutex_lock(&gpio_lookup_lock);
3031
3032 list_for_each_entry(table, &gpio_lookup_list, list) {
3033 if (table->dev_id && dev_id) {
3034 /*
3035 * Valid strings on both ends, must be identical to have
3036 * a match
3037 */
3038 if (!strcmp(table->dev_id, dev_id))
3039 goto found;
3040 } else {
3041 /*
3042 * One of the pointers is NULL, so both must be to have
3043 * a match
3044 */
3045 if (dev_id == table->dev_id)
3046 goto found;
3047 }
3048 }
3049 table = NULL;
3050
3051found:
3052 mutex_unlock(&gpio_lookup_lock);
3053 return table;
3054}
3055
3056static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3057 unsigned int idx,
3058 enum gpio_lookup_flags *flags)
3059{
3060 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3061 struct gpiod_lookup_table *table;
3062 struct gpiod_lookup *p;
3063
3064 table = gpiod_find_lookup_table(dev);
3065 if (!table)
3066 return desc;
3067
3068 for (p = &table->table[0]; p->chip_label; p++) {
3069 struct gpio_chip *chip;
3070
3071 /* idx must always match exactly */
3072 if (p->idx != idx)
3073 continue;
3074
3075 /* If the lookup entry has a con_id, require exact match */
3076 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3077 continue;
3078
3079 chip = find_chip_by_name(p->chip_label);
3080
3081 if (!chip) {
3082 dev_err(dev, "cannot find GPIO chip %s\n",
3083 p->chip_label);
3084 return ERR_PTR(-ENODEV);
3085 }
3086
3087 if (chip->ngpio <= p->chip_hwnum) {
3088 dev_err(dev,
3089 "requested GPIO %d is out of range [0..%d] for chip %s\n",
3090 idx, chip->ngpio, chip->label);
3091 return ERR_PTR(-EINVAL);
3092 }
3093
3094 desc = gpiochip_get_desc(chip, p->chip_hwnum);
3095 *flags = p->flags;
3096
3097 return desc;
3098 }
3099
3100 return desc;
3101}
3102
3103static int dt_gpio_count(struct device *dev, const char *con_id)
3104{
3105 int ret;
3106 char propname[32];
3107 unsigned int i;
3108
3109 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3110 if (con_id)
3111 snprintf(propname, sizeof(propname), "%s-%s",
3112 con_id, gpio_suffixes[i]);
3113 else
3114 snprintf(propname, sizeof(propname), "%s",
3115 gpio_suffixes[i]);
3116
3117 ret = of_gpio_named_count(dev->of_node, propname);
3118 if (ret >= 0)
3119 break;
3120 }
3121 return ret;
3122}
3123
3124static int platform_gpio_count(struct device *dev, const char *con_id)
3125{
3126 struct gpiod_lookup_table *table;
3127 struct gpiod_lookup *p;
3128 unsigned int count = 0;
3129
3130 table = gpiod_find_lookup_table(dev);
3131 if (!table)
3132 return -ENOENT;
3133
3134 for (p = &table->table[0]; p->chip_label; p++) {
3135 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3136 (!con_id && !p->con_id))
3137 count++;
3138 }
3139 if (!count)
3140 return -ENOENT;
3141
3142 return count;
3143}
3144
3145/**
3146 * gpiod_count - return the number of GPIOs associated with a device / function
3147 * or -ENOENT if no GPIO has been assigned to the requested function
3148 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3149 * @con_id: function within the GPIO consumer
3150 */
3151int gpiod_count(struct device *dev, const char *con_id)
3152{
3153 int count = -ENOENT;
3154
3155 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3156 count = dt_gpio_count(dev, con_id);
3157 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3158 count = acpi_gpio_count(dev, con_id);
3159
3160 if (count < 0)
3161 count = platform_gpio_count(dev, con_id);
3162
3163 return count;
3164}
3165EXPORT_SYMBOL_GPL(gpiod_count);
3166
3167/**
3168 * gpiod_get - obtain a GPIO for a given GPIO function
3169 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3170 * @con_id: function within the GPIO consumer
3171 * @flags: optional GPIO initialization flags
3172 *
3173 * Return the GPIO descriptor corresponding to the function con_id of device
3174 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3175 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3176 */
3177struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3178 enum gpiod_flags flags)
3179{
3180 return gpiod_get_index(dev, con_id, 0, flags);
3181}
3182EXPORT_SYMBOL_GPL(gpiod_get);
3183
3184/**
3185 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3186 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3187 * @con_id: function within the GPIO consumer
3188 * @flags: optional GPIO initialization flags
3189 *
3190 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3191 * the requested function it will return NULL. This is convenient for drivers
3192 * that need to handle optional GPIOs.
3193 */
3194struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3195 const char *con_id,
3196 enum gpiod_flags flags)
3197{
3198 return gpiod_get_index_optional(dev, con_id, 0, flags);
3199}
3200EXPORT_SYMBOL_GPL(gpiod_get_optional);
3201
3202
3203/**
3204 * gpiod_configure_flags - helper function to configure a given GPIO
3205 * @desc: gpio whose value will be assigned
3206 * @con_id: function within the GPIO consumer
3207 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
3208 * of_get_gpio_hog()
3209 * @dflags: gpiod_flags - optional GPIO initialization flags
3210 *
3211 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3212 * requested function and/or index, or another IS_ERR() code if an error
3213 * occurred while trying to acquire the GPIO.
3214 */
3215static int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3216 unsigned long lflags, enum gpiod_flags dflags)
3217{
3218 int status;
3219
3220 if (lflags & GPIO_ACTIVE_LOW)
3221 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3222 if (lflags & GPIO_OPEN_DRAIN)
3223 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3224 if (lflags & GPIO_OPEN_SOURCE)
3225 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3226
3227 /* No particular flag request, return here... */
3228 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3229 pr_debug("no flags found for %s\n", con_id);
3230 return 0;
3231 }
3232
3233 /* Process flags */
3234 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3235 status = gpiod_direction_output(desc,
3236 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3237 else
3238 status = gpiod_direction_input(desc);
3239
3240 return status;
3241}
3242
3243/**
3244 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3245 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3246 * @con_id: function within the GPIO consumer
3247 * @idx: index of the GPIO to obtain in the consumer
3248 * @flags: optional GPIO initialization flags
3249 *
3250 * This variant of gpiod_get() allows to access GPIOs other than the first
3251 * defined one for functions that define several GPIOs.
3252 *
3253 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3254 * requested function and/or index, or another IS_ERR() code if an error
3255 * occurred while trying to acquire the GPIO.
3256 */
3257struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3258 const char *con_id,
3259 unsigned int idx,
3260 enum gpiod_flags flags)
3261{
3262 struct gpio_desc *desc = NULL;
3263 int status;
3264 enum gpio_lookup_flags lookupflags = 0;
3265
3266 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3267
3268 if (dev) {
3269 /* Using device tree? */
3270 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3271 dev_dbg(dev, "using device tree for GPIO lookup\n");
3272 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3273 } else if (ACPI_COMPANION(dev)) {
3274 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3275 desc = acpi_find_gpio(dev, con_id, idx, flags, &lookupflags);
3276 }
3277 }
3278
3279 /*
3280 * Either we are not using DT or ACPI, or their lookup did not return
3281 * a result. In that case, use platform lookup as a fallback.
3282 */
3283 if (!desc || desc == ERR_PTR(-ENOENT)) {
3284 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3285 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3286 }
3287
3288 if (IS_ERR(desc)) {
3289 dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
3290 return desc;
3291 }
3292
3293 status = gpiod_request(desc, con_id);
3294 if (status < 0)
3295 return ERR_PTR(status);
3296
3297 status = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3298 if (status < 0) {
3299 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3300 gpiod_put(desc);
3301 return ERR_PTR(status);
3302 }
3303
3304 return desc;
3305}
3306EXPORT_SYMBOL_GPL(gpiod_get_index);
3307
3308/**
3309 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3310 * @fwnode: handle of the firmware node
3311 * @propname: name of the firmware property representing the GPIO
3312 *
3313 * This function can be used for drivers that get their configuration
3314 * from firmware.
3315 *
3316 * Function properly finds the corresponding GPIO using whatever is the
3317 * underlying firmware interface and then makes sure that the GPIO
3318 * descriptor is requested before it is returned to the caller.
3319 *
3320 * In case of error an ERR_PTR() is returned.
3321 */
3322struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3323 const char *propname)
3324{
3325 struct gpio_desc *desc = ERR_PTR(-ENODEV);
3326 bool active_low = false;
3327 bool single_ended = false;
3328 int ret;
3329
3330 if (!fwnode)
3331 return ERR_PTR(-EINVAL);
3332
3333 if (is_of_node(fwnode)) {
3334 enum of_gpio_flags flags;
3335
3336 desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname, 0,
3337 &flags);
3338 if (!IS_ERR(desc)) {
3339 active_low = flags & OF_GPIO_ACTIVE_LOW;
3340 single_ended = flags & OF_GPIO_SINGLE_ENDED;
3341 }
3342 } else if (is_acpi_node(fwnode)) {
3343 struct acpi_gpio_info info;
3344
3345 desc = acpi_node_get_gpiod(fwnode, propname, 0, &info);
3346 if (!IS_ERR(desc))
3347 active_low = info.polarity == GPIO_ACTIVE_LOW;
3348 }
3349
3350 if (IS_ERR(desc))
3351 return desc;
3352
3353 ret = gpiod_request(desc, NULL);
3354 if (ret)
3355 return ERR_PTR(ret);
3356
3357 if (active_low)
3358 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3359
3360 if (single_ended) {
3361 if (active_low)
3362 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3363 else
3364 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3365 }
3366
3367 return desc;
3368}
3369EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3370
3371/**
3372 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3373 * function
3374 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3375 * @con_id: function within the GPIO consumer
3376 * @index: index of the GPIO to obtain in the consumer
3377 * @flags: optional GPIO initialization flags
3378 *
3379 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3380 * specified index was assigned to the requested function it will return NULL.
3381 * This is convenient for drivers that need to handle optional GPIOs.
3382 */
3383struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
3384 const char *con_id,
3385 unsigned int index,
3386 enum gpiod_flags flags)
3387{
3388 struct gpio_desc *desc;
3389
3390 desc = gpiod_get_index(dev, con_id, index, flags);
3391 if (IS_ERR(desc)) {
3392 if (PTR_ERR(desc) == -ENOENT)
3393 return NULL;
3394 }
3395
3396 return desc;
3397}
3398EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
3399
3400/**
3401 * gpiod_hog - Hog the specified GPIO desc given the provided flags
3402 * @desc: gpio whose value will be assigned
3403 * @name: gpio line name
3404 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
3405 * of_get_gpio_hog()
3406 * @dflags: gpiod_flags - optional GPIO initialization flags
3407 */
3408int gpiod_hog(struct gpio_desc *desc, const char *name,
3409 unsigned long lflags, enum gpiod_flags dflags)
3410{
3411 struct gpio_chip *chip;
3412 struct gpio_desc *local_desc;
3413 int hwnum;
3414 int status;
3415
3416 chip = gpiod_to_chip(desc);
3417 hwnum = gpio_chip_hwgpio(desc);
3418
3419 local_desc = gpiochip_request_own_desc(chip, hwnum, name);
3420 if (IS_ERR(local_desc)) {
3421 status = PTR_ERR(local_desc);
3422 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
3423 name, chip->label, hwnum, status);
3424 return status;
3425 }
3426
3427 status = gpiod_configure_flags(desc, name, lflags, dflags);
3428 if (status < 0) {
3429 pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n",
3430 name, chip->label, hwnum, status);
3431 gpiochip_free_own_desc(desc);
3432 return status;
3433 }
3434
3435 /* Mark GPIO as hogged so it can be identified and removed later */
3436 set_bit(FLAG_IS_HOGGED, &desc->flags);
3437
3438 pr_info("GPIO line %d (%s) hogged as %s%s\n",
3439 desc_to_gpio(desc), name,
3440 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
3441 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
3442 (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
3443
3444 return 0;
3445}
3446
3447/**
3448 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
3449 * @chip: gpio chip to act on
3450 *
3451 * This is only used by of_gpiochip_remove to free hogged gpios
3452 */
3453static void gpiochip_free_hogs(struct gpio_chip *chip)
3454{
3455 int id;
3456
3457 for (id = 0; id < chip->ngpio; id++) {
3458 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
3459 gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
3460 }
3461}
3462
3463/**
3464 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
3465 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3466 * @con_id: function within the GPIO consumer
3467 * @flags: optional GPIO initialization flags
3468 *
3469 * This function acquires all the GPIOs defined under a given function.
3470 *
3471 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
3472 * no GPIO has been assigned to the requested function, or another IS_ERR()
3473 * code if an error occurred while trying to acquire the GPIOs.
3474 */
3475struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
3476 const char *con_id,
3477 enum gpiod_flags flags)
3478{
3479 struct gpio_desc *desc;
3480 struct gpio_descs *descs;
3481 int count;
3482
3483 count = gpiod_count(dev, con_id);
3484 if (count < 0)
3485 return ERR_PTR(count);
3486
3487 descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count,
3488 GFP_KERNEL);
3489 if (!descs)
3490 return ERR_PTR(-ENOMEM);
3491
3492 for (descs->ndescs = 0; descs->ndescs < count; ) {
3493 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
3494 if (IS_ERR(desc)) {
3495 gpiod_put_array(descs);
3496 return ERR_CAST(desc);
3497 }
3498 descs->desc[descs->ndescs] = desc;
3499 descs->ndescs++;
3500 }
3501 return descs;
3502}
3503EXPORT_SYMBOL_GPL(gpiod_get_array);
3504
3505/**
3506 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
3507 * function
3508 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3509 * @con_id: function within the GPIO consumer
3510 * @flags: optional GPIO initialization flags
3511 *
3512 * This is equivalent to gpiod_get_array(), except that when no GPIO was
3513 * assigned to the requested function it will return NULL.
3514 */
3515struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
3516 const char *con_id,
3517 enum gpiod_flags flags)
3518{
3519 struct gpio_descs *descs;
3520
3521 descs = gpiod_get_array(dev, con_id, flags);
3522 if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
3523 return NULL;
3524
3525 return descs;
3526}
3527EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
3528
3529/**
3530 * gpiod_put - dispose of a GPIO descriptor
3531 * @desc: GPIO descriptor to dispose of
3532 *
3533 * No descriptor can be used after gpiod_put() has been called on it.
3534 */
3535void gpiod_put(struct gpio_desc *desc)
3536{
3537 gpiod_free(desc);
3538}
3539EXPORT_SYMBOL_GPL(gpiod_put);
3540
3541/**
3542 * gpiod_put_array - dispose of multiple GPIO descriptors
3543 * @descs: struct gpio_descs containing an array of descriptors
3544 */
3545void gpiod_put_array(struct gpio_descs *descs)
3546{
3547 unsigned int i;
3548
3549 for (i = 0; i < descs->ndescs; i++)
3550 gpiod_put(descs->desc[i]);
3551
3552 kfree(descs);
3553}
3554EXPORT_SYMBOL_GPL(gpiod_put_array);
3555
3556static int __init gpiolib_dev_init(void)
3557{
3558 int ret;
3559
3560 /* Register GPIO sysfs bus */
3561 ret = bus_register(&gpio_bus_type);
3562 if (ret < 0) {
3563 pr_err("gpiolib: could not register GPIO bus type\n");
3564 return ret;
3565 }
3566
3567 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
3568 if (ret < 0) {
3569 pr_err("gpiolib: failed to allocate char dev region\n");
3570 bus_unregister(&gpio_bus_type);
3571 } else {
3572 gpiolib_initialized = true;
3573 gpiochip_setup_devs();
3574 }
3575 return ret;
3576}
3577core_initcall(gpiolib_dev_init);
3578
3579#ifdef CONFIG_DEBUG_FS
3580
3581static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
3582{
3583 unsigned i;
3584 struct gpio_chip *chip = gdev->chip;
3585 unsigned gpio = gdev->base;
3586 struct gpio_desc *gdesc = &gdev->descs[0];
3587 int is_out;
3588 int is_irq;
3589
3590 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
3591 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
3592 if (gdesc->name) {
3593 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
3594 gpio, gdesc->name);
3595 }
3596 continue;
3597 }
3598
3599 gpiod_get_direction(gdesc);
3600 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
3601 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
3602 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
3603 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
3604 is_out ? "out" : "in ",
3605 chip->get
3606 ? (chip->get(chip, i) ? "hi" : "lo")
3607 : "? ",
3608 is_irq ? "IRQ" : " ");
3609 seq_printf(s, "\n");
3610 }
3611}
3612
3613static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
3614{
3615 unsigned long flags;
3616 struct gpio_device *gdev = NULL;
3617 loff_t index = *pos;
3618
3619 s->private = "";
3620
3621 spin_lock_irqsave(&gpio_lock, flags);
3622 list_for_each_entry(gdev, &gpio_devices, list)
3623 if (index-- == 0) {
3624 spin_unlock_irqrestore(&gpio_lock, flags);
3625 return gdev;
3626 }
3627 spin_unlock_irqrestore(&gpio_lock, flags);
3628
3629 return NULL;
3630}
3631
3632static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
3633{
3634 unsigned long flags;
3635 struct gpio_device *gdev = v;
3636 void *ret = NULL;
3637
3638 spin_lock_irqsave(&gpio_lock, flags);
3639 if (list_is_last(&gdev->list, &gpio_devices))
3640 ret = NULL;
3641 else
3642 ret = list_entry(gdev->list.next, struct gpio_device, list);
3643 spin_unlock_irqrestore(&gpio_lock, flags);
3644
3645 s->private = "\n";
3646 ++*pos;
3647
3648 return ret;
3649}
3650
3651static void gpiolib_seq_stop(struct seq_file *s, void *v)
3652{
3653}
3654
3655static int gpiolib_seq_show(struct seq_file *s, void *v)
3656{
3657 struct gpio_device *gdev = v;
3658 struct gpio_chip *chip = gdev->chip;
3659 struct device *parent;
3660
3661 if (!chip) {
3662 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
3663 dev_name(&gdev->dev));
3664 return 0;
3665 }
3666
3667 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
3668 dev_name(&gdev->dev),
3669 gdev->base, gdev->base + gdev->ngpio - 1);
3670 parent = chip->parent;
3671 if (parent)
3672 seq_printf(s, ", parent: %s/%s",
3673 parent->bus ? parent->bus->name : "no-bus",
3674 dev_name(parent));
3675 if (chip->label)
3676 seq_printf(s, ", %s", chip->label);
3677 if (chip->can_sleep)
3678 seq_printf(s, ", can sleep");
3679 seq_printf(s, ":\n");
3680
3681 if (chip->dbg_show)
3682 chip->dbg_show(s, chip);
3683 else
3684 gpiolib_dbg_show(s, gdev);
3685
3686 return 0;
3687}
3688
3689static const struct seq_operations gpiolib_seq_ops = {
3690 .start = gpiolib_seq_start,
3691 .next = gpiolib_seq_next,
3692 .stop = gpiolib_seq_stop,
3693 .show = gpiolib_seq_show,
3694};
3695
3696static int gpiolib_open(struct inode *inode, struct file *file)
3697{
3698 return seq_open(file, &gpiolib_seq_ops);
3699}
3700
3701static const struct file_operations gpiolib_operations = {
3702 .owner = THIS_MODULE,
3703 .open = gpiolib_open,
3704 .read = seq_read,
3705 .llseek = seq_lseek,
3706 .release = seq_release,
3707};
3708
3709static int __init gpiolib_debugfs_init(void)
3710{
3711 /* /sys/kernel/debug/gpio */
3712 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
3713 NULL, NULL, &gpiolib_operations);
3714 return 0;
3715}
3716subsys_initcall(gpiolib_debugfs_init);
3717
3718#endif /* DEBUG_FS */