1 // SPDX-License-Identifier: GPL-2.0+
3 * OF helpers for the GPIO API
5 * Copyright (c) 2007-2008 MontaVista Software, Inc.
7 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
15 #include <linux/gpio/consumer.h>
17 #include <linux/of_address.h>
18 #include <linux/of_gpio.h>
19 #include <linux/pinctrl/pinctrl.h>
20 #include <linux/slab.h>
21 #include <linux/gpio/machine.h>
24 #include "gpiolib-of.h"
27 * of_gpio_spi_cs_get_count() - special GPIO counting for SPI
28 * Some elder GPIO controllers need special quirks. Currently we handle
29 * the Freescale GPIO controller with bindings that doesn't use the
30 * established "cs-gpios" for chip selects but instead rely on
31 * "gpios" for the chip select lines. If we detect this, we redirect
32 * the counting of "cs-gpios" to count "gpios" transparent to the
35 static int of_gpio_spi_cs_get_count(struct device *dev, const char *con_id)
37 struct device_node *np = dev->of_node;
39 if (!IS_ENABLED(CONFIG_SPI_MASTER))
41 if (!con_id || strcmp(con_id, "cs"))
43 if (!of_device_is_compatible(np, "fsl,spi") &&
44 !of_device_is_compatible(np, "aeroflexgaisler,spictrl"))
46 return of_gpio_named_count(np, "gpios");
50 * This is used by external users of of_gpio_count() from <linux/of_gpio.h>
52 * FIXME: get rid of those external users by converting them to GPIO
53 * descriptors and let them all use gpiod_count()
55 int of_gpio_get_count(struct device *dev, const char *con_id)
61 ret = of_gpio_spi_cs_get_count(dev, con_id);
65 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
67 snprintf(propname, sizeof(propname), "%s-%s",
68 con_id, gpio_suffixes[i]);
70 snprintf(propname, sizeof(propname), "%s",
73 ret = of_gpio_named_count(dev->of_node, propname);
77 return ret ? ret : -ENOENT;
80 static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data)
82 struct of_phandle_args *gpiospec = data;
84 return chip->gpiodev->dev.of_node == gpiospec->np &&
86 chip->of_xlate(chip, gpiospec, NULL) >= 0;
89 static struct gpio_chip *of_find_gpiochip_by_xlate(
90 struct of_phandle_args *gpiospec)
92 return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate);
95 static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip,
96 struct of_phandle_args *gpiospec,
97 enum of_gpio_flags *flags)
101 if (chip->of_gpio_n_cells != gpiospec->args_count)
102 return ERR_PTR(-EINVAL);
104 ret = chip->of_xlate(chip, gpiospec, flags);
108 return gpiochip_get_desc(chip, ret);
112 * of_gpio_need_valid_mask() - figure out if the OF GPIO driver needs
113 * to set the .valid_mask
114 * @gc: the target gpio_chip
116 * Return: true if the valid mask needs to be set
118 bool of_gpio_need_valid_mask(const struct gpio_chip *gc)
121 struct device_node *np = gc->of_node;
123 size = of_property_count_u32_elems(np, "gpio-reserved-ranges");
124 if (size > 0 && size % 2 == 0)
129 static void of_gpio_flags_quirks(struct device_node *np,
130 const char *propname,
131 enum of_gpio_flags *flags,
135 * Some GPIO fixed regulator quirks.
136 * Note that active low is the default.
138 if (IS_ENABLED(CONFIG_REGULATOR) &&
139 (of_device_is_compatible(np, "regulator-fixed") ||
140 of_device_is_compatible(np, "reg-fixed-voltage") ||
141 (!(strcmp(propname, "enable-gpio") &&
142 strcmp(propname, "enable-gpios")) &&
143 of_device_is_compatible(np, "regulator-gpio")))) {
144 bool active_low = !of_property_read_bool(np,
145 "enable-active-high");
147 * The regulator GPIO handles are specified such that the
148 * presence or absence of "enable-active-high" solely controls
149 * the polarity of the GPIO line. Any phandle flags must
150 * be actively ignored.
152 if ((*flags & OF_GPIO_ACTIVE_LOW) && !active_low) {
153 pr_warn("%s GPIO handle specifies active low - ignored\n",
154 of_node_full_name(np));
155 *flags &= ~OF_GPIO_ACTIVE_LOW;
158 *flags |= OF_GPIO_ACTIVE_LOW;
161 * Legacy open drain handling for fixed voltage regulators.
163 if (IS_ENABLED(CONFIG_REGULATOR) &&
164 of_device_is_compatible(np, "reg-fixed-voltage") &&
165 of_property_read_bool(np, "gpio-open-drain")) {
166 *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN);
167 pr_info("%s uses legacy open drain flag - update the DTS if you can\n",
168 of_node_full_name(np));
172 * Legacy handling of SPI active high chip select. If we have a
173 * property named "cs-gpios" we need to inspect the child node
174 * to determine if the flags should have inverted semantics.
176 if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") &&
177 of_property_read_bool(np, "cs-gpios")) {
178 struct device_node *child;
182 for_each_child_of_node(np, child) {
183 ret = of_property_read_u32(child, "reg", &cs);
188 * SPI children have active low chip selects
189 * by default. This can be specified negatively
190 * by just omitting "spi-cs-high" in the
191 * device node, or actively by tagging on
192 * GPIO_ACTIVE_LOW as flag in the device
193 * tree. If the line is simultaneously
194 * tagged as active low in the device tree
195 * and has the "spi-cs-high" set, we get a
196 * conflict and the "spi-cs-high" flag will
199 if (of_property_read_bool(child, "spi-cs-high")) {
200 if (*flags & OF_GPIO_ACTIVE_LOW) {
201 pr_warn("%s GPIO handle specifies active low - ignored\n",
202 of_node_full_name(child));
203 *flags &= ~OF_GPIO_ACTIVE_LOW;
206 if (!(*flags & OF_GPIO_ACTIVE_LOW))
207 pr_info("%s enforce active low on chipselect handle\n",
208 of_node_full_name(child));
209 *flags |= OF_GPIO_ACTIVE_LOW;
217 /* Legacy handling of stmmac's active-low PHY reset line */
218 if (IS_ENABLED(CONFIG_STMMAC_ETH) &&
219 !strcmp(propname, "snps,reset-gpio") &&
220 of_property_read_bool(np, "snps,reset-active-low"))
221 *flags |= OF_GPIO_ACTIVE_LOW;
225 * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
226 * @np: device node to get GPIO from
227 * @propname: property name containing gpio specifier(s)
228 * @index: index of the GPIO
229 * @flags: a flags pointer to fill in
231 * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
232 * value on the error condition. If @flags is not NULL the function also fills
233 * in flags for the GPIO.
235 static struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
236 const char *propname, int index, enum of_gpio_flags *flags)
238 struct of_phandle_args gpiospec;
239 struct gpio_chip *chip;
240 struct gpio_desc *desc;
243 ret = of_parse_phandle_with_args_map(np, propname, "gpio", index,
246 pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n",
247 __func__, propname, np, index);
251 chip = of_find_gpiochip_by_xlate(&gpiospec);
253 desc = ERR_PTR(-EPROBE_DEFER);
257 desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags);
262 of_gpio_flags_quirks(np, propname, flags, index);
264 pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n",
265 __func__, propname, np, index,
266 PTR_ERR_OR_ZERO(desc));
269 of_node_put(gpiospec.np);
274 int of_get_named_gpio_flags(struct device_node *np, const char *list_name,
275 int index, enum of_gpio_flags *flags)
277 struct gpio_desc *desc;
279 desc = of_get_named_gpiod_flags(np, list_name, index, flags);
282 return PTR_ERR(desc);
284 return desc_to_gpio(desc);
286 EXPORT_SYMBOL_GPL(of_get_named_gpio_flags);
289 * gpiod_get_from_of_node() - obtain a GPIO from an OF node
290 * @node: handle of the OF node
291 * @propname: name of the DT property representing the GPIO
292 * @index: index of the GPIO to obtain for the consumer
293 * @dflags: GPIO initialization flags
294 * @label: label to attach to the requested GPIO
297 * On successful request the GPIO pin is configured in accordance with
300 * In case of error an ERR_PTR() is returned.
302 struct gpio_desc *gpiod_get_from_of_node(struct device_node *node,
303 const char *propname, int index,
304 enum gpiod_flags dflags,
307 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
308 struct gpio_desc *desc;
309 enum of_gpio_flags flags;
310 bool active_low = false;
311 bool single_ended = false;
312 bool open_drain = false;
313 bool transitory = false;
316 desc = of_get_named_gpiod_flags(node, propname,
319 if (!desc || IS_ERR(desc)) {
323 active_low = flags & OF_GPIO_ACTIVE_LOW;
324 single_ended = flags & OF_GPIO_SINGLE_ENDED;
325 open_drain = flags & OF_GPIO_OPEN_DRAIN;
326 transitory = flags & OF_GPIO_TRANSITORY;
328 ret = gpiod_request(desc, label);
329 if (ret == -EBUSY && (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE))
335 lflags |= GPIO_ACTIVE_LOW;
339 lflags |= GPIO_OPEN_DRAIN;
341 lflags |= GPIO_OPEN_SOURCE;
345 lflags |= GPIO_TRANSITORY;
347 if (flags & OF_GPIO_PULL_UP)
348 lflags |= GPIO_PULL_UP;
350 if (flags & OF_GPIO_PULL_DOWN)
351 lflags |= GPIO_PULL_DOWN;
353 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
361 EXPORT_SYMBOL_GPL(gpiod_get_from_of_node);
364 * The SPI GPIO bindings happened before we managed to establish that GPIO
365 * properties should be named "foo-gpios" so we have this special kludge for
368 static struct gpio_desc *of_find_spi_gpio(struct device *dev, const char *con_id,
369 enum of_gpio_flags *of_flags)
371 char prop_name[32]; /* 32 is max size of property name */
372 struct device_node *np = dev->of_node;
373 struct gpio_desc *desc;
376 * Hopefully the compiler stubs the rest of the function if this
379 if (!IS_ENABLED(CONFIG_SPI_MASTER))
380 return ERR_PTR(-ENOENT);
382 /* Allow this specifically for "spi-gpio" devices */
383 if (!of_device_is_compatible(np, "spi-gpio") || !con_id)
384 return ERR_PTR(-ENOENT);
386 /* Will be "gpio-sck", "gpio-mosi" or "gpio-miso" */
387 snprintf(prop_name, sizeof(prop_name), "%s-%s", "gpio", con_id);
389 desc = of_get_named_gpiod_flags(np, prop_name, 0, of_flags);
394 * The old Freescale bindings use simply "gpios" as name for the chip select
395 * lines rather than "cs-gpios" like all other SPI hardware. Account for this
396 * with a special quirk.
398 static struct gpio_desc *of_find_spi_cs_gpio(struct device *dev,
401 unsigned long *flags)
403 struct device_node *np = dev->of_node;
405 if (!IS_ENABLED(CONFIG_SPI_MASTER))
406 return ERR_PTR(-ENOENT);
408 /* Allow this specifically for Freescale devices */
409 if (!of_device_is_compatible(np, "fsl,spi") &&
410 !of_device_is_compatible(np, "aeroflexgaisler,spictrl"))
411 return ERR_PTR(-ENOENT);
412 /* Allow only if asking for "cs-gpios" */
413 if (!con_id || strcmp(con_id, "cs"))
414 return ERR_PTR(-ENOENT);
417 * While all other SPI controllers use "cs-gpios" the Freescale
418 * uses just "gpios" so translate to that when "cs-gpios" is
421 return of_find_gpio(dev, NULL, idx, flags);
425 * Some regulator bindings happened before we managed to establish that GPIO
426 * properties should be named "foo-gpios" so we have this special kludge for
429 static struct gpio_desc *of_find_regulator_gpio(struct device *dev, const char *con_id,
430 enum of_gpio_flags *of_flags)
432 /* These are the connection IDs we accept as legacy GPIO phandles */
433 const char *whitelist[] = {
434 "wlf,ldoena", /* Arizona */
435 "wlf,ldo1ena", /* WM8994 */
436 "wlf,ldo2ena", /* WM8994 */
438 struct device_node *np = dev->of_node;
439 struct gpio_desc *desc;
442 if (!IS_ENABLED(CONFIG_REGULATOR))
443 return ERR_PTR(-ENOENT);
446 return ERR_PTR(-ENOENT);
448 i = match_string(whitelist, ARRAY_SIZE(whitelist), con_id);
450 return ERR_PTR(-ENOENT);
452 desc = of_get_named_gpiod_flags(np, con_id, 0, of_flags);
456 static struct gpio_desc *of_find_arizona_gpio(struct device *dev,
458 enum of_gpio_flags *of_flags)
460 if (!IS_ENABLED(CONFIG_MFD_ARIZONA))
461 return ERR_PTR(-ENOENT);
463 if (!con_id || strcmp(con_id, "wlf,reset"))
464 return ERR_PTR(-ENOENT);
466 return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
469 static struct gpio_desc *of_find_usb_gpio(struct device *dev,
471 enum of_gpio_flags *of_flags)
474 * Currently this USB quirk is only for the Fairchild FUSB302 host which is using
475 * an undocumented DT GPIO line named "fcs,int_n" without the compulsory "-gpios"
478 if (!IS_ENABLED(CONFIG_TYPEC_FUSB302))
479 return ERR_PTR(-ENOENT);
481 if (!con_id || strcmp(con_id, "fcs,int_n"))
482 return ERR_PTR(-ENOENT);
484 return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
487 struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
488 unsigned int idx, unsigned long *flags)
490 char prop_name[32]; /* 32 is max size of property name */
491 enum of_gpio_flags of_flags;
492 struct gpio_desc *desc;
495 /* Try GPIO property "foo-gpios" and "foo-gpio" */
496 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
498 snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
501 snprintf(prop_name, sizeof(prop_name), "%s",
504 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
507 if (!IS_ERR(desc) || PTR_ERR(desc) != -ENOENT)
511 if (PTR_ERR(desc) == -ENOENT) {
512 /* Special handling for SPI GPIOs if used */
513 desc = of_find_spi_gpio(dev, con_id, &of_flags);
516 if (PTR_ERR(desc) == -ENOENT) {
517 /* This quirk looks up flags and all */
518 desc = of_find_spi_cs_gpio(dev, con_id, idx, flags);
523 if (PTR_ERR(desc) == -ENOENT) {
524 /* Special handling for regulator GPIOs if used */
525 desc = of_find_regulator_gpio(dev, con_id, &of_flags);
528 if (PTR_ERR(desc) == -ENOENT)
529 desc = of_find_arizona_gpio(dev, con_id, &of_flags);
531 if (PTR_ERR(desc) == -ENOENT)
532 desc = of_find_usb_gpio(dev, con_id, &of_flags);
537 if (of_flags & OF_GPIO_ACTIVE_LOW)
538 *flags |= GPIO_ACTIVE_LOW;
540 if (of_flags & OF_GPIO_SINGLE_ENDED) {
541 if (of_flags & OF_GPIO_OPEN_DRAIN)
542 *flags |= GPIO_OPEN_DRAIN;
544 *flags |= GPIO_OPEN_SOURCE;
547 if (of_flags & OF_GPIO_TRANSITORY)
548 *flags |= GPIO_TRANSITORY;
550 if (of_flags & OF_GPIO_PULL_UP)
551 *flags |= GPIO_PULL_UP;
552 if (of_flags & OF_GPIO_PULL_DOWN)
553 *flags |= GPIO_PULL_DOWN;
559 * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
560 * @np: device node to get GPIO from
561 * @chip: GPIO chip whose hog is parsed
562 * @idx: Index of the GPIO to parse
563 * @name: GPIO line name
564 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
565 * of_find_gpio() or of_parse_own_gpio()
566 * @dflags: gpiod_flags - optional GPIO initialization flags
568 * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
569 * value on the error condition.
571 static struct gpio_desc *of_parse_own_gpio(struct device_node *np,
572 struct gpio_chip *chip,
573 unsigned int idx, const char **name,
574 unsigned long *lflags,
575 enum gpiod_flags *dflags)
577 struct device_node *chip_np;
578 enum of_gpio_flags xlate_flags;
579 struct of_phandle_args gpiospec;
580 struct gpio_desc *desc;
585 chip_np = chip->of_node;
587 return ERR_PTR(-EINVAL);
590 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
593 ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
597 gpiospec.np = chip_np;
598 gpiospec.args_count = tmp;
600 for (i = 0; i < tmp; i++) {
601 ret = of_property_read_u32_index(np, "gpios", idx * tmp + i,
607 desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
611 if (xlate_flags & OF_GPIO_ACTIVE_LOW)
612 *lflags |= GPIO_ACTIVE_LOW;
613 if (xlate_flags & OF_GPIO_TRANSITORY)
614 *lflags |= GPIO_TRANSITORY;
615 if (xlate_flags & OF_GPIO_PULL_UP)
616 *lflags |= GPIO_PULL_UP;
617 if (xlate_flags & OF_GPIO_PULL_DOWN)
618 *lflags |= GPIO_PULL_DOWN;
620 if (of_property_read_bool(np, "input"))
622 else if (of_property_read_bool(np, "output-low"))
623 *dflags |= GPIOD_OUT_LOW;
624 else if (of_property_read_bool(np, "output-high"))
625 *dflags |= GPIOD_OUT_HIGH;
627 pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n",
628 desc_to_gpio(desc), np);
629 return ERR_PTR(-EINVAL);
632 if (name && of_property_read_string(np, "line-name", name))
639 * of_gpiochip_add_hog - Add all hogs in a hog device node
640 * @chip: gpio chip to act on
641 * @hog: device node describing the hogs
643 * Returns error if it fails otherwise 0 on success.
645 static int of_gpiochip_add_hog(struct gpio_chip *chip, struct device_node *hog)
647 enum gpiod_flags dflags;
648 struct gpio_desc *desc;
649 unsigned long lflags;
655 desc = of_parse_own_gpio(hog, chip, i, &name, &lflags, &dflags);
659 ret = gpiod_hog(desc, name, lflags, dflags);
663 #ifdef CONFIG_OF_DYNAMIC
672 * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
673 * @chip: gpio chip to act on
675 * This is only used by of_gpiochip_add to request/set GPIO initial
677 * It returns error if it fails otherwise 0 on success.
679 static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
681 struct device_node *np;
684 for_each_available_child_of_node(chip->of_node, np) {
685 if (!of_property_read_bool(np, "gpio-hog"))
688 ret = of_gpiochip_add_hog(chip, np);
694 of_node_set_flag(np, OF_POPULATED);
700 #ifdef CONFIG_OF_DYNAMIC
702 * of_gpiochip_remove_hog - Remove all hogs in a hog device node
703 * @chip: gpio chip to act on
704 * @hog: device node describing the hogs
706 static void of_gpiochip_remove_hog(struct gpio_chip *chip,
707 struct device_node *hog)
709 struct gpio_desc *descs = chip->gpiodev->descs;
712 for (i = 0; i < chip->ngpio; i++) {
713 if (test_bit(FLAG_IS_HOGGED, &descs[i].flags) &&
715 gpiochip_free_own_desc(&descs[i]);
719 static int of_gpiochip_match_node(struct gpio_chip *chip, void *data)
721 return chip->gpiodev->dev.of_node == data;
724 static struct gpio_chip *of_find_gpiochip_by_node(struct device_node *np)
726 return gpiochip_find(np, of_gpiochip_match_node);
729 static int of_gpio_notify(struct notifier_block *nb, unsigned long action,
732 struct of_reconfig_data *rd = arg;
733 struct gpio_chip *chip;
737 * This only supports adding and removing complete gpio-hog nodes.
738 * Modifying an existing gpio-hog node is not supported (except for
739 * changing its "status" property, which is treated the same as
742 switch (of_reconfig_get_state_change(action, arg)) {
743 case OF_RECONFIG_CHANGE_ADD:
744 if (!of_property_read_bool(rd->dn, "gpio-hog"))
745 return NOTIFY_OK; /* not for us */
747 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED))
750 chip = of_find_gpiochip_by_node(rd->dn->parent);
752 return NOTIFY_OK; /* not for us */
754 ret = of_gpiochip_add_hog(chip, rd->dn);
756 pr_err("%s: failed to add hogs for %pOF\n", __func__,
758 of_node_clear_flag(rd->dn, OF_POPULATED);
759 return notifier_from_errno(ret);
763 case OF_RECONFIG_CHANGE_REMOVE:
764 if (!of_node_check_flag(rd->dn, OF_POPULATED))
765 return NOTIFY_OK; /* already depopulated */
767 chip = of_find_gpiochip_by_node(rd->dn->parent);
769 return NOTIFY_OK; /* not for us */
771 of_gpiochip_remove_hog(chip, rd->dn);
772 of_node_clear_flag(rd->dn, OF_POPULATED);
779 struct notifier_block gpio_of_notifier = {
780 .notifier_call = of_gpio_notify,
782 #endif /* CONFIG_OF_DYNAMIC */
785 * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags
786 * @gc: pointer to the gpio_chip structure
787 * @gpiospec: GPIO specifier as found in the device tree
788 * @flags: a flags pointer to fill in
790 * This is simple translation function, suitable for the most 1:1 mapped
791 * GPIO chips. This function performs only one sanity check: whether GPIO
792 * is less than ngpios (that is specified in the gpio_chip).
794 static int of_gpio_simple_xlate(struct gpio_chip *gc,
795 const struct of_phandle_args *gpiospec,
799 * We're discouraging gpio_cells < 2, since that way you'll have to
800 * write your own xlate function (that will have to retrieve the GPIO
801 * number and the flags from a single gpio cell -- this is possible,
802 * but not recommended).
804 if (gc->of_gpio_n_cells < 2) {
809 if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
812 if (gpiospec->args[0] >= gc->ngpio)
816 *flags = gpiospec->args[1];
818 return gpiospec->args[0];
822 * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank)
823 * @np: device node of the GPIO chip
824 * @mm_gc: pointer to the of_mm_gpio_chip allocated structure
825 * @data: driver data to store in the struct gpio_chip
827 * To use this function you should allocate and fill mm_gc with:
829 * 1) In the gpio_chip structure:
830 * - all the callbacks
832 * - of_xlate callback (optional)
834 * 3) In the of_mm_gpio_chip structure:
835 * - save_regs callback (optional)
837 * If succeeded, this function will map bank's memory and will
838 * do all necessary work for you. Then you'll able to use .regs
839 * to manage GPIOs from the callbacks.
841 int of_mm_gpiochip_add_data(struct device_node *np,
842 struct of_mm_gpio_chip *mm_gc,
846 struct gpio_chip *gc = &mm_gc->gc;
848 gc->label = kasprintf(GFP_KERNEL, "%pOF", np);
852 mm_gc->regs = of_iomap(np, 0);
858 if (mm_gc->save_regs)
859 mm_gc->save_regs(mm_gc);
861 mm_gc->gc.of_node = np;
863 ret = gpiochip_add_data(gc, data);
869 iounmap(mm_gc->regs);
873 pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret);
876 EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data);
879 * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
880 * @mm_gc: pointer to the of_mm_gpio_chip allocated structure
882 void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
884 struct gpio_chip *gc = &mm_gc->gc;
890 iounmap(mm_gc->regs);
893 EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove);
895 static void of_gpiochip_init_valid_mask(struct gpio_chip *chip)
899 struct device_node *np = chip->of_node;
901 len = of_property_count_u32_elems(np, "gpio-reserved-ranges");
902 if (len < 0 || len % 2 != 0)
905 for (i = 0; i < len; i += 2) {
906 of_property_read_u32_index(np, "gpio-reserved-ranges",
908 of_property_read_u32_index(np, "gpio-reserved-ranges",
910 if (start >= chip->ngpio || start + count >= chip->ngpio)
913 bitmap_clear(chip->valid_mask, start, count);
917 #ifdef CONFIG_PINCTRL
918 static int of_gpiochip_add_pin_range(struct gpio_chip *chip)
920 struct device_node *np = chip->of_node;
921 struct of_phandle_args pinspec;
922 struct pinctrl_dev *pctldev;
925 static const char group_names_propname[] = "gpio-ranges-group-names";
926 struct property *group_names;
931 group_names = of_find_property(np, group_names_propname, NULL);
934 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
939 pctldev = of_pinctrl_get(pinspec.np);
940 of_node_put(pinspec.np);
942 return -EPROBE_DEFER;
944 if (pinspec.args[2]) {
946 of_property_read_string_index(np,
947 group_names_propname,
950 pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n",
955 /* npins != 0: linear range */
956 ret = gpiochip_add_pin_range(chip,
957 pinctrl_dev_get_devname(pctldev),
964 /* npins == 0: special range */
965 if (pinspec.args[1]) {
966 pr_err("%pOF: Illegal gpio-range format.\n",
972 pr_err("%pOF: GPIO group range requested but no %s property.\n",
973 np, group_names_propname);
977 ret = of_property_read_string_index(np,
978 group_names_propname,
984 pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n",
989 ret = gpiochip_add_pingroup_range(chip, pctldev,
990 pinspec.args[0], name);
1000 static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
1003 int of_gpiochip_add(struct gpio_chip *chip)
1010 if (!chip->of_xlate) {
1011 chip->of_gpio_n_cells = 2;
1012 chip->of_xlate = of_gpio_simple_xlate;
1015 if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
1018 of_gpiochip_init_valid_mask(chip);
1020 ret = of_gpiochip_add_pin_range(chip);
1024 /* If the chip defines names itself, these take precedence */
1026 devprop_gpiochip_set_names(chip,
1027 of_fwnode_handle(chip->of_node));
1029 of_node_get(chip->of_node);
1031 ret = of_gpiochip_scan_gpios(chip);
1033 of_node_put(chip->of_node);
1038 void of_gpiochip_remove(struct gpio_chip *chip)
1040 of_node_put(chip->of_node);