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 struct bus_type gpio_bus_type = {
64 * Number of GPIOs to use for the fast path in set array
66 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
68 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
69 * While any GPIO is requested, its gpio_chip is not removable;
70 * each GPIO's "requested" flag serves as a lock and refcount.
72 DEFINE_SPINLOCK(gpio_lock);
74 static DEFINE_MUTEX(gpio_lookup_lock);
75 static LIST_HEAD(gpio_lookup_list);
76 LIST_HEAD(gpio_devices);
78 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
79 static LIST_HEAD(gpio_machine_hogs);
81 static void gpiochip_free_hogs(struct gpio_chip *gc);
82 static int gpiochip_add_irqchip(struct gpio_chip *gc,
83 struct lock_class_key *lock_key,
84 struct lock_class_key *request_key);
85 static void gpiochip_irqchip_remove(struct gpio_chip *gc);
86 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc);
87 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc);
88 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc);
90 static bool gpiolib_initialized;
92 static inline void desc_set_label(struct gpio_desc *d, const char *label)
98 * gpio_to_desc - Convert a GPIO number to its descriptor
99 * @gpio: global GPIO number
102 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
103 * with the given number exists in the system.
105 struct gpio_desc *gpio_to_desc(unsigned gpio)
107 struct gpio_device *gdev;
110 spin_lock_irqsave(&gpio_lock, flags);
112 list_for_each_entry(gdev, &gpio_devices, list) {
113 if (gdev->base <= gpio &&
114 gdev->base + gdev->ngpio > gpio) {
115 spin_unlock_irqrestore(&gpio_lock, flags);
116 return &gdev->descs[gpio - gdev->base];
120 spin_unlock_irqrestore(&gpio_lock, flags);
122 if (!gpio_is_valid(gpio))
123 pr_warn("invalid GPIO %d\n", gpio);
127 EXPORT_SYMBOL_GPL(gpio_to_desc);
130 * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
131 * hardware number for this chip
133 * @hwnum: hardware number of the GPIO for this chip
136 * A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists
137 * in the given chip for the specified hardware number.
139 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc,
142 struct gpio_device *gdev = gc->gpiodev;
144 if (hwnum >= gdev->ngpio)
145 return ERR_PTR(-EINVAL);
147 return &gdev->descs[hwnum];
149 EXPORT_SYMBOL_GPL(gpiochip_get_desc);
152 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
153 * @desc: GPIO descriptor
155 * This should disappear in the future but is needed since we still
156 * use GPIO numbers for error messages and sysfs nodes.
159 * The global GPIO number for the GPIO specified by its descriptor.
161 int desc_to_gpio(const struct gpio_desc *desc)
163 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
165 EXPORT_SYMBOL_GPL(desc_to_gpio);
169 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
170 * @desc: descriptor to return the chip of
172 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
174 if (!desc || !desc->gdev)
176 return desc->gdev->chip;
178 EXPORT_SYMBOL_GPL(gpiod_to_chip);
180 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
181 static int gpiochip_find_base(int ngpio)
183 struct gpio_device *gdev;
184 int base = ARCH_NR_GPIOS - ngpio;
186 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
187 /* found a free space? */
188 if (gdev->base + gdev->ngpio <= base)
191 /* nope, check the space right before the chip */
192 base = gdev->base - ngpio;
195 if (gpio_is_valid(base)) {
196 pr_debug("%s: found new base at %d\n", __func__, base);
199 pr_err("%s: cannot find free range\n", __func__);
205 * gpiod_get_direction - return the current direction of a GPIO
206 * @desc: GPIO to get the direction of
208 * Returns 0 for output, 1 for input, or an error code in case of error.
210 * This function may sleep if gpiod_cansleep() is true.
212 int gpiod_get_direction(struct gpio_desc *desc)
214 struct gpio_chip *gc;
218 gc = gpiod_to_chip(desc);
219 offset = gpio_chip_hwgpio(desc);
222 * Open drain emulation using input mode may incorrectly report
223 * input here, fix that up.
225 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) &&
226 test_bit(FLAG_IS_OUT, &desc->flags))
229 if (!gc->get_direction)
232 ret = gc->get_direction(gc, offset);
236 /* GPIOF_DIR_IN or other positive, otherwise GPIOF_DIR_OUT */
240 assign_bit(FLAG_IS_OUT, &desc->flags, !ret);
244 EXPORT_SYMBOL_GPL(gpiod_get_direction);
247 * Add a new chip to the global chips list, keeping the list of chips sorted
248 * by range(means [base, base + ngpio - 1]) order.
250 * Return -EBUSY if the new chip overlaps with some other chip's integer
253 static int gpiodev_add_to_list(struct gpio_device *gdev)
255 struct gpio_device *prev, *next;
257 if (list_empty(&gpio_devices)) {
258 /* initial entry in list */
259 list_add_tail(&gdev->list, &gpio_devices);
263 next = list_entry(gpio_devices.next, struct gpio_device, list);
264 if (gdev->base + gdev->ngpio <= next->base) {
265 /* add before first entry */
266 list_add(&gdev->list, &gpio_devices);
270 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
271 if (prev->base + prev->ngpio <= gdev->base) {
272 /* add behind last entry */
273 list_add_tail(&gdev->list, &gpio_devices);
277 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
278 /* at the end of the list */
279 if (&next->list == &gpio_devices)
282 /* add between prev and next */
283 if (prev->base + prev->ngpio <= gdev->base
284 && gdev->base + gdev->ngpio <= next->base) {
285 list_add(&gdev->list, &prev->list);
290 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
295 * Convert a GPIO name to its descriptor
296 * Note that there is no guarantee that GPIO names are globally unique!
297 * Hence this function will return, if it exists, a reference to the first GPIO
298 * line found that matches the given name.
300 static struct gpio_desc *gpio_name_to_desc(const char * const name)
302 struct gpio_device *gdev;
308 spin_lock_irqsave(&gpio_lock, flags);
310 list_for_each_entry(gdev, &gpio_devices, list) {
313 for (i = 0; i != gdev->ngpio; ++i) {
314 struct gpio_desc *desc = &gdev->descs[i];
319 if (!strcmp(desc->name, name)) {
320 spin_unlock_irqrestore(&gpio_lock, flags);
326 spin_unlock_irqrestore(&gpio_lock, flags);
332 * Take the names from gc->names and assign them to their GPIO descriptors.
333 * Warn if a name is already used for a GPIO line on a different GPIO chip.
336 * 1. Non-unique names are still accepted,
337 * 2. Name collisions within the same GPIO chip are not reported.
339 static int gpiochip_set_desc_names(struct gpio_chip *gc)
341 struct gpio_device *gdev = gc->gpiodev;
344 /* First check all names if they are unique */
345 for (i = 0; i != gc->ngpio; ++i) {
346 struct gpio_desc *gpio;
348 gpio = gpio_name_to_desc(gc->names[i]);
351 "Detected name collision for GPIO name '%s'\n",
355 /* Then add all names to the GPIO descriptors */
356 for (i = 0; i != gc->ngpio; ++i)
357 gdev->descs[i].name = gc->names[i];
363 * devprop_gpiochip_set_names - Set GPIO line names using device properties
364 * @chip: GPIO chip whose lines should be named, if possible
366 * Looks for device property "gpio-line-names" and if it exists assigns
367 * GPIO line names for the chip. The memory allocated for the assigned
368 * names belong to the underlying software node and should not be released
371 static int devprop_gpiochip_set_names(struct gpio_chip *chip)
373 struct gpio_device *gdev = chip->gpiodev;
374 struct device *dev = chip->parent;
379 /* GPIO chip may not have a parent device whose properties we inspect. */
383 count = device_property_string_array_count(dev, "gpio-line-names");
387 if (count > gdev->ngpio) {
388 dev_warn(&gdev->dev, "gpio-line-names is length %d but should be at most length %d",
393 names = kcalloc(count, sizeof(*names), GFP_KERNEL);
397 ret = device_property_read_string_array(dev, "gpio-line-names",
400 dev_warn(&gdev->dev, "failed to read GPIO line names\n");
405 for (i = 0; i < count; i++)
406 gdev->descs[i].name = names[i];
413 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
417 p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
421 /* Assume by default all GPIOs are valid */
422 bitmap_fill(p, gc->ngpio);
427 static int gpiochip_alloc_valid_mask(struct gpio_chip *gc)
429 if (!(of_gpio_need_valid_mask(gc) || gc->init_valid_mask))
432 gc->valid_mask = gpiochip_allocate_mask(gc);
439 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
441 if (gc->init_valid_mask)
442 return gc->init_valid_mask(gc,
449 static void gpiochip_free_valid_mask(struct gpio_chip *gc)
451 bitmap_free(gc->valid_mask);
452 gc->valid_mask = NULL;
455 static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
457 if (gc->add_pin_ranges)
458 return gc->add_pin_ranges(gc);
463 bool gpiochip_line_is_valid(const struct gpio_chip *gc,
466 /* No mask means all valid */
467 if (likely(!gc->valid_mask))
469 return test_bit(offset, gc->valid_mask);
471 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
473 static void gpiodevice_release(struct device *dev)
475 struct gpio_device *gdev = dev_get_drvdata(dev);
477 list_del(&gdev->list);
478 ida_free(&gpio_ida, gdev->id);
479 kfree_const(gdev->label);
484 #ifdef CONFIG_GPIO_CDEV
485 #define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
486 #define gcdev_unregister(gdev) gpiolib_cdev_unregister((gdev))
489 * gpiolib_cdev_register() indirectly calls device_add(), which is still
490 * required even when cdev is not selected.
492 #define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
493 #define gcdev_unregister(gdev) device_del(&(gdev)->dev)
496 static int gpiochip_setup_dev(struct gpio_device *gdev)
500 ret = gcdev_register(gdev, gpio_devt);
504 ret = gpiochip_sysfs_register(gdev);
506 goto err_remove_device;
508 /* From this point, the .release() function cleans up gpio_device */
509 gdev->dev.release = gpiodevice_release;
510 dev_dbg(&gdev->dev, "registered GPIOs %d to %d on %s\n", gdev->base,
511 gdev->base + gdev->ngpio - 1, gdev->chip->label ? : "generic");
516 gcdev_unregister(gdev);
520 static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
522 struct gpio_desc *desc;
525 desc = gpiochip_get_desc(gc, hog->chip_hwnum);
527 chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
532 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
535 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
537 gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
538 __func__, gc->label, hog->chip_hwnum, rv);
541 static void machine_gpiochip_add(struct gpio_chip *gc)
543 struct gpiod_hog *hog;
545 mutex_lock(&gpio_machine_hogs_mutex);
547 list_for_each_entry(hog, &gpio_machine_hogs, list) {
548 if (!strcmp(gc->label, hog->chip_label))
549 gpiochip_machine_hog(gc, hog);
552 mutex_unlock(&gpio_machine_hogs_mutex);
555 static void gpiochip_setup_devs(void)
557 struct gpio_device *gdev;
560 list_for_each_entry(gdev, &gpio_devices, list) {
561 ret = gpiochip_setup_dev(gdev);
564 "Failed to initialize gpio device (%d)\n", ret);
568 int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
569 struct lock_class_key *lock_key,
570 struct lock_class_key *request_key)
576 struct gpio_device *gdev;
579 * First: allocate and populate the internal stat container, and
580 * set up the struct device.
582 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
585 gdev->dev.bus = &gpio_bus_type;
589 gdev->dev.parent = gc->parent;
590 gdev->dev.of_node = gc->parent->of_node;
593 #ifdef CONFIG_OF_GPIO
594 /* If the gpiochip has an assigned OF node this takes precedence */
596 gdev->dev.of_node = gc->of_node;
598 gc->of_node = gdev->dev.of_node;
601 gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
607 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
611 device_initialize(&gdev->dev);
612 dev_set_drvdata(&gdev->dev, gdev);
613 if (gc->parent && gc->parent->driver)
614 gdev->owner = gc->parent->driver->owner;
616 /* TODO: remove chip->owner */
617 gdev->owner = gc->owner;
619 gdev->owner = THIS_MODULE;
621 gdev->descs = kcalloc(gc->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
624 goto err_free_dev_name;
627 if (gc->ngpio == 0) {
628 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
633 if (gc->ngpio > FASTPATH_NGPIO)
634 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
635 gc->ngpio, FASTPATH_NGPIO);
637 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
643 gdev->ngpio = gc->ngpio;
646 spin_lock_irqsave(&gpio_lock, flags);
649 * TODO: this allocates a Linux GPIO number base in the global
650 * GPIO numberspace for this chip. In the long run we want to
651 * get *rid* of this numberspace and use only descriptors, but
652 * it may be a pipe dream. It will not happen before we get rid
653 * of the sysfs interface anyways.
656 base = gpiochip_find_base(gc->ngpio);
659 spin_unlock_irqrestore(&gpio_lock, flags);
663 * TODO: it should not be necessary to reflect the assigned
664 * base outside of the GPIO subsystem. Go over drivers and
665 * see if anyone makes use of this, else drop this and assign
672 ret = gpiodev_add_to_list(gdev);
674 spin_unlock_irqrestore(&gpio_lock, flags);
678 for (i = 0; i < gc->ngpio; i++)
679 gdev->descs[i].gdev = gdev;
681 spin_unlock_irqrestore(&gpio_lock, flags);
683 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->notifier);
685 #ifdef CONFIG_PINCTRL
686 INIT_LIST_HEAD(&gdev->pin_ranges);
690 ret = gpiochip_set_desc_names(gc);
692 ret = devprop_gpiochip_set_names(gc);
694 goto err_remove_from_list;
696 ret = gpiochip_alloc_valid_mask(gc);
698 goto err_remove_from_list;
700 ret = of_gpiochip_add(gc);
702 goto err_free_gpiochip_mask;
704 ret = gpiochip_init_valid_mask(gc);
706 goto err_remove_of_chip;
708 for (i = 0; i < gc->ngpio; i++) {
709 struct gpio_desc *desc = &gdev->descs[i];
711 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
712 assign_bit(FLAG_IS_OUT,
713 &desc->flags, !gc->get_direction(gc, i));
715 assign_bit(FLAG_IS_OUT,
716 &desc->flags, !gc->direction_input);
720 ret = gpiochip_add_pin_ranges(gc);
722 goto err_remove_of_chip;
724 acpi_gpiochip_add(gc);
726 machine_gpiochip_add(gc);
728 ret = gpiochip_irqchip_init_valid_mask(gc);
730 goto err_remove_acpi_chip;
732 ret = gpiochip_irqchip_init_hw(gc);
734 goto err_remove_acpi_chip;
736 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
738 goto err_remove_irqchip_mask;
741 * By first adding the chardev, and then adding the device,
742 * we get a device node entry in sysfs under
743 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
744 * coldplug of device nodes and other udev business.
745 * We can do this only if gpiolib has been initialized.
746 * Otherwise, defer until later.
748 if (gpiolib_initialized) {
749 ret = gpiochip_setup_dev(gdev);
751 goto err_remove_irqchip;
756 gpiochip_irqchip_remove(gc);
757 err_remove_irqchip_mask:
758 gpiochip_irqchip_free_valid_mask(gc);
759 err_remove_acpi_chip:
760 acpi_gpiochip_remove(gc);
762 gpiochip_free_hogs(gc);
763 of_gpiochip_remove(gc);
764 err_free_gpiochip_mask:
765 gpiochip_remove_pin_ranges(gc);
766 gpiochip_free_valid_mask(gc);
767 err_remove_from_list:
768 spin_lock_irqsave(&gpio_lock, flags);
769 list_del(&gdev->list);
770 spin_unlock_irqrestore(&gpio_lock, flags);
772 kfree_const(gdev->label);
776 kfree(dev_name(&gdev->dev));
778 ida_free(&gpio_ida, gdev->id);
780 /* failures here can mean systems won't boot... */
781 if (ret != -EPROBE_DEFER) {
782 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
783 gdev->base, gdev->base + gdev->ngpio - 1,
784 gc->label ? : "generic", ret);
789 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
792 * gpiochip_get_data() - get per-subdriver data for the chip
796 * The per-subdriver data for the chip.
798 void *gpiochip_get_data(struct gpio_chip *gc)
800 return gc->gpiodev->data;
802 EXPORT_SYMBOL_GPL(gpiochip_get_data);
805 * gpiochip_remove() - unregister a gpio_chip
806 * @gc: the chip to unregister
808 * A gpio_chip with any GPIOs still requested may not be removed.
810 void gpiochip_remove(struct gpio_chip *gc)
812 struct gpio_device *gdev = gc->gpiodev;
816 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
817 gpiochip_sysfs_unregister(gdev);
818 gpiochip_free_hogs(gc);
819 /* Numb the device, cancelling all outstanding operations */
821 gpiochip_irqchip_remove(gc);
822 acpi_gpiochip_remove(gc);
823 of_gpiochip_remove(gc);
824 gpiochip_remove_pin_ranges(gc);
825 gpiochip_free_valid_mask(gc);
827 * We accept no more calls into the driver from this point, so
828 * NULL the driver data pointer
832 spin_lock_irqsave(&gpio_lock, flags);
833 for (i = 0; i < gdev->ngpio; i++) {
834 if (gpiochip_is_requested(gc, i))
837 spin_unlock_irqrestore(&gpio_lock, flags);
839 if (i != gdev->ngpio)
841 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
844 * The gpiochip side puts its use of the device to rest here:
845 * if there are no userspace clients, the chardev and device will
846 * be removed, else it will be dangling until the last user is
849 gcdev_unregister(gdev);
850 put_device(&gdev->dev);
852 EXPORT_SYMBOL_GPL(gpiochip_remove);
855 * gpiochip_find() - iterator for locating a specific gpio_chip
856 * @data: data to pass to match function
857 * @match: Callback function to check gpio_chip
859 * Similar to bus_find_device. It returns a reference to a gpio_chip as
860 * determined by a user supplied @match callback. The callback should return
861 * 0 if the device doesn't match and non-zero if it does. If the callback is
862 * non-zero, this function will return to the caller and not iterate over any
865 struct gpio_chip *gpiochip_find(void *data,
866 int (*match)(struct gpio_chip *gc,
869 struct gpio_device *gdev;
870 struct gpio_chip *gc = NULL;
873 spin_lock_irqsave(&gpio_lock, flags);
874 list_for_each_entry(gdev, &gpio_devices, list)
875 if (gdev->chip && match(gdev->chip, data)) {
880 spin_unlock_irqrestore(&gpio_lock, flags);
884 EXPORT_SYMBOL_GPL(gpiochip_find);
886 static int gpiochip_match_name(struct gpio_chip *gc, void *data)
888 const char *name = data;
890 return !strcmp(gc->label, name);
893 static struct gpio_chip *find_chip_by_name(const char *name)
895 return gpiochip_find((void *)name, gpiochip_match_name);
898 #ifdef CONFIG_GPIOLIB_IRQCHIP
901 * The following is irqchip helper code for gpiochips.
904 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
906 struct gpio_irq_chip *girq = &gc->irq;
911 return girq->init_hw(gc);
914 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
916 struct gpio_irq_chip *girq = &gc->irq;
918 if (!girq->init_valid_mask)
921 girq->valid_mask = gpiochip_allocate_mask(gc);
922 if (!girq->valid_mask)
925 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
930 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
932 bitmap_free(gc->irq.valid_mask);
933 gc->irq.valid_mask = NULL;
936 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
939 if (!gpiochip_line_is_valid(gc, offset))
941 /* No mask means all valid */
942 if (likely(!gc->irq.valid_mask))
944 return test_bit(offset, gc->irq.valid_mask);
946 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
948 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
951 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
953 * @gc: the gpiochip to set the irqchip hierarchical handler to
954 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
955 * will then percolate up to the parent
957 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
958 struct irq_chip *irqchip)
960 /* DT will deal with mapping each IRQ as we go along */
961 if (is_of_node(gc->irq.fwnode))
965 * This is for legacy and boardfile "irqchip" fwnodes: allocate
966 * irqs upfront instead of dynamically since we don't have the
967 * dynamic type of allocation that hardware description languages
968 * provide. Once all GPIO drivers using board files are gone from
969 * the kernel we can delete this code, but for a transitional period
970 * it is necessary to keep this around.
972 if (is_fwnode_irqchip(gc->irq.fwnode)) {
976 for (i = 0; i < gc->ngpio; i++) {
977 struct irq_fwspec fwspec;
978 unsigned int parent_hwirq;
979 unsigned int parent_type;
980 struct gpio_irq_chip *girq = &gc->irq;
983 * We call the child to parent translation function
984 * only to check if the child IRQ is valid or not.
985 * Just pick the rising edge type here as that is what
986 * we likely need to support.
988 ret = girq->child_to_parent_hwirq(gc, i,
989 IRQ_TYPE_EDGE_RISING,
993 chip_err(gc, "skip set-up on hwirq %d\n",
998 fwspec.fwnode = gc->irq.fwnode;
999 /* This is the hwirq for the GPIO line side of things */
1000 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
1001 /* Just pick something */
1002 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
1003 fwspec.param_count = 2;
1004 ret = __irq_domain_alloc_irqs(gc->irq.domain,
1005 /* just pick something */
1014 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1021 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1026 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1027 struct irq_fwspec *fwspec,
1028 unsigned long *hwirq,
1031 /* We support standard DT translation */
1032 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1033 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1036 /* This is for board files and others not using DT */
1037 if (is_fwnode_irqchip(fwspec->fwnode)) {
1040 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1043 WARN_ON(*type == IRQ_TYPE_NONE);
1049 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1051 unsigned int nr_irqs,
1054 struct gpio_chip *gc = d->host_data;
1055 irq_hw_number_t hwirq;
1056 unsigned int type = IRQ_TYPE_NONE;
1057 struct irq_fwspec *fwspec = data;
1059 unsigned int parent_hwirq;
1060 unsigned int parent_type;
1061 struct gpio_irq_chip *girq = &gc->irq;
1065 * The nr_irqs parameter is always one except for PCI multi-MSI
1066 * so this should not happen.
1068 WARN_ON(nr_irqs != 1);
1070 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1074 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1076 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1077 &parent_hwirq, &parent_type);
1079 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1082 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1085 * We set handle_bad_irq because the .set_type() should
1086 * always be invoked and set the right type of handler.
1088 irq_domain_set_info(d,
1097 /* This parent only handles asserted level IRQs */
1098 parent_arg = girq->populate_parent_alloc_arg(gc, parent_hwirq, parent_type);
1102 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1104 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1105 ret = irq_domain_alloc_irqs_parent(d, irq, 1, parent_arg);
1107 * If the parent irqdomain is msi, the interrupts have already
1108 * been allocated, so the EEXIST is good.
1110 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1114 "failed to allocate parent hwirq %d for hwirq %lu\n",
1115 parent_hwirq, hwirq);
1121 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1122 unsigned int offset)
1127 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1129 ops->activate = gpiochip_irq_domain_activate;
1130 ops->deactivate = gpiochip_irq_domain_deactivate;
1131 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1132 ops->free = irq_domain_free_irqs_common;
1135 * We only allow overriding the translate() function for
1136 * hierarchical chips, and this should only be done if the user
1137 * really need something other than 1:1 translation.
1139 if (!ops->translate)
1140 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1143 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1145 if (!gc->irq.child_to_parent_hwirq ||
1147 chip_err(gc, "missing irqdomain vital data\n");
1151 if (!gc->irq.child_offset_to_irq)
1152 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1154 if (!gc->irq.populate_parent_alloc_arg)
1155 gc->irq.populate_parent_alloc_arg =
1156 gpiochip_populate_parent_fwspec_twocell;
1158 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1160 gc->irq.domain = irq_domain_create_hierarchy(
1161 gc->irq.parent_domain,
1165 &gc->irq.child_irq_domain_ops,
1168 if (!gc->irq.domain)
1171 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1176 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1178 return !!gc->irq.parent_domain;
1181 void *gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1182 unsigned int parent_hwirq,
1183 unsigned int parent_type)
1185 struct irq_fwspec *fwspec;
1187 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1191 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1192 fwspec->param_count = 2;
1193 fwspec->param[0] = parent_hwirq;
1194 fwspec->param[1] = parent_type;
1198 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1200 void *gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1201 unsigned int parent_hwirq,
1202 unsigned int parent_type)
1204 struct irq_fwspec *fwspec;
1206 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1210 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1211 fwspec->param_count = 4;
1212 fwspec->param[0] = 0;
1213 fwspec->param[1] = parent_hwirq;
1214 fwspec->param[2] = 0;
1215 fwspec->param[3] = parent_type;
1219 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1223 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1228 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1233 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1236 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1237 * @d: the irqdomain used by this irqchip
1238 * @irq: the global irq number used by this GPIO irqchip irq
1239 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1241 * This function will set up the mapping for a certain IRQ line on a
1242 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1243 * stored inside the gpiochip.
1245 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1246 irq_hw_number_t hwirq)
1248 struct gpio_chip *gc = d->host_data;
1251 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1254 irq_set_chip_data(irq, gc);
1256 * This lock class tells lockdep that GPIO irqs are in a different
1257 * category than their parents, so it won't report false recursion.
1259 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1260 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1261 /* Chips that use nested thread handlers have them marked */
1262 if (gc->irq.threaded)
1263 irq_set_nested_thread(irq, 1);
1264 irq_set_noprobe(irq);
1266 if (gc->irq.num_parents == 1)
1267 ret = irq_set_parent(irq, gc->irq.parents[0]);
1268 else if (gc->irq.map)
1269 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1275 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1276 * is passed as default type.
1278 if (gc->irq.default_type != IRQ_TYPE_NONE)
1279 irq_set_irq_type(irq, gc->irq.default_type);
1283 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1285 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1287 struct gpio_chip *gc = d->host_data;
1289 if (gc->irq.threaded)
1290 irq_set_nested_thread(irq, 0);
1291 irq_set_chip_and_handler(irq, NULL, NULL);
1292 irq_set_chip_data(irq, NULL);
1294 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1296 static const struct irq_domain_ops gpiochip_domain_ops = {
1297 .map = gpiochip_irq_map,
1298 .unmap = gpiochip_irq_unmap,
1299 /* Virtually all GPIO irqchips are twocell:ed */
1300 .xlate = irq_domain_xlate_twocell,
1304 * TODO: move these activate/deactivate in under the hierarchicial
1305 * irqchip implementation as static once SPMI and SSBI (all external
1306 * users) are phased over.
1309 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1310 * @domain: The IRQ domain used by this IRQ chip
1311 * @data: Outermost irq_data associated with the IRQ
1312 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1314 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1315 * used as the activate function for the &struct irq_domain_ops. The host_data
1316 * for the IRQ domain must be the &struct gpio_chip.
1318 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1319 struct irq_data *data, bool reserve)
1321 struct gpio_chip *gc = domain->host_data;
1323 return gpiochip_lock_as_irq(gc, data->hwirq);
1325 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1328 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1329 * @domain: The IRQ domain used by this IRQ chip
1330 * @data: Outermost irq_data associated with the IRQ
1332 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1333 * be used as the deactivate function for the &struct irq_domain_ops. The
1334 * host_data for the IRQ domain must be the &struct gpio_chip.
1336 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1337 struct irq_data *data)
1339 struct gpio_chip *gc = domain->host_data;
1341 return gpiochip_unlock_as_irq(gc, data->hwirq);
1343 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1345 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1347 struct irq_domain *domain = gc->irq.domain;
1349 if (!gpiochip_irqchip_irq_valid(gc, offset))
1352 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1353 if (irq_domain_is_hierarchy(domain)) {
1354 struct irq_fwspec spec;
1356 spec.fwnode = domain->fwnode;
1357 spec.param_count = 2;
1358 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1359 spec.param[1] = IRQ_TYPE_NONE;
1361 return irq_create_fwspec_mapping(&spec);
1365 return irq_create_mapping(domain, offset);
1368 static int gpiochip_irq_reqres(struct irq_data *d)
1370 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1372 return gpiochip_reqres_irq(gc, d->hwirq);
1375 static void gpiochip_irq_relres(struct irq_data *d)
1377 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1379 gpiochip_relres_irq(gc, d->hwirq);
1382 static void gpiochip_irq_mask(struct irq_data *d)
1384 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1386 if (gc->irq.irq_mask)
1387 gc->irq.irq_mask(d);
1388 gpiochip_disable_irq(gc, d->hwirq);
1391 static void gpiochip_irq_unmask(struct irq_data *d)
1393 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1395 gpiochip_enable_irq(gc, d->hwirq);
1396 if (gc->irq.irq_unmask)
1397 gc->irq.irq_unmask(d);
1400 static void gpiochip_irq_enable(struct irq_data *d)
1402 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1404 gpiochip_enable_irq(gc, d->hwirq);
1405 gc->irq.irq_enable(d);
1408 static void gpiochip_irq_disable(struct irq_data *d)
1410 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1412 gc->irq.irq_disable(d);
1413 gpiochip_disable_irq(gc, d->hwirq);
1416 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1418 struct irq_chip *irqchip = gc->irq.chip;
1420 if (!irqchip->irq_request_resources &&
1421 !irqchip->irq_release_resources) {
1422 irqchip->irq_request_resources = gpiochip_irq_reqres;
1423 irqchip->irq_release_resources = gpiochip_irq_relres;
1425 if (WARN_ON(gc->irq.irq_enable))
1427 /* Check if the irqchip already has this hook... */
1428 if (irqchip->irq_enable == gpiochip_irq_enable ||
1429 irqchip->irq_mask == gpiochip_irq_mask) {
1431 * ...and if so, give a gentle warning that this is bad
1435 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1439 if (irqchip->irq_disable) {
1440 gc->irq.irq_disable = irqchip->irq_disable;
1441 irqchip->irq_disable = gpiochip_irq_disable;
1443 gc->irq.irq_mask = irqchip->irq_mask;
1444 irqchip->irq_mask = gpiochip_irq_mask;
1447 if (irqchip->irq_enable) {
1448 gc->irq.irq_enable = irqchip->irq_enable;
1449 irqchip->irq_enable = gpiochip_irq_enable;
1451 gc->irq.irq_unmask = irqchip->irq_unmask;
1452 irqchip->irq_unmask = gpiochip_irq_unmask;
1457 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1458 * @gc: the GPIO chip to add the IRQ chip to
1459 * @lock_key: lockdep class for IRQ lock
1460 * @request_key: lockdep class for IRQ request
1462 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1463 struct lock_class_key *lock_key,
1464 struct lock_class_key *request_key)
1466 struct irq_chip *irqchip = gc->irq.chip;
1467 const struct irq_domain_ops *ops = NULL;
1468 struct device_node *np;
1475 if (gc->irq.parent_handler && gc->can_sleep) {
1476 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1480 np = gc->gpiodev->dev.of_node;
1481 type = gc->irq.default_type;
1484 * Specifying a default trigger is a terrible idea if DT or ACPI is
1485 * used to configure the interrupts, as you may end up with
1486 * conflicting triggers. Tell the user, and reset to NONE.
1488 if (WARN(np && type != IRQ_TYPE_NONE,
1489 "%s: Ignoring %u default trigger\n", np->full_name, type))
1490 type = IRQ_TYPE_NONE;
1492 if (has_acpi_companion(gc->parent) && type != IRQ_TYPE_NONE) {
1493 acpi_handle_warn(ACPI_HANDLE(gc->parent),
1494 "Ignoring %u default trigger\n", type);
1495 type = IRQ_TYPE_NONE;
1499 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1501 gc->to_irq = gpiochip_to_irq;
1502 gc->irq.default_type = type;
1503 gc->irq.lock_key = lock_key;
1504 gc->irq.request_key = request_key;
1506 /* If a parent irqdomain is provided, let's build a hierarchy */
1507 if (gpiochip_hierarchy_is_hierarchical(gc)) {
1508 int ret = gpiochip_hierarchy_add_domain(gc);
1512 /* Some drivers provide custom irqdomain ops */
1513 if (gc->irq.domain_ops)
1514 ops = gc->irq.domain_ops;
1517 ops = &gpiochip_domain_ops;
1518 gc->irq.domain = irq_domain_add_simple(np,
1522 if (!gc->irq.domain)
1526 if (gc->irq.parent_handler) {
1527 void *data = gc->irq.parent_handler_data ?: gc;
1529 for (i = 0; i < gc->irq.num_parents; i++) {
1531 * The parent IRQ chip is already using the chip_data
1532 * for this IRQ chip, so our callbacks simply use the
1535 irq_set_chained_handler_and_data(gc->irq.parents[i],
1536 gc->irq.parent_handler,
1541 gpiochip_set_irq_hooks(gc);
1543 acpi_gpiochip_request_interrupts(gc);
1549 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1550 * @gc: the gpiochip to remove the irqchip from
1552 * This is called only from gpiochip_remove()
1554 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1556 struct irq_chip *irqchip = gc->irq.chip;
1557 unsigned int offset;
1559 acpi_gpiochip_free_interrupts(gc);
1561 if (irqchip && gc->irq.parent_handler) {
1562 struct gpio_irq_chip *irq = &gc->irq;
1565 for (i = 0; i < irq->num_parents; i++)
1566 irq_set_chained_handler_and_data(irq->parents[i],
1570 /* Remove all IRQ mappings and delete the domain */
1571 if (gc->irq.domain) {
1574 for (offset = 0; offset < gc->ngpio; offset++) {
1575 if (!gpiochip_irqchip_irq_valid(gc, offset))
1578 irq = irq_find_mapping(gc->irq.domain, offset);
1579 irq_dispose_mapping(irq);
1582 irq_domain_remove(gc->irq.domain);
1586 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1587 irqchip->irq_request_resources = NULL;
1588 irqchip->irq_release_resources = NULL;
1590 if (irqchip->irq_enable == gpiochip_irq_enable) {
1591 irqchip->irq_enable = gc->irq.irq_enable;
1592 irqchip->irq_disable = gc->irq.irq_disable;
1595 gc->irq.irq_enable = NULL;
1596 gc->irq.irq_disable = NULL;
1597 gc->irq.chip = NULL;
1599 gpiochip_irqchip_free_valid_mask(gc);
1603 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1604 * @gc: the gpiochip to add the irqchip to
1605 * @domain: the irqdomain to add to the gpiochip
1607 * This function adds an IRQ domain to the gpiochip.
1609 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1610 struct irq_domain *domain)
1615 gc->to_irq = gpiochip_to_irq;
1616 gc->irq.domain = domain;
1620 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1622 #else /* CONFIG_GPIOLIB_IRQCHIP */
1624 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1625 struct lock_class_key *lock_key,
1626 struct lock_class_key *request_key)
1630 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1632 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1637 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1641 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1644 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1647 * gpiochip_generic_request() - request the gpio function for a pin
1648 * @gc: the gpiochip owning the GPIO
1649 * @offset: the offset of the GPIO to request for GPIO function
1651 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
1653 #ifdef CONFIG_PINCTRL
1654 if (list_empty(&gc->gpiodev->pin_ranges))
1658 return pinctrl_gpio_request(gc->gpiodev->base + offset);
1660 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1663 * gpiochip_generic_free() - free the gpio function from a pin
1664 * @gc: the gpiochip to request the gpio function for
1665 * @offset: the offset of the GPIO to free from GPIO function
1667 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
1669 #ifdef CONFIG_PINCTRL
1670 if (list_empty(&gc->gpiodev->pin_ranges))
1674 pinctrl_gpio_free(gc->gpiodev->base + offset);
1676 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1679 * gpiochip_generic_config() - apply configuration for a pin
1680 * @gc: the gpiochip owning the GPIO
1681 * @offset: the offset of the GPIO to apply the configuration
1682 * @config: the configuration to be applied
1684 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
1685 unsigned long config)
1687 return pinctrl_gpio_set_config(gc->gpiodev->base + offset, config);
1689 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1691 #ifdef CONFIG_PINCTRL
1694 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1695 * @gc: the gpiochip to add the range for
1696 * @pctldev: the pin controller to map to
1697 * @gpio_offset: the start offset in the current gpio_chip number space
1698 * @pin_group: name of the pin group inside the pin controller
1700 * Calling this function directly from a DeviceTree-supported
1701 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1702 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1703 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1705 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
1706 struct pinctrl_dev *pctldev,
1707 unsigned int gpio_offset, const char *pin_group)
1709 struct gpio_pin_range *pin_range;
1710 struct gpio_device *gdev = gc->gpiodev;
1713 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1715 chip_err(gc, "failed to allocate pin ranges\n");
1719 /* Use local offset as range ID */
1720 pin_range->range.id = gpio_offset;
1721 pin_range->range.gc = gc;
1722 pin_range->range.name = gc->label;
1723 pin_range->range.base = gdev->base + gpio_offset;
1724 pin_range->pctldev = pctldev;
1726 ret = pinctrl_get_group_pins(pctldev, pin_group,
1727 &pin_range->range.pins,
1728 &pin_range->range.npins);
1734 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1736 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1737 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1738 pinctrl_dev_get_devname(pctldev), pin_group);
1740 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1744 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1747 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1748 * @gc: the gpiochip to add the range for
1749 * @pinctl_name: the dev_name() of the pin controller to map to
1750 * @gpio_offset: the start offset in the current gpio_chip number space
1751 * @pin_offset: the start offset in the pin controller number space
1752 * @npins: the number of pins from the offset of each pin space (GPIO and
1753 * pin controller) to accumulate in this range
1756 * 0 on success, or a negative error-code on failure.
1758 * Calling this function directly from a DeviceTree-supported
1759 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1760 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1761 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1763 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
1764 unsigned int gpio_offset, unsigned int pin_offset,
1767 struct gpio_pin_range *pin_range;
1768 struct gpio_device *gdev = gc->gpiodev;
1771 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1773 chip_err(gc, "failed to allocate pin ranges\n");
1777 /* Use local offset as range ID */
1778 pin_range->range.id = gpio_offset;
1779 pin_range->range.gc = gc;
1780 pin_range->range.name = gc->label;
1781 pin_range->range.base = gdev->base + gpio_offset;
1782 pin_range->range.pin_base = pin_offset;
1783 pin_range->range.npins = npins;
1784 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1786 if (IS_ERR(pin_range->pctldev)) {
1787 ret = PTR_ERR(pin_range->pctldev);
1788 chip_err(gc, "could not create pin range\n");
1792 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1793 gpio_offset, gpio_offset + npins - 1,
1795 pin_offset, pin_offset + npins - 1);
1797 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1801 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1804 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1805 * @gc: the chip to remove all the mappings for
1807 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
1809 struct gpio_pin_range *pin_range, *tmp;
1810 struct gpio_device *gdev = gc->gpiodev;
1812 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1813 list_del(&pin_range->node);
1814 pinctrl_remove_gpio_range(pin_range->pctldev,
1819 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1821 #endif /* CONFIG_PINCTRL */
1823 /* These "optional" allocation calls help prevent drivers from stomping
1824 * on each other, and help provide better diagnostics in debugfs.
1825 * They're called even less than the "set direction" calls.
1827 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
1829 struct gpio_chip *gc = desc->gdev->chip;
1831 unsigned long flags;
1835 label = kstrdup_const(label, GFP_KERNEL);
1840 spin_lock_irqsave(&gpio_lock, flags);
1842 /* NOTE: gpio_request() can be called in early boot,
1843 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1846 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1847 desc_set_label(desc, label ? : "?");
1850 goto out_free_unlock;
1854 /* gc->request may sleep */
1855 spin_unlock_irqrestore(&gpio_lock, flags);
1856 offset = gpio_chip_hwgpio(desc);
1857 if (gpiochip_line_is_valid(gc, offset))
1858 ret = gc->request(gc, offset);
1861 spin_lock_irqsave(&gpio_lock, flags);
1864 desc_set_label(desc, NULL);
1865 clear_bit(FLAG_REQUESTED, &desc->flags);
1866 goto out_free_unlock;
1869 if (gc->get_direction) {
1870 /* gc->get_direction may sleep */
1871 spin_unlock_irqrestore(&gpio_lock, flags);
1872 gpiod_get_direction(desc);
1873 spin_lock_irqsave(&gpio_lock, flags);
1875 spin_unlock_irqrestore(&gpio_lock, flags);
1879 spin_unlock_irqrestore(&gpio_lock, flags);
1885 * This descriptor validation needs to be inserted verbatim into each
1886 * function taking a descriptor, so we need to use a preprocessor
1887 * macro to avoid endless duplication. If the desc is NULL it is an
1888 * optional GPIO and calls should just bail out.
1890 static int validate_desc(const struct gpio_desc *desc, const char *func)
1895 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
1896 return PTR_ERR(desc);
1899 pr_warn("%s: invalid GPIO (no device)\n", func);
1902 if (!desc->gdev->chip) {
1903 dev_warn(&desc->gdev->dev,
1904 "%s: backing chip is gone\n", func);
1910 #define VALIDATE_DESC(desc) do { \
1911 int __valid = validate_desc(desc, __func__); \
1916 #define VALIDATE_DESC_VOID(desc) do { \
1917 int __valid = validate_desc(desc, __func__); \
1922 int gpiod_request(struct gpio_desc *desc, const char *label)
1924 int ret = -EPROBE_DEFER;
1925 struct gpio_device *gdev;
1927 VALIDATE_DESC(desc);
1930 if (try_module_get(gdev->owner)) {
1931 ret = gpiod_request_commit(desc, label);
1933 module_put(gdev->owner);
1935 get_device(&gdev->dev);
1939 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
1944 static bool gpiod_free_commit(struct gpio_desc *desc)
1947 unsigned long flags;
1948 struct gpio_chip *gc;
1952 gpiod_unexport(desc);
1954 spin_lock_irqsave(&gpio_lock, flags);
1956 gc = desc->gdev->chip;
1957 if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
1959 spin_unlock_irqrestore(&gpio_lock, flags);
1960 might_sleep_if(gc->can_sleep);
1961 gc->free(gc, gpio_chip_hwgpio(desc));
1962 spin_lock_irqsave(&gpio_lock, flags);
1964 kfree_const(desc->label);
1965 desc_set_label(desc, NULL);
1966 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1967 clear_bit(FLAG_REQUESTED, &desc->flags);
1968 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1969 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1970 clear_bit(FLAG_PULL_UP, &desc->flags);
1971 clear_bit(FLAG_PULL_DOWN, &desc->flags);
1972 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
1973 clear_bit(FLAG_EDGE_RISING, &desc->flags);
1974 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
1975 clear_bit(FLAG_IS_HOGGED, &desc->flags);
1976 #ifdef CONFIG_OF_DYNAMIC
1979 #ifdef CONFIG_GPIO_CDEV
1980 WRITE_ONCE(desc->debounce_period_us, 0);
1985 spin_unlock_irqrestore(&gpio_lock, flags);
1986 blocking_notifier_call_chain(&desc->gdev->notifier,
1987 GPIOLINE_CHANGED_RELEASED, desc);
1992 void gpiod_free(struct gpio_desc *desc)
1994 if (desc && desc->gdev && gpiod_free_commit(desc)) {
1995 module_put(desc->gdev->owner);
1996 put_device(&desc->gdev->dev);
1998 WARN_ON(extra_checks);
2003 * gpiochip_is_requested - return string iff signal was requested
2004 * @gc: controller managing the signal
2005 * @offset: of signal within controller's 0..(ngpio - 1) range
2007 * Returns NULL if the GPIO is not currently requested, else a string.
2008 * The string returned is the label passed to gpio_request(); if none has been
2009 * passed it is a meaningless, non-NULL constant.
2011 * This function is for use by GPIO controller drivers. The label can
2012 * help with diagnostics, and knowing that the signal is used as a GPIO
2013 * can help avoid accidentally multiplexing it to another controller.
2015 const char *gpiochip_is_requested(struct gpio_chip *gc, unsigned int offset)
2017 struct gpio_desc *desc;
2019 if (offset >= gc->ngpio)
2022 desc = gpiochip_get_desc(gc, offset);
2026 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2030 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2033 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2035 * @hwnum: hardware number of the GPIO for which to request the descriptor
2036 * @label: label for the GPIO
2037 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2038 * specify things like line inversion semantics with the machine flags
2039 * such as GPIO_OUT_LOW
2040 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2041 * can be used to specify consumer semantics such as open drain
2043 * Function allows GPIO chip drivers to request and use their own GPIO
2044 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2045 * function will not increase reference count of the GPIO chip module. This
2046 * allows the GPIO chip module to be unloaded as needed (we assume that the
2047 * GPIO chip driver handles freeing the GPIOs it has requested).
2050 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2053 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2056 enum gpio_lookup_flags lflags,
2057 enum gpiod_flags dflags)
2059 struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2063 chip_err(gc, "failed to get GPIO descriptor\n");
2067 ret = gpiod_request_commit(desc, label);
2069 return ERR_PTR(ret);
2071 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2073 chip_err(gc, "setup of own GPIO %s failed\n", label);
2074 gpiod_free_commit(desc);
2075 return ERR_PTR(ret);
2080 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2083 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2084 * @desc: GPIO descriptor to free
2086 * Function frees the given GPIO requested previously with
2087 * gpiochip_request_own_desc().
2089 void gpiochip_free_own_desc(struct gpio_desc *desc)
2092 gpiod_free_commit(desc);
2094 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2097 * Drivers MUST set GPIO direction before making get/set calls. In
2098 * some cases this is done in early boot, before IRQs are enabled.
2100 * As a rule these aren't called more than once (except for drivers
2101 * using the open-drain emulation idiom) so these are natural places
2102 * to accumulate extra debugging checks. Note that we can't (yet)
2103 * rely on gpio_request() having been called beforehand.
2106 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2107 unsigned long config)
2109 if (!gc->set_config)
2112 return gc->set_config(gc, offset, config);
2115 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2116 enum pin_config_param mode,
2119 struct gpio_chip *gc = desc->gdev->chip;
2120 unsigned long config;
2122 config = pinconf_to_config_packed(mode, argument);
2123 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2126 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2127 enum pin_config_param mode,
2130 struct device *dev = &desc->gdev->dev;
2131 int gpio = gpio_chip_hwgpio(desc);
2134 ret = gpio_set_config_with_argument(desc, mode, argument);
2135 if (ret != -ENOTSUPP)
2139 case PIN_CONFIG_PERSIST_STATE:
2140 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2149 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2151 return gpio_set_config_with_argument(desc, mode, 0);
2154 static int gpio_set_bias(struct gpio_desc *desc)
2156 enum pin_config_param bias;
2159 if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2160 bias = PIN_CONFIG_BIAS_DISABLE;
2161 else if (test_bit(FLAG_PULL_UP, &desc->flags))
2162 bias = PIN_CONFIG_BIAS_PULL_UP;
2163 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2164 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2169 case PIN_CONFIG_BIAS_PULL_DOWN:
2170 case PIN_CONFIG_BIAS_PULL_UP:
2179 return gpio_set_config_with_argument_optional(desc, bias, arg);
2182 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2184 return gpio_set_config_with_argument_optional(desc,
2185 PIN_CONFIG_INPUT_DEBOUNCE,
2190 * gpiod_direction_input - set the GPIO direction to input
2191 * @desc: GPIO to set to input
2193 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2194 * be called safely on it.
2196 * Return 0 in case of success, else an error code.
2198 int gpiod_direction_input(struct gpio_desc *desc)
2200 struct gpio_chip *gc;
2203 VALIDATE_DESC(desc);
2204 gc = desc->gdev->chip;
2207 * It is legal to have no .get() and .direction_input() specified if
2208 * the chip is output-only, but you can't specify .direction_input()
2209 * and not support the .get() operation, that doesn't make sense.
2211 if (!gc->get && gc->direction_input) {
2213 "%s: missing get() but have direction_input()\n",
2219 * If we have a .direction_input() callback, things are simple,
2220 * just call it. Else we are some input-only chip so try to check the
2221 * direction (if .get_direction() is supported) else we silently
2222 * assume we are in input mode after this.
2224 if (gc->direction_input) {
2225 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2226 } else if (gc->get_direction &&
2227 (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2229 "%s: missing direction_input() operation and line is output\n",
2234 clear_bit(FLAG_IS_OUT, &desc->flags);
2235 ret = gpio_set_bias(desc);
2238 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2242 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2244 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2246 struct gpio_chip *gc = desc->gdev->chip;
2251 * It's OK not to specify .direction_output() if the gpiochip is
2252 * output-only, but if there is then not even a .set() operation it
2253 * is pretty tricky to drive the output line.
2255 if (!gc->set && !gc->direction_output) {
2257 "%s: missing set() and direction_output() operations\n",
2262 if (gc->direction_output) {
2263 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2265 /* Check that we are in output mode if we can */
2266 if (gc->get_direction &&
2267 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2269 "%s: missing direction_output() operation\n",
2274 * If we can't actively set the direction, we are some
2275 * output-only chip, so just drive the output as desired.
2277 gc->set(gc, gpio_chip_hwgpio(desc), val);
2281 set_bit(FLAG_IS_OUT, &desc->flags);
2282 trace_gpio_value(desc_to_gpio(desc), 0, val);
2283 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2288 * gpiod_direction_output_raw - set the GPIO direction to output
2289 * @desc: GPIO to set to output
2290 * @value: initial output value of the GPIO
2292 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2293 * be called safely on it. The initial value of the output must be specified
2294 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2296 * Return 0 in case of success, else an error code.
2298 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2300 VALIDATE_DESC(desc);
2301 return gpiod_direction_output_raw_commit(desc, value);
2303 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2306 * gpiod_direction_output - set the GPIO direction to output
2307 * @desc: GPIO to set to output
2308 * @value: initial output value of the GPIO
2310 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2311 * be called safely on it. The initial value of the output must be specified
2312 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2315 * Return 0 in case of success, else an error code.
2317 int gpiod_direction_output(struct gpio_desc *desc, int value)
2321 VALIDATE_DESC(desc);
2322 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2327 /* GPIOs used for enabled IRQs shall not be set as output */
2328 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2329 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2331 "%s: tried to set a GPIO tied to an IRQ as output\n",
2336 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2337 /* First see if we can enable open drain in hardware */
2338 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2340 goto set_output_value;
2341 /* Emulate open drain by not actively driving the line high */
2343 ret = gpiod_direction_input(desc);
2344 goto set_output_flag;
2347 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2348 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2350 goto set_output_value;
2351 /* Emulate open source by not actively driving the line low */
2353 ret = gpiod_direction_input(desc);
2354 goto set_output_flag;
2357 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2361 ret = gpio_set_bias(desc);
2364 return gpiod_direction_output_raw_commit(desc, value);
2368 * When emulating open-source or open-drain functionalities by not
2369 * actively driving the line (setting mode to input) we still need to
2370 * set the IS_OUT flag or otherwise we won't be able to set the line
2374 set_bit(FLAG_IS_OUT, &desc->flags);
2377 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2380 * gpiod_set_config - sets @config for a GPIO
2381 * @desc: descriptor of the GPIO for which to set the configuration
2382 * @config: Same packed config format as generic pinconf
2385 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2388 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2390 struct gpio_chip *gc;
2392 VALIDATE_DESC(desc);
2393 gc = desc->gdev->chip;
2395 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2397 EXPORT_SYMBOL_GPL(gpiod_set_config);
2400 * gpiod_set_debounce - sets @debounce time for a GPIO
2401 * @desc: descriptor of the GPIO for which to set debounce time
2402 * @debounce: debounce time in microseconds
2405 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2408 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2410 unsigned long config;
2412 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2413 return gpiod_set_config(desc, config);
2415 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2418 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2419 * @desc: descriptor of the GPIO for which to configure persistence
2420 * @transitory: True to lose state on suspend or reset, false for persistence
2423 * 0 on success, otherwise a negative error code.
2425 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2427 VALIDATE_DESC(desc);
2429 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2430 * persistence state.
2432 assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2434 /* If the driver supports it, set the persistence state now */
2435 return gpio_set_config_with_argument_optional(desc,
2436 PIN_CONFIG_PERSIST_STATE,
2439 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2442 * gpiod_is_active_low - test whether a GPIO is active-low or not
2443 * @desc: the gpio descriptor to test
2445 * Returns 1 if the GPIO is active-low, 0 otherwise.
2447 int gpiod_is_active_low(const struct gpio_desc *desc)
2449 VALIDATE_DESC(desc);
2450 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2452 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2455 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2456 * @desc: the gpio descriptor to change
2458 void gpiod_toggle_active_low(struct gpio_desc *desc)
2460 VALIDATE_DESC_VOID(desc);
2461 change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2463 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2465 /* I/O calls are only valid after configuration completed; the relevant
2466 * "is this a valid GPIO" error checks should already have been done.
2468 * "Get" operations are often inlinable as reading a pin value register,
2469 * and masking the relevant bit in that register.
2471 * When "set" operations are inlinable, they involve writing that mask to
2472 * one register to set a low value, or a different register to set it high.
2473 * Otherwise locking is needed, so there may be little value to inlining.
2475 *------------------------------------------------------------------------
2477 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2478 * have requested the GPIO. That can include implicit requesting by
2479 * a direction setting call. Marking a gpio as requested locks its chip
2480 * in memory, guaranteeing that these table lookups need no more locking
2481 * and that gpiochip_remove() will fail.
2483 * REVISIT when debugging, consider adding some instrumentation to ensure
2484 * that the GPIO was actually requested.
2487 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2489 struct gpio_chip *gc;
2493 gc = desc->gdev->chip;
2494 offset = gpio_chip_hwgpio(desc);
2495 value = gc->get ? gc->get(gc, offset) : -EIO;
2496 value = value < 0 ? value : !!value;
2497 trace_gpio_value(desc_to_gpio(desc), 1, value);
2501 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2502 unsigned long *mask, unsigned long *bits)
2504 if (gc->get_multiple) {
2505 return gc->get_multiple(gc, mask, bits);
2506 } else if (gc->get) {
2509 for_each_set_bit(i, mask, gc->ngpio) {
2510 value = gc->get(gc, i);
2513 __assign_bit(i, bits, value);
2520 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2521 unsigned int array_size,
2522 struct gpio_desc **desc_array,
2523 struct gpio_array *array_info,
2524 unsigned long *value_bitmap)
2529 * Validate array_info against desc_array and its size.
2530 * It should immediately follow desc_array if both
2531 * have been obtained from the same gpiod_get_array() call.
2533 if (array_info && array_info->desc == desc_array &&
2534 array_size <= array_info->size &&
2535 (void *)array_info == desc_array + array_info->size) {
2537 WARN_ON(array_info->chip->can_sleep);
2539 ret = gpio_chip_get_multiple(array_info->chip,
2540 array_info->get_mask,
2545 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2546 bitmap_xor(value_bitmap, value_bitmap,
2547 array_info->invert_mask, array_size);
2549 i = find_first_zero_bit(array_info->get_mask, array_size);
2550 if (i == array_size)
2556 while (i < array_size) {
2557 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2558 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2559 unsigned long *mask, *bits;
2562 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2565 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2567 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2572 bits = mask + BITS_TO_LONGS(gc->ngpio);
2573 bitmap_zero(mask, gc->ngpio);
2576 WARN_ON(gc->can_sleep);
2578 /* collect all inputs belonging to the same chip */
2581 const struct gpio_desc *desc = desc_array[i];
2582 int hwgpio = gpio_chip_hwgpio(desc);
2584 __set_bit(hwgpio, mask);
2588 i = find_next_zero_bit(array_info->get_mask,
2590 } while ((i < array_size) &&
2591 (desc_array[i]->gdev->chip == gc));
2593 ret = gpio_chip_get_multiple(gc, mask, bits);
2595 if (mask != fastpath)
2600 for (j = first; j < i; ) {
2601 const struct gpio_desc *desc = desc_array[j];
2602 int hwgpio = gpio_chip_hwgpio(desc);
2603 int value = test_bit(hwgpio, bits);
2605 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2607 __assign_bit(j, value_bitmap, value);
2608 trace_gpio_value(desc_to_gpio(desc), 1, value);
2612 j = find_next_zero_bit(array_info->get_mask, i,
2616 if (mask != fastpath)
2623 * gpiod_get_raw_value() - return a gpio's raw value
2624 * @desc: gpio whose value will be returned
2626 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2627 * its ACTIVE_LOW status, or negative errno on failure.
2629 * This function can be called from contexts where we cannot sleep, and will
2630 * complain if the GPIO chip functions potentially sleep.
2632 int gpiod_get_raw_value(const struct gpio_desc *desc)
2634 VALIDATE_DESC(desc);
2635 /* Should be using gpiod_get_raw_value_cansleep() */
2636 WARN_ON(desc->gdev->chip->can_sleep);
2637 return gpiod_get_raw_value_commit(desc);
2639 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2642 * gpiod_get_value() - return a gpio's value
2643 * @desc: gpio whose value will be returned
2645 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2646 * account, or negative errno on failure.
2648 * This function can be called from contexts where we cannot sleep, and will
2649 * complain if the GPIO chip functions potentially sleep.
2651 int gpiod_get_value(const struct gpio_desc *desc)
2655 VALIDATE_DESC(desc);
2656 /* Should be using gpiod_get_value_cansleep() */
2657 WARN_ON(desc->gdev->chip->can_sleep);
2659 value = gpiod_get_raw_value_commit(desc);
2663 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2668 EXPORT_SYMBOL_GPL(gpiod_get_value);
2671 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2672 * @array_size: number of elements in the descriptor array / value bitmap
2673 * @desc_array: array of GPIO descriptors whose values will be read
2674 * @array_info: information on applicability of fast bitmap processing path
2675 * @value_bitmap: bitmap to store the read values
2677 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2678 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2679 * else an error code.
2681 * This function can be called from contexts where we cannot sleep,
2682 * and it will complain if the GPIO chip functions potentially sleep.
2684 int gpiod_get_raw_array_value(unsigned int array_size,
2685 struct gpio_desc **desc_array,
2686 struct gpio_array *array_info,
2687 unsigned long *value_bitmap)
2691 return gpiod_get_array_value_complex(true, false, array_size,
2692 desc_array, array_info,
2695 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2698 * gpiod_get_array_value() - read values from an array of GPIOs
2699 * @array_size: number of elements in the descriptor array / value bitmap
2700 * @desc_array: array of GPIO descriptors whose values will be read
2701 * @array_info: information on applicability of fast bitmap processing path
2702 * @value_bitmap: bitmap to store the read values
2704 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2705 * into account. Return 0 in case of success, else an error code.
2707 * This function can be called from contexts where we cannot sleep,
2708 * and it will complain if the GPIO chip functions potentially sleep.
2710 int gpiod_get_array_value(unsigned int array_size,
2711 struct gpio_desc **desc_array,
2712 struct gpio_array *array_info,
2713 unsigned long *value_bitmap)
2717 return gpiod_get_array_value_complex(false, false, array_size,
2718 desc_array, array_info,
2721 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2724 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2725 * @desc: gpio descriptor whose state need to be set.
2726 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2728 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2731 struct gpio_chip *gc = desc->gdev->chip;
2732 int offset = gpio_chip_hwgpio(desc);
2735 ret = gc->direction_input(gc, offset);
2737 ret = gc->direction_output(gc, offset, 0);
2739 set_bit(FLAG_IS_OUT, &desc->flags);
2741 trace_gpio_direction(desc_to_gpio(desc), value, ret);
2744 "%s: Error in set_value for open drain err %d\n",
2749 * _gpio_set_open_source_value() - Set the open source gpio's value.
2750 * @desc: gpio descriptor whose state need to be set.
2751 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2753 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2756 struct gpio_chip *gc = desc->gdev->chip;
2757 int offset = gpio_chip_hwgpio(desc);
2760 ret = gc->direction_output(gc, offset, 1);
2762 set_bit(FLAG_IS_OUT, &desc->flags);
2764 ret = gc->direction_input(gc, offset);
2766 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
2769 "%s: Error in set_value for open source err %d\n",
2773 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2775 struct gpio_chip *gc;
2777 gc = desc->gdev->chip;
2778 trace_gpio_value(desc_to_gpio(desc), 0, value);
2779 gc->set(gc, gpio_chip_hwgpio(desc), value);
2783 * set multiple outputs on the same chip;
2784 * use the chip's set_multiple function if available;
2785 * otherwise set the outputs sequentially;
2786 * @chip: the GPIO chip we operate on
2787 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2788 * defines which outputs are to be changed
2789 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2790 * defines the values the outputs specified by mask are to be set to
2792 static void gpio_chip_set_multiple(struct gpio_chip *gc,
2793 unsigned long *mask, unsigned long *bits)
2795 if (gc->set_multiple) {
2796 gc->set_multiple(gc, mask, bits);
2800 /* set outputs if the corresponding mask bit is set */
2801 for_each_set_bit(i, mask, gc->ngpio)
2802 gc->set(gc, i, test_bit(i, bits));
2806 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
2807 unsigned int array_size,
2808 struct gpio_desc **desc_array,
2809 struct gpio_array *array_info,
2810 unsigned long *value_bitmap)
2815 * Validate array_info against desc_array and its size.
2816 * It should immediately follow desc_array if both
2817 * have been obtained from the same gpiod_get_array() call.
2819 if (array_info && array_info->desc == desc_array &&
2820 array_size <= array_info->size &&
2821 (void *)array_info == desc_array + array_info->size) {
2823 WARN_ON(array_info->chip->can_sleep);
2825 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2826 bitmap_xor(value_bitmap, value_bitmap,
2827 array_info->invert_mask, array_size);
2829 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
2832 i = find_first_zero_bit(array_info->set_mask, array_size);
2833 if (i == array_size)
2839 while (i < array_size) {
2840 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2841 unsigned long fastpath[2 * BITS_TO_LONGS(FASTPATH_NGPIO)];
2842 unsigned long *mask, *bits;
2845 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2848 mask = kmalloc_array(2 * BITS_TO_LONGS(gc->ngpio),
2850 can_sleep ? GFP_KERNEL : GFP_ATOMIC);
2855 bits = mask + BITS_TO_LONGS(gc->ngpio);
2856 bitmap_zero(mask, gc->ngpio);
2859 WARN_ON(gc->can_sleep);
2862 struct gpio_desc *desc = desc_array[i];
2863 int hwgpio = gpio_chip_hwgpio(desc);
2864 int value = test_bit(i, value_bitmap);
2867 * Pins applicable for fast input but not for
2868 * fast output processing may have been already
2869 * inverted inside the fast path, skip them.
2871 if (!raw && !(array_info &&
2872 test_bit(i, array_info->invert_mask)) &&
2873 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2875 trace_gpio_value(desc_to_gpio(desc), 0, value);
2877 * collect all normal outputs belonging to the same chip
2878 * open drain and open source outputs are set individually
2880 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
2881 gpio_set_open_drain_value_commit(desc, value);
2882 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
2883 gpio_set_open_source_value_commit(desc, value);
2885 __set_bit(hwgpio, mask);
2886 __assign_bit(hwgpio, bits, value);
2892 i = find_next_zero_bit(array_info->set_mask,
2894 } while ((i < array_size) &&
2895 (desc_array[i]->gdev->chip == gc));
2896 /* push collected bits to outputs */
2898 gpio_chip_set_multiple(gc, mask, bits);
2900 if (mask != fastpath)
2907 * gpiod_set_raw_value() - assign a gpio's raw value
2908 * @desc: gpio whose value will be assigned
2909 * @value: value to assign
2911 * Set the raw value of the GPIO, i.e. the value of its physical line without
2912 * regard for its ACTIVE_LOW status.
2914 * This function can be called from contexts where we cannot sleep, and will
2915 * complain if the GPIO chip functions potentially sleep.
2917 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2919 VALIDATE_DESC_VOID(desc);
2920 /* Should be using gpiod_set_raw_value_cansleep() */
2921 WARN_ON(desc->gdev->chip->can_sleep);
2922 gpiod_set_raw_value_commit(desc, value);
2924 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2927 * gpiod_set_value_nocheck() - set a GPIO line value without checking
2928 * @desc: the descriptor to set the value on
2929 * @value: value to set
2931 * This sets the value of a GPIO line backing a descriptor, applying
2932 * different semantic quirks like active low and open drain/source
2935 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
2937 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2939 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2940 gpio_set_open_drain_value_commit(desc, value);
2941 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2942 gpio_set_open_source_value_commit(desc, value);
2944 gpiod_set_raw_value_commit(desc, value);
2948 * gpiod_set_value() - assign a gpio's value
2949 * @desc: gpio whose value will be assigned
2950 * @value: value to assign
2952 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
2953 * OPEN_DRAIN and OPEN_SOURCE flags into account.
2955 * This function can be called from contexts where we cannot sleep, and will
2956 * complain if the GPIO chip functions potentially sleep.
2958 void gpiod_set_value(struct gpio_desc *desc, int value)
2960 VALIDATE_DESC_VOID(desc);
2961 /* Should be using gpiod_set_value_cansleep() */
2962 WARN_ON(desc->gdev->chip->can_sleep);
2963 gpiod_set_value_nocheck(desc, value);
2965 EXPORT_SYMBOL_GPL(gpiod_set_value);
2968 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
2969 * @array_size: number of elements in the descriptor array / value bitmap
2970 * @desc_array: array of GPIO descriptors whose values will be assigned
2971 * @array_info: information on applicability of fast bitmap processing path
2972 * @value_bitmap: bitmap of values to assign
2974 * Set the raw values of the GPIOs, i.e. the values of the physical lines
2975 * without regard for their ACTIVE_LOW status.
2977 * This function can be called from contexts where we cannot sleep, and will
2978 * complain if the GPIO chip functions potentially sleep.
2980 int gpiod_set_raw_array_value(unsigned int array_size,
2981 struct gpio_desc **desc_array,
2982 struct gpio_array *array_info,
2983 unsigned long *value_bitmap)
2987 return gpiod_set_array_value_complex(true, false, array_size,
2988 desc_array, array_info, value_bitmap);
2990 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
2993 * gpiod_set_array_value() - assign values to an array of GPIOs
2994 * @array_size: number of elements in the descriptor array / value bitmap
2995 * @desc_array: array of GPIO descriptors whose values will be assigned
2996 * @array_info: information on applicability of fast bitmap processing path
2997 * @value_bitmap: bitmap of values to assign
2999 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3002 * This function can be called from contexts where we cannot sleep, and will
3003 * complain if the GPIO chip functions potentially sleep.
3005 int gpiod_set_array_value(unsigned int array_size,
3006 struct gpio_desc **desc_array,
3007 struct gpio_array *array_info,
3008 unsigned long *value_bitmap)
3012 return gpiod_set_array_value_complex(false, false, array_size,
3013 desc_array, array_info,
3016 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3019 * gpiod_cansleep() - report whether gpio value access may sleep
3020 * @desc: gpio to check
3023 int gpiod_cansleep(const struct gpio_desc *desc)
3025 VALIDATE_DESC(desc);
3026 return desc->gdev->chip->can_sleep;
3028 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3031 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3032 * @desc: gpio to set the consumer name on
3033 * @name: the new consumer name
3035 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3037 VALIDATE_DESC(desc);
3039 name = kstrdup_const(name, GFP_KERNEL);
3044 kfree_const(desc->label);
3045 desc_set_label(desc, name);
3049 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3052 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3053 * @desc: gpio whose IRQ will be returned (already requested)
3055 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3058 int gpiod_to_irq(const struct gpio_desc *desc)
3060 struct gpio_chip *gc;
3064 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3065 * requires this function to not return zero on an invalid descriptor
3066 * but rather a negative error number.
3068 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3071 gc = desc->gdev->chip;
3072 offset = gpio_chip_hwgpio(desc);
3074 int retirq = gc->to_irq(gc, offset);
3076 /* Zero means NO_IRQ */
3084 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3087 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3088 * @gc: the chip the GPIO to lock belongs to
3089 * @offset: the offset of the GPIO to lock as IRQ
3091 * This is used directly by GPIO drivers that want to lock down
3092 * a certain GPIO line to be used for IRQs.
3094 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3096 struct gpio_desc *desc;
3098 desc = gpiochip_get_desc(gc, offset);
3100 return PTR_ERR(desc);
3103 * If it's fast: flush the direction setting if something changed
3106 if (!gc->can_sleep && gc->get_direction) {
3107 int dir = gpiod_get_direction(desc);
3110 chip_err(gc, "%s: cannot get GPIO direction\n",
3116 /* To be valid for IRQ the line needs to be input or open drain */
3117 if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3118 !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3120 "%s: tried to flag a GPIO set as output for IRQ\n",
3125 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3126 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3129 * If the consumer has not set up a label (such as when the
3130 * IRQ is referenced from .to_irq()) we set up a label here
3131 * so it is clear this is used as an interrupt.
3134 desc_set_label(desc, "interrupt");
3138 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3141 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3142 * @gc: the chip the GPIO to lock belongs to
3143 * @offset: the offset of the GPIO to lock as IRQ
3145 * This is used directly by GPIO drivers that want to indicate
3146 * that a certain GPIO is no longer used exclusively for IRQ.
3148 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3150 struct gpio_desc *desc;
3152 desc = gpiochip_get_desc(gc, offset);
3156 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3157 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3159 /* If we only had this marking, erase it */
3160 if (desc->label && !strcmp(desc->label, "interrupt"))
3161 desc_set_label(desc, NULL);
3163 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3165 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3167 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3169 if (!IS_ERR(desc) &&
3170 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3171 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3173 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3175 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3177 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3179 if (!IS_ERR(desc) &&
3180 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3182 * We must not be output when using IRQ UNLESS we are
3185 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3186 !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3187 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3190 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3192 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3194 if (offset >= gc->ngpio)
3197 return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3199 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3201 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3205 if (!try_module_get(gc->gpiodev->owner))
3208 ret = gpiochip_lock_as_irq(gc, offset);
3210 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3211 module_put(gc->gpiodev->owner);
3216 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3218 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3220 gpiochip_unlock_as_irq(gc, offset);
3221 module_put(gc->gpiodev->owner);
3223 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3225 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3227 if (offset >= gc->ngpio)
3230 return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3232 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3234 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3236 if (offset >= gc->ngpio)
3239 return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3241 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3243 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3245 if (offset >= gc->ngpio)
3248 return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3250 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3253 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3254 * @desc: gpio whose value will be returned
3256 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3257 * its ACTIVE_LOW status, or negative errno on failure.
3259 * This function is to be called from contexts that can sleep.
3261 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3263 might_sleep_if(extra_checks);
3264 VALIDATE_DESC(desc);
3265 return gpiod_get_raw_value_commit(desc);
3267 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3270 * gpiod_get_value_cansleep() - return a gpio's value
3271 * @desc: gpio whose value will be returned
3273 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3274 * account, or negative errno on failure.
3276 * This function is to be called from contexts that can sleep.
3278 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3282 might_sleep_if(extra_checks);
3283 VALIDATE_DESC(desc);
3284 value = gpiod_get_raw_value_commit(desc);
3288 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3293 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3296 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3297 * @array_size: number of elements in the descriptor array / value bitmap
3298 * @desc_array: array of GPIO descriptors whose values will be read
3299 * @array_info: information on applicability of fast bitmap processing path
3300 * @value_bitmap: bitmap to store the read values
3302 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3303 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3304 * else an error code.
3306 * This function is to be called from contexts that can sleep.
3308 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3309 struct gpio_desc **desc_array,
3310 struct gpio_array *array_info,
3311 unsigned long *value_bitmap)
3313 might_sleep_if(extra_checks);
3316 return gpiod_get_array_value_complex(true, true, array_size,
3317 desc_array, array_info,
3320 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3323 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3324 * @array_size: number of elements in the descriptor array / value bitmap
3325 * @desc_array: array of GPIO descriptors whose values will be read
3326 * @array_info: information on applicability of fast bitmap processing path
3327 * @value_bitmap: bitmap to store the read values
3329 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3330 * into account. Return 0 in case of success, else an error code.
3332 * This function is to be called from contexts that can sleep.
3334 int gpiod_get_array_value_cansleep(unsigned int array_size,
3335 struct gpio_desc **desc_array,
3336 struct gpio_array *array_info,
3337 unsigned long *value_bitmap)
3339 might_sleep_if(extra_checks);
3342 return gpiod_get_array_value_complex(false, true, array_size,
3343 desc_array, array_info,
3346 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3349 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3350 * @desc: gpio whose value will be assigned
3351 * @value: value to assign
3353 * Set the raw value of the GPIO, i.e. the value of its physical line without
3354 * regard for its ACTIVE_LOW status.
3356 * This function is to be called from contexts that can sleep.
3358 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3360 might_sleep_if(extra_checks);
3361 VALIDATE_DESC_VOID(desc);
3362 gpiod_set_raw_value_commit(desc, value);
3364 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3367 * gpiod_set_value_cansleep() - assign a gpio's value
3368 * @desc: gpio whose value will be assigned
3369 * @value: value to assign
3371 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3374 * This function is to be called from contexts that can sleep.
3376 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3378 might_sleep_if(extra_checks);
3379 VALIDATE_DESC_VOID(desc);
3380 gpiod_set_value_nocheck(desc, value);
3382 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3385 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3386 * @array_size: number of elements in the descriptor array / value bitmap
3387 * @desc_array: array of GPIO descriptors whose values will be assigned
3388 * @array_info: information on applicability of fast bitmap processing path
3389 * @value_bitmap: bitmap of values to assign
3391 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3392 * without regard for their ACTIVE_LOW status.
3394 * This function is to be called from contexts that can sleep.
3396 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3397 struct gpio_desc **desc_array,
3398 struct gpio_array *array_info,
3399 unsigned long *value_bitmap)
3401 might_sleep_if(extra_checks);
3404 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3405 array_info, value_bitmap);
3407 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3410 * gpiod_add_lookup_tables() - register GPIO device consumers
3411 * @tables: list of tables of consumers to register
3412 * @n: number of tables in the list
3414 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3418 mutex_lock(&gpio_lookup_lock);
3420 for (i = 0; i < n; i++)
3421 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3423 mutex_unlock(&gpio_lookup_lock);
3427 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3428 * @array_size: number of elements in the descriptor array / value bitmap
3429 * @desc_array: array of GPIO descriptors whose values will be assigned
3430 * @array_info: information on applicability of fast bitmap processing path
3431 * @value_bitmap: bitmap of values to assign
3433 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3436 * This function is to be called from contexts that can sleep.
3438 int gpiod_set_array_value_cansleep(unsigned int array_size,
3439 struct gpio_desc **desc_array,
3440 struct gpio_array *array_info,
3441 unsigned long *value_bitmap)
3443 might_sleep_if(extra_checks);
3446 return gpiod_set_array_value_complex(false, true, array_size,
3447 desc_array, array_info,
3450 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3453 * gpiod_add_lookup_table() - register GPIO device consumers
3454 * @table: table of consumers to register
3456 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3458 mutex_lock(&gpio_lookup_lock);
3460 list_add_tail(&table->list, &gpio_lookup_list);
3462 mutex_unlock(&gpio_lookup_lock);
3464 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3467 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3468 * @table: table of consumers to unregister
3470 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3472 /* Nothing to remove */
3476 mutex_lock(&gpio_lookup_lock);
3478 list_del(&table->list);
3480 mutex_unlock(&gpio_lookup_lock);
3482 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3485 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3486 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3488 void gpiod_add_hogs(struct gpiod_hog *hogs)
3490 struct gpio_chip *gc;
3491 struct gpiod_hog *hog;
3493 mutex_lock(&gpio_machine_hogs_mutex);
3495 for (hog = &hogs[0]; hog->chip_label; hog++) {
3496 list_add_tail(&hog->list, &gpio_machine_hogs);
3499 * The chip may have been registered earlier, so check if it
3500 * exists and, if so, try to hog the line now.
3502 gc = find_chip_by_name(hog->chip_label);
3504 gpiochip_machine_hog(gc, hog);
3507 mutex_unlock(&gpio_machine_hogs_mutex);
3509 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3511 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3513 const char *dev_id = dev ? dev_name(dev) : NULL;
3514 struct gpiod_lookup_table *table;
3516 mutex_lock(&gpio_lookup_lock);
3518 list_for_each_entry(table, &gpio_lookup_list, list) {
3519 if (table->dev_id && dev_id) {
3521 * Valid strings on both ends, must be identical to have
3524 if (!strcmp(table->dev_id, dev_id))
3528 * One of the pointers is NULL, so both must be to have
3531 if (dev_id == table->dev_id)
3538 mutex_unlock(&gpio_lookup_lock);
3542 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3543 unsigned int idx, unsigned long *flags)
3545 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3546 struct gpiod_lookup_table *table;
3547 struct gpiod_lookup *p;
3549 table = gpiod_find_lookup_table(dev);
3553 for (p = &table->table[0]; p->key; p++) {
3554 struct gpio_chip *gc;
3556 /* idx must always match exactly */
3560 /* If the lookup entry has a con_id, require exact match */
3561 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3564 if (p->chip_hwnum == U16_MAX) {
3565 desc = gpio_name_to_desc(p->key);
3571 dev_warn(dev, "cannot find GPIO line %s, deferring\n",
3573 return ERR_PTR(-EPROBE_DEFER);
3576 gc = find_chip_by_name(p->key);
3580 * As the lookup table indicates a chip with
3581 * p->key should exist, assume it may
3582 * still appear later and let the interested
3583 * consumer be probed again or let the Deferred
3584 * Probe infrastructure handle the error.
3586 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3588 return ERR_PTR(-EPROBE_DEFER);
3591 if (gc->ngpio <= p->chip_hwnum) {
3593 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3594 idx, p->chip_hwnum, gc->ngpio - 1,
3596 return ERR_PTR(-EINVAL);
3599 desc = gpiochip_get_desc(gc, p->chip_hwnum);
3608 static int platform_gpio_count(struct device *dev, const char *con_id)
3610 struct gpiod_lookup_table *table;
3611 struct gpiod_lookup *p;
3612 unsigned int count = 0;
3614 table = gpiod_find_lookup_table(dev);
3618 for (p = &table->table[0]; p->key; p++) {
3619 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3620 (!con_id && !p->con_id))
3630 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3631 * @fwnode: handle of the firmware node
3632 * @con_id: function within the GPIO consumer
3633 * @index: index of the GPIO to obtain for the consumer
3634 * @flags: GPIO initialization flags
3635 * @label: label to attach to the requested GPIO
3637 * This function can be used for drivers that get their configuration
3638 * from opaque firmware.
3640 * The function properly finds the corresponding GPIO using whatever is the
3641 * underlying firmware interface and then makes sure that the GPIO
3642 * descriptor is requested before it is returned to the caller.
3645 * On successful request the GPIO pin is configured in accordance with
3648 * In case of error an ERR_PTR() is returned.
3650 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
3651 const char *con_id, int index,
3652 enum gpiod_flags flags,
3655 struct gpio_desc *desc;
3656 char prop_name[32]; /* 32 is max size of property name */
3659 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3661 snprintf(prop_name, sizeof(prop_name), "%s-%s",
3662 con_id, gpio_suffixes[i]);
3664 snprintf(prop_name, sizeof(prop_name), "%s",
3667 desc = fwnode_get_named_gpiod(fwnode, prop_name, index, flags,
3669 if (!gpiod_not_found(desc))
3675 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
3678 * gpiod_count - return the number of GPIOs associated with a device / function
3679 * or -ENOENT if no GPIO has been assigned to the requested function
3680 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3681 * @con_id: function within the GPIO consumer
3683 int gpiod_count(struct device *dev, const char *con_id)
3685 int count = -ENOENT;
3687 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
3688 count = of_gpio_get_count(dev, con_id);
3689 else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
3690 count = acpi_gpio_count(dev, con_id);
3693 count = platform_gpio_count(dev, con_id);
3697 EXPORT_SYMBOL_GPL(gpiod_count);
3700 * gpiod_get - obtain a GPIO for a given GPIO function
3701 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3702 * @con_id: function within the GPIO consumer
3703 * @flags: optional GPIO initialization flags
3705 * Return the GPIO descriptor corresponding to the function con_id of device
3706 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3707 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3709 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3710 enum gpiod_flags flags)
3712 return gpiod_get_index(dev, con_id, 0, flags);
3714 EXPORT_SYMBOL_GPL(gpiod_get);
3717 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3718 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3719 * @con_id: function within the GPIO consumer
3720 * @flags: optional GPIO initialization flags
3722 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3723 * the requested function it will return NULL. This is convenient for drivers
3724 * that need to handle optional GPIOs.
3726 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3728 enum gpiod_flags flags)
3730 return gpiod_get_index_optional(dev, con_id, 0, flags);
3732 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3736 * gpiod_configure_flags - helper function to configure a given GPIO
3737 * @desc: gpio whose value will be assigned
3738 * @con_id: function within the GPIO consumer
3739 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3740 * of_find_gpio() or of_get_gpio_hog()
3741 * @dflags: gpiod_flags - optional GPIO initialization flags
3743 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3744 * requested function and/or index, or another IS_ERR() code if an error
3745 * occurred while trying to acquire the GPIO.
3747 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3748 unsigned long lflags, enum gpiod_flags dflags)
3752 if (lflags & GPIO_ACTIVE_LOW)
3753 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3755 if (lflags & GPIO_OPEN_DRAIN)
3756 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3757 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3759 * This enforces open drain mode from the consumer side.
3760 * This is necessary for some busses like I2C, but the lookup
3761 * should *REALLY* have specified them as open drain in the
3762 * first place, so print a little warning here.
3764 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3766 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3769 if (lflags & GPIO_OPEN_SOURCE)
3770 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3772 if ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) {
3774 "both pull-up and pull-down enabled, invalid configuration\n");
3778 if (lflags & GPIO_PULL_UP)
3779 set_bit(FLAG_PULL_UP, &desc->flags);
3780 else if (lflags & GPIO_PULL_DOWN)
3781 set_bit(FLAG_PULL_DOWN, &desc->flags);
3783 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
3787 /* No particular flag request, return here... */
3788 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3789 gpiod_dbg(desc, "no flags found for %s\n", con_id);
3794 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3795 ret = gpiod_direction_output(desc,
3796 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3798 ret = gpiod_direction_input(desc);
3804 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3805 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3806 * @con_id: function within the GPIO consumer
3807 * @idx: index of the GPIO to obtain in the consumer
3808 * @flags: optional GPIO initialization flags
3810 * This variant of gpiod_get() allows to access GPIOs other than the first
3811 * defined one for functions that define several GPIOs.
3813 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3814 * requested function and/or index, or another IS_ERR() code if an error
3815 * occurred while trying to acquire the GPIO.
3817 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3820 enum gpiod_flags flags)
3822 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3823 struct gpio_desc *desc = NULL;
3825 /* Maybe we have a device name, maybe not */
3826 const char *devname = dev ? dev_name(dev) : "?";
3828 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3831 /* Using device tree? */
3832 if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
3833 dev_dbg(dev, "using device tree for GPIO lookup\n");
3834 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3835 } else if (ACPI_COMPANION(dev)) {
3836 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3837 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3842 * Either we are not using DT or ACPI, or their lookup did not return
3843 * a result. In that case, use platform lookup as a fallback.
3845 if (!desc || gpiod_not_found(desc)) {
3846 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3847 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3851 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
3856 * If a connection label was passed use that, else attempt to use
3857 * the device name as label
3859 ret = gpiod_request(desc, con_id ? con_id : devname);
3861 if (ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
3863 * This happens when there are several consumers for
3864 * the same GPIO line: we just return here without
3865 * further initialization. It is a bit if a hack.
3866 * This is necessary to support fixed regulators.
3868 * FIXME: Make this more sane and safe.
3870 dev_info(dev, "nonexclusive access to GPIO for %s\n",
3871 con_id ? con_id : devname);
3874 return ERR_PTR(ret);
3878 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3880 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3882 return ERR_PTR(ret);
3885 blocking_notifier_call_chain(&desc->gdev->notifier,
3886 GPIOLINE_CHANGED_REQUESTED, desc);
3890 EXPORT_SYMBOL_GPL(gpiod_get_index);
3893 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3894 * @fwnode: handle of the firmware node
3895 * @propname: name of the firmware property representing the GPIO
3896 * @index: index of the GPIO to obtain for the consumer
3897 * @dflags: GPIO initialization flags
3898 * @label: label to attach to the requested GPIO
3900 * This function can be used for drivers that get their configuration
3901 * from opaque firmware.
3903 * The function properly finds the corresponding GPIO using whatever is the
3904 * underlying firmware interface and then makes sure that the GPIO
3905 * descriptor is requested before it is returned to the caller.
3908 * On successful request the GPIO pin is configured in accordance with
3911 * In case of error an ERR_PTR() is returned.
3913 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3914 const char *propname, int index,
3915 enum gpiod_flags dflags,
3918 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3919 struct gpio_desc *desc = ERR_PTR(-ENODEV);
3923 return ERR_PTR(-EINVAL);
3925 if (is_of_node(fwnode)) {
3926 desc = gpiod_get_from_of_node(to_of_node(fwnode),
3931 } else if (is_acpi_node(fwnode)) {
3932 struct acpi_gpio_info info;
3934 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
3938 acpi_gpio_update_gpiod_flags(&dflags, &info);
3939 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
3942 /* Currently only ACPI takes this path */
3943 ret = gpiod_request(desc, label);
3945 return ERR_PTR(ret);
3947 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3950 return ERR_PTR(ret);
3953 blocking_notifier_call_chain(&desc->gdev->notifier,
3954 GPIOLINE_CHANGED_REQUESTED, desc);
3958 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3961 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3963 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3964 * @con_id: function within the GPIO consumer
3965 * @index: index of the GPIO to obtain in the consumer
3966 * @flags: optional GPIO initialization flags
3968 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3969 * specified index was assigned to the requested function it will return NULL.
3970 * This is convenient for drivers that need to handle optional GPIOs.
3972 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
3975 enum gpiod_flags flags)
3977 struct gpio_desc *desc;
3979 desc = gpiod_get_index(dev, con_id, index, flags);
3980 if (gpiod_not_found(desc))
3985 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
3988 * gpiod_hog - Hog the specified GPIO desc given the provided flags
3989 * @desc: gpio whose value will be assigned
3990 * @name: gpio line name
3991 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3992 * of_find_gpio() or of_get_gpio_hog()
3993 * @dflags: gpiod_flags - optional GPIO initialization flags
3995 int gpiod_hog(struct gpio_desc *desc, const char *name,
3996 unsigned long lflags, enum gpiod_flags dflags)
3998 struct gpio_chip *gc;
3999 struct gpio_desc *local_desc;
4003 gc = gpiod_to_chip(desc);
4004 hwnum = gpio_chip_hwgpio(desc);
4006 local_desc = gpiochip_request_own_desc(gc, hwnum, name,
4008 if (IS_ERR(local_desc)) {
4009 ret = PTR_ERR(local_desc);
4010 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4011 name, gc->label, hwnum, ret);
4015 /* Mark GPIO as hogged so it can be identified and removed later */
4016 set_bit(FLAG_IS_HOGGED, &desc->flags);
4018 gpiod_info(desc, "hogged as %s%s\n",
4019 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4020 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4021 (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4027 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4028 * @gc: gpio chip to act on
4030 static void gpiochip_free_hogs(struct gpio_chip *gc)
4034 for (id = 0; id < gc->ngpio; id++) {
4035 if (test_bit(FLAG_IS_HOGGED, &gc->gpiodev->descs[id].flags))
4036 gpiochip_free_own_desc(&gc->gpiodev->descs[id]);
4041 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4042 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4043 * @con_id: function within the GPIO consumer
4044 * @flags: optional GPIO initialization flags
4046 * This function acquires all the GPIOs defined under a given function.
4048 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4049 * no GPIO has been assigned to the requested function, or another IS_ERR()
4050 * code if an error occurred while trying to acquire the GPIOs.
4052 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4054 enum gpiod_flags flags)
4056 struct gpio_desc *desc;
4057 struct gpio_descs *descs;
4058 struct gpio_array *array_info = NULL;
4059 struct gpio_chip *gc;
4060 int count, bitmap_size;
4062 count = gpiod_count(dev, con_id);
4064 return ERR_PTR(count);
4066 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4068 return ERR_PTR(-ENOMEM);
4070 for (descs->ndescs = 0; descs->ndescs < count; ) {
4071 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4073 gpiod_put_array(descs);
4074 return ERR_CAST(desc);
4077 descs->desc[descs->ndescs] = desc;
4079 gc = gpiod_to_chip(desc);
4081 * If pin hardware number of array member 0 is also 0, select
4082 * its chip as a candidate for fast bitmap processing path.
4084 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4085 struct gpio_descs *array;
4087 bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4090 array = kzalloc(struct_size(descs, desc, count) +
4091 struct_size(array_info, invert_mask,
4092 3 * bitmap_size), GFP_KERNEL);
4094 gpiod_put_array(descs);
4095 return ERR_PTR(-ENOMEM);
4098 memcpy(array, descs,
4099 struct_size(descs, desc, descs->ndescs + 1));
4103 array_info = (void *)(descs->desc + count);
4104 array_info->get_mask = array_info->invert_mask +
4106 array_info->set_mask = array_info->get_mask +
4109 array_info->desc = descs->desc;
4110 array_info->size = count;
4111 array_info->chip = gc;
4112 bitmap_set(array_info->get_mask, descs->ndescs,
4113 count - descs->ndescs);
4114 bitmap_set(array_info->set_mask, descs->ndescs,
4115 count - descs->ndescs);
4116 descs->info = array_info;
4118 /* Unmark array members which don't belong to the 'fast' chip */
4119 if (array_info && array_info->chip != gc) {
4120 __clear_bit(descs->ndescs, array_info->get_mask);
4121 __clear_bit(descs->ndescs, array_info->set_mask);
4124 * Detect array members which belong to the 'fast' chip
4125 * but their pins are not in hardware order.
4127 else if (array_info &&
4128 gpio_chip_hwgpio(desc) != descs->ndescs) {
4130 * Don't use fast path if all array members processed so
4131 * far belong to the same chip as this one but its pin
4132 * hardware number is different from its array index.
4134 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4137 __clear_bit(descs->ndescs,
4138 array_info->get_mask);
4139 __clear_bit(descs->ndescs,
4140 array_info->set_mask);
4142 } else if (array_info) {
4143 /* Exclude open drain or open source from fast output */
4144 if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4145 gpiochip_line_is_open_source(gc, descs->ndescs))
4146 __clear_bit(descs->ndescs,
4147 array_info->set_mask);
4148 /* Identify 'fast' pins which require invertion */
4149 if (gpiod_is_active_low(desc))
4150 __set_bit(descs->ndescs,
4151 array_info->invert_mask);
4158 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4159 array_info->chip->label, array_info->size,
4160 *array_info->get_mask, *array_info->set_mask,
4161 *array_info->invert_mask);
4164 EXPORT_SYMBOL_GPL(gpiod_get_array);
4167 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4169 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4170 * @con_id: function within the GPIO consumer
4171 * @flags: optional GPIO initialization flags
4173 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4174 * assigned to the requested function it will return NULL.
4176 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4178 enum gpiod_flags flags)
4180 struct gpio_descs *descs;
4182 descs = gpiod_get_array(dev, con_id, flags);
4183 if (gpiod_not_found(descs))
4188 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4191 * gpiod_put - dispose of a GPIO descriptor
4192 * @desc: GPIO descriptor to dispose of
4194 * No descriptor can be used after gpiod_put() has been called on it.
4196 void gpiod_put(struct gpio_desc *desc)
4201 EXPORT_SYMBOL_GPL(gpiod_put);
4204 * gpiod_put_array - dispose of multiple GPIO descriptors
4205 * @descs: struct gpio_descs containing an array of descriptors
4207 void gpiod_put_array(struct gpio_descs *descs)
4211 for (i = 0; i < descs->ndescs; i++)
4212 gpiod_put(descs->desc[i]);
4216 EXPORT_SYMBOL_GPL(gpiod_put_array);
4218 static int __init gpiolib_dev_init(void)
4222 /* Register GPIO sysfs bus */
4223 ret = bus_register(&gpio_bus_type);
4225 pr_err("gpiolib: could not register GPIO bus type\n");
4229 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4231 pr_err("gpiolib: failed to allocate char dev region\n");
4232 bus_unregister(&gpio_bus_type);
4236 gpiolib_initialized = true;
4237 gpiochip_setup_devs();
4239 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4240 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4241 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4245 core_initcall(gpiolib_dev_init);
4247 #ifdef CONFIG_DEBUG_FS
4249 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4252 struct gpio_chip *gc = gdev->chip;
4253 unsigned gpio = gdev->base;
4254 struct gpio_desc *gdesc = &gdev->descs[0];
4259 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4260 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4262 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4268 gpiod_get_direction(gdesc);
4269 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4270 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4271 active_low = test_bit(FLAG_ACTIVE_LOW, &gdesc->flags);
4272 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s",
4273 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4274 is_out ? "out" : "in ",
4275 gc->get ? (gc->get(gc, i) ? "hi" : "lo") : "? ",
4276 is_irq ? "IRQ " : "",
4277 active_low ? "ACTIVE LOW" : "");
4278 seq_printf(s, "\n");
4282 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4284 unsigned long flags;
4285 struct gpio_device *gdev = NULL;
4286 loff_t index = *pos;
4290 spin_lock_irqsave(&gpio_lock, flags);
4291 list_for_each_entry(gdev, &gpio_devices, list)
4293 spin_unlock_irqrestore(&gpio_lock, flags);
4296 spin_unlock_irqrestore(&gpio_lock, flags);
4301 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4303 unsigned long flags;
4304 struct gpio_device *gdev = v;
4307 spin_lock_irqsave(&gpio_lock, flags);
4308 if (list_is_last(&gdev->list, &gpio_devices))
4311 ret = list_entry(gdev->list.next, struct gpio_device, list);
4312 spin_unlock_irqrestore(&gpio_lock, flags);
4320 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4324 static int gpiolib_seq_show(struct seq_file *s, void *v)
4326 struct gpio_device *gdev = v;
4327 struct gpio_chip *gc = gdev->chip;
4328 struct device *parent;
4331 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4332 dev_name(&gdev->dev));
4336 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4337 dev_name(&gdev->dev),
4338 gdev->base, gdev->base + gdev->ngpio - 1);
4339 parent = gc->parent;
4341 seq_printf(s, ", parent: %s/%s",
4342 parent->bus ? parent->bus->name : "no-bus",
4345 seq_printf(s, ", %s", gc->label);
4347 seq_printf(s, ", can sleep");
4348 seq_printf(s, ":\n");
4351 gc->dbg_show(s, gc);
4353 gpiolib_dbg_show(s, gdev);
4358 static const struct seq_operations gpiolib_sops = {
4359 .start = gpiolib_seq_start,
4360 .next = gpiolib_seq_next,
4361 .stop = gpiolib_seq_stop,
4362 .show = gpiolib_seq_show,
4364 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4366 static int __init gpiolib_debugfs_init(void)
4368 /* /sys/kernel/debug/gpio */
4369 debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4372 subsys_initcall(gpiolib_debugfs_init);
4374 #endif /* DEBUG_FS */