1 #include <linux/kernel.h>
2 #include <linux/module.h>
3 #include <linux/interrupt.h>
5 #include <linux/spinlock.h>
6 #include <linux/list.h>
7 #include <linux/device.h>
9 #include <linux/debugfs.h>
10 #include <linux/seq_file.h>
11 #include <linux/gpio.h>
12 #include <linux/of_gpio.h>
13 #include <linux/idr.h>
14 #include <linux/slab.h>
15 #include <linux/acpi.h>
16 #include <linux/gpio/driver.h>
20 #define CREATE_TRACE_POINTS
21 #include <trace/events/gpio.h>
23 /* Implementation infrastructure for GPIO interfaces.
25 * The GPIO programming interface allows for inlining speed-critical
26 * get/set operations for common cases, so that access to SOC-integrated
27 * GPIOs can sometimes cost only an instruction or two per bit.
31 /* When debugging, extend minimal trust to callers and platform code.
32 * Also emit diagnostic messages that may help initial bringup, when
33 * board setup or driver bugs are most common.
35 * Otherwise, minimize overhead in what may be bitbanging codepaths.
38 #define extra_checks 1
40 #define extra_checks 0
43 /* gpio_lock prevents conflicts during gpio_desc[] table updates.
44 * While any GPIO is requested, its gpio_chip is not removable;
45 * each GPIO's "requested" flag serves as a lock and refcount.
47 DEFINE_SPINLOCK(gpio_lock);
49 static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];
51 #define GPIO_OFFSET_VALID(chip, offset) (offset >= 0 && offset < chip->ngpio)
53 static DEFINE_MUTEX(gpio_lookup_lock);
54 static LIST_HEAD(gpio_lookup_list);
55 LIST_HEAD(gpio_chips);
57 static inline void desc_set_label(struct gpio_desc *d, const char *label)
63 * Convert a GPIO number to its descriptor
65 struct gpio_desc *gpio_to_desc(unsigned gpio)
67 if (WARN(!gpio_is_valid(gpio), "invalid GPIO %d\n", gpio))
70 return &gpio_desc[gpio];
72 EXPORT_SYMBOL_GPL(gpio_to_desc);
75 * Get the GPIO descriptor corresponding to the given hw number for this chip.
77 struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
80 if (hwnum >= chip->ngpio)
81 return ERR_PTR(-EINVAL);
83 return &chip->desc[hwnum];
87 * Convert a GPIO descriptor to the integer namespace.
88 * This should disappear in the future but is needed since we still
89 * use GPIO numbers for error messages and sysfs nodes
91 int desc_to_gpio(const struct gpio_desc *desc)
93 return desc - &gpio_desc[0];
95 EXPORT_SYMBOL_GPL(desc_to_gpio);
99 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
100 * @desc: descriptor to return the chip of
102 struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
104 return desc ? desc->chip : NULL;
106 EXPORT_SYMBOL_GPL(gpiod_to_chip);
108 /* dynamic allocation of GPIOs, e.g. on a hotplugged device */
109 static int gpiochip_find_base(int ngpio)
111 struct gpio_chip *chip;
112 int base = ARCH_NR_GPIOS - ngpio;
114 list_for_each_entry_reverse(chip, &gpio_chips, list) {
115 /* found a free space? */
116 if (chip->base + chip->ngpio <= base)
119 /* nope, check the space right before the chip */
120 base = chip->base - ngpio;
123 if (gpio_is_valid(base)) {
124 pr_debug("%s: found new base at %d\n", __func__, base);
127 pr_err("%s: cannot find free range\n", __func__);
133 * gpiod_get_direction - return the current direction of a GPIO
134 * @desc: GPIO to get the direction of
136 * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error.
138 * This function may sleep if gpiod_cansleep() is true.
140 int gpiod_get_direction(const struct gpio_desc *desc)
142 struct gpio_chip *chip;
144 int status = -EINVAL;
146 chip = gpiod_to_chip(desc);
147 offset = gpio_chip_hwgpio(desc);
149 if (!chip->get_direction)
152 status = chip->get_direction(chip, offset);
154 /* GPIOF_DIR_IN, or other positive */
156 /* FLAG_IS_OUT is just a cache of the result of get_direction(),
157 * so it does not affect constness per se */
158 clear_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
162 set_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
166 EXPORT_SYMBOL_GPL(gpiod_get_direction);
169 * Add a new chip to the global chips list, keeping the list of chips sorted
172 * Return -EBUSY if the new chip overlaps with some other chip's integer
175 static int gpiochip_add_to_list(struct gpio_chip *chip)
177 struct list_head *pos = &gpio_chips;
178 struct gpio_chip *_chip;
181 /* find where to insert our chip */
182 list_for_each(pos, &gpio_chips) {
183 _chip = list_entry(pos, struct gpio_chip, list);
184 /* shall we insert before _chip? */
185 if (_chip->base >= chip->base + chip->ngpio)
189 /* are we stepping on the chip right before? */
190 if (pos != &gpio_chips && pos->prev != &gpio_chips) {
191 _chip = list_entry(pos->prev, struct gpio_chip, list);
192 if (_chip->base + _chip->ngpio > chip->base) {
194 "GPIO integer space overlap, cannot add chip\n");
200 list_add_tail(&chip->list, pos);
206 * gpiochip_add() - register a gpio_chip
207 * @chip: the chip to register, with chip->base initialized
208 * Context: potentially before irqs or kmalloc will work
210 * Returns a negative errno if the chip can't be registered, such as
211 * because the chip->base is invalid or already associated with a
212 * different chip. Otherwise it returns zero as a success code.
214 * When gpiochip_add() is called very early during boot, so that GPIOs
215 * can be freely used, the chip->dev device must be registered before
216 * the gpio framework's arch_initcall(). Otherwise sysfs initialization
217 * for GPIOs will fail rudely.
219 * If chip->base is negative, this requests dynamic assignment of
220 * a range of valid GPIOs.
222 int gpiochip_add(struct gpio_chip *chip)
227 int base = chip->base;
229 if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
235 spin_lock_irqsave(&gpio_lock, flags);
238 base = gpiochip_find_base(chip->ngpio);
246 status = gpiochip_add_to_list(chip);
249 chip->desc = &gpio_desc[chip->base];
251 for (id = 0; id < chip->ngpio; id++) {
252 struct gpio_desc *desc = &chip->desc[id];
255 /* REVISIT: most hardware initializes GPIOs as
256 * inputs (often with pullups enabled) so power
257 * usage is minimized. Linux code should set the
258 * gpio direction first thing; but until it does,
259 * and in case chip->get_direction is not set,
260 * we may expose the wrong direction in sysfs.
262 desc->flags = !chip->direction_input
268 spin_unlock_irqrestore(&gpio_lock, flags);
270 #ifdef CONFIG_PINCTRL
271 INIT_LIST_HEAD(&chip->pin_ranges);
274 of_gpiochip_add(chip);
275 acpi_gpiochip_add(chip);
280 status = gpiochip_export(chip);
284 pr_debug("%s: registered GPIOs %d to %d on device: %s\n", __func__,
285 chip->base, chip->base + chip->ngpio - 1,
286 chip->label ? : "generic");
291 spin_unlock_irqrestore(&gpio_lock, flags);
293 /* failures here can mean systems won't boot... */
294 pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
295 chip->base, chip->base + chip->ngpio - 1,
296 chip->label ? : "generic");
299 EXPORT_SYMBOL_GPL(gpiochip_add);
301 /* Forward-declaration */
302 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
305 * gpiochip_remove() - unregister a gpio_chip
306 * @chip: the chip to unregister
308 * A gpio_chip with any GPIOs still requested may not be removed.
310 int gpiochip_remove(struct gpio_chip *chip)
316 acpi_gpiochip_remove(chip);
318 spin_lock_irqsave(&gpio_lock, flags);
320 gpiochip_irqchip_remove(chip);
321 gpiochip_remove_pin_ranges(chip);
322 of_gpiochip_remove(chip);
324 for (id = 0; id < chip->ngpio; id++) {
325 if (test_bit(FLAG_REQUESTED, &chip->desc[id].flags)) {
331 for (id = 0; id < chip->ngpio; id++)
332 chip->desc[id].chip = NULL;
334 list_del(&chip->list);
337 spin_unlock_irqrestore(&gpio_lock, flags);
340 gpiochip_unexport(chip);
344 EXPORT_SYMBOL_GPL(gpiochip_remove);
347 * gpiochip_find() - iterator for locating a specific gpio_chip
348 * @data: data to pass to match function
349 * @callback: Callback function to check gpio_chip
351 * Similar to bus_find_device. It returns a reference to a gpio_chip as
352 * determined by a user supplied @match callback. The callback should return
353 * 0 if the device doesn't match and non-zero if it does. If the callback is
354 * non-zero, this function will return to the caller and not iterate over any
357 struct gpio_chip *gpiochip_find(void *data,
358 int (*match)(struct gpio_chip *chip,
361 struct gpio_chip *chip;
364 spin_lock_irqsave(&gpio_lock, flags);
365 list_for_each_entry(chip, &gpio_chips, list)
366 if (match(chip, data))
370 if (&chip->list == &gpio_chips)
372 spin_unlock_irqrestore(&gpio_lock, flags);
376 EXPORT_SYMBOL_GPL(gpiochip_find);
378 static int gpiochip_match_name(struct gpio_chip *chip, void *data)
380 const char *name = data;
382 return !strcmp(chip->label, name);
385 static struct gpio_chip *find_chip_by_name(const char *name)
387 return gpiochip_find((void *)name, gpiochip_match_name);
390 #ifdef CONFIG_GPIOLIB_IRQCHIP
393 * The following is irqchip helper code for gpiochips.
397 * gpiochip_add_chained_irqchip() - adds a chained irqchip to a gpiochip
398 * @gpiochip: the gpiochip to add the irqchip to
399 * @irqchip: the irqchip to add to the gpiochip
400 * @parent_irq: the irq number corresponding to the parent IRQ for this
402 * @parent_handler: the parent interrupt handler for the accumulated IRQ
403 * coming out of the gpiochip
405 void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
406 struct irq_chip *irqchip,
408 irq_flow_handler_t parent_handler)
410 if (gpiochip->can_sleep) {
411 chip_err(gpiochip, "you cannot have chained interrupts on a chip that may sleep\n");
415 irq_set_chained_handler(parent_irq, parent_handler);
417 * The parent irqchip is already using the chip_data for this
418 * irqchip, so our callbacks simply use the handler_data.
420 irq_set_handler_data(parent_irq, gpiochip);
422 EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
425 * This lock class tells lockdep that GPIO irqs are in a different
426 * category than their parents, so it won't report false recursion.
428 static struct lock_class_key gpiochip_irq_lock_class;
431 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
432 * @d: the irqdomain used by this irqchip
433 * @irq: the global irq number used by this GPIO irqchip irq
434 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
436 * This function will set up the mapping for a certain IRQ line on a
437 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
438 * stored inside the gpiochip.
440 static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
441 irq_hw_number_t hwirq)
443 struct gpio_chip *chip = d->host_data;
445 irq_set_chip_data(irq, chip);
446 irq_set_lockdep_class(irq, &gpiochip_irq_lock_class);
447 irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
448 /* Chips that can sleep need nested thread handlers */
450 irq_set_nested_thread(irq, 1);
452 set_irq_flags(irq, IRQF_VALID);
454 irq_set_noprobe(irq);
457 * No set-up of the hardware will happen if IRQ_TYPE_NONE
458 * is passed as default type.
460 if (chip->irq_default_type != IRQ_TYPE_NONE)
461 irq_set_irq_type(irq, chip->irq_default_type);
466 static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
468 struct gpio_chip *chip = d->host_data;
471 set_irq_flags(irq, 0);
474 irq_set_nested_thread(irq, 0);
475 irq_set_chip_and_handler(irq, NULL, NULL);
476 irq_set_chip_data(irq, NULL);
479 static const struct irq_domain_ops gpiochip_domain_ops = {
480 .map = gpiochip_irq_map,
481 .unmap = gpiochip_irq_unmap,
482 /* Virtually all GPIO irqchips are twocell:ed */
483 .xlate = irq_domain_xlate_twocell,
486 static int gpiochip_irq_reqres(struct irq_data *d)
488 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
490 if (gpio_lock_as_irq(chip, d->hwirq)) {
492 "unable to lock HW IRQ %lu for IRQ\n",
499 static void gpiochip_irq_relres(struct irq_data *d)
501 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
503 gpio_unlock_as_irq(chip, d->hwirq);
506 static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
508 return irq_find_mapping(chip->irqdomain, offset);
512 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
513 * @gpiochip: the gpiochip to remove the irqchip from
515 * This is called only from gpiochip_remove()
517 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
521 /* Remove all IRQ mappings and delete the domain */
522 if (gpiochip->irqdomain) {
523 for (offset = 0; offset < gpiochip->ngpio; offset++)
524 irq_dispose_mapping(gpiochip->irq_base + offset);
525 irq_domain_remove(gpiochip->irqdomain);
528 if (gpiochip->irqchip) {
529 gpiochip->irqchip->irq_request_resources = NULL;
530 gpiochip->irqchip->irq_release_resources = NULL;
531 gpiochip->irqchip = NULL;
536 * gpiochip_irqchip_add() - adds an irqchip to a gpiochip
537 * @gpiochip: the gpiochip to add the irqchip to
538 * @irqchip: the irqchip to add to the gpiochip
539 * @first_irq: if not dynamically assigned, the base (first) IRQ to
540 * allocate gpiochip irqs from
541 * @handler: the irq handler to use (often a predefined irq core function)
542 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
543 * to have the core avoid setting up any default type in the hardware.
545 * This function closely associates a certain irqchip with a certain
546 * gpiochip, providing an irq domain to translate the local IRQs to
547 * global irqs in the gpiolib core, and making sure that the gpiochip
548 * is passed as chip data to all related functions. Driver callbacks
549 * need to use container_of() to get their local state containers back
550 * from the gpiochip passed as chip data. An irqdomain will be stored
551 * in the gpiochip that shall be used by the driver to handle IRQ number
552 * translation. The gpiochip will need to be initialized and registered
553 * before calling this function.
555 * This function will handle two cell:ed simple IRQs and assumes all
556 * the pins on the gpiochip can generate a unique IRQ. Everything else
557 * need to be open coded.
559 int gpiochip_irqchip_add(struct gpio_chip *gpiochip,
560 struct irq_chip *irqchip,
561 unsigned int first_irq,
562 irq_flow_handler_t handler,
565 struct device_node *of_node;
567 unsigned irq_base = 0;
569 if (!gpiochip || !irqchip)
572 if (!gpiochip->dev) {
573 pr_err("missing gpiochip .dev parent pointer\n");
576 of_node = gpiochip->dev->of_node;
577 #ifdef CONFIG_OF_GPIO
579 * If the gpiochip has an assigned OF node this takes precendence
580 * FIXME: get rid of this and use gpiochip->dev->of_node everywhere
582 if (gpiochip->of_node)
583 of_node = gpiochip->of_node;
585 gpiochip->irqchip = irqchip;
586 gpiochip->irq_handler = handler;
587 gpiochip->irq_default_type = type;
588 gpiochip->to_irq = gpiochip_to_irq;
589 gpiochip->irqdomain = irq_domain_add_simple(of_node,
590 gpiochip->ngpio, first_irq,
591 &gpiochip_domain_ops, gpiochip);
592 if (!gpiochip->irqdomain) {
593 gpiochip->irqchip = NULL;
596 irqchip->irq_request_resources = gpiochip_irq_reqres;
597 irqchip->irq_release_resources = gpiochip_irq_relres;
600 * Prepare the mapping since the irqchip shall be orthogonal to
601 * any gpiochip calls. If the first_irq was zero, this is
602 * necessary to allocate descriptors for all IRQs.
604 for (offset = 0; offset < gpiochip->ngpio; offset++) {
605 irq_base = irq_create_mapping(gpiochip->irqdomain, offset);
608 * Store the base into the gpiochip to be used when
609 * unmapping the irqs.
611 gpiochip->irq_base = irq_base;
616 EXPORT_SYMBOL_GPL(gpiochip_irqchip_add);
618 #else /* CONFIG_GPIOLIB_IRQCHIP */
620 static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
622 #endif /* CONFIG_GPIOLIB_IRQCHIP */
624 #ifdef CONFIG_PINCTRL
627 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
628 * @chip: the gpiochip to add the range for
629 * @pinctrl: the dev_name() of the pin controller to map to
630 * @gpio_offset: the start offset in the current gpio_chip number space
631 * @pin_group: name of the pin group inside the pin controller
633 int gpiochip_add_pingroup_range(struct gpio_chip *chip,
634 struct pinctrl_dev *pctldev,
635 unsigned int gpio_offset, const char *pin_group)
637 struct gpio_pin_range *pin_range;
640 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
642 chip_err(chip, "failed to allocate pin ranges\n");
646 /* Use local offset as range ID */
647 pin_range->range.id = gpio_offset;
648 pin_range->range.gc = chip;
649 pin_range->range.name = chip->label;
650 pin_range->range.base = chip->base + gpio_offset;
651 pin_range->pctldev = pctldev;
653 ret = pinctrl_get_group_pins(pctldev, pin_group,
654 &pin_range->range.pins,
655 &pin_range->range.npins);
661 pinctrl_add_gpio_range(pctldev, &pin_range->range);
663 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
664 gpio_offset, gpio_offset + pin_range->range.npins - 1,
665 pinctrl_dev_get_devname(pctldev), pin_group);
667 list_add_tail(&pin_range->node, &chip->pin_ranges);
671 EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
674 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
675 * @chip: the gpiochip to add the range for
676 * @pinctrl_name: the dev_name() of the pin controller to map to
677 * @gpio_offset: the start offset in the current gpio_chip number space
678 * @pin_offset: the start offset in the pin controller number space
679 * @npins: the number of pins from the offset of each pin space (GPIO and
680 * pin controller) to accumulate in this range
682 int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
683 unsigned int gpio_offset, unsigned int pin_offset,
686 struct gpio_pin_range *pin_range;
689 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
691 chip_err(chip, "failed to allocate pin ranges\n");
695 /* Use local offset as range ID */
696 pin_range->range.id = gpio_offset;
697 pin_range->range.gc = chip;
698 pin_range->range.name = chip->label;
699 pin_range->range.base = chip->base + gpio_offset;
700 pin_range->range.pin_base = pin_offset;
701 pin_range->range.npins = npins;
702 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
704 if (IS_ERR(pin_range->pctldev)) {
705 ret = PTR_ERR(pin_range->pctldev);
706 chip_err(chip, "could not create pin range\n");
710 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
711 gpio_offset, gpio_offset + npins - 1,
713 pin_offset, pin_offset + npins - 1);
715 list_add_tail(&pin_range->node, &chip->pin_ranges);
719 EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
722 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
723 * @chip: the chip to remove all the mappings for
725 void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
727 struct gpio_pin_range *pin_range, *tmp;
729 list_for_each_entry_safe(pin_range, tmp, &chip->pin_ranges, node) {
730 list_del(&pin_range->node);
731 pinctrl_remove_gpio_range(pin_range->pctldev,
736 EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
738 #endif /* CONFIG_PINCTRL */
740 /* These "optional" allocation calls help prevent drivers from stomping
741 * on each other, and help provide better diagnostics in debugfs.
742 * They're called even less than the "set direction" calls.
744 static int __gpiod_request(struct gpio_desc *desc, const char *label)
746 struct gpio_chip *chip = desc->chip;
750 spin_lock_irqsave(&gpio_lock, flags);
752 /* NOTE: gpio_request() can be called in early boot,
753 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
756 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
757 desc_set_label(desc, label ? : "?");
765 /* chip->request may sleep */
766 spin_unlock_irqrestore(&gpio_lock, flags);
767 status = chip->request(chip, gpio_chip_hwgpio(desc));
768 spin_lock_irqsave(&gpio_lock, flags);
771 desc_set_label(desc, NULL);
772 clear_bit(FLAG_REQUESTED, &desc->flags);
776 if (chip->get_direction) {
777 /* chip->get_direction may sleep */
778 spin_unlock_irqrestore(&gpio_lock, flags);
779 gpiod_get_direction(desc);
780 spin_lock_irqsave(&gpio_lock, flags);
783 spin_unlock_irqrestore(&gpio_lock, flags);
787 int gpiod_request(struct gpio_desc *desc, const char *label)
789 int status = -EPROBE_DEFER;
790 struct gpio_chip *chip;
793 pr_warn("%s: invalid GPIO\n", __func__);
801 if (try_module_get(chip->owner)) {
802 status = __gpiod_request(desc, label);
804 module_put(chip->owner);
809 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
814 static bool __gpiod_free(struct gpio_desc *desc)
818 struct gpio_chip *chip;
822 gpiod_unexport(desc);
824 spin_lock_irqsave(&gpio_lock, flags);
827 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
829 spin_unlock_irqrestore(&gpio_lock, flags);
830 might_sleep_if(chip->can_sleep);
831 chip->free(chip, gpio_chip_hwgpio(desc));
832 spin_lock_irqsave(&gpio_lock, flags);
834 desc_set_label(desc, NULL);
835 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
836 clear_bit(FLAG_REQUESTED, &desc->flags);
837 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
838 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
842 spin_unlock_irqrestore(&gpio_lock, flags);
846 void gpiod_free(struct gpio_desc *desc)
848 if (desc && __gpiod_free(desc))
849 module_put(desc->chip->owner);
851 WARN_ON(extra_checks);
855 * gpiochip_is_requested - return string iff signal was requested
856 * @chip: controller managing the signal
857 * @offset: of signal within controller's 0..(ngpio - 1) range
859 * Returns NULL if the GPIO is not currently requested, else a string.
860 * The string returned is the label passed to gpio_request(); if none has been
861 * passed it is a meaningless, non-NULL constant.
863 * This function is for use by GPIO controller drivers. The label can
864 * help with diagnostics, and knowing that the signal is used as a GPIO
865 * can help avoid accidentally multiplexing it to another controller.
867 const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
869 struct gpio_desc *desc;
871 if (!GPIO_OFFSET_VALID(chip, offset))
874 desc = &chip->desc[offset];
876 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
880 EXPORT_SYMBOL_GPL(gpiochip_is_requested);
883 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
884 * @desc: GPIO descriptor to request
885 * @label: label for the GPIO
887 * Function allows GPIO chip drivers to request and use their own GPIO
888 * descriptors via gpiolib API. Difference to gpiod_request() is that this
889 * function will not increase reference count of the GPIO chip module. This
890 * allows the GPIO chip module to be unloaded as needed (we assume that the
891 * GPIO chip driver handles freeing the GPIOs it has requested).
893 int gpiochip_request_own_desc(struct gpio_desc *desc, const char *label)
895 if (!desc || !desc->chip)
898 return __gpiod_request(desc, label);
900 EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
903 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
904 * @desc: GPIO descriptor to free
906 * Function frees the given GPIO requested previously with
907 * gpiochip_request_own_desc().
909 void gpiochip_free_own_desc(struct gpio_desc *desc)
914 EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
916 /* Drivers MUST set GPIO direction before making get/set calls. In
917 * some cases this is done in early boot, before IRQs are enabled.
919 * As a rule these aren't called more than once (except for drivers
920 * using the open-drain emulation idiom) so these are natural places
921 * to accumulate extra debugging checks. Note that we can't (yet)
922 * rely on gpio_request() having been called beforehand.
926 * gpiod_direction_input - set the GPIO direction to input
927 * @desc: GPIO to set to input
929 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
930 * be called safely on it.
932 * Return 0 in case of success, else an error code.
934 int gpiod_direction_input(struct gpio_desc *desc)
936 struct gpio_chip *chip;
937 int status = -EINVAL;
939 if (!desc || !desc->chip) {
940 pr_warn("%s: invalid GPIO\n", __func__);
945 if (!chip->get || !chip->direction_input) {
947 "%s: missing get() or direction_input() operations\n",
952 status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
954 clear_bit(FLAG_IS_OUT, &desc->flags);
956 trace_gpio_direction(desc_to_gpio(desc), 1, status);
960 EXPORT_SYMBOL_GPL(gpiod_direction_input);
962 static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
964 struct gpio_chip *chip;
965 int status = -EINVAL;
967 /* GPIOs used for IRQs shall not be set as output */
968 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
970 "%s: tried to set a GPIO tied to an IRQ as output\n",
975 /* Open drain pin should not be driven to 1 */
976 if (value && test_bit(FLAG_OPEN_DRAIN, &desc->flags))
977 return gpiod_direction_input(desc);
979 /* Open source pin should not be driven to 0 */
980 if (!value && test_bit(FLAG_OPEN_SOURCE, &desc->flags))
981 return gpiod_direction_input(desc);
984 if (!chip->set || !chip->direction_output) {
986 "%s: missing set() or direction_output() operations\n",
991 status = chip->direction_output(chip, gpio_chip_hwgpio(desc), value);
993 set_bit(FLAG_IS_OUT, &desc->flags);
994 trace_gpio_value(desc_to_gpio(desc), 0, value);
995 trace_gpio_direction(desc_to_gpio(desc), 0, status);
1000 * gpiod_direction_output_raw - set the GPIO direction to output
1001 * @desc: GPIO to set to output
1002 * @value: initial output value of the GPIO
1004 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
1005 * be called safely on it. The initial value of the output must be specified
1006 * as raw value on the physical line without regard for the ACTIVE_LOW status.
1008 * Return 0 in case of success, else an error code.
1010 int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
1012 if (!desc || !desc->chip) {
1013 pr_warn("%s: invalid GPIO\n", __func__);
1016 return _gpiod_direction_output_raw(desc, value);
1018 EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
1021 * gpiod_direction_output - set the GPIO direction to output
1022 * @desc: GPIO to set to output
1023 * @value: initial output value of the GPIO
1025 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
1026 * be called safely on it. The initial value of the output must be specified
1027 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
1030 * Return 0 in case of success, else an error code.
1032 int gpiod_direction_output(struct gpio_desc *desc, int value)
1034 if (!desc || !desc->chip) {
1035 pr_warn("%s: invalid GPIO\n", __func__);
1038 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1040 return _gpiod_direction_output_raw(desc, value);
1042 EXPORT_SYMBOL_GPL(gpiod_direction_output);
1045 * gpiod_set_debounce - sets @debounce time for a @gpio
1046 * @gpio: the gpio to set debounce time
1047 * @debounce: debounce time is microseconds
1049 * returns -ENOTSUPP if the controller does not support setting
1052 int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
1054 struct gpio_chip *chip;
1056 if (!desc || !desc->chip) {
1057 pr_warn("%s: invalid GPIO\n", __func__);
1062 if (!chip->set || !chip->set_debounce) {
1064 "%s: missing set() or set_debounce() operations\n",
1069 return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce);
1071 EXPORT_SYMBOL_GPL(gpiod_set_debounce);
1074 * gpiod_is_active_low - test whether a GPIO is active-low or not
1075 * @desc: the gpio descriptor to test
1077 * Returns 1 if the GPIO is active-low, 0 otherwise.
1079 int gpiod_is_active_low(const struct gpio_desc *desc)
1081 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
1083 EXPORT_SYMBOL_GPL(gpiod_is_active_low);
1085 /* I/O calls are only valid after configuration completed; the relevant
1086 * "is this a valid GPIO" error checks should already have been done.
1088 * "Get" operations are often inlinable as reading a pin value register,
1089 * and masking the relevant bit in that register.
1091 * When "set" operations are inlinable, they involve writing that mask to
1092 * one register to set a low value, or a different register to set it high.
1093 * Otherwise locking is needed, so there may be little value to inlining.
1095 *------------------------------------------------------------------------
1097 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
1098 * have requested the GPIO. That can include implicit requesting by
1099 * a direction setting call. Marking a gpio as requested locks its chip
1100 * in memory, guaranteeing that these table lookups need no more locking
1101 * and that gpiochip_remove() will fail.
1103 * REVISIT when debugging, consider adding some instrumentation to ensure
1104 * that the GPIO was actually requested.
1107 static bool _gpiod_get_raw_value(const struct gpio_desc *desc)
1109 struct gpio_chip *chip;
1114 offset = gpio_chip_hwgpio(desc);
1115 value = chip->get ? chip->get(chip, offset) : false;
1116 trace_gpio_value(desc_to_gpio(desc), 1, value);
1121 * gpiod_get_raw_value() - return a gpio's raw value
1122 * @desc: gpio whose value will be returned
1124 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
1125 * its ACTIVE_LOW status.
1127 * This function should be called from contexts where we cannot sleep, and will
1128 * complain if the GPIO chip functions potentially sleep.
1130 int gpiod_get_raw_value(const struct gpio_desc *desc)
1134 /* Should be using gpio_get_value_cansleep() */
1135 WARN_ON(desc->chip->can_sleep);
1136 return _gpiod_get_raw_value(desc);
1138 EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
1141 * gpiod_get_value() - return a gpio's value
1142 * @desc: gpio whose value will be returned
1144 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
1147 * This function should be called from contexts where we cannot sleep, and will
1148 * complain if the GPIO chip functions potentially sleep.
1150 int gpiod_get_value(const struct gpio_desc *desc)
1155 /* Should be using gpio_get_value_cansleep() */
1156 WARN_ON(desc->chip->can_sleep);
1158 value = _gpiod_get_raw_value(desc);
1159 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1164 EXPORT_SYMBOL_GPL(gpiod_get_value);
1167 * _gpio_set_open_drain_value() - Set the open drain gpio's value.
1168 * @desc: gpio descriptor whose state need to be set.
1169 * @value: Non-zero for setting it HIGH otherise it will set to LOW.
1171 static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
1174 struct gpio_chip *chip = desc->chip;
1175 int offset = gpio_chip_hwgpio(desc);
1178 err = chip->direction_input(chip, offset);
1180 clear_bit(FLAG_IS_OUT, &desc->flags);
1182 err = chip->direction_output(chip, offset, 0);
1184 set_bit(FLAG_IS_OUT, &desc->flags);
1186 trace_gpio_direction(desc_to_gpio(desc), value, err);
1189 "%s: Error in set_value for open drain err %d\n",
1194 * _gpio_set_open_source_value() - Set the open source gpio's value.
1195 * @desc: gpio descriptor whose state need to be set.
1196 * @value: Non-zero for setting it HIGH otherise it will set to LOW.
1198 static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
1201 struct gpio_chip *chip = desc->chip;
1202 int offset = gpio_chip_hwgpio(desc);
1205 err = chip->direction_output(chip, offset, 1);
1207 set_bit(FLAG_IS_OUT, &desc->flags);
1209 err = chip->direction_input(chip, offset);
1211 clear_bit(FLAG_IS_OUT, &desc->flags);
1213 trace_gpio_direction(desc_to_gpio(desc), !value, err);
1216 "%s: Error in set_value for open source err %d\n",
1220 static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
1222 struct gpio_chip *chip;
1225 trace_gpio_value(desc_to_gpio(desc), 0, value);
1226 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
1227 _gpio_set_open_drain_value(desc, value);
1228 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
1229 _gpio_set_open_source_value(desc, value);
1231 chip->set(chip, gpio_chip_hwgpio(desc), value);
1235 * gpiod_set_raw_value() - assign a gpio's raw value
1236 * @desc: gpio whose value will be assigned
1237 * @value: value to assign
1239 * Set the raw value of the GPIO, i.e. the value of its physical line without
1240 * regard for its ACTIVE_LOW status.
1242 * This function should be called from contexts where we cannot sleep, and will
1243 * complain if the GPIO chip functions potentially sleep.
1245 void gpiod_set_raw_value(struct gpio_desc *desc, int value)
1249 /* Should be using gpio_set_value_cansleep() */
1250 WARN_ON(desc->chip->can_sleep);
1251 _gpiod_set_raw_value(desc, value);
1253 EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
1256 * gpiod_set_value() - assign a gpio's value
1257 * @desc: gpio whose value will be assigned
1258 * @value: value to assign
1260 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
1263 * This function should be called from contexts where we cannot sleep, and will
1264 * complain if the GPIO chip functions potentially sleep.
1266 void gpiod_set_value(struct gpio_desc *desc, int value)
1270 /* Should be using gpio_set_value_cansleep() */
1271 WARN_ON(desc->chip->can_sleep);
1272 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1274 _gpiod_set_raw_value(desc, value);
1276 EXPORT_SYMBOL_GPL(gpiod_set_value);
1279 * gpiod_cansleep() - report whether gpio value access may sleep
1280 * @desc: gpio to check
1283 int gpiod_cansleep(const struct gpio_desc *desc)
1287 return desc->chip->can_sleep;
1289 EXPORT_SYMBOL_GPL(gpiod_cansleep);
1292 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
1293 * @desc: gpio whose IRQ will be returned (already requested)
1295 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
1298 int gpiod_to_irq(const struct gpio_desc *desc)
1300 struct gpio_chip *chip;
1306 offset = gpio_chip_hwgpio(desc);
1307 return chip->to_irq ? chip->to_irq(chip, offset) : -ENXIO;
1309 EXPORT_SYMBOL_GPL(gpiod_to_irq);
1312 * gpio_lock_as_irq() - lock a GPIO to be used as IRQ
1313 * @chip: the chip the GPIO to lock belongs to
1314 * @offset: the offset of the GPIO to lock as IRQ
1316 * This is used directly by GPIO drivers that want to lock down
1317 * a certain GPIO line to be used for IRQs.
1319 int gpio_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
1321 if (offset >= chip->ngpio)
1324 if (test_bit(FLAG_IS_OUT, &chip->desc[offset].flags)) {
1326 "%s: tried to flag a GPIO set as output for IRQ\n",
1331 set_bit(FLAG_USED_AS_IRQ, &chip->desc[offset].flags);
1334 EXPORT_SYMBOL_GPL(gpio_lock_as_irq);
1337 * gpio_unlock_as_irq() - unlock a GPIO used as IRQ
1338 * @chip: the chip the GPIO to lock belongs to
1339 * @offset: the offset of the GPIO to lock as IRQ
1341 * This is used directly by GPIO drivers that want to indicate
1342 * that a certain GPIO is no longer used exclusively for IRQ.
1344 void gpio_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
1346 if (offset >= chip->ngpio)
1349 clear_bit(FLAG_USED_AS_IRQ, &chip->desc[offset].flags);
1351 EXPORT_SYMBOL_GPL(gpio_unlock_as_irq);
1354 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
1355 * @desc: gpio whose value will be returned
1357 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
1358 * its ACTIVE_LOW status.
1360 * This function is to be called from contexts that can sleep.
1362 int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
1364 might_sleep_if(extra_checks);
1367 return _gpiod_get_raw_value(desc);
1369 EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
1372 * gpiod_get_value_cansleep() - return a gpio's value
1373 * @desc: gpio whose value will be returned
1375 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
1378 * This function is to be called from contexts that can sleep.
1380 int gpiod_get_value_cansleep(const struct gpio_desc *desc)
1384 might_sleep_if(extra_checks);
1388 value = _gpiod_get_raw_value(desc);
1389 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1394 EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
1397 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
1398 * @desc: gpio whose value will be assigned
1399 * @value: value to assign
1401 * Set the raw value of the GPIO, i.e. the value of its physical line without
1402 * regard for its ACTIVE_LOW status.
1404 * This function is to be called from contexts that can sleep.
1406 void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
1408 might_sleep_if(extra_checks);
1411 _gpiod_set_raw_value(desc, value);
1413 EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
1416 * gpiod_set_value_cansleep() - assign a gpio's value
1417 * @desc: gpio whose value will be assigned
1418 * @value: value to assign
1420 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
1423 * This function is to be called from contexts that can sleep.
1425 void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
1427 might_sleep_if(extra_checks);
1431 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
1433 _gpiod_set_raw_value(desc, value);
1435 EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
1438 * gpiod_add_lookup_table() - register GPIO device consumers
1439 * @table: table of consumers to register
1441 void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
1443 mutex_lock(&gpio_lookup_lock);
1445 list_add_tail(&table->list, &gpio_lookup_list);
1447 mutex_unlock(&gpio_lookup_lock);
1450 static struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
1452 enum gpio_lookup_flags *flags)
1454 static const char *suffixes[] = { "gpios", "gpio" };
1455 char prop_name[32]; /* 32 is max size of property name */
1456 enum of_gpio_flags of_flags;
1457 struct gpio_desc *desc;
1460 for (i = 0; i < ARRAY_SIZE(suffixes); i++) {
1462 snprintf(prop_name, 32, "%s-%s", con_id, suffixes[i]);
1464 snprintf(prop_name, 32, "%s", suffixes[i]);
1466 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
1468 if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER))
1475 if (of_flags & OF_GPIO_ACTIVE_LOW)
1476 *flags |= GPIO_ACTIVE_LOW;
1481 static struct gpio_desc *acpi_find_gpio(struct device *dev, const char *con_id,
1483 enum gpio_lookup_flags *flags)
1485 struct acpi_gpio_info info;
1486 struct gpio_desc *desc;
1488 desc = acpi_get_gpiod_by_index(dev, idx, &info);
1492 if (info.gpioint && info.active_low)
1493 *flags |= GPIO_ACTIVE_LOW;
1498 static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
1500 const char *dev_id = dev ? dev_name(dev) : NULL;
1501 struct gpiod_lookup_table *table;
1503 mutex_lock(&gpio_lookup_lock);
1505 list_for_each_entry(table, &gpio_lookup_list, list) {
1506 if (table->dev_id && dev_id) {
1508 * Valid strings on both ends, must be identical to have
1511 if (!strcmp(table->dev_id, dev_id))
1515 * One of the pointers is NULL, so both must be to have
1518 if (dev_id == table->dev_id)
1525 mutex_unlock(&gpio_lookup_lock);
1529 static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
1531 enum gpio_lookup_flags *flags)
1533 struct gpio_desc *desc = ERR_PTR(-ENOENT);
1534 struct gpiod_lookup_table *table;
1535 struct gpiod_lookup *p;
1537 table = gpiod_find_lookup_table(dev);
1541 for (p = &table->table[0]; p->chip_label; p++) {
1542 struct gpio_chip *chip;
1544 /* idx must always match exactly */
1548 /* If the lookup entry has a con_id, require exact match */
1549 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
1552 chip = find_chip_by_name(p->chip_label);
1555 dev_err(dev, "cannot find GPIO chip %s\n",
1557 return ERR_PTR(-ENODEV);
1560 if (chip->ngpio <= p->chip_hwnum) {
1562 "requested GPIO %d is out of range [0..%d] for chip %s\n",
1563 idx, chip->ngpio, chip->label);
1564 return ERR_PTR(-EINVAL);
1567 desc = gpiochip_get_desc(chip, p->chip_hwnum);
1577 * gpiod_get - obtain a GPIO for a given GPIO function
1578 * @dev: GPIO consumer, can be NULL for system-global GPIOs
1579 * @con_id: function within the GPIO consumer
1581 * Return the GPIO descriptor corresponding to the function con_id of device
1582 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
1583 * another IS_ERR() code if an error occured while trying to acquire the GPIO.
1585 struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id)
1587 return gpiod_get_index(dev, con_id, 0);
1589 EXPORT_SYMBOL_GPL(gpiod_get);
1592 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
1593 * @dev: GPIO consumer, can be NULL for system-global GPIOs
1594 * @con_id: function within the GPIO consumer
1596 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
1597 * the requested function it will return NULL. This is convenient for drivers
1598 * that need to handle optional GPIOs.
1600 struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
1603 return gpiod_get_index_optional(dev, con_id, 0);
1605 EXPORT_SYMBOL_GPL(gpiod_get_optional);
1608 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
1609 * @dev: GPIO consumer, can be NULL for system-global GPIOs
1610 * @con_id: function within the GPIO consumer
1611 * @idx: index of the GPIO to obtain in the consumer
1613 * This variant of gpiod_get() allows to access GPIOs other than the first
1614 * defined one for functions that define several GPIOs.
1616 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
1617 * requested function and/or index, or another IS_ERR() code if an error
1618 * occured while trying to acquire the GPIO.
1620 struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
1624 struct gpio_desc *desc = NULL;
1626 enum gpio_lookup_flags flags = 0;
1628 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
1630 /* Using device tree? */
1631 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node) {
1632 dev_dbg(dev, "using device tree for GPIO lookup\n");
1633 desc = of_find_gpio(dev, con_id, idx, &flags);
1634 } else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev)) {
1635 dev_dbg(dev, "using ACPI for GPIO lookup\n");
1636 desc = acpi_find_gpio(dev, con_id, idx, &flags);
1640 * Either we are not using DT or ACPI, or their lookup did not return
1641 * a result. In that case, use platform lookup as a fallback.
1643 if (!desc || desc == ERR_PTR(-ENOENT)) {
1644 dev_dbg(dev, "using lookup tables for GPIO lookup");
1645 desc = gpiod_find(dev, con_id, idx, &flags);
1649 dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
1653 status = gpiod_request(desc, con_id);
1656 return ERR_PTR(status);
1658 if (flags & GPIO_ACTIVE_LOW)
1659 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
1660 if (flags & GPIO_OPEN_DRAIN)
1661 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
1662 if (flags & GPIO_OPEN_SOURCE)
1663 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
1667 EXPORT_SYMBOL_GPL(gpiod_get_index);
1670 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
1672 * @dev: GPIO consumer, can be NULL for system-global GPIOs
1673 * @con_id: function within the GPIO consumer
1674 * @index: index of the GPIO to obtain in the consumer
1676 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
1677 * specified index was assigned to the requested function it will return NULL.
1678 * This is convenient for drivers that need to handle optional GPIOs.
1680 struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
1684 struct gpio_desc *desc;
1686 desc = gpiod_get_index(dev, con_id, index);
1688 if (PTR_ERR(desc) == -ENOENT)
1694 EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
1697 * gpiod_put - dispose of a GPIO descriptor
1698 * @desc: GPIO descriptor to dispose of
1700 * No descriptor can be used after gpiod_put() has been called on it.
1702 void gpiod_put(struct gpio_desc *desc)
1706 EXPORT_SYMBOL_GPL(gpiod_put);
1708 #ifdef CONFIG_DEBUG_FS
1710 static void gpiolib_dbg_show(struct seq_file *s, struct gpio_chip *chip)
1713 unsigned gpio = chip->base;
1714 struct gpio_desc *gdesc = &chip->desc[0];
1718 for (i = 0; i < chip->ngpio; i++, gpio++, gdesc++) {
1719 if (!test_bit(FLAG_REQUESTED, &gdesc->flags))
1722 gpiod_get_direction(gdesc);
1723 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
1724 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
1725 seq_printf(s, " gpio-%-3d (%-20.20s) %s %s %s",
1727 is_out ? "out" : "in ",
1729 ? (chip->get(chip, i) ? "hi" : "lo")
1731 is_irq ? "IRQ" : " ");
1732 seq_printf(s, "\n");
1736 static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
1738 unsigned long flags;
1739 struct gpio_chip *chip = NULL;
1740 loff_t index = *pos;
1744 spin_lock_irqsave(&gpio_lock, flags);
1745 list_for_each_entry(chip, &gpio_chips, list)
1747 spin_unlock_irqrestore(&gpio_lock, flags);
1750 spin_unlock_irqrestore(&gpio_lock, flags);
1755 static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
1757 unsigned long flags;
1758 struct gpio_chip *chip = v;
1761 spin_lock_irqsave(&gpio_lock, flags);
1762 if (list_is_last(&chip->list, &gpio_chips))
1765 ret = list_entry(chip->list.next, struct gpio_chip, list);
1766 spin_unlock_irqrestore(&gpio_lock, flags);
1774 static void gpiolib_seq_stop(struct seq_file *s, void *v)
1778 static int gpiolib_seq_show(struct seq_file *s, void *v)
1780 struct gpio_chip *chip = v;
1783 seq_printf(s, "%sGPIOs %d-%d", (char *)s->private,
1784 chip->base, chip->base + chip->ngpio - 1);
1787 seq_printf(s, ", %s/%s", dev->bus ? dev->bus->name : "no-bus",
1790 seq_printf(s, ", %s", chip->label);
1791 if (chip->can_sleep)
1792 seq_printf(s, ", can sleep");
1793 seq_printf(s, ":\n");
1796 chip->dbg_show(s, chip);
1798 gpiolib_dbg_show(s, chip);
1803 static const struct seq_operations gpiolib_seq_ops = {
1804 .start = gpiolib_seq_start,
1805 .next = gpiolib_seq_next,
1806 .stop = gpiolib_seq_stop,
1807 .show = gpiolib_seq_show,
1810 static int gpiolib_open(struct inode *inode, struct file *file)
1812 return seq_open(file, &gpiolib_seq_ops);
1815 static const struct file_operations gpiolib_operations = {
1816 .owner = THIS_MODULE,
1817 .open = gpiolib_open,
1819 .llseek = seq_lseek,
1820 .release = seq_release,
1823 static int __init gpiolib_debugfs_init(void)
1825 /* /sys/kernel/debug/gpio */
1826 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
1827 NULL, NULL, &gpiolib_operations);
1830 subsys_initcall(gpiolib_debugfs_init);
1832 #endif /* DEBUG_FS */