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 software 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 device *dev = chip->parent;
381 /* GPIO chip may not have a parent device whose properties we inspect. */
385 count = device_property_string_array_count(dev, "gpio-line-names");
389 if (count > gdev->ngpio) {
390 dev_warn(&gdev->dev, "gpio-line-names is length %d but should be at most length %d",
395 names = kcalloc(count, sizeof(*names), GFP_KERNEL);
399 ret = device_property_read_string_array(dev, "gpio-line-names",
402 dev_warn(&gdev->dev, "failed to read GPIO line names\n");
407 for (i = 0; i < count; i++)
408 gdev->descs[i].name = names[i];
415 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
419 p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
423 /* Assume by default all GPIOs are valid */
424 bitmap_fill(p, gc->ngpio);
429 static int gpiochip_alloc_valid_mask(struct gpio_chip *gc)
431 if (!(of_gpio_need_valid_mask(gc) || gc->init_valid_mask))
434 gc->valid_mask = gpiochip_allocate_mask(gc);
441 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
443 if (gc->init_valid_mask)
444 return gc->init_valid_mask(gc,
451 static void gpiochip_free_valid_mask(struct gpio_chip *gc)
453 bitmap_free(gc->valid_mask);
454 gc->valid_mask = NULL;
457 static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
459 if (gc->add_pin_ranges)
460 return gc->add_pin_ranges(gc);
465 bool gpiochip_line_is_valid(const struct gpio_chip *gc,
468 /* No mask means all valid */
469 if (likely(!gc->valid_mask))
471 return test_bit(offset, gc->valid_mask);
473 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
475 static void gpiodevice_release(struct device *dev)
477 struct gpio_device *gdev = dev_get_drvdata(dev);
479 list_del(&gdev->list);
480 ida_free(&gpio_ida, gdev->id);
481 kfree_const(gdev->label);
486 #ifdef CONFIG_GPIO_CDEV
487 #define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
488 #define gcdev_unregister(gdev) gpiolib_cdev_unregister((gdev))
491 * gpiolib_cdev_register() indirectly calls device_add(), which is still
492 * required even when cdev is not selected.
494 #define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
495 #define gcdev_unregister(gdev) device_del(&(gdev)->dev)
498 static int gpiochip_setup_dev(struct gpio_device *gdev)
502 ret = gcdev_register(gdev, gpio_devt);
506 ret = gpiochip_sysfs_register(gdev);
508 goto err_remove_device;
510 /* From this point, the .release() function cleans up gpio_device */
511 gdev->dev.release = gpiodevice_release;
512 dev_dbg(&gdev->dev, "registered GPIOs %d to %d on %s\n", gdev->base,
513 gdev->base + gdev->ngpio - 1, gdev->chip->label ? : "generic");
518 gcdev_unregister(gdev);
522 static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
524 struct gpio_desc *desc;
527 desc = gpiochip_get_desc(gc, hog->chip_hwnum);
529 chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
534 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
537 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
539 gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
540 __func__, gc->label, hog->chip_hwnum, rv);
543 static void machine_gpiochip_add(struct gpio_chip *gc)
545 struct gpiod_hog *hog;
547 mutex_lock(&gpio_machine_hogs_mutex);
549 list_for_each_entry(hog, &gpio_machine_hogs, list) {
550 if (!strcmp(gc->label, hog->chip_label))
551 gpiochip_machine_hog(gc, hog);
554 mutex_unlock(&gpio_machine_hogs_mutex);
557 static void gpiochip_setup_devs(void)
559 struct gpio_device *gdev;
562 list_for_each_entry(gdev, &gpio_devices, list) {
563 ret = gpiochip_setup_dev(gdev);
566 "Failed to initialize gpio device (%d)\n", ret);
570 int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
571 struct lock_class_key *lock_key,
572 struct lock_class_key *request_key)
578 struct gpio_device *gdev;
581 * First: allocate and populate the internal stat container, and
582 * set up the struct device.
584 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
587 gdev->dev.bus = &gpio_bus_type;
591 gdev->dev.parent = gc->parent;
592 gdev->dev.of_node = gc->parent->of_node;
595 of_gpio_dev_init(gc, gdev);
597 gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
603 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
607 device_initialize(&gdev->dev);
608 dev_set_drvdata(&gdev->dev, gdev);
609 if (gc->parent && gc->parent->driver)
610 gdev->owner = gc->parent->driver->owner;
612 /* TODO: remove chip->owner */
613 gdev->owner = gc->owner;
615 gdev->owner = THIS_MODULE;
617 gdev->descs = kcalloc(gc->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
620 goto err_free_dev_name;
623 if (gc->ngpio == 0) {
624 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
629 if (gc->ngpio > FASTPATH_NGPIO)
630 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
631 gc->ngpio, FASTPATH_NGPIO);
633 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
639 gdev->ngpio = gc->ngpio;
642 spin_lock_irqsave(&gpio_lock, flags);
645 * TODO: this allocates a Linux GPIO number base in the global
646 * GPIO numberspace for this chip. In the long run we want to
647 * get *rid* of this numberspace and use only descriptors, but
648 * it may be a pipe dream. It will not happen before we get rid
649 * of the sysfs interface anyways.
652 base = gpiochip_find_base(gc->ngpio);
655 spin_unlock_irqrestore(&gpio_lock, flags);
659 * TODO: it should not be necessary to reflect the assigned
660 * base outside of the GPIO subsystem. Go over drivers and
661 * see if anyone makes use of this, else drop this and assign
668 ret = gpiodev_add_to_list(gdev);
670 spin_unlock_irqrestore(&gpio_lock, flags);
674 for (i = 0; i < gc->ngpio; i++)
675 gdev->descs[i].gdev = gdev;
677 spin_unlock_irqrestore(&gpio_lock, flags);
679 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->notifier);
681 #ifdef CONFIG_PINCTRL
682 INIT_LIST_HEAD(&gdev->pin_ranges);
686 ret = gpiochip_set_desc_names(gc);
688 ret = devprop_gpiochip_set_names(gc);
690 goto err_remove_from_list;
692 ret = gpiochip_alloc_valid_mask(gc);
694 goto err_remove_from_list;
696 ret = of_gpiochip_add(gc);
698 goto err_free_gpiochip_mask;
700 ret = gpiochip_init_valid_mask(gc);
702 goto err_remove_of_chip;
704 for (i = 0; i < gc->ngpio; i++) {
705 struct gpio_desc *desc = &gdev->descs[i];
707 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
708 assign_bit(FLAG_IS_OUT,
709 &desc->flags, !gc->get_direction(gc, i));
711 assign_bit(FLAG_IS_OUT,
712 &desc->flags, !gc->direction_input);
716 ret = gpiochip_add_pin_ranges(gc);
718 goto err_remove_of_chip;
720 acpi_gpiochip_add(gc);
722 machine_gpiochip_add(gc);
724 ret = gpiochip_irqchip_init_valid_mask(gc);
726 goto err_remove_acpi_chip;
728 ret = gpiochip_irqchip_init_hw(gc);
730 goto err_remove_acpi_chip;
732 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
734 goto err_remove_irqchip_mask;
737 * By first adding the chardev, and then adding the device,
738 * we get a device node entry in sysfs under
739 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
740 * coldplug of device nodes and other udev business.
741 * We can do this only if gpiolib has been initialized.
742 * Otherwise, defer until later.
744 if (gpiolib_initialized) {
745 ret = gpiochip_setup_dev(gdev);
747 goto err_remove_irqchip;
752 gpiochip_irqchip_remove(gc);
753 err_remove_irqchip_mask:
754 gpiochip_irqchip_free_valid_mask(gc);
755 err_remove_acpi_chip:
756 acpi_gpiochip_remove(gc);
758 gpiochip_free_hogs(gc);
759 of_gpiochip_remove(gc);
760 err_free_gpiochip_mask:
761 gpiochip_remove_pin_ranges(gc);
762 gpiochip_free_valid_mask(gc);
763 err_remove_from_list:
764 spin_lock_irqsave(&gpio_lock, flags);
765 list_del(&gdev->list);
766 spin_unlock_irqrestore(&gpio_lock, flags);
768 kfree_const(gdev->label);
772 kfree(dev_name(&gdev->dev));
774 ida_free(&gpio_ida, gdev->id);
776 /* failures here can mean systems won't boot... */
777 if (ret != -EPROBE_DEFER) {
778 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
779 gdev->base, gdev->base + gdev->ngpio - 1,
780 gc->label ? : "generic", ret);
785 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
788 * gpiochip_get_data() - get per-subdriver data for the chip
792 * The per-subdriver data for the chip.
794 void *gpiochip_get_data(struct gpio_chip *gc)
796 return gc->gpiodev->data;
798 EXPORT_SYMBOL_GPL(gpiochip_get_data);
801 * gpiochip_remove() - unregister a gpio_chip
802 * @gc: the chip to unregister
804 * A gpio_chip with any GPIOs still requested may not be removed.
806 void gpiochip_remove(struct gpio_chip *gc)
808 struct gpio_device *gdev = gc->gpiodev;
812 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
813 gpiochip_sysfs_unregister(gdev);
814 gpiochip_free_hogs(gc);
815 /* Numb the device, cancelling all outstanding operations */
817 gpiochip_irqchip_remove(gc);
818 acpi_gpiochip_remove(gc);
819 of_gpiochip_remove(gc);
820 gpiochip_remove_pin_ranges(gc);
821 gpiochip_free_valid_mask(gc);
823 * We accept no more calls into the driver from this point, so
824 * NULL the driver data pointer
828 spin_lock_irqsave(&gpio_lock, flags);
829 for (i = 0; i < gdev->ngpio; i++) {
830 if (gpiochip_is_requested(gc, i))
833 spin_unlock_irqrestore(&gpio_lock, flags);
835 if (i != gdev->ngpio)
837 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
840 * The gpiochip side puts its use of the device to rest here:
841 * if there are no userspace clients, the chardev and device will
842 * be removed, else it will be dangling until the last user is
845 gcdev_unregister(gdev);
846 put_device(&gdev->dev);
848 EXPORT_SYMBOL_GPL(gpiochip_remove);
851 * gpiochip_find() - iterator for locating a specific gpio_chip
852 * @data: data to pass to match function
853 * @match: Callback function to check gpio_chip
855 * Similar to bus_find_device. It returns a reference to a gpio_chip as
856 * determined by a user supplied @match callback. The callback should return
857 * 0 if the device doesn't match and non-zero if it does. If the callback is
858 * non-zero, this function will return to the caller and not iterate over any
861 struct gpio_chip *gpiochip_find(void *data,
862 int (*match)(struct gpio_chip *gc,
865 struct gpio_device *gdev;
866 struct gpio_chip *gc = NULL;
869 spin_lock_irqsave(&gpio_lock, flags);
870 list_for_each_entry(gdev, &gpio_devices, list)
871 if (gdev->chip && match(gdev->chip, data)) {
876 spin_unlock_irqrestore(&gpio_lock, flags);
880 EXPORT_SYMBOL_GPL(gpiochip_find);
882 static int gpiochip_match_name(struct gpio_chip *gc, void *data)
884 const char *name = data;
886 return !strcmp(gc->label, name);
889 static struct gpio_chip *find_chip_by_name(const char *name)
891 return gpiochip_find((void *)name, gpiochip_match_name);
894 #ifdef CONFIG_GPIOLIB_IRQCHIP
897 * The following is irqchip helper code for gpiochips.
900 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
902 struct gpio_irq_chip *girq = &gc->irq;
907 return girq->init_hw(gc);
910 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
912 struct gpio_irq_chip *girq = &gc->irq;
914 if (!girq->init_valid_mask)
917 girq->valid_mask = gpiochip_allocate_mask(gc);
918 if (!girq->valid_mask)
921 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
926 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
928 bitmap_free(gc->irq.valid_mask);
929 gc->irq.valid_mask = NULL;
932 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
935 if (!gpiochip_line_is_valid(gc, offset))
937 /* No mask means all valid */
938 if (likely(!gc->irq.valid_mask))
940 return test_bit(offset, gc->irq.valid_mask);
942 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
944 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
947 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
949 * @gc: the gpiochip to set the irqchip hierarchical handler to
950 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
951 * will then percolate up to the parent
953 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
954 struct irq_chip *irqchip)
956 /* DT will deal with mapping each IRQ as we go along */
957 if (is_of_node(gc->irq.fwnode))
961 * This is for legacy and boardfile "irqchip" fwnodes: allocate
962 * irqs upfront instead of dynamically since we don't have the
963 * dynamic type of allocation that hardware description languages
964 * provide. Once all GPIO drivers using board files are gone from
965 * the kernel we can delete this code, but for a transitional period
966 * it is necessary to keep this around.
968 if (is_fwnode_irqchip(gc->irq.fwnode)) {
972 for (i = 0; i < gc->ngpio; i++) {
973 struct irq_fwspec fwspec;
974 unsigned int parent_hwirq;
975 unsigned int parent_type;
976 struct gpio_irq_chip *girq = &gc->irq;
979 * We call the child to parent translation function
980 * only to check if the child IRQ is valid or not.
981 * Just pick the rising edge type here as that is what
982 * we likely need to support.
984 ret = girq->child_to_parent_hwirq(gc, i,
985 IRQ_TYPE_EDGE_RISING,
989 chip_err(gc, "skip set-up on hwirq %d\n",
994 fwspec.fwnode = gc->irq.fwnode;
995 /* This is the hwirq for the GPIO line side of things */
996 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
997 /* Just pick something */
998 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
999 fwspec.param_count = 2;
1000 ret = __irq_domain_alloc_irqs(gc->irq.domain,
1001 /* just pick something */
1010 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1017 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1022 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1023 struct irq_fwspec *fwspec,
1024 unsigned long *hwirq,
1027 /* We support standard DT translation */
1028 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1029 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1032 /* This is for board files and others not using DT */
1033 if (is_fwnode_irqchip(fwspec->fwnode)) {
1036 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1039 WARN_ON(*type == IRQ_TYPE_NONE);
1045 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1047 unsigned int nr_irqs,
1050 struct gpio_chip *gc = d->host_data;
1051 irq_hw_number_t hwirq;
1052 unsigned int type = IRQ_TYPE_NONE;
1053 struct irq_fwspec *fwspec = data;
1055 unsigned int parent_hwirq;
1056 unsigned int parent_type;
1057 struct gpio_irq_chip *girq = &gc->irq;
1061 * The nr_irqs parameter is always one except for PCI multi-MSI
1062 * so this should not happen.
1064 WARN_ON(nr_irqs != 1);
1066 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1070 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1072 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1073 &parent_hwirq, &parent_type);
1075 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1078 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1081 * We set handle_bad_irq because the .set_type() should
1082 * always be invoked and set the right type of handler.
1084 irq_domain_set_info(d,
1093 /* This parent only handles asserted level IRQs */
1094 parent_arg = girq->populate_parent_alloc_arg(gc, parent_hwirq, parent_type);
1098 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1100 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1101 ret = irq_domain_alloc_irqs_parent(d, irq, 1, parent_arg);
1103 * If the parent irqdomain is msi, the interrupts have already
1104 * been allocated, so the EEXIST is good.
1106 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1110 "failed to allocate parent hwirq %d for hwirq %lu\n",
1111 parent_hwirq, hwirq);
1117 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1118 unsigned int offset)
1123 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1125 ops->activate = gpiochip_irq_domain_activate;
1126 ops->deactivate = gpiochip_irq_domain_deactivate;
1127 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1128 ops->free = irq_domain_free_irqs_common;
1131 * We only allow overriding the translate() function for
1132 * hierarchical chips, and this should only be done if the user
1133 * really need something other than 1:1 translation.
1135 if (!ops->translate)
1136 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1139 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1141 if (!gc->irq.child_to_parent_hwirq ||
1143 chip_err(gc, "missing irqdomain vital data\n");
1147 if (!gc->irq.child_offset_to_irq)
1148 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1150 if (!gc->irq.populate_parent_alloc_arg)
1151 gc->irq.populate_parent_alloc_arg =
1152 gpiochip_populate_parent_fwspec_twocell;
1154 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1156 gc->irq.domain = irq_domain_create_hierarchy(
1157 gc->irq.parent_domain,
1161 &gc->irq.child_irq_domain_ops,
1164 if (!gc->irq.domain)
1167 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1172 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1174 return !!gc->irq.parent_domain;
1177 void *gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1178 unsigned int parent_hwirq,
1179 unsigned int parent_type)
1181 struct irq_fwspec *fwspec;
1183 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1187 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1188 fwspec->param_count = 2;
1189 fwspec->param[0] = parent_hwirq;
1190 fwspec->param[1] = parent_type;
1194 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1196 void *gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1197 unsigned int parent_hwirq,
1198 unsigned int parent_type)
1200 struct irq_fwspec *fwspec;
1202 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1206 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1207 fwspec->param_count = 4;
1208 fwspec->param[0] = 0;
1209 fwspec->param[1] = parent_hwirq;
1210 fwspec->param[2] = 0;
1211 fwspec->param[3] = parent_type;
1215 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1219 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1224 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1229 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1232 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1233 * @d: the irqdomain used by this irqchip
1234 * @irq: the global irq number used by this GPIO irqchip irq
1235 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1237 * This function will set up the mapping for a certain IRQ line on a
1238 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1239 * stored inside the gpiochip.
1241 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1242 irq_hw_number_t hwirq)
1244 struct gpio_chip *gc = d->host_data;
1247 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1250 irq_set_chip_data(irq, gc);
1252 * This lock class tells lockdep that GPIO irqs are in a different
1253 * category than their parents, so it won't report false recursion.
1255 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1256 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1257 /* Chips that use nested thread handlers have them marked */
1258 if (gc->irq.threaded)
1259 irq_set_nested_thread(irq, 1);
1260 irq_set_noprobe(irq);
1262 if (gc->irq.num_parents == 1)
1263 ret = irq_set_parent(irq, gc->irq.parents[0]);
1264 else if (gc->irq.map)
1265 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1271 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1272 * is passed as default type.
1274 if (gc->irq.default_type != IRQ_TYPE_NONE)
1275 irq_set_irq_type(irq, gc->irq.default_type);
1279 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1281 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1283 struct gpio_chip *gc = d->host_data;
1285 if (gc->irq.threaded)
1286 irq_set_nested_thread(irq, 0);
1287 irq_set_chip_and_handler(irq, NULL, NULL);
1288 irq_set_chip_data(irq, NULL);
1290 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1292 static const struct irq_domain_ops gpiochip_domain_ops = {
1293 .map = gpiochip_irq_map,
1294 .unmap = gpiochip_irq_unmap,
1295 /* Virtually all GPIO irqchips are twocell:ed */
1296 .xlate = irq_domain_xlate_twocell,
1300 * TODO: move these activate/deactivate in under the hierarchicial
1301 * irqchip implementation as static once SPMI and SSBI (all external
1302 * users) are phased over.
1305 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1306 * @domain: The IRQ domain used by this IRQ chip
1307 * @data: Outermost irq_data associated with the IRQ
1308 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1310 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1311 * used as the activate function for the &struct irq_domain_ops. The host_data
1312 * for the IRQ domain must be the &struct gpio_chip.
1314 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1315 struct irq_data *data, bool reserve)
1317 struct gpio_chip *gc = domain->host_data;
1319 return gpiochip_lock_as_irq(gc, data->hwirq);
1321 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1324 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1325 * @domain: The IRQ domain used by this IRQ chip
1326 * @data: Outermost irq_data associated with the IRQ
1328 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1329 * be used as the deactivate function for the &struct irq_domain_ops. The
1330 * host_data for the IRQ domain must be the &struct gpio_chip.
1332 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1333 struct irq_data *data)
1335 struct gpio_chip *gc = domain->host_data;
1337 return gpiochip_unlock_as_irq(gc, data->hwirq);
1339 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1341 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1343 struct irq_domain *domain = gc->irq.domain;
1345 if (!gpiochip_irqchip_irq_valid(gc, offset))
1348 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1349 if (irq_domain_is_hierarchy(domain)) {
1350 struct irq_fwspec spec;
1352 spec.fwnode = domain->fwnode;
1353 spec.param_count = 2;
1354 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1355 spec.param[1] = IRQ_TYPE_NONE;
1357 return irq_create_fwspec_mapping(&spec);
1361 return irq_create_mapping(domain, offset);
1364 static int gpiochip_irq_reqres(struct irq_data *d)
1366 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1368 return gpiochip_reqres_irq(gc, d->hwirq);
1371 static void gpiochip_irq_relres(struct irq_data *d)
1373 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1375 gpiochip_relres_irq(gc, d->hwirq);
1378 static void gpiochip_irq_mask(struct irq_data *d)
1380 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1382 if (gc->irq.irq_mask)
1383 gc->irq.irq_mask(d);
1384 gpiochip_disable_irq(gc, d->hwirq);
1387 static void gpiochip_irq_unmask(struct irq_data *d)
1389 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1391 gpiochip_enable_irq(gc, d->hwirq);
1392 if (gc->irq.irq_unmask)
1393 gc->irq.irq_unmask(d);
1396 static void gpiochip_irq_enable(struct irq_data *d)
1398 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1400 gpiochip_enable_irq(gc, d->hwirq);
1401 gc->irq.irq_enable(d);
1404 static void gpiochip_irq_disable(struct irq_data *d)
1406 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1408 gc->irq.irq_disable(d);
1409 gpiochip_disable_irq(gc, d->hwirq);
1412 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1414 struct irq_chip *irqchip = gc->irq.chip;
1416 if (!irqchip->irq_request_resources &&
1417 !irqchip->irq_release_resources) {
1418 irqchip->irq_request_resources = gpiochip_irq_reqres;
1419 irqchip->irq_release_resources = gpiochip_irq_relres;
1421 if (WARN_ON(gc->irq.irq_enable))
1423 /* Check if the irqchip already has this hook... */
1424 if (irqchip->irq_enable == gpiochip_irq_enable ||
1425 irqchip->irq_mask == gpiochip_irq_mask) {
1427 * ...and if so, give a gentle warning that this is bad
1431 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1435 if (irqchip->irq_disable) {
1436 gc->irq.irq_disable = irqchip->irq_disable;
1437 irqchip->irq_disable = gpiochip_irq_disable;
1439 gc->irq.irq_mask = irqchip->irq_mask;
1440 irqchip->irq_mask = gpiochip_irq_mask;
1443 if (irqchip->irq_enable) {
1444 gc->irq.irq_enable = irqchip->irq_enable;
1445 irqchip->irq_enable = gpiochip_irq_enable;
1447 gc->irq.irq_unmask = irqchip->irq_unmask;
1448 irqchip->irq_unmask = gpiochip_irq_unmask;
1453 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1454 * @gc: the GPIO chip to add the IRQ chip to
1455 * @lock_key: lockdep class for IRQ lock
1456 * @request_key: lockdep class for IRQ request
1458 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1459 struct lock_class_key *lock_key,
1460 struct lock_class_key *request_key)
1462 struct irq_chip *irqchip = gc->irq.chip;
1463 const struct irq_domain_ops *ops = NULL;
1464 struct device_node *np;
1471 if (gc->irq.parent_handler && gc->can_sleep) {
1472 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1476 np = gc->gpiodev->dev.of_node;
1477 type = gc->irq.default_type;
1480 * Specifying a default trigger is a terrible idea if DT or ACPI is
1481 * used to configure the interrupts, as you may end up with
1482 * conflicting triggers. Tell the user, and reset to NONE.
1484 if (WARN(np && type != IRQ_TYPE_NONE,
1485 "%s: Ignoring %u default trigger\n", np->full_name, type))
1486 type = IRQ_TYPE_NONE;
1488 if (has_acpi_companion(gc->parent) && type != IRQ_TYPE_NONE) {
1489 acpi_handle_warn(ACPI_HANDLE(gc->parent),
1490 "Ignoring %u default trigger\n", type);
1491 type = IRQ_TYPE_NONE;
1495 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1497 gc->to_irq = gpiochip_to_irq;
1498 gc->irq.default_type = type;
1499 gc->irq.lock_key = lock_key;
1500 gc->irq.request_key = request_key;
1502 /* If a parent irqdomain is provided, let's build a hierarchy */
1503 if (gpiochip_hierarchy_is_hierarchical(gc)) {
1504 int ret = gpiochip_hierarchy_add_domain(gc);
1508 /* Some drivers provide custom irqdomain ops */
1509 if (gc->irq.domain_ops)
1510 ops = gc->irq.domain_ops;
1513 ops = &gpiochip_domain_ops;
1514 gc->irq.domain = irq_domain_add_simple(np,
1518 if (!gc->irq.domain)
1522 if (gc->irq.parent_handler) {
1523 void *data = gc->irq.parent_handler_data ?: gc;
1525 for (i = 0; i < gc->irq.num_parents; i++) {
1527 * The parent IRQ chip is already using the chip_data
1528 * for this IRQ chip, so our callbacks simply use the
1531 irq_set_chained_handler_and_data(gc->irq.parents[i],
1532 gc->irq.parent_handler,
1537 gpiochip_set_irq_hooks(gc);
1539 acpi_gpiochip_request_interrupts(gc);
1545 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1546 * @gc: the gpiochip to remove the irqchip from
1548 * This is called only from gpiochip_remove()
1550 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1552 struct irq_chip *irqchip = gc->irq.chip;
1553 unsigned int offset;
1555 acpi_gpiochip_free_interrupts(gc);
1557 if (irqchip && gc->irq.parent_handler) {
1558 struct gpio_irq_chip *irq = &gc->irq;
1561 for (i = 0; i < irq->num_parents; i++)
1562 irq_set_chained_handler_and_data(irq->parents[i],
1566 /* Remove all IRQ mappings and delete the domain */
1567 if (gc->irq.domain) {
1570 for (offset = 0; offset < gc->ngpio; offset++) {
1571 if (!gpiochip_irqchip_irq_valid(gc, offset))
1574 irq = irq_find_mapping(gc->irq.domain, offset);
1575 irq_dispose_mapping(irq);
1578 irq_domain_remove(gc->irq.domain);
1582 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1583 irqchip->irq_request_resources = NULL;
1584 irqchip->irq_release_resources = NULL;
1586 if (irqchip->irq_enable == gpiochip_irq_enable) {
1587 irqchip->irq_enable = gc->irq.irq_enable;
1588 irqchip->irq_disable = gc->irq.irq_disable;
1591 gc->irq.irq_enable = NULL;
1592 gc->irq.irq_disable = NULL;
1593 gc->irq.chip = NULL;
1595 gpiochip_irqchip_free_valid_mask(gc);
1599 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1600 * @gc: the gpiochip to add the irqchip to
1601 * @domain: the irqdomain to add to the gpiochip
1603 * This function adds an IRQ domain to the gpiochip.
1605 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1606 struct irq_domain *domain)
1611 gc->to_irq = gpiochip_to_irq;
1612 gc->irq.domain = domain;
1616 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1618 #else /* CONFIG_GPIOLIB_IRQCHIP */
1620 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1621 struct lock_class_key *lock_key,
1622 struct lock_class_key *request_key)
1626 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1628 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1633 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1637 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1640 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1643 * gpiochip_generic_request() - request the gpio function for a pin
1644 * @gc: the gpiochip owning the GPIO
1645 * @offset: the offset of the GPIO to request for GPIO function
1647 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
1649 #ifdef CONFIG_PINCTRL
1650 if (list_empty(&gc->gpiodev->pin_ranges))
1654 return pinctrl_gpio_request(gc->gpiodev->base + offset);
1656 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1659 * gpiochip_generic_free() - free the gpio function from a pin
1660 * @gc: the gpiochip to request the gpio function for
1661 * @offset: the offset of the GPIO to free from GPIO function
1663 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
1665 #ifdef CONFIG_PINCTRL
1666 if (list_empty(&gc->gpiodev->pin_ranges))
1670 pinctrl_gpio_free(gc->gpiodev->base + offset);
1672 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1675 * gpiochip_generic_config() - apply configuration for a pin
1676 * @gc: the gpiochip owning the GPIO
1677 * @offset: the offset of the GPIO to apply the configuration
1678 * @config: the configuration to be applied
1680 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
1681 unsigned long config)
1683 return pinctrl_gpio_set_config(gc->gpiodev->base + offset, config);
1685 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1687 #ifdef CONFIG_PINCTRL
1690 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1691 * @gc: the gpiochip to add the range for
1692 * @pctldev: the pin controller to map to
1693 * @gpio_offset: the start offset in the current gpio_chip number space
1694 * @pin_group: name of the pin group inside the pin controller
1696 * Calling this function directly from a DeviceTree-supported
1697 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1698 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1699 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1701 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
1702 struct pinctrl_dev *pctldev,
1703 unsigned int gpio_offset, const char *pin_group)
1705 struct gpio_pin_range *pin_range;
1706 struct gpio_device *gdev = gc->gpiodev;
1709 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1711 chip_err(gc, "failed to allocate pin ranges\n");
1715 /* Use local offset as range ID */
1716 pin_range->range.id = gpio_offset;
1717 pin_range->range.gc = gc;
1718 pin_range->range.name = gc->label;
1719 pin_range->range.base = gdev->base + gpio_offset;
1720 pin_range->pctldev = pctldev;
1722 ret = pinctrl_get_group_pins(pctldev, pin_group,
1723 &pin_range->range.pins,
1724 &pin_range->range.npins);
1730 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1732 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1733 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1734 pinctrl_dev_get_devname(pctldev), pin_group);
1736 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1740 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1743 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1744 * @gc: the gpiochip to add the range for
1745 * @pinctl_name: the dev_name() of the pin controller to map to
1746 * @gpio_offset: the start offset in the current gpio_chip number space
1747 * @pin_offset: the start offset in the pin controller number space
1748 * @npins: the number of pins from the offset of each pin space (GPIO and
1749 * pin controller) to accumulate in this range
1752 * 0 on success, or a negative error-code on failure.
1754 * Calling this function directly from a DeviceTree-supported
1755 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1756 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1757 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1759 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
1760 unsigned int gpio_offset, unsigned int pin_offset,
1763 struct gpio_pin_range *pin_range;
1764 struct gpio_device *gdev = gc->gpiodev;
1767 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1769 chip_err(gc, "failed to allocate pin ranges\n");
1773 /* Use local offset as range ID */
1774 pin_range->range.id = gpio_offset;
1775 pin_range->range.gc = gc;
1776 pin_range->range.name = gc->label;
1777 pin_range->range.base = gdev->base + gpio_offset;
1778 pin_range->range.pin_base = pin_offset;
1779 pin_range->range.npins = npins;
1780 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1782 if (IS_ERR(pin_range->pctldev)) {
1783 ret = PTR_ERR(pin_range->pctldev);
1784 chip_err(gc, "could not create pin range\n");
1788 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1789 gpio_offset, gpio_offset + npins - 1,
1791 pin_offset, pin_offset + npins - 1);
1793 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1797 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1800 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1801 * @gc: the chip to remove all the mappings for
1803 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
1805 struct gpio_pin_range *pin_range, *tmp;
1806 struct gpio_device *gdev = gc->gpiodev;
1808 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1809 list_del(&pin_range->node);
1810 pinctrl_remove_gpio_range(pin_range->pctldev,
1815 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1817 #endif /* CONFIG_PINCTRL */
1819 /* These "optional" allocation calls help prevent drivers from stomping
1820 * on each other, and help provide better diagnostics in debugfs.
1821 * They're called even less than the "set direction" calls.
1823 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
1825 struct gpio_chip *gc = desc->gdev->chip;
1827 unsigned long flags;
1831 label = kstrdup_const(label, GFP_KERNEL);
1836 spin_lock_irqsave(&gpio_lock, flags);
1838 /* NOTE: gpio_request() can be called in early boot,
1839 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1842 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1843 desc_set_label(desc, label ? : "?");
1846 goto out_free_unlock;
1850 /* gc->request may sleep */
1851 spin_unlock_irqrestore(&gpio_lock, flags);
1852 offset = gpio_chip_hwgpio(desc);
1853 if (gpiochip_line_is_valid(gc, offset))
1854 ret = gc->request(gc, offset);
1857 spin_lock_irqsave(&gpio_lock, flags);
1860 desc_set_label(desc, NULL);
1861 clear_bit(FLAG_REQUESTED, &desc->flags);
1862 goto out_free_unlock;
1865 if (gc->get_direction) {
1866 /* gc->get_direction may sleep */
1867 spin_unlock_irqrestore(&gpio_lock, flags);
1868 gpiod_get_direction(desc);
1869 spin_lock_irqsave(&gpio_lock, flags);
1871 spin_unlock_irqrestore(&gpio_lock, flags);
1875 spin_unlock_irqrestore(&gpio_lock, flags);
1881 * This descriptor validation needs to be inserted verbatim into each
1882 * function taking a descriptor, so we need to use a preprocessor
1883 * macro to avoid endless duplication. If the desc is NULL it is an
1884 * optional GPIO and calls should just bail out.
1886 static int validate_desc(const struct gpio_desc *desc, const char *func)
1891 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
1892 return PTR_ERR(desc);
1895 pr_warn("%s: invalid GPIO (no device)\n", func);
1898 if (!desc->gdev->chip) {
1899 dev_warn(&desc->gdev->dev,
1900 "%s: backing chip is gone\n", func);
1906 #define VALIDATE_DESC(desc) do { \
1907 int __valid = validate_desc(desc, __func__); \
1912 #define VALIDATE_DESC_VOID(desc) do { \
1913 int __valid = validate_desc(desc, __func__); \
1918 int gpiod_request(struct gpio_desc *desc, const char *label)
1920 int ret = -EPROBE_DEFER;
1921 struct gpio_device *gdev;
1923 VALIDATE_DESC(desc);
1926 if (try_module_get(gdev->owner)) {
1927 ret = gpiod_request_commit(desc, label);
1929 module_put(gdev->owner);
1931 get_device(&gdev->dev);
1935 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
1940 static bool gpiod_free_commit(struct gpio_desc *desc)
1943 unsigned long flags;
1944 struct gpio_chip *gc;
1948 gpiod_unexport(desc);
1950 spin_lock_irqsave(&gpio_lock, flags);
1952 gc = desc->gdev->chip;
1953 if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
1955 spin_unlock_irqrestore(&gpio_lock, flags);
1956 might_sleep_if(gc->can_sleep);
1957 gc->free(gc, gpio_chip_hwgpio(desc));
1958 spin_lock_irqsave(&gpio_lock, flags);
1960 kfree_const(desc->label);
1961 desc_set_label(desc, NULL);
1962 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1963 clear_bit(FLAG_REQUESTED, &desc->flags);
1964 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1965 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1966 clear_bit(FLAG_PULL_UP, &desc->flags);
1967 clear_bit(FLAG_PULL_DOWN, &desc->flags);
1968 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
1969 clear_bit(FLAG_EDGE_RISING, &desc->flags);
1970 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
1971 clear_bit(FLAG_IS_HOGGED, &desc->flags);
1972 #ifdef CONFIG_OF_DYNAMIC
1975 #ifdef CONFIG_GPIO_CDEV
1976 WRITE_ONCE(desc->debounce_period_us, 0);
1981 spin_unlock_irqrestore(&gpio_lock, flags);
1982 blocking_notifier_call_chain(&desc->gdev->notifier,
1983 GPIOLINE_CHANGED_RELEASED, desc);
1988 void gpiod_free(struct gpio_desc *desc)
1990 if (desc && desc->gdev && gpiod_free_commit(desc)) {
1991 module_put(desc->gdev->owner);
1992 put_device(&desc->gdev->dev);
1994 WARN_ON(extra_checks);
1999 * gpiochip_is_requested - return string iff signal was requested
2000 * @gc: controller managing the signal
2001 * @offset: of signal within controller's 0..(ngpio - 1) range
2003 * Returns NULL if the GPIO is not currently requested, else a string.
2004 * The string returned is the label passed to gpio_request(); if none has been
2005 * passed it is a meaningless, non-NULL constant.
2007 * This function is for use by GPIO controller drivers. The label can
2008 * help with diagnostics, and knowing that the signal is used as a GPIO
2009 * can help avoid accidentally multiplexing it to another controller.
2011 const char *gpiochip_is_requested(struct gpio_chip *gc, unsigned int offset)
2013 struct gpio_desc *desc;
2015 if (offset >= gc->ngpio)
2018 desc = gpiochip_get_desc(gc, offset);
2022 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2026 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2029 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2031 * @hwnum: hardware number of the GPIO for which to request the descriptor
2032 * @label: label for the GPIO
2033 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2034 * specify things like line inversion semantics with the machine flags
2035 * such as GPIO_OUT_LOW
2036 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2037 * can be used to specify consumer semantics such as open drain
2039 * Function allows GPIO chip drivers to request and use their own GPIO
2040 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2041 * function will not increase reference count of the GPIO chip module. This
2042 * allows the GPIO chip module to be unloaded as needed (we assume that the
2043 * GPIO chip driver handles freeing the GPIOs it has requested).
2046 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2049 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2052 enum gpio_lookup_flags lflags,
2053 enum gpiod_flags dflags)
2055 struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2059 chip_err(gc, "failed to get GPIO descriptor\n");
2063 ret = gpiod_request_commit(desc, label);
2065 return ERR_PTR(ret);
2067 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2069 chip_err(gc, "setup of own GPIO %s failed\n", label);
2070 gpiod_free_commit(desc);
2071 return ERR_PTR(ret);
2076 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2079 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2080 * @desc: GPIO descriptor to free
2082 * Function frees the given GPIO requested previously with
2083 * gpiochip_request_own_desc().
2085 void gpiochip_free_own_desc(struct gpio_desc *desc)
2088 gpiod_free_commit(desc);
2090 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2093 * Drivers MUST set GPIO direction before making get/set calls. In
2094 * some cases this is done in early boot, before IRQs are enabled.
2096 * As a rule these aren't called more than once (except for drivers
2097 * using the open-drain emulation idiom) so these are natural places
2098 * to accumulate extra debugging checks. Note that we can't (yet)
2099 * rely on gpio_request() having been called beforehand.
2102 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2103 unsigned long config)
2105 if (!gc->set_config)
2108 return gc->set_config(gc, offset, config);
2111 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2112 enum pin_config_param mode,
2115 struct gpio_chip *gc = desc->gdev->chip;
2116 unsigned long config;
2118 config = pinconf_to_config_packed(mode, argument);
2119 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2122 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2123 enum pin_config_param mode,
2126 struct device *dev = &desc->gdev->dev;
2127 int gpio = gpio_chip_hwgpio(desc);
2130 ret = gpio_set_config_with_argument(desc, mode, argument);
2131 if (ret != -ENOTSUPP)
2135 case PIN_CONFIG_PERSIST_STATE:
2136 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2145 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2147 return gpio_set_config_with_argument(desc, mode, 0);
2150 static int gpio_set_bias(struct gpio_desc *desc)
2152 enum pin_config_param bias;
2155 if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2156 bias = PIN_CONFIG_BIAS_DISABLE;
2157 else if (test_bit(FLAG_PULL_UP, &desc->flags))
2158 bias = PIN_CONFIG_BIAS_PULL_UP;
2159 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2160 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2165 case PIN_CONFIG_BIAS_PULL_DOWN:
2166 case PIN_CONFIG_BIAS_PULL_UP:
2175 return gpio_set_config_with_argument_optional(desc, bias, arg);
2178 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2180 return gpio_set_config_with_argument_optional(desc,
2181 PIN_CONFIG_INPUT_DEBOUNCE,
2186 * gpiod_direction_input - set the GPIO direction to input
2187 * @desc: GPIO to set to input
2189 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2190 * be called safely on it.
2192 * Return 0 in case of success, else an error code.
2194 int gpiod_direction_input(struct gpio_desc *desc)
2196 struct gpio_chip *gc;
2199 VALIDATE_DESC(desc);
2200 gc = desc->gdev->chip;
2203 * It is legal to have no .get() and .direction_input() specified if
2204 * the chip is output-only, but you can't specify .direction_input()
2205 * and not support the .get() operation, that doesn't make sense.
2207 if (!gc->get && gc->direction_input) {
2209 "%s: missing get() but have direction_input()\n",
2215 * If we have a .direction_input() callback, things are simple,
2216 * just call it. Else we are some input-only chip so try to check the
2217 * direction (if .get_direction() is supported) else we silently
2218 * assume we are in input mode after this.
2220 if (gc->direction_input) {
2221 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2222 } else if (gc->get_direction &&
2223 (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2225 "%s: missing direction_input() operation and line is output\n",
2230 clear_bit(FLAG_IS_OUT, &desc->flags);
2231 ret = gpio_set_bias(desc);
2234 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2238 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2240 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2242 struct gpio_chip *gc = desc->gdev->chip;
2247 * It's OK not to specify .direction_output() if the gpiochip is
2248 * output-only, but if there is then not even a .set() operation it
2249 * is pretty tricky to drive the output line.
2251 if (!gc->set && !gc->direction_output) {
2253 "%s: missing set() and direction_output() operations\n",
2258 if (gc->direction_output) {
2259 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2261 /* Check that we are in output mode if we can */
2262 if (gc->get_direction &&
2263 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2265 "%s: missing direction_output() operation\n",
2270 * If we can't actively set the direction, we are some
2271 * output-only chip, so just drive the output as desired.
2273 gc->set(gc, gpio_chip_hwgpio(desc), val);
2277 set_bit(FLAG_IS_OUT, &desc->flags);
2278 trace_gpio_value(desc_to_gpio(desc), 0, val);
2279 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2284 * gpiod_direction_output_raw - set the GPIO direction to output
2285 * @desc: GPIO to set to output
2286 * @value: initial output value of the GPIO
2288 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2289 * be called safely on it. The initial value of the output must be specified
2290 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2292 * Return 0 in case of success, else an error code.
2294 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2296 VALIDATE_DESC(desc);
2297 return gpiod_direction_output_raw_commit(desc, value);
2299 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2302 * gpiod_direction_output - set the GPIO direction to output
2303 * @desc: GPIO to set to output
2304 * @value: initial output value of the GPIO
2306 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2307 * be called safely on it. The initial value of the output must be specified
2308 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2311 * Return 0 in case of success, else an error code.
2313 int gpiod_direction_output(struct gpio_desc *desc, int value)
2317 VALIDATE_DESC(desc);
2318 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2323 /* GPIOs used for enabled IRQs shall not be set as output */
2324 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2325 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2327 "%s: tried to set a GPIO tied to an IRQ as output\n",
2332 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2333 /* First see if we can enable open drain in hardware */
2334 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2336 goto set_output_value;
2337 /* Emulate open drain by not actively driving the line high */
2339 ret = gpiod_direction_input(desc);
2340 goto set_output_flag;
2343 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2344 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2346 goto set_output_value;
2347 /* Emulate open source by not actively driving the line low */
2349 ret = gpiod_direction_input(desc);
2350 goto set_output_flag;
2353 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2357 ret = gpio_set_bias(desc);
2360 return gpiod_direction_output_raw_commit(desc, value);
2364 * When emulating open-source or open-drain functionalities by not
2365 * actively driving the line (setting mode to input) we still need to
2366 * set the IS_OUT flag or otherwise we won't be able to set the line
2370 set_bit(FLAG_IS_OUT, &desc->flags);
2373 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2376 * gpiod_set_config - sets @config for a GPIO
2377 * @desc: descriptor of the GPIO for which to set the configuration
2378 * @config: Same packed config format as generic pinconf
2381 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2384 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2386 struct gpio_chip *gc;
2388 VALIDATE_DESC(desc);
2389 gc = desc->gdev->chip;
2391 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2393 EXPORT_SYMBOL_GPL(gpiod_set_config);
2396 * gpiod_set_debounce - sets @debounce time for a GPIO
2397 * @desc: descriptor of the GPIO for which to set debounce time
2398 * @debounce: debounce time in microseconds
2401 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2404 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2406 unsigned long config;
2408 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2409 return gpiod_set_config(desc, config);
2411 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2414 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2415 * @desc: descriptor of the GPIO for which to configure persistence
2416 * @transitory: True to lose state on suspend or reset, false for persistence
2419 * 0 on success, otherwise a negative error code.
2421 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2423 VALIDATE_DESC(desc);
2425 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2426 * persistence state.
2428 assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2430 /* If the driver supports it, set the persistence state now */
2431 return gpio_set_config_with_argument_optional(desc,
2432 PIN_CONFIG_PERSIST_STATE,
2435 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2438 * gpiod_is_active_low - test whether a GPIO is active-low or not
2439 * @desc: the gpio descriptor to test
2441 * Returns 1 if the GPIO is active-low, 0 otherwise.
2443 int gpiod_is_active_low(const struct gpio_desc *desc)
2445 VALIDATE_DESC(desc);
2446 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2448 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2451 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2452 * @desc: the gpio descriptor to change
2454 void gpiod_toggle_active_low(struct gpio_desc *desc)
2456 VALIDATE_DESC_VOID(desc);
2457 change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2459 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2461 /* I/O calls are only valid after configuration completed; the relevant
2462 * "is this a valid GPIO" error checks should already have been done.
2464 * "Get" operations are often inlinable as reading a pin value register,
2465 * and masking the relevant bit in that register.
2467 * When "set" operations are inlinable, they involve writing that mask to
2468 * one register to set a low value, or a different register to set it high.
2469 * Otherwise locking is needed, so there may be little value to inlining.
2471 *------------------------------------------------------------------------
2473 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2474 * have requested the GPIO. That can include implicit requesting by
2475 * a direction setting call. Marking a gpio as requested locks its chip
2476 * in memory, guaranteeing that these table lookups need no more locking
2477 * and that gpiochip_remove() will fail.
2479 * REVISIT when debugging, consider adding some instrumentation to ensure
2480 * that the GPIO was actually requested.
2483 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2485 struct gpio_chip *gc;
2489 gc = desc->gdev->chip;
2490 offset = gpio_chip_hwgpio(desc);
2491 value = gc->get ? gc->get(gc, offset) : -EIO;
2492 value = value < 0 ? value : !!value;
2493 trace_gpio_value(desc_to_gpio(desc), 1, value);
2497 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2498 unsigned long *mask, unsigned long *bits)
2500 if (gc->get_multiple) {
2501 return gc->get_multiple(gc, mask, bits);
2502 } else if (gc->get) {
2505 for_each_set_bit(i, mask, gc->ngpio) {
2506 value = gc->get(gc, i);
2509 __assign_bit(i, bits, value);
2516 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2517 unsigned int array_size,
2518 struct gpio_desc **desc_array,
2519 struct gpio_array *array_info,
2520 unsigned long *value_bitmap)
2525 * Validate array_info against desc_array and its size.
2526 * It should immediately follow desc_array if both
2527 * have been obtained from the same gpiod_get_array() call.
2529 if (array_info && array_info->desc == desc_array &&
2530 array_size <= array_info->size &&
2531 (void *)array_info == desc_array + array_info->size) {
2533 WARN_ON(array_info->chip->can_sleep);
2535 ret = gpio_chip_get_multiple(array_info->chip,
2536 array_info->get_mask,
2541 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2542 bitmap_xor(value_bitmap, value_bitmap,
2543 array_info->invert_mask, array_size);
2545 i = find_first_zero_bit(array_info->get_mask, array_size);
2546 if (i == array_size)
2552 while (i < array_size) {
2553 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2554 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2555 unsigned long *mask, *bits;
2558 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2561 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2563 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2568 bits = mask + BITS_TO_LONGS(gc->ngpio);
2569 bitmap_zero(mask, gc->ngpio);
2572 WARN_ON(gc->can_sleep);
2574 /* collect all inputs belonging to the same chip */
2577 const struct gpio_desc *desc = desc_array[i];
2578 int hwgpio = gpio_chip_hwgpio(desc);
2580 __set_bit(hwgpio, mask);
2584 i = find_next_zero_bit(array_info->get_mask,
2586 } while ((i < array_size) &&
2587 (desc_array[i]->gdev->chip == gc));
2589 ret = gpio_chip_get_multiple(gc, mask, bits);
2591 if (mask != fastpath)
2596 for (j = first; j < i; ) {
2597 const struct gpio_desc *desc = desc_array[j];
2598 int hwgpio = gpio_chip_hwgpio(desc);
2599 int value = test_bit(hwgpio, bits);
2601 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2603 __assign_bit(j, value_bitmap, value);
2604 trace_gpio_value(desc_to_gpio(desc), 1, value);
2608 j = find_next_zero_bit(array_info->get_mask, i,
2612 if (mask != fastpath)
2619 * gpiod_get_raw_value() - return a gpio's raw value
2620 * @desc: gpio whose value will be returned
2622 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2623 * its ACTIVE_LOW status, or negative errno on failure.
2625 * This function can be called from contexts where we cannot sleep, and will
2626 * complain if the GPIO chip functions potentially sleep.
2628 int gpiod_get_raw_value(const struct gpio_desc *desc)
2630 VALIDATE_DESC(desc);
2631 /* Should be using gpiod_get_raw_value_cansleep() */
2632 WARN_ON(desc->gdev->chip->can_sleep);
2633 return gpiod_get_raw_value_commit(desc);
2635 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2638 * gpiod_get_value() - return a gpio's value
2639 * @desc: gpio whose value will be returned
2641 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2642 * account, or negative errno on failure.
2644 * This function can be called from contexts where we cannot sleep, and will
2645 * complain if the GPIO chip functions potentially sleep.
2647 int gpiod_get_value(const struct gpio_desc *desc)
2651 VALIDATE_DESC(desc);
2652 /* Should be using gpiod_get_value_cansleep() */
2653 WARN_ON(desc->gdev->chip->can_sleep);
2655 value = gpiod_get_raw_value_commit(desc);
2659 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2664 EXPORT_SYMBOL_GPL(gpiod_get_value);
2667 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2668 * @array_size: number of elements in the descriptor array / value bitmap
2669 * @desc_array: array of GPIO descriptors whose values will be read
2670 * @array_info: information on applicability of fast bitmap processing path
2671 * @value_bitmap: bitmap to store the read values
2673 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2674 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2675 * else an error code.
2677 * This function can be called from contexts where we cannot sleep,
2678 * and it will complain if the GPIO chip functions potentially sleep.
2680 int gpiod_get_raw_array_value(unsigned int array_size,
2681 struct gpio_desc **desc_array,
2682 struct gpio_array *array_info,
2683 unsigned long *value_bitmap)
2687 return gpiod_get_array_value_complex(true, false, array_size,
2688 desc_array, array_info,
2691 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2694 * gpiod_get_array_value() - read values from an array of GPIOs
2695 * @array_size: number of elements in the descriptor array / value bitmap
2696 * @desc_array: array of GPIO descriptors whose values will be read
2697 * @array_info: information on applicability of fast bitmap processing path
2698 * @value_bitmap: bitmap to store the read values
2700 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2701 * into account. Return 0 in case of success, else an error code.
2703 * This function can be called from contexts where we cannot sleep,
2704 * and it will complain if the GPIO chip functions potentially sleep.
2706 int gpiod_get_array_value(unsigned int array_size,
2707 struct gpio_desc **desc_array,
2708 struct gpio_array *array_info,
2709 unsigned long *value_bitmap)
2713 return gpiod_get_array_value_complex(false, false, array_size,
2714 desc_array, array_info,
2717 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2720 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2721 * @desc: gpio descriptor whose state need to be set.
2722 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2724 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2727 struct gpio_chip *gc = desc->gdev->chip;
2728 int offset = gpio_chip_hwgpio(desc);
2731 ret = gc->direction_input(gc, offset);
2733 ret = gc->direction_output(gc, offset, 0);
2735 set_bit(FLAG_IS_OUT, &desc->flags);
2737 trace_gpio_direction(desc_to_gpio(desc), value, ret);
2740 "%s: Error in set_value for open drain err %d\n",
2745 * _gpio_set_open_source_value() - Set the open source gpio's value.
2746 * @desc: gpio descriptor whose state need to be set.
2747 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2749 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2752 struct gpio_chip *gc = desc->gdev->chip;
2753 int offset = gpio_chip_hwgpio(desc);
2756 ret = gc->direction_output(gc, offset, 1);
2758 set_bit(FLAG_IS_OUT, &desc->flags);
2760 ret = gc->direction_input(gc, offset);
2762 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
2765 "%s: Error in set_value for open source err %d\n",
2769 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2771 struct gpio_chip *gc;
2773 gc = desc->gdev->chip;
2774 trace_gpio_value(desc_to_gpio(desc), 0, value);
2775 gc->set(gc, gpio_chip_hwgpio(desc), value);
2779 * set multiple outputs on the same chip;
2780 * use the chip's set_multiple function if available;
2781 * otherwise set the outputs sequentially;
2782 * @chip: the GPIO chip we operate on
2783 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2784 * defines which outputs are to be changed
2785 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2786 * defines the values the outputs specified by mask are to be set to
2788 static void gpio_chip_set_multiple(struct gpio_chip *gc,
2789 unsigned long *mask, unsigned long *bits)
2791 if (gc->set_multiple) {
2792 gc->set_multiple(gc, mask, bits);
2796 /* set outputs if the corresponding mask bit is set */
2797 for_each_set_bit(i, mask, gc->ngpio)
2798 gc->set(gc, i, test_bit(i, bits));
2802 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
2803 unsigned int array_size,
2804 struct gpio_desc **desc_array,
2805 struct gpio_array *array_info,
2806 unsigned long *value_bitmap)
2811 * Validate array_info against desc_array and its size.
2812 * It should immediately follow desc_array if both
2813 * have been obtained from the same gpiod_get_array() call.
2815 if (array_info && array_info->desc == desc_array &&
2816 array_size <= array_info->size &&
2817 (void *)array_info == desc_array + array_info->size) {
2819 WARN_ON(array_info->chip->can_sleep);
2821 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2822 bitmap_xor(value_bitmap, value_bitmap,
2823 array_info->invert_mask, array_size);
2825 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
2828 i = find_first_zero_bit(array_info->set_mask, array_size);
2829 if (i == array_size)
2835 while (i < array_size) {
2836 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2837 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2838 unsigned long *mask, *bits;
2841 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2844 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2846 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2851 bits = mask + BITS_TO_LONGS(gc->ngpio);
2852 bitmap_zero(mask, gc->ngpio);
2855 WARN_ON(gc->can_sleep);
2858 struct gpio_desc *desc = desc_array[i];
2859 int hwgpio = gpio_chip_hwgpio(desc);
2860 int value = test_bit(i, value_bitmap);
2863 * Pins applicable for fast input but not for
2864 * fast output processing may have been already
2865 * inverted inside the fast path, skip them.
2867 if (!raw && !(array_info &&
2868 test_bit(i, array_info->invert_mask)) &&
2869 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2871 trace_gpio_value(desc_to_gpio(desc), 0, value);
2873 * collect all normal outputs belonging to the same chip
2874 * open drain and open source outputs are set individually
2876 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
2877 gpio_set_open_drain_value_commit(desc, value);
2878 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
2879 gpio_set_open_source_value_commit(desc, value);
2881 __set_bit(hwgpio, mask);
2882 __assign_bit(hwgpio, bits, value);
2888 i = find_next_zero_bit(array_info->set_mask,
2890 } while ((i < array_size) &&
2891 (desc_array[i]->gdev->chip == gc));
2892 /* push collected bits to outputs */
2894 gpio_chip_set_multiple(gc, mask, bits);
2896 if (mask != fastpath)
2903 * gpiod_set_raw_value() - assign a gpio's raw value
2904 * @desc: gpio whose value will be assigned
2905 * @value: value to assign
2907 * Set the raw value of the GPIO, i.e. the value of its physical line without
2908 * regard for its ACTIVE_LOW status.
2910 * This function can be called from contexts where we cannot sleep, and will
2911 * complain if the GPIO chip functions potentially sleep.
2913 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2915 VALIDATE_DESC_VOID(desc);
2916 /* Should be using gpiod_set_raw_value_cansleep() */
2917 WARN_ON(desc->gdev->chip->can_sleep);
2918 gpiod_set_raw_value_commit(desc, value);
2920 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2923 * gpiod_set_value_nocheck() - set a GPIO line value without checking
2924 * @desc: the descriptor to set the value on
2925 * @value: value to set
2927 * This sets the value of a GPIO line backing a descriptor, applying
2928 * different semantic quirks like active low and open drain/source
2931 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
2933 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2935 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2936 gpio_set_open_drain_value_commit(desc, value);
2937 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2938 gpio_set_open_source_value_commit(desc, value);
2940 gpiod_set_raw_value_commit(desc, value);
2944 * gpiod_set_value() - assign a gpio's value
2945 * @desc: gpio whose value will be assigned
2946 * @value: value to assign
2948 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
2949 * OPEN_DRAIN and OPEN_SOURCE flags into account.
2951 * This function can be called from contexts where we cannot sleep, and will
2952 * complain if the GPIO chip functions potentially sleep.
2954 void gpiod_set_value(struct gpio_desc *desc, int value)
2956 VALIDATE_DESC_VOID(desc);
2957 /* Should be using gpiod_set_value_cansleep() */
2958 WARN_ON(desc->gdev->chip->can_sleep);
2959 gpiod_set_value_nocheck(desc, value);
2961 EXPORT_SYMBOL_GPL(gpiod_set_value);
2964 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2965 * @array_size: number of elements in the descriptor array / value bitmap
2966 * @desc_array: array of GPIO descriptors whose values will be assigned
2967 * @array_info: information on applicability of fast bitmap processing path
2968 * @value_bitmap: bitmap of values to assign
2970 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2971 * without regard for their ACTIVE_LOW status.
2973 * This function can be called from contexts where we cannot sleep, and will
2974 * complain if the GPIO chip functions potentially sleep.
2976 int gpiod_set_raw_array_value(unsigned int array_size,
2977 struct gpio_desc **desc_array,
2978 struct gpio_array *array_info,
2979 unsigned long *value_bitmap)
2983 return gpiod_set_array_value_complex(true, false, array_size,
2984 desc_array, array_info, value_bitmap);
2986 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
2989 * gpiod_set_array_value() - assign values to an array of GPIOs
2990 * @array_size: number of elements in the descriptor array / value bitmap
2991 * @desc_array: array of GPIO descriptors whose values will be assigned
2992 * @array_info: information on applicability of fast bitmap processing path
2993 * @value_bitmap: bitmap of values to assign
2995 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2998 * This function can be called from contexts where we cannot sleep, and will
2999 * complain if the GPIO chip functions potentially sleep.
3001 int gpiod_set_array_value(unsigned int array_size,
3002 struct gpio_desc **desc_array,
3003 struct gpio_array *array_info,
3004 unsigned long *value_bitmap)
3008 return gpiod_set_array_value_complex(false, false, array_size,
3009 desc_array, array_info,
3012 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3015 * gpiod_cansleep() - report whether gpio value access may sleep
3016 * @desc: gpio to check
3019 int gpiod_cansleep(const struct gpio_desc *desc)
3021 VALIDATE_DESC(desc);
3022 return desc->gdev->chip->can_sleep;
3024 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3027 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3028 * @desc: gpio to set the consumer name on
3029 * @name: the new consumer name
3031 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3033 VALIDATE_DESC(desc);
3035 name = kstrdup_const(name, GFP_KERNEL);
3040 kfree_const(desc->label);
3041 desc_set_label(desc, name);
3045 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3048 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3049 * @desc: gpio whose IRQ will be returned (already requested)
3051 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3054 int gpiod_to_irq(const struct gpio_desc *desc)
3056 struct gpio_chip *gc;
3060 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3061 * requires this function to not return zero on an invalid descriptor
3062 * but rather a negative error number.
3064 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3067 gc = desc->gdev->chip;
3068 offset = gpio_chip_hwgpio(desc);
3070 int retirq = gc->to_irq(gc, offset);
3072 /* Zero means NO_IRQ */
3080 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3083 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3084 * @gc: the chip the GPIO to lock belongs to
3085 * @offset: the offset of the GPIO to lock as IRQ
3087 * This is used directly by GPIO drivers that want to lock down
3088 * a certain GPIO line to be used for IRQs.
3090 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3092 struct gpio_desc *desc;
3094 desc = gpiochip_get_desc(gc, offset);
3096 return PTR_ERR(desc);
3099 * If it's fast: flush the direction setting if something changed
3102 if (!gc->can_sleep && gc->get_direction) {
3103 int dir = gpiod_get_direction(desc);
3106 chip_err(gc, "%s: cannot get GPIO direction\n",
3112 /* To be valid for IRQ the line needs to be input or open drain */
3113 if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3114 !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3116 "%s: tried to flag a GPIO set as output for IRQ\n",
3121 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3122 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3125 * If the consumer has not set up a label (such as when the
3126 * IRQ is referenced from .to_irq()) we set up a label here
3127 * so it is clear this is used as an interrupt.
3130 desc_set_label(desc, "interrupt");
3134 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3137 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3138 * @gc: the chip the GPIO to lock belongs to
3139 * @offset: the offset of the GPIO to lock as IRQ
3141 * This is used directly by GPIO drivers that want to indicate
3142 * that a certain GPIO is no longer used exclusively for IRQ.
3144 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3146 struct gpio_desc *desc;
3148 desc = gpiochip_get_desc(gc, offset);
3152 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3153 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3155 /* If we only had this marking, erase it */
3156 if (desc->label && !strcmp(desc->label, "interrupt"))
3157 desc_set_label(desc, NULL);
3159 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3161 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3163 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3165 if (!IS_ERR(desc) &&
3166 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3167 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3169 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3171 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3173 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3175 if (!IS_ERR(desc) &&
3176 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3178 * We must not be output when using IRQ UNLESS we are
3181 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3182 !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3183 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3186 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3188 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3190 if (offset >= gc->ngpio)
3193 return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3195 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3197 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3201 if (!try_module_get(gc->gpiodev->owner))
3204 ret = gpiochip_lock_as_irq(gc, offset);
3206 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3207 module_put(gc->gpiodev->owner);
3212 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3214 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3216 gpiochip_unlock_as_irq(gc, offset);
3217 module_put(gc->gpiodev->owner);
3219 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3221 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3223 if (offset >= gc->ngpio)
3226 return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3228 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3230 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3232 if (offset >= gc->ngpio)
3235 return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3237 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3239 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3241 if (offset >= gc->ngpio)
3244 return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3246 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3249 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3250 * @desc: gpio whose value will be returned
3252 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3253 * its ACTIVE_LOW status, or negative errno on failure.
3255 * This function is to be called from contexts that can sleep.
3257 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3259 might_sleep_if(extra_checks);
3260 VALIDATE_DESC(desc);
3261 return gpiod_get_raw_value_commit(desc);
3263 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3266 * gpiod_get_value_cansleep() - return a gpio's value
3267 * @desc: gpio whose value will be returned
3269 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3270 * account, or negative errno on failure.
3272 * This function is to be called from contexts that can sleep.
3274 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3278 might_sleep_if(extra_checks);
3279 VALIDATE_DESC(desc);
3280 value = gpiod_get_raw_value_commit(desc);
3284 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3289 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3292 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3293 * @array_size: number of elements in the descriptor array / value bitmap
3294 * @desc_array: array of GPIO descriptors whose values will be read
3295 * @array_info: information on applicability of fast bitmap processing path
3296 * @value_bitmap: bitmap to store the read values
3298 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3299 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3300 * else an error code.
3302 * This function is to be called from contexts that can sleep.
3304 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3305 struct gpio_desc **desc_array,
3306 struct gpio_array *array_info,
3307 unsigned long *value_bitmap)
3309 might_sleep_if(extra_checks);
3312 return gpiod_get_array_value_complex(true, true, array_size,
3313 desc_array, array_info,
3316 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3319 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3320 * @array_size: number of elements in the descriptor array / value bitmap
3321 * @desc_array: array of GPIO descriptors whose values will be read
3322 * @array_info: information on applicability of fast bitmap processing path
3323 * @value_bitmap: bitmap to store the read values
3325 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3326 * into account. Return 0 in case of success, else an error code.
3328 * This function is to be called from contexts that can sleep.
3330 int gpiod_get_array_value_cansleep(unsigned int array_size,
3331 struct gpio_desc **desc_array,
3332 struct gpio_array *array_info,
3333 unsigned long *value_bitmap)
3335 might_sleep_if(extra_checks);
3338 return gpiod_get_array_value_complex(false, true, array_size,
3339 desc_array, array_info,
3342 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3345 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3346 * @desc: gpio whose value will be assigned
3347 * @value: value to assign
3349 * Set the raw value of the GPIO, i.e. the value of its physical line without
3350 * regard for its ACTIVE_LOW status.
3352 * This function is to be called from contexts that can sleep.
3354 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3356 might_sleep_if(extra_checks);
3357 VALIDATE_DESC_VOID(desc);
3358 gpiod_set_raw_value_commit(desc, value);
3360 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3363 * gpiod_set_value_cansleep() - assign a gpio's value
3364 * @desc: gpio whose value will be assigned
3365 * @value: value to assign
3367 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3370 * This function is to be called from contexts that can sleep.
3372 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3374 might_sleep_if(extra_checks);
3375 VALIDATE_DESC_VOID(desc);
3376 gpiod_set_value_nocheck(desc, value);
3378 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3381 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3382 * @array_size: number of elements in the descriptor array / value bitmap
3383 * @desc_array: array of GPIO descriptors whose values will be assigned
3384 * @array_info: information on applicability of fast bitmap processing path
3385 * @value_bitmap: bitmap of values to assign
3387 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3388 * without regard for their ACTIVE_LOW status.
3390 * This function is to be called from contexts that can sleep.
3392 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3393 struct gpio_desc **desc_array,
3394 struct gpio_array *array_info,
3395 unsigned long *value_bitmap)
3397 might_sleep_if(extra_checks);
3400 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3401 array_info, value_bitmap);
3403 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3406 * gpiod_add_lookup_tables() - register GPIO device consumers
3407 * @tables: list of tables of consumers to register
3408 * @n: number of tables in the list
3410 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3414 mutex_lock(&gpio_lookup_lock);
3416 for (i = 0; i < n; i++)
3417 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3419 mutex_unlock(&gpio_lookup_lock);
3423 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3424 * @array_size: number of elements in the descriptor array / value bitmap
3425 * @desc_array: array of GPIO descriptors whose values will be assigned
3426 * @array_info: information on applicability of fast bitmap processing path
3427 * @value_bitmap: bitmap of values to assign
3429 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3432 * This function is to be called from contexts that can sleep.
3434 int gpiod_set_array_value_cansleep(unsigned int array_size,
3435 struct gpio_desc **desc_array,
3436 struct gpio_array *array_info,
3437 unsigned long *value_bitmap)
3439 might_sleep_if(extra_checks);
3442 return gpiod_set_array_value_complex(false, true, array_size,
3443 desc_array, array_info,
3446 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3449 * gpiod_add_lookup_table() - register GPIO device consumers
3450 * @table: table of consumers to register
3452 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3454 mutex_lock(&gpio_lookup_lock);
3456 list_add_tail(&table->list, &gpio_lookup_list);
3458 mutex_unlock(&gpio_lookup_lock);
3460 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3463 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3464 * @table: table of consumers to unregister
3466 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3468 /* Nothing to remove */
3472 mutex_lock(&gpio_lookup_lock);
3474 list_del(&table->list);
3476 mutex_unlock(&gpio_lookup_lock);
3478 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3481 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3482 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3484 void gpiod_add_hogs(struct gpiod_hog *hogs)
3486 struct gpio_chip *gc;
3487 struct gpiod_hog *hog;
3489 mutex_lock(&gpio_machine_hogs_mutex);
3491 for (hog = &hogs[0]; hog->chip_label; hog++) {
3492 list_add_tail(&hog->list, &gpio_machine_hogs);
3495 * The chip may have been registered earlier, so check if it
3496 * exists and, if so, try to hog the line now.
3498 gc = find_chip_by_name(hog->chip_label);
3500 gpiochip_machine_hog(gc, hog);
3503 mutex_unlock(&gpio_machine_hogs_mutex);
3505 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3507 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3509 const char *dev_id = dev ? dev_name(dev) : NULL;
3510 struct gpiod_lookup_table *table;
3512 mutex_lock(&gpio_lookup_lock);
3514 list_for_each_entry(table, &gpio_lookup_list, list) {
3515 if (table->dev_id && dev_id) {
3517 * Valid strings on both ends, must be identical to have
3520 if (!strcmp(table->dev_id, dev_id))
3524 * One of the pointers is NULL, so both must be to have
3527 if (dev_id == table->dev_id)
3534 mutex_unlock(&gpio_lookup_lock);
3538 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3539 unsigned int idx, unsigned long *flags)
3541 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3542 struct gpiod_lookup_table *table;
3543 struct gpiod_lookup *p;
3545 table = gpiod_find_lookup_table(dev);
3549 for (p = &table->table[0]; p->key; p++) {
3550 struct gpio_chip *gc;
3552 /* idx must always match exactly */
3556 /* If the lookup entry has a con_id, require exact match */
3557 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3560 if (p->chip_hwnum == U16_MAX) {
3561 desc = gpio_name_to_desc(p->key);
3567 dev_warn(dev, "cannot find GPIO line %s, deferring\n",
3569 return ERR_PTR(-EPROBE_DEFER);
3572 gc = find_chip_by_name(p->key);
3576 * As the lookup table indicates a chip with
3577 * p->key should exist, assume it may
3578 * still appear later and let the interested
3579 * consumer be probed again or let the Deferred
3580 * Probe infrastructure handle the error.
3582 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3584 return ERR_PTR(-EPROBE_DEFER);
3587 if (gc->ngpio <= p->chip_hwnum) {
3589 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3590 idx, p->chip_hwnum, gc->ngpio - 1,
3592 return ERR_PTR(-EINVAL);
3595 desc = gpiochip_get_desc(gc, p->chip_hwnum);
3604 static int platform_gpio_count(struct device *dev, const char *con_id)
3606 struct gpiod_lookup_table *table;
3607 struct gpiod_lookup *p;
3608 unsigned int count = 0;
3610 table = gpiod_find_lookup_table(dev);
3614 for (p = &table->table[0]; p->key; p++) {
3615 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3616 (!con_id && !p->con_id))
3626 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3627 * @fwnode: handle of the firmware node
3628 * @con_id: function within the GPIO consumer
3629 * @index: index of the GPIO to obtain for the consumer
3630 * @flags: GPIO initialization flags
3631 * @label: label to attach to the requested GPIO
3633 * This function can be used for drivers that get their configuration
3634 * from opaque firmware.
3636 * The function properly finds the corresponding GPIO using whatever is the
3637 * underlying firmware interface and then makes sure that the GPIO
3638 * descriptor is requested before it is returned to the caller.
3641 * On successful request the GPIO pin is configured in accordance with
3644 * In case of error an ERR_PTR() is returned.
3646 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
3647 const char *con_id, int index,
3648 enum gpiod_flags flags,
3651 struct gpio_desc *desc;
3652 char prop_name[32]; /* 32 is max size of property name */
3655 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3657 snprintf(prop_name, sizeof(prop_name), "%s-%s",
3658 con_id, gpio_suffixes[i]);
3660 snprintf(prop_name, sizeof(prop_name), "%s",
3663 desc = fwnode_get_named_gpiod(fwnode, prop_name, index, flags,
3665 if (!gpiod_not_found(desc))
3671 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
3674 * gpiod_count - return the number of GPIOs associated with a device / function
3675 * or -ENOENT if no GPIO has been assigned to the requested function
3676 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3677 * @con_id: function within the GPIO consumer
3679 int gpiod_count(struct device *dev, const char *con_id)
3681 int count = -ENOENT;
3683 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3684 count = of_gpio_get_count(dev, con_id);
3685 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3686 count = acpi_gpio_count(dev, con_id);
3689 count = platform_gpio_count(dev, con_id);
3693 EXPORT_SYMBOL_GPL(gpiod_count);
3696 * gpiod_get - obtain a GPIO for a given GPIO function
3697 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3698 * @con_id: function within the GPIO consumer
3699 * @flags: optional GPIO initialization flags
3701 * Return the GPIO descriptor corresponding to the function con_id of device
3702 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3703 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3705 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3706 enum gpiod_flags flags)
3708 return gpiod_get_index(dev, con_id, 0, flags);
3710 EXPORT_SYMBOL_GPL(gpiod_get);
3713 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3714 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3715 * @con_id: function within the GPIO consumer
3716 * @flags: optional GPIO initialization flags
3718 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3719 * the requested function it will return NULL. This is convenient for drivers
3720 * that need to handle optional GPIOs.
3722 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3724 enum gpiod_flags flags)
3726 return gpiod_get_index_optional(dev, con_id, 0, flags);
3728 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3732 * gpiod_configure_flags - helper function to configure a given GPIO
3733 * @desc: gpio whose value will be assigned
3734 * @con_id: function within the GPIO consumer
3735 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3736 * of_find_gpio() or of_get_gpio_hog()
3737 * @dflags: gpiod_flags - optional GPIO initialization flags
3739 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3740 * requested function and/or index, or another IS_ERR() code if an error
3741 * occurred while trying to acquire the GPIO.
3743 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3744 unsigned long lflags, enum gpiod_flags dflags)
3748 if (lflags & GPIO_ACTIVE_LOW)
3749 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3751 if (lflags & GPIO_OPEN_DRAIN)
3752 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3753 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3755 * This enforces open drain mode from the consumer side.
3756 * This is necessary for some busses like I2C, but the lookup
3757 * should *REALLY* have specified them as open drain in the
3758 * first place, so print a little warning here.
3760 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3762 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3765 if (lflags & GPIO_OPEN_SOURCE)
3766 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3768 if ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) {
3770 "both pull-up and pull-down enabled, invalid configuration\n");
3774 if (lflags & GPIO_PULL_UP)
3775 set_bit(FLAG_PULL_UP, &desc->flags);
3776 else if (lflags & GPIO_PULL_DOWN)
3777 set_bit(FLAG_PULL_DOWN, &desc->flags);
3779 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
3783 /* No particular flag request, return here... */
3784 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3785 gpiod_dbg(desc, "no flags found for %s\n", con_id);
3790 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3791 ret = gpiod_direction_output(desc,
3792 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3794 ret = gpiod_direction_input(desc);
3800 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3801 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3802 * @con_id: function within the GPIO consumer
3803 * @idx: index of the GPIO to obtain in the consumer
3804 * @flags: optional GPIO initialization flags
3806 * This variant of gpiod_get() allows to access GPIOs other than the first
3807 * defined one for functions that define several GPIOs.
3809 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3810 * requested function and/or index, or another IS_ERR() code if an error
3811 * occurred while trying to acquire the GPIO.
3813 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3816 enum gpiod_flags flags)
3818 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3819 struct gpio_desc *desc = NULL;
3821 /* Maybe we have a device name, maybe not */
3822 const char *devname = dev ? dev_name(dev) : "?";
3824 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3827 /* Using device tree? */
3828 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3829 dev_dbg(dev, "using device tree for GPIO lookup\n");
3830 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3831 } else if (ACPI_COMPANION(dev)) {
3832 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3833 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3838 * Either we are not using DT or ACPI, or their lookup did not return
3839 * a result. In that case, use platform lookup as a fallback.
3841 if (!desc || gpiod_not_found(desc)) {
3842 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3843 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3847 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
3852 * If a connection label was passed use that, else attempt to use
3853 * the device name as label
3855 ret = gpiod_request(desc, con_id ? con_id : devname);
3857 if (ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
3859 * This happens when there are several consumers for
3860 * the same GPIO line: we just return here without
3861 * further initialization. It is a bit if a hack.
3862 * This is necessary to support fixed regulators.
3864 * FIXME: Make this more sane and safe.
3866 dev_info(dev, "nonexclusive access to GPIO for %s\n",
3867 con_id ? con_id : devname);
3870 return ERR_PTR(ret);
3874 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3876 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3878 return ERR_PTR(ret);
3881 blocking_notifier_call_chain(&desc->gdev->notifier,
3882 GPIOLINE_CHANGED_REQUESTED, desc);
3886 EXPORT_SYMBOL_GPL(gpiod_get_index);
3889 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3890 * @fwnode: handle of the firmware node
3891 * @propname: name of the firmware property representing the GPIO
3892 * @index: index of the GPIO to obtain for the consumer
3893 * @dflags: GPIO initialization flags
3894 * @label: label to attach to the requested GPIO
3896 * This function can be used for drivers that get their configuration
3897 * from opaque firmware.
3899 * The function properly finds the corresponding GPIO using whatever is the
3900 * underlying firmware interface and then makes sure that the GPIO
3901 * descriptor is requested before it is returned to the caller.
3904 * On successful request the GPIO pin is configured in accordance with
3907 * In case of error an ERR_PTR() is returned.
3909 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3910 const char *propname, int index,
3911 enum gpiod_flags dflags,
3914 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3915 struct gpio_desc *desc = ERR_PTR(-ENODEV);
3919 return ERR_PTR(-EINVAL);
3921 if (is_of_node(fwnode)) {
3922 desc = gpiod_get_from_of_node(to_of_node(fwnode),
3927 } else if (is_acpi_node(fwnode)) {
3928 struct acpi_gpio_info info;
3930 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
3934 acpi_gpio_update_gpiod_flags(&dflags, &info);
3935 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
3938 /* Currently only ACPI takes this path */
3939 ret = gpiod_request(desc, label);
3941 return ERR_PTR(ret);
3943 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3946 return ERR_PTR(ret);
3949 blocking_notifier_call_chain(&desc->gdev->notifier,
3950 GPIOLINE_CHANGED_REQUESTED, desc);
3954 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3957 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3959 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3960 * @con_id: function within the GPIO consumer
3961 * @index: index of the GPIO to obtain in the consumer
3962 * @flags: optional GPIO initialization flags
3964 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3965 * specified index was assigned to the requested function it will return NULL.
3966 * This is convenient for drivers that need to handle optional GPIOs.
3968 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
3971 enum gpiod_flags flags)
3973 struct gpio_desc *desc;
3975 desc = gpiod_get_index(dev, con_id, index, flags);
3976 if (gpiod_not_found(desc))
3981 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
3984 * gpiod_hog - Hog the specified GPIO desc given the provided flags
3985 * @desc: gpio whose value will be assigned
3986 * @name: gpio line name
3987 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3988 * of_find_gpio() or of_get_gpio_hog()
3989 * @dflags: gpiod_flags - optional GPIO initialization flags
3991 int gpiod_hog(struct gpio_desc *desc, const char *name,
3992 unsigned long lflags, enum gpiod_flags dflags)
3994 struct gpio_chip *gc;
3995 struct gpio_desc *local_desc;
3999 gc = gpiod_to_chip(desc);
4000 hwnum = gpio_chip_hwgpio(desc);
4002 local_desc = gpiochip_request_own_desc(gc, hwnum, name,
4004 if (IS_ERR(local_desc)) {
4005 ret = PTR_ERR(local_desc);
4006 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4007 name, gc->label, hwnum, ret);
4011 /* Mark GPIO as hogged so it can be identified and removed later */
4012 set_bit(FLAG_IS_HOGGED, &desc->flags);
4014 gpiod_info(desc, "hogged as %s%s\n",
4015 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4016 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4017 (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4023 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4024 * @gc: gpio chip to act on
4026 static void gpiochip_free_hogs(struct gpio_chip *gc)
4030 for (id = 0; id < gc->ngpio; id++) {
4031 if (test_bit(FLAG_IS_HOGGED, &gc->gpiodev->descs[id].flags))
4032 gpiochip_free_own_desc(&gc->gpiodev->descs[id]);
4037 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4038 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4039 * @con_id: function within the GPIO consumer
4040 * @flags: optional GPIO initialization flags
4042 * This function acquires all the GPIOs defined under a given function.
4044 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4045 * no GPIO has been assigned to the requested function, or another IS_ERR()
4046 * code if an error occurred while trying to acquire the GPIOs.
4048 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4050 enum gpiod_flags flags)
4052 struct gpio_desc *desc;
4053 struct gpio_descs *descs;
4054 struct gpio_array *array_info = NULL;
4055 struct gpio_chip *gc;
4056 int count, bitmap_size;
4058 count = gpiod_count(dev, con_id);
4060 return ERR_PTR(count);
4062 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4064 return ERR_PTR(-ENOMEM);
4066 for (descs->ndescs = 0; descs->ndescs < count; ) {
4067 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4069 gpiod_put_array(descs);
4070 return ERR_CAST(desc);
4073 descs->desc[descs->ndescs] = desc;
4075 gc = gpiod_to_chip(desc);
4077 * If pin hardware number of array member 0 is also 0, select
4078 * its chip as a candidate for fast bitmap processing path.
4080 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4081 struct gpio_descs *array;
4083 bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4086 array = kzalloc(struct_size(descs, desc, count) +
4087 struct_size(array_info, invert_mask,
4088 3 * bitmap_size), GFP_KERNEL);
4090 gpiod_put_array(descs);
4091 return ERR_PTR(-ENOMEM);
4094 memcpy(array, descs,
4095 struct_size(descs, desc, descs->ndescs + 1));
4099 array_info = (void *)(descs->desc + count);
4100 array_info->get_mask = array_info->invert_mask +
4102 array_info->set_mask = array_info->get_mask +
4105 array_info->desc = descs->desc;
4106 array_info->size = count;
4107 array_info->chip = gc;
4108 bitmap_set(array_info->get_mask, descs->ndescs,
4109 count - descs->ndescs);
4110 bitmap_set(array_info->set_mask, descs->ndescs,
4111 count - descs->ndescs);
4112 descs->info = array_info;
4114 /* Unmark array members which don't belong to the 'fast' chip */
4115 if (array_info && array_info->chip != gc) {
4116 __clear_bit(descs->ndescs, array_info->get_mask);
4117 __clear_bit(descs->ndescs, array_info->set_mask);
4120 * Detect array members which belong to the 'fast' chip
4121 * but their pins are not in hardware order.
4123 else if (array_info &&
4124 gpio_chip_hwgpio(desc) != descs->ndescs) {
4126 * Don't use fast path if all array members processed so
4127 * far belong to the same chip as this one but its pin
4128 * hardware number is different from its array index.
4130 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4133 __clear_bit(descs->ndescs,
4134 array_info->get_mask);
4135 __clear_bit(descs->ndescs,
4136 array_info->set_mask);
4138 } else if (array_info) {
4139 /* Exclude open drain or open source from fast output */
4140 if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4141 gpiochip_line_is_open_source(gc, descs->ndescs))
4142 __clear_bit(descs->ndescs,
4143 array_info->set_mask);
4144 /* Identify 'fast' pins which require invertion */
4145 if (gpiod_is_active_low(desc))
4146 __set_bit(descs->ndescs,
4147 array_info->invert_mask);
4154 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4155 array_info->chip->label, array_info->size,
4156 *array_info->get_mask, *array_info->set_mask,
4157 *array_info->invert_mask);
4160 EXPORT_SYMBOL_GPL(gpiod_get_array);
4163 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4165 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4166 * @con_id: function within the GPIO consumer
4167 * @flags: optional GPIO initialization flags
4169 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4170 * assigned to the requested function it will return NULL.
4172 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4174 enum gpiod_flags flags)
4176 struct gpio_descs *descs;
4178 descs = gpiod_get_array(dev, con_id, flags);
4179 if (gpiod_not_found(descs))
4184 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4187 * gpiod_put - dispose of a GPIO descriptor
4188 * @desc: GPIO descriptor to dispose of
4190 * No descriptor can be used after gpiod_put() has been called on it.
4192 void gpiod_put(struct gpio_desc *desc)
4197 EXPORT_SYMBOL_GPL(gpiod_put);
4200 * gpiod_put_array - dispose of multiple GPIO descriptors
4201 * @descs: struct gpio_descs containing an array of descriptors
4203 void gpiod_put_array(struct gpio_descs *descs)
4207 for (i = 0; i < descs->ndescs; i++)
4208 gpiod_put(descs->desc[i]);
4212 EXPORT_SYMBOL_GPL(gpiod_put_array);
4215 static int gpio_bus_match(struct device *dev, struct device_driver *drv)
4218 * Only match if the fwnode doesn't already have a proper struct device
4221 if (dev->fwnode && dev->fwnode->dev != dev)
4226 static int gpio_stub_drv_probe(struct device *dev)
4229 * The DT node of some GPIO chips have a "compatible" property, but
4230 * never have a struct device added and probed by a driver to register
4231 * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4232 * the consumers of the GPIO chip to get probe deferred forever because
4233 * they will be waiting for a device associated with the GPIO chip
4234 * firmware node to get added and bound to a driver.
4236 * To allow these consumers to probe, we associate the struct
4237 * gpio_device of the GPIO chip with the firmware node and then simply
4238 * bind it to this stub driver.
4243 static struct device_driver gpio_stub_drv = {
4244 .name = "gpio_stub_drv",
4245 .bus = &gpio_bus_type,
4246 .probe = gpio_stub_drv_probe,
4249 static int __init gpiolib_dev_init(void)
4253 /* Register GPIO sysfs bus */
4254 ret = bus_register(&gpio_bus_type);
4256 pr_err("gpiolib: could not register GPIO bus type\n");
4260 if (driver_register(&gpio_stub_drv) < 0) {
4261 pr_err("gpiolib: could not register GPIO stub driver\n");
4262 bus_unregister(&gpio_bus_type);
4266 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4268 pr_err("gpiolib: failed to allocate char dev region\n");
4269 driver_unregister(&gpio_stub_drv);
4270 bus_unregister(&gpio_bus_type);
4274 gpiolib_initialized = true;
4275 gpiochip_setup_devs();
4277 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4278 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4279 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4283 core_initcall(gpiolib_dev_init);
4285 #ifdef CONFIG_DEBUG_FS
4287 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4290 struct gpio_chip *gc = gdev->chip;
4291 unsigned gpio = gdev->base;
4292 struct gpio_desc *gdesc = &gdev->descs[0];
4297 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4298 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4300 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4306 gpiod_get_direction(gdesc);
4307 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4308 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4309 active_low = test_bit(FLAG_ACTIVE_LOW, &gdesc->flags);
4310 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s",
4311 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4312 is_out ? "out" : "in ",
4313 gc->get ? (gc->get(gc, i) ? "hi" : "lo") : "? ",
4314 is_irq ? "IRQ " : "",
4315 active_low ? "ACTIVE LOW" : "");
4316 seq_printf(s, "\n");
4320 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4322 unsigned long flags;
4323 struct gpio_device *gdev = NULL;
4324 loff_t index = *pos;
4328 spin_lock_irqsave(&gpio_lock, flags);
4329 list_for_each_entry(gdev, &gpio_devices, list)
4331 spin_unlock_irqrestore(&gpio_lock, flags);
4334 spin_unlock_irqrestore(&gpio_lock, flags);
4339 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4341 unsigned long flags;
4342 struct gpio_device *gdev = v;
4345 spin_lock_irqsave(&gpio_lock, flags);
4346 if (list_is_last(&gdev->list, &gpio_devices))
4349 ret = list_entry(gdev->list.next, struct gpio_device, list);
4350 spin_unlock_irqrestore(&gpio_lock, flags);
4358 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4362 static int gpiolib_seq_show(struct seq_file *s, void *v)
4364 struct gpio_device *gdev = v;
4365 struct gpio_chip *gc = gdev->chip;
4366 struct device *parent;
4369 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4370 dev_name(&gdev->dev));
4374 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4375 dev_name(&gdev->dev),
4376 gdev->base, gdev->base + gdev->ngpio - 1);
4377 parent = gc->parent;
4379 seq_printf(s, ", parent: %s/%s",
4380 parent->bus ? parent->bus->name : "no-bus",
4383 seq_printf(s, ", %s", gc->label);
4385 seq_printf(s, ", can sleep");
4386 seq_printf(s, ":\n");
4389 gc->dbg_show(s, gc);
4391 gpiolib_dbg_show(s, gdev);
4396 static const struct seq_operations gpiolib_sops = {
4397 .start = gpiolib_seq_start,
4398 .next = gpiolib_seq_next,
4399 .stop = gpiolib_seq_stop,
4400 .show = gpiolib_seq_show,
4402 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4404 static int __init gpiolib_debugfs_init(void)
4406 /* /sys/kernel/debug/gpio */
4407 debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4410 subsys_initcall(gpiolib_debugfs_init);
4412 #endif /* DEBUG_FS */