1 #include <linux/bitmap.h>
2 #include <linux/kernel.h>
3 #include <linux/module.h>
4 #include <linux/interrupt.h>
6 #include <linux/spinlock.h>
7 #include <linux/list.h>
8 #include <linux/device.h>
10 #include <linux/debugfs.h>
11 #include <linux/seq_file.h>
12 #include <linux/gpio.h>
13 #include <linux/of_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>
33 #define CREATE_TRACE_POINTS
34 #include <trace/events/gpio.h>
36 /* Implementation infrastructure for GPIO interfaces.
38 * The GPIO programming interface allows for inlining speed-critical
39 * get/set operations for common cases, so that access to SOC-integrated
40 * GPIOs can sometimes cost only an instruction or two per bit.
44 /* When debugging, extend minimal trust to callers and platform code.
45 * Also emit diagnostic messages that may help initial bringup, when
46 * board setup or driver bugs are most common.
48 * Otherwise, minimize overhead in what may be bitbanging codepaths.
51 #define extra_checks 1
53 #define extra_checks 0
56 /* Device and char device-related information */
57 static DEFINE_IDA(gpio_ida);
58 static dev_t gpio_devt;
59 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
60 static struct bus_type gpio_bus_type = {
65 * Number of GPIOs to use for the fast path in set array
67 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
69 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
70 * While any GPIO is requested, its gpio_chip is not removable;
71 * each GPIO's "requested" flag serves as a lock and refcount.
73 DEFINE_SPINLOCK(gpio_lock);
75 static DEFINE_MUTEX(gpio_lookup_lock);
76 static LIST_HEAD(gpio_lookup_list);
77 LIST_HEAD(gpio_devices);
79 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
80 static LIST_HEAD(gpio_machine_hogs);
82 static void gpiochip_free_hogs(struct gpio_chip *chip);
83 static int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
84 struct lock_class_key *lock_key,
85 struct lock_class_key *request_key);
86 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
87 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip);
88 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip);
90 static bool gpiolib_initialized;
92 static inline void desc_set_label(struct gpio_desc *d, const char *label)
98 * gpio_to_desc - Convert a GPIO number to its descriptor
99 * @gpio: global GPIO number
102 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
103 * with the given number exists in the system.
105 struct gpio_desc *gpio_to_desc(unsigned gpio)
107 struct gpio_device *gdev;
110 spin_lock_irqsave(&gpio_lock, flags);
112 list_for_each_entry(gdev, &gpio_devices, list) {
113 if (gdev->base <= gpio &&
114 gdev->base + gdev->ngpio > gpio) {
115 spin_unlock_irqrestore(&gpio_lock, flags);
116 return &gdev->descs[gpio - gdev->base];
120 spin_unlock_irqrestore(&gpio_lock, flags);
122 if (!gpio_is_valid(gpio))
123 WARN(1, "invalid GPIO %d\n", gpio);
127 EXPORT_SYMBOL_GPL(gpio_to_desc);
130 * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
131 * hardware number for this chip
133 * @hwnum: hardware number of the GPIO for this chip
136 * A pointer to the GPIO descriptor or %ERR_PTR(-EINVAL) if no GPIO exists
137 * in the given chip for the specified hardware number.
139 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
142 struct gpio_device *gdev = chip->gpiodev;
144 if (hwnum >= gdev->ngpio)
145 return ERR_PTR(-EINVAL);
147 return &gdev->descs[hwnum];
151 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
152 * @desc: GPIO descriptor
154 * This should disappear in the future but is needed since we still
155 * use GPIO numbers for error messages and sysfs nodes.
158 * The global GPIO number for the GPIO specified by its descriptor.
160 int desc_to_gpio(const struct gpio_desc *desc)
162 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
164 EXPORT_SYMBOL_GPL(desc_to_gpio);
168 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
169 * @desc: descriptor to return the chip of
171 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
173 if (!desc || !desc->gdev)
175 return desc->gdev->chip;
177 EXPORT_SYMBOL_GPL(gpiod_to_chip);
179 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
180 static int gpiochip_find_base(int ngpio)
182 struct gpio_device *gdev;
183 int base = ARCH_NR_GPIOS - ngpio;
185 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
186 /* found a free space? */
187 if (gdev->base + gdev->ngpio <= base)
190 /* nope, check the space right before the chip */
191 base = gdev->base - ngpio;
194 if (gpio_is_valid(base)) {
195 pr_debug("%s: found new base at %d\n", __func__, base);
198 pr_err("%s: cannot find free range\n", __func__);
204 * gpiod_get_direction - return the current direction of a GPIO
205 * @desc: GPIO to get the direction of
207 * Returns 0 for output, 1 for input, or an error code in case of error.
209 * This function may sleep if gpiod_cansleep() is true.
211 int gpiod_get_direction(struct gpio_desc *desc)
213 struct gpio_chip *chip;
215 int status = -EINVAL;
217 chip = gpiod_to_chip(desc);
218 offset = gpio_chip_hwgpio(desc);
220 if (!chip->get_direction)
223 status = chip->get_direction(chip, offset);
225 /* GPIOF_DIR_IN, or other positive */
227 clear_bit(FLAG_IS_OUT, &desc->flags);
231 set_bit(FLAG_IS_OUT, &desc->flags);
235 EXPORT_SYMBOL_GPL(gpiod_get_direction);
238 * Add a new chip to the global chips list, keeping the list of chips sorted
239 * by range(means [base, base + ngpio - 1]) order.
241 * Return -EBUSY if the new chip overlaps with some other chip's integer
244 static int gpiodev_add_to_list(struct gpio_device *gdev)
246 struct gpio_device *prev, *next;
248 if (list_empty(&gpio_devices)) {
249 /* initial entry in list */
250 list_add_tail(&gdev->list, &gpio_devices);
254 next = list_entry(gpio_devices.next, struct gpio_device, list);
255 if (gdev->base + gdev->ngpio <= next->base) {
256 /* add before first entry */
257 list_add(&gdev->list, &gpio_devices);
261 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
262 if (prev->base + prev->ngpio <= gdev->base) {
263 /* add behind last entry */
264 list_add_tail(&gdev->list, &gpio_devices);
268 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
269 /* at the end of the list */
270 if (&next->list == &gpio_devices)
273 /* add between prev and next */
274 if (prev->base + prev->ngpio <= gdev->base
275 && gdev->base + gdev->ngpio <= next->base) {
276 list_add(&gdev->list, &prev->list);
281 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
286 * Convert a GPIO name to its descriptor
288 static struct gpio_desc *gpio_name_to_desc(const char * const name)
290 struct gpio_device *gdev;
293 spin_lock_irqsave(&gpio_lock, flags);
295 list_for_each_entry(gdev, &gpio_devices, list) {
298 for (i = 0; i != gdev->ngpio; ++i) {
299 struct gpio_desc *desc = &gdev->descs[i];
301 if (!desc->name || !name)
304 if (!strcmp(desc->name, name)) {
305 spin_unlock_irqrestore(&gpio_lock, flags);
311 spin_unlock_irqrestore(&gpio_lock, flags);
317 * Takes the names from gc->names and checks if they are all unique. If they
318 * are, they are assigned to their gpio descriptors.
320 * Warning if one of the names is already used for a different GPIO.
322 static int gpiochip_set_desc_names(struct gpio_chip *gc)
324 struct gpio_device *gdev = gc->gpiodev;
330 /* First check all names if they are unique */
331 for (i = 0; i != gc->ngpio; ++i) {
332 struct gpio_desc *gpio;
334 gpio = gpio_name_to_desc(gc->names[i]);
337 "Detected name collision for GPIO name '%s'\n",
341 /* Then add all names to the GPIO descriptors */
342 for (i = 0; i != gc->ngpio; ++i)
343 gdev->descs[i].name = gc->names[i];
348 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *chip)
352 p = kmalloc_array(BITS_TO_LONGS(chip->ngpio), sizeof(*p), GFP_KERNEL);
356 /* Assume by default all GPIOs are valid */
357 bitmap_fill(p, chip->ngpio);
362 static int gpiochip_init_valid_mask(struct gpio_chip *gpiochip)
364 #ifdef CONFIG_OF_GPIO
366 struct device_node *np = gpiochip->of_node;
368 size = of_property_count_u32_elems(np, "gpio-reserved-ranges");
369 if (size > 0 && size % 2 == 0)
370 gpiochip->need_valid_mask = true;
373 if (!gpiochip->need_valid_mask)
376 gpiochip->valid_mask = gpiochip_allocate_mask(gpiochip);
377 if (!gpiochip->valid_mask)
383 static void gpiochip_free_valid_mask(struct gpio_chip *gpiochip)
385 kfree(gpiochip->valid_mask);
386 gpiochip->valid_mask = NULL;
389 bool gpiochip_line_is_valid(const struct gpio_chip *gpiochip,
392 /* No mask means all valid */
393 if (likely(!gpiochip->valid_mask))
395 return test_bit(offset, gpiochip->valid_mask);
397 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
400 * GPIO line handle management
404 * struct linehandle_state - contains the state of a userspace handle
405 * @gdev: the GPIO device the handle pertains to
406 * @label: consumer label used to tag descriptors
407 * @descs: the GPIO descriptors held by this handle
408 * @numdescs: the number of descriptors held in the descs array
410 struct linehandle_state {
411 struct gpio_device *gdev;
413 struct gpio_desc *descs[GPIOHANDLES_MAX];
417 #define GPIOHANDLE_REQUEST_VALID_FLAGS \
418 (GPIOHANDLE_REQUEST_INPUT | \
419 GPIOHANDLE_REQUEST_OUTPUT | \
420 GPIOHANDLE_REQUEST_ACTIVE_LOW | \
421 GPIOHANDLE_REQUEST_OPEN_DRAIN | \
422 GPIOHANDLE_REQUEST_OPEN_SOURCE)
424 static long linehandle_ioctl(struct file *filep, unsigned int cmd,
427 struct linehandle_state *lh = filep->private_data;
428 void __user *ip = (void __user *)arg;
429 struct gpiohandle_data ghd;
430 DECLARE_BITMAP(vals, GPIOHANDLES_MAX);
433 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
434 /* NOTE: It's ok to read values of output lines. */
435 int ret = gpiod_get_array_value_complex(false,
443 memset(&ghd, 0, sizeof(ghd));
444 for (i = 0; i < lh->numdescs; i++)
445 ghd.values[i] = test_bit(i, vals);
447 if (copy_to_user(ip, &ghd, sizeof(ghd)))
451 } else if (cmd == GPIOHANDLE_SET_LINE_VALUES_IOCTL) {
453 * All line descriptors were created at once with the same
454 * flags so just check if the first one is really output.
456 if (!test_bit(FLAG_IS_OUT, &lh->descs[0]->flags))
459 if (copy_from_user(&ghd, ip, sizeof(ghd)))
462 /* Clamp all values to [0,1] */
463 for (i = 0; i < lh->numdescs; i++)
464 __assign_bit(i, vals, ghd.values[i]);
466 /* Reuse the array setting function */
467 return gpiod_set_array_value_complex(false,
477 static long linehandle_ioctl_compat(struct file *filep, unsigned int cmd,
480 return linehandle_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
484 static int linehandle_release(struct inode *inode, struct file *filep)
486 struct linehandle_state *lh = filep->private_data;
487 struct gpio_device *gdev = lh->gdev;
490 for (i = 0; i < lh->numdescs; i++)
491 gpiod_free(lh->descs[i]);
494 put_device(&gdev->dev);
498 static const struct file_operations linehandle_fileops = {
499 .release = linehandle_release,
500 .owner = THIS_MODULE,
501 .llseek = noop_llseek,
502 .unlocked_ioctl = linehandle_ioctl,
504 .compat_ioctl = linehandle_ioctl_compat,
508 static int linehandle_create(struct gpio_device *gdev, void __user *ip)
510 struct gpiohandle_request handlereq;
511 struct linehandle_state *lh;
513 int fd, i, count = 0, ret;
516 if (copy_from_user(&handlereq, ip, sizeof(handlereq)))
518 if ((handlereq.lines == 0) || (handlereq.lines > GPIOHANDLES_MAX))
521 lflags = handlereq.flags;
523 /* Return an error if an unknown flag is set */
524 if (lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS)
528 * Do not allow OPEN_SOURCE & OPEN_DRAIN flags in a single request. If
529 * the hardware actually supports enabling both at the same time the
530 * electrical result would be disastrous.
532 if ((lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN) &&
533 (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE))
536 /* OPEN_DRAIN and OPEN_SOURCE flags only make sense for output mode. */
537 if (!(lflags & GPIOHANDLE_REQUEST_OUTPUT) &&
538 ((lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN) ||
539 (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)))
542 lh = kzalloc(sizeof(*lh), GFP_KERNEL);
546 get_device(&gdev->dev);
548 /* Make sure this is terminated */
549 handlereq.consumer_label[sizeof(handlereq.consumer_label)-1] = '\0';
550 if (strlen(handlereq.consumer_label)) {
551 lh->label = kstrdup(handlereq.consumer_label,
559 /* Request each GPIO */
560 for (i = 0; i < handlereq.lines; i++) {
561 u32 offset = handlereq.lineoffsets[i];
562 struct gpio_desc *desc;
564 if (offset >= gdev->ngpio) {
569 desc = &gdev->descs[offset];
570 ret = gpiod_request(desc, lh->label);
576 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
577 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
578 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
579 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
580 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
581 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
583 ret = gpiod_set_transitory(desc, false);
588 * Lines have to be requested explicitly for input
589 * or output, else the line will be treated "as is".
591 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
592 int val = !!handlereq.default_values[i];
594 ret = gpiod_direction_output(desc, val);
597 } else if (lflags & GPIOHANDLE_REQUEST_INPUT) {
598 ret = gpiod_direction_input(desc);
602 dev_dbg(&gdev->dev, "registered chardev handle for line %d\n",
605 /* Let i point at the last handle */
607 lh->numdescs = handlereq.lines;
609 fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
615 file = anon_inode_getfile("gpio-linehandle",
618 O_RDONLY | O_CLOEXEC);
621 goto out_put_unused_fd;
625 if (copy_to_user(ip, &handlereq, sizeof(handlereq))) {
627 * fput() will trigger the release() callback, so do not go onto
628 * the regular error cleanup path here.
635 fd_install(fd, file);
637 dev_dbg(&gdev->dev, "registered chardev handle for %d lines\n",
645 for (i = 0; i < count; i++)
646 gpiod_free(lh->descs[i]);
650 put_device(&gdev->dev);
655 * GPIO line event management
659 * struct lineevent_state - contains the state of a userspace event
660 * @gdev: the GPIO device the event pertains to
661 * @label: consumer label used to tag descriptors
662 * @desc: the GPIO descriptor held by this event
663 * @eflags: the event flags this line was requested with
664 * @irq: the interrupt that trigger in response to events on this GPIO
665 * @wait: wait queue that handles blocking reads of events
666 * @events: KFIFO for the GPIO events
667 * @read_lock: mutex lock to protect reads from colliding with adding
668 * new events to the FIFO
669 * @timestamp: cache for the timestamp storing it between hardirq
670 * and IRQ thread, used to bring the timestamp close to the actual
673 struct lineevent_state {
674 struct gpio_device *gdev;
676 struct gpio_desc *desc;
679 wait_queue_head_t wait;
680 DECLARE_KFIFO(events, struct gpioevent_data, 16);
681 struct mutex read_lock;
685 #define GPIOEVENT_REQUEST_VALID_FLAGS \
686 (GPIOEVENT_REQUEST_RISING_EDGE | \
687 GPIOEVENT_REQUEST_FALLING_EDGE)
689 static __poll_t lineevent_poll(struct file *filep,
690 struct poll_table_struct *wait)
692 struct lineevent_state *le = filep->private_data;
695 poll_wait(filep, &le->wait, wait);
697 if (!kfifo_is_empty(&le->events))
698 events = EPOLLIN | EPOLLRDNORM;
704 static ssize_t lineevent_read(struct file *filep,
709 struct lineevent_state *le = filep->private_data;
713 if (count < sizeof(struct gpioevent_data))
717 if (kfifo_is_empty(&le->events)) {
718 if (filep->f_flags & O_NONBLOCK)
721 ret = wait_event_interruptible(le->wait,
722 !kfifo_is_empty(&le->events));
727 if (mutex_lock_interruptible(&le->read_lock))
729 ret = kfifo_to_user(&le->events, buf, count, &copied);
730 mutex_unlock(&le->read_lock);
736 * If we couldn't read anything from the fifo (a different
737 * thread might have been faster) we either return -EAGAIN if
738 * the file descriptor is non-blocking, otherwise we go back to
739 * sleep and wait for more data to arrive.
741 if (copied == 0 && (filep->f_flags & O_NONBLOCK))
744 } while (copied == 0);
749 static int lineevent_release(struct inode *inode, struct file *filep)
751 struct lineevent_state *le = filep->private_data;
752 struct gpio_device *gdev = le->gdev;
754 free_irq(le->irq, le);
755 gpiod_free(le->desc);
758 put_device(&gdev->dev);
762 static long lineevent_ioctl(struct file *filep, unsigned int cmd,
765 struct lineevent_state *le = filep->private_data;
766 void __user *ip = (void __user *)arg;
767 struct gpiohandle_data ghd;
770 * We can get the value for an event line but not set it,
771 * because it is input by definition.
773 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
776 memset(&ghd, 0, sizeof(ghd));
778 val = gpiod_get_value_cansleep(le->desc);
783 if (copy_to_user(ip, &ghd, sizeof(ghd)))
792 static long lineevent_ioctl_compat(struct file *filep, unsigned int cmd,
795 return lineevent_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
799 static const struct file_operations lineevent_fileops = {
800 .release = lineevent_release,
801 .read = lineevent_read,
802 .poll = lineevent_poll,
803 .owner = THIS_MODULE,
804 .llseek = noop_llseek,
805 .unlocked_ioctl = lineevent_ioctl,
807 .compat_ioctl = lineevent_ioctl_compat,
811 static irqreturn_t lineevent_irq_thread(int irq, void *p)
813 struct lineevent_state *le = p;
814 struct gpioevent_data ge;
817 /* Do not leak kernel stack to userspace */
818 memset(&ge, 0, sizeof(ge));
820 ge.timestamp = le->timestamp;
821 level = gpiod_get_value_cansleep(le->desc);
823 if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE
824 && le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
826 /* Emit low-to-high event */
827 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
829 /* Emit high-to-low event */
830 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
831 } else if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE && level) {
832 /* Emit low-to-high event */
833 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
834 } else if (le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE && !level) {
835 /* Emit high-to-low event */
836 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
841 ret = kfifo_put(&le->events, ge);
843 wake_up_poll(&le->wait, EPOLLIN);
848 static irqreturn_t lineevent_irq_handler(int irq, void *p)
850 struct lineevent_state *le = p;
853 * Just store the timestamp in hardirq context so we get it as
854 * close in time as possible to the actual event.
856 le->timestamp = ktime_get_real_ns();
858 return IRQ_WAKE_THREAD;
861 static int lineevent_create(struct gpio_device *gdev, void __user *ip)
863 struct gpioevent_request eventreq;
864 struct lineevent_state *le;
865 struct gpio_desc *desc;
874 if (copy_from_user(&eventreq, ip, sizeof(eventreq)))
877 le = kzalloc(sizeof(*le), GFP_KERNEL);
881 get_device(&gdev->dev);
883 /* Make sure this is terminated */
884 eventreq.consumer_label[sizeof(eventreq.consumer_label)-1] = '\0';
885 if (strlen(eventreq.consumer_label)) {
886 le->label = kstrdup(eventreq.consumer_label,
894 offset = eventreq.lineoffset;
895 lflags = eventreq.handleflags;
896 eflags = eventreq.eventflags;
898 if (offset >= gdev->ngpio) {
903 /* Return an error if a unknown flag is set */
904 if ((lflags & ~GPIOHANDLE_REQUEST_VALID_FLAGS) ||
905 (eflags & ~GPIOEVENT_REQUEST_VALID_FLAGS)) {
910 /* This is just wrong: we don't look for events on output lines */
911 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
916 desc = &gdev->descs[offset];
917 ret = gpiod_request(desc, le->label);
923 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
924 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
925 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
926 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
927 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
928 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
930 ret = gpiod_direction_input(desc);
934 le->irq = gpiod_to_irq(desc);
940 if (eflags & GPIOEVENT_REQUEST_RISING_EDGE)
941 irqflags |= IRQF_TRIGGER_RISING;
942 if (eflags & GPIOEVENT_REQUEST_FALLING_EDGE)
943 irqflags |= IRQF_TRIGGER_FALLING;
944 irqflags |= IRQF_ONESHOT;
945 irqflags |= IRQF_SHARED;
947 INIT_KFIFO(le->events);
948 init_waitqueue_head(&le->wait);
949 mutex_init(&le->read_lock);
951 /* Request a thread to read the events */
952 ret = request_threaded_irq(le->irq,
953 lineevent_irq_handler,
954 lineevent_irq_thread,
961 fd = get_unused_fd_flags(O_RDONLY | O_CLOEXEC);
967 file = anon_inode_getfile("gpio-event",
970 O_RDONLY | O_CLOEXEC);
973 goto out_put_unused_fd;
977 if (copy_to_user(ip, &eventreq, sizeof(eventreq))) {
979 * fput() will trigger the release() callback, so do not go onto
980 * the regular error cleanup path here.
987 fd_install(fd, file);
994 free_irq(le->irq, le);
996 gpiod_free(le->desc);
1001 put_device(&gdev->dev);
1006 * gpio_ioctl() - ioctl handler for the GPIO chardev
1008 static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1010 struct gpio_device *gdev = filp->private_data;
1011 struct gpio_chip *chip = gdev->chip;
1012 void __user *ip = (void __user *)arg;
1014 /* We fail any subsequent ioctl():s when the chip is gone */
1018 /* Fill in the struct and pass to userspace */
1019 if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
1020 struct gpiochip_info chipinfo;
1022 memset(&chipinfo, 0, sizeof(chipinfo));
1024 strncpy(chipinfo.name, dev_name(&gdev->dev),
1025 sizeof(chipinfo.name));
1026 chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
1027 strncpy(chipinfo.label, gdev->label,
1028 sizeof(chipinfo.label));
1029 chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
1030 chipinfo.lines = gdev->ngpio;
1031 if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
1034 } else if (cmd == GPIO_GET_LINEINFO_IOCTL) {
1035 struct gpioline_info lineinfo;
1036 struct gpio_desc *desc;
1038 if (copy_from_user(&lineinfo, ip, sizeof(lineinfo)))
1040 if (lineinfo.line_offset >= gdev->ngpio)
1043 desc = &gdev->descs[lineinfo.line_offset];
1045 strncpy(lineinfo.name, desc->name,
1046 sizeof(lineinfo.name));
1047 lineinfo.name[sizeof(lineinfo.name)-1] = '\0';
1049 lineinfo.name[0] = '\0';
1052 strncpy(lineinfo.consumer, desc->label,
1053 sizeof(lineinfo.consumer));
1054 lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
1056 lineinfo.consumer[0] = '\0';
1060 * Userspace only need to know that the kernel is using
1061 * this GPIO so it can't use it.
1064 if (test_bit(FLAG_REQUESTED, &desc->flags) ||
1065 test_bit(FLAG_IS_HOGGED, &desc->flags) ||
1066 test_bit(FLAG_USED_AS_IRQ, &desc->flags) ||
1067 test_bit(FLAG_EXPORT, &desc->flags) ||
1068 test_bit(FLAG_SYSFS, &desc->flags))
1069 lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
1070 if (test_bit(FLAG_IS_OUT, &desc->flags))
1071 lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
1072 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1073 lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
1074 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
1075 lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
1076 if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
1077 lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;
1079 if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
1082 } else if (cmd == GPIO_GET_LINEHANDLE_IOCTL) {
1083 return linehandle_create(gdev, ip);
1084 } else if (cmd == GPIO_GET_LINEEVENT_IOCTL) {
1085 return lineevent_create(gdev, ip);
1090 #ifdef CONFIG_COMPAT
1091 static long gpio_ioctl_compat(struct file *filp, unsigned int cmd,
1094 return gpio_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
1099 * gpio_chrdev_open() - open the chardev for ioctl operations
1100 * @inode: inode for this chardev
1101 * @filp: file struct for storing private data
1102 * Returns 0 on success
1104 static int gpio_chrdev_open(struct inode *inode, struct file *filp)
1106 struct gpio_device *gdev = container_of(inode->i_cdev,
1107 struct gpio_device, chrdev);
1109 /* Fail on open if the backing gpiochip is gone */
1112 get_device(&gdev->dev);
1113 filp->private_data = gdev;
1115 return nonseekable_open(inode, filp);
1119 * gpio_chrdev_release() - close chardev after ioctl operations
1120 * @inode: inode for this chardev
1121 * @filp: file struct for storing private data
1122 * Returns 0 on success
1124 static int gpio_chrdev_release(struct inode *inode, struct file *filp)
1126 struct gpio_device *gdev = container_of(inode->i_cdev,
1127 struct gpio_device, chrdev);
1129 put_device(&gdev->dev);
1134 static const struct file_operations gpio_fileops = {
1135 .release = gpio_chrdev_release,
1136 .open = gpio_chrdev_open,
1137 .owner = THIS_MODULE,
1138 .llseek = no_llseek,
1139 .unlocked_ioctl = gpio_ioctl,
1140 #ifdef CONFIG_COMPAT
1141 .compat_ioctl = gpio_ioctl_compat,
1145 static void gpiodevice_release(struct device *dev)
1147 struct gpio_device *gdev = dev_get_drvdata(dev);
1149 list_del(&gdev->list);
1150 ida_simple_remove(&gpio_ida, gdev->id);
1151 kfree_const(gdev->label);
1156 static int gpiochip_setup_dev(struct gpio_device *gdev)
1160 cdev_init(&gdev->chrdev, &gpio_fileops);
1161 gdev->chrdev.owner = THIS_MODULE;
1162 gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id);
1164 status = cdev_device_add(&gdev->chrdev, &gdev->dev);
1168 chip_dbg(gdev->chip, "added GPIO chardev (%d:%d)\n",
1169 MAJOR(gpio_devt), gdev->id);
1171 status = gpiochip_sysfs_register(gdev);
1173 goto err_remove_device;
1175 /* From this point, the .release() function cleans up gpio_device */
1176 gdev->dev.release = gpiodevice_release;
1177 pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n",
1178 __func__, gdev->base, gdev->base + gdev->ngpio - 1,
1179 dev_name(&gdev->dev), gdev->chip->label ? : "generic");
1184 cdev_device_del(&gdev->chrdev, &gdev->dev);
1188 static void gpiochip_machine_hog(struct gpio_chip *chip, struct gpiod_hog *hog)
1190 struct gpio_desc *desc;
1193 desc = gpiochip_get_desc(chip, hog->chip_hwnum);
1195 pr_err("%s: unable to get GPIO desc: %ld\n",
1196 __func__, PTR_ERR(desc));
1200 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
1203 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
1205 pr_err("%s: unable to hog GPIO line (%s:%u): %d\n",
1206 __func__, chip->label, hog->chip_hwnum, rv);
1209 static void machine_gpiochip_add(struct gpio_chip *chip)
1211 struct gpiod_hog *hog;
1213 mutex_lock(&gpio_machine_hogs_mutex);
1215 list_for_each_entry(hog, &gpio_machine_hogs, list) {
1216 if (!strcmp(chip->label, hog->chip_label))
1217 gpiochip_machine_hog(chip, hog);
1220 mutex_unlock(&gpio_machine_hogs_mutex);
1223 static void gpiochip_setup_devs(void)
1225 struct gpio_device *gdev;
1228 list_for_each_entry(gdev, &gpio_devices, list) {
1229 err = gpiochip_setup_dev(gdev);
1231 pr_err("%s: Failed to initialize gpio device (%d)\n",
1232 dev_name(&gdev->dev), err);
1236 int gpiochip_add_data_with_key(struct gpio_chip *chip, void *data,
1237 struct lock_class_key *lock_key,
1238 struct lock_class_key *request_key)
1240 unsigned long flags;
1243 int base = chip->base;
1244 struct gpio_device *gdev;
1247 * First: allocate and populate the internal stat container, and
1248 * set up the struct device.
1250 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
1253 gdev->dev.bus = &gpio_bus_type;
1255 chip->gpiodev = gdev;
1257 gdev->dev.parent = chip->parent;
1258 gdev->dev.of_node = chip->parent->of_node;
1261 #ifdef CONFIG_OF_GPIO
1262 /* If the gpiochip has an assigned OF node this takes precedence */
1264 gdev->dev.of_node = chip->of_node;
1266 chip->of_node = gdev->dev.of_node;
1269 gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
1274 dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
1275 device_initialize(&gdev->dev);
1276 dev_set_drvdata(&gdev->dev, gdev);
1277 if (chip->parent && chip->parent->driver)
1278 gdev->owner = chip->parent->driver->owner;
1279 else if (chip->owner)
1280 /* TODO: remove chip->owner */
1281 gdev->owner = chip->owner;
1283 gdev->owner = THIS_MODULE;
1285 gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
1291 if (chip->ngpio == 0) {
1292 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
1294 goto err_free_descs;
1297 if (chip->ngpio > FASTPATH_NGPIO)
1298 chip_warn(chip, "line cnt %u is greater than fast path cnt %u\n",
1299 chip->ngpio, FASTPATH_NGPIO);
1301 gdev->label = kstrdup_const(chip->label ?: "unknown", GFP_KERNEL);
1304 goto err_free_descs;
1307 gdev->ngpio = chip->ngpio;
1310 spin_lock_irqsave(&gpio_lock, flags);
1313 * TODO: this allocates a Linux GPIO number base in the global
1314 * GPIO numberspace for this chip. In the long run we want to
1315 * get *rid* of this numberspace and use only descriptors, but
1316 * it may be a pipe dream. It will not happen before we get rid
1317 * of the sysfs interface anyways.
1320 base = gpiochip_find_base(chip->ngpio);
1323 spin_unlock_irqrestore(&gpio_lock, flags);
1324 goto err_free_label;
1327 * TODO: it should not be necessary to reflect the assigned
1328 * base outside of the GPIO subsystem. Go over drivers and
1329 * see if anyone makes use of this, else drop this and assign
1336 status = gpiodev_add_to_list(gdev);
1338 spin_unlock_irqrestore(&gpio_lock, flags);
1339 goto err_free_label;
1342 spin_unlock_irqrestore(&gpio_lock, flags);
1344 for (i = 0; i < chip->ngpio; i++) {
1345 struct gpio_desc *desc = &gdev->descs[i];
1349 /* REVISIT: most hardware initializes GPIOs as inputs (often
1350 * with pullups enabled) so power usage is minimized. Linux
1351 * code should set the gpio direction first thing; but until
1352 * it does, and in case chip->get_direction is not set, we may
1353 * expose the wrong direction in sysfs.
1355 desc->flags = !chip->direction_input ? (1 << FLAG_IS_OUT) : 0;
1358 #ifdef CONFIG_PINCTRL
1359 INIT_LIST_HEAD(&gdev->pin_ranges);
1362 status = gpiochip_set_desc_names(chip);
1364 goto err_remove_from_list;
1366 status = gpiochip_irqchip_init_valid_mask(chip);
1368 goto err_remove_from_list;
1370 status = gpiochip_init_valid_mask(chip);
1372 goto err_remove_irqchip_mask;
1374 status = gpiochip_add_irqchip(chip, lock_key, request_key);
1376 goto err_remove_chip;
1378 status = of_gpiochip_add(chip);
1380 goto err_remove_chip;
1382 acpi_gpiochip_add(chip);
1384 machine_gpiochip_add(chip);
1387 * By first adding the chardev, and then adding the device,
1388 * we get a device node entry in sysfs under
1389 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
1390 * coldplug of device nodes and other udev business.
1391 * We can do this only if gpiolib has been initialized.
1392 * Otherwise, defer until later.
1394 if (gpiolib_initialized) {
1395 status = gpiochip_setup_dev(gdev);
1397 goto err_remove_chip;
1402 acpi_gpiochip_remove(chip);
1403 gpiochip_free_hogs(chip);
1404 of_gpiochip_remove(chip);
1405 gpiochip_free_valid_mask(chip);
1406 err_remove_irqchip_mask:
1407 gpiochip_irqchip_free_valid_mask(chip);
1408 err_remove_from_list:
1409 spin_lock_irqsave(&gpio_lock, flags);
1410 list_del(&gdev->list);
1411 spin_unlock_irqrestore(&gpio_lock, flags);
1413 kfree_const(gdev->label);
1417 ida_simple_remove(&gpio_ida, gdev->id);
1418 /* failures here can mean systems won't boot... */
1419 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
1420 gdev->base, gdev->base + gdev->ngpio - 1,
1421 chip->label ? : "generic", status);
1425 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
1428 * gpiochip_get_data() - get per-subdriver data for the chip
1432 * The per-subdriver data for the chip.
1434 void *gpiochip_get_data(struct gpio_chip *chip)
1436 return chip->gpiodev->data;
1438 EXPORT_SYMBOL_GPL(gpiochip_get_data);
1441 * gpiochip_remove() - unregister a gpio_chip
1442 * @chip: the chip to unregister
1444 * A gpio_chip with any GPIOs still requested may not be removed.
1446 void gpiochip_remove(struct gpio_chip *chip)
1448 struct gpio_device *gdev = chip->gpiodev;
1449 struct gpio_desc *desc;
1450 unsigned long flags;
1452 bool requested = false;
1454 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1455 gpiochip_sysfs_unregister(gdev);
1456 gpiochip_free_hogs(chip);
1457 /* Numb the device, cancelling all outstanding operations */
1459 gpiochip_irqchip_remove(chip);
1460 acpi_gpiochip_remove(chip);
1461 gpiochip_remove_pin_ranges(chip);
1462 of_gpiochip_remove(chip);
1463 gpiochip_free_valid_mask(chip);
1465 * We accept no more calls into the driver from this point, so
1466 * NULL the driver data pointer
1470 spin_lock_irqsave(&gpio_lock, flags);
1471 for (i = 0; i < gdev->ngpio; i++) {
1472 desc = &gdev->descs[i];
1473 if (test_bit(FLAG_REQUESTED, &desc->flags))
1476 spin_unlock_irqrestore(&gpio_lock, flags);
1479 dev_crit(&gdev->dev,
1480 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
1483 * The gpiochip side puts its use of the device to rest here:
1484 * if there are no userspace clients, the chardev and device will
1485 * be removed, else it will be dangling until the last user is
1488 cdev_device_del(&gdev->chrdev, &gdev->dev);
1489 put_device(&gdev->dev);
1491 EXPORT_SYMBOL_GPL(gpiochip_remove);
1493 static void devm_gpio_chip_release(struct device *dev, void *res)
1495 struct gpio_chip *chip = *(struct gpio_chip **)res;
1497 gpiochip_remove(chip);
1500 static int devm_gpio_chip_match(struct device *dev, void *res, void *data)
1503 struct gpio_chip **r = res;
1514 * devm_gpiochip_add_data() - Resource manager gpiochip_add_data()
1515 * @dev: the device pointer on which irq_chip belongs to.
1516 * @chip: the chip to register, with chip->base initialized
1517 * @data: driver-private data associated with this chip
1519 * Context: potentially before irqs will work
1521 * The gpio chip automatically be released when the device is unbound.
1524 * A negative errno if the chip can't be registered, such as because the
1525 * chip->base is invalid or already associated with a different chip.
1526 * Otherwise it returns zero as a success code.
1528 int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
1531 struct gpio_chip **ptr;
1534 ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
1539 ret = gpiochip_add_data(chip, data);
1546 devres_add(dev, ptr);
1550 EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);
1553 * devm_gpiochip_remove() - Resource manager of gpiochip_remove()
1554 * @dev: device for which which resource was allocated
1555 * @chip: the chip to remove
1557 * A gpio_chip with any GPIOs still requested may not be removed.
1559 void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip)
1563 ret = devres_release(dev, devm_gpio_chip_release,
1564 devm_gpio_chip_match, chip);
1567 EXPORT_SYMBOL_GPL(devm_gpiochip_remove);
1570 * gpiochip_find() - iterator for locating a specific gpio_chip
1571 * @data: data to pass to match function
1572 * @match: Callback function to check gpio_chip
1574 * Similar to bus_find_device. It returns a reference to a gpio_chip as
1575 * determined by a user supplied @match callback. The callback should return
1576 * 0 if the device doesn't match and non-zero if it does. If the callback is
1577 * non-zero, this function will return to the caller and not iterate over any
1580 struct gpio_chip *gpiochip_find(void *data,
1581 int (*match)(struct gpio_chip *chip,
1584 struct gpio_device *gdev;
1585 struct gpio_chip *chip = NULL;
1586 unsigned long flags;
1588 spin_lock_irqsave(&gpio_lock, flags);
1589 list_for_each_entry(gdev, &gpio_devices, list)
1590 if (gdev->chip && match(gdev->chip, data)) {
1595 spin_unlock_irqrestore(&gpio_lock, flags);
1599 EXPORT_SYMBOL_GPL(gpiochip_find);
1601 static int gpiochip_match_name(struct gpio_chip *chip, void *data)
1603 const char *name = data;
1605 return !strcmp(chip->label, name);
1608 static struct gpio_chip *find_chip_by_name(const char *name)
1610 return gpiochip_find((void *)name, gpiochip_match_name);
1613 #ifdef CONFIG_GPIOLIB_IRQCHIP
1616 * The following is irqchip helper code for gpiochips.
1619 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1621 if (!gpiochip->irq.need_valid_mask)
1624 gpiochip->irq.valid_mask = gpiochip_allocate_mask(gpiochip);
1625 if (!gpiochip->irq.valid_mask)
1631 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1633 kfree(gpiochip->irq.valid_mask);
1634 gpiochip->irq.valid_mask = NULL;
1637 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
1638 unsigned int offset)
1640 if (!gpiochip_line_is_valid(gpiochip, offset))
1642 /* No mask means all valid */
1643 if (likely(!gpiochip->irq.valid_mask))
1645 return test_bit(offset, gpiochip->irq.valid_mask);
1647 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
1650 * gpiochip_set_cascaded_irqchip() - connects a cascaded irqchip to a gpiochip
1651 * @gpiochip: the gpiochip to set the irqchip chain to
1652 * @irqchip: the irqchip to chain to the gpiochip
1653 * @parent_irq: the irq number corresponding to the parent IRQ for this
1655 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1656 * coming out of the gpiochip. If the interrupt is nested rather than
1657 * cascaded, pass NULL in this handler argument
1659 static void gpiochip_set_cascaded_irqchip(struct gpio_chip *gpiochip,
1660 struct irq_chip *irqchip,
1661 unsigned int parent_irq,
1662 irq_flow_handler_t parent_handler)
1664 unsigned int offset;
1666 if (!gpiochip->irq.domain) {
1667 chip_err(gpiochip, "called %s before setting up irqchip\n",
1672 if (parent_handler) {
1673 if (gpiochip->can_sleep) {
1675 "you cannot have chained interrupts on a chip that may sleep\n");
1679 * The parent irqchip is already using the chip_data for this
1680 * irqchip, so our callbacks simply use the handler_data.
1682 irq_set_chained_handler_and_data(parent_irq, parent_handler,
1685 gpiochip->irq.parents = &parent_irq;
1686 gpiochip->irq.num_parents = 1;
1689 /* Set the parent IRQ for all affected IRQs */
1690 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1691 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1693 irq_set_parent(irq_find_mapping(gpiochip->irq.domain, offset),
1699 * gpiochip_set_chained_irqchip() - connects a chained irqchip to a gpiochip
1700 * @gpiochip: the gpiochip to set the irqchip chain to
1701 * @irqchip: the irqchip to chain to the gpiochip
1702 * @parent_irq: the irq number corresponding to the parent IRQ for this
1704 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1705 * coming out of the gpiochip. If the interrupt is nested rather than
1706 * cascaded, pass NULL in this handler argument
1708 void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
1709 struct irq_chip *irqchip,
1710 unsigned int parent_irq,
1711 irq_flow_handler_t parent_handler)
1713 if (gpiochip->irq.threaded) {
1714 chip_err(gpiochip, "tried to chain a threaded gpiochip\n");
1718 gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1721 EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
1724 * gpiochip_set_nested_irqchip() - connects a nested irqchip to a gpiochip
1725 * @gpiochip: the gpiochip to set the irqchip nested handler to
1726 * @irqchip: the irqchip to nest to the gpiochip
1727 * @parent_irq: the irq number corresponding to the parent IRQ for this
1730 void gpiochip_set_nested_irqchip(struct gpio_chip *gpiochip,
1731 struct irq_chip *irqchip,
1732 unsigned int parent_irq)
1734 gpiochip_set_cascaded_irqchip(gpiochip, irqchip, parent_irq,
1737 EXPORT_SYMBOL_GPL(gpiochip_set_nested_irqchip);
1740 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1741 * @d: the irqdomain used by this irqchip
1742 * @irq: the global irq number used by this GPIO irqchip irq
1743 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1745 * This function will set up the mapping for a certain IRQ line on a
1746 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1747 * stored inside the gpiochip.
1749 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1750 irq_hw_number_t hwirq)
1752 struct gpio_chip *chip = d->host_data;
1755 if (!gpiochip_irqchip_irq_valid(chip, hwirq))
1758 irq_set_chip_data(irq, chip);
1760 * This lock class tells lockdep that GPIO irqs are in a different
1761 * category than their parents, so it won't report false recursion.
1763 irq_set_lockdep_class(irq, chip->irq.lock_key, chip->irq.request_key);
1764 irq_set_chip_and_handler(irq, chip->irq.chip, chip->irq.handler);
1765 /* Chips that use nested thread handlers have them marked */
1766 if (chip->irq.threaded)
1767 irq_set_nested_thread(irq, 1);
1768 irq_set_noprobe(irq);
1770 if (chip->irq.num_parents == 1)
1771 err = irq_set_parent(irq, chip->irq.parents[0]);
1772 else if (chip->irq.map)
1773 err = irq_set_parent(irq, chip->irq.map[hwirq]);
1779 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1780 * is passed as default type.
1782 if (chip->irq.default_type != IRQ_TYPE_NONE)
1783 irq_set_irq_type(irq, chip->irq.default_type);
1787 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1789 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1791 struct gpio_chip *chip = d->host_data;
1793 if (chip->irq.threaded)
1794 irq_set_nested_thread(irq, 0);
1795 irq_set_chip_and_handler(irq, NULL, NULL);
1796 irq_set_chip_data(irq, NULL);
1798 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1800 static const struct irq_domain_ops gpiochip_domain_ops = {
1801 .map = gpiochip_irq_map,
1802 .unmap = gpiochip_irq_unmap,
1803 /* Virtually all GPIO irqchips are twocell:ed */
1804 .xlate = irq_domain_xlate_twocell,
1807 static int gpiochip_irq_reqres(struct irq_data *d)
1809 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1812 if (!try_module_get(chip->gpiodev->owner))
1815 ret = gpiochip_lock_as_irq(chip, d->hwirq);
1818 "unable to lock HW IRQ %lu for IRQ\n",
1820 module_put(chip->gpiodev->owner);
1826 static void gpiochip_irq_relres(struct irq_data *d)
1828 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1830 gpiochip_unlock_as_irq(chip, d->hwirq);
1831 module_put(chip->gpiodev->owner);
1834 static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
1836 if (!gpiochip_irqchip_irq_valid(chip, offset))
1839 return irq_create_mapping(chip->irq.domain, offset);
1843 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1844 * @gpiochip: the GPIO chip to add the IRQ chip to
1845 * @lock_key: lockdep class for IRQ lock
1846 * @request_key: lockdep class for IRQ request
1848 static int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
1849 struct lock_class_key *lock_key,
1850 struct lock_class_key *request_key)
1852 struct irq_chip *irqchip = gpiochip->irq.chip;
1853 const struct irq_domain_ops *ops;
1854 struct device_node *np;
1861 if (gpiochip->irq.parent_handler && gpiochip->can_sleep) {
1862 chip_err(gpiochip, "you cannot have chained interrupts on a chip that may sleep\n");
1866 np = gpiochip->gpiodev->dev.of_node;
1867 type = gpiochip->irq.default_type;
1870 * Specifying a default trigger is a terrible idea if DT or ACPI is
1871 * used to configure the interrupts, as you may end up with
1872 * conflicting triggers. Tell the user, and reset to NONE.
1874 if (WARN(np && type != IRQ_TYPE_NONE,
1875 "%s: Ignoring %u default trigger\n", np->full_name, type))
1876 type = IRQ_TYPE_NONE;
1878 if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
1879 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
1880 "Ignoring %u default trigger\n", type);
1881 type = IRQ_TYPE_NONE;
1884 gpiochip->to_irq = gpiochip_to_irq;
1885 gpiochip->irq.default_type = type;
1886 gpiochip->irq.lock_key = lock_key;
1887 gpiochip->irq.request_key = request_key;
1889 if (gpiochip->irq.domain_ops)
1890 ops = gpiochip->irq.domain_ops;
1892 ops = &gpiochip_domain_ops;
1894 gpiochip->irq.domain = irq_domain_add_simple(np, gpiochip->ngpio,
1895 gpiochip->irq.first,
1897 if (!gpiochip->irq.domain)
1901 * It is possible for a driver to override this, but only if the
1902 * alternative functions are both implemented.
1904 if (!irqchip->irq_request_resources &&
1905 !irqchip->irq_release_resources) {
1906 irqchip->irq_request_resources = gpiochip_irq_reqres;
1907 irqchip->irq_release_resources = gpiochip_irq_relres;
1910 if (gpiochip->irq.parent_handler) {
1911 void *data = gpiochip->irq.parent_handler_data ?: gpiochip;
1913 for (i = 0; i < gpiochip->irq.num_parents; i++) {
1915 * The parent IRQ chip is already using the chip_data
1916 * for this IRQ chip, so our callbacks simply use the
1919 irq_set_chained_handler_and_data(gpiochip->irq.parents[i],
1920 gpiochip->irq.parent_handler,
1925 acpi_gpiochip_request_interrupts(gpiochip);
1931 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1932 * @gpiochip: the gpiochip to remove the irqchip from
1934 * This is called only from gpiochip_remove()
1936 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
1938 unsigned int offset;
1940 acpi_gpiochip_free_interrupts(gpiochip);
1942 if (gpiochip->irq.chip && gpiochip->irq.parent_handler) {
1943 struct gpio_irq_chip *irq = &gpiochip->irq;
1946 for (i = 0; i < irq->num_parents; i++)
1947 irq_set_chained_handler_and_data(irq->parents[i],
1951 /* Remove all IRQ mappings and delete the domain */
1952 if (gpiochip->irq.domain) {
1955 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1956 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1959 irq = irq_find_mapping(gpiochip->irq.domain, offset);
1960 irq_dispose_mapping(irq);
1963 irq_domain_remove(gpiochip->irq.domain);
1966 if (gpiochip->irq.chip) {
1967 gpiochip->irq.chip->irq_request_resources = NULL;
1968 gpiochip->irq.chip->irq_release_resources = NULL;
1969 gpiochip->irq.chip = NULL;
1972 gpiochip_irqchip_free_valid_mask(gpiochip);
1976 * gpiochip_irqchip_add_key() - adds an irqchip to a gpiochip
1977 * @gpiochip: the gpiochip to add the irqchip to
1978 * @irqchip: the irqchip to add to the gpiochip
1979 * @first_irq: if not dynamically assigned, the base (first) IRQ to
1980 * allocate gpiochip irqs from
1981 * @handler: the irq handler to use (often a predefined irq core function)
1982 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
1983 * to have the core avoid setting up any default type in the hardware.
1984 * @threaded: whether this irqchip uses a nested thread handler
1985 * @lock_key: lockdep class for IRQ lock
1986 * @request_key: lockdep class for IRQ request
1988 * This function closely associates a certain irqchip with a certain
1989 * gpiochip, providing an irq domain to translate the local IRQs to
1990 * global irqs in the gpiolib core, and making sure that the gpiochip
1991 * is passed as chip data to all related functions. Driver callbacks
1992 * need to use gpiochip_get_data() to get their local state containers back
1993 * from the gpiochip passed as chip data. An irqdomain will be stored
1994 * in the gpiochip that shall be used by the driver to handle IRQ number
1995 * translation. The gpiochip will need to be initialized and registered
1996 * before calling this function.
1998 * This function will handle two cell:ed simple IRQs and assumes all
1999 * the pins on the gpiochip can generate a unique IRQ. Everything else
2000 * need to be open coded.
2002 int gpiochip_irqchip_add_key(struct gpio_chip *gpiochip,
2003 struct irq_chip *irqchip,
2004 unsigned int first_irq,
2005 irq_flow_handler_t handler,
2008 struct lock_class_key *lock_key,
2009 struct lock_class_key *request_key)
2011 struct device_node *of_node;
2013 if (!gpiochip || !irqchip)
2016 if (!gpiochip->parent) {
2017 pr_err("missing gpiochip .dev parent pointer\n");
2020 gpiochip->irq.threaded = threaded;
2021 of_node = gpiochip->parent->of_node;
2022 #ifdef CONFIG_OF_GPIO
2024 * If the gpiochip has an assigned OF node this takes precedence
2025 * FIXME: get rid of this and use gpiochip->parent->of_node
2028 if (gpiochip->of_node)
2029 of_node = gpiochip->of_node;
2032 * Specifying a default trigger is a terrible idea if DT or ACPI is
2033 * used to configure the interrupts, as you may end-up with
2034 * conflicting triggers. Tell the user, and reset to NONE.
2036 if (WARN(of_node && type != IRQ_TYPE_NONE,
2037 "%pOF: Ignoring %d default trigger\n", of_node, type))
2038 type = IRQ_TYPE_NONE;
2039 if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
2040 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
2041 "Ignoring %d default trigger\n", type);
2042 type = IRQ_TYPE_NONE;
2045 gpiochip->irq.chip = irqchip;
2046 gpiochip->irq.handler = handler;
2047 gpiochip->irq.default_type = type;
2048 gpiochip->to_irq = gpiochip_to_irq;
2049 gpiochip->irq.lock_key = lock_key;
2050 gpiochip->irq.request_key = request_key;
2051 gpiochip->irq.domain = irq_domain_add_simple(of_node,
2052 gpiochip->ngpio, first_irq,
2053 &gpiochip_domain_ops, gpiochip);
2054 if (!gpiochip->irq.domain) {
2055 gpiochip->irq.chip = NULL;
2060 * It is possible for a driver to override this, but only if the
2061 * alternative functions are both implemented.
2063 if (!irqchip->irq_request_resources &&
2064 !irqchip->irq_release_resources) {
2065 irqchip->irq_request_resources = gpiochip_irq_reqres;
2066 irqchip->irq_release_resources = gpiochip_irq_relres;
2069 acpi_gpiochip_request_interrupts(gpiochip);
2073 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_key);
2075 #else /* CONFIG_GPIOLIB_IRQCHIP */
2077 static inline int gpiochip_add_irqchip(struct gpio_chip *gpiochip,
2078 struct lock_class_key *lock_key,
2079 struct lock_class_key *request_key)
2084 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
2085 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
2089 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
2092 #endif /* CONFIG_GPIOLIB_IRQCHIP */
2095 * gpiochip_generic_request() - request the gpio function for a pin
2096 * @chip: the gpiochip owning the GPIO
2097 * @offset: the offset of the GPIO to request for GPIO function
2099 int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
2101 return pinctrl_gpio_request(chip->gpiodev->base + offset);
2103 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
2106 * gpiochip_generic_free() - free the gpio function from a pin
2107 * @chip: the gpiochip to request the gpio function for
2108 * @offset: the offset of the GPIO to free from GPIO function
2110 void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
2112 pinctrl_gpio_free(chip->gpiodev->base + offset);
2114 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
2117 * gpiochip_generic_config() - apply configuration for a pin
2118 * @chip: the gpiochip owning the GPIO
2119 * @offset: the offset of the GPIO to apply the configuration
2120 * @config: the configuration to be applied
2122 int gpiochip_generic_config(struct gpio_chip *chip, unsigned offset,
2123 unsigned long config)
2125 return pinctrl_gpio_set_config(chip->gpiodev->base + offset, config);
2127 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
2129 #ifdef CONFIG_PINCTRL
2132 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
2133 * @chip: the gpiochip to add the range for
2134 * @pctldev: the pin controller to map to
2135 * @gpio_offset: the start offset in the current gpio_chip number space
2136 * @pin_group: name of the pin group inside the pin controller
2138 * Calling this function directly from a DeviceTree-supported
2139 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2140 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2141 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2143 int gpiochip_add_pingroup_range(struct gpio_chip *chip,
2144 struct pinctrl_dev *pctldev,
2145 unsigned int gpio_offset, const char *pin_group)
2147 struct gpio_pin_range *pin_range;
2148 struct gpio_device *gdev = chip->gpiodev;
2151 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2153 chip_err(chip, "failed to allocate pin ranges\n");
2157 /* Use local offset as range ID */
2158 pin_range->range.id = gpio_offset;
2159 pin_range->range.gc = chip;
2160 pin_range->range.name = chip->label;
2161 pin_range->range.base = gdev->base + gpio_offset;
2162 pin_range->pctldev = pctldev;
2164 ret = pinctrl_get_group_pins(pctldev, pin_group,
2165 &pin_range->range.pins,
2166 &pin_range->range.npins);
2172 pinctrl_add_gpio_range(pctldev, &pin_range->range);
2174 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
2175 gpio_offset, gpio_offset + pin_range->range.npins - 1,
2176 pinctrl_dev_get_devname(pctldev), pin_group);
2178 list_add_tail(&pin_range->node, &gdev->pin_ranges);
2182 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
2185 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
2186 * @chip: the gpiochip to add the range for
2187 * @pinctl_name: the dev_name() of the pin controller to map to
2188 * @gpio_offset: the start offset in the current gpio_chip number space
2189 * @pin_offset: the start offset in the pin controller number space
2190 * @npins: the number of pins from the offset of each pin space (GPIO and
2191 * pin controller) to accumulate in this range
2194 * 0 on success, or a negative error-code on failure.
2196 * Calling this function directly from a DeviceTree-supported
2197 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2198 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2199 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2201 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
2202 unsigned int gpio_offset, unsigned int pin_offset,
2205 struct gpio_pin_range *pin_range;
2206 struct gpio_device *gdev = chip->gpiodev;
2209 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2211 chip_err(chip, "failed to allocate pin ranges\n");
2215 /* Use local offset as range ID */
2216 pin_range->range.id = gpio_offset;
2217 pin_range->range.gc = chip;
2218 pin_range->range.name = chip->label;
2219 pin_range->range.base = gdev->base + gpio_offset;
2220 pin_range->range.pin_base = pin_offset;
2221 pin_range->range.npins = npins;
2222 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
2224 if (IS_ERR(pin_range->pctldev)) {
2225 ret = PTR_ERR(pin_range->pctldev);
2226 chip_err(chip, "could not create pin range\n");
2230 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
2231 gpio_offset, gpio_offset + npins - 1,
2233 pin_offset, pin_offset + npins - 1);
2235 list_add_tail(&pin_range->node, &gdev->pin_ranges);
2239 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
2242 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
2243 * @chip: the chip to remove all the mappings for
2245 void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
2247 struct gpio_pin_range *pin_range, *tmp;
2248 struct gpio_device *gdev = chip->gpiodev;
2250 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
2251 list_del(&pin_range->node);
2252 pinctrl_remove_gpio_range(pin_range->pctldev,
2257 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
2259 #endif /* CONFIG_PINCTRL */
2261 /* These "optional" allocation calls help prevent drivers from stomping
2262 * on each other, and help provide better diagnostics in debugfs.
2263 * They're called even less than the "set direction" calls.
2265 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
2267 struct gpio_chip *chip = desc->gdev->chip;
2269 unsigned long flags;
2272 spin_lock_irqsave(&gpio_lock, flags);
2274 /* NOTE: gpio_request() can be called in early boot,
2275 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
2278 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
2279 desc_set_label(desc, label ? : "?");
2286 if (chip->request) {
2287 /* chip->request may sleep */
2288 spin_unlock_irqrestore(&gpio_lock, flags);
2289 offset = gpio_chip_hwgpio(desc);
2290 if (gpiochip_line_is_valid(chip, offset))
2291 status = chip->request(chip, offset);
2294 spin_lock_irqsave(&gpio_lock, flags);
2297 desc_set_label(desc, NULL);
2298 clear_bit(FLAG_REQUESTED, &desc->flags);
2302 if (chip->get_direction) {
2303 /* chip->get_direction may sleep */
2304 spin_unlock_irqrestore(&gpio_lock, flags);
2305 gpiod_get_direction(desc);
2306 spin_lock_irqsave(&gpio_lock, flags);
2309 spin_unlock_irqrestore(&gpio_lock, flags);
2314 * This descriptor validation needs to be inserted verbatim into each
2315 * function taking a descriptor, so we need to use a preprocessor
2316 * macro to avoid endless duplication. If the desc is NULL it is an
2317 * optional GPIO and calls should just bail out.
2319 static int validate_desc(const struct gpio_desc *desc, const char *func)
2324 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
2325 return PTR_ERR(desc);
2328 pr_warn("%s: invalid GPIO (no device)\n", func);
2331 if (!desc->gdev->chip) {
2332 dev_warn(&desc->gdev->dev,
2333 "%s: backing chip is gone\n", func);
2339 #define VALIDATE_DESC(desc) do { \
2340 int __valid = validate_desc(desc, __func__); \
2345 #define VALIDATE_DESC_VOID(desc) do { \
2346 int __valid = validate_desc(desc, __func__); \
2351 int gpiod_request(struct gpio_desc *desc, const char *label)
2353 int status = -EPROBE_DEFER;
2354 struct gpio_device *gdev;
2356 VALIDATE_DESC(desc);
2359 if (try_module_get(gdev->owner)) {
2360 status = gpiod_request_commit(desc, label);
2362 module_put(gdev->owner);
2364 get_device(&gdev->dev);
2368 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
2373 static bool gpiod_free_commit(struct gpio_desc *desc)
2376 unsigned long flags;
2377 struct gpio_chip *chip;
2381 gpiod_unexport(desc);
2383 spin_lock_irqsave(&gpio_lock, flags);
2385 chip = desc->gdev->chip;
2386 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
2388 spin_unlock_irqrestore(&gpio_lock, flags);
2389 might_sleep_if(chip->can_sleep);
2390 chip->free(chip, gpio_chip_hwgpio(desc));
2391 spin_lock_irqsave(&gpio_lock, flags);
2393 desc_set_label(desc, NULL);
2394 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2395 clear_bit(FLAG_REQUESTED, &desc->flags);
2396 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2397 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2398 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2402 spin_unlock_irqrestore(&gpio_lock, flags);
2406 void gpiod_free(struct gpio_desc *desc)
2408 if (desc && desc->gdev && gpiod_free_commit(desc)) {
2409 module_put(desc->gdev->owner);
2410 put_device(&desc->gdev->dev);
2412 WARN_ON(extra_checks);
2417 * gpiochip_is_requested - return string iff signal was requested
2418 * @chip: controller managing the signal
2419 * @offset: of signal within controller's 0..(ngpio - 1) range
2421 * Returns NULL if the GPIO is not currently requested, else a string.
2422 * The string returned is the label passed to gpio_request(); if none has been
2423 * passed it is a meaningless, non-NULL constant.
2425 * This function is for use by GPIO controller drivers. The label can
2426 * help with diagnostics, and knowing that the signal is used as a GPIO
2427 * can help avoid accidentally multiplexing it to another controller.
2429 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
2431 struct gpio_desc *desc;
2433 if (offset >= chip->ngpio)
2436 desc = &chip->gpiodev->descs[offset];
2438 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2442 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2445 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2447 * @hwnum: hardware number of the GPIO for which to request the descriptor
2448 * @label: label for the GPIO
2450 * Function allows GPIO chip drivers to request and use their own GPIO
2451 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2452 * function will not increase reference count of the GPIO chip module. This
2453 * allows the GPIO chip module to be unloaded as needed (we assume that the
2454 * GPIO chip driver handles freeing the GPIOs it has requested).
2457 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2460 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
2463 struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
2467 chip_err(chip, "failed to get GPIO descriptor\n");
2471 err = gpiod_request_commit(desc, label);
2473 return ERR_PTR(err);
2477 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2480 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2481 * @desc: GPIO descriptor to free
2483 * Function frees the given GPIO requested previously with
2484 * gpiochip_request_own_desc().
2486 void gpiochip_free_own_desc(struct gpio_desc *desc)
2489 gpiod_free_commit(desc);
2491 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2494 * Drivers MUST set GPIO direction before making get/set calls. In
2495 * some cases this is done in early boot, before IRQs are enabled.
2497 * As a rule these aren't called more than once (except for drivers
2498 * using the open-drain emulation idiom) so these are natural places
2499 * to accumulate extra debugging checks. Note that we can't (yet)
2500 * rely on gpio_request() having been called beforehand.
2504 * gpiod_direction_input - set the GPIO direction to input
2505 * @desc: GPIO to set to input
2507 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2508 * be called safely on it.
2510 * Return 0 in case of success, else an error code.
2512 int gpiod_direction_input(struct gpio_desc *desc)
2514 struct gpio_chip *chip;
2515 int status = -EINVAL;
2517 VALIDATE_DESC(desc);
2518 chip = desc->gdev->chip;
2520 if (!chip->get || !chip->direction_input) {
2522 "%s: missing get() or direction_input() operations\n",
2527 status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
2529 clear_bit(FLAG_IS_OUT, &desc->flags);
2531 trace_gpio_direction(desc_to_gpio(desc), 1, status);
2535 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2537 static int gpio_set_drive_single_ended(struct gpio_chip *gc, unsigned offset,
2538 enum pin_config_param mode)
2540 unsigned long config = { PIN_CONF_PACKED(mode, 0) };
2542 return gc->set_config ? gc->set_config(gc, offset, config) : -ENOTSUPP;
2545 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2547 struct gpio_chip *gc = desc->gdev->chip;
2551 if (!gc->set || !gc->direction_output) {
2553 "%s: missing set() or direction_output() operations\n",
2558 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2560 set_bit(FLAG_IS_OUT, &desc->flags);
2561 trace_gpio_value(desc_to_gpio(desc), 0, val);
2562 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2567 * gpiod_direction_output_raw - set the GPIO direction to output
2568 * @desc: GPIO to set to output
2569 * @value: initial output value of the GPIO
2571 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2572 * be called safely on it. The initial value of the output must be specified
2573 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2575 * Return 0 in case of success, else an error code.
2577 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2579 VALIDATE_DESC(desc);
2580 return gpiod_direction_output_raw_commit(desc, value);
2582 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2585 * gpiod_direction_output - set the GPIO direction to output
2586 * @desc: GPIO to set to output
2587 * @value: initial output value of the GPIO
2589 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2590 * be called safely on it. The initial value of the output must be specified
2591 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2594 * Return 0 in case of success, else an error code.
2596 int gpiod_direction_output(struct gpio_desc *desc, int value)
2598 struct gpio_chip *gc;
2601 VALIDATE_DESC(desc);
2602 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2607 /* GPIOs used for IRQs shall not be set as output */
2608 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
2610 "%s: tried to set a GPIO tied to an IRQ as output\n",
2615 gc = desc->gdev->chip;
2616 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2617 /* First see if we can enable open drain in hardware */
2618 ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2619 PIN_CONFIG_DRIVE_OPEN_DRAIN);
2621 goto set_output_value;
2622 /* Emulate open drain by not actively driving the line high */
2624 return gpiod_direction_input(desc);
2626 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2627 ret = gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2628 PIN_CONFIG_DRIVE_OPEN_SOURCE);
2630 goto set_output_value;
2631 /* Emulate open source by not actively driving the line low */
2633 return gpiod_direction_input(desc);
2635 gpio_set_drive_single_ended(gc, gpio_chip_hwgpio(desc),
2636 PIN_CONFIG_DRIVE_PUSH_PULL);
2640 return gpiod_direction_output_raw_commit(desc, value);
2642 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2645 * gpiod_set_debounce - sets @debounce time for a GPIO
2646 * @desc: descriptor of the GPIO for which to set debounce time
2647 * @debounce: debounce time in microseconds
2650 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2653 int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
2655 struct gpio_chip *chip;
2656 unsigned long config;
2658 VALIDATE_DESC(desc);
2659 chip = desc->gdev->chip;
2660 if (!chip->set || !chip->set_config) {
2662 "%s: missing set() or set_config() operations\n",
2667 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2668 return chip->set_config(chip, gpio_chip_hwgpio(desc), config);
2670 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2673 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2674 * @desc: descriptor of the GPIO for which to configure persistence
2675 * @transitory: True to lose state on suspend or reset, false for persistence
2678 * 0 on success, otherwise a negative error code.
2680 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2682 struct gpio_chip *chip;
2683 unsigned long packed;
2687 VALIDATE_DESC(desc);
2689 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2690 * persistence state.
2693 set_bit(FLAG_TRANSITORY, &desc->flags);
2695 clear_bit(FLAG_TRANSITORY, &desc->flags);
2697 /* If the driver supports it, set the persistence state now */
2698 chip = desc->gdev->chip;
2699 if (!chip->set_config)
2702 packed = pinconf_to_config_packed(PIN_CONFIG_PERSIST_STATE,
2704 gpio = gpio_chip_hwgpio(desc);
2705 rc = chip->set_config(chip, gpio, packed);
2706 if (rc == -ENOTSUPP) {
2707 dev_dbg(&desc->gdev->dev, "Persistence not supported for GPIO %d\n",
2714 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2717 * gpiod_is_active_low - test whether a GPIO is active-low or not
2718 * @desc: the gpio descriptor to test
2720 * Returns 1 if the GPIO is active-low, 0 otherwise.
2722 int gpiod_is_active_low(const struct gpio_desc *desc)
2724 VALIDATE_DESC(desc);
2725 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2727 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2729 /* I/O calls are only valid after configuration completed; the relevant
2730 * "is this a valid GPIO" error checks should already have been done.
2732 * "Get" operations are often inlinable as reading a pin value register,
2733 * and masking the relevant bit in that register.
2735 * When "set" operations are inlinable, they involve writing that mask to
2736 * one register to set a low value, or a different register to set it high.
2737 * Otherwise locking is needed, so there may be little value to inlining.
2739 *------------------------------------------------------------------------
2741 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2742 * have requested the GPIO. That can include implicit requesting by
2743 * a direction setting call. Marking a gpio as requested locks its chip
2744 * in memory, guaranteeing that these table lookups need no more locking
2745 * and that gpiochip_remove() will fail.
2747 * REVISIT when debugging, consider adding some instrumentation to ensure
2748 * that the GPIO was actually requested.
2751 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2753 struct gpio_chip *chip;
2757 chip = desc->gdev->chip;
2758 offset = gpio_chip_hwgpio(desc);
2759 value = chip->get ? chip->get(chip, offset) : -EIO;
2760 value = value < 0 ? value : !!value;
2761 trace_gpio_value(desc_to_gpio(desc), 1, value);
2765 static int gpio_chip_get_multiple(struct gpio_chip *chip,
2766 unsigned long *mask, unsigned long *bits)
2768 if (chip->get_multiple) {
2769 return chip->get_multiple(chip, mask, bits);
2770 } else if (chip->get) {
2773 for_each_set_bit(i, mask, chip->ngpio) {
2774 value = chip->get(chip, i);
2777 __assign_bit(i, bits, value);
2784 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2785 unsigned int array_size,
2786 struct gpio_desc **desc_array,
2787 unsigned long *value_bitmap)
2791 while (i < array_size) {
2792 struct gpio_chip *chip = desc_array[i]->gdev->chip;
2793 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2794 unsigned long *mask, *bits;
2797 if (likely(chip->ngpio <= FASTPATH_NGPIO)) {
2800 mask = kmalloc_array(2 * BITS_TO_LONGS(chip->ngpio),
2802 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2807 bits = mask + BITS_TO_LONGS(chip->ngpio);
2808 bitmap_zero(mask, chip->ngpio);
2811 WARN_ON(chip->can_sleep);
2813 /* collect all inputs belonging to the same chip */
2816 const struct gpio_desc *desc = desc_array[i];
2817 int hwgpio = gpio_chip_hwgpio(desc);
2819 __set_bit(hwgpio, mask);
2821 } while ((i < array_size) &&
2822 (desc_array[i]->gdev->chip == chip));
2824 ret = gpio_chip_get_multiple(chip, mask, bits);
2826 if (mask != fastpath)
2831 for (j = first; j < i; j++) {
2832 const struct gpio_desc *desc = desc_array[j];
2833 int hwgpio = gpio_chip_hwgpio(desc);
2834 int value = test_bit(hwgpio, bits);
2836 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2838 __assign_bit(j, value_bitmap, value);
2839 trace_gpio_value(desc_to_gpio(desc), 1, value);
2842 if (mask != fastpath)
2849 * gpiod_get_raw_value() - return a gpio's raw value
2850 * @desc: gpio whose value will be returned
2852 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2853 * its ACTIVE_LOW status, or negative errno on failure.
2855 * This function should be called from contexts where we cannot sleep, and will
2856 * complain if the GPIO chip functions potentially sleep.
2858 int gpiod_get_raw_value(const struct gpio_desc *desc)
2860 VALIDATE_DESC(desc);
2861 /* Should be using gpio_get_value_cansleep() */
2862 WARN_ON(desc->gdev->chip->can_sleep);
2863 return gpiod_get_raw_value_commit(desc);
2865 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2868 * gpiod_get_value() - return a gpio's value
2869 * @desc: gpio whose value will be returned
2871 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2872 * account, or negative errno on failure.
2874 * This function should be called from contexts where we cannot sleep, and will
2875 * complain if the GPIO chip functions potentially sleep.
2877 int gpiod_get_value(const struct gpio_desc *desc)
2881 VALIDATE_DESC(desc);
2882 /* Should be using gpio_get_value_cansleep() */
2883 WARN_ON(desc->gdev->chip->can_sleep);
2885 value = gpiod_get_raw_value_commit(desc);
2889 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2894 EXPORT_SYMBOL_GPL(gpiod_get_value);
2897 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2898 * @array_size: number of elements in the descriptor array / value bitmap
2899 * @desc_array: array of GPIO descriptors whose values will be read
2900 * @value_bitmap: bitmap to store the read values
2902 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2903 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2904 * else an error code.
2906 * This function should be called from contexts where we cannot sleep,
2907 * and it will complain if the GPIO chip functions potentially sleep.
2909 int gpiod_get_raw_array_value(unsigned int array_size,
2910 struct gpio_desc **desc_array,
2911 unsigned long *value_bitmap)
2915 return gpiod_get_array_value_complex(true, false, array_size,
2916 desc_array, value_bitmap);
2918 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2921 * gpiod_get_array_value() - read values from an array of GPIOs
2922 * @array_size: number of elements in the descriptor array / value bitmap
2923 * @desc_array: array of GPIO descriptors whose values will be read
2924 * @value_bitmap: bitmap to store the read values
2926 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2927 * into account. Return 0 in case of success, else an error code.
2929 * This function should be called from contexts where we cannot sleep,
2930 * and it will complain if the GPIO chip functions potentially sleep.
2932 int gpiod_get_array_value(unsigned int array_size,
2933 struct gpio_desc **desc_array,
2934 unsigned long *value_bitmap)
2938 return gpiod_get_array_value_complex(false, false, array_size,
2939 desc_array, value_bitmap);
2941 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2944 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2945 * @desc: gpio descriptor whose state need to be set.
2946 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2948 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2951 struct gpio_chip *chip = desc->gdev->chip;
2952 int offset = gpio_chip_hwgpio(desc);
2955 err = chip->direction_input(chip, offset);
2957 clear_bit(FLAG_IS_OUT, &desc->flags);
2959 err = chip->direction_output(chip, offset, 0);
2961 set_bit(FLAG_IS_OUT, &desc->flags);
2963 trace_gpio_direction(desc_to_gpio(desc), value, err);
2966 "%s: Error in set_value for open drain err %d\n",
2971 * _gpio_set_open_source_value() - Set the open source gpio's value.
2972 * @desc: gpio descriptor whose state need to be set.
2973 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2975 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2978 struct gpio_chip *chip = desc->gdev->chip;
2979 int offset = gpio_chip_hwgpio(desc);
2982 err = chip->direction_output(chip, offset, 1);
2984 set_bit(FLAG_IS_OUT, &desc->flags);
2986 err = chip->direction_input(chip, offset);
2988 clear_bit(FLAG_IS_OUT, &desc->flags);
2990 trace_gpio_direction(desc_to_gpio(desc), !value, err);
2993 "%s: Error in set_value for open source err %d\n",
2997 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2999 struct gpio_chip *chip;
3001 chip = desc->gdev->chip;
3002 trace_gpio_value(desc_to_gpio(desc), 0, value);
3003 chip->set(chip, gpio_chip_hwgpio(desc), value);
3007 * set multiple outputs on the same chip;
3008 * use the chip's set_multiple function if available;
3009 * otherwise set the outputs sequentially;
3010 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
3011 * defines which outputs are to be changed
3012 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
3013 * defines the values the outputs specified by mask are to be set to
3015 static void gpio_chip_set_multiple(struct gpio_chip *chip,
3016 unsigned long *mask, unsigned long *bits)
3018 if (chip->set_multiple) {
3019 chip->set_multiple(chip, mask, bits);
3023 /* set outputs if the corresponding mask bit is set */
3024 for_each_set_bit(i, mask, chip->ngpio)
3025 chip->set(chip, i, test_bit(i, bits));
3029 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
3030 unsigned int array_size,
3031 struct gpio_desc **desc_array,
3032 unsigned long *value_bitmap)
3036 while (i < array_size) {
3037 struct gpio_chip *chip = desc_array[i]->gdev->chip;
3038 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
3039 unsigned long *mask, *bits;
3042 if (likely(chip->ngpio <= FASTPATH_NGPIO)) {
3045 mask = kmalloc_array(2 * BITS_TO_LONGS(chip->ngpio),
3047 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
3052 bits = mask + BITS_TO_LONGS(chip->ngpio);
3053 bitmap_zero(mask, chip->ngpio);
3056 WARN_ON(chip->can_sleep);
3059 struct gpio_desc *desc = desc_array[i];
3060 int hwgpio = gpio_chip_hwgpio(desc);
3061 int value = test_bit(i, value_bitmap);
3063 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3065 trace_gpio_value(desc_to_gpio(desc), 0, value);
3067 * collect all normal outputs belonging to the same chip
3068 * open drain and open source outputs are set individually
3070 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
3071 gpio_set_open_drain_value_commit(desc, value);
3072 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
3073 gpio_set_open_source_value_commit(desc, value);
3075 __set_bit(hwgpio, mask);
3077 __set_bit(hwgpio, bits);
3079 __clear_bit(hwgpio, bits);
3083 } while ((i < array_size) &&
3084 (desc_array[i]->gdev->chip == chip));
3085 /* push collected bits to outputs */
3087 gpio_chip_set_multiple(chip, mask, bits);
3089 if (mask != fastpath)
3096 * gpiod_set_raw_value() - assign a gpio's raw value
3097 * @desc: gpio whose value will be assigned
3098 * @value: value to assign
3100 * Set the raw value of the GPIO, i.e. the value of its physical line without
3101 * regard for its ACTIVE_LOW status.
3103 * This function should be called from contexts where we cannot sleep, and will
3104 * complain if the GPIO chip functions potentially sleep.
3106 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
3108 VALIDATE_DESC_VOID(desc);
3109 /* Should be using gpiod_set_value_cansleep() */
3110 WARN_ON(desc->gdev->chip->can_sleep);
3111 gpiod_set_raw_value_commit(desc, value);
3113 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
3116 * gpiod_set_value_nocheck() - set a GPIO line value without checking
3117 * @desc: the descriptor to set the value on
3118 * @value: value to set
3120 * This sets the value of a GPIO line backing a descriptor, applying
3121 * different semantic quirks like active low and open drain/source
3124 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
3126 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3128 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
3129 gpio_set_open_drain_value_commit(desc, value);
3130 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
3131 gpio_set_open_source_value_commit(desc, value);
3133 gpiod_set_raw_value_commit(desc, value);
3137 * gpiod_set_value() - assign a gpio's value
3138 * @desc: gpio whose value will be assigned
3139 * @value: value to assign
3141 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
3142 * OPEN_DRAIN and OPEN_SOURCE flags into account.
3144 * This function should be called from contexts where we cannot sleep, and will
3145 * complain if the GPIO chip functions potentially sleep.
3147 void gpiod_set_value(struct gpio_desc *desc, int value)
3149 VALIDATE_DESC_VOID(desc);
3150 WARN_ON(desc->gdev->chip->can_sleep);
3151 gpiod_set_value_nocheck(desc, value);
3153 EXPORT_SYMBOL_GPL(gpiod_set_value);
3156 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
3157 * @array_size: number of elements in the descriptor array / value bitmap
3158 * @desc_array: array of GPIO descriptors whose values will be assigned
3159 * @value_bitmap: bitmap of values to assign
3161 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3162 * without regard for their ACTIVE_LOW status.
3164 * This function should be called from contexts where we cannot sleep, and will
3165 * complain if the GPIO chip functions potentially sleep.
3167 int gpiod_set_raw_array_value(unsigned int array_size,
3168 struct gpio_desc **desc_array,
3169 unsigned long *value_bitmap)
3173 return gpiod_set_array_value_complex(true, false, array_size,
3174 desc_array, value_bitmap);
3176 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
3179 * gpiod_set_array_value() - assign values to an array of GPIOs
3180 * @array_size: number of elements in the descriptor array / value bitmap
3181 * @desc_array: array of GPIO descriptors whose values will be assigned
3182 * @value_bitmap: bitmap of values to assign
3184 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3187 * This function should be called from contexts where we cannot sleep, and will
3188 * complain if the GPIO chip functions potentially sleep.
3190 void gpiod_set_array_value(unsigned int array_size,
3191 struct gpio_desc **desc_array,
3192 unsigned long *value_bitmap)
3196 gpiod_set_array_value_complex(false, false, array_size, desc_array,
3199 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3202 * gpiod_cansleep() - report whether gpio value access may sleep
3203 * @desc: gpio to check
3206 int gpiod_cansleep(const struct gpio_desc *desc)
3208 VALIDATE_DESC(desc);
3209 return desc->gdev->chip->can_sleep;
3211 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3214 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3215 * @desc: gpio to set the consumer name on
3216 * @name: the new consumer name
3218 void gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3220 VALIDATE_DESC_VOID(desc);
3221 /* Just overwrite whatever the previous name was */
3224 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3227 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3228 * @desc: gpio whose IRQ will be returned (already requested)
3230 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3233 int gpiod_to_irq(const struct gpio_desc *desc)
3235 struct gpio_chip *chip;
3239 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3240 * requires this function to not return zero on an invalid descriptor
3241 * but rather a negative error number.
3243 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3246 chip = desc->gdev->chip;
3247 offset = gpio_chip_hwgpio(desc);
3249 int retirq = chip->to_irq(chip, offset);
3251 /* Zero means NO_IRQ */
3259 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3262 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3263 * @chip: the chip the GPIO to lock belongs to
3264 * @offset: the offset of the GPIO to lock as IRQ
3266 * This is used directly by GPIO drivers that want to lock down
3267 * a certain GPIO line to be used for IRQs.
3269 int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
3271 struct gpio_desc *desc;
3273 desc = gpiochip_get_desc(chip, offset);
3275 return PTR_ERR(desc);
3278 * If it's fast: flush the direction setting if something changed
3281 if (!chip->can_sleep && chip->get_direction) {
3282 int dir = gpiod_get_direction(desc);
3285 chip_err(chip, "%s: cannot get GPIO direction\n",
3291 if (test_bit(FLAG_IS_OUT, &desc->flags)) {
3293 "%s: tried to flag a GPIO set as output for IRQ\n",
3298 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3301 * If the consumer has not set up a label (such as when the
3302 * IRQ is referenced from .to_irq()) we set up a label here
3303 * so it is clear this is used as an interrupt.
3306 desc_set_label(desc, "interrupt");
3310 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3313 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3314 * @chip: the chip the GPIO to lock belongs to
3315 * @offset: the offset of the GPIO to lock as IRQ
3317 * This is used directly by GPIO drivers that want to indicate
3318 * that a certain GPIO is no longer used exclusively for IRQ.
3320 void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
3322 struct gpio_desc *desc;
3324 desc = gpiochip_get_desc(chip, offset);
3328 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3330 /* If we only had this marking, erase it */
3331 if (desc->label && !strcmp(desc->label, "interrupt"))
3332 desc_set_label(desc, NULL);
3334 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3336 bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
3338 if (offset >= chip->ngpio)
3341 return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
3343 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3345 bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
3347 if (offset >= chip->ngpio)
3350 return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
3352 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3354 bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
3356 if (offset >= chip->ngpio)
3359 return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
3361 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3363 bool gpiochip_line_is_persistent(struct gpio_chip *chip, unsigned int offset)
3365 if (offset >= chip->ngpio)
3368 return !test_bit(FLAG_TRANSITORY, &chip->gpiodev->descs[offset].flags);
3370 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3373 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3374 * @desc: gpio whose value will be returned
3376 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3377 * its ACTIVE_LOW status, or negative errno on failure.
3379 * This function is to be called from contexts that can sleep.
3381 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3383 might_sleep_if(extra_checks);
3384 VALIDATE_DESC(desc);
3385 return gpiod_get_raw_value_commit(desc);
3387 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3390 * gpiod_get_value_cansleep() - return a gpio's value
3391 * @desc: gpio whose value will be returned
3393 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3394 * account, or negative errno on failure.
3396 * This function is to be called from contexts that can sleep.
3398 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3402 might_sleep_if(extra_checks);
3403 VALIDATE_DESC(desc);
3404 value = gpiod_get_raw_value_commit(desc);
3408 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3413 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3416 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3417 * @array_size: number of elements in the descriptor array / value bitmap
3418 * @desc_array: array of GPIO descriptors whose values will be read
3419 * @value_bitmap: bitmap to store the read values
3421 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3422 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3423 * else an error code.
3425 * This function is to be called from contexts that can sleep.
3427 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3428 struct gpio_desc **desc_array,
3429 unsigned long *value_bitmap)
3431 might_sleep_if(extra_checks);
3434 return gpiod_get_array_value_complex(true, true, array_size,
3435 desc_array, value_bitmap);
3437 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3440 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3441 * @array_size: number of elements in the descriptor array / value bitmap
3442 * @desc_array: array of GPIO descriptors whose values will be read
3443 * @value_bitmap: bitmap to store the read values
3445 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3446 * into account. Return 0 in case of success, else an error code.
3448 * This function is to be called from contexts that can sleep.
3450 int gpiod_get_array_value_cansleep(unsigned int array_size,
3451 struct gpio_desc **desc_array,
3452 unsigned long *value_bitmap)
3454 might_sleep_if(extra_checks);
3457 return gpiod_get_array_value_complex(false, true, array_size,
3458 desc_array, value_bitmap);
3460 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3463 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3464 * @desc: gpio whose value will be assigned
3465 * @value: value to assign
3467 * Set the raw value of the GPIO, i.e. the value of its physical line without
3468 * regard for its ACTIVE_LOW status.
3470 * This function is to be called from contexts that can sleep.
3472 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3474 might_sleep_if(extra_checks);
3475 VALIDATE_DESC_VOID(desc);
3476 gpiod_set_raw_value_commit(desc, value);
3478 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3481 * gpiod_set_value_cansleep() - assign a gpio's value
3482 * @desc: gpio whose value will be assigned
3483 * @value: value to assign
3485 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3488 * This function is to be called from contexts that can sleep.
3490 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3492 might_sleep_if(extra_checks);
3493 VALIDATE_DESC_VOID(desc);
3494 gpiod_set_value_nocheck(desc, value);
3496 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3499 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3500 * @array_size: number of elements in the descriptor array / value bitmap
3501 * @desc_array: array of GPIO descriptors whose values will be assigned
3502 * @value_bitmap: bitmap of values to assign
3504 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3505 * without regard for their ACTIVE_LOW status.
3507 * This function is to be called from contexts that can sleep.
3509 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3510 struct gpio_desc **desc_array,
3511 unsigned long *value_bitmap)
3513 might_sleep_if(extra_checks);
3516 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3519 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3522 * gpiod_add_lookup_tables() - register GPIO device consumers
3523 * @tables: list of tables of consumers to register
3524 * @n: number of tables in the list
3526 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3530 mutex_lock(&gpio_lookup_lock);
3532 for (i = 0; i < n; i++)
3533 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3535 mutex_unlock(&gpio_lookup_lock);
3539 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3540 * @array_size: number of elements in the descriptor array / value bitmap
3541 * @desc_array: array of GPIO descriptors whose values will be assigned
3542 * @value_bitmap: bitmap of values to assign
3544 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3547 * This function is to be called from contexts that can sleep.
3549 void gpiod_set_array_value_cansleep(unsigned int array_size,
3550 struct gpio_desc **desc_array,
3551 unsigned long *value_bitmap)
3553 might_sleep_if(extra_checks);
3556 gpiod_set_array_value_complex(false, true, array_size, desc_array,
3559 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3562 * gpiod_add_lookup_table() - register GPIO device consumers
3563 * @table: table of consumers to register
3565 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3567 mutex_lock(&gpio_lookup_lock);
3569 list_add_tail(&table->list, &gpio_lookup_list);
3571 mutex_unlock(&gpio_lookup_lock);
3573 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3576 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3577 * @table: table of consumers to unregister
3579 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3581 mutex_lock(&gpio_lookup_lock);
3583 list_del(&table->list);
3585 mutex_unlock(&gpio_lookup_lock);
3587 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3590 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3591 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3593 void gpiod_add_hogs(struct gpiod_hog *hogs)
3595 struct gpio_chip *chip;
3596 struct gpiod_hog *hog;
3598 mutex_lock(&gpio_machine_hogs_mutex);
3600 for (hog = &hogs[0]; hog->chip_label; hog++) {
3601 list_add_tail(&hog->list, &gpio_machine_hogs);
3604 * The chip may have been registered earlier, so check if it
3605 * exists and, if so, try to hog the line now.
3607 chip = find_chip_by_name(hog->chip_label);
3609 gpiochip_machine_hog(chip, hog);
3612 mutex_unlock(&gpio_machine_hogs_mutex);
3614 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3616 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3618 const char *dev_id = dev ? dev_name(dev) : NULL;
3619 struct gpiod_lookup_table *table;
3621 mutex_lock(&gpio_lookup_lock);
3623 list_for_each_entry(table, &gpio_lookup_list, list) {
3624 if (table->dev_id && dev_id) {
3626 * Valid strings on both ends, must be identical to have
3629 if (!strcmp(table->dev_id, dev_id))
3633 * One of the pointers is NULL, so both must be to have
3636 if (dev_id == table->dev_id)
3643 mutex_unlock(&gpio_lookup_lock);
3647 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3649 enum gpio_lookup_flags *flags)
3651 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3652 struct gpiod_lookup_table *table;
3653 struct gpiod_lookup *p;
3655 table = gpiod_find_lookup_table(dev);
3659 for (p = &table->table[0]; p->chip_label; p++) {
3660 struct gpio_chip *chip;
3662 /* idx must always match exactly */
3666 /* If the lookup entry has a con_id, require exact match */
3667 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3670 chip = find_chip_by_name(p->chip_label);
3674 * As the lookup table indicates a chip with
3675 * p->chip_label should exist, assume it may
3676 * still appear later and let the interested
3677 * consumer be probed again or let the Deferred
3678 * Probe infrastructure handle the error.
3680 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3682 return ERR_PTR(-EPROBE_DEFER);
3685 if (chip->ngpio <= p->chip_hwnum) {
3687 "requested GPIO %d is out of range [0..%d] for chip %s\n",
3688 idx, chip->ngpio, chip->label);
3689 return ERR_PTR(-EINVAL);
3692 desc = gpiochip_get_desc(chip, p->chip_hwnum);
3701 static int dt_gpio_count(struct device *dev, const char *con_id)
3707 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3709 snprintf(propname, sizeof(propname), "%s-%s",
3710 con_id, gpio_suffixes[i]);
3712 snprintf(propname, sizeof(propname), "%s",
3715 ret = of_gpio_named_count(dev->of_node, propname);
3719 return ret ? ret : -ENOENT;
3722 static int platform_gpio_count(struct device *dev, const char *con_id)
3724 struct gpiod_lookup_table *table;
3725 struct gpiod_lookup *p;
3726 unsigned int count = 0;
3728 table = gpiod_find_lookup_table(dev);
3732 for (p = &table->table[0]; p->chip_label; p++) {
3733 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3734 (!con_id && !p->con_id))
3744 * gpiod_count - return the number of GPIOs associated with a device / function
3745 * or -ENOENT if no GPIO has been assigned to the requested function
3746 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3747 * @con_id: function within the GPIO consumer
3749 int gpiod_count(struct device *dev, const char *con_id)
3751 int count = -ENOENT;
3753 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3754 count = dt_gpio_count(dev, con_id);
3755 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3756 count = acpi_gpio_count(dev, con_id);
3759 count = platform_gpio_count(dev, con_id);
3763 EXPORT_SYMBOL_GPL(gpiod_count);
3766 * gpiod_get - obtain a GPIO for a given GPIO function
3767 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3768 * @con_id: function within the GPIO consumer
3769 * @flags: optional GPIO initialization flags
3771 * Return the GPIO descriptor corresponding to the function con_id of device
3772 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3773 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3775 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3776 enum gpiod_flags flags)
3778 return gpiod_get_index(dev, con_id, 0, flags);
3780 EXPORT_SYMBOL_GPL(gpiod_get);
3783 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3784 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3785 * @con_id: function within the GPIO consumer
3786 * @flags: optional GPIO initialization flags
3788 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3789 * the requested function it will return NULL. This is convenient for drivers
3790 * that need to handle optional GPIOs.
3792 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3794 enum gpiod_flags flags)
3796 return gpiod_get_index_optional(dev, con_id, 0, flags);
3798 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3802 * gpiod_configure_flags - helper function to configure a given GPIO
3803 * @desc: gpio whose value will be assigned
3804 * @con_id: function within the GPIO consumer
3805 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
3807 * @dflags: gpiod_flags - optional GPIO initialization flags
3809 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3810 * requested function and/or index, or another IS_ERR() code if an error
3811 * occurred while trying to acquire the GPIO.
3813 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3814 unsigned long lflags, enum gpiod_flags dflags)
3818 if (lflags & GPIO_ACTIVE_LOW)
3819 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3821 if (lflags & GPIO_OPEN_DRAIN)
3822 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3823 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3825 * This enforces open drain mode from the consumer side.
3826 * This is necessary for some busses like I2C, but the lookup
3827 * should *REALLY* have specified them as open drain in the
3828 * first place, so print a little warning here.
3830 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3832 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3835 if (lflags & GPIO_OPEN_SOURCE)
3836 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3838 status = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
3842 /* No particular flag request, return here... */
3843 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3844 pr_debug("no flags found for %s\n", con_id);
3849 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3850 status = gpiod_direction_output(desc,
3851 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3853 status = gpiod_direction_input(desc);
3859 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3860 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3861 * @con_id: function within the GPIO consumer
3862 * @idx: index of the GPIO to obtain in the consumer
3863 * @flags: optional GPIO initialization flags
3865 * This variant of gpiod_get() allows to access GPIOs other than the first
3866 * defined one for functions that define several GPIOs.
3868 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3869 * requested function and/or index, or another IS_ERR() code if an error
3870 * occurred while trying to acquire the GPIO.
3872 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3875 enum gpiod_flags flags)
3877 struct gpio_desc *desc = NULL;
3879 enum gpio_lookup_flags lookupflags = 0;
3880 /* Maybe we have a device name, maybe not */
3881 const char *devname = dev ? dev_name(dev) : "?";
3883 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3886 /* Using device tree? */
3887 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3888 dev_dbg(dev, "using device tree for GPIO lookup\n");
3889 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3890 } else if (ACPI_COMPANION(dev)) {
3891 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3892 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3897 * Either we are not using DT or ACPI, or their lookup did not return
3898 * a result. In that case, use platform lookup as a fallback.
3900 if (!desc || desc == ERR_PTR(-ENOENT)) {
3901 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3902 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3906 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
3911 * If a connection label was passed use that, else attempt to use
3912 * the device name as label
3914 status = gpiod_request(desc, con_id ? con_id : devname);
3916 return ERR_PTR(status);
3918 status = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3920 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3922 return ERR_PTR(status);
3927 EXPORT_SYMBOL_GPL(gpiod_get_index);
3930 * gpiod_get_from_of_node() - obtain a GPIO from an OF node
3931 * @node: handle of the OF node
3932 * @propname: name of the DT property representing the GPIO
3933 * @index: index of the GPIO to obtain for the consumer
3934 * @dflags: GPIO initialization flags
3935 * @label: label to attach to the requested GPIO
3938 * On successful request the GPIO pin is configured in accordance with
3939 * provided @dflags. If the node does not have the requested GPIO
3940 * property, NULL is returned.
3942 * In case of error an ERR_PTR() is returned.
3944 struct gpio_desc *gpiod_get_from_of_node(struct device_node *node,
3945 const char *propname, int index,
3946 enum gpiod_flags dflags,
3949 struct gpio_desc *desc;
3950 unsigned long lflags = 0;
3951 enum of_gpio_flags flags;
3952 bool active_low = false;
3953 bool single_ended = false;
3954 bool open_drain = false;
3955 bool transitory = false;
3958 desc = of_get_named_gpiod_flags(node, propname,
3961 if (!desc || IS_ERR(desc)) {
3962 /* If it is not there, just return NULL */
3963 if (PTR_ERR(desc) == -ENOENT)
3968 active_low = flags & OF_GPIO_ACTIVE_LOW;
3969 single_ended = flags & OF_GPIO_SINGLE_ENDED;
3970 open_drain = flags & OF_GPIO_OPEN_DRAIN;
3971 transitory = flags & OF_GPIO_TRANSITORY;
3973 ret = gpiod_request(desc, label);
3975 return ERR_PTR(ret);
3978 lflags |= GPIO_ACTIVE_LOW;
3982 lflags |= GPIO_OPEN_DRAIN;
3984 lflags |= GPIO_OPEN_SOURCE;
3988 lflags |= GPIO_TRANSITORY;
3990 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3993 return ERR_PTR(ret);
3998 EXPORT_SYMBOL(gpiod_get_from_of_node);
4001 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
4002 * @fwnode: handle of the firmware node
4003 * @propname: name of the firmware property representing the GPIO
4004 * @index: index of the GPIO to obtain for the consumer
4005 * @dflags: GPIO initialization flags
4006 * @label: label to attach to the requested GPIO
4008 * This function can be used for drivers that get their configuration
4009 * from opaque firmware.
4011 * The function properly finds the corresponding GPIO using whatever is the
4012 * underlying firmware interface and then makes sure that the GPIO
4013 * descriptor is requested before it is returned to the caller.
4016 * On successful request the GPIO pin is configured in accordance with
4019 * In case of error an ERR_PTR() is returned.
4021 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
4022 const char *propname, int index,
4023 enum gpiod_flags dflags,
4026 struct gpio_desc *desc = ERR_PTR(-ENODEV);
4027 unsigned long lflags = 0;
4031 return ERR_PTR(-EINVAL);
4033 if (is_of_node(fwnode)) {
4034 desc = gpiod_get_from_of_node(to_of_node(fwnode),
4039 } else if (is_acpi_node(fwnode)) {
4040 struct acpi_gpio_info info;
4042 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
4046 acpi_gpio_update_gpiod_flags(&dflags, &info);
4048 if (info.polarity == GPIO_ACTIVE_LOW)
4049 lflags |= GPIO_ACTIVE_LOW;
4052 /* Currently only ACPI takes this path */
4053 ret = gpiod_request(desc, label);
4055 return ERR_PTR(ret);
4057 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
4060 return ERR_PTR(ret);
4065 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
4068 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
4070 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4071 * @con_id: function within the GPIO consumer
4072 * @index: index of the GPIO to obtain in the consumer
4073 * @flags: optional GPIO initialization flags
4075 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
4076 * specified index was assigned to the requested function it will return NULL.
4077 * This is convenient for drivers that need to handle optional GPIOs.
4079 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
4082 enum gpiod_flags flags)
4084 struct gpio_desc *desc;
4086 desc = gpiod_get_index(dev, con_id, index, flags);
4088 if (PTR_ERR(desc) == -ENOENT)
4094 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
4097 * gpiod_hog - Hog the specified GPIO desc given the provided flags
4098 * @desc: gpio whose value will be assigned
4099 * @name: gpio line name
4100 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
4102 * @dflags: gpiod_flags - optional GPIO initialization flags
4104 int gpiod_hog(struct gpio_desc *desc, const char *name,
4105 unsigned long lflags, enum gpiod_flags dflags)
4107 struct gpio_chip *chip;
4108 struct gpio_desc *local_desc;
4112 chip = gpiod_to_chip(desc);
4113 hwnum = gpio_chip_hwgpio(desc);
4115 local_desc = gpiochip_request_own_desc(chip, hwnum, name);
4116 if (IS_ERR(local_desc)) {
4117 status = PTR_ERR(local_desc);
4118 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4119 name, chip->label, hwnum, status);
4123 status = gpiod_configure_flags(desc, name, lflags, dflags);
4125 pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n",
4126 name, chip->label, hwnum, status);
4127 gpiochip_free_own_desc(desc);
4131 /* Mark GPIO as hogged so it can be identified and removed later */
4132 set_bit(FLAG_IS_HOGGED, &desc->flags);
4134 pr_info("GPIO line %d (%s) hogged as %s%s\n",
4135 desc_to_gpio(desc), name,
4136 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4137 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
4138 (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
4144 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4145 * @chip: gpio chip to act on
4147 * This is only used by of_gpiochip_remove to free hogged gpios
4149 static void gpiochip_free_hogs(struct gpio_chip *chip)
4153 for (id = 0; id < chip->ngpio; id++) {
4154 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
4155 gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
4160 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4161 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4162 * @con_id: function within the GPIO consumer
4163 * @flags: optional GPIO initialization flags
4165 * This function acquires all the GPIOs defined under a given function.
4167 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4168 * no GPIO has been assigned to the requested function, or another IS_ERR()
4169 * code if an error occurred while trying to acquire the GPIOs.
4171 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4173 enum gpiod_flags flags)
4175 struct gpio_desc *desc;
4176 struct gpio_descs *descs;
4177 struct gpio_array *array_info = NULL;
4178 struct gpio_chip *chip;
4179 int count, bitmap_size;
4181 count = gpiod_count(dev, con_id);
4183 return ERR_PTR(count);
4185 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4187 return ERR_PTR(-ENOMEM);
4189 for (descs->ndescs = 0; descs->ndescs < count; ) {
4190 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4192 gpiod_put_array(descs);
4193 return ERR_CAST(desc);
4196 descs->desc[descs->ndescs] = desc;
4198 chip = gpiod_to_chip(desc);
4200 * Select a chip of first array member
4201 * whose index matches its pin hardware number
4202 * as a candidate for fast bitmap processing.
4204 if (!array_info && gpio_chip_hwgpio(desc) == descs->ndescs) {
4205 struct gpio_descs *array;
4207 bitmap_size = BITS_TO_LONGS(chip->ngpio > count ?
4208 chip->ngpio : count);
4210 array = kzalloc(struct_size(descs, desc, count) +
4211 struct_size(array_info, invert_mask,
4212 3 * bitmap_size), GFP_KERNEL);
4214 gpiod_put_array(descs);
4215 return ERR_PTR(-ENOMEM);
4218 memcpy(array, descs,
4219 struct_size(descs, desc, descs->ndescs + 1));
4223 array_info = (void *)(descs->desc + count);
4224 array_info->get_mask = array_info->invert_mask +
4226 array_info->set_mask = array_info->get_mask +
4229 array_info->desc = descs->desc;
4230 array_info->size = count;
4231 array_info->chip = chip;
4232 bitmap_set(array_info->get_mask, descs->ndescs,
4233 count - descs->ndescs);
4234 bitmap_set(array_info->set_mask, descs->ndescs,
4235 count - descs->ndescs);
4236 descs->info = array_info;
4239 * Unmark members which don't qualify for fast bitmap
4240 * processing (different chip, not in hardware order)
4242 if (array_info && (chip != array_info->chip ||
4243 gpio_chip_hwgpio(desc) != descs->ndescs)) {
4244 __clear_bit(descs->ndescs, array_info->get_mask);
4245 __clear_bit(descs->ndescs, array_info->set_mask);
4246 } else if (array_info) {
4247 /* Exclude open drain or open source from fast output */
4248 if (gpiochip_line_is_open_drain(chip, descs->ndescs) ||
4249 gpiochip_line_is_open_source(chip, descs->ndescs))
4250 __clear_bit(descs->ndescs,
4251 array_info->set_mask);
4252 /* Identify 'fast' pins which require invertion */
4253 if (gpiod_is_active_low(desc))
4254 __set_bit(descs->ndescs,
4255 array_info->invert_mask);
4262 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4263 array_info->chip->label, array_info->size,
4264 *array_info->get_mask, *array_info->set_mask,
4265 *array_info->invert_mask);
4268 EXPORT_SYMBOL_GPL(gpiod_get_array);
4271 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4273 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4274 * @con_id: function within the GPIO consumer
4275 * @flags: optional GPIO initialization flags
4277 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4278 * assigned to the requested function it will return NULL.
4280 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4282 enum gpiod_flags flags)
4284 struct gpio_descs *descs;
4286 descs = gpiod_get_array(dev, con_id, flags);
4287 if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
4292 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4295 * gpiod_put - dispose of a GPIO descriptor
4296 * @desc: GPIO descriptor to dispose of
4298 * No descriptor can be used after gpiod_put() has been called on it.
4300 void gpiod_put(struct gpio_desc *desc)
4304 EXPORT_SYMBOL_GPL(gpiod_put);
4307 * gpiod_put_array - dispose of multiple GPIO descriptors
4308 * @descs: struct gpio_descs containing an array of descriptors
4310 void gpiod_put_array(struct gpio_descs *descs)
4314 for (i = 0; i < descs->ndescs; i++)
4315 gpiod_put(descs->desc[i]);
4319 EXPORT_SYMBOL_GPL(gpiod_put_array);
4321 static int __init gpiolib_dev_init(void)
4325 /* Register GPIO sysfs bus */
4326 ret = bus_register(&gpio_bus_type);
4328 pr_err("gpiolib: could not register GPIO bus type\n");
4332 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
4334 pr_err("gpiolib: failed to allocate char dev region\n");
4335 bus_unregister(&gpio_bus_type);
4337 gpiolib_initialized = true;
4338 gpiochip_setup_devs();
4342 core_initcall(gpiolib_dev_init);
4344 #ifdef CONFIG_DEBUG_FS
4346 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4349 struct gpio_chip *chip = gdev->chip;
4350 unsigned gpio = gdev->base;
4351 struct gpio_desc *gdesc = &gdev->descs[0];
4355 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4356 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4358 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4364 gpiod_get_direction(gdesc);
4365 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4366 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4367 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
4368 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4369 is_out ? "out" : "in ",
4370 chip->get ? (chip->get(chip, i) ? "hi" : "lo") : "? ",
4371 is_irq ? "IRQ" : " ");
4372 seq_printf(s, "\n");
4376 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4378 unsigned long flags;
4379 struct gpio_device *gdev = NULL;
4380 loff_t index = *pos;
4384 spin_lock_irqsave(&gpio_lock, flags);
4385 list_for_each_entry(gdev, &gpio_devices, list)
4387 spin_unlock_irqrestore(&gpio_lock, flags);
4390 spin_unlock_irqrestore(&gpio_lock, flags);
4395 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4397 unsigned long flags;
4398 struct gpio_device *gdev = v;
4401 spin_lock_irqsave(&gpio_lock, flags);
4402 if (list_is_last(&gdev->list, &gpio_devices))
4405 ret = list_entry(gdev->list.next, struct gpio_device, list);
4406 spin_unlock_irqrestore(&gpio_lock, flags);
4414 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4418 static int gpiolib_seq_show(struct seq_file *s, void *v)
4420 struct gpio_device *gdev = v;
4421 struct gpio_chip *chip = gdev->chip;
4422 struct device *parent;
4425 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4426 dev_name(&gdev->dev));
4430 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4431 dev_name(&gdev->dev),
4432 gdev->base, gdev->base + gdev->ngpio - 1);
4433 parent = chip->parent;
4435 seq_printf(s, ", parent: %s/%s",
4436 parent->bus ? parent->bus->name : "no-bus",
4439 seq_printf(s, ", %s", chip->label);
4440 if (chip->can_sleep)
4441 seq_printf(s, ", can sleep");
4442 seq_printf(s, ":\n");
4445 chip->dbg_show(s, chip);
4447 gpiolib_dbg_show(s, gdev);
4452 static const struct seq_operations gpiolib_seq_ops = {
4453 .start = gpiolib_seq_start,
4454 .next = gpiolib_seq_next,
4455 .stop = gpiolib_seq_stop,
4456 .show = gpiolib_seq_show,
4459 static int gpiolib_open(struct inode *inode, struct file *file)
4461 return seq_open(file, &gpiolib_seq_ops);
4464 static const struct file_operations gpiolib_operations = {
4465 .owner = THIS_MODULE,
4466 .open = gpiolib_open,
4468 .llseek = seq_lseek,
4469 .release = seq_release,
4472 static int __init gpiolib_debugfs_init(void)
4474 /* /sys/kernel/debug/gpio */
4475 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
4476 NULL, NULL, &gpiolib_operations);
4479 subsys_initcall(gpiolib_debugfs_init);
4481 #endif /* DEBUG_FS */