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)
574 struct fwnode_handle *fwnode = gc->parent ? dev_fwnode(gc->parent) : NULL;
579 struct gpio_device *gdev;
582 * First: allocate and populate the internal stat container, and
583 * set up the struct device.
585 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
588 gdev->dev.bus = &gpio_bus_type;
589 gdev->dev.parent = gc->parent;
593 of_gpio_dev_init(gc, gdev);
594 acpi_gpio_dev_init(gc, gdev);
597 * Assign fwnode depending on the result of the previous calls,
598 * if none of them succeed, assign it to the parent's one.
600 gdev->dev.fwnode = dev_fwnode(&gdev->dev) ?: fwnode;
602 gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
608 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
612 device_initialize(&gdev->dev);
613 if (gc->parent && gc->parent->driver)
614 gdev->owner = gc->parent->driver->owner;
616 /* TODO: remove chip->owner */
617 gdev->owner = gc->owner;
619 gdev->owner = THIS_MODULE;
621 gdev->descs = kcalloc(gc->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
624 goto err_free_dev_name;
627 if (gc->ngpio == 0) {
628 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
633 if (gc->ngpio > FASTPATH_NGPIO)
634 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
635 gc->ngpio, FASTPATH_NGPIO);
637 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
643 gdev->ngpio = gc->ngpio;
646 spin_lock_irqsave(&gpio_lock, flags);
649 * TODO: this allocates a Linux GPIO number base in the global
650 * GPIO numberspace for this chip. In the long run we want to
651 * get *rid* of this numberspace and use only descriptors, but
652 * it may be a pipe dream. It will not happen before we get rid
653 * of the sysfs interface anyways.
656 base = gpiochip_find_base(gc->ngpio);
659 spin_unlock_irqrestore(&gpio_lock, flags);
663 * TODO: it should not be necessary to reflect the assigned
664 * base outside of the GPIO subsystem. Go over drivers and
665 * see if anyone makes use of this, else drop this and assign
672 ret = gpiodev_add_to_list(gdev);
674 spin_unlock_irqrestore(&gpio_lock, flags);
678 for (i = 0; i < gc->ngpio; i++)
679 gdev->descs[i].gdev = gdev;
681 spin_unlock_irqrestore(&gpio_lock, flags);
683 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->notifier);
685 #ifdef CONFIG_PINCTRL
686 INIT_LIST_HEAD(&gdev->pin_ranges);
690 ret = gpiochip_set_desc_names(gc);
692 ret = devprop_gpiochip_set_names(gc);
694 goto err_remove_from_list;
696 ret = gpiochip_alloc_valid_mask(gc);
698 goto err_remove_from_list;
700 ret = of_gpiochip_add(gc);
702 goto err_free_gpiochip_mask;
704 ret = gpiochip_init_valid_mask(gc);
706 goto err_remove_of_chip;
708 for (i = 0; i < gc->ngpio; i++) {
709 struct gpio_desc *desc = &gdev->descs[i];
711 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
712 assign_bit(FLAG_IS_OUT,
713 &desc->flags, !gc->get_direction(gc, i));
715 assign_bit(FLAG_IS_OUT,
716 &desc->flags, !gc->direction_input);
720 ret = gpiochip_add_pin_ranges(gc);
722 goto err_remove_of_chip;
724 acpi_gpiochip_add(gc);
726 machine_gpiochip_add(gc);
728 ret = gpiochip_irqchip_init_valid_mask(gc);
730 goto err_remove_acpi_chip;
732 ret = gpiochip_irqchip_init_hw(gc);
734 goto err_remove_acpi_chip;
736 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
738 goto err_remove_irqchip_mask;
741 * By first adding the chardev, and then adding the device,
742 * we get a device node entry in sysfs under
743 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
744 * coldplug of device nodes and other udev business.
745 * We can do this only if gpiolib has been initialized.
746 * Otherwise, defer until later.
748 if (gpiolib_initialized) {
749 ret = gpiochip_setup_dev(gdev);
751 goto err_remove_irqchip;
756 gpiochip_irqchip_remove(gc);
757 err_remove_irqchip_mask:
758 gpiochip_irqchip_free_valid_mask(gc);
759 err_remove_acpi_chip:
760 acpi_gpiochip_remove(gc);
762 gpiochip_free_hogs(gc);
763 of_gpiochip_remove(gc);
764 err_free_gpiochip_mask:
765 gpiochip_remove_pin_ranges(gc);
766 gpiochip_free_valid_mask(gc);
767 err_remove_from_list:
768 spin_lock_irqsave(&gpio_lock, flags);
769 list_del(&gdev->list);
770 spin_unlock_irqrestore(&gpio_lock, flags);
772 kfree_const(gdev->label);
776 kfree(dev_name(&gdev->dev));
778 ida_free(&gpio_ida, gdev->id);
780 /* failures here can mean systems won't boot... */
781 if (ret != -EPROBE_DEFER) {
782 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
783 gdev->base, gdev->base + gdev->ngpio - 1,
784 gc->label ? : "generic", ret);
789 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
792 * gpiochip_get_data() - get per-subdriver data for the chip
796 * The per-subdriver data for the chip.
798 void *gpiochip_get_data(struct gpio_chip *gc)
800 return gc->gpiodev->data;
802 EXPORT_SYMBOL_GPL(gpiochip_get_data);
805 * gpiochip_remove() - unregister a gpio_chip
806 * @gc: the chip to unregister
808 * A gpio_chip with any GPIOs still requested may not be removed.
810 void gpiochip_remove(struct gpio_chip *gc)
812 struct gpio_device *gdev = gc->gpiodev;
816 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
817 gpiochip_sysfs_unregister(gdev);
818 gpiochip_free_hogs(gc);
819 /* Numb the device, cancelling all outstanding operations */
821 gpiochip_irqchip_remove(gc);
822 acpi_gpiochip_remove(gc);
823 of_gpiochip_remove(gc);
824 gpiochip_remove_pin_ranges(gc);
825 gpiochip_free_valid_mask(gc);
827 * We accept no more calls into the driver from this point, so
828 * NULL the driver data pointer
832 spin_lock_irqsave(&gpio_lock, flags);
833 for (i = 0; i < gdev->ngpio; i++) {
834 if (gpiochip_is_requested(gc, i))
837 spin_unlock_irqrestore(&gpio_lock, flags);
839 if (i != gdev->ngpio)
841 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
844 * The gpiochip side puts its use of the device to rest here:
845 * if there are no userspace clients, the chardev and device will
846 * be removed, else it will be dangling until the last user is
849 gcdev_unregister(gdev);
850 put_device(&gdev->dev);
852 EXPORT_SYMBOL_GPL(gpiochip_remove);
855 * gpiochip_find() - iterator for locating a specific gpio_chip
856 * @data: data to pass to match function
857 * @match: Callback function to check gpio_chip
859 * Similar to bus_find_device. It returns a reference to a gpio_chip as
860 * determined by a user supplied @match callback. The callback should return
861 * 0 if the device doesn't match and non-zero if it does. If the callback is
862 * non-zero, this function will return to the caller and not iterate over any
865 struct gpio_chip *gpiochip_find(void *data,
866 int (*match)(struct gpio_chip *gc,
869 struct gpio_device *gdev;
870 struct gpio_chip *gc = NULL;
873 spin_lock_irqsave(&gpio_lock, flags);
874 list_for_each_entry(gdev, &gpio_devices, list)
875 if (gdev->chip && match(gdev->chip, data)) {
880 spin_unlock_irqrestore(&gpio_lock, flags);
884 EXPORT_SYMBOL_GPL(gpiochip_find);
886 static int gpiochip_match_name(struct gpio_chip *gc, void *data)
888 const char *name = data;
890 return !strcmp(gc->label, name);
893 static struct gpio_chip *find_chip_by_name(const char *name)
895 return gpiochip_find((void *)name, gpiochip_match_name);
898 #ifdef CONFIG_GPIOLIB_IRQCHIP
901 * The following is irqchip helper code for gpiochips.
904 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
906 struct gpio_irq_chip *girq = &gc->irq;
911 return girq->init_hw(gc);
914 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
916 struct gpio_irq_chip *girq = &gc->irq;
918 if (!girq->init_valid_mask)
921 girq->valid_mask = gpiochip_allocate_mask(gc);
922 if (!girq->valid_mask)
925 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
930 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
932 bitmap_free(gc->irq.valid_mask);
933 gc->irq.valid_mask = NULL;
936 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
939 if (!gpiochip_line_is_valid(gc, offset))
941 /* No mask means all valid */
942 if (likely(!gc->irq.valid_mask))
944 return test_bit(offset, gc->irq.valid_mask);
946 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
948 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
951 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
953 * @gc: the gpiochip to set the irqchip hierarchical handler to
954 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
955 * will then percolate up to the parent
957 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
958 struct irq_chip *irqchip)
960 /* DT will deal with mapping each IRQ as we go along */
961 if (is_of_node(gc->irq.fwnode))
965 * This is for legacy and boardfile "irqchip" fwnodes: allocate
966 * irqs upfront instead of dynamically since we don't have the
967 * dynamic type of allocation that hardware description languages
968 * provide. Once all GPIO drivers using board files are gone from
969 * the kernel we can delete this code, but for a transitional period
970 * it is necessary to keep this around.
972 if (is_fwnode_irqchip(gc->irq.fwnode)) {
976 for (i = 0; i < gc->ngpio; i++) {
977 struct irq_fwspec fwspec;
978 unsigned int parent_hwirq;
979 unsigned int parent_type;
980 struct gpio_irq_chip *girq = &gc->irq;
983 * We call the child to parent translation function
984 * only to check if the child IRQ is valid or not.
985 * Just pick the rising edge type here as that is what
986 * we likely need to support.
988 ret = girq->child_to_parent_hwirq(gc, i,
989 IRQ_TYPE_EDGE_RISING,
993 chip_err(gc, "skip set-up on hwirq %d\n",
998 fwspec.fwnode = gc->irq.fwnode;
999 /* This is the hwirq for the GPIO line side of things */
1000 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
1001 /* Just pick something */
1002 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
1003 fwspec.param_count = 2;
1004 ret = __irq_domain_alloc_irqs(gc->irq.domain,
1005 /* just pick something */
1014 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1021 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1026 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1027 struct irq_fwspec *fwspec,
1028 unsigned long *hwirq,
1031 /* We support standard DT translation */
1032 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1033 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1036 /* This is for board files and others not using DT */
1037 if (is_fwnode_irqchip(fwspec->fwnode)) {
1040 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1043 WARN_ON(*type == IRQ_TYPE_NONE);
1049 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1051 unsigned int nr_irqs,
1054 struct gpio_chip *gc = d->host_data;
1055 irq_hw_number_t hwirq;
1056 unsigned int type = IRQ_TYPE_NONE;
1057 struct irq_fwspec *fwspec = data;
1059 unsigned int parent_hwirq;
1060 unsigned int parent_type;
1061 struct gpio_irq_chip *girq = &gc->irq;
1065 * The nr_irqs parameter is always one except for PCI multi-MSI
1066 * so this should not happen.
1068 WARN_ON(nr_irqs != 1);
1070 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1074 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1076 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1077 &parent_hwirq, &parent_type);
1079 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1082 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1085 * We set handle_bad_irq because the .set_type() should
1086 * always be invoked and set the right type of handler.
1088 irq_domain_set_info(d,
1097 /* This parent only handles asserted level IRQs */
1098 parent_arg = girq->populate_parent_alloc_arg(gc, parent_hwirq, parent_type);
1102 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1104 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1105 ret = irq_domain_alloc_irqs_parent(d, irq, 1, parent_arg);
1107 * If the parent irqdomain is msi, the interrupts have already
1108 * been allocated, so the EEXIST is good.
1110 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1114 "failed to allocate parent hwirq %d for hwirq %lu\n",
1115 parent_hwirq, hwirq);
1121 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1122 unsigned int offset)
1127 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1129 ops->activate = gpiochip_irq_domain_activate;
1130 ops->deactivate = gpiochip_irq_domain_deactivate;
1131 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1132 ops->free = irq_domain_free_irqs_common;
1135 * We only allow overriding the translate() function for
1136 * hierarchical chips, and this should only be done if the user
1137 * really need something other than 1:1 translation.
1139 if (!ops->translate)
1140 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1143 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1145 if (!gc->irq.child_to_parent_hwirq ||
1147 chip_err(gc, "missing irqdomain vital data\n");
1151 if (!gc->irq.child_offset_to_irq)
1152 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1154 if (!gc->irq.populate_parent_alloc_arg)
1155 gc->irq.populate_parent_alloc_arg =
1156 gpiochip_populate_parent_fwspec_twocell;
1158 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1160 gc->irq.domain = irq_domain_create_hierarchy(
1161 gc->irq.parent_domain,
1165 &gc->irq.child_irq_domain_ops,
1168 if (!gc->irq.domain)
1171 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1176 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1178 return !!gc->irq.parent_domain;
1181 void *gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1182 unsigned int parent_hwirq,
1183 unsigned int parent_type)
1185 struct irq_fwspec *fwspec;
1187 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1191 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1192 fwspec->param_count = 2;
1193 fwspec->param[0] = parent_hwirq;
1194 fwspec->param[1] = parent_type;
1198 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1200 void *gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1201 unsigned int parent_hwirq,
1202 unsigned int parent_type)
1204 struct irq_fwspec *fwspec;
1206 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1210 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1211 fwspec->param_count = 4;
1212 fwspec->param[0] = 0;
1213 fwspec->param[1] = parent_hwirq;
1214 fwspec->param[2] = 0;
1215 fwspec->param[3] = parent_type;
1219 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1223 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1228 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1233 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1236 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1237 * @d: the irqdomain used by this irqchip
1238 * @irq: the global irq number used by this GPIO irqchip irq
1239 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1241 * This function will set up the mapping for a certain IRQ line on a
1242 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1243 * stored inside the gpiochip.
1245 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1246 irq_hw_number_t hwirq)
1248 struct gpio_chip *gc = d->host_data;
1251 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1254 irq_set_chip_data(irq, gc);
1256 * This lock class tells lockdep that GPIO irqs are in a different
1257 * category than their parents, so it won't report false recursion.
1259 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1260 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1261 /* Chips that use nested thread handlers have them marked */
1262 if (gc->irq.threaded)
1263 irq_set_nested_thread(irq, 1);
1264 irq_set_noprobe(irq);
1266 if (gc->irq.num_parents == 1)
1267 ret = irq_set_parent(irq, gc->irq.parents[0]);
1268 else if (gc->irq.map)
1269 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1275 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1276 * is passed as default type.
1278 if (gc->irq.default_type != IRQ_TYPE_NONE)
1279 irq_set_irq_type(irq, gc->irq.default_type);
1283 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1285 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1287 struct gpio_chip *gc = d->host_data;
1289 if (gc->irq.threaded)
1290 irq_set_nested_thread(irq, 0);
1291 irq_set_chip_and_handler(irq, NULL, NULL);
1292 irq_set_chip_data(irq, NULL);
1294 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1296 static const struct irq_domain_ops gpiochip_domain_ops = {
1297 .map = gpiochip_irq_map,
1298 .unmap = gpiochip_irq_unmap,
1299 /* Virtually all GPIO irqchips are twocell:ed */
1300 .xlate = irq_domain_xlate_twocell,
1304 * TODO: move these activate/deactivate in under the hierarchicial
1305 * irqchip implementation as static once SPMI and SSBI (all external
1306 * users) are phased over.
1309 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1310 * @domain: The IRQ domain used by this IRQ chip
1311 * @data: Outermost irq_data associated with the IRQ
1312 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1314 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1315 * used as the activate function for the &struct irq_domain_ops. The host_data
1316 * for the IRQ domain must be the &struct gpio_chip.
1318 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1319 struct irq_data *data, bool reserve)
1321 struct gpio_chip *gc = domain->host_data;
1323 return gpiochip_lock_as_irq(gc, data->hwirq);
1325 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1328 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1329 * @domain: The IRQ domain used by this IRQ chip
1330 * @data: Outermost irq_data associated with the IRQ
1332 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1333 * be used as the deactivate function for the &struct irq_domain_ops. The
1334 * host_data for the IRQ domain must be the &struct gpio_chip.
1336 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1337 struct irq_data *data)
1339 struct gpio_chip *gc = domain->host_data;
1341 return gpiochip_unlock_as_irq(gc, data->hwirq);
1343 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1345 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1347 struct irq_domain *domain = gc->irq.domain;
1349 if (!gpiochip_irqchip_irq_valid(gc, offset))
1352 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1353 if (irq_domain_is_hierarchy(domain)) {
1354 struct irq_fwspec spec;
1356 spec.fwnode = domain->fwnode;
1357 spec.param_count = 2;
1358 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1359 spec.param[1] = IRQ_TYPE_NONE;
1361 return irq_create_fwspec_mapping(&spec);
1365 return irq_create_mapping(domain, offset);
1368 static int gpiochip_irq_reqres(struct irq_data *d)
1370 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1372 return gpiochip_reqres_irq(gc, d->hwirq);
1375 static void gpiochip_irq_relres(struct irq_data *d)
1377 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1379 gpiochip_relres_irq(gc, d->hwirq);
1382 static void gpiochip_irq_mask(struct irq_data *d)
1384 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1386 if (gc->irq.irq_mask)
1387 gc->irq.irq_mask(d);
1388 gpiochip_disable_irq(gc, d->hwirq);
1391 static void gpiochip_irq_unmask(struct irq_data *d)
1393 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1395 gpiochip_enable_irq(gc, d->hwirq);
1396 if (gc->irq.irq_unmask)
1397 gc->irq.irq_unmask(d);
1400 static void gpiochip_irq_enable(struct irq_data *d)
1402 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1404 gpiochip_enable_irq(gc, d->hwirq);
1405 gc->irq.irq_enable(d);
1408 static void gpiochip_irq_disable(struct irq_data *d)
1410 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1412 gc->irq.irq_disable(d);
1413 gpiochip_disable_irq(gc, d->hwirq);
1416 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1418 struct irq_chip *irqchip = gc->irq.chip;
1420 if (!irqchip->irq_request_resources &&
1421 !irqchip->irq_release_resources) {
1422 irqchip->irq_request_resources = gpiochip_irq_reqres;
1423 irqchip->irq_release_resources = gpiochip_irq_relres;
1425 if (WARN_ON(gc->irq.irq_enable))
1427 /* Check if the irqchip already has this hook... */
1428 if (irqchip->irq_enable == gpiochip_irq_enable ||
1429 irqchip->irq_mask == gpiochip_irq_mask) {
1431 * ...and if so, give a gentle warning that this is bad
1435 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1439 if (irqchip->irq_disable) {
1440 gc->irq.irq_disable = irqchip->irq_disable;
1441 irqchip->irq_disable = gpiochip_irq_disable;
1443 gc->irq.irq_mask = irqchip->irq_mask;
1444 irqchip->irq_mask = gpiochip_irq_mask;
1447 if (irqchip->irq_enable) {
1448 gc->irq.irq_enable = irqchip->irq_enable;
1449 irqchip->irq_enable = gpiochip_irq_enable;
1451 gc->irq.irq_unmask = irqchip->irq_unmask;
1452 irqchip->irq_unmask = gpiochip_irq_unmask;
1457 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1458 * @gc: the GPIO chip to add the IRQ chip to
1459 * @lock_key: lockdep class for IRQ lock
1460 * @request_key: lockdep class for IRQ request
1462 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1463 struct lock_class_key *lock_key,
1464 struct lock_class_key *request_key)
1466 struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
1467 struct irq_chip *irqchip = gc->irq.chip;
1474 if (gc->irq.parent_handler && gc->can_sleep) {
1475 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1479 type = gc->irq.default_type;
1482 * Specifying a default trigger is a terrible idea if DT or ACPI is
1483 * used to configure the interrupts, as you may end up with
1484 * conflicting triggers. Tell the user, and reset to NONE.
1486 if (WARN(fwnode && type != IRQ_TYPE_NONE,
1487 "%pfw: Ignoring %u default trigger\n", fwnode, type))
1488 type = IRQ_TYPE_NONE;
1491 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1493 gc->to_irq = gpiochip_to_irq;
1494 gc->irq.default_type = type;
1495 gc->irq.lock_key = lock_key;
1496 gc->irq.request_key = request_key;
1498 /* If a parent irqdomain is provided, let's build a hierarchy */
1499 if (gpiochip_hierarchy_is_hierarchical(gc)) {
1500 int ret = gpiochip_hierarchy_add_domain(gc);
1504 /* Some drivers provide custom irqdomain ops */
1505 gc->irq.domain = irq_domain_create_simple(fwnode,
1508 gc->irq.domain_ops ?: &gpiochip_domain_ops,
1510 if (!gc->irq.domain)
1514 if (gc->irq.parent_handler) {
1515 void *data = gc->irq.parent_handler_data ?: gc;
1517 for (i = 0; i < gc->irq.num_parents; i++) {
1519 * The parent IRQ chip is already using the chip_data
1520 * for this IRQ chip, so our callbacks simply use the
1523 irq_set_chained_handler_and_data(gc->irq.parents[i],
1524 gc->irq.parent_handler,
1529 gpiochip_set_irq_hooks(gc);
1531 acpi_gpiochip_request_interrupts(gc);
1537 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1538 * @gc: the gpiochip to remove the irqchip from
1540 * This is called only from gpiochip_remove()
1542 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1544 struct irq_chip *irqchip = gc->irq.chip;
1545 unsigned int offset;
1547 acpi_gpiochip_free_interrupts(gc);
1549 if (irqchip && gc->irq.parent_handler) {
1550 struct gpio_irq_chip *irq = &gc->irq;
1553 for (i = 0; i < irq->num_parents; i++)
1554 irq_set_chained_handler_and_data(irq->parents[i],
1558 /* Remove all IRQ mappings and delete the domain */
1559 if (gc->irq.domain) {
1562 for (offset = 0; offset < gc->ngpio; offset++) {
1563 if (!gpiochip_irqchip_irq_valid(gc, offset))
1566 irq = irq_find_mapping(gc->irq.domain, offset);
1567 irq_dispose_mapping(irq);
1570 irq_domain_remove(gc->irq.domain);
1574 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1575 irqchip->irq_request_resources = NULL;
1576 irqchip->irq_release_resources = NULL;
1578 if (irqchip->irq_enable == gpiochip_irq_enable) {
1579 irqchip->irq_enable = gc->irq.irq_enable;
1580 irqchip->irq_disable = gc->irq.irq_disable;
1583 gc->irq.irq_enable = NULL;
1584 gc->irq.irq_disable = NULL;
1585 gc->irq.chip = NULL;
1587 gpiochip_irqchip_free_valid_mask(gc);
1591 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1592 * @gc: the gpiochip to add the irqchip to
1593 * @domain: the irqdomain to add to the gpiochip
1595 * This function adds an IRQ domain to the gpiochip.
1597 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1598 struct irq_domain *domain)
1603 gc->to_irq = gpiochip_to_irq;
1604 gc->irq.domain = domain;
1608 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1610 #else /* CONFIG_GPIOLIB_IRQCHIP */
1612 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1613 struct lock_class_key *lock_key,
1614 struct lock_class_key *request_key)
1618 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1620 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1625 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1629 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1632 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1635 * gpiochip_generic_request() - request the gpio function for a pin
1636 * @gc: the gpiochip owning the GPIO
1637 * @offset: the offset of the GPIO to request for GPIO function
1639 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
1641 #ifdef CONFIG_PINCTRL
1642 if (list_empty(&gc->gpiodev->pin_ranges))
1646 return pinctrl_gpio_request(gc->gpiodev->base + offset);
1648 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1651 * gpiochip_generic_free() - free the gpio function from a pin
1652 * @gc: the gpiochip to request the gpio function for
1653 * @offset: the offset of the GPIO to free from GPIO function
1655 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
1657 #ifdef CONFIG_PINCTRL
1658 if (list_empty(&gc->gpiodev->pin_ranges))
1662 pinctrl_gpio_free(gc->gpiodev->base + offset);
1664 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1667 * gpiochip_generic_config() - apply configuration for a pin
1668 * @gc: the gpiochip owning the GPIO
1669 * @offset: the offset of the GPIO to apply the configuration
1670 * @config: the configuration to be applied
1672 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
1673 unsigned long config)
1675 return pinctrl_gpio_set_config(gc->gpiodev->base + offset, config);
1677 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1679 #ifdef CONFIG_PINCTRL
1682 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1683 * @gc: the gpiochip to add the range for
1684 * @pctldev: the pin controller to map to
1685 * @gpio_offset: the start offset in the current gpio_chip number space
1686 * @pin_group: name of the pin group inside the pin controller
1688 * Calling this function directly from a DeviceTree-supported
1689 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1690 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1691 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1693 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
1694 struct pinctrl_dev *pctldev,
1695 unsigned int gpio_offset, const char *pin_group)
1697 struct gpio_pin_range *pin_range;
1698 struct gpio_device *gdev = gc->gpiodev;
1701 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1703 chip_err(gc, "failed to allocate pin ranges\n");
1707 /* Use local offset as range ID */
1708 pin_range->range.id = gpio_offset;
1709 pin_range->range.gc = gc;
1710 pin_range->range.name = gc->label;
1711 pin_range->range.base = gdev->base + gpio_offset;
1712 pin_range->pctldev = pctldev;
1714 ret = pinctrl_get_group_pins(pctldev, pin_group,
1715 &pin_range->range.pins,
1716 &pin_range->range.npins);
1722 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1724 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1725 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1726 pinctrl_dev_get_devname(pctldev), pin_group);
1728 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1732 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1735 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1736 * @gc: the gpiochip to add the range for
1737 * @pinctl_name: the dev_name() of the pin controller to map to
1738 * @gpio_offset: the start offset in the current gpio_chip number space
1739 * @pin_offset: the start offset in the pin controller number space
1740 * @npins: the number of pins from the offset of each pin space (GPIO and
1741 * pin controller) to accumulate in this range
1744 * 0 on success, or a negative error-code on failure.
1746 * Calling this function directly from a DeviceTree-supported
1747 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1748 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1749 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1751 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
1752 unsigned int gpio_offset, unsigned int pin_offset,
1755 struct gpio_pin_range *pin_range;
1756 struct gpio_device *gdev = gc->gpiodev;
1759 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1761 chip_err(gc, "failed to allocate pin ranges\n");
1765 /* Use local offset as range ID */
1766 pin_range->range.id = gpio_offset;
1767 pin_range->range.gc = gc;
1768 pin_range->range.name = gc->label;
1769 pin_range->range.base = gdev->base + gpio_offset;
1770 pin_range->range.pin_base = pin_offset;
1771 pin_range->range.npins = npins;
1772 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1774 if (IS_ERR(pin_range->pctldev)) {
1775 ret = PTR_ERR(pin_range->pctldev);
1776 chip_err(gc, "could not create pin range\n");
1780 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1781 gpio_offset, gpio_offset + npins - 1,
1783 pin_offset, pin_offset + npins - 1);
1785 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1789 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1792 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1793 * @gc: the chip to remove all the mappings for
1795 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
1797 struct gpio_pin_range *pin_range, *tmp;
1798 struct gpio_device *gdev = gc->gpiodev;
1800 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1801 list_del(&pin_range->node);
1802 pinctrl_remove_gpio_range(pin_range->pctldev,
1807 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1809 #endif /* CONFIG_PINCTRL */
1811 /* These "optional" allocation calls help prevent drivers from stomping
1812 * on each other, and help provide better diagnostics in debugfs.
1813 * They're called even less than the "set direction" calls.
1815 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
1817 struct gpio_chip *gc = desc->gdev->chip;
1819 unsigned long flags;
1823 label = kstrdup_const(label, GFP_KERNEL);
1828 spin_lock_irqsave(&gpio_lock, flags);
1830 /* NOTE: gpio_request() can be called in early boot,
1831 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1834 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1835 desc_set_label(desc, label ? : "?");
1838 goto out_free_unlock;
1842 /* gc->request may sleep */
1843 spin_unlock_irqrestore(&gpio_lock, flags);
1844 offset = gpio_chip_hwgpio(desc);
1845 if (gpiochip_line_is_valid(gc, offset))
1846 ret = gc->request(gc, offset);
1849 spin_lock_irqsave(&gpio_lock, flags);
1852 desc_set_label(desc, NULL);
1853 clear_bit(FLAG_REQUESTED, &desc->flags);
1854 goto out_free_unlock;
1857 if (gc->get_direction) {
1858 /* gc->get_direction may sleep */
1859 spin_unlock_irqrestore(&gpio_lock, flags);
1860 gpiod_get_direction(desc);
1861 spin_lock_irqsave(&gpio_lock, flags);
1863 spin_unlock_irqrestore(&gpio_lock, flags);
1867 spin_unlock_irqrestore(&gpio_lock, flags);
1873 * This descriptor validation needs to be inserted verbatim into each
1874 * function taking a descriptor, so we need to use a preprocessor
1875 * macro to avoid endless duplication. If the desc is NULL it is an
1876 * optional GPIO and calls should just bail out.
1878 static int validate_desc(const struct gpio_desc *desc, const char *func)
1883 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
1884 return PTR_ERR(desc);
1887 pr_warn("%s: invalid GPIO (no device)\n", func);
1890 if (!desc->gdev->chip) {
1891 dev_warn(&desc->gdev->dev,
1892 "%s: backing chip is gone\n", func);
1898 #define VALIDATE_DESC(desc) do { \
1899 int __valid = validate_desc(desc, __func__); \
1904 #define VALIDATE_DESC_VOID(desc) do { \
1905 int __valid = validate_desc(desc, __func__); \
1910 int gpiod_request(struct gpio_desc *desc, const char *label)
1912 int ret = -EPROBE_DEFER;
1913 struct gpio_device *gdev;
1915 VALIDATE_DESC(desc);
1918 if (try_module_get(gdev->owner)) {
1919 ret = gpiod_request_commit(desc, label);
1921 module_put(gdev->owner);
1923 get_device(&gdev->dev);
1927 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
1932 static bool gpiod_free_commit(struct gpio_desc *desc)
1935 unsigned long flags;
1936 struct gpio_chip *gc;
1940 gpiod_unexport(desc);
1942 spin_lock_irqsave(&gpio_lock, flags);
1944 gc = desc->gdev->chip;
1945 if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
1947 spin_unlock_irqrestore(&gpio_lock, flags);
1948 might_sleep_if(gc->can_sleep);
1949 gc->free(gc, gpio_chip_hwgpio(desc));
1950 spin_lock_irqsave(&gpio_lock, flags);
1952 kfree_const(desc->label);
1953 desc_set_label(desc, NULL);
1954 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1955 clear_bit(FLAG_REQUESTED, &desc->flags);
1956 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1957 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1958 clear_bit(FLAG_PULL_UP, &desc->flags);
1959 clear_bit(FLAG_PULL_DOWN, &desc->flags);
1960 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
1961 clear_bit(FLAG_EDGE_RISING, &desc->flags);
1962 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
1963 clear_bit(FLAG_IS_HOGGED, &desc->flags);
1964 #ifdef CONFIG_OF_DYNAMIC
1967 #ifdef CONFIG_GPIO_CDEV
1968 WRITE_ONCE(desc->debounce_period_us, 0);
1973 spin_unlock_irqrestore(&gpio_lock, flags);
1974 blocking_notifier_call_chain(&desc->gdev->notifier,
1975 GPIOLINE_CHANGED_RELEASED, desc);
1980 void gpiod_free(struct gpio_desc *desc)
1982 if (desc && desc->gdev && gpiod_free_commit(desc)) {
1983 module_put(desc->gdev->owner);
1984 put_device(&desc->gdev->dev);
1986 WARN_ON(extra_checks);
1991 * gpiochip_is_requested - return string iff signal was requested
1992 * @gc: controller managing the signal
1993 * @offset: of signal within controller's 0..(ngpio - 1) range
1995 * Returns NULL if the GPIO is not currently requested, else a string.
1996 * The string returned is the label passed to gpio_request(); if none has been
1997 * passed it is a meaningless, non-NULL constant.
1999 * This function is for use by GPIO controller drivers. The label can
2000 * help with diagnostics, and knowing that the signal is used as a GPIO
2001 * can help avoid accidentally multiplexing it to another controller.
2003 const char *gpiochip_is_requested(struct gpio_chip *gc, unsigned int offset)
2005 struct gpio_desc *desc;
2007 if (offset >= gc->ngpio)
2010 desc = gpiochip_get_desc(gc, offset);
2014 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2018 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2021 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2023 * @hwnum: hardware number of the GPIO for which to request the descriptor
2024 * @label: label for the GPIO
2025 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2026 * specify things like line inversion semantics with the machine flags
2027 * such as GPIO_OUT_LOW
2028 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2029 * can be used to specify consumer semantics such as open drain
2031 * Function allows GPIO chip drivers to request and use their own GPIO
2032 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2033 * function will not increase reference count of the GPIO chip module. This
2034 * allows the GPIO chip module to be unloaded as needed (we assume that the
2035 * GPIO chip driver handles freeing the GPIOs it has requested).
2038 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2041 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2044 enum gpio_lookup_flags lflags,
2045 enum gpiod_flags dflags)
2047 struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2051 chip_err(gc, "failed to get GPIO descriptor\n");
2055 ret = gpiod_request_commit(desc, label);
2057 return ERR_PTR(ret);
2059 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2061 chip_err(gc, "setup of own GPIO %s failed\n", label);
2062 gpiod_free_commit(desc);
2063 return ERR_PTR(ret);
2068 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2071 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2072 * @desc: GPIO descriptor to free
2074 * Function frees the given GPIO requested previously with
2075 * gpiochip_request_own_desc().
2077 void gpiochip_free_own_desc(struct gpio_desc *desc)
2080 gpiod_free_commit(desc);
2082 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2085 * Drivers MUST set GPIO direction before making get/set calls. In
2086 * some cases this is done in early boot, before IRQs are enabled.
2088 * As a rule these aren't called more than once (except for drivers
2089 * using the open-drain emulation idiom) so these are natural places
2090 * to accumulate extra debugging checks. Note that we can't (yet)
2091 * rely on gpio_request() having been called beforehand.
2094 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2095 unsigned long config)
2097 if (!gc->set_config)
2100 return gc->set_config(gc, offset, config);
2103 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2104 enum pin_config_param mode,
2107 struct gpio_chip *gc = desc->gdev->chip;
2108 unsigned long config;
2110 config = pinconf_to_config_packed(mode, argument);
2111 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2114 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2115 enum pin_config_param mode,
2118 struct device *dev = &desc->gdev->dev;
2119 int gpio = gpio_chip_hwgpio(desc);
2122 ret = gpio_set_config_with_argument(desc, mode, argument);
2123 if (ret != -ENOTSUPP)
2127 case PIN_CONFIG_PERSIST_STATE:
2128 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2137 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2139 return gpio_set_config_with_argument(desc, mode, 0);
2142 static int gpio_set_bias(struct gpio_desc *desc)
2144 enum pin_config_param bias;
2147 if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2148 bias = PIN_CONFIG_BIAS_DISABLE;
2149 else if (test_bit(FLAG_PULL_UP, &desc->flags))
2150 bias = PIN_CONFIG_BIAS_PULL_UP;
2151 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2152 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2157 case PIN_CONFIG_BIAS_PULL_DOWN:
2158 case PIN_CONFIG_BIAS_PULL_UP:
2167 return gpio_set_config_with_argument_optional(desc, bias, arg);
2170 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2172 return gpio_set_config_with_argument_optional(desc,
2173 PIN_CONFIG_INPUT_DEBOUNCE,
2178 * gpiod_direction_input - set the GPIO direction to input
2179 * @desc: GPIO to set to input
2181 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2182 * be called safely on it.
2184 * Return 0 in case of success, else an error code.
2186 int gpiod_direction_input(struct gpio_desc *desc)
2188 struct gpio_chip *gc;
2191 VALIDATE_DESC(desc);
2192 gc = desc->gdev->chip;
2195 * It is legal to have no .get() and .direction_input() specified if
2196 * the chip is output-only, but you can't specify .direction_input()
2197 * and not support the .get() operation, that doesn't make sense.
2199 if (!gc->get && gc->direction_input) {
2201 "%s: missing get() but have direction_input()\n",
2207 * If we have a .direction_input() callback, things are simple,
2208 * just call it. Else we are some input-only chip so try to check the
2209 * direction (if .get_direction() is supported) else we silently
2210 * assume we are in input mode after this.
2212 if (gc->direction_input) {
2213 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2214 } else if (gc->get_direction &&
2215 (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2217 "%s: missing direction_input() operation and line is output\n",
2222 clear_bit(FLAG_IS_OUT, &desc->flags);
2223 ret = gpio_set_bias(desc);
2226 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2230 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2232 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2234 struct gpio_chip *gc = desc->gdev->chip;
2239 * It's OK not to specify .direction_output() if the gpiochip is
2240 * output-only, but if there is then not even a .set() operation it
2241 * is pretty tricky to drive the output line.
2243 if (!gc->set && !gc->direction_output) {
2245 "%s: missing set() and direction_output() operations\n",
2250 if (gc->direction_output) {
2251 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2253 /* Check that we are in output mode if we can */
2254 if (gc->get_direction &&
2255 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2257 "%s: missing direction_output() operation\n",
2262 * If we can't actively set the direction, we are some
2263 * output-only chip, so just drive the output as desired.
2265 gc->set(gc, gpio_chip_hwgpio(desc), val);
2269 set_bit(FLAG_IS_OUT, &desc->flags);
2270 trace_gpio_value(desc_to_gpio(desc), 0, val);
2271 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2276 * gpiod_direction_output_raw - set the GPIO direction to output
2277 * @desc: GPIO to set to output
2278 * @value: initial output value of the GPIO
2280 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2281 * be called safely on it. The initial value of the output must be specified
2282 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2284 * Return 0 in case of success, else an error code.
2286 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2288 VALIDATE_DESC(desc);
2289 return gpiod_direction_output_raw_commit(desc, value);
2291 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2294 * gpiod_direction_output - set the GPIO direction to output
2295 * @desc: GPIO to set to output
2296 * @value: initial output value of the GPIO
2298 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2299 * be called safely on it. The initial value of the output must be specified
2300 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2303 * Return 0 in case of success, else an error code.
2305 int gpiod_direction_output(struct gpio_desc *desc, int value)
2309 VALIDATE_DESC(desc);
2310 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2315 /* GPIOs used for enabled IRQs shall not be set as output */
2316 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2317 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2319 "%s: tried to set a GPIO tied to an IRQ as output\n",
2324 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2325 /* First see if we can enable open drain in hardware */
2326 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2328 goto set_output_value;
2329 /* Emulate open drain by not actively driving the line high */
2331 ret = gpiod_direction_input(desc);
2332 goto set_output_flag;
2335 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2336 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2338 goto set_output_value;
2339 /* Emulate open source by not actively driving the line low */
2341 ret = gpiod_direction_input(desc);
2342 goto set_output_flag;
2345 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2349 ret = gpio_set_bias(desc);
2352 return gpiod_direction_output_raw_commit(desc, value);
2356 * When emulating open-source or open-drain functionalities by not
2357 * actively driving the line (setting mode to input) we still need to
2358 * set the IS_OUT flag or otherwise we won't be able to set the line
2362 set_bit(FLAG_IS_OUT, &desc->flags);
2365 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2368 * gpiod_set_config - sets @config for a GPIO
2369 * @desc: descriptor of the GPIO for which to set the configuration
2370 * @config: Same packed config format as generic pinconf
2373 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2376 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2378 struct gpio_chip *gc;
2380 VALIDATE_DESC(desc);
2381 gc = desc->gdev->chip;
2383 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2385 EXPORT_SYMBOL_GPL(gpiod_set_config);
2388 * gpiod_set_debounce - sets @debounce time for a GPIO
2389 * @desc: descriptor of the GPIO for which to set debounce time
2390 * @debounce: debounce time in microseconds
2393 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2396 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2398 unsigned long config;
2400 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2401 return gpiod_set_config(desc, config);
2403 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2406 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2407 * @desc: descriptor of the GPIO for which to configure persistence
2408 * @transitory: True to lose state on suspend or reset, false for persistence
2411 * 0 on success, otherwise a negative error code.
2413 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2415 VALIDATE_DESC(desc);
2417 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2418 * persistence state.
2420 assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2422 /* If the driver supports it, set the persistence state now */
2423 return gpio_set_config_with_argument_optional(desc,
2424 PIN_CONFIG_PERSIST_STATE,
2427 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2430 * gpiod_is_active_low - test whether a GPIO is active-low or not
2431 * @desc: the gpio descriptor to test
2433 * Returns 1 if the GPIO is active-low, 0 otherwise.
2435 int gpiod_is_active_low(const struct gpio_desc *desc)
2437 VALIDATE_DESC(desc);
2438 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2440 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2443 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2444 * @desc: the gpio descriptor to change
2446 void gpiod_toggle_active_low(struct gpio_desc *desc)
2448 VALIDATE_DESC_VOID(desc);
2449 change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2451 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2453 /* I/O calls are only valid after configuration completed; the relevant
2454 * "is this a valid GPIO" error checks should already have been done.
2456 * "Get" operations are often inlinable as reading a pin value register,
2457 * and masking the relevant bit in that register.
2459 * When "set" operations are inlinable, they involve writing that mask to
2460 * one register to set a low value, or a different register to set it high.
2461 * Otherwise locking is needed, so there may be little value to inlining.
2463 *------------------------------------------------------------------------
2465 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2466 * have requested the GPIO. That can include implicit requesting by
2467 * a direction setting call. Marking a gpio as requested locks its chip
2468 * in memory, guaranteeing that these table lookups need no more locking
2469 * and that gpiochip_remove() will fail.
2471 * REVISIT when debugging, consider adding some instrumentation to ensure
2472 * that the GPIO was actually requested.
2475 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2477 struct gpio_chip *gc;
2481 gc = desc->gdev->chip;
2482 offset = gpio_chip_hwgpio(desc);
2483 value = gc->get ? gc->get(gc, offset) : -EIO;
2484 value = value < 0 ? value : !!value;
2485 trace_gpio_value(desc_to_gpio(desc), 1, value);
2489 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2490 unsigned long *mask, unsigned long *bits)
2492 if (gc->get_multiple) {
2493 return gc->get_multiple(gc, mask, bits);
2494 } else if (gc->get) {
2497 for_each_set_bit(i, mask, gc->ngpio) {
2498 value = gc->get(gc, i);
2501 __assign_bit(i, bits, value);
2508 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2509 unsigned int array_size,
2510 struct gpio_desc **desc_array,
2511 struct gpio_array *array_info,
2512 unsigned long *value_bitmap)
2517 * Validate array_info against desc_array and its size.
2518 * It should immediately follow desc_array if both
2519 * have been obtained from the same gpiod_get_array() call.
2521 if (array_info && array_info->desc == desc_array &&
2522 array_size <= array_info->size &&
2523 (void *)array_info == desc_array + array_info->size) {
2525 WARN_ON(array_info->chip->can_sleep);
2527 ret = gpio_chip_get_multiple(array_info->chip,
2528 array_info->get_mask,
2533 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2534 bitmap_xor(value_bitmap, value_bitmap,
2535 array_info->invert_mask, array_size);
2537 i = find_first_zero_bit(array_info->get_mask, array_size);
2538 if (i == array_size)
2544 while (i < array_size) {
2545 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2546 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2547 unsigned long *mask, *bits;
2550 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2553 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2555 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2560 bits = mask + BITS_TO_LONGS(gc->ngpio);
2561 bitmap_zero(mask, gc->ngpio);
2564 WARN_ON(gc->can_sleep);
2566 /* collect all inputs belonging to the same chip */
2569 const struct gpio_desc *desc = desc_array[i];
2570 int hwgpio = gpio_chip_hwgpio(desc);
2572 __set_bit(hwgpio, mask);
2576 i = find_next_zero_bit(array_info->get_mask,
2578 } while ((i < array_size) &&
2579 (desc_array[i]->gdev->chip == gc));
2581 ret = gpio_chip_get_multiple(gc, mask, bits);
2583 if (mask != fastpath)
2588 for (j = first; j < i; ) {
2589 const struct gpio_desc *desc = desc_array[j];
2590 int hwgpio = gpio_chip_hwgpio(desc);
2591 int value = test_bit(hwgpio, bits);
2593 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2595 __assign_bit(j, value_bitmap, value);
2596 trace_gpio_value(desc_to_gpio(desc), 1, value);
2600 j = find_next_zero_bit(array_info->get_mask, i,
2604 if (mask != fastpath)
2611 * gpiod_get_raw_value() - return a gpio's raw value
2612 * @desc: gpio whose value will be returned
2614 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2615 * its ACTIVE_LOW status, or negative errno on failure.
2617 * This function can be called from contexts where we cannot sleep, and will
2618 * complain if the GPIO chip functions potentially sleep.
2620 int gpiod_get_raw_value(const struct gpio_desc *desc)
2622 VALIDATE_DESC(desc);
2623 /* Should be using gpiod_get_raw_value_cansleep() */
2624 WARN_ON(desc->gdev->chip->can_sleep);
2625 return gpiod_get_raw_value_commit(desc);
2627 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2630 * gpiod_get_value() - return a gpio's value
2631 * @desc: gpio whose value will be returned
2633 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2634 * account, or negative errno on failure.
2636 * This function can be called from contexts where we cannot sleep, and will
2637 * complain if the GPIO chip functions potentially sleep.
2639 int gpiod_get_value(const struct gpio_desc *desc)
2643 VALIDATE_DESC(desc);
2644 /* Should be using gpiod_get_value_cansleep() */
2645 WARN_ON(desc->gdev->chip->can_sleep);
2647 value = gpiod_get_raw_value_commit(desc);
2651 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2656 EXPORT_SYMBOL_GPL(gpiod_get_value);
2659 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2660 * @array_size: number of elements in the descriptor array / value bitmap
2661 * @desc_array: array of GPIO descriptors whose values will be read
2662 * @array_info: information on applicability of fast bitmap processing path
2663 * @value_bitmap: bitmap to store the read values
2665 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2666 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2667 * else an error code.
2669 * This function can be called from contexts where we cannot sleep,
2670 * and it will complain if the GPIO chip functions potentially sleep.
2672 int gpiod_get_raw_array_value(unsigned int array_size,
2673 struct gpio_desc **desc_array,
2674 struct gpio_array *array_info,
2675 unsigned long *value_bitmap)
2679 return gpiod_get_array_value_complex(true, false, array_size,
2680 desc_array, array_info,
2683 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2686 * gpiod_get_array_value() - read values from an array of GPIOs
2687 * @array_size: number of elements in the descriptor array / value bitmap
2688 * @desc_array: array of GPIO descriptors whose values will be read
2689 * @array_info: information on applicability of fast bitmap processing path
2690 * @value_bitmap: bitmap to store the read values
2692 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2693 * into account. Return 0 in case of success, else an error code.
2695 * This function can be called from contexts where we cannot sleep,
2696 * and it will complain if the GPIO chip functions potentially sleep.
2698 int gpiod_get_array_value(unsigned int array_size,
2699 struct gpio_desc **desc_array,
2700 struct gpio_array *array_info,
2701 unsigned long *value_bitmap)
2705 return gpiod_get_array_value_complex(false, false, array_size,
2706 desc_array, array_info,
2709 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2712 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2713 * @desc: gpio descriptor whose state need to be set.
2714 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2716 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2719 struct gpio_chip *gc = desc->gdev->chip;
2720 int offset = gpio_chip_hwgpio(desc);
2723 ret = gc->direction_input(gc, offset);
2725 ret = gc->direction_output(gc, offset, 0);
2727 set_bit(FLAG_IS_OUT, &desc->flags);
2729 trace_gpio_direction(desc_to_gpio(desc), value, ret);
2732 "%s: Error in set_value for open drain err %d\n",
2737 * _gpio_set_open_source_value() - Set the open source gpio's value.
2738 * @desc: gpio descriptor whose state need to be set.
2739 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2741 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2744 struct gpio_chip *gc = desc->gdev->chip;
2745 int offset = gpio_chip_hwgpio(desc);
2748 ret = gc->direction_output(gc, offset, 1);
2750 set_bit(FLAG_IS_OUT, &desc->flags);
2752 ret = gc->direction_input(gc, offset);
2754 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
2757 "%s: Error in set_value for open source err %d\n",
2761 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2763 struct gpio_chip *gc;
2765 gc = desc->gdev->chip;
2766 trace_gpio_value(desc_to_gpio(desc), 0, value);
2767 gc->set(gc, gpio_chip_hwgpio(desc), value);
2771 * set multiple outputs on the same chip;
2772 * use the chip's set_multiple function if available;
2773 * otherwise set the outputs sequentially;
2774 * @chip: the GPIO chip we operate on
2775 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2776 * defines which outputs are to be changed
2777 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2778 * defines the values the outputs specified by mask are to be set to
2780 static void gpio_chip_set_multiple(struct gpio_chip *gc,
2781 unsigned long *mask, unsigned long *bits)
2783 if (gc->set_multiple) {
2784 gc->set_multiple(gc, mask, bits);
2788 /* set outputs if the corresponding mask bit is set */
2789 for_each_set_bit(i, mask, gc->ngpio)
2790 gc->set(gc, i, test_bit(i, bits));
2794 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
2795 unsigned int array_size,
2796 struct gpio_desc **desc_array,
2797 struct gpio_array *array_info,
2798 unsigned long *value_bitmap)
2803 * Validate array_info against desc_array and its size.
2804 * It should immediately follow desc_array if both
2805 * have been obtained from the same gpiod_get_array() call.
2807 if (array_info && array_info->desc == desc_array &&
2808 array_size <= array_info->size &&
2809 (void *)array_info == desc_array + array_info->size) {
2811 WARN_ON(array_info->chip->can_sleep);
2813 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2814 bitmap_xor(value_bitmap, value_bitmap,
2815 array_info->invert_mask, array_size);
2817 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
2820 i = find_first_zero_bit(array_info->set_mask, array_size);
2821 if (i == array_size)
2827 while (i < array_size) {
2828 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2829 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2830 unsigned long *mask, *bits;
2833 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2836 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2838 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2843 bits = mask + BITS_TO_LONGS(gc->ngpio);
2844 bitmap_zero(mask, gc->ngpio);
2847 WARN_ON(gc->can_sleep);
2850 struct gpio_desc *desc = desc_array[i];
2851 int hwgpio = gpio_chip_hwgpio(desc);
2852 int value = test_bit(i, value_bitmap);
2855 * Pins applicable for fast input but not for
2856 * fast output processing may have been already
2857 * inverted inside the fast path, skip them.
2859 if (!raw && !(array_info &&
2860 test_bit(i, array_info->invert_mask)) &&
2861 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2863 trace_gpio_value(desc_to_gpio(desc), 0, value);
2865 * collect all normal outputs belonging to the same chip
2866 * open drain and open source outputs are set individually
2868 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
2869 gpio_set_open_drain_value_commit(desc, value);
2870 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
2871 gpio_set_open_source_value_commit(desc, value);
2873 __set_bit(hwgpio, mask);
2874 __assign_bit(hwgpio, bits, value);
2880 i = find_next_zero_bit(array_info->set_mask,
2882 } while ((i < array_size) &&
2883 (desc_array[i]->gdev->chip == gc));
2884 /* push collected bits to outputs */
2886 gpio_chip_set_multiple(gc, mask, bits);
2888 if (mask != fastpath)
2895 * gpiod_set_raw_value() - assign a gpio's raw value
2896 * @desc: gpio whose value will be assigned
2897 * @value: value to assign
2899 * Set the raw value of the GPIO, i.e. the value of its physical line without
2900 * regard for its ACTIVE_LOW status.
2902 * This function can be called from contexts where we cannot sleep, and will
2903 * complain if the GPIO chip functions potentially sleep.
2905 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2907 VALIDATE_DESC_VOID(desc);
2908 /* Should be using gpiod_set_raw_value_cansleep() */
2909 WARN_ON(desc->gdev->chip->can_sleep);
2910 gpiod_set_raw_value_commit(desc, value);
2912 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2915 * gpiod_set_value_nocheck() - set a GPIO line value without checking
2916 * @desc: the descriptor to set the value on
2917 * @value: value to set
2919 * This sets the value of a GPIO line backing a descriptor, applying
2920 * different semantic quirks like active low and open drain/source
2923 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
2925 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2927 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2928 gpio_set_open_drain_value_commit(desc, value);
2929 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2930 gpio_set_open_source_value_commit(desc, value);
2932 gpiod_set_raw_value_commit(desc, value);
2936 * gpiod_set_value() - assign a gpio's value
2937 * @desc: gpio whose value will be assigned
2938 * @value: value to assign
2940 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
2941 * OPEN_DRAIN and OPEN_SOURCE flags into account.
2943 * This function can be called from contexts where we cannot sleep, and will
2944 * complain if the GPIO chip functions potentially sleep.
2946 void gpiod_set_value(struct gpio_desc *desc, int value)
2948 VALIDATE_DESC_VOID(desc);
2949 /* Should be using gpiod_set_value_cansleep() */
2950 WARN_ON(desc->gdev->chip->can_sleep);
2951 gpiod_set_value_nocheck(desc, value);
2953 EXPORT_SYMBOL_GPL(gpiod_set_value);
2956 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2957 * @array_size: number of elements in the descriptor array / value bitmap
2958 * @desc_array: array of GPIO descriptors whose values will be assigned
2959 * @array_info: information on applicability of fast bitmap processing path
2960 * @value_bitmap: bitmap of values to assign
2962 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2963 * without regard for their ACTIVE_LOW status.
2965 * This function can be called from contexts where we cannot sleep, and will
2966 * complain if the GPIO chip functions potentially sleep.
2968 int gpiod_set_raw_array_value(unsigned int array_size,
2969 struct gpio_desc **desc_array,
2970 struct gpio_array *array_info,
2971 unsigned long *value_bitmap)
2975 return gpiod_set_array_value_complex(true, false, array_size,
2976 desc_array, array_info, value_bitmap);
2978 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
2981 * gpiod_set_array_value() - assign values to an array of GPIOs
2982 * @array_size: number of elements in the descriptor array / value bitmap
2983 * @desc_array: array of GPIO descriptors whose values will be assigned
2984 * @array_info: information on applicability of fast bitmap processing path
2985 * @value_bitmap: bitmap of values to assign
2987 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2990 * This function can be called from contexts where we cannot sleep, and will
2991 * complain if the GPIO chip functions potentially sleep.
2993 int gpiod_set_array_value(unsigned int array_size,
2994 struct gpio_desc **desc_array,
2995 struct gpio_array *array_info,
2996 unsigned long *value_bitmap)
3000 return gpiod_set_array_value_complex(false, false, array_size,
3001 desc_array, array_info,
3004 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3007 * gpiod_cansleep() - report whether gpio value access may sleep
3008 * @desc: gpio to check
3011 int gpiod_cansleep(const struct gpio_desc *desc)
3013 VALIDATE_DESC(desc);
3014 return desc->gdev->chip->can_sleep;
3016 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3019 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3020 * @desc: gpio to set the consumer name on
3021 * @name: the new consumer name
3023 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3025 VALIDATE_DESC(desc);
3027 name = kstrdup_const(name, GFP_KERNEL);
3032 kfree_const(desc->label);
3033 desc_set_label(desc, name);
3037 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3040 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3041 * @desc: gpio whose IRQ will be returned (already requested)
3043 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3046 int gpiod_to_irq(const struct gpio_desc *desc)
3048 struct gpio_chip *gc;
3052 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3053 * requires this function to not return zero on an invalid descriptor
3054 * but rather a negative error number.
3056 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3059 gc = desc->gdev->chip;
3060 offset = gpio_chip_hwgpio(desc);
3062 int retirq = gc->to_irq(gc, offset);
3064 /* Zero means NO_IRQ */
3072 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3075 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3076 * @gc: the chip the GPIO to lock belongs to
3077 * @offset: the offset of the GPIO to lock as IRQ
3079 * This is used directly by GPIO drivers that want to lock down
3080 * a certain GPIO line to be used for IRQs.
3082 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3084 struct gpio_desc *desc;
3086 desc = gpiochip_get_desc(gc, offset);
3088 return PTR_ERR(desc);
3091 * If it's fast: flush the direction setting if something changed
3094 if (!gc->can_sleep && gc->get_direction) {
3095 int dir = gpiod_get_direction(desc);
3098 chip_err(gc, "%s: cannot get GPIO direction\n",
3104 /* To be valid for IRQ the line needs to be input or open drain */
3105 if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3106 !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3108 "%s: tried to flag a GPIO set as output for IRQ\n",
3113 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3114 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3117 * If the consumer has not set up a label (such as when the
3118 * IRQ is referenced from .to_irq()) we set up a label here
3119 * so it is clear this is used as an interrupt.
3122 desc_set_label(desc, "interrupt");
3126 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3129 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3130 * @gc: the chip the GPIO to lock belongs to
3131 * @offset: the offset of the GPIO to lock as IRQ
3133 * This is used directly by GPIO drivers that want to indicate
3134 * that a certain GPIO is no longer used exclusively for IRQ.
3136 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3138 struct gpio_desc *desc;
3140 desc = gpiochip_get_desc(gc, offset);
3144 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3145 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3147 /* If we only had this marking, erase it */
3148 if (desc->label && !strcmp(desc->label, "interrupt"))
3149 desc_set_label(desc, NULL);
3151 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3153 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3155 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3157 if (!IS_ERR(desc) &&
3158 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3159 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3161 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3163 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3165 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3167 if (!IS_ERR(desc) &&
3168 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3170 * We must not be output when using IRQ UNLESS we are
3173 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3174 !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3175 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3178 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3180 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3182 if (offset >= gc->ngpio)
3185 return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3187 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3189 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3193 if (!try_module_get(gc->gpiodev->owner))
3196 ret = gpiochip_lock_as_irq(gc, offset);
3198 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3199 module_put(gc->gpiodev->owner);
3204 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3206 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3208 gpiochip_unlock_as_irq(gc, offset);
3209 module_put(gc->gpiodev->owner);
3211 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3213 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3215 if (offset >= gc->ngpio)
3218 return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3220 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3222 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3224 if (offset >= gc->ngpio)
3227 return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3229 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3231 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3233 if (offset >= gc->ngpio)
3236 return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3238 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3241 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3242 * @desc: gpio whose value will be returned
3244 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3245 * its ACTIVE_LOW status, or negative errno on failure.
3247 * This function is to be called from contexts that can sleep.
3249 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3251 might_sleep_if(extra_checks);
3252 VALIDATE_DESC(desc);
3253 return gpiod_get_raw_value_commit(desc);
3255 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3258 * gpiod_get_value_cansleep() - return a gpio's value
3259 * @desc: gpio whose value will be returned
3261 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3262 * account, or negative errno on failure.
3264 * This function is to be called from contexts that can sleep.
3266 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3270 might_sleep_if(extra_checks);
3271 VALIDATE_DESC(desc);
3272 value = gpiod_get_raw_value_commit(desc);
3276 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3281 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3284 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3285 * @array_size: number of elements in the descriptor array / value bitmap
3286 * @desc_array: array of GPIO descriptors whose values will be read
3287 * @array_info: information on applicability of fast bitmap processing path
3288 * @value_bitmap: bitmap to store the read values
3290 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3291 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3292 * else an error code.
3294 * This function is to be called from contexts that can sleep.
3296 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3297 struct gpio_desc **desc_array,
3298 struct gpio_array *array_info,
3299 unsigned long *value_bitmap)
3301 might_sleep_if(extra_checks);
3304 return gpiod_get_array_value_complex(true, true, array_size,
3305 desc_array, array_info,
3308 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3311 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3312 * @array_size: number of elements in the descriptor array / value bitmap
3313 * @desc_array: array of GPIO descriptors whose values will be read
3314 * @array_info: information on applicability of fast bitmap processing path
3315 * @value_bitmap: bitmap to store the read values
3317 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3318 * into account. Return 0 in case of success, else an error code.
3320 * This function is to be called from contexts that can sleep.
3322 int gpiod_get_array_value_cansleep(unsigned int array_size,
3323 struct gpio_desc **desc_array,
3324 struct gpio_array *array_info,
3325 unsigned long *value_bitmap)
3327 might_sleep_if(extra_checks);
3330 return gpiod_get_array_value_complex(false, true, array_size,
3331 desc_array, array_info,
3334 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3337 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3338 * @desc: gpio whose value will be assigned
3339 * @value: value to assign
3341 * Set the raw value of the GPIO, i.e. the value of its physical line without
3342 * regard for its ACTIVE_LOW status.
3344 * This function is to be called from contexts that can sleep.
3346 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3348 might_sleep_if(extra_checks);
3349 VALIDATE_DESC_VOID(desc);
3350 gpiod_set_raw_value_commit(desc, value);
3352 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3355 * gpiod_set_value_cansleep() - assign a gpio's value
3356 * @desc: gpio whose value will be assigned
3357 * @value: value to assign
3359 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3362 * This function is to be called from contexts that can sleep.
3364 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3366 might_sleep_if(extra_checks);
3367 VALIDATE_DESC_VOID(desc);
3368 gpiod_set_value_nocheck(desc, value);
3370 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3373 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3374 * @array_size: number of elements in the descriptor array / value bitmap
3375 * @desc_array: array of GPIO descriptors whose values will be assigned
3376 * @array_info: information on applicability of fast bitmap processing path
3377 * @value_bitmap: bitmap of values to assign
3379 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3380 * without regard for their ACTIVE_LOW status.
3382 * This function is to be called from contexts that can sleep.
3384 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3385 struct gpio_desc **desc_array,
3386 struct gpio_array *array_info,
3387 unsigned long *value_bitmap)
3389 might_sleep_if(extra_checks);
3392 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3393 array_info, value_bitmap);
3395 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3398 * gpiod_add_lookup_tables() - register GPIO device consumers
3399 * @tables: list of tables of consumers to register
3400 * @n: number of tables in the list
3402 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3406 mutex_lock(&gpio_lookup_lock);
3408 for (i = 0; i < n; i++)
3409 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3411 mutex_unlock(&gpio_lookup_lock);
3415 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3416 * @array_size: number of elements in the descriptor array / value bitmap
3417 * @desc_array: array of GPIO descriptors whose values will be assigned
3418 * @array_info: information on applicability of fast bitmap processing path
3419 * @value_bitmap: bitmap of values to assign
3421 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3424 * This function is to be called from contexts that can sleep.
3426 int gpiod_set_array_value_cansleep(unsigned int array_size,
3427 struct gpio_desc **desc_array,
3428 struct gpio_array *array_info,
3429 unsigned long *value_bitmap)
3431 might_sleep_if(extra_checks);
3434 return gpiod_set_array_value_complex(false, true, array_size,
3435 desc_array, array_info,
3438 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3441 * gpiod_add_lookup_table() - register GPIO device consumers
3442 * @table: table of consumers to register
3444 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3446 mutex_lock(&gpio_lookup_lock);
3448 list_add_tail(&table->list, &gpio_lookup_list);
3450 mutex_unlock(&gpio_lookup_lock);
3452 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3455 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3456 * @table: table of consumers to unregister
3458 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3460 /* Nothing to remove */
3464 mutex_lock(&gpio_lookup_lock);
3466 list_del(&table->list);
3468 mutex_unlock(&gpio_lookup_lock);
3470 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3473 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3474 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3476 void gpiod_add_hogs(struct gpiod_hog *hogs)
3478 struct gpio_chip *gc;
3479 struct gpiod_hog *hog;
3481 mutex_lock(&gpio_machine_hogs_mutex);
3483 for (hog = &hogs[0]; hog->chip_label; hog++) {
3484 list_add_tail(&hog->list, &gpio_machine_hogs);
3487 * The chip may have been registered earlier, so check if it
3488 * exists and, if so, try to hog the line now.
3490 gc = find_chip_by_name(hog->chip_label);
3492 gpiochip_machine_hog(gc, hog);
3495 mutex_unlock(&gpio_machine_hogs_mutex);
3497 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3499 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3501 const char *dev_id = dev ? dev_name(dev) : NULL;
3502 struct gpiod_lookup_table *table;
3504 mutex_lock(&gpio_lookup_lock);
3506 list_for_each_entry(table, &gpio_lookup_list, list) {
3507 if (table->dev_id && dev_id) {
3509 * Valid strings on both ends, must be identical to have
3512 if (!strcmp(table->dev_id, dev_id))
3516 * One of the pointers is NULL, so both must be to have
3519 if (dev_id == table->dev_id)
3526 mutex_unlock(&gpio_lookup_lock);
3530 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3531 unsigned int idx, unsigned long *flags)
3533 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3534 struct gpiod_lookup_table *table;
3535 struct gpiod_lookup *p;
3537 table = gpiod_find_lookup_table(dev);
3541 for (p = &table->table[0]; p->key; p++) {
3542 struct gpio_chip *gc;
3544 /* idx must always match exactly */
3548 /* If the lookup entry has a con_id, require exact match */
3549 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3552 if (p->chip_hwnum == U16_MAX) {
3553 desc = gpio_name_to_desc(p->key);
3559 dev_warn(dev, "cannot find GPIO line %s, deferring\n",
3561 return ERR_PTR(-EPROBE_DEFER);
3564 gc = find_chip_by_name(p->key);
3568 * As the lookup table indicates a chip with
3569 * p->key should exist, assume it may
3570 * still appear later and let the interested
3571 * consumer be probed again or let the Deferred
3572 * Probe infrastructure handle the error.
3574 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3576 return ERR_PTR(-EPROBE_DEFER);
3579 if (gc->ngpio <= p->chip_hwnum) {
3581 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3582 idx, p->chip_hwnum, gc->ngpio - 1,
3584 return ERR_PTR(-EINVAL);
3587 desc = gpiochip_get_desc(gc, p->chip_hwnum);
3596 static int platform_gpio_count(struct device *dev, const char *con_id)
3598 struct gpiod_lookup_table *table;
3599 struct gpiod_lookup *p;
3600 unsigned int count = 0;
3602 table = gpiod_find_lookup_table(dev);
3606 for (p = &table->table[0]; p->key; p++) {
3607 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3608 (!con_id && !p->con_id))
3618 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3619 * @fwnode: handle of the firmware node
3620 * @con_id: function within the GPIO consumer
3621 * @index: index of the GPIO to obtain for the consumer
3622 * @flags: GPIO initialization flags
3623 * @label: label to attach to the requested GPIO
3625 * This function can be used for drivers that get their configuration
3626 * from opaque firmware.
3628 * The function properly finds the corresponding GPIO using whatever is the
3629 * underlying firmware interface and then makes sure that the GPIO
3630 * descriptor is requested before it is returned to the caller.
3633 * On successful request the GPIO pin is configured in accordance with
3636 * In case of error an ERR_PTR() is returned.
3638 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
3639 const char *con_id, int index,
3640 enum gpiod_flags flags,
3643 struct gpio_desc *desc;
3644 char prop_name[32]; /* 32 is max size of property name */
3647 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3649 snprintf(prop_name, sizeof(prop_name), "%s-%s",
3650 con_id, gpio_suffixes[i]);
3652 snprintf(prop_name, sizeof(prop_name), "%s",
3655 desc = fwnode_get_named_gpiod(fwnode, prop_name, index, flags,
3657 if (!gpiod_not_found(desc))
3663 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
3666 * gpiod_count - return the number of GPIOs associated with a device / function
3667 * or -ENOENT if no GPIO has been assigned to the requested function
3668 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3669 * @con_id: function within the GPIO consumer
3671 int gpiod_count(struct device *dev, const char *con_id)
3673 const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
3674 int count = -ENOENT;
3676 if (is_of_node(fwnode))
3677 count = of_gpio_get_count(dev, con_id);
3678 else if (is_acpi_node(fwnode))
3679 count = acpi_gpio_count(dev, con_id);
3682 count = platform_gpio_count(dev, con_id);
3686 EXPORT_SYMBOL_GPL(gpiod_count);
3689 * gpiod_get - obtain a GPIO for a given GPIO function
3690 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3691 * @con_id: function within the GPIO consumer
3692 * @flags: optional GPIO initialization flags
3694 * Return the GPIO descriptor corresponding to the function con_id of device
3695 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3696 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3698 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3699 enum gpiod_flags flags)
3701 return gpiod_get_index(dev, con_id, 0, flags);
3703 EXPORT_SYMBOL_GPL(gpiod_get);
3706 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3707 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3708 * @con_id: function within the GPIO consumer
3709 * @flags: optional GPIO initialization flags
3711 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3712 * the requested function it will return NULL. This is convenient for drivers
3713 * that need to handle optional GPIOs.
3715 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3717 enum gpiod_flags flags)
3719 return gpiod_get_index_optional(dev, con_id, 0, flags);
3721 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3725 * gpiod_configure_flags - helper function to configure a given GPIO
3726 * @desc: gpio whose value will be assigned
3727 * @con_id: function within the GPIO consumer
3728 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3729 * of_find_gpio() or of_get_gpio_hog()
3730 * @dflags: gpiod_flags - optional GPIO initialization flags
3732 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3733 * requested function and/or index, or another IS_ERR() code if an error
3734 * occurred while trying to acquire the GPIO.
3736 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3737 unsigned long lflags, enum gpiod_flags dflags)
3741 if (lflags & GPIO_ACTIVE_LOW)
3742 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3744 if (lflags & GPIO_OPEN_DRAIN)
3745 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3746 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3748 * This enforces open drain mode from the consumer side.
3749 * This is necessary for some busses like I2C, but the lookup
3750 * should *REALLY* have specified them as open drain in the
3751 * first place, so print a little warning here.
3753 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3755 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3758 if (lflags & GPIO_OPEN_SOURCE)
3759 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3761 if ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) {
3763 "both pull-up and pull-down enabled, invalid configuration\n");
3767 if (lflags & GPIO_PULL_UP)
3768 set_bit(FLAG_PULL_UP, &desc->flags);
3769 else if (lflags & GPIO_PULL_DOWN)
3770 set_bit(FLAG_PULL_DOWN, &desc->flags);
3772 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
3776 /* No particular flag request, return here... */
3777 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3778 gpiod_dbg(desc, "no flags found for %s\n", con_id);
3783 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3784 ret = gpiod_direction_output(desc,
3785 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3787 ret = gpiod_direction_input(desc);
3793 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3794 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3795 * @con_id: function within the GPIO consumer
3796 * @idx: index of the GPIO to obtain in the consumer
3797 * @flags: optional GPIO initialization flags
3799 * This variant of gpiod_get() allows to access GPIOs other than the first
3800 * defined one for functions that define several GPIOs.
3802 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3803 * requested function and/or index, or another IS_ERR() code if an error
3804 * occurred while trying to acquire the GPIO.
3806 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3809 enum gpiod_flags flags)
3811 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3812 struct gpio_desc *desc = NULL;
3814 /* Maybe we have a device name, maybe not */
3815 const char *devname = dev ? dev_name(dev) : "?";
3816 const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
3818 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3820 /* Using device tree? */
3821 if (is_of_node(fwnode)) {
3822 dev_dbg(dev, "using device tree for GPIO lookup\n");
3823 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3824 } else if (is_acpi_node(fwnode)) {
3825 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3826 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3830 * Either we are not using DT or ACPI, or their lookup did not return
3831 * a result. In that case, use platform lookup as a fallback.
3833 if (!desc || gpiod_not_found(desc)) {
3834 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3835 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3839 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
3844 * If a connection label was passed use that, else attempt to use
3845 * the device name as label
3847 ret = gpiod_request(desc, con_id ? con_id : devname);
3849 if (ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
3851 * This happens when there are several consumers for
3852 * the same GPIO line: we just return here without
3853 * further initialization. It is a bit if a hack.
3854 * This is necessary to support fixed regulators.
3856 * FIXME: Make this more sane and safe.
3858 dev_info(dev, "nonexclusive access to GPIO for %s\n",
3859 con_id ? con_id : devname);
3862 return ERR_PTR(ret);
3866 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3868 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3870 return ERR_PTR(ret);
3873 blocking_notifier_call_chain(&desc->gdev->notifier,
3874 GPIOLINE_CHANGED_REQUESTED, desc);
3878 EXPORT_SYMBOL_GPL(gpiod_get_index);
3881 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3882 * @fwnode: handle of the firmware node
3883 * @propname: name of the firmware property representing the GPIO
3884 * @index: index of the GPIO to obtain for the consumer
3885 * @dflags: GPIO initialization flags
3886 * @label: label to attach to the requested GPIO
3888 * This function can be used for drivers that get their configuration
3889 * from opaque firmware.
3891 * The function properly finds the corresponding GPIO using whatever is the
3892 * underlying firmware interface and then makes sure that the GPIO
3893 * descriptor is requested before it is returned to the caller.
3896 * On successful request the GPIO pin is configured in accordance with
3899 * In case of error an ERR_PTR() is returned.
3901 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3902 const char *propname, int index,
3903 enum gpiod_flags dflags,
3906 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3907 struct gpio_desc *desc = ERR_PTR(-ENODEV);
3910 if (is_of_node(fwnode)) {
3911 desc = gpiod_get_from_of_node(to_of_node(fwnode),
3916 } else if (is_acpi_node(fwnode)) {
3917 struct acpi_gpio_info info;
3919 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
3923 acpi_gpio_update_gpiod_flags(&dflags, &info);
3924 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
3926 return ERR_PTR(-EINVAL);
3928 /* Currently only ACPI takes this path */
3929 ret = gpiod_request(desc, label);
3931 return ERR_PTR(ret);
3933 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3936 return ERR_PTR(ret);
3939 blocking_notifier_call_chain(&desc->gdev->notifier,
3940 GPIOLINE_CHANGED_REQUESTED, desc);
3944 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3947 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3949 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3950 * @con_id: function within the GPIO consumer
3951 * @index: index of the GPIO to obtain in the consumer
3952 * @flags: optional GPIO initialization flags
3954 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3955 * specified index was assigned to the requested function it will return NULL.
3956 * This is convenient for drivers that need to handle optional GPIOs.
3958 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
3961 enum gpiod_flags flags)
3963 struct gpio_desc *desc;
3965 desc = gpiod_get_index(dev, con_id, index, flags);
3966 if (gpiod_not_found(desc))
3971 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
3974 * gpiod_hog - Hog the specified GPIO desc given the provided flags
3975 * @desc: gpio whose value will be assigned
3976 * @name: gpio line name
3977 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3978 * of_find_gpio() or of_get_gpio_hog()
3979 * @dflags: gpiod_flags - optional GPIO initialization flags
3981 int gpiod_hog(struct gpio_desc *desc, const char *name,
3982 unsigned long lflags, enum gpiod_flags dflags)
3984 struct gpio_chip *gc;
3985 struct gpio_desc *local_desc;
3989 gc = gpiod_to_chip(desc);
3990 hwnum = gpio_chip_hwgpio(desc);
3992 local_desc = gpiochip_request_own_desc(gc, hwnum, name,
3994 if (IS_ERR(local_desc)) {
3995 ret = PTR_ERR(local_desc);
3996 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
3997 name, gc->label, hwnum, ret);
4001 /* Mark GPIO as hogged so it can be identified and removed later */
4002 set_bit(FLAG_IS_HOGGED, &desc->flags);
4004 gpiod_info(desc, "hogged as %s%s\n",
4005 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4006 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4007 (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4013 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4014 * @gc: gpio chip to act on
4016 static void gpiochip_free_hogs(struct gpio_chip *gc)
4020 for (id = 0; id < gc->ngpio; id++) {
4021 if (test_bit(FLAG_IS_HOGGED, &gc->gpiodev->descs[id].flags))
4022 gpiochip_free_own_desc(&gc->gpiodev->descs[id]);
4027 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4028 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4029 * @con_id: function within the GPIO consumer
4030 * @flags: optional GPIO initialization flags
4032 * This function acquires all the GPIOs defined under a given function.
4034 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4035 * no GPIO has been assigned to the requested function, or another IS_ERR()
4036 * code if an error occurred while trying to acquire the GPIOs.
4038 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4040 enum gpiod_flags flags)
4042 struct gpio_desc *desc;
4043 struct gpio_descs *descs;
4044 struct gpio_array *array_info = NULL;
4045 struct gpio_chip *gc;
4046 int count, bitmap_size;
4048 count = gpiod_count(dev, con_id);
4050 return ERR_PTR(count);
4052 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4054 return ERR_PTR(-ENOMEM);
4056 for (descs->ndescs = 0; descs->ndescs < count; ) {
4057 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4059 gpiod_put_array(descs);
4060 return ERR_CAST(desc);
4063 descs->desc[descs->ndescs] = desc;
4065 gc = gpiod_to_chip(desc);
4067 * If pin hardware number of array member 0 is also 0, select
4068 * its chip as a candidate for fast bitmap processing path.
4070 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4071 struct gpio_descs *array;
4073 bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4076 array = kzalloc(struct_size(descs, desc, count) +
4077 struct_size(array_info, invert_mask,
4078 3 * bitmap_size), GFP_KERNEL);
4080 gpiod_put_array(descs);
4081 return ERR_PTR(-ENOMEM);
4084 memcpy(array, descs,
4085 struct_size(descs, desc, descs->ndescs + 1));
4089 array_info = (void *)(descs->desc + count);
4090 array_info->get_mask = array_info->invert_mask +
4092 array_info->set_mask = array_info->get_mask +
4095 array_info->desc = descs->desc;
4096 array_info->size = count;
4097 array_info->chip = gc;
4098 bitmap_set(array_info->get_mask, descs->ndescs,
4099 count - descs->ndescs);
4100 bitmap_set(array_info->set_mask, descs->ndescs,
4101 count - descs->ndescs);
4102 descs->info = array_info;
4104 /* Unmark array members which don't belong to the 'fast' chip */
4105 if (array_info && array_info->chip != gc) {
4106 __clear_bit(descs->ndescs, array_info->get_mask);
4107 __clear_bit(descs->ndescs, array_info->set_mask);
4110 * Detect array members which belong to the 'fast' chip
4111 * but their pins are not in hardware order.
4113 else if (array_info &&
4114 gpio_chip_hwgpio(desc) != descs->ndescs) {
4116 * Don't use fast path if all array members processed so
4117 * far belong to the same chip as this one but its pin
4118 * hardware number is different from its array index.
4120 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4123 __clear_bit(descs->ndescs,
4124 array_info->get_mask);
4125 __clear_bit(descs->ndescs,
4126 array_info->set_mask);
4128 } else if (array_info) {
4129 /* Exclude open drain or open source from fast output */
4130 if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4131 gpiochip_line_is_open_source(gc, descs->ndescs))
4132 __clear_bit(descs->ndescs,
4133 array_info->set_mask);
4134 /* Identify 'fast' pins which require invertion */
4135 if (gpiod_is_active_low(desc))
4136 __set_bit(descs->ndescs,
4137 array_info->invert_mask);
4144 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4145 array_info->chip->label, array_info->size,
4146 *array_info->get_mask, *array_info->set_mask,
4147 *array_info->invert_mask);
4150 EXPORT_SYMBOL_GPL(gpiod_get_array);
4153 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4155 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4156 * @con_id: function within the GPIO consumer
4157 * @flags: optional GPIO initialization flags
4159 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4160 * assigned to the requested function it will return NULL.
4162 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4164 enum gpiod_flags flags)
4166 struct gpio_descs *descs;
4168 descs = gpiod_get_array(dev, con_id, flags);
4169 if (gpiod_not_found(descs))
4174 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4177 * gpiod_put - dispose of a GPIO descriptor
4178 * @desc: GPIO descriptor to dispose of
4180 * No descriptor can be used after gpiod_put() has been called on it.
4182 void gpiod_put(struct gpio_desc *desc)
4187 EXPORT_SYMBOL_GPL(gpiod_put);
4190 * gpiod_put_array - dispose of multiple GPIO descriptors
4191 * @descs: struct gpio_descs containing an array of descriptors
4193 void gpiod_put_array(struct gpio_descs *descs)
4197 for (i = 0; i < descs->ndescs; i++)
4198 gpiod_put(descs->desc[i]);
4202 EXPORT_SYMBOL_GPL(gpiod_put_array);
4205 static int gpio_bus_match(struct device *dev, struct device_driver *drv)
4207 struct fwnode_handle *fwnode = dev_fwnode(dev);
4210 * Only match if the fwnode doesn't already have a proper struct device
4213 if (fwnode && fwnode->dev != dev)
4218 static int gpio_stub_drv_probe(struct device *dev)
4221 * The DT node of some GPIO chips have a "compatible" property, but
4222 * never have a struct device added and probed by a driver to register
4223 * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4224 * the consumers of the GPIO chip to get probe deferred forever because
4225 * they will be waiting for a device associated with the GPIO chip
4226 * firmware node to get added and bound to a driver.
4228 * To allow these consumers to probe, we associate the struct
4229 * gpio_device of the GPIO chip with the firmware node and then simply
4230 * bind it to this stub driver.
4235 static struct device_driver gpio_stub_drv = {
4236 .name = "gpio_stub_drv",
4237 .bus = &gpio_bus_type,
4238 .probe = gpio_stub_drv_probe,
4241 static int __init gpiolib_dev_init(void)
4245 /* Register GPIO sysfs bus */
4246 ret = bus_register(&gpio_bus_type);
4248 pr_err("gpiolib: could not register GPIO bus type\n");
4252 ret = driver_register(&gpio_stub_drv);
4254 pr_err("gpiolib: could not register GPIO stub driver\n");
4255 bus_unregister(&gpio_bus_type);
4259 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4261 pr_err("gpiolib: failed to allocate char dev region\n");
4262 driver_unregister(&gpio_stub_drv);
4263 bus_unregister(&gpio_bus_type);
4267 gpiolib_initialized = true;
4268 gpiochip_setup_devs();
4270 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4271 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4272 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4276 core_initcall(gpiolib_dev_init);
4278 #ifdef CONFIG_DEBUG_FS
4280 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4283 struct gpio_chip *gc = gdev->chip;
4284 unsigned gpio = gdev->base;
4285 struct gpio_desc *gdesc = &gdev->descs[0];
4290 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4291 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4293 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4299 gpiod_get_direction(gdesc);
4300 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4301 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4302 active_low = test_bit(FLAG_ACTIVE_LOW, &gdesc->flags);
4303 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s",
4304 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4305 is_out ? "out" : "in ",
4306 gc->get ? (gc->get(gc, i) ? "hi" : "lo") : "? ",
4307 is_irq ? "IRQ " : "",
4308 active_low ? "ACTIVE LOW" : "");
4309 seq_printf(s, "\n");
4313 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4315 unsigned long flags;
4316 struct gpio_device *gdev = NULL;
4317 loff_t index = *pos;
4321 spin_lock_irqsave(&gpio_lock, flags);
4322 list_for_each_entry(gdev, &gpio_devices, list)
4324 spin_unlock_irqrestore(&gpio_lock, flags);
4327 spin_unlock_irqrestore(&gpio_lock, flags);
4332 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4334 unsigned long flags;
4335 struct gpio_device *gdev = v;
4338 spin_lock_irqsave(&gpio_lock, flags);
4339 if (list_is_last(&gdev->list, &gpio_devices))
4342 ret = list_entry(gdev->list.next, struct gpio_device, list);
4343 spin_unlock_irqrestore(&gpio_lock, flags);
4351 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4355 static int gpiolib_seq_show(struct seq_file *s, void *v)
4357 struct gpio_device *gdev = v;
4358 struct gpio_chip *gc = gdev->chip;
4359 struct device *parent;
4362 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4363 dev_name(&gdev->dev));
4367 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4368 dev_name(&gdev->dev),
4369 gdev->base, gdev->base + gdev->ngpio - 1);
4370 parent = gc->parent;
4372 seq_printf(s, ", parent: %s/%s",
4373 parent->bus ? parent->bus->name : "no-bus",
4376 seq_printf(s, ", %s", gc->label);
4378 seq_printf(s, ", can sleep");
4379 seq_printf(s, ":\n");
4382 gc->dbg_show(s, gc);
4384 gpiolib_dbg_show(s, gdev);
4389 static const struct seq_operations gpiolib_sops = {
4390 .start = gpiolib_seq_start,
4391 .next = gpiolib_seq_next,
4392 .stop = gpiolib_seq_stop,
4393 .show = gpiolib_seq_show,
4395 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4397 static int __init gpiolib_debugfs_init(void)
4399 /* /sys/kernel/debug/gpio */
4400 debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4403 subsys_initcall(gpiolib_debugfs_init);
4405 #endif /* DEBUG_FS */