127038c3eSVladimir Zapolskiy // SPDX-License-Identifier: GPL-2.0+ 2f141ed65SGrant Likely /* 3f141ed65SGrant Likely * OF helpers for the GPIO API 4f141ed65SGrant Likely * 5f141ed65SGrant Likely * Copyright (c) 2007-2008 MontaVista Software, Inc. 6f141ed65SGrant Likely * 7f141ed65SGrant Likely * Author: Anton Vorontsov <avorontsov@ru.mvista.com> 8f141ed65SGrant Likely */ 9f141ed65SGrant Likely 10f141ed65SGrant Likely #include <linux/device.h> 11bea4dbeeSSachin Kamat #include <linux/err.h> 12f141ed65SGrant Likely #include <linux/errno.h> 13f141ed65SGrant Likely #include <linux/module.h> 14f141ed65SGrant Likely #include <linux/io.h> 15af8b6375SAlexandre Courbot #include <linux/gpio/consumer.h> 16f141ed65SGrant Likely #include <linux/of.h> 17f141ed65SGrant Likely #include <linux/of_address.h> 18f141ed65SGrant Likely #include <linux/of_gpio.h> 19f23f1516SShiraz Hashim #include <linux/pinctrl/pinctrl.h> 20f141ed65SGrant Likely #include <linux/slab.h> 21f625d460SBenoit Parrot #include <linux/gpio/machine.h> 22f141ed65SGrant Likely 231bd6b601SAlexandre Courbot #include "gpiolib.h" 24f626d6dfSLinus Walleij #include "gpiolib-of.h" 25f626d6dfSLinus Walleij 2671b8f600SLinus Walleij /** 2771b8f600SLinus Walleij * of_gpio_spi_cs_get_count() - special GPIO counting for SPI 28c5a66b97SLee Jones * @dev: Consuming device 29c5a66b97SLee Jones * @con_id: Function within the GPIO consumer 30c5a66b97SLee Jones * 3171b8f600SLinus Walleij * Some elder GPIO controllers need special quirks. Currently we handle 3247267732SLinus Walleij * the Freescale and PPC GPIO controller with bindings that doesn't use the 3371b8f600SLinus Walleij * established "cs-gpios" for chip selects but instead rely on 3471b8f600SLinus Walleij * "gpios" for the chip select lines. If we detect this, we redirect 3571b8f600SLinus Walleij * the counting of "cs-gpios" to count "gpios" transparent to the 3671b8f600SLinus Walleij * driver. 3771b8f600SLinus Walleij */ 38a1f4c96bSYueHaibing static int of_gpio_spi_cs_get_count(struct device *dev, const char *con_id) 3971b8f600SLinus Walleij { 4071b8f600SLinus Walleij struct device_node *np = dev->of_node; 4171b8f600SLinus Walleij 4271b8f600SLinus Walleij if (!IS_ENABLED(CONFIG_SPI_MASTER)) 4371b8f600SLinus Walleij return 0; 4471b8f600SLinus Walleij if (!con_id || strcmp(con_id, "cs")) 4571b8f600SLinus Walleij return 0; 4671b8f600SLinus Walleij if (!of_device_is_compatible(np, "fsl,spi") && 4747267732SLinus Walleij !of_device_is_compatible(np, "aeroflexgaisler,spictrl") && 4847267732SLinus Walleij !of_device_is_compatible(np, "ibm,ppc4xx-spi")) 4971b8f600SLinus Walleij return 0; 5071b8f600SLinus Walleij return of_gpio_named_count(np, "gpios"); 5171b8f600SLinus Walleij } 5271b8f600SLinus Walleij 53f626d6dfSLinus Walleij /* 54f626d6dfSLinus Walleij * This is used by external users of of_gpio_count() from <linux/of_gpio.h> 55f626d6dfSLinus Walleij * 56f626d6dfSLinus Walleij * FIXME: get rid of those external users by converting them to GPIO 57808b9931SGeert Uytterhoeven * descriptors and let them all use gpiod_count() 58f626d6dfSLinus Walleij */ 59f626d6dfSLinus Walleij int of_gpio_get_count(struct device *dev, const char *con_id) 60f626d6dfSLinus Walleij { 61f626d6dfSLinus Walleij int ret; 62f626d6dfSLinus Walleij char propname[32]; 63f626d6dfSLinus Walleij unsigned int i; 64f626d6dfSLinus Walleij 6571b8f600SLinus Walleij ret = of_gpio_spi_cs_get_count(dev, con_id); 6671b8f600SLinus Walleij if (ret > 0) 6771b8f600SLinus Walleij return ret; 6871b8f600SLinus Walleij 69f626d6dfSLinus Walleij for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { 70f626d6dfSLinus Walleij if (con_id) 71f626d6dfSLinus Walleij snprintf(propname, sizeof(propname), "%s-%s", 72f626d6dfSLinus Walleij con_id, gpio_suffixes[i]); 73f626d6dfSLinus Walleij else 74f626d6dfSLinus Walleij snprintf(propname, sizeof(propname), "%s", 75f626d6dfSLinus Walleij gpio_suffixes[i]); 76f626d6dfSLinus Walleij 77f626d6dfSLinus Walleij ret = of_gpio_named_count(dev->of_node, propname); 78f626d6dfSLinus Walleij if (ret > 0) 79f626d6dfSLinus Walleij break; 80f626d6dfSLinus Walleij } 81f626d6dfSLinus Walleij return ret ? ret : -ENOENT; 82f626d6dfSLinus Walleij } 83af8b6375SAlexandre Courbot 84c7e9d398SMasahiro Yamada static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data) 853d0f7cf0SGrant Likely { 86c7e9d398SMasahiro Yamada struct of_phandle_args *gpiospec = data; 87c7e9d398SMasahiro Yamada 88d59fdbc7SAndy Shevchenko return device_match_of_node(&chip->gpiodev->dev, gpiospec->np) && 89d49b48f0SVincent Whitchurch chip->of_xlate && 90c7e9d398SMasahiro Yamada chip->of_xlate(chip, gpiospec, NULL) >= 0; 917b8792bbSHans Holmberg } 923d0f7cf0SGrant Likely 93c7e9d398SMasahiro Yamada static struct gpio_chip *of_find_gpiochip_by_xlate( 94c7e9d398SMasahiro Yamada struct of_phandle_args *gpiospec) 95762c2e46SMasahiro Yamada { 96c7e9d398SMasahiro Yamada return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate); 973d0f7cf0SGrant Likely } 983d0f7cf0SGrant Likely 9999468c1aSMasahiro Yamada static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip, 10099468c1aSMasahiro Yamada struct of_phandle_args *gpiospec, 10199468c1aSMasahiro Yamada enum of_gpio_flags *flags) 10299468c1aSMasahiro Yamada { 10399468c1aSMasahiro Yamada int ret; 10499468c1aSMasahiro Yamada 10599468c1aSMasahiro Yamada if (chip->of_gpio_n_cells != gpiospec->args_count) 10699468c1aSMasahiro Yamada return ERR_PTR(-EINVAL); 10799468c1aSMasahiro Yamada 10899468c1aSMasahiro Yamada ret = chip->of_xlate(chip, gpiospec, flags); 10999468c1aSMasahiro Yamada if (ret < 0) 11099468c1aSMasahiro Yamada return ERR_PTR(ret); 11199468c1aSMasahiro Yamada 11299468c1aSMasahiro Yamada return gpiochip_get_desc(chip, ret); 113f141ed65SGrant Likely } 114f141ed65SGrant Likely 115f626d6dfSLinus Walleij /** 116f626d6dfSLinus Walleij * of_gpio_need_valid_mask() - figure out if the OF GPIO driver needs 117f626d6dfSLinus Walleij * to set the .valid_mask 11814e8c535SRandy Dunlap * @gc: the target gpio_chip 11914e8c535SRandy Dunlap * 12014e8c535SRandy Dunlap * Return: true if the valid mask needs to be set 121f626d6dfSLinus Walleij */ 12249281a22SStephen Boyd bool of_gpio_need_valid_mask(const struct gpio_chip *gc) 123f626d6dfSLinus Walleij { 124f626d6dfSLinus Walleij int size; 1258990899dSKrzysztof Kozlowski const struct device_node *np = gc->of_node; 126f626d6dfSLinus Walleij 127f626d6dfSLinus Walleij size = of_property_count_u32_elems(np, "gpio-reserved-ranges"); 128f626d6dfSLinus Walleij if (size > 0 && size % 2 == 0) 129f626d6dfSLinus Walleij return true; 130f626d6dfSLinus Walleij return false; 131f626d6dfSLinus Walleij } 132f626d6dfSLinus Walleij 133e3186e36SDmitry Torokhov /* 134e3186e36SDmitry Torokhov * Overrides stated polarity of a gpio line and warns when there is a 135e3186e36SDmitry Torokhov * discrepancy. 136e3186e36SDmitry Torokhov */ 137e3186e36SDmitry Torokhov static void of_gpio_quirk_polarity(const struct device_node *np, 138e3186e36SDmitry Torokhov bool active_high, 139e3186e36SDmitry Torokhov enum of_gpio_flags *flags) 140e3186e36SDmitry Torokhov { 141e3186e36SDmitry Torokhov if (active_high) { 142e3186e36SDmitry Torokhov if (*flags & OF_GPIO_ACTIVE_LOW) { 143e3186e36SDmitry Torokhov pr_warn("%s GPIO handle specifies active low - ignored\n", 144e3186e36SDmitry Torokhov of_node_full_name(np)); 145e3186e36SDmitry Torokhov *flags &= ~OF_GPIO_ACTIVE_LOW; 146e3186e36SDmitry Torokhov } 147e3186e36SDmitry Torokhov } else { 148e3186e36SDmitry Torokhov if (!(*flags & OF_GPIO_ACTIVE_LOW)) 149e3186e36SDmitry Torokhov pr_info("%s enforce active low on GPIO handle\n", 150e3186e36SDmitry Torokhov of_node_full_name(np)); 151e3186e36SDmitry Torokhov *flags |= OF_GPIO_ACTIVE_LOW; 152e3186e36SDmitry Torokhov } 153e3186e36SDmitry Torokhov } 154e3186e36SDmitry Torokhov 15599d18d42SDmitry Torokhov /* 15699d18d42SDmitry Torokhov * This quirk does static polarity overrides in cases where existing 15799d18d42SDmitry Torokhov * DTS specified incorrect polarity. 15899d18d42SDmitry Torokhov */ 15999d18d42SDmitry Torokhov static void of_gpio_try_fixup_polarity(const struct device_node *np, 16099d18d42SDmitry Torokhov const char *propname, 16199d18d42SDmitry Torokhov enum of_gpio_flags *flags) 16299d18d42SDmitry Torokhov { 16399d18d42SDmitry Torokhov static const struct { 16499d18d42SDmitry Torokhov const char *compatible; 16599d18d42SDmitry Torokhov const char *propname; 16699d18d42SDmitry Torokhov bool active_high; 16799d18d42SDmitry Torokhov } gpios[] = { 16899d18d42SDmitry Torokhov #if !IS_ENABLED(CONFIG_LCD_HX8357) 16999d18d42SDmitry Torokhov /* 17099d18d42SDmitry Torokhov * Himax LCD controllers used incorrectly named 17199d18d42SDmitry Torokhov * "gpios-reset" property and also specified wrong 17299d18d42SDmitry Torokhov * polarity. 17399d18d42SDmitry Torokhov */ 17499d18d42SDmitry Torokhov { "himax,hx8357", "gpios-reset", false }, 17599d18d42SDmitry Torokhov { "himax,hx8369", "gpios-reset", false }, 17699d18d42SDmitry Torokhov #endif 17799d18d42SDmitry Torokhov }; 17899d18d42SDmitry Torokhov unsigned int i; 17999d18d42SDmitry Torokhov 18099d18d42SDmitry Torokhov for (i = 0; i < ARRAY_SIZE(gpios); i++) { 18199d18d42SDmitry Torokhov if (of_device_is_compatible(np, gpios[i].compatible) && 18299d18d42SDmitry Torokhov !strcmp(propname, gpios[i].propname)) { 18399d18d42SDmitry Torokhov of_gpio_quirk_polarity(np, gpios[i].active_high, flags); 18499d18d42SDmitry Torokhov break; 18599d18d42SDmitry Torokhov } 18699d18d42SDmitry Torokhov } 18799d18d42SDmitry Torokhov } 18899d18d42SDmitry Torokhov 18934cb9352SDmitry Torokhov static void of_gpio_set_polarity_by_property(const struct device_node *np, 19089a5e15bSLinus Walleij const char *propname, 19134cb9352SDmitry Torokhov enum of_gpio_flags *flags) 192a603a2b8SLinus Walleij { 19334cb9352SDmitry Torokhov static const struct { 19434cb9352SDmitry Torokhov const char *compatible; 19534cb9352SDmitry Torokhov const char *gpio_propname; 19634cb9352SDmitry Torokhov const char *polarity_propname; 19734cb9352SDmitry Torokhov } gpios[] = { 19834cb9352SDmitry Torokhov #if IS_ENABLED(CONFIG_FEC) 19934cb9352SDmitry Torokhov /* Freescale Fast Ethernet Controller */ 20034cb9352SDmitry Torokhov { "fsl,imx25-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20134cb9352SDmitry Torokhov { "fsl,imx27-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20234cb9352SDmitry Torokhov { "fsl,imx28-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20334cb9352SDmitry Torokhov { "fsl,imx6q-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20434cb9352SDmitry Torokhov { "fsl,mvf600-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20534cb9352SDmitry Torokhov { "fsl,imx6sx-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20634cb9352SDmitry Torokhov { "fsl,imx6ul-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20734cb9352SDmitry Torokhov { "fsl,imx8mq-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20834cb9352SDmitry Torokhov { "fsl,imx8qm-fec", "phy-reset-gpios", "phy-reset-active-high" }, 20934cb9352SDmitry Torokhov { "fsl,s32v234-fec", "phy-reset-gpios", "phy-reset-active-high" }, 21034cb9352SDmitry Torokhov #endif 211b8b80348SDmitry Torokhov #if IS_ENABLED(CONFIG_PCI_IMX6) 212b8b80348SDmitry Torokhov { "fsl,imx6q-pcie", "reset-gpio", "reset-gpio-active-high" }, 213b8b80348SDmitry Torokhov { "fsl,imx6sx-pcie", "reset-gpio", "reset-gpio-active-high" }, 214b8b80348SDmitry Torokhov { "fsl,imx6qp-pcie", "reset-gpio", "reset-gpio-active-high" }, 215b8b80348SDmitry Torokhov { "fsl,imx7d-pcie", "reset-gpio", "reset-gpio-active-high" }, 216b8b80348SDmitry Torokhov { "fsl,imx8mq-pcie", "reset-gpio", "reset-gpio-active-high" }, 217b8b80348SDmitry Torokhov { "fsl,imx8mm-pcie", "reset-gpio", "reset-gpio-active-high" }, 218b8b80348SDmitry Torokhov { "fsl,imx8mp-pcie", "reset-gpio", "reset-gpio-active-high" }, 219b8b80348SDmitry Torokhov #endif 22099d18d42SDmitry Torokhov 221a603a2b8SLinus Walleij /* 222a603a2b8SLinus Walleij * The regulator GPIO handles are specified such that the 223a603a2b8SLinus Walleij * presence or absence of "enable-active-high" solely controls 224a603a2b8SLinus Walleij * the polarity of the GPIO line. Any phandle flags must 225a603a2b8SLinus Walleij * be actively ignored. 226a603a2b8SLinus Walleij */ 22734cb9352SDmitry Torokhov #if IS_ENABLED(CONFIG_REGULATOR_FIXED_VOLTAGE) 22834cb9352SDmitry Torokhov { "regulator-fixed", "gpios", "enable-active-high" }, 22934cb9352SDmitry Torokhov { "regulator-fixed", "gpio", "enable-active-high" }, 23034cb9352SDmitry Torokhov { "reg-fixed-voltage", "gpios", "enable-active-high" }, 23134cb9352SDmitry Torokhov { "reg-fixed-voltage", "gpio", "enable-active-high" }, 23234cb9352SDmitry Torokhov #endif 23334cb9352SDmitry Torokhov #if IS_ENABLED(CONFIG_REGULATOR_GPIO) 23434cb9352SDmitry Torokhov { "regulator-gpio", "enable-gpio", "enable-active-high" }, 23534cb9352SDmitry Torokhov { "regulator-gpio", "enable-gpios", "enable-active-high" }, 23634cb9352SDmitry Torokhov #endif 23734cb9352SDmitry Torokhov }; 23834cb9352SDmitry Torokhov unsigned int i; 23934cb9352SDmitry Torokhov bool active_high; 24034cb9352SDmitry Torokhov 24134cb9352SDmitry Torokhov for (i = 0; i < ARRAY_SIZE(gpios); i++) { 24234cb9352SDmitry Torokhov if (of_device_is_compatible(np, gpios[i].compatible) && 24334cb9352SDmitry Torokhov !strcmp(propname, gpios[i].gpio_propname)) { 24434cb9352SDmitry Torokhov active_high = of_property_read_bool(np, 24534cb9352SDmitry Torokhov gpios[i].polarity_propname); 246e3186e36SDmitry Torokhov of_gpio_quirk_polarity(np, active_high, flags); 24734cb9352SDmitry Torokhov break; 248a603a2b8SLinus Walleij } 24934cb9352SDmitry Torokhov } 25034cb9352SDmitry Torokhov } 25134cb9352SDmitry Torokhov 25234cb9352SDmitry Torokhov static void of_gpio_flags_quirks(const struct device_node *np, 25334cb9352SDmitry Torokhov const char *propname, 25434cb9352SDmitry Torokhov enum of_gpio_flags *flags, 25534cb9352SDmitry Torokhov int index) 25634cb9352SDmitry Torokhov { 25734cb9352SDmitry Torokhov of_gpio_try_fixup_polarity(np, propname, flags); 25834cb9352SDmitry Torokhov of_gpio_set_polarity_by_property(np, propname, flags); 25934cb9352SDmitry Torokhov 260a603a2b8SLinus Walleij /* 261a603a2b8SLinus Walleij * Legacy open drain handling for fixed voltage regulators. 262a603a2b8SLinus Walleij */ 263a603a2b8SLinus Walleij if (IS_ENABLED(CONFIG_REGULATOR) && 264a603a2b8SLinus Walleij of_device_is_compatible(np, "reg-fixed-voltage") && 265a603a2b8SLinus Walleij of_property_read_bool(np, "gpio-open-drain")) { 266a603a2b8SLinus Walleij *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN); 267a603a2b8SLinus Walleij pr_info("%s uses legacy open drain flag - update the DTS if you can\n", 268a603a2b8SLinus Walleij of_node_full_name(np)); 269a603a2b8SLinus Walleij } 2706953c57aSLinus Walleij 2716953c57aSLinus Walleij /* 2726953c57aSLinus Walleij * Legacy handling of SPI active high chip select. If we have a 2736953c57aSLinus Walleij * property named "cs-gpios" we need to inspect the child node 2746953c57aSLinus Walleij * to determine if the flags should have inverted semantics. 2756953c57aSLinus Walleij */ 276da7f1349SLinus Walleij if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") && 277a71a81e7SGeert Uytterhoeven of_property_read_bool(np, "cs-gpios")) { 2786953c57aSLinus Walleij struct device_node *child; 2796953c57aSLinus Walleij u32 cs; 2806953c57aSLinus Walleij int ret; 2816953c57aSLinus Walleij 2826953c57aSLinus Walleij for_each_child_of_node(np, child) { 2836953c57aSLinus Walleij ret = of_property_read_u32(child, "reg", &cs); 284c1c04ceaSLinus Walleij if (ret) 2856953c57aSLinus Walleij continue; 2866953c57aSLinus Walleij if (cs == index) { 2876953c57aSLinus Walleij /* 2886953c57aSLinus Walleij * SPI children have active low chip selects 2896953c57aSLinus Walleij * by default. This can be specified negatively 2906953c57aSLinus Walleij * by just omitting "spi-cs-high" in the 2916953c57aSLinus Walleij * device node, or actively by tagging on 2926953c57aSLinus Walleij * GPIO_ACTIVE_LOW as flag in the device 2936953c57aSLinus Walleij * tree. If the line is simultaneously 2946953c57aSLinus Walleij * tagged as active low in the device tree 2956953c57aSLinus Walleij * and has the "spi-cs-high" set, we get a 2966953c57aSLinus Walleij * conflict and the "spi-cs-high" flag will 2976953c57aSLinus Walleij * take precedence. 2986953c57aSLinus Walleij */ 299e3186e36SDmitry Torokhov bool active_high = of_property_read_bool(child, 300e3186e36SDmitry Torokhov "spi-cs-high"); 301e3186e36SDmitry Torokhov of_gpio_quirk_polarity(child, active_high, 302e3186e36SDmitry Torokhov flags); 30389fea04cSNishka Dasgupta of_node_put(child); 3046953c57aSLinus Walleij break; 3056953c57aSLinus Walleij } 3066953c57aSLinus Walleij } 3076953c57aSLinus Walleij } 308edc1ef3fSMartin Blumenstingl 309edc1ef3fSMartin Blumenstingl /* Legacy handling of stmmac's active-low PHY reset line */ 310edc1ef3fSMartin Blumenstingl if (IS_ENABLED(CONFIG_STMMAC_ETH) && 311edc1ef3fSMartin Blumenstingl !strcmp(propname, "snps,reset-gpio") && 312edc1ef3fSMartin Blumenstingl of_property_read_bool(np, "snps,reset-active-low")) 313edc1ef3fSMartin Blumenstingl *flags |= OF_GPIO_ACTIVE_LOW; 314a603a2b8SLinus Walleij } 315a603a2b8SLinus Walleij 316f141ed65SGrant Likely /** 317af8b6375SAlexandre Courbot * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API 318f141ed65SGrant Likely * @np: device node to get GPIO from 319f141ed65SGrant Likely * @propname: property name containing gpio specifier(s) 320f141ed65SGrant Likely * @index: index of the GPIO 321f141ed65SGrant Likely * @flags: a flags pointer to fill in 322f141ed65SGrant Likely * 323af8b6375SAlexandre Courbot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 324f141ed65SGrant Likely * value on the error condition. If @flags is not NULL the function also fills 325f141ed65SGrant Likely * in flags for the GPIO. 326f141ed65SGrant Likely */ 327e6ae9a83SKrzysztof Kozlowski static struct gpio_desc *of_get_named_gpiod_flags(const struct device_node *np, 328af8b6375SAlexandre Courbot const char *propname, int index, enum of_gpio_flags *flags) 329f141ed65SGrant Likely { 330762c2e46SMasahiro Yamada struct of_phandle_args gpiospec; 331762c2e46SMasahiro Yamada struct gpio_chip *chip; 332762c2e46SMasahiro Yamada struct gpio_desc *desc; 333f141ed65SGrant Likely int ret; 334f141ed65SGrant Likely 335c11e6f0fSStephen Boyd ret = of_parse_phandle_with_args_map(np, propname, "gpio", index, 336762c2e46SMasahiro Yamada &gpiospec); 3373d0f7cf0SGrant Likely if (ret) { 3387eb6ce2fSRob Herring pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n", 3397eb6ce2fSRob Herring __func__, propname, np, index); 340af8b6375SAlexandre Courbot return ERR_PTR(ret); 3413d0f7cf0SGrant Likely } 342f141ed65SGrant Likely 343c7e9d398SMasahiro Yamada chip = of_find_gpiochip_by_xlate(&gpiospec); 344762c2e46SMasahiro Yamada if (!chip) { 345762c2e46SMasahiro Yamada desc = ERR_PTR(-EPROBE_DEFER); 346762c2e46SMasahiro Yamada goto out; 347762c2e46SMasahiro Yamada } 3483d0f7cf0SGrant Likely 34999468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags); 350762c2e46SMasahiro Yamada if (IS_ERR(desc)) 351762c2e46SMasahiro Yamada goto out; 352762c2e46SMasahiro Yamada 353605f2d34SLinus Walleij if (flags) 35489a5e15bSLinus Walleij of_gpio_flags_quirks(np, propname, flags, index); 355a603a2b8SLinus Walleij 3567eb6ce2fSRob Herring pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n", 3577eb6ce2fSRob Herring __func__, propname, np, index, 358762c2e46SMasahiro Yamada PTR_ERR_OR_ZERO(desc)); 359762c2e46SMasahiro Yamada 360762c2e46SMasahiro Yamada out: 361762c2e46SMasahiro Yamada of_node_put(gpiospec.np); 362762c2e46SMasahiro Yamada 363762c2e46SMasahiro Yamada return desc; 364f141ed65SGrant Likely } 365f141ed65SGrant Likely 366e6ae9a83SKrzysztof Kozlowski int of_get_named_gpio_flags(const struct device_node *np, const char *list_name, 367f01d9075SAlexandre Courbot int index, enum of_gpio_flags *flags) 368f01d9075SAlexandre Courbot { 369f01d9075SAlexandre Courbot struct gpio_desc *desc; 370f01d9075SAlexandre Courbot 371f01d9075SAlexandre Courbot desc = of_get_named_gpiod_flags(np, list_name, index, flags); 372f01d9075SAlexandre Courbot 373f01d9075SAlexandre Courbot if (IS_ERR(desc)) 374f01d9075SAlexandre Courbot return PTR_ERR(desc); 375f01d9075SAlexandre Courbot else 376f01d9075SAlexandre Courbot return desc_to_gpio(desc); 377f01d9075SAlexandre Courbot } 3786d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_get_named_gpio_flags); 379f01d9075SAlexandre Courbot 380d9e7f0e3SDmitry Torokhov /* Converts gpio_lookup_flags into bitmask of GPIO_* values */ 381d9e7f0e3SDmitry Torokhov static unsigned long of_convert_gpio_flags(enum of_gpio_flags flags) 382d9e7f0e3SDmitry Torokhov { 383d9e7f0e3SDmitry Torokhov unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 384d9e7f0e3SDmitry Torokhov 385d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_ACTIVE_LOW) 386d9e7f0e3SDmitry Torokhov lflags |= GPIO_ACTIVE_LOW; 387d9e7f0e3SDmitry Torokhov 388d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_SINGLE_ENDED) { 389d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_OPEN_DRAIN) 390d9e7f0e3SDmitry Torokhov lflags |= GPIO_OPEN_DRAIN; 391d9e7f0e3SDmitry Torokhov else 392d9e7f0e3SDmitry Torokhov lflags |= GPIO_OPEN_SOURCE; 393d9e7f0e3SDmitry Torokhov } 394d9e7f0e3SDmitry Torokhov 395d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_TRANSITORY) 396d9e7f0e3SDmitry Torokhov lflags |= GPIO_TRANSITORY; 397d9e7f0e3SDmitry Torokhov 398d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_PULL_UP) 399d9e7f0e3SDmitry Torokhov lflags |= GPIO_PULL_UP; 400d9e7f0e3SDmitry Torokhov 401d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_PULL_DOWN) 402d9e7f0e3SDmitry Torokhov lflags |= GPIO_PULL_DOWN; 403d9e7f0e3SDmitry Torokhov 404d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_PULL_DISABLE) 405d9e7f0e3SDmitry Torokhov lflags |= GPIO_PULL_DISABLE; 406d9e7f0e3SDmitry Torokhov 407d9e7f0e3SDmitry Torokhov return lflags; 408d9e7f0e3SDmitry Torokhov } 409d9e7f0e3SDmitry Torokhov 410f626d6dfSLinus Walleij /** 411f626d6dfSLinus Walleij * gpiod_get_from_of_node() - obtain a GPIO from an OF node 412f626d6dfSLinus Walleij * @node: handle of the OF node 413f626d6dfSLinus Walleij * @propname: name of the DT property representing the GPIO 414f626d6dfSLinus Walleij * @index: index of the GPIO to obtain for the consumer 415f626d6dfSLinus Walleij * @dflags: GPIO initialization flags 416f626d6dfSLinus Walleij * @label: label to attach to the requested GPIO 417f626d6dfSLinus Walleij * 418f626d6dfSLinus Walleij * Returns: 419f626d6dfSLinus Walleij * On successful request the GPIO pin is configured in accordance with 420f626d6dfSLinus Walleij * provided @dflags. 421f626d6dfSLinus Walleij * 422f626d6dfSLinus Walleij * In case of error an ERR_PTR() is returned. 423f626d6dfSLinus Walleij */ 424e6ae9a83SKrzysztof Kozlowski struct gpio_desc *gpiod_get_from_of_node(const struct device_node *node, 425f626d6dfSLinus Walleij const char *propname, int index, 426f626d6dfSLinus Walleij enum gpiod_flags dflags, 427f626d6dfSLinus Walleij const char *label) 428f626d6dfSLinus Walleij { 429d9e7f0e3SDmitry Torokhov unsigned long lflags; 430f626d6dfSLinus Walleij struct gpio_desc *desc; 431d9e7f0e3SDmitry Torokhov enum of_gpio_flags of_flags; 432f626d6dfSLinus Walleij int ret; 433f626d6dfSLinus Walleij 434d9e7f0e3SDmitry Torokhov desc = of_get_named_gpiod_flags(node, propname, index, &of_flags); 435d9e7f0e3SDmitry Torokhov if (!desc || IS_ERR(desc)) 436f626d6dfSLinus Walleij return desc; 437f626d6dfSLinus Walleij 438f626d6dfSLinus Walleij ret = gpiod_request(desc, label); 439be7ae45cSMarco Felsch if (ret == -EBUSY && (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE)) 440f626d6dfSLinus Walleij return desc; 441f626d6dfSLinus Walleij if (ret) 442f626d6dfSLinus Walleij return ERR_PTR(ret); 443f626d6dfSLinus Walleij 444d9e7f0e3SDmitry Torokhov lflags = of_convert_gpio_flags(of_flags); 44531bea231SNuno Sá 446f626d6dfSLinus Walleij ret = gpiod_configure_flags(desc, propname, lflags, dflags); 447f626d6dfSLinus Walleij if (ret < 0) { 448f626d6dfSLinus Walleij gpiod_put(desc); 449f626d6dfSLinus Walleij return ERR_PTR(ret); 450f626d6dfSLinus Walleij } 451f626d6dfSLinus Walleij 452f626d6dfSLinus Walleij return desc; 453f626d6dfSLinus Walleij } 4546d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(gpiod_get_from_of_node); 455f141ed65SGrant Likely 456b311c5cbSDmitry Torokhov static struct gpio_desc *of_find_gpio_rename(struct device_node *np, 45798c3c940SDmitry Torokhov const char *con_id, 45898c3c940SDmitry Torokhov unsigned int idx, 459c8582339SLinus Walleij enum of_gpio_flags *of_flags) 460c8582339SLinus Walleij { 461b311c5cbSDmitry Torokhov static const struct of_rename_gpio { 462b311c5cbSDmitry Torokhov const char *con_id; 463b311c5cbSDmitry Torokhov const char *legacy_id; /* NULL - same as con_id */ 464b311c5cbSDmitry Torokhov /* 465b311c5cbSDmitry Torokhov * Compatible string can be set to NULL in case where 466b311c5cbSDmitry Torokhov * matching to a particular compatible is not practical, 467b311c5cbSDmitry Torokhov * but it should only be done for gpio names that have 468b311c5cbSDmitry Torokhov * vendor prefix to reduce risk of false positives. 469b311c5cbSDmitry Torokhov * Addition of such entries is strongly discouraged. 470b311c5cbSDmitry Torokhov */ 471b311c5cbSDmitry Torokhov const char *compatible; 472b311c5cbSDmitry Torokhov } gpios[] = { 473fbbbcd17SDmitry Torokhov #if !IS_ENABLED(CONFIG_LCD_HX8357) 474fbbbcd17SDmitry Torokhov /* Himax LCD controllers used "gpios-reset" */ 475fbbbcd17SDmitry Torokhov { "reset", "gpios-reset", "himax,hx8357" }, 476fbbbcd17SDmitry Torokhov { "reset", "gpios-reset", "himax,hx8369" }, 477fbbbcd17SDmitry Torokhov #endif 478b311c5cbSDmitry Torokhov #if IS_ENABLED(CONFIG_MFD_ARIZONA) 479b311c5cbSDmitry Torokhov { "wlf,reset", NULL, NULL }, 480b311c5cbSDmitry Torokhov #endif 481eaf1a296SDmitry Torokhov #if IS_ENABLED(CONFIG_RTC_DRV_MOXART) 482eaf1a296SDmitry Torokhov { "rtc-data", "gpio-rtc-data", "moxa,moxart-rtc" }, 483eaf1a296SDmitry Torokhov { "rtc-sclk", "gpio-rtc-sclk", "moxa,moxart-rtc" }, 484eaf1a296SDmitry Torokhov { "rtc-reset", "gpio-rtc-reset", "moxa,moxart-rtc" }, 485eaf1a296SDmitry Torokhov #endif 4869c2cc717SDmitry Torokhov #if IS_ENABLED(CONFIG_NFC_MRVL_I2C) 4879c2cc717SDmitry Torokhov { "reset", "reset-n-io", "marvell,nfc-i2c" }, 4889c2cc717SDmitry Torokhov #endif 4899c2cc717SDmitry Torokhov #if IS_ENABLED(CONFIG_NFC_MRVL_SPI) 4909c2cc717SDmitry Torokhov { "reset", "reset-n-io", "marvell,nfc-spi" }, 4919c2cc717SDmitry Torokhov #endif 4929c2cc717SDmitry Torokhov #if IS_ENABLED(CONFIG_NFC_MRVL_UART) 4939c2cc717SDmitry Torokhov { "reset", "reset-n-io", "marvell,nfc-uart" }, 4949c2cc717SDmitry Torokhov { "reset", "reset-n-io", "mrvl,nfc-uart" }, 4959c2cc717SDmitry Torokhov #endif 496fbbbcd17SDmitry Torokhov #if !IS_ENABLED(CONFIG_PCI_LANTIQ) 497fbbbcd17SDmitry Torokhov /* MIPS Lantiq PCI */ 498fbbbcd17SDmitry Torokhov { "reset", "gpios-reset", "lantiq,pci-xway" }, 499fbbbcd17SDmitry Torokhov #endif 500307c593bSDmitry Torokhov 501b311c5cbSDmitry Torokhov /* 502b311c5cbSDmitry Torokhov * Some regulator bindings happened before we managed to 503b311c5cbSDmitry Torokhov * establish that GPIO properties should be named 504b311c5cbSDmitry Torokhov * "foo-gpios" so we have this special kludge for them. 505b311c5cbSDmitry Torokhov */ 506307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_REGULATOR_ARIZONA_LDO1) 507b311c5cbSDmitry Torokhov { "wlf,ldoena", NULL, NULL }, /* Arizona */ 508307c593bSDmitry Torokhov #endif 509307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_REGULATOR_WM8994) 510b311c5cbSDmitry Torokhov { "wlf,ldo1ena", NULL, NULL }, /* WM8994 */ 511b311c5cbSDmitry Torokhov { "wlf,ldo2ena", NULL, NULL }, /* WM8994 */ 512b311c5cbSDmitry Torokhov #endif 513c8582339SLinus Walleij 514944004ebSDmitry Torokhov #if IS_ENABLED(CONFIG_SND_SOC_CS42L56) 515944004ebSDmitry Torokhov { "reset", "cirrus,gpio-nreset", "cirrus,cs42l56" }, 516944004ebSDmitry Torokhov #endif 517fbbbcd17SDmitry Torokhov #if IS_ENABLED(CONFIG_SND_SOC_TLV320AIC3X) 518fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3x" }, 519fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic33" }, 520fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3007" }, 521fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3104" }, 522fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3106" }, 523fbbbcd17SDmitry Torokhov #endif 524307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_SPI_GPIO) 525c8582339SLinus Walleij /* 526b311c5cbSDmitry Torokhov * The SPI GPIO bindings happened before we managed to 527b311c5cbSDmitry Torokhov * establish that GPIO properties should be named 528b311c5cbSDmitry Torokhov * "foo-gpios" so we have this special kludge for them. 529c8582339SLinus Walleij */ 530b311c5cbSDmitry Torokhov { "miso", "gpio-miso", "spi-gpio" }, 531b311c5cbSDmitry Torokhov { "mosi", "gpio-mosi", "spi-gpio" }, 532b311c5cbSDmitry Torokhov { "sck", "gpio-sck", "spi-gpio" }, 533307c593bSDmitry Torokhov #endif 534c8582339SLinus Walleij 5356a537d48SLinus Walleij /* 536b311c5cbSDmitry Torokhov * The old Freescale bindings use simply "gpios" as name 537b311c5cbSDmitry Torokhov * for the chip select lines rather than "cs-gpios" like 538b311c5cbSDmitry Torokhov * all other SPI hardware. Allow this specifically for 539b311c5cbSDmitry Torokhov * Freescale and PPC devices. 540e3023bf8SLinus Walleij */ 541307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_SPI_FSL_SPI) 542b311c5cbSDmitry Torokhov { "cs", "gpios", "fsl,spi" }, 543b311c5cbSDmitry Torokhov { "cs", "gpios", "aeroflexgaisler,spictrl" }, 544307c593bSDmitry Torokhov #endif 545307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_SPI_PPC4xx) 546b311c5cbSDmitry Torokhov { "cs", "gpios", "ibm,ppc4xx-spi" }, 547b311c5cbSDmitry Torokhov #endif 548307c593bSDmitry Torokhov 549b311c5cbSDmitry Torokhov #if IS_ENABLED(CONFIG_TYPEC_FUSB302) 550e3023bf8SLinus Walleij /* 551b311c5cbSDmitry Torokhov * Fairchild FUSB302 host is using undocumented "fcs,int_n" 552b311c5cbSDmitry Torokhov * property without the compulsory "-gpios" suffix. 553e3023bf8SLinus Walleij */ 554b311c5cbSDmitry Torokhov { "fcs,int_n", NULL, "fcs,fusb302" }, 555b311c5cbSDmitry Torokhov #endif 5566a537d48SLinus Walleij }; 557b311c5cbSDmitry Torokhov struct gpio_desc *desc; 558b311c5cbSDmitry Torokhov const char *legacy_id; 559b311c5cbSDmitry Torokhov unsigned int i; 5606a537d48SLinus Walleij 5616a537d48SLinus Walleij if (!con_id) 5626a537d48SLinus Walleij return ERR_PTR(-ENOENT); 5636a537d48SLinus Walleij 564b311c5cbSDmitry Torokhov for (i = 0; i < ARRAY_SIZE(gpios); i++) { 565b311c5cbSDmitry Torokhov if (strcmp(con_id, gpios[i].con_id)) 566b311c5cbSDmitry Torokhov continue; 5676a537d48SLinus Walleij 568b311c5cbSDmitry Torokhov if (gpios[i].compatible && 569b311c5cbSDmitry Torokhov !of_device_is_compatible(np, gpios[i].compatible)) 570b311c5cbSDmitry Torokhov continue; 571b311c5cbSDmitry Torokhov 572b311c5cbSDmitry Torokhov legacy_id = gpios[i].legacy_id ?: gpios[i].con_id; 573b311c5cbSDmitry Torokhov desc = of_get_named_gpiod_flags(np, legacy_id, idx, of_flags); 574b311c5cbSDmitry Torokhov if (!gpiod_not_found(desc)) { 575b311c5cbSDmitry Torokhov pr_info("%s uses legacy gpio name '%s' instead of '%s-gpios'\n", 576b311c5cbSDmitry Torokhov of_node_full_name(np), legacy_id, con_id); 577b311c5cbSDmitry Torokhov return desc; 578b311c5cbSDmitry Torokhov } 5796a537d48SLinus Walleij } 5806a537d48SLinus Walleij 58111c43bb0SDmitry Torokhov return ERR_PTR(-ENOENT); 5826e24826dSLinus Walleij } 5836e24826dSLinus Walleij 584326c3753SDmitry Torokhov static struct gpio_desc *of_find_mt2701_gpio(struct device_node *np, 585326c3753SDmitry Torokhov const char *con_id, 586326c3753SDmitry Torokhov unsigned int idx, 587326c3753SDmitry Torokhov enum of_gpio_flags *of_flags) 588326c3753SDmitry Torokhov { 589326c3753SDmitry Torokhov struct gpio_desc *desc; 590326c3753SDmitry Torokhov const char *legacy_id; 591326c3753SDmitry Torokhov 592326c3753SDmitry Torokhov if (!IS_ENABLED(CONFIG_SND_SOC_MT2701_CS42448)) 593326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 594326c3753SDmitry Torokhov 595326c3753SDmitry Torokhov if (!of_device_is_compatible(np, "mediatek,mt2701-cs42448-machine")) 596326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 597326c3753SDmitry Torokhov 598326c3753SDmitry Torokhov if (!con_id || strcmp(con_id, "i2s1-in-sel")) 599326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 600326c3753SDmitry Torokhov 601326c3753SDmitry Torokhov if (idx == 0) 602326c3753SDmitry Torokhov legacy_id = "i2s1-in-sel-gpio1"; 603326c3753SDmitry Torokhov else if (idx == 1) 604326c3753SDmitry Torokhov legacy_id = "i2s1-in-sel-gpio2"; 605326c3753SDmitry Torokhov else 606326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 607326c3753SDmitry Torokhov 608326c3753SDmitry Torokhov desc = of_get_named_gpiod_flags(np, legacy_id, 0, of_flags); 609326c3753SDmitry Torokhov if (!gpiod_not_found(desc)) 610326c3753SDmitry Torokhov pr_info("%s is using legacy gpio name '%s' instead of '%s-gpios'\n", 611326c3753SDmitry Torokhov of_node_full_name(np), legacy_id, con_id); 612326c3753SDmitry Torokhov 613326c3753SDmitry Torokhov return desc; 614326c3753SDmitry Torokhov } 615326c3753SDmitry Torokhov 616a2b5e207SDmitry Torokhov typedef struct gpio_desc *(*of_find_gpio_quirk)(struct device_node *np, 617a2b5e207SDmitry Torokhov const char *con_id, 618a2b5e207SDmitry Torokhov unsigned int idx, 619a2b5e207SDmitry Torokhov enum of_gpio_flags *of_flags); 620a2b5e207SDmitry Torokhov static const of_find_gpio_quirk of_find_gpio_quirks[] = { 621b311c5cbSDmitry Torokhov of_find_gpio_rename, 622326c3753SDmitry Torokhov of_find_mt2701_gpio, 6238b10ca2fSMichael Walle NULL 624a2b5e207SDmitry Torokhov }; 625a2b5e207SDmitry Torokhov 626ea713bc4SLinus Walleij struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id, 627fed7026aSAndy Shevchenko unsigned int idx, unsigned long *flags) 628ea713bc4SLinus Walleij { 629ea713bc4SLinus Walleij char prop_name[32]; /* 32 is max size of property name */ 630ea713bc4SLinus Walleij enum of_gpio_flags of_flags; 631a2b5e207SDmitry Torokhov const of_find_gpio_quirk *q; 632ea713bc4SLinus Walleij struct gpio_desc *desc; 633ea713bc4SLinus Walleij unsigned int i; 634ea713bc4SLinus Walleij 635c8582339SLinus Walleij /* Try GPIO property "foo-gpios" and "foo-gpio" */ 636ea713bc4SLinus Walleij for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { 637ea713bc4SLinus Walleij if (con_id) 638ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id, 639ea713bc4SLinus Walleij gpio_suffixes[i]); 640ea713bc4SLinus Walleij else 641ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s", 642ea713bc4SLinus Walleij gpio_suffixes[i]); 643ea713bc4SLinus Walleij 644ea713bc4SLinus Walleij desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx, 645ea713bc4SLinus Walleij &of_flags); 6466662ae6aSMaxime Ripard 6477b58696dSAndy Shevchenko if (!gpiod_not_found(desc)) 648ea713bc4SLinus Walleij break; 649ea713bc4SLinus Walleij } 650ea713bc4SLinus Walleij 651a2b5e207SDmitry Torokhov /* Properly named GPIO was not found, try workarounds */ 652a2b5e207SDmitry Torokhov for (q = of_find_gpio_quirks; gpiod_not_found(desc) && *q; q++) 653a2b5e207SDmitry Torokhov desc = (*q)(dev->of_node, con_id, idx, &of_flags); 6546e24826dSLinus Walleij 655ea713bc4SLinus Walleij if (IS_ERR(desc)) 656ea713bc4SLinus Walleij return desc; 657ea713bc4SLinus Walleij 658d9e7f0e3SDmitry Torokhov *flags = of_convert_gpio_flags(of_flags); 659d449991cSThomas Petazzoni 660ea713bc4SLinus Walleij return desc; 661ea713bc4SLinus Walleij } 662ea713bc4SLinus Walleij 663f141ed65SGrant Likely /** 664fd7337fdSMarkus Pargmann * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API 665f625d460SBenoit Parrot * @np: device node to get GPIO from 666be715343SMasahiro Yamada * @chip: GPIO chip whose hog is parsed 667a79fead5SGeert Uytterhoeven * @idx: Index of the GPIO to parse 668f625d460SBenoit Parrot * @name: GPIO line name 669fed7026aSAndy Shevchenko * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from 670fed7026aSAndy Shevchenko * of_find_gpio() or of_parse_own_gpio() 671f625d460SBenoit Parrot * @dflags: gpiod_flags - optional GPIO initialization flags 672f625d460SBenoit Parrot * 673f625d460SBenoit Parrot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 674f625d460SBenoit Parrot * value on the error condition. 675f625d460SBenoit Parrot */ 676fd7337fdSMarkus Pargmann static struct gpio_desc *of_parse_own_gpio(struct device_node *np, 677be715343SMasahiro Yamada struct gpio_chip *chip, 678a79fead5SGeert Uytterhoeven unsigned int idx, const char **name, 679fed7026aSAndy Shevchenko unsigned long *lflags, 680f625d460SBenoit Parrot enum gpiod_flags *dflags) 681f625d460SBenoit Parrot { 682f625d460SBenoit Parrot struct device_node *chip_np; 683f625d460SBenoit Parrot enum of_gpio_flags xlate_flags; 684be715343SMasahiro Yamada struct of_phandle_args gpiospec; 685be715343SMasahiro Yamada struct gpio_desc *desc; 686a79fead5SGeert Uytterhoeven unsigned int i; 687f625d460SBenoit Parrot u32 tmp; 6883f9547e1SMasahiro Yamada int ret; 689f625d460SBenoit Parrot 690be715343SMasahiro Yamada chip_np = chip->of_node; 691f625d460SBenoit Parrot if (!chip_np) 692f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 693f625d460SBenoit Parrot 694f625d460SBenoit Parrot xlate_flags = 0; 6952d6c06f5SAndy Shevchenko *lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 69640941954SAndy Shevchenko *dflags = GPIOD_ASIS; 697f625d460SBenoit Parrot 698f625d460SBenoit Parrot ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp); 699f625d460SBenoit Parrot if (ret) 700f625d460SBenoit Parrot return ERR_PTR(ret); 701f625d460SBenoit Parrot 702be715343SMasahiro Yamada gpiospec.np = chip_np; 703be715343SMasahiro Yamada gpiospec.args_count = tmp; 704f625d460SBenoit Parrot 705a79fead5SGeert Uytterhoeven for (i = 0; i < tmp; i++) { 706a79fead5SGeert Uytterhoeven ret = of_property_read_u32_index(np, "gpios", idx * tmp + i, 707a79fead5SGeert Uytterhoeven &gpiospec.args[i]); 708f625d460SBenoit Parrot if (ret) 709f625d460SBenoit Parrot return ERR_PTR(ret); 710a79fead5SGeert Uytterhoeven } 711f625d460SBenoit Parrot 71299468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags); 713be715343SMasahiro Yamada if (IS_ERR(desc)) 714be715343SMasahiro Yamada return desc; 715f625d460SBenoit Parrot 716d9e7f0e3SDmitry Torokhov *lflags = of_convert_gpio_flags(xlate_flags); 717f625d460SBenoit Parrot 718f625d460SBenoit Parrot if (of_property_read_bool(np, "input")) 719f625d460SBenoit Parrot *dflags |= GPIOD_IN; 720f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-low")) 721f625d460SBenoit Parrot *dflags |= GPIOD_OUT_LOW; 722f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-high")) 723f625d460SBenoit Parrot *dflags |= GPIOD_OUT_HIGH; 724f625d460SBenoit Parrot else { 72562cdcb6cSRob Herring pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n", 72662cdcb6cSRob Herring desc_to_gpio(desc), np); 727f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 728f625d460SBenoit Parrot } 729f625d460SBenoit Parrot 730f625d460SBenoit Parrot if (name && of_property_read_string(np, "line-name", name)) 731f625d460SBenoit Parrot *name = np->name; 732f625d460SBenoit Parrot 733be715343SMasahiro Yamada return desc; 734f625d460SBenoit Parrot } 735f625d460SBenoit Parrot 736f625d460SBenoit Parrot /** 737bc21077eSGeert Uytterhoeven * of_gpiochip_add_hog - Add all hogs in a hog device node 738bc21077eSGeert Uytterhoeven * @chip: gpio chip to act on 739bc21077eSGeert Uytterhoeven * @hog: device node describing the hogs 740bc21077eSGeert Uytterhoeven * 741bc21077eSGeert Uytterhoeven * Returns error if it fails otherwise 0 on success. 742bc21077eSGeert Uytterhoeven */ 743bc21077eSGeert Uytterhoeven static int of_gpiochip_add_hog(struct gpio_chip *chip, struct device_node *hog) 744bc21077eSGeert Uytterhoeven { 745bc21077eSGeert Uytterhoeven enum gpiod_flags dflags; 746bc21077eSGeert Uytterhoeven struct gpio_desc *desc; 747bc21077eSGeert Uytterhoeven unsigned long lflags; 748bc21077eSGeert Uytterhoeven const char *name; 749bc21077eSGeert Uytterhoeven unsigned int i; 750bc21077eSGeert Uytterhoeven int ret; 751bc21077eSGeert Uytterhoeven 752bc21077eSGeert Uytterhoeven for (i = 0;; i++) { 753bc21077eSGeert Uytterhoeven desc = of_parse_own_gpio(hog, chip, i, &name, &lflags, &dflags); 754bc21077eSGeert Uytterhoeven if (IS_ERR(desc)) 755bc21077eSGeert Uytterhoeven break; 756bc21077eSGeert Uytterhoeven 757bc21077eSGeert Uytterhoeven ret = gpiod_hog(desc, name, lflags, dflags); 758bc21077eSGeert Uytterhoeven if (ret < 0) 759bc21077eSGeert Uytterhoeven return ret; 76063636d95SGeert Uytterhoeven 76163636d95SGeert Uytterhoeven #ifdef CONFIG_OF_DYNAMIC 76263636d95SGeert Uytterhoeven desc->hog = hog; 76363636d95SGeert Uytterhoeven #endif 764bc21077eSGeert Uytterhoeven } 765bc21077eSGeert Uytterhoeven 766bc21077eSGeert Uytterhoeven return 0; 767bc21077eSGeert Uytterhoeven } 768bc21077eSGeert Uytterhoeven 769bc21077eSGeert Uytterhoeven /** 770fd7337fdSMarkus Pargmann * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions 771f625d460SBenoit Parrot * @chip: gpio chip to act on 772f625d460SBenoit Parrot * 773f625d460SBenoit Parrot * This is only used by of_gpiochip_add to request/set GPIO initial 774f625d460SBenoit Parrot * configuration. 775ead066e6SGeert Uytterhoeven * It returns error if it fails otherwise 0 on success. 776f625d460SBenoit Parrot */ 777dfbd379bSLaxman Dewangan static int of_gpiochip_scan_gpios(struct gpio_chip *chip) 778f625d460SBenoit Parrot { 779f625d460SBenoit Parrot struct device_node *np; 780dfbd379bSLaxman Dewangan int ret; 781f625d460SBenoit Parrot 782d1279d94SLaxman Dewangan for_each_available_child_of_node(chip->of_node, np) { 783f625d460SBenoit Parrot if (!of_property_read_bool(np, "gpio-hog")) 784f625d460SBenoit Parrot continue; 785f625d460SBenoit Parrot 786bc21077eSGeert Uytterhoeven ret = of_gpiochip_add_hog(chip, np); 78709e258afSWei Yongjun if (ret < 0) { 78809e258afSWei Yongjun of_node_put(np); 789dfbd379bSLaxman Dewangan return ret; 790f625d460SBenoit Parrot } 79163636d95SGeert Uytterhoeven 79263636d95SGeert Uytterhoeven of_node_set_flag(np, OF_POPULATED); 79309e258afSWei Yongjun } 794dfbd379bSLaxman Dewangan 795dfbd379bSLaxman Dewangan return 0; 796f625d460SBenoit Parrot } 797f625d460SBenoit Parrot 79863636d95SGeert Uytterhoeven #ifdef CONFIG_OF_DYNAMIC 79963636d95SGeert Uytterhoeven /** 80063636d95SGeert Uytterhoeven * of_gpiochip_remove_hog - Remove all hogs in a hog device node 80163636d95SGeert Uytterhoeven * @chip: gpio chip to act on 80263636d95SGeert Uytterhoeven * @hog: device node describing the hogs 80363636d95SGeert Uytterhoeven */ 80463636d95SGeert Uytterhoeven static void of_gpiochip_remove_hog(struct gpio_chip *chip, 80563636d95SGeert Uytterhoeven struct device_node *hog) 80663636d95SGeert Uytterhoeven { 80780c78fbeSAndy Shevchenko struct gpio_desc *desc; 80863636d95SGeert Uytterhoeven 80957017eddSAndy Shevchenko for_each_gpio_desc_with_flag(chip, desc, FLAG_IS_HOGGED) 81080c78fbeSAndy Shevchenko if (desc->hog == hog) 81180c78fbeSAndy Shevchenko gpiochip_free_own_desc(desc); 81263636d95SGeert Uytterhoeven } 81363636d95SGeert Uytterhoeven 81463636d95SGeert Uytterhoeven static int of_gpiochip_match_node(struct gpio_chip *chip, void *data) 81563636d95SGeert Uytterhoeven { 816597a8a88SAndy Shevchenko return device_match_of_node(&chip->gpiodev->dev, data); 81763636d95SGeert Uytterhoeven } 81863636d95SGeert Uytterhoeven 81963636d95SGeert Uytterhoeven static struct gpio_chip *of_find_gpiochip_by_node(struct device_node *np) 82063636d95SGeert Uytterhoeven { 82163636d95SGeert Uytterhoeven return gpiochip_find(np, of_gpiochip_match_node); 82263636d95SGeert Uytterhoeven } 82363636d95SGeert Uytterhoeven 82463636d95SGeert Uytterhoeven static int of_gpio_notify(struct notifier_block *nb, unsigned long action, 82563636d95SGeert Uytterhoeven void *arg) 82663636d95SGeert Uytterhoeven { 82763636d95SGeert Uytterhoeven struct of_reconfig_data *rd = arg; 82863636d95SGeert Uytterhoeven struct gpio_chip *chip; 82963636d95SGeert Uytterhoeven int ret; 83063636d95SGeert Uytterhoeven 83163636d95SGeert Uytterhoeven /* 83263636d95SGeert Uytterhoeven * This only supports adding and removing complete gpio-hog nodes. 83363636d95SGeert Uytterhoeven * Modifying an existing gpio-hog node is not supported (except for 83463636d95SGeert Uytterhoeven * changing its "status" property, which is treated the same as 83563636d95SGeert Uytterhoeven * addition/removal). 83663636d95SGeert Uytterhoeven */ 83763636d95SGeert Uytterhoeven switch (of_reconfig_get_state_change(action, arg)) { 83863636d95SGeert Uytterhoeven case OF_RECONFIG_CHANGE_ADD: 83963636d95SGeert Uytterhoeven if (!of_property_read_bool(rd->dn, "gpio-hog")) 84063636d95SGeert Uytterhoeven return NOTIFY_OK; /* not for us */ 84163636d95SGeert Uytterhoeven 84263636d95SGeert Uytterhoeven if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) 84363636d95SGeert Uytterhoeven return NOTIFY_OK; 84463636d95SGeert Uytterhoeven 84563636d95SGeert Uytterhoeven chip = of_find_gpiochip_by_node(rd->dn->parent); 84663636d95SGeert Uytterhoeven if (chip == NULL) 84763636d95SGeert Uytterhoeven return NOTIFY_OK; /* not for us */ 84863636d95SGeert Uytterhoeven 84963636d95SGeert Uytterhoeven ret = of_gpiochip_add_hog(chip, rd->dn); 85063636d95SGeert Uytterhoeven if (ret < 0) { 85163636d95SGeert Uytterhoeven pr_err("%s: failed to add hogs for %pOF\n", __func__, 85263636d95SGeert Uytterhoeven rd->dn); 85363636d95SGeert Uytterhoeven of_node_clear_flag(rd->dn, OF_POPULATED); 85463636d95SGeert Uytterhoeven return notifier_from_errno(ret); 85563636d95SGeert Uytterhoeven } 85663636d95SGeert Uytterhoeven break; 85763636d95SGeert Uytterhoeven 85863636d95SGeert Uytterhoeven case OF_RECONFIG_CHANGE_REMOVE: 85963636d95SGeert Uytterhoeven if (!of_node_check_flag(rd->dn, OF_POPULATED)) 86063636d95SGeert Uytterhoeven return NOTIFY_OK; /* already depopulated */ 86163636d95SGeert Uytterhoeven 86263636d95SGeert Uytterhoeven chip = of_find_gpiochip_by_node(rd->dn->parent); 86363636d95SGeert Uytterhoeven if (chip == NULL) 86463636d95SGeert Uytterhoeven return NOTIFY_OK; /* not for us */ 86563636d95SGeert Uytterhoeven 86663636d95SGeert Uytterhoeven of_gpiochip_remove_hog(chip, rd->dn); 86763636d95SGeert Uytterhoeven of_node_clear_flag(rd->dn, OF_POPULATED); 86863636d95SGeert Uytterhoeven break; 86963636d95SGeert Uytterhoeven } 87063636d95SGeert Uytterhoeven 87163636d95SGeert Uytterhoeven return NOTIFY_OK; 87263636d95SGeert Uytterhoeven } 87363636d95SGeert Uytterhoeven 87463636d95SGeert Uytterhoeven struct notifier_block gpio_of_notifier = { 87563636d95SGeert Uytterhoeven .notifier_call = of_gpio_notify, 87663636d95SGeert Uytterhoeven }; 87763636d95SGeert Uytterhoeven #endif /* CONFIG_OF_DYNAMIC */ 87863636d95SGeert Uytterhoeven 879f625d460SBenoit Parrot /** 88067049c50SThierry Reding * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags 881f141ed65SGrant Likely * @gc: pointer to the gpio_chip structure 88267049c50SThierry Reding * @gpiospec: GPIO specifier as found in the device tree 883f141ed65SGrant Likely * @flags: a flags pointer to fill in 884f141ed65SGrant Likely * 885f141ed65SGrant Likely * This is simple translation function, suitable for the most 1:1 mapped 88667049c50SThierry Reding * GPIO chips. This function performs only one sanity check: whether GPIO 887f141ed65SGrant Likely * is less than ngpios (that is specified in the gpio_chip). 888f141ed65SGrant Likely */ 889b0c7e73bSGeert Uytterhoeven static int of_gpio_simple_xlate(struct gpio_chip *gc, 890b0c7e73bSGeert Uytterhoeven const struct of_phandle_args *gpiospec, 891b0c7e73bSGeert Uytterhoeven u32 *flags) 892f141ed65SGrant Likely { 893f141ed65SGrant Likely /* 894f141ed65SGrant Likely * We're discouraging gpio_cells < 2, since that way you'll have to 89520a8a968SColin Cronin * write your own xlate function (that will have to retrieve the GPIO 896f141ed65SGrant Likely * number and the flags from a single gpio cell -- this is possible, 897f141ed65SGrant Likely * but not recommended). 898f141ed65SGrant Likely */ 899f141ed65SGrant Likely if (gc->of_gpio_n_cells < 2) { 900f141ed65SGrant Likely WARN_ON(1); 901f141ed65SGrant Likely return -EINVAL; 902f141ed65SGrant Likely } 903f141ed65SGrant Likely 904f141ed65SGrant Likely if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells)) 905f141ed65SGrant Likely return -EINVAL; 906f141ed65SGrant Likely 9077b96c686SGrant Likely if (gpiospec->args[0] >= gc->ngpio) 908f141ed65SGrant Likely return -EINVAL; 909f141ed65SGrant Likely 910f141ed65SGrant Likely if (flags) 911f141ed65SGrant Likely *flags = gpiospec->args[1]; 912f141ed65SGrant Likely 913f141ed65SGrant Likely return gpiospec->args[0]; 914f141ed65SGrant Likely } 915f141ed65SGrant Likely 916f141ed65SGrant Likely /** 9173208b0f0SLinus Walleij * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank) 918f141ed65SGrant Likely * @np: device node of the GPIO chip 919f141ed65SGrant Likely * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 9203208b0f0SLinus Walleij * @data: driver data to store in the struct gpio_chip 921f141ed65SGrant Likely * 922f141ed65SGrant Likely * To use this function you should allocate and fill mm_gc with: 923f141ed65SGrant Likely * 924f141ed65SGrant Likely * 1) In the gpio_chip structure: 925f141ed65SGrant Likely * - all the callbacks 926f141ed65SGrant Likely * - of_gpio_n_cells 927f141ed65SGrant Likely * - of_xlate callback (optional) 928f141ed65SGrant Likely * 929f141ed65SGrant Likely * 3) In the of_mm_gpio_chip structure: 930f141ed65SGrant Likely * - save_regs callback (optional) 931f141ed65SGrant Likely * 932f141ed65SGrant Likely * If succeeded, this function will map bank's memory and will 933f141ed65SGrant Likely * do all necessary work for you. Then you'll able to use .regs 934f141ed65SGrant Likely * to manage GPIOs from the callbacks. 935f141ed65SGrant Likely */ 9363208b0f0SLinus Walleij int of_mm_gpiochip_add_data(struct device_node *np, 9373208b0f0SLinus Walleij struct of_mm_gpio_chip *mm_gc, 9383208b0f0SLinus Walleij void *data) 939f141ed65SGrant Likely { 940f141ed65SGrant Likely int ret = -ENOMEM; 941f141ed65SGrant Likely struct gpio_chip *gc = &mm_gc->gc; 942f141ed65SGrant Likely 9437eb6ce2fSRob Herring gc->label = kasprintf(GFP_KERNEL, "%pOF", np); 944f141ed65SGrant Likely if (!gc->label) 945f141ed65SGrant Likely goto err0; 946f141ed65SGrant Likely 947f141ed65SGrant Likely mm_gc->regs = of_iomap(np, 0); 948f141ed65SGrant Likely if (!mm_gc->regs) 949f141ed65SGrant Likely goto err1; 950f141ed65SGrant Likely 951f141ed65SGrant Likely gc->base = -1; 952f141ed65SGrant Likely 953f141ed65SGrant Likely if (mm_gc->save_regs) 954f141ed65SGrant Likely mm_gc->save_regs(mm_gc); 955f141ed65SGrant Likely 9565d07a692SLiang He of_node_put(mm_gc->gc.of_node); 9575d07a692SLiang He mm_gc->gc.of_node = of_node_get(np); 958f141ed65SGrant Likely 9593208b0f0SLinus Walleij ret = gpiochip_add_data(gc, data); 960f141ed65SGrant Likely if (ret) 961f141ed65SGrant Likely goto err2; 962f141ed65SGrant Likely 963f141ed65SGrant Likely return 0; 964f141ed65SGrant Likely err2: 9655d07a692SLiang He of_node_put(np); 966f141ed65SGrant Likely iounmap(mm_gc->regs); 967f141ed65SGrant Likely err1: 968f141ed65SGrant Likely kfree(gc->label); 969f141ed65SGrant Likely err0: 9707eb6ce2fSRob Herring pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret); 971f141ed65SGrant Likely return ret; 972f141ed65SGrant Likely } 9736d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data); 974f141ed65SGrant Likely 975d621e8baSRicardo Ribalda Delgado /** 976d621e8baSRicardo Ribalda Delgado * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank) 977d621e8baSRicardo Ribalda Delgado * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 978d621e8baSRicardo Ribalda Delgado */ 979d621e8baSRicardo Ribalda Delgado void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc) 980d621e8baSRicardo Ribalda Delgado { 981d621e8baSRicardo Ribalda Delgado struct gpio_chip *gc = &mm_gc->gc; 982d621e8baSRicardo Ribalda Delgado 983d621e8baSRicardo Ribalda Delgado if (!mm_gc) 984d621e8baSRicardo Ribalda Delgado return; 985d621e8baSRicardo Ribalda Delgado 986d621e8baSRicardo Ribalda Delgado gpiochip_remove(gc); 987d621e8baSRicardo Ribalda Delgado iounmap(mm_gc->regs); 988d621e8baSRicardo Ribalda Delgado kfree(gc->label); 989d621e8baSRicardo Ribalda Delgado } 9906d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove); 991d621e8baSRicardo Ribalda Delgado 992726cb3baSStephen Boyd static void of_gpiochip_init_valid_mask(struct gpio_chip *chip) 993726cb3baSStephen Boyd { 994726cb3baSStephen Boyd int len, i; 995726cb3baSStephen Boyd u32 start, count; 996726cb3baSStephen Boyd struct device_node *np = chip->of_node; 997726cb3baSStephen Boyd 998726cb3baSStephen Boyd len = of_property_count_u32_elems(np, "gpio-reserved-ranges"); 999726cb3baSStephen Boyd if (len < 0 || len % 2 != 0) 1000726cb3baSStephen Boyd return; 1001726cb3baSStephen Boyd 1002726cb3baSStephen Boyd for (i = 0; i < len; i += 2) { 1003726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 1004726cb3baSStephen Boyd i, &start); 1005726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 1006726cb3baSStephen Boyd i + 1, &count); 1007e75f88efSAndrei Lalaev if (start >= chip->ngpio || start + count > chip->ngpio) 1008726cb3baSStephen Boyd continue; 1009726cb3baSStephen Boyd 1010726cb3baSStephen Boyd bitmap_clear(chip->valid_mask, start, count); 1011726cb3baSStephen Boyd } 1012726cb3baSStephen Boyd }; 1013726cb3baSStephen Boyd 1014f23f1516SShiraz Hashim #ifdef CONFIG_PINCTRL 101528355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) 1016f23f1516SShiraz Hashim { 1017f23f1516SShiraz Hashim struct device_node *np = chip->of_node; 1018f23f1516SShiraz Hashim struct of_phandle_args pinspec; 10191e63d7b9SLinus Walleij struct pinctrl_dev *pctldev; 1020f23f1516SShiraz Hashim int index = 0, ret; 1021586a87e6SChristian Ruppert const char *name; 1022586a87e6SChristian Ruppert static const char group_names_propname[] = "gpio-ranges-group-names"; 1023586a87e6SChristian Ruppert struct property *group_names; 1024f23f1516SShiraz Hashim 1025f23f1516SShiraz Hashim if (!np) 102628355f81STomeu Vizoso return 0; 1027f23f1516SShiraz Hashim 10283550bba2SStefan Wahren if (!of_property_read_bool(np, "gpio-ranges") && 10293550bba2SStefan Wahren chip->of_gpio_ranges_fallback) { 10303550bba2SStefan Wahren return chip->of_gpio_ranges_fallback(chip, np); 10313550bba2SStefan Wahren } 10323550bba2SStefan Wahren 1033586a87e6SChristian Ruppert group_names = of_find_property(np, group_names_propname, NULL); 1034586a87e6SChristian Ruppert 1035ad4e1a7cSHaojian Zhuang for (;; index++) { 1036d9fe0039SStephen Warren ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 1037d9fe0039SStephen Warren index, &pinspec); 1038f23f1516SShiraz Hashim if (ret) 1039f23f1516SShiraz Hashim break; 1040f23f1516SShiraz Hashim 10411e63d7b9SLinus Walleij pctldev = of_pinctrl_get(pinspec.np); 1042602cf638SMasahiro Yamada of_node_put(pinspec.np); 10431e63d7b9SLinus Walleij if (!pctldev) 104428355f81STomeu Vizoso return -EPROBE_DEFER; 1045f23f1516SShiraz Hashim 1046586a87e6SChristian Ruppert if (pinspec.args[2]) { 1047586a87e6SChristian Ruppert if (group_names) { 104872858602SLaurent Navet of_property_read_string_index(np, 1049586a87e6SChristian Ruppert group_names_propname, 1050586a87e6SChristian Ruppert index, &name); 1051586a87e6SChristian Ruppert if (strlen(name)) { 10527eb6ce2fSRob Herring pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n", 10537eb6ce2fSRob Herring np); 1054586a87e6SChristian Ruppert break; 1055586a87e6SChristian Ruppert } 1056586a87e6SChristian Ruppert } 1057586a87e6SChristian Ruppert /* npins != 0: linear range */ 10581e63d7b9SLinus Walleij ret = gpiochip_add_pin_range(chip, 1059ef5e3eefSHaojian Zhuang pinctrl_dev_get_devname(pctldev), 10601e63d7b9SLinus Walleij pinspec.args[0], 106186853c83SHaojian Zhuang pinspec.args[1], 106286853c83SHaojian Zhuang pinspec.args[2]); 10631e63d7b9SLinus Walleij if (ret) 106428355f81STomeu Vizoso return ret; 1065586a87e6SChristian Ruppert } else { 1066586a87e6SChristian Ruppert /* npins == 0: special range */ 1067586a87e6SChristian Ruppert if (pinspec.args[1]) { 10687eb6ce2fSRob Herring pr_err("%pOF: Illegal gpio-range format.\n", 10697eb6ce2fSRob Herring np); 1070586a87e6SChristian Ruppert break; 1071586a87e6SChristian Ruppert } 1072586a87e6SChristian Ruppert 1073586a87e6SChristian Ruppert if (!group_names) { 10747eb6ce2fSRob Herring pr_err("%pOF: GPIO group range requested but no %s property.\n", 10757eb6ce2fSRob Herring np, group_names_propname); 1076586a87e6SChristian Ruppert break; 1077586a87e6SChristian Ruppert } 1078586a87e6SChristian Ruppert 1079586a87e6SChristian Ruppert ret = of_property_read_string_index(np, 1080586a87e6SChristian Ruppert group_names_propname, 1081586a87e6SChristian Ruppert index, &name); 1082586a87e6SChristian Ruppert if (ret) 1083586a87e6SChristian Ruppert break; 1084586a87e6SChristian Ruppert 1085586a87e6SChristian Ruppert if (!strlen(name)) { 10867eb6ce2fSRob Herring pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n", 10877eb6ce2fSRob Herring np); 1088586a87e6SChristian Ruppert break; 1089586a87e6SChristian Ruppert } 1090586a87e6SChristian Ruppert 1091586a87e6SChristian Ruppert ret = gpiochip_add_pingroup_range(chip, pctldev, 1092586a87e6SChristian Ruppert pinspec.args[0], name); 1093586a87e6SChristian Ruppert if (ret) 109428355f81STomeu Vizoso return ret; 1095586a87e6SChristian Ruppert } 1096ad4e1a7cSHaojian Zhuang } 109728355f81STomeu Vizoso 109828355f81STomeu Vizoso return 0; 1099f23f1516SShiraz Hashim } 1100f23f1516SShiraz Hashim 1101f23f1516SShiraz Hashim #else 110228355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; } 1103f23f1516SShiraz Hashim #endif 1104f23f1516SShiraz Hashim 110528355f81STomeu Vizoso int of_gpiochip_add(struct gpio_chip *chip) 1106f141ed65SGrant Likely { 1107*8afe8255SAndy Shevchenko struct device_node *np; 1108f0d1ab05SLinus Walleij int ret; 110928355f81STomeu Vizoso 1110*8afe8255SAndy Shevchenko np = to_of_node(chip->fwnode); 1111*8afe8255SAndy Shevchenko if (!np) 111228355f81STomeu Vizoso return 0; 1113f141ed65SGrant Likely 1114f141ed65SGrant Likely if (!chip->of_xlate) { 1115f141ed65SGrant Likely chip->of_gpio_n_cells = 2; 1116f141ed65SGrant Likely chip->of_xlate = of_gpio_simple_xlate; 1117f141ed65SGrant Likely } 1118f141ed65SGrant Likely 11191020dfd1SMasahiro Yamada if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS) 11201020dfd1SMasahiro Yamada return -EINVAL; 11211020dfd1SMasahiro Yamada 1122726cb3baSStephen Boyd of_gpiochip_init_valid_mask(chip); 1123726cb3baSStephen Boyd 1124f0d1ab05SLinus Walleij ret = of_gpiochip_add_pin_range(chip); 1125f0d1ab05SLinus Walleij if (ret) 1126f0d1ab05SLinus Walleij return ret; 112728355f81STomeu Vizoso 1128*8afe8255SAndy Shevchenko fwnode_handle_get(chip->fwnode); 1129f625d460SBenoit Parrot 1130f0d1ab05SLinus Walleij ret = of_gpiochip_scan_gpios(chip); 11312f4133bbSAndy Shevchenko if (ret) 1132*8afe8255SAndy Shevchenko fwnode_handle_put(chip->fwnode); 1133f7299d44SGeert Uytterhoeven 1134f0d1ab05SLinus Walleij return ret; 1135f141ed65SGrant Likely } 1136f141ed65SGrant Likely 1137f141ed65SGrant Likely void of_gpiochip_remove(struct gpio_chip *chip) 1138f141ed65SGrant Likely { 1139*8afe8255SAndy Shevchenko fwnode_handle_put(chip->fwnode); 1140f141ed65SGrant Likely } 11414731210cSSaravana Kannan 11424731210cSSaravana Kannan void of_gpio_dev_init(struct gpio_chip *gc, struct gpio_device *gdev) 11434731210cSSaravana Kannan { 11441df62542SAndy Shevchenko /* Set default OF node to parent's one if present */ 11451df62542SAndy Shevchenko if (gc->parent) 11461df62542SAndy Shevchenko gdev->dev.of_node = gc->parent->of_node; 11471df62542SAndy Shevchenko 1148ac627260SBartosz Golaszewski if (gc->fwnode) 1149ac627260SBartosz Golaszewski gc->of_node = to_of_node(gc->fwnode); 1150ac627260SBartosz Golaszewski 11514731210cSSaravana Kannan /* If the gpiochip has an assigned OF node this takes precedence */ 11524731210cSSaravana Kannan if (gc->of_node) 11534731210cSSaravana Kannan gdev->dev.of_node = gc->of_node; 11544731210cSSaravana Kannan else 11554731210cSSaravana Kannan gc->of_node = gdev->dev.of_node; 11564731210cSSaravana Kannan } 1157