1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/bitmap.h>
4 #include <linux/kernel.h>
5 #include <linux/module.h>
6 #include <linux/interrupt.h>
8 #include <linux/spinlock.h>
9 #include <linux/list.h>
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/debugfs.h>
13 #include <linux/seq_file.h>
14 #include <linux/gpio.h>
15 #include <linux/idr.h>
16 #include <linux/slab.h>
17 #include <linux/acpi.h>
18 #include <linux/gpio/driver.h>
19 #include <linux/gpio/machine.h>
20 #include <linux/pinctrl/consumer.h>
22 #include <linux/compat.h>
23 #include <linux/file.h>
24 #include <uapi/linux/gpio.h>
27 #include "gpiolib-of.h"
28 #include "gpiolib-acpi.h"
29 #include "gpiolib-cdev.h"
30 #include "gpiolib-sysfs.h"
32 #define CREATE_TRACE_POINTS
33 #include <trace/events/gpio.h>
35 /* Implementation infrastructure for GPIO interfaces.
37 * The GPIO programming interface allows for inlining speed-critical
38 * get/set operations for common cases, so that access to SOC-integrated
39 * GPIOs can sometimes cost only an instruction or two per bit.
43 /* When debugging, extend minimal trust to callers and platform code.
44 * Also emit diagnostic messages that may help initial bringup, when
45 * board setup or driver bugs are most common.
47 * Otherwise, minimize overhead in what may be bitbanging codepaths.
50 #define extra_checks 1
52 #define extra_checks 0
55 /* Device and char device-related information */
56 static DEFINE_IDA(gpio_ida);
57 static dev_t gpio_devt;
58 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
59 static int gpio_bus_match(struct device *dev, struct device_driver *drv);
60 static struct bus_type gpio_bus_type = {
62 .match = gpio_bus_match,
66 * Number of GPIOs to use for the fast path in set array
68 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
70 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
71 * While any GPIO is requested, its gpio_chip is not removable;
72 * each GPIO's "requested" flag serves as a lock and refcount.
74 DEFINE_SPINLOCK(gpio_lock);
76 static DEFINE_MUTEX(gpio_lookup_lock);
77 static LIST_HEAD(gpio_lookup_list);
78 LIST_HEAD(gpio_devices);
80 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
81 static LIST_HEAD(gpio_machine_hogs);
83 static void gpiochip_free_hogs(struct gpio_chip *gc);
84 static int gpiochip_add_irqchip(struct gpio_chip *gc,
85 struct lock_class_key *lock_key,
86 struct lock_class_key *request_key);
87 static void gpiochip_irqchip_remove(struct gpio_chip *gc);
88 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc);
89 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc);
90 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc);
92 static bool gpiolib_initialized;
94 static inline void desc_set_label(struct gpio_desc *d, const char *label)
100 * gpio_to_desc - Convert a GPIO number to its descriptor
101 * @gpio: global GPIO number
104 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
105 * with the given number exists in the system.
107 struct gpio_desc *gpio_to_desc(unsigned gpio)
109 struct gpio_device *gdev;
112 spin_lock_irqsave(&gpio_lock, flags);
114 list_for_each_entry(gdev, &gpio_devices, list) {
115 if (gdev->base <= gpio &&
116 gdev->base + gdev->ngpio > gpio) {
117 spin_unlock_irqrestore(&gpio_lock, flags);
118 return &gdev->descs[gpio - gdev->base];
122 spin_unlock_irqrestore(&gpio_lock, flags);
124 if (!gpio_is_valid(gpio))
125 pr_warn("invalid GPIO %d\n", gpio);
129 EXPORT_SYMBOL_GPL(gpio_to_desc);
132 * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
133 * hardware number for this chip
135 * @hwnum: hardware number of the GPIO for this chip
138 * A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists
139 * in the given chip for the specified hardware number.
141 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc,
144 struct gpio_device *gdev = gc->gpiodev;
146 if (hwnum >= gdev->ngpio)
147 return ERR_PTR(-EINVAL);
149 return &gdev->descs[hwnum];
151 EXPORT_SYMBOL_GPL(gpiochip_get_desc);
154 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
155 * @desc: GPIO descriptor
157 * This should disappear in the future but is needed since we still
158 * use GPIO numbers for error messages and sysfs nodes.
161 * The global GPIO number for the GPIO specified by its descriptor.
163 int desc_to_gpio(const struct gpio_desc *desc)
165 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
167 EXPORT_SYMBOL_GPL(desc_to_gpio);
171 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
172 * @desc: descriptor to return the chip of
174 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
176 if (!desc || !desc->gdev)
178 return desc->gdev->chip;
180 EXPORT_SYMBOL_GPL(gpiod_to_chip);
182 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
183 static int gpiochip_find_base(int ngpio)
185 struct gpio_device *gdev;
186 int base = ARCH_NR_GPIOS - ngpio;
188 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
189 /* found a free space? */
190 if (gdev->base + gdev->ngpio <= base)
193 /* nope, check the space right before the chip */
194 base = gdev->base - ngpio;
197 if (gpio_is_valid(base)) {
198 pr_debug("%s: found new base at %d\n", __func__, base);
201 pr_err("%s: cannot find free range\n", __func__);
207 * gpiod_get_direction - return the current direction of a GPIO
208 * @desc: GPIO to get the direction of
210 * Returns 0 for output, 1 for input, or an error code in case of error.
212 * This function may sleep if gpiod_cansleep() is true.
214 int gpiod_get_direction(struct gpio_desc *desc)
216 struct gpio_chip *gc;
220 gc = gpiod_to_chip(desc);
221 offset = gpio_chip_hwgpio(desc);
224 * Open drain emulation using input mode may incorrectly report
225 * input here, fix that up.
227 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) &&
228 test_bit(FLAG_IS_OUT, &desc->flags))
231 if (!gc->get_direction)
234 ret = gc->get_direction(gc, offset);
238 /* GPIOF_DIR_IN or other positive, otherwise GPIOF_DIR_OUT */
242 assign_bit(FLAG_IS_OUT, &desc->flags, !ret);
246 EXPORT_SYMBOL_GPL(gpiod_get_direction);
249 * Add a new chip to the global chips list, keeping the list of chips sorted
250 * by range(means [base, base + ngpio - 1]) order.
252 * Return -EBUSY if the new chip overlaps with some other chip's integer
255 static int gpiodev_add_to_list(struct gpio_device *gdev)
257 struct gpio_device *prev, *next;
259 if (list_empty(&gpio_devices)) {
260 /* initial entry in list */
261 list_add_tail(&gdev->list, &gpio_devices);
265 next = list_entry(gpio_devices.next, struct gpio_device, list);
266 if (gdev->base + gdev->ngpio <= next->base) {
267 /* add before first entry */
268 list_add(&gdev->list, &gpio_devices);
272 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
273 if (prev->base + prev->ngpio <= gdev->base) {
274 /* add behind last entry */
275 list_add_tail(&gdev->list, &gpio_devices);
279 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
280 /* at the end of the list */
281 if (&next->list == &gpio_devices)
284 /* add between prev and next */
285 if (prev->base + prev->ngpio <= gdev->base
286 && gdev->base + gdev->ngpio <= next->base) {
287 list_add(&gdev->list, &prev->list);
292 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
297 * Convert a GPIO name to its descriptor
298 * Note that there is no guarantee that GPIO names are globally unique!
299 * Hence this function will return, if it exists, a reference to the first GPIO
300 * line found that matches the given name.
302 static struct gpio_desc *gpio_name_to_desc(const char * const name)
304 struct gpio_device *gdev;
310 spin_lock_irqsave(&gpio_lock, flags);
312 list_for_each_entry(gdev, &gpio_devices, list) {
315 for (i = 0; i != gdev->ngpio; ++i) {
316 struct gpio_desc *desc = &gdev->descs[i];
321 if (!strcmp(desc->name, name)) {
322 spin_unlock_irqrestore(&gpio_lock, flags);
328 spin_unlock_irqrestore(&gpio_lock, flags);
334 * Take the names from gc->names and assign them to their GPIO descriptors.
335 * Warn if a name is already used for a GPIO line on a different GPIO chip.
338 * 1. Non-unique names are still accepted,
339 * 2. Name collisions within the same GPIO chip are not reported.
341 static int gpiochip_set_desc_names(struct gpio_chip *gc)
343 struct gpio_device *gdev = gc->gpiodev;
346 /* First check all names if they are unique */
347 for (i = 0; i != gc->ngpio; ++i) {
348 struct gpio_desc *gpio;
350 gpio = gpio_name_to_desc(gc->names[i]);
353 "Detected name collision for GPIO name '%s'\n",
357 /* Then add all names to the GPIO descriptors */
358 for (i = 0; i != gc->ngpio; ++i)
359 gdev->descs[i].name = gc->names[i];
365 * devprop_gpiochip_set_names - Set GPIO line names using device properties
366 * @chip: GPIO chip whose lines should be named, if possible
368 * Looks for device property "gpio-line-names" and if it exists assigns
369 * GPIO line names for the chip. The memory allocated for the assigned
370 * names belong to the underlying firmware node and should not be released
373 static int devprop_gpiochip_set_names(struct gpio_chip *chip)
375 struct gpio_device *gdev = chip->gpiodev;
376 struct fwnode_handle *fwnode = dev_fwnode(&gdev->dev);
381 count = fwnode_property_string_array_count(fwnode, "gpio-line-names");
385 if (count > gdev->ngpio) {
386 dev_warn(&gdev->dev, "gpio-line-names is length %d but should be at most length %d",
391 names = kcalloc(count, sizeof(*names), GFP_KERNEL);
395 ret = fwnode_property_read_string_array(fwnode, "gpio-line-names",
398 dev_warn(&gdev->dev, "failed to read GPIO line names\n");
403 for (i = 0; i < count; i++)
404 gdev->descs[i].name = names[i];
411 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
415 p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
419 /* Assume by default all GPIOs are valid */
420 bitmap_fill(p, gc->ngpio);
425 static int gpiochip_alloc_valid_mask(struct gpio_chip *gc)
427 if (!(of_gpio_need_valid_mask(gc) || gc->init_valid_mask))
430 gc->valid_mask = gpiochip_allocate_mask(gc);
437 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
439 if (gc->init_valid_mask)
440 return gc->init_valid_mask(gc,
447 static void gpiochip_free_valid_mask(struct gpio_chip *gc)
449 bitmap_free(gc->valid_mask);
450 gc->valid_mask = NULL;
453 static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
455 if (gc->add_pin_ranges)
456 return gc->add_pin_ranges(gc);
461 bool gpiochip_line_is_valid(const struct gpio_chip *gc,
464 /* No mask means all valid */
465 if (likely(!gc->valid_mask))
467 return test_bit(offset, gc->valid_mask);
469 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
471 static void gpiodevice_release(struct device *dev)
473 struct gpio_device *gdev = container_of(dev, struct gpio_device, dev);
476 spin_lock_irqsave(&gpio_lock, flags);
477 list_del(&gdev->list);
478 spin_unlock_irqrestore(&gpio_lock, flags);
480 ida_free(&gpio_ida, gdev->id);
481 kfree_const(gdev->label);
486 #ifdef CONFIG_GPIO_CDEV
487 #define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
488 #define gcdev_unregister(gdev) gpiolib_cdev_unregister((gdev))
491 * gpiolib_cdev_register() indirectly calls device_add(), which is still
492 * required even when cdev is not selected.
494 #define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
495 #define gcdev_unregister(gdev) device_del(&(gdev)->dev)
498 static int gpiochip_setup_dev(struct gpio_device *gdev)
502 ret = gcdev_register(gdev, gpio_devt);
506 ret = gpiochip_sysfs_register(gdev);
508 goto err_remove_device;
510 /* From this point, the .release() function cleans up gpio_device */
511 gdev->dev.release = gpiodevice_release;
512 dev_dbg(&gdev->dev, "registered GPIOs %d to %d on %s\n", gdev->base,
513 gdev->base + gdev->ngpio - 1, gdev->chip->label ? : "generic");
518 gcdev_unregister(gdev);
522 static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
524 struct gpio_desc *desc;
527 desc = gpiochip_get_desc(gc, hog->chip_hwnum);
529 chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
534 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
537 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
539 gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
540 __func__, gc->label, hog->chip_hwnum, rv);
543 static void machine_gpiochip_add(struct gpio_chip *gc)
545 struct gpiod_hog *hog;
547 mutex_lock(&gpio_machine_hogs_mutex);
549 list_for_each_entry(hog, &gpio_machine_hogs, list) {
550 if (!strcmp(gc->label, hog->chip_label))
551 gpiochip_machine_hog(gc, hog);
554 mutex_unlock(&gpio_machine_hogs_mutex);
557 static void gpiochip_setup_devs(void)
559 struct gpio_device *gdev;
562 list_for_each_entry(gdev, &gpio_devices, list) {
563 ret = gpiochip_setup_dev(gdev);
566 "Failed to initialize gpio device (%d)\n", ret);
570 int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
571 struct lock_class_key *lock_key,
572 struct lock_class_key *request_key)
578 struct gpio_device *gdev;
581 * First: allocate and populate the internal stat container, and
582 * set up the struct device.
584 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
587 gdev->dev.bus = &gpio_bus_type;
591 gdev->dev.parent = gc->parent;
592 gdev->dev.of_node = gc->parent->of_node;
595 of_gpio_dev_init(gc, gdev);
597 gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
603 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
607 device_initialize(&gdev->dev);
608 if (gc->parent && gc->parent->driver)
609 gdev->owner = gc->parent->driver->owner;
611 /* TODO: remove chip->owner */
612 gdev->owner = gc->owner;
614 gdev->owner = THIS_MODULE;
616 gdev->descs = kcalloc(gc->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
619 goto err_free_dev_name;
622 if (gc->ngpio == 0) {
623 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
628 if (gc->ngpio > FASTPATH_NGPIO)
629 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
630 gc->ngpio, FASTPATH_NGPIO);
632 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
638 gdev->ngpio = gc->ngpio;
641 spin_lock_irqsave(&gpio_lock, flags);
644 * TODO: this allocates a Linux GPIO number base in the global
645 * GPIO numberspace for this chip. In the long run we want to
646 * get *rid* of this numberspace and use only descriptors, but
647 * it may be a pipe dream. It will not happen before we get rid
648 * of the sysfs interface anyways.
651 base = gpiochip_find_base(gc->ngpio);
654 spin_unlock_irqrestore(&gpio_lock, flags);
658 * TODO: it should not be necessary to reflect the assigned
659 * base outside of the GPIO subsystem. Go over drivers and
660 * see if anyone makes use of this, else drop this and assign
667 ret = gpiodev_add_to_list(gdev);
669 spin_unlock_irqrestore(&gpio_lock, flags);
673 for (i = 0; i < gc->ngpio; i++)
674 gdev->descs[i].gdev = gdev;
676 spin_unlock_irqrestore(&gpio_lock, flags);
678 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->notifier);
680 #ifdef CONFIG_PINCTRL
681 INIT_LIST_HEAD(&gdev->pin_ranges);
685 ret = gpiochip_set_desc_names(gc);
687 ret = devprop_gpiochip_set_names(gc);
689 goto err_remove_from_list;
691 ret = gpiochip_alloc_valid_mask(gc);
693 goto err_remove_from_list;
695 ret = of_gpiochip_add(gc);
697 goto err_free_gpiochip_mask;
699 ret = gpiochip_init_valid_mask(gc);
701 goto err_remove_of_chip;
703 for (i = 0; i < gc->ngpio; i++) {
704 struct gpio_desc *desc = &gdev->descs[i];
706 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
707 assign_bit(FLAG_IS_OUT,
708 &desc->flags, !gc->get_direction(gc, i));
710 assign_bit(FLAG_IS_OUT,
711 &desc->flags, !gc->direction_input);
715 ret = gpiochip_add_pin_ranges(gc);
717 goto err_remove_of_chip;
719 acpi_gpiochip_add(gc);
721 machine_gpiochip_add(gc);
723 ret = gpiochip_irqchip_init_valid_mask(gc);
725 goto err_remove_acpi_chip;
727 ret = gpiochip_irqchip_init_hw(gc);
729 goto err_remove_acpi_chip;
731 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
733 goto err_remove_irqchip_mask;
736 * By first adding the chardev, and then adding the device,
737 * we get a device node entry in sysfs under
738 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
739 * coldplug of device nodes and other udev business.
740 * We can do this only if gpiolib has been initialized.
741 * Otherwise, defer until later.
743 if (gpiolib_initialized) {
744 ret = gpiochip_setup_dev(gdev);
746 goto err_remove_irqchip;
751 gpiochip_irqchip_remove(gc);
752 err_remove_irqchip_mask:
753 gpiochip_irqchip_free_valid_mask(gc);
754 err_remove_acpi_chip:
755 acpi_gpiochip_remove(gc);
757 gpiochip_free_hogs(gc);
758 of_gpiochip_remove(gc);
759 err_free_gpiochip_mask:
760 gpiochip_remove_pin_ranges(gc);
761 gpiochip_free_valid_mask(gc);
762 err_remove_from_list:
763 spin_lock_irqsave(&gpio_lock, flags);
764 list_del(&gdev->list);
765 spin_unlock_irqrestore(&gpio_lock, flags);
767 kfree_const(gdev->label);
771 kfree(dev_name(&gdev->dev));
773 ida_free(&gpio_ida, gdev->id);
775 /* failures here can mean systems won't boot... */
776 if (ret != -EPROBE_DEFER) {
777 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
778 gdev->base, gdev->base + gdev->ngpio - 1,
779 gc->label ? : "generic", ret);
784 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
787 * gpiochip_get_data() - get per-subdriver data for the chip
791 * The per-subdriver data for the chip.
793 void *gpiochip_get_data(struct gpio_chip *gc)
795 return gc->gpiodev->data;
797 EXPORT_SYMBOL_GPL(gpiochip_get_data);
800 * gpiochip_remove() - unregister a gpio_chip
801 * @gc: the chip to unregister
803 * A gpio_chip with any GPIOs still requested may not be removed.
805 void gpiochip_remove(struct gpio_chip *gc)
807 struct gpio_device *gdev = gc->gpiodev;
811 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
812 gpiochip_sysfs_unregister(gdev);
813 gpiochip_free_hogs(gc);
814 /* Numb the device, cancelling all outstanding operations */
816 gpiochip_irqchip_remove(gc);
817 acpi_gpiochip_remove(gc);
818 of_gpiochip_remove(gc);
819 gpiochip_remove_pin_ranges(gc);
820 gpiochip_free_valid_mask(gc);
822 * We accept no more calls into the driver from this point, so
823 * NULL the driver data pointer
827 spin_lock_irqsave(&gpio_lock, flags);
828 for (i = 0; i < gdev->ngpio; i++) {
829 if (gpiochip_is_requested(gc, i))
832 spin_unlock_irqrestore(&gpio_lock, flags);
834 if (i != gdev->ngpio)
836 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
839 * The gpiochip side puts its use of the device to rest here:
840 * if there are no userspace clients, the chardev and device will
841 * be removed, else it will be dangling until the last user is
844 gcdev_unregister(gdev);
845 put_device(&gdev->dev);
847 EXPORT_SYMBOL_GPL(gpiochip_remove);
850 * gpiochip_find() - iterator for locating a specific gpio_chip
851 * @data: data to pass to match function
852 * @match: Callback function to check gpio_chip
854 * Similar to bus_find_device. It returns a reference to a gpio_chip as
855 * determined by a user supplied @match callback. The callback should return
856 * 0 if the device doesn't match and non-zero if it does. If the callback is
857 * non-zero, this function will return to the caller and not iterate over any
860 struct gpio_chip *gpiochip_find(void *data,
861 int (*match)(struct gpio_chip *gc,
864 struct gpio_device *gdev;
865 struct gpio_chip *gc = NULL;
868 spin_lock_irqsave(&gpio_lock, flags);
869 list_for_each_entry(gdev, &gpio_devices, list)
870 if (gdev->chip && match(gdev->chip, data)) {
875 spin_unlock_irqrestore(&gpio_lock, flags);
879 EXPORT_SYMBOL_GPL(gpiochip_find);
881 static int gpiochip_match_name(struct gpio_chip *gc, void *data)
883 const char *name = data;
885 return !strcmp(gc->label, name);
888 static struct gpio_chip *find_chip_by_name(const char *name)
890 return gpiochip_find((void *)name, gpiochip_match_name);
893 #ifdef CONFIG_GPIOLIB_IRQCHIP
896 * The following is irqchip helper code for gpiochips.
899 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
901 struct gpio_irq_chip *girq = &gc->irq;
906 return girq->init_hw(gc);
909 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
911 struct gpio_irq_chip *girq = &gc->irq;
913 if (!girq->init_valid_mask)
916 girq->valid_mask = gpiochip_allocate_mask(gc);
917 if (!girq->valid_mask)
920 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
925 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
927 bitmap_free(gc->irq.valid_mask);
928 gc->irq.valid_mask = NULL;
931 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
934 if (!gpiochip_line_is_valid(gc, offset))
936 /* No mask means all valid */
937 if (likely(!gc->irq.valid_mask))
939 return test_bit(offset, gc->irq.valid_mask);
941 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
943 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
946 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
948 * @gc: the gpiochip to set the irqchip hierarchical handler to
949 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
950 * will then percolate up to the parent
952 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
953 struct irq_chip *irqchip)
955 /* DT will deal with mapping each IRQ as we go along */
956 if (is_of_node(gc->irq.fwnode))
960 * This is for legacy and boardfile "irqchip" fwnodes: allocate
961 * irqs upfront instead of dynamically since we don't have the
962 * dynamic type of allocation that hardware description languages
963 * provide. Once all GPIO drivers using board files are gone from
964 * the kernel we can delete this code, but for a transitional period
965 * it is necessary to keep this around.
967 if (is_fwnode_irqchip(gc->irq.fwnode)) {
971 for (i = 0; i < gc->ngpio; i++) {
972 struct irq_fwspec fwspec;
973 unsigned int parent_hwirq;
974 unsigned int parent_type;
975 struct gpio_irq_chip *girq = &gc->irq;
978 * We call the child to parent translation function
979 * only to check if the child IRQ is valid or not.
980 * Just pick the rising edge type here as that is what
981 * we likely need to support.
983 ret = girq->child_to_parent_hwirq(gc, i,
984 IRQ_TYPE_EDGE_RISING,
988 chip_err(gc, "skip set-up on hwirq %d\n",
993 fwspec.fwnode = gc->irq.fwnode;
994 /* This is the hwirq for the GPIO line side of things */
995 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
996 /* Just pick something */
997 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
998 fwspec.param_count = 2;
999 ret = __irq_domain_alloc_irqs(gc->irq.domain,
1000 /* just pick something */
1009 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1016 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1021 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1022 struct irq_fwspec *fwspec,
1023 unsigned long *hwirq,
1026 /* We support standard DT translation */
1027 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1028 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1031 /* This is for board files and others not using DT */
1032 if (is_fwnode_irqchip(fwspec->fwnode)) {
1035 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1038 WARN_ON(*type == IRQ_TYPE_NONE);
1044 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1046 unsigned int nr_irqs,
1049 struct gpio_chip *gc = d->host_data;
1050 irq_hw_number_t hwirq;
1051 unsigned int type = IRQ_TYPE_NONE;
1052 struct irq_fwspec *fwspec = data;
1054 unsigned int parent_hwirq;
1055 unsigned int parent_type;
1056 struct gpio_irq_chip *girq = &gc->irq;
1060 * The nr_irqs parameter is always one except for PCI multi-MSI
1061 * so this should not happen.
1063 WARN_ON(nr_irqs != 1);
1065 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1069 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1071 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1072 &parent_hwirq, &parent_type);
1074 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1077 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1080 * We set handle_bad_irq because the .set_type() should
1081 * always be invoked and set the right type of handler.
1083 irq_domain_set_info(d,
1092 /* This parent only handles asserted level IRQs */
1093 parent_arg = girq->populate_parent_alloc_arg(gc, parent_hwirq, parent_type);
1097 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1099 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1100 ret = irq_domain_alloc_irqs_parent(d, irq, 1, parent_arg);
1102 * If the parent irqdomain is msi, the interrupts have already
1103 * been allocated, so the EEXIST is good.
1105 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1109 "failed to allocate parent hwirq %d for hwirq %lu\n",
1110 parent_hwirq, hwirq);
1116 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1117 unsigned int offset)
1122 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1124 ops->activate = gpiochip_irq_domain_activate;
1125 ops->deactivate = gpiochip_irq_domain_deactivate;
1126 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1127 ops->free = irq_domain_free_irqs_common;
1130 * We only allow overriding the translate() function for
1131 * hierarchical chips, and this should only be done if the user
1132 * really need something other than 1:1 translation.
1134 if (!ops->translate)
1135 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1138 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1140 if (!gc->irq.child_to_parent_hwirq ||
1142 chip_err(gc, "missing irqdomain vital data\n");
1146 if (!gc->irq.child_offset_to_irq)
1147 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1149 if (!gc->irq.populate_parent_alloc_arg)
1150 gc->irq.populate_parent_alloc_arg =
1151 gpiochip_populate_parent_fwspec_twocell;
1153 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1155 gc->irq.domain = irq_domain_create_hierarchy(
1156 gc->irq.parent_domain,
1160 &gc->irq.child_irq_domain_ops,
1163 if (!gc->irq.domain)
1166 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1171 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1173 return !!gc->irq.parent_domain;
1176 void *gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1177 unsigned int parent_hwirq,
1178 unsigned int parent_type)
1180 struct irq_fwspec *fwspec;
1182 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1186 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1187 fwspec->param_count = 2;
1188 fwspec->param[0] = parent_hwirq;
1189 fwspec->param[1] = parent_type;
1193 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1195 void *gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1196 unsigned int parent_hwirq,
1197 unsigned int parent_type)
1199 struct irq_fwspec *fwspec;
1201 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1205 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1206 fwspec->param_count = 4;
1207 fwspec->param[0] = 0;
1208 fwspec->param[1] = parent_hwirq;
1209 fwspec->param[2] = 0;
1210 fwspec->param[3] = parent_type;
1214 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1218 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1223 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1228 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1231 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1232 * @d: the irqdomain used by this irqchip
1233 * @irq: the global irq number used by this GPIO irqchip irq
1234 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1236 * This function will set up the mapping for a certain IRQ line on a
1237 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1238 * stored inside the gpiochip.
1240 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1241 irq_hw_number_t hwirq)
1243 struct gpio_chip *gc = d->host_data;
1246 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1249 irq_set_chip_data(irq, gc);
1251 * This lock class tells lockdep that GPIO irqs are in a different
1252 * category than their parents, so it won't report false recursion.
1254 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1255 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1256 /* Chips that use nested thread handlers have them marked */
1257 if (gc->irq.threaded)
1258 irq_set_nested_thread(irq, 1);
1259 irq_set_noprobe(irq);
1261 if (gc->irq.num_parents == 1)
1262 ret = irq_set_parent(irq, gc->irq.parents[0]);
1263 else if (gc->irq.map)
1264 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1270 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1271 * is passed as default type.
1273 if (gc->irq.default_type != IRQ_TYPE_NONE)
1274 irq_set_irq_type(irq, gc->irq.default_type);
1278 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1280 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1282 struct gpio_chip *gc = d->host_data;
1284 if (gc->irq.threaded)
1285 irq_set_nested_thread(irq, 0);
1286 irq_set_chip_and_handler(irq, NULL, NULL);
1287 irq_set_chip_data(irq, NULL);
1289 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1291 static const struct irq_domain_ops gpiochip_domain_ops = {
1292 .map = gpiochip_irq_map,
1293 .unmap = gpiochip_irq_unmap,
1294 /* Virtually all GPIO irqchips are twocell:ed */
1295 .xlate = irq_domain_xlate_twocell,
1299 * TODO: move these activate/deactivate in under the hierarchicial
1300 * irqchip implementation as static once SPMI and SSBI (all external
1301 * users) are phased over.
1304 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1305 * @domain: The IRQ domain used by this IRQ chip
1306 * @data: Outermost irq_data associated with the IRQ
1307 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1309 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1310 * used as the activate function for the &struct irq_domain_ops. The host_data
1311 * for the IRQ domain must be the &struct gpio_chip.
1313 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1314 struct irq_data *data, bool reserve)
1316 struct gpio_chip *gc = domain->host_data;
1318 return gpiochip_lock_as_irq(gc, data->hwirq);
1320 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1323 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1324 * @domain: The IRQ domain used by this IRQ chip
1325 * @data: Outermost irq_data associated with the IRQ
1327 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1328 * be used as the deactivate function for the &struct irq_domain_ops. The
1329 * host_data for the IRQ domain must be the &struct gpio_chip.
1331 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1332 struct irq_data *data)
1334 struct gpio_chip *gc = domain->host_data;
1336 return gpiochip_unlock_as_irq(gc, data->hwirq);
1338 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1340 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1342 struct irq_domain *domain = gc->irq.domain;
1344 if (!gpiochip_irqchip_irq_valid(gc, offset))
1347 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1348 if (irq_domain_is_hierarchy(domain)) {
1349 struct irq_fwspec spec;
1351 spec.fwnode = domain->fwnode;
1352 spec.param_count = 2;
1353 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1354 spec.param[1] = IRQ_TYPE_NONE;
1356 return irq_create_fwspec_mapping(&spec);
1360 return irq_create_mapping(domain, offset);
1363 static int gpiochip_irq_reqres(struct irq_data *d)
1365 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1367 return gpiochip_reqres_irq(gc, d->hwirq);
1370 static void gpiochip_irq_relres(struct irq_data *d)
1372 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1374 gpiochip_relres_irq(gc, d->hwirq);
1377 static void gpiochip_irq_mask(struct irq_data *d)
1379 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1381 if (gc->irq.irq_mask)
1382 gc->irq.irq_mask(d);
1383 gpiochip_disable_irq(gc, d->hwirq);
1386 static void gpiochip_irq_unmask(struct irq_data *d)
1388 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1390 gpiochip_enable_irq(gc, d->hwirq);
1391 if (gc->irq.irq_unmask)
1392 gc->irq.irq_unmask(d);
1395 static void gpiochip_irq_enable(struct irq_data *d)
1397 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1399 gpiochip_enable_irq(gc, d->hwirq);
1400 gc->irq.irq_enable(d);
1403 static void gpiochip_irq_disable(struct irq_data *d)
1405 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1407 gc->irq.irq_disable(d);
1408 gpiochip_disable_irq(gc, d->hwirq);
1411 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1413 struct irq_chip *irqchip = gc->irq.chip;
1415 if (!irqchip->irq_request_resources &&
1416 !irqchip->irq_release_resources) {
1417 irqchip->irq_request_resources = gpiochip_irq_reqres;
1418 irqchip->irq_release_resources = gpiochip_irq_relres;
1420 if (WARN_ON(gc->irq.irq_enable))
1422 /* Check if the irqchip already has this hook... */
1423 if (irqchip->irq_enable == gpiochip_irq_enable ||
1424 irqchip->irq_mask == gpiochip_irq_mask) {
1426 * ...and if so, give a gentle warning that this is bad
1430 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1434 if (irqchip->irq_disable) {
1435 gc->irq.irq_disable = irqchip->irq_disable;
1436 irqchip->irq_disable = gpiochip_irq_disable;
1438 gc->irq.irq_mask = irqchip->irq_mask;
1439 irqchip->irq_mask = gpiochip_irq_mask;
1442 if (irqchip->irq_enable) {
1443 gc->irq.irq_enable = irqchip->irq_enable;
1444 irqchip->irq_enable = gpiochip_irq_enable;
1446 gc->irq.irq_unmask = irqchip->irq_unmask;
1447 irqchip->irq_unmask = gpiochip_irq_unmask;
1452 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1453 * @gc: the GPIO chip to add the IRQ chip to
1454 * @lock_key: lockdep class for IRQ lock
1455 * @request_key: lockdep class for IRQ request
1457 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1458 struct lock_class_key *lock_key,
1459 struct lock_class_key *request_key)
1461 struct irq_chip *irqchip = gc->irq.chip;
1462 const struct irq_domain_ops *ops = NULL;
1463 struct device_node *np;
1470 if (gc->irq.parent_handler && gc->can_sleep) {
1471 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1475 np = gc->gpiodev->dev.of_node;
1476 type = gc->irq.default_type;
1479 * Specifying a default trigger is a terrible idea if DT or ACPI is
1480 * used to configure the interrupts, as you may end up with
1481 * conflicting triggers. Tell the user, and reset to NONE.
1483 if (WARN(np && type != IRQ_TYPE_NONE,
1484 "%s: Ignoring %u default trigger\n", np->full_name, type))
1485 type = IRQ_TYPE_NONE;
1487 if (has_acpi_companion(gc->parent) && type != IRQ_TYPE_NONE) {
1488 acpi_handle_warn(ACPI_HANDLE(gc->parent),
1489 "Ignoring %u default trigger\n", type);
1490 type = IRQ_TYPE_NONE;
1494 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1496 gc->to_irq = gpiochip_to_irq;
1497 gc->irq.default_type = type;
1498 gc->irq.lock_key = lock_key;
1499 gc->irq.request_key = request_key;
1501 /* If a parent irqdomain is provided, let's build a hierarchy */
1502 if (gpiochip_hierarchy_is_hierarchical(gc)) {
1503 int ret = gpiochip_hierarchy_add_domain(gc);
1507 /* Some drivers provide custom irqdomain ops */
1508 if (gc->irq.domain_ops)
1509 ops = gc->irq.domain_ops;
1512 ops = &gpiochip_domain_ops;
1513 gc->irq.domain = irq_domain_add_simple(np,
1517 if (!gc->irq.domain)
1521 if (gc->irq.parent_handler) {
1522 void *data = gc->irq.parent_handler_data ?: gc;
1524 for (i = 0; i < gc->irq.num_parents; i++) {
1526 * The parent IRQ chip is already using the chip_data
1527 * for this IRQ chip, so our callbacks simply use the
1530 irq_set_chained_handler_and_data(gc->irq.parents[i],
1531 gc->irq.parent_handler,
1536 gpiochip_set_irq_hooks(gc);
1538 acpi_gpiochip_request_interrupts(gc);
1544 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1545 * @gc: the gpiochip to remove the irqchip from
1547 * This is called only from gpiochip_remove()
1549 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1551 struct irq_chip *irqchip = gc->irq.chip;
1552 unsigned int offset;
1554 acpi_gpiochip_free_interrupts(gc);
1556 if (irqchip && gc->irq.parent_handler) {
1557 struct gpio_irq_chip *irq = &gc->irq;
1560 for (i = 0; i < irq->num_parents; i++)
1561 irq_set_chained_handler_and_data(irq->parents[i],
1565 /* Remove all IRQ mappings and delete the domain */
1566 if (gc->irq.domain) {
1569 for (offset = 0; offset < gc->ngpio; offset++) {
1570 if (!gpiochip_irqchip_irq_valid(gc, offset))
1573 irq = irq_find_mapping(gc->irq.domain, offset);
1574 irq_dispose_mapping(irq);
1577 irq_domain_remove(gc->irq.domain);
1581 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1582 irqchip->irq_request_resources = NULL;
1583 irqchip->irq_release_resources = NULL;
1585 if (irqchip->irq_enable == gpiochip_irq_enable) {
1586 irqchip->irq_enable = gc->irq.irq_enable;
1587 irqchip->irq_disable = gc->irq.irq_disable;
1590 gc->irq.irq_enable = NULL;
1591 gc->irq.irq_disable = NULL;
1592 gc->irq.chip = NULL;
1594 gpiochip_irqchip_free_valid_mask(gc);
1598 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1599 * @gc: the gpiochip to add the irqchip to
1600 * @domain: the irqdomain to add to the gpiochip
1602 * This function adds an IRQ domain to the gpiochip.
1604 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1605 struct irq_domain *domain)
1610 gc->to_irq = gpiochip_to_irq;
1611 gc->irq.domain = domain;
1615 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1617 #else /* CONFIG_GPIOLIB_IRQCHIP */
1619 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1620 struct lock_class_key *lock_key,
1621 struct lock_class_key *request_key)
1625 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1627 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1632 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1636 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1639 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1642 * gpiochip_generic_request() - request the gpio function for a pin
1643 * @gc: the gpiochip owning the GPIO
1644 * @offset: the offset of the GPIO to request for GPIO function
1646 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
1648 #ifdef CONFIG_PINCTRL
1649 if (list_empty(&gc->gpiodev->pin_ranges))
1653 return pinctrl_gpio_request(gc->gpiodev->base + offset);
1655 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1658 * gpiochip_generic_free() - free the gpio function from a pin
1659 * @gc: the gpiochip to request the gpio function for
1660 * @offset: the offset of the GPIO to free from GPIO function
1662 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
1664 #ifdef CONFIG_PINCTRL
1665 if (list_empty(&gc->gpiodev->pin_ranges))
1669 pinctrl_gpio_free(gc->gpiodev->base + offset);
1671 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1674 * gpiochip_generic_config() - apply configuration for a pin
1675 * @gc: the gpiochip owning the GPIO
1676 * @offset: the offset of the GPIO to apply the configuration
1677 * @config: the configuration to be applied
1679 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
1680 unsigned long config)
1682 return pinctrl_gpio_set_config(gc->gpiodev->base + offset, config);
1684 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1686 #ifdef CONFIG_PINCTRL
1689 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1690 * @gc: the gpiochip to add the range for
1691 * @pctldev: the pin controller to map to
1692 * @gpio_offset: the start offset in the current gpio_chip number space
1693 * @pin_group: name of the pin group inside the pin controller
1695 * Calling this function directly from a DeviceTree-supported
1696 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1697 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1698 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1700 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
1701 struct pinctrl_dev *pctldev,
1702 unsigned int gpio_offset, const char *pin_group)
1704 struct gpio_pin_range *pin_range;
1705 struct gpio_device *gdev = gc->gpiodev;
1708 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1710 chip_err(gc, "failed to allocate pin ranges\n");
1714 /* Use local offset as range ID */
1715 pin_range->range.id = gpio_offset;
1716 pin_range->range.gc = gc;
1717 pin_range->range.name = gc->label;
1718 pin_range->range.base = gdev->base + gpio_offset;
1719 pin_range->pctldev = pctldev;
1721 ret = pinctrl_get_group_pins(pctldev, pin_group,
1722 &pin_range->range.pins,
1723 &pin_range->range.npins);
1729 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1731 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1732 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1733 pinctrl_dev_get_devname(pctldev), pin_group);
1735 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1739 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1742 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1743 * @gc: the gpiochip to add the range for
1744 * @pinctl_name: the dev_name() of the pin controller to map to
1745 * @gpio_offset: the start offset in the current gpio_chip number space
1746 * @pin_offset: the start offset in the pin controller number space
1747 * @npins: the number of pins from the offset of each pin space (GPIO and
1748 * pin controller) to accumulate in this range
1751 * 0 on success, or a negative error-code on failure.
1753 * Calling this function directly from a DeviceTree-supported
1754 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1755 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1756 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1758 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
1759 unsigned int gpio_offset, unsigned int pin_offset,
1762 struct gpio_pin_range *pin_range;
1763 struct gpio_device *gdev = gc->gpiodev;
1766 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1768 chip_err(gc, "failed to allocate pin ranges\n");
1772 /* Use local offset as range ID */
1773 pin_range->range.id = gpio_offset;
1774 pin_range->range.gc = gc;
1775 pin_range->range.name = gc->label;
1776 pin_range->range.base = gdev->base + gpio_offset;
1777 pin_range->range.pin_base = pin_offset;
1778 pin_range->range.npins = npins;
1779 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1781 if (IS_ERR(pin_range->pctldev)) {
1782 ret = PTR_ERR(pin_range->pctldev);
1783 chip_err(gc, "could not create pin range\n");
1787 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1788 gpio_offset, gpio_offset + npins - 1,
1790 pin_offset, pin_offset + npins - 1);
1792 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1796 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1799 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1800 * @gc: the chip to remove all the mappings for
1802 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
1804 struct gpio_pin_range *pin_range, *tmp;
1805 struct gpio_device *gdev = gc->gpiodev;
1807 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1808 list_del(&pin_range->node);
1809 pinctrl_remove_gpio_range(pin_range->pctldev,
1814 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1816 #endif /* CONFIG_PINCTRL */
1818 /* These "optional" allocation calls help prevent drivers from stomping
1819 * on each other, and help provide better diagnostics in debugfs.
1820 * They're called even less than the "set direction" calls.
1822 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
1824 struct gpio_chip *gc = desc->gdev->chip;
1826 unsigned long flags;
1830 label = kstrdup_const(label, GFP_KERNEL);
1835 spin_lock_irqsave(&gpio_lock, flags);
1837 /* NOTE: gpio_request() can be called in early boot,
1838 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1841 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1842 desc_set_label(desc, label ? : "?");
1845 goto out_free_unlock;
1849 /* gc->request may sleep */
1850 spin_unlock_irqrestore(&gpio_lock, flags);
1851 offset = gpio_chip_hwgpio(desc);
1852 if (gpiochip_line_is_valid(gc, offset))
1853 ret = gc->request(gc, offset);
1856 spin_lock_irqsave(&gpio_lock, flags);
1859 desc_set_label(desc, NULL);
1860 clear_bit(FLAG_REQUESTED, &desc->flags);
1861 goto out_free_unlock;
1864 if (gc->get_direction) {
1865 /* gc->get_direction may sleep */
1866 spin_unlock_irqrestore(&gpio_lock, flags);
1867 gpiod_get_direction(desc);
1868 spin_lock_irqsave(&gpio_lock, flags);
1870 spin_unlock_irqrestore(&gpio_lock, flags);
1874 spin_unlock_irqrestore(&gpio_lock, flags);
1880 * This descriptor validation needs to be inserted verbatim into each
1881 * function taking a descriptor, so we need to use a preprocessor
1882 * macro to avoid endless duplication. If the desc is NULL it is an
1883 * optional GPIO and calls should just bail out.
1885 static int validate_desc(const struct gpio_desc *desc, const char *func)
1890 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
1891 return PTR_ERR(desc);
1894 pr_warn("%s: invalid GPIO (no device)\n", func);
1897 if (!desc->gdev->chip) {
1898 dev_warn(&desc->gdev->dev,
1899 "%s: backing chip is gone\n", func);
1905 #define VALIDATE_DESC(desc) do { \
1906 int __valid = validate_desc(desc, __func__); \
1911 #define VALIDATE_DESC_VOID(desc) do { \
1912 int __valid = validate_desc(desc, __func__); \
1917 int gpiod_request(struct gpio_desc *desc, const char *label)
1919 int ret = -EPROBE_DEFER;
1920 struct gpio_device *gdev;
1922 VALIDATE_DESC(desc);
1925 if (try_module_get(gdev->owner)) {
1926 ret = gpiod_request_commit(desc, label);
1928 module_put(gdev->owner);
1930 get_device(&gdev->dev);
1934 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
1939 static bool gpiod_free_commit(struct gpio_desc *desc)
1942 unsigned long flags;
1943 struct gpio_chip *gc;
1947 gpiod_unexport(desc);
1949 spin_lock_irqsave(&gpio_lock, flags);
1951 gc = desc->gdev->chip;
1952 if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
1954 spin_unlock_irqrestore(&gpio_lock, flags);
1955 might_sleep_if(gc->can_sleep);
1956 gc->free(gc, gpio_chip_hwgpio(desc));
1957 spin_lock_irqsave(&gpio_lock, flags);
1959 kfree_const(desc->label);
1960 desc_set_label(desc, NULL);
1961 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1962 clear_bit(FLAG_REQUESTED, &desc->flags);
1963 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1964 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1965 clear_bit(FLAG_PULL_UP, &desc->flags);
1966 clear_bit(FLAG_PULL_DOWN, &desc->flags);
1967 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
1968 clear_bit(FLAG_EDGE_RISING, &desc->flags);
1969 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
1970 clear_bit(FLAG_IS_HOGGED, &desc->flags);
1971 #ifdef CONFIG_OF_DYNAMIC
1974 #ifdef CONFIG_GPIO_CDEV
1975 WRITE_ONCE(desc->debounce_period_us, 0);
1980 spin_unlock_irqrestore(&gpio_lock, flags);
1981 blocking_notifier_call_chain(&desc->gdev->notifier,
1982 GPIOLINE_CHANGED_RELEASED, desc);
1987 void gpiod_free(struct gpio_desc *desc)
1989 if (desc && desc->gdev && gpiod_free_commit(desc)) {
1990 module_put(desc->gdev->owner);
1991 put_device(&desc->gdev->dev);
1993 WARN_ON(extra_checks);
1998 * gpiochip_is_requested - return string iff signal was requested
1999 * @gc: controller managing the signal
2000 * @offset: of signal within controller's 0..(ngpio - 1) range
2002 * Returns NULL if the GPIO is not currently requested, else a string.
2003 * The string returned is the label passed to gpio_request(); if none has been
2004 * passed it is a meaningless, non-NULL constant.
2006 * This function is for use by GPIO controller drivers. The label can
2007 * help with diagnostics, and knowing that the signal is used as a GPIO
2008 * can help avoid accidentally multiplexing it to another controller.
2010 const char *gpiochip_is_requested(struct gpio_chip *gc, unsigned int offset)
2012 struct gpio_desc *desc;
2014 if (offset >= gc->ngpio)
2017 desc = gpiochip_get_desc(gc, offset);
2021 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2025 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2028 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2030 * @hwnum: hardware number of the GPIO for which to request the descriptor
2031 * @label: label for the GPIO
2032 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2033 * specify things like line inversion semantics with the machine flags
2034 * such as GPIO_OUT_LOW
2035 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2036 * can be used to specify consumer semantics such as open drain
2038 * Function allows GPIO chip drivers to request and use their own GPIO
2039 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2040 * function will not increase reference count of the GPIO chip module. This
2041 * allows the GPIO chip module to be unloaded as needed (we assume that the
2042 * GPIO chip driver handles freeing the GPIOs it has requested).
2045 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2048 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2051 enum gpio_lookup_flags lflags,
2052 enum gpiod_flags dflags)
2054 struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2058 chip_err(gc, "failed to get GPIO descriptor\n");
2062 ret = gpiod_request_commit(desc, label);
2064 return ERR_PTR(ret);
2066 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2068 chip_err(gc, "setup of own GPIO %s failed\n", label);
2069 gpiod_free_commit(desc);
2070 return ERR_PTR(ret);
2075 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2078 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2079 * @desc: GPIO descriptor to free
2081 * Function frees the given GPIO requested previously with
2082 * gpiochip_request_own_desc().
2084 void gpiochip_free_own_desc(struct gpio_desc *desc)
2087 gpiod_free_commit(desc);
2089 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2092 * Drivers MUST set GPIO direction before making get/set calls. In
2093 * some cases this is done in early boot, before IRQs are enabled.
2095 * As a rule these aren't called more than once (except for drivers
2096 * using the open-drain emulation idiom) so these are natural places
2097 * to accumulate extra debugging checks. Note that we can't (yet)
2098 * rely on gpio_request() having been called beforehand.
2101 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2102 unsigned long config)
2104 if (!gc->set_config)
2107 return gc->set_config(gc, offset, config);
2110 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2111 enum pin_config_param mode,
2114 struct gpio_chip *gc = desc->gdev->chip;
2115 unsigned long config;
2117 config = pinconf_to_config_packed(mode, argument);
2118 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2121 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2122 enum pin_config_param mode,
2125 struct device *dev = &desc->gdev->dev;
2126 int gpio = gpio_chip_hwgpio(desc);
2129 ret = gpio_set_config_with_argument(desc, mode, argument);
2130 if (ret != -ENOTSUPP)
2134 case PIN_CONFIG_PERSIST_STATE:
2135 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2144 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2146 return gpio_set_config_with_argument(desc, mode, 0);
2149 static int gpio_set_bias(struct gpio_desc *desc)
2151 enum pin_config_param bias;
2154 if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2155 bias = PIN_CONFIG_BIAS_DISABLE;
2156 else if (test_bit(FLAG_PULL_UP, &desc->flags))
2157 bias = PIN_CONFIG_BIAS_PULL_UP;
2158 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2159 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2164 case PIN_CONFIG_BIAS_PULL_DOWN:
2165 case PIN_CONFIG_BIAS_PULL_UP:
2174 return gpio_set_config_with_argument_optional(desc, bias, arg);
2177 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2179 return gpio_set_config_with_argument_optional(desc,
2180 PIN_CONFIG_INPUT_DEBOUNCE,
2185 * gpiod_direction_input - set the GPIO direction to input
2186 * @desc: GPIO to set to input
2188 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2189 * be called safely on it.
2191 * Return 0 in case of success, else an error code.
2193 int gpiod_direction_input(struct gpio_desc *desc)
2195 struct gpio_chip *gc;
2198 VALIDATE_DESC(desc);
2199 gc = desc->gdev->chip;
2202 * It is legal to have no .get() and .direction_input() specified if
2203 * the chip is output-only, but you can't specify .direction_input()
2204 * and not support the .get() operation, that doesn't make sense.
2206 if (!gc->get && gc->direction_input) {
2208 "%s: missing get() but have direction_input()\n",
2214 * If we have a .direction_input() callback, things are simple,
2215 * just call it. Else we are some input-only chip so try to check the
2216 * direction (if .get_direction() is supported) else we silently
2217 * assume we are in input mode after this.
2219 if (gc->direction_input) {
2220 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2221 } else if (gc->get_direction &&
2222 (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2224 "%s: missing direction_input() operation and line is output\n",
2229 clear_bit(FLAG_IS_OUT, &desc->flags);
2230 ret = gpio_set_bias(desc);
2233 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2237 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2239 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2241 struct gpio_chip *gc = desc->gdev->chip;
2246 * It's OK not to specify .direction_output() if the gpiochip is
2247 * output-only, but if there is then not even a .set() operation it
2248 * is pretty tricky to drive the output line.
2250 if (!gc->set && !gc->direction_output) {
2252 "%s: missing set() and direction_output() operations\n",
2257 if (gc->direction_output) {
2258 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2260 /* Check that we are in output mode if we can */
2261 if (gc->get_direction &&
2262 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2264 "%s: missing direction_output() operation\n",
2269 * If we can't actively set the direction, we are some
2270 * output-only chip, so just drive the output as desired.
2272 gc->set(gc, gpio_chip_hwgpio(desc), val);
2276 set_bit(FLAG_IS_OUT, &desc->flags);
2277 trace_gpio_value(desc_to_gpio(desc), 0, val);
2278 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2283 * gpiod_direction_output_raw - set the GPIO direction to output
2284 * @desc: GPIO to set to output
2285 * @value: initial output value of the GPIO
2287 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2288 * be called safely on it. The initial value of the output must be specified
2289 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2291 * Return 0 in case of success, else an error code.
2293 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2295 VALIDATE_DESC(desc);
2296 return gpiod_direction_output_raw_commit(desc, value);
2298 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2301 * gpiod_direction_output - set the GPIO direction to output
2302 * @desc: GPIO to set to output
2303 * @value: initial output value of the GPIO
2305 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2306 * be called safely on it. The initial value of the output must be specified
2307 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2310 * Return 0 in case of success, else an error code.
2312 int gpiod_direction_output(struct gpio_desc *desc, int value)
2316 VALIDATE_DESC(desc);
2317 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2322 /* GPIOs used for enabled IRQs shall not be set as output */
2323 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2324 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2326 "%s: tried to set a GPIO tied to an IRQ as output\n",
2331 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2332 /* First see if we can enable open drain in hardware */
2333 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2335 goto set_output_value;
2336 /* Emulate open drain by not actively driving the line high */
2338 ret = gpiod_direction_input(desc);
2339 goto set_output_flag;
2342 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2343 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2345 goto set_output_value;
2346 /* Emulate open source by not actively driving the line low */
2348 ret = gpiod_direction_input(desc);
2349 goto set_output_flag;
2352 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2356 ret = gpio_set_bias(desc);
2359 return gpiod_direction_output_raw_commit(desc, value);
2363 * When emulating open-source or open-drain functionalities by not
2364 * actively driving the line (setting mode to input) we still need to
2365 * set the IS_OUT flag or otherwise we won't be able to set the line
2369 set_bit(FLAG_IS_OUT, &desc->flags);
2372 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2375 * gpiod_set_config - sets @config for a GPIO
2376 * @desc: descriptor of the GPIO for which to set the configuration
2377 * @config: Same packed config format as generic pinconf
2380 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2383 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2385 struct gpio_chip *gc;
2387 VALIDATE_DESC(desc);
2388 gc = desc->gdev->chip;
2390 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2392 EXPORT_SYMBOL_GPL(gpiod_set_config);
2395 * gpiod_set_debounce - sets @debounce time for a GPIO
2396 * @desc: descriptor of the GPIO for which to set debounce time
2397 * @debounce: debounce time in microseconds
2400 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2403 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2405 unsigned long config;
2407 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2408 return gpiod_set_config(desc, config);
2410 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2413 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2414 * @desc: descriptor of the GPIO for which to configure persistence
2415 * @transitory: True to lose state on suspend or reset, false for persistence
2418 * 0 on success, otherwise a negative error code.
2420 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2422 VALIDATE_DESC(desc);
2424 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2425 * persistence state.
2427 assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2429 /* If the driver supports it, set the persistence state now */
2430 return gpio_set_config_with_argument_optional(desc,
2431 PIN_CONFIG_PERSIST_STATE,
2434 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2437 * gpiod_is_active_low - test whether a GPIO is active-low or not
2438 * @desc: the gpio descriptor to test
2440 * Returns 1 if the GPIO is active-low, 0 otherwise.
2442 int gpiod_is_active_low(const struct gpio_desc *desc)
2444 VALIDATE_DESC(desc);
2445 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2447 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2450 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2451 * @desc: the gpio descriptor to change
2453 void gpiod_toggle_active_low(struct gpio_desc *desc)
2455 VALIDATE_DESC_VOID(desc);
2456 change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2458 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2460 /* I/O calls are only valid after configuration completed; the relevant
2461 * "is this a valid GPIO" error checks should already have been done.
2463 * "Get" operations are often inlinable as reading a pin value register,
2464 * and masking the relevant bit in that register.
2466 * When "set" operations are inlinable, they involve writing that mask to
2467 * one register to set a low value, or a different register to set it high.
2468 * Otherwise locking is needed, so there may be little value to inlining.
2470 *------------------------------------------------------------------------
2472 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2473 * have requested the GPIO. That can include implicit requesting by
2474 * a direction setting call. Marking a gpio as requested locks its chip
2475 * in memory, guaranteeing that these table lookups need no more locking
2476 * and that gpiochip_remove() will fail.
2478 * REVISIT when debugging, consider adding some instrumentation to ensure
2479 * that the GPIO was actually requested.
2482 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2484 struct gpio_chip *gc;
2488 gc = desc->gdev->chip;
2489 offset = gpio_chip_hwgpio(desc);
2490 value = gc->get ? gc->get(gc, offset) : -EIO;
2491 value = value < 0 ? value : !!value;
2492 trace_gpio_value(desc_to_gpio(desc), 1, value);
2496 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2497 unsigned long *mask, unsigned long *bits)
2499 if (gc->get_multiple) {
2500 return gc->get_multiple(gc, mask, bits);
2501 } else if (gc->get) {
2504 for_each_set_bit(i, mask, gc->ngpio) {
2505 value = gc->get(gc, i);
2508 __assign_bit(i, bits, value);
2515 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2516 unsigned int array_size,
2517 struct gpio_desc **desc_array,
2518 struct gpio_array *array_info,
2519 unsigned long *value_bitmap)
2524 * Validate array_info against desc_array and its size.
2525 * It should immediately follow desc_array if both
2526 * have been obtained from the same gpiod_get_array() call.
2528 if (array_info && array_info->desc == desc_array &&
2529 array_size <= array_info->size &&
2530 (void *)array_info == desc_array + array_info->size) {
2532 WARN_ON(array_info->chip->can_sleep);
2534 ret = gpio_chip_get_multiple(array_info->chip,
2535 array_info->get_mask,
2540 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2541 bitmap_xor(value_bitmap, value_bitmap,
2542 array_info->invert_mask, array_size);
2544 i = find_first_zero_bit(array_info->get_mask, array_size);
2545 if (i == array_size)
2551 while (i < array_size) {
2552 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2553 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2554 unsigned long *mask, *bits;
2557 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2560 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2562 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2567 bits = mask + BITS_TO_LONGS(gc->ngpio);
2568 bitmap_zero(mask, gc->ngpio);
2571 WARN_ON(gc->can_sleep);
2573 /* collect all inputs belonging to the same chip */
2576 const struct gpio_desc *desc = desc_array[i];
2577 int hwgpio = gpio_chip_hwgpio(desc);
2579 __set_bit(hwgpio, mask);
2583 i = find_next_zero_bit(array_info->get_mask,
2585 } while ((i < array_size) &&
2586 (desc_array[i]->gdev->chip == gc));
2588 ret = gpio_chip_get_multiple(gc, mask, bits);
2590 if (mask != fastpath)
2595 for (j = first; j < i; ) {
2596 const struct gpio_desc *desc = desc_array[j];
2597 int hwgpio = gpio_chip_hwgpio(desc);
2598 int value = test_bit(hwgpio, bits);
2600 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2602 __assign_bit(j, value_bitmap, value);
2603 trace_gpio_value(desc_to_gpio(desc), 1, value);
2607 j = find_next_zero_bit(array_info->get_mask, i,
2611 if (mask != fastpath)
2618 * gpiod_get_raw_value() - return a gpio's raw value
2619 * @desc: gpio whose value will be returned
2621 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2622 * its ACTIVE_LOW status, or negative errno on failure.
2624 * This function can be called from contexts where we cannot sleep, and will
2625 * complain if the GPIO chip functions potentially sleep.
2627 int gpiod_get_raw_value(const struct gpio_desc *desc)
2629 VALIDATE_DESC(desc);
2630 /* Should be using gpiod_get_raw_value_cansleep() */
2631 WARN_ON(desc->gdev->chip->can_sleep);
2632 return gpiod_get_raw_value_commit(desc);
2634 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2637 * gpiod_get_value() - return a gpio's value
2638 * @desc: gpio whose value will be returned
2640 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2641 * account, or negative errno on failure.
2643 * This function can be called from contexts where we cannot sleep, and will
2644 * complain if the GPIO chip functions potentially sleep.
2646 int gpiod_get_value(const struct gpio_desc *desc)
2650 VALIDATE_DESC(desc);
2651 /* Should be using gpiod_get_value_cansleep() */
2652 WARN_ON(desc->gdev->chip->can_sleep);
2654 value = gpiod_get_raw_value_commit(desc);
2658 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2663 EXPORT_SYMBOL_GPL(gpiod_get_value);
2666 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2667 * @array_size: number of elements in the descriptor array / value bitmap
2668 * @desc_array: array of GPIO descriptors whose values will be read
2669 * @array_info: information on applicability of fast bitmap processing path
2670 * @value_bitmap: bitmap to store the read values
2672 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2673 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2674 * else an error code.
2676 * This function can be called from contexts where we cannot sleep,
2677 * and it will complain if the GPIO chip functions potentially sleep.
2679 int gpiod_get_raw_array_value(unsigned int array_size,
2680 struct gpio_desc **desc_array,
2681 struct gpio_array *array_info,
2682 unsigned long *value_bitmap)
2686 return gpiod_get_array_value_complex(true, false, array_size,
2687 desc_array, array_info,
2690 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2693 * gpiod_get_array_value() - read values from an array of GPIOs
2694 * @array_size: number of elements in the descriptor array / value bitmap
2695 * @desc_array: array of GPIO descriptors whose values will be read
2696 * @array_info: information on applicability of fast bitmap processing path
2697 * @value_bitmap: bitmap to store the read values
2699 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2700 * into account. Return 0 in case of success, else an error code.
2702 * This function can be called from contexts where we cannot sleep,
2703 * and it will complain if the GPIO chip functions potentially sleep.
2705 int gpiod_get_array_value(unsigned int array_size,
2706 struct gpio_desc **desc_array,
2707 struct gpio_array *array_info,
2708 unsigned long *value_bitmap)
2712 return gpiod_get_array_value_complex(false, false, array_size,
2713 desc_array, array_info,
2716 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2719 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2720 * @desc: gpio descriptor whose state need to be set.
2721 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2723 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2726 struct gpio_chip *gc = desc->gdev->chip;
2727 int offset = gpio_chip_hwgpio(desc);
2730 ret = gc->direction_input(gc, offset);
2732 ret = gc->direction_output(gc, offset, 0);
2734 set_bit(FLAG_IS_OUT, &desc->flags);
2736 trace_gpio_direction(desc_to_gpio(desc), value, ret);
2739 "%s: Error in set_value for open drain err %d\n",
2744 * _gpio_set_open_source_value() - Set the open source gpio's value.
2745 * @desc: gpio descriptor whose state need to be set.
2746 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2748 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2751 struct gpio_chip *gc = desc->gdev->chip;
2752 int offset = gpio_chip_hwgpio(desc);
2755 ret = gc->direction_output(gc, offset, 1);
2757 set_bit(FLAG_IS_OUT, &desc->flags);
2759 ret = gc->direction_input(gc, offset);
2761 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
2764 "%s: Error in set_value for open source err %d\n",
2768 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2770 struct gpio_chip *gc;
2772 gc = desc->gdev->chip;
2773 trace_gpio_value(desc_to_gpio(desc), 0, value);
2774 gc->set(gc, gpio_chip_hwgpio(desc), value);
2778 * set multiple outputs on the same chip;
2779 * use the chip's set_multiple function if available;
2780 * otherwise set the outputs sequentially;
2781 * @chip: the GPIO chip we operate on
2782 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2783 * defines which outputs are to be changed
2784 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2785 * defines the values the outputs specified by mask are to be set to
2787 static void gpio_chip_set_multiple(struct gpio_chip *gc,
2788 unsigned long *mask, unsigned long *bits)
2790 if (gc->set_multiple) {
2791 gc->set_multiple(gc, mask, bits);
2795 /* set outputs if the corresponding mask bit is set */
2796 for_each_set_bit(i, mask, gc->ngpio)
2797 gc->set(gc, i, test_bit(i, bits));
2801 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
2802 unsigned int array_size,
2803 struct gpio_desc **desc_array,
2804 struct gpio_array *array_info,
2805 unsigned long *value_bitmap)
2810 * Validate array_info against desc_array and its size.
2811 * It should immediately follow desc_array if both
2812 * have been obtained from the same gpiod_get_array() call.
2814 if (array_info && array_info->desc == desc_array &&
2815 array_size <= array_info->size &&
2816 (void *)array_info == desc_array + array_info->size) {
2818 WARN_ON(array_info->chip->can_sleep);
2820 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2821 bitmap_xor(value_bitmap, value_bitmap,
2822 array_info->invert_mask, array_size);
2824 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
2827 i = find_first_zero_bit(array_info->set_mask, array_size);
2828 if (i == array_size)
2834 while (i < array_size) {
2835 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2836 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2837 unsigned long *mask, *bits;
2840 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2843 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2845 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2850 bits = mask + BITS_TO_LONGS(gc->ngpio);
2851 bitmap_zero(mask, gc->ngpio);
2854 WARN_ON(gc->can_sleep);
2857 struct gpio_desc *desc = desc_array[i];
2858 int hwgpio = gpio_chip_hwgpio(desc);
2859 int value = test_bit(i, value_bitmap);
2862 * Pins applicable for fast input but not for
2863 * fast output processing may have been already
2864 * inverted inside the fast path, skip them.
2866 if (!raw && !(array_info &&
2867 test_bit(i, array_info->invert_mask)) &&
2868 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2870 trace_gpio_value(desc_to_gpio(desc), 0, value);
2872 * collect all normal outputs belonging to the same chip
2873 * open drain and open source outputs are set individually
2875 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
2876 gpio_set_open_drain_value_commit(desc, value);
2877 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
2878 gpio_set_open_source_value_commit(desc, value);
2880 __set_bit(hwgpio, mask);
2881 __assign_bit(hwgpio, bits, value);
2887 i = find_next_zero_bit(array_info->set_mask,
2889 } while ((i < array_size) &&
2890 (desc_array[i]->gdev->chip == gc));
2891 /* push collected bits to outputs */
2893 gpio_chip_set_multiple(gc, mask, bits);
2895 if (mask != fastpath)
2902 * gpiod_set_raw_value() - assign a gpio's raw value
2903 * @desc: gpio whose value will be assigned
2904 * @value: value to assign
2906 * Set the raw value of the GPIO, i.e. the value of its physical line without
2907 * regard for its ACTIVE_LOW status.
2909 * This function can be called from contexts where we cannot sleep, and will
2910 * complain if the GPIO chip functions potentially sleep.
2912 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2914 VALIDATE_DESC_VOID(desc);
2915 /* Should be using gpiod_set_raw_value_cansleep() */
2916 WARN_ON(desc->gdev->chip->can_sleep);
2917 gpiod_set_raw_value_commit(desc, value);
2919 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2922 * gpiod_set_value_nocheck() - set a GPIO line value without checking
2923 * @desc: the descriptor to set the value on
2924 * @value: value to set
2926 * This sets the value of a GPIO line backing a descriptor, applying
2927 * different semantic quirks like active low and open drain/source
2930 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
2932 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2934 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2935 gpio_set_open_drain_value_commit(desc, value);
2936 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2937 gpio_set_open_source_value_commit(desc, value);
2939 gpiod_set_raw_value_commit(desc, value);
2943 * gpiod_set_value() - assign a gpio's value
2944 * @desc: gpio whose value will be assigned
2945 * @value: value to assign
2947 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
2948 * OPEN_DRAIN and OPEN_SOURCE flags into account.
2950 * This function can be called from contexts where we cannot sleep, and will
2951 * complain if the GPIO chip functions potentially sleep.
2953 void gpiod_set_value(struct gpio_desc *desc, int value)
2955 VALIDATE_DESC_VOID(desc);
2956 /* Should be using gpiod_set_value_cansleep() */
2957 WARN_ON(desc->gdev->chip->can_sleep);
2958 gpiod_set_value_nocheck(desc, value);
2960 EXPORT_SYMBOL_GPL(gpiod_set_value);
2963 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2964 * @array_size: number of elements in the descriptor array / value bitmap
2965 * @desc_array: array of GPIO descriptors whose values will be assigned
2966 * @array_info: information on applicability of fast bitmap processing path
2967 * @value_bitmap: bitmap of values to assign
2969 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2970 * without regard for their ACTIVE_LOW status.
2972 * This function can be called from contexts where we cannot sleep, and will
2973 * complain if the GPIO chip functions potentially sleep.
2975 int gpiod_set_raw_array_value(unsigned int array_size,
2976 struct gpio_desc **desc_array,
2977 struct gpio_array *array_info,
2978 unsigned long *value_bitmap)
2982 return gpiod_set_array_value_complex(true, false, array_size,
2983 desc_array, array_info, value_bitmap);
2985 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
2988 * gpiod_set_array_value() - assign values to an array of GPIOs
2989 * @array_size: number of elements in the descriptor array / value bitmap
2990 * @desc_array: array of GPIO descriptors whose values will be assigned
2991 * @array_info: information on applicability of fast bitmap processing path
2992 * @value_bitmap: bitmap of values to assign
2994 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2997 * This function can be called from contexts where we cannot sleep, and will
2998 * complain if the GPIO chip functions potentially sleep.
3000 int gpiod_set_array_value(unsigned int array_size,
3001 struct gpio_desc **desc_array,
3002 struct gpio_array *array_info,
3003 unsigned long *value_bitmap)
3007 return gpiod_set_array_value_complex(false, false, array_size,
3008 desc_array, array_info,
3011 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3014 * gpiod_cansleep() - report whether gpio value access may sleep
3015 * @desc: gpio to check
3018 int gpiod_cansleep(const struct gpio_desc *desc)
3020 VALIDATE_DESC(desc);
3021 return desc->gdev->chip->can_sleep;
3023 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3026 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3027 * @desc: gpio to set the consumer name on
3028 * @name: the new consumer name
3030 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3032 VALIDATE_DESC(desc);
3034 name = kstrdup_const(name, GFP_KERNEL);
3039 kfree_const(desc->label);
3040 desc_set_label(desc, name);
3044 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3047 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3048 * @desc: gpio whose IRQ will be returned (already requested)
3050 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3053 int gpiod_to_irq(const struct gpio_desc *desc)
3055 struct gpio_chip *gc;
3059 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3060 * requires this function to not return zero on an invalid descriptor
3061 * but rather a negative error number.
3063 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3066 gc = desc->gdev->chip;
3067 offset = gpio_chip_hwgpio(desc);
3069 int retirq = gc->to_irq(gc, offset);
3071 /* Zero means NO_IRQ */
3079 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3082 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3083 * @gc: the chip the GPIO to lock belongs to
3084 * @offset: the offset of the GPIO to lock as IRQ
3086 * This is used directly by GPIO drivers that want to lock down
3087 * a certain GPIO line to be used for IRQs.
3089 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3091 struct gpio_desc *desc;
3093 desc = gpiochip_get_desc(gc, offset);
3095 return PTR_ERR(desc);
3098 * If it's fast: flush the direction setting if something changed
3101 if (!gc->can_sleep && gc->get_direction) {
3102 int dir = gpiod_get_direction(desc);
3105 chip_err(gc, "%s: cannot get GPIO direction\n",
3111 /* To be valid for IRQ the line needs to be input or open drain */
3112 if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3113 !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3115 "%s: tried to flag a GPIO set as output for IRQ\n",
3120 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3121 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3124 * If the consumer has not set up a label (such as when the
3125 * IRQ is referenced from .to_irq()) we set up a label here
3126 * so it is clear this is used as an interrupt.
3129 desc_set_label(desc, "interrupt");
3133 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3136 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3137 * @gc: the chip the GPIO to lock belongs to
3138 * @offset: the offset of the GPIO to lock as IRQ
3140 * This is used directly by GPIO drivers that want to indicate
3141 * that a certain GPIO is no longer used exclusively for IRQ.
3143 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3145 struct gpio_desc *desc;
3147 desc = gpiochip_get_desc(gc, offset);
3151 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3152 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3154 /* If we only had this marking, erase it */
3155 if (desc->label && !strcmp(desc->label, "interrupt"))
3156 desc_set_label(desc, NULL);
3158 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3160 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3162 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3164 if (!IS_ERR(desc) &&
3165 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3166 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3168 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3170 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3172 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3174 if (!IS_ERR(desc) &&
3175 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3177 * We must not be output when using IRQ UNLESS we are
3180 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3181 !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3182 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3185 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3187 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3189 if (offset >= gc->ngpio)
3192 return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3194 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3196 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3200 if (!try_module_get(gc->gpiodev->owner))
3203 ret = gpiochip_lock_as_irq(gc, offset);
3205 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3206 module_put(gc->gpiodev->owner);
3211 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3213 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3215 gpiochip_unlock_as_irq(gc, offset);
3216 module_put(gc->gpiodev->owner);
3218 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3220 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3222 if (offset >= gc->ngpio)
3225 return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3227 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3229 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3231 if (offset >= gc->ngpio)
3234 return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3236 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3238 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3240 if (offset >= gc->ngpio)
3243 return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3245 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3248 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3249 * @desc: gpio whose value will be returned
3251 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3252 * its ACTIVE_LOW status, or negative errno on failure.
3254 * This function is to be called from contexts that can sleep.
3256 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3258 might_sleep_if(extra_checks);
3259 VALIDATE_DESC(desc);
3260 return gpiod_get_raw_value_commit(desc);
3262 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3265 * gpiod_get_value_cansleep() - return a gpio's value
3266 * @desc: gpio whose value will be returned
3268 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3269 * account, or negative errno on failure.
3271 * This function is to be called from contexts that can sleep.
3273 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3277 might_sleep_if(extra_checks);
3278 VALIDATE_DESC(desc);
3279 value = gpiod_get_raw_value_commit(desc);
3283 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3288 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3291 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3292 * @array_size: number of elements in the descriptor array / value bitmap
3293 * @desc_array: array of GPIO descriptors whose values will be read
3294 * @array_info: information on applicability of fast bitmap processing path
3295 * @value_bitmap: bitmap to store the read values
3297 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3298 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3299 * else an error code.
3301 * This function is to be called from contexts that can sleep.
3303 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3304 struct gpio_desc **desc_array,
3305 struct gpio_array *array_info,
3306 unsigned long *value_bitmap)
3308 might_sleep_if(extra_checks);
3311 return gpiod_get_array_value_complex(true, true, array_size,
3312 desc_array, array_info,
3315 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3318 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3319 * @array_size: number of elements in the descriptor array / value bitmap
3320 * @desc_array: array of GPIO descriptors whose values will be read
3321 * @array_info: information on applicability of fast bitmap processing path
3322 * @value_bitmap: bitmap to store the read values
3324 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3325 * into account. Return 0 in case of success, else an error code.
3327 * This function is to be called from contexts that can sleep.
3329 int gpiod_get_array_value_cansleep(unsigned int array_size,
3330 struct gpio_desc **desc_array,
3331 struct gpio_array *array_info,
3332 unsigned long *value_bitmap)
3334 might_sleep_if(extra_checks);
3337 return gpiod_get_array_value_complex(false, true, array_size,
3338 desc_array, array_info,
3341 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3344 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3345 * @desc: gpio whose value will be assigned
3346 * @value: value to assign
3348 * Set the raw value of the GPIO, i.e. the value of its physical line without
3349 * regard for its ACTIVE_LOW status.
3351 * This function is to be called from contexts that can sleep.
3353 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3355 might_sleep_if(extra_checks);
3356 VALIDATE_DESC_VOID(desc);
3357 gpiod_set_raw_value_commit(desc, value);
3359 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3362 * gpiod_set_value_cansleep() - assign a gpio's value
3363 * @desc: gpio whose value will be assigned
3364 * @value: value to assign
3366 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3369 * This function is to be called from contexts that can sleep.
3371 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3373 might_sleep_if(extra_checks);
3374 VALIDATE_DESC_VOID(desc);
3375 gpiod_set_value_nocheck(desc, value);
3377 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3380 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3381 * @array_size: number of elements in the descriptor array / value bitmap
3382 * @desc_array: array of GPIO descriptors whose values will be assigned
3383 * @array_info: information on applicability of fast bitmap processing path
3384 * @value_bitmap: bitmap of values to assign
3386 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3387 * without regard for their ACTIVE_LOW status.
3389 * This function is to be called from contexts that can sleep.
3391 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3392 struct gpio_desc **desc_array,
3393 struct gpio_array *array_info,
3394 unsigned long *value_bitmap)
3396 might_sleep_if(extra_checks);
3399 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3400 array_info, value_bitmap);
3402 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3405 * gpiod_add_lookup_tables() - register GPIO device consumers
3406 * @tables: list of tables of consumers to register
3407 * @n: number of tables in the list
3409 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3413 mutex_lock(&gpio_lookup_lock);
3415 for (i = 0; i < n; i++)
3416 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3418 mutex_unlock(&gpio_lookup_lock);
3422 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3423 * @array_size: number of elements in the descriptor array / value bitmap
3424 * @desc_array: array of GPIO descriptors whose values will be assigned
3425 * @array_info: information on applicability of fast bitmap processing path
3426 * @value_bitmap: bitmap of values to assign
3428 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3431 * This function is to be called from contexts that can sleep.
3433 int gpiod_set_array_value_cansleep(unsigned int array_size,
3434 struct gpio_desc **desc_array,
3435 struct gpio_array *array_info,
3436 unsigned long *value_bitmap)
3438 might_sleep_if(extra_checks);
3441 return gpiod_set_array_value_complex(false, true, array_size,
3442 desc_array, array_info,
3445 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3448 * gpiod_add_lookup_table() - register GPIO device consumers
3449 * @table: table of consumers to register
3451 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3453 mutex_lock(&gpio_lookup_lock);
3455 list_add_tail(&table->list, &gpio_lookup_list);
3457 mutex_unlock(&gpio_lookup_lock);
3459 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3462 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3463 * @table: table of consumers to unregister
3465 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3467 /* Nothing to remove */
3471 mutex_lock(&gpio_lookup_lock);
3473 list_del(&table->list);
3475 mutex_unlock(&gpio_lookup_lock);
3477 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3480 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3481 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3483 void gpiod_add_hogs(struct gpiod_hog *hogs)
3485 struct gpio_chip *gc;
3486 struct gpiod_hog *hog;
3488 mutex_lock(&gpio_machine_hogs_mutex);
3490 for (hog = &hogs[0]; hog->chip_label; hog++) {
3491 list_add_tail(&hog->list, &gpio_machine_hogs);
3494 * The chip may have been registered earlier, so check if it
3495 * exists and, if so, try to hog the line now.
3497 gc = find_chip_by_name(hog->chip_label);
3499 gpiochip_machine_hog(gc, hog);
3502 mutex_unlock(&gpio_machine_hogs_mutex);
3504 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3506 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3508 const char *dev_id = dev ? dev_name(dev) : NULL;
3509 struct gpiod_lookup_table *table;
3511 mutex_lock(&gpio_lookup_lock);
3513 list_for_each_entry(table, &gpio_lookup_list, list) {
3514 if (table->dev_id && dev_id) {
3516 * Valid strings on both ends, must be identical to have
3519 if (!strcmp(table->dev_id, dev_id))
3523 * One of the pointers is NULL, so both must be to have
3526 if (dev_id == table->dev_id)
3533 mutex_unlock(&gpio_lookup_lock);
3537 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3538 unsigned int idx, unsigned long *flags)
3540 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3541 struct gpiod_lookup_table *table;
3542 struct gpiod_lookup *p;
3544 table = gpiod_find_lookup_table(dev);
3548 for (p = &table->table[0]; p->key; p++) {
3549 struct gpio_chip *gc;
3551 /* idx must always match exactly */
3555 /* If the lookup entry has a con_id, require exact match */
3556 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3559 if (p->chip_hwnum == U16_MAX) {
3560 desc = gpio_name_to_desc(p->key);
3566 dev_warn(dev, "cannot find GPIO line %s, deferring\n",
3568 return ERR_PTR(-EPROBE_DEFER);
3571 gc = find_chip_by_name(p->key);
3575 * As the lookup table indicates a chip with
3576 * p->key should exist, assume it may
3577 * still appear later and let the interested
3578 * consumer be probed again or let the Deferred
3579 * Probe infrastructure handle the error.
3581 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3583 return ERR_PTR(-EPROBE_DEFER);
3586 if (gc->ngpio <= p->chip_hwnum) {
3588 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3589 idx, p->chip_hwnum, gc->ngpio - 1,
3591 return ERR_PTR(-EINVAL);
3594 desc = gpiochip_get_desc(gc, p->chip_hwnum);
3603 static int platform_gpio_count(struct device *dev, const char *con_id)
3605 struct gpiod_lookup_table *table;
3606 struct gpiod_lookup *p;
3607 unsigned int count = 0;
3609 table = gpiod_find_lookup_table(dev);
3613 for (p = &table->table[0]; p->key; p++) {
3614 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3615 (!con_id && !p->con_id))
3625 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3626 * @fwnode: handle of the firmware node
3627 * @con_id: function within the GPIO consumer
3628 * @index: index of the GPIO to obtain for the consumer
3629 * @flags: GPIO initialization flags
3630 * @label: label to attach to the requested GPIO
3632 * This function can be used for drivers that get their configuration
3633 * from opaque firmware.
3635 * The function properly finds the corresponding GPIO using whatever is the
3636 * underlying firmware interface and then makes sure that the GPIO
3637 * descriptor is requested before it is returned to the caller.
3640 * On successful request the GPIO pin is configured in accordance with
3643 * In case of error an ERR_PTR() is returned.
3645 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
3646 const char *con_id, int index,
3647 enum gpiod_flags flags,
3650 struct gpio_desc *desc;
3651 char prop_name[32]; /* 32 is max size of property name */
3654 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3656 snprintf(prop_name, sizeof(prop_name), "%s-%s",
3657 con_id, gpio_suffixes[i]);
3659 snprintf(prop_name, sizeof(prop_name), "%s",
3662 desc = fwnode_get_named_gpiod(fwnode, prop_name, index, flags,
3664 if (!gpiod_not_found(desc))
3670 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
3673 * gpiod_count - return the number of GPIOs associated with a device / function
3674 * or -ENOENT if no GPIO has been assigned to the requested function
3675 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3676 * @con_id: function within the GPIO consumer
3678 int gpiod_count(struct device *dev, const char *con_id)
3680 int count = -ENOENT;
3682 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3683 count = of_gpio_get_count(dev, con_id);
3684 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3685 count = acpi_gpio_count(dev, con_id);
3688 count = platform_gpio_count(dev, con_id);
3692 EXPORT_SYMBOL_GPL(gpiod_count);
3695 * gpiod_get - obtain a GPIO for a given GPIO function
3696 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3697 * @con_id: function within the GPIO consumer
3698 * @flags: optional GPIO initialization flags
3700 * Return the GPIO descriptor corresponding to the function con_id of device
3701 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3702 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3704 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3705 enum gpiod_flags flags)
3707 return gpiod_get_index(dev, con_id, 0, flags);
3709 EXPORT_SYMBOL_GPL(gpiod_get);
3712 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3713 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3714 * @con_id: function within the GPIO consumer
3715 * @flags: optional GPIO initialization flags
3717 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3718 * the requested function it will return NULL. This is convenient for drivers
3719 * that need to handle optional GPIOs.
3721 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3723 enum gpiod_flags flags)
3725 return gpiod_get_index_optional(dev, con_id, 0, flags);
3727 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3731 * gpiod_configure_flags - helper function to configure a given GPIO
3732 * @desc: gpio whose value will be assigned
3733 * @con_id: function within the GPIO consumer
3734 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3735 * of_find_gpio() or of_get_gpio_hog()
3736 * @dflags: gpiod_flags - optional GPIO initialization flags
3738 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3739 * requested function and/or index, or another IS_ERR() code if an error
3740 * occurred while trying to acquire the GPIO.
3742 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3743 unsigned long lflags, enum gpiod_flags dflags)
3747 if (lflags & GPIO_ACTIVE_LOW)
3748 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3750 if (lflags & GPIO_OPEN_DRAIN)
3751 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3752 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3754 * This enforces open drain mode from the consumer side.
3755 * This is necessary for some busses like I2C, but the lookup
3756 * should *REALLY* have specified them as open drain in the
3757 * first place, so print a little warning here.
3759 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3761 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3764 if (lflags & GPIO_OPEN_SOURCE)
3765 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3767 if ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) {
3769 "both pull-up and pull-down enabled, invalid configuration\n");
3773 if (lflags & GPIO_PULL_UP)
3774 set_bit(FLAG_PULL_UP, &desc->flags);
3775 else if (lflags & GPIO_PULL_DOWN)
3776 set_bit(FLAG_PULL_DOWN, &desc->flags);
3778 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
3782 /* No particular flag request, return here... */
3783 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3784 gpiod_dbg(desc, "no flags found for %s\n", con_id);
3789 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3790 ret = gpiod_direction_output(desc,
3791 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3793 ret = gpiod_direction_input(desc);
3799 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3800 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3801 * @con_id: function within the GPIO consumer
3802 * @idx: index of the GPIO to obtain in the consumer
3803 * @flags: optional GPIO initialization flags
3805 * This variant of gpiod_get() allows to access GPIOs other than the first
3806 * defined one for functions that define several GPIOs.
3808 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3809 * requested function and/or index, or another IS_ERR() code if an error
3810 * occurred while trying to acquire the GPIO.
3812 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3815 enum gpiod_flags flags)
3817 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3818 struct gpio_desc *desc = NULL;
3820 /* Maybe we have a device name, maybe not */
3821 const char *devname = dev ? dev_name(dev) : "?";
3823 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3826 /* Using device tree? */
3827 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3828 dev_dbg(dev, "using device tree for GPIO lookup\n");
3829 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3830 } else if (ACPI_COMPANION(dev)) {
3831 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3832 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3837 * Either we are not using DT or ACPI, or their lookup did not return
3838 * a result. In that case, use platform lookup as a fallback.
3840 if (!desc || gpiod_not_found(desc)) {
3841 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3842 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3846 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
3851 * If a connection label was passed use that, else attempt to use
3852 * the device name as label
3854 ret = gpiod_request(desc, con_id ? con_id : devname);
3856 if (ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
3858 * This happens when there are several consumers for
3859 * the same GPIO line: we just return here without
3860 * further initialization. It is a bit if a hack.
3861 * This is necessary to support fixed regulators.
3863 * FIXME: Make this more sane and safe.
3865 dev_info(dev, "nonexclusive access to GPIO for %s\n",
3866 con_id ? con_id : devname);
3869 return ERR_PTR(ret);
3873 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3875 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3877 return ERR_PTR(ret);
3880 blocking_notifier_call_chain(&desc->gdev->notifier,
3881 GPIOLINE_CHANGED_REQUESTED, desc);
3885 EXPORT_SYMBOL_GPL(gpiod_get_index);
3888 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3889 * @fwnode: handle of the firmware node
3890 * @propname: name of the firmware property representing the GPIO
3891 * @index: index of the GPIO to obtain for the consumer
3892 * @dflags: GPIO initialization flags
3893 * @label: label to attach to the requested GPIO
3895 * This function can be used for drivers that get their configuration
3896 * from opaque firmware.
3898 * The function properly finds the corresponding GPIO using whatever is the
3899 * underlying firmware interface and then makes sure that the GPIO
3900 * descriptor is requested before it is returned to the caller.
3903 * On successful request the GPIO pin is configured in accordance with
3906 * In case of error an ERR_PTR() is returned.
3908 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3909 const char *propname, int index,
3910 enum gpiod_flags dflags,
3913 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3914 struct gpio_desc *desc = ERR_PTR(-ENODEV);
3918 return ERR_PTR(-EINVAL);
3920 if (is_of_node(fwnode)) {
3921 desc = gpiod_get_from_of_node(to_of_node(fwnode),
3926 } else if (is_acpi_node(fwnode)) {
3927 struct acpi_gpio_info info;
3929 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
3933 acpi_gpio_update_gpiod_flags(&dflags, &info);
3934 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
3937 /* Currently only ACPI takes this path */
3938 ret = gpiod_request(desc, label);
3940 return ERR_PTR(ret);
3942 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3945 return ERR_PTR(ret);
3948 blocking_notifier_call_chain(&desc->gdev->notifier,
3949 GPIOLINE_CHANGED_REQUESTED, desc);
3953 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3956 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3958 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3959 * @con_id: function within the GPIO consumer
3960 * @index: index of the GPIO to obtain in the consumer
3961 * @flags: optional GPIO initialization flags
3963 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3964 * specified index was assigned to the requested function it will return NULL.
3965 * This is convenient for drivers that need to handle optional GPIOs.
3967 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
3970 enum gpiod_flags flags)
3972 struct gpio_desc *desc;
3974 desc = gpiod_get_index(dev, con_id, index, flags);
3975 if (gpiod_not_found(desc))
3980 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
3983 * gpiod_hog - Hog the specified GPIO desc given the provided flags
3984 * @desc: gpio whose value will be assigned
3985 * @name: gpio line name
3986 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3987 * of_find_gpio() or of_get_gpio_hog()
3988 * @dflags: gpiod_flags - optional GPIO initialization flags
3990 int gpiod_hog(struct gpio_desc *desc, const char *name,
3991 unsigned long lflags, enum gpiod_flags dflags)
3993 struct gpio_chip *gc;
3994 struct gpio_desc *local_desc;
3998 gc = gpiod_to_chip(desc);
3999 hwnum = gpio_chip_hwgpio(desc);
4001 local_desc = gpiochip_request_own_desc(gc, hwnum, name,
4003 if (IS_ERR(local_desc)) {
4004 ret = PTR_ERR(local_desc);
4005 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4006 name, gc->label, hwnum, ret);
4010 /* Mark GPIO as hogged so it can be identified and removed later */
4011 set_bit(FLAG_IS_HOGGED, &desc->flags);
4013 gpiod_info(desc, "hogged as %s%s\n",
4014 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4015 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4016 (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4022 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4023 * @gc: gpio chip to act on
4025 static void gpiochip_free_hogs(struct gpio_chip *gc)
4029 for (id = 0; id < gc->ngpio; id++) {
4030 if (test_bit(FLAG_IS_HOGGED, &gc->gpiodev->descs[id].flags))
4031 gpiochip_free_own_desc(&gc->gpiodev->descs[id]);
4036 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4037 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4038 * @con_id: function within the GPIO consumer
4039 * @flags: optional GPIO initialization flags
4041 * This function acquires all the GPIOs defined under a given function.
4043 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4044 * no GPIO has been assigned to the requested function, or another IS_ERR()
4045 * code if an error occurred while trying to acquire the GPIOs.
4047 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4049 enum gpiod_flags flags)
4051 struct gpio_desc *desc;
4052 struct gpio_descs *descs;
4053 struct gpio_array *array_info = NULL;
4054 struct gpio_chip *gc;
4055 int count, bitmap_size;
4057 count = gpiod_count(dev, con_id);
4059 return ERR_PTR(count);
4061 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4063 return ERR_PTR(-ENOMEM);
4065 for (descs->ndescs = 0; descs->ndescs < count; ) {
4066 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4068 gpiod_put_array(descs);
4069 return ERR_CAST(desc);
4072 descs->desc[descs->ndescs] = desc;
4074 gc = gpiod_to_chip(desc);
4076 * If pin hardware number of array member 0 is also 0, select
4077 * its chip as a candidate for fast bitmap processing path.
4079 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4080 struct gpio_descs *array;
4082 bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4085 array = kzalloc(struct_size(descs, desc, count) +
4086 struct_size(array_info, invert_mask,
4087 3 * bitmap_size), GFP_KERNEL);
4089 gpiod_put_array(descs);
4090 return ERR_PTR(-ENOMEM);
4093 memcpy(array, descs,
4094 struct_size(descs, desc, descs->ndescs + 1));
4098 array_info = (void *)(descs->desc + count);
4099 array_info->get_mask = array_info->invert_mask +
4101 array_info->set_mask = array_info->get_mask +
4104 array_info->desc = descs->desc;
4105 array_info->size = count;
4106 array_info->chip = gc;
4107 bitmap_set(array_info->get_mask, descs->ndescs,
4108 count - descs->ndescs);
4109 bitmap_set(array_info->set_mask, descs->ndescs,
4110 count - descs->ndescs);
4111 descs->info = array_info;
4113 /* Unmark array members which don't belong to the 'fast' chip */
4114 if (array_info && array_info->chip != gc) {
4115 __clear_bit(descs->ndescs, array_info->get_mask);
4116 __clear_bit(descs->ndescs, array_info->set_mask);
4119 * Detect array members which belong to the 'fast' chip
4120 * but their pins are not in hardware order.
4122 else if (array_info &&
4123 gpio_chip_hwgpio(desc) != descs->ndescs) {
4125 * Don't use fast path if all array members processed so
4126 * far belong to the same chip as this one but its pin
4127 * hardware number is different from its array index.
4129 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4132 __clear_bit(descs->ndescs,
4133 array_info->get_mask);
4134 __clear_bit(descs->ndescs,
4135 array_info->set_mask);
4137 } else if (array_info) {
4138 /* Exclude open drain or open source from fast output */
4139 if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4140 gpiochip_line_is_open_source(gc, descs->ndescs))
4141 __clear_bit(descs->ndescs,
4142 array_info->set_mask);
4143 /* Identify 'fast' pins which require invertion */
4144 if (gpiod_is_active_low(desc))
4145 __set_bit(descs->ndescs,
4146 array_info->invert_mask);
4153 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4154 array_info->chip->label, array_info->size,
4155 *array_info->get_mask, *array_info->set_mask,
4156 *array_info->invert_mask);
4159 EXPORT_SYMBOL_GPL(gpiod_get_array);
4162 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4164 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4165 * @con_id: function within the GPIO consumer
4166 * @flags: optional GPIO initialization flags
4168 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4169 * assigned to the requested function it will return NULL.
4171 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4173 enum gpiod_flags flags)
4175 struct gpio_descs *descs;
4177 descs = gpiod_get_array(dev, con_id, flags);
4178 if (gpiod_not_found(descs))
4183 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4186 * gpiod_put - dispose of a GPIO descriptor
4187 * @desc: GPIO descriptor to dispose of
4189 * No descriptor can be used after gpiod_put() has been called on it.
4191 void gpiod_put(struct gpio_desc *desc)
4196 EXPORT_SYMBOL_GPL(gpiod_put);
4199 * gpiod_put_array - dispose of multiple GPIO descriptors
4200 * @descs: struct gpio_descs containing an array of descriptors
4202 void gpiod_put_array(struct gpio_descs *descs)
4206 for (i = 0; i < descs->ndescs; i++)
4207 gpiod_put(descs->desc[i]);
4211 EXPORT_SYMBOL_GPL(gpiod_put_array);
4214 static int gpio_bus_match(struct device *dev, struct device_driver *drv)
4217 * Only match if the fwnode doesn't already have a proper struct device
4220 if (dev->fwnode && dev->fwnode->dev != dev)
4225 static int gpio_stub_drv_probe(struct device *dev)
4228 * The DT node of some GPIO chips have a "compatible" property, but
4229 * never have a struct device added and probed by a driver to register
4230 * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4231 * the consumers of the GPIO chip to get probe deferred forever because
4232 * they will be waiting for a device associated with the GPIO chip
4233 * firmware node to get added and bound to a driver.
4235 * To allow these consumers to probe, we associate the struct
4236 * gpio_device of the GPIO chip with the firmware node and then simply
4237 * bind it to this stub driver.
4242 static struct device_driver gpio_stub_drv = {
4243 .name = "gpio_stub_drv",
4244 .bus = &gpio_bus_type,
4245 .probe = gpio_stub_drv_probe,
4248 static int __init gpiolib_dev_init(void)
4252 /* Register GPIO sysfs bus */
4253 ret = bus_register(&gpio_bus_type);
4255 pr_err("gpiolib: could not register GPIO bus type\n");
4259 if (driver_register(&gpio_stub_drv) < 0) {
4260 pr_err("gpiolib: could not register GPIO stub driver\n");
4261 bus_unregister(&gpio_bus_type);
4265 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4267 pr_err("gpiolib: failed to allocate char dev region\n");
4268 driver_unregister(&gpio_stub_drv);
4269 bus_unregister(&gpio_bus_type);
4273 gpiolib_initialized = true;
4274 gpiochip_setup_devs();
4276 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4277 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4278 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4282 core_initcall(gpiolib_dev_init);
4284 #ifdef CONFIG_DEBUG_FS
4286 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4289 struct gpio_chip *gc = gdev->chip;
4290 unsigned gpio = gdev->base;
4291 struct gpio_desc *gdesc = &gdev->descs[0];
4296 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4297 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4299 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4305 gpiod_get_direction(gdesc);
4306 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4307 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4308 active_low = test_bit(FLAG_ACTIVE_LOW, &gdesc->flags);
4309 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s",
4310 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4311 is_out ? "out" : "in ",
4312 gc->get ? (gc->get(gc, i) ? "hi" : "lo") : "? ",
4313 is_irq ? "IRQ " : "",
4314 active_low ? "ACTIVE LOW" : "");
4315 seq_printf(s, "\n");
4319 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4321 unsigned long flags;
4322 struct gpio_device *gdev = NULL;
4323 loff_t index = *pos;
4327 spin_lock_irqsave(&gpio_lock, flags);
4328 list_for_each_entry(gdev, &gpio_devices, list)
4330 spin_unlock_irqrestore(&gpio_lock, flags);
4333 spin_unlock_irqrestore(&gpio_lock, flags);
4338 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4340 unsigned long flags;
4341 struct gpio_device *gdev = v;
4344 spin_lock_irqsave(&gpio_lock, flags);
4345 if (list_is_last(&gdev->list, &gpio_devices))
4348 ret = list_entry(gdev->list.next, struct gpio_device, list);
4349 spin_unlock_irqrestore(&gpio_lock, flags);
4357 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4361 static int gpiolib_seq_show(struct seq_file *s, void *v)
4363 struct gpio_device *gdev = v;
4364 struct gpio_chip *gc = gdev->chip;
4365 struct device *parent;
4368 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4369 dev_name(&gdev->dev));
4373 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4374 dev_name(&gdev->dev),
4375 gdev->base, gdev->base + gdev->ngpio - 1);
4376 parent = gc->parent;
4378 seq_printf(s, ", parent: %s/%s",
4379 parent->bus ? parent->bus->name : "no-bus",
4382 seq_printf(s, ", %s", gc->label);
4384 seq_printf(s, ", can sleep");
4385 seq_printf(s, ":\n");
4388 gc->dbg_show(s, gc);
4390 gpiolib_dbg_show(s, gdev);
4395 static const struct seq_operations gpiolib_sops = {
4396 .start = gpiolib_seq_start,
4397 .next = gpiolib_seq_next,
4398 .stop = gpiolib_seq_stop,
4399 .show = gpiolib_seq_show,
4401 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4403 static int __init gpiolib_debugfs_init(void)
4405 /* /sys/kernel/debug/gpio */
4406 debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4409 subsys_initcall(gpiolib_debugfs_init);
4411 #endif /* DEBUG_FS */