1 #include <linux/kernel.h>
2 #include <linux/module.h>
3 #include <linux/interrupt.h>
5 #include <linux/spinlock.h>
6 #include <linux/list.h>
7 #include <linux/device.h>
9 #include <linux/debugfs.h>
10 #include <linux/seq_file.h>
11 #include <linux/gpio.h>
12 #include <linux/of_gpio.h>
13 #include <linux/idr.h>
14 #include <linux/slab.h>
15 #include <linux/acpi.h>
16 #include <linux/gpio/driver.h>
17 #include <linux/gpio/machine.h>
18 #include <linux/pinctrl/consumer.h>
19 #include <linux/cdev.h>
21 #include <linux/uaccess.h>
22 #include <linux/compat.h>
23 #include <linux/anon_inodes.h>
24 #include <linux/kfifo.h>
25 #include <linux/poll.h>
26 #include <linux/timekeeping.h>
27 #include <uapi/linux/gpio.h>
31 #define CREATE_TRACE_POINTS
32 #include <trace/events/gpio.h>
34 /* Implementation infrastructure for GPIO interfaces.
36 * The GPIO programming interface allows for inlining speed-critical
37 * get/set operations for common cases, so that access to SOC-integrated
38 * GPIOs can sometimes cost only an instruction or two per bit.
42 /* When debugging, extend minimal trust to callers and platform code.
43 * Also emit diagnostic messages that may help initial bringup, when
44 * board setup or driver bugs are most common.
46 * Otherwise, minimize overhead in what may be bitbanging codepaths.
49 #define extra_checks 1
51 #define extra_checks 0
54 /* Device and char device-related information */
55 static DEFINE_IDA(gpio_ida);
56 static dev_t gpio_devt;
57 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
58 static struct bus_type gpio_bus_type = {
62 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
63 * While any GPIO is requested, its gpio_chip is not removable;
64 * each GPIO's "requested" flag serves as a lock and refcount.
66 DEFINE_SPINLOCK(gpio_lock);
68 static DEFINE_MUTEX(gpio_lookup_lock);
69 static LIST_HEAD(gpio_lookup_list);
70 LIST_HEAD(gpio_devices);
72 static void gpiochip_free_hogs(struct gpio_chip *chip);
73 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
74 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip);
75 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip);
77 static bool gpiolib_initialized;
79 static inline void desc_set_label(struct gpio_desc *d, const char *label)
85 * Convert a GPIO number to its descriptor
87 struct gpio_desc *gpio_to_desc(unsigned gpio)
89 struct gpio_device *gdev;
92 spin_lock_irqsave(&gpio_lock, flags);
94 list_for_each_entry(gdev, &gpio_devices, list) {
95 if (gdev->base <= gpio &&
96 gdev->base + gdev->ngpio > gpio) {
97 spin_unlock_irqrestore(&gpio_lock, flags);
98 return &gdev->descs[gpio - gdev->base];
102 spin_unlock_irqrestore(&gpio_lock, flags);
104 if (!gpio_is_valid(gpio))
105 WARN(1, "invalid GPIO %d\n", gpio);
109 EXPORT_SYMBOL_GPL(gpio_to_desc);
112 * Get the GPIO descriptor corresponding to the given hw number for this chip.
114 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
117 struct gpio_device *gdev = chip->gpiodev;
119 if (hwnum >= gdev->ngpio)
120 return ERR_PTR(-EINVAL);
122 return &gdev->descs[hwnum];
126 * Convert a GPIO descriptor to the integer namespace.
127 * This should disappear in the future but is needed since we still
128 * use GPIO numbers for error messages and sysfs nodes
130 int desc_to_gpio(const struct gpio_desc *desc)
132 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
134 EXPORT_SYMBOL_GPL(desc_to_gpio);
138 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
139 * @desc: descriptor to return the chip of
141 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
143 if (!desc || !desc->gdev || !desc->gdev->chip)
145 return desc->gdev->chip;
147 EXPORT_SYMBOL_GPL(gpiod_to_chip);
149 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
150 static int gpiochip_find_base(int ngpio)
152 struct gpio_device *gdev;
153 int base = ARCH_NR_GPIOS - ngpio;
155 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
156 /* found a free space? */
157 if (gdev->base + gdev->ngpio <= base)
160 /* nope, check the space right before the chip */
161 base = gdev->base - ngpio;
164 if (gpio_is_valid(base)) {
165 pr_debug("%s: found new base at %d\n", __func__, base);
168 pr_err("%s: cannot find free range\n", __func__);
174 * gpiod_get_direction - return the current direction of a GPIO
175 * @desc: GPIO to get the direction of
177 * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error.
179 * This function may sleep if gpiod_cansleep() is true.
181 int gpiod_get_direction(struct gpio_desc *desc)
183 struct gpio_chip *chip;
185 int status = -EINVAL;
187 chip = gpiod_to_chip(desc);
188 offset = gpio_chip_hwgpio(desc);
190 if (!chip->get_direction)
193 status = chip->get_direction(chip, offset);
195 /* GPIOF_DIR_IN, or other positive */
197 clear_bit(FLAG_IS_OUT, &desc->flags);
201 set_bit(FLAG_IS_OUT, &desc->flags);
205 EXPORT_SYMBOL_GPL(gpiod_get_direction);
208 * Add a new chip to the global chips list, keeping the list of chips sorted
209 * by range(means [base, base + ngpio - 1]) order.
211 * Return -EBUSY if the new chip overlaps with some other chip's integer
214 static int gpiodev_add_to_list(struct gpio_device *gdev)
216 struct gpio_device *prev, *next;
218 if (list_empty(&gpio_devices)) {
219 /* initial entry in list */
220 list_add_tail(&gdev->list, &gpio_devices);
224 next = list_entry(gpio_devices.next, struct gpio_device, list);
225 if (gdev->base + gdev->ngpio <= next->base) {
226 /* add before first entry */
227 list_add(&gdev->list, &gpio_devices);
231 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
232 if (prev->base + prev->ngpio <= gdev->base) {
233 /* add behind last entry */
234 list_add_tail(&gdev->list, &gpio_devices);
238 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
239 /* at the end of the list */
240 if (&next->list == &gpio_devices)
243 /* add between prev and next */
244 if (prev->base + prev->ngpio <= gdev->base
245 && gdev->base + gdev->ngpio <= next->base) {
246 list_add(&gdev->list, &prev->list);
251 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
256 * Convert a GPIO name to its descriptor
258 static struct gpio_desc *gpio_name_to_desc(const char * const name)
260 struct gpio_device *gdev;
263 spin_lock_irqsave(&gpio_lock, flags);
265 list_for_each_entry(gdev, &gpio_devices, list) {
268 for (i = 0; i != gdev->ngpio; ++i) {
269 struct gpio_desc *desc = &gdev->descs[i];
271 if (!desc->name || !name)
274 if (!strcmp(desc->name, name)) {
275 spin_unlock_irqrestore(&gpio_lock, flags);
281 spin_unlock_irqrestore(&gpio_lock, flags);
287 * Takes the names from gc->names and checks if they are all unique. If they
288 * are, they are assigned to their gpio descriptors.
290 * Warning if one of the names is already used for a different GPIO.
292 static int gpiochip_set_desc_names(struct gpio_chip *gc)
294 struct gpio_device *gdev = gc->gpiodev;
300 /* First check all names if they are unique */
301 for (i = 0; i != gc->ngpio; ++i) {
302 struct gpio_desc *gpio;
304 gpio = gpio_name_to_desc(gc->names[i]);
307 "Detected name collision for GPIO name '%s'\n",
311 /* Then add all names to the GPIO descriptors */
312 for (i = 0; i != gc->ngpio; ++i)
313 gdev->descs[i].name = gc->names[i];
319 * GPIO line handle management
323 * struct linehandle_state - contains the state of a userspace handle
324 * @gdev: the GPIO device the handle pertains to
325 * @label: consumer label used to tag descriptors
326 * @descs: the GPIO descriptors held by this handle
327 * @numdescs: the number of descriptors held in the descs array
329 struct linehandle_state {
330 struct gpio_device *gdev;
332 struct gpio_desc *descs[GPIOHANDLES_MAX];
336 static long linehandle_ioctl(struct file *filep, unsigned int cmd,
339 struct linehandle_state *lh = filep->private_data;
340 void __user *ip = (void __user *)arg;
341 struct gpiohandle_data ghd;
344 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
347 /* TODO: check if descriptors are really input */
348 for (i = 0; i < lh->numdescs; i++) {
349 val = gpiod_get_value_cansleep(lh->descs[i]);
355 if (copy_to_user(ip, &ghd, sizeof(ghd)))
359 } else if (cmd == GPIOHANDLE_SET_LINE_VALUES_IOCTL) {
360 int vals[GPIOHANDLES_MAX];
362 /* TODO: check if descriptors are really output */
363 if (copy_from_user(&ghd, ip, sizeof(ghd)))
366 /* Clamp all values to [0,1] */
367 for (i = 0; i < lh->numdescs; i++)
368 vals[i] = !!ghd.values[i];
370 /* Reuse the array setting function */
371 gpiod_set_array_value_complex(false,
382 static long linehandle_ioctl_compat(struct file *filep, unsigned int cmd,
385 return linehandle_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
389 static int linehandle_release(struct inode *inode, struct file *filep)
391 struct linehandle_state *lh = filep->private_data;
392 struct gpio_device *gdev = lh->gdev;
395 for (i = 0; i < lh->numdescs; i++)
396 gpiod_free(lh->descs[i]);
399 put_device(&gdev->dev);
403 static const struct file_operations linehandle_fileops = {
404 .release = linehandle_release,
405 .owner = THIS_MODULE,
406 .llseek = noop_llseek,
407 .unlocked_ioctl = linehandle_ioctl,
409 .compat_ioctl = linehandle_ioctl_compat,
413 static int linehandle_create(struct gpio_device *gdev, void __user *ip)
415 struct gpiohandle_request handlereq;
416 struct linehandle_state *lh;
419 if (copy_from_user(&handlereq, ip, sizeof(handlereq)))
421 if ((handlereq.lines == 0) || (handlereq.lines > GPIOHANDLES_MAX))
424 lh = kzalloc(sizeof(*lh), GFP_KERNEL);
428 get_device(&gdev->dev);
430 /* Make sure this is terminated */
431 handlereq.consumer_label[sizeof(handlereq.consumer_label)-1] = '\0';
432 if (strlen(handlereq.consumer_label)) {
433 lh->label = kstrdup(handlereq.consumer_label,
441 /* Request each GPIO */
442 for (i = 0; i < handlereq.lines; i++) {
443 u32 offset = handlereq.lineoffsets[i];
444 u32 lflags = handlereq.flags;
445 struct gpio_desc *desc;
447 desc = &gdev->descs[offset];
448 ret = gpiod_request(desc, lh->label);
453 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
454 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
455 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
456 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
457 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
458 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
461 * Lines have to be requested explicitly for input
462 * or output, else the line will be treated "as is".
464 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
465 int val = !!handlereq.default_values[i];
467 ret = gpiod_direction_output(desc, val);
470 } else if (lflags & GPIOHANDLE_REQUEST_INPUT) {
471 ret = gpiod_direction_input(desc);
475 dev_dbg(&gdev->dev, "registered chardev handle for line %d\n",
478 /* Let i point at the last handle */
480 lh->numdescs = handlereq.lines;
482 fd = anon_inode_getfd("gpio-linehandle",
485 O_RDONLY | O_CLOEXEC);
492 if (copy_to_user(ip, &handlereq, sizeof(handlereq))) {
497 dev_dbg(&gdev->dev, "registered chardev handle for %d lines\n",
504 gpiod_free(lh->descs[i]);
508 put_device(&gdev->dev);
513 * GPIO line event management
517 * struct lineevent_state - contains the state of a userspace event
518 * @gdev: the GPIO device the event pertains to
519 * @label: consumer label used to tag descriptors
520 * @desc: the GPIO descriptor held by this event
521 * @eflags: the event flags this line was requested with
522 * @irq: the interrupt that trigger in response to events on this GPIO
523 * @wait: wait queue that handles blocking reads of events
524 * @events: KFIFO for the GPIO events
525 * @read_lock: mutex lock to protect reads from colliding with adding
526 * new events to the FIFO
528 struct lineevent_state {
529 struct gpio_device *gdev;
531 struct gpio_desc *desc;
534 wait_queue_head_t wait;
535 DECLARE_KFIFO(events, struct gpioevent_data, 16);
536 struct mutex read_lock;
539 static unsigned int lineevent_poll(struct file *filep,
540 struct poll_table_struct *wait)
542 struct lineevent_state *le = filep->private_data;
543 unsigned int events = 0;
545 poll_wait(filep, &le->wait, wait);
547 if (!kfifo_is_empty(&le->events))
548 events = POLLIN | POLLRDNORM;
554 static ssize_t lineevent_read(struct file *filep,
559 struct lineevent_state *le = filep->private_data;
563 if (count < sizeof(struct gpioevent_data))
567 if (kfifo_is_empty(&le->events)) {
568 if (filep->f_flags & O_NONBLOCK)
571 ret = wait_event_interruptible(le->wait,
572 !kfifo_is_empty(&le->events));
577 if (mutex_lock_interruptible(&le->read_lock))
579 ret = kfifo_to_user(&le->events, buf, count, &copied);
580 mutex_unlock(&le->read_lock);
586 * If we couldn't read anything from the fifo (a different
587 * thread might have been faster) we either return -EAGAIN if
588 * the file descriptor is non-blocking, otherwise we go back to
589 * sleep and wait for more data to arrive.
591 if (copied == 0 && (filep->f_flags & O_NONBLOCK))
594 } while (copied == 0);
599 static int lineevent_release(struct inode *inode, struct file *filep)
601 struct lineevent_state *le = filep->private_data;
602 struct gpio_device *gdev = le->gdev;
604 free_irq(le->irq, le);
605 gpiod_free(le->desc);
608 put_device(&gdev->dev);
612 static long lineevent_ioctl(struct file *filep, unsigned int cmd,
615 struct lineevent_state *le = filep->private_data;
616 void __user *ip = (void __user *)arg;
617 struct gpiohandle_data ghd;
620 * We can get the value for an event line but not set it,
621 * because it is input by definition.
623 if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
626 val = gpiod_get_value_cansleep(le->desc);
631 if (copy_to_user(ip, &ghd, sizeof(ghd)))
640 static long lineevent_ioctl_compat(struct file *filep, unsigned int cmd,
643 return lineevent_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
647 static const struct file_operations lineevent_fileops = {
648 .release = lineevent_release,
649 .read = lineevent_read,
650 .poll = lineevent_poll,
651 .owner = THIS_MODULE,
652 .llseek = noop_llseek,
653 .unlocked_ioctl = lineevent_ioctl,
655 .compat_ioctl = lineevent_ioctl_compat,
659 static irqreturn_t lineevent_irq_thread(int irq, void *p)
661 struct lineevent_state *le = p;
662 struct gpioevent_data ge;
665 ge.timestamp = ktime_get_real_ns();
667 if (le->eflags & GPIOEVENT_REQUEST_BOTH_EDGES) {
668 int level = gpiod_get_value_cansleep(le->desc);
671 /* Emit low-to-high event */
672 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
674 /* Emit high-to-low event */
675 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
676 } else if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE) {
677 /* Emit low-to-high event */
678 ge.id = GPIOEVENT_EVENT_RISING_EDGE;
679 } else if (le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
680 /* Emit high-to-low event */
681 ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
686 ret = kfifo_put(&le->events, ge);
688 wake_up_poll(&le->wait, POLLIN);
693 static int lineevent_create(struct gpio_device *gdev, void __user *ip)
695 struct gpioevent_request eventreq;
696 struct lineevent_state *le;
697 struct gpio_desc *desc;
705 if (copy_from_user(&eventreq, ip, sizeof(eventreq)))
708 le = kzalloc(sizeof(*le), GFP_KERNEL);
712 get_device(&gdev->dev);
714 /* Make sure this is terminated */
715 eventreq.consumer_label[sizeof(eventreq.consumer_label)-1] = '\0';
716 if (strlen(eventreq.consumer_label)) {
717 le->label = kstrdup(eventreq.consumer_label,
725 offset = eventreq.lineoffset;
726 lflags = eventreq.handleflags;
727 eflags = eventreq.eventflags;
729 /* This is just wrong: we don't look for events on output lines */
730 if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
735 desc = &gdev->descs[offset];
736 ret = gpiod_request(desc, le->label);
742 if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
743 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
744 if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
745 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
746 if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
747 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
749 ret = gpiod_direction_input(desc);
753 le->irq = gpiod_to_irq(desc);
759 if (eflags & GPIOEVENT_REQUEST_RISING_EDGE)
760 irqflags |= IRQF_TRIGGER_RISING;
761 if (eflags & GPIOEVENT_REQUEST_FALLING_EDGE)
762 irqflags |= IRQF_TRIGGER_FALLING;
763 irqflags |= IRQF_ONESHOT;
764 irqflags |= IRQF_SHARED;
766 INIT_KFIFO(le->events);
767 init_waitqueue_head(&le->wait);
768 mutex_init(&le->read_lock);
770 /* Request a thread to read the events */
771 ret = request_threaded_irq(le->irq,
773 lineevent_irq_thread,
780 fd = anon_inode_getfd("gpio-event",
783 O_RDONLY | O_CLOEXEC);
790 if (copy_to_user(ip, &eventreq, sizeof(eventreq))) {
798 free_irq(le->irq, le);
800 gpiod_free(le->desc);
805 put_device(&gdev->dev);
810 * gpio_ioctl() - ioctl handler for the GPIO chardev
812 static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
814 struct gpio_device *gdev = filp->private_data;
815 struct gpio_chip *chip = gdev->chip;
816 void __user *ip = (void __user *)arg;
818 /* We fail any subsequent ioctl():s when the chip is gone */
822 /* Fill in the struct and pass to userspace */
823 if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
824 struct gpiochip_info chipinfo;
826 memset(&chipinfo, 0, sizeof(chipinfo));
828 strncpy(chipinfo.name, dev_name(&gdev->dev),
829 sizeof(chipinfo.name));
830 chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
831 strncpy(chipinfo.label, gdev->label,
832 sizeof(chipinfo.label));
833 chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
834 chipinfo.lines = gdev->ngpio;
835 if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
838 } else if (cmd == GPIO_GET_LINEINFO_IOCTL) {
839 struct gpioline_info lineinfo;
840 struct gpio_desc *desc;
842 if (copy_from_user(&lineinfo, ip, sizeof(lineinfo)))
844 if (lineinfo.line_offset >= gdev->ngpio)
847 desc = &gdev->descs[lineinfo.line_offset];
849 strncpy(lineinfo.name, desc->name,
850 sizeof(lineinfo.name));
851 lineinfo.name[sizeof(lineinfo.name)-1] = '\0';
853 lineinfo.name[0] = '\0';
856 strncpy(lineinfo.consumer, desc->label,
857 sizeof(lineinfo.consumer));
858 lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
860 lineinfo.consumer[0] = '\0';
864 * Userspace only need to know that the kernel is using
865 * this GPIO so it can't use it.
868 if (test_bit(FLAG_REQUESTED, &desc->flags) ||
869 test_bit(FLAG_IS_HOGGED, &desc->flags) ||
870 test_bit(FLAG_USED_AS_IRQ, &desc->flags) ||
871 test_bit(FLAG_EXPORT, &desc->flags) ||
872 test_bit(FLAG_SYSFS, &desc->flags))
873 lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
874 if (test_bit(FLAG_IS_OUT, &desc->flags))
875 lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
876 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
877 lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
878 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
879 lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
880 if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
881 lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;
883 if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
886 } else if (cmd == GPIO_GET_LINEHANDLE_IOCTL) {
887 return linehandle_create(gdev, ip);
888 } else if (cmd == GPIO_GET_LINEEVENT_IOCTL) {
889 return lineevent_create(gdev, ip);
895 static long gpio_ioctl_compat(struct file *filp, unsigned int cmd,
898 return gpio_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
903 * gpio_chrdev_open() - open the chardev for ioctl operations
904 * @inode: inode for this chardev
905 * @filp: file struct for storing private data
906 * Returns 0 on success
908 static int gpio_chrdev_open(struct inode *inode, struct file *filp)
910 struct gpio_device *gdev = container_of(inode->i_cdev,
911 struct gpio_device, chrdev);
913 /* Fail on open if the backing gpiochip is gone */
914 if (!gdev || !gdev->chip)
916 get_device(&gdev->dev);
917 filp->private_data = gdev;
922 * gpio_chrdev_release() - close chardev after ioctl operations
923 * @inode: inode for this chardev
924 * @filp: file struct for storing private data
925 * Returns 0 on success
927 static int gpio_chrdev_release(struct inode *inode, struct file *filp)
929 struct gpio_device *gdev = container_of(inode->i_cdev,
930 struct gpio_device, chrdev);
934 put_device(&gdev->dev);
939 static const struct file_operations gpio_fileops = {
940 .release = gpio_chrdev_release,
941 .open = gpio_chrdev_open,
942 .owner = THIS_MODULE,
943 .llseek = noop_llseek,
944 .unlocked_ioctl = gpio_ioctl,
946 .compat_ioctl = gpio_ioctl_compat,
950 static void gpiodevice_release(struct device *dev)
952 struct gpio_device *gdev = dev_get_drvdata(dev);
954 list_del(&gdev->list);
955 ida_simple_remove(&gpio_ida, gdev->id);
961 static int gpiochip_setup_dev(struct gpio_device *gdev)
965 cdev_init(&gdev->chrdev, &gpio_fileops);
966 gdev->chrdev.owner = THIS_MODULE;
967 gdev->chrdev.kobj.parent = &gdev->dev.kobj;
968 gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id);
969 status = cdev_add(&gdev->chrdev, gdev->dev.devt, 1);
971 chip_warn(gdev->chip, "failed to add char device %d:%d\n",
972 MAJOR(gpio_devt), gdev->id);
974 chip_dbg(gdev->chip, "added GPIO chardev (%d:%d)\n",
975 MAJOR(gpio_devt), gdev->id);
976 status = device_add(&gdev->dev);
978 goto err_remove_chardev;
980 status = gpiochip_sysfs_register(gdev);
982 goto err_remove_device;
984 /* From this point, the .release() function cleans up gpio_device */
985 gdev->dev.release = gpiodevice_release;
986 pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n",
987 __func__, gdev->base, gdev->base + gdev->ngpio - 1,
988 dev_name(&gdev->dev), gdev->chip->label ? : "generic");
993 device_del(&gdev->dev);
995 cdev_del(&gdev->chrdev);
999 static void gpiochip_setup_devs(void)
1001 struct gpio_device *gdev;
1004 list_for_each_entry(gdev, &gpio_devices, list) {
1005 err = gpiochip_setup_dev(gdev);
1007 pr_err("%s: Failed to initialize gpio device (%d)\n",
1008 dev_name(&gdev->dev), err);
1013 * gpiochip_add_data() - register a gpio_chip
1014 * @chip: the chip to register, with chip->base initialized
1015 * Context: potentially before irqs will work
1017 * Returns a negative errno if the chip can't be registered, such as
1018 * because the chip->base is invalid or already associated with a
1019 * different chip. Otherwise it returns zero as a success code.
1021 * When gpiochip_add_data() is called very early during boot, so that GPIOs
1022 * can be freely used, the chip->parent device must be registered before
1023 * the gpio framework's arch_initcall(). Otherwise sysfs initialization
1024 * for GPIOs will fail rudely.
1026 * gpiochip_add_data() must only be called after gpiolib initialization,
1027 * ie after core_initcall().
1029 * If chip->base is negative, this requests dynamic assignment of
1030 * a range of valid GPIOs.
1032 int gpiochip_add_data(struct gpio_chip *chip, void *data)
1034 unsigned long flags;
1037 int base = chip->base;
1038 struct gpio_device *gdev;
1041 * First: allocate and populate the internal stat container, and
1042 * set up the struct device.
1044 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
1047 gdev->dev.bus = &gpio_bus_type;
1049 chip->gpiodev = gdev;
1051 gdev->dev.parent = chip->parent;
1052 gdev->dev.of_node = chip->parent->of_node;
1055 #ifdef CONFIG_OF_GPIO
1056 /* If the gpiochip has an assigned OF node this takes precedence */
1058 gdev->dev.of_node = chip->of_node;
1061 gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
1066 dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
1067 device_initialize(&gdev->dev);
1068 dev_set_drvdata(&gdev->dev, gdev);
1069 if (chip->parent && chip->parent->driver)
1070 gdev->owner = chip->parent->driver->owner;
1071 else if (chip->owner)
1072 /* TODO: remove chip->owner */
1073 gdev->owner = chip->owner;
1075 gdev->owner = THIS_MODULE;
1077 gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
1083 if (chip->ngpio == 0) {
1084 chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
1086 goto err_free_descs;
1090 gdev->label = kstrdup(chip->label, GFP_KERNEL);
1092 gdev->label = kstrdup("unknown", GFP_KERNEL);
1095 goto err_free_descs;
1098 gdev->ngpio = chip->ngpio;
1101 spin_lock_irqsave(&gpio_lock, flags);
1104 * TODO: this allocates a Linux GPIO number base in the global
1105 * GPIO numberspace for this chip. In the long run we want to
1106 * get *rid* of this numberspace and use only descriptors, but
1107 * it may be a pipe dream. It will not happen before we get rid
1108 * of the sysfs interface anyways.
1111 base = gpiochip_find_base(chip->ngpio);
1114 spin_unlock_irqrestore(&gpio_lock, flags);
1115 goto err_free_label;
1118 * TODO: it should not be necessary to reflect the assigned
1119 * base outside of the GPIO subsystem. Go over drivers and
1120 * see if anyone makes use of this, else drop this and assign
1127 status = gpiodev_add_to_list(gdev);
1129 spin_unlock_irqrestore(&gpio_lock, flags);
1130 goto err_free_label;
1133 spin_unlock_irqrestore(&gpio_lock, flags);
1135 for (i = 0; i < chip->ngpio; i++) {
1136 struct gpio_desc *desc = &gdev->descs[i];
1140 * REVISIT: most hardware initializes GPIOs as inputs
1141 * (often with pullups enabled) so power usage is
1142 * minimized. Linux code should set the gpio direction
1143 * first thing; but until it does, and in case
1144 * chip->get_direction is not set, we may expose the
1145 * wrong direction in sysfs.
1148 if (chip->get_direction) {
1150 * If we have .get_direction, set up the initial
1151 * direction flag from the hardware.
1153 int dir = chip->get_direction(chip, i);
1156 set_bit(FLAG_IS_OUT, &desc->flags);
1157 } else if (!chip->direction_input) {
1159 * If the chip lacks the .direction_input callback
1160 * we logically assume all lines are outputs.
1162 set_bit(FLAG_IS_OUT, &desc->flags);
1166 #ifdef CONFIG_PINCTRL
1167 INIT_LIST_HEAD(&gdev->pin_ranges);
1170 status = gpiochip_set_desc_names(chip);
1172 goto err_remove_from_list;
1174 status = gpiochip_irqchip_init_valid_mask(chip);
1176 goto err_remove_from_list;
1178 status = of_gpiochip_add(chip);
1180 goto err_remove_chip;
1182 acpi_gpiochip_add(chip);
1185 * By first adding the chardev, and then adding the device,
1186 * we get a device node entry in sysfs under
1187 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
1188 * coldplug of device nodes and other udev business.
1189 * We can do this only if gpiolib has been initialized.
1190 * Otherwise, defer until later.
1192 if (gpiolib_initialized) {
1193 status = gpiochip_setup_dev(gdev);
1195 goto err_remove_chip;
1200 acpi_gpiochip_remove(chip);
1201 gpiochip_free_hogs(chip);
1202 of_gpiochip_remove(chip);
1203 gpiochip_irqchip_free_valid_mask(chip);
1204 err_remove_from_list:
1205 spin_lock_irqsave(&gpio_lock, flags);
1206 list_del(&gdev->list);
1207 spin_unlock_irqrestore(&gpio_lock, flags);
1213 ida_simple_remove(&gpio_ida, gdev->id);
1214 /* failures here can mean systems won't boot... */
1215 pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
1216 gdev->base, gdev->base + gdev->ngpio - 1,
1217 chip->label ? : "generic");
1221 EXPORT_SYMBOL_GPL(gpiochip_add_data);
1224 * gpiochip_get_data() - get per-subdriver data for the chip
1226 void *gpiochip_get_data(struct gpio_chip *chip)
1228 return chip->gpiodev->data;
1230 EXPORT_SYMBOL_GPL(gpiochip_get_data);
1233 * gpiochip_remove() - unregister a gpio_chip
1234 * @chip: the chip to unregister
1236 * A gpio_chip with any GPIOs still requested may not be removed.
1238 void gpiochip_remove(struct gpio_chip *chip)
1240 struct gpio_device *gdev = chip->gpiodev;
1241 struct gpio_desc *desc;
1242 unsigned long flags;
1244 bool requested = false;
1246 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1247 gpiochip_sysfs_unregister(gdev);
1248 /* Numb the device, cancelling all outstanding operations */
1250 gpiochip_irqchip_remove(chip);
1251 acpi_gpiochip_remove(chip);
1252 gpiochip_remove_pin_ranges(chip);
1253 gpiochip_free_hogs(chip);
1254 of_gpiochip_remove(chip);
1256 * We accept no more calls into the driver from this point, so
1257 * NULL the driver data pointer
1261 spin_lock_irqsave(&gpio_lock, flags);
1262 for (i = 0; i < gdev->ngpio; i++) {
1263 desc = &gdev->descs[i];
1264 if (test_bit(FLAG_REQUESTED, &desc->flags))
1267 spin_unlock_irqrestore(&gpio_lock, flags);
1270 dev_crit(&gdev->dev,
1271 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
1274 * The gpiochip side puts its use of the device to rest here:
1275 * if there are no userspace clients, the chardev and device will
1276 * be removed, else it will be dangling until the last user is
1279 cdev_del(&gdev->chrdev);
1280 device_del(&gdev->dev);
1281 put_device(&gdev->dev);
1283 EXPORT_SYMBOL_GPL(gpiochip_remove);
1285 static void devm_gpio_chip_release(struct device *dev, void *res)
1287 struct gpio_chip *chip = *(struct gpio_chip **)res;
1289 gpiochip_remove(chip);
1292 static int devm_gpio_chip_match(struct device *dev, void *res, void *data)
1295 struct gpio_chip **r = res;
1306 * devm_gpiochip_add_data() - Resource manager piochip_add_data()
1307 * @dev: the device pointer on which irq_chip belongs to.
1308 * @chip: the chip to register, with chip->base initialized
1309 * Context: potentially before irqs will work
1311 * Returns a negative errno if the chip can't be registered, such as
1312 * because the chip->base is invalid or already associated with a
1313 * different chip. Otherwise it returns zero as a success code.
1315 * The gpio chip automatically be released when the device is unbound.
1317 int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
1320 struct gpio_chip **ptr;
1323 ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
1328 ret = gpiochip_add_data(chip, data);
1335 devres_add(dev, ptr);
1339 EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);
1342 * devm_gpiochip_remove() - Resource manager of gpiochip_remove()
1343 * @dev: device for which which resource was allocated
1344 * @chip: the chip to remove
1346 * A gpio_chip with any GPIOs still requested may not be removed.
1348 void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip)
1352 ret = devres_release(dev, devm_gpio_chip_release,
1353 devm_gpio_chip_match, chip);
1357 EXPORT_SYMBOL_GPL(devm_gpiochip_remove);
1360 * gpiochip_find() - iterator for locating a specific gpio_chip
1361 * @data: data to pass to match function
1362 * @callback: Callback function to check gpio_chip
1364 * Similar to bus_find_device. It returns a reference to a gpio_chip as
1365 * determined by a user supplied @match callback. The callback should return
1366 * 0 if the device doesn't match and non-zero if it does. If the callback is
1367 * non-zero, this function will return to the caller and not iterate over any
1370 struct gpio_chip *gpiochip_find(void *data,
1371 int (*match)(struct gpio_chip *chip,
1374 struct gpio_device *gdev;
1375 struct gpio_chip *chip = NULL;
1376 unsigned long flags;
1378 spin_lock_irqsave(&gpio_lock, flags);
1379 list_for_each_entry(gdev, &gpio_devices, list)
1380 if (gdev->chip && match(gdev->chip, data)) {
1385 spin_unlock_irqrestore(&gpio_lock, flags);
1389 EXPORT_SYMBOL_GPL(gpiochip_find);
1391 static int gpiochip_match_name(struct gpio_chip *chip, void *data)
1393 const char *name = data;
1395 return !strcmp(chip->label, name);
1398 static struct gpio_chip *find_chip_by_name(const char *name)
1400 return gpiochip_find((void *)name, gpiochip_match_name);
1403 #ifdef CONFIG_GPIOLIB_IRQCHIP
1406 * The following is irqchip helper code for gpiochips.
1409 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1413 if (!gpiochip->irq_need_valid_mask)
1416 gpiochip->irq_valid_mask = kcalloc(BITS_TO_LONGS(gpiochip->ngpio),
1417 sizeof(long), GFP_KERNEL);
1418 if (!gpiochip->irq_valid_mask)
1421 /* Assume by default all GPIOs are valid */
1422 for (i = 0; i < gpiochip->ngpio; i++)
1423 set_bit(i, gpiochip->irq_valid_mask);
1428 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1430 kfree(gpiochip->irq_valid_mask);
1431 gpiochip->irq_valid_mask = NULL;
1434 static bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gpiochip,
1435 unsigned int offset)
1437 /* No mask means all valid */
1438 if (likely(!gpiochip->irq_valid_mask))
1440 return test_bit(offset, gpiochip->irq_valid_mask);
1444 * gpiochip_set_chained_irqchip() - sets a chained irqchip to a gpiochip
1445 * @gpiochip: the gpiochip to set the irqchip chain to
1446 * @irqchip: the irqchip to chain to the gpiochip
1447 * @parent_irq: the irq number corresponding to the parent IRQ for this
1449 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1450 * coming out of the gpiochip. If the interrupt is nested rather than
1451 * cascaded, pass NULL in this handler argument
1453 void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
1454 struct irq_chip *irqchip,
1456 irq_flow_handler_t parent_handler)
1458 unsigned int offset;
1460 if (!gpiochip->irqdomain) {
1461 chip_err(gpiochip, "called %s before setting up irqchip\n",
1466 if (parent_handler) {
1467 if (gpiochip->can_sleep) {
1469 "you cannot have chained interrupts on a "
1470 "chip that may sleep\n");
1474 * The parent irqchip is already using the chip_data for this
1475 * irqchip, so our callbacks simply use the handler_data.
1477 irq_set_chained_handler_and_data(parent_irq, parent_handler,
1480 gpiochip->irq_parent = parent_irq;
1483 /* Set the parent IRQ for all affected IRQs */
1484 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1485 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1487 irq_set_parent(irq_find_mapping(gpiochip->irqdomain, offset),
1491 EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
1494 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1495 * @d: the irqdomain used by this irqchip
1496 * @irq: the global irq number used by this GPIO irqchip irq
1497 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1499 * This function will set up the mapping for a certain IRQ line on a
1500 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1501 * stored inside the gpiochip.
1503 static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1504 irq_hw_number_t hwirq)
1506 struct gpio_chip *chip = d->host_data;
1508 irq_set_chip_data(irq, chip);
1510 * This lock class tells lockdep that GPIO irqs are in a different
1511 * category than their parents, so it won't report false recursion.
1513 irq_set_lockdep_class(irq, chip->lock_key);
1514 irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
1515 /* Chips that can sleep need nested thread handlers */
1516 if (chip->can_sleep && !chip->irq_not_threaded)
1517 irq_set_nested_thread(irq, 1);
1518 irq_set_noprobe(irq);
1521 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1522 * is passed as default type.
1524 if (chip->irq_default_type != IRQ_TYPE_NONE)
1525 irq_set_irq_type(irq, chip->irq_default_type);
1530 static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1532 struct gpio_chip *chip = d->host_data;
1534 if (chip->can_sleep)
1535 irq_set_nested_thread(irq, 0);
1536 irq_set_chip_and_handler(irq, NULL, NULL);
1537 irq_set_chip_data(irq, NULL);
1540 static const struct irq_domain_ops gpiochip_domain_ops = {
1541 .map = gpiochip_irq_map,
1542 .unmap = gpiochip_irq_unmap,
1543 /* Virtually all GPIO irqchips are twocell:ed */
1544 .xlate = irq_domain_xlate_twocell,
1547 static int gpiochip_irq_reqres(struct irq_data *d)
1549 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1551 if (!try_module_get(chip->gpiodev->owner))
1554 if (gpiochip_lock_as_irq(chip, d->hwirq)) {
1556 "unable to lock HW IRQ %lu for IRQ\n",
1558 module_put(chip->gpiodev->owner);
1564 static void gpiochip_irq_relres(struct irq_data *d)
1566 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1568 gpiochip_unlock_as_irq(chip, d->hwirq);
1569 module_put(chip->gpiodev->owner);
1572 static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
1574 return irq_find_mapping(chip->irqdomain, offset);
1578 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1579 * @gpiochip: the gpiochip to remove the irqchip from
1581 * This is called only from gpiochip_remove()
1583 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
1585 unsigned int offset;
1587 acpi_gpiochip_free_interrupts(gpiochip);
1589 if (gpiochip->irq_parent) {
1590 irq_set_chained_handler(gpiochip->irq_parent, NULL);
1591 irq_set_handler_data(gpiochip->irq_parent, NULL);
1594 /* Remove all IRQ mappings and delete the domain */
1595 if (gpiochip->irqdomain) {
1596 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1597 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1599 irq_dispose_mapping(
1600 irq_find_mapping(gpiochip->irqdomain, offset));
1602 irq_domain_remove(gpiochip->irqdomain);
1605 if (gpiochip->irqchip) {
1606 gpiochip->irqchip->irq_request_resources = NULL;
1607 gpiochip->irqchip->irq_release_resources = NULL;
1608 gpiochip->irqchip = NULL;
1611 gpiochip_irqchip_free_valid_mask(gpiochip);
1615 * gpiochip_irqchip_add() - adds an irqchip to a gpiochip
1616 * @gpiochip: the gpiochip to add the irqchip to
1617 * @irqchip: the irqchip to add to the gpiochip
1618 * @first_irq: if not dynamically assigned, the base (first) IRQ to
1619 * allocate gpiochip irqs from
1620 * @handler: the irq handler to use (often a predefined irq core function)
1621 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
1622 * to have the core avoid setting up any default type in the hardware.
1623 * @lock_key: lockdep class
1625 * This function closely associates a certain irqchip with a certain
1626 * gpiochip, providing an irq domain to translate the local IRQs to
1627 * global irqs in the gpiolib core, and making sure that the gpiochip
1628 * is passed as chip data to all related functions. Driver callbacks
1629 * need to use gpiochip_get_data() to get their local state containers back
1630 * from the gpiochip passed as chip data. An irqdomain will be stored
1631 * in the gpiochip that shall be used by the driver to handle IRQ number
1632 * translation. The gpiochip will need to be initialized and registered
1633 * before calling this function.
1635 * This function will handle two cell:ed simple IRQs and assumes all
1636 * the pins on the gpiochip can generate a unique IRQ. Everything else
1637 * need to be open coded.
1639 int _gpiochip_irqchip_add(struct gpio_chip *gpiochip,
1640 struct irq_chip *irqchip,
1641 unsigned int first_irq,
1642 irq_flow_handler_t handler,
1644 struct lock_class_key *lock_key)
1646 struct device_node *of_node;
1647 bool irq_base_set = false;
1648 unsigned int offset;
1649 unsigned irq_base = 0;
1651 if (!gpiochip || !irqchip)
1654 if (!gpiochip->parent) {
1655 pr_err("missing gpiochip .dev parent pointer\n");
1658 of_node = gpiochip->parent->of_node;
1659 #ifdef CONFIG_OF_GPIO
1661 * If the gpiochip has an assigned OF node this takes precedence
1662 * FIXME: get rid of this and use gpiochip->parent->of_node
1665 if (gpiochip->of_node)
1666 of_node = gpiochip->of_node;
1669 * Specifying a default trigger is a terrible idea if DT or ACPI is
1670 * used to configure the interrupts, as you may end-up with
1671 * conflicting triggers. Tell the user, and reset to NONE.
1673 if (WARN(of_node && type != IRQ_TYPE_NONE,
1674 "%s: Ignoring %d default trigger\n", of_node->full_name, type))
1675 type = IRQ_TYPE_NONE;
1676 if (has_acpi_companion(gpiochip->parent) && type != IRQ_TYPE_NONE) {
1677 acpi_handle_warn(ACPI_HANDLE(gpiochip->parent),
1678 "Ignoring %d default trigger\n", type);
1679 type = IRQ_TYPE_NONE;
1682 gpiochip->irqchip = irqchip;
1683 gpiochip->irq_handler = handler;
1684 gpiochip->irq_default_type = type;
1685 gpiochip->to_irq = gpiochip_to_irq;
1686 gpiochip->lock_key = lock_key;
1687 gpiochip->irqdomain = irq_domain_add_simple(of_node,
1688 gpiochip->ngpio, first_irq,
1689 &gpiochip_domain_ops, gpiochip);
1690 if (!gpiochip->irqdomain) {
1691 gpiochip->irqchip = NULL;
1696 * It is possible for a driver to override this, but only if the
1697 * alternative functions are both implemented.
1699 if (!irqchip->irq_request_resources &&
1700 !irqchip->irq_release_resources) {
1701 irqchip->irq_request_resources = gpiochip_irq_reqres;
1702 irqchip->irq_release_resources = gpiochip_irq_relres;
1706 * Prepare the mapping since the irqchip shall be orthogonal to
1707 * any gpiochip calls. If the first_irq was zero, this is
1708 * necessary to allocate descriptors for all IRQs.
1710 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1711 if (!gpiochip_irqchip_irq_valid(gpiochip, offset))
1713 irq_base = irq_create_mapping(gpiochip->irqdomain, offset);
1714 if (!irq_base_set) {
1716 * Store the base into the gpiochip to be used when
1717 * unmapping the irqs.
1719 gpiochip->irq_base = irq_base;
1720 irq_base_set = true;
1724 acpi_gpiochip_request_interrupts(gpiochip);
1728 EXPORT_SYMBOL_GPL(_gpiochip_irqchip_add);
1730 #else /* CONFIG_GPIOLIB_IRQCHIP */
1732 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
1733 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip)
1737 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip)
1740 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1743 * gpiochip_generic_request() - request the gpio function for a pin
1744 * @chip: the gpiochip owning the GPIO
1745 * @offset: the offset of the GPIO to request for GPIO function
1747 int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
1749 return pinctrl_request_gpio(chip->gpiodev->base + offset);
1751 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1754 * gpiochip_generic_free() - free the gpio function from a pin
1755 * @chip: the gpiochip to request the gpio function for
1756 * @offset: the offset of the GPIO to free from GPIO function
1758 void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
1760 pinctrl_free_gpio(chip->gpiodev->base + offset);
1762 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1764 #ifdef CONFIG_PINCTRL
1767 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1768 * @chip: the gpiochip to add the range for
1769 * @pctldev: the pin controller to map to
1770 * @gpio_offset: the start offset in the current gpio_chip number space
1771 * @pin_group: name of the pin group inside the pin controller
1773 int gpiochip_add_pingroup_range(struct gpio_chip *chip,
1774 struct pinctrl_dev *pctldev,
1775 unsigned int gpio_offset, const char *pin_group)
1777 struct gpio_pin_range *pin_range;
1778 struct gpio_device *gdev = chip->gpiodev;
1781 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1783 chip_err(chip, "failed to allocate pin ranges\n");
1787 /* Use local offset as range ID */
1788 pin_range->range.id = gpio_offset;
1789 pin_range->range.gc = chip;
1790 pin_range->range.name = chip->label;
1791 pin_range->range.base = gdev->base + gpio_offset;
1792 pin_range->pctldev = pctldev;
1794 ret = pinctrl_get_group_pins(pctldev, pin_group,
1795 &pin_range->range.pins,
1796 &pin_range->range.npins);
1802 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1804 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1805 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1806 pinctrl_dev_get_devname(pctldev), pin_group);
1808 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1812 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1815 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1816 * @chip: the gpiochip to add the range for
1817 * @pinctrl_name: the dev_name() of the pin controller to map to
1818 * @gpio_offset: the start offset in the current gpio_chip number space
1819 * @pin_offset: the start offset in the pin controller number space
1820 * @npins: the number of pins from the offset of each pin space (GPIO and
1821 * pin controller) to accumulate in this range
1823 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
1824 unsigned int gpio_offset, unsigned int pin_offset,
1827 struct gpio_pin_range *pin_range;
1828 struct gpio_device *gdev = chip->gpiodev;
1831 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1833 chip_err(chip, "failed to allocate pin ranges\n");
1837 /* Use local offset as range ID */
1838 pin_range->range.id = gpio_offset;
1839 pin_range->range.gc = chip;
1840 pin_range->range.name = chip->label;
1841 pin_range->range.base = gdev->base + gpio_offset;
1842 pin_range->range.pin_base = pin_offset;
1843 pin_range->range.npins = npins;
1844 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1846 if (IS_ERR(pin_range->pctldev)) {
1847 ret = PTR_ERR(pin_range->pctldev);
1848 chip_err(chip, "could not create pin range\n");
1852 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1853 gpio_offset, gpio_offset + npins - 1,
1855 pin_offset, pin_offset + npins - 1);
1857 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1861 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1864 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1865 * @chip: the chip to remove all the mappings for
1867 void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
1869 struct gpio_pin_range *pin_range, *tmp;
1870 struct gpio_device *gdev = chip->gpiodev;
1872 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1873 list_del(&pin_range->node);
1874 pinctrl_remove_gpio_range(pin_range->pctldev,
1879 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1881 #endif /* CONFIG_PINCTRL */
1883 /* These "optional" allocation calls help prevent drivers from stomping
1884 * on each other, and help provide better diagnostics in debugfs.
1885 * They're called even less than the "set direction" calls.
1887 static int __gpiod_request(struct gpio_desc *desc, const char *label)
1889 struct gpio_chip *chip = desc->gdev->chip;
1891 unsigned long flags;
1893 spin_lock_irqsave(&gpio_lock, flags);
1895 /* NOTE: gpio_request() can be called in early boot,
1896 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1899 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1900 desc_set_label(desc, label ? : "?");
1907 if (chip->request) {
1908 /* chip->request may sleep */
1909 spin_unlock_irqrestore(&gpio_lock, flags);
1910 status = chip->request(chip, gpio_chip_hwgpio(desc));
1911 spin_lock_irqsave(&gpio_lock, flags);
1914 desc_set_label(desc, NULL);
1915 clear_bit(FLAG_REQUESTED, &desc->flags);
1919 if (chip->get_direction) {
1920 /* chip->get_direction may sleep */
1921 spin_unlock_irqrestore(&gpio_lock, flags);
1922 gpiod_get_direction(desc);
1923 spin_lock_irqsave(&gpio_lock, flags);
1926 spin_unlock_irqrestore(&gpio_lock, flags);
1931 * This descriptor validation needs to be inserted verbatim into each
1932 * function taking a descriptor, so we need to use a preprocessor
1933 * macro to avoid endless duplication. If the desc is NULL it is an
1934 * optional GPIO and calls should just bail out.
1936 #define VALIDATE_DESC(desc) do { \
1939 if (IS_ERR(desc)) { \
1940 pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \
1941 return PTR_ERR(desc); \
1943 if (!desc->gdev) { \
1944 pr_warn("%s: invalid GPIO (no device)\n", __func__); \
1947 if ( !desc->gdev->chip ) { \
1948 dev_warn(&desc->gdev->dev, \
1949 "%s: backing chip is gone\n", __func__); \
1953 #define VALIDATE_DESC_VOID(desc) do { \
1956 if (IS_ERR(desc)) { \
1957 pr_warn("%s: invalid GPIO (errorpointer)\n", __func__); \
1960 if (!desc->gdev) { \
1961 pr_warn("%s: invalid GPIO (no device)\n", __func__); \
1964 if (!desc->gdev->chip) { \
1965 dev_warn(&desc->gdev->dev, \
1966 "%s: backing chip is gone\n", __func__); \
1971 int gpiod_request(struct gpio_desc *desc, const char *label)
1973 int status = -EPROBE_DEFER;
1974 struct gpio_device *gdev;
1976 VALIDATE_DESC(desc);
1979 if (try_module_get(gdev->owner)) {
1980 status = __gpiod_request(desc, label);
1982 module_put(gdev->owner);
1984 get_device(&gdev->dev);
1988 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
1993 static bool __gpiod_free(struct gpio_desc *desc)
1996 unsigned long flags;
1997 struct gpio_chip *chip;
2001 gpiod_unexport(desc);
2003 spin_lock_irqsave(&gpio_lock, flags);
2005 chip = desc->gdev->chip;
2006 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
2008 spin_unlock_irqrestore(&gpio_lock, flags);
2009 might_sleep_if(chip->can_sleep);
2010 chip->free(chip, gpio_chip_hwgpio(desc));
2011 spin_lock_irqsave(&gpio_lock, flags);
2013 desc_set_label(desc, NULL);
2014 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2015 clear_bit(FLAG_REQUESTED, &desc->flags);
2016 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2017 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2018 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2022 spin_unlock_irqrestore(&gpio_lock, flags);
2026 void gpiod_free(struct gpio_desc *desc)
2028 if (desc && desc->gdev && __gpiod_free(desc)) {
2029 module_put(desc->gdev->owner);
2030 put_device(&desc->gdev->dev);
2032 WARN_ON(extra_checks);
2037 * gpiochip_is_requested - return string iff signal was requested
2038 * @chip: controller managing the signal
2039 * @offset: of signal within controller's 0..(ngpio - 1) range
2041 * Returns NULL if the GPIO is not currently requested, else a string.
2042 * The string returned is the label passed to gpio_request(); if none has been
2043 * passed it is a meaningless, non-NULL constant.
2045 * This function is for use by GPIO controller drivers. The label can
2046 * help with diagnostics, and knowing that the signal is used as a GPIO
2047 * can help avoid accidentally multiplexing it to another controller.
2049 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
2051 struct gpio_desc *desc;
2053 if (offset >= chip->ngpio)
2056 desc = &chip->gpiodev->descs[offset];
2058 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2062 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2065 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2066 * @desc: GPIO descriptor to request
2067 * @label: label for the GPIO
2069 * Function allows GPIO chip drivers to request and use their own GPIO
2070 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2071 * function will not increase reference count of the GPIO chip module. This
2072 * allows the GPIO chip module to be unloaded as needed (we assume that the
2073 * GPIO chip driver handles freeing the GPIOs it has requested).
2075 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
2078 struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
2082 chip_err(chip, "failed to get GPIO descriptor\n");
2086 err = __gpiod_request(desc, label);
2088 return ERR_PTR(err);
2092 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2095 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2096 * @desc: GPIO descriptor to free
2098 * Function frees the given GPIO requested previously with
2099 * gpiochip_request_own_desc().
2101 void gpiochip_free_own_desc(struct gpio_desc *desc)
2106 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2109 * Drivers MUST set GPIO direction before making get/set calls. In
2110 * some cases this is done in early boot, before IRQs are enabled.
2112 * As a rule these aren't called more than once (except for drivers
2113 * using the open-drain emulation idiom) so these are natural places
2114 * to accumulate extra debugging checks. Note that we can't (yet)
2115 * rely on gpio_request() having been called beforehand.
2119 * gpiod_direction_input - set the GPIO direction to input
2120 * @desc: GPIO to set to input
2122 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2123 * be called safely on it.
2125 * Return 0 in case of success, else an error code.
2127 int gpiod_direction_input(struct gpio_desc *desc)
2129 struct gpio_chip *chip;
2130 int status = -EINVAL;
2132 VALIDATE_DESC(desc);
2133 chip = desc->gdev->chip;
2135 if (!chip->get || !chip->direction_input) {
2137 "%s: missing get() or direction_input() operations\n",
2142 status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
2144 clear_bit(FLAG_IS_OUT, &desc->flags);
2146 trace_gpio_direction(desc_to_gpio(desc), 1, status);
2150 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2152 static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2154 struct gpio_chip *gc = desc->gdev->chip;
2157 /* GPIOs used for IRQs shall not be set as output */
2158 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
2160 "%s: tried to set a GPIO tied to an IRQ as output\n",
2165 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2166 /* First see if we can enable open drain in hardware */
2167 if (gc->set_single_ended) {
2168 ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
2169 LINE_MODE_OPEN_DRAIN);
2171 goto set_output_value;
2173 /* Emulate open drain by not actively driving the line high */
2175 return gpiod_direction_input(desc);
2177 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2178 if (gc->set_single_ended) {
2179 ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
2180 LINE_MODE_OPEN_SOURCE);
2182 goto set_output_value;
2184 /* Emulate open source by not actively driving the line low */
2186 return gpiod_direction_input(desc);
2188 /* Make sure to disable open drain/source hardware, if any */
2189 if (gc->set_single_ended)
2190 gc->set_single_ended(gc,
2191 gpio_chip_hwgpio(desc),
2192 LINE_MODE_PUSH_PULL);
2196 if (!gc->set || !gc->direction_output) {
2198 "%s: missing set() or direction_output() operations\n",
2203 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), value);
2205 set_bit(FLAG_IS_OUT, &desc->flags);
2206 trace_gpio_value(desc_to_gpio(desc), 0, value);
2207 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2212 * gpiod_direction_output_raw - set the GPIO direction to output
2213 * @desc: GPIO to set to output
2214 * @value: initial output value of the GPIO
2216 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2217 * be called safely on it. The initial value of the output must be specified
2218 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2220 * Return 0 in case of success, else an error code.
2222 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2224 VALIDATE_DESC(desc);
2225 return _gpiod_direction_output_raw(desc, value);
2227 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2230 * gpiod_direction_output - set the GPIO direction to output
2231 * @desc: GPIO to set to output
2232 * @value: initial output value of the GPIO
2234 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2235 * be called safely on it. The initial value of the output must be specified
2236 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2239 * Return 0 in case of success, else an error code.
2241 int gpiod_direction_output(struct gpio_desc *desc, int value)
2243 VALIDATE_DESC(desc);
2244 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2246 return _gpiod_direction_output_raw(desc, value);
2248 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2251 * gpiod_set_debounce - sets @debounce time for a @gpio
2252 * @gpio: the gpio to set debounce time
2253 * @debounce: debounce time is microseconds
2255 * returns -ENOTSUPP if the controller does not support setting
2258 int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
2260 struct gpio_chip *chip;
2262 VALIDATE_DESC(desc);
2263 chip = desc->gdev->chip;
2264 if (!chip->set || !chip->set_debounce) {
2266 "%s: missing set() or set_debounce() operations\n",
2271 return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce);
2273 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2276 * gpiod_is_active_low - test whether a GPIO is active-low or not
2277 * @desc: the gpio descriptor to test
2279 * Returns 1 if the GPIO is active-low, 0 otherwise.
2281 int gpiod_is_active_low(const struct gpio_desc *desc)
2283 VALIDATE_DESC(desc);
2284 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2286 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2288 /* I/O calls are only valid after configuration completed; the relevant
2289 * "is this a valid GPIO" error checks should already have been done.
2291 * "Get" operations are often inlinable as reading a pin value register,
2292 * and masking the relevant bit in that register.
2294 * When "set" operations are inlinable, they involve writing that mask to
2295 * one register to set a low value, or a different register to set it high.
2296 * Otherwise locking is needed, so there may be little value to inlining.
2298 *------------------------------------------------------------------------
2300 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2301 * have requested the GPIO. That can include implicit requesting by
2302 * a direction setting call. Marking a gpio as requested locks its chip
2303 * in memory, guaranteeing that these table lookups need no more locking
2304 * and that gpiochip_remove() will fail.
2306 * REVISIT when debugging, consider adding some instrumentation to ensure
2307 * that the GPIO was actually requested.
2310 static int _gpiod_get_raw_value(const struct gpio_desc *desc)
2312 struct gpio_chip *chip;
2316 chip = desc->gdev->chip;
2317 offset = gpio_chip_hwgpio(desc);
2318 value = chip->get ? chip->get(chip, offset) : -EIO;
2319 value = value < 0 ? value : !!value;
2320 trace_gpio_value(desc_to_gpio(desc), 1, value);
2325 * gpiod_get_raw_value() - return a gpio's raw value
2326 * @desc: gpio whose value will be returned
2328 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2329 * its ACTIVE_LOW status, or negative errno on failure.
2331 * This function should be called from contexts where we cannot sleep, and will
2332 * complain if the GPIO chip functions potentially sleep.
2334 int gpiod_get_raw_value(const struct gpio_desc *desc)
2336 VALIDATE_DESC(desc);
2337 /* Should be using gpio_get_value_cansleep() */
2338 WARN_ON(desc->gdev->chip->can_sleep);
2339 return _gpiod_get_raw_value(desc);
2341 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2344 * gpiod_get_value() - return a gpio's value
2345 * @desc: gpio whose value will be returned
2347 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2348 * account, or negative errno on failure.
2350 * This function should be called from contexts where we cannot sleep, and will
2351 * complain if the GPIO chip functions potentially sleep.
2353 int gpiod_get_value(const struct gpio_desc *desc)
2357 VALIDATE_DESC(desc);
2358 /* Should be using gpio_get_value_cansleep() */
2359 WARN_ON(desc->gdev->chip->can_sleep);
2361 value = _gpiod_get_raw_value(desc);
2365 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2370 EXPORT_SYMBOL_GPL(gpiod_get_value);
2373 * _gpio_set_open_drain_value() - Set the open drain gpio's value.
2374 * @desc: gpio descriptor whose state need to be set.
2375 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2377 static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
2380 struct gpio_chip *chip = desc->gdev->chip;
2381 int offset = gpio_chip_hwgpio(desc);
2384 err = chip->direction_input(chip, offset);
2386 clear_bit(FLAG_IS_OUT, &desc->flags);
2388 err = chip->direction_output(chip, offset, 0);
2390 set_bit(FLAG_IS_OUT, &desc->flags);
2392 trace_gpio_direction(desc_to_gpio(desc), value, err);
2395 "%s: Error in set_value for open drain err %d\n",
2400 * _gpio_set_open_source_value() - Set the open source gpio's value.
2401 * @desc: gpio descriptor whose state need to be set.
2402 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2404 static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
2407 struct gpio_chip *chip = desc->gdev->chip;
2408 int offset = gpio_chip_hwgpio(desc);
2411 err = chip->direction_output(chip, offset, 1);
2413 set_bit(FLAG_IS_OUT, &desc->flags);
2415 err = chip->direction_input(chip, offset);
2417 clear_bit(FLAG_IS_OUT, &desc->flags);
2419 trace_gpio_direction(desc_to_gpio(desc), !value, err);
2422 "%s: Error in set_value for open source err %d\n",
2426 static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
2428 struct gpio_chip *chip;
2430 chip = desc->gdev->chip;
2431 trace_gpio_value(desc_to_gpio(desc), 0, value);
2432 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2433 _gpio_set_open_drain_value(desc, value);
2434 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2435 _gpio_set_open_source_value(desc, value);
2437 chip->set(chip, gpio_chip_hwgpio(desc), value);
2441 * set multiple outputs on the same chip;
2442 * use the chip's set_multiple function if available;
2443 * otherwise set the outputs sequentially;
2444 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2445 * defines which outputs are to be changed
2446 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2447 * defines the values the outputs specified by mask are to be set to
2449 static void gpio_chip_set_multiple(struct gpio_chip *chip,
2450 unsigned long *mask, unsigned long *bits)
2452 if (chip->set_multiple) {
2453 chip->set_multiple(chip, mask, bits);
2456 for (i = 0; i < chip->ngpio; i++) {
2457 if (mask[BIT_WORD(i)] == 0) {
2458 /* no more set bits in this mask word;
2459 * skip ahead to the next word */
2460 i = (BIT_WORD(i) + 1) * BITS_PER_LONG - 1;
2463 /* set outputs if the corresponding mask bit is set */
2464 if (__test_and_clear_bit(i, mask))
2465 chip->set(chip, i, test_bit(i, bits));
2470 void gpiod_set_array_value_complex(bool raw, bool can_sleep,
2471 unsigned int array_size,
2472 struct gpio_desc **desc_array,
2477 while (i < array_size) {
2478 struct gpio_chip *chip = desc_array[i]->gdev->chip;
2479 unsigned long mask[BITS_TO_LONGS(chip->ngpio)];
2480 unsigned long bits[BITS_TO_LONGS(chip->ngpio)];
2484 WARN_ON(chip->can_sleep);
2486 memset(mask, 0, sizeof(mask));
2488 struct gpio_desc *desc = desc_array[i];
2489 int hwgpio = gpio_chip_hwgpio(desc);
2490 int value = value_array[i];
2492 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2494 trace_gpio_value(desc_to_gpio(desc), 0, value);
2496 * collect all normal outputs belonging to the same chip
2497 * open drain and open source outputs are set individually
2499 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2500 _gpio_set_open_drain_value(desc, value);
2501 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2502 _gpio_set_open_source_value(desc, value);
2504 __set_bit(hwgpio, mask);
2506 __set_bit(hwgpio, bits);
2508 __clear_bit(hwgpio, bits);
2512 } while ((i < array_size) &&
2513 (desc_array[i]->gdev->chip == chip));
2514 /* push collected bits to outputs */
2516 gpio_chip_set_multiple(chip, mask, bits);
2521 * gpiod_set_raw_value() - assign a gpio's raw value
2522 * @desc: gpio whose value will be assigned
2523 * @value: value to assign
2525 * Set the raw value of the GPIO, i.e. the value of its physical line without
2526 * regard for its ACTIVE_LOW status.
2528 * This function should be called from contexts where we cannot sleep, and will
2529 * complain if the GPIO chip functions potentially sleep.
2531 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2533 VALIDATE_DESC_VOID(desc);
2534 /* Should be using gpiod_set_value_cansleep() */
2535 WARN_ON(desc->gdev->chip->can_sleep);
2536 _gpiod_set_raw_value(desc, value);
2538 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2541 * gpiod_set_value() - assign a gpio's value
2542 * @desc: gpio whose value will be assigned
2543 * @value: value to assign
2545 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2548 * This function should be called from contexts where we cannot sleep, and will
2549 * complain if the GPIO chip functions potentially sleep.
2551 void gpiod_set_value(struct gpio_desc *desc, int value)
2553 VALIDATE_DESC_VOID(desc);
2554 /* Should be using gpiod_set_value_cansleep() */
2555 WARN_ON(desc->gdev->chip->can_sleep);
2556 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2558 _gpiod_set_raw_value(desc, value);
2560 EXPORT_SYMBOL_GPL(gpiod_set_value);
2563 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2564 * @array_size: number of elements in the descriptor / value arrays
2565 * @desc_array: array of GPIO descriptors whose values will be assigned
2566 * @value_array: array of values to assign
2568 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2569 * without regard for their ACTIVE_LOW status.
2571 * This function should be called from contexts where we cannot sleep, and will
2572 * complain if the GPIO chip functions potentially sleep.
2574 void gpiod_set_raw_array_value(unsigned int array_size,
2575 struct gpio_desc **desc_array, int *value_array)
2579 gpiod_set_array_value_complex(true, false, array_size, desc_array,
2582 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
2585 * gpiod_set_array_value() - assign values to an array of GPIOs
2586 * @array_size: number of elements in the descriptor / value arrays
2587 * @desc_array: array of GPIO descriptors whose values will be assigned
2588 * @value_array: array of values to assign
2590 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2593 * This function should be called from contexts where we cannot sleep, and will
2594 * complain if the GPIO chip functions potentially sleep.
2596 void gpiod_set_array_value(unsigned int array_size,
2597 struct gpio_desc **desc_array, int *value_array)
2601 gpiod_set_array_value_complex(false, false, array_size, desc_array,
2604 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
2607 * gpiod_cansleep() - report whether gpio value access may sleep
2608 * @desc: gpio to check
2611 int gpiod_cansleep(const struct gpio_desc *desc)
2613 VALIDATE_DESC(desc);
2614 return desc->gdev->chip->can_sleep;
2616 EXPORT_SYMBOL_GPL(gpiod_cansleep);
2619 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
2620 * @desc: gpio whose IRQ will be returned (already requested)
2622 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
2625 int gpiod_to_irq(const struct gpio_desc *desc)
2627 struct gpio_chip *chip;
2631 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
2632 * requires this function to not return zero on an invalid descriptor
2633 * but rather a negative error number.
2635 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
2638 chip = desc->gdev->chip;
2639 offset = gpio_chip_hwgpio(desc);
2641 int retirq = chip->to_irq(chip, offset);
2643 /* Zero means NO_IRQ */
2651 EXPORT_SYMBOL_GPL(gpiod_to_irq);
2654 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
2655 * @chip: the chip the GPIO to lock belongs to
2656 * @offset: the offset of the GPIO to lock as IRQ
2658 * This is used directly by GPIO drivers that want to lock down
2659 * a certain GPIO line to be used for IRQs.
2661 int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
2663 struct gpio_desc *desc;
2665 desc = gpiochip_get_desc(chip, offset);
2667 return PTR_ERR(desc);
2669 /* Flush direction if something changed behind our back */
2670 if (chip->get_direction) {
2671 int dir = chip->get_direction(chip, offset);
2674 clear_bit(FLAG_IS_OUT, &desc->flags);
2676 set_bit(FLAG_IS_OUT, &desc->flags);
2679 if (test_bit(FLAG_IS_OUT, &desc->flags)) {
2681 "%s: tried to flag a GPIO set as output for IRQ\n",
2686 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
2689 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
2692 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
2693 * @chip: the chip the GPIO to lock belongs to
2694 * @offset: the offset of the GPIO to lock as IRQ
2696 * This is used directly by GPIO drivers that want to indicate
2697 * that a certain GPIO is no longer used exclusively for IRQ.
2699 void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
2701 if (offset >= chip->ngpio)
2704 clear_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
2706 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
2708 bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
2710 if (offset >= chip->ngpio)
2713 return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
2715 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
2717 bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
2719 if (offset >= chip->ngpio)
2722 return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
2724 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
2726 bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
2728 if (offset >= chip->ngpio)
2731 return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
2733 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
2736 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
2737 * @desc: gpio whose value will be returned
2739 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2740 * its ACTIVE_LOW status, or negative errno on failure.
2742 * This function is to be called from contexts that can sleep.
2744 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
2746 might_sleep_if(extra_checks);
2747 VALIDATE_DESC(desc);
2748 return _gpiod_get_raw_value(desc);
2750 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
2753 * gpiod_get_value_cansleep() - return a gpio's value
2754 * @desc: gpio whose value will be returned
2756 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2757 * account, or negative errno on failure.
2759 * This function is to be called from contexts that can sleep.
2761 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
2765 might_sleep_if(extra_checks);
2766 VALIDATE_DESC(desc);
2767 value = _gpiod_get_raw_value(desc);
2771 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2776 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
2779 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
2780 * @desc: gpio whose value will be assigned
2781 * @value: value to assign
2783 * Set the raw value of the GPIO, i.e. the value of its physical line without
2784 * regard for its ACTIVE_LOW status.
2786 * This function is to be called from contexts that can sleep.
2788 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
2790 might_sleep_if(extra_checks);
2791 VALIDATE_DESC_VOID(desc);
2792 _gpiod_set_raw_value(desc, value);
2794 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
2797 * gpiod_set_value_cansleep() - assign a gpio's value
2798 * @desc: gpio whose value will be assigned
2799 * @value: value to assign
2801 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2804 * This function is to be called from contexts that can sleep.
2806 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
2808 might_sleep_if(extra_checks);
2809 VALIDATE_DESC_VOID(desc);
2810 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2812 _gpiod_set_raw_value(desc, value);
2814 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
2817 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
2818 * @array_size: number of elements in the descriptor / value arrays
2819 * @desc_array: array of GPIO descriptors whose values will be assigned
2820 * @value_array: array of values to assign
2822 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2823 * without regard for their ACTIVE_LOW status.
2825 * This function is to be called from contexts that can sleep.
2827 void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
2828 struct gpio_desc **desc_array,
2831 might_sleep_if(extra_checks);
2834 gpiod_set_array_value_complex(true, true, array_size, desc_array,
2837 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
2840 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
2841 * @array_size: number of elements in the descriptor / value arrays
2842 * @desc_array: array of GPIO descriptors whose values will be assigned
2843 * @value_array: array of values to assign
2845 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2848 * This function is to be called from contexts that can sleep.
2850 void gpiod_set_array_value_cansleep(unsigned int array_size,
2851 struct gpio_desc **desc_array,
2854 might_sleep_if(extra_checks);
2857 gpiod_set_array_value_complex(false, true, array_size, desc_array,
2860 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
2863 * gpiod_add_lookup_table() - register GPIO device consumers
2864 * @table: table of consumers to register
2866 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
2868 mutex_lock(&gpio_lookup_lock);
2870 list_add_tail(&table->list, &gpio_lookup_list);
2872 mutex_unlock(&gpio_lookup_lock);
2876 * gpiod_remove_lookup_table() - unregister GPIO device consumers
2877 * @table: table of consumers to unregister
2879 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
2881 mutex_lock(&gpio_lookup_lock);
2883 list_del(&table->list);
2885 mutex_unlock(&gpio_lookup_lock);
2888 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
2890 const char *dev_id = dev ? dev_name(dev) : NULL;
2891 struct gpiod_lookup_table *table;
2893 mutex_lock(&gpio_lookup_lock);
2895 list_for_each_entry(table, &gpio_lookup_list, list) {
2896 if (table->dev_id && dev_id) {
2898 * Valid strings on both ends, must be identical to have
2901 if (!strcmp(table->dev_id, dev_id))
2905 * One of the pointers is NULL, so both must be to have
2908 if (dev_id == table->dev_id)
2915 mutex_unlock(&gpio_lookup_lock);
2919 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
2921 enum gpio_lookup_flags *flags)
2923 struct gpio_desc *desc = ERR_PTR(-ENOENT);
2924 struct gpiod_lookup_table *table;
2925 struct gpiod_lookup *p;
2927 table = gpiod_find_lookup_table(dev);
2931 for (p = &table->table[0]; p->chip_label; p++) {
2932 struct gpio_chip *chip;
2934 /* idx must always match exactly */
2938 /* If the lookup entry has a con_id, require exact match */
2939 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
2942 chip = find_chip_by_name(p->chip_label);
2945 dev_err(dev, "cannot find GPIO chip %s\n",
2947 return ERR_PTR(-ENODEV);
2950 if (chip->ngpio <= p->chip_hwnum) {
2952 "requested GPIO %d is out of range [0..%d] for chip %s\n",
2953 idx, chip->ngpio, chip->label);
2954 return ERR_PTR(-EINVAL);
2957 desc = gpiochip_get_desc(chip, p->chip_hwnum);
2966 static int dt_gpio_count(struct device *dev, const char *con_id)
2972 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
2974 snprintf(propname, sizeof(propname), "%s-%s",
2975 con_id, gpio_suffixes[i]);
2977 snprintf(propname, sizeof(propname), "%s",
2980 ret = of_gpio_named_count(dev->of_node, propname);
2987 static int platform_gpio_count(struct device *dev, const char *con_id)
2989 struct gpiod_lookup_table *table;
2990 struct gpiod_lookup *p;
2991 unsigned int count = 0;
2993 table = gpiod_find_lookup_table(dev);
2997 for (p = &table->table[0]; p->chip_label; p++) {
2998 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
2999 (!con_id && !p->con_id))
3009 * gpiod_count - return the number of GPIOs associated with a device / function
3010 * or -ENOENT if no GPIO has been assigned to the requested function
3011 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3012 * @con_id: function within the GPIO consumer
3014 int gpiod_count(struct device *dev, const char *con_id)
3016 int count = -ENOENT;
3018 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3019 count = dt_gpio_count(dev, con_id);
3020 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3021 count = acpi_gpio_count(dev, con_id);
3024 count = platform_gpio_count(dev, con_id);
3028 EXPORT_SYMBOL_GPL(gpiod_count);
3031 * gpiod_get - obtain a GPIO for a given GPIO function
3032 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3033 * @con_id: function within the GPIO consumer
3034 * @flags: optional GPIO initialization flags
3036 * Return the GPIO descriptor corresponding to the function con_id of device
3037 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3038 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3040 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3041 enum gpiod_flags flags)
3043 return gpiod_get_index(dev, con_id, 0, flags);
3045 EXPORT_SYMBOL_GPL(gpiod_get);
3048 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3049 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3050 * @con_id: function within the GPIO consumer
3051 * @flags: optional GPIO initialization flags
3053 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3054 * the requested function it will return NULL. This is convenient for drivers
3055 * that need to handle optional GPIOs.
3057 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3059 enum gpiod_flags flags)
3061 return gpiod_get_index_optional(dev, con_id, 0, flags);
3063 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3067 * gpiod_configure_flags - helper function to configure a given GPIO
3068 * @desc: gpio whose value will be assigned
3069 * @con_id: function within the GPIO consumer
3070 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
3072 * @dflags: gpiod_flags - optional GPIO initialization flags
3074 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3075 * requested function and/or index, or another IS_ERR() code if an error
3076 * occurred while trying to acquire the GPIO.
3078 static int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3079 unsigned long lflags, enum gpiod_flags dflags)
3083 if (lflags & GPIO_ACTIVE_LOW)
3084 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3085 if (lflags & GPIO_OPEN_DRAIN)
3086 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3087 if (lflags & GPIO_OPEN_SOURCE)
3088 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3090 /* No particular flag request, return here... */
3091 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3092 pr_debug("no flags found for %s\n", con_id);
3097 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3098 status = gpiod_direction_output(desc,
3099 dflags & GPIOD_FLAGS_BIT_DIR_VAL);
3101 status = gpiod_direction_input(desc);
3107 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3108 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3109 * @con_id: function within the GPIO consumer
3110 * @idx: index of the GPIO to obtain in the consumer
3111 * @flags: optional GPIO initialization flags
3113 * This variant of gpiod_get() allows to access GPIOs other than the first
3114 * defined one for functions that define several GPIOs.
3116 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3117 * requested function and/or index, or another IS_ERR() code if an error
3118 * occurred while trying to acquire the GPIO.
3120 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3123 enum gpiod_flags flags)
3125 struct gpio_desc *desc = NULL;
3127 enum gpio_lookup_flags lookupflags = 0;
3129 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3132 /* Using device tree? */
3133 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3134 dev_dbg(dev, "using device tree for GPIO lookup\n");
3135 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3136 } else if (ACPI_COMPANION(dev)) {
3137 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3138 desc = acpi_find_gpio(dev, con_id, idx, flags, &lookupflags);
3143 * Either we are not using DT or ACPI, or their lookup did not return
3144 * a result. In that case, use platform lookup as a fallback.
3146 if (!desc || desc == ERR_PTR(-ENOENT)) {
3147 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3148 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3152 dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
3156 status = gpiod_request(desc, con_id);
3158 return ERR_PTR(status);
3160 status = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3162 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3164 return ERR_PTR(status);
3169 EXPORT_SYMBOL_GPL(gpiod_get_index);
3172 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3173 * @fwnode: handle of the firmware node
3174 * @propname: name of the firmware property representing the GPIO
3176 * This function can be used for drivers that get their configuration
3179 * Function properly finds the corresponding GPIO using whatever is the
3180 * underlying firmware interface and then makes sure that the GPIO
3181 * descriptor is requested before it is returned to the caller.
3183 * In case of error an ERR_PTR() is returned.
3185 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3186 const char *propname)
3188 struct gpio_desc *desc = ERR_PTR(-ENODEV);
3189 bool active_low = false;
3190 bool single_ended = false;
3194 return ERR_PTR(-EINVAL);
3196 if (is_of_node(fwnode)) {
3197 enum of_gpio_flags flags;
3199 desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname, 0,
3201 if (!IS_ERR(desc)) {
3202 active_low = flags & OF_GPIO_ACTIVE_LOW;
3203 single_ended = flags & OF_GPIO_SINGLE_ENDED;
3205 } else if (is_acpi_node(fwnode)) {
3206 struct acpi_gpio_info info;
3208 desc = acpi_node_get_gpiod(fwnode, propname, 0, &info);
3210 active_low = info.polarity == GPIO_ACTIVE_LOW;
3216 ret = gpiod_request(desc, NULL);
3218 return ERR_PTR(ret);
3221 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3225 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3227 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3232 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3235 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3237 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3238 * @con_id: function within the GPIO consumer
3239 * @index: index of the GPIO to obtain in the consumer
3240 * @flags: optional GPIO initialization flags
3242 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3243 * specified index was assigned to the requested function it will return NULL.
3244 * This is convenient for drivers that need to handle optional GPIOs.
3246 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
3249 enum gpiod_flags flags)
3251 struct gpio_desc *desc;
3253 desc = gpiod_get_index(dev, con_id, index, flags);
3255 if (PTR_ERR(desc) == -ENOENT)
3261 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
3264 * gpiod_hog - Hog the specified GPIO desc given the provided flags
3265 * @desc: gpio whose value will be assigned
3266 * @name: gpio line name
3267 * @lflags: gpio_lookup_flags - returned from of_find_gpio() or
3269 * @dflags: gpiod_flags - optional GPIO initialization flags
3271 int gpiod_hog(struct gpio_desc *desc, const char *name,
3272 unsigned long lflags, enum gpiod_flags dflags)
3274 struct gpio_chip *chip;
3275 struct gpio_desc *local_desc;
3279 chip = gpiod_to_chip(desc);
3280 hwnum = gpio_chip_hwgpio(desc);
3282 local_desc = gpiochip_request_own_desc(chip, hwnum, name);
3283 if (IS_ERR(local_desc)) {
3284 status = PTR_ERR(local_desc);
3285 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
3286 name, chip->label, hwnum, status);
3290 status = gpiod_configure_flags(desc, name, lflags, dflags);
3292 pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n",
3293 name, chip->label, hwnum, status);
3294 gpiochip_free_own_desc(desc);
3298 /* Mark GPIO as hogged so it can be identified and removed later */
3299 set_bit(FLAG_IS_HOGGED, &desc->flags);
3301 pr_info("GPIO line %d (%s) hogged as %s%s\n",
3302 desc_to_gpio(desc), name,
3303 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
3304 (dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
3305 (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");
3311 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
3312 * @chip: gpio chip to act on
3314 * This is only used by of_gpiochip_remove to free hogged gpios
3316 static void gpiochip_free_hogs(struct gpio_chip *chip)
3320 for (id = 0; id < chip->ngpio; id++) {
3321 if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
3322 gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
3327 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
3328 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3329 * @con_id: function within the GPIO consumer
3330 * @flags: optional GPIO initialization flags
3332 * This function acquires all the GPIOs defined under a given function.
3334 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
3335 * no GPIO has been assigned to the requested function, or another IS_ERR()
3336 * code if an error occurred while trying to acquire the GPIOs.
3338 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
3340 enum gpiod_flags flags)
3342 struct gpio_desc *desc;
3343 struct gpio_descs *descs;
3346 count = gpiod_count(dev, con_id);
3348 return ERR_PTR(count);
3350 descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count,
3353 return ERR_PTR(-ENOMEM);
3355 for (descs->ndescs = 0; descs->ndescs < count; ) {
3356 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
3358 gpiod_put_array(descs);
3359 return ERR_CAST(desc);
3361 descs->desc[descs->ndescs] = desc;
3366 EXPORT_SYMBOL_GPL(gpiod_get_array);
3369 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
3371 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3372 * @con_id: function within the GPIO consumer
3373 * @flags: optional GPIO initialization flags
3375 * This is equivalent to gpiod_get_array(), except that when no GPIO was
3376 * assigned to the requested function it will return NULL.
3378 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
3380 enum gpiod_flags flags)
3382 struct gpio_descs *descs;
3384 descs = gpiod_get_array(dev, con_id, flags);
3385 if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
3390 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
3393 * gpiod_put - dispose of a GPIO descriptor
3394 * @desc: GPIO descriptor to dispose of
3396 * No descriptor can be used after gpiod_put() has been called on it.
3398 void gpiod_put(struct gpio_desc *desc)
3402 EXPORT_SYMBOL_GPL(gpiod_put);
3405 * gpiod_put_array - dispose of multiple GPIO descriptors
3406 * @descs: struct gpio_descs containing an array of descriptors
3408 void gpiod_put_array(struct gpio_descs *descs)
3412 for (i = 0; i < descs->ndescs; i++)
3413 gpiod_put(descs->desc[i]);
3417 EXPORT_SYMBOL_GPL(gpiod_put_array);
3419 static int __init gpiolib_dev_init(void)
3423 /* Register GPIO sysfs bus */
3424 ret = bus_register(&gpio_bus_type);
3426 pr_err("gpiolib: could not register GPIO bus type\n");
3430 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
3432 pr_err("gpiolib: failed to allocate char dev region\n");
3433 bus_unregister(&gpio_bus_type);
3435 gpiolib_initialized = true;
3436 gpiochip_setup_devs();
3440 core_initcall(gpiolib_dev_init);
3442 #ifdef CONFIG_DEBUG_FS
3444 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
3447 struct gpio_chip *chip = gdev->chip;
3448 unsigned gpio = gdev->base;
3449 struct gpio_desc *gdesc = &gdev->descs[0];
3453 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
3454 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
3456 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
3462 gpiod_get_direction(gdesc);
3463 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
3464 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
3465 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
3466 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
3467 is_out ? "out" : "in ",
3469 ? (chip->get(chip, i) ? "hi" : "lo")
3471 is_irq ? "IRQ" : " ");
3472 seq_printf(s, "\n");
3476 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
3478 unsigned long flags;
3479 struct gpio_device *gdev = NULL;
3480 loff_t index = *pos;
3484 spin_lock_irqsave(&gpio_lock, flags);
3485 list_for_each_entry(gdev, &gpio_devices, list)
3487 spin_unlock_irqrestore(&gpio_lock, flags);
3490 spin_unlock_irqrestore(&gpio_lock, flags);
3495 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
3497 unsigned long flags;
3498 struct gpio_device *gdev = v;
3501 spin_lock_irqsave(&gpio_lock, flags);
3502 if (list_is_last(&gdev->list, &gpio_devices))
3505 ret = list_entry(gdev->list.next, struct gpio_device, list);
3506 spin_unlock_irqrestore(&gpio_lock, flags);
3514 static void gpiolib_seq_stop(struct seq_file *s, void *v)
3518 static int gpiolib_seq_show(struct seq_file *s, void *v)
3520 struct gpio_device *gdev = v;
3521 struct gpio_chip *chip = gdev->chip;
3522 struct device *parent;
3525 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
3526 dev_name(&gdev->dev));
3530 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
3531 dev_name(&gdev->dev),
3532 gdev->base, gdev->base + gdev->ngpio - 1);
3533 parent = chip->parent;
3535 seq_printf(s, ", parent: %s/%s",
3536 parent->bus ? parent->bus->name : "no-bus",
3539 seq_printf(s, ", %s", chip->label);
3540 if (chip->can_sleep)
3541 seq_printf(s, ", can sleep");
3542 seq_printf(s, ":\n");
3545 chip->dbg_show(s, chip);
3547 gpiolib_dbg_show(s, gdev);
3552 static const struct seq_operations gpiolib_seq_ops = {
3553 .start = gpiolib_seq_start,
3554 .next = gpiolib_seq_next,
3555 .stop = gpiolib_seq_stop,
3556 .show = gpiolib_seq_show,
3559 static int gpiolib_open(struct inode *inode, struct file *file)
3561 return seq_open(file, &gpiolib_seq_ops);
3564 static const struct file_operations gpiolib_operations = {
3565 .owner = THIS_MODULE,
3566 .open = gpiolib_open,
3568 .llseek = seq_lseek,
3569 .release = seq_release,
3572 static int __init gpiolib_debugfs_init(void)
3574 /* /sys/kernel/debug/gpio */
3575 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
3576 NULL, NULL, &gpiolib_operations);
3579 subsys_initcall(gpiolib_debugfs_init);
3581 #endif /* DEBUG_FS */