1 // SPDX-License-Identifier: GPL-2.0
2 #include <linux/bitmap.h>
3 #include <linux/kernel.h>
4 #include <linux/module.h>
5 #include <linux/interrupt.h>
7 #include <linux/spinlock.h>
8 #include <linux/list.h>
9 #include <linux/device.h>
10 #include <linux/err.h>
11 #include <linux/debugfs.h>
12 #include <linux/seq_file.h>
13 #include <linux/gpio.h>
14 #include <linux/idr.h>
15 #include <linux/slab.h>
16 #include <linux/acpi.h>
17 #include <linux/gpio/driver.h>
18 #include <linux/gpio/machine.h>
19 #include <linux/pinctrl/consumer.h>
20 #include <linux/cdev.h>
22 #include <linux/uaccess.h>
23 #include <linux/compat.h>
24 #include <linux/anon_inodes.h>
25 #include <linux/file.h>
26 #include <linux/kfifo.h>
27 #include <linux/poll.h>
28 #include <linux/timekeeping.h>
29 #include <uapi/linux/gpio.h>
32 #include "gpiolib-of.h"
33 #include "gpiolib-acpi.h"
35 #define CREATE_TRACE_POINTS
36 #include <trace/events/gpio.h>
38 /* Implementation infrastructure for GPIO interfaces.
40 * The GPIO programming interface allows for inlining speed-critical
41 * get/set operations for common cases, so that access to SOC-integrated
42 * GPIOs can sometimes cost only an instruction or two per bit.
46 /* When debugging, extend minimal trust to callers and platform code.
47 * Also emit diagnostic messages that may help initial bringup, when
48 * board setup or driver bugs are most common.
50 * Otherwise, minimize overhead in what may be bitbanging codepaths.
53 #define extra_checks 1
55 #define extra_checks 0
58 /* Device and char device-related information */
59 static DEFINE_IDA(gpio_ida);
60 static dev_t gpio_devt;
61 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
62 static struct bus_type gpio_bus_type = {
67 * Number of GPIOs to use for the fast path in set array
69 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
71 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
72 * While any GPIO is requested, its gpio_chip is not removable;
73 * each GPIO's "requested" flag serves as a lock and refcount.
75 DEFINE_SPINLOCK(gpio_lock);
77 static DEFINE_MUTEX(gpio_lookup_lock);
78 static LIST_HEAD(gpio_lookup_list);
79 LIST_HEAD(gpio_devices);
81 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
82 static LIST_HEAD(gpio_machine_hogs);
84 static void gpiochip_free_hogs(struct gpio_chip *chip);
85 static int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
86 struct lock_class_key *lock_key,
87 struct lock_class_key *request_key);
88 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
89 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip);
90 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip);
92 static bool gpiolib_initialized;
94 static inline void desc_set_label(struct gpio_desc *d, const char *label)
100 * gpio_to_desc - Convert a GPIO number to its descriptor
101 * @gpio: global GPIO number
104 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
105 * with the given number exists in the system.
107 struct gpio_desc *gpio_to_desc(unsigned gpio)
109 struct gpio_device *gdev;
112 spin_lock_irqsave(&gpio_lock, flags);
114 list_for_each_entry(gdev, &gpio_devices, list) {
115 if (gdev->base <= gpio &&
116 gdev->base + gdev->ngpio > gpio) {
117 spin_unlock_irqrestore(&gpio_lock, flags);
118 return &gdev->descs[gpio - gdev->base];
122 spin_unlock_irqrestore(&gpio_lock, flags);
124 if (!gpio_is_valid(gpio))
125 WARN(1, "invalid GPIO %d\n", gpio);
129 EXPORT_SYMBOL_GPL(gpio_to_desc);
132 * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
133 * hardware number for this chip
135 * @hwnum: hardware number of the GPIO for this chip
138 * A pointer to the GPIO descriptor or %ERR_PTR(-EINVAL) if no GPIO exists
139 * in the given chip for the specified hardware number.
141 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
144 struct gpio_device *gdev = chip->gpiodev;
146 if (hwnum >= gdev->ngpio)
147 return ERR_PTR(-EINVAL);
149 return &gdev->descs[hwnum];
153 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
154 * @desc: GPIO descriptor
156 * This should disappear in the future but is needed since we still
157 * use GPIO numbers for error messages and sysfs nodes.
160 * The global GPIO number for the GPIO specified by its descriptor.
162 int desc_to_gpio(const struct gpio_desc *desc)
164 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
166 EXPORT_SYMBOL_GPL(desc_to_gpio);
170 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
171 * @desc: descriptor to return the chip of
173 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
175 if (!desc || !desc->gdev)
177 return desc->gdev->chip;
179 EXPORT_SYMBOL_GPL(gpiod_to_chip);
181 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
182 static int gpiochip_find_base(int ngpio)
184 struct gpio_device *gdev;
185 int base = ARCH_NR_GPIOS - ngpio;
187 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
188 /* found a free space? */
189 if (gdev->base + gdev->ngpio <= base)
192 /* nope, check the space right before the chip */
193 base = gdev->base - ngpio;
196 if (gpio_is_valid(base)) {
197 pr_debug("%s: found new base at %d\n", __func__, base);
200 pr_err("%s: cannot find free range\n", __func__);
206 * gpiod_get_direction - return the current direction of a GPIO
207 * @desc: GPIO to get the direction of
209 * Returns 0 for output, 1 for input, or an error code in case of error.
211 * This function may sleep if gpiod_cansleep() is true.
213 int gpiod_get_direction(struct gpio_desc *desc)
215 struct gpio_chip *chip;
219 chip = gpiod_to_chip(desc);
220 offset = gpio_chip_hwgpio(desc);
222 if (!chip->get_direction)
225 ret = chip->get_direction(chip, offset);
227 /* GPIOF_DIR_IN, or other positive */
229 clear_bit(FLAG_IS_OUT, &desc->flags);
233 set_bit(FLAG_IS_OUT, &desc->flags);
237 EXPORT_SYMBOL_GPL(gpiod_get_direction);
240 * Add a new chip to the global chips list, keeping the list of chips sorted
241 * by range(means [base, base + ngpio - 1]) order.
243 * Return -EBUSY if the new chip overlaps with some other chip's integer
246 static int gpiodev_add_to_list(struct gpio_device *gdev)
248 struct gpio_device *prev, *next;
250 if (list_empty(&gpio_devices)) {
251 /* initial entry in list */
252 list_add_tail(&gdev->list, &gpio_devices);
256 next = list_entry(gpio_devices.next, struct gpio_device, list);
257 if (gdev->base + gdev->ngpio <= next->base) {
258 /* add before first entry */
259 list_add(&gdev->list, &gpio_devices);
263 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
264 if (prev->base + prev->ngpio <= gdev->base) {
265 /* add behind last entry */
266 list_add_tail(&gdev->list, &gpio_devices);
270 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
271 /* at the end of the list */
272 if (&next->list == &gpio_devices)
275 /* add between prev and next */
276 if (prev->base + prev->ngpio <= gdev->base
277 && gdev->base + gdev->ngpio <= next->base) {
278 list_add(&gdev->list, &prev->list);
283 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
288 * Convert a GPIO name to its descriptor
290 static struct gpio_desc *gpio_name_to_desc(const char * const name)
292 struct gpio_device *gdev;
295 spin_lock_irqsave(&gpio_lock, flags);
297 list_for_each_entry(gdev, &gpio_devices, list) {
300 for (i = 0; i != gdev->ngpio; ++i) {
301 struct gpio_desc *desc = &gdev->descs[i];
303 if (!desc->name || !name)
306 if (!strcmp(desc->name, name)) {
307 spin_unlock_irqrestore(&gpio_lock, flags);
313 spin_unlock_irqrestore(&gpio_lock, flags);
319 * Takes the names from gc->names and checks if they are all unique. If they
320 * are, they are assigned to their gpio descriptors.
322 * Warning if one of the names is already used for a different GPIO.
324 static int gpiochip_set_desc_names(struct gpio_chip *gc)
326 struct gpio_device *gdev = gc->gpiodev;
332 /* First check all names if they are unique */
333 for (i = 0; i != gc->ngpio; ++i) {
334 struct gpio_desc *gpio;
336 gpio = gpio_name_to_desc(gc->names[i]);
339 "Detected name collision for GPIO name '%s'\n",
343 /* Then add all names to the GPIO descriptors */
344 for (i = 0; i != gc->ngpio; ++i)
345 gdev->descs[i].name = gc->names[i];
350 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *chip)
354 p = bitmap_alloc(chip->ngpio, GFP_KERNEL);
358 /* Assume by default all GPIOs are valid */
359 bitmap_fill(p, chip->ngpio);
364 static int gpiochip_alloc_valid_mask(struct gpio_chip *gc)
366 if (!(of_gpio_need_valid_mask(gc) || gc->init_valid_mask))
369 gc->valid_mask = gpiochip_allocate_mask(gc);
376 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
378 if (gc->init_valid_mask)
379 return gc->init_valid_mask(gc,
386 static void gpiochip_free_valid_mask(struct gpio_chip *gpiochip)
388 bitmap_free(gpiochip->valid_mask);
389 gpiochip->valid_mask = NULL;
392 bool gpiochip_line_is_valid(const struct gpio_chip *gpiochip,
395 /* No mask means all valid */
396 if (likely(!gpiochip->valid_mask))
398 return test_bit(offset, gpiochip->valid_mask);
400 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
403 * GPIO line handle management
407 * struct linehandle_state - contains the state of a userspace handle
408 * @gdev: the GPIO device the handle pertains to
409 * @label: consumer label used to tag descriptors
410 * @descs: the GPIO descriptors held by this handle
411 * @numdescs: the number of descriptors held in the descs array
413 struct linehandle_state {
414 struct gpio_device *gdev;
416 struct gpio_desc *descs[GPIOHANDLES_MAX];
420 #define GPIOHANDLE_REQUEST_VALID_FLAGS \
421 (GPIOHANDLE_REQUEST_INPUT | \
422 GPIOHANDLE_REQUEST_OUTPUT | \
423 GPIOHANDLE_REQUEST_ACTIVE_LOW | \
424 GPIOHANDLE_REQUEST_OPEN_DRAIN | \
425 GPIOHANDLE_REQUEST_OPEN_SOURCE)
427 static long linehandle_ioctl(struct file *filep, unsigned int cmd,
430 struct linehandle_state *lh = filep->private_data;
431 void __user *ip = (void __user *)arg;
432 struct gpiohandle_data ghd;
433 DECLARE_BITMAP(vals, GPIOHANDLES_MAX);
436 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
437 /* NOTE: It's ok to read values of output lines. */
438 int ret = gpiod_get_array_value_complex(false,
447 memset(&ghd, 0, sizeof(ghd));
448 for (i = 0; i < lh->numdescs; i++)
449 ghd.values[i] = test_bit(i, vals);
451 if (copy_to_user(ip, &ghd, sizeof(ghd)))
455 } else if (cmd == GPIOHANDLE_SET_LINE_VALUES_IOCTL) {
457 * All line descriptors were created at once with the same
458 * flags so just check if the first one is really output.
460 if (!test_bit(FLAG_IS_OUT, &lh->descs[0]->flags))
463 if (copy_from_user(&ghd, ip, sizeof(ghd)))
466 /* Clamp all values to [0,1] */
467 for (i = 0; i < lh->numdescs; i++)
468 __assign_bit(i, vals, ghd.values[i]);
470 /* Reuse the array setting function */
471 return gpiod_set_array_value_complex(false,
482 static long linehandle_ioctl_compat(struct file *filep, unsigned int cmd,
485 return linehandle_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
489 static int linehandle_release(struct inode *inode, struct file *filep)
491 struct linehandle_state *lh = filep->private_data;
492 struct gpio_device *gdev = lh->gdev;
495 for (i = 0; i < lh->numdescs; i++)
496 gpiod_free(lh->descs[i]);
499 put_device(&gdev->dev);
503 static const struct file_operations linehandle_fileops = {
504 .release = linehandle_release,
505 .owner = THIS_MODULE,
506 .llseek = noop_llseek,
507 .unlocked_ioctl = linehandle_ioctl,
509 .compat_ioctl = linehandle_ioctl_compat,
513 static int linehandle_create(struct gpio_device *gdev, void __user *ip)
515 struct gpiohandle_request handlereq;
516 struct linehandle_state *lh;
518 int fd, i, count = 0, ret;
521 if (copy_from_user(&handlereq, ip, sizeof(handlereq)))
523 if ((handlereq.lines == 0) || (handlereq.lines > GPIOHANDLES_MAX))
526 lflags = handlereq.flags;
528 /* Return an error if an unknown flag is set */
529 if (lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS)
533 * Do not allow both INPUT & OUTPUT flags to be set as they are
536 if ((lflags & GPIOHANDLE_REQUEST_INPUT) &&
537 (lflags & GPIOHANDLE_REQUEST_OUTPUT))
541 * Do not allow OPEN_SOURCE & OPEN_DRAIN flags in a single request. If
542 * the hardware actually supports enabling both at the same time the
543 * electrical result would be disastrous.
545 if ((lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN) &&
546 (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE))
549 /* OPEN_DRAIN and OPEN_SOURCE flags only make sense for output mode. */
550 if (!(lflags & GPIOHANDLE_REQUEST_OUTPUT) &&
551 ((lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN) ||
552 (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)))
555 lh = kzalloc(sizeof(*lh), GFP_KERNEL);
559 get_device(&gdev->dev);
561 /* Make sure this is terminated */
562 handlereq.consumer_label[sizeof(handlereq.consumer_label)-1] = '\0';
563 if (strlen(handlereq.consumer_label)) {
564 lh->label = kstrdup(handlereq.consumer_label,
572 /* Request each GPIO */
573 for (i = 0; i < handlereq.lines; i++) {
574 u32 offset = handlereq.lineoffsets[i];
575 struct gpio_desc *desc;
577 if (offset >= gdev->ngpio) {
582 desc = &gdev->descs[offset];
583 ret = gpiod_request(desc, lh->label);
589 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
590 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
591 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
592 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
593 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
594 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
596 ret = gpiod_set_transitory(desc, false);
601 * Lines have to be requested explicitly for input
602 * or output, else the line will be treated "as is".
604 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
605 int val = !!handlereq.default_values[i];
607 ret = gpiod_direction_output(desc, val);
610 } else if (lflags & GPIOHANDLE_REQUEST_INPUT) {
611 ret = gpiod_direction_input(desc);
615 dev_dbg(&gdev->dev, "registered chardev handle for line %d\n",
618 /* Let i point at the last handle */
620 lh->numdescs = handlereq.lines;
622 fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
628 file = anon_inode_getfile("gpio-linehandle",
631 O_RDONLY | O_CLOEXEC);
634 goto out_put_unused_fd;
638 if (copy_to_user(ip, &handlereq, sizeof(handlereq))) {
640 * fput() will trigger the release() callback, so do not go onto
641 * the regular error cleanup path here.
648 fd_install(fd, file);
650 dev_dbg(&gdev->dev, "registered chardev handle for %d lines\n",
658 for (i = 0; i < count; i++)
659 gpiod_free(lh->descs[i]);
663 put_device(&gdev->dev);
668 * GPIO line event management
672 * struct lineevent_state - contains the state of a userspace event
673 * @gdev: the GPIO device the event pertains to
674 * @label: consumer label used to tag descriptors
675 * @desc: the GPIO descriptor held by this event
676 * @eflags: the event flags this line was requested with
677 * @irq: the interrupt that trigger in response to events on this GPIO
678 * @wait: wait queue that handles blocking reads of events
679 * @events: KFIFO for the GPIO events
680 * @read_lock: mutex lock to protect reads from colliding with adding
681 * new events to the FIFO
682 * @timestamp: cache for the timestamp storing it between hardirq
683 * and IRQ thread, used to bring the timestamp close to the actual
686 struct lineevent_state {
687 struct gpio_device *gdev;
689 struct gpio_desc *desc;
692 wait_queue_head_t wait;
693 DECLARE_KFIFO(events, struct gpioevent_data, 16);
694 struct mutex read_lock;
698 #define GPIOEVENT_REQUEST_VALID_FLAGS \
699 (GPIOEVENT_REQUEST_RISING_EDGE | \
700 GPIOEVENT_REQUEST_FALLING_EDGE)
702 static __poll_t lineevent_poll(struct file *filep,
703 struct poll_table_struct *wait)
705 struct lineevent_state *le = filep->private_data;
708 poll_wait(filep, &le->wait, wait);
710 if (!kfifo_is_empty(&le->events))
711 events = EPOLLIN | EPOLLRDNORM;
717 static ssize_t lineevent_read(struct file *filep,
722 struct lineevent_state *le = filep->private_data;
726 if (count < sizeof(struct gpioevent_data))
730 if (kfifo_is_empty(&le->events)) {
731 if (filep->f_flags & O_NONBLOCK)
734 ret = wait_event_interruptible(le->wait,
735 !kfifo_is_empty(&le->events));
740 if (mutex_lock_interruptible(&le->read_lock))
742 ret = kfifo_to_user(&le->events, buf, count, &copied);
743 mutex_unlock(&le->read_lock);
749 * If we couldn't read anything from the fifo (a different
750 * thread might have been faster) we either return -EAGAIN if
751 * the file descriptor is non-blocking, otherwise we go back to
752 * sleep and wait for more data to arrive.
754 if (copied == 0 && (filep->f_flags & O_NONBLOCK))
757 } while (copied == 0);
762 static int lineevent_release(struct inode *inode, struct file *filep)
764 struct lineevent_state *le = filep->private_data;
765 struct gpio_device *gdev = le->gdev;
767 free_irq(le->irq, le);
768 gpiod_free(le->desc);
771 put_device(&gdev->dev);
775 static long lineevent_ioctl(struct file *filep, unsigned int cmd,
778 struct lineevent_state *le = filep->private_data;
779 void __user *ip = (void __user *)arg;
780 struct gpiohandle_data ghd;
783 * We can get the value for an event line but not set it,
784 * because it is input by definition.
786 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
789 memset(&ghd, 0, sizeof(ghd));
791 val = gpiod_get_value_cansleep(le->desc);
796 if (copy_to_user(ip, &ghd, sizeof(ghd)))
805 static long lineevent_ioctl_compat(struct file *filep, unsigned int cmd,
808 return lineevent_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
812 static const struct file_operations lineevent_fileops = {
813 .release = lineevent_release,
814 .read = lineevent_read,
815 .poll = lineevent_poll,
816 .owner = THIS_MODULE,
817 .llseek = noop_llseek,
818 .unlocked_ioctl = lineevent_ioctl,
820 .compat_ioctl = lineevent_ioctl_compat,
824 static irqreturn_t lineevent_irq_thread(int irq, void *p)
826 struct lineevent_state *le = p;
827 struct gpioevent_data ge;
830 /* Do not leak kernel stack to userspace */
831 memset(&ge, 0, sizeof(ge));
834 * We may be running from a nested threaded interrupt in which case
835 * we didn't get the timestamp from lineevent_irq_handler().
838 ge.timestamp = ktime_get_real_ns();
840 ge.timestamp = le->timestamp;
842 if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE
843 && le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
844 int level = gpiod_get_value_cansleep(le->desc);
846 /* Emit low-to-high event */
847 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
849 /* Emit high-to-low event */
850 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
851 } else if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE) {
852 /* Emit low-to-high event */
853 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
854 } else if (le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
855 /* Emit high-to-low event */
856 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
861 ret = kfifo_put(&le->events, ge);
863 wake_up_poll(&le->wait, EPOLLIN);
868 static irqreturn_t lineevent_irq_handler(int irq, void *p)
870 struct lineevent_state *le = p;
873 * Just store the timestamp in hardirq context so we get it as
874 * close in time as possible to the actual event.
876 le->timestamp = ktime_get_real_ns();
878 return IRQ_WAKE_THREAD;
881 static int lineevent_create(struct gpio_device *gdev, void __user *ip)
883 struct gpioevent_request eventreq;
884 struct lineevent_state *le;
885 struct gpio_desc *desc;
894 if (copy_from_user(&eventreq, ip, sizeof(eventreq)))
897 le = kzalloc(sizeof(*le), GFP_KERNEL);
901 get_device(&gdev->dev);
903 /* Make sure this is terminated */
904 eventreq.consumer_label[sizeof(eventreq.consumer_label)-1] = '\0';
905 if (strlen(eventreq.consumer_label)) {
906 le->label = kstrdup(eventreq.consumer_label,
914 offset = eventreq.lineoffset;
915 lflags = eventreq.handleflags;
916 eflags = eventreq.eventflags;
918 if (offset >= gdev->ngpio) {
923 /* Return an error if a unknown flag is set */
924 if ((lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) ||
925 (eflags & ~GPIOEVENT_REQUEST_VALID_FLAGS)) {
930 /* This is just wrong: we don't look for events on output lines */
931 if ((lflags & GPIOHANDLE_REQUEST_OUTPUT) ||
932 (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN) ||
933 (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)) {
938 desc = &gdev->descs[offset];
939 ret = gpiod_request(desc, le->label);
945 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
946 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
948 ret = gpiod_direction_input(desc);
952 le->irq = gpiod_to_irq(desc);
958 if (eflags & GPIOEVENT_REQUEST_RISING_EDGE)
959 irqflags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
960 IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
961 if (eflags & GPIOEVENT_REQUEST_FALLING_EDGE)
962 irqflags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
963 IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
964 irqflags |= IRQF_ONESHOT;
966 INIT_KFIFO(le->events);
967 init_waitqueue_head(&le->wait);
968 mutex_init(&le->read_lock);
970 /* Request a thread to read the events */
971 ret = request_threaded_irq(le->irq,
972 lineevent_irq_handler,
973 lineevent_irq_thread,
980 fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
986 file = anon_inode_getfile("gpio-event",
989 O_RDONLY | O_CLOEXEC);
992 goto out_put_unused_fd;
996 if (copy_to_user(ip, &eventreq, sizeof(eventreq))) {
998 * fput() will trigger the release() callback, so do not go onto
999 * the regular error cleanup path here.
1006 fd_install(fd, file);
1013 free_irq(le->irq, le);
1015 gpiod_free(le->desc);
1020 put_device(&gdev->dev);
1025 * gpio_ioctl() - ioctl handler for the GPIO chardev
1027 static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1029 struct gpio_device *gdev = filp->private_data;
1030 struct gpio_chip *chip = gdev->chip;
1031 void __user *ip = (void __user *)arg;
1033 /* We fail any subsequent ioctl():s when the chip is gone */
1037 /* Fill in the struct and pass to userspace */
1038 if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
1039 struct gpiochip_info chipinfo;
1041 memset(&chipinfo, 0, sizeof(chipinfo));
1043 strncpy(chipinfo.name, dev_name(&gdev->dev),
1044 sizeof(chipinfo.name));
1045 chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
1046 strncpy(chipinfo.label, gdev->label,
1047 sizeof(chipinfo.label));
1048 chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
1049 chipinfo.lines = gdev->ngpio;
1050 if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
1053 } else if (cmd == GPIO_GET_LINEINFO_IOCTL) {
1054 struct gpioline_info lineinfo;
1055 struct gpio_desc *desc;
1057 if (copy_from_user(&lineinfo, ip, sizeof(lineinfo)))
1059 if (lineinfo.line_offset >= gdev->ngpio)
1062 desc = &gdev->descs[lineinfo.line_offset];
1064 strncpy(lineinfo.name, desc->name,
1065 sizeof(lineinfo.name));
1066 lineinfo.name[sizeof(lineinfo.name)-1] = '\0';
1068 lineinfo.name[0] = '\0';
1071 strncpy(lineinfo.consumer, desc->label,
1072 sizeof(lineinfo.consumer));
1073 lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
1075 lineinfo.consumer[0] = '\0';
1079 * Userspace only need to know that the kernel is using
1080 * this GPIO so it can't use it.
1083 if (test_bit(FLAG_REQUESTED, &desc->flags) ||
1084 test_bit(FLAG_IS_HOGGED, &desc->flags) ||
1085 test_bit(FLAG_USED_AS_IRQ, &desc->flags) ||
1086 test_bit(FLAG_EXPORT, &desc->flags) ||
1087 test_bit(FLAG_SYSFS, &desc->flags) ||
1088 !pinctrl_gpio_can_use_line(chip->base + lineinfo.line_offset))
1089 lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
1090 if (test_bit(FLAG_IS_OUT, &desc->flags))
1091 lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
1092 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1093 lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
1094 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
1095 lineinfo.flags |= (GPIOLINE_FLAG_OPEN_DRAIN |
1096 GPIOLINE_FLAG_IS_OUT);
1097 if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
1098 lineinfo.flags |= (GPIOLINE_FLAG_OPEN_SOURCE |
1099 GPIOLINE_FLAG_IS_OUT);
1101 if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
1104 } else if (cmd == GPIO_GET_LINEHANDLE_IOCTL) {
1105 return linehandle_create(gdev, ip);
1106 } else if (cmd == GPIO_GET_LINEEVENT_IOCTL) {
1107 return lineevent_create(gdev, ip);
1112 #ifdef CONFIG_COMPAT
1113 static long gpio_ioctl_compat(struct file *filp, unsigned int cmd,
1116 return gpio_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
1121 * gpio_chrdev_open() - open the chardev for ioctl operations
1122 * @inode: inode for this chardev
1123 * @filp: file struct for storing private data
1124 * Returns 0 on success
1126 static int gpio_chrdev_open(struct inode *inode, struct file *filp)
1128 struct gpio_device *gdev = container_of(inode->i_cdev,
1129 struct gpio_device, chrdev);
1131 /* Fail on open if the backing gpiochip is gone */
1134 get_device(&gdev->dev);
1135 filp->private_data = gdev;
1137 return nonseekable_open(inode, filp);
1141 * gpio_chrdev_release() - close chardev after ioctl operations
1142 * @inode: inode for this chardev
1143 * @filp: file struct for storing private data
1144 * Returns 0 on success
1146 static int gpio_chrdev_release(struct inode *inode, struct file *filp)
1148 struct gpio_device *gdev = container_of(inode->i_cdev,
1149 struct gpio_device, chrdev);
1151 put_device(&gdev->dev);
1156 static const struct file_operations gpio_fileops = {
1157 .release = gpio_chrdev_release,
1158 .open = gpio_chrdev_open,
1159 .owner = THIS_MODULE,
1160 .llseek = no_llseek,
1161 .unlocked_ioctl = gpio_ioctl,
1162 #ifdef CONFIG_COMPAT
1163 .compat_ioctl = gpio_ioctl_compat,
1167 static void gpiodevice_release(struct device *dev)
1169 struct gpio_device *gdev = dev_get_drvdata(dev);
1171 list_del(&gdev->list);
1172 ida_simple_remove(&gpio_ida, gdev->id);
1173 kfree_const(gdev->label);
1178 static int gpiochip_setup_dev(struct gpio_device *gdev)
1182 cdev_init(&gdev->chrdev, &gpio_fileops);
1183 gdev->chrdev.owner = THIS_MODULE;
1184 gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id);
1186 ret = cdev_device_add(&gdev->chrdev, &gdev->dev);
1190 chip_dbg(gdev->chip, "added GPIO chardev (%d:%d)\n",
1191 MAJOR(gpio_devt), gdev->id);
1193 ret = gpiochip_sysfs_register(gdev);
1195 goto err_remove_device;
1197 /* From this point, the .release() function cleans up gpio_device */
1198 gdev->dev.release = gpiodevice_release;
1199 pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n",
1200 __func__, gdev->base, gdev->base + gdev->ngpio - 1,
1201 dev_name(&gdev->dev), gdev->chip->label ? : "generic");
1206 cdev_device_del(&gdev->chrdev, &gdev->dev);
1210 static void gpiochip_machine_hog(struct gpio_chip *chip, struct gpiod_hog *hog)
1212 struct gpio_desc *desc;
1215 desc = gpiochip_get_desc(chip, hog->chip_hwnum);
1217 pr_err("%s: unable to get GPIO desc: %ld\n",
1218 __func__, PTR_ERR(desc));
1222 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
1225 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
1227 pr_err("%s: unable to hog GPIO line (%s:%u): %d\n",
1228 __func__, chip->label, hog->chip_hwnum, rv);
1231 static void machine_gpiochip_add(struct gpio_chip *chip)
1233 struct gpiod_hog *hog;
1235 mutex_lock(&gpio_machine_hogs_mutex);
1237 list_for_each_entry(hog, &gpio_machine_hogs, list) {
1238 if (!strcmp(chip->label, hog->chip_label))
1239 gpiochip_machine_hog(chip, hog);
1242 mutex_unlock(&gpio_machine_hogs_mutex);
1245 static void gpiochip_setup_devs(void)
1247 struct gpio_device *gdev;
1250 list_for_each_entry(gdev, &gpio_devices, list) {
1251 ret = gpiochip_setup_dev(gdev);
1253 pr_err("%s: Failed to initialize gpio device (%d)\n",
1254 dev_name(&gdev->dev), ret);
1258 int gpiochip_add_data_with_key(struct gpio_chip *chip, void *data,
1259 struct lock_class_key *lock_key,
1260 struct lock_class_key *request_key)
1262 unsigned long flags;
1265 int base = chip->base;
1266 struct gpio_device *gdev;
1269 * First: allocate and populate the internal stat container, and
1270 * set up the struct device.
1272 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
1275 gdev->dev.bus = &gpio_bus_type;
1277 chip->gpiodev = gdev;
1279 gdev->dev.parent = chip->parent;
1280 gdev->dev.of_node = chip->parent->of_node;
1283 #ifdef CONFIG_OF_GPIO
1284 /* If the gpiochip has an assigned OF node this takes precedence */
1286 gdev->dev.of_node = chip->of_node;
1288 chip->of_node = gdev->dev.of_node;
1291 gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
1296 dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
1297 device_initialize(&gdev->dev);
1298 dev_set_drvdata(&gdev->dev, gdev);
1299 if (chip->parent && chip->parent->driver)
1300 gdev->owner = chip->parent->driver->owner;
1301 else if (chip->owner)
1302 /* TODO: remove chip->owner */
1303 gdev->owner = chip->owner;
1305 gdev->owner = THIS_MODULE;
1307 gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
1313 if (chip->ngpio == 0) {
1314 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
1316 goto err_free_descs;
1319 if (chip->ngpio > FASTPATH_NGPIO)
1320 chip_warn(chip, "line cnt %u is greater than fast path cnt %u\n",
1321 chip->ngpio, FASTPATH_NGPIO);
1323 gdev->label = kstrdup_const(chip->label ?: "unknown", GFP_KERNEL);
1326 goto err_free_descs;
1329 gdev->ngpio = chip->ngpio;
1332 spin_lock_irqsave(&gpio_lock, flags);
1335 * TODO: this allocates a Linux GPIO number base in the global
1336 * GPIO numberspace for this chip. In the long run we want to
1337 * get *rid* of this numberspace and use only descriptors, but
1338 * it may be a pipe dream. It will not happen before we get rid
1339 * of the sysfs interface anyways.
1342 base = gpiochip_find_base(chip->ngpio);
1345 spin_unlock_irqrestore(&gpio_lock, flags);
1346 goto err_free_label;
1349 * TODO: it should not be necessary to reflect the assigned
1350 * base outside of the GPIO subsystem. Go over drivers and
1351 * see if anyone makes use of this, else drop this and assign
1358 ret = gpiodev_add_to_list(gdev);
1360 spin_unlock_irqrestore(&gpio_lock, flags);
1361 goto err_free_label;
1364 spin_unlock_irqrestore(&gpio_lock, flags);
1366 for (i = 0; i < chip->ngpio; i++)
1367 gdev->descs[i].gdev = gdev;
1369 #ifdef CONFIG_PINCTRL
1370 INIT_LIST_HEAD(&gdev->pin_ranges);
1373 ret = gpiochip_set_desc_names(chip);
1375 goto err_remove_from_list;
1377 ret = gpiochip_alloc_valid_mask(chip);
1379 goto err_remove_from_list;
1381 ret = of_gpiochip_add(chip);
1383 goto err_free_gpiochip_mask;
1385 ret = gpiochip_init_valid_mask(chip);
1387 goto err_remove_of_chip;
1389 for (i = 0; i < chip->ngpio; i++) {
1390 struct gpio_desc *desc = &gdev->descs[i];
1392 if (chip->get_direction && gpiochip_line_is_valid(chip, i)) {
1393 if (!chip->get_direction(chip, i))
1394 set_bit(FLAG_IS_OUT, &desc->flags);
1396 clear_bit(FLAG_IS_OUT, &desc->flags);
1398 if (!chip->direction_input)
1399 set_bit(FLAG_IS_OUT, &desc->flags);
1401 clear_bit(FLAG_IS_OUT, &desc->flags);
1405 acpi_gpiochip_add(chip);
1407 machine_gpiochip_add(chip);
1409 ret = gpiochip_irqchip_init_valid_mask(chip);
1411 goto err_remove_acpi_chip;
1413 ret = gpiochip_add_irqchip(chip, lock_key, request_key);
1415 goto err_remove_irqchip_mask;
1418 * By first adding the chardev, and then adding the device,
1419 * we get a device node entry in sysfs under
1420 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
1421 * coldplug of device nodes and other udev business.
1422 * We can do this only if gpiolib has been initialized.
1423 * Otherwise, defer until later.
1425 if (gpiolib_initialized) {
1426 ret = gpiochip_setup_dev(gdev);
1428 goto err_remove_irqchip;
1433 gpiochip_irqchip_remove(chip);
1434 err_remove_irqchip_mask:
1435 gpiochip_irqchip_free_valid_mask(chip);
1436 err_remove_acpi_chip:
1437 acpi_gpiochip_remove(chip);
1439 gpiochip_free_hogs(chip);
1440 of_gpiochip_remove(chip);
1441 err_free_gpiochip_mask:
1442 gpiochip_free_valid_mask(chip);
1443 err_remove_from_list:
1444 spin_lock_irqsave(&gpio_lock, flags);
1445 list_del(&gdev->list);
1446 spin_unlock_irqrestore(&gpio_lock, flags);
1448 kfree_const(gdev->label);
1452 ida_simple_remove(&gpio_ida, gdev->id);
1454 /* failures here can mean systems won't boot... */
1455 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
1456 gdev->base, gdev->base + gdev->ngpio - 1,
1457 chip->label ? : "generic", ret);
1461 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
1464 * gpiochip_get_data() - get per-subdriver data for the chip
1468 * The per-subdriver data for the chip.
1470 void *gpiochip_get_data(struct gpio_chip *chip)
1472 return chip->gpiodev->data;
1474 EXPORT_SYMBOL_GPL(gpiochip_get_data);
1477 * gpiochip_remove() - unregister a gpio_chip
1478 * @chip: the chip to unregister
1480 * A gpio_chip with any GPIOs still requested may not be removed.
1482 void gpiochip_remove(struct gpio_chip *chip)
1484 struct gpio_device *gdev = chip->gpiodev;
1485 struct gpio_desc *desc;
1486 unsigned long flags;
1488 bool requested = false;
1490 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1491 gpiochip_sysfs_unregister(gdev);
1492 gpiochip_free_hogs(chip);
1493 /* Numb the device, cancelling all outstanding operations */
1495 gpiochip_irqchip_remove(chip);
1496 acpi_gpiochip_remove(chip);
1497 gpiochip_remove_pin_ranges(chip);
1498 of_gpiochip_remove(chip);
1499 gpiochip_free_valid_mask(chip);
1501 * We accept no more calls into the driver from this point, so
1502 * NULL the driver data pointer
1506 spin_lock_irqsave(&gpio_lock, flags);
1507 for (i = 0; i < gdev->ngpio; i++) {
1508 desc = &gdev->descs[i];
1509 if (test_bit(FLAG_REQUESTED, &desc->flags))
1512 spin_unlock_irqrestore(&gpio_lock, flags);
1515 dev_crit(&gdev->dev,
1516 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
1519 * The gpiochip side puts its use of the device to rest here:
1520 * if there are no userspace clients, the chardev and device will
1521 * be removed, else it will be dangling until the last user is
1524 cdev_device_del(&gdev->chrdev, &gdev->dev);
1525 put_device(&gdev->dev);
1527 EXPORT_SYMBOL_GPL(gpiochip_remove);
1529 static void devm_gpio_chip_release(struct device *dev, void *res)
1531 struct gpio_chip *chip = *(struct gpio_chip **)res;
1533 gpiochip_remove(chip);
1537 * devm_gpiochip_add_data() - Resource manager gpiochip_add_data()
1538 * @dev: pointer to the device that gpio_chip belongs to.
1539 * @chip: the chip to register, with chip->base initialized
1540 * @data: driver-private data associated with this chip
1542 * Context: potentially before irqs will work
1544 * The gpio chip automatically be released when the device is unbound.
1547 * A negative errno if the chip can't be registered, such as because the
1548 * chip->base is invalid or already associated with a different chip.
1549 * Otherwise it returns zero as a success code.
1551 int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
1554 struct gpio_chip **ptr;
1557 ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
1562 ret = gpiochip_add_data(chip, data);
1569 devres_add(dev, ptr);
1573 EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);
1576 * gpiochip_find() - iterator for locating a specific gpio_chip
1577 * @data: data to pass to match function
1578 * @match: Callback function to check gpio_chip
1580 * Similar to bus_find_device. It returns a reference to a gpio_chip as
1581 * determined by a user supplied @match callback. The callback should return
1582 * 0 if the device doesn't match and non-zero if it does. If the callback is
1583 * non-zero, this function will return to the caller and not iterate over any
1586 struct gpio_chip *gpiochip_find(void *data,
1587 int (*match)(struct gpio_chip *chip,
1590 struct gpio_device *gdev;
1591 struct gpio_chip *chip = NULL;
1592 unsigned long flags;
1594 spin_lock_irqsave(&gpio_lock, flags);
1595 list_for_each_entry(gdev, &gpio_devices, list)
1596 if (gdev->chip && match(gdev->chip, data)) {
1601 spin_unlock_irqrestore(&gpio_lock, flags);
1605 EXPORT_SYMBOL_GPL(gpiochip_find);
1607 static int gpiochip_match_name(struct gpio_chip *chip, void *data)
1609 const char *name = data;
1611 return !strcmp(chip->label, name);
1614 static struct gpio_chip *find_chip_by_name(const char *name)
1616 return gpiochip_find((void *)name, gpiochip_match_name);
1619 #ifdef CONFIG_GPIOLIB_IRQCHIP
1622 * The following is irqchip helper code for gpiochips.
1625 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1627 struct gpio_irq_chip *girq = &gc->irq;
1629 if (!girq->init_valid_mask)
1632 girq->valid_mask = gpiochip_allocate_mask(gc);
1633 if (!girq->valid_mask)
1636 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
1641 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1643 bitmap_free(gpiochip->irq.valid_mask);
1644 gpiochip->irq.valid_mask = NULL;
1647 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
1648 unsigned int offset)
1650 if (!gpiochip_line_is_valid(gpiochip, offset))
1652 /* No mask means all valid */
1653 if (likely(!gpiochip->irq.valid_mask))
1655 return test_bit(offset, gpiochip->irq.valid_mask);
1657 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
1660 * gpiochip_set_cascaded_irqchip() - connects a cascaded irqchip to a gpiochip
1661 * @gc: the gpiochip to set the irqchip chain to
1662 * @parent_irq: the irq number corresponding to the parent IRQ for this
1664 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1665 * coming out of the gpiochip. If the interrupt is nested rather than
1666 * cascaded, pass NULL in this handler argument
1668 static void gpiochip_set_cascaded_irqchip(struct gpio_chip *gc,
1669 unsigned int parent_irq,
1670 irq_flow_handler_t parent_handler)
1672 struct gpio_irq_chip *girq = &gc->irq;
1673 struct device *dev = &gc->gpiodev->dev;
1675 if (!girq->domain) {
1676 chip_err(gc, "called %s before setting up irqchip\n",
1681 if (parent_handler) {
1682 if (gc->can_sleep) {
1684 "you cannot have chained interrupts on a chip that may sleep\n");
1687 girq->parents = devm_kcalloc(dev, 1,
1688 sizeof(*girq->parents),
1690 if (!girq->parents) {
1691 chip_err(gc, "out of memory allocating parent IRQ\n");
1694 girq->parents[0] = parent_irq;
1695 girq->num_parents = 1;
1697 * The parent irqchip is already using the chip_data for this
1698 * irqchip, so our callbacks simply use the handler_data.
1700 irq_set_chained_handler_and_data(parent_irq, parent_handler,
1706 * gpiochip_set_chained_irqchip() - connects a chained irqchip to a gpiochip
1707 * @gpiochip: the gpiochip to set the irqchip chain to
1708 * @irqchip: the irqchip to chain to the gpiochip
1709 * @parent_irq: the irq number corresponding to the parent IRQ for this
1711 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1712 * coming out of the gpiochip.
1714 void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
1715 struct irq_chip *irqchip,
1716 unsigned int parent_irq,
1717 irq_flow_handler_t parent_handler)
1719 if (gpiochip->irq.threaded) {
1720 chip_err(gpiochip, "tried to chain a threaded gpiochip\n");
1724 gpiochip_set_cascaded_irqchip(gpiochip, parent_irq, parent_handler);
1726 EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
1729 * gpiochip_set_nested_irqchip() - connects a nested irqchip to a gpiochip
1730 * @gpiochip: the gpiochip to set the irqchip nested handler to
1731 * @irqchip: the irqchip to nest to the gpiochip
1732 * @parent_irq: the irq number corresponding to the parent IRQ for this
1735 void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip,
1736 struct irq_chip *irqchip,
1737 unsigned int parent_irq)
1739 gpiochip_set_cascaded_irqchip(gpiochip, parent_irq, NULL);
1741 EXPORT_SYMBOL_GPL(gpiochip_set_nested_irqchip);
1743 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1746 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
1748 * @gc: the gpiochip to set the irqchip hierarchical handler to
1749 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
1750 * will then percolate up to the parent
1752 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
1753 struct irq_chip *irqchip)
1755 /* DT will deal with mapping each IRQ as we go along */
1756 if (is_of_node(gc->irq.fwnode))
1760 * This is for legacy and boardfile "irqchip" fwnodes: allocate
1761 * irqs upfront instead of dynamically since we don't have the
1762 * dynamic type of allocation that hardware description languages
1763 * provide. Once all GPIO drivers using board files are gone from
1764 * the kernel we can delete this code, but for a transitional period
1765 * it is necessary to keep this around.
1767 if (is_fwnode_irqchip(gc->irq.fwnode)) {
1771 for (i = 0; i < gc->ngpio; i++) {
1772 struct irq_fwspec fwspec;
1773 unsigned int parent_hwirq;
1774 unsigned int parent_type;
1775 struct gpio_irq_chip *girq = &gc->irq;
1778 * We call the child to parent translation function
1779 * only to check if the child IRQ is valid or not.
1780 * Just pick the rising edge type here as that is what
1781 * we likely need to support.
1783 ret = girq->child_to_parent_hwirq(gc, i,
1784 IRQ_TYPE_EDGE_RISING,
1788 chip_err(gc, "skip set-up on hwirq %d\n",
1793 fwspec.fwnode = gc->irq.fwnode;
1794 /* This is the hwirq for the GPIO line side of things */
1795 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
1796 /* Just pick something */
1797 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
1798 fwspec.param_count = 2;
1799 ret = __irq_domain_alloc_irqs(gc->irq.domain,
1800 /* just pick something */
1809 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1816 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1821 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1822 struct irq_fwspec *fwspec,
1823 unsigned long *hwirq,
1826 /* We support standard DT translation */
1827 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1828 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1831 /* This is for board files and others not using DT */
1832 if (is_fwnode_irqchip(fwspec->fwnode)) {
1835 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1838 WARN_ON(*type == IRQ_TYPE_NONE);
1844 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1846 unsigned int nr_irqs,
1849 struct gpio_chip *gc = d->host_data;
1850 irq_hw_number_t hwirq;
1851 unsigned int type = IRQ_TYPE_NONE;
1852 struct irq_fwspec *fwspec = data;
1853 struct irq_fwspec parent_fwspec;
1854 unsigned int parent_hwirq;
1855 unsigned int parent_type;
1856 struct gpio_irq_chip *girq = &gc->irq;
1860 * The nr_irqs parameter is always one except for PCI multi-MSI
1861 * so this should not happen.
1863 WARN_ON(nr_irqs != 1);
1865 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1869 chip_info(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1871 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1872 &parent_hwirq, &parent_type);
1874 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1877 chip_info(gc, "found parent hwirq %u\n", parent_hwirq);
1880 * We set handle_bad_irq because the .set_type() should
1881 * always be invoked and set the right type of handler.
1883 irq_domain_set_info(d,
1893 * Create a IRQ fwspec to send up to the parent irqdomain:
1894 * specify the hwirq we address on the parent and tie it
1895 * all together up the chain.
1897 parent_fwspec.fwnode = d->parent->fwnode;
1898 /* This parent only handles asserted level IRQs */
1899 girq->populate_parent_fwspec(gc, &parent_fwspec, parent_hwirq,
1901 chip_info(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1903 ret = irq_domain_alloc_irqs_parent(d, irq, 1, &parent_fwspec);
1906 "failed to allocate parent hwirq %d for hwirq %lu\n",
1907 parent_hwirq, hwirq);
1912 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *chip,
1913 unsigned int offset)
1918 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1920 ops->activate = gpiochip_irq_domain_activate;
1921 ops->deactivate = gpiochip_irq_domain_deactivate;
1922 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1923 ops->free = irq_domain_free_irqs_common;
1926 * We only allow overriding the translate() function for
1927 * hierarchical chips, and this should only be done if the user
1928 * really need something other than 1:1 translation.
1930 if (!ops->translate)
1931 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1934 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1936 if (!gc->irq.child_to_parent_hwirq ||
1938 chip_err(gc, "missing irqdomain vital data\n");
1942 if (!gc->irq.child_offset_to_irq)
1943 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1945 if (!gc->irq.populate_parent_fwspec)
1946 gc->irq.populate_parent_fwspec =
1947 gpiochip_populate_parent_fwspec_twocell;
1949 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1951 gc->irq.domain = irq_domain_create_hierarchy(
1952 gc->irq.parent_domain,
1956 &gc->irq.child_irq_domain_ops,
1959 if (!gc->irq.domain)
1962 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1967 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1969 return !!gc->irq.parent_domain;
1972 void gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *chip,
1973 struct irq_fwspec *fwspec,
1974 unsigned int parent_hwirq,
1975 unsigned int parent_type)
1977 fwspec->param_count = 2;
1978 fwspec->param[0] = parent_hwirq;
1979 fwspec->param[1] = parent_type;
1981 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1983 void gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *chip,
1984 struct irq_fwspec *fwspec,
1985 unsigned int parent_hwirq,
1986 unsigned int parent_type)
1988 fwspec->param_count = 4;
1989 fwspec->param[0] = 0;
1990 fwspec->param[1] = parent_hwirq;
1991 fwspec->param[2] = 0;
1992 fwspec->param[3] = parent_type;
1994 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1998 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
2003 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
2008 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
2011 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
2012 * @d: the irqdomain used by this irqchip
2013 * @irq: the global irq number used by this GPIO irqchip irq
2014 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
2016 * This function will set up the mapping for a certain IRQ line on a
2017 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
2018 * stored inside the gpiochip.
2020 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
2021 irq_hw_number_t hwirq)
2023 struct gpio_chip *chip = d->host_data;
2026 if (!gpiochip_irqchip_irq_valid(chip, hwirq))
2029 irq_set_chip_data(irq, chip);
2031 * This lock class tells lockdep that GPIO irqs are in a different
2032 * category than their parents, so it won't report false recursion.
2034 irq_set_lockdep_class(irq, chip->irq.lock_key, chip->irq.request_key);
2035 irq_set_chip_and_handler(irq, chip->irq.chip, chip->irq.handler);
2036 /* Chips that use nested thread handlers have them marked */
2037 if (chip->irq.threaded)
2038 irq_set_nested_thread(irq, 1);
2039 irq_set_noprobe(irq);
2041 if (chip->irq.num_parents == 1)
2042 ret = irq_set_parent(irq, chip->irq.parents[0]);
2043 else if (chip->irq.map)
2044 ret = irq_set_parent(irq, chip->irq.map[hwirq]);
2050 * No set-up of the hardware will happen if IRQ_TYPE_NONE
2051 * is passed as default type.
2053 if (chip->irq.default_type != IRQ_TYPE_NONE)
2054 irq_set_irq_type(irq, chip->irq.default_type);
2058 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
2060 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
2062 struct gpio_chip *chip = d->host_data;
2064 if (chip->irq.threaded)
2065 irq_set_nested_thread(irq, 0);
2066 irq_set_chip_and_handler(irq, NULL, NULL);
2067 irq_set_chip_data(irq, NULL);
2069 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
2071 static const struct irq_domain_ops gpiochip_domain_ops = {
2072 .map = gpiochip_irq_map,
2073 .unmap = gpiochip_irq_unmap,
2074 /* Virtually all GPIO irqchips are twocell:ed */
2075 .xlate = irq_domain_xlate_twocell,
2079 * TODO: move these activate/deactivate in under the hierarchicial
2080 * irqchip implementation as static once SPMI and SSBI (all external
2081 * users) are phased over.
2084 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
2085 * @domain: The IRQ domain used by this IRQ chip
2086 * @data: Outermost irq_data associated with the IRQ
2087 * @reserve: If set, only reserve an interrupt vector instead of assigning one
2089 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
2090 * used as the activate function for the &struct irq_domain_ops. The host_data
2091 * for the IRQ domain must be the &struct gpio_chip.
2093 int gpiochip_irq_domain_activate(struct irq_domain *domain,
2094 struct irq_data *data, bool reserve)
2096 struct gpio_chip *chip = domain->host_data;
2098 return gpiochip_lock_as_irq(chip, data->hwirq);
2100 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
2103 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
2104 * @domain: The IRQ domain used by this IRQ chip
2105 * @data: Outermost irq_data associated with the IRQ
2107 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
2108 * be used as the deactivate function for the &struct irq_domain_ops. The
2109 * host_data for the IRQ domain must be the &struct gpio_chip.
2111 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
2112 struct irq_data *data)
2114 struct gpio_chip *chip = domain->host_data;
2116 return gpiochip_unlock_as_irq(chip, data->hwirq);
2118 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
2120 static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
2122 struct irq_domain *domain = chip->irq.domain;
2124 if (!gpiochip_irqchip_irq_valid(chip, offset))
2127 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
2128 if (irq_domain_is_hierarchy(domain)) {
2129 struct irq_fwspec spec;
2131 spec.fwnode = domain->fwnode;
2132 spec.param_count = 2;
2133 spec.param[0] = chip->irq.child_offset_to_irq(chip, offset);
2134 spec.param[1] = IRQ_TYPE_NONE;
2136 return irq_create_fwspec_mapping(&spec);
2140 return irq_create_mapping(domain, offset);
2143 static int gpiochip_irq_reqres(struct irq_data *d)
2145 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
2147 return gpiochip_reqres_irq(chip, d->hwirq);
2150 static void gpiochip_irq_relres(struct irq_data *d)
2152 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
2154 gpiochip_relres_irq(chip, d->hwirq);
2157 static void gpiochip_irq_enable(struct irq_data *d)
2159 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
2161 gpiochip_enable_irq(chip, d->hwirq);
2162 if (chip->irq.irq_enable)
2163 chip->irq.irq_enable(d);
2165 chip->irq.chip->irq_unmask(d);
2168 static void gpiochip_irq_disable(struct irq_data *d)
2170 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
2172 if (chip->irq.irq_disable)
2173 chip->irq.irq_disable(d);
2175 chip->irq.chip->irq_mask(d);
2176 gpiochip_disable_irq(chip, d->hwirq);
2179 static void gpiochip_set_irq_hooks(struct gpio_chip *gpiochip)
2181 struct irq_chip *irqchip = gpiochip->irq.chip;
2183 if (!irqchip->irq_request_resources &&
2184 !irqchip->irq_release_resources) {
2185 irqchip->irq_request_resources = gpiochip_irq_reqres;
2186 irqchip->irq_release_resources = gpiochip_irq_relres;
2188 if (WARN_ON(gpiochip->irq.irq_enable))
2190 /* Check if the irqchip already has this hook... */
2191 if (irqchip->irq_enable == gpiochip_irq_enable) {
2193 * ...and if so, give a gentle warning that this is bad
2197 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
2200 gpiochip->irq.irq_enable = irqchip->irq_enable;
2201 gpiochip->irq.irq_disable = irqchip->irq_disable;
2202 irqchip->irq_enable = gpiochip_irq_enable;
2203 irqchip->irq_disable = gpiochip_irq_disable;
2207 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
2208 * @gpiochip: the GPIO chip to add the IRQ chip to
2209 * @lock_key: lockdep class for IRQ lock
2210 * @request_key: lockdep class for IRQ request
2212 static int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
2213 struct lock_class_key *lock_key,
2214 struct lock_class_key *request_key)
2216 struct irq_chip *irqchip = gpiochip->irq.chip;
2217 const struct irq_domain_ops *ops = NULL;
2218 struct device_node *np;
2225 if (gpiochip->irq.parent_handler && gpiochip->can_sleep) {
2226 chip_err(gpiochip, "you cannot have chained interrupts on a chip that may sleep\n");
2230 np = gpiochip->gpiodev->dev.of_node;
2231 type = gpiochip->irq.default_type;
2234 * Specifying a default trigger is a terrible idea if DT or ACPI is
2235 * used to configure the interrupts, as you may end up with
2236 * conflicting triggers. Tell the user, and reset to NONE.
2238 if (WARN(np && type != IRQ_TYPE_NONE,
2239 "%s: Ignoring %u default trigger\n", np->full_name, type))
2240 type = IRQ_TYPE_NONE;
2242 if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
2243 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
2244 "Ignoring %u default trigger\n", type);
2245 type = IRQ_TYPE_NONE;
2248 gpiochip->to_irq = gpiochip_to_irq;
2249 gpiochip->irq.default_type = type;
2250 gpiochip->irq.lock_key = lock_key;
2251 gpiochip->irq.request_key = request_key;
2253 /* If a parent irqdomain is provided, let's build a hierarchy */
2254 if (gpiochip_hierarchy_is_hierarchical(gpiochip)) {
2255 int ret = gpiochip_hierarchy_add_domain(gpiochip);
2259 /* Some drivers provide custom irqdomain ops */
2260 if (gpiochip->irq.domain_ops)
2261 ops = gpiochip->irq.domain_ops;
2264 ops = &gpiochip_domain_ops;
2265 gpiochip->irq.domain = irq_domain_add_simple(np,
2267 gpiochip->irq.first,
2269 if (!gpiochip->irq.domain)
2273 if (gpiochip->irq.parent_handler) {
2274 void *data = gpiochip->irq.parent_handler_data ?: gpiochip;
2276 for (i = 0; i < gpiochip->irq.num_parents; i++) {
2278 * The parent IRQ chip is already using the chip_data
2279 * for this IRQ chip, so our callbacks simply use the
2282 irq_set_chained_handler_and_data(gpiochip->irq.parents[i],
2283 gpiochip->irq.parent_handler,
2288 gpiochip_set_irq_hooks(gpiochip);
2290 acpi_gpiochip_request_interrupts(gpiochip);
2296 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
2297 * @gpiochip: the gpiochip to remove the irqchip from
2299 * This is called only from gpiochip_remove()
2301 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
2303 struct irq_chip *irqchip = gpiochip->irq.chip;
2304 unsigned int offset;
2306 acpi_gpiochip_free_interrupts(gpiochip);
2308 if (irqchip && gpiochip->irq.parent_handler) {
2309 struct gpio_irq_chip *irq = &gpiochip->irq;
2312 for (i = 0; i < irq->num_parents; i++)
2313 irq_set_chained_handler_and_data(irq->parents[i],
2317 /* Remove all IRQ mappings and delete the domain */
2318 if (gpiochip->irq.domain) {
2321 for (offset = 0; offset < gpiochip->ngpio; offset++) {
2322 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
2325 irq = irq_find_mapping(gpiochip->irq.domain, offset);
2326 irq_dispose_mapping(irq);
2329 irq_domain_remove(gpiochip->irq.domain);
2333 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
2334 irqchip->irq_request_resources = NULL;
2335 irqchip->irq_release_resources = NULL;
2337 if (irqchip->irq_enable == gpiochip_irq_enable) {
2338 irqchip->irq_enable = gpiochip->irq.irq_enable;
2339 irqchip->irq_disable = gpiochip->irq.irq_disable;
2342 gpiochip->irq.irq_enable = NULL;
2343 gpiochip->irq.irq_disable = NULL;
2344 gpiochip->irq.chip = NULL;
2346 gpiochip_irqchip_free_valid_mask(gpiochip);
2350 * gpiochip_irqchip_add_key() - adds an irqchip to a gpiochip
2351 * @gpiochip: the gpiochip to add the irqchip to
2352 * @irqchip: the irqchip to add to the gpiochip
2353 * @first_irq: if not dynamically assigned, the base (first) IRQ to
2354 * allocate gpiochip irqs from
2355 * @handler: the irq handler to use (often a predefined irq core function)
2356 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
2357 * to have the core avoid setting up any default type in the hardware.
2358 * @threaded: whether this irqchip uses a nested thread handler
2359 * @lock_key: lockdep class for IRQ lock
2360 * @request_key: lockdep class for IRQ request
2362 * This function closely associates a certain irqchip with a certain
2363 * gpiochip, providing an irq domain to translate the local IRQs to
2364 * global irqs in the gpiolib core, and making sure that the gpiochip
2365 * is passed as chip data to all related functions. Driver callbacks
2366 * need to use gpiochip_get_data() to get their local state containers back
2367 * from the gpiochip passed as chip data. An irqdomain will be stored
2368 * in the gpiochip that shall be used by the driver to handle IRQ number
2369 * translation. The gpiochip will need to be initialized and registered
2370 * before calling this function.
2372 * This function will handle two cell:ed simple IRQs and assumes all
2373 * the pins on the gpiochip can generate a unique IRQ. Everything else
2374 * need to be open coded.
2376 int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip,
2377 struct irq_chip *irqchip,
2378 unsigned int first_irq,
2379 irq_flow_handler_t handler,
2382 struct lock_class_key *lock_key,
2383 struct lock_class_key *request_key)
2385 struct device_node *of_node;
2387 if (!gpiochip || !irqchip)
2390 if (!gpiochip->parent) {
2391 pr_err("missing gpiochip .dev parent pointer\n");
2394 gpiochip->irq.threaded = threaded;
2395 of_node = gpiochip->parent->of_node;
2396 #ifdef CONFIG_OF_GPIO
2398 * If the gpiochip has an assigned OF node this takes precedence
2399 * FIXME: get rid of this and use gpiochip->parent->of_node
2402 if (gpiochip->of_node)
2403 of_node = gpiochip->of_node;
2406 * Specifying a default trigger is a terrible idea if DT or ACPI is
2407 * used to configure the interrupts, as you may end-up with
2408 * conflicting triggers. Tell the user, and reset to NONE.
2410 if (WARN(of_node && type != IRQ_TYPE_NONE,
2411 "%pOF: Ignoring %d default trigger\n", of_node, type))
2412 type = IRQ_TYPE_NONE;
2413 if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
2414 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
2415 "Ignoring %d default trigger\n", type);
2416 type = IRQ_TYPE_NONE;
2419 gpiochip->irq.chip = irqchip;
2420 gpiochip->irq.handler = handler;
2421 gpiochip->irq.default_type = type;
2422 gpiochip->to_irq = gpiochip_to_irq;
2423 gpiochip->irq.lock_key = lock_key;
2424 gpiochip->irq.request_key = request_key;
2425 gpiochip->irq.domain = irq_domain_add_simple(of_node,
2426 gpiochip->ngpio, first_irq,
2427 &gpiochip_domain_ops, gpiochip);
2428 if (!gpiochip->irq.domain) {
2429 gpiochip->irq.chip = NULL;
2433 gpiochip_set_irq_hooks(gpiochip);
2435 acpi_gpiochip_request_interrupts(gpiochip);
2439 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_key);
2441 #else /* CONFIG_GPIOLIB_IRQCHIP */
2443 static inline int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
2444 struct lock_class_key *lock_key,
2445 struct lock_class_key *request_key)
2450 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
2451 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
2455 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
2458 #endif /* CONFIG_GPIOLIB_IRQCHIP */
2461 * gpiochip_generic_request() - request the gpio function for a pin
2462 * @chip: the gpiochip owning the GPIO
2463 * @offset: the offset of the GPIO to request for GPIO function
2465 int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
2467 return pinctrl_gpio_request(chip->gpiodev->base + offset);
2469 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
2472 * gpiochip_generic_free() - free the gpio function from a pin
2473 * @chip: the gpiochip to request the gpio function for
2474 * @offset: the offset of the GPIO to free from GPIO function
2476 void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
2478 pinctrl_gpio_free(chip->gpiodev->base + offset);
2480 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
2483 * gpiochip_generic_config() - apply configuration for a pin
2484 * @chip: the gpiochip owning the GPIO
2485 * @offset: the offset of the GPIO to apply the configuration
2486 * @config: the configuration to be applied
2488 int gpiochip_generic_config(struct gpio_chip *chip, unsigned offset,
2489 unsigned long config)
2491 return pinctrl_gpio_set_config(chip->gpiodev->base + offset, config);
2493 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
2495 #ifdef CONFIG_PINCTRL
2498 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
2499 * @chip: the gpiochip to add the range for
2500 * @pctldev: the pin controller to map to
2501 * @gpio_offset: the start offset in the current gpio_chip number space
2502 * @pin_group: name of the pin group inside the pin controller
2504 * Calling this function directly from a DeviceTree-supported
2505 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2506 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2507 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2509 int gpiochip_add_pingroup_range(struct gpio_chip *chip,
2510 struct pinctrl_dev *pctldev,
2511 unsigned int gpio_offset, const char *pin_group)
2513 struct gpio_pin_range *pin_range;
2514 struct gpio_device *gdev = chip->gpiodev;
2517 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2519 chip_err(chip, "failed to allocate pin ranges\n");
2523 /* Use local offset as range ID */
2524 pin_range->range.id = gpio_offset;
2525 pin_range->range.gc = chip;
2526 pin_range->range.name = chip->label;
2527 pin_range->range.base = gdev->base + gpio_offset;
2528 pin_range->pctldev = pctldev;
2530 ret = pinctrl_get_group_pins(pctldev, pin_group,
2531 &pin_range->range.pins,
2532 &pin_range->range.npins);
2538 pinctrl_add_gpio_range(pctldev, &pin_range->range);
2540 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
2541 gpio_offset, gpio_offset + pin_range->range.npins - 1,
2542 pinctrl_dev_get_devname(pctldev), pin_group);
2544 list_add_tail(&pin_range->node, &gdev->pin_ranges);
2548 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
2551 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
2552 * @chip: the gpiochip to add the range for
2553 * @pinctl_name: the dev_name() of the pin controller to map to
2554 * @gpio_offset: the start offset in the current gpio_chip number space
2555 * @pin_offset: the start offset in the pin controller number space
2556 * @npins: the number of pins from the offset of each pin space (GPIO and
2557 * pin controller) to accumulate in this range
2560 * 0 on success, or a negative error-code on failure.
2562 * Calling this function directly from a DeviceTree-supported
2563 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2564 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2565 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2567 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
2568 unsigned int gpio_offset, unsigned int pin_offset,
2571 struct gpio_pin_range *pin_range;
2572 struct gpio_device *gdev = chip->gpiodev;
2575 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2577 chip_err(chip, "failed to allocate pin ranges\n");
2581 /* Use local offset as range ID */
2582 pin_range->range.id = gpio_offset;
2583 pin_range->range.gc = chip;
2584 pin_range->range.name = chip->label;
2585 pin_range->range.base = gdev->base + gpio_offset;
2586 pin_range->range.pin_base = pin_offset;
2587 pin_range->range.npins = npins;
2588 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
2590 if (IS_ERR(pin_range->pctldev)) {
2591 ret = PTR_ERR(pin_range->pctldev);
2592 chip_err(chip, "could not create pin range\n");
2596 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
2597 gpio_offset, gpio_offset + npins - 1,
2599 pin_offset, pin_offset + npins - 1);
2601 list_add_tail(&pin_range->node, &gdev->pin_ranges);
2605 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
2608 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
2609 * @chip: the chip to remove all the mappings for
2611 void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
2613 struct gpio_pin_range *pin_range, *tmp;
2614 struct gpio_device *gdev = chip->gpiodev;
2616 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
2617 list_del(&pin_range->node);
2618 pinctrl_remove_gpio_range(pin_range->pctldev,
2623 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
2625 #endif /* CONFIG_PINCTRL */
2627 /* These "optional" allocation calls help prevent drivers from stomping
2628 * on each other, and help provide better diagnostics in debugfs.
2629 * They're called even less than the "set direction" calls.
2631 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
2633 struct gpio_chip *chip = desc->gdev->chip;
2635 unsigned long flags;
2639 label = kstrdup_const(label, GFP_KERNEL);
2644 spin_lock_irqsave(&gpio_lock, flags);
2646 /* NOTE: gpio_request() can be called in early boot,
2647 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
2650 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
2651 desc_set_label(desc, label ? : "?");
2659 if (chip->request) {
2660 /* chip->request may sleep */
2661 spin_unlock_irqrestore(&gpio_lock, flags);
2662 offset = gpio_chip_hwgpio(desc);
2663 if (gpiochip_line_is_valid(chip, offset))
2664 ret = chip->request(chip, offset);
2667 spin_lock_irqsave(&gpio_lock, flags);
2670 desc_set_label(desc, NULL);
2672 clear_bit(FLAG_REQUESTED, &desc->flags);
2676 if (chip->get_direction) {
2677 /* chip->get_direction may sleep */
2678 spin_unlock_irqrestore(&gpio_lock, flags);
2679 gpiod_get_direction(desc);
2680 spin_lock_irqsave(&gpio_lock, flags);
2683 spin_unlock_irqrestore(&gpio_lock, flags);
2688 * This descriptor validation needs to be inserted verbatim into each
2689 * function taking a descriptor, so we need to use a preprocessor
2690 * macro to avoid endless duplication. If the desc is NULL it is an
2691 * optional GPIO and calls should just bail out.
2693 static int validate_desc(const struct gpio_desc *desc, const char *func)
2698 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
2699 return PTR_ERR(desc);
2702 pr_warn("%s: invalid GPIO (no device)\n", func);
2705 if (!desc->gdev->chip) {
2706 dev_warn(&desc->gdev->dev,
2707 "%s: backing chip is gone\n", func);
2713 #define VALIDATE_DESC(desc) do { \
2714 int __valid = validate_desc(desc, __func__); \
2719 #define VALIDATE_DESC_VOID(desc) do { \
2720 int __valid = validate_desc(desc, __func__); \
2725 int gpiod_request(struct gpio_desc *desc, const char *label)
2727 int ret = -EPROBE_DEFER;
2728 struct gpio_device *gdev;
2730 VALIDATE_DESC(desc);
2733 if (try_module_get(gdev->owner)) {
2734 ret = gpiod_request_commit(desc, label);
2736 module_put(gdev->owner);
2738 get_device(&gdev->dev);
2742 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
2747 static bool gpiod_free_commit(struct gpio_desc *desc)
2750 unsigned long flags;
2751 struct gpio_chip *chip;
2755 gpiod_unexport(desc);
2757 spin_lock_irqsave(&gpio_lock, flags);
2759 chip = desc->gdev->chip;
2760 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
2762 spin_unlock_irqrestore(&gpio_lock, flags);
2763 might_sleep_if(chip->can_sleep);
2764 chip->free(chip, gpio_chip_hwgpio(desc));
2765 spin_lock_irqsave(&gpio_lock, flags);
2767 kfree_const(desc->label);
2768 desc_set_label(desc, NULL);
2769 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2770 clear_bit(FLAG_REQUESTED, &desc->flags);
2771 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2772 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2773 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2777 spin_unlock_irqrestore(&gpio_lock, flags);
2781 void gpiod_free(struct gpio_desc *desc)
2783 if (desc && desc->gdev && gpiod_free_commit(desc)) {
2784 module_put(desc->gdev->owner);
2785 put_device(&desc->gdev->dev);
2787 WARN_ON(extra_checks);
2792 * gpiochip_is_requested - return string iff signal was requested
2793 * @chip: controller managing the signal
2794 * @offset: of signal within controller's 0..(ngpio - 1) range
2796 * Returns NULL if the GPIO is not currently requested, else a string.
2797 * The string returned is the label passed to gpio_request(); if none has been
2798 * passed it is a meaningless, non-NULL constant.
2800 * This function is for use by GPIO controller drivers. The label can
2801 * help with diagnostics, and knowing that the signal is used as a GPIO
2802 * can help avoid accidentally multiplexing it to another controller.
2804 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
2806 struct gpio_desc *desc;
2808 if (offset >= chip->ngpio)
2811 desc = &chip->gpiodev->descs[offset];
2813 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2817 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2820 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2822 * @hwnum: hardware number of the GPIO for which to request the descriptor
2823 * @label: label for the GPIO
2824 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2825 * specify things like line inversion semantics with the machine flags
2826 * such as GPIO_OUT_LOW
2827 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2828 * can be used to specify consumer semantics such as open drain
2830 * Function allows GPIO chip drivers to request and use their own GPIO
2831 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2832 * function will not increase reference count of the GPIO chip module. This
2833 * allows the GPIO chip module to be unloaded as needed (we assume that the
2834 * GPIO chip driver handles freeing the GPIOs it has requested).
2837 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2840 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
2842 enum gpio_lookup_flags lflags,
2843 enum gpiod_flags dflags)
2845 struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
2849 chip_err(chip, "failed to get GPIO descriptor\n");
2853 ret = gpiod_request_commit(desc, label);
2855 return ERR_PTR(ret);
2857 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2859 chip_err(chip, "setup of own GPIO %s failed\n", label);
2860 gpiod_free_commit(desc);
2861 return ERR_PTR(ret);
2866 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2869 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2870 * @desc: GPIO descriptor to free
2872 * Function frees the given GPIO requested previously with
2873 * gpiochip_request_own_desc().
2875 void gpiochip_free_own_desc(struct gpio_desc *desc)
2878 gpiod_free_commit(desc);
2880 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2883 * Drivers MUST set GPIO direction before making get/set calls. In
2884 * some cases this is done in early boot, before IRQs are enabled.
2886 * As a rule these aren't called more than once (except for drivers
2887 * using the open-drain emulation idiom) so these are natural places
2888 * to accumulate extra debugging checks. Note that we can't (yet)
2889 * rely on gpio_request() having been called beforehand.
2892 static int gpio_set_config(struct gpio_chip *gc, unsigned offset,
2893 enum pin_config_param mode)
2895 unsigned long config;
2899 case PIN_CONFIG_BIAS_PULL_DOWN:
2900 case PIN_CONFIG_BIAS_PULL_UP:
2908 config = PIN_CONF_PACKED(mode, arg);
2909 return gc->set_config ? gc->set_config(gc, offset, config) : -ENOTSUPP;
2913 * gpiod_direction_input - set the GPIO direction to input
2914 * @desc: GPIO to set to input
2916 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2917 * be called safely on it.
2919 * Return 0 in case of success, else an error code.
2921 int gpiod_direction_input(struct gpio_desc *desc)
2923 struct gpio_chip *chip;
2926 VALIDATE_DESC(desc);
2927 chip = desc->gdev->chip;
2930 * It is legal to have no .get() and .direction_input() specified if
2931 * the chip is output-only, but you can't specify .direction_input()
2932 * and not support the .get() operation, that doesn't make sense.
2934 if (!chip->get && chip->direction_input) {
2936 "%s: missing get() but have direction_input()\n",
2942 * If we have a .direction_input() callback, things are simple,
2943 * just call it. Else we are some input-only chip so try to check the
2944 * direction (if .get_direction() is supported) else we silently
2945 * assume we are in input mode after this.
2947 if (chip->direction_input) {
2948 ret = chip->direction_input(chip, gpio_chip_hwgpio(desc));
2949 } else if (chip->get_direction &&
2950 (chip->get_direction(chip, gpio_chip_hwgpio(desc)) != 1)) {
2952 "%s: missing direction_input() operation and line is output\n",
2957 clear_bit(FLAG_IS_OUT, &desc->flags);
2959 if (test_bit(FLAG_PULL_UP, &desc->flags))
2960 gpio_set_config(chip, gpio_chip_hwgpio(desc),
2961 PIN_CONFIG_BIAS_PULL_UP);
2962 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2963 gpio_set_config(chip, gpio_chip_hwgpio(desc),
2964 PIN_CONFIG_BIAS_PULL_DOWN);
2966 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2970 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2972 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2974 struct gpio_chip *gc = desc->gdev->chip;
2979 * It's OK not to specify .direction_output() if the gpiochip is
2980 * output-only, but if there is then not even a .set() operation it
2981 * is pretty tricky to drive the output line.
2983 if (!gc->set && !gc->direction_output) {
2985 "%s: missing set() and direction_output() operations\n",
2990 if (gc->direction_output) {
2991 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2993 /* Check that we are in output mode if we can */
2994 if (gc->get_direction &&
2995 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2997 "%s: missing direction_output() operation\n",
3002 * If we can't actively set the direction, we are some
3003 * output-only chip, so just drive the output as desired.
3005 gc->set(gc, gpio_chip_hwgpio(desc), val);
3009 set_bit(FLAG_IS_OUT, &desc->flags);
3010 trace_gpio_value(desc_to_gpio(desc), 0, val);
3011 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
3016 * gpiod_direction_output_raw - set the GPIO direction to output
3017 * @desc: GPIO to set to output
3018 * @value: initial output value of the GPIO
3020 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
3021 * be called safely on it. The initial value of the output must be specified
3022 * as raw value on the physical line without regard for the ACTIVE_LOW status.
3024 * Return 0 in case of success, else an error code.
3026 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
3028 VALIDATE_DESC(desc);
3029 return gpiod_direction_output_raw_commit(desc, value);
3031 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
3034 * gpiod_direction_output - set the GPIO direction to output
3035 * @desc: GPIO to set to output
3036 * @value: initial output value of the GPIO
3038 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
3039 * be called safely on it. The initial value of the output must be specified
3040 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3043 * Return 0 in case of success, else an error code.
3045 int gpiod_direction_output(struct gpio_desc *desc, int value)
3047 struct gpio_chip *gc;
3050 VALIDATE_DESC(desc);
3051 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3056 /* GPIOs used for enabled IRQs shall not be set as output */
3057 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
3058 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
3060 "%s: tried to set a GPIO tied to an IRQ as output\n",
3065 gc = desc->gdev->chip;
3066 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3067 /* First see if we can enable open drain in hardware */
3068 ret = gpio_set_config(gc, gpio_chip_hwgpio(desc),
3069 PIN_CONFIG_DRIVE_OPEN_DRAIN);
3071 goto set_output_value;
3072 /* Emulate open drain by not actively driving the line high */
3074 ret = gpiod_direction_input(desc);
3075 goto set_output_flag;
3078 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
3079 ret = gpio_set_config(gc, gpio_chip_hwgpio(desc),
3080 PIN_CONFIG_DRIVE_OPEN_SOURCE);
3082 goto set_output_value;
3083 /* Emulate open source by not actively driving the line low */
3085 ret = gpiod_direction_input(desc);
3086 goto set_output_flag;
3089 gpio_set_config(gc, gpio_chip_hwgpio(desc),
3090 PIN_CONFIG_DRIVE_PUSH_PULL);
3094 return gpiod_direction_output_raw_commit(desc, value);
3098 * When emulating open-source or open-drain functionalities by not
3099 * actively driving the line (setting mode to input) we still need to
3100 * set the IS_OUT flag or otherwise we won't be able to set the line
3104 set_bit(FLAG_IS_OUT, &desc->flags);
3107 EXPORT_SYMBOL_GPL(gpiod_direction_output);
3110 * gpiod_set_debounce - sets @debounce time for a GPIO
3111 * @desc: descriptor of the GPIO for which to set debounce time
3112 * @debounce: debounce time in microseconds
3115 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
3118 int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
3120 struct gpio_chip *chip;
3121 unsigned long config;
3123 VALIDATE_DESC(desc);
3124 chip = desc->gdev->chip;
3125 if (!chip->set || !chip->set_config) {
3127 "%s: missing set() or set_config() operations\n",
3132 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
3133 return chip->set_config(chip, gpio_chip_hwgpio(desc), config);
3135 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
3138 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
3139 * @desc: descriptor of the GPIO for which to configure persistence
3140 * @transitory: True to lose state on suspend or reset, false for persistence
3143 * 0 on success, otherwise a negative error code.
3145 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
3147 struct gpio_chip *chip;
3148 unsigned long packed;
3152 VALIDATE_DESC(desc);
3154 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
3155 * persistence state.
3158 set_bit(FLAG_TRANSITORY, &desc->flags);
3160 clear_bit(FLAG_TRANSITORY, &desc->flags);
3162 /* If the driver supports it, set the persistence state now */
3163 chip = desc->gdev->chip;
3164 if (!chip->set_config)
3167 packed = pinconf_to_config_packed(PIN_CONFIG_PERSIST_STATE,
3169 gpio = gpio_chip_hwgpio(desc);
3170 rc = chip->set_config(chip, gpio, packed);
3171 if (rc == -ENOTSUPP) {
3172 dev_dbg(&desc->gdev->dev, "Persistence not supported for GPIO %d\n",
3179 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
3182 * gpiod_is_active_low - test whether a GPIO is active-low or not
3183 * @desc: the gpio descriptor to test
3185 * Returns 1 if the GPIO is active-low, 0 otherwise.
3187 int gpiod_is_active_low(const struct gpio_desc *desc)
3189 VALIDATE_DESC(desc);
3190 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
3192 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
3194 /* I/O calls are only valid after configuration completed; the relevant
3195 * "is this a valid GPIO" error checks should already have been done.
3197 * "Get" operations are often inlinable as reading a pin value register,
3198 * and masking the relevant bit in that register.
3200 * When "set" operations are inlinable, they involve writing that mask to
3201 * one register to set a low value, or a different register to set it high.
3202 * Otherwise locking is needed, so there may be little value to inlining.
3204 *------------------------------------------------------------------------
3206 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
3207 * have requested the GPIO. That can include implicit requesting by
3208 * a direction setting call. Marking a gpio as requested locks its chip
3209 * in memory, guaranteeing that these table lookups need no more locking
3210 * and that gpiochip_remove() will fail.
3212 * REVISIT when debugging, consider adding some instrumentation to ensure
3213 * that the GPIO was actually requested.
3216 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
3218 struct gpio_chip *chip;
3222 chip = desc->gdev->chip;
3223 offset = gpio_chip_hwgpio(desc);
3224 value = chip->get ? chip->get(chip, offset) : -EIO;
3225 value = value < 0 ? value : !!value;
3226 trace_gpio_value(desc_to_gpio(desc), 1, value);
3230 static int gpio_chip_get_multiple(struct gpio_chip *chip,
3231 unsigned long *mask, unsigned long *bits)
3233 if (chip->get_multiple) {
3234 return chip->get_multiple(chip, mask, bits);
3235 } else if (chip->get) {
3238 for_each_set_bit(i, mask, chip->ngpio) {
3239 value = chip->get(chip, i);
3242 __assign_bit(i, bits, value);
3249 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
3250 unsigned int array_size,
3251 struct gpio_desc **desc_array,
3252 struct gpio_array *array_info,
3253 unsigned long *value_bitmap)
3258 * Validate array_info against desc_array and its size.
3259 * It should immediately follow desc_array if both
3260 * have been obtained from the same gpiod_get_array() call.
3262 if (array_info && array_info->desc == desc_array &&
3263 array_size <= array_info->size &&
3264 (void *)array_info == desc_array + array_info->size) {
3266 WARN_ON(array_info->chip->can_sleep);
3268 ret = gpio_chip_get_multiple(array_info->chip,
3269 array_info->get_mask,
3274 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
3275 bitmap_xor(value_bitmap, value_bitmap,
3276 array_info->invert_mask, array_size);
3278 if (bitmap_full(array_info->get_mask, array_size))
3281 i = find_first_zero_bit(array_info->get_mask, array_size);
3286 while (i < array_size) {
3287 struct gpio_chip *chip = desc_array[i]->gdev->chip;
3288 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
3289 unsigned long *mask, *bits;
3292 if (likely(chip->ngpio <= FASTPATH_NGPIO)) {
3295 mask = kmalloc_array(2 * BITS_TO_LONGS(chip->ngpio),
3297 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
3302 bits = mask + BITS_TO_LONGS(chip->ngpio);
3303 bitmap_zero(mask, chip->ngpio);
3306 WARN_ON(chip->can_sleep);
3308 /* collect all inputs belonging to the same chip */
3311 const struct gpio_desc *desc = desc_array[i];
3312 int hwgpio = gpio_chip_hwgpio(desc);
3314 __set_bit(hwgpio, mask);
3318 i = find_next_zero_bit(array_info->get_mask,
3320 } while ((i < array_size) &&
3321 (desc_array[i]->gdev->chip == chip));
3323 ret = gpio_chip_get_multiple(chip, mask, bits);
3325 if (mask != fastpath)
3330 for (j = first; j < i; ) {
3331 const struct gpio_desc *desc = desc_array[j];
3332 int hwgpio = gpio_chip_hwgpio(desc);
3333 int value = test_bit(hwgpio, bits);
3335 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3337 __assign_bit(j, value_bitmap, value);
3338 trace_gpio_value(desc_to_gpio(desc), 1, value);
3342 j = find_next_zero_bit(array_info->get_mask, i,
3346 if (mask != fastpath)
3353 * gpiod_get_raw_value() - return a gpio's raw value
3354 * @desc: gpio whose value will be returned
3356 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3357 * its ACTIVE_LOW status, or negative errno on failure.
3359 * This function can be called from contexts where we cannot sleep, and will
3360 * complain if the GPIO chip functions potentially sleep.
3362 int gpiod_get_raw_value(const struct gpio_desc *desc)
3364 VALIDATE_DESC(desc);
3365 /* Should be using gpiod_get_raw_value_cansleep() */
3366 WARN_ON(desc->gdev->chip->can_sleep);
3367 return gpiod_get_raw_value_commit(desc);
3369 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
3372 * gpiod_get_value() - return a gpio's value
3373 * @desc: gpio whose value will be returned
3375 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3376 * account, or negative errno on failure.
3378 * This function can be called from contexts where we cannot sleep, and will
3379 * complain if the GPIO chip functions potentially sleep.
3381 int gpiod_get_value(const struct gpio_desc *desc)
3385 VALIDATE_DESC(desc);
3386 /* Should be using gpiod_get_value_cansleep() */
3387 WARN_ON(desc->gdev->chip->can_sleep);
3389 value = gpiod_get_raw_value_commit(desc);
3393 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3398 EXPORT_SYMBOL_GPL(gpiod_get_value);
3401 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
3402 * @array_size: number of elements in the descriptor array / value bitmap
3403 * @desc_array: array of GPIO descriptors whose values will be read
3404 * @array_info: information on applicability of fast bitmap processing path
3405 * @value_bitmap: bitmap to store the read values
3407 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3408 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3409 * else an error code.
3411 * This function can be called from contexts where we cannot sleep,
3412 * and it will complain if the GPIO chip functions potentially sleep.
3414 int gpiod_get_raw_array_value(unsigned int array_size,
3415 struct gpio_desc **desc_array,
3416 struct gpio_array *array_info,
3417 unsigned long *value_bitmap)
3421 return gpiod_get_array_value_complex(true, false, array_size,
3422 desc_array, array_info,
3425 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
3428 * gpiod_get_array_value() - read values from an array of GPIOs
3429 * @array_size: number of elements in the descriptor array / value bitmap
3430 * @desc_array: array of GPIO descriptors whose values will be read
3431 * @array_info: information on applicability of fast bitmap processing path
3432 * @value_bitmap: bitmap to store the read values
3434 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3435 * into account. Return 0 in case of success, else an error code.
3437 * This function can be called from contexts where we cannot sleep,
3438 * and it will complain if the GPIO chip functions potentially sleep.
3440 int gpiod_get_array_value(unsigned int array_size,
3441 struct gpio_desc **desc_array,
3442 struct gpio_array *array_info,
3443 unsigned long *value_bitmap)
3447 return gpiod_get_array_value_complex(false, false, array_size,
3448 desc_array, array_info,
3451 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
3454 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
3455 * @desc: gpio descriptor whose state need to be set.
3456 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
3458 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
3461 struct gpio_chip *chip = desc->gdev->chip;
3462 int offset = gpio_chip_hwgpio(desc);
3465 ret = chip->direction_input(chip, offset);
3467 ret = chip->direction_output(chip, offset, 0);
3469 set_bit(FLAG_IS_OUT, &desc->flags);
3471 trace_gpio_direction(desc_to_gpio(desc), value, ret);
3474 "%s: Error in set_value for open drain err %d\n",
3479 * _gpio_set_open_source_value() - Set the open source gpio's value.
3480 * @desc: gpio descriptor whose state need to be set.
3481 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
3483 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
3486 struct gpio_chip *chip = desc->gdev->chip;
3487 int offset = gpio_chip_hwgpio(desc);
3490 ret = chip->direction_output(chip, offset, 1);
3492 set_bit(FLAG_IS_OUT, &desc->flags);
3494 ret = chip->direction_input(chip, offset);
3496 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
3499 "%s: Error in set_value for open source err %d\n",
3503 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
3505 struct gpio_chip *chip;
3507 chip = desc->gdev->chip;
3508 trace_gpio_value(desc_to_gpio(desc), 0, value);
3509 chip->set(chip, gpio_chip_hwgpio(desc), value);
3513 * set multiple outputs on the same chip;
3514 * use the chip's set_multiple function if available;
3515 * otherwise set the outputs sequentially;
3516 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
3517 * defines which outputs are to be changed
3518 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
3519 * defines the values the outputs specified by mask are to be set to
3521 static void gpio_chip_set_multiple(struct gpio_chip *chip,
3522 unsigned long *mask, unsigned long *bits)
3524 if (chip->set_multiple) {
3525 chip->set_multiple(chip, mask, bits);
3529 /* set outputs if the corresponding mask bit is set */
3530 for_each_set_bit(i, mask, chip->ngpio)
3531 chip->set(chip, i, test_bit(i, bits));
3535 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
3536 unsigned int array_size,
3537 struct gpio_desc **desc_array,
3538 struct gpio_array *array_info,
3539 unsigned long *value_bitmap)
3544 * Validate array_info against desc_array and its size.
3545 * It should immediately follow desc_array if both
3546 * have been obtained from the same gpiod_get_array() call.
3548 if (array_info && array_info->desc == desc_array &&
3549 array_size <= array_info->size &&
3550 (void *)array_info == desc_array + array_info->size) {
3552 WARN_ON(array_info->chip->can_sleep);
3554 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
3555 bitmap_xor(value_bitmap, value_bitmap,
3556 array_info->invert_mask, array_size);
3558 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
3561 if (bitmap_full(array_info->set_mask, array_size))
3564 i = find_first_zero_bit(array_info->set_mask, array_size);
3569 while (i < array_size) {
3570 struct gpio_chip *chip = desc_array[i]->gdev->chip;
3571 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
3572 unsigned long *mask, *bits;
3575 if (likely(chip->ngpio <= FASTPATH_NGPIO)) {
3578 mask = kmalloc_array(2 * BITS_TO_LONGS(chip->ngpio),
3580 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
3585 bits = mask + BITS_TO_LONGS(chip->ngpio);
3586 bitmap_zero(mask, chip->ngpio);
3589 WARN_ON(chip->can_sleep);
3592 struct gpio_desc *desc = desc_array[i];
3593 int hwgpio = gpio_chip_hwgpio(desc);
3594 int value = test_bit(i, value_bitmap);
3597 * Pins applicable for fast input but not for
3598 * fast output processing may have been already
3599 * inverted inside the fast path, skip them.
3601 if (!raw && !(array_info &&
3602 test_bit(i, array_info->invert_mask)) &&
3603 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3605 trace_gpio_value(desc_to_gpio(desc), 0, value);
3607 * collect all normal outputs belonging to the same chip
3608 * open drain and open source outputs are set individually
3610 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
3611 gpio_set_open_drain_value_commit(desc, value);
3612 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
3613 gpio_set_open_source_value_commit(desc, value);
3615 __set_bit(hwgpio, mask);
3617 __set_bit(hwgpio, bits);
3619 __clear_bit(hwgpio, bits);
3625 i = find_next_zero_bit(array_info->set_mask,
3627 } while ((i < array_size) &&
3628 (desc_array[i]->gdev->chip == chip));
3629 /* push collected bits to outputs */
3631 gpio_chip_set_multiple(chip, mask, bits);
3633 if (mask != fastpath)
3640 * gpiod_set_raw_value() - assign a gpio's raw value
3641 * @desc: gpio whose value will be assigned
3642 * @value: value to assign
3644 * Set the raw value of the GPIO, i.e. the value of its physical line without
3645 * regard for its ACTIVE_LOW status.
3647 * This function can be called from contexts where we cannot sleep, and will
3648 * complain if the GPIO chip functions potentially sleep.
3650 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
3652 VALIDATE_DESC_VOID(desc);
3653 /* Should be using gpiod_set_raw_value_cansleep() */
3654 WARN_ON(desc->gdev->chip->can_sleep);
3655 gpiod_set_raw_value_commit(desc, value);
3657 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
3660 * gpiod_set_value_nocheck() - set a GPIO line value without checking
3661 * @desc: the descriptor to set the value on
3662 * @value: value to set
3664 * This sets the value of a GPIO line backing a descriptor, applying
3665 * different semantic quirks like active low and open drain/source
3668 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
3670 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3672 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
3673 gpio_set_open_drain_value_commit(desc, value);
3674 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
3675 gpio_set_open_source_value_commit(desc, value);
3677 gpiod_set_raw_value_commit(desc, value);
3681 * gpiod_set_value() - assign a gpio's value
3682 * @desc: gpio whose value will be assigned
3683 * @value: value to assign
3685 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
3686 * OPEN_DRAIN and OPEN_SOURCE flags into account.
3688 * This function can be called from contexts where we cannot sleep, and will
3689 * complain if the GPIO chip functions potentially sleep.
3691 void gpiod_set_value(struct gpio_desc *desc, int value)
3693 VALIDATE_DESC_VOID(desc);
3694 /* Should be using gpiod_set_value_cansleep() */
3695 WARN_ON(desc->gdev->chip->can_sleep);
3696 gpiod_set_value_nocheck(desc, value);
3698 EXPORT_SYMBOL_GPL(gpiod_set_value);
3701 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
3702 * @array_size: number of elements in the descriptor array / value bitmap
3703 * @desc_array: array of GPIO descriptors whose values will be assigned
3704 * @array_info: information on applicability of fast bitmap processing path
3705 * @value_bitmap: bitmap of values to assign
3707 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3708 * without regard for their ACTIVE_LOW status.
3710 * This function can be called from contexts where we cannot sleep, and will
3711 * complain if the GPIO chip functions potentially sleep.
3713 int gpiod_set_raw_array_value(unsigned int array_size,
3714 struct gpio_desc **desc_array,
3715 struct gpio_array *array_info,
3716 unsigned long *value_bitmap)
3720 return gpiod_set_array_value_complex(true, false, array_size,
3721 desc_array, array_info, value_bitmap);
3723 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
3726 * gpiod_set_array_value() - assign values to an array of GPIOs
3727 * @array_size: number of elements in the descriptor array / value bitmap
3728 * @desc_array: array of GPIO descriptors whose values will be assigned
3729 * @array_info: information on applicability of fast bitmap processing path
3730 * @value_bitmap: bitmap of values to assign
3732 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3735 * This function can be called from contexts where we cannot sleep, and will
3736 * complain if the GPIO chip functions potentially sleep.
3738 int gpiod_set_array_value(unsigned int array_size,
3739 struct gpio_desc **desc_array,
3740 struct gpio_array *array_info,
3741 unsigned long *value_bitmap)
3745 return gpiod_set_array_value_complex(false, false, array_size,
3746 desc_array, array_info,
3749 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3752 * gpiod_cansleep() - report whether gpio value access may sleep
3753 * @desc: gpio to check
3756 int gpiod_cansleep(const struct gpio_desc *desc)
3758 VALIDATE_DESC(desc);
3759 return desc->gdev->chip->can_sleep;
3761 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3764 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3765 * @desc: gpio to set the consumer name on
3766 * @name: the new consumer name
3768 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3770 VALIDATE_DESC(desc);
3772 name = kstrdup_const(name, GFP_KERNEL);
3777 kfree_const(desc->label);
3778 desc_set_label(desc, name);
3782 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3785 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3786 * @desc: gpio whose IRQ will be returned (already requested)
3788 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3791 int gpiod_to_irq(const struct gpio_desc *desc)
3793 struct gpio_chip *chip;
3797 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3798 * requires this function to not return zero on an invalid descriptor
3799 * but rather a negative error number.
3801 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3804 chip = desc->gdev->chip;
3805 offset = gpio_chip_hwgpio(desc);
3807 int retirq = chip->to_irq(chip, offset);
3809 /* Zero means NO_IRQ */
3817 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3820 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3821 * @chip: the chip the GPIO to lock belongs to
3822 * @offset: the offset of the GPIO to lock as IRQ
3824 * This is used directly by GPIO drivers that want to lock down
3825 * a certain GPIO line to be used for IRQs.
3827 int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
3829 struct gpio_desc *desc;
3831 desc = gpiochip_get_desc(chip, offset);
3833 return PTR_ERR(desc);
3836 * If it's fast: flush the direction setting if something changed
3839 if (!chip->can_sleep && chip->get_direction) {
3840 int dir = gpiod_get_direction(desc);
3843 chip_err(chip, "%s: cannot get GPIO direction\n",
3849 if (test_bit(FLAG_IS_OUT, &desc->flags)) {
3851 "%s: tried to flag a GPIO set as output for IRQ\n",
3856 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3857 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3860 * If the consumer has not set up a label (such as when the
3861 * IRQ is referenced from .to_irq()) we set up a label here
3862 * so it is clear this is used as an interrupt.
3865 desc_set_label(desc, "interrupt");
3869 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3872 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3873 * @chip: the chip the GPIO to lock belongs to
3874 * @offset: the offset of the GPIO to lock as IRQ
3876 * This is used directly by GPIO drivers that want to indicate
3877 * that a certain GPIO is no longer used exclusively for IRQ.
3879 void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
3881 struct gpio_desc *desc;
3883 desc = gpiochip_get_desc(chip, offset);
3887 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3888 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3890 /* If we only had this marking, erase it */
3891 if (desc->label && !strcmp(desc->label, "interrupt"))
3892 desc_set_label(desc, NULL);
3894 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3896 void gpiochip_disable_irq(struct gpio_chip *chip, unsigned int offset)
3898 struct gpio_desc *desc = gpiochip_get_desc(chip, offset);
3900 if (!IS_ERR(desc) &&
3901 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3902 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3904 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3906 void gpiochip_enable_irq(struct gpio_chip *chip, unsigned int offset)
3908 struct gpio_desc *desc = gpiochip_get_desc(chip, offset);
3910 if (!IS_ERR(desc) &&
3911 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3912 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags));
3913 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3916 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3918 bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
3920 if (offset >= chip->ngpio)
3923 return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
3925 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3927 int gpiochip_reqres_irq(struct gpio_chip *chip, unsigned int offset)
3931 if (!try_module_get(chip->gpiodev->owner))
3934 ret = gpiochip_lock_as_irq(chip, offset);
3936 chip_err(chip, "unable to lock HW IRQ %u for IRQ\n", offset);
3937 module_put(chip->gpiodev->owner);
3942 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3944 void gpiochip_relres_irq(struct gpio_chip *chip, unsigned int offset)
3946 gpiochip_unlock_as_irq(chip, offset);
3947 module_put(chip->gpiodev->owner);
3949 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3951 bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
3953 if (offset >= chip->ngpio)
3956 return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
3958 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3960 bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
3962 if (offset >= chip->ngpio)
3965 return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
3967 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3969 bool gpiochip_line_is_persistent(struct gpio_chip *chip, unsigned int offset)
3971 if (offset >= chip->ngpio)
3974 return !test_bit(FLAG_TRANSITORY, &chip->gpiodev->descs[offset].flags);
3976 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3979 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3980 * @desc: gpio whose value will be returned
3982 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3983 * its ACTIVE_LOW status, or negative errno on failure.
3985 * This function is to be called from contexts that can sleep.
3987 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3989 might_sleep_if(extra_checks);
3990 VALIDATE_DESC(desc);
3991 return gpiod_get_raw_value_commit(desc);
3993 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3996 * gpiod_get_value_cansleep() - return a gpio's value
3997 * @desc: gpio whose value will be returned
3999 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
4000 * account, or negative errno on failure.
4002 * This function is to be called from contexts that can sleep.
4004 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
4008 might_sleep_if(extra_checks);
4009 VALIDATE_DESC(desc);
4010 value = gpiod_get_raw_value_commit(desc);
4014 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
4019 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
4022 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
4023 * @array_size: number of elements in the descriptor array / value bitmap
4024 * @desc_array: array of GPIO descriptors whose values will be read
4025 * @array_info: information on applicability of fast bitmap processing path
4026 * @value_bitmap: bitmap to store the read values
4028 * Read the raw values of the GPIOs, i.e. the values of the physical lines
4029 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
4030 * else an error code.
4032 * This function is to be called from contexts that can sleep.
4034 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
4035 struct gpio_desc **desc_array,
4036 struct gpio_array *array_info,
4037 unsigned long *value_bitmap)
4039 might_sleep_if(extra_checks);
4042 return gpiod_get_array_value_complex(true, true, array_size,
4043 desc_array, array_info,
4046 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
4049 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
4050 * @array_size: number of elements in the descriptor array / value bitmap
4051 * @desc_array: array of GPIO descriptors whose values will be read
4052 * @array_info: information on applicability of fast bitmap processing path
4053 * @value_bitmap: bitmap to store the read values
4055 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
4056 * into account. Return 0 in case of success, else an error code.
4058 * This function is to be called from contexts that can sleep.
4060 int gpiod_get_array_value_cansleep(unsigned int array_size,
4061 struct gpio_desc **desc_array,
4062 struct gpio_array *array_info,
4063 unsigned long *value_bitmap)
4065 might_sleep_if(extra_checks);
4068 return gpiod_get_array_value_complex(false, true, array_size,
4069 desc_array, array_info,
4072 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
4075 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
4076 * @desc: gpio whose value will be assigned
4077 * @value: value to assign
4079 * Set the raw value of the GPIO, i.e. the value of its physical line without
4080 * regard for its ACTIVE_LOW status.
4082 * This function is to be called from contexts that can sleep.
4084 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
4086 might_sleep_if(extra_checks);
4087 VALIDATE_DESC_VOID(desc);
4088 gpiod_set_raw_value_commit(desc, value);
4090 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
4093 * gpiod_set_value_cansleep() - assign a gpio's value
4094 * @desc: gpio whose value will be assigned
4095 * @value: value to assign
4097 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
4100 * This function is to be called from contexts that can sleep.
4102 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
4104 might_sleep_if(extra_checks);
4105 VALIDATE_DESC_VOID(desc);
4106 gpiod_set_value_nocheck(desc, value);
4108 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
4111 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
4112 * @array_size: number of elements in the descriptor array / value bitmap
4113 * @desc_array: array of GPIO descriptors whose values will be assigned
4114 * @array_info: information on applicability of fast bitmap processing path
4115 * @value_bitmap: bitmap of values to assign
4117 * Set the raw values of the GPIOs, i.e. the values of the physical lines
4118 * without regard for their ACTIVE_LOW status.
4120 * This function is to be called from contexts that can sleep.
4122 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
4123 struct gpio_desc **desc_array,
4124 struct gpio_array *array_info,
4125 unsigned long *value_bitmap)
4127 might_sleep_if(extra_checks);
4130 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
4131 array_info, value_bitmap);
4133 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
4136 * gpiod_add_lookup_tables() - register GPIO device consumers
4137 * @tables: list of tables of consumers to register
4138 * @n: number of tables in the list
4140 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
4144 mutex_lock(&gpio_lookup_lock);
4146 for (i = 0; i < n; i++)
4147 list_add_tail(&tables[i]->list, &gpio_lookup_list);
4149 mutex_unlock(&gpio_lookup_lock);
4153 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
4154 * @array_size: number of elements in the descriptor array / value bitmap
4155 * @desc_array: array of GPIO descriptors whose values will be assigned
4156 * @array_info: information on applicability of fast bitmap processing path
4157 * @value_bitmap: bitmap of values to assign
4159 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
4162 * This function is to be called from contexts that can sleep.
4164 int gpiod_set_array_value_cansleep(unsigned int array_size,
4165 struct gpio_desc **desc_array,
4166 struct gpio_array *array_info,
4167 unsigned long *value_bitmap)
4169 might_sleep_if(extra_checks);
4172 return gpiod_set_array_value_complex(false, true, array_size,
4173 desc_array, array_info,
4176 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
4179 * gpiod_add_lookup_table() - register GPIO device consumers
4180 * @table: table of consumers to register
4182 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
4184 mutex_lock(&gpio_lookup_lock);
4186 list_add_tail(&table->list, &gpio_lookup_list);
4188 mutex_unlock(&gpio_lookup_lock);
4190 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
4193 * gpiod_remove_lookup_table() - unregister GPIO device consumers
4194 * @table: table of consumers to unregister
4196 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
4198 mutex_lock(&gpio_lookup_lock);
4200 list_del(&table->list);
4202 mutex_unlock(&gpio_lookup_lock);
4204 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
4207 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
4208 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
4210 void gpiod_add_hogs(struct gpiod_hog *hogs)
4212 struct gpio_chip *chip;
4213 struct gpiod_hog *hog;
4215 mutex_lock(&gpio_machine_hogs_mutex);
4217 for (hog = &hogs[0]; hog->chip_label; hog++) {
4218 list_add_tail(&hog->list, &gpio_machine_hogs);
4221 * The chip may have been registered earlier, so check if it
4222 * exists and, if so, try to hog the line now.
4224 chip = find_chip_by_name(hog->chip_label);
4226 gpiochip_machine_hog(chip, hog);
4229 mutex_unlock(&gpio_machine_hogs_mutex);
4231 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
4233 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
4235 const char *dev_id = dev ? dev_name(dev) : NULL;
4236 struct gpiod_lookup_table *table;
4238 mutex_lock(&gpio_lookup_lock);
4240 list_for_each_entry(table, &gpio_lookup_list, list) {
4241 if (table->dev_id && dev_id) {
4243 * Valid strings on both ends, must be identical to have
4246 if (!strcmp(table->dev_id, dev_id))
4250 * One of the pointers is NULL, so both must be to have
4253 if (dev_id == table->dev_id)
4260 mutex_unlock(&gpio_lookup_lock);
4264 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
4265 unsigned int idx, unsigned long *flags)
4267 struct gpio_desc *desc = ERR_PTR(-ENOENT);
4268 struct gpiod_lookup_table *table;
4269 struct gpiod_lookup *p;
4271 table = gpiod_find_lookup_table(dev);
4275 for (p = &table->table[0]; p->chip_label; p++) {
4276 struct gpio_chip *chip;
4278 /* idx must always match exactly */
4282 /* If the lookup entry has a con_id, require exact match */
4283 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
4286 chip = find_chip_by_name(p->chip_label);
4290 * As the lookup table indicates a chip with
4291 * p->chip_label should exist, assume it may
4292 * still appear later and let the interested
4293 * consumer be probed again or let the Deferred
4294 * Probe infrastructure handle the error.
4296 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
4298 return ERR_PTR(-EPROBE_DEFER);
4301 if (chip->ngpio <= p->chip_hwnum) {
4303 "requested GPIO %d is out of range [0..%d] for chip %s\n",
4304 idx, chip->ngpio, chip->label);
4305 return ERR_PTR(-EINVAL);
4308 desc = gpiochip_get_desc(chip, p->chip_hwnum);
4317 static int platform_gpio_count(struct device *dev, const char *con_id)
4319 struct gpiod_lookup_table *table;
4320 struct gpiod_lookup *p;
4321 unsigned int count = 0;
4323 table = gpiod_find_lookup_table(dev);
4327 for (p = &table->table[0]; p->chip_label; p++) {
4328 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
4329 (!con_id && !p->con_id))
4339 * gpiod_count - return the number of GPIOs associated with a device / function
4340 * or -ENOENT if no GPIO has been assigned to the requested function
4341 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4342 * @con_id: function within the GPIO consumer
4344 int gpiod_count(struct device *dev, const char *con_id)
4346 int count = -ENOENT;
4348 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
4349 count = of_gpio_get_count(dev, con_id);
4350 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
4351 count = acpi_gpio_count(dev, con_id);
4354 count = platform_gpio_count(dev, con_id);
4358 EXPORT_SYMBOL_GPL(gpiod_count);
4361 * gpiod_get - obtain a GPIO for a given GPIO function
4362 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4363 * @con_id: function within the GPIO consumer
4364 * @flags: optional GPIO initialization flags
4366 * Return the GPIO descriptor corresponding to the function con_id of device
4367 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
4368 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
4370 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
4371 enum gpiod_flags flags)
4373 return gpiod_get_index(dev, con_id, 0, flags);
4375 EXPORT_SYMBOL_GPL(gpiod_get);
4378 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
4379 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4380 * @con_id: function within the GPIO consumer
4381 * @flags: optional GPIO initialization flags
4383 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
4384 * the requested function it will return NULL. This is convenient for drivers
4385 * that need to handle optional GPIOs.
4387 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
4389 enum gpiod_flags flags)
4391 return gpiod_get_index_optional(dev, con_id, 0, flags);
4393 EXPORT_SYMBOL_GPL(gpiod_get_optional);
4397 * gpiod_configure_flags - helper function to configure a given GPIO
4398 * @desc: gpio whose value will be assigned
4399 * @con_id: function within the GPIO consumer
4400 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4401 * of_find_gpio() or of_get_gpio_hog()
4402 * @dflags: gpiod_flags - optional GPIO initialization flags
4404 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
4405 * requested function and/or index, or another IS_ERR() code if an error
4406 * occurred while trying to acquire the GPIO.
4408 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
4409 unsigned long lflags, enum gpiod_flags dflags)
4413 if (lflags & GPIO_ACTIVE_LOW)
4414 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
4416 if (lflags & GPIO_OPEN_DRAIN)
4417 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
4418 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
4420 * This enforces open drain mode from the consumer side.
4421 * This is necessary for some busses like I2C, but the lookup
4422 * should *REALLY* have specified them as open drain in the
4423 * first place, so print a little warning here.
4425 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
4427 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
4430 if (lflags & GPIO_OPEN_SOURCE)
4431 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
4433 if ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) {
4435 "both pull-up and pull-down enabled, invalid configuration\n");
4439 if (lflags & GPIO_PULL_UP)
4440 set_bit(FLAG_PULL_UP, &desc->flags);
4441 else if (lflags & GPIO_PULL_DOWN)
4442 set_bit(FLAG_PULL_DOWN, &desc->flags);
4444 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
4448 /* No particular flag request, return here... */
4449 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
4450 pr_debug("no flags found for %s\n", con_id);
4455 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
4456 ret = gpiod_direction_output(desc,
4457 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
4459 ret = gpiod_direction_input(desc);
4465 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
4466 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4467 * @con_id: function within the GPIO consumer
4468 * @idx: index of the GPIO to obtain in the consumer
4469 * @flags: optional GPIO initialization flags
4471 * This variant of gpiod_get() allows to access GPIOs other than the first
4472 * defined one for functions that define several GPIOs.
4474 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
4475 * requested function and/or index, or another IS_ERR() code if an error
4476 * occurred while trying to acquire the GPIO.
4478 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
4481 enum gpiod_flags flags)
4483 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
4484 struct gpio_desc *desc = NULL;
4486 /* Maybe we have a device name, maybe not */
4487 const char *devname = dev ? dev_name(dev) : "?";
4489 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
4492 /* Using device tree? */
4493 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
4494 dev_dbg(dev, "using device tree for GPIO lookup\n");
4495 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
4496 } else if (ACPI_COMPANION(dev)) {
4497 dev_dbg(dev, "using ACPI for GPIO lookup\n");
4498 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
4503 * Either we are not using DT or ACPI, or their lookup did not return
4504 * a result. In that case, use platform lookup as a fallback.
4506 if (!desc || desc == ERR_PTR(-ENOENT)) {
4507 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
4508 desc = gpiod_find(dev, con_id, idx, &lookupflags);
4512 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
4517 * If a connection label was passed use that, else attempt to use
4518 * the device name as label
4520 ret = gpiod_request(desc, con_id ? con_id : devname);
4522 if (ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
4524 * This happens when there are several consumers for
4525 * the same GPIO line: we just return here without
4526 * further initialization. It is a bit if a hack.
4527 * This is necessary to support fixed regulators.
4529 * FIXME: Make this more sane and safe.
4531 dev_info(dev, "nonexclusive access to GPIO for %s\n",
4532 con_id ? con_id : devname);
4535 return ERR_PTR(ret);
4539 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
4541 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
4543 return ERR_PTR(ret);
4548 EXPORT_SYMBOL_GPL(gpiod_get_index);
4551 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
4552 * @fwnode: handle of the firmware node
4553 * @propname: name of the firmware property representing the GPIO
4554 * @index: index of the GPIO to obtain for the consumer
4555 * @dflags: GPIO initialization flags
4556 * @label: label to attach to the requested GPIO
4558 * This function can be used for drivers that get their configuration
4559 * from opaque firmware.
4561 * The function properly finds the corresponding GPIO using whatever is the
4562 * underlying firmware interface and then makes sure that the GPIO
4563 * descriptor is requested before it is returned to the caller.
4566 * On successful request the GPIO pin is configured in accordance with
4569 * In case of error an ERR_PTR() is returned.
4571 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
4572 const char *propname, int index,
4573 enum gpiod_flags dflags,
4576 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
4577 struct gpio_desc *desc = ERR_PTR(-ENODEV);
4581 return ERR_PTR(-EINVAL);
4583 if (is_of_node(fwnode)) {
4584 desc = gpiod_get_from_of_node(to_of_node(fwnode),
4589 } else if (is_acpi_node(fwnode)) {
4590 struct acpi_gpio_info info;
4592 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
4596 acpi_gpio_update_gpiod_flags(&dflags, &info);
4597 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
4600 /* Currently only ACPI takes this path */
4601 ret = gpiod_request(desc, label);
4603 return ERR_PTR(ret);
4605 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
4608 return ERR_PTR(ret);
4613 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
4616 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
4618 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4619 * @con_id: function within the GPIO consumer
4620 * @index: index of the GPIO to obtain in the consumer
4621 * @flags: optional GPIO initialization flags
4623 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
4624 * specified index was assigned to the requested function it will return NULL.
4625 * This is convenient for drivers that need to handle optional GPIOs.
4627 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
4630 enum gpiod_flags flags)
4632 struct gpio_desc *desc;
4634 desc = gpiod_get_index(dev, con_id, index, flags);
4636 if (PTR_ERR(desc) == -ENOENT)
4642 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
4645 * gpiod_hog - Hog the specified GPIO desc given the provided flags
4646 * @desc: gpio whose value will be assigned
4647 * @name: gpio line name
4648 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4649 * of_find_gpio() or of_get_gpio_hog()
4650 * @dflags: gpiod_flags - optional GPIO initialization flags
4652 int gpiod_hog(struct gpio_desc *desc, const char *name,
4653 unsigned long lflags, enum gpiod_flags dflags)
4655 struct gpio_chip *chip;
4656 struct gpio_desc *local_desc;
4660 chip = gpiod_to_chip(desc);
4661 hwnum = gpio_chip_hwgpio(desc);
4663 local_desc = gpiochip_request_own_desc(chip, hwnum, name,
4665 if (IS_ERR(local_desc)) {
4666 ret = PTR_ERR(local_desc);
4667 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4668 name, chip->label, hwnum, ret);
4672 /* Mark GPIO as hogged so it can be identified and removed later */
4673 set_bit(FLAG_IS_HOGGED, &desc->flags);
4675 pr_info("GPIO line %d (%s) hogged as %s%s\n",
4676 desc_to_gpio(desc), name,
4677 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4678 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
4679 (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
4685 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4686 * @chip: gpio chip to act on
4688 static void gpiochip_free_hogs(struct gpio_chip *chip)
4692 for (id = 0; id < chip->ngpio; id++) {
4693 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
4694 gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
4699 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4700 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4701 * @con_id: function within the GPIO consumer
4702 * @flags: optional GPIO initialization flags
4704 * This function acquires all the GPIOs defined under a given function.
4706 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4707 * no GPIO has been assigned to the requested function, or another IS_ERR()
4708 * code if an error occurred while trying to acquire the GPIOs.
4710 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4712 enum gpiod_flags flags)
4714 struct gpio_desc *desc;
4715 struct gpio_descs *descs;
4716 struct gpio_array *array_info = NULL;
4717 struct gpio_chip *chip;
4718 int count, bitmap_size;
4720 count = gpiod_count(dev, con_id);
4722 return ERR_PTR(count);
4724 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4726 return ERR_PTR(-ENOMEM);
4728 for (descs->ndescs = 0; descs->ndescs < count; ) {
4729 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4731 gpiod_put_array(descs);
4732 return ERR_CAST(desc);
4735 descs->desc[descs->ndescs] = desc;
4737 chip = gpiod_to_chip(desc);
4739 * If pin hardware number of array member 0 is also 0, select
4740 * its chip as a candidate for fast bitmap processing path.
4742 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4743 struct gpio_descs *array;
4745 bitmap_size = BITS_TO_LONGS(chip->ngpio > count ?
4746 chip->ngpio : count);
4748 array = kzalloc(struct_size(descs, desc, count) +
4749 struct_size(array_info, invert_mask,
4750 3 * bitmap_size), GFP_KERNEL);
4752 gpiod_put_array(descs);
4753 return ERR_PTR(-ENOMEM);
4756 memcpy(array, descs,
4757 struct_size(descs, desc, descs->ndescs + 1));
4761 array_info = (void *)(descs->desc + count);
4762 array_info->get_mask = array_info->invert_mask +
4764 array_info->set_mask = array_info->get_mask +
4767 array_info->desc = descs->desc;
4768 array_info->size = count;
4769 array_info->chip = chip;
4770 bitmap_set(array_info->get_mask, descs->ndescs,
4771 count - descs->ndescs);
4772 bitmap_set(array_info->set_mask, descs->ndescs,
4773 count - descs->ndescs);
4774 descs->info = array_info;
4776 /* Unmark array members which don't belong to the 'fast' chip */
4777 if (array_info && array_info->chip != chip) {
4778 __clear_bit(descs->ndescs, array_info->get_mask);
4779 __clear_bit(descs->ndescs, array_info->set_mask);
4782 * Detect array members which belong to the 'fast' chip
4783 * but their pins are not in hardware order.
4785 else if (array_info &&
4786 gpio_chip_hwgpio(desc) != descs->ndescs) {
4788 * Don't use fast path if all array members processed so
4789 * far belong to the same chip as this one but its pin
4790 * hardware number is different from its array index.
4792 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4795 __clear_bit(descs->ndescs,
4796 array_info->get_mask);
4797 __clear_bit(descs->ndescs,
4798 array_info->set_mask);
4800 } else if (array_info) {
4801 /* Exclude open drain or open source from fast output */
4802 if (gpiochip_line_is_open_drain(chip, descs->ndescs) ||
4803 gpiochip_line_is_open_source(chip, descs->ndescs))
4804 __clear_bit(descs->ndescs,
4805 array_info->set_mask);
4806 /* Identify 'fast' pins which require invertion */
4807 if (gpiod_is_active_low(desc))
4808 __set_bit(descs->ndescs,
4809 array_info->invert_mask);
4816 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4817 array_info->chip->label, array_info->size,
4818 *array_info->get_mask, *array_info->set_mask,
4819 *array_info->invert_mask);
4822 EXPORT_SYMBOL_GPL(gpiod_get_array);
4825 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4827 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4828 * @con_id: function within the GPIO consumer
4829 * @flags: optional GPIO initialization flags
4831 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4832 * assigned to the requested function it will return NULL.
4834 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4836 enum gpiod_flags flags)
4838 struct gpio_descs *descs;
4840 descs = gpiod_get_array(dev, con_id, flags);
4841 if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
4846 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4849 * gpiod_put - dispose of a GPIO descriptor
4850 * @desc: GPIO descriptor to dispose of
4852 * No descriptor can be used after gpiod_put() has been called on it.
4854 void gpiod_put(struct gpio_desc *desc)
4859 EXPORT_SYMBOL_GPL(gpiod_put);
4862 * gpiod_put_array - dispose of multiple GPIO descriptors
4863 * @descs: struct gpio_descs containing an array of descriptors
4865 void gpiod_put_array(struct gpio_descs *descs)
4869 for (i = 0; i < descs->ndescs; i++)
4870 gpiod_put(descs->desc[i]);
4874 EXPORT_SYMBOL_GPL(gpiod_put_array);
4876 static int __init gpiolib_dev_init(void)
4880 /* Register GPIO sysfs bus */
4881 ret = bus_register(&gpio_bus_type);
4883 pr_err("gpiolib: could not register GPIO bus type\n");
4887 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
4889 pr_err("gpiolib: failed to allocate char dev region\n");
4890 bus_unregister(&gpio_bus_type);
4892 gpiolib_initialized = true;
4893 gpiochip_setup_devs();
4897 core_initcall(gpiolib_dev_init);
4899 #ifdef CONFIG_DEBUG_FS
4901 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4904 struct gpio_chip *chip = gdev->chip;
4905 unsigned gpio = gdev->base;
4906 struct gpio_desc *gdesc = &gdev->descs[0];
4911 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4912 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4914 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4920 gpiod_get_direction(gdesc);
4921 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4922 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4923 active_low = test_bit(FLAG_ACTIVE_LOW, &gdesc->flags);
4924 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s",
4925 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4926 is_out ? "out" : "in ",
4927 chip->get ? (chip->get(chip, i) ? "hi" : "lo") : "? ",
4928 is_irq ? "IRQ " : "",
4929 active_low ? "ACTIVE LOW" : "");
4930 seq_printf(s, "\n");
4934 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4936 unsigned long flags;
4937 struct gpio_device *gdev = NULL;
4938 loff_t index = *pos;
4942 spin_lock_irqsave(&gpio_lock, flags);
4943 list_for_each_entry(gdev, &gpio_devices, list)
4945 spin_unlock_irqrestore(&gpio_lock, flags);
4948 spin_unlock_irqrestore(&gpio_lock, flags);
4953 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4955 unsigned long flags;
4956 struct gpio_device *gdev = v;
4959 spin_lock_irqsave(&gpio_lock, flags);
4960 if (list_is_last(&gdev->list, &gpio_devices))
4963 ret = list_entry(gdev->list.next, struct gpio_device, list);
4964 spin_unlock_irqrestore(&gpio_lock, flags);
4972 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4976 static int gpiolib_seq_show(struct seq_file *s, void *v)
4978 struct gpio_device *gdev = v;
4979 struct gpio_chip *chip = gdev->chip;
4980 struct device *parent;
4983 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4984 dev_name(&gdev->dev));
4988 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4989 dev_name(&gdev->dev),
4990 gdev->base, gdev->base + gdev->ngpio - 1);
4991 parent = chip->parent;
4993 seq_printf(s, ", parent: %s/%s",
4994 parent->bus ? parent->bus->name : "no-bus",
4997 seq_printf(s, ", %s", chip->label);
4998 if (chip->can_sleep)
4999 seq_printf(s, ", can sleep");
5000 seq_printf(s, ":\n");
5003 chip->dbg_show(s, chip);
5005 gpiolib_dbg_show(s, gdev);
5010 static const struct seq_operations gpiolib_seq_ops = {
5011 .start = gpiolib_seq_start,
5012 .next = gpiolib_seq_next,
5013 .stop = gpiolib_seq_stop,
5014 .show = gpiolib_seq_show,
5017 static int gpiolib_open(struct inode *inode, struct file *file)
5019 return seq_open(file, &gpiolib_seq_ops);
5022 static const struct file_operations gpiolib_operations = {
5023 .owner = THIS_MODULE,
5024 .open = gpiolib_open,
5026 .llseek = seq_lseek,
5027 .release = seq_release,
5030 static int __init gpiolib_debugfs_init(void)
5032 /* /sys/kernel/debug/gpio */
5033 debugfs_create_file("gpio", S_IFREG | S_IRUGO, NULL, NULL,
5034 &gpiolib_operations);
5037 subsys_initcall(gpiolib_debugfs_init);
5039 #endif /* DEBUG_FS */