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 * @dev: Consuming device
29 * @con_id: Function within the GPIO consumer
31 * Some elder GPIO controllers need special quirks. Currently we handle
32 * the Freescale and PPC GPIO controller with bindings that doesn't use the
33 * established "cs-gpios" for chip selects but instead rely on
34 * "gpios" for the chip select lines. If we detect this, we redirect
35 * the counting of "cs-gpios" to count "gpios" transparent to the
38 static int of_gpio_spi_cs_get_count(struct device *dev, const char *con_id)
40 struct device_node *np = dev->of_node;
42 if (!IS_ENABLED(CONFIG_SPI_MASTER))
44 if (!con_id || strcmp(con_id, "cs"))
46 if (!of_device_is_compatible(np, "fsl,spi") &&
47 !of_device_is_compatible(np, "aeroflexgaisler,spictrl") &&
48 !of_device_is_compatible(np, "ibm,ppc4xx-spi"))
50 return of_gpio_named_count(np, "gpios");
54 * This is used by external users of of_gpio_count() from <linux/of_gpio.h>
56 * FIXME: get rid of those external users by converting them to GPIO
57 * descriptors and let them all use gpiod_count()
59 int of_gpio_get_count(struct device *dev, const char *con_id)
65 ret = of_gpio_spi_cs_get_count(dev, con_id);
69 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
71 snprintf(propname, sizeof(propname), "%s-%s",
72 con_id, gpio_suffixes[i]);
74 snprintf(propname, sizeof(propname), "%s",
77 ret = of_gpio_named_count(dev->of_node, propname);
81 return ret ? ret : -ENOENT;
84 static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data)
86 struct of_phandle_args *gpiospec = data;
88 return chip->gpiodev->dev.of_node == gpiospec->np &&
90 chip->of_xlate(chip, gpiospec, NULL) >= 0;
93 static struct gpio_chip *of_find_gpiochip_by_xlate(
94 struct of_phandle_args *gpiospec)
96 return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate);
99 static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip,
100 struct of_phandle_args *gpiospec,
101 enum of_gpio_flags *flags)
105 if (chip->of_gpio_n_cells != gpiospec->args_count)
106 return ERR_PTR(-EINVAL);
108 ret = chip->of_xlate(chip, gpiospec, flags);
112 return gpiochip_get_desc(chip, ret);
116 * of_gpio_need_valid_mask() - figure out if the OF GPIO driver needs
117 * to set the .valid_mask
118 * @gc: the target gpio_chip
120 * Return: true if the valid mask needs to be set
122 bool of_gpio_need_valid_mask(const struct gpio_chip *gc)
125 const struct device_node *np = gc->of_node;
127 size = of_property_count_u32_elems(np, "gpio-reserved-ranges");
128 if (size > 0 && size % 2 == 0)
133 static void of_gpio_flags_quirks(const struct device_node *np,
134 const char *propname,
135 enum of_gpio_flags *flags,
139 * Some GPIO fixed regulator quirks.
140 * Note that active low is the default.
142 if (IS_ENABLED(CONFIG_REGULATOR) &&
143 (of_device_is_compatible(np, "regulator-fixed") ||
144 of_device_is_compatible(np, "reg-fixed-voltage") ||
145 (!(strcmp(propname, "enable-gpio") &&
146 strcmp(propname, "enable-gpios")) &&
147 of_device_is_compatible(np, "regulator-gpio")))) {
148 bool active_low = !of_property_read_bool(np,
149 "enable-active-high");
151 * The regulator GPIO handles are specified such that the
152 * presence or absence of "enable-active-high" solely controls
153 * the polarity of the GPIO line. Any phandle flags must
154 * be actively ignored.
156 if ((*flags & OF_GPIO_ACTIVE_LOW) && !active_low) {
157 pr_warn("%s GPIO handle specifies active low - ignored\n",
158 of_node_full_name(np));
159 *flags &= ~OF_GPIO_ACTIVE_LOW;
162 *flags |= OF_GPIO_ACTIVE_LOW;
165 * Legacy open drain handling for fixed voltage regulators.
167 if (IS_ENABLED(CONFIG_REGULATOR) &&
168 of_device_is_compatible(np, "reg-fixed-voltage") &&
169 of_property_read_bool(np, "gpio-open-drain")) {
170 *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN);
171 pr_info("%s uses legacy open drain flag - update the DTS if you can\n",
172 of_node_full_name(np));
176 * Legacy handling of SPI active high chip select. If we have a
177 * property named "cs-gpios" we need to inspect the child node
178 * to determine if the flags should have inverted semantics.
180 if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") &&
181 of_property_read_bool(np, "cs-gpios")) {
182 struct device_node *child;
186 for_each_child_of_node(np, child) {
187 ret = of_property_read_u32(child, "reg", &cs);
192 * SPI children have active low chip selects
193 * by default. This can be specified negatively
194 * by just omitting "spi-cs-high" in the
195 * device node, or actively by tagging on
196 * GPIO_ACTIVE_LOW as flag in the device
197 * tree. If the line is simultaneously
198 * tagged as active low in the device tree
199 * and has the "spi-cs-high" set, we get a
200 * conflict and the "spi-cs-high" flag will
203 if (of_property_read_bool(child, "spi-cs-high")) {
204 if (*flags & OF_GPIO_ACTIVE_LOW) {
205 pr_warn("%s GPIO handle specifies active low - ignored\n",
206 of_node_full_name(child));
207 *flags &= ~OF_GPIO_ACTIVE_LOW;
210 if (!(*flags & OF_GPIO_ACTIVE_LOW))
211 pr_info("%s enforce active low on chipselect handle\n",
212 of_node_full_name(child));
213 *flags |= OF_GPIO_ACTIVE_LOW;
221 /* Legacy handling of stmmac's active-low PHY reset line */
222 if (IS_ENABLED(CONFIG_STMMAC_ETH) &&
223 !strcmp(propname, "snps,reset-gpio") &&
224 of_property_read_bool(np, "snps,reset-active-low"))
225 *flags |= OF_GPIO_ACTIVE_LOW;
229 * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
230 * @np: device node to get GPIO from
231 * @propname: property name containing gpio specifier(s)
232 * @index: index of the GPIO
233 * @flags: a flags pointer to fill in
235 * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
236 * value on the error condition. If @flags is not NULL the function also fills
237 * in flags for the GPIO.
239 static struct gpio_desc *of_get_named_gpiod_flags(const struct device_node *np,
240 const char *propname, int index, enum of_gpio_flags *flags)
242 struct of_phandle_args gpiospec;
243 struct gpio_chip *chip;
244 struct gpio_desc *desc;
247 ret = of_parse_phandle_with_args_map(np, propname, "gpio", index,
250 pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n",
251 __func__, propname, np, index);
255 chip = of_find_gpiochip_by_xlate(&gpiospec);
257 desc = ERR_PTR(-EPROBE_DEFER);
261 desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags);
266 of_gpio_flags_quirks(np, propname, flags, index);
268 pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n",
269 __func__, propname, np, index,
270 PTR_ERR_OR_ZERO(desc));
273 of_node_put(gpiospec.np);
278 int of_get_named_gpio_flags(const struct device_node *np, const char *list_name,
279 int index, enum of_gpio_flags *flags)
281 struct gpio_desc *desc;
283 desc = of_get_named_gpiod_flags(np, list_name, index, flags);
286 return PTR_ERR(desc);
288 return desc_to_gpio(desc);
290 EXPORT_SYMBOL_GPL(of_get_named_gpio_flags);
293 * gpiod_get_from_of_node() - obtain a GPIO from an OF node
294 * @node: handle of the OF node
295 * @propname: name of the DT property representing the GPIO
296 * @index: index of the GPIO to obtain for the consumer
297 * @dflags: GPIO initialization flags
298 * @label: label to attach to the requested GPIO
301 * On successful request the GPIO pin is configured in accordance with
304 * In case of error an ERR_PTR() is returned.
306 struct gpio_desc *gpiod_get_from_of_node(const struct device_node *node,
307 const char *propname, int index,
308 enum gpiod_flags dflags,
311 unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
312 struct gpio_desc *desc;
313 enum of_gpio_flags flags;
314 bool active_low = false;
315 bool single_ended = false;
316 bool open_drain = false;
317 bool transitory = false;
320 desc = of_get_named_gpiod_flags(node, propname,
323 if (!desc || IS_ERR(desc)) {
327 active_low = flags & OF_GPIO_ACTIVE_LOW;
328 single_ended = flags & OF_GPIO_SINGLE_ENDED;
329 open_drain = flags & OF_GPIO_OPEN_DRAIN;
330 transitory = flags & OF_GPIO_TRANSITORY;
332 ret = gpiod_request(desc, label);
333 if (ret == -EBUSY && (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE))
339 lflags |= GPIO_ACTIVE_LOW;
343 lflags |= GPIO_OPEN_DRAIN;
345 lflags |= GPIO_OPEN_SOURCE;
349 lflags |= GPIO_TRANSITORY;
351 if (flags & OF_GPIO_PULL_UP)
352 lflags |= GPIO_PULL_UP;
354 if (flags & OF_GPIO_PULL_DOWN)
355 lflags |= GPIO_PULL_DOWN;
357 if (flags & OF_GPIO_PULL_DISABLE)
358 lflags |= GPIO_PULL_DISABLE;
360 ret = gpiod_configure_flags(desc, propname, lflags, dflags);
368 EXPORT_SYMBOL_GPL(gpiod_get_from_of_node);
371 * The SPI GPIO bindings happened before we managed to establish that GPIO
372 * properties should be named "foo-gpios" so we have this special kludge for
375 static struct gpio_desc *of_find_spi_gpio(struct device *dev, const char *con_id,
376 enum of_gpio_flags *of_flags)
378 char prop_name[32]; /* 32 is max size of property name */
379 const struct device_node *np = dev->of_node;
380 struct gpio_desc *desc;
383 * Hopefully the compiler stubs the rest of the function if this
386 if (!IS_ENABLED(CONFIG_SPI_MASTER))
387 return ERR_PTR(-ENOENT);
389 /* Allow this specifically for "spi-gpio" devices */
390 if (!of_device_is_compatible(np, "spi-gpio") || !con_id)
391 return ERR_PTR(-ENOENT);
393 /* Will be "gpio-sck", "gpio-mosi" or "gpio-miso" */
394 snprintf(prop_name, sizeof(prop_name), "%s-%s", "gpio", con_id);
396 desc = of_get_named_gpiod_flags(np, prop_name, 0, of_flags);
401 * The old Freescale bindings use simply "gpios" as name for the chip select
402 * lines rather than "cs-gpios" like all other SPI hardware. Account for this
403 * with a special quirk.
405 static struct gpio_desc *of_find_spi_cs_gpio(struct device *dev,
408 unsigned long *flags)
410 const struct device_node *np = dev->of_node;
412 if (!IS_ENABLED(CONFIG_SPI_MASTER))
413 return ERR_PTR(-ENOENT);
415 /* Allow this specifically for Freescale and PPC devices */
416 if (!of_device_is_compatible(np, "fsl,spi") &&
417 !of_device_is_compatible(np, "aeroflexgaisler,spictrl") &&
418 !of_device_is_compatible(np, "ibm,ppc4xx-spi"))
419 return ERR_PTR(-ENOENT);
420 /* Allow only if asking for "cs-gpios" */
421 if (!con_id || strcmp(con_id, "cs"))
422 return ERR_PTR(-ENOENT);
425 * While all other SPI controllers use "cs-gpios" the Freescale
426 * uses just "gpios" so translate to that when "cs-gpios" is
429 return of_find_gpio(dev, NULL, idx, flags);
433 * Some regulator bindings happened before we managed to establish that GPIO
434 * properties should be named "foo-gpios" so we have this special kludge for
437 static struct gpio_desc *of_find_regulator_gpio(struct device *dev, const char *con_id,
438 enum of_gpio_flags *of_flags)
440 /* These are the connection IDs we accept as legacy GPIO phandles */
441 const char *whitelist[] = {
442 "wlf,ldoena", /* Arizona */
443 "wlf,ldo1ena", /* WM8994 */
444 "wlf,ldo2ena", /* WM8994 */
446 const struct device_node *np = dev->of_node;
447 struct gpio_desc *desc;
450 if (!IS_ENABLED(CONFIG_REGULATOR))
451 return ERR_PTR(-ENOENT);
454 return ERR_PTR(-ENOENT);
456 i = match_string(whitelist, ARRAY_SIZE(whitelist), con_id);
458 return ERR_PTR(-ENOENT);
460 desc = of_get_named_gpiod_flags(np, con_id, 0, of_flags);
464 static struct gpio_desc *of_find_arizona_gpio(struct device *dev,
466 enum of_gpio_flags *of_flags)
468 if (!IS_ENABLED(CONFIG_MFD_ARIZONA))
469 return ERR_PTR(-ENOENT);
471 if (!con_id || strcmp(con_id, "wlf,reset"))
472 return ERR_PTR(-ENOENT);
474 return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
477 static struct gpio_desc *of_find_usb_gpio(struct device *dev,
479 enum of_gpio_flags *of_flags)
482 * Currently this USB quirk is only for the Fairchild FUSB302 host which is using
483 * an undocumented DT GPIO line named "fcs,int_n" without the compulsory "-gpios"
486 if (!IS_ENABLED(CONFIG_TYPEC_FUSB302))
487 return ERR_PTR(-ENOENT);
489 if (!con_id || strcmp(con_id, "fcs,int_n"))
490 return ERR_PTR(-ENOENT);
492 return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
495 struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
496 unsigned int idx, unsigned long *flags)
498 char prop_name[32]; /* 32 is max size of property name */
499 enum of_gpio_flags of_flags;
500 struct gpio_desc *desc;
503 /* Try GPIO property "foo-gpios" and "foo-gpio" */
504 for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
506 snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
509 snprintf(prop_name, sizeof(prop_name), "%s",
512 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
515 if (!gpiod_not_found(desc))
519 if (gpiod_not_found(desc)) {
520 /* Special handling for SPI GPIOs if used */
521 desc = of_find_spi_gpio(dev, con_id, &of_flags);
524 if (gpiod_not_found(desc)) {
525 /* This quirk looks up flags and all */
526 desc = of_find_spi_cs_gpio(dev, con_id, idx, flags);
531 if (gpiod_not_found(desc)) {
532 /* Special handling for regulator GPIOs if used */
533 desc = of_find_regulator_gpio(dev, con_id, &of_flags);
536 if (gpiod_not_found(desc))
537 desc = of_find_arizona_gpio(dev, con_id, &of_flags);
539 if (gpiod_not_found(desc))
540 desc = of_find_usb_gpio(dev, con_id, &of_flags);
545 if (of_flags & OF_GPIO_ACTIVE_LOW)
546 *flags |= GPIO_ACTIVE_LOW;
548 if (of_flags & OF_GPIO_SINGLE_ENDED) {
549 if (of_flags & OF_GPIO_OPEN_DRAIN)
550 *flags |= GPIO_OPEN_DRAIN;
552 *flags |= GPIO_OPEN_SOURCE;
555 if (of_flags & OF_GPIO_TRANSITORY)
556 *flags |= GPIO_TRANSITORY;
558 if (of_flags & OF_GPIO_PULL_UP)
559 *flags |= GPIO_PULL_UP;
560 if (of_flags & OF_GPIO_PULL_DOWN)
561 *flags |= GPIO_PULL_DOWN;
562 if (of_flags & OF_GPIO_PULL_DISABLE)
563 *flags |= GPIO_PULL_DISABLE;
569 * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
570 * @np: device node to get GPIO from
571 * @chip: GPIO chip whose hog is parsed
572 * @idx: Index of the GPIO to parse
573 * @name: GPIO line name
574 * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from
575 * of_find_gpio() or of_parse_own_gpio()
576 * @dflags: gpiod_flags - optional GPIO initialization flags
578 * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
579 * value on the error condition.
581 static struct gpio_desc *of_parse_own_gpio(struct device_node *np,
582 struct gpio_chip *chip,
583 unsigned int idx, const char **name,
584 unsigned long *lflags,
585 enum gpiod_flags *dflags)
587 struct device_node *chip_np;
588 enum of_gpio_flags xlate_flags;
589 struct of_phandle_args gpiospec;
590 struct gpio_desc *desc;
595 chip_np = chip->of_node;
597 return ERR_PTR(-EINVAL);
600 *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
601 *dflags = GPIOD_ASIS;
603 ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
607 gpiospec.np = chip_np;
608 gpiospec.args_count = tmp;
610 for (i = 0; i < tmp; i++) {
611 ret = of_property_read_u32_index(np, "gpios", idx * tmp + i,
617 desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
621 if (xlate_flags & OF_GPIO_ACTIVE_LOW)
622 *lflags |= GPIO_ACTIVE_LOW;
623 if (xlate_flags & OF_GPIO_TRANSITORY)
624 *lflags |= GPIO_TRANSITORY;
625 if (xlate_flags & OF_GPIO_PULL_UP)
626 *lflags |= GPIO_PULL_UP;
627 if (xlate_flags & OF_GPIO_PULL_DOWN)
628 *lflags |= GPIO_PULL_DOWN;
629 if (xlate_flags & OF_GPIO_PULL_DISABLE)
630 *lflags |= GPIO_PULL_DISABLE;
632 if (of_property_read_bool(np, "input"))
634 else if (of_property_read_bool(np, "output-low"))
635 *dflags |= GPIOD_OUT_LOW;
636 else if (of_property_read_bool(np, "output-high"))
637 *dflags |= GPIOD_OUT_HIGH;
639 pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n",
640 desc_to_gpio(desc), np);
641 return ERR_PTR(-EINVAL);
644 if (name && of_property_read_string(np, "line-name", name))
651 * of_gpiochip_add_hog - Add all hogs in a hog device node
652 * @chip: gpio chip to act on
653 * @hog: device node describing the hogs
655 * Returns error if it fails otherwise 0 on success.
657 static int of_gpiochip_add_hog(struct gpio_chip *chip, struct device_node *hog)
659 enum gpiod_flags dflags;
660 struct gpio_desc *desc;
661 unsigned long lflags;
667 desc = of_parse_own_gpio(hog, chip, i, &name, &lflags, &dflags);
671 ret = gpiod_hog(desc, name, lflags, dflags);
675 #ifdef CONFIG_OF_DYNAMIC
684 * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
685 * @chip: gpio chip to act on
687 * This is only used by of_gpiochip_add to request/set GPIO initial
689 * It returns error if it fails otherwise 0 on success.
691 static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
693 struct device_node *np;
696 for_each_available_child_of_node(chip->of_node, np) {
697 if (!of_property_read_bool(np, "gpio-hog"))
700 ret = of_gpiochip_add_hog(chip, np);
706 of_node_set_flag(np, OF_POPULATED);
712 #ifdef CONFIG_OF_DYNAMIC
714 * of_gpiochip_remove_hog - Remove all hogs in a hog device node
715 * @chip: gpio chip to act on
716 * @hog: device node describing the hogs
718 static void of_gpiochip_remove_hog(struct gpio_chip *chip,
719 struct device_node *hog)
721 struct gpio_desc *desc;
723 for_each_gpio_desc_with_flag(chip, desc, FLAG_IS_HOGGED)
724 if (desc->hog == hog)
725 gpiochip_free_own_desc(desc);
728 static int of_gpiochip_match_node(struct gpio_chip *chip, void *data)
730 return device_match_of_node(&chip->gpiodev->dev, data);
733 static struct gpio_chip *of_find_gpiochip_by_node(struct device_node *np)
735 return gpiochip_find(np, of_gpiochip_match_node);
738 static int of_gpio_notify(struct notifier_block *nb, unsigned long action,
741 struct of_reconfig_data *rd = arg;
742 struct gpio_chip *chip;
746 * This only supports adding and removing complete gpio-hog nodes.
747 * Modifying an existing gpio-hog node is not supported (except for
748 * changing its "status" property, which is treated the same as
751 switch (of_reconfig_get_state_change(action, arg)) {
752 case OF_RECONFIG_CHANGE_ADD:
753 if (!of_property_read_bool(rd->dn, "gpio-hog"))
754 return NOTIFY_OK; /* not for us */
756 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED))
759 chip = of_find_gpiochip_by_node(rd->dn->parent);
761 return NOTIFY_OK; /* not for us */
763 ret = of_gpiochip_add_hog(chip, rd->dn);
765 pr_err("%s: failed to add hogs for %pOF\n", __func__,
767 of_node_clear_flag(rd->dn, OF_POPULATED);
768 return notifier_from_errno(ret);
772 case OF_RECONFIG_CHANGE_REMOVE:
773 if (!of_node_check_flag(rd->dn, OF_POPULATED))
774 return NOTIFY_OK; /* already depopulated */
776 chip = of_find_gpiochip_by_node(rd->dn->parent);
778 return NOTIFY_OK; /* not for us */
780 of_gpiochip_remove_hog(chip, rd->dn);
781 of_node_clear_flag(rd->dn, OF_POPULATED);
788 struct notifier_block gpio_of_notifier = {
789 .notifier_call = of_gpio_notify,
791 #endif /* CONFIG_OF_DYNAMIC */
794 * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags
795 * @gc: pointer to the gpio_chip structure
796 * @gpiospec: GPIO specifier as found in the device tree
797 * @flags: a flags pointer to fill in
799 * This is simple translation function, suitable for the most 1:1 mapped
800 * GPIO chips. This function performs only one sanity check: whether GPIO
801 * is less than ngpios (that is specified in the gpio_chip).
803 static int of_gpio_simple_xlate(struct gpio_chip *gc,
804 const struct of_phandle_args *gpiospec,
808 * We're discouraging gpio_cells < 2, since that way you'll have to
809 * write your own xlate function (that will have to retrieve the GPIO
810 * number and the flags from a single gpio cell -- this is possible,
811 * but not recommended).
813 if (gc->of_gpio_n_cells < 2) {
818 if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
821 if (gpiospec->args[0] >= gc->ngpio)
825 *flags = gpiospec->args[1];
827 return gpiospec->args[0];
831 * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank)
832 * @np: device node of the GPIO chip
833 * @mm_gc: pointer to the of_mm_gpio_chip allocated structure
834 * @data: driver data to store in the struct gpio_chip
836 * To use this function you should allocate and fill mm_gc with:
838 * 1) In the gpio_chip structure:
839 * - all the callbacks
841 * - of_xlate callback (optional)
843 * 3) In the of_mm_gpio_chip structure:
844 * - save_regs callback (optional)
846 * If succeeded, this function will map bank's memory and will
847 * do all necessary work for you. Then you'll able to use .regs
848 * to manage GPIOs from the callbacks.
850 int of_mm_gpiochip_add_data(struct device_node *np,
851 struct of_mm_gpio_chip *mm_gc,
855 struct gpio_chip *gc = &mm_gc->gc;
857 gc->label = kasprintf(GFP_KERNEL, "%pOF", np);
861 mm_gc->regs = of_iomap(np, 0);
867 if (mm_gc->save_regs)
868 mm_gc->save_regs(mm_gc);
870 of_node_put(mm_gc->gc.of_node);
871 mm_gc->gc.of_node = of_node_get(np);
873 ret = gpiochip_add_data(gc, data);
880 iounmap(mm_gc->regs);
884 pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret);
887 EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data);
890 * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
891 * @mm_gc: pointer to the of_mm_gpio_chip allocated structure
893 void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
895 struct gpio_chip *gc = &mm_gc->gc;
901 iounmap(mm_gc->regs);
904 EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove);
906 static void of_gpiochip_init_valid_mask(struct gpio_chip *chip)
910 struct device_node *np = chip->of_node;
912 len = of_property_count_u32_elems(np, "gpio-reserved-ranges");
913 if (len < 0 || len % 2 != 0)
916 for (i = 0; i < len; i += 2) {
917 of_property_read_u32_index(np, "gpio-reserved-ranges",
919 of_property_read_u32_index(np, "gpio-reserved-ranges",
921 if (start >= chip->ngpio || start + count > chip->ngpio)
924 bitmap_clear(chip->valid_mask, start, count);
928 #ifdef CONFIG_PINCTRL
929 static int of_gpiochip_add_pin_range(struct gpio_chip *chip)
931 struct device_node *np = chip->of_node;
932 struct of_phandle_args pinspec;
933 struct pinctrl_dev *pctldev;
936 static const char group_names_propname[] = "gpio-ranges-group-names";
937 struct property *group_names;
942 if (!of_property_read_bool(np, "gpio-ranges") &&
943 chip->of_gpio_ranges_fallback) {
944 return chip->of_gpio_ranges_fallback(chip, np);
947 group_names = of_find_property(np, group_names_propname, NULL);
950 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
955 pctldev = of_pinctrl_get(pinspec.np);
956 of_node_put(pinspec.np);
958 return -EPROBE_DEFER;
960 if (pinspec.args[2]) {
962 of_property_read_string_index(np,
963 group_names_propname,
966 pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n",
971 /* npins != 0: linear range */
972 ret = gpiochip_add_pin_range(chip,
973 pinctrl_dev_get_devname(pctldev),
980 /* npins == 0: special range */
981 if (pinspec.args[1]) {
982 pr_err("%pOF: Illegal gpio-range format.\n",
988 pr_err("%pOF: GPIO group range requested but no %s property.\n",
989 np, group_names_propname);
993 ret = of_property_read_string_index(np,
994 group_names_propname,
1000 pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n",
1005 ret = gpiochip_add_pingroup_range(chip, pctldev,
1006 pinspec.args[0], name);
1016 static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
1019 int of_gpiochip_add(struct gpio_chip *chip)
1026 if (!chip->of_xlate) {
1027 chip->of_gpio_n_cells = 2;
1028 chip->of_xlate = of_gpio_simple_xlate;
1031 if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
1034 of_gpiochip_init_valid_mask(chip);
1036 ret = of_gpiochip_add_pin_range(chip);
1040 of_node_get(chip->of_node);
1042 ret = of_gpiochip_scan_gpios(chip);
1044 of_node_put(chip->of_node);
1049 void of_gpiochip_remove(struct gpio_chip *chip)
1051 of_node_put(chip->of_node);
1054 void of_gpio_dev_init(struct gpio_chip *gc, struct gpio_device *gdev)
1056 /* Set default OF node to parent's one if present */
1058 gdev->dev.of_node = gc->parent->of_node;
1061 gc->of_node = to_of_node(gc->fwnode);
1063 /* If the gpiochip has an assigned OF node this takes precedence */
1065 gdev->dev.of_node = gc->of_node;
1067 gc->of_node = gdev->dev.of_node;