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-swnode.h"
30 #include "gpiolib-cdev.h"
31 #include "gpiolib-sysfs.h"
33 #define CREATE_TRACE_POINTS
34 #include <trace/events/gpio.h>
36 /* Implementation infrastructure for GPIO interfaces.
38 * The GPIO programming interface allows for inlining speed-critical
39 * get/set operations for common cases, so that access to SOC-integrated
40 * GPIOs can sometimes cost only an instruction or two per bit.
44 /* When debugging, extend minimal trust to callers and platform code.
45 * Also emit diagnostic messages that may help initial bringup, when
46 * board setup or driver bugs are most common.
48 * Otherwise, minimize overhead in what may be bitbanging codepaths.
51 #define extra_checks 1
53 #define extra_checks 0
56 /* Device and char device-related information */
57 static DEFINE_IDA(gpio_ida);
58 static dev_t gpio_devt;
59 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
60 static int gpio_bus_match(struct device *dev, struct device_driver *drv);
61 static struct bus_type gpio_bus_type = {
63 .match = gpio_bus_match,
67 * Number of GPIOs to use for the fast path in set array
69 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
71 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
72 * While any GPIO is requested, its gpio_chip is not removable;
73 * each GPIO's "requested" flag serves as a lock and refcount.
75 DEFINE_SPINLOCK(gpio_lock);
77 static DEFINE_MUTEX(gpio_lookup_lock);
78 static LIST_HEAD(gpio_lookup_list);
79 LIST_HEAD(gpio_devices);
81 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
82 static LIST_HEAD(gpio_machine_hogs);
84 static void gpiochip_free_hogs(struct gpio_chip *gc);
85 static int gpiochip_add_irqchip(struct gpio_chip *gc,
86 struct lock_class_key *lock_key,
87 struct lock_class_key *request_key);
88 static void gpiochip_irqchip_remove(struct gpio_chip *gc);
89 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc);
90 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc);
91 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc);
93 static bool gpiolib_initialized;
95 static inline void desc_set_label(struct gpio_desc *d, const char *label)
101 * gpio_to_desc - Convert a GPIO number to its descriptor
102 * @gpio: global GPIO number
105 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
106 * with the given number exists in the system.
108 struct gpio_desc *gpio_to_desc(unsigned gpio)
110 struct gpio_device *gdev;
113 spin_lock_irqsave(&gpio_lock, flags);
115 list_for_each_entry(gdev, &gpio_devices, list) {
116 if (gdev->base <= gpio &&
117 gdev->base + gdev->ngpio > gpio) {
118 spin_unlock_irqrestore(&gpio_lock, flags);
119 return &gdev->descs[gpio - gdev->base];
123 spin_unlock_irqrestore(&gpio_lock, flags);
125 if (!gpio_is_valid(gpio))
126 pr_warn("invalid GPIO %d\n", gpio);
130 EXPORT_SYMBOL_GPL(gpio_to_desc);
133 * gpiochip_get_desc - get the GPIO descriptor corresponding to the given
134 * hardware number for this chip
136 * @hwnum: hardware number of the GPIO for this chip
139 * A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists
140 * in the given chip for the specified hardware number.
142 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc,
145 struct gpio_device *gdev = gc->gpiodev;
147 if (hwnum >= gdev->ngpio)
148 return ERR_PTR(-EINVAL);
150 return &gdev->descs[hwnum];
152 EXPORT_SYMBOL_GPL(gpiochip_get_desc);
155 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
156 * @desc: GPIO descriptor
158 * This should disappear in the future but is needed since we still
159 * use GPIO numbers for error messages and sysfs nodes.
162 * The global GPIO number for the GPIO specified by its descriptor.
164 int desc_to_gpio(const struct gpio_desc *desc)
166 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
168 EXPORT_SYMBOL_GPL(desc_to_gpio);
172 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
173 * @desc: descriptor to return the chip of
175 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
177 if (!desc || !desc->gdev)
179 return desc->gdev->chip;
181 EXPORT_SYMBOL_GPL(gpiod_to_chip);
183 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
184 static int gpiochip_find_base(int ngpio)
186 struct gpio_device *gdev;
187 int base = GPIO_DYNAMIC_BASE;
189 list_for_each_entry(gdev, &gpio_devices, list) {
190 /* found a free space? */
191 if (gdev->base >= base + ngpio)
193 /* nope, check the space right after the chip */
194 base = gdev->base + gdev->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_first_entry(&gpio_devices, 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_last_entry(&gpio_devices, 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);
296 * Convert a GPIO name to its descriptor
297 * Note that there is no guarantee that GPIO names are globally unique!
298 * Hence this function will return, if it exists, a reference to the first GPIO
299 * line found that matches the given name.
301 static struct gpio_desc *gpio_name_to_desc(const char * const name)
303 struct gpio_device *gdev;
309 spin_lock_irqsave(&gpio_lock, flags);
311 list_for_each_entry(gdev, &gpio_devices, list) {
312 struct gpio_desc *desc;
314 for_each_gpio_desc(gdev->chip, desc) {
315 if (desc->name && !strcmp(desc->name, name)) {
316 spin_unlock_irqrestore(&gpio_lock, flags);
322 spin_unlock_irqrestore(&gpio_lock, flags);
328 * Take the names from gc->names and assign them to their GPIO descriptors.
329 * Warn if a name is already used for a GPIO line on a different GPIO chip.
332 * 1. Non-unique names are still accepted,
333 * 2. Name collisions within the same GPIO chip are not reported.
335 static int gpiochip_set_desc_names(struct gpio_chip *gc)
337 struct gpio_device *gdev = gc->gpiodev;
340 /* First check all names if they are unique */
341 for (i = 0; i != gc->ngpio; ++i) {
342 struct gpio_desc *gpio;
344 gpio = gpio_name_to_desc(gc->names[i]);
347 "Detected name collision for GPIO name '%s'\n",
351 /* Then add all names to the GPIO descriptors */
352 for (i = 0; i != gc->ngpio; ++i)
353 gdev->descs[i].name = gc->names[i];
359 * devprop_gpiochip_set_names - Set GPIO line names using device properties
360 * @chip: GPIO chip whose lines should be named, if possible
362 * Looks for device property "gpio-line-names" and if it exists assigns
363 * GPIO line names for the chip. The memory allocated for the assigned
364 * names belong to the underlying firmware node and should not be released
367 static int devprop_gpiochip_set_names(struct gpio_chip *chip)
369 struct gpio_device *gdev = chip->gpiodev;
370 struct device *dev = &gdev->dev;
375 count = device_property_string_array_count(dev, "gpio-line-names");
380 * When offset is set in the driver side we assume the driver internally
381 * is using more than one gpiochip per the same device. We have to stop
382 * setting friendly names if the specified ones with 'gpio-line-names'
383 * are less than the offset in the device itself. This means all the
384 * lines are not present for every single pin within all the internal
387 if (count <= chip->offset) {
388 dev_warn(dev, "gpio-line-names too short (length %d), cannot map names for the gpiochip at offset %u\n",
389 count, chip->offset);
393 names = kcalloc(count, sizeof(*names), GFP_KERNEL);
397 ret = device_property_read_string_array(dev, "gpio-line-names",
400 dev_warn(dev, "failed to read GPIO line names\n");
406 * When more that one gpiochip per device is used, 'count' can
407 * contain at most number gpiochips x chip->ngpio. We have to
408 * correctly distribute all defined lines taking into account
409 * chip->offset as starting point from where we will assign
410 * the names to pins from the 'names' array. Since property
411 * 'gpio-line-names' cannot contains gaps, we have to be sure
412 * we only assign those pins that really exists since chip->ngpio
413 * can be different of the chip->offset.
415 count = (count > chip->offset) ? count - chip->offset : count;
416 if (count > chip->ngpio)
419 for (i = 0; i < count; i++) {
421 * Allow overriding "fixed" names provided by the GPIO
422 * provider. The "fixed" names are more often than not
423 * generic and less informative than the names given in
426 if (names[chip->offset + i] && names[chip->offset + i][0])
427 gdev->descs[i].name = names[chip->offset + i];
435 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
439 p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
443 /* Assume by default all GPIOs are valid */
444 bitmap_fill(p, gc->ngpio);
449 static unsigned int gpiochip_count_reserved_ranges(struct gpio_chip *gc)
451 struct device *dev = &gc->gpiodev->dev;
454 /* Format is "start, count, ..." */
455 size = device_property_count_u32(dev, "gpio-reserved-ranges");
456 if (size > 0 && size % 2 == 0)
462 static int gpiochip_alloc_valid_mask(struct gpio_chip *gc)
464 if (!(gpiochip_count_reserved_ranges(gc) || gc->init_valid_mask))
467 gc->valid_mask = gpiochip_allocate_mask(gc);
474 static int gpiochip_apply_reserved_ranges(struct gpio_chip *gc)
476 struct device *dev = &gc->gpiodev->dev;
481 size = gpiochip_count_reserved_ranges(gc);
485 ranges = kmalloc_array(size, sizeof(*ranges), GFP_KERNEL);
489 ret = device_property_read_u32_array(dev, "gpio-reserved-ranges",
497 u32 count = ranges[--size];
498 u32 start = ranges[--size];
500 if (start >= gc->ngpio || start + count > gc->ngpio)
503 bitmap_clear(gc->valid_mask, start, count);
510 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
514 ret = gpiochip_apply_reserved_ranges(gc);
518 if (gc->init_valid_mask)
519 return gc->init_valid_mask(gc,
526 static void gpiochip_free_valid_mask(struct gpio_chip *gc)
528 bitmap_free(gc->valid_mask);
529 gc->valid_mask = NULL;
532 static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
534 if (gc->add_pin_ranges)
535 return gc->add_pin_ranges(gc);
540 bool gpiochip_line_is_valid(const struct gpio_chip *gc,
543 /* No mask means all valid */
544 if (likely(!gc->valid_mask))
546 return test_bit(offset, gc->valid_mask);
548 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
550 static void gpiodevice_release(struct device *dev)
552 struct gpio_device *gdev = to_gpio_device(dev);
555 spin_lock_irqsave(&gpio_lock, flags);
556 list_del(&gdev->list);
557 spin_unlock_irqrestore(&gpio_lock, flags);
559 ida_free(&gpio_ida, gdev->id);
560 kfree_const(gdev->label);
565 #ifdef CONFIG_GPIO_CDEV
566 #define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
567 #define gcdev_unregister(gdev) gpiolib_cdev_unregister((gdev))
570 * gpiolib_cdev_register() indirectly calls device_add(), which is still
571 * required even when cdev is not selected.
573 #define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
574 #define gcdev_unregister(gdev) device_del(&(gdev)->dev)
577 static int gpiochip_setup_dev(struct gpio_device *gdev)
581 ret = gcdev_register(gdev, gpio_devt);
585 /* From this point, the .release() function cleans up gpio_device */
586 gdev->dev.release = gpiodevice_release;
588 ret = gpiochip_sysfs_register(gdev);
590 goto err_remove_device;
592 dev_dbg(&gdev->dev, "registered GPIOs %d to %d on %s\n", gdev->base,
593 gdev->base + gdev->ngpio - 1, gdev->chip->label ? : "generic");
598 gcdev_unregister(gdev);
602 static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
604 struct gpio_desc *desc;
607 desc = gpiochip_get_desc(gc, hog->chip_hwnum);
609 chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
614 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
617 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
619 gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
620 __func__, gc->label, hog->chip_hwnum, rv);
623 static void machine_gpiochip_add(struct gpio_chip *gc)
625 struct gpiod_hog *hog;
627 mutex_lock(&gpio_machine_hogs_mutex);
629 list_for_each_entry(hog, &gpio_machine_hogs, list) {
630 if (!strcmp(gc->label, hog->chip_label))
631 gpiochip_machine_hog(gc, hog);
634 mutex_unlock(&gpio_machine_hogs_mutex);
637 static void gpiochip_setup_devs(void)
639 struct gpio_device *gdev;
642 list_for_each_entry(gdev, &gpio_devices, list) {
643 ret = gpiochip_setup_dev(gdev);
646 "Failed to initialize gpio device (%d)\n", ret);
650 int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
651 struct lock_class_key *lock_key,
652 struct lock_class_key *request_key)
654 struct fwnode_handle *fwnode = NULL;
655 struct gpio_device *gdev;
665 fwnode = dev_fwnode(gc->parent);
668 * First: allocate and populate the internal stat container, and
669 * set up the struct device.
671 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
674 gdev->dev.bus = &gpio_bus_type;
675 gdev->dev.parent = gc->parent;
679 of_gpio_dev_init(gc, gdev);
680 acpi_gpio_dev_init(gc, gdev);
683 * Assign fwnode depending on the result of the previous calls,
684 * if none of them succeed, assign it to the parent's one.
686 gc->fwnode = gdev->dev.fwnode = dev_fwnode(&gdev->dev) ?: fwnode;
688 gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
694 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
698 device_initialize(&gdev->dev);
699 if (gc->parent && gc->parent->driver)
700 gdev->owner = gc->parent->driver->owner;
702 /* TODO: remove chip->owner */
703 gdev->owner = gc->owner;
705 gdev->owner = THIS_MODULE;
708 * Try the device properties if the driver didn't supply the number
713 ret = device_property_read_u32(&gdev->dev, "ngpios", &ngpios);
716 * -ENODATA means that there is no property found and
717 * we want to issue the error message to the user.
718 * Besides that, we want to return different error code
719 * to state that supplied value is not valid.
723 goto err_free_dev_name;
728 if (gc->ngpio == 0) {
729 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
731 goto err_free_dev_name;
734 if (gc->ngpio > FASTPATH_NGPIO)
735 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
736 gc->ngpio, FASTPATH_NGPIO);
738 gdev->descs = kcalloc(gc->ngpio, sizeof(*gdev->descs), GFP_KERNEL);
741 goto err_free_dev_name;
744 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
750 gdev->ngpio = gc->ngpio;
753 spin_lock_irqsave(&gpio_lock, flags);
756 * TODO: this allocates a Linux GPIO number base in the global
757 * GPIO numberspace for this chip. In the long run we want to
758 * get *rid* of this numberspace and use only descriptors, but
759 * it may be a pipe dream. It will not happen before we get rid
760 * of the sysfs interface anyways.
764 base = gpiochip_find_base(gc->ngpio);
766 spin_unlock_irqrestore(&gpio_lock, flags);
772 * TODO: it should not be necessary to reflect the assigned
773 * base outside of the GPIO subsystem. Go over drivers and
774 * see if anyone makes use of this, else drop this and assign
780 "Static allocation of GPIO base is deprecated, use dynamic allocation.\n");
784 ret = gpiodev_add_to_list(gdev);
786 spin_unlock_irqrestore(&gpio_lock, flags);
787 chip_err(gc, "GPIO integer space overlap, cannot add chip\n");
791 for (i = 0; i < gc->ngpio; i++)
792 gdev->descs[i].gdev = gdev;
794 spin_unlock_irqrestore(&gpio_lock, flags);
796 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->notifier);
797 init_rwsem(&gdev->sem);
799 #ifdef CONFIG_PINCTRL
800 INIT_LIST_HEAD(&gdev->pin_ranges);
804 ret = gpiochip_set_desc_names(gc);
806 goto err_remove_from_list;
808 ret = devprop_gpiochip_set_names(gc);
810 goto err_remove_from_list;
812 ret = gpiochip_alloc_valid_mask(gc);
814 goto err_remove_from_list;
816 ret = of_gpiochip_add(gc);
818 goto err_free_gpiochip_mask;
820 ret = gpiochip_init_valid_mask(gc);
822 goto err_remove_of_chip;
824 for (i = 0; i < gc->ngpio; i++) {
825 struct gpio_desc *desc = &gdev->descs[i];
827 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
828 assign_bit(FLAG_IS_OUT,
829 &desc->flags, !gc->get_direction(gc, i));
831 assign_bit(FLAG_IS_OUT,
832 &desc->flags, !gc->direction_input);
836 ret = gpiochip_add_pin_ranges(gc);
838 goto err_remove_of_chip;
840 acpi_gpiochip_add(gc);
842 machine_gpiochip_add(gc);
844 ret = gpiochip_irqchip_init_valid_mask(gc);
846 goto err_remove_acpi_chip;
848 ret = gpiochip_irqchip_init_hw(gc);
850 goto err_remove_acpi_chip;
852 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
854 goto err_remove_irqchip_mask;
857 * By first adding the chardev, and then adding the device,
858 * we get a device node entry in sysfs under
859 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
860 * coldplug of device nodes and other udev business.
861 * We can do this only if gpiolib has been initialized.
862 * Otherwise, defer until later.
864 if (gpiolib_initialized) {
865 ret = gpiochip_setup_dev(gdev);
867 goto err_remove_irqchip;
872 gpiochip_irqchip_remove(gc);
873 err_remove_irqchip_mask:
874 gpiochip_irqchip_free_valid_mask(gc);
875 err_remove_acpi_chip:
876 acpi_gpiochip_remove(gc);
878 gpiochip_free_hogs(gc);
879 of_gpiochip_remove(gc);
880 err_free_gpiochip_mask:
881 gpiochip_remove_pin_ranges(gc);
882 gpiochip_free_valid_mask(gc);
883 if (gdev->dev.release) {
884 /* release() has been registered by gpiochip_setup_dev() */
885 put_device(&gdev->dev);
886 goto err_print_message;
888 err_remove_from_list:
889 spin_lock_irqsave(&gpio_lock, flags);
890 list_del(&gdev->list);
891 spin_unlock_irqrestore(&gpio_lock, flags);
893 kfree_const(gdev->label);
897 kfree(dev_name(&gdev->dev));
899 ida_free(&gpio_ida, gdev->id);
903 /* failures here can mean systems won't boot... */
904 if (ret != -EPROBE_DEFER) {
905 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
906 base, base + (int)ngpios - 1,
907 gc->label ? : "generic", ret);
911 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
914 * gpiochip_get_data() - get per-subdriver data for the chip
918 * The per-subdriver data for the chip.
920 void *gpiochip_get_data(struct gpio_chip *gc)
922 return gc->gpiodev->data;
924 EXPORT_SYMBOL_GPL(gpiochip_get_data);
927 * gpiochip_remove() - unregister a gpio_chip
928 * @gc: the chip to unregister
930 * A gpio_chip with any GPIOs still requested may not be removed.
932 void gpiochip_remove(struct gpio_chip *gc)
934 struct gpio_device *gdev = gc->gpiodev;
938 down_write(&gdev->sem);
940 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
941 gpiochip_sysfs_unregister(gdev);
942 gpiochip_free_hogs(gc);
943 /* Numb the device, cancelling all outstanding operations */
945 gpiochip_irqchip_remove(gc);
946 acpi_gpiochip_remove(gc);
947 of_gpiochip_remove(gc);
948 gpiochip_remove_pin_ranges(gc);
949 gpiochip_free_valid_mask(gc);
951 * We accept no more calls into the driver from this point, so
952 * NULL the driver data pointer
956 spin_lock_irqsave(&gpio_lock, flags);
957 for (i = 0; i < gdev->ngpio; i++) {
958 if (gpiochip_is_requested(gc, i))
961 spin_unlock_irqrestore(&gpio_lock, flags);
963 if (i != gdev->ngpio)
965 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
968 * The gpiochip side puts its use of the device to rest here:
969 * if there are no userspace clients, the chardev and device will
970 * be removed, else it will be dangling until the last user is
973 gcdev_unregister(gdev);
974 up_write(&gdev->sem);
975 put_device(&gdev->dev);
977 EXPORT_SYMBOL_GPL(gpiochip_remove);
980 * gpiochip_find() - iterator for locating a specific gpio_chip
981 * @data: data to pass to match function
982 * @match: Callback function to check gpio_chip
984 * Similar to bus_find_device. It returns a reference to a gpio_chip as
985 * determined by a user supplied @match callback. The callback should return
986 * 0 if the device doesn't match and non-zero if it does. If the callback is
987 * non-zero, this function will return to the caller and not iterate over any
990 struct gpio_chip *gpiochip_find(void *data,
991 int (*match)(struct gpio_chip *gc,
994 struct gpio_device *gdev;
995 struct gpio_chip *gc = NULL;
998 spin_lock_irqsave(&gpio_lock, flags);
999 list_for_each_entry(gdev, &gpio_devices, list)
1000 if (gdev->chip && match(gdev->chip, data)) {
1005 spin_unlock_irqrestore(&gpio_lock, flags);
1009 EXPORT_SYMBOL_GPL(gpiochip_find);
1011 static int gpiochip_match_name(struct gpio_chip *gc, void *data)
1013 const char *name = data;
1015 return !strcmp(gc->label, name);
1018 static struct gpio_chip *find_chip_by_name(const char *name)
1020 return gpiochip_find((void *)name, gpiochip_match_name);
1023 #ifdef CONFIG_GPIOLIB_IRQCHIP
1026 * The following is irqchip helper code for gpiochips.
1029 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1031 struct gpio_irq_chip *girq = &gc->irq;
1036 return girq->init_hw(gc);
1039 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1041 struct gpio_irq_chip *girq = &gc->irq;
1043 if (!girq->init_valid_mask)
1046 girq->valid_mask = gpiochip_allocate_mask(gc);
1047 if (!girq->valid_mask)
1050 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
1055 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1057 bitmap_free(gc->irq.valid_mask);
1058 gc->irq.valid_mask = NULL;
1061 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
1062 unsigned int offset)
1064 if (!gpiochip_line_is_valid(gc, offset))
1066 /* No mask means all valid */
1067 if (likely(!gc->irq.valid_mask))
1069 return test_bit(offset, gc->irq.valid_mask);
1071 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
1073 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1076 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
1078 * @gc: the gpiochip to set the irqchip hierarchical handler to
1079 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
1080 * will then percolate up to the parent
1082 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
1083 struct irq_chip *irqchip)
1085 /* DT will deal with mapping each IRQ as we go along */
1086 if (is_of_node(gc->irq.fwnode))
1090 * This is for legacy and boardfile "irqchip" fwnodes: allocate
1091 * irqs upfront instead of dynamically since we don't have the
1092 * dynamic type of allocation that hardware description languages
1093 * provide. Once all GPIO drivers using board files are gone from
1094 * the kernel we can delete this code, but for a transitional period
1095 * it is necessary to keep this around.
1097 if (is_fwnode_irqchip(gc->irq.fwnode)) {
1101 for (i = 0; i < gc->ngpio; i++) {
1102 struct irq_fwspec fwspec;
1103 unsigned int parent_hwirq;
1104 unsigned int parent_type;
1105 struct gpio_irq_chip *girq = &gc->irq;
1108 * We call the child to parent translation function
1109 * only to check if the child IRQ is valid or not.
1110 * Just pick the rising edge type here as that is what
1111 * we likely need to support.
1113 ret = girq->child_to_parent_hwirq(gc, i,
1114 IRQ_TYPE_EDGE_RISING,
1118 chip_err(gc, "skip set-up on hwirq %d\n",
1123 fwspec.fwnode = gc->irq.fwnode;
1124 /* This is the hwirq for the GPIO line side of things */
1125 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
1126 /* Just pick something */
1127 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
1128 fwspec.param_count = 2;
1129 ret = __irq_domain_alloc_irqs(gc->irq.domain,
1130 /* just pick something */
1139 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1146 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1151 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1152 struct irq_fwspec *fwspec,
1153 unsigned long *hwirq,
1156 /* We support standard DT translation */
1157 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1158 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1161 /* This is for board files and others not using DT */
1162 if (is_fwnode_irqchip(fwspec->fwnode)) {
1165 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1168 WARN_ON(*type == IRQ_TYPE_NONE);
1174 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1176 unsigned int nr_irqs,
1179 struct gpio_chip *gc = d->host_data;
1180 irq_hw_number_t hwirq;
1181 unsigned int type = IRQ_TYPE_NONE;
1182 struct irq_fwspec *fwspec = data;
1183 union gpio_irq_fwspec gpio_parent_fwspec = {};
1184 unsigned int parent_hwirq;
1185 unsigned int parent_type;
1186 struct gpio_irq_chip *girq = &gc->irq;
1190 * The nr_irqs parameter is always one except for PCI multi-MSI
1191 * so this should not happen.
1193 WARN_ON(nr_irqs != 1);
1195 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1199 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1201 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1202 &parent_hwirq, &parent_type);
1204 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1207 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1210 * We set handle_bad_irq because the .set_type() should
1211 * always be invoked and set the right type of handler.
1213 irq_domain_set_info(d,
1222 /* This parent only handles asserted level IRQs */
1223 ret = girq->populate_parent_alloc_arg(gc, &gpio_parent_fwspec,
1224 parent_hwirq, parent_type);
1228 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1230 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1231 ret = irq_domain_alloc_irqs_parent(d, irq, 1, &gpio_parent_fwspec);
1233 * If the parent irqdomain is msi, the interrupts have already
1234 * been allocated, so the EEXIST is good.
1236 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1240 "failed to allocate parent hwirq %d for hwirq %lu\n",
1241 parent_hwirq, hwirq);
1246 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1247 unsigned int offset)
1252 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1254 ops->activate = gpiochip_irq_domain_activate;
1255 ops->deactivate = gpiochip_irq_domain_deactivate;
1256 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1259 * We only allow overriding the translate() and free() functions for
1260 * hierarchical chips, and this should only be done if the user
1261 * really need something other than 1:1 translation for translate()
1262 * callback and free if user wants to free up any resources which
1263 * were allocated during callbacks, for example populate_parent_alloc_arg.
1265 if (!ops->translate)
1266 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1268 ops->free = irq_domain_free_irqs_common;
1271 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1273 if (!gc->irq.child_to_parent_hwirq ||
1275 chip_err(gc, "missing irqdomain vital data\n");
1279 if (!gc->irq.child_offset_to_irq)
1280 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1282 if (!gc->irq.populate_parent_alloc_arg)
1283 gc->irq.populate_parent_alloc_arg =
1284 gpiochip_populate_parent_fwspec_twocell;
1286 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1288 gc->irq.domain = irq_domain_create_hierarchy(
1289 gc->irq.parent_domain,
1293 &gc->irq.child_irq_domain_ops,
1296 if (!gc->irq.domain)
1299 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1304 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1306 return !!gc->irq.parent_domain;
1309 int gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1310 union gpio_irq_fwspec *gfwspec,
1311 unsigned int parent_hwirq,
1312 unsigned int parent_type)
1314 struct irq_fwspec *fwspec = &gfwspec->fwspec;
1316 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1317 fwspec->param_count = 2;
1318 fwspec->param[0] = parent_hwirq;
1319 fwspec->param[1] = parent_type;
1323 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1325 int gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1326 union gpio_irq_fwspec *gfwspec,
1327 unsigned int parent_hwirq,
1328 unsigned int parent_type)
1330 struct irq_fwspec *fwspec = &gfwspec->fwspec;
1332 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1333 fwspec->param_count = 4;
1334 fwspec->param[0] = 0;
1335 fwspec->param[1] = parent_hwirq;
1336 fwspec->param[2] = 0;
1337 fwspec->param[3] = parent_type;
1341 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1345 static int gpiochip_hierarchy_add_domain(struct gpio_chip *gc)
1350 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1355 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1358 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1359 * @d: the irqdomain used by this irqchip
1360 * @irq: the global irq number used by this GPIO irqchip irq
1361 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1363 * This function will set up the mapping for a certain IRQ line on a
1364 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1365 * stored inside the gpiochip.
1367 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1368 irq_hw_number_t hwirq)
1370 struct gpio_chip *gc = d->host_data;
1373 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1376 irq_set_chip_data(irq, gc);
1378 * This lock class tells lockdep that GPIO irqs are in a different
1379 * category than their parents, so it won't report false recursion.
1381 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1382 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1383 /* Chips that use nested thread handlers have them marked */
1384 if (gc->irq.threaded)
1385 irq_set_nested_thread(irq, 1);
1386 irq_set_noprobe(irq);
1388 if (gc->irq.num_parents == 1)
1389 ret = irq_set_parent(irq, gc->irq.parents[0]);
1390 else if (gc->irq.map)
1391 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1397 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1398 * is passed as default type.
1400 if (gc->irq.default_type != IRQ_TYPE_NONE)
1401 irq_set_irq_type(irq, gc->irq.default_type);
1405 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1407 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1409 struct gpio_chip *gc = d->host_data;
1411 if (gc->irq.threaded)
1412 irq_set_nested_thread(irq, 0);
1413 irq_set_chip_and_handler(irq, NULL, NULL);
1414 irq_set_chip_data(irq, NULL);
1416 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1418 static const struct irq_domain_ops gpiochip_domain_ops = {
1419 .map = gpiochip_irq_map,
1420 .unmap = gpiochip_irq_unmap,
1421 /* Virtually all GPIO irqchips are twocell:ed */
1422 .xlate = irq_domain_xlate_twocell,
1426 * TODO: move these activate/deactivate in under the hierarchicial
1427 * irqchip implementation as static once SPMI and SSBI (all external
1428 * users) are phased over.
1431 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1432 * @domain: The IRQ domain used by this IRQ chip
1433 * @data: Outermost irq_data associated with the IRQ
1434 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1436 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1437 * used as the activate function for the &struct irq_domain_ops. The host_data
1438 * for the IRQ domain must be the &struct gpio_chip.
1440 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1441 struct irq_data *data, bool reserve)
1443 struct gpio_chip *gc = domain->host_data;
1445 return gpiochip_lock_as_irq(gc, data->hwirq);
1447 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1450 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1451 * @domain: The IRQ domain used by this IRQ chip
1452 * @data: Outermost irq_data associated with the IRQ
1454 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1455 * be used as the deactivate function for the &struct irq_domain_ops. The
1456 * host_data for the IRQ domain must be the &struct gpio_chip.
1458 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1459 struct irq_data *data)
1461 struct gpio_chip *gc = domain->host_data;
1463 return gpiochip_unlock_as_irq(gc, data->hwirq);
1465 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1467 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1469 struct irq_domain *domain = gc->irq.domain;
1471 #ifdef CONFIG_GPIOLIB_IRQCHIP
1473 * Avoid race condition with other code, which tries to lookup
1474 * an IRQ before the irqchip has been properly registered,
1475 * i.e. while gpiochip is still being brought up.
1477 if (!gc->irq.initialized)
1478 return -EPROBE_DEFER;
1481 if (!gpiochip_irqchip_irq_valid(gc, offset))
1484 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1485 if (irq_domain_is_hierarchy(domain)) {
1486 struct irq_fwspec spec;
1488 spec.fwnode = domain->fwnode;
1489 spec.param_count = 2;
1490 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1491 spec.param[1] = IRQ_TYPE_NONE;
1493 return irq_create_fwspec_mapping(&spec);
1497 return irq_create_mapping(domain, offset);
1500 int gpiochip_irq_reqres(struct irq_data *d)
1502 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1504 return gpiochip_reqres_irq(gc, d->hwirq);
1506 EXPORT_SYMBOL(gpiochip_irq_reqres);
1508 void gpiochip_irq_relres(struct irq_data *d)
1510 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1512 gpiochip_relres_irq(gc, d->hwirq);
1514 EXPORT_SYMBOL(gpiochip_irq_relres);
1516 static void gpiochip_irq_mask(struct irq_data *d)
1518 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1520 if (gc->irq.irq_mask)
1521 gc->irq.irq_mask(d);
1522 gpiochip_disable_irq(gc, d->hwirq);
1525 static void gpiochip_irq_unmask(struct irq_data *d)
1527 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1529 gpiochip_enable_irq(gc, d->hwirq);
1530 if (gc->irq.irq_unmask)
1531 gc->irq.irq_unmask(d);
1534 static void gpiochip_irq_enable(struct irq_data *d)
1536 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1538 gpiochip_enable_irq(gc, d->hwirq);
1539 gc->irq.irq_enable(d);
1542 static void gpiochip_irq_disable(struct irq_data *d)
1544 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1546 gc->irq.irq_disable(d);
1547 gpiochip_disable_irq(gc, d->hwirq);
1550 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1552 struct irq_chip *irqchip = gc->irq.chip;
1554 if (irqchip->flags & IRQCHIP_IMMUTABLE)
1557 chip_warn(gc, "not an immutable chip, please consider fixing it!\n");
1559 if (!irqchip->irq_request_resources &&
1560 !irqchip->irq_release_resources) {
1561 irqchip->irq_request_resources = gpiochip_irq_reqres;
1562 irqchip->irq_release_resources = gpiochip_irq_relres;
1564 if (WARN_ON(gc->irq.irq_enable))
1566 /* Check if the irqchip already has this hook... */
1567 if (irqchip->irq_enable == gpiochip_irq_enable ||
1568 irqchip->irq_mask == gpiochip_irq_mask) {
1570 * ...and if so, give a gentle warning that this is bad
1574 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1578 if (irqchip->irq_disable) {
1579 gc->irq.irq_disable = irqchip->irq_disable;
1580 irqchip->irq_disable = gpiochip_irq_disable;
1582 gc->irq.irq_mask = irqchip->irq_mask;
1583 irqchip->irq_mask = gpiochip_irq_mask;
1586 if (irqchip->irq_enable) {
1587 gc->irq.irq_enable = irqchip->irq_enable;
1588 irqchip->irq_enable = gpiochip_irq_enable;
1590 gc->irq.irq_unmask = irqchip->irq_unmask;
1591 irqchip->irq_unmask = gpiochip_irq_unmask;
1596 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1597 * @gc: the GPIO chip to add the IRQ chip to
1598 * @lock_key: lockdep class for IRQ lock
1599 * @request_key: lockdep class for IRQ request
1601 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1602 struct lock_class_key *lock_key,
1603 struct lock_class_key *request_key)
1605 struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
1606 struct irq_chip *irqchip = gc->irq.chip;
1613 if (gc->irq.parent_handler && gc->can_sleep) {
1614 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1618 type = gc->irq.default_type;
1621 * Specifying a default trigger is a terrible idea if DT or ACPI is
1622 * used to configure the interrupts, as you may end up with
1623 * conflicting triggers. Tell the user, and reset to NONE.
1625 if (WARN(fwnode && type != IRQ_TYPE_NONE,
1626 "%pfw: Ignoring %u default trigger\n", fwnode, type))
1627 type = IRQ_TYPE_NONE;
1630 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1632 gc->to_irq = gpiochip_to_irq;
1633 gc->irq.default_type = type;
1634 gc->irq.lock_key = lock_key;
1635 gc->irq.request_key = request_key;
1637 /* If a parent irqdomain is provided, let's build a hierarchy */
1638 if (gpiochip_hierarchy_is_hierarchical(gc)) {
1639 int ret = gpiochip_hierarchy_add_domain(gc);
1643 /* Some drivers provide custom irqdomain ops */
1644 gc->irq.domain = irq_domain_create_simple(fwnode,
1647 gc->irq.domain_ops ?: &gpiochip_domain_ops,
1649 if (!gc->irq.domain)
1653 if (gc->irq.parent_handler) {
1654 for (i = 0; i < gc->irq.num_parents; i++) {
1657 if (gc->irq.per_parent_data)
1658 data = gc->irq.parent_handler_data_array[i];
1660 data = gc->irq.parent_handler_data ?: gc;
1663 * The parent IRQ chip is already using the chip_data
1664 * for this IRQ chip, so our callbacks simply use the
1667 irq_set_chained_handler_and_data(gc->irq.parents[i],
1668 gc->irq.parent_handler,
1673 gpiochip_set_irq_hooks(gc);
1676 * Using barrier() here to prevent compiler from reordering
1677 * gc->irq.initialized before initialization of above
1678 * GPIO chip irq members.
1682 gc->irq.initialized = true;
1684 acpi_gpiochip_request_interrupts(gc);
1690 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1691 * @gc: the gpiochip to remove the irqchip from
1693 * This is called only from gpiochip_remove()
1695 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1697 struct irq_chip *irqchip = gc->irq.chip;
1698 unsigned int offset;
1700 acpi_gpiochip_free_interrupts(gc);
1702 if (irqchip && gc->irq.parent_handler) {
1703 struct gpio_irq_chip *irq = &gc->irq;
1706 for (i = 0; i < irq->num_parents; i++)
1707 irq_set_chained_handler_and_data(irq->parents[i],
1711 /* Remove all IRQ mappings and delete the domain */
1712 if (gc->irq.domain) {
1715 for (offset = 0; offset < gc->ngpio; offset++) {
1716 if (!gpiochip_irqchip_irq_valid(gc, offset))
1719 irq = irq_find_mapping(gc->irq.domain, offset);
1720 irq_dispose_mapping(irq);
1723 irq_domain_remove(gc->irq.domain);
1726 if (irqchip && !(irqchip->flags & IRQCHIP_IMMUTABLE)) {
1727 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1728 irqchip->irq_request_resources = NULL;
1729 irqchip->irq_release_resources = NULL;
1731 if (irqchip->irq_enable == gpiochip_irq_enable) {
1732 irqchip->irq_enable = gc->irq.irq_enable;
1733 irqchip->irq_disable = gc->irq.irq_disable;
1736 gc->irq.irq_enable = NULL;
1737 gc->irq.irq_disable = NULL;
1738 gc->irq.chip = NULL;
1740 gpiochip_irqchip_free_valid_mask(gc);
1744 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1745 * @gc: the gpiochip to add the irqchip to
1746 * @domain: the irqdomain to add to the gpiochip
1748 * This function adds an IRQ domain to the gpiochip.
1750 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1751 struct irq_domain *domain)
1756 gc->to_irq = gpiochip_to_irq;
1757 gc->irq.domain = domain;
1761 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1763 #else /* CONFIG_GPIOLIB_IRQCHIP */
1765 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1766 struct lock_class_key *lock_key,
1767 struct lock_class_key *request_key)
1771 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1773 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1778 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1782 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1785 #endif /* CONFIG_GPIOLIB_IRQCHIP */
1788 * gpiochip_generic_request() - request the gpio function for a pin
1789 * @gc: the gpiochip owning the GPIO
1790 * @offset: the offset of the GPIO to request for GPIO function
1792 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
1794 #ifdef CONFIG_PINCTRL
1795 if (list_empty(&gc->gpiodev->pin_ranges))
1799 return pinctrl_gpio_request(gc->gpiodev->base + offset);
1801 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
1804 * gpiochip_generic_free() - free the gpio function from a pin
1805 * @gc: the gpiochip to request the gpio function for
1806 * @offset: the offset of the GPIO to free from GPIO function
1808 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
1810 #ifdef CONFIG_PINCTRL
1811 if (list_empty(&gc->gpiodev->pin_ranges))
1815 pinctrl_gpio_free(gc->gpiodev->base + offset);
1817 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
1820 * gpiochip_generic_config() - apply configuration for a pin
1821 * @gc: the gpiochip owning the GPIO
1822 * @offset: the offset of the GPIO to apply the configuration
1823 * @config: the configuration to be applied
1825 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
1826 unsigned long config)
1828 return pinctrl_gpio_set_config(gc->gpiodev->base + offset, config);
1830 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
1832 #ifdef CONFIG_PINCTRL
1835 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1836 * @gc: the gpiochip to add the range for
1837 * @pctldev: the pin controller to map to
1838 * @gpio_offset: the start offset in the current gpio_chip number space
1839 * @pin_group: name of the pin group inside the pin controller
1841 * Calling this function directly from a DeviceTree-supported
1842 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1843 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1844 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1846 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
1847 struct pinctrl_dev *pctldev,
1848 unsigned int gpio_offset, const char *pin_group)
1850 struct gpio_pin_range *pin_range;
1851 struct gpio_device *gdev = gc->gpiodev;
1854 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1856 chip_err(gc, "failed to allocate pin ranges\n");
1860 /* Use local offset as range ID */
1861 pin_range->range.id = gpio_offset;
1862 pin_range->range.gc = gc;
1863 pin_range->range.name = gc->label;
1864 pin_range->range.base = gdev->base + gpio_offset;
1865 pin_range->pctldev = pctldev;
1867 ret = pinctrl_get_group_pins(pctldev, pin_group,
1868 &pin_range->range.pins,
1869 &pin_range->range.npins);
1875 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1877 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1878 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1879 pinctrl_dev_get_devname(pctldev), pin_group);
1881 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1885 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1888 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1889 * @gc: the gpiochip to add the range for
1890 * @pinctl_name: the dev_name() of the pin controller to map to
1891 * @gpio_offset: the start offset in the current gpio_chip number space
1892 * @pin_offset: the start offset in the pin controller number space
1893 * @npins: the number of pins from the offset of each pin space (GPIO and
1894 * pin controller) to accumulate in this range
1897 * 0 on success, or a negative error-code on failure.
1899 * Calling this function directly from a DeviceTree-supported
1900 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
1901 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
1902 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
1904 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
1905 unsigned int gpio_offset, unsigned int pin_offset,
1908 struct gpio_pin_range *pin_range;
1909 struct gpio_device *gdev = gc->gpiodev;
1912 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1914 chip_err(gc, "failed to allocate pin ranges\n");
1918 /* Use local offset as range ID */
1919 pin_range->range.id = gpio_offset;
1920 pin_range->range.gc = gc;
1921 pin_range->range.name = gc->label;
1922 pin_range->range.base = gdev->base + gpio_offset;
1923 pin_range->range.pin_base = pin_offset;
1924 pin_range->range.npins = npins;
1925 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1927 if (IS_ERR(pin_range->pctldev)) {
1928 ret = PTR_ERR(pin_range->pctldev);
1929 chip_err(gc, "could not create pin range\n");
1933 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1934 gpio_offset, gpio_offset + npins - 1,
1936 pin_offset, pin_offset + npins - 1);
1938 list_add_tail(&pin_range->node, &gdev->pin_ranges);
1942 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1945 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1946 * @gc: the chip to remove all the mappings for
1948 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
1950 struct gpio_pin_range *pin_range, *tmp;
1951 struct gpio_device *gdev = gc->gpiodev;
1953 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1954 list_del(&pin_range->node);
1955 pinctrl_remove_gpio_range(pin_range->pctldev,
1960 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1962 #endif /* CONFIG_PINCTRL */
1964 /* These "optional" allocation calls help prevent drivers from stomping
1965 * on each other, and help provide better diagnostics in debugfs.
1966 * They're called even less than the "set direction" calls.
1968 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
1970 struct gpio_chip *gc = desc->gdev->chip;
1972 unsigned long flags;
1976 label = kstrdup_const(label, GFP_KERNEL);
1981 spin_lock_irqsave(&gpio_lock, flags);
1983 /* NOTE: gpio_request() can be called in early boot,
1984 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1987 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1988 desc_set_label(desc, label ? : "?");
1991 goto out_free_unlock;
1995 /* gc->request may sleep */
1996 spin_unlock_irqrestore(&gpio_lock, flags);
1997 offset = gpio_chip_hwgpio(desc);
1998 if (gpiochip_line_is_valid(gc, offset))
1999 ret = gc->request(gc, offset);
2002 spin_lock_irqsave(&gpio_lock, flags);
2005 desc_set_label(desc, NULL);
2006 clear_bit(FLAG_REQUESTED, &desc->flags);
2007 goto out_free_unlock;
2010 if (gc->get_direction) {
2011 /* gc->get_direction may sleep */
2012 spin_unlock_irqrestore(&gpio_lock, flags);
2013 gpiod_get_direction(desc);
2014 spin_lock_irqsave(&gpio_lock, flags);
2016 spin_unlock_irqrestore(&gpio_lock, flags);
2020 spin_unlock_irqrestore(&gpio_lock, flags);
2026 * This descriptor validation needs to be inserted verbatim into each
2027 * function taking a descriptor, so we need to use a preprocessor
2028 * macro to avoid endless duplication. If the desc is NULL it is an
2029 * optional GPIO and calls should just bail out.
2031 static int validate_desc(const struct gpio_desc *desc, const char *func)
2036 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
2037 return PTR_ERR(desc);
2040 pr_warn("%s: invalid GPIO (no device)\n", func);
2043 if (!desc->gdev->chip) {
2044 dev_warn(&desc->gdev->dev,
2045 "%s: backing chip is gone\n", func);
2051 #define VALIDATE_DESC(desc) do { \
2052 int __valid = validate_desc(desc, __func__); \
2057 #define VALIDATE_DESC_VOID(desc) do { \
2058 int __valid = validate_desc(desc, __func__); \
2063 int gpiod_request(struct gpio_desc *desc, const char *label)
2065 int ret = -EPROBE_DEFER;
2066 struct gpio_device *gdev;
2068 VALIDATE_DESC(desc);
2071 if (try_module_get(gdev->owner)) {
2072 ret = gpiod_request_commit(desc, label);
2074 module_put(gdev->owner);
2076 get_device(&gdev->dev);
2080 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
2085 static bool gpiod_free_commit(struct gpio_desc *desc)
2088 unsigned long flags;
2089 struct gpio_chip *gc;
2093 gpiod_unexport(desc);
2095 spin_lock_irqsave(&gpio_lock, flags);
2097 gc = desc->gdev->chip;
2098 if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
2100 spin_unlock_irqrestore(&gpio_lock, flags);
2101 might_sleep_if(gc->can_sleep);
2102 gc->free(gc, gpio_chip_hwgpio(desc));
2103 spin_lock_irqsave(&gpio_lock, flags);
2105 kfree_const(desc->label);
2106 desc_set_label(desc, NULL);
2107 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2108 clear_bit(FLAG_REQUESTED, &desc->flags);
2109 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2110 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2111 clear_bit(FLAG_PULL_UP, &desc->flags);
2112 clear_bit(FLAG_PULL_DOWN, &desc->flags);
2113 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
2114 clear_bit(FLAG_EDGE_RISING, &desc->flags);
2115 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
2116 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2117 #ifdef CONFIG_OF_DYNAMIC
2120 #ifdef CONFIG_GPIO_CDEV
2121 WRITE_ONCE(desc->debounce_period_us, 0);
2126 spin_unlock_irqrestore(&gpio_lock, flags);
2127 blocking_notifier_call_chain(&desc->gdev->notifier,
2128 GPIOLINE_CHANGED_RELEASED, desc);
2133 void gpiod_free(struct gpio_desc *desc)
2135 if (desc && desc->gdev && gpiod_free_commit(desc)) {
2136 module_put(desc->gdev->owner);
2137 put_device(&desc->gdev->dev);
2139 WARN_ON(extra_checks);
2144 * gpiochip_is_requested - return string iff signal was requested
2145 * @gc: controller managing the signal
2146 * @offset: of signal within controller's 0..(ngpio - 1) range
2148 * Returns NULL if the GPIO is not currently requested, else a string.
2149 * The string returned is the label passed to gpio_request(); if none has been
2150 * passed it is a meaningless, non-NULL constant.
2152 * This function is for use by GPIO controller drivers. The label can
2153 * help with diagnostics, and knowing that the signal is used as a GPIO
2154 * can help avoid accidentally multiplexing it to another controller.
2156 const char *gpiochip_is_requested(struct gpio_chip *gc, unsigned int offset)
2158 struct gpio_desc *desc;
2160 desc = gpiochip_get_desc(gc, offset);
2164 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
2168 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
2171 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2173 * @hwnum: hardware number of the GPIO for which to request the descriptor
2174 * @label: label for the GPIO
2175 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2176 * specify things like line inversion semantics with the machine flags
2177 * such as GPIO_OUT_LOW
2178 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2179 * can be used to specify consumer semantics such as open drain
2181 * Function allows GPIO chip drivers to request and use their own GPIO
2182 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2183 * function will not increase reference count of the GPIO chip module. This
2184 * allows the GPIO chip module to be unloaded as needed (we assume that the
2185 * GPIO chip driver handles freeing the GPIOs it has requested).
2188 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2191 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2194 enum gpio_lookup_flags lflags,
2195 enum gpiod_flags dflags)
2197 struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2201 chip_err(gc, "failed to get GPIO descriptor\n");
2205 ret = gpiod_request_commit(desc, label);
2207 return ERR_PTR(ret);
2209 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2211 chip_err(gc, "setup of own GPIO %s failed\n", label);
2212 gpiod_free_commit(desc);
2213 return ERR_PTR(ret);
2218 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2221 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2222 * @desc: GPIO descriptor to free
2224 * Function frees the given GPIO requested previously with
2225 * gpiochip_request_own_desc().
2227 void gpiochip_free_own_desc(struct gpio_desc *desc)
2230 gpiod_free_commit(desc);
2232 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2235 * Drivers MUST set GPIO direction before making get/set calls. In
2236 * some cases this is done in early boot, before IRQs are enabled.
2238 * As a rule these aren't called more than once (except for drivers
2239 * using the open-drain emulation idiom) so these are natural places
2240 * to accumulate extra debugging checks. Note that we can't (yet)
2241 * rely on gpio_request() having been called beforehand.
2244 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2245 unsigned long config)
2247 if (!gc->set_config)
2250 return gc->set_config(gc, offset, config);
2253 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2254 enum pin_config_param mode,
2257 struct gpio_chip *gc = desc->gdev->chip;
2258 unsigned long config;
2260 config = pinconf_to_config_packed(mode, argument);
2261 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2264 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2265 enum pin_config_param mode,
2268 struct device *dev = &desc->gdev->dev;
2269 int gpio = gpio_chip_hwgpio(desc);
2272 ret = gpio_set_config_with_argument(desc, mode, argument);
2273 if (ret != -ENOTSUPP)
2277 case PIN_CONFIG_PERSIST_STATE:
2278 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2287 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2289 return gpio_set_config_with_argument(desc, mode, 0);
2292 static int gpio_set_bias(struct gpio_desc *desc)
2294 enum pin_config_param bias;
2297 if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2298 bias = PIN_CONFIG_BIAS_DISABLE;
2299 else if (test_bit(FLAG_PULL_UP, &desc->flags))
2300 bias = PIN_CONFIG_BIAS_PULL_UP;
2301 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2302 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2307 case PIN_CONFIG_BIAS_PULL_DOWN:
2308 case PIN_CONFIG_BIAS_PULL_UP:
2317 return gpio_set_config_with_argument_optional(desc, bias, arg);
2321 * gpio_set_debounce_timeout() - Set debounce timeout
2322 * @desc: GPIO descriptor to set the debounce timeout
2323 * @debounce: Debounce timeout in microseconds
2325 * The function calls the certain GPIO driver to set debounce timeout
2328 * Returns 0 on success, or negative error code otherwise.
2330 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2332 return gpio_set_config_with_argument_optional(desc,
2333 PIN_CONFIG_INPUT_DEBOUNCE,
2338 * gpiod_direction_input - set the GPIO direction to input
2339 * @desc: GPIO to set to input
2341 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2342 * be called safely on it.
2344 * Return 0 in case of success, else an error code.
2346 int gpiod_direction_input(struct gpio_desc *desc)
2348 struct gpio_chip *gc;
2351 VALIDATE_DESC(desc);
2352 gc = desc->gdev->chip;
2355 * It is legal to have no .get() and .direction_input() specified if
2356 * the chip is output-only, but you can't specify .direction_input()
2357 * and not support the .get() operation, that doesn't make sense.
2359 if (!gc->get && gc->direction_input) {
2361 "%s: missing get() but have direction_input()\n",
2367 * If we have a .direction_input() callback, things are simple,
2368 * just call it. Else we are some input-only chip so try to check the
2369 * direction (if .get_direction() is supported) else we silently
2370 * assume we are in input mode after this.
2372 if (gc->direction_input) {
2373 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2374 } else if (gc->get_direction &&
2375 (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2377 "%s: missing direction_input() operation and line is output\n",
2382 clear_bit(FLAG_IS_OUT, &desc->flags);
2383 ret = gpio_set_bias(desc);
2386 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2390 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2392 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2394 struct gpio_chip *gc = desc->gdev->chip;
2399 * It's OK not to specify .direction_output() if the gpiochip is
2400 * output-only, but if there is then not even a .set() operation it
2401 * is pretty tricky to drive the output line.
2403 if (!gc->set && !gc->direction_output) {
2405 "%s: missing set() and direction_output() operations\n",
2410 if (gc->direction_output) {
2411 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2413 /* Check that we are in output mode if we can */
2414 if (gc->get_direction &&
2415 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2417 "%s: missing direction_output() operation\n",
2422 * If we can't actively set the direction, we are some
2423 * output-only chip, so just drive the output as desired.
2425 gc->set(gc, gpio_chip_hwgpio(desc), val);
2429 set_bit(FLAG_IS_OUT, &desc->flags);
2430 trace_gpio_value(desc_to_gpio(desc), 0, val);
2431 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2436 * gpiod_direction_output_raw - set the GPIO direction to output
2437 * @desc: GPIO to set to output
2438 * @value: initial output value of the GPIO
2440 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2441 * be called safely on it. The initial value of the output must be specified
2442 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2444 * Return 0 in case of success, else an error code.
2446 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2448 VALIDATE_DESC(desc);
2449 return gpiod_direction_output_raw_commit(desc, value);
2451 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2454 * gpiod_direction_output - set the GPIO direction to output
2455 * @desc: GPIO to set to output
2456 * @value: initial output value of the GPIO
2458 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2459 * be called safely on it. The initial value of the output must be specified
2460 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2463 * Return 0 in case of success, else an error code.
2465 int gpiod_direction_output(struct gpio_desc *desc, int value)
2469 VALIDATE_DESC(desc);
2470 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2475 /* GPIOs used for enabled IRQs shall not be set as output */
2476 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2477 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2479 "%s: tried to set a GPIO tied to an IRQ as output\n",
2484 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2485 /* First see if we can enable open drain in hardware */
2486 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2488 goto set_output_value;
2489 /* Emulate open drain by not actively driving the line high */
2491 ret = gpiod_direction_input(desc);
2492 goto set_output_flag;
2494 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2495 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2497 goto set_output_value;
2498 /* Emulate open source by not actively driving the line low */
2500 ret = gpiod_direction_input(desc);
2501 goto set_output_flag;
2504 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2508 ret = gpio_set_bias(desc);
2511 return gpiod_direction_output_raw_commit(desc, value);
2515 * When emulating open-source or open-drain functionalities by not
2516 * actively driving the line (setting mode to input) we still need to
2517 * set the IS_OUT flag or otherwise we won't be able to set the line
2521 set_bit(FLAG_IS_OUT, &desc->flags);
2524 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2527 * gpiod_enable_hw_timestamp_ns - Enable hardware timestamp in nanoseconds.
2529 * @desc: GPIO to enable.
2530 * @flags: Flags related to GPIO edge.
2532 * Return 0 in case of success, else negative error code.
2534 int gpiod_enable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags)
2537 struct gpio_chip *gc;
2539 VALIDATE_DESC(desc);
2541 gc = desc->gdev->chip;
2542 if (!gc->en_hw_timestamp) {
2543 gpiod_warn(desc, "%s: hw ts not supported\n", __func__);
2547 ret = gc->en_hw_timestamp(gc, gpio_chip_hwgpio(desc), flags);
2549 gpiod_warn(desc, "%s: hw ts request failed\n", __func__);
2553 EXPORT_SYMBOL_GPL(gpiod_enable_hw_timestamp_ns);
2556 * gpiod_disable_hw_timestamp_ns - Disable hardware timestamp.
2558 * @desc: GPIO to disable.
2559 * @flags: Flags related to GPIO edge, same value as used during enable call.
2561 * Return 0 in case of success, else negative error code.
2563 int gpiod_disable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags)
2566 struct gpio_chip *gc;
2568 VALIDATE_DESC(desc);
2570 gc = desc->gdev->chip;
2571 if (!gc->dis_hw_timestamp) {
2572 gpiod_warn(desc, "%s: hw ts not supported\n", __func__);
2576 ret = gc->dis_hw_timestamp(gc, gpio_chip_hwgpio(desc), flags);
2578 gpiod_warn(desc, "%s: hw ts release failed\n", __func__);
2582 EXPORT_SYMBOL_GPL(gpiod_disable_hw_timestamp_ns);
2585 * gpiod_set_config - sets @config for a GPIO
2586 * @desc: descriptor of the GPIO for which to set the configuration
2587 * @config: Same packed config format as generic pinconf
2590 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2593 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2595 struct gpio_chip *gc;
2597 VALIDATE_DESC(desc);
2598 gc = desc->gdev->chip;
2600 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2602 EXPORT_SYMBOL_GPL(gpiod_set_config);
2605 * gpiod_set_debounce - sets @debounce time for a GPIO
2606 * @desc: descriptor of the GPIO for which to set debounce time
2607 * @debounce: debounce time in microseconds
2610 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2613 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2615 unsigned long config;
2617 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2618 return gpiod_set_config(desc, config);
2620 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2623 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2624 * @desc: descriptor of the GPIO for which to configure persistence
2625 * @transitory: True to lose state on suspend or reset, false for persistence
2628 * 0 on success, otherwise a negative error code.
2630 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2632 VALIDATE_DESC(desc);
2634 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2635 * persistence state.
2637 assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2639 /* If the driver supports it, set the persistence state now */
2640 return gpio_set_config_with_argument_optional(desc,
2641 PIN_CONFIG_PERSIST_STATE,
2644 EXPORT_SYMBOL_GPL(gpiod_set_transitory);
2647 * gpiod_is_active_low - test whether a GPIO is active-low or not
2648 * @desc: the gpio descriptor to test
2650 * Returns 1 if the GPIO is active-low, 0 otherwise.
2652 int gpiod_is_active_low(const struct gpio_desc *desc)
2654 VALIDATE_DESC(desc);
2655 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2657 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2660 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2661 * @desc: the gpio descriptor to change
2663 void gpiod_toggle_active_low(struct gpio_desc *desc)
2665 VALIDATE_DESC_VOID(desc);
2666 change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2668 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2670 static int gpio_chip_get_value(struct gpio_chip *gc, const struct gpio_desc *desc)
2672 return gc->get ? gc->get(gc, gpio_chip_hwgpio(desc)) : -EIO;
2675 /* I/O calls are only valid after configuration completed; the relevant
2676 * "is this a valid GPIO" error checks should already have been done.
2678 * "Get" operations are often inlinable as reading a pin value register,
2679 * and masking the relevant bit in that register.
2681 * When "set" operations are inlinable, they involve writing that mask to
2682 * one register to set a low value, or a different register to set it high.
2683 * Otherwise locking is needed, so there may be little value to inlining.
2685 *------------------------------------------------------------------------
2687 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2688 * have requested the GPIO. That can include implicit requesting by
2689 * a direction setting call. Marking a gpio as requested locks its chip
2690 * in memory, guaranteeing that these table lookups need no more locking
2691 * and that gpiochip_remove() will fail.
2693 * REVISIT when debugging, consider adding some instrumentation to ensure
2694 * that the GPIO was actually requested.
2697 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2699 struct gpio_chip *gc;
2702 gc = desc->gdev->chip;
2703 value = gpio_chip_get_value(gc, desc);
2704 value = value < 0 ? value : !!value;
2705 trace_gpio_value(desc_to_gpio(desc), 1, value);
2709 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2710 unsigned long *mask, unsigned long *bits)
2712 if (gc->get_multiple)
2713 return gc->get_multiple(gc, mask, bits);
2717 for_each_set_bit(i, mask, gc->ngpio) {
2718 value = gc->get(gc, i);
2721 __assign_bit(i, bits, value);
2728 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2729 unsigned int array_size,
2730 struct gpio_desc **desc_array,
2731 struct gpio_array *array_info,
2732 unsigned long *value_bitmap)
2737 * Validate array_info against desc_array and its size.
2738 * It should immediately follow desc_array if both
2739 * have been obtained from the same gpiod_get_array() call.
2741 if (array_info && array_info->desc == desc_array &&
2742 array_size <= array_info->size &&
2743 (void *)array_info == desc_array + array_info->size) {
2745 WARN_ON(array_info->chip->can_sleep);
2747 ret = gpio_chip_get_multiple(array_info->chip,
2748 array_info->get_mask,
2753 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2754 bitmap_xor(value_bitmap, value_bitmap,
2755 array_info->invert_mask, array_size);
2757 i = find_first_zero_bit(array_info->get_mask, array_size);
2758 if (i == array_size)
2764 while (i < array_size) {
2765 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2766 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
2767 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
2768 unsigned long *mask, *bits;
2771 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
2772 mask = fastpath_mask;
2773 bits = fastpath_bits;
2775 gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
2777 mask = bitmap_alloc(gc->ngpio, flags);
2781 bits = bitmap_alloc(gc->ngpio, flags);
2788 bitmap_zero(mask, gc->ngpio);
2791 WARN_ON(gc->can_sleep);
2793 /* collect all inputs belonging to the same chip */
2796 const struct gpio_desc *desc = desc_array[i];
2797 int hwgpio = gpio_chip_hwgpio(desc);
2799 __set_bit(hwgpio, mask);
2803 i = find_next_zero_bit(array_info->get_mask,
2805 } while ((i < array_size) &&
2806 (desc_array[i]->gdev->chip == gc));
2808 ret = gpio_chip_get_multiple(gc, mask, bits);
2810 if (mask != fastpath_mask)
2812 if (bits != fastpath_bits)
2817 for (j = first; j < i; ) {
2818 const struct gpio_desc *desc = desc_array[j];
2819 int hwgpio = gpio_chip_hwgpio(desc);
2820 int value = test_bit(hwgpio, bits);
2822 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2824 __assign_bit(j, value_bitmap, value);
2825 trace_gpio_value(desc_to_gpio(desc), 1, value);
2829 j = find_next_zero_bit(array_info->get_mask, i,
2833 if (mask != fastpath_mask)
2835 if (bits != fastpath_bits)
2842 * gpiod_get_raw_value() - return a gpio's raw value
2843 * @desc: gpio whose value will be returned
2845 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2846 * its ACTIVE_LOW status, or negative errno on failure.
2848 * This function can be called from contexts where we cannot sleep, and will
2849 * complain if the GPIO chip functions potentially sleep.
2851 int gpiod_get_raw_value(const struct gpio_desc *desc)
2853 VALIDATE_DESC(desc);
2854 /* Should be using gpiod_get_raw_value_cansleep() */
2855 WARN_ON(desc->gdev->chip->can_sleep);
2856 return gpiod_get_raw_value_commit(desc);
2858 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
2861 * gpiod_get_value() - return a gpio's value
2862 * @desc: gpio whose value will be returned
2864 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2865 * account, or negative errno on failure.
2867 * This function can be called from contexts where we cannot sleep, and will
2868 * complain if the GPIO chip functions potentially sleep.
2870 int gpiod_get_value(const struct gpio_desc *desc)
2874 VALIDATE_DESC(desc);
2875 /* Should be using gpiod_get_value_cansleep() */
2876 WARN_ON(desc->gdev->chip->can_sleep);
2878 value = gpiod_get_raw_value_commit(desc);
2882 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2887 EXPORT_SYMBOL_GPL(gpiod_get_value);
2890 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
2891 * @array_size: number of elements in the descriptor array / value bitmap
2892 * @desc_array: array of GPIO descriptors whose values will be read
2893 * @array_info: information on applicability of fast bitmap processing path
2894 * @value_bitmap: bitmap to store the read values
2896 * Read the raw values of the GPIOs, i.e. the values of the physical lines
2897 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
2898 * else an error code.
2900 * This function can be called from contexts where we cannot sleep,
2901 * and it will complain if the GPIO chip functions potentially sleep.
2903 int gpiod_get_raw_array_value(unsigned int array_size,
2904 struct gpio_desc **desc_array,
2905 struct gpio_array *array_info,
2906 unsigned long *value_bitmap)
2910 return gpiod_get_array_value_complex(true, false, array_size,
2911 desc_array, array_info,
2914 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
2917 * gpiod_get_array_value() - read values from an array of GPIOs
2918 * @array_size: number of elements in the descriptor array / value bitmap
2919 * @desc_array: array of GPIO descriptors whose values will be read
2920 * @array_info: information on applicability of fast bitmap processing path
2921 * @value_bitmap: bitmap to store the read values
2923 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
2924 * into account. Return 0 in case of success, else an error code.
2926 * This function can be called from contexts where we cannot sleep,
2927 * and it will complain if the GPIO chip functions potentially sleep.
2929 int gpiod_get_array_value(unsigned int array_size,
2930 struct gpio_desc **desc_array,
2931 struct gpio_array *array_info,
2932 unsigned long *value_bitmap)
2936 return gpiod_get_array_value_complex(false, false, array_size,
2937 desc_array, array_info,
2940 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
2943 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
2944 * @desc: gpio descriptor whose state need to be set.
2945 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2947 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
2950 struct gpio_chip *gc = desc->gdev->chip;
2951 int offset = gpio_chip_hwgpio(desc);
2954 ret = gc->direction_input(gc, offset);
2956 ret = gc->direction_output(gc, offset, 0);
2958 set_bit(FLAG_IS_OUT, &desc->flags);
2960 trace_gpio_direction(desc_to_gpio(desc), value, ret);
2963 "%s: Error in set_value for open drain err %d\n",
2968 * _gpio_set_open_source_value() - Set the open source gpio's value.
2969 * @desc: gpio descriptor whose state need to be set.
2970 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
2972 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
2975 struct gpio_chip *gc = desc->gdev->chip;
2976 int offset = gpio_chip_hwgpio(desc);
2979 ret = gc->direction_output(gc, offset, 1);
2981 set_bit(FLAG_IS_OUT, &desc->flags);
2983 ret = gc->direction_input(gc, offset);
2985 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
2988 "%s: Error in set_value for open source err %d\n",
2992 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
2994 struct gpio_chip *gc;
2996 gc = desc->gdev->chip;
2997 trace_gpio_value(desc_to_gpio(desc), 0, value);
2998 gc->set(gc, gpio_chip_hwgpio(desc), value);
3002 * set multiple outputs on the same chip;
3003 * use the chip's set_multiple function if available;
3004 * otherwise set the outputs sequentially;
3005 * @chip: the GPIO chip we operate on
3006 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
3007 * defines which outputs are to be changed
3008 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
3009 * defines the values the outputs specified by mask are to be set to
3011 static void gpio_chip_set_multiple(struct gpio_chip *gc,
3012 unsigned long *mask, unsigned long *bits)
3014 if (gc->set_multiple) {
3015 gc->set_multiple(gc, mask, bits);
3019 /* set outputs if the corresponding mask bit is set */
3020 for_each_set_bit(i, mask, gc->ngpio)
3021 gc->set(gc, i, test_bit(i, bits));
3025 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
3026 unsigned int array_size,
3027 struct gpio_desc **desc_array,
3028 struct gpio_array *array_info,
3029 unsigned long *value_bitmap)
3034 * Validate array_info against desc_array and its size.
3035 * It should immediately follow desc_array if both
3036 * have been obtained from the same gpiod_get_array() call.
3038 if (array_info && array_info->desc == desc_array &&
3039 array_size <= array_info->size &&
3040 (void *)array_info == desc_array + array_info->size) {
3042 WARN_ON(array_info->chip->can_sleep);
3044 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
3045 bitmap_xor(value_bitmap, value_bitmap,
3046 array_info->invert_mask, array_size);
3048 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
3051 i = find_first_zero_bit(array_info->set_mask, array_size);
3052 if (i == array_size)
3058 while (i < array_size) {
3059 struct gpio_chip *gc = desc_array[i]->gdev->chip;
3060 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
3061 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
3062 unsigned long *mask, *bits;
3065 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
3066 mask = fastpath_mask;
3067 bits = fastpath_bits;
3069 gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
3071 mask = bitmap_alloc(gc->ngpio, flags);
3075 bits = bitmap_alloc(gc->ngpio, flags);
3082 bitmap_zero(mask, gc->ngpio);
3085 WARN_ON(gc->can_sleep);
3088 struct gpio_desc *desc = desc_array[i];
3089 int hwgpio = gpio_chip_hwgpio(desc);
3090 int value = test_bit(i, value_bitmap);
3093 * Pins applicable for fast input but not for
3094 * fast output processing may have been already
3095 * inverted inside the fast path, skip them.
3097 if (!raw && !(array_info &&
3098 test_bit(i, array_info->invert_mask)) &&
3099 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3101 trace_gpio_value(desc_to_gpio(desc), 0, value);
3103 * collect all normal outputs belonging to the same chip
3104 * open drain and open source outputs are set individually
3106 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
3107 gpio_set_open_drain_value_commit(desc, value);
3108 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
3109 gpio_set_open_source_value_commit(desc, value);
3111 __set_bit(hwgpio, mask);
3112 __assign_bit(hwgpio, bits, value);
3118 i = find_next_zero_bit(array_info->set_mask,
3120 } while ((i < array_size) &&
3121 (desc_array[i]->gdev->chip == gc));
3122 /* push collected bits to outputs */
3124 gpio_chip_set_multiple(gc, mask, bits);
3126 if (mask != fastpath_mask)
3128 if (bits != fastpath_bits)
3135 * gpiod_set_raw_value() - assign a gpio's raw value
3136 * @desc: gpio whose value will be assigned
3137 * @value: value to assign
3139 * Set the raw value of the GPIO, i.e. the value of its physical line without
3140 * regard for its ACTIVE_LOW status.
3142 * This function can be called from contexts where we cannot sleep, and will
3143 * complain if the GPIO chip functions potentially sleep.
3145 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
3147 VALIDATE_DESC_VOID(desc);
3148 /* Should be using gpiod_set_raw_value_cansleep() */
3149 WARN_ON(desc->gdev->chip->can_sleep);
3150 gpiod_set_raw_value_commit(desc, value);
3152 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
3155 * gpiod_set_value_nocheck() - set a GPIO line value without checking
3156 * @desc: the descriptor to set the value on
3157 * @value: value to set
3159 * This sets the value of a GPIO line backing a descriptor, applying
3160 * different semantic quirks like active low and open drain/source
3163 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
3165 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3167 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
3168 gpio_set_open_drain_value_commit(desc, value);
3169 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
3170 gpio_set_open_source_value_commit(desc, value);
3172 gpiod_set_raw_value_commit(desc, value);
3176 * gpiod_set_value() - assign a gpio's value
3177 * @desc: gpio whose value will be assigned
3178 * @value: value to assign
3180 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
3181 * OPEN_DRAIN and OPEN_SOURCE flags into account.
3183 * This function can be called from contexts where we cannot sleep, and will
3184 * complain if the GPIO chip functions potentially sleep.
3186 void gpiod_set_value(struct gpio_desc *desc, int value)
3188 VALIDATE_DESC_VOID(desc);
3189 /* Should be using gpiod_set_value_cansleep() */
3190 WARN_ON(desc->gdev->chip->can_sleep);
3191 gpiod_set_value_nocheck(desc, value);
3193 EXPORT_SYMBOL_GPL(gpiod_set_value);
3196 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
3197 * @array_size: number of elements in the descriptor array / value bitmap
3198 * @desc_array: array of GPIO descriptors whose values will be assigned
3199 * @array_info: information on applicability of fast bitmap processing path
3200 * @value_bitmap: bitmap of values to assign
3202 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3203 * without regard for their ACTIVE_LOW status.
3205 * This function can be called from contexts where we cannot sleep, and will
3206 * complain if the GPIO chip functions potentially sleep.
3208 int gpiod_set_raw_array_value(unsigned int array_size,
3209 struct gpio_desc **desc_array,
3210 struct gpio_array *array_info,
3211 unsigned long *value_bitmap)
3215 return gpiod_set_array_value_complex(true, false, array_size,
3216 desc_array, array_info, value_bitmap);
3218 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
3221 * gpiod_set_array_value() - assign values to an array of GPIOs
3222 * @array_size: number of elements in the descriptor array / value bitmap
3223 * @desc_array: array of GPIO descriptors whose values will be assigned
3224 * @array_info: information on applicability of fast bitmap processing path
3225 * @value_bitmap: bitmap of values to assign
3227 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3230 * This function can be called from contexts where we cannot sleep, and will
3231 * complain if the GPIO chip functions potentially sleep.
3233 int gpiod_set_array_value(unsigned int array_size,
3234 struct gpio_desc **desc_array,
3235 struct gpio_array *array_info,
3236 unsigned long *value_bitmap)
3240 return gpiod_set_array_value_complex(false, false, array_size,
3241 desc_array, array_info,
3244 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3247 * gpiod_cansleep() - report whether gpio value access may sleep
3248 * @desc: gpio to check
3251 int gpiod_cansleep(const struct gpio_desc *desc)
3253 VALIDATE_DESC(desc);
3254 return desc->gdev->chip->can_sleep;
3256 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3259 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3260 * @desc: gpio to set the consumer name on
3261 * @name: the new consumer name
3263 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3265 VALIDATE_DESC(desc);
3267 name = kstrdup_const(name, GFP_KERNEL);
3272 kfree_const(desc->label);
3273 desc_set_label(desc, name);
3277 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3280 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3281 * @desc: gpio whose IRQ will be returned (already requested)
3283 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3286 int gpiod_to_irq(const struct gpio_desc *desc)
3288 struct gpio_chip *gc;
3292 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3293 * requires this function to not return zero on an invalid descriptor
3294 * but rather a negative error number.
3296 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3299 gc = desc->gdev->chip;
3300 offset = gpio_chip_hwgpio(desc);
3302 int retirq = gc->to_irq(gc, offset);
3304 /* Zero means NO_IRQ */
3310 #ifdef CONFIG_GPIOLIB_IRQCHIP
3313 * Avoid race condition with other code, which tries to lookup
3314 * an IRQ before the irqchip has been properly registered,
3315 * i.e. while gpiochip is still being brought up.
3317 return -EPROBE_DEFER;
3322 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3325 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3326 * @gc: the chip the GPIO to lock belongs to
3327 * @offset: the offset of the GPIO to lock as IRQ
3329 * This is used directly by GPIO drivers that want to lock down
3330 * a certain GPIO line to be used for IRQs.
3332 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3334 struct gpio_desc *desc;
3336 desc = gpiochip_get_desc(gc, offset);
3338 return PTR_ERR(desc);
3341 * If it's fast: flush the direction setting if something changed
3344 if (!gc->can_sleep && gc->get_direction) {
3345 int dir = gpiod_get_direction(desc);
3348 chip_err(gc, "%s: cannot get GPIO direction\n",
3354 /* To be valid for IRQ the line needs to be input or open drain */
3355 if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3356 !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3358 "%s: tried to flag a GPIO set as output for IRQ\n",
3363 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3364 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3367 * If the consumer has not set up a label (such as when the
3368 * IRQ is referenced from .to_irq()) we set up a label here
3369 * so it is clear this is used as an interrupt.
3372 desc_set_label(desc, "interrupt");
3376 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3379 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3380 * @gc: the chip the GPIO to lock belongs to
3381 * @offset: the offset of the GPIO to lock as IRQ
3383 * This is used directly by GPIO drivers that want to indicate
3384 * that a certain GPIO is no longer used exclusively for IRQ.
3386 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3388 struct gpio_desc *desc;
3390 desc = gpiochip_get_desc(gc, offset);
3394 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3395 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3397 /* If we only had this marking, erase it */
3398 if (desc->label && !strcmp(desc->label, "interrupt"))
3399 desc_set_label(desc, NULL);
3401 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3403 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3405 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3407 if (!IS_ERR(desc) &&
3408 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3409 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3411 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3413 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3415 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3417 if (!IS_ERR(desc) &&
3418 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3420 * We must not be output when using IRQ UNLESS we are
3423 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3424 !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3425 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3428 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3430 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3432 if (offset >= gc->ngpio)
3435 return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3437 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3439 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3443 if (!try_module_get(gc->gpiodev->owner))
3446 ret = gpiochip_lock_as_irq(gc, offset);
3448 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3449 module_put(gc->gpiodev->owner);
3454 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3456 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3458 gpiochip_unlock_as_irq(gc, offset);
3459 module_put(gc->gpiodev->owner);
3461 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3463 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3465 if (offset >= gc->ngpio)
3468 return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3470 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3472 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3474 if (offset >= gc->ngpio)
3477 return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3479 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3481 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3483 if (offset >= gc->ngpio)
3486 return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3488 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3491 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3492 * @desc: gpio whose value will be returned
3494 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3495 * its ACTIVE_LOW status, or negative errno on failure.
3497 * This function is to be called from contexts that can sleep.
3499 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3501 might_sleep_if(extra_checks);
3502 VALIDATE_DESC(desc);
3503 return gpiod_get_raw_value_commit(desc);
3505 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3508 * gpiod_get_value_cansleep() - return a gpio's value
3509 * @desc: gpio whose value will be returned
3511 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3512 * account, or negative errno on failure.
3514 * This function is to be called from contexts that can sleep.
3516 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3520 might_sleep_if(extra_checks);
3521 VALIDATE_DESC(desc);
3522 value = gpiod_get_raw_value_commit(desc);
3526 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3531 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3534 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3535 * @array_size: number of elements in the descriptor array / value bitmap
3536 * @desc_array: array of GPIO descriptors whose values will be read
3537 * @array_info: information on applicability of fast bitmap processing path
3538 * @value_bitmap: bitmap to store the read values
3540 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3541 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3542 * else an error code.
3544 * This function is to be called from contexts that can sleep.
3546 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3547 struct gpio_desc **desc_array,
3548 struct gpio_array *array_info,
3549 unsigned long *value_bitmap)
3551 might_sleep_if(extra_checks);
3554 return gpiod_get_array_value_complex(true, true, array_size,
3555 desc_array, array_info,
3558 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3561 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3562 * @array_size: number of elements in the descriptor array / value bitmap
3563 * @desc_array: array of GPIO descriptors whose values will be read
3564 * @array_info: information on applicability of fast bitmap processing path
3565 * @value_bitmap: bitmap to store the read values
3567 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3568 * into account. Return 0 in case of success, else an error code.
3570 * This function is to be called from contexts that can sleep.
3572 int gpiod_get_array_value_cansleep(unsigned int array_size,
3573 struct gpio_desc **desc_array,
3574 struct gpio_array *array_info,
3575 unsigned long *value_bitmap)
3577 might_sleep_if(extra_checks);
3580 return gpiod_get_array_value_complex(false, true, array_size,
3581 desc_array, array_info,
3584 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3587 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3588 * @desc: gpio whose value will be assigned
3589 * @value: value to assign
3591 * Set the raw value of the GPIO, i.e. the value of its physical line without
3592 * regard for its ACTIVE_LOW status.
3594 * This function is to be called from contexts that can sleep.
3596 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3598 might_sleep_if(extra_checks);
3599 VALIDATE_DESC_VOID(desc);
3600 gpiod_set_raw_value_commit(desc, value);
3602 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3605 * gpiod_set_value_cansleep() - assign a gpio's value
3606 * @desc: gpio whose value will be assigned
3607 * @value: value to assign
3609 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3612 * This function is to be called from contexts that can sleep.
3614 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3616 might_sleep_if(extra_checks);
3617 VALIDATE_DESC_VOID(desc);
3618 gpiod_set_value_nocheck(desc, value);
3620 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3623 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3624 * @array_size: number of elements in the descriptor array / value bitmap
3625 * @desc_array: array of GPIO descriptors whose values will be assigned
3626 * @array_info: information on applicability of fast bitmap processing path
3627 * @value_bitmap: bitmap of values to assign
3629 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3630 * without regard for their ACTIVE_LOW status.
3632 * This function is to be called from contexts that can sleep.
3634 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3635 struct gpio_desc **desc_array,
3636 struct gpio_array *array_info,
3637 unsigned long *value_bitmap)
3639 might_sleep_if(extra_checks);
3642 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3643 array_info, value_bitmap);
3645 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3648 * gpiod_add_lookup_tables() - register GPIO device consumers
3649 * @tables: list of tables of consumers to register
3650 * @n: number of tables in the list
3652 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3656 mutex_lock(&gpio_lookup_lock);
3658 for (i = 0; i < n; i++)
3659 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3661 mutex_unlock(&gpio_lookup_lock);
3665 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3666 * @array_size: number of elements in the descriptor array / value bitmap
3667 * @desc_array: array of GPIO descriptors whose values will be assigned
3668 * @array_info: information on applicability of fast bitmap processing path
3669 * @value_bitmap: bitmap of values to assign
3671 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3674 * This function is to be called from contexts that can sleep.
3676 int gpiod_set_array_value_cansleep(unsigned int array_size,
3677 struct gpio_desc **desc_array,
3678 struct gpio_array *array_info,
3679 unsigned long *value_bitmap)
3681 might_sleep_if(extra_checks);
3684 return gpiod_set_array_value_complex(false, true, array_size,
3685 desc_array, array_info,
3688 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3691 * gpiod_add_lookup_table() - register GPIO device consumers
3692 * @table: table of consumers to register
3694 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3696 gpiod_add_lookup_tables(&table, 1);
3698 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3701 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3702 * @table: table of consumers to unregister
3704 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3706 /* Nothing to remove */
3710 mutex_lock(&gpio_lookup_lock);
3712 list_del(&table->list);
3714 mutex_unlock(&gpio_lookup_lock);
3716 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3719 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3720 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3722 void gpiod_add_hogs(struct gpiod_hog *hogs)
3724 struct gpio_chip *gc;
3725 struct gpiod_hog *hog;
3727 mutex_lock(&gpio_machine_hogs_mutex);
3729 for (hog = &hogs[0]; hog->chip_label; hog++) {
3730 list_add_tail(&hog->list, &gpio_machine_hogs);
3733 * The chip may have been registered earlier, so check if it
3734 * exists and, if so, try to hog the line now.
3736 gc = find_chip_by_name(hog->chip_label);
3738 gpiochip_machine_hog(gc, hog);
3741 mutex_unlock(&gpio_machine_hogs_mutex);
3743 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3745 void gpiod_remove_hogs(struct gpiod_hog *hogs)
3747 struct gpiod_hog *hog;
3749 mutex_lock(&gpio_machine_hogs_mutex);
3750 for (hog = &hogs[0]; hog->chip_label; hog++)
3751 list_del(&hog->list);
3752 mutex_unlock(&gpio_machine_hogs_mutex);
3754 EXPORT_SYMBOL_GPL(gpiod_remove_hogs);
3756 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3758 const char *dev_id = dev ? dev_name(dev) : NULL;
3759 struct gpiod_lookup_table *table;
3761 mutex_lock(&gpio_lookup_lock);
3763 list_for_each_entry(table, &gpio_lookup_list, list) {
3764 if (table->dev_id && dev_id) {
3766 * Valid strings on both ends, must be identical to have
3769 if (!strcmp(table->dev_id, dev_id))
3773 * One of the pointers is NULL, so both must be to have
3776 if (dev_id == table->dev_id)
3783 mutex_unlock(&gpio_lookup_lock);
3787 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
3788 unsigned int idx, unsigned long *flags)
3790 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3791 struct gpiod_lookup_table *table;
3792 struct gpiod_lookup *p;
3794 table = gpiod_find_lookup_table(dev);
3798 for (p = &table->table[0]; p->key; p++) {
3799 struct gpio_chip *gc;
3801 /* idx must always match exactly */
3805 /* If the lookup entry has a con_id, require exact match */
3806 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
3809 if (p->chip_hwnum == U16_MAX) {
3810 desc = gpio_name_to_desc(p->key);
3816 dev_warn(dev, "cannot find GPIO line %s, deferring\n",
3818 return ERR_PTR(-EPROBE_DEFER);
3821 gc = find_chip_by_name(p->key);
3825 * As the lookup table indicates a chip with
3826 * p->key should exist, assume it may
3827 * still appear later and let the interested
3828 * consumer be probed again or let the Deferred
3829 * Probe infrastructure handle the error.
3831 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
3833 return ERR_PTR(-EPROBE_DEFER);
3836 if (gc->ngpio <= p->chip_hwnum) {
3838 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
3839 idx, p->chip_hwnum, gc->ngpio - 1,
3841 return ERR_PTR(-EINVAL);
3844 desc = gpiochip_get_desc(gc, p->chip_hwnum);
3853 static int platform_gpio_count(struct device *dev, const char *con_id)
3855 struct gpiod_lookup_table *table;
3856 struct gpiod_lookup *p;
3857 unsigned int count = 0;
3859 table = gpiod_find_lookup_table(dev);
3863 for (p = &table->table[0]; p->key; p++) {
3864 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
3865 (!con_id && !p->con_id))
3874 static struct gpio_desc *gpiod_find_by_fwnode(struct fwnode_handle *fwnode,
3875 struct device *consumer,
3878 enum gpiod_flags *flags,
3879 unsigned long *lookupflags)
3881 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3883 if (is_of_node(fwnode)) {
3884 dev_dbg(consumer, "using DT '%pfw' for '%s' GPIO lookup\n",
3886 desc = of_find_gpio(to_of_node(fwnode), con_id, idx, lookupflags);
3887 } else if (is_acpi_node(fwnode)) {
3888 dev_dbg(consumer, "using ACPI '%pfw' for '%s' GPIO lookup\n",
3890 desc = acpi_find_gpio(fwnode, con_id, idx, flags, lookupflags);
3891 } else if (is_software_node(fwnode)) {
3892 dev_dbg(consumer, "using swnode '%pfw' for '%s' GPIO lookup\n",
3894 desc = swnode_find_gpio(fwnode, con_id, idx, lookupflags);
3900 static struct gpio_desc *gpiod_find_and_request(struct device *consumer,
3901 struct fwnode_handle *fwnode,
3904 enum gpiod_flags flags,
3906 bool platform_lookup_allowed)
3908 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
3909 struct gpio_desc *desc = ERR_PTR(-ENOENT);
3912 if (!IS_ERR_OR_NULL(fwnode))
3913 desc = gpiod_find_by_fwnode(fwnode, consumer, con_id, idx,
3914 &flags, &lookupflags);
3916 if (gpiod_not_found(desc) && platform_lookup_allowed) {
3918 * Either we are not using DT or ACPI, or their lookup did not
3919 * return a result. In that case, use platform lookup as a
3922 dev_dbg(consumer, "using lookup tables for GPIO lookup\n");
3923 desc = gpiod_find(consumer, con_id, idx, &lookupflags);
3927 dev_dbg(consumer, "No GPIO consumer %s found\n", con_id);
3932 * If a connection label was passed use that, else attempt to use
3933 * the device name as label
3935 ret = gpiod_request(desc, label);
3937 if (!(ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE))
3938 return ERR_PTR(ret);
3941 * This happens when there are several consumers for
3942 * the same GPIO line: we just return here without
3943 * further initialization. It is a bit of a hack.
3944 * This is necessary to support fixed regulators.
3946 * FIXME: Make this more sane and safe.
3949 "nonexclusive access to GPIO for %s\n", con_id);
3953 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
3955 dev_dbg(consumer, "setup of GPIO %s failed\n", con_id);
3957 return ERR_PTR(ret);
3960 blocking_notifier_call_chain(&desc->gdev->notifier,
3961 GPIOLINE_CHANGED_REQUESTED, desc);
3967 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
3968 * @fwnode: handle of the firmware node
3969 * @con_id: function within the GPIO consumer
3970 * @index: index of the GPIO to obtain for the consumer
3971 * @flags: GPIO initialization flags
3972 * @label: label to attach to the requested GPIO
3974 * This function can be used for drivers that get their configuration
3975 * from opaque firmware.
3977 * The function properly finds the corresponding GPIO using whatever is the
3978 * underlying firmware interface and then makes sure that the GPIO
3979 * descriptor is requested before it is returned to the caller.
3982 * On successful request the GPIO pin is configured in accordance with
3985 * In case of error an ERR_PTR() is returned.
3987 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
3990 enum gpiod_flags flags,
3993 return gpiod_find_and_request(NULL, fwnode, con_id, index, flags, label, false);
3995 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
3998 * gpiod_count - return the number of GPIOs associated with a device / function
3999 * or -ENOENT if no GPIO has been assigned to the requested function
4000 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4001 * @con_id: function within the GPIO consumer
4003 int gpiod_count(struct device *dev, const char *con_id)
4005 const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
4006 int count = -ENOENT;
4008 if (is_of_node(fwnode))
4009 count = of_gpio_get_count(dev, con_id);
4010 else if (is_acpi_node(fwnode))
4011 count = acpi_gpio_count(dev, con_id);
4012 else if (is_software_node(fwnode))
4013 count = swnode_gpio_count(fwnode, con_id);
4016 count = platform_gpio_count(dev, con_id);
4020 EXPORT_SYMBOL_GPL(gpiod_count);
4023 * gpiod_get - obtain a GPIO for a given GPIO function
4024 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4025 * @con_id: function within the GPIO consumer
4026 * @flags: optional GPIO initialization flags
4028 * Return the GPIO descriptor corresponding to the function con_id of device
4029 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
4030 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
4032 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
4033 enum gpiod_flags flags)
4035 return gpiod_get_index(dev, con_id, 0, flags);
4037 EXPORT_SYMBOL_GPL(gpiod_get);
4040 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
4041 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4042 * @con_id: function within the GPIO consumer
4043 * @flags: optional GPIO initialization flags
4045 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
4046 * the requested function it will return NULL. This is convenient for drivers
4047 * that need to handle optional GPIOs.
4049 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
4051 enum gpiod_flags flags)
4053 return gpiod_get_index_optional(dev, con_id, 0, flags);
4055 EXPORT_SYMBOL_GPL(gpiod_get_optional);
4059 * gpiod_configure_flags - helper function to configure a given GPIO
4060 * @desc: gpio whose value will be assigned
4061 * @con_id: function within the GPIO consumer
4062 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4063 * of_find_gpio() or of_get_gpio_hog()
4064 * @dflags: gpiod_flags - optional GPIO initialization flags
4066 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
4067 * requested function and/or index, or another IS_ERR() code if an error
4068 * occurred while trying to acquire the GPIO.
4070 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
4071 unsigned long lflags, enum gpiod_flags dflags)
4075 if (lflags & GPIO_ACTIVE_LOW)
4076 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
4078 if (lflags & GPIO_OPEN_DRAIN)
4079 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
4080 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
4082 * This enforces open drain mode from the consumer side.
4083 * This is necessary for some busses like I2C, but the lookup
4084 * should *REALLY* have specified them as open drain in the
4085 * first place, so print a little warning here.
4087 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
4089 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
4092 if (lflags & GPIO_OPEN_SOURCE)
4093 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
4095 if (((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) ||
4096 ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DISABLE)) ||
4097 ((lflags & GPIO_PULL_DOWN) && (lflags & GPIO_PULL_DISABLE))) {
4099 "multiple pull-up, pull-down or pull-disable enabled, invalid configuration\n");
4103 if (lflags & GPIO_PULL_UP)
4104 set_bit(FLAG_PULL_UP, &desc->flags);
4105 else if (lflags & GPIO_PULL_DOWN)
4106 set_bit(FLAG_PULL_DOWN, &desc->flags);
4107 else if (lflags & GPIO_PULL_DISABLE)
4108 set_bit(FLAG_BIAS_DISABLE, &desc->flags);
4110 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
4114 /* No particular flag request, return here... */
4115 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
4116 gpiod_dbg(desc, "no flags found for %s\n", con_id);
4121 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
4122 ret = gpiod_direction_output(desc,
4123 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
4125 ret = gpiod_direction_input(desc);
4131 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
4132 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4133 * @con_id: function within the GPIO consumer
4134 * @idx: index of the GPIO to obtain in the consumer
4135 * @flags: optional GPIO initialization flags
4137 * This variant of gpiod_get() allows to access GPIOs other than the first
4138 * defined one for functions that define several GPIOs.
4140 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
4141 * requested function and/or index, or another IS_ERR() code if an error
4142 * occurred while trying to acquire the GPIO.
4144 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
4147 enum gpiod_flags flags)
4149 struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
4150 const char *devname = dev ? dev_name(dev) : "?";
4151 const char *label = con_id ?: devname;
4153 return gpiod_find_and_request(dev, fwnode, con_id, idx, flags, label, true);
4155 EXPORT_SYMBOL_GPL(gpiod_get_index);
4158 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
4160 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4161 * @con_id: function within the GPIO consumer
4162 * @index: index of the GPIO to obtain in the consumer
4163 * @flags: optional GPIO initialization flags
4165 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
4166 * specified index was assigned to the requested function it will return NULL.
4167 * This is convenient for drivers that need to handle optional GPIOs.
4169 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
4172 enum gpiod_flags flags)
4174 struct gpio_desc *desc;
4176 desc = gpiod_get_index(dev, con_id, index, flags);
4177 if (gpiod_not_found(desc))
4182 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
4185 * gpiod_hog - Hog the specified GPIO desc given the provided flags
4186 * @desc: gpio whose value will be assigned
4187 * @name: gpio line name
4188 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4189 * of_find_gpio() or of_get_gpio_hog()
4190 * @dflags: gpiod_flags - optional GPIO initialization flags
4192 int gpiod_hog(struct gpio_desc *desc, const char *name,
4193 unsigned long lflags, enum gpiod_flags dflags)
4195 struct gpio_chip *gc;
4196 struct gpio_desc *local_desc;
4200 gc = gpiod_to_chip(desc);
4201 hwnum = gpio_chip_hwgpio(desc);
4203 local_desc = gpiochip_request_own_desc(gc, hwnum, name,
4205 if (IS_ERR(local_desc)) {
4206 ret = PTR_ERR(local_desc);
4207 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4208 name, gc->label, hwnum, ret);
4212 /* Mark GPIO as hogged so it can be identified and removed later */
4213 set_bit(FLAG_IS_HOGGED, &desc->flags);
4215 gpiod_info(desc, "hogged as %s%s\n",
4216 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4217 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4218 (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4224 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4225 * @gc: gpio chip to act on
4227 static void gpiochip_free_hogs(struct gpio_chip *gc)
4229 struct gpio_desc *desc;
4231 for_each_gpio_desc_with_flag(gc, desc, FLAG_IS_HOGGED)
4232 gpiochip_free_own_desc(desc);
4236 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4237 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4238 * @con_id: function within the GPIO consumer
4239 * @flags: optional GPIO initialization flags
4241 * This function acquires all the GPIOs defined under a given function.
4243 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4244 * no GPIO has been assigned to the requested function, or another IS_ERR()
4245 * code if an error occurred while trying to acquire the GPIOs.
4247 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4249 enum gpiod_flags flags)
4251 struct gpio_desc *desc;
4252 struct gpio_descs *descs;
4253 struct gpio_array *array_info = NULL;
4254 struct gpio_chip *gc;
4255 int count, bitmap_size;
4257 count = gpiod_count(dev, con_id);
4259 return ERR_PTR(count);
4261 descs = kzalloc(struct_size(descs, desc, count), GFP_KERNEL);
4263 return ERR_PTR(-ENOMEM);
4265 for (descs->ndescs = 0; descs->ndescs < count; ) {
4266 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4268 gpiod_put_array(descs);
4269 return ERR_CAST(desc);
4272 descs->desc[descs->ndescs] = desc;
4274 gc = gpiod_to_chip(desc);
4276 * If pin hardware number of array member 0 is also 0, select
4277 * its chip as a candidate for fast bitmap processing path.
4279 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4280 struct gpio_descs *array;
4282 bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4285 array = kzalloc(struct_size(descs, desc, count) +
4286 struct_size(array_info, invert_mask,
4287 3 * bitmap_size), GFP_KERNEL);
4289 gpiod_put_array(descs);
4290 return ERR_PTR(-ENOMEM);
4293 memcpy(array, descs,
4294 struct_size(descs, desc, descs->ndescs + 1));
4298 array_info = (void *)(descs->desc + count);
4299 array_info->get_mask = array_info->invert_mask +
4301 array_info->set_mask = array_info->get_mask +
4304 array_info->desc = descs->desc;
4305 array_info->size = count;
4306 array_info->chip = gc;
4307 bitmap_set(array_info->get_mask, descs->ndescs,
4308 count - descs->ndescs);
4309 bitmap_set(array_info->set_mask, descs->ndescs,
4310 count - descs->ndescs);
4311 descs->info = array_info;
4313 /* Unmark array members which don't belong to the 'fast' chip */
4314 if (array_info && array_info->chip != gc) {
4315 __clear_bit(descs->ndescs, array_info->get_mask);
4316 __clear_bit(descs->ndescs, array_info->set_mask);
4319 * Detect array members which belong to the 'fast' chip
4320 * but their pins are not in hardware order.
4322 else if (array_info &&
4323 gpio_chip_hwgpio(desc) != descs->ndescs) {
4325 * Don't use fast path if all array members processed so
4326 * far belong to the same chip as this one but its pin
4327 * hardware number is different from its array index.
4329 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4332 __clear_bit(descs->ndescs,
4333 array_info->get_mask);
4334 __clear_bit(descs->ndescs,
4335 array_info->set_mask);
4337 } else if (array_info) {
4338 /* Exclude open drain or open source from fast output */
4339 if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4340 gpiochip_line_is_open_source(gc, descs->ndescs))
4341 __clear_bit(descs->ndescs,
4342 array_info->set_mask);
4343 /* Identify 'fast' pins which require invertion */
4344 if (gpiod_is_active_low(desc))
4345 __set_bit(descs->ndescs,
4346 array_info->invert_mask);
4353 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4354 array_info->chip->label, array_info->size,
4355 *array_info->get_mask, *array_info->set_mask,
4356 *array_info->invert_mask);
4359 EXPORT_SYMBOL_GPL(gpiod_get_array);
4362 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4364 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4365 * @con_id: function within the GPIO consumer
4366 * @flags: optional GPIO initialization flags
4368 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4369 * assigned to the requested function it will return NULL.
4371 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4373 enum gpiod_flags flags)
4375 struct gpio_descs *descs;
4377 descs = gpiod_get_array(dev, con_id, flags);
4378 if (gpiod_not_found(descs))
4383 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4386 * gpiod_put - dispose of a GPIO descriptor
4387 * @desc: GPIO descriptor to dispose of
4389 * No descriptor can be used after gpiod_put() has been called on it.
4391 void gpiod_put(struct gpio_desc *desc)
4396 EXPORT_SYMBOL_GPL(gpiod_put);
4399 * gpiod_put_array - dispose of multiple GPIO descriptors
4400 * @descs: struct gpio_descs containing an array of descriptors
4402 void gpiod_put_array(struct gpio_descs *descs)
4406 for (i = 0; i < descs->ndescs; i++)
4407 gpiod_put(descs->desc[i]);
4411 EXPORT_SYMBOL_GPL(gpiod_put_array);
4414 static int gpio_bus_match(struct device *dev, struct device_driver *drv)
4416 struct fwnode_handle *fwnode = dev_fwnode(dev);
4419 * Only match if the fwnode doesn't already have a proper struct device
4422 if (fwnode && fwnode->dev != dev)
4427 static int gpio_stub_drv_probe(struct device *dev)
4430 * The DT node of some GPIO chips have a "compatible" property, but
4431 * never have a struct device added and probed by a driver to register
4432 * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4433 * the consumers of the GPIO chip to get probe deferred forever because
4434 * they will be waiting for a device associated with the GPIO chip
4435 * firmware node to get added and bound to a driver.
4437 * To allow these consumers to probe, we associate the struct
4438 * gpio_device of the GPIO chip with the firmware node and then simply
4439 * bind it to this stub driver.
4444 static struct device_driver gpio_stub_drv = {
4445 .name = "gpio_stub_drv",
4446 .bus = &gpio_bus_type,
4447 .probe = gpio_stub_drv_probe,
4450 static int __init gpiolib_dev_init(void)
4454 /* Register GPIO sysfs bus */
4455 ret = bus_register(&gpio_bus_type);
4457 pr_err("gpiolib: could not register GPIO bus type\n");
4461 ret = driver_register(&gpio_stub_drv);
4463 pr_err("gpiolib: could not register GPIO stub driver\n");
4464 bus_unregister(&gpio_bus_type);
4468 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4470 pr_err("gpiolib: failed to allocate char dev region\n");
4471 driver_unregister(&gpio_stub_drv);
4472 bus_unregister(&gpio_bus_type);
4476 gpiolib_initialized = true;
4477 gpiochip_setup_devs();
4479 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4480 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4481 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4485 core_initcall(gpiolib_dev_init);
4487 #ifdef CONFIG_DEBUG_FS
4489 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4491 struct gpio_chip *gc = gdev->chip;
4492 struct gpio_desc *desc;
4493 unsigned gpio = gdev->base;
4499 for_each_gpio_desc(gc, desc) {
4500 if (test_bit(FLAG_REQUESTED, &desc->flags)) {
4501 gpiod_get_direction(desc);
4502 is_out = test_bit(FLAG_IS_OUT, &desc->flags);
4503 value = gpio_chip_get_value(gc, desc);
4504 is_irq = test_bit(FLAG_USED_AS_IRQ, &desc->flags);
4505 active_low = test_bit(FLAG_ACTIVE_LOW, &desc->flags);
4506 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s\n",
4507 gpio, desc->name ?: "", desc->label,
4508 is_out ? "out" : "in ",
4509 value >= 0 ? (value ? "hi" : "lo") : "? ",
4510 is_irq ? "IRQ " : "",
4511 active_low ? "ACTIVE LOW" : "");
4512 } else if (desc->name) {
4513 seq_printf(s, " gpio-%-3d (%-20.20s)\n", gpio, desc->name);
4520 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4522 unsigned long flags;
4523 struct gpio_device *gdev = NULL;
4524 loff_t index = *pos;
4528 spin_lock_irqsave(&gpio_lock, flags);
4529 list_for_each_entry(gdev, &gpio_devices, list)
4531 spin_unlock_irqrestore(&gpio_lock, flags);
4534 spin_unlock_irqrestore(&gpio_lock, flags);
4539 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4541 unsigned long flags;
4542 struct gpio_device *gdev = v;
4545 spin_lock_irqsave(&gpio_lock, flags);
4546 if (list_is_last(&gdev->list, &gpio_devices))
4549 ret = list_first_entry(&gdev->list, struct gpio_device, list);
4550 spin_unlock_irqrestore(&gpio_lock, flags);
4558 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4562 static int gpiolib_seq_show(struct seq_file *s, void *v)
4564 struct gpio_device *gdev = v;
4565 struct gpio_chip *gc = gdev->chip;
4566 struct device *parent;
4569 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4570 dev_name(&gdev->dev));
4574 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4575 dev_name(&gdev->dev),
4576 gdev->base, gdev->base + gdev->ngpio - 1);
4577 parent = gc->parent;
4579 seq_printf(s, ", parent: %s/%s",
4580 parent->bus ? parent->bus->name : "no-bus",
4583 seq_printf(s, ", %s", gc->label);
4585 seq_printf(s, ", can sleep");
4586 seq_printf(s, ":\n");
4589 gc->dbg_show(s, gc);
4591 gpiolib_dbg_show(s, gdev);
4596 static const struct seq_operations gpiolib_sops = {
4597 .start = gpiolib_seq_start,
4598 .next = gpiolib_seq_next,
4599 .stop = gpiolib_seq_stop,
4600 .show = gpiolib_seq_show,
4602 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4604 static int __init gpiolib_debugfs_init(void)
4606 /* /sys/kernel/debug/gpio */
4607 debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4610 subsys_initcall(gpiolib_debugfs_init);
4612 #endif /* DEBUG_FS */