1 // SPDX-License-Identifier: GPL-2.0
3 #include <linux/acpi.h>
4 #include <linux/bitmap.h>
5 #include <linux/compat.h>
6 #include <linux/debugfs.h>
7 #include <linux/device.h>
9 #include <linux/errno.h>
10 #include <linux/file.h>
12 #include <linux/idr.h>
13 #include <linux/interrupt.h>
14 #include <linux/irq.h>
15 #include <linux/kernel.h>
16 #include <linux/list.h>
17 #include <linux/module.h>
19 #include <linux/pinctrl/consumer.h>
20 #include <linux/seq_file.h>
21 #include <linux/slab.h>
22 #include <linux/spinlock.h>
23 #include <linux/string.h>
25 #include <linux/gpio.h>
26 #include <linux/gpio/driver.h>
27 #include <linux/gpio/machine.h>
29 #include <uapi/linux/gpio.h>
31 #include "gpiolib-acpi.h"
32 #include "gpiolib-cdev.h"
33 #include "gpiolib-of.h"
34 #include "gpiolib-swnode.h"
35 #include "gpiolib-sysfs.h"
38 #define CREATE_TRACE_POINTS
39 #include <trace/events/gpio.h>
41 /* Implementation infrastructure for GPIO interfaces.
43 * The GPIO programming interface allows for inlining speed-critical
44 * get/set operations for common cases, so that access to SOC-integrated
45 * GPIOs can sometimes cost only an instruction or two per bit.
48 /* Device and char device-related information */
49 static DEFINE_IDA(gpio_ida);
50 static dev_t gpio_devt;
51 #define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
53 static int gpio_bus_match(struct device *dev, struct device_driver *drv)
55 struct fwnode_handle *fwnode = dev_fwnode(dev);
58 * Only match if the fwnode doesn't already have a proper struct device
61 if (fwnode && fwnode->dev != dev)
66 static struct bus_type gpio_bus_type = {
68 .match = gpio_bus_match,
72 * Number of GPIOs to use for the fast path in set array
74 #define FASTPATH_NGPIO CONFIG_GPIOLIB_FASTPATH_LIMIT
76 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
77 * While any GPIO is requested, its gpio_chip is not removable;
78 * each GPIO's "requested" flag serves as a lock and refcount.
80 DEFINE_SPINLOCK(gpio_lock);
82 static DEFINE_MUTEX(gpio_lookup_lock);
83 static LIST_HEAD(gpio_lookup_list);
84 LIST_HEAD(gpio_devices);
86 static DEFINE_MUTEX(gpio_machine_hogs_mutex);
87 static LIST_HEAD(gpio_machine_hogs);
89 static void gpiochip_free_hogs(struct gpio_chip *gc);
90 static int gpiochip_add_irqchip(struct gpio_chip *gc,
91 struct lock_class_key *lock_key,
92 struct lock_class_key *request_key);
93 static void gpiochip_irqchip_remove(struct gpio_chip *gc);
94 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc);
95 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc);
96 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc);
98 static bool gpiolib_initialized;
100 static inline void desc_set_label(struct gpio_desc *d, const char *label)
106 * gpio_to_desc - Convert a GPIO number to its descriptor
107 * @gpio: global GPIO number
110 * The GPIO descriptor associated with the given GPIO, or %NULL if no GPIO
111 * with the given number exists in the system.
113 struct gpio_desc *gpio_to_desc(unsigned gpio)
115 struct gpio_device *gdev;
118 spin_lock_irqsave(&gpio_lock, flags);
120 list_for_each_entry(gdev, &gpio_devices, list) {
121 if (gdev->base <= gpio &&
122 gdev->base + gdev->ngpio > gpio) {
123 spin_unlock_irqrestore(&gpio_lock, flags);
124 return &gdev->descs[gpio - gdev->base];
128 spin_unlock_irqrestore(&gpio_lock, flags);
130 if (!gpio_is_valid(gpio))
131 pr_warn("invalid GPIO %d\n", gpio);
135 EXPORT_SYMBOL_GPL(gpio_to_desc);
137 /* This function is deprecated and will be removed soon, don't use. */
138 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc,
141 return gpio_device_get_desc(gc->gpiodev, hwnum);
143 EXPORT_SYMBOL_GPL(gpiochip_get_desc);
146 * gpio_device_get_desc() - get the GPIO descriptor corresponding to the given
147 * hardware number for this GPIO device
148 * @gdev: GPIO device to get the descriptor from
149 * @hwnum: hardware number of the GPIO for this chip
152 * A pointer to the GPIO descriptor or %EINVAL if no GPIO exists in the given
153 * chip for the specified hardware number or %ENODEV if the underlying chip
156 * The reference count of struct gpio_device is *NOT* increased like when the
157 * GPIO is being requested for exclusive usage. It's up to the caller to make
158 * sure the GPIO device will stay alive together with the descriptor returned
162 gpio_device_get_desc(struct gpio_device *gdev, unsigned int hwnum)
164 struct gpio_chip *gc;
167 * FIXME: This will be locked once we protect gdev->chip everywhere
172 return ERR_PTR(-ENODEV);
174 if (hwnum >= gdev->ngpio)
175 return ERR_PTR(-EINVAL);
177 return &gdev->descs[hwnum];
179 EXPORT_SYMBOL_GPL(gpio_device_get_desc);
182 * desc_to_gpio - convert a GPIO descriptor to the integer namespace
183 * @desc: GPIO descriptor
185 * This should disappear in the future but is needed since we still
186 * use GPIO numbers for error messages and sysfs nodes.
189 * The global GPIO number for the GPIO specified by its descriptor.
191 int desc_to_gpio(const struct gpio_desc *desc)
193 return desc->gdev->base + (desc - &desc->gdev->descs[0]);
195 EXPORT_SYMBOL_GPL(desc_to_gpio);
199 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
200 * @desc: descriptor to return the chip of
202 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
204 if (!desc || !desc->gdev)
206 return desc->gdev->chip;
208 EXPORT_SYMBOL_GPL(gpiod_to_chip);
211 * gpiod_to_gpio_device() - Return the GPIO device to which this descriptor
213 * @desc: Descriptor for which to return the GPIO device.
215 * This *DOES NOT* increase the reference count of the GPIO device as it's
216 * expected that the descriptor is requested and the users already holds a
217 * reference to the device.
220 * Address of the GPIO device owning this descriptor.
222 struct gpio_device *gpiod_to_gpio_device(struct gpio_desc *desc)
229 EXPORT_SYMBOL_GPL(gpiod_to_gpio_device);
232 * gpio_device_get_base() - Get the base GPIO number allocated by this device
236 * First GPIO number in the global GPIO numberspace for this device.
238 int gpio_device_get_base(struct gpio_device *gdev)
242 EXPORT_SYMBOL_GPL(gpio_device_get_base);
245 * gpio_device_get_label() - Get the label of this GPIO device
249 * Pointer to the string containing the GPIO device label. The string's
250 * lifetime is tied to that of the underlying GPIO device.
252 const char *gpio_device_get_label(struct gpio_device *gdev)
256 EXPORT_SYMBOL(gpio_device_get_label);
259 * gpio_device_get_chip() - Get the gpio_chip implementation of this GPIO device
263 * Address of the GPIO chip backing this device.
265 * Until we can get rid of all non-driver users of struct gpio_chip, we must
266 * provide a way of retrieving the pointer to it from struct gpio_device. This
267 * is *NOT* safe as the GPIO API is considered to be hot-unpluggable and the
268 * chip can dissapear at any moment (unlike reference-counted struct
271 * Use at your own risk.
273 struct gpio_chip *gpio_device_get_chip(struct gpio_device *gdev)
277 EXPORT_SYMBOL_GPL(gpio_device_get_chip);
279 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
280 static int gpiochip_find_base_unlocked(int ngpio)
282 struct gpio_device *gdev;
283 int base = GPIO_DYNAMIC_BASE;
285 list_for_each_entry(gdev, &gpio_devices, list) {
286 /* found a free space? */
287 if (gdev->base >= base + ngpio)
289 /* nope, check the space right after the chip */
290 base = gdev->base + gdev->ngpio;
291 if (base < GPIO_DYNAMIC_BASE)
292 base = GPIO_DYNAMIC_BASE;
295 if (gpio_is_valid(base)) {
296 pr_debug("%s: found new base at %d\n", __func__, base);
299 pr_err("%s: cannot find free range\n", __func__);
305 * gpiod_get_direction - return the current direction of a GPIO
306 * @desc: GPIO to get the direction of
308 * Returns 0 for output, 1 for input, or an error code in case of error.
310 * This function may sleep if gpiod_cansleep() is true.
312 int gpiod_get_direction(struct gpio_desc *desc)
314 struct gpio_chip *gc;
318 gc = gpiod_to_chip(desc);
319 offset = gpio_chip_hwgpio(desc);
322 * Open drain emulation using input mode may incorrectly report
323 * input here, fix that up.
325 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) &&
326 test_bit(FLAG_IS_OUT, &desc->flags))
329 if (!gc->get_direction)
332 ret = gc->get_direction(gc, offset);
336 /* GPIOF_DIR_IN or other positive, otherwise GPIOF_DIR_OUT */
340 assign_bit(FLAG_IS_OUT, &desc->flags, !ret);
344 EXPORT_SYMBOL_GPL(gpiod_get_direction);
347 * Add a new chip to the global chips list, keeping the list of chips sorted
348 * by range(means [base, base + ngpio - 1]) order.
350 * Return -EBUSY if the new chip overlaps with some other chip's integer
353 static int gpiodev_add_to_list_unlocked(struct gpio_device *gdev)
355 struct gpio_device *prev, *next;
357 if (list_empty(&gpio_devices)) {
358 /* initial entry in list */
359 list_add_tail(&gdev->list, &gpio_devices);
363 next = list_first_entry(&gpio_devices, struct gpio_device, list);
364 if (gdev->base + gdev->ngpio <= next->base) {
365 /* add before first entry */
366 list_add(&gdev->list, &gpio_devices);
370 prev = list_last_entry(&gpio_devices, struct gpio_device, list);
371 if (prev->base + prev->ngpio <= gdev->base) {
372 /* add behind last entry */
373 list_add_tail(&gdev->list, &gpio_devices);
377 list_for_each_entry_safe(prev, next, &gpio_devices, list) {
378 /* at the end of the list */
379 if (&next->list == &gpio_devices)
382 /* add between prev and next */
383 if (prev->base + prev->ngpio <= gdev->base
384 && gdev->base + gdev->ngpio <= next->base) {
385 list_add(&gdev->list, &prev->list);
394 * Convert a GPIO name to its descriptor
395 * Note that there is no guarantee that GPIO names are globally unique!
396 * Hence this function will return, if it exists, a reference to the first GPIO
397 * line found that matches the given name.
399 static struct gpio_desc *gpio_name_to_desc(const char * const name)
401 struct gpio_device *gdev;
407 spin_lock_irqsave(&gpio_lock, flags);
409 list_for_each_entry(gdev, &gpio_devices, list) {
410 struct gpio_desc *desc;
412 for_each_gpio_desc(gdev->chip, desc) {
413 if (desc->name && !strcmp(desc->name, name)) {
414 spin_unlock_irqrestore(&gpio_lock, flags);
420 spin_unlock_irqrestore(&gpio_lock, flags);
426 * Take the names from gc->names and assign them to their GPIO descriptors.
427 * Warn if a name is already used for a GPIO line on a different GPIO chip.
430 * 1. Non-unique names are still accepted,
431 * 2. Name collisions within the same GPIO chip are not reported.
433 static int gpiochip_set_desc_names(struct gpio_chip *gc)
435 struct gpio_device *gdev = gc->gpiodev;
438 /* First check all names if they are unique */
439 for (i = 0; i != gc->ngpio; ++i) {
440 struct gpio_desc *gpio;
442 gpio = gpio_name_to_desc(gc->names[i]);
445 "Detected name collision for GPIO name '%s'\n",
449 /* Then add all names to the GPIO descriptors */
450 for (i = 0; i != gc->ngpio; ++i)
451 gdev->descs[i].name = gc->names[i];
457 * gpiochip_set_names - Set GPIO line names using device properties
458 * @chip: GPIO chip whose lines should be named, if possible
460 * Looks for device property "gpio-line-names" and if it exists assigns
461 * GPIO line names for the chip. The memory allocated for the assigned
462 * names belong to the underlying firmware node and should not be released
465 static int gpiochip_set_names(struct gpio_chip *chip)
467 struct gpio_device *gdev = chip->gpiodev;
468 struct device *dev = &gdev->dev;
473 count = device_property_string_array_count(dev, "gpio-line-names");
478 * When offset is set in the driver side we assume the driver internally
479 * is using more than one gpiochip per the same device. We have to stop
480 * setting friendly names if the specified ones with 'gpio-line-names'
481 * are less than the offset in the device itself. This means all the
482 * lines are not present for every single pin within all the internal
485 if (count <= chip->offset) {
486 dev_warn(dev, "gpio-line-names too short (length %d), cannot map names for the gpiochip at offset %u\n",
487 count, chip->offset);
491 names = kcalloc(count, sizeof(*names), GFP_KERNEL);
495 ret = device_property_read_string_array(dev, "gpio-line-names",
498 dev_warn(dev, "failed to read GPIO line names\n");
504 * When more that one gpiochip per device is used, 'count' can
505 * contain at most number gpiochips x chip->ngpio. We have to
506 * correctly distribute all defined lines taking into account
507 * chip->offset as starting point from where we will assign
508 * the names to pins from the 'names' array. Since property
509 * 'gpio-line-names' cannot contains gaps, we have to be sure
510 * we only assign those pins that really exists since chip->ngpio
511 * can be different of the chip->offset.
513 count = (count > chip->offset) ? count - chip->offset : count;
514 if (count > chip->ngpio)
517 for (i = 0; i < count; i++) {
519 * Allow overriding "fixed" names provided by the GPIO
520 * provider. The "fixed" names are more often than not
521 * generic and less informative than the names given in
524 if (names[chip->offset + i] && names[chip->offset + i][0])
525 gdev->descs[i].name = names[chip->offset + i];
533 static unsigned long *gpiochip_allocate_mask(struct gpio_chip *gc)
537 p = bitmap_alloc(gc->ngpio, GFP_KERNEL);
541 /* Assume by default all GPIOs are valid */
542 bitmap_fill(p, gc->ngpio);
547 static void gpiochip_free_mask(unsigned long **p)
553 static unsigned int gpiochip_count_reserved_ranges(struct gpio_chip *gc)
555 struct device *dev = &gc->gpiodev->dev;
558 /* Format is "start, count, ..." */
559 size = device_property_count_u32(dev, "gpio-reserved-ranges");
560 if (size > 0 && size % 2 == 0)
566 static int gpiochip_apply_reserved_ranges(struct gpio_chip *gc)
568 struct device *dev = &gc->gpiodev->dev;
573 size = gpiochip_count_reserved_ranges(gc);
577 ranges = kmalloc_array(size, sizeof(*ranges), GFP_KERNEL);
581 ret = device_property_read_u32_array(dev, "gpio-reserved-ranges",
589 u32 count = ranges[--size];
590 u32 start = ranges[--size];
592 if (start >= gc->ngpio || start + count > gc->ngpio)
595 bitmap_clear(gc->valid_mask, start, count);
602 static int gpiochip_init_valid_mask(struct gpio_chip *gc)
606 if (!(gpiochip_count_reserved_ranges(gc) || gc->init_valid_mask))
609 gc->valid_mask = gpiochip_allocate_mask(gc);
613 ret = gpiochip_apply_reserved_ranges(gc);
617 if (gc->init_valid_mask)
618 return gc->init_valid_mask(gc,
625 static void gpiochip_free_valid_mask(struct gpio_chip *gc)
627 gpiochip_free_mask(&gc->valid_mask);
630 static int gpiochip_add_pin_ranges(struct gpio_chip *gc)
633 * Device Tree platforms are supposed to use "gpio-ranges"
634 * property. This check ensures that the ->add_pin_ranges()
635 * won't be called for them.
637 if (device_property_present(&gc->gpiodev->dev, "gpio-ranges"))
640 if (gc->add_pin_ranges)
641 return gc->add_pin_ranges(gc);
646 bool gpiochip_line_is_valid(const struct gpio_chip *gc,
649 /* No mask means all valid */
650 if (likely(!gc->valid_mask))
652 return test_bit(offset, gc->valid_mask);
654 EXPORT_SYMBOL_GPL(gpiochip_line_is_valid);
656 static void gpiodev_release(struct device *dev)
658 struct gpio_device *gdev = to_gpio_device(dev);
660 ida_free(&gpio_ida, gdev->id);
661 kfree_const(gdev->label);
666 #ifdef CONFIG_GPIO_CDEV
667 #define gcdev_register(gdev, devt) gpiolib_cdev_register((gdev), (devt))
668 #define gcdev_unregister(gdev) gpiolib_cdev_unregister((gdev))
671 * gpiolib_cdev_register() indirectly calls device_add(), which is still
672 * required even when cdev is not selected.
674 #define gcdev_register(gdev, devt) device_add(&(gdev)->dev)
675 #define gcdev_unregister(gdev) device_del(&(gdev)->dev)
678 static int gpiochip_setup_dev(struct gpio_device *gdev)
680 struct fwnode_handle *fwnode = dev_fwnode(&gdev->dev);
684 * If fwnode doesn't belong to another device, it's safe to clear its
687 if (fwnode && !fwnode->dev)
688 fwnode_dev_initialized(fwnode, false);
690 ret = gcdev_register(gdev, gpio_devt);
694 /* From this point, the .release() function cleans up gpio_device */
695 gdev->dev.release = gpiodev_release;
697 ret = gpiochip_sysfs_register(gdev);
699 goto err_remove_device;
701 dev_dbg(&gdev->dev, "registered GPIOs %d to %d on %s\n", gdev->base,
702 gdev->base + gdev->ngpio - 1, gdev->chip->label ? : "generic");
707 gcdev_unregister(gdev);
711 static void gpiochip_machine_hog(struct gpio_chip *gc, struct gpiod_hog *hog)
713 struct gpio_desc *desc;
716 desc = gpiochip_get_desc(gc, hog->chip_hwnum);
718 chip_err(gc, "%s: unable to get GPIO desc: %ld\n", __func__,
723 if (test_bit(FLAG_IS_HOGGED, &desc->flags))
726 rv = gpiod_hog(desc, hog->line_name, hog->lflags, hog->dflags);
728 gpiod_err(desc, "%s: unable to hog GPIO line (%s:%u): %d\n",
729 __func__, gc->label, hog->chip_hwnum, rv);
732 static void machine_gpiochip_add(struct gpio_chip *gc)
734 struct gpiod_hog *hog;
736 mutex_lock(&gpio_machine_hogs_mutex);
738 list_for_each_entry(hog, &gpio_machine_hogs, list) {
739 if (!strcmp(gc->label, hog->chip_label))
740 gpiochip_machine_hog(gc, hog);
743 mutex_unlock(&gpio_machine_hogs_mutex);
746 static void gpiochip_setup_devs(void)
748 struct gpio_device *gdev;
751 list_for_each_entry(gdev, &gpio_devices, list) {
752 ret = gpiochip_setup_dev(gdev);
755 "Failed to initialize gpio device (%d)\n", ret);
759 static void gpiochip_set_data(struct gpio_chip *gc, void *data)
761 gc->gpiodev->data = data;
765 * gpiochip_get_data() - get per-subdriver data for the chip
769 * The per-subdriver data for the chip.
771 void *gpiochip_get_data(struct gpio_chip *gc)
773 return gc->gpiodev->data;
775 EXPORT_SYMBOL_GPL(gpiochip_get_data);
777 int gpiochip_get_ngpios(struct gpio_chip *gc, struct device *dev)
779 u32 ngpios = gc->ngpio;
783 ret = device_property_read_u32(dev, "ngpios", &ngpios);
786 * -ENODATA means that there is no property found and
787 * we want to issue the error message to the user.
788 * Besides that, we want to return different error code
789 * to state that supplied value is not valid.
798 if (gc->ngpio == 0) {
799 chip_err(gc, "tried to insert a GPIO chip with zero lines\n");
803 if (gc->ngpio > FASTPATH_NGPIO)
804 chip_warn(gc, "line cnt %u is greater than fast path cnt %u\n",
805 gc->ngpio, FASTPATH_NGPIO);
809 EXPORT_SYMBOL_GPL(gpiochip_get_ngpios);
811 int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
812 struct lock_class_key *lock_key,
813 struct lock_class_key *request_key)
815 struct gpio_device *gdev;
822 * First: allocate and populate the internal stat container, and
823 * set up the struct device.
825 gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
828 gdev->dev.bus = &gpio_bus_type;
829 gdev->dev.parent = gc->parent;
833 gpiochip_set_data(gc, data);
836 * If the calling driver did not initialize firmware node,
837 * do it here using the parent device, if any.
840 device_set_node(&gdev->dev, gc->fwnode);
842 device_set_node(&gdev->dev, dev_fwnode(gc->parent));
844 gdev->id = ida_alloc(&gpio_ida, GFP_KERNEL);
850 ret = dev_set_name(&gdev->dev, GPIOCHIP_NAME "%d", gdev->id);
854 device_initialize(&gdev->dev);
855 if (gc->parent && gc->parent->driver)
856 gdev->owner = gc->parent->driver->owner;
858 /* TODO: remove chip->owner */
859 gdev->owner = gc->owner;
861 gdev->owner = THIS_MODULE;
863 ret = gpiochip_get_ngpios(gc, &gdev->dev);
865 goto err_free_dev_name;
867 gdev->descs = kcalloc(gc->ngpio, sizeof(*gdev->descs), GFP_KERNEL);
870 goto err_free_dev_name;
873 gdev->label = kstrdup_const(gc->label ?: "unknown", GFP_KERNEL);
879 gdev->ngpio = gc->ngpio;
881 spin_lock_irqsave(&gpio_lock, flags);
884 * TODO: this allocates a Linux GPIO number base in the global
885 * GPIO numberspace for this chip. In the long run we want to
886 * get *rid* of this numberspace and use only descriptors, but
887 * it may be a pipe dream. It will not happen before we get rid
888 * of the sysfs interface anyways.
892 base = gpiochip_find_base_unlocked(gc->ngpio);
894 spin_unlock_irqrestore(&gpio_lock, flags);
900 * TODO: it should not be necessary to reflect the assigned
901 * base outside of the GPIO subsystem. Go over drivers and
902 * see if anyone makes use of this, else drop this and assign
908 "Static allocation of GPIO base is deprecated, use dynamic allocation.\n");
912 ret = gpiodev_add_to_list_unlocked(gdev);
914 spin_unlock_irqrestore(&gpio_lock, flags);
915 chip_err(gc, "GPIO integer space overlap, cannot add chip\n");
919 for (i = 0; i < gc->ngpio; i++)
920 gdev->descs[i].gdev = gdev;
922 spin_unlock_irqrestore(&gpio_lock, flags);
924 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->line_state_notifier);
925 BLOCKING_INIT_NOTIFIER_HEAD(&gdev->device_notifier);
926 init_rwsem(&gdev->sem);
928 #ifdef CONFIG_PINCTRL
929 INIT_LIST_HEAD(&gdev->pin_ranges);
933 ret = gpiochip_set_desc_names(gc);
935 goto err_remove_from_list;
937 ret = gpiochip_set_names(gc);
939 goto err_remove_from_list;
941 ret = gpiochip_init_valid_mask(gc);
943 goto err_remove_from_list;
945 ret = of_gpiochip_add(gc);
947 goto err_free_gpiochip_mask;
949 for (i = 0; i < gc->ngpio; i++) {
950 struct gpio_desc *desc = &gdev->descs[i];
952 if (gc->get_direction && gpiochip_line_is_valid(gc, i)) {
953 assign_bit(FLAG_IS_OUT,
954 &desc->flags, !gc->get_direction(gc, i));
956 assign_bit(FLAG_IS_OUT,
957 &desc->flags, !gc->direction_input);
961 ret = gpiochip_add_pin_ranges(gc);
963 goto err_remove_of_chip;
965 acpi_gpiochip_add(gc);
967 machine_gpiochip_add(gc);
969 ret = gpiochip_irqchip_init_valid_mask(gc);
971 goto err_remove_acpi_chip;
973 ret = gpiochip_irqchip_init_hw(gc);
975 goto err_remove_acpi_chip;
977 ret = gpiochip_add_irqchip(gc, lock_key, request_key);
979 goto err_remove_irqchip_mask;
982 * By first adding the chardev, and then adding the device,
983 * we get a device node entry in sysfs under
984 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
985 * coldplug of device nodes and other udev business.
986 * We can do this only if gpiolib has been initialized.
987 * Otherwise, defer until later.
989 if (gpiolib_initialized) {
990 ret = gpiochip_setup_dev(gdev);
992 goto err_remove_irqchip;
997 gpiochip_irqchip_remove(gc);
998 err_remove_irqchip_mask:
999 gpiochip_irqchip_free_valid_mask(gc);
1000 err_remove_acpi_chip:
1001 acpi_gpiochip_remove(gc);
1003 gpiochip_free_hogs(gc);
1004 of_gpiochip_remove(gc);
1005 err_free_gpiochip_mask:
1006 gpiochip_remove_pin_ranges(gc);
1007 gpiochip_free_valid_mask(gc);
1008 err_remove_from_list:
1009 spin_lock_irqsave(&gpio_lock, flags);
1010 list_del(&gdev->list);
1011 spin_unlock_irqrestore(&gpio_lock, flags);
1012 if (gdev->dev.release) {
1013 /* release() has been registered by gpiochip_setup_dev() */
1014 gpio_device_put(gdev);
1015 goto err_print_message;
1018 kfree_const(gdev->label);
1022 kfree(dev_name(&gdev->dev));
1024 ida_free(&gpio_ida, gdev->id);
1028 /* failures here can mean systems won't boot... */
1029 if (ret != -EPROBE_DEFER) {
1030 pr_err("%s: GPIOs %d..%d (%s) failed to register, %d\n", __func__,
1031 base, base + (int)gc->ngpio - 1,
1032 gc->label ? : "generic", ret);
1036 EXPORT_SYMBOL_GPL(gpiochip_add_data_with_key);
1039 * gpiochip_remove() - unregister a gpio_chip
1040 * @gc: the chip to unregister
1042 * A gpio_chip with any GPIOs still requested may not be removed.
1044 void gpiochip_remove(struct gpio_chip *gc)
1046 struct gpio_device *gdev = gc->gpiodev;
1047 unsigned long flags;
1050 down_write(&gdev->sem);
1052 /* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1053 gpiochip_sysfs_unregister(gdev);
1054 gpiochip_free_hogs(gc);
1055 /* Numb the device, cancelling all outstanding operations */
1057 gpiochip_irqchip_remove(gc);
1058 acpi_gpiochip_remove(gc);
1059 of_gpiochip_remove(gc);
1060 gpiochip_remove_pin_ranges(gc);
1061 gpiochip_free_valid_mask(gc);
1063 * We accept no more calls into the driver from this point, so
1064 * NULL the driver data pointer.
1066 gpiochip_set_data(gc, NULL);
1068 spin_lock_irqsave(&gpio_lock, flags);
1069 for (i = 0; i < gdev->ngpio; i++) {
1070 if (test_bit(FLAG_REQUESTED, &gdev->descs[i].flags))
1073 spin_unlock_irqrestore(&gpio_lock, flags);
1075 if (i != gdev->ngpio)
1076 dev_crit(&gdev->dev,
1077 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
1079 scoped_guard(spinlock_irqsave, &gpio_lock)
1080 list_del(&gdev->list);
1083 * The gpiochip side puts its use of the device to rest here:
1084 * if there are no userspace clients, the chardev and device will
1085 * be removed, else it will be dangling until the last user is
1088 gcdev_unregister(gdev);
1089 up_write(&gdev->sem);
1090 gpio_device_put(gdev);
1092 EXPORT_SYMBOL_GPL(gpiochip_remove);
1095 * gpio_device_find() - find a specific GPIO device
1096 * @data: data to pass to match function
1097 * @match: Callback function to check gpio_chip
1100 * New reference to struct gpio_device.
1102 * Similar to bus_find_device(). It returns a reference to a gpio_device as
1103 * determined by a user supplied @match callback. The callback should return
1104 * 0 if the device doesn't match and non-zero if it does. If the callback
1105 * returns non-zero, this function will return to the caller and not iterate
1106 * over any more gpio_devices.
1108 * The callback takes the GPIO chip structure as argument. During the execution
1109 * of the callback function the chip is protected from being freed. TODO: This
1110 * actually has yet to be implemented.
1112 * If the function returns non-NULL, the returned reference must be freed by
1113 * the caller using gpio_device_put().
1115 struct gpio_device *gpio_device_find(void *data,
1116 int (*match)(struct gpio_chip *gc,
1119 struct gpio_device *gdev;
1122 * Not yet but in the future the spinlock below will become a mutex.
1123 * Annotate this function before anyone tries to use it in interrupt
1124 * context like it happened with gpiochip_find().
1128 guard(spinlock_irqsave)(&gpio_lock);
1130 list_for_each_entry(gdev, &gpio_devices, list) {
1131 if (gdev->chip && match(gdev->chip, data))
1132 return gpio_device_get(gdev);
1137 EXPORT_SYMBOL_GPL(gpio_device_find);
1139 static int gpio_chip_match_by_label(struct gpio_chip *gc, void *label)
1141 return gc->label && !strcmp(gc->label, label);
1145 * gpio_device_find_by_label() - wrapper around gpio_device_find() finding the
1146 * GPIO device by its backing chip's label
1147 * @label: Label to lookup
1150 * Reference to the GPIO device or NULL. Reference must be released with
1151 * gpio_device_put().
1153 struct gpio_device *gpio_device_find_by_label(const char *label)
1155 return gpio_device_find((void *)label, gpio_chip_match_by_label);
1157 EXPORT_SYMBOL_GPL(gpio_device_find_by_label);
1159 static int gpio_chip_match_by_fwnode(struct gpio_chip *gc, void *fwnode)
1161 return device_match_fwnode(&gc->gpiodev->dev, fwnode);
1165 * gpio_device_find_by_fwnode() - wrapper around gpio_device_find() finding
1166 * the GPIO device by its fwnode
1167 * @fwnode: Firmware node to lookup
1170 * Reference to the GPIO device or NULL. Reference must be released with
1171 * gpio_device_put().
1173 struct gpio_device *gpio_device_find_by_fwnode(const struct fwnode_handle *fwnode)
1175 return gpio_device_find((void *)fwnode, gpio_chip_match_by_fwnode);
1177 EXPORT_SYMBOL_GPL(gpio_device_find_by_fwnode);
1180 * gpio_device_get() - Increase the reference count of this GPIO device
1181 * @gdev: GPIO device to increase the refcount for
1186 struct gpio_device *gpio_device_get(struct gpio_device *gdev)
1188 return to_gpio_device(get_device(&gdev->dev));
1190 EXPORT_SYMBOL_GPL(gpio_device_get);
1193 * gpio_device_put() - Decrease the reference count of this GPIO device and
1194 * possibly free all resources associated with it.
1195 * @gdev: GPIO device to decrease the reference count for
1197 void gpio_device_put(struct gpio_device *gdev)
1199 put_device(&gdev->dev);
1201 EXPORT_SYMBOL_GPL(gpio_device_put);
1204 * gpio_device_to_device() - Retrieve the address of the underlying struct
1206 * @gdev: GPIO device for which to return the address.
1208 * This does not increase the reference count of the GPIO device nor the
1209 * underlying struct device.
1212 * Address of struct device backing this GPIO device.
1214 struct device *gpio_device_to_device(struct gpio_device *gdev)
1218 EXPORT_SYMBOL_GPL(gpio_device_to_device);
1220 #ifdef CONFIG_GPIOLIB_IRQCHIP
1223 * The following is irqchip helper code for gpiochips.
1226 static int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1228 struct gpio_irq_chip *girq = &gc->irq;
1233 return girq->init_hw(gc);
1236 static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1238 struct gpio_irq_chip *girq = &gc->irq;
1240 if (!girq->init_valid_mask)
1243 girq->valid_mask = gpiochip_allocate_mask(gc);
1244 if (!girq->valid_mask)
1247 girq->init_valid_mask(gc, girq->valid_mask, gc->ngpio);
1252 static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
1254 gpiochip_free_mask(&gc->irq.valid_mask);
1257 bool gpiochip_irqchip_irq_valid(const struct gpio_chip *gc,
1258 unsigned int offset)
1260 if (!gpiochip_line_is_valid(gc, offset))
1262 /* No mask means all valid */
1263 if (likely(!gc->irq.valid_mask))
1265 return test_bit(offset, gc->irq.valid_mask);
1267 EXPORT_SYMBOL_GPL(gpiochip_irqchip_irq_valid);
1269 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1272 * gpiochip_set_hierarchical_irqchip() - connects a hierarchical irqchip
1274 * @gc: the gpiochip to set the irqchip hierarchical handler to
1275 * @irqchip: the irqchip to handle this level of the hierarchy, the interrupt
1276 * will then percolate up to the parent
1278 static void gpiochip_set_hierarchical_irqchip(struct gpio_chip *gc,
1279 struct irq_chip *irqchip)
1281 /* DT will deal with mapping each IRQ as we go along */
1282 if (is_of_node(gc->irq.fwnode))
1286 * This is for legacy and boardfile "irqchip" fwnodes: allocate
1287 * irqs upfront instead of dynamically since we don't have the
1288 * dynamic type of allocation that hardware description languages
1289 * provide. Once all GPIO drivers using board files are gone from
1290 * the kernel we can delete this code, but for a transitional period
1291 * it is necessary to keep this around.
1293 if (is_fwnode_irqchip(gc->irq.fwnode)) {
1297 for (i = 0; i < gc->ngpio; i++) {
1298 struct irq_fwspec fwspec;
1299 unsigned int parent_hwirq;
1300 unsigned int parent_type;
1301 struct gpio_irq_chip *girq = &gc->irq;
1304 * We call the child to parent translation function
1305 * only to check if the child IRQ is valid or not.
1306 * Just pick the rising edge type here as that is what
1307 * we likely need to support.
1309 ret = girq->child_to_parent_hwirq(gc, i,
1310 IRQ_TYPE_EDGE_RISING,
1314 chip_err(gc, "skip set-up on hwirq %d\n",
1319 fwspec.fwnode = gc->irq.fwnode;
1320 /* This is the hwirq for the GPIO line side of things */
1321 fwspec.param[0] = girq->child_offset_to_irq(gc, i);
1322 /* Just pick something */
1323 fwspec.param[1] = IRQ_TYPE_EDGE_RISING;
1324 fwspec.param_count = 2;
1325 ret = irq_domain_alloc_irqs(gc->irq.domain, 1,
1326 NUMA_NO_NODE, &fwspec);
1329 "can not allocate irq for GPIO line %d parent hwirq %d in hierarchy domain: %d\n",
1336 chip_err(gc, "%s unknown fwnode type proceed anyway\n", __func__);
1341 static int gpiochip_hierarchy_irq_domain_translate(struct irq_domain *d,
1342 struct irq_fwspec *fwspec,
1343 unsigned long *hwirq,
1346 /* We support standard DT translation */
1347 if (is_of_node(fwspec->fwnode) && fwspec->param_count == 2) {
1348 return irq_domain_translate_twocell(d, fwspec, hwirq, type);
1351 /* This is for board files and others not using DT */
1352 if (is_fwnode_irqchip(fwspec->fwnode)) {
1355 ret = irq_domain_translate_twocell(d, fwspec, hwirq, type);
1358 WARN_ON(*type == IRQ_TYPE_NONE);
1364 static int gpiochip_hierarchy_irq_domain_alloc(struct irq_domain *d,
1366 unsigned int nr_irqs,
1369 struct gpio_chip *gc = d->host_data;
1370 irq_hw_number_t hwirq;
1371 unsigned int type = IRQ_TYPE_NONE;
1372 struct irq_fwspec *fwspec = data;
1373 union gpio_irq_fwspec gpio_parent_fwspec = {};
1374 unsigned int parent_hwirq;
1375 unsigned int parent_type;
1376 struct gpio_irq_chip *girq = &gc->irq;
1380 * The nr_irqs parameter is always one except for PCI multi-MSI
1381 * so this should not happen.
1383 WARN_ON(nr_irqs != 1);
1385 ret = gc->irq.child_irq_domain_ops.translate(d, fwspec, &hwirq, &type);
1389 chip_dbg(gc, "allocate IRQ %d, hwirq %lu\n", irq, hwirq);
1391 ret = girq->child_to_parent_hwirq(gc, hwirq, type,
1392 &parent_hwirq, &parent_type);
1394 chip_err(gc, "can't look up hwirq %lu\n", hwirq);
1397 chip_dbg(gc, "found parent hwirq %u\n", parent_hwirq);
1400 * We set handle_bad_irq because the .set_type() should
1401 * always be invoked and set the right type of handler.
1403 irq_domain_set_info(d,
1412 /* This parent only handles asserted level IRQs */
1413 ret = girq->populate_parent_alloc_arg(gc, &gpio_parent_fwspec,
1414 parent_hwirq, parent_type);
1418 chip_dbg(gc, "alloc_irqs_parent for %d parent hwirq %d\n",
1420 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1421 ret = irq_domain_alloc_irqs_parent(d, irq, 1, &gpio_parent_fwspec);
1423 * If the parent irqdomain is msi, the interrupts have already
1424 * been allocated, so the EEXIST is good.
1426 if (irq_domain_is_msi(d->parent) && (ret == -EEXIST))
1430 "failed to allocate parent hwirq %d for hwirq %lu\n",
1431 parent_hwirq, hwirq);
1436 static unsigned int gpiochip_child_offset_to_irq_noop(struct gpio_chip *gc,
1437 unsigned int offset)
1442 static void gpiochip_hierarchy_setup_domain_ops(struct irq_domain_ops *ops)
1444 ops->activate = gpiochip_irq_domain_activate;
1445 ops->deactivate = gpiochip_irq_domain_deactivate;
1446 ops->alloc = gpiochip_hierarchy_irq_domain_alloc;
1449 * We only allow overriding the translate() and free() functions for
1450 * hierarchical chips, and this should only be done if the user
1451 * really need something other than 1:1 translation for translate()
1452 * callback and free if user wants to free up any resources which
1453 * were allocated during callbacks, for example populate_parent_alloc_arg.
1455 if (!ops->translate)
1456 ops->translate = gpiochip_hierarchy_irq_domain_translate;
1458 ops->free = irq_domain_free_irqs_common;
1461 static struct irq_domain *gpiochip_hierarchy_create_domain(struct gpio_chip *gc)
1463 struct irq_domain *domain;
1465 if (!gc->irq.child_to_parent_hwirq ||
1467 chip_err(gc, "missing irqdomain vital data\n");
1468 return ERR_PTR(-EINVAL);
1471 if (!gc->irq.child_offset_to_irq)
1472 gc->irq.child_offset_to_irq = gpiochip_child_offset_to_irq_noop;
1474 if (!gc->irq.populate_parent_alloc_arg)
1475 gc->irq.populate_parent_alloc_arg =
1476 gpiochip_populate_parent_fwspec_twocell;
1478 gpiochip_hierarchy_setup_domain_ops(&gc->irq.child_irq_domain_ops);
1480 domain = irq_domain_create_hierarchy(
1481 gc->irq.parent_domain,
1485 &gc->irq.child_irq_domain_ops,
1489 return ERR_PTR(-ENOMEM);
1491 gpiochip_set_hierarchical_irqchip(gc, gc->irq.chip);
1496 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1498 return !!gc->irq.parent_domain;
1501 int gpiochip_populate_parent_fwspec_twocell(struct gpio_chip *gc,
1502 union gpio_irq_fwspec *gfwspec,
1503 unsigned int parent_hwirq,
1504 unsigned int parent_type)
1506 struct irq_fwspec *fwspec = &gfwspec->fwspec;
1508 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1509 fwspec->param_count = 2;
1510 fwspec->param[0] = parent_hwirq;
1511 fwspec->param[1] = parent_type;
1515 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_twocell);
1517 int gpiochip_populate_parent_fwspec_fourcell(struct gpio_chip *gc,
1518 union gpio_irq_fwspec *gfwspec,
1519 unsigned int parent_hwirq,
1520 unsigned int parent_type)
1522 struct irq_fwspec *fwspec = &gfwspec->fwspec;
1524 fwspec->fwnode = gc->irq.parent_domain->fwnode;
1525 fwspec->param_count = 4;
1526 fwspec->param[0] = 0;
1527 fwspec->param[1] = parent_hwirq;
1528 fwspec->param[2] = 0;
1529 fwspec->param[3] = parent_type;
1533 EXPORT_SYMBOL_GPL(gpiochip_populate_parent_fwspec_fourcell);
1537 static struct irq_domain *gpiochip_hierarchy_create_domain(struct gpio_chip *gc)
1539 return ERR_PTR(-EINVAL);
1542 static bool gpiochip_hierarchy_is_hierarchical(struct gpio_chip *gc)
1547 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1550 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1551 * @d: the irqdomain used by this irqchip
1552 * @irq: the global irq number used by this GPIO irqchip irq
1553 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1555 * This function will set up the mapping for a certain IRQ line on a
1556 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1557 * stored inside the gpiochip.
1559 int gpiochip_irq_map(struct irq_domain *d, unsigned int irq, irq_hw_number_t hwirq)
1561 struct gpio_chip *gc = d->host_data;
1564 if (!gpiochip_irqchip_irq_valid(gc, hwirq))
1567 irq_set_chip_data(irq, gc);
1569 * This lock class tells lockdep that GPIO irqs are in a different
1570 * category than their parents, so it won't report false recursion.
1572 irq_set_lockdep_class(irq, gc->irq.lock_key, gc->irq.request_key);
1573 irq_set_chip_and_handler(irq, gc->irq.chip, gc->irq.handler);
1574 /* Chips that use nested thread handlers have them marked */
1575 if (gc->irq.threaded)
1576 irq_set_nested_thread(irq, 1);
1577 irq_set_noprobe(irq);
1579 if (gc->irq.num_parents == 1)
1580 ret = irq_set_parent(irq, gc->irq.parents[0]);
1581 else if (gc->irq.map)
1582 ret = irq_set_parent(irq, gc->irq.map[hwirq]);
1588 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1589 * is passed as default type.
1591 if (gc->irq.default_type != IRQ_TYPE_NONE)
1592 irq_set_irq_type(irq, gc->irq.default_type);
1596 EXPORT_SYMBOL_GPL(gpiochip_irq_map);
1598 void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1600 struct gpio_chip *gc = d->host_data;
1602 if (gc->irq.threaded)
1603 irq_set_nested_thread(irq, 0);
1604 irq_set_chip_and_handler(irq, NULL, NULL);
1605 irq_set_chip_data(irq, NULL);
1607 EXPORT_SYMBOL_GPL(gpiochip_irq_unmap);
1609 static const struct irq_domain_ops gpiochip_domain_ops = {
1610 .map = gpiochip_irq_map,
1611 .unmap = gpiochip_irq_unmap,
1612 /* Virtually all GPIO irqchips are twocell:ed */
1613 .xlate = irq_domain_xlate_twocell,
1616 static struct irq_domain *gpiochip_simple_create_domain(struct gpio_chip *gc)
1618 struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
1619 struct irq_domain *domain;
1621 domain = irq_domain_create_simple(fwnode, gc->ngpio, gc->irq.first,
1622 &gpiochip_domain_ops, gc);
1624 return ERR_PTR(-EINVAL);
1630 * TODO: move these activate/deactivate in under the hierarchicial
1631 * irqchip implementation as static once SPMI and SSBI (all external
1632 * users) are phased over.
1635 * gpiochip_irq_domain_activate() - Lock a GPIO to be used as an IRQ
1636 * @domain: The IRQ domain used by this IRQ chip
1637 * @data: Outermost irq_data associated with the IRQ
1638 * @reserve: If set, only reserve an interrupt vector instead of assigning one
1640 * This function is a wrapper that calls gpiochip_lock_as_irq() and is to be
1641 * used as the activate function for the &struct irq_domain_ops. The host_data
1642 * for the IRQ domain must be the &struct gpio_chip.
1644 int gpiochip_irq_domain_activate(struct irq_domain *domain,
1645 struct irq_data *data, bool reserve)
1647 struct gpio_chip *gc = domain->host_data;
1648 unsigned int hwirq = irqd_to_hwirq(data);
1650 return gpiochip_lock_as_irq(gc, hwirq);
1652 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_activate);
1655 * gpiochip_irq_domain_deactivate() - Unlock a GPIO used as an IRQ
1656 * @domain: The IRQ domain used by this IRQ chip
1657 * @data: Outermost irq_data associated with the IRQ
1659 * This function is a wrapper that will call gpiochip_unlock_as_irq() and is to
1660 * be used as the deactivate function for the &struct irq_domain_ops. The
1661 * host_data for the IRQ domain must be the &struct gpio_chip.
1663 void gpiochip_irq_domain_deactivate(struct irq_domain *domain,
1664 struct irq_data *data)
1666 struct gpio_chip *gc = domain->host_data;
1667 unsigned int hwirq = irqd_to_hwirq(data);
1669 return gpiochip_unlock_as_irq(gc, hwirq);
1671 EXPORT_SYMBOL_GPL(gpiochip_irq_domain_deactivate);
1673 static int gpiochip_to_irq(struct gpio_chip *gc, unsigned int offset)
1675 struct irq_domain *domain = gc->irq.domain;
1677 #ifdef CONFIG_GPIOLIB_IRQCHIP
1679 * Avoid race condition with other code, which tries to lookup
1680 * an IRQ before the irqchip has been properly registered,
1681 * i.e. while gpiochip is still being brought up.
1683 if (!gc->irq.initialized)
1684 return -EPROBE_DEFER;
1687 if (!gpiochip_irqchip_irq_valid(gc, offset))
1690 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
1691 if (irq_domain_is_hierarchy(domain)) {
1692 struct irq_fwspec spec;
1694 spec.fwnode = domain->fwnode;
1695 spec.param_count = 2;
1696 spec.param[0] = gc->irq.child_offset_to_irq(gc, offset);
1697 spec.param[1] = IRQ_TYPE_NONE;
1699 return irq_create_fwspec_mapping(&spec);
1703 return irq_create_mapping(domain, offset);
1706 int gpiochip_irq_reqres(struct irq_data *d)
1708 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1709 unsigned int hwirq = irqd_to_hwirq(d);
1711 return gpiochip_reqres_irq(gc, hwirq);
1713 EXPORT_SYMBOL(gpiochip_irq_reqres);
1715 void gpiochip_irq_relres(struct irq_data *d)
1717 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1718 unsigned int hwirq = irqd_to_hwirq(d);
1720 gpiochip_relres_irq(gc, hwirq);
1722 EXPORT_SYMBOL(gpiochip_irq_relres);
1724 static void gpiochip_irq_mask(struct irq_data *d)
1726 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1727 unsigned int hwirq = irqd_to_hwirq(d);
1729 if (gc->irq.irq_mask)
1730 gc->irq.irq_mask(d);
1731 gpiochip_disable_irq(gc, hwirq);
1734 static void gpiochip_irq_unmask(struct irq_data *d)
1736 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1737 unsigned int hwirq = irqd_to_hwirq(d);
1739 gpiochip_enable_irq(gc, hwirq);
1740 if (gc->irq.irq_unmask)
1741 gc->irq.irq_unmask(d);
1744 static void gpiochip_irq_enable(struct irq_data *d)
1746 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1747 unsigned int hwirq = irqd_to_hwirq(d);
1749 gpiochip_enable_irq(gc, hwirq);
1750 gc->irq.irq_enable(d);
1753 static void gpiochip_irq_disable(struct irq_data *d)
1755 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
1756 unsigned int hwirq = irqd_to_hwirq(d);
1758 gc->irq.irq_disable(d);
1759 gpiochip_disable_irq(gc, hwirq);
1762 static void gpiochip_set_irq_hooks(struct gpio_chip *gc)
1764 struct irq_chip *irqchip = gc->irq.chip;
1766 if (irqchip->flags & IRQCHIP_IMMUTABLE)
1769 chip_warn(gc, "not an immutable chip, please consider fixing it!\n");
1771 if (!irqchip->irq_request_resources &&
1772 !irqchip->irq_release_resources) {
1773 irqchip->irq_request_resources = gpiochip_irq_reqres;
1774 irqchip->irq_release_resources = gpiochip_irq_relres;
1776 if (WARN_ON(gc->irq.irq_enable))
1778 /* Check if the irqchip already has this hook... */
1779 if (irqchip->irq_enable == gpiochip_irq_enable ||
1780 irqchip->irq_mask == gpiochip_irq_mask) {
1782 * ...and if so, give a gentle warning that this is bad
1786 "detected irqchip that is shared with multiple gpiochips: please fix the driver.\n");
1790 if (irqchip->irq_disable) {
1791 gc->irq.irq_disable = irqchip->irq_disable;
1792 irqchip->irq_disable = gpiochip_irq_disable;
1794 gc->irq.irq_mask = irqchip->irq_mask;
1795 irqchip->irq_mask = gpiochip_irq_mask;
1798 if (irqchip->irq_enable) {
1799 gc->irq.irq_enable = irqchip->irq_enable;
1800 irqchip->irq_enable = gpiochip_irq_enable;
1802 gc->irq.irq_unmask = irqchip->irq_unmask;
1803 irqchip->irq_unmask = gpiochip_irq_unmask;
1807 static int gpiochip_irqchip_add_allocated_domain(struct gpio_chip *gc,
1808 struct irq_domain *domain,
1809 bool allocated_externally)
1815 chip_warn(gc, "to_irq is redefined in %s and you shouldn't rely on it\n", __func__);
1817 gc->to_irq = gpiochip_to_irq;
1818 gc->irq.domain = domain;
1819 gc->irq.domain_is_allocated_externally = allocated_externally;
1822 * Using barrier() here to prevent compiler from reordering
1823 * gc->irq.initialized before adding irqdomain.
1827 gc->irq.initialized = true;
1833 * gpiochip_add_irqchip() - adds an IRQ chip to a GPIO chip
1834 * @gc: the GPIO chip to add the IRQ chip to
1835 * @lock_key: lockdep class for IRQ lock
1836 * @request_key: lockdep class for IRQ request
1838 static int gpiochip_add_irqchip(struct gpio_chip *gc,
1839 struct lock_class_key *lock_key,
1840 struct lock_class_key *request_key)
1842 struct fwnode_handle *fwnode = dev_fwnode(&gc->gpiodev->dev);
1843 struct irq_chip *irqchip = gc->irq.chip;
1844 struct irq_domain *domain;
1852 if (gc->irq.parent_handler && gc->can_sleep) {
1853 chip_err(gc, "you cannot have chained interrupts on a chip that may sleep\n");
1857 type = gc->irq.default_type;
1860 * Specifying a default trigger is a terrible idea if DT or ACPI is
1861 * used to configure the interrupts, as you may end up with
1862 * conflicting triggers. Tell the user, and reset to NONE.
1864 if (WARN(fwnode && type != IRQ_TYPE_NONE,
1865 "%pfw: Ignoring %u default trigger\n", fwnode, type))
1866 type = IRQ_TYPE_NONE;
1868 gc->irq.default_type = type;
1869 gc->irq.lock_key = lock_key;
1870 gc->irq.request_key = request_key;
1872 /* If a parent irqdomain is provided, let's build a hierarchy */
1873 if (gpiochip_hierarchy_is_hierarchical(gc)) {
1874 domain = gpiochip_hierarchy_create_domain(gc);
1876 domain = gpiochip_simple_create_domain(gc);
1879 return PTR_ERR(domain);
1881 if (gc->irq.parent_handler) {
1882 for (i = 0; i < gc->irq.num_parents; i++) {
1885 if (gc->irq.per_parent_data)
1886 data = gc->irq.parent_handler_data_array[i];
1888 data = gc->irq.parent_handler_data ?: gc;
1891 * The parent IRQ chip is already using the chip_data
1892 * for this IRQ chip, so our callbacks simply use the
1895 irq_set_chained_handler_and_data(gc->irq.parents[i],
1896 gc->irq.parent_handler,
1901 gpiochip_set_irq_hooks(gc);
1903 ret = gpiochip_irqchip_add_allocated_domain(gc, domain, false);
1907 acpi_gpiochip_request_interrupts(gc);
1913 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1914 * @gc: the gpiochip to remove the irqchip from
1916 * This is called only from gpiochip_remove()
1918 static void gpiochip_irqchip_remove(struct gpio_chip *gc)
1920 struct irq_chip *irqchip = gc->irq.chip;
1921 unsigned int offset;
1923 acpi_gpiochip_free_interrupts(gc);
1925 if (irqchip && gc->irq.parent_handler) {
1926 struct gpio_irq_chip *irq = &gc->irq;
1929 for (i = 0; i < irq->num_parents; i++)
1930 irq_set_chained_handler_and_data(irq->parents[i],
1934 /* Remove all IRQ mappings and delete the domain */
1935 if (!gc->irq.domain_is_allocated_externally && gc->irq.domain) {
1938 for (offset = 0; offset < gc->ngpio; offset++) {
1939 if (!gpiochip_irqchip_irq_valid(gc, offset))
1942 irq = irq_find_mapping(gc->irq.domain, offset);
1943 irq_dispose_mapping(irq);
1946 irq_domain_remove(gc->irq.domain);
1949 if (irqchip && !(irqchip->flags & IRQCHIP_IMMUTABLE)) {
1950 if (irqchip->irq_request_resources == gpiochip_irq_reqres) {
1951 irqchip->irq_request_resources = NULL;
1952 irqchip->irq_release_resources = NULL;
1954 if (irqchip->irq_enable == gpiochip_irq_enable) {
1955 irqchip->irq_enable = gc->irq.irq_enable;
1956 irqchip->irq_disable = gc->irq.irq_disable;
1959 gc->irq.irq_enable = NULL;
1960 gc->irq.irq_disable = NULL;
1961 gc->irq.chip = NULL;
1963 gpiochip_irqchip_free_valid_mask(gc);
1967 * gpiochip_irqchip_add_domain() - adds an irqdomain to a gpiochip
1968 * @gc: the gpiochip to add the irqchip to
1969 * @domain: the irqdomain to add to the gpiochip
1971 * This function adds an IRQ domain to the gpiochip.
1973 int gpiochip_irqchip_add_domain(struct gpio_chip *gc,
1974 struct irq_domain *domain)
1976 return gpiochip_irqchip_add_allocated_domain(gc, domain, true);
1978 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add_domain);
1980 #else /* CONFIG_GPIOLIB_IRQCHIP */
1982 static inline int gpiochip_add_irqchip(struct gpio_chip *gc,
1983 struct lock_class_key *lock_key,
1984 struct lock_class_key *request_key)
1988 static void gpiochip_irqchip_remove(struct gpio_chip *gc) {}
1990 static inline int gpiochip_irqchip_init_hw(struct gpio_chip *gc)
1995 static inline int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gc)
1999 static inline void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gc)
2002 #endif /* CONFIG_GPIOLIB_IRQCHIP */
2005 * gpiochip_generic_request() - request the gpio function for a pin
2006 * @gc: the gpiochip owning the GPIO
2007 * @offset: the offset of the GPIO to request for GPIO function
2009 int gpiochip_generic_request(struct gpio_chip *gc, unsigned int offset)
2011 #ifdef CONFIG_PINCTRL
2012 if (list_empty(&gc->gpiodev->pin_ranges))
2016 return pinctrl_gpio_request(gc, offset);
2018 EXPORT_SYMBOL_GPL(gpiochip_generic_request);
2021 * gpiochip_generic_free() - free the gpio function from a pin
2022 * @gc: the gpiochip to request the gpio function for
2023 * @offset: the offset of the GPIO to free from GPIO function
2025 void gpiochip_generic_free(struct gpio_chip *gc, unsigned int offset)
2027 #ifdef CONFIG_PINCTRL
2028 if (list_empty(&gc->gpiodev->pin_ranges))
2032 pinctrl_gpio_free(gc, offset);
2034 EXPORT_SYMBOL_GPL(gpiochip_generic_free);
2037 * gpiochip_generic_config() - apply configuration for a pin
2038 * @gc: the gpiochip owning the GPIO
2039 * @offset: the offset of the GPIO to apply the configuration
2040 * @config: the configuration to be applied
2042 int gpiochip_generic_config(struct gpio_chip *gc, unsigned int offset,
2043 unsigned long config)
2045 return pinctrl_gpio_set_config(gc, offset, config);
2047 EXPORT_SYMBOL_GPL(gpiochip_generic_config);
2049 #ifdef CONFIG_PINCTRL
2052 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
2053 * @gc: the gpiochip to add the range for
2054 * @pctldev: the pin controller to map to
2055 * @gpio_offset: the start offset in the current gpio_chip number space
2056 * @pin_group: name of the pin group inside the pin controller
2058 * Calling this function directly from a DeviceTree-supported
2059 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2060 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2061 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2063 int gpiochip_add_pingroup_range(struct gpio_chip *gc,
2064 struct pinctrl_dev *pctldev,
2065 unsigned int gpio_offset, const char *pin_group)
2067 struct gpio_pin_range *pin_range;
2068 struct gpio_device *gdev = gc->gpiodev;
2071 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2073 chip_err(gc, "failed to allocate pin ranges\n");
2077 /* Use local offset as range ID */
2078 pin_range->range.id = gpio_offset;
2079 pin_range->range.gc = gc;
2080 pin_range->range.name = gc->label;
2081 pin_range->range.base = gdev->base + gpio_offset;
2082 pin_range->pctldev = pctldev;
2084 ret = pinctrl_get_group_pins(pctldev, pin_group,
2085 &pin_range->range.pins,
2086 &pin_range->range.npins);
2092 pinctrl_add_gpio_range(pctldev, &pin_range->range);
2094 chip_dbg(gc, "created GPIO range %d->%d ==> %s PINGRP %s\n",
2095 gpio_offset, gpio_offset + pin_range->range.npins - 1,
2096 pinctrl_dev_get_devname(pctldev), pin_group);
2098 list_add_tail(&pin_range->node, &gdev->pin_ranges);
2102 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
2105 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
2106 * @gc: the gpiochip to add the range for
2107 * @pinctl_name: the dev_name() of the pin controller to map to
2108 * @gpio_offset: the start offset in the current gpio_chip number space
2109 * @pin_offset: the start offset in the pin controller number space
2110 * @npins: the number of pins from the offset of each pin space (GPIO and
2111 * pin controller) to accumulate in this range
2114 * 0 on success, or a negative error-code on failure.
2116 * Calling this function directly from a DeviceTree-supported
2117 * pinctrl driver is DEPRECATED. Please see Section 2.1 of
2118 * Documentation/devicetree/bindings/gpio/gpio.txt on how to
2119 * bind pinctrl and gpio drivers via the "gpio-ranges" property.
2121 int gpiochip_add_pin_range(struct gpio_chip *gc, const char *pinctl_name,
2122 unsigned int gpio_offset, unsigned int pin_offset,
2125 struct gpio_pin_range *pin_range;
2126 struct gpio_device *gdev = gc->gpiodev;
2129 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
2131 chip_err(gc, "failed to allocate pin ranges\n");
2135 /* Use local offset as range ID */
2136 pin_range->range.id = gpio_offset;
2137 pin_range->range.gc = gc;
2138 pin_range->range.name = gc->label;
2139 pin_range->range.base = gdev->base + gpio_offset;
2140 pin_range->range.pin_base = pin_offset;
2141 pin_range->range.npins = npins;
2142 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
2144 if (IS_ERR(pin_range->pctldev)) {
2145 ret = PTR_ERR(pin_range->pctldev);
2146 chip_err(gc, "could not create pin range\n");
2150 chip_dbg(gc, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
2151 gpio_offset, gpio_offset + npins - 1,
2153 pin_offset, pin_offset + npins - 1);
2155 list_add_tail(&pin_range->node, &gdev->pin_ranges);
2159 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
2162 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
2163 * @gc: the chip to remove all the mappings for
2165 void gpiochip_remove_pin_ranges(struct gpio_chip *gc)
2167 struct gpio_pin_range *pin_range, *tmp;
2168 struct gpio_device *gdev = gc->gpiodev;
2170 list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
2171 list_del(&pin_range->node);
2172 pinctrl_remove_gpio_range(pin_range->pctldev,
2177 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
2179 #endif /* CONFIG_PINCTRL */
2181 /* These "optional" allocation calls help prevent drivers from stomping
2182 * on each other, and help provide better diagnostics in debugfs.
2183 * They're called even less than the "set direction" calls.
2185 static int gpiod_request_commit(struct gpio_desc *desc, const char *label)
2187 struct gpio_chip *gc = desc->gdev->chip;
2188 unsigned long flags;
2189 unsigned int offset;
2193 label = kstrdup_const(label, GFP_KERNEL);
2198 spin_lock_irqsave(&gpio_lock, flags);
2200 /* NOTE: gpio_request() can be called in early boot,
2201 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
2204 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
2205 desc_set_label(desc, label ? : "?");
2208 goto out_free_unlock;
2212 /* gc->request may sleep */
2213 spin_unlock_irqrestore(&gpio_lock, flags);
2214 offset = gpio_chip_hwgpio(desc);
2215 if (gpiochip_line_is_valid(gc, offset))
2216 ret = gc->request(gc, offset);
2219 spin_lock_irqsave(&gpio_lock, flags);
2222 desc_set_label(desc, NULL);
2223 clear_bit(FLAG_REQUESTED, &desc->flags);
2224 goto out_free_unlock;
2227 if (gc->get_direction) {
2228 /* gc->get_direction may sleep */
2229 spin_unlock_irqrestore(&gpio_lock, flags);
2230 gpiod_get_direction(desc);
2231 spin_lock_irqsave(&gpio_lock, flags);
2233 spin_unlock_irqrestore(&gpio_lock, flags);
2237 spin_unlock_irqrestore(&gpio_lock, flags);
2243 * This descriptor validation needs to be inserted verbatim into each
2244 * function taking a descriptor, so we need to use a preprocessor
2245 * macro to avoid endless duplication. If the desc is NULL it is an
2246 * optional GPIO and calls should just bail out.
2248 static int validate_desc(const struct gpio_desc *desc, const char *func)
2253 pr_warn("%s: invalid GPIO (errorpointer)\n", func);
2254 return PTR_ERR(desc);
2257 pr_warn("%s: invalid GPIO (no device)\n", func);
2260 if (!desc->gdev->chip) {
2261 dev_warn(&desc->gdev->dev,
2262 "%s: backing chip is gone\n", func);
2268 #define VALIDATE_DESC(desc) do { \
2269 int __valid = validate_desc(desc, __func__); \
2274 #define VALIDATE_DESC_VOID(desc) do { \
2275 int __valid = validate_desc(desc, __func__); \
2280 int gpiod_request(struct gpio_desc *desc, const char *label)
2282 int ret = -EPROBE_DEFER;
2284 VALIDATE_DESC(desc);
2286 if (try_module_get(desc->gdev->owner)) {
2287 ret = gpiod_request_commit(desc, label);
2289 module_put(desc->gdev->owner);
2291 gpio_device_get(desc->gdev);
2295 gpiod_dbg(desc, "%s: status %d\n", __func__, ret);
2300 static bool gpiod_free_commit(struct gpio_desc *desc)
2302 struct gpio_chip *gc;
2303 unsigned long flags;
2308 spin_lock_irqsave(&gpio_lock, flags);
2310 gc = desc->gdev->chip;
2311 if (gc && test_bit(FLAG_REQUESTED, &desc->flags)) {
2313 spin_unlock_irqrestore(&gpio_lock, flags);
2314 might_sleep_if(gc->can_sleep);
2315 gc->free(gc, gpio_chip_hwgpio(desc));
2316 spin_lock_irqsave(&gpio_lock, flags);
2318 kfree_const(desc->label);
2319 desc_set_label(desc, NULL);
2320 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
2321 clear_bit(FLAG_REQUESTED, &desc->flags);
2322 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
2323 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
2324 clear_bit(FLAG_PULL_UP, &desc->flags);
2325 clear_bit(FLAG_PULL_DOWN, &desc->flags);
2326 clear_bit(FLAG_BIAS_DISABLE, &desc->flags);
2327 clear_bit(FLAG_EDGE_RISING, &desc->flags);
2328 clear_bit(FLAG_EDGE_FALLING, &desc->flags);
2329 clear_bit(FLAG_IS_HOGGED, &desc->flags);
2330 #ifdef CONFIG_OF_DYNAMIC
2336 spin_unlock_irqrestore(&gpio_lock, flags);
2337 gpiod_line_state_notify(desc, GPIOLINE_CHANGED_RELEASED);
2342 void gpiod_free(struct gpio_desc *desc)
2345 * We must not use VALIDATE_DESC_VOID() as the underlying gdev->chip
2346 * may already be NULL but we still want to put the references.
2351 if (!gpiod_free_commit(desc))
2354 module_put(desc->gdev->owner);
2355 gpio_device_put(desc->gdev);
2359 * gpiochip_dup_line_label - Get a copy of the consumer label.
2360 * @gc: GPIO chip controlling this line.
2361 * @offset: Hardware offset of the line.
2364 * Pointer to a copy of the consumer label if the line is requested or NULL
2365 * if it's not. If a valid pointer was returned, it must be freed using
2366 * kfree(). In case of a memory allocation error, the function returns %ENOMEM.
2368 * Must not be called from atomic context.
2370 char *gpiochip_dup_line_label(struct gpio_chip *gc, unsigned int offset)
2372 struct gpio_desc *desc;
2375 desc = gpiochip_get_desc(gc, offset);
2379 guard(spinlock_irqsave)(&gpio_lock);
2381 if (!test_bit(FLAG_REQUESTED, &desc->flags))
2385 * FIXME: Once we mark gpiod_direction_input/output() and
2386 * gpiod_get_direction() with might_sleep(), we'll be able to protect
2387 * the GPIO descriptors with mutex (while value setting operations will
2390 * Until this happens, this allocation needs to be atomic.
2392 label = kstrdup(desc->label, GFP_ATOMIC);
2394 return ERR_PTR(-ENOMEM);
2398 EXPORT_SYMBOL_GPL(gpiochip_dup_line_label);
2401 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
2403 * @hwnum: hardware number of the GPIO for which to request the descriptor
2404 * @label: label for the GPIO
2405 * @lflags: lookup flags for this GPIO or 0 if default, this can be used to
2406 * specify things like line inversion semantics with the machine flags
2407 * such as GPIO_OUT_LOW
2408 * @dflags: descriptor request flags for this GPIO or 0 if default, this
2409 * can be used to specify consumer semantics such as open drain
2411 * Function allows GPIO chip drivers to request and use their own GPIO
2412 * descriptors via gpiolib API. Difference to gpiod_request() is that this
2413 * function will not increase reference count of the GPIO chip module. This
2414 * allows the GPIO chip module to be unloaded as needed (we assume that the
2415 * GPIO chip driver handles freeing the GPIOs it has requested).
2418 * A pointer to the GPIO descriptor, or an ERR_PTR()-encoded negative error
2421 struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,
2424 enum gpio_lookup_flags lflags,
2425 enum gpiod_flags dflags)
2427 struct gpio_desc *desc = gpiochip_get_desc(gc, hwnum);
2431 chip_err(gc, "failed to get GPIO descriptor\n");
2435 ret = gpiod_request_commit(desc, label);
2437 return ERR_PTR(ret);
2439 ret = gpiod_configure_flags(desc, label, lflags, dflags);
2441 chip_err(gc, "setup of own GPIO %s failed\n", label);
2442 gpiod_free_commit(desc);
2443 return ERR_PTR(ret);
2448 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
2451 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
2452 * @desc: GPIO descriptor to free
2454 * Function frees the given GPIO requested previously with
2455 * gpiochip_request_own_desc().
2457 void gpiochip_free_own_desc(struct gpio_desc *desc)
2460 gpiod_free_commit(desc);
2462 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
2465 * Drivers MUST set GPIO direction before making get/set calls. In
2466 * some cases this is done in early boot, before IRQs are enabled.
2468 * As a rule these aren't called more than once (except for drivers
2469 * using the open-drain emulation idiom) so these are natural places
2470 * to accumulate extra debugging checks. Note that we can't (yet)
2471 * rely on gpio_request() having been called beforehand.
2474 static int gpio_do_set_config(struct gpio_chip *gc, unsigned int offset,
2475 unsigned long config)
2477 if (!gc->set_config)
2480 return gc->set_config(gc, offset, config);
2483 static int gpio_set_config_with_argument(struct gpio_desc *desc,
2484 enum pin_config_param mode,
2487 struct gpio_chip *gc = desc->gdev->chip;
2488 unsigned long config;
2490 config = pinconf_to_config_packed(mode, argument);
2491 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2494 static int gpio_set_config_with_argument_optional(struct gpio_desc *desc,
2495 enum pin_config_param mode,
2498 struct device *dev = &desc->gdev->dev;
2499 int gpio = gpio_chip_hwgpio(desc);
2502 ret = gpio_set_config_with_argument(desc, mode, argument);
2503 if (ret != -ENOTSUPP)
2507 case PIN_CONFIG_PERSIST_STATE:
2508 dev_dbg(dev, "Persistence not supported for GPIO %d\n", gpio);
2517 static int gpio_set_config(struct gpio_desc *desc, enum pin_config_param mode)
2519 return gpio_set_config_with_argument(desc, mode, 0);
2522 static int gpio_set_bias(struct gpio_desc *desc)
2524 enum pin_config_param bias;
2527 if (test_bit(FLAG_BIAS_DISABLE, &desc->flags))
2528 bias = PIN_CONFIG_BIAS_DISABLE;
2529 else if (test_bit(FLAG_PULL_UP, &desc->flags))
2530 bias = PIN_CONFIG_BIAS_PULL_UP;
2531 else if (test_bit(FLAG_PULL_DOWN, &desc->flags))
2532 bias = PIN_CONFIG_BIAS_PULL_DOWN;
2537 case PIN_CONFIG_BIAS_PULL_DOWN:
2538 case PIN_CONFIG_BIAS_PULL_UP:
2547 return gpio_set_config_with_argument_optional(desc, bias, arg);
2551 * gpio_set_debounce_timeout() - Set debounce timeout
2552 * @desc: GPIO descriptor to set the debounce timeout
2553 * @debounce: Debounce timeout in microseconds
2555 * The function calls the certain GPIO driver to set debounce timeout
2558 * Returns 0 on success, or negative error code otherwise.
2560 int gpio_set_debounce_timeout(struct gpio_desc *desc, unsigned int debounce)
2562 return gpio_set_config_with_argument_optional(desc,
2563 PIN_CONFIG_INPUT_DEBOUNCE,
2568 * gpiod_direction_input - set the GPIO direction to input
2569 * @desc: GPIO to set to input
2571 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
2572 * be called safely on it.
2574 * Return 0 in case of success, else an error code.
2576 int gpiod_direction_input(struct gpio_desc *desc)
2578 struct gpio_chip *gc;
2581 VALIDATE_DESC(desc);
2582 gc = desc->gdev->chip;
2585 * It is legal to have no .get() and .direction_input() specified if
2586 * the chip is output-only, but you can't specify .direction_input()
2587 * and not support the .get() operation, that doesn't make sense.
2589 if (!gc->get && gc->direction_input) {
2591 "%s: missing get() but have direction_input()\n",
2597 * If we have a .direction_input() callback, things are simple,
2598 * just call it. Else we are some input-only chip so try to check the
2599 * direction (if .get_direction() is supported) else we silently
2600 * assume we are in input mode after this.
2602 if (gc->direction_input) {
2603 ret = gc->direction_input(gc, gpio_chip_hwgpio(desc));
2604 } else if (gc->get_direction &&
2605 (gc->get_direction(gc, gpio_chip_hwgpio(desc)) != 1)) {
2607 "%s: missing direction_input() operation and line is output\n",
2612 clear_bit(FLAG_IS_OUT, &desc->flags);
2613 ret = gpio_set_bias(desc);
2616 trace_gpio_direction(desc_to_gpio(desc), 1, ret);
2620 EXPORT_SYMBOL_GPL(gpiod_direction_input);
2622 static int gpiod_direction_output_raw_commit(struct gpio_desc *desc, int value)
2624 struct gpio_chip *gc = desc->gdev->chip;
2629 * It's OK not to specify .direction_output() if the gpiochip is
2630 * output-only, but if there is then not even a .set() operation it
2631 * is pretty tricky to drive the output line.
2633 if (!gc->set && !gc->direction_output) {
2635 "%s: missing set() and direction_output() operations\n",
2640 if (gc->direction_output) {
2641 ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), val);
2643 /* Check that we are in output mode if we can */
2644 if (gc->get_direction &&
2645 gc->get_direction(gc, gpio_chip_hwgpio(desc))) {
2647 "%s: missing direction_output() operation\n",
2652 * If we can't actively set the direction, we are some
2653 * output-only chip, so just drive the output as desired.
2655 gc->set(gc, gpio_chip_hwgpio(desc), val);
2659 set_bit(FLAG_IS_OUT, &desc->flags);
2660 trace_gpio_value(desc_to_gpio(desc), 0, val);
2661 trace_gpio_direction(desc_to_gpio(desc), 0, ret);
2666 * gpiod_direction_output_raw - set the GPIO direction to output
2667 * @desc: GPIO to set to output
2668 * @value: initial output value of the GPIO
2670 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2671 * be called safely on it. The initial value of the output must be specified
2672 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2674 * Return 0 in case of success, else an error code.
2676 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2678 VALIDATE_DESC(desc);
2679 return gpiod_direction_output_raw_commit(desc, value);
2681 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2684 * gpiod_direction_output - set the GPIO direction to output
2685 * @desc: GPIO to set to output
2686 * @value: initial output value of the GPIO
2688 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2689 * be called safely on it. The initial value of the output must be specified
2690 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2693 * Return 0 in case of success, else an error code.
2695 int gpiod_direction_output(struct gpio_desc *desc, int value)
2699 VALIDATE_DESC(desc);
2700 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2705 /* GPIOs used for enabled IRQs shall not be set as output */
2706 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags) &&
2707 test_bit(FLAG_IRQ_IS_ENABLED, &desc->flags)) {
2709 "%s: tried to set a GPIO tied to an IRQ as output\n",
2714 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
2715 /* First see if we can enable open drain in hardware */
2716 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_DRAIN);
2718 goto set_output_value;
2719 /* Emulate open drain by not actively driving the line high */
2721 ret = gpiod_direction_input(desc);
2722 goto set_output_flag;
2724 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
2725 ret = gpio_set_config(desc, PIN_CONFIG_DRIVE_OPEN_SOURCE);
2727 goto set_output_value;
2728 /* Emulate open source by not actively driving the line low */
2730 ret = gpiod_direction_input(desc);
2731 goto set_output_flag;
2734 gpio_set_config(desc, PIN_CONFIG_DRIVE_PUSH_PULL);
2738 ret = gpio_set_bias(desc);
2741 return gpiod_direction_output_raw_commit(desc, value);
2745 * When emulating open-source or open-drain functionalities by not
2746 * actively driving the line (setting mode to input) we still need to
2747 * set the IS_OUT flag or otherwise we won't be able to set the line
2751 set_bit(FLAG_IS_OUT, &desc->flags);
2754 EXPORT_SYMBOL_GPL(gpiod_direction_output);
2757 * gpiod_enable_hw_timestamp_ns - Enable hardware timestamp in nanoseconds.
2759 * @desc: GPIO to enable.
2760 * @flags: Flags related to GPIO edge.
2762 * Return 0 in case of success, else negative error code.
2764 int gpiod_enable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags)
2767 struct gpio_chip *gc;
2769 VALIDATE_DESC(desc);
2771 gc = desc->gdev->chip;
2772 if (!gc->en_hw_timestamp) {
2773 gpiod_warn(desc, "%s: hw ts not supported\n", __func__);
2777 ret = gc->en_hw_timestamp(gc, gpio_chip_hwgpio(desc), flags);
2779 gpiod_warn(desc, "%s: hw ts request failed\n", __func__);
2783 EXPORT_SYMBOL_GPL(gpiod_enable_hw_timestamp_ns);
2786 * gpiod_disable_hw_timestamp_ns - Disable hardware timestamp.
2788 * @desc: GPIO to disable.
2789 * @flags: Flags related to GPIO edge, same value as used during enable call.
2791 * Return 0 in case of success, else negative error code.
2793 int gpiod_disable_hw_timestamp_ns(struct gpio_desc *desc, unsigned long flags)
2796 struct gpio_chip *gc;
2798 VALIDATE_DESC(desc);
2800 gc = desc->gdev->chip;
2801 if (!gc->dis_hw_timestamp) {
2802 gpiod_warn(desc, "%s: hw ts not supported\n", __func__);
2806 ret = gc->dis_hw_timestamp(gc, gpio_chip_hwgpio(desc), flags);
2808 gpiod_warn(desc, "%s: hw ts release failed\n", __func__);
2812 EXPORT_SYMBOL_GPL(gpiod_disable_hw_timestamp_ns);
2815 * gpiod_set_config - sets @config for a GPIO
2816 * @desc: descriptor of the GPIO for which to set the configuration
2817 * @config: Same packed config format as generic pinconf
2820 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2823 int gpiod_set_config(struct gpio_desc *desc, unsigned long config)
2825 struct gpio_chip *gc;
2827 VALIDATE_DESC(desc);
2828 gc = desc->gdev->chip;
2830 return gpio_do_set_config(gc, gpio_chip_hwgpio(desc), config);
2832 EXPORT_SYMBOL_GPL(gpiod_set_config);
2835 * gpiod_set_debounce - sets @debounce time for a GPIO
2836 * @desc: descriptor of the GPIO for which to set debounce time
2837 * @debounce: debounce time in microseconds
2840 * 0 on success, %-ENOTSUPP if the controller doesn't support setting the
2843 int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounce)
2845 unsigned long config;
2847 config = pinconf_to_config_packed(PIN_CONFIG_INPUT_DEBOUNCE, debounce);
2848 return gpiod_set_config(desc, config);
2850 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
2853 * gpiod_set_transitory - Lose or retain GPIO state on suspend or reset
2854 * @desc: descriptor of the GPIO for which to configure persistence
2855 * @transitory: True to lose state on suspend or reset, false for persistence
2858 * 0 on success, otherwise a negative error code.
2860 int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)
2862 VALIDATE_DESC(desc);
2864 * Handle FLAG_TRANSITORY first, enabling queries to gpiolib for
2865 * persistence state.
2867 assign_bit(FLAG_TRANSITORY, &desc->flags, transitory);
2869 /* If the driver supports it, set the persistence state now */
2870 return gpio_set_config_with_argument_optional(desc,
2871 PIN_CONFIG_PERSIST_STATE,
2876 * gpiod_is_active_low - test whether a GPIO is active-low or not
2877 * @desc: the gpio descriptor to test
2879 * Returns 1 if the GPIO is active-low, 0 otherwise.
2881 int gpiod_is_active_low(const struct gpio_desc *desc)
2883 VALIDATE_DESC(desc);
2884 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
2886 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
2889 * gpiod_toggle_active_low - toggle whether a GPIO is active-low or not
2890 * @desc: the gpio descriptor to change
2892 void gpiod_toggle_active_low(struct gpio_desc *desc)
2894 VALIDATE_DESC_VOID(desc);
2895 change_bit(FLAG_ACTIVE_LOW, &desc->flags);
2897 EXPORT_SYMBOL_GPL(gpiod_toggle_active_low);
2899 static int gpio_chip_get_value(struct gpio_chip *gc, const struct gpio_desc *desc)
2901 return gc->get ? gc->get(gc, gpio_chip_hwgpio(desc)) : -EIO;
2904 /* I/O calls are only valid after configuration completed; the relevant
2905 * "is this a valid GPIO" error checks should already have been done.
2907 * "Get" operations are often inlinable as reading a pin value register,
2908 * and masking the relevant bit in that register.
2910 * When "set" operations are inlinable, they involve writing that mask to
2911 * one register to set a low value, or a different register to set it high.
2912 * Otherwise locking is needed, so there may be little value to inlining.
2914 *------------------------------------------------------------------------
2916 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2917 * have requested the GPIO. That can include implicit requesting by
2918 * a direction setting call. Marking a gpio as requested locks its chip
2919 * in memory, guaranteeing that these table lookups need no more locking
2920 * and that gpiochip_remove() will fail.
2922 * REVISIT when debugging, consider adding some instrumentation to ensure
2923 * that the GPIO was actually requested.
2926 static int gpiod_get_raw_value_commit(const struct gpio_desc *desc)
2928 struct gpio_chip *gc;
2931 gc = desc->gdev->chip;
2932 value = gpio_chip_get_value(gc, desc);
2933 value = value < 0 ? value : !!value;
2934 trace_gpio_value(desc_to_gpio(desc), 1, value);
2938 static int gpio_chip_get_multiple(struct gpio_chip *gc,
2939 unsigned long *mask, unsigned long *bits)
2941 if (gc->get_multiple)
2942 return gc->get_multiple(gc, mask, bits);
2946 for_each_set_bit(i, mask, gc->ngpio) {
2947 value = gc->get(gc, i);
2950 __assign_bit(i, bits, value);
2957 int gpiod_get_array_value_complex(bool raw, bool can_sleep,
2958 unsigned int array_size,
2959 struct gpio_desc **desc_array,
2960 struct gpio_array *array_info,
2961 unsigned long *value_bitmap)
2966 * Validate array_info against desc_array and its size.
2967 * It should immediately follow desc_array if both
2968 * have been obtained from the same gpiod_get_array() call.
2970 if (array_info && array_info->desc == desc_array &&
2971 array_size <= array_info->size &&
2972 (void *)array_info == desc_array + array_info->size) {
2974 WARN_ON(array_info->chip->can_sleep);
2976 ret = gpio_chip_get_multiple(array_info->chip,
2977 array_info->get_mask,
2982 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
2983 bitmap_xor(value_bitmap, value_bitmap,
2984 array_info->invert_mask, array_size);
2986 i = find_first_zero_bit(array_info->get_mask, array_size);
2987 if (i == array_size)
2993 while (i < array_size) {
2994 struct gpio_chip *gc = desc_array[i]->gdev->chip;
2995 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
2996 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
2997 unsigned long *mask, *bits;
3000 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
3001 mask = fastpath_mask;
3002 bits = fastpath_bits;
3004 gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
3006 mask = bitmap_alloc(gc->ngpio, flags);
3010 bits = bitmap_alloc(gc->ngpio, flags);
3017 bitmap_zero(mask, gc->ngpio);
3020 WARN_ON(gc->can_sleep);
3022 /* collect all inputs belonging to the same chip */
3025 const struct gpio_desc *desc = desc_array[i];
3026 int hwgpio = gpio_chip_hwgpio(desc);
3028 __set_bit(hwgpio, mask);
3032 i = find_next_zero_bit(array_info->get_mask,
3034 } while ((i < array_size) &&
3035 (desc_array[i]->gdev->chip == gc));
3037 ret = gpio_chip_get_multiple(gc, mask, bits);
3039 if (mask != fastpath_mask)
3041 if (bits != fastpath_bits)
3046 for (j = first; j < i; ) {
3047 const struct gpio_desc *desc = desc_array[j];
3048 int hwgpio = gpio_chip_hwgpio(desc);
3049 int value = test_bit(hwgpio, bits);
3051 if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3053 __assign_bit(j, value_bitmap, value);
3054 trace_gpio_value(desc_to_gpio(desc), 1, value);
3058 j = find_next_zero_bit(array_info->get_mask, i,
3062 if (mask != fastpath_mask)
3064 if (bits != fastpath_bits)
3071 * gpiod_get_raw_value() - return a gpio's raw value
3072 * @desc: gpio whose value will be returned
3074 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3075 * its ACTIVE_LOW status, or negative errno on failure.
3077 * This function can be called from contexts where we cannot sleep, and will
3078 * complain if the GPIO chip functions potentially sleep.
3080 int gpiod_get_raw_value(const struct gpio_desc *desc)
3082 VALIDATE_DESC(desc);
3083 /* Should be using gpiod_get_raw_value_cansleep() */
3084 WARN_ON(desc->gdev->chip->can_sleep);
3085 return gpiod_get_raw_value_commit(desc);
3087 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
3090 * gpiod_get_value() - return a gpio's value
3091 * @desc: gpio whose value will be returned
3093 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3094 * account, or negative errno on failure.
3096 * This function can be called from contexts where we cannot sleep, and will
3097 * complain if the GPIO chip functions potentially sleep.
3099 int gpiod_get_value(const struct gpio_desc *desc)
3103 VALIDATE_DESC(desc);
3104 /* Should be using gpiod_get_value_cansleep() */
3105 WARN_ON(desc->gdev->chip->can_sleep);
3107 value = gpiod_get_raw_value_commit(desc);
3111 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3116 EXPORT_SYMBOL_GPL(gpiod_get_value);
3119 * gpiod_get_raw_array_value() - read raw values from an array of GPIOs
3120 * @array_size: number of elements in the descriptor array / value bitmap
3121 * @desc_array: array of GPIO descriptors whose values will be read
3122 * @array_info: information on applicability of fast bitmap processing path
3123 * @value_bitmap: bitmap to store the read values
3125 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3126 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3127 * else an error code.
3129 * This function can be called from contexts where we cannot sleep,
3130 * and it will complain if the GPIO chip functions potentially sleep.
3132 int gpiod_get_raw_array_value(unsigned int array_size,
3133 struct gpio_desc **desc_array,
3134 struct gpio_array *array_info,
3135 unsigned long *value_bitmap)
3139 return gpiod_get_array_value_complex(true, false, array_size,
3140 desc_array, array_info,
3143 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value);
3146 * gpiod_get_array_value() - read values from an array of GPIOs
3147 * @array_size: number of elements in the descriptor array / value bitmap
3148 * @desc_array: array of GPIO descriptors whose values will be read
3149 * @array_info: information on applicability of fast bitmap processing path
3150 * @value_bitmap: bitmap to store the read values
3152 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3153 * into account. Return 0 in case of success, else an error code.
3155 * This function can be called from contexts where we cannot sleep,
3156 * and it will complain if the GPIO chip functions potentially sleep.
3158 int gpiod_get_array_value(unsigned int array_size,
3159 struct gpio_desc **desc_array,
3160 struct gpio_array *array_info,
3161 unsigned long *value_bitmap)
3165 return gpiod_get_array_value_complex(false, false, array_size,
3166 desc_array, array_info,
3169 EXPORT_SYMBOL_GPL(gpiod_get_array_value);
3172 * gpio_set_open_drain_value_commit() - Set the open drain gpio's value.
3173 * @desc: gpio descriptor whose state need to be set.
3174 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
3176 static void gpio_set_open_drain_value_commit(struct gpio_desc *desc, bool value)
3179 struct gpio_chip *gc = desc->gdev->chip;
3180 int offset = gpio_chip_hwgpio(desc);
3183 ret = gc->direction_input(gc, offset);
3185 ret = gc->direction_output(gc, offset, 0);
3187 set_bit(FLAG_IS_OUT, &desc->flags);
3189 trace_gpio_direction(desc_to_gpio(desc), value, ret);
3192 "%s: Error in set_value for open drain err %d\n",
3197 * _gpio_set_open_source_value() - Set the open source gpio's value.
3198 * @desc: gpio descriptor whose state need to be set.
3199 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
3201 static void gpio_set_open_source_value_commit(struct gpio_desc *desc, bool value)
3204 struct gpio_chip *gc = desc->gdev->chip;
3205 int offset = gpio_chip_hwgpio(desc);
3208 ret = gc->direction_output(gc, offset, 1);
3210 set_bit(FLAG_IS_OUT, &desc->flags);
3212 ret = gc->direction_input(gc, offset);
3214 trace_gpio_direction(desc_to_gpio(desc), !value, ret);
3217 "%s: Error in set_value for open source err %d\n",
3221 static void gpiod_set_raw_value_commit(struct gpio_desc *desc, bool value)
3223 struct gpio_chip *gc;
3225 gc = desc->gdev->chip;
3226 trace_gpio_value(desc_to_gpio(desc), 0, value);
3227 gc->set(gc, gpio_chip_hwgpio(desc), value);
3231 * set multiple outputs on the same chip;
3232 * use the chip's set_multiple function if available;
3233 * otherwise set the outputs sequentially;
3234 * @chip: the GPIO chip we operate on
3235 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
3236 * defines which outputs are to be changed
3237 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
3238 * defines the values the outputs specified by mask are to be set to
3240 static void gpio_chip_set_multiple(struct gpio_chip *gc,
3241 unsigned long *mask, unsigned long *bits)
3243 if (gc->set_multiple) {
3244 gc->set_multiple(gc, mask, bits);
3248 /* set outputs if the corresponding mask bit is set */
3249 for_each_set_bit(i, mask, gc->ngpio)
3250 gc->set(gc, i, test_bit(i, bits));
3254 int gpiod_set_array_value_complex(bool raw, bool can_sleep,
3255 unsigned int array_size,
3256 struct gpio_desc **desc_array,
3257 struct gpio_array *array_info,
3258 unsigned long *value_bitmap)
3263 * Validate array_info against desc_array and its size.
3264 * It should immediately follow desc_array if both
3265 * have been obtained from the same gpiod_get_array() call.
3267 if (array_info && array_info->desc == desc_array &&
3268 array_size <= array_info->size &&
3269 (void *)array_info == desc_array + array_info->size) {
3271 WARN_ON(array_info->chip->can_sleep);
3273 if (!raw && !bitmap_empty(array_info->invert_mask, array_size))
3274 bitmap_xor(value_bitmap, value_bitmap,
3275 array_info->invert_mask, array_size);
3277 gpio_chip_set_multiple(array_info->chip, array_info->set_mask,
3280 i = find_first_zero_bit(array_info->set_mask, array_size);
3281 if (i == array_size)
3287 while (i < array_size) {
3288 struct gpio_chip *gc = desc_array[i]->gdev->chip;
3289 DECLARE_BITMAP(fastpath_mask, FASTPATH_NGPIO);
3290 DECLARE_BITMAP(fastpath_bits, FASTPATH_NGPIO);
3291 unsigned long *mask, *bits;
3294 if (likely(gc->ngpio <= FASTPATH_NGPIO)) {
3295 mask = fastpath_mask;
3296 bits = fastpath_bits;
3298 gfp_t flags = can_sleep ? GFP_KERNEL : GFP_ATOMIC;
3300 mask = bitmap_alloc(gc->ngpio, flags);
3304 bits = bitmap_alloc(gc->ngpio, flags);
3311 bitmap_zero(mask, gc->ngpio);
3314 WARN_ON(gc->can_sleep);
3317 struct gpio_desc *desc = desc_array[i];
3318 int hwgpio = gpio_chip_hwgpio(desc);
3319 int value = test_bit(i, value_bitmap);
3322 * Pins applicable for fast input but not for
3323 * fast output processing may have been already
3324 * inverted inside the fast path, skip them.
3326 if (!raw && !(array_info &&
3327 test_bit(i, array_info->invert_mask)) &&
3328 test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3330 trace_gpio_value(desc_to_gpio(desc), 0, value);
3332 * collect all normal outputs belonging to the same chip
3333 * open drain and open source outputs are set individually
3335 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags) && !raw) {
3336 gpio_set_open_drain_value_commit(desc, value);
3337 } else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags) && !raw) {
3338 gpio_set_open_source_value_commit(desc, value);
3340 __set_bit(hwgpio, mask);
3341 __assign_bit(hwgpio, bits, value);
3347 i = find_next_zero_bit(array_info->set_mask,
3349 } while ((i < array_size) &&
3350 (desc_array[i]->gdev->chip == gc));
3351 /* push collected bits to outputs */
3353 gpio_chip_set_multiple(gc, mask, bits);
3355 if (mask != fastpath_mask)
3357 if (bits != fastpath_bits)
3364 * gpiod_set_raw_value() - assign a gpio's raw value
3365 * @desc: gpio whose value will be assigned
3366 * @value: value to assign
3368 * Set the raw value of the GPIO, i.e. the value of its physical line without
3369 * regard for its ACTIVE_LOW status.
3371 * This function can be called from contexts where we cannot sleep, and will
3372 * complain if the GPIO chip functions potentially sleep.
3374 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
3376 VALIDATE_DESC_VOID(desc);
3377 /* Should be using gpiod_set_raw_value_cansleep() */
3378 WARN_ON(desc->gdev->chip->can_sleep);
3379 gpiod_set_raw_value_commit(desc, value);
3381 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
3384 * gpiod_set_value_nocheck() - set a GPIO line value without checking
3385 * @desc: the descriptor to set the value on
3386 * @value: value to set
3388 * This sets the value of a GPIO line backing a descriptor, applying
3389 * different semantic quirks like active low and open drain/source
3392 static void gpiod_set_value_nocheck(struct gpio_desc *desc, int value)
3394 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3396 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
3397 gpio_set_open_drain_value_commit(desc, value);
3398 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
3399 gpio_set_open_source_value_commit(desc, value);
3401 gpiod_set_raw_value_commit(desc, value);
3405 * gpiod_set_value() - assign a gpio's value
3406 * @desc: gpio whose value will be assigned
3407 * @value: value to assign
3409 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW,
3410 * OPEN_DRAIN and OPEN_SOURCE flags into account.
3412 * This function can be called from contexts where we cannot sleep, and will
3413 * complain if the GPIO chip functions potentially sleep.
3415 void gpiod_set_value(struct gpio_desc *desc, int value)
3417 VALIDATE_DESC_VOID(desc);
3418 /* Should be using gpiod_set_value_cansleep() */
3419 WARN_ON(desc->gdev->chip->can_sleep);
3420 gpiod_set_value_nocheck(desc, value);
3422 EXPORT_SYMBOL_GPL(gpiod_set_value);
3425 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
3426 * @array_size: number of elements in the descriptor array / value bitmap
3427 * @desc_array: array of GPIO descriptors whose values will be assigned
3428 * @array_info: information on applicability of fast bitmap processing path
3429 * @value_bitmap: bitmap of values to assign
3431 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3432 * without regard for their ACTIVE_LOW status.
3434 * This function can be called from contexts where we cannot sleep, and will
3435 * complain if the GPIO chip functions potentially sleep.
3437 int gpiod_set_raw_array_value(unsigned int array_size,
3438 struct gpio_desc **desc_array,
3439 struct gpio_array *array_info,
3440 unsigned long *value_bitmap)
3444 return gpiod_set_array_value_complex(true, false, array_size,
3445 desc_array, array_info, value_bitmap);
3447 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
3450 * gpiod_set_array_value() - assign values to an array of GPIOs
3451 * @array_size: number of elements in the descriptor array / value bitmap
3452 * @desc_array: array of GPIO descriptors whose values will be assigned
3453 * @array_info: information on applicability of fast bitmap processing path
3454 * @value_bitmap: bitmap of values to assign
3456 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3459 * This function can be called from contexts where we cannot sleep, and will
3460 * complain if the GPIO chip functions potentially sleep.
3462 int gpiod_set_array_value(unsigned int array_size,
3463 struct gpio_desc **desc_array,
3464 struct gpio_array *array_info,
3465 unsigned long *value_bitmap)
3469 return gpiod_set_array_value_complex(false, false, array_size,
3470 desc_array, array_info,
3473 EXPORT_SYMBOL_GPL(gpiod_set_array_value);
3476 * gpiod_cansleep() - report whether gpio value access may sleep
3477 * @desc: gpio to check
3480 int gpiod_cansleep(const struct gpio_desc *desc)
3482 VALIDATE_DESC(desc);
3483 return desc->gdev->chip->can_sleep;
3485 EXPORT_SYMBOL_GPL(gpiod_cansleep);
3488 * gpiod_set_consumer_name() - set the consumer name for the descriptor
3489 * @desc: gpio to set the consumer name on
3490 * @name: the new consumer name
3492 int gpiod_set_consumer_name(struct gpio_desc *desc, const char *name)
3494 VALIDATE_DESC(desc);
3496 name = kstrdup_const(name, GFP_KERNEL);
3501 kfree_const(desc->label);
3502 desc_set_label(desc, name);
3506 EXPORT_SYMBOL_GPL(gpiod_set_consumer_name);
3509 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
3510 * @desc: gpio whose IRQ will be returned (already requested)
3512 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
3515 int gpiod_to_irq(const struct gpio_desc *desc)
3517 struct gpio_chip *gc;
3521 * Cannot VALIDATE_DESC() here as gpiod_to_irq() consumer semantics
3522 * requires this function to not return zero on an invalid descriptor
3523 * but rather a negative error number.
3525 if (!desc || IS_ERR(desc) || !desc->gdev || !desc->gdev->chip)
3528 gc = desc->gdev->chip;
3529 offset = gpio_chip_hwgpio(desc);
3531 int retirq = gc->to_irq(gc, offset);
3533 /* Zero means NO_IRQ */
3539 #ifdef CONFIG_GPIOLIB_IRQCHIP
3542 * Avoid race condition with other code, which tries to lookup
3543 * an IRQ before the irqchip has been properly registered,
3544 * i.e. while gpiochip is still being brought up.
3546 return -EPROBE_DEFER;
3551 EXPORT_SYMBOL_GPL(gpiod_to_irq);
3554 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
3555 * @gc: the chip the GPIO to lock belongs to
3556 * @offset: the offset of the GPIO to lock as IRQ
3558 * This is used directly by GPIO drivers that want to lock down
3559 * a certain GPIO line to be used for IRQs.
3561 int gpiochip_lock_as_irq(struct gpio_chip *gc, unsigned int offset)
3563 struct gpio_desc *desc;
3565 desc = gpiochip_get_desc(gc, offset);
3567 return PTR_ERR(desc);
3570 * If it's fast: flush the direction setting if something changed
3573 if (!gc->can_sleep && gc->get_direction) {
3574 int dir = gpiod_get_direction(desc);
3577 chip_err(gc, "%s: cannot get GPIO direction\n",
3583 /* To be valid for IRQ the line needs to be input or open drain */
3584 if (test_bit(FLAG_IS_OUT, &desc->flags) &&
3585 !test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
3587 "%s: tried to flag a GPIO set as output for IRQ\n",
3592 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
3593 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3596 * If the consumer has not set up a label (such as when the
3597 * IRQ is referenced from .to_irq()) we set up a label here
3598 * so it is clear this is used as an interrupt.
3601 desc_set_label(desc, "interrupt");
3605 EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
3608 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
3609 * @gc: the chip the GPIO to lock belongs to
3610 * @offset: the offset of the GPIO to lock as IRQ
3612 * This is used directly by GPIO drivers that want to indicate
3613 * that a certain GPIO is no longer used exclusively for IRQ.
3615 void gpiochip_unlock_as_irq(struct gpio_chip *gc, unsigned int offset)
3617 struct gpio_desc *desc;
3619 desc = gpiochip_get_desc(gc, offset);
3623 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
3624 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3626 /* If we only had this marking, erase it */
3627 if (desc->label && !strcmp(desc->label, "interrupt"))
3628 desc_set_label(desc, NULL);
3630 EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
3632 void gpiochip_disable_irq(struct gpio_chip *gc, unsigned int offset)
3634 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3636 if (!IS_ERR(desc) &&
3637 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags)))
3638 clear_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3640 EXPORT_SYMBOL_GPL(gpiochip_disable_irq);
3642 void gpiochip_enable_irq(struct gpio_chip *gc, unsigned int offset)
3644 struct gpio_desc *desc = gpiochip_get_desc(gc, offset);
3646 if (!IS_ERR(desc) &&
3647 !WARN_ON(!test_bit(FLAG_USED_AS_IRQ, &desc->flags))) {
3649 * We must not be output when using IRQ UNLESS we are
3652 WARN_ON(test_bit(FLAG_IS_OUT, &desc->flags) &&
3653 !test_bit(FLAG_OPEN_DRAIN, &desc->flags));
3654 set_bit(FLAG_IRQ_IS_ENABLED, &desc->flags);
3657 EXPORT_SYMBOL_GPL(gpiochip_enable_irq);
3659 bool gpiochip_line_is_irq(struct gpio_chip *gc, unsigned int offset)
3661 if (offset >= gc->ngpio)
3664 return test_bit(FLAG_USED_AS_IRQ, &gc->gpiodev->descs[offset].flags);
3666 EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);
3668 int gpiochip_reqres_irq(struct gpio_chip *gc, unsigned int offset)
3672 if (!try_module_get(gc->gpiodev->owner))
3675 ret = gpiochip_lock_as_irq(gc, offset);
3677 chip_err(gc, "unable to lock HW IRQ %u for IRQ\n", offset);
3678 module_put(gc->gpiodev->owner);
3683 EXPORT_SYMBOL_GPL(gpiochip_reqres_irq);
3685 void gpiochip_relres_irq(struct gpio_chip *gc, unsigned int offset)
3687 gpiochip_unlock_as_irq(gc, offset);
3688 module_put(gc->gpiodev->owner);
3690 EXPORT_SYMBOL_GPL(gpiochip_relres_irq);
3692 bool gpiochip_line_is_open_drain(struct gpio_chip *gc, unsigned int offset)
3694 if (offset >= gc->ngpio)
3697 return test_bit(FLAG_OPEN_DRAIN, &gc->gpiodev->descs[offset].flags);
3699 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);
3701 bool gpiochip_line_is_open_source(struct gpio_chip *gc, unsigned int offset)
3703 if (offset >= gc->ngpio)
3706 return test_bit(FLAG_OPEN_SOURCE, &gc->gpiodev->descs[offset].flags);
3708 EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);
3710 bool gpiochip_line_is_persistent(struct gpio_chip *gc, unsigned int offset)
3712 if (offset >= gc->ngpio)
3715 return !test_bit(FLAG_TRANSITORY, &gc->gpiodev->descs[offset].flags);
3717 EXPORT_SYMBOL_GPL(gpiochip_line_is_persistent);
3720 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
3721 * @desc: gpio whose value will be returned
3723 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
3724 * its ACTIVE_LOW status, or negative errno on failure.
3726 * This function is to be called from contexts that can sleep.
3728 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
3731 VALIDATE_DESC(desc);
3732 return gpiod_get_raw_value_commit(desc);
3734 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
3737 * gpiod_get_value_cansleep() - return a gpio's value
3738 * @desc: gpio whose value will be returned
3740 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
3741 * account, or negative errno on failure.
3743 * This function is to be called from contexts that can sleep.
3745 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
3750 VALIDATE_DESC(desc);
3751 value = gpiod_get_raw_value_commit(desc);
3755 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
3760 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
3763 * gpiod_get_raw_array_value_cansleep() - read raw values from an array of GPIOs
3764 * @array_size: number of elements in the descriptor array / value bitmap
3765 * @desc_array: array of GPIO descriptors whose values will be read
3766 * @array_info: information on applicability of fast bitmap processing path
3767 * @value_bitmap: bitmap to store the read values
3769 * Read the raw values of the GPIOs, i.e. the values of the physical lines
3770 * without regard for their ACTIVE_LOW status. Return 0 in case of success,
3771 * else an error code.
3773 * This function is to be called from contexts that can sleep.
3775 int gpiod_get_raw_array_value_cansleep(unsigned int array_size,
3776 struct gpio_desc **desc_array,
3777 struct gpio_array *array_info,
3778 unsigned long *value_bitmap)
3783 return gpiod_get_array_value_complex(true, true, array_size,
3784 desc_array, array_info,
3787 EXPORT_SYMBOL_GPL(gpiod_get_raw_array_value_cansleep);
3790 * gpiod_get_array_value_cansleep() - read values from an array of GPIOs
3791 * @array_size: number of elements in the descriptor array / value bitmap
3792 * @desc_array: array of GPIO descriptors whose values will be read
3793 * @array_info: information on applicability of fast bitmap processing path
3794 * @value_bitmap: bitmap to store the read values
3796 * Read the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3797 * into account. Return 0 in case of success, else an error code.
3799 * This function is to be called from contexts that can sleep.
3801 int gpiod_get_array_value_cansleep(unsigned int array_size,
3802 struct gpio_desc **desc_array,
3803 struct gpio_array *array_info,
3804 unsigned long *value_bitmap)
3809 return gpiod_get_array_value_complex(false, true, array_size,
3810 desc_array, array_info,
3813 EXPORT_SYMBOL_GPL(gpiod_get_array_value_cansleep);
3816 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
3817 * @desc: gpio whose value will be assigned
3818 * @value: value to assign
3820 * Set the raw value of the GPIO, i.e. the value of its physical line without
3821 * regard for its ACTIVE_LOW status.
3823 * This function is to be called from contexts that can sleep.
3825 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
3828 VALIDATE_DESC_VOID(desc);
3829 gpiod_set_raw_value_commit(desc, value);
3831 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
3834 * gpiod_set_value_cansleep() - assign a gpio's value
3835 * @desc: gpio whose value will be assigned
3836 * @value: value to assign
3838 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
3841 * This function is to be called from contexts that can sleep.
3843 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
3846 VALIDATE_DESC_VOID(desc);
3847 gpiod_set_value_nocheck(desc, value);
3849 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
3852 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
3853 * @array_size: number of elements in the descriptor array / value bitmap
3854 * @desc_array: array of GPIO descriptors whose values will be assigned
3855 * @array_info: information on applicability of fast bitmap processing path
3856 * @value_bitmap: bitmap of values to assign
3858 * Set the raw values of the GPIOs, i.e. the values of the physical lines
3859 * without regard for their ACTIVE_LOW status.
3861 * This function is to be called from contexts that can sleep.
3863 int gpiod_set_raw_array_value_cansleep(unsigned int array_size,
3864 struct gpio_desc **desc_array,
3865 struct gpio_array *array_info,
3866 unsigned long *value_bitmap)
3871 return gpiod_set_array_value_complex(true, true, array_size, desc_array,
3872 array_info, value_bitmap);
3874 EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
3877 * gpiod_add_lookup_tables() - register GPIO device consumers
3878 * @tables: list of tables of consumers to register
3879 * @n: number of tables in the list
3881 void gpiod_add_lookup_tables(struct gpiod_lookup_table **tables, size_t n)
3885 mutex_lock(&gpio_lookup_lock);
3887 for (i = 0; i < n; i++)
3888 list_add_tail(&tables[i]->list, &gpio_lookup_list);
3890 mutex_unlock(&gpio_lookup_lock);
3894 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
3895 * @array_size: number of elements in the descriptor array / value bitmap
3896 * @desc_array: array of GPIO descriptors whose values will be assigned
3897 * @array_info: information on applicability of fast bitmap processing path
3898 * @value_bitmap: bitmap of values to assign
3900 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
3903 * This function is to be called from contexts that can sleep.
3905 int gpiod_set_array_value_cansleep(unsigned int array_size,
3906 struct gpio_desc **desc_array,
3907 struct gpio_array *array_info,
3908 unsigned long *value_bitmap)
3913 return gpiod_set_array_value_complex(false, true, array_size,
3914 desc_array, array_info,
3917 EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
3919 void gpiod_line_state_notify(struct gpio_desc *desc, unsigned long action)
3921 blocking_notifier_call_chain(&desc->gdev->line_state_notifier,
3926 * gpiod_add_lookup_table() - register GPIO device consumers
3927 * @table: table of consumers to register
3929 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
3931 gpiod_add_lookup_tables(&table, 1);
3933 EXPORT_SYMBOL_GPL(gpiod_add_lookup_table);
3936 * gpiod_remove_lookup_table() - unregister GPIO device consumers
3937 * @table: table of consumers to unregister
3939 void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
3941 /* Nothing to remove */
3945 mutex_lock(&gpio_lookup_lock);
3947 list_del(&table->list);
3949 mutex_unlock(&gpio_lookup_lock);
3951 EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);
3954 * gpiod_add_hogs() - register a set of GPIO hogs from machine code
3955 * @hogs: table of gpio hog entries with a zeroed sentinel at the end
3957 void gpiod_add_hogs(struct gpiod_hog *hogs)
3959 struct gpiod_hog *hog;
3961 mutex_lock(&gpio_machine_hogs_mutex);
3963 for (hog = &hogs[0]; hog->chip_label; hog++) {
3964 list_add_tail(&hog->list, &gpio_machine_hogs);
3967 * The chip may have been registered earlier, so check if it
3968 * exists and, if so, try to hog the line now.
3970 struct gpio_device *gdev __free(gpio_device_put) =
3971 gpio_device_find_by_label(hog->chip_label);
3973 gpiochip_machine_hog(gpio_device_get_chip(gdev), hog);
3976 mutex_unlock(&gpio_machine_hogs_mutex);
3978 EXPORT_SYMBOL_GPL(gpiod_add_hogs);
3980 void gpiod_remove_hogs(struct gpiod_hog *hogs)
3982 struct gpiod_hog *hog;
3984 mutex_lock(&gpio_machine_hogs_mutex);
3985 for (hog = &hogs[0]; hog->chip_label; hog++)
3986 list_del(&hog->list);
3987 mutex_unlock(&gpio_machine_hogs_mutex);
3989 EXPORT_SYMBOL_GPL(gpiod_remove_hogs);
3991 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
3993 const char *dev_id = dev ? dev_name(dev) : NULL;
3994 struct gpiod_lookup_table *table;
3996 list_for_each_entry(table, &gpio_lookup_list, list) {
3997 if (table->dev_id && dev_id) {
3999 * Valid strings on both ends, must be identical to have
4002 if (!strcmp(table->dev_id, dev_id))
4006 * One of the pointers is NULL, so both must be to have
4009 if (dev_id == table->dev_id)
4017 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
4018 unsigned int idx, unsigned long *flags)
4020 struct gpio_desc *desc = ERR_PTR(-ENOENT);
4021 struct gpiod_lookup_table *table;
4022 struct gpiod_lookup *p;
4023 struct gpio_chip *gc;
4025 guard(mutex)(&gpio_lookup_lock);
4027 table = gpiod_find_lookup_table(dev);
4031 for (p = &table->table[0]; p->key; p++) {
4032 /* idx must always match exactly */
4036 /* If the lookup entry has a con_id, require exact match */
4037 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
4040 if (p->chip_hwnum == U16_MAX) {
4041 desc = gpio_name_to_desc(p->key);
4047 dev_warn(dev, "cannot find GPIO line %s, deferring\n",
4049 return ERR_PTR(-EPROBE_DEFER);
4052 struct gpio_device *gdev __free(gpio_device_put) =
4053 gpio_device_find_by_label(p->key);
4056 * As the lookup table indicates a chip with
4057 * p->key should exist, assume it may
4058 * still appear later and let the interested
4059 * consumer be probed again or let the Deferred
4060 * Probe infrastructure handle the error.
4062 dev_warn(dev, "cannot find GPIO chip %s, deferring\n",
4064 return ERR_PTR(-EPROBE_DEFER);
4067 gc = gpio_device_get_chip(gdev);
4069 if (gc->ngpio <= p->chip_hwnum) {
4071 "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
4072 idx, p->chip_hwnum, gc->ngpio - 1,
4074 return ERR_PTR(-EINVAL);
4077 desc = gpio_device_get_desc(gdev, p->chip_hwnum);
4086 static int platform_gpio_count(struct device *dev, const char *con_id)
4088 struct gpiod_lookup_table *table;
4089 struct gpiod_lookup *p;
4090 unsigned int count = 0;
4092 scoped_guard(mutex, &gpio_lookup_lock) {
4093 table = gpiod_find_lookup_table(dev);
4097 for (p = &table->table[0]; p->key; p++) {
4098 if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
4099 (!con_id && !p->con_id))
4110 static struct gpio_desc *gpiod_find_by_fwnode(struct fwnode_handle *fwnode,
4111 struct device *consumer,
4114 enum gpiod_flags *flags,
4115 unsigned long *lookupflags)
4117 struct gpio_desc *desc = ERR_PTR(-ENOENT);
4119 if (is_of_node(fwnode)) {
4120 dev_dbg(consumer, "using DT '%pfw' for '%s' GPIO lookup\n",
4122 desc = of_find_gpio(to_of_node(fwnode), con_id, idx, lookupflags);
4123 } else if (is_acpi_node(fwnode)) {
4124 dev_dbg(consumer, "using ACPI '%pfw' for '%s' GPIO lookup\n",
4126 desc = acpi_find_gpio(fwnode, con_id, idx, flags, lookupflags);
4127 } else if (is_software_node(fwnode)) {
4128 dev_dbg(consumer, "using swnode '%pfw' for '%s' GPIO lookup\n",
4130 desc = swnode_find_gpio(fwnode, con_id, idx, lookupflags);
4136 static struct gpio_desc *gpiod_find_and_request(struct device *consumer,
4137 struct fwnode_handle *fwnode,
4140 enum gpiod_flags flags,
4142 bool platform_lookup_allowed)
4144 unsigned long lookupflags = GPIO_LOOKUP_FLAGS_DEFAULT;
4145 struct gpio_desc *desc;
4148 desc = gpiod_find_by_fwnode(fwnode, consumer, con_id, idx, &flags, &lookupflags);
4149 if (gpiod_not_found(desc) && platform_lookup_allowed) {
4151 * Either we are not using DT or ACPI, or their lookup did not
4152 * return a result. In that case, use platform lookup as a
4155 dev_dbg(consumer, "using lookup tables for GPIO lookup\n");
4156 desc = gpiod_find(consumer, con_id, idx, &lookupflags);
4160 dev_dbg(consumer, "No GPIO consumer %s found\n", con_id);
4165 * If a connection label was passed use that, else attempt to use
4166 * the device name as label
4168 ret = gpiod_request(desc, label);
4170 if (!(ret == -EBUSY && flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE))
4171 return ERR_PTR(ret);
4174 * This happens when there are several consumers for
4175 * the same GPIO line: we just return here without
4176 * further initialization. It is a bit of a hack.
4177 * This is necessary to support fixed regulators.
4179 * FIXME: Make this more sane and safe.
4182 "nonexclusive access to GPIO for %s\n", con_id);
4186 ret = gpiod_configure_flags(desc, con_id, lookupflags, flags);
4188 dev_dbg(consumer, "setup of GPIO %s failed\n", con_id);
4190 return ERR_PTR(ret);
4193 gpiod_line_state_notify(desc, GPIOLINE_CHANGED_REQUESTED);
4199 * fwnode_gpiod_get_index - obtain a GPIO from firmware node
4200 * @fwnode: handle of the firmware node
4201 * @con_id: function within the GPIO consumer
4202 * @index: index of the GPIO to obtain for the consumer
4203 * @flags: GPIO initialization flags
4204 * @label: label to attach to the requested GPIO
4206 * This function can be used for drivers that get their configuration
4207 * from opaque firmware.
4209 * The function properly finds the corresponding GPIO using whatever is the
4210 * underlying firmware interface and then makes sure that the GPIO
4211 * descriptor is requested before it is returned to the caller.
4214 * On successful request the GPIO pin is configured in accordance with
4217 * In case of error an ERR_PTR() is returned.
4219 struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
4222 enum gpiod_flags flags,
4225 return gpiod_find_and_request(NULL, fwnode, con_id, index, flags, label, false);
4227 EXPORT_SYMBOL_GPL(fwnode_gpiod_get_index);
4230 * gpiod_count - return the number of GPIOs associated with a device / function
4231 * or -ENOENT if no GPIO has been assigned to the requested function
4232 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4233 * @con_id: function within the GPIO consumer
4235 int gpiod_count(struct device *dev, const char *con_id)
4237 const struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
4238 int count = -ENOENT;
4240 if (is_of_node(fwnode))
4241 count = of_gpio_get_count(dev, con_id);
4242 else if (is_acpi_node(fwnode))
4243 count = acpi_gpio_count(dev, con_id);
4244 else if (is_software_node(fwnode))
4245 count = swnode_gpio_count(fwnode, con_id);
4248 count = platform_gpio_count(dev, con_id);
4252 EXPORT_SYMBOL_GPL(gpiod_count);
4255 * gpiod_get - obtain a GPIO for a given GPIO function
4256 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4257 * @con_id: function within the GPIO consumer
4258 * @flags: optional GPIO initialization flags
4260 * Return the GPIO descriptor corresponding to the function con_id of device
4261 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
4262 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
4264 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
4265 enum gpiod_flags flags)
4267 return gpiod_get_index(dev, con_id, 0, flags);
4269 EXPORT_SYMBOL_GPL(gpiod_get);
4272 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
4273 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4274 * @con_id: function within the GPIO consumer
4275 * @flags: optional GPIO initialization flags
4277 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
4278 * the requested function it will return NULL. This is convenient for drivers
4279 * that need to handle optional GPIOs.
4281 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
4283 enum gpiod_flags flags)
4285 return gpiod_get_index_optional(dev, con_id, 0, flags);
4287 EXPORT_SYMBOL_GPL(gpiod_get_optional);
4291 * gpiod_configure_flags - helper function to configure a given GPIO
4292 * @desc: gpio whose value will be assigned
4293 * @con_id: function within the GPIO consumer
4294 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4295 * of_find_gpio() or of_get_gpio_hog()
4296 * @dflags: gpiod_flags - optional GPIO initialization flags
4298 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
4299 * requested function and/or index, or another IS_ERR() code if an error
4300 * occurred while trying to acquire the GPIO.
4302 int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
4303 unsigned long lflags, enum gpiod_flags dflags)
4307 if (lflags & GPIO_ACTIVE_LOW)
4308 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
4310 if (lflags & GPIO_OPEN_DRAIN)
4311 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
4312 else if (dflags & GPIOD_FLAGS_BIT_OPEN_DRAIN) {
4314 * This enforces open drain mode from the consumer side.
4315 * This is necessary for some busses like I2C, but the lookup
4316 * should *REALLY* have specified them as open drain in the
4317 * first place, so print a little warning here.
4319 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
4321 "enforced open drain please flag it properly in DT/ACPI DSDT/board file\n");
4324 if (lflags & GPIO_OPEN_SOURCE)
4325 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
4327 if (((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DOWN)) ||
4328 ((lflags & GPIO_PULL_UP) && (lflags & GPIO_PULL_DISABLE)) ||
4329 ((lflags & GPIO_PULL_DOWN) && (lflags & GPIO_PULL_DISABLE))) {
4331 "multiple pull-up, pull-down or pull-disable enabled, invalid configuration\n");
4335 if (lflags & GPIO_PULL_UP)
4336 set_bit(FLAG_PULL_UP, &desc->flags);
4337 else if (lflags & GPIO_PULL_DOWN)
4338 set_bit(FLAG_PULL_DOWN, &desc->flags);
4339 else if (lflags & GPIO_PULL_DISABLE)
4340 set_bit(FLAG_BIAS_DISABLE, &desc->flags);
4342 ret = gpiod_set_transitory(desc, (lflags & GPIO_TRANSITORY));
4346 /* No particular flag request, return here... */
4347 if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
4348 gpiod_dbg(desc, "no flags found for %s\n", con_id);
4353 if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
4354 ret = gpiod_direction_output(desc,
4355 !!(dflags & GPIOD_FLAGS_BIT_DIR_VAL));
4357 ret = gpiod_direction_input(desc);
4363 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
4364 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4365 * @con_id: function within the GPIO consumer
4366 * @idx: index of the GPIO to obtain in the consumer
4367 * @flags: optional GPIO initialization flags
4369 * This variant of gpiod_get() allows to access GPIOs other than the first
4370 * defined one for functions that define several GPIOs.
4372 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
4373 * requested function and/or index, or another IS_ERR() code if an error
4374 * occurred while trying to acquire the GPIO.
4376 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
4379 enum gpiod_flags flags)
4381 struct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL;
4382 const char *devname = dev ? dev_name(dev) : "?";
4383 const char *label = con_id ?: devname;
4385 return gpiod_find_and_request(dev, fwnode, con_id, idx, flags, label, true);
4387 EXPORT_SYMBOL_GPL(gpiod_get_index);
4390 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
4392 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4393 * @con_id: function within the GPIO consumer
4394 * @index: index of the GPIO to obtain in the consumer
4395 * @flags: optional GPIO initialization flags
4397 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
4398 * specified index was assigned to the requested function it will return NULL.
4399 * This is convenient for drivers that need to handle optional GPIOs.
4401 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
4404 enum gpiod_flags flags)
4406 struct gpio_desc *desc;
4408 desc = gpiod_get_index(dev, con_id, index, flags);
4409 if (gpiod_not_found(desc))
4414 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
4417 * gpiod_hog - Hog the specified GPIO desc given the provided flags
4418 * @desc: gpio whose value will be assigned
4419 * @name: gpio line name
4420 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
4421 * of_find_gpio() or of_get_gpio_hog()
4422 * @dflags: gpiod_flags - optional GPIO initialization flags
4424 int gpiod_hog(struct gpio_desc *desc, const char *name,
4425 unsigned long lflags, enum gpiod_flags dflags)
4427 struct gpio_chip *gc;
4428 struct gpio_desc *local_desc;
4432 gc = gpiod_to_chip(desc);
4433 hwnum = gpio_chip_hwgpio(desc);
4435 local_desc = gpiochip_request_own_desc(gc, hwnum, name,
4437 if (IS_ERR(local_desc)) {
4438 ret = PTR_ERR(local_desc);
4439 pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
4440 name, gc->label, hwnum, ret);
4444 /* Mark GPIO as hogged so it can be identified and removed later */
4445 set_bit(FLAG_IS_HOGGED, &desc->flags);
4447 gpiod_dbg(desc, "hogged as %s%s\n",
4448 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
4449 (dflags & GPIOD_FLAGS_BIT_DIR_OUT) ?
4450 (dflags & GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low" : "");
4456 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
4457 * @gc: gpio chip to act on
4459 static void gpiochip_free_hogs(struct gpio_chip *gc)
4461 struct gpio_desc *desc;
4463 for_each_gpio_desc_with_flag(gc, desc, FLAG_IS_HOGGED)
4464 gpiochip_free_own_desc(desc);
4468 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
4469 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4470 * @con_id: function within the GPIO consumer
4471 * @flags: optional GPIO initialization flags
4473 * This function acquires all the GPIOs defined under a given function.
4475 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
4476 * no GPIO has been assigned to the requested function, or another IS_ERR()
4477 * code if an error occurred while trying to acquire the GPIOs.
4479 struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
4481 enum gpiod_flags flags)
4483 struct gpio_desc *desc;
4484 struct gpio_descs *descs;
4485 struct gpio_array *array_info = NULL;
4486 struct gpio_chip *gc;
4487 int count, bitmap_size;
4490 count = gpiod_count(dev, con_id);
4492 return ERR_PTR(count);
4494 descs_size = struct_size(descs, desc, count);
4495 descs = kzalloc(descs_size, GFP_KERNEL);
4497 return ERR_PTR(-ENOMEM);
4499 for (descs->ndescs = 0; descs->ndescs < count; descs->ndescs++) {
4500 desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
4502 gpiod_put_array(descs);
4503 return ERR_CAST(desc);
4506 descs->desc[descs->ndescs] = desc;
4508 gc = gpiod_to_chip(desc);
4510 * If pin hardware number of array member 0 is also 0, select
4511 * its chip as a candidate for fast bitmap processing path.
4513 if (descs->ndescs == 0 && gpio_chip_hwgpio(desc) == 0) {
4514 struct gpio_descs *array;
4516 bitmap_size = BITS_TO_LONGS(gc->ngpio > count ?
4519 array = krealloc(descs, descs_size +
4520 struct_size(array_info, invert_mask, 3 * bitmap_size),
4521 GFP_KERNEL | __GFP_ZERO);
4523 gpiod_put_array(descs);
4524 return ERR_PTR(-ENOMEM);
4529 array_info = (void *)descs + descs_size;
4530 array_info->get_mask = array_info->invert_mask +
4532 array_info->set_mask = array_info->get_mask +
4535 array_info->desc = descs->desc;
4536 array_info->size = count;
4537 array_info->chip = gc;
4538 bitmap_set(array_info->get_mask, descs->ndescs,
4539 count - descs->ndescs);
4540 bitmap_set(array_info->set_mask, descs->ndescs,
4541 count - descs->ndescs);
4542 descs->info = array_info;
4545 /* If there is no cache for fast bitmap processing path, continue */
4549 /* Unmark array members which don't belong to the 'fast' chip */
4550 if (array_info->chip != gc) {
4551 __clear_bit(descs->ndescs, array_info->get_mask);
4552 __clear_bit(descs->ndescs, array_info->set_mask);
4555 * Detect array members which belong to the 'fast' chip
4556 * but their pins are not in hardware order.
4558 else if (gpio_chip_hwgpio(desc) != descs->ndescs) {
4560 * Don't use fast path if all array members processed so
4561 * far belong to the same chip as this one but its pin
4562 * hardware number is different from its array index.
4564 if (bitmap_full(array_info->get_mask, descs->ndescs)) {
4567 __clear_bit(descs->ndescs,
4568 array_info->get_mask);
4569 __clear_bit(descs->ndescs,
4570 array_info->set_mask);
4573 /* Exclude open drain or open source from fast output */
4574 if (gpiochip_line_is_open_drain(gc, descs->ndescs) ||
4575 gpiochip_line_is_open_source(gc, descs->ndescs))
4576 __clear_bit(descs->ndescs,
4577 array_info->set_mask);
4578 /* Identify 'fast' pins which require invertion */
4579 if (gpiod_is_active_low(desc))
4580 __set_bit(descs->ndescs,
4581 array_info->invert_mask);
4586 "GPIO array info: chip=%s, size=%d, get_mask=%lx, set_mask=%lx, invert_mask=%lx\n",
4587 array_info->chip->label, array_info->size,
4588 *array_info->get_mask, *array_info->set_mask,
4589 *array_info->invert_mask);
4592 EXPORT_SYMBOL_GPL(gpiod_get_array);
4595 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
4597 * @dev: GPIO consumer, can be NULL for system-global GPIOs
4598 * @con_id: function within the GPIO consumer
4599 * @flags: optional GPIO initialization flags
4601 * This is equivalent to gpiod_get_array(), except that when no GPIO was
4602 * assigned to the requested function it will return NULL.
4604 struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
4606 enum gpiod_flags flags)
4608 struct gpio_descs *descs;
4610 descs = gpiod_get_array(dev, con_id, flags);
4611 if (gpiod_not_found(descs))
4616 EXPORT_SYMBOL_GPL(gpiod_get_array_optional);
4619 * gpiod_put - dispose of a GPIO descriptor
4620 * @desc: GPIO descriptor to dispose of
4622 * No descriptor can be used after gpiod_put() has been called on it.
4624 void gpiod_put(struct gpio_desc *desc)
4629 EXPORT_SYMBOL_GPL(gpiod_put);
4632 * gpiod_put_array - dispose of multiple GPIO descriptors
4633 * @descs: struct gpio_descs containing an array of descriptors
4635 void gpiod_put_array(struct gpio_descs *descs)
4639 for (i = 0; i < descs->ndescs; i++)
4640 gpiod_put(descs->desc[i]);
4644 EXPORT_SYMBOL_GPL(gpiod_put_array);
4646 static int gpio_stub_drv_probe(struct device *dev)
4649 * The DT node of some GPIO chips have a "compatible" property, but
4650 * never have a struct device added and probed by a driver to register
4651 * the GPIO chip with gpiolib. In such cases, fw_devlink=on will cause
4652 * the consumers of the GPIO chip to get probe deferred forever because
4653 * they will be waiting for a device associated with the GPIO chip
4654 * firmware node to get added and bound to a driver.
4656 * To allow these consumers to probe, we associate the struct
4657 * gpio_device of the GPIO chip with the firmware node and then simply
4658 * bind it to this stub driver.
4663 static struct device_driver gpio_stub_drv = {
4664 .name = "gpio_stub_drv",
4665 .bus = &gpio_bus_type,
4666 .probe = gpio_stub_drv_probe,
4669 static int __init gpiolib_dev_init(void)
4673 /* Register GPIO sysfs bus */
4674 ret = bus_register(&gpio_bus_type);
4676 pr_err("gpiolib: could not register GPIO bus type\n");
4680 ret = driver_register(&gpio_stub_drv);
4682 pr_err("gpiolib: could not register GPIO stub driver\n");
4683 bus_unregister(&gpio_bus_type);
4687 ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, GPIOCHIP_NAME);
4689 pr_err("gpiolib: failed to allocate char dev region\n");
4690 driver_unregister(&gpio_stub_drv);
4691 bus_unregister(&gpio_bus_type);
4695 gpiolib_initialized = true;
4696 gpiochip_setup_devs();
4698 #if IS_ENABLED(CONFIG_OF_DYNAMIC) && IS_ENABLED(CONFIG_OF_GPIO)
4699 WARN_ON(of_reconfig_notifier_register(&gpio_of_notifier));
4700 #endif /* CONFIG_OF_DYNAMIC && CONFIG_OF_GPIO */
4704 core_initcall(gpiolib_dev_init);
4706 #ifdef CONFIG_DEBUG_FS
4708 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
4710 struct gpio_chip *gc = gdev->chip;
4711 bool active_low, is_irq, is_out;
4712 unsigned int gpio = gdev->base;
4713 struct gpio_desc *desc;
4716 for_each_gpio_desc(gc, desc) {
4717 if (test_bit(FLAG_REQUESTED, &desc->flags)) {
4718 gpiod_get_direction(desc);
4719 is_out = test_bit(FLAG_IS_OUT, &desc->flags);
4720 value = gpio_chip_get_value(gc, desc);
4721 is_irq = test_bit(FLAG_USED_AS_IRQ, &desc->flags);
4722 active_low = test_bit(FLAG_ACTIVE_LOW, &desc->flags);
4723 seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s%s\n",
4724 gpio, desc->name ?: "", desc->label,
4725 is_out ? "out" : "in ",
4726 value >= 0 ? (value ? "hi" : "lo") : "? ",
4727 is_irq ? "IRQ " : "",
4728 active_low ? "ACTIVE LOW" : "");
4729 } else if (desc->name) {
4730 seq_printf(s, " gpio-%-3d (%-20.20s)\n", gpio, desc->name);
4737 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
4739 unsigned long flags;
4740 struct gpio_device *gdev = NULL;
4741 loff_t index = *pos;
4745 spin_lock_irqsave(&gpio_lock, flags);
4746 list_for_each_entry(gdev, &gpio_devices, list)
4748 spin_unlock_irqrestore(&gpio_lock, flags);
4751 spin_unlock_irqrestore(&gpio_lock, flags);
4756 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
4758 unsigned long flags;
4759 struct gpio_device *gdev = v;
4762 spin_lock_irqsave(&gpio_lock, flags);
4763 if (list_is_last(&gdev->list, &gpio_devices))
4766 ret = list_first_entry(&gdev->list, struct gpio_device, list);
4767 spin_unlock_irqrestore(&gpio_lock, flags);
4775 static void gpiolib_seq_stop(struct seq_file *s, void *v)
4779 static int gpiolib_seq_show(struct seq_file *s, void *v)
4781 struct gpio_device *gdev = v;
4782 struct gpio_chip *gc = gdev->chip;
4783 struct device *parent;
4786 seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
4787 dev_name(&gdev->dev));
4791 seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
4792 dev_name(&gdev->dev),
4793 gdev->base, gdev->base + gdev->ngpio - 1);
4794 parent = gc->parent;
4796 seq_printf(s, ", parent: %s/%s",
4797 parent->bus ? parent->bus->name : "no-bus",
4800 seq_printf(s, ", %s", gc->label);
4802 seq_printf(s, ", can sleep");
4803 seq_printf(s, ":\n");
4806 gc->dbg_show(s, gc);
4808 gpiolib_dbg_show(s, gdev);
4813 static const struct seq_operations gpiolib_sops = {
4814 .start = gpiolib_seq_start,
4815 .next = gpiolib_seq_next,
4816 .stop = gpiolib_seq_stop,
4817 .show = gpiolib_seq_show,
4819 DEFINE_SEQ_ATTRIBUTE(gpiolib);
4821 static int __init gpiolib_debugfs_init(void)
4823 /* /sys/kernel/debug/gpio */
4824 debugfs_create_file("gpio", 0444, NULL, NULL, &gpiolib_fops);
4827 subsys_initcall(gpiolib_debugfs_init);
4829 #endif /* DEBUG_FS */