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 88c7e9d398SMasahiro Yamada return chip->gpiodev->dev.of_node == 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 133e6ae9a83SKrzysztof Kozlowski static void of_gpio_flags_quirks(const struct device_node *np, 13489a5e15bSLinus Walleij const char *propname, 1356953c57aSLinus Walleij enum of_gpio_flags *flags, 1366953c57aSLinus Walleij int index) 137a603a2b8SLinus Walleij { 138a603a2b8SLinus Walleij /* 139a603a2b8SLinus Walleij * Some GPIO fixed regulator quirks. 140a603a2b8SLinus Walleij * Note that active low is the default. 141a603a2b8SLinus Walleij */ 142a603a2b8SLinus Walleij if (IS_ENABLED(CONFIG_REGULATOR) && 143906402a4SLinus Walleij (of_device_is_compatible(np, "regulator-fixed") || 144906402a4SLinus Walleij of_device_is_compatible(np, "reg-fixed-voltage") || 145a71a81e7SGeert Uytterhoeven (!(strcmp(propname, "enable-gpio") && 146a71a81e7SGeert Uytterhoeven strcmp(propname, "enable-gpios")) && 147a71a81e7SGeert Uytterhoeven of_device_is_compatible(np, "regulator-gpio")))) { 148228fc010SLucas Stach bool active_low = !of_property_read_bool(np, 149228fc010SLucas Stach "enable-active-high"); 150a603a2b8SLinus Walleij /* 151a603a2b8SLinus Walleij * The regulator GPIO handles are specified such that the 152a603a2b8SLinus Walleij * presence or absence of "enable-active-high" solely controls 153a603a2b8SLinus Walleij * the polarity of the GPIO line. Any phandle flags must 154a603a2b8SLinus Walleij * be actively ignored. 155a603a2b8SLinus Walleij */ 156228fc010SLucas Stach if ((*flags & OF_GPIO_ACTIVE_LOW) && !active_low) { 157a603a2b8SLinus Walleij pr_warn("%s GPIO handle specifies active low - ignored\n", 158a603a2b8SLinus Walleij of_node_full_name(np)); 159a603a2b8SLinus Walleij *flags &= ~OF_GPIO_ACTIVE_LOW; 160a603a2b8SLinus Walleij } 161228fc010SLucas Stach if (active_low) 162a603a2b8SLinus Walleij *flags |= OF_GPIO_ACTIVE_LOW; 163a603a2b8SLinus Walleij } 164a603a2b8SLinus Walleij /* 165a603a2b8SLinus Walleij * Legacy open drain handling for fixed voltage regulators. 166a603a2b8SLinus Walleij */ 167a603a2b8SLinus Walleij if (IS_ENABLED(CONFIG_REGULATOR) && 168a603a2b8SLinus Walleij of_device_is_compatible(np, "reg-fixed-voltage") && 169a603a2b8SLinus Walleij of_property_read_bool(np, "gpio-open-drain")) { 170a603a2b8SLinus Walleij *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN); 171a603a2b8SLinus Walleij pr_info("%s uses legacy open drain flag - update the DTS if you can\n", 172a603a2b8SLinus Walleij of_node_full_name(np)); 173a603a2b8SLinus Walleij } 1746953c57aSLinus Walleij 1756953c57aSLinus Walleij /* 1766953c57aSLinus Walleij * Legacy handling of SPI active high chip select. If we have a 1776953c57aSLinus Walleij * property named "cs-gpios" we need to inspect the child node 1786953c57aSLinus Walleij * to determine if the flags should have inverted semantics. 1796953c57aSLinus Walleij */ 180da7f1349SLinus Walleij if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") && 181a71a81e7SGeert Uytterhoeven of_property_read_bool(np, "cs-gpios")) { 1826953c57aSLinus Walleij struct device_node *child; 1836953c57aSLinus Walleij u32 cs; 1846953c57aSLinus Walleij int ret; 1856953c57aSLinus Walleij 1866953c57aSLinus Walleij for_each_child_of_node(np, child) { 1876953c57aSLinus Walleij ret = of_property_read_u32(child, "reg", &cs); 188c1c04ceaSLinus Walleij if (ret) 1896953c57aSLinus Walleij continue; 1906953c57aSLinus Walleij if (cs == index) { 1916953c57aSLinus Walleij /* 1926953c57aSLinus Walleij * SPI children have active low chip selects 1936953c57aSLinus Walleij * by default. This can be specified negatively 1946953c57aSLinus Walleij * by just omitting "spi-cs-high" in the 1956953c57aSLinus Walleij * device node, or actively by tagging on 1966953c57aSLinus Walleij * GPIO_ACTIVE_LOW as flag in the device 1976953c57aSLinus Walleij * tree. If the line is simultaneously 1986953c57aSLinus Walleij * tagged as active low in the device tree 1996953c57aSLinus Walleij * and has the "spi-cs-high" set, we get a 2006953c57aSLinus Walleij * conflict and the "spi-cs-high" flag will 2016953c57aSLinus Walleij * take precedence. 2026953c57aSLinus Walleij */ 2037ce40277SAndrey Smirnov if (of_property_read_bool(child, "spi-cs-high")) { 2046953c57aSLinus Walleij if (*flags & OF_GPIO_ACTIVE_LOW) { 2056953c57aSLinus Walleij pr_warn("%s GPIO handle specifies active low - ignored\n", 2067ce40277SAndrey Smirnov of_node_full_name(child)); 2076953c57aSLinus Walleij *flags &= ~OF_GPIO_ACTIVE_LOW; 2086953c57aSLinus Walleij } 2096953c57aSLinus Walleij } else { 2106953c57aSLinus Walleij if (!(*flags & OF_GPIO_ACTIVE_LOW)) 2116953c57aSLinus Walleij pr_info("%s enforce active low on chipselect handle\n", 2127ce40277SAndrey Smirnov of_node_full_name(child)); 2136953c57aSLinus Walleij *flags |= OF_GPIO_ACTIVE_LOW; 2146953c57aSLinus Walleij } 21589fea04cSNishka Dasgupta of_node_put(child); 2166953c57aSLinus Walleij break; 2176953c57aSLinus Walleij } 2186953c57aSLinus Walleij } 2196953c57aSLinus Walleij } 220edc1ef3fSMartin Blumenstingl 221edc1ef3fSMartin Blumenstingl /* Legacy handling of stmmac's active-low PHY reset line */ 222edc1ef3fSMartin Blumenstingl if (IS_ENABLED(CONFIG_STMMAC_ETH) && 223edc1ef3fSMartin Blumenstingl !strcmp(propname, "snps,reset-gpio") && 224edc1ef3fSMartin Blumenstingl of_property_read_bool(np, "snps,reset-active-low")) 225edc1ef3fSMartin Blumenstingl *flags |= OF_GPIO_ACTIVE_LOW; 226a603a2b8SLinus Walleij } 227a603a2b8SLinus Walleij 228f141ed65SGrant Likely /** 229af8b6375SAlexandre Courbot * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API 230f141ed65SGrant Likely * @np: device node to get GPIO from 231f141ed65SGrant Likely * @propname: property name containing gpio specifier(s) 232f141ed65SGrant Likely * @index: index of the GPIO 233f141ed65SGrant Likely * @flags: a flags pointer to fill in 234f141ed65SGrant Likely * 235af8b6375SAlexandre Courbot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 236f141ed65SGrant Likely * value on the error condition. If @flags is not NULL the function also fills 237f141ed65SGrant Likely * in flags for the GPIO. 238f141ed65SGrant Likely */ 239e6ae9a83SKrzysztof Kozlowski static struct gpio_desc *of_get_named_gpiod_flags(const struct device_node *np, 240af8b6375SAlexandre Courbot const char *propname, int index, enum of_gpio_flags *flags) 241f141ed65SGrant Likely { 242762c2e46SMasahiro Yamada struct of_phandle_args gpiospec; 243762c2e46SMasahiro Yamada struct gpio_chip *chip; 244762c2e46SMasahiro Yamada struct gpio_desc *desc; 245f141ed65SGrant Likely int ret; 246f141ed65SGrant Likely 247c11e6f0fSStephen Boyd ret = of_parse_phandle_with_args_map(np, propname, "gpio", index, 248762c2e46SMasahiro Yamada &gpiospec); 2493d0f7cf0SGrant Likely if (ret) { 2507eb6ce2fSRob Herring pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n", 2517eb6ce2fSRob Herring __func__, propname, np, index); 252af8b6375SAlexandre Courbot return ERR_PTR(ret); 2533d0f7cf0SGrant Likely } 254f141ed65SGrant Likely 255c7e9d398SMasahiro Yamada chip = of_find_gpiochip_by_xlate(&gpiospec); 256762c2e46SMasahiro Yamada if (!chip) { 257762c2e46SMasahiro Yamada desc = ERR_PTR(-EPROBE_DEFER); 258762c2e46SMasahiro Yamada goto out; 259762c2e46SMasahiro Yamada } 2603d0f7cf0SGrant Likely 26199468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags); 262762c2e46SMasahiro Yamada if (IS_ERR(desc)) 263762c2e46SMasahiro Yamada goto out; 264762c2e46SMasahiro Yamada 265605f2d34SLinus Walleij if (flags) 26689a5e15bSLinus Walleij of_gpio_flags_quirks(np, propname, flags, index); 267a603a2b8SLinus Walleij 2687eb6ce2fSRob Herring pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n", 2697eb6ce2fSRob Herring __func__, propname, np, index, 270762c2e46SMasahiro Yamada PTR_ERR_OR_ZERO(desc)); 271762c2e46SMasahiro Yamada 272762c2e46SMasahiro Yamada out: 273762c2e46SMasahiro Yamada of_node_put(gpiospec.np); 274762c2e46SMasahiro Yamada 275762c2e46SMasahiro Yamada return desc; 276f141ed65SGrant Likely } 277f141ed65SGrant Likely 278e6ae9a83SKrzysztof Kozlowski int of_get_named_gpio_flags(const struct device_node *np, const char *list_name, 279f01d9075SAlexandre Courbot int index, enum of_gpio_flags *flags) 280f01d9075SAlexandre Courbot { 281f01d9075SAlexandre Courbot struct gpio_desc *desc; 282f01d9075SAlexandre Courbot 283f01d9075SAlexandre Courbot desc = of_get_named_gpiod_flags(np, list_name, index, flags); 284f01d9075SAlexandre Courbot 285f01d9075SAlexandre Courbot if (IS_ERR(desc)) 286f01d9075SAlexandre Courbot return PTR_ERR(desc); 287f01d9075SAlexandre Courbot else 288f01d9075SAlexandre Courbot return desc_to_gpio(desc); 289f01d9075SAlexandre Courbot } 2906d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_get_named_gpio_flags); 291f01d9075SAlexandre Courbot 292d9e7f0e3SDmitry Torokhov /* Converts gpio_lookup_flags into bitmask of GPIO_* values */ 293d9e7f0e3SDmitry Torokhov static unsigned long of_convert_gpio_flags(enum of_gpio_flags flags) 294d9e7f0e3SDmitry Torokhov { 295d9e7f0e3SDmitry Torokhov unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 296d9e7f0e3SDmitry Torokhov 297d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_ACTIVE_LOW) 298d9e7f0e3SDmitry Torokhov lflags |= GPIO_ACTIVE_LOW; 299d9e7f0e3SDmitry Torokhov 300d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_SINGLE_ENDED) { 301d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_OPEN_DRAIN) 302d9e7f0e3SDmitry Torokhov lflags |= GPIO_OPEN_DRAIN; 303d9e7f0e3SDmitry Torokhov else 304d9e7f0e3SDmitry Torokhov lflags |= GPIO_OPEN_SOURCE; 305d9e7f0e3SDmitry Torokhov } 306d9e7f0e3SDmitry Torokhov 307d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_TRANSITORY) 308d9e7f0e3SDmitry Torokhov lflags |= GPIO_TRANSITORY; 309d9e7f0e3SDmitry Torokhov 310d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_PULL_UP) 311d9e7f0e3SDmitry Torokhov lflags |= GPIO_PULL_UP; 312d9e7f0e3SDmitry Torokhov 313d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_PULL_DOWN) 314d9e7f0e3SDmitry Torokhov lflags |= GPIO_PULL_DOWN; 315d9e7f0e3SDmitry Torokhov 316d9e7f0e3SDmitry Torokhov if (flags & OF_GPIO_PULL_DISABLE) 317d9e7f0e3SDmitry Torokhov lflags |= GPIO_PULL_DISABLE; 318d9e7f0e3SDmitry Torokhov 319d9e7f0e3SDmitry Torokhov return lflags; 320d9e7f0e3SDmitry Torokhov } 321d9e7f0e3SDmitry Torokhov 322f626d6dfSLinus Walleij /** 323f626d6dfSLinus Walleij * gpiod_get_from_of_node() - obtain a GPIO from an OF node 324f626d6dfSLinus Walleij * @node: handle of the OF node 325f626d6dfSLinus Walleij * @propname: name of the DT property representing the GPIO 326f626d6dfSLinus Walleij * @index: index of the GPIO to obtain for the consumer 327f626d6dfSLinus Walleij * @dflags: GPIO initialization flags 328f626d6dfSLinus Walleij * @label: label to attach to the requested GPIO 329f626d6dfSLinus Walleij * 330f626d6dfSLinus Walleij * Returns: 331f626d6dfSLinus Walleij * On successful request the GPIO pin is configured in accordance with 332f626d6dfSLinus Walleij * provided @dflags. 333f626d6dfSLinus Walleij * 334f626d6dfSLinus Walleij * In case of error an ERR_PTR() is returned. 335f626d6dfSLinus Walleij */ 336e6ae9a83SKrzysztof Kozlowski struct gpio_desc *gpiod_get_from_of_node(const struct device_node *node, 337f626d6dfSLinus Walleij const char *propname, int index, 338f626d6dfSLinus Walleij enum gpiod_flags dflags, 339f626d6dfSLinus Walleij const char *label) 340f626d6dfSLinus Walleij { 341d9e7f0e3SDmitry Torokhov unsigned long lflags; 342f626d6dfSLinus Walleij struct gpio_desc *desc; 343d9e7f0e3SDmitry Torokhov enum of_gpio_flags of_flags; 344f626d6dfSLinus Walleij int ret; 345f626d6dfSLinus Walleij 346d9e7f0e3SDmitry Torokhov desc = of_get_named_gpiod_flags(node, propname, index, &of_flags); 347d9e7f0e3SDmitry Torokhov if (!desc || IS_ERR(desc)) 348f626d6dfSLinus Walleij return desc; 349f626d6dfSLinus Walleij 350f626d6dfSLinus Walleij ret = gpiod_request(desc, label); 351be7ae45cSMarco Felsch if (ret == -EBUSY && (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE)) 352f626d6dfSLinus Walleij return desc; 353f626d6dfSLinus Walleij if (ret) 354f626d6dfSLinus Walleij return ERR_PTR(ret); 355f626d6dfSLinus Walleij 356d9e7f0e3SDmitry Torokhov lflags = of_convert_gpio_flags(of_flags); 35731bea231SNuno Sá 358f626d6dfSLinus Walleij ret = gpiod_configure_flags(desc, propname, lflags, dflags); 359f626d6dfSLinus Walleij if (ret < 0) { 360f626d6dfSLinus Walleij gpiod_put(desc); 361f626d6dfSLinus Walleij return ERR_PTR(ret); 362f626d6dfSLinus Walleij } 363f626d6dfSLinus Walleij 364f626d6dfSLinus Walleij return desc; 365f626d6dfSLinus Walleij } 3666d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(gpiod_get_from_of_node); 367f141ed65SGrant Likely 368b311c5cbSDmitry Torokhov static struct gpio_desc *of_find_gpio_rename(struct device_node *np, 36998c3c940SDmitry Torokhov const char *con_id, 37098c3c940SDmitry Torokhov unsigned int idx, 371c8582339SLinus Walleij enum of_gpio_flags *of_flags) 372c8582339SLinus Walleij { 373b311c5cbSDmitry Torokhov static const struct of_rename_gpio { 374b311c5cbSDmitry Torokhov const char *con_id; 375b311c5cbSDmitry Torokhov const char *legacy_id; /* NULL - same as con_id */ 376b311c5cbSDmitry Torokhov /* 377b311c5cbSDmitry Torokhov * Compatible string can be set to NULL in case where 378b311c5cbSDmitry Torokhov * matching to a particular compatible is not practical, 379b311c5cbSDmitry Torokhov * but it should only be done for gpio names that have 380b311c5cbSDmitry Torokhov * vendor prefix to reduce risk of false positives. 381b311c5cbSDmitry Torokhov * Addition of such entries is strongly discouraged. 382b311c5cbSDmitry Torokhov */ 383b311c5cbSDmitry Torokhov const char *compatible; 384b311c5cbSDmitry Torokhov } gpios[] = { 385fbbbcd17SDmitry Torokhov #if !IS_ENABLED(CONFIG_LCD_HX8357) 386fbbbcd17SDmitry Torokhov /* Himax LCD controllers used "gpios-reset" */ 387fbbbcd17SDmitry Torokhov { "reset", "gpios-reset", "himax,hx8357" }, 388fbbbcd17SDmitry Torokhov { "reset", "gpios-reset", "himax,hx8369" }, 389fbbbcd17SDmitry Torokhov #endif 390b311c5cbSDmitry Torokhov #if IS_ENABLED(CONFIG_MFD_ARIZONA) 391b311c5cbSDmitry Torokhov { "wlf,reset", NULL, NULL }, 392b311c5cbSDmitry Torokhov #endif 3939c2cc717SDmitry Torokhov #if IS_ENABLED(CONFIG_NFC_MRVL_I2C) 3949c2cc717SDmitry Torokhov { "reset", "reset-n-io", "marvell,nfc-i2c" }, 3959c2cc717SDmitry Torokhov #endif 3969c2cc717SDmitry Torokhov #if IS_ENABLED(CONFIG_NFC_MRVL_SPI) 3979c2cc717SDmitry Torokhov { "reset", "reset-n-io", "marvell,nfc-spi" }, 3989c2cc717SDmitry Torokhov #endif 3999c2cc717SDmitry Torokhov #if IS_ENABLED(CONFIG_NFC_MRVL_UART) 4009c2cc717SDmitry Torokhov { "reset", "reset-n-io", "marvell,nfc-uart" }, 4019c2cc717SDmitry Torokhov { "reset", "reset-n-io", "mrvl,nfc-uart" }, 4029c2cc717SDmitry Torokhov #endif 403fbbbcd17SDmitry Torokhov #if !IS_ENABLED(CONFIG_PCI_LANTIQ) 404fbbbcd17SDmitry Torokhov /* MIPS Lantiq PCI */ 405fbbbcd17SDmitry Torokhov { "reset", "gpios-reset", "lantiq,pci-xway" }, 406fbbbcd17SDmitry Torokhov #endif 407307c593bSDmitry Torokhov 408b311c5cbSDmitry Torokhov /* 409b311c5cbSDmitry Torokhov * Some regulator bindings happened before we managed to 410b311c5cbSDmitry Torokhov * establish that GPIO properties should be named 411b311c5cbSDmitry Torokhov * "foo-gpios" so we have this special kludge for them. 412b311c5cbSDmitry Torokhov */ 413307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_REGULATOR_ARIZONA_LDO1) 414b311c5cbSDmitry Torokhov { "wlf,ldoena", NULL, NULL }, /* Arizona */ 415307c593bSDmitry Torokhov #endif 416307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_REGULATOR_WM8994) 417b311c5cbSDmitry Torokhov { "wlf,ldo1ena", NULL, NULL }, /* WM8994 */ 418b311c5cbSDmitry Torokhov { "wlf,ldo2ena", NULL, NULL }, /* WM8994 */ 419b311c5cbSDmitry Torokhov #endif 420c8582339SLinus Walleij 421*944004ebSDmitry Torokhov #if IS_ENABLED(CONFIG_SND_SOC_CS42L56) 422*944004ebSDmitry Torokhov { "reset", "cirrus,gpio-nreset", "cirrus,cs42l56" }, 423*944004ebSDmitry Torokhov #endif 424fbbbcd17SDmitry Torokhov #if IS_ENABLED(CONFIG_SND_SOC_TLV320AIC3X) 425fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3x" }, 426fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic33" }, 427fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3007" }, 428fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3104" }, 429fbbbcd17SDmitry Torokhov { "reset", "gpio-reset", "ti,tlv320aic3106" }, 430fbbbcd17SDmitry Torokhov #endif 431307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_SPI_GPIO) 432c8582339SLinus Walleij /* 433b311c5cbSDmitry Torokhov * The SPI GPIO bindings happened before we managed to 434b311c5cbSDmitry Torokhov * establish that GPIO properties should be named 435b311c5cbSDmitry Torokhov * "foo-gpios" so we have this special kludge for them. 436c8582339SLinus Walleij */ 437b311c5cbSDmitry Torokhov { "miso", "gpio-miso", "spi-gpio" }, 438b311c5cbSDmitry Torokhov { "mosi", "gpio-mosi", "spi-gpio" }, 439b311c5cbSDmitry Torokhov { "sck", "gpio-sck", "spi-gpio" }, 440307c593bSDmitry Torokhov #endif 441c8582339SLinus Walleij 4426a537d48SLinus Walleij /* 443b311c5cbSDmitry Torokhov * The old Freescale bindings use simply "gpios" as name 444b311c5cbSDmitry Torokhov * for the chip select lines rather than "cs-gpios" like 445b311c5cbSDmitry Torokhov * all other SPI hardware. Allow this specifically for 446b311c5cbSDmitry Torokhov * Freescale and PPC devices. 447e3023bf8SLinus Walleij */ 448307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_SPI_FSL_SPI) 449b311c5cbSDmitry Torokhov { "cs", "gpios", "fsl,spi" }, 450b311c5cbSDmitry Torokhov { "cs", "gpios", "aeroflexgaisler,spictrl" }, 451307c593bSDmitry Torokhov #endif 452307c593bSDmitry Torokhov #if IS_ENABLED(CONFIG_SPI_PPC4xx) 453b311c5cbSDmitry Torokhov { "cs", "gpios", "ibm,ppc4xx-spi" }, 454b311c5cbSDmitry Torokhov #endif 455307c593bSDmitry Torokhov 456b311c5cbSDmitry Torokhov #if IS_ENABLED(CONFIG_TYPEC_FUSB302) 457e3023bf8SLinus Walleij /* 458b311c5cbSDmitry Torokhov * Fairchild FUSB302 host is using undocumented "fcs,int_n" 459b311c5cbSDmitry Torokhov * property without the compulsory "-gpios" suffix. 460e3023bf8SLinus Walleij */ 461b311c5cbSDmitry Torokhov { "fcs,int_n", NULL, "fcs,fusb302" }, 462b311c5cbSDmitry Torokhov #endif 4636a537d48SLinus Walleij }; 464b311c5cbSDmitry Torokhov struct gpio_desc *desc; 465b311c5cbSDmitry Torokhov const char *legacy_id; 466b311c5cbSDmitry Torokhov unsigned int i; 4676a537d48SLinus Walleij 4686a537d48SLinus Walleij if (!con_id) 4696a537d48SLinus Walleij return ERR_PTR(-ENOENT); 4706a537d48SLinus Walleij 471b311c5cbSDmitry Torokhov for (i = 0; i < ARRAY_SIZE(gpios); i++) { 472b311c5cbSDmitry Torokhov if (strcmp(con_id, gpios[i].con_id)) 473b311c5cbSDmitry Torokhov continue; 4746a537d48SLinus Walleij 475b311c5cbSDmitry Torokhov if (gpios[i].compatible && 476b311c5cbSDmitry Torokhov !of_device_is_compatible(np, gpios[i].compatible)) 477b311c5cbSDmitry Torokhov continue; 478b311c5cbSDmitry Torokhov 479b311c5cbSDmitry Torokhov legacy_id = gpios[i].legacy_id ?: gpios[i].con_id; 480b311c5cbSDmitry Torokhov desc = of_get_named_gpiod_flags(np, legacy_id, idx, of_flags); 481b311c5cbSDmitry Torokhov if (!gpiod_not_found(desc)) { 482b311c5cbSDmitry Torokhov pr_info("%s uses legacy gpio name '%s' instead of '%s-gpios'\n", 483b311c5cbSDmitry Torokhov of_node_full_name(np), legacy_id, con_id); 484b311c5cbSDmitry Torokhov return desc; 485b311c5cbSDmitry Torokhov } 4866a537d48SLinus Walleij } 4876a537d48SLinus Walleij 48811c43bb0SDmitry Torokhov return ERR_PTR(-ENOENT); 4896e24826dSLinus Walleij } 4906e24826dSLinus Walleij 491326c3753SDmitry Torokhov static struct gpio_desc *of_find_mt2701_gpio(struct device_node *np, 492326c3753SDmitry Torokhov const char *con_id, 493326c3753SDmitry Torokhov unsigned int idx, 494326c3753SDmitry Torokhov enum of_gpio_flags *of_flags) 495326c3753SDmitry Torokhov { 496326c3753SDmitry Torokhov struct gpio_desc *desc; 497326c3753SDmitry Torokhov const char *legacy_id; 498326c3753SDmitry Torokhov 499326c3753SDmitry Torokhov if (!IS_ENABLED(CONFIG_SND_SOC_MT2701_CS42448)) 500326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 501326c3753SDmitry Torokhov 502326c3753SDmitry Torokhov if (!of_device_is_compatible(np, "mediatek,mt2701-cs42448-machine")) 503326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 504326c3753SDmitry Torokhov 505326c3753SDmitry Torokhov if (!con_id || strcmp(con_id, "i2s1-in-sel")) 506326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 507326c3753SDmitry Torokhov 508326c3753SDmitry Torokhov if (idx == 0) 509326c3753SDmitry Torokhov legacy_id = "i2s1-in-sel-gpio1"; 510326c3753SDmitry Torokhov else if (idx == 1) 511326c3753SDmitry Torokhov legacy_id = "i2s1-in-sel-gpio2"; 512326c3753SDmitry Torokhov else 513326c3753SDmitry Torokhov return ERR_PTR(-ENOENT); 514326c3753SDmitry Torokhov 515326c3753SDmitry Torokhov desc = of_get_named_gpiod_flags(np, legacy_id, 0, of_flags); 516326c3753SDmitry Torokhov if (!gpiod_not_found(desc)) 517326c3753SDmitry Torokhov pr_info("%s is using legacy gpio name '%s' instead of '%s-gpios'\n", 518326c3753SDmitry Torokhov of_node_full_name(np), legacy_id, con_id); 519326c3753SDmitry Torokhov 520326c3753SDmitry Torokhov return desc; 521326c3753SDmitry Torokhov } 522326c3753SDmitry Torokhov 523a2b5e207SDmitry Torokhov typedef struct gpio_desc *(*of_find_gpio_quirk)(struct device_node *np, 524a2b5e207SDmitry Torokhov const char *con_id, 525a2b5e207SDmitry Torokhov unsigned int idx, 526a2b5e207SDmitry Torokhov enum of_gpio_flags *of_flags); 527a2b5e207SDmitry Torokhov static const of_find_gpio_quirk of_find_gpio_quirks[] = { 528b311c5cbSDmitry Torokhov of_find_gpio_rename, 529326c3753SDmitry Torokhov of_find_mt2701_gpio, 5308b10ca2fSMichael Walle NULL 531a2b5e207SDmitry Torokhov }; 532a2b5e207SDmitry Torokhov 533ea713bc4SLinus Walleij struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id, 534fed7026aSAndy Shevchenko unsigned int idx, unsigned long *flags) 535ea713bc4SLinus Walleij { 536ea713bc4SLinus Walleij char prop_name[32]; /* 32 is max size of property name */ 537ea713bc4SLinus Walleij enum of_gpio_flags of_flags; 538a2b5e207SDmitry Torokhov const of_find_gpio_quirk *q; 539ea713bc4SLinus Walleij struct gpio_desc *desc; 540ea713bc4SLinus Walleij unsigned int i; 541ea713bc4SLinus Walleij 542c8582339SLinus Walleij /* Try GPIO property "foo-gpios" and "foo-gpio" */ 543ea713bc4SLinus Walleij for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { 544ea713bc4SLinus Walleij if (con_id) 545ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id, 546ea713bc4SLinus Walleij gpio_suffixes[i]); 547ea713bc4SLinus Walleij else 548ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s", 549ea713bc4SLinus Walleij gpio_suffixes[i]); 550ea713bc4SLinus Walleij 551ea713bc4SLinus Walleij desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx, 552ea713bc4SLinus Walleij &of_flags); 5536662ae6aSMaxime Ripard 5547b58696dSAndy Shevchenko if (!gpiod_not_found(desc)) 555ea713bc4SLinus Walleij break; 556ea713bc4SLinus Walleij } 557ea713bc4SLinus Walleij 558a2b5e207SDmitry Torokhov /* Properly named GPIO was not found, try workarounds */ 559a2b5e207SDmitry Torokhov for (q = of_find_gpio_quirks; gpiod_not_found(desc) && *q; q++) 560a2b5e207SDmitry Torokhov desc = (*q)(dev->of_node, con_id, idx, &of_flags); 5616e24826dSLinus Walleij 562ea713bc4SLinus Walleij if (IS_ERR(desc)) 563ea713bc4SLinus Walleij return desc; 564ea713bc4SLinus Walleij 565d9e7f0e3SDmitry Torokhov *flags = of_convert_gpio_flags(of_flags); 566d449991cSThomas Petazzoni 567ea713bc4SLinus Walleij return desc; 568ea713bc4SLinus Walleij } 569ea713bc4SLinus Walleij 570f141ed65SGrant Likely /** 571fd7337fdSMarkus Pargmann * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API 572f625d460SBenoit Parrot * @np: device node to get GPIO from 573be715343SMasahiro Yamada * @chip: GPIO chip whose hog is parsed 574a79fead5SGeert Uytterhoeven * @idx: Index of the GPIO to parse 575f625d460SBenoit Parrot * @name: GPIO line name 576fed7026aSAndy Shevchenko * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from 577fed7026aSAndy Shevchenko * of_find_gpio() or of_parse_own_gpio() 578f625d460SBenoit Parrot * @dflags: gpiod_flags - optional GPIO initialization flags 579f625d460SBenoit Parrot * 580f625d460SBenoit Parrot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 581f625d460SBenoit Parrot * value on the error condition. 582f625d460SBenoit Parrot */ 583fd7337fdSMarkus Pargmann static struct gpio_desc *of_parse_own_gpio(struct device_node *np, 584be715343SMasahiro Yamada struct gpio_chip *chip, 585a79fead5SGeert Uytterhoeven unsigned int idx, const char **name, 586fed7026aSAndy Shevchenko unsigned long *lflags, 587f625d460SBenoit Parrot enum gpiod_flags *dflags) 588f625d460SBenoit Parrot { 589f625d460SBenoit Parrot struct device_node *chip_np; 590f625d460SBenoit Parrot enum of_gpio_flags xlate_flags; 591be715343SMasahiro Yamada struct of_phandle_args gpiospec; 592be715343SMasahiro Yamada struct gpio_desc *desc; 593a79fead5SGeert Uytterhoeven unsigned int i; 594f625d460SBenoit Parrot u32 tmp; 5953f9547e1SMasahiro Yamada int ret; 596f625d460SBenoit Parrot 597be715343SMasahiro Yamada chip_np = chip->of_node; 598f625d460SBenoit Parrot if (!chip_np) 599f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 600f625d460SBenoit Parrot 601f625d460SBenoit Parrot xlate_flags = 0; 6022d6c06f5SAndy Shevchenko *lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 60340941954SAndy Shevchenko *dflags = GPIOD_ASIS; 604f625d460SBenoit Parrot 605f625d460SBenoit Parrot ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp); 606f625d460SBenoit Parrot if (ret) 607f625d460SBenoit Parrot return ERR_PTR(ret); 608f625d460SBenoit Parrot 609be715343SMasahiro Yamada gpiospec.np = chip_np; 610be715343SMasahiro Yamada gpiospec.args_count = tmp; 611f625d460SBenoit Parrot 612a79fead5SGeert Uytterhoeven for (i = 0; i < tmp; i++) { 613a79fead5SGeert Uytterhoeven ret = of_property_read_u32_index(np, "gpios", idx * tmp + i, 614a79fead5SGeert Uytterhoeven &gpiospec.args[i]); 615f625d460SBenoit Parrot if (ret) 616f625d460SBenoit Parrot return ERR_PTR(ret); 617a79fead5SGeert Uytterhoeven } 618f625d460SBenoit Parrot 61999468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags); 620be715343SMasahiro Yamada if (IS_ERR(desc)) 621be715343SMasahiro Yamada return desc; 622f625d460SBenoit Parrot 623d9e7f0e3SDmitry Torokhov *lflags = of_convert_gpio_flags(xlate_flags); 624f625d460SBenoit Parrot 625f625d460SBenoit Parrot if (of_property_read_bool(np, "input")) 626f625d460SBenoit Parrot *dflags |= GPIOD_IN; 627f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-low")) 628f625d460SBenoit Parrot *dflags |= GPIOD_OUT_LOW; 629f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-high")) 630f625d460SBenoit Parrot *dflags |= GPIOD_OUT_HIGH; 631f625d460SBenoit Parrot else { 63262cdcb6cSRob Herring pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n", 63362cdcb6cSRob Herring desc_to_gpio(desc), np); 634f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 635f625d460SBenoit Parrot } 636f625d460SBenoit Parrot 637f625d460SBenoit Parrot if (name && of_property_read_string(np, "line-name", name)) 638f625d460SBenoit Parrot *name = np->name; 639f625d460SBenoit Parrot 640be715343SMasahiro Yamada return desc; 641f625d460SBenoit Parrot } 642f625d460SBenoit Parrot 643f625d460SBenoit Parrot /** 644bc21077eSGeert Uytterhoeven * of_gpiochip_add_hog - Add all hogs in a hog device node 645bc21077eSGeert Uytterhoeven * @chip: gpio chip to act on 646bc21077eSGeert Uytterhoeven * @hog: device node describing the hogs 647bc21077eSGeert Uytterhoeven * 648bc21077eSGeert Uytterhoeven * Returns error if it fails otherwise 0 on success. 649bc21077eSGeert Uytterhoeven */ 650bc21077eSGeert Uytterhoeven static int of_gpiochip_add_hog(struct gpio_chip *chip, struct device_node *hog) 651bc21077eSGeert Uytterhoeven { 652bc21077eSGeert Uytterhoeven enum gpiod_flags dflags; 653bc21077eSGeert Uytterhoeven struct gpio_desc *desc; 654bc21077eSGeert Uytterhoeven unsigned long lflags; 655bc21077eSGeert Uytterhoeven const char *name; 656bc21077eSGeert Uytterhoeven unsigned int i; 657bc21077eSGeert Uytterhoeven int ret; 658bc21077eSGeert Uytterhoeven 659bc21077eSGeert Uytterhoeven for (i = 0;; i++) { 660bc21077eSGeert Uytterhoeven desc = of_parse_own_gpio(hog, chip, i, &name, &lflags, &dflags); 661bc21077eSGeert Uytterhoeven if (IS_ERR(desc)) 662bc21077eSGeert Uytterhoeven break; 663bc21077eSGeert Uytterhoeven 664bc21077eSGeert Uytterhoeven ret = gpiod_hog(desc, name, lflags, dflags); 665bc21077eSGeert Uytterhoeven if (ret < 0) 666bc21077eSGeert Uytterhoeven return ret; 66763636d95SGeert Uytterhoeven 66863636d95SGeert Uytterhoeven #ifdef CONFIG_OF_DYNAMIC 66963636d95SGeert Uytterhoeven desc->hog = hog; 67063636d95SGeert Uytterhoeven #endif 671bc21077eSGeert Uytterhoeven } 672bc21077eSGeert Uytterhoeven 673bc21077eSGeert Uytterhoeven return 0; 674bc21077eSGeert Uytterhoeven } 675bc21077eSGeert Uytterhoeven 676bc21077eSGeert Uytterhoeven /** 677fd7337fdSMarkus Pargmann * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions 678f625d460SBenoit Parrot * @chip: gpio chip to act on 679f625d460SBenoit Parrot * 680f625d460SBenoit Parrot * This is only used by of_gpiochip_add to request/set GPIO initial 681f625d460SBenoit Parrot * configuration. 682ead066e6SGeert Uytterhoeven * It returns error if it fails otherwise 0 on success. 683f625d460SBenoit Parrot */ 684dfbd379bSLaxman Dewangan static int of_gpiochip_scan_gpios(struct gpio_chip *chip) 685f625d460SBenoit Parrot { 686f625d460SBenoit Parrot struct device_node *np; 687dfbd379bSLaxman Dewangan int ret; 688f625d460SBenoit Parrot 689d1279d94SLaxman Dewangan for_each_available_child_of_node(chip->of_node, np) { 690f625d460SBenoit Parrot if (!of_property_read_bool(np, "gpio-hog")) 691f625d460SBenoit Parrot continue; 692f625d460SBenoit Parrot 693bc21077eSGeert Uytterhoeven ret = of_gpiochip_add_hog(chip, np); 69409e258afSWei Yongjun if (ret < 0) { 69509e258afSWei Yongjun of_node_put(np); 696dfbd379bSLaxman Dewangan return ret; 697f625d460SBenoit Parrot } 69863636d95SGeert Uytterhoeven 69963636d95SGeert Uytterhoeven of_node_set_flag(np, OF_POPULATED); 70009e258afSWei Yongjun } 701dfbd379bSLaxman Dewangan 702dfbd379bSLaxman Dewangan return 0; 703f625d460SBenoit Parrot } 704f625d460SBenoit Parrot 70563636d95SGeert Uytterhoeven #ifdef CONFIG_OF_DYNAMIC 70663636d95SGeert Uytterhoeven /** 70763636d95SGeert Uytterhoeven * of_gpiochip_remove_hog - Remove all hogs in a hog device node 70863636d95SGeert Uytterhoeven * @chip: gpio chip to act on 70963636d95SGeert Uytterhoeven * @hog: device node describing the hogs 71063636d95SGeert Uytterhoeven */ 71163636d95SGeert Uytterhoeven static void of_gpiochip_remove_hog(struct gpio_chip *chip, 71263636d95SGeert Uytterhoeven struct device_node *hog) 71363636d95SGeert Uytterhoeven { 71480c78fbeSAndy Shevchenko struct gpio_desc *desc; 71563636d95SGeert Uytterhoeven 71657017eddSAndy Shevchenko for_each_gpio_desc_with_flag(chip, desc, FLAG_IS_HOGGED) 71780c78fbeSAndy Shevchenko if (desc->hog == hog) 71880c78fbeSAndy Shevchenko gpiochip_free_own_desc(desc); 71963636d95SGeert Uytterhoeven } 72063636d95SGeert Uytterhoeven 72163636d95SGeert Uytterhoeven static int of_gpiochip_match_node(struct gpio_chip *chip, void *data) 72263636d95SGeert Uytterhoeven { 723597a8a88SAndy Shevchenko return device_match_of_node(&chip->gpiodev->dev, data); 72463636d95SGeert Uytterhoeven } 72563636d95SGeert Uytterhoeven 72663636d95SGeert Uytterhoeven static struct gpio_chip *of_find_gpiochip_by_node(struct device_node *np) 72763636d95SGeert Uytterhoeven { 72863636d95SGeert Uytterhoeven return gpiochip_find(np, of_gpiochip_match_node); 72963636d95SGeert Uytterhoeven } 73063636d95SGeert Uytterhoeven 73163636d95SGeert Uytterhoeven static int of_gpio_notify(struct notifier_block *nb, unsigned long action, 73263636d95SGeert Uytterhoeven void *arg) 73363636d95SGeert Uytterhoeven { 73463636d95SGeert Uytterhoeven struct of_reconfig_data *rd = arg; 73563636d95SGeert Uytterhoeven struct gpio_chip *chip; 73663636d95SGeert Uytterhoeven int ret; 73763636d95SGeert Uytterhoeven 73863636d95SGeert Uytterhoeven /* 73963636d95SGeert Uytterhoeven * This only supports adding and removing complete gpio-hog nodes. 74063636d95SGeert Uytterhoeven * Modifying an existing gpio-hog node is not supported (except for 74163636d95SGeert Uytterhoeven * changing its "status" property, which is treated the same as 74263636d95SGeert Uytterhoeven * addition/removal). 74363636d95SGeert Uytterhoeven */ 74463636d95SGeert Uytterhoeven switch (of_reconfig_get_state_change(action, arg)) { 74563636d95SGeert Uytterhoeven case OF_RECONFIG_CHANGE_ADD: 74663636d95SGeert Uytterhoeven if (!of_property_read_bool(rd->dn, "gpio-hog")) 74763636d95SGeert Uytterhoeven return NOTIFY_OK; /* not for us */ 74863636d95SGeert Uytterhoeven 74963636d95SGeert Uytterhoeven if (of_node_test_and_set_flag(rd->dn, OF_POPULATED)) 75063636d95SGeert Uytterhoeven return NOTIFY_OK; 75163636d95SGeert Uytterhoeven 75263636d95SGeert Uytterhoeven chip = of_find_gpiochip_by_node(rd->dn->parent); 75363636d95SGeert Uytterhoeven if (chip == NULL) 75463636d95SGeert Uytterhoeven return NOTIFY_OK; /* not for us */ 75563636d95SGeert Uytterhoeven 75663636d95SGeert Uytterhoeven ret = of_gpiochip_add_hog(chip, rd->dn); 75763636d95SGeert Uytterhoeven if (ret < 0) { 75863636d95SGeert Uytterhoeven pr_err("%s: failed to add hogs for %pOF\n", __func__, 75963636d95SGeert Uytterhoeven rd->dn); 76063636d95SGeert Uytterhoeven of_node_clear_flag(rd->dn, OF_POPULATED); 76163636d95SGeert Uytterhoeven return notifier_from_errno(ret); 76263636d95SGeert Uytterhoeven } 76363636d95SGeert Uytterhoeven break; 76463636d95SGeert Uytterhoeven 76563636d95SGeert Uytterhoeven case OF_RECONFIG_CHANGE_REMOVE: 76663636d95SGeert Uytterhoeven if (!of_node_check_flag(rd->dn, OF_POPULATED)) 76763636d95SGeert Uytterhoeven return NOTIFY_OK; /* already depopulated */ 76863636d95SGeert Uytterhoeven 76963636d95SGeert Uytterhoeven chip = of_find_gpiochip_by_node(rd->dn->parent); 77063636d95SGeert Uytterhoeven if (chip == NULL) 77163636d95SGeert Uytterhoeven return NOTIFY_OK; /* not for us */ 77263636d95SGeert Uytterhoeven 77363636d95SGeert Uytterhoeven of_gpiochip_remove_hog(chip, rd->dn); 77463636d95SGeert Uytterhoeven of_node_clear_flag(rd->dn, OF_POPULATED); 77563636d95SGeert Uytterhoeven break; 77663636d95SGeert Uytterhoeven } 77763636d95SGeert Uytterhoeven 77863636d95SGeert Uytterhoeven return NOTIFY_OK; 77963636d95SGeert Uytterhoeven } 78063636d95SGeert Uytterhoeven 78163636d95SGeert Uytterhoeven struct notifier_block gpio_of_notifier = { 78263636d95SGeert Uytterhoeven .notifier_call = of_gpio_notify, 78363636d95SGeert Uytterhoeven }; 78463636d95SGeert Uytterhoeven #endif /* CONFIG_OF_DYNAMIC */ 78563636d95SGeert Uytterhoeven 786f625d460SBenoit Parrot /** 78767049c50SThierry Reding * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags 788f141ed65SGrant Likely * @gc: pointer to the gpio_chip structure 78967049c50SThierry Reding * @gpiospec: GPIO specifier as found in the device tree 790f141ed65SGrant Likely * @flags: a flags pointer to fill in 791f141ed65SGrant Likely * 792f141ed65SGrant Likely * This is simple translation function, suitable for the most 1:1 mapped 79367049c50SThierry Reding * GPIO chips. This function performs only one sanity check: whether GPIO 794f141ed65SGrant Likely * is less than ngpios (that is specified in the gpio_chip). 795f141ed65SGrant Likely */ 796b0c7e73bSGeert Uytterhoeven static int of_gpio_simple_xlate(struct gpio_chip *gc, 797b0c7e73bSGeert Uytterhoeven const struct of_phandle_args *gpiospec, 798b0c7e73bSGeert Uytterhoeven u32 *flags) 799f141ed65SGrant Likely { 800f141ed65SGrant Likely /* 801f141ed65SGrant Likely * We're discouraging gpio_cells < 2, since that way you'll have to 80220a8a968SColin Cronin * write your own xlate function (that will have to retrieve the GPIO 803f141ed65SGrant Likely * number and the flags from a single gpio cell -- this is possible, 804f141ed65SGrant Likely * but not recommended). 805f141ed65SGrant Likely */ 806f141ed65SGrant Likely if (gc->of_gpio_n_cells < 2) { 807f141ed65SGrant Likely WARN_ON(1); 808f141ed65SGrant Likely return -EINVAL; 809f141ed65SGrant Likely } 810f141ed65SGrant Likely 811f141ed65SGrant Likely if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells)) 812f141ed65SGrant Likely return -EINVAL; 813f141ed65SGrant Likely 8147b96c686SGrant Likely if (gpiospec->args[0] >= gc->ngpio) 815f141ed65SGrant Likely return -EINVAL; 816f141ed65SGrant Likely 817f141ed65SGrant Likely if (flags) 818f141ed65SGrant Likely *flags = gpiospec->args[1]; 819f141ed65SGrant Likely 820f141ed65SGrant Likely return gpiospec->args[0]; 821f141ed65SGrant Likely } 822f141ed65SGrant Likely 823f141ed65SGrant Likely /** 8243208b0f0SLinus Walleij * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank) 825f141ed65SGrant Likely * @np: device node of the GPIO chip 826f141ed65SGrant Likely * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 8273208b0f0SLinus Walleij * @data: driver data to store in the struct gpio_chip 828f141ed65SGrant Likely * 829f141ed65SGrant Likely * To use this function you should allocate and fill mm_gc with: 830f141ed65SGrant Likely * 831f141ed65SGrant Likely * 1) In the gpio_chip structure: 832f141ed65SGrant Likely * - all the callbacks 833f141ed65SGrant Likely * - of_gpio_n_cells 834f141ed65SGrant Likely * - of_xlate callback (optional) 835f141ed65SGrant Likely * 836f141ed65SGrant Likely * 3) In the of_mm_gpio_chip structure: 837f141ed65SGrant Likely * - save_regs callback (optional) 838f141ed65SGrant Likely * 839f141ed65SGrant Likely * If succeeded, this function will map bank's memory and will 840f141ed65SGrant Likely * do all necessary work for you. Then you'll able to use .regs 841f141ed65SGrant Likely * to manage GPIOs from the callbacks. 842f141ed65SGrant Likely */ 8433208b0f0SLinus Walleij int of_mm_gpiochip_add_data(struct device_node *np, 8443208b0f0SLinus Walleij struct of_mm_gpio_chip *mm_gc, 8453208b0f0SLinus Walleij void *data) 846f141ed65SGrant Likely { 847f141ed65SGrant Likely int ret = -ENOMEM; 848f141ed65SGrant Likely struct gpio_chip *gc = &mm_gc->gc; 849f141ed65SGrant Likely 8507eb6ce2fSRob Herring gc->label = kasprintf(GFP_KERNEL, "%pOF", np); 851f141ed65SGrant Likely if (!gc->label) 852f141ed65SGrant Likely goto err0; 853f141ed65SGrant Likely 854f141ed65SGrant Likely mm_gc->regs = of_iomap(np, 0); 855f141ed65SGrant Likely if (!mm_gc->regs) 856f141ed65SGrant Likely goto err1; 857f141ed65SGrant Likely 858f141ed65SGrant Likely gc->base = -1; 859f141ed65SGrant Likely 860f141ed65SGrant Likely if (mm_gc->save_regs) 861f141ed65SGrant Likely mm_gc->save_regs(mm_gc); 862f141ed65SGrant Likely 8635d07a692SLiang He of_node_put(mm_gc->gc.of_node); 8645d07a692SLiang He mm_gc->gc.of_node = of_node_get(np); 865f141ed65SGrant Likely 8663208b0f0SLinus Walleij ret = gpiochip_add_data(gc, data); 867f141ed65SGrant Likely if (ret) 868f141ed65SGrant Likely goto err2; 869f141ed65SGrant Likely 870f141ed65SGrant Likely return 0; 871f141ed65SGrant Likely err2: 8725d07a692SLiang He of_node_put(np); 873f141ed65SGrant Likely iounmap(mm_gc->regs); 874f141ed65SGrant Likely err1: 875f141ed65SGrant Likely kfree(gc->label); 876f141ed65SGrant Likely err0: 8777eb6ce2fSRob Herring pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret); 878f141ed65SGrant Likely return ret; 879f141ed65SGrant Likely } 8806d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data); 881f141ed65SGrant Likely 882d621e8baSRicardo Ribalda Delgado /** 883d621e8baSRicardo Ribalda Delgado * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank) 884d621e8baSRicardo Ribalda Delgado * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 885d621e8baSRicardo Ribalda Delgado */ 886d621e8baSRicardo Ribalda Delgado void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc) 887d621e8baSRicardo Ribalda Delgado { 888d621e8baSRicardo Ribalda Delgado struct gpio_chip *gc = &mm_gc->gc; 889d621e8baSRicardo Ribalda Delgado 890d621e8baSRicardo Ribalda Delgado if (!mm_gc) 891d621e8baSRicardo Ribalda Delgado return; 892d621e8baSRicardo Ribalda Delgado 893d621e8baSRicardo Ribalda Delgado gpiochip_remove(gc); 894d621e8baSRicardo Ribalda Delgado iounmap(mm_gc->regs); 895d621e8baSRicardo Ribalda Delgado kfree(gc->label); 896d621e8baSRicardo Ribalda Delgado } 8976d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove); 898d621e8baSRicardo Ribalda Delgado 899726cb3baSStephen Boyd static void of_gpiochip_init_valid_mask(struct gpio_chip *chip) 900726cb3baSStephen Boyd { 901726cb3baSStephen Boyd int len, i; 902726cb3baSStephen Boyd u32 start, count; 903726cb3baSStephen Boyd struct device_node *np = chip->of_node; 904726cb3baSStephen Boyd 905726cb3baSStephen Boyd len = of_property_count_u32_elems(np, "gpio-reserved-ranges"); 906726cb3baSStephen Boyd if (len < 0 || len % 2 != 0) 907726cb3baSStephen Boyd return; 908726cb3baSStephen Boyd 909726cb3baSStephen Boyd for (i = 0; i < len; i += 2) { 910726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 911726cb3baSStephen Boyd i, &start); 912726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 913726cb3baSStephen Boyd i + 1, &count); 914e75f88efSAndrei Lalaev if (start >= chip->ngpio || start + count > chip->ngpio) 915726cb3baSStephen Boyd continue; 916726cb3baSStephen Boyd 917726cb3baSStephen Boyd bitmap_clear(chip->valid_mask, start, count); 918726cb3baSStephen Boyd } 919726cb3baSStephen Boyd }; 920726cb3baSStephen Boyd 921f23f1516SShiraz Hashim #ifdef CONFIG_PINCTRL 92228355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) 923f23f1516SShiraz Hashim { 924f23f1516SShiraz Hashim struct device_node *np = chip->of_node; 925f23f1516SShiraz Hashim struct of_phandle_args pinspec; 9261e63d7b9SLinus Walleij struct pinctrl_dev *pctldev; 927f23f1516SShiraz Hashim int index = 0, ret; 928586a87e6SChristian Ruppert const char *name; 929586a87e6SChristian Ruppert static const char group_names_propname[] = "gpio-ranges-group-names"; 930586a87e6SChristian Ruppert struct property *group_names; 931f23f1516SShiraz Hashim 932f23f1516SShiraz Hashim if (!np) 93328355f81STomeu Vizoso return 0; 934f23f1516SShiraz Hashim 9353550bba2SStefan Wahren if (!of_property_read_bool(np, "gpio-ranges") && 9363550bba2SStefan Wahren chip->of_gpio_ranges_fallback) { 9373550bba2SStefan Wahren return chip->of_gpio_ranges_fallback(chip, np); 9383550bba2SStefan Wahren } 9393550bba2SStefan Wahren 940586a87e6SChristian Ruppert group_names = of_find_property(np, group_names_propname, NULL); 941586a87e6SChristian Ruppert 942ad4e1a7cSHaojian Zhuang for (;; index++) { 943d9fe0039SStephen Warren ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 944d9fe0039SStephen Warren index, &pinspec); 945f23f1516SShiraz Hashim if (ret) 946f23f1516SShiraz Hashim break; 947f23f1516SShiraz Hashim 9481e63d7b9SLinus Walleij pctldev = of_pinctrl_get(pinspec.np); 949602cf638SMasahiro Yamada of_node_put(pinspec.np); 9501e63d7b9SLinus Walleij if (!pctldev) 95128355f81STomeu Vizoso return -EPROBE_DEFER; 952f23f1516SShiraz Hashim 953586a87e6SChristian Ruppert if (pinspec.args[2]) { 954586a87e6SChristian Ruppert if (group_names) { 95572858602SLaurent Navet of_property_read_string_index(np, 956586a87e6SChristian Ruppert group_names_propname, 957586a87e6SChristian Ruppert index, &name); 958586a87e6SChristian Ruppert if (strlen(name)) { 9597eb6ce2fSRob Herring pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n", 9607eb6ce2fSRob Herring np); 961586a87e6SChristian Ruppert break; 962586a87e6SChristian Ruppert } 963586a87e6SChristian Ruppert } 964586a87e6SChristian Ruppert /* npins != 0: linear range */ 9651e63d7b9SLinus Walleij ret = gpiochip_add_pin_range(chip, 966ef5e3eefSHaojian Zhuang pinctrl_dev_get_devname(pctldev), 9671e63d7b9SLinus Walleij pinspec.args[0], 96886853c83SHaojian Zhuang pinspec.args[1], 96986853c83SHaojian Zhuang pinspec.args[2]); 9701e63d7b9SLinus Walleij if (ret) 97128355f81STomeu Vizoso return ret; 972586a87e6SChristian Ruppert } else { 973586a87e6SChristian Ruppert /* npins == 0: special range */ 974586a87e6SChristian Ruppert if (pinspec.args[1]) { 9757eb6ce2fSRob Herring pr_err("%pOF: Illegal gpio-range format.\n", 9767eb6ce2fSRob Herring np); 977586a87e6SChristian Ruppert break; 978586a87e6SChristian Ruppert } 979586a87e6SChristian Ruppert 980586a87e6SChristian Ruppert if (!group_names) { 9817eb6ce2fSRob Herring pr_err("%pOF: GPIO group range requested but no %s property.\n", 9827eb6ce2fSRob Herring np, group_names_propname); 983586a87e6SChristian Ruppert break; 984586a87e6SChristian Ruppert } 985586a87e6SChristian Ruppert 986586a87e6SChristian Ruppert ret = of_property_read_string_index(np, 987586a87e6SChristian Ruppert group_names_propname, 988586a87e6SChristian Ruppert index, &name); 989586a87e6SChristian Ruppert if (ret) 990586a87e6SChristian Ruppert break; 991586a87e6SChristian Ruppert 992586a87e6SChristian Ruppert if (!strlen(name)) { 9937eb6ce2fSRob Herring pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n", 9947eb6ce2fSRob Herring np); 995586a87e6SChristian Ruppert break; 996586a87e6SChristian Ruppert } 997586a87e6SChristian Ruppert 998586a87e6SChristian Ruppert ret = gpiochip_add_pingroup_range(chip, pctldev, 999586a87e6SChristian Ruppert pinspec.args[0], name); 1000586a87e6SChristian Ruppert if (ret) 100128355f81STomeu Vizoso return ret; 1002586a87e6SChristian Ruppert } 1003ad4e1a7cSHaojian Zhuang } 100428355f81STomeu Vizoso 100528355f81STomeu Vizoso return 0; 1006f23f1516SShiraz Hashim } 1007f23f1516SShiraz Hashim 1008f23f1516SShiraz Hashim #else 100928355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; } 1010f23f1516SShiraz Hashim #endif 1011f23f1516SShiraz Hashim 101228355f81STomeu Vizoso int of_gpiochip_add(struct gpio_chip *chip) 1013f141ed65SGrant Likely { 1014f0d1ab05SLinus Walleij int ret; 101528355f81STomeu Vizoso 1016f141ed65SGrant Likely if (!chip->of_node) 101728355f81STomeu Vizoso return 0; 1018f141ed65SGrant Likely 1019f141ed65SGrant Likely if (!chip->of_xlate) { 1020f141ed65SGrant Likely chip->of_gpio_n_cells = 2; 1021f141ed65SGrant Likely chip->of_xlate = of_gpio_simple_xlate; 1022f141ed65SGrant Likely } 1023f141ed65SGrant Likely 10241020dfd1SMasahiro Yamada if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS) 10251020dfd1SMasahiro Yamada return -EINVAL; 10261020dfd1SMasahiro Yamada 1027726cb3baSStephen Boyd of_gpiochip_init_valid_mask(chip); 1028726cb3baSStephen Boyd 1029f0d1ab05SLinus Walleij ret = of_gpiochip_add_pin_range(chip); 1030f0d1ab05SLinus Walleij if (ret) 1031f0d1ab05SLinus Walleij return ret; 103228355f81STomeu Vizoso 1033f141ed65SGrant Likely of_node_get(chip->of_node); 1034f625d460SBenoit Parrot 1035f0d1ab05SLinus Walleij ret = of_gpiochip_scan_gpios(chip); 10362f4133bbSAndy Shevchenko if (ret) 1037f7299d44SGeert Uytterhoeven of_node_put(chip->of_node); 1038f7299d44SGeert Uytterhoeven 1039f0d1ab05SLinus Walleij return ret; 1040f141ed65SGrant Likely } 1041f141ed65SGrant Likely 1042f141ed65SGrant Likely void of_gpiochip_remove(struct gpio_chip *chip) 1043f141ed65SGrant Likely { 1044f141ed65SGrant Likely of_node_put(chip->of_node); 1045f141ed65SGrant Likely } 10464731210cSSaravana Kannan 10474731210cSSaravana Kannan void of_gpio_dev_init(struct gpio_chip *gc, struct gpio_device *gdev) 10484731210cSSaravana Kannan { 10491df62542SAndy Shevchenko /* Set default OF node to parent's one if present */ 10501df62542SAndy Shevchenko if (gc->parent) 10511df62542SAndy Shevchenko gdev->dev.of_node = gc->parent->of_node; 10521df62542SAndy Shevchenko 1053ac627260SBartosz Golaszewski if (gc->fwnode) 1054ac627260SBartosz Golaszewski gc->of_node = to_of_node(gc->fwnode); 1055ac627260SBartosz Golaszewski 10564731210cSSaravana Kannan /* If the gpiochip has an assigned OF node this takes precedence */ 10574731210cSSaravana Kannan if (gc->of_node) 10584731210cSSaravana Kannan gdev->dev.of_node = gc->of_node; 10594731210cSSaravana Kannan else 10604731210cSSaravana Kannan gc->of_node = gdev->dev.of_node; 10614731210cSSaravana Kannan } 1062