1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/bitmap.h>
4 #include <linux/kernel.h>
5 #include <linux/module.h>
6 #include <linux/interrupt.h>
8 #include <linux/spinlock.h>
9 #include <linux/list.h>
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/debugfs.h>
13 #include <linux/seq_file.h>
14 #include <linux/gpio.h>
15 #include <linux/idr.h>
16 #include <linux/slab.h>
17 #include <linux/acpi.h>
18 #include <linux/gpio/driver.h>
19 #include <linux/gpio/machine.h>
20 #include <linux/pinctrl/consumer.h>
22 #include <linux/compat.h>
23 #include <linux/file.h>
24 #include <uapi/linux/gpio.h>
27 #include "gpiolib-of.h"
28 #include "gpiolib-acpi.h"
29 #include "gpiolib-cdev.h"
30 #include "gpiolib-sysfs.h"
32 #define CREATE_TRACE_POINTS
33 #include <trace/events/gpio.h>
35 /* Implementation infrastructure for GPIO interfaces.
37 * The GPIO programming interface allows for inlining speed-critical
38 * get/set operations for common cases, so that access to SOC-integrated
39 * GPIOs can sometimes cost only an instruction or two per bit.
43 /* When debugging, extend minimal trust to callers and platform code.
44 * Also emit diagnostic messages that may help initial bringup, when
45 * board setup or driver bugs are most common.
47 * Otherwise, minimize overhead in what may be bitbanging codepaths.
50 #define extra_checks 1
52 #define extra_checks 0
55 /* Device and char device-related information */
56 static DEFINE_IDA(gpio_ida);
57 static dev_t gpio_devt;
58 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
59 static int gpio_bus_match(struct device *dev, struct device_driver *drv);
60 static struct bus_type gpio_bus_type = {
62 .match = gpio_bus_match,
66 * Number of GPIOs to use for the fast path in set array
68 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
70 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
71 * While any GPIO is requested, its gpio_chip is not removable;
72 * each GPIO's "requested" flag serves as a lock and refcount.
74 DEFINE_SPINLOCK(gpio_lock);
76 static DEFINE_MUTEX(gpio_lookup_lock);
77 static LIST_HEAD(gpio_lookup_list);
78 LIST_HEAD(gpio_devices);
80 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
81 static LIST_HEAD(gpio_machine_hogs);
83 static void gpiochip_free_hogs(struct gpio_chip *gc);
84 static int gpiochip_add_irqchip(struct gpio_chip *gc,
85 struct lock_class_key *lock_key,
86 struct lock_class_key *request_key);
87 static void gpiochip_irqchip_remove(struct gpio_chip *gc);
88 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc);
89 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc);
90 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc);
92 static bool gpiolib_initialized;
94 static inline void desc_set_label(struct gpio_desc *d, const char *label)
100 * gpio_to_desc - Convert a GPIO number to its descriptor
101 * @gpio: global GPIO number
104 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
105 * with the given number exists in the system.
107 struct gpio_desc *gpio_to_desc(unsigned gpio)
109 struct gpio_device *gdev;
112 spin_lock_irqsave(&gpio_lock, flags);
114 list_for_each_entry(gdev, &gpio_devices, list) {
115 if (gdev->base <= gpio &&
116 gdev->base + gdev->ngpio > gpio) {
117 spin_unlock_irqrestore(&gpio_lock, flags);
118 return &gdev->descs[gpio - gdev->base];
122 spin_unlock_irqrestore(&gpio_lock, flags);
124 if (!gpio_is_valid(gpio))
125 pr_warn("invalid GPIO %d\n", gpio);
129 EXPORT_SYMBOL_GPL(gpio_to_desc);
132 * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
133 * hardware number for this chip
135 * @hwnum: hardware number of the GPIO for this chip
138 * A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists
139 * in the given chip for the specified hardware number.
141 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc,
144 struct gpio_device *gdev = gc->gpiodev;
146 if (hwnum >= gdev->ngpio)
147 return ERR_PTR(-EINVAL);
149 return &gdev->descs[hwnum];
151 EXPORT_SYMBOL_GPL(gpiochip_get_desc);
154 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
155 * @desc: GPIO descriptor
157 * This should disappear in the future but is needed since we still
158 * use GPIO numbers for error messages and sysfs nodes.
161 * The global GPIO number for the GPIO specified by its descriptor.
163 int desc_to_gpio(const struct gpio_desc *desc)
165 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
167 EXPORT_SYMBOL_GPL(desc_to_gpio);
171 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
172 * @desc: descriptor to return the chip of
174 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
176 if (!desc || !desc->gdev)
178 return desc->gdev->chip;
180 EXPORT_SYMBOL_GPL(gpiod_to_chip);
182 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
183 static int gpiochip_find_base(int ngpio)
185 struct gpio_device *gdev;
186 int base = ARCH_NR_GPIOS - ngpio;
188 list_for_each_entry_reverse(gdev, &gpio_devices, list) {
189 /* found a free space? */
190 if (gdev->base + gdev->ngpio <= base)
193 /* nope, check the space right before the chip */
194 base = gdev->base - ngpio;
197 if (gpio_is_valid(base)) {
198 pr_debug("%s: found new base at %d\n", __func__, base);
201 pr_err("%s: cannot find free range\n", __func__);
207 * gpiod_get_direction - return the current direction of a GPIO
208 * @desc: GPIO to get the direction of
210 * Returns 0 for output, 1 for input, or an error code in case of error.
212 * This function may sleep if gpiod_cansleep() is true.
214 int gpiod_get_direction(struct gpio_desc *desc)
216 struct gpio_chip *gc;
220 gc = gpiod_to_chip(desc);
221 offset = gpio_chip_hwgpio(desc);
224 * Open drain emulation using input mode may incorrectly report
225 * input here, fix that up.
227 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) &&
228 test_bit(FLAG_IS_OUT, &desc->flags))
231 if (!gc->get_direction)
234 ret = gc->get_direction(gc, offset);
238 /* GPIOF_DIR_IN or other positive, otherwise GPIOF_DIR_OUT */
242 assign_bit(FLAG_IS_OUT, &desc->flags, !ret);
246 EXPORT_SYMBOL_GPL(gpiod_get_direction);
249 * Add a new chip to the global chips list, keeping the list of chips sorted
250 * by range(means [base, base + ngpio - 1]) order.
252 * Return -EBUSY if the new chip overlaps with some other chip's integer
255 static int gpiodev_add_to_list(struct gpio_device *gdev)
257 struct gpio_device *prev, *next;
259 if (list_empty(&gpio_devices)) {
260 /* initial entry in list */
261 list_add_tail(&gdev->list, &gpio_devices);
265 next = list_entry(gpio_devices.next, struct gpio_device, list);
266 if (gdev->base + gdev->ngpio <= next->base) {
267 /* add before first entry */
268 list_add(&gdev->list, &gpio_devices);
272 prev = list_entry(gpio_devices.prev, struct gpio_device, list);
273 if (prev->base + prev->ngpio <= gdev->base) {
274 /* add behind last entry */
275 list_add_tail(&gdev->list, &gpio_devices);
279 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
280 /* at the end of the list */
281 if (&next->list == &gpio_devices)
284 /* add between prev and next */
285 if (prev->base + prev->ngpio <= gdev->base
286 && gdev->base + gdev->ngpio <= next->base) {
287 list_add(&gdev->list, &prev->list);
292 dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
297 * Convert a GPIO name to its descriptor
298 * Note that there is no guarantee that GPIO names are globally unique!
299 * Hence this function will return, if it exists, a reference to the first GPIO
300 * line found that matches the given name.
302 static struct gpio_desc *gpio_name_to_desc(const char * const name)
304 struct gpio_device *gdev;
310 spin_lock_irqsave(&gpio_lock, flags);
312 list_for_each_entry(gdev, &gpio_devices, list) {
315 for (i = 0; i != gdev->ngpio; ++i) {
316 struct gpio_desc *desc = &gdev->descs[i];
321 if (!strcmp(desc->name, name)) {
322 spin_unlock_irqrestore(&gpio_lock, flags);
328 spin_unlock_irqrestore(&gpio_lock, flags);
334 * Take the names from gc->names and assign them to their GPIO descriptors.
335 * Warn if a name is already used for a GPIO line on a different GPIO chip.
338 * 1. Non-unique names are still accepted,
339 * 2. Name collisions within the same GPIO chip are not reported.
341 static int gpiochip_set_desc_names(struct gpio_chip *gc)
343 struct gpio_device *gdev = gc->gpiodev;
346 /* First check all names if they are unique */
347 for (i = 0; i != gc->ngpio; ++i) {
348 struct gpio_desc *gpio;
350 gpio = gpio_name_to_desc(gc->names[i]);
353 "Detected name collision for GPIO name '%s'\n",
357 /* Then add all names to the GPIO descriptors */
358 for (i = 0; i != gc->ngpio; ++i)
359 gdev->descs[i].name = gc->names[i];
365 * devprop_gpiochip_set_names - Set GPIO line names using device properties
366 * @chip: GPIO chip whose lines should be named, if possible
368 * Looks for device property "gpio-line-names" and if it exists assigns
369 * GPIO line names for the chip. The memory allocated for the assigned
370 * names belong to the underlying firmware node and should not be released
373 static int devprop_gpiochip_set_names(struct gpio_chip *chip)
375 struct gpio_device *gdev = chip->gpiodev;
376 struct fwnode_handle *fwnode = dev_fwnode(&gdev->dev);
381 count = fwnode_property_string_array_count(fwnode, "gpio-line-names");
386 * When offset is set in the driver side we assume the driver internally
387 * is using more than one gpiochip per the same device. We have to stop
388 * setting friendly names if the specified ones with 'gpio-line-names'
389 * are less than the offset in the device itself. This means all the
390 * lines are not present for every single pin within all the internal
393 if (count <= chip->offset) {
394 dev_warn(&gdev->dev, "gpio-line-names too short (length %d), cannot map names for the gpiochip at offset %u\n",
395 count, chip->offset);
399 names = kcalloc(count, sizeof(*names), GFP_KERNEL);
403 ret = fwnode_property_read_string_array(fwnode, "gpio-line-names",
406 dev_warn(&gdev->dev, "failed to read GPIO line names\n");
412 * When more that one gpiochip per device is used, 'count' can
413 * contain at most number gpiochips x chip->ngpio. We have to
414 * correctly distribute all defined lines taking into account
415 * chip->offset as starting point from where we will assign
416 * the names to pins from the 'names' array. Since property
417 * 'gpio-line-names' cannot contains gaps, we have to be sure
418 * we only assign those pins that really exists since chip->ngpio
419 * can be different of the chip->offset.
421 count = (count > chip->offset) ? count - chip->offset : count;
422 if (count > chip->ngpio)
425 for (i = 0; i < count; i++)
426 gdev->descs[i].name = names[chip->offset + i];
433 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
437 p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
441 /* Assume by default all GPIOs are valid */
442 bitmap_fill(p, gc->ngpio);
447 static int gpiochip_alloc_valid_mask(struct gpio_chip *gc)
449 if (!(of_gpio_need_valid_mask(gc) || gc->init_valid_mask))
452 gc->valid_mask = gpiochip_allocate_mask(gc);
459 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
461 if (gc->init_valid_mask)
462 return gc->init_valid_mask(gc,
469 static void gpiochip_free_valid_mask(struct gpio_chip *gc)
471 bitmap_free(gc->valid_mask);
472 gc->valid_mask = NULL;
475 static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
477 if (gc->add_pin_ranges)
478 return gc->add_pin_ranges(gc);
483 bool gpiochip_line_is_valid(const struct gpio_chip *gc,
486 /* No mask means all valid */
487 if (likely(!gc->valid_mask))
489 return test_bit(offset, gc->valid_mask);
491 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
493 static void gpiodevice_release(struct device *dev)
495 struct gpio_device *gdev = container_of(dev, struct gpio_device, dev);
498 spin_lock_irqsave(&gpio_lock, flags);
499 list_del(&gdev->list);
500 spin_unlock_irqrestore(&gpio_lock, flags);
502 ida_free(&gpio_ida, gdev->id);
503 kfree_const(gdev->label);
508 #ifdef CONFIG_GPIO_CDEV
509 #define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
510 #define gcdev_unregister(gdev) gpiolib_cdev_unregister((gdev))
513 * gpiolib_cdev_register() indirectly calls device_add(), which is still
514 * required even when cdev is not selected.
516 #define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
517 #define gcdev_unregister(gdev) device_del(&(gdev)->dev)
520 static int gpiochip_setup_dev(struct gpio_device *gdev)
524 ret = gcdev_register(gdev, gpio_devt);
528 ret = gpiochip_sysfs_register(gdev);
530 goto err_remove_device;
532 /* From this point, the .release() function cleans up gpio_device */
533 gdev->dev.release = gpiodevice_release;
534 dev_dbg(&gdev->dev, "registered GPIOs %d to %d on %s\n", gdev->base,
535 gdev->base + gdev->ngpio - 1, gdev->chip->label ? : "generic");
540 gcdev_unregister(gdev);
544 static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
546 struct gpio_desc *desc;
549 desc = gpiochip_get_desc(gc, hog->chip_hwnum);
551 chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
556 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
559 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
561 gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
562 __func__, gc->label, hog->chip_hwnum, rv);
565 static void machine_gpiochip_add(struct gpio_chip *gc)
567 struct gpiod_hog *hog;
569 mutex_lock(&gpio_machine_hogs_mutex);
571 list_for_each_entry(hog, &gpio_machine_hogs, list) {
572 if (!strcmp(gc->label, hog->chip_label))
573 gpiochip_machine_hog(gc, hog);
576 mutex_unlock(&gpio_machine_hogs_mutex);
579 static void gpiochip_setup_devs(void)
581 struct gpio_device *gdev;
584 list_for_each_entry(gdev, &gpio_devices, list) {
585 ret = gpiochip_setup_dev(gdev);
588 "Failed to initialize gpio device (%d)\n", ret);
592 int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
593 struct lock_class_key *lock_key,
594 struct lock_class_key *request_key)
596 struct fwnode_handle *fwnode = gc->parent ? dev_fwnode(gc->parent) : NULL;
601 struct gpio_device *gdev;
604 * First: allocate and populate the internal stat container, and
605 * set up the struct device.
607 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
610 gdev->dev.bus = &gpio_bus_type;
611 gdev->dev.parent = gc->parent;
615 of_gpio_dev_init(gc, gdev);
616 acpi_gpio_dev_init(gc, gdev);
619 * Assign fwnode depending on the result of the previous calls,
620 * if none of them succeed, assign it to the parent's one.
622 gdev->dev.fwnode = dev_fwnode(&gdev->dev) ?: fwnode;
624 gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
630 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
634 device_initialize(&gdev->dev);
635 if (gc->parent && gc->parent->driver)
636 gdev->owner = gc->parent->driver->owner;
638 /* TODO: remove chip->owner */
639 gdev->owner = gc->owner;
641 gdev->owner = THIS_MODULE;
643 gdev->descs = kcalloc(gc->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
646 goto err_free_dev_name;
649 if (gc->ngpio == 0) {
650 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
655 if (gc->ngpio > FASTPATH_NGPIO)
656 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
657 gc->ngpio, FASTPATH_NGPIO);
659 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
665 gdev->ngpio = gc->ngpio;
668 spin_lock_irqsave(&gpio_lock, flags);
671 * TODO: this allocates a Linux GPIO number base in the global
672 * GPIO numberspace for this chip. In the long run we want to
673 * get *rid* of this numberspace and use only descriptors, but
674 * it may be a pipe dream. It will not happen before we get rid
675 * of the sysfs interface anyways.
678 base = gpiochip_find_base(gc->ngpio);
681 spin_unlock_irqrestore(&gpio_lock, flags);
685 * TODO: it should not be necessary to reflect the assigned
686 * base outside of the GPIO subsystem. Go over drivers and
687 * see if anyone makes use of this, else drop this and assign
694 ret = gpiodev_add_to_list(gdev);
696 spin_unlock_irqrestore(&gpio_lock, flags);
700 for (i = 0; i < gc->ngpio; i++)
701 gdev->descs[i].gdev = gdev;
703 spin_unlock_irqrestore(&gpio_lock, flags);
705 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->notifier);
707 #ifdef CONFIG_PINCTRL
708 INIT_LIST_HEAD(&gdev->pin_ranges);
712 ret = gpiochip_set_desc_names(gc);
714 ret = devprop_gpiochip_set_names(gc);
716 goto err_remove_from_list;
718 ret = gpiochip_alloc_valid_mask(gc);
720 goto err_remove_from_list;
722 ret = of_gpiochip_add(gc);
724 goto err_free_gpiochip_mask;
726 ret = gpiochip_init_valid_mask(gc);
728 goto err_remove_of_chip;
730 for (i = 0; i < gc->ngpio; i++) {
731 struct gpio_desc *desc = &gdev->descs[i];
733 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
734 assign_bit(FLAG_IS_OUT,
735 &desc->flags, !gc->get_direction(gc, i));
737 assign_bit(FLAG_IS_OUT,
738 &desc->flags, !gc->direction_input);
742 ret = gpiochip_add_pin_ranges(gc);
744 goto err_remove_of_chip;
746 acpi_gpiochip_add(gc);
748 machine_gpiochip_add(gc);
750 ret = gpiochip_irqchip_init_valid_mask(gc);
752 goto err_remove_acpi_chip;
754 ret = gpiochip_irqchip_init_hw(gc);
756 goto err_remove_acpi_chip;
758 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
760 goto err_remove_irqchip_mask;
763 * By first adding the chardev, and then adding the device,
764 * we get a device node entry in sysfs under
765 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
766 * coldplug of device nodes and other udev business.
767 * We can do this only if gpiolib has been initialized.
768 * Otherwise, defer until later.
770 if (gpiolib_initialized) {
771 ret = gpiochip_setup_dev(gdev);
773 goto err_remove_irqchip;
778 gpiochip_irqchip_remove(gc);
779 err_remove_irqchip_mask:
780 gpiochip_irqchip_free_valid_mask(gc);
781 err_remove_acpi_chip:
782 acpi_gpiochip_remove(gc);
784 gpiochip_free_hogs(gc);
785 of_gpiochip_remove(gc);
786 err_free_gpiochip_mask:
787 gpiochip_remove_pin_ranges(gc);
788 gpiochip_free_valid_mask(gc);
789 err_remove_from_list:
790 spin_lock_irqsave(&gpio_lock, flags);
791 list_del(&gdev->list);
792 spin_unlock_irqrestore(&gpio_lock, flags);
794 kfree_const(gdev->label);
798 kfree(dev_name(&gdev->dev));
800 ida_free(&gpio_ida, gdev->id);
802 /* failures here can mean systems won't boot... */
803 if (ret != -EPROBE_DEFER) {
804 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
805 gdev->base, gdev->base + gdev->ngpio - 1,
806 gc->label ? : "generic", ret);
811 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
814 * gpiochip_get_data() - get per-subdriver data for the chip
818 * The per-subdriver data for the chip.
820 void *gpiochip_get_data(struct gpio_chip *gc)
822 return gc->gpiodev->data;
824 EXPORT_SYMBOL_GPL(gpiochip_get_data);
827 * gpiochip_remove() - unregister a gpio_chip
828 * @gc: the chip to unregister
830 * A gpio_chip with any GPIOs still requested may not be removed.
832 void gpiochip_remove(struct gpio_chip *gc)
834 struct gpio_device *gdev = gc->gpiodev;
838 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
839 gpiochip_sysfs_unregister(gdev);
840 gpiochip_free_hogs(gc);
841 /* Numb the device, cancelling all outstanding operations */
843 gpiochip_irqchip_remove(gc);
844 acpi_gpiochip_remove(gc);
845 of_gpiochip_remove(gc);
846 gpiochip_remove_pin_ranges(gc);
847 gpiochip_free_valid_mask(gc);
849 * We accept no more calls into the driver from this point, so
850 * NULL the driver data pointer
854 spin_lock_irqsave(&gpio_lock, flags);
855 for (i = 0; i < gdev->ngpio; i++) {
856 if (gpiochip_is_requested(gc, i))
859 spin_unlock_irqrestore(&gpio_lock, flags);
861 if (i != gdev->ngpio)
863 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
866 * The gpiochip side puts its use of the device to rest here:
867 * if there are no userspace clients, the chardev and device will
868 * be removed, else it will be dangling until the last user is
871 gcdev_unregister(gdev);
872 put_device(&gdev->dev);
874 EXPORT_SYMBOL_GPL(gpiochip_remove);
877 * gpiochip_find() - iterator for locating a specific gpio_chip
878 * @data: data to pass to match function
879 * @match: Callback function to check gpio_chip
881 * Similar to bus_find_device. It returns a reference to a gpio_chip as
882 * determined by a user supplied @match callback. The callback should return
883 * 0 if the device doesn't match and non-zero if it does. If the callback is
884 * non-zero, this function will return to the caller and not iterate over any
887 struct gpio_chip *gpiochip_find(void *data,
888 int (*match)(struct gpio_chip *gc,
891 struct gpio_device *gdev;
892 struct gpio_chip *gc = NULL;
895 spin_lock_irqsave(&gpio_lock, flags);
896 list_for_each_entry(gdev, &gpio_devices, list)
897 if (gdev->chip && match(gdev->chip, data)) {
902 spin_unlock_irqrestore(&gpio_lock, flags);
906 EXPORT_SYMBOL_GPL(gpiochip_find);
908 static int gpiochip_match_name(struct gpio_chip *gc, void *data)
910 const char *name = data;
912 return !strcmp(gc->label, name);
915 static struct gpio_chip *find_chip_by_name(const char *name)
917 return gpiochip_find((void *)name, gpiochip_match_name);
920 #ifdef CONFIG_GPIOLIB_IRQCHIP
923 * The following is irqchip helper code for gpiochips.
926 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
928 struct gpio_irq_chip *girq = &gc->irq;
933 return girq->init_hw(gc);
936 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
938 struct gpio_irq_chip *girq = &gc->irq;
940 if (!girq->init_valid_mask)
943 girq->valid_mask = gpiochip_allocate_mask(gc);
944 if (!girq->valid_mask)
947 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
952 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
954 bitmap_free(gc->irq.valid_mask);
955 gc->irq.valid_mask = NULL;
958 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
961 if (!gpiochip_line_is_valid(gc, offset))
963 /* No mask means all valid */
964 if (likely(!gc->irq.valid_mask))
966 return test_bit(offset, gc->irq.valid_mask);
968 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
970 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
973 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
975 * @gc: the gpiochip to set the irqchip hierarchical handler to
976 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
977 * will then percolate up to the parent
979 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
980 struct irq_chip *irqchip)
982 /* DT will deal with mapping each IRQ as we go along */
983 if (is_of_node(gc->irq.fwnode))
987 * This is for legacy and boardfile "irqchip" fwnodes: allocate
988 * irqs upfront instead of dynamically since we don't have the
989 * dynamic type of allocation that hardware description languages
990 * provide. Once all GPIO drivers using board files are gone from
991 * the kernel we can delete this code, but for a transitional period
992 * it is necessary to keep this around.
994 if (is_fwnode_irqchip(gc->irq.fwnode)) {
998 for (i = 0; i < gc->ngpio; i++) {
999 struct irq_fwspec fwspec;
1000 unsigned int parent_hwirq;
1001 unsigned int parent_type;
1002 struct gpio_irq_chip *girq = &gc->irq;
1005 * We call the child to parent translation function
1006 * only to check if the child IRQ is valid or not.
1007 * Just pick the rising edge type here as that is what
1008 * we likely need to support.
1010 ret = girq->child_to_parent_hwirq(gc, i,
1011 IRQ_TYPE_EDGE_RISING,
1015 chip_err(gc, "skip set-up on hwirq %d\n",
1020 fwspec.fwnode = gc->irq.fwnode;
1021 /* This is the hwirq for the GPIO line side of things */
1022 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
1023 /* Just pick something */
1024 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
1025 fwspec.param_count = 2;
1026 ret = __irq_domain_alloc_irqs(gc->irq.domain,
1027 /* just pick something */
1036 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1043 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1048 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1049 struct irq_fwspec *fwspec,
1050 unsigned long *hwirq,
1053 /* We support standard DT translation */
1054 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1055 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1058 /* This is for board files and others not using DT */
1059 if (is_fwnode_irqchip(fwspec->fwnode)) {
1062 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1065 WARN_ON(*type == IRQ_TYPE_NONE);
1071 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1073 unsigned int nr_irqs,
1076 struct gpio_chip *gc = d->host_data;
1077 irq_hw_number_t hwirq;
1078 unsigned int type = IRQ_TYPE_NONE;
1079 struct irq_fwspec *fwspec = data;
1081 unsigned int parent_hwirq;
1082 unsigned int parent_type;
1083 struct gpio_irq_chip *girq = &gc->irq;
1087 * The nr_irqs parameter is always one except for PCI multi-MSI
1088 * so this should not happen.
1090 WARN_ON(nr_irqs != 1);
1092 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1096 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1098 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1099 &parent_hwirq, &parent_type);
1101 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1104 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1107 * We set handle_bad_irq because the .set_type() should
1108 * always be invoked and set the right type of handler.
1110 irq_domain_set_info(d,
1119 /* This parent only handles asserted level IRQs */
1120 parent_arg = girq->populate_parent_alloc_arg(gc, parent_hwirq, parent_type);
1124 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1126 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1127 ret = irq_domain_alloc_irqs_parent(d, irq, 1, parent_arg);
1129 * If the parent irqdomain is msi, the interrupts have already
1130 * been allocated, so the EEXIST is good.
1132 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1136 "failed to allocate parent hwirq %d for hwirq %lu\n",
1137 parent_hwirq, hwirq);
1143 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1144 unsigned int offset)
1149 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1151 ops->activate = gpiochip_irq_domain_activate;
1152 ops->deactivate = gpiochip_irq_domain_deactivate;
1153 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1154 ops->free = irq_domain_free_irqs_common;
1157 * We only allow overriding the translate() function for
1158 * hierarchical chips, and this should only be done if the user
1159 * really need something other than 1:1 translation.
1161 if (!ops->translate)
1162 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1165 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1167 if (!gc->irq.child_to_parent_hwirq ||
1169 chip_err(gc, "missing irqdomain vital data\n");
1173 if (!gc->irq.child_offset_to_irq)
1174 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1176 if (!gc->irq.populate_parent_alloc_arg)
1177 gc->irq.populate_parent_alloc_arg =
1178 gpiochip_populate_parent_fwspec_twocell;
1180 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1182 gc->irq.domain = irq_domain_create_hierarchy(
1183 gc->irq.parent_domain,
1187 &gc->irq.child_irq_domain_ops,
1190 if (!gc->irq.domain)
1193 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1198 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1200 return !!gc->irq.parent_domain;
1203 void *gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1204 unsigned int parent_hwirq,
1205 unsigned int parent_type)
1207 struct irq_fwspec *fwspec;
1209 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1213 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1214 fwspec->param_count = 2;
1215 fwspec->param[0] = parent_hwirq;
1216 fwspec->param[1] = parent_type;
1220 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1222 void *gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1223 unsigned int parent_hwirq,
1224 unsigned int parent_type)
1226 struct irq_fwspec *fwspec;
1228 fwspec = kmalloc(sizeof(*fwspec), GFP_KERNEL);
1232 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1233 fwspec->param_count = 4;
1234 fwspec->param[0] = 0;
1235 fwspec->param[1] = parent_hwirq;
1236 fwspec->param[2] = 0;
1237 fwspec->param[3] = parent_type;
1241 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1245 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1250 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1255 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1258 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1259 * @d: the irqdomain used by this irqchip
1260 * @irq: the global irq number used by this GPIO irqchip irq
1261 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1263 * This function will set up the mapping for a certain IRQ line on a
1264 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1265 * stored inside the gpiochip.
1267 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1268 irq_hw_number_t hwirq)
1270 struct gpio_chip *gc = d->host_data;
1273 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1276 irq_set_chip_data(irq, gc);
1278 * This lock class tells lockdep that GPIO irqs are in a different
1279 * category than their parents, so it won't report false recursion.
1281 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1282 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1283 /* Chips that use nested thread handlers have them marked */
1284 if (gc->irq.threaded)
1285 irq_set_nested_thread(irq, 1);
1286 irq_set_noprobe(irq);
1288 if (gc->irq.num_parents == 1)
1289 ret = irq_set_parent(irq, gc->irq.parents[0]);
1290 else if (gc->irq.map)
1291 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1297 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1298 * is passed as default type.
1300 if (gc->irq.default_type != IRQ_TYPE_NONE)
1301 irq_set_irq_type(irq, gc->irq.default_type);
1305 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1307 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1309 struct gpio_chip *gc = d->host_data;
1311 if (gc->irq.threaded)
1312 irq_set_nested_thread(irq, 0);
1313 irq_set_chip_and_handler(irq, NULL, NULL);
1314 irq_set_chip_data(irq, NULL);
1316 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1318 static const struct irq_domain_ops gpiochip_domain_ops = {
1319 .map = gpiochip_irq_map,
1320 .unmap = gpiochip_irq_unmap,
1321 /* Virtually all GPIO irqchips are twocell:ed */
1322 .xlate = irq_domain_xlate_twocell,
1326 * TODO: move these activate/deactivate in under the hierarchicial
1327 * irqchip implementation as static once SPMI and SSBI (all external
1328 * users) are phased over.
1331 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1332 * @domain: The IRQ domain used by this IRQ chip
1333 * @data: Outermost irq_data associated with the IRQ
1334 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1336 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1337 * used as the activate function for the &struct irq_domain_ops. The host_data
1338 * for the IRQ domain must be the &struct gpio_chip.
1340 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1341 struct irq_data *data, bool reserve)
1343 struct gpio_chip *gc = domain->host_data;
1345 return gpiochip_lock_as_irq(gc, data->hwirq);
1347 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1350 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1351 * @domain: The IRQ domain used by this IRQ chip
1352 * @data: Outermost irq_data associated with the IRQ
1354 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1355 * be used as the deactivate function for the &struct irq_domain_ops. The
1356 * host_data for the IRQ domain must be the &struct gpio_chip.
1358 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1359 struct irq_data *data)
1361 struct gpio_chip *gc = domain->host_data;
1363 return gpiochip_unlock_as_irq(gc, data->hwirq);
1365 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1367 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1369 struct irq_domain *domain = gc->irq.domain;
1371 if (!gpiochip_irqchip_irq_valid(gc, offset))
1374 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1375 if (irq_domain_is_hierarchy(domain)) {
1376 struct irq_fwspec spec;
1378 spec.fwnode = domain->fwnode;
1379 spec.param_count = 2;
1380 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1381 spec.param[1] = IRQ_TYPE_NONE;
1383 return irq_create_fwspec_mapping(&spec);
1387 return irq_create_mapping(domain, offset);
1390 static int gpiochip_irq_reqres(struct irq_data *d)
1392 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1394 return gpiochip_reqres_irq(gc, d->hwirq);
1397 static void gpiochip_irq_relres(struct irq_data *d)
1399 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1401 gpiochip_relres_irq(gc, d->hwirq);
1404 static void gpiochip_irq_mask(struct irq_data *d)
1406 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1408 if (gc->irq.irq_mask)
1409 gc->irq.irq_mask(d);
1410 gpiochip_disable_irq(gc, d->hwirq);
1413 static void gpiochip_irq_unmask(struct irq_data *d)
1415 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1417 gpiochip_enable_irq(gc, d->hwirq);
1418 if (gc->irq.irq_unmask)
1419 gc->irq.irq_unmask(d);
1422 static void gpiochip_irq_enable(struct irq_data *d)
1424 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1426 gpiochip_enable_irq(gc, d->hwirq);
1427 gc->irq.irq_enable(d);
1430 static void gpiochip_irq_disable(struct irq_data *d)
1432 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1434 gc->irq.irq_disable(d);
1435 gpiochip_disable_irq(gc, d->hwirq);
1438 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1440 struct irq_chip *irqchip = gc->irq.chip;
1442 if (!irqchip->irq_request_resources &&
1443 !irqchip->irq_release_resources) {
1444 irqchip->irq_request_resources = gpiochip_irq_reqres;
1445 irqchip->irq_release_resources = gpiochip_irq_relres;
1447 if (WARN_ON(gc->irq.irq_enable))
1449 /* Check if the irqchip already has this hook... */
1450 if (irqchip->irq_enable == gpiochip_irq_enable ||
1451 irqchip->irq_mask == gpiochip_irq_mask) {
1453 * ...and if so, give a gentle warning that this is bad
1457 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1461 if (irqchip->irq_disable) {
1462 gc->irq.irq_disable = irqchip->irq_disable;
1463 irqchip->irq_disable = gpiochip_irq_disable;
1465 gc->irq.irq_mask = irqchip->irq_mask;
1466 irqchip->irq_mask = gpiochip_irq_mask;
1469 if (irqchip->irq_enable) {
1470 gc->irq.irq_enable = irqchip->irq_enable;
1471 irqchip->irq_enable = gpiochip_irq_enable;
1473 gc->irq.irq_unmask = irqchip->irq_unmask;
1474 irqchip->irq_unmask = gpiochip_irq_unmask;
1479 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1480 * @gc: the GPIO chip to add the IRQ chip to
1481 * @lock_key: lockdep class for IRQ lock
1482 * @request_key: lockdep class for IRQ request
1484 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1485 struct lock_class_key *lock_key,
1486 struct lock_class_key *request_key)
1488 struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
1489 struct irq_chip *irqchip = gc->irq.chip;
1496 if (gc->irq.parent_handler && gc->can_sleep) {
1497 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1501 type = gc->irq.default_type;
1504 * Specifying a default trigger is a terrible idea if DT or ACPI is
1505 * used to configure the interrupts, as you may end up with
1506 * conflicting triggers. Tell the user, and reset to NONE.
1508 if (WARN(fwnode && type != IRQ_TYPE_NONE,
1509 "%pfw: Ignoring %u default trigger\n", fwnode, type))
1510 type = IRQ_TYPE_NONE;
1513 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1515 gc->to_irq = gpiochip_to_irq;
1516 gc->irq.default_type = type;
1517 gc->irq.lock_key = lock_key;
1518 gc->irq.request_key = request_key;
1520 /* If a parent irqdomain is provided, let's build a hierarchy */
1521 if (gpiochip_hierarchy_is_hierarchical(gc)) {
1522 int ret = gpiochip_hierarchy_add_domain(gc);
1526 /* Some drivers provide custom irqdomain ops */
1527 gc->irq.domain = irq_domain_create_simple(fwnode,
1530 gc->irq.domain_ops ?: &gpiochip_domain_ops,
1532 if (!gc->irq.domain)
1536 if (gc->irq.parent_handler) {
1537 for (i = 0; i < gc->irq.num_parents; i++) {
1540 if (gc->irq.per_parent_data)
1541 data = gc->irq.parent_handler_data_array[i];
1543 data = gc->irq.parent_handler_data ?: gc;
1546 * The parent IRQ chip is already using the chip_data
1547 * for this IRQ chip, so our callbacks simply use the
1550 irq_set_chained_handler_and_data(gc->irq.parents[i],
1551 gc->irq.parent_handler,
1556 gpiochip_set_irq_hooks(gc);
1558 acpi_gpiochip_request_interrupts(gc);
1564 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1565 * @gc: the gpiochip to remove the irqchip from
1567 * This is called only from gpiochip_remove()
1569 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1571 struct irq_chip *irqchip = gc->irq.chip;
1572 unsigned int offset;
1574 acpi_gpiochip_free_interrupts(gc);
1576 if (irqchip && gc->irq.parent_handler) {
1577 struct gpio_irq_chip *irq = &gc->irq;
1580 for (i = 0; i < irq->num_parents; i++)
1581 irq_set_chained_handler_and_data(irq->parents[i],
1585 /* Remove all IRQ mappings and delete the domain */
1586 if (gc->irq.domain) {
1589 for (offset = 0; offset < gc->ngpio; offset++) {
1590 if (!gpiochip_irqchip_irq_valid(gc, offset))
1593 irq = irq_find_mapping(gc->irq.domain, offset);
1594 irq_dispose_mapping(irq);
1597 irq_domain_remove(gc->irq.domain);
1601 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1602 irqchip->irq_request_resources = NULL;
1603 irqchip->irq_release_resources = NULL;
1605 if (irqchip->irq_enable == gpiochip_irq_enable) {
1606 irqchip->irq_enable = gc->irq.irq_enable;
1607 irqchip->irq_disable = gc->irq.irq_disable;
1610 gc->irq.irq_enable = NULL;
1611 gc->irq.irq_disable = NULL;
1612 gc->irq.chip = NULL;
1614 gpiochip_irqchip_free_valid_mask(gc);
1618 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1619 * @gc: the gpiochip to add the irqchip to
1620 * @domain: the irqdomain to add to the gpiochip
1622 * This function adds an IRQ domain to the gpiochip.
1624 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1625 struct irq_domain *domain)
1630 gc->to_irq = gpiochip_to_irq;
1631 gc->irq.domain = domain;
1635 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1637 #else /* CONFIG_GPIOLIB_IRQCHIP */
1639 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1640 struct lock_class_key *lock_key,
1641 struct lock_class_key *request_key)
1645 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1647 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1652 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1656 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1659 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1662 * gpiochip_generic_request() - request the gpio function for a pin
1663 * @gc: the gpiochip owning the GPIO
1664 * @offset: the offset of the GPIO to request for GPIO function
1666 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
1668 #ifdef CONFIG_PINCTRL
1669 if (list_empty(&gc->gpiodev->pin_ranges))
1673 return pinctrl_gpio_request(gc->gpiodev->base + offset);
1675 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1678 * gpiochip_generic_free() - free the gpio function from a pin
1679 * @gc: the gpiochip to request the gpio function for
1680 * @offset: the offset of the GPIO to free from GPIO function
1682 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
1684 #ifdef CONFIG_PINCTRL
1685 if (list_empty(&gc->gpiodev->pin_ranges))
1689 pinctrl_gpio_free(gc->gpiodev->base + offset);
1691 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1694 * gpiochip_generic_config() - apply configuration for a pin
1695 * @gc: the gpiochip owning the GPIO
1696 * @offset: the offset of the GPIO to apply the configuration
1697 * @config: the configuration to be applied
1699 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
1700 unsigned long config)
1702 return pinctrl_gpio_set_config(gc->gpiodev->base + offset, config);
1704 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1706 #ifdef CONFIG_PINCTRL
1709 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1710 * @gc: the gpiochip to add the range for
1711 * @pctldev: the pin controller to map to
1712 * @gpio_offset: the start offset in the current gpio_chip number space
1713 * @pin_group: name of the pin group inside the pin controller
1715 * Calling this function directly from a DeviceTree-supported
1716 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1717 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1718 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1720 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
1721 struct pinctrl_dev *pctldev,
1722 unsigned int gpio_offset, const char *pin_group)
1724 struct gpio_pin_range *pin_range;
1725 struct gpio_device *gdev = gc->gpiodev;
1728 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1730 chip_err(gc, "failed to allocate pin ranges\n");
1734 /* Use local offset as range ID */
1735 pin_range->range.id = gpio_offset;
1736 pin_range->range.gc = gc;
1737 pin_range->range.name = gc->label;
1738 pin_range->range.base = gdev->base + gpio_offset;
1739 pin_range->pctldev = pctldev;
1741 ret = pinctrl_get_group_pins(pctldev, pin_group,
1742 &pin_range->range.pins,
1743 &pin_range->range.npins);
1749 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1751 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1752 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1753 pinctrl_dev_get_devname(pctldev), pin_group);
1755 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1759 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1762 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1763 * @gc: the gpiochip to add the range for
1764 * @pinctl_name: the dev_name() of the pin controller to map to
1765 * @gpio_offset: the start offset in the current gpio_chip number space
1766 * @pin_offset: the start offset in the pin controller number space
1767 * @npins: the number of pins from the offset of each pin space (GPIO and
1768 * pin controller) to accumulate in this range
1771 * 0 on success, or a negative error-code on failure.
1773 * Calling this function directly from a DeviceTree-supported
1774 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1775 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1776 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1778 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
1779 unsigned int gpio_offset, unsigned int pin_offset,
1782 struct gpio_pin_range *pin_range;
1783 struct gpio_device *gdev = gc->gpiodev;
1786 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1788 chip_err(gc, "failed to allocate pin ranges\n");
1792 /* Use local offset as range ID */
1793 pin_range->range.id = gpio_offset;
1794 pin_range->range.gc = gc;
1795 pin_range->range.name = gc->label;
1796 pin_range->range.base = gdev->base + gpio_offset;
1797 pin_range->range.pin_base = pin_offset;
1798 pin_range->range.npins = npins;
1799 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1801 if (IS_ERR(pin_range->pctldev)) {
1802 ret = PTR_ERR(pin_range->pctldev);
1803 chip_err(gc, "could not create pin range\n");
1807 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1808 gpio_offset, gpio_offset + npins - 1,
1810 pin_offset, pin_offset + npins - 1);
1812 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1816 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1819 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1820 * @gc: the chip to remove all the mappings for
1822 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
1824 struct gpio_pin_range *pin_range, *tmp;
1825 struct gpio_device *gdev = gc->gpiodev;
1827 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1828 list_del(&pin_range->node);
1829 pinctrl_remove_gpio_range(pin_range->pctldev,
1834 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1836 #endif /* CONFIG_PINCTRL */
1838 /* These "optional" allocation calls help prevent drivers from stomping
1839 * on each other, and help provide better diagnostics in debugfs.
1840 * They're called even less than the "set direction" calls.
1842 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
1844 struct gpio_chip *gc = desc->gdev->chip;
1846 unsigned long flags;
1850 label = kstrdup_const(label, GFP_KERNEL);
1855 spin_lock_irqsave(&gpio_lock, flags);
1857 /* NOTE: gpio_request() can be called in early boot,
1858 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1861 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1862 desc_set_label(desc, label ? : "?");
1865 goto out_free_unlock;
1869 /* gc->request may sleep */
1870 spin_unlock_irqrestore(&gpio_lock, flags);
1871 offset = gpio_chip_hwgpio(desc);
1872 if (gpiochip_line_is_valid(gc, offset))
1873 ret = gc->request(gc, offset);
1876 spin_lock_irqsave(&gpio_lock, flags);
1879 desc_set_label(desc, NULL);
1880 clear_bit(FLAG_REQUESTED, &desc->flags);
1881 goto out_free_unlock;
1884 if (gc->get_direction) {
1885 /* gc->get_direction may sleep */
1886 spin_unlock_irqrestore(&gpio_lock, flags);
1887 gpiod_get_direction(desc);
1888 spin_lock_irqsave(&gpio_lock, flags);
1890 spin_unlock_irqrestore(&gpio_lock, flags);
1894 spin_unlock_irqrestore(&gpio_lock, flags);
1900 * This descriptor validation needs to be inserted verbatim into each
1901 * function taking a descriptor, so we need to use a preprocessor
1902 * macro to avoid endless duplication. If the desc is NULL it is an
1903 * optional GPIO and calls should just bail out.
1905 static int validate_desc(const struct gpio_desc *desc, const char *func)
1910 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
1911 return PTR_ERR(desc);
1914 pr_warn("%s: invalid GPIO (no device)\n", func);
1917 if (!desc->gdev->chip) {
1918 dev_warn(&desc->gdev->dev,
1919 "%s: backing chip is gone\n", func);
1925 #define VALIDATE_DESC(desc) do { \
1926 int __valid = validate_desc(desc, __func__); \
1931 #define VALIDATE_DESC_VOID(desc) do { \
1932 int __valid = validate_desc(desc, __func__); \
1937 int gpiod_request(struct gpio_desc *desc, const char *label)
1939 int ret = -EPROBE_DEFER;
1940 struct gpio_device *gdev;
1942 VALIDATE_DESC(desc);
1945 if (try_module_get(gdev->owner)) {
1946 ret = gpiod_request_commit(desc, label);
1948 module_put(gdev->owner);
1950 get_device(&gdev->dev);
1954 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
1959 static bool gpiod_free_commit(struct gpio_desc *desc)
1962 unsigned long flags;
1963 struct gpio_chip *gc;
1967 gpiod_unexport(desc);
1969 spin_lock_irqsave(&gpio_lock, flags);
1971 gc = desc->gdev->chip;
1972 if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
1974 spin_unlock_irqrestore(&gpio_lock, flags);
1975 might_sleep_if(gc->can_sleep);
1976 gc->free(gc, gpio_chip_hwgpio(desc));
1977 spin_lock_irqsave(&gpio_lock, flags);
1979 kfree_const(desc->label);
1980 desc_set_label(desc, NULL);
1981 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
1982 clear_bit(FLAG_REQUESTED, &desc->flags);
1983 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1984 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1985 clear_bit(FLAG_PULL_UP, &desc->flags);
1986 clear_bit(FLAG_PULL_DOWN, &desc->flags);
1987 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
1988 clear_bit(FLAG_EDGE_RISING, &desc->flags);
1989 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
1990 clear_bit(FLAG_IS_HOGGED, &desc->flags);
1991 #ifdef CONFIG_OF_DYNAMIC
1994 #ifdef CONFIG_GPIO_CDEV
1995 WRITE_ONCE(desc->debounce_period_us, 0);
2000 spin_unlock_irqrestore(&gpio_lock, flags);
2001 blocking_notifier_call_chain(&desc->gdev->notifier,
2002 GPIOLINE_CHANGED_RELEASED, desc);
2007 void gpiod_free(struct gpio_desc *desc)
2009 if (desc && desc->gdev && gpiod_free_commit(desc)) {
2010 module_put(desc->gdev->owner);
2011 put_device(&desc->gdev->dev);
2013 WARN_ON(extra_checks);
2018 * gpiochip_is_requested - return string iff signal was requested
2019 * @gc: controller managing the signal
2020 * @offset: of signal within controller's 0..(ngpio - 1) range
2022 * Returns NULL if the GPIO is not currently requested, else a string.
2023 * The string returned is the label passed to gpio_request(); if none has been
2024 * passed it is a meaningless, non-NULL constant.
2026 * This function is for use by GPIO controller drivers. The label can
2027 * help with diagnostics, and knowing that the signal is used as a GPIO
2028 * can help avoid accidentally multiplexing it to another controller.
2030 const char *gpiochip_is_requested(struct gpio_chip *gc, unsigned int offset)
2032 struct gpio_desc *desc;
2034 desc = gpiochip_get_desc(gc, offset);
2038 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2042 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2045 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2047 * @hwnum: hardware number of the GPIO for which to request the descriptor
2048 * @label: label for the GPIO
2049 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2050 * specify things like line inversion semantics with the machine flags
2051 * such as GPIO_OUT_LOW
2052 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2053 * can be used to specify consumer semantics such as open drain
2055 * Function allows GPIO chip drivers to request and use their own GPIO
2056 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2057 * function will not increase reference count of the GPIO chip module. This
2058 * allows the GPIO chip module to be unloaded as needed (we assume that the
2059 * GPIO chip driver handles freeing the GPIOs it has requested).
2062 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2065 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2068 enum gpio_lookup_flags lflags,
2069 enum gpiod_flags dflags)
2071 struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2075 chip_err(gc, "failed to get GPIO descriptor\n");
2079 ret = gpiod_request_commit(desc, label);
2081 return ERR_PTR(ret);
2083 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2085 chip_err(gc, "setup of own GPIO %s failed\n", label);
2086 gpiod_free_commit(desc);
2087 return ERR_PTR(ret);
2092 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2095 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2096 * @desc: GPIO descriptor to free
2098 * Function frees the given GPIO requested previously with
2099 * gpiochip_request_own_desc().
2101 void gpiochip_free_own_desc(struct gpio_desc *desc)
2104 gpiod_free_commit(desc);
2106 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2109 * Drivers MUST set GPIO direction before making get/set calls. In
2110 * some cases this is done in early boot, before IRQs are enabled.
2112 * As a rule these aren't called more than once (except for drivers
2113 * using the open-drain emulation idiom) so these are natural places
2114 * to accumulate extra debugging checks. Note that we can't (yet)
2115 * rely on gpio_request() having been called beforehand.
2118 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2119 unsigned long config)
2121 if (!gc->set_config)
2124 return gc->set_config(gc, offset, config);
2127 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2128 enum pin_config_param mode,
2131 struct gpio_chip *gc = desc->gdev->chip;
2132 unsigned long config;
2134 config = pinconf_to_config_packed(mode, argument);
2135 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2138 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2139 enum pin_config_param mode,
2142 struct device *dev = &desc->gdev->dev;
2143 int gpio = gpio_chip_hwgpio(desc);
2146 ret = gpio_set_config_with_argument(desc, mode, argument);
2147 if (ret != -ENOTSUPP)
2151 case PIN_CONFIG_PERSIST_STATE:
2152 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2161 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2163 return gpio_set_config_with_argument(desc, mode, 0);
2166 static int gpio_set_bias(struct gpio_desc *desc)
2168 enum pin_config_param bias;
2171 if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2172 bias = PIN_CONFIG_BIAS_DISABLE;
2173 else if (test_bit(FLAG_PULL_UP, &desc->flags))
2174 bias = PIN_CONFIG_BIAS_PULL_UP;
2175 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2176 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2181 case PIN_CONFIG_BIAS_PULL_DOWN:
2182 case PIN_CONFIG_BIAS_PULL_UP:
2191 return gpio_set_config_with_argument_optional(desc, bias, arg);
2194 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2196 return gpio_set_config_with_argument_optional(desc,
2197 PIN_CONFIG_INPUT_DEBOUNCE,
2202 * gpiod_direction_input - set the GPIO direction to input
2203 * @desc: GPIO to set to input
2205 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2206 * be called safely on it.
2208 * Return 0 in case of success, else an error code.
2210 int gpiod_direction_input(struct gpio_desc *desc)
2212 struct gpio_chip *gc;
2215 VALIDATE_DESC(desc);
2216 gc = desc->gdev->chip;
2219 * It is legal to have no .get() and .direction_input() specified if
2220 * the chip is output-only, but you can't specify .direction_input()
2221 * and not support the .get() operation, that doesn't make sense.
2223 if (!gc->get && gc->direction_input) {
2225 "%s: missing get() but have direction_input()\n",
2231 * If we have a .direction_input() callback, things are simple,
2232 * just call it. Else we are some input-only chip so try to check the
2233 * direction (if .get_direction() is supported) else we silently
2234 * assume we are in input mode after this.
2236 if (gc->direction_input) {
2237 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2238 } else if (gc->get_direction &&
2239 (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2241 "%s: missing direction_input() operation and line is output\n",
2246 clear_bit(FLAG_IS_OUT, &desc->flags);
2247 ret = gpio_set_bias(desc);
2250 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2254 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2256 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2258 struct gpio_chip *gc = desc->gdev->chip;
2263 * It's OK not to specify .direction_output() if the gpiochip is
2264 * output-only, but if there is then not even a .set() operation it
2265 * is pretty tricky to drive the output line.
2267 if (!gc->set && !gc->direction_output) {
2269 "%s: missing set() and direction_output() operations\n",
2274 if (gc->direction_output) {
2275 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2277 /* Check that we are in output mode if we can */
2278 if (gc->get_direction &&
2279 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2281 "%s: missing direction_output() operation\n",
2286 * If we can't actively set the direction, we are some
2287 * output-only chip, so just drive the output as desired.
2289 gc->set(gc, gpio_chip_hwgpio(desc), val);
2293 set_bit(FLAG_IS_OUT, &desc->flags);
2294 trace_gpio_value(desc_to_gpio(desc), 0, val);
2295 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2300 * gpiod_direction_output_raw - set the GPIO direction to output
2301 * @desc: GPIO to set to output
2302 * @value: initial output value of the GPIO
2304 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2305 * be called safely on it. The initial value of the output must be specified
2306 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2308 * Return 0 in case of success, else an error code.
2310 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2312 VALIDATE_DESC(desc);
2313 return gpiod_direction_output_raw_commit(desc, value);
2315 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2318 * gpiod_direction_output - set the GPIO direction to output
2319 * @desc: GPIO to set to output
2320 * @value: initial output value of the GPIO
2322 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2323 * be called safely on it. The initial value of the output must be specified
2324 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2327 * Return 0 in case of success, else an error code.
2329 int gpiod_direction_output(struct gpio_desc *desc, int value)
2333 VALIDATE_DESC(desc);
2334 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2339 /* GPIOs used for enabled IRQs shall not be set as output */
2340 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2341 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2343 "%s: tried to set a GPIO tied to an IRQ as output\n",
2348 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2349 /* First see if we can enable open drain in hardware */
2350 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2352 goto set_output_value;
2353 /* Emulate open drain by not actively driving the line high */
2355 ret = gpiod_direction_input(desc);
2356 goto set_output_flag;
2359 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2360 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2362 goto set_output_value;
2363 /* Emulate open source by not actively driving the line low */
2365 ret = gpiod_direction_input(desc);
2366 goto set_output_flag;
2369 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2373 ret = gpio_set_bias(desc);
2376 return gpiod_direction_output_raw_commit(desc, value);
2380 * When emulating open-source or open-drain functionalities by not
2381 * actively driving the line (setting mode to input) we still need to
2382 * set the IS_OUT flag or otherwise we won't be able to set the line
2386 set_bit(FLAG_IS_OUT, &desc->flags);
2389 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2392 * gpiod_set_config - sets @config for a GPIO
2393 * @desc: descriptor of the GPIO for which to set the configuration
2394 * @config: Same packed config format as generic pinconf
2397 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2400 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2402 struct gpio_chip *gc;
2404 VALIDATE_DESC(desc);
2405 gc = desc->gdev->chip;
2407 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2409 EXPORT_SYMBOL_GPL(gpiod_set_config);
2412 * gpiod_set_debounce - sets @debounce time for a GPIO
2413 * @desc: descriptor of the GPIO for which to set debounce time
2414 * @debounce: debounce time in microseconds
2417 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2420 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2422 unsigned long config;
2424 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2425 return gpiod_set_config(desc, config);
2427 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2430 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2431 * @desc: descriptor of the GPIO for which to configure persistence
2432 * @transitory: True to lose state on suspend or reset, false for persistence
2435 * 0 on success, otherwise a negative error code.
2437 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2439 VALIDATE_DESC(desc);
2441 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2442 * persistence state.
2444 assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2446 /* If the driver supports it, set the persistence state now */
2447 return gpio_set_config_with_argument_optional(desc,
2448 PIN_CONFIG_PERSIST_STATE,
2451 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2454 * gpiod_is_active_low - test whether a GPIO is active-low or not
2455 * @desc: the gpio descriptor to test
2457 * Returns 1 if the GPIO is active-low, 0 otherwise.
2459 int gpiod_is_active_low(const struct gpio_desc *desc)
2461 VALIDATE_DESC(desc);
2462 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2464 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2467 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2468 * @desc: the gpio descriptor to change
2470 void gpiod_toggle_active_low(struct gpio_desc *desc)
2472 VALIDATE_DESC_VOID(desc);
2473 change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2475 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2477 /* I/O calls are only valid after configuration completed; the relevant
2478 * "is this a valid GPIO" error checks should already have been done.
2480 * "Get" operations are often inlinable as reading a pin value register,
2481 * and masking the relevant bit in that register.
2483 * When "set" operations are inlinable, they involve writing that mask to
2484 * one register to set a low value, or a different register to set it high.
2485 * Otherwise locking is needed, so there may be little value to inlining.
2487 *------------------------------------------------------------------------
2489 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2490 * have requested the GPIO. That can include implicit requesting by
2491 * a direction setting call. Marking a gpio as requested locks its chip
2492 * in memory, guaranteeing that these table lookups need no more locking
2493 * and that gpiochip_remove() will fail.
2495 * REVISIT when debugging, consider adding some instrumentation to ensure
2496 * that the GPIO was actually requested.
2499 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2501 struct gpio_chip *gc;
2505 gc = desc->gdev->chip;
2506 offset = gpio_chip_hwgpio(desc);
2507 value = gc->get ? gc->get(gc, offset) : -EIO;
2508 value = value < 0 ? value : !!value;
2509 trace_gpio_value(desc_to_gpio(desc), 1, value);
2513 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2514 unsigned long *mask, unsigned long *bits)
2516 if (gc->get_multiple) {
2517 return gc->get_multiple(gc, mask, bits);
2518 } else if (gc->get) {
2521 for_each_set_bit(i, mask, gc->ngpio) {
2522 value = gc->get(gc, i);
2525 __assign_bit(i, bits, value);
2532 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2533 unsigned int array_size,
2534 struct gpio_desc **desc_array,
2535 struct gpio_array *array_info,
2536 unsigned long *value_bitmap)
2541 * Validate array_info against desc_array and its size.
2542 * It should immediately follow desc_array if both
2543 * have been obtained from the same gpiod_get_array() call.
2545 if (array_info && array_info->desc == desc_array &&
2546 array_size <= array_info->size &&
2547 (void *)array_info == desc_array + array_info->size) {
2549 WARN_ON(array_info->chip->can_sleep);
2551 ret = gpio_chip_get_multiple(array_info->chip,
2552 array_info->get_mask,
2557 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2558 bitmap_xor(value_bitmap, value_bitmap,
2559 array_info->invert_mask, array_size);
2561 i = find_first_zero_bit(array_info->get_mask, array_size);
2562 if (i == array_size)
2568 while (i < array_size) {
2569 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2570 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
2571 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
2572 unsigned long *mask, *bits;
2575 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2576 mask = fastpath_mask;
2577 bits = fastpath_bits;
2579 gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
2581 mask = bitmap_alloc(gc->ngpio, flags);
2585 bits = bitmap_alloc(gc->ngpio, flags);
2592 bitmap_zero(mask, gc->ngpio);
2595 WARN_ON(gc->can_sleep);
2597 /* collect all inputs belonging to the same chip */
2600 const struct gpio_desc *desc = desc_array[i];
2601 int hwgpio = gpio_chip_hwgpio(desc);
2603 __set_bit(hwgpio, mask);
2607 i = find_next_zero_bit(array_info->get_mask,
2609 } while ((i < array_size) &&
2610 (desc_array[i]->gdev->chip == gc));
2612 ret = gpio_chip_get_multiple(gc, mask, bits);
2614 if (mask != fastpath_mask)
2616 if (bits != fastpath_bits)
2621 for (j = first; j < i; ) {
2622 const struct gpio_desc *desc = desc_array[j];
2623 int hwgpio = gpio_chip_hwgpio(desc);
2624 int value = test_bit(hwgpio, bits);
2626 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2628 __assign_bit(j, value_bitmap, value);
2629 trace_gpio_value(desc_to_gpio(desc), 1, value);
2633 j = find_next_zero_bit(array_info->get_mask, i,
2637 if (mask != fastpath_mask)
2639 if (bits != fastpath_bits)
2646 * gpiod_get_raw_value() - return a gpio's raw value
2647 * @desc: gpio whose value will be returned
2649 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2650 * its ACTIVE_LOW status, or negative errno on failure.
2652 * This function can be called from contexts where we cannot sleep, and will
2653 * complain if the GPIO chip functions potentially sleep.
2655 int gpiod_get_raw_value(const struct gpio_desc *desc)
2657 VALIDATE_DESC(desc);
2658 /* Should be using gpiod_get_raw_value_cansleep() */
2659 WARN_ON(desc->gdev->chip->can_sleep);
2660 return gpiod_get_raw_value_commit(desc);
2662 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2665 * gpiod_get_value() - return a gpio's value
2666 * @desc: gpio whose value will be returned
2668 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2669 * account, or negative errno on failure.
2671 * This function can be called from contexts where we cannot sleep, and will
2672 * complain if the GPIO chip functions potentially sleep.
2674 int gpiod_get_value(const struct gpio_desc *desc)
2678 VALIDATE_DESC(desc);
2679 /* Should be using gpiod_get_value_cansleep() */
2680 WARN_ON(desc->gdev->chip->can_sleep);
2682 value = gpiod_get_raw_value_commit(desc);
2686 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2691 EXPORT_SYMBOL_GPL(gpiod_get_value);
2694 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2695 * @array_size: number of elements in the descriptor array / value bitmap
2696 * @desc_array: array of GPIO descriptors whose values will be read
2697 * @array_info: information on applicability of fast bitmap processing path
2698 * @value_bitmap: bitmap to store the read values
2700 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2701 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2702 * else an error code.
2704 * This function can be called from contexts where we cannot sleep,
2705 * and it will complain if the GPIO chip functions potentially sleep.
2707 int gpiod_get_raw_array_value(unsigned int array_size,
2708 struct gpio_desc **desc_array,
2709 struct gpio_array *array_info,
2710 unsigned long *value_bitmap)
2714 return gpiod_get_array_value_complex(true, false, array_size,
2715 desc_array, array_info,
2718 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2721 * gpiod_get_array_value() - read values from an array of GPIOs
2722 * @array_size: number of elements in the descriptor array / value bitmap
2723 * @desc_array: array of GPIO descriptors whose values will be read
2724 * @array_info: information on applicability of fast bitmap processing path
2725 * @value_bitmap: bitmap to store the read values
2727 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2728 * into account. Return 0 in case of success, else an error code.
2730 * This function can be called from contexts where we cannot sleep,
2731 * and it will complain if the GPIO chip functions potentially sleep.
2733 int gpiod_get_array_value(unsigned int array_size,
2734 struct gpio_desc **desc_array,
2735 struct gpio_array *array_info,
2736 unsigned long *value_bitmap)
2740 return gpiod_get_array_value_complex(false, false, array_size,
2741 desc_array, array_info,
2744 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2747 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2748 * @desc: gpio descriptor whose state need to be set.
2749 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2751 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2754 struct gpio_chip *gc = desc->gdev->chip;
2755 int offset = gpio_chip_hwgpio(desc);
2758 ret = gc->direction_input(gc, offset);
2760 ret = gc->direction_output(gc, offset, 0);
2762 set_bit(FLAG_IS_OUT, &desc->flags);
2764 trace_gpio_direction(desc_to_gpio(desc), value, ret);
2767 "%s: Error in set_value for open drain err %d\n",
2772 * _gpio_set_open_source_value() - Set the open source gpio's value.
2773 * @desc: gpio descriptor whose state need to be set.
2774 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2776 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2779 struct gpio_chip *gc = desc->gdev->chip;
2780 int offset = gpio_chip_hwgpio(desc);
2783 ret = gc->direction_output(gc, offset, 1);
2785 set_bit(FLAG_IS_OUT, &desc->flags);
2787 ret = gc->direction_input(gc, offset);
2789 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
2792 "%s: Error in set_value for open source err %d\n",
2796 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2798 struct gpio_chip *gc;
2800 gc = desc->gdev->chip;
2801 trace_gpio_value(desc_to_gpio(desc), 0, value);
2802 gc->set(gc, gpio_chip_hwgpio(desc), value);
2806 * set multiple outputs on the same chip;
2807 * use the chip's set_multiple function if available;
2808 * otherwise set the outputs sequentially;
2809 * @chip: the GPIO chip we operate on
2810 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
2811 * defines which outputs are to be changed
2812 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
2813 * defines the values the outputs specified by mask are to be set to
2815 static void gpio_chip_set_multiple(struct gpio_chip *gc,
2816 unsigned long *mask, unsigned long *bits)
2818 if (gc->set_multiple) {
2819 gc->set_multiple(gc, mask, bits);
2823 /* set outputs if the corresponding mask bit is set */
2824 for_each_set_bit(i, mask, gc->ngpio)
2825 gc->set(gc, i, test_bit(i, bits));
2829 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
2830 unsigned int array_size,
2831 struct gpio_desc **desc_array,
2832 struct gpio_array *array_info,
2833 unsigned long *value_bitmap)
2838 * Validate array_info against desc_array and its size.
2839 * It should immediately follow desc_array if both
2840 * have been obtained from the same gpiod_get_array() call.
2842 if (array_info && array_info->desc == desc_array &&
2843 array_size <= array_info->size &&
2844 (void *)array_info == desc_array + array_info->size) {
2846 WARN_ON(array_info->chip->can_sleep);
2848 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2849 bitmap_xor(value_bitmap, value_bitmap,
2850 array_info->invert_mask, array_size);
2852 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
2855 i = find_first_zero_bit(array_info->set_mask, array_size);
2856 if (i == array_size)
2862 while (i < array_size) {
2863 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2864 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
2865 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
2866 unsigned long *mask, *bits;
2869 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2870 mask = fastpath_mask;
2871 bits = fastpath_bits;
2873 gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
2875 mask = bitmap_alloc(gc->ngpio, flags);
2879 bits = bitmap_alloc(gc->ngpio, flags);
2886 bitmap_zero(mask, gc->ngpio);
2889 WARN_ON(gc->can_sleep);
2892 struct gpio_desc *desc = desc_array[i];
2893 int hwgpio = gpio_chip_hwgpio(desc);
2894 int value = test_bit(i, value_bitmap);
2897 * Pins applicable for fast input but not for
2898 * fast output processing may have been already
2899 * inverted inside the fast path, skip them.
2901 if (!raw && !(array_info &&
2902 test_bit(i, array_info->invert_mask)) &&
2903 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2905 trace_gpio_value(desc_to_gpio(desc), 0, value);
2907 * collect all normal outputs belonging to the same chip
2908 * open drain and open source outputs are set individually
2910 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
2911 gpio_set_open_drain_value_commit(desc, value);
2912 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
2913 gpio_set_open_source_value_commit(desc, value);
2915 __set_bit(hwgpio, mask);
2916 __assign_bit(hwgpio, bits, value);
2922 i = find_next_zero_bit(array_info->set_mask,
2924 } while ((i < array_size) &&
2925 (desc_array[i]->gdev->chip == gc));
2926 /* push collected bits to outputs */
2928 gpio_chip_set_multiple(gc, mask, bits);
2930 if (mask != fastpath_mask)
2932 if (bits != fastpath_bits)
2939 * gpiod_set_raw_value() - assign a gpio's raw value
2940 * @desc: gpio whose value will be assigned
2941 * @value: value to assign
2943 * Set the raw value of the GPIO, i.e. the value of its physical line without
2944 * regard for its ACTIVE_LOW status.
2946 * This function can be called from contexts where we cannot sleep, and will
2947 * complain if the GPIO chip functions potentially sleep.
2949 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
2951 VALIDATE_DESC_VOID(desc);
2952 /* Should be using gpiod_set_raw_value_cansleep() */
2953 WARN_ON(desc->gdev->chip->can_sleep);
2954 gpiod_set_raw_value_commit(desc, value);
2956 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
2959 * gpiod_set_value_nocheck() - set a GPIO line value without checking
2960 * @desc: the descriptor to set the value on
2961 * @value: value to set
2963 * This sets the value of a GPIO line backing a descriptor, applying
2964 * different semantic quirks like active low and open drain/source
2967 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
2969 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2971 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2972 gpio_set_open_drain_value_commit(desc, value);
2973 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2974 gpio_set_open_source_value_commit(desc, value);
2976 gpiod_set_raw_value_commit(desc, value);
2980 * gpiod_set_value() - assign a gpio's value
2981 * @desc: gpio whose value will be assigned
2982 * @value: value to assign
2984 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
2985 * OPEN_DRAIN and OPEN_SOURCE flags into account.
2987 * This function can be called from contexts where we cannot sleep, and will
2988 * complain if the GPIO chip functions potentially sleep.
2990 void gpiod_set_value(struct gpio_desc *desc, int value)
2992 VALIDATE_DESC_VOID(desc);
2993 /* Should be using gpiod_set_value_cansleep() */
2994 WARN_ON(desc->gdev->chip->can_sleep);
2995 gpiod_set_value_nocheck(desc, value);
2997 EXPORT_SYMBOL_GPL(gpiod_set_value);
3000 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
3001 * @array_size: number of elements in the descriptor array / value bitmap
3002 * @desc_array: array of GPIO descriptors whose values will be assigned
3003 * @array_info: information on applicability of fast bitmap processing path
3004 * @value_bitmap: bitmap of values to assign
3006 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3007 * without regard for their ACTIVE_LOW status.
3009 * This function can be called from contexts where we cannot sleep, and will
3010 * complain if the GPIO chip functions potentially sleep.
3012 int gpiod_set_raw_array_value(unsigned int array_size,
3013 struct gpio_desc **desc_array,
3014 struct gpio_array *array_info,
3015 unsigned long *value_bitmap)
3019 return gpiod_set_array_value_complex(true, false, array_size,
3020 desc_array, array_info, value_bitmap);
3022 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
3025 * gpiod_set_array_value() - assign values to an array of GPIOs
3026 * @array_size: number of elements in the descriptor array / value bitmap
3027 * @desc_array: array of GPIO descriptors whose values will be assigned
3028 * @array_info: information on applicability of fast bitmap processing path
3029 * @value_bitmap: bitmap of values to assign
3031 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3034 * This function can be called from contexts where we cannot sleep, and will
3035 * complain if the GPIO chip functions potentially sleep.
3037 int gpiod_set_array_value(unsigned int array_size,
3038 struct gpio_desc **desc_array,
3039 struct gpio_array *array_info,
3040 unsigned long *value_bitmap)
3044 return gpiod_set_array_value_complex(false, false, array_size,
3045 desc_array, array_info,
3048 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3051 * gpiod_cansleep() - report whether gpio value access may sleep
3052 * @desc: gpio to check
3055 int gpiod_cansleep(const struct gpio_desc *desc)
3057 VALIDATE_DESC(desc);
3058 return desc->gdev->chip->can_sleep;
3060 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3063 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3064 * @desc: gpio to set the consumer name on
3065 * @name: the new consumer name
3067 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3069 VALIDATE_DESC(desc);
3071 name = kstrdup_const(name, GFP_KERNEL);
3076 kfree_const(desc->label);
3077 desc_set_label(desc, name);
3081 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3084 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3085 * @desc: gpio whose IRQ will be returned (already requested)
3087 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3090 int gpiod_to_irq(const struct gpio_desc *desc)
3092 struct gpio_chip *gc;
3096 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3097 * requires this function to not return zero on an invalid descriptor
3098 * but rather a negative error number.
3100 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3103 gc = desc->gdev->chip;
3104 offset = gpio_chip_hwgpio(desc);
3106 int retirq = gc->to_irq(gc, offset);
3108 /* Zero means NO_IRQ */
3116 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3119 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3120 * @gc: the chip the GPIO to lock belongs to
3121 * @offset: the offset of the GPIO to lock as IRQ
3123 * This is used directly by GPIO drivers that want to lock down
3124 * a certain GPIO line to be used for IRQs.
3126 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3128 struct gpio_desc *desc;
3130 desc = gpiochip_get_desc(gc, offset);
3132 return PTR_ERR(desc);
3135 * If it's fast: flush the direction setting if something changed
3138 if (!gc->can_sleep && gc->get_direction) {
3139 int dir = gpiod_get_direction(desc);
3142 chip_err(gc, "%s: cannot get GPIO direction\n",
3148 /* To be valid for IRQ the line needs to be input or open drain */
3149 if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3150 !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3152 "%s: tried to flag a GPIO set as output for IRQ\n",
3157 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3158 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3161 * If the consumer has not set up a label (such as when the
3162 * IRQ is referenced from .to_irq()) we set up a label here
3163 * so it is clear this is used as an interrupt.
3166 desc_set_label(desc, "interrupt");
3170 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3173 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3174 * @gc: the chip the GPIO to lock belongs to
3175 * @offset: the offset of the GPIO to lock as IRQ
3177 * This is used directly by GPIO drivers that want to indicate
3178 * that a certain GPIO is no longer used exclusively for IRQ.
3180 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3182 struct gpio_desc *desc;
3184 desc = gpiochip_get_desc(gc, offset);
3188 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3189 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3191 /* If we only had this marking, erase it */
3192 if (desc->label && !strcmp(desc->label, "interrupt"))
3193 desc_set_label(desc, NULL);
3195 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3197 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3199 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3201 if (!IS_ERR(desc) &&
3202 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3203 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3205 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3207 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3209 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3211 if (!IS_ERR(desc) &&
3212 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3214 * We must not be output when using IRQ UNLESS we are
3217 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3218 !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3219 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3222 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3224 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3226 if (offset >= gc->ngpio)
3229 return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3231 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3233 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3237 if (!try_module_get(gc->gpiodev->owner))
3240 ret = gpiochip_lock_as_irq(gc, offset);
3242 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3243 module_put(gc->gpiodev->owner);
3248 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3250 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3252 gpiochip_unlock_as_irq(gc, offset);
3253 module_put(gc->gpiodev->owner);
3255 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3257 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3259 if (offset >= gc->ngpio)
3262 return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3264 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3266 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3268 if (offset >= gc->ngpio)
3271 return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3273 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3275 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3277 if (offset >= gc->ngpio)
3280 return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3282 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3285 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3286 * @desc: gpio whose value will be returned
3288 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3289 * its ACTIVE_LOW status, or negative errno on failure.
3291 * This function is to be called from contexts that can sleep.
3293 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3295 might_sleep_if(extra_checks);
3296 VALIDATE_DESC(desc);
3297 return gpiod_get_raw_value_commit(desc);
3299 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3302 * gpiod_get_value_cansleep() - return a gpio's value
3303 * @desc: gpio whose value will be returned
3305 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3306 * account, or negative errno on failure.
3308 * This function is to be called from contexts that can sleep.
3310 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3314 might_sleep_if(extra_checks);
3315 VALIDATE_DESC(desc);
3316 value = gpiod_get_raw_value_commit(desc);
3320 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3325 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3328 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3329 * @array_size: number of elements in the descriptor array / value bitmap
3330 * @desc_array: array of GPIO descriptors whose values will be read
3331 * @array_info: information on applicability of fast bitmap processing path
3332 * @value_bitmap: bitmap to store the read values
3334 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3335 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3336 * else an error code.
3338 * This function is to be called from contexts that can sleep.
3340 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3341 struct gpio_desc **desc_array,
3342 struct gpio_array *array_info,
3343 unsigned long *value_bitmap)
3345 might_sleep_if(extra_checks);
3348 return gpiod_get_array_value_complex(true, true, array_size,
3349 desc_array, array_info,
3352 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3355 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3356 * @array_size: number of elements in the descriptor array / value bitmap
3357 * @desc_array: array of GPIO descriptors whose values will be read
3358 * @array_info: information on applicability of fast bitmap processing path
3359 * @value_bitmap: bitmap to store the read values
3361 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3362 * into account. Return 0 in case of success, else an error code.
3364 * This function is to be called from contexts that can sleep.
3366 int gpiod_get_array_value_cansleep(unsigned int array_size,
3367 struct gpio_desc **desc_array,
3368 struct gpio_array *array_info,
3369 unsigned long *value_bitmap)
3371 might_sleep_if(extra_checks);
3374 return gpiod_get_array_value_complex(false, true, array_size,
3375 desc_array, array_info,
3378 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3381 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3382 * @desc: gpio whose value will be assigned
3383 * @value: value to assign
3385 * Set the raw value of the GPIO, i.e. the value of its physical line without
3386 * regard for its ACTIVE_LOW status.
3388 * This function is to be called from contexts that can sleep.
3390 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3392 might_sleep_if(extra_checks);
3393 VALIDATE_DESC_VOID(desc);
3394 gpiod_set_raw_value_commit(desc, value);
3396 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3399 * gpiod_set_value_cansleep() - assign a gpio's value
3400 * @desc: gpio whose value will be assigned
3401 * @value: value to assign
3403 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3406 * This function is to be called from contexts that can sleep.
3408 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3410 might_sleep_if(extra_checks);
3411 VALIDATE_DESC_VOID(desc);
3412 gpiod_set_value_nocheck(desc, value);
3414 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3417 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3418 * @array_size: number of elements in the descriptor array / value bitmap
3419 * @desc_array: array of GPIO descriptors whose values will be assigned
3420 * @array_info: information on applicability of fast bitmap processing path
3421 * @value_bitmap: bitmap of values to assign
3423 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3424 * without regard for their ACTIVE_LOW status.
3426 * This function is to be called from contexts that can sleep.
3428 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3429 struct gpio_desc **desc_array,
3430 struct gpio_array *array_info,
3431 unsigned long *value_bitmap)
3433 might_sleep_if(extra_checks);
3436 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3437 array_info, value_bitmap);
3439 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3442 * gpiod_add_lookup_tables() - register GPIO device consumers
3443 * @tables: list of tables of consumers to register
3444 * @n: number of tables in the list
3446 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3450 mutex_lock(&gpio_lookup_lock);
3452 for (i = 0; i < n; i++)
3453 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3455 mutex_unlock(&gpio_lookup_lock);
3459 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3460 * @array_size: number of elements in the descriptor array / value bitmap
3461 * @desc_array: array of GPIO descriptors whose values will be assigned
3462 * @array_info: information on applicability of fast bitmap processing path
3463 * @value_bitmap: bitmap of values to assign
3465 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3468 * This function is to be called from contexts that can sleep.
3470 int gpiod_set_array_value_cansleep(unsigned int array_size,
3471 struct gpio_desc **desc_array,
3472 struct gpio_array *array_info,
3473 unsigned long *value_bitmap)
3475 might_sleep_if(extra_checks);
3478 return gpiod_set_array_value_complex(false, true, array_size,
3479 desc_array, array_info,
3482 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3485 * gpiod_add_lookup_table() - register GPIO device consumers
3486 * @table: table of consumers to register
3488 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3490 mutex_lock(&gpio_lookup_lock);
3492 list_add_tail(&table->list, &gpio_lookup_list);
3494 mutex_unlock(&gpio_lookup_lock);
3496 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3499 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3500 * @table: table of consumers to unregister
3502 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3504 /* Nothing to remove */
3508 mutex_lock(&gpio_lookup_lock);
3510 list_del(&table->list);
3512 mutex_unlock(&gpio_lookup_lock);
3514 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3517 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3518 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3520 void gpiod_add_hogs(struct gpiod_hog *hogs)
3522 struct gpio_chip *gc;
3523 struct gpiod_hog *hog;
3525 mutex_lock(&gpio_machine_hogs_mutex);
3527 for (hog = &hogs[0]; hog->chip_label; hog++) {
3528 list_add_tail(&hog->list, &gpio_machine_hogs);
3531 * The chip may have been registered earlier, so check if it
3532 * exists and, if so, try to hog the line now.
3534 gc = find_chip_by_name(hog->chip_label);
3536 gpiochip_machine_hog(gc, hog);
3539 mutex_unlock(&gpio_machine_hogs_mutex);
3541 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3543 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3545 const char *dev_id = dev ? dev_name(dev) : NULL;
3546 struct gpiod_lookup_table *table;
3548 mutex_lock(&gpio_lookup_lock);
3550 list_for_each_entry(table, &gpio_lookup_list, list) {
3551 if (table->dev_id && dev_id) {
3553 * Valid strings on both ends, must be identical to have
3556 if (!strcmp(table->dev_id, dev_id))
3560 * One of the pointers is NULL, so both must be to have
3563 if (dev_id == table->dev_id)
3570 mutex_unlock(&gpio_lookup_lock);
3574 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3575 unsigned int idx, unsigned long *flags)
3577 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3578 struct gpiod_lookup_table *table;
3579 struct gpiod_lookup *p;
3581 table = gpiod_find_lookup_table(dev);
3585 for (p = &table->table[0]; p->key; p++) {
3586 struct gpio_chip *gc;
3588 /* idx must always match exactly */
3592 /* If the lookup entry has a con_id, require exact match */
3593 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3596 if (p->chip_hwnum == U16_MAX) {
3597 desc = gpio_name_to_desc(p->key);
3603 dev_warn(dev, "cannot find GPIO line %s, deferring\n",
3605 return ERR_PTR(-EPROBE_DEFER);
3608 gc = find_chip_by_name(p->key);
3612 * As the lookup table indicates a chip with
3613 * p->key should exist, assume it may
3614 * still appear later and let the interested
3615 * consumer be probed again or let the Deferred
3616 * Probe infrastructure handle the error.
3618 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3620 return ERR_PTR(-EPROBE_DEFER);
3623 if (gc->ngpio <= p->chip_hwnum) {
3625 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3626 idx, p->chip_hwnum, gc->ngpio - 1,
3628 return ERR_PTR(-EINVAL);
3631 desc = gpiochip_get_desc(gc, p->chip_hwnum);
3640 static int platform_gpio_count(struct device *dev, const char *con_id)
3642 struct gpiod_lookup_table *table;
3643 struct gpiod_lookup *p;
3644 unsigned int count = 0;
3646 table = gpiod_find_lookup_table(dev);
3650 for (p = &table->table[0]; p->key; p++) {
3651 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3652 (!con_id && !p->con_id))
3662 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3663 * @fwnode: handle of the firmware node
3664 * @con_id: function within the GPIO consumer
3665 * @index: index of the GPIO to obtain for the consumer
3666 * @flags: GPIO initialization flags
3667 * @label: label to attach to the requested GPIO
3669 * This function can be used for drivers that get their configuration
3670 * from opaque firmware.
3672 * The function properly finds the corresponding GPIO using whatever is the
3673 * underlying firmware interface and then makes sure that the GPIO
3674 * descriptor is requested before it is returned to the caller.
3677 * On successful request the GPIO pin is configured in accordance with
3680 * In case of error an ERR_PTR() is returned.
3682 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
3683 const char *con_id, int index,
3684 enum gpiod_flags flags,
3687 struct gpio_desc *desc;
3688 char prop_name[32]; /* 32 is max size of property name */
3691 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
3693 snprintf(prop_name, sizeof(prop_name), "%s-%s",
3694 con_id, gpio_suffixes[i]);
3696 snprintf(prop_name, sizeof(prop_name), "%s",
3699 desc = fwnode_get_named_gpiod(fwnode, prop_name, index, flags,
3701 if (!gpiod_not_found(desc))
3707 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
3710 * gpiod_count - return the number of GPIOs associated with a device / function
3711 * or -ENOENT if no GPIO has been assigned to the requested function
3712 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3713 * @con_id: function within the GPIO consumer
3715 int gpiod_count(struct device *dev, const char *con_id)
3717 const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
3718 int count = -ENOENT;
3720 if (is_of_node(fwnode))
3721 count = of_gpio_get_count(dev, con_id);
3722 else if (is_acpi_node(fwnode))
3723 count = acpi_gpio_count(dev, con_id);
3726 count = platform_gpio_count(dev, con_id);
3730 EXPORT_SYMBOL_GPL(gpiod_count);
3733 * gpiod_get - obtain a GPIO for a given GPIO function
3734 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3735 * @con_id: function within the GPIO consumer
3736 * @flags: optional GPIO initialization flags
3738 * Return the GPIO descriptor corresponding to the function con_id of device
3739 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
3740 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
3742 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
3743 enum gpiod_flags flags)
3745 return gpiod_get_index(dev, con_id, 0, flags);
3747 EXPORT_SYMBOL_GPL(gpiod_get);
3750 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
3751 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3752 * @con_id: function within the GPIO consumer
3753 * @flags: optional GPIO initialization flags
3755 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
3756 * the requested function it will return NULL. This is convenient for drivers
3757 * that need to handle optional GPIOs.
3759 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
3761 enum gpiod_flags flags)
3763 return gpiod_get_index_optional(dev, con_id, 0, flags);
3765 EXPORT_SYMBOL_GPL(gpiod_get_optional);
3769 * gpiod_configure_flags - helper function to configure a given GPIO
3770 * @desc: gpio whose value will be assigned
3771 * @con_id: function within the GPIO consumer
3772 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
3773 * of_find_gpio() or of_get_gpio_hog()
3774 * @dflags: gpiod_flags - optional GPIO initialization flags
3776 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
3777 * requested function and/or index, or another IS_ERR() code if an error
3778 * occurred while trying to acquire the GPIO.
3780 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
3781 unsigned long lflags, enum gpiod_flags dflags)
3785 if (lflags & GPIO_ACTIVE_LOW)
3786 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
3788 if (lflags & GPIO_OPEN_DRAIN)
3789 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3790 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
3792 * This enforces open drain mode from the consumer side.
3793 * This is necessary for some busses like I2C, but the lookup
3794 * should *REALLY* have specified them as open drain in the
3795 * first place, so print a little warning here.
3797 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
3799 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
3802 if (lflags & GPIO_OPEN_SOURCE)
3803 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
3805 if ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) {
3807 "both pull-up and pull-down enabled, invalid configuration\n");
3811 if (lflags & GPIO_PULL_UP)
3812 set_bit(FLAG_PULL_UP, &desc->flags);
3813 else if (lflags & GPIO_PULL_DOWN)
3814 set_bit(FLAG_PULL_DOWN, &desc->flags);
3816 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
3820 /* No particular flag request, return here... */
3821 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
3822 gpiod_dbg(desc, "no flags found for %s\n", con_id);
3827 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
3828 ret = gpiod_direction_output(desc,
3829 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
3831 ret = gpiod_direction_input(desc);
3837 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
3838 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3839 * @con_id: function within the GPIO consumer
3840 * @idx: index of the GPIO to obtain in the consumer
3841 * @flags: optional GPIO initialization flags
3843 * This variant of gpiod_get() allows to access GPIOs other than the first
3844 * defined one for functions that define several GPIOs.
3846 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
3847 * requested function and/or index, or another IS_ERR() code if an error
3848 * occurred while trying to acquire the GPIO.
3850 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
3853 enum gpiod_flags flags)
3855 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3856 struct gpio_desc *desc = NULL;
3858 /* Maybe we have a device name, maybe not */
3859 const char *devname = dev ? dev_name(dev) : "?";
3860 const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
3862 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
3864 /* Using device tree? */
3865 if (is_of_node(fwnode)) {
3866 dev_dbg(dev, "using device tree for GPIO lookup\n");
3867 desc = of_find_gpio(dev, con_id, idx, &lookupflags);
3868 } else if (is_acpi_node(fwnode)) {
3869 dev_dbg(dev, "using ACPI for GPIO lookup\n");
3870 desc = acpi_find_gpio(dev, con_id, idx, &flags, &lookupflags);
3874 * Either we are not using DT or ACPI, or their lookup did not return
3875 * a result. In that case, use platform lookup as a fallback.
3877 if (!desc || gpiod_not_found(desc)) {
3878 dev_dbg(dev, "using lookup tables for GPIO lookup\n");
3879 desc = gpiod_find(dev, con_id, idx, &lookupflags);
3883 dev_dbg(dev, "No GPIO consumer %s found\n", con_id);
3888 * If a connection label was passed use that, else attempt to use
3889 * the device name as label
3891 ret = gpiod_request(desc, con_id ? con_id : devname);
3893 if (ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE) {
3895 * This happens when there are several consumers for
3896 * the same GPIO line: we just return here without
3897 * further initialization. It is a bit if a hack.
3898 * This is necessary to support fixed regulators.
3900 * FIXME: Make this more sane and safe.
3902 dev_info(dev, "nonexclusive access to GPIO for %s\n",
3903 con_id ? con_id : devname);
3906 return ERR_PTR(ret);
3910 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3912 dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
3914 return ERR_PTR(ret);
3917 blocking_notifier_call_chain(&desc->gdev->notifier,
3918 GPIOLINE_CHANGED_REQUESTED, desc);
3922 EXPORT_SYMBOL_GPL(gpiod_get_index);
3925 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
3926 * @fwnode: handle of the firmware node
3927 * @propname: name of the firmware property representing the GPIO
3928 * @index: index of the GPIO to obtain for the consumer
3929 * @dflags: GPIO initialization flags
3930 * @label: label to attach to the requested GPIO
3932 * This function can be used for drivers that get their configuration
3933 * from opaque firmware.
3935 * The function properly finds the corresponding GPIO using whatever is the
3936 * underlying firmware interface and then makes sure that the GPIO
3937 * descriptor is requested before it is returned to the caller.
3940 * On successful request the GPIO pin is configured in accordance with
3943 * In case of error an ERR_PTR() is returned.
3945 struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
3946 const char *propname, int index,
3947 enum gpiod_flags dflags,
3950 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3951 struct gpio_desc *desc = ERR_PTR(-ENODEV);
3954 if (is_of_node(fwnode)) {
3955 desc = gpiod_get_from_of_node(to_of_node(fwnode),
3960 } else if (is_acpi_node(fwnode)) {
3961 struct acpi_gpio_info info;
3963 desc = acpi_node_get_gpiod(fwnode, propname, index, &info);
3967 acpi_gpio_update_gpiod_flags(&dflags, &info);
3968 acpi_gpio_update_gpiod_lookup_flags(&lflags, &info);
3970 return ERR_PTR(-EINVAL);
3972 /* Currently only ACPI takes this path */
3973 ret = gpiod_request(desc, label);
3975 return ERR_PTR(ret);
3977 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
3980 return ERR_PTR(ret);
3983 blocking_notifier_call_chain(&desc->gdev->notifier,
3984 GPIOLINE_CHANGED_REQUESTED, desc);
3988 EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);
3991 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
3993 * @dev: GPIO consumer, can be NULL for system-global GPIOs
3994 * @con_id: function within the GPIO consumer
3995 * @index: index of the GPIO to obtain in the consumer
3996 * @flags: optional GPIO initialization flags
3998 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
3999 * specified index was assigned to the requested function it will return NULL.
4000 * This is convenient for drivers that need to handle optional GPIOs.
4002 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
4005 enum gpiod_flags flags)
4007 struct gpio_desc *desc;
4009 desc = gpiod_get_index(dev, con_id, index, flags);
4010 if (gpiod_not_found(desc))
4015 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
4018 * gpiod_hog - Hog the specified GPIO desc given the provided flags
4019 * @desc: gpio whose value will be assigned
4020 * @name: gpio line name
4021 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4022 * of_find_gpio() or of_get_gpio_hog()
4023 * @dflags: gpiod_flags - optional GPIO initialization flags
4025 int gpiod_hog(struct gpio_desc *desc, const char *name,
4026 unsigned long lflags, enum gpiod_flags dflags)
4028 struct gpio_chip *gc;
4029 struct gpio_desc *local_desc;
4033 gc = gpiod_to_chip(desc);
4034 hwnum = gpio_chip_hwgpio(desc);
4036 local_desc = gpiochip_request_own_desc(gc, hwnum, name,
4038 if (IS_ERR(local_desc)) {
4039 ret = PTR_ERR(local_desc);
4040 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4041 name, gc->label, hwnum, ret);
4045 /* Mark GPIO as hogged so it can be identified and removed later */
4046 set_bit(FLAG_IS_HOGGED, &desc->flags);
4048 gpiod_info(desc, "hogged as %s%s\n",
4049 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4050 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4051 (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4057 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4058 * @gc: gpio chip to act on
4060 static void gpiochip_free_hogs(struct gpio_chip *gc)
4064 for (id = 0; id < gc->ngpio; id++) {
4065 if (test_bit(FLAG_IS_HOGGED, &gc->gpiodev->descs[id].flags))
4066 gpiochip_free_own_desc(&gc->gpiodev->descs[id]);
4071 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4072 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4073 * @con_id: function within the GPIO consumer
4074 * @flags: optional GPIO initialization flags
4076 * This function acquires all the GPIOs defined under a given function.
4078 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4079 * no GPIO has been assigned to the requested function, or another IS_ERR()
4080 * code if an error occurred while trying to acquire the GPIOs.
4082 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4084 enum gpiod_flags flags)
4086 struct gpio_desc *desc;
4087 struct gpio_descs *descs;
4088 struct gpio_array *array_info = NULL;
4089 struct gpio_chip *gc;
4090 int count, bitmap_size;
4092 count = gpiod_count(dev, con_id);
4094 return ERR_PTR(count);
4096 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4098 return ERR_PTR(-ENOMEM);
4100 for (descs->ndescs = 0; descs->ndescs < count; ) {
4101 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4103 gpiod_put_array(descs);
4104 return ERR_CAST(desc);
4107 descs->desc[descs->ndescs] = desc;
4109 gc = gpiod_to_chip(desc);
4111 * If pin hardware number of array member 0 is also 0, select
4112 * its chip as a candidate for fast bitmap processing path.
4114 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4115 struct gpio_descs *array;
4117 bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4120 array = kzalloc(struct_size(descs, desc, count) +
4121 struct_size(array_info, invert_mask,
4122 3 * bitmap_size), GFP_KERNEL);
4124 gpiod_put_array(descs);
4125 return ERR_PTR(-ENOMEM);
4128 memcpy(array, descs,
4129 struct_size(descs, desc, descs->ndescs + 1));
4133 array_info = (void *)(descs->desc + count);
4134 array_info->get_mask = array_info->invert_mask +
4136 array_info->set_mask = array_info->get_mask +
4139 array_info->desc = descs->desc;
4140 array_info->size = count;
4141 array_info->chip = gc;
4142 bitmap_set(array_info->get_mask, descs->ndescs,
4143 count - descs->ndescs);
4144 bitmap_set(array_info->set_mask, descs->ndescs,
4145 count - descs->ndescs);
4146 descs->info = array_info;
4148 /* Unmark array members which don't belong to the 'fast' chip */
4149 if (array_info && array_info->chip != gc) {
4150 __clear_bit(descs->ndescs, array_info->get_mask);
4151 __clear_bit(descs->ndescs, array_info->set_mask);
4154 * Detect array members which belong to the 'fast' chip
4155 * but their pins are not in hardware order.
4157 else if (array_info &&
4158 gpio_chip_hwgpio(desc) != descs->ndescs) {
4160 * Don't use fast path if all array members processed so
4161 * far belong to the same chip as this one but its pin
4162 * hardware number is different from its array index.
4164 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4167 __clear_bit(descs->ndescs,
4168 array_info->get_mask);
4169 __clear_bit(descs->ndescs,
4170 array_info->set_mask);
4172 } else if (array_info) {
4173 /* Exclude open drain or open source from fast output */
4174 if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4175 gpiochip_line_is_open_source(gc, descs->ndescs))
4176 __clear_bit(descs->ndescs,
4177 array_info->set_mask);
4178 /* Identify 'fast' pins which require invertion */
4179 if (gpiod_is_active_low(desc))
4180 __set_bit(descs->ndescs,
4181 array_info->invert_mask);
4188 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4189 array_info->chip->label, array_info->size,
4190 *array_info->get_mask, *array_info->set_mask,
4191 *array_info->invert_mask);
4194 EXPORT_SYMBOL_GPL(gpiod_get_array);
4197 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4199 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4200 * @con_id: function within the GPIO consumer
4201 * @flags: optional GPIO initialization flags
4203 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4204 * assigned to the requested function it will return NULL.
4206 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4208 enum gpiod_flags flags)
4210 struct gpio_descs *descs;
4212 descs = gpiod_get_array(dev, con_id, flags);
4213 if (gpiod_not_found(descs))
4218 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4221 * gpiod_put - dispose of a GPIO descriptor
4222 * @desc: GPIO descriptor to dispose of
4224 * No descriptor can be used after gpiod_put() has been called on it.
4226 void gpiod_put(struct gpio_desc *desc)
4231 EXPORT_SYMBOL_GPL(gpiod_put);
4234 * gpiod_put_array - dispose of multiple GPIO descriptors
4235 * @descs: struct gpio_descs containing an array of descriptors
4237 void gpiod_put_array(struct gpio_descs *descs)
4241 for (i = 0; i < descs->ndescs; i++)
4242 gpiod_put(descs->desc[i]);
4246 EXPORT_SYMBOL_GPL(gpiod_put_array);
4249 static int gpio_bus_match(struct device *dev, struct device_driver *drv)
4251 struct fwnode_handle *fwnode = dev_fwnode(dev);
4254 * Only match if the fwnode doesn't already have a proper struct device
4257 if (fwnode && fwnode->dev != dev)
4262 static int gpio_stub_drv_probe(struct device *dev)
4265 * The DT node of some GPIO chips have a "compatible" property, but
4266 * never have a struct device added and probed by a driver to register
4267 * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4268 * the consumers of the GPIO chip to get probe deferred forever because
4269 * they will be waiting for a device associated with the GPIO chip
4270 * firmware node to get added and bound to a driver.
4272 * To allow these consumers to probe, we associate the struct
4273 * gpio_device of the GPIO chip with the firmware node and then simply
4274 * bind it to this stub driver.
4279 static struct device_driver gpio_stub_drv = {
4280 .name = "gpio_stub_drv",
4281 .bus = &gpio_bus_type,
4282 .probe = gpio_stub_drv_probe,
4285 static int __init gpiolib_dev_init(void)
4289 /* Register GPIO sysfs bus */
4290 ret = bus_register(&gpio_bus_type);
4292 pr_err("gpiolib: could not register GPIO bus type\n");
4296 ret = driver_register(&gpio_stub_drv);
4298 pr_err("gpiolib: could not register GPIO stub driver\n");
4299 bus_unregister(&gpio_bus_type);
4303 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4305 pr_err("gpiolib: failed to allocate char dev region\n");
4306 driver_unregister(&gpio_stub_drv);
4307 bus_unregister(&gpio_bus_type);
4311 gpiolib_initialized = true;
4312 gpiochip_setup_devs();
4314 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4315 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4316 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4320 core_initcall(gpiolib_dev_init);
4322 #ifdef CONFIG_DEBUG_FS
4324 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4327 struct gpio_chip *gc = gdev->chip;
4328 unsigned gpio = gdev->base;
4329 struct gpio_desc *gdesc = &gdev->descs[0];
4334 for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
4335 if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
4337 seq_printf(s, " gpio-%-3d (%-20.20s)\n",
4343 gpiod_get_direction(gdesc);
4344 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
4345 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
4346 active_low = test_bit(FLAG_ACTIVE_LOW, &gdesc->flags);
4347 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s",
4348 gpio, gdesc->name ? gdesc->name : "", gdesc->label,
4349 is_out ? "out" : "in ",
4350 gc->get ? (gc->get(gc, i) ? "hi" : "lo") : "? ",
4351 is_irq ? "IRQ " : "",
4352 active_low ? "ACTIVE LOW" : "");
4353 seq_printf(s, "\n");
4357 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4359 unsigned long flags;
4360 struct gpio_device *gdev = NULL;
4361 loff_t index = *pos;
4365 spin_lock_irqsave(&gpio_lock, flags);
4366 list_for_each_entry(gdev, &gpio_devices, list)
4368 spin_unlock_irqrestore(&gpio_lock, flags);
4371 spin_unlock_irqrestore(&gpio_lock, flags);
4376 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4378 unsigned long flags;
4379 struct gpio_device *gdev = v;
4382 spin_lock_irqsave(&gpio_lock, flags);
4383 if (list_is_last(&gdev->list, &gpio_devices))
4386 ret = list_entry(gdev->list.next, struct gpio_device, list);
4387 spin_unlock_irqrestore(&gpio_lock, flags);
4395 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4399 static int gpiolib_seq_show(struct seq_file *s, void *v)
4401 struct gpio_device *gdev = v;
4402 struct gpio_chip *gc = gdev->chip;
4403 struct device *parent;
4406 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4407 dev_name(&gdev->dev));
4411 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4412 dev_name(&gdev->dev),
4413 gdev->base, gdev->base + gdev->ngpio - 1);
4414 parent = gc->parent;
4416 seq_printf(s, ", parent: %s/%s",
4417 parent->bus ? parent->bus->name : "no-bus",
4420 seq_printf(s, ", %s", gc->label);
4422 seq_printf(s, ", can sleep");
4423 seq_printf(s, ":\n");
4426 gc->dbg_show(s, gc);
4428 gpiolib_dbg_show(s, gdev);
4433 static const struct seq_operations gpiolib_sops = {
4434 .start = gpiolib_seq_start,
4435 .next = gpiolib_seq_next,
4436 .stop = gpiolib_seq_stop,
4437 .show = gpiolib_seq_show,
4439 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4441 static int __init gpiolib_debugfs_init(void)
4443 /* /sys/kernel/debug/gpio */
4444 debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4447 subsys_initcall(gpiolib_debugfs_init);
4449 #endif /* DEBUG_FS */