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 26f626d6dfSLinus Walleij /* 27f626d6dfSLinus Walleij * This is used by external users of of_gpio_count() from <linux/of_gpio.h> 28f626d6dfSLinus Walleij * 29f626d6dfSLinus Walleij * FIXME: get rid of those external users by converting them to GPIO 30f626d6dfSLinus Walleij * descriptors and let them all use gpiod_get_count() 31f626d6dfSLinus Walleij */ 32f626d6dfSLinus Walleij int of_gpio_get_count(struct device *dev, const char *con_id) 33f626d6dfSLinus Walleij { 34f626d6dfSLinus Walleij int ret; 35f626d6dfSLinus Walleij char propname[32]; 36f626d6dfSLinus Walleij unsigned int i; 37f626d6dfSLinus Walleij 38f626d6dfSLinus Walleij for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { 39f626d6dfSLinus Walleij if (con_id) 40f626d6dfSLinus Walleij snprintf(propname, sizeof(propname), "%s-%s", 41f626d6dfSLinus Walleij con_id, gpio_suffixes[i]); 42f626d6dfSLinus Walleij else 43f626d6dfSLinus Walleij snprintf(propname, sizeof(propname), "%s", 44f626d6dfSLinus Walleij gpio_suffixes[i]); 45f626d6dfSLinus Walleij 46f626d6dfSLinus Walleij ret = of_gpio_named_count(dev->of_node, propname); 47f626d6dfSLinus Walleij if (ret > 0) 48f626d6dfSLinus Walleij break; 49f626d6dfSLinus Walleij } 50f626d6dfSLinus Walleij return ret ? ret : -ENOENT; 51f626d6dfSLinus Walleij } 52af8b6375SAlexandre Courbot 53c7e9d398SMasahiro Yamada static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data) 543d0f7cf0SGrant Likely { 55c7e9d398SMasahiro Yamada struct of_phandle_args *gpiospec = data; 56c7e9d398SMasahiro Yamada 57c7e9d398SMasahiro Yamada return chip->gpiodev->dev.of_node == gpiospec->np && 58d49b48f0SVincent Whitchurch chip->of_xlate && 59c7e9d398SMasahiro Yamada chip->of_xlate(chip, gpiospec, NULL) >= 0; 607b8792bbSHans Holmberg } 613d0f7cf0SGrant Likely 62c7e9d398SMasahiro Yamada static struct gpio_chip *of_find_gpiochip_by_xlate( 63c7e9d398SMasahiro Yamada struct of_phandle_args *gpiospec) 64762c2e46SMasahiro Yamada { 65c7e9d398SMasahiro Yamada return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate); 663d0f7cf0SGrant Likely } 673d0f7cf0SGrant Likely 6899468c1aSMasahiro Yamada static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip, 6999468c1aSMasahiro Yamada struct of_phandle_args *gpiospec, 7099468c1aSMasahiro Yamada enum of_gpio_flags *flags) 7199468c1aSMasahiro Yamada { 7299468c1aSMasahiro Yamada int ret; 7399468c1aSMasahiro Yamada 7499468c1aSMasahiro Yamada if (chip->of_gpio_n_cells != gpiospec->args_count) 7599468c1aSMasahiro Yamada return ERR_PTR(-EINVAL); 7699468c1aSMasahiro Yamada 7799468c1aSMasahiro Yamada ret = chip->of_xlate(chip, gpiospec, flags); 7899468c1aSMasahiro Yamada if (ret < 0) 7999468c1aSMasahiro Yamada return ERR_PTR(ret); 8099468c1aSMasahiro Yamada 8199468c1aSMasahiro Yamada return gpiochip_get_desc(chip, ret); 82f141ed65SGrant Likely } 83f141ed65SGrant Likely 84f626d6dfSLinus Walleij /** 85f626d6dfSLinus Walleij * of_gpio_need_valid_mask() - figure out if the OF GPIO driver needs 86f626d6dfSLinus Walleij * to set the .valid_mask 87f626d6dfSLinus Walleij * @dev: the device for the GPIO provider 88f626d6dfSLinus Walleij * @return: true if the valid mask needs to be set 89f626d6dfSLinus Walleij */ 9049281a22SStephen Boyd bool of_gpio_need_valid_mask(const struct gpio_chip *gc) 91f626d6dfSLinus Walleij { 92f626d6dfSLinus Walleij int size; 93f626d6dfSLinus Walleij struct device_node *np = gc->of_node; 94f626d6dfSLinus Walleij 95f626d6dfSLinus Walleij size = of_property_count_u32_elems(np, "gpio-reserved-ranges"); 96f626d6dfSLinus Walleij if (size > 0 && size % 2 == 0) 97f626d6dfSLinus Walleij return true; 98f626d6dfSLinus Walleij return false; 99f626d6dfSLinus Walleij } 100f626d6dfSLinus Walleij 101a603a2b8SLinus Walleij static void of_gpio_flags_quirks(struct device_node *np, 10289a5e15bSLinus Walleij const char *propname, 1036953c57aSLinus Walleij enum of_gpio_flags *flags, 1046953c57aSLinus Walleij int index) 105a603a2b8SLinus Walleij { 106a603a2b8SLinus Walleij /* 10781c85ec1SLinus Walleij * Handle MMC "cd-inverted" and "wp-inverted" semantics. 10881c85ec1SLinus Walleij */ 10981c85ec1SLinus Walleij if (IS_ENABLED(CONFIG_MMC)) { 11081c85ec1SLinus Walleij /* 11181c85ec1SLinus Walleij * Active low is the default according to the 11289a5e15bSLinus Walleij * SDHCI specification and the device tree 11389a5e15bSLinus Walleij * bindings. However the code in the current 11489a5e15bSLinus Walleij * kernel was written such that the phandle 11589a5e15bSLinus Walleij * flags were always respected, and "cd-inverted" 11689a5e15bSLinus Walleij * would invert the flag from the device phandle. 11781c85ec1SLinus Walleij */ 11889a5e15bSLinus Walleij if (!strcmp(propname, "cd-gpios")) { 11989a5e15bSLinus Walleij if (of_property_read_bool(np, "cd-inverted")) 12089a5e15bSLinus Walleij *flags ^= OF_GPIO_ACTIVE_LOW; 12181c85ec1SLinus Walleij } 12289a5e15bSLinus Walleij if (!strcmp(propname, "wp-gpios")) { 12389a5e15bSLinus Walleij if (of_property_read_bool(np, "wp-inverted")) 12489a5e15bSLinus Walleij *flags ^= OF_GPIO_ACTIVE_LOW; 12581c85ec1SLinus Walleij } 12681c85ec1SLinus Walleij } 12781c85ec1SLinus Walleij /* 128a603a2b8SLinus Walleij * Some GPIO fixed regulator quirks. 129a603a2b8SLinus Walleij * Note that active low is the default. 130a603a2b8SLinus Walleij */ 131a603a2b8SLinus Walleij if (IS_ENABLED(CONFIG_REGULATOR) && 132906402a4SLinus Walleij (of_device_is_compatible(np, "regulator-fixed") || 133906402a4SLinus Walleij of_device_is_compatible(np, "reg-fixed-voltage") || 134a71a81e7SGeert Uytterhoeven (!(strcmp(propname, "enable-gpio") && 135a71a81e7SGeert Uytterhoeven strcmp(propname, "enable-gpios")) && 136a71a81e7SGeert Uytterhoeven of_device_is_compatible(np, "regulator-gpio")))) { 137a603a2b8SLinus Walleij /* 138a603a2b8SLinus Walleij * The regulator GPIO handles are specified such that the 139a603a2b8SLinus Walleij * presence or absence of "enable-active-high" solely controls 140a603a2b8SLinus Walleij * the polarity of the GPIO line. Any phandle flags must 141a603a2b8SLinus Walleij * be actively ignored. 142a603a2b8SLinus Walleij */ 143a603a2b8SLinus Walleij if (*flags & OF_GPIO_ACTIVE_LOW) { 144a603a2b8SLinus Walleij pr_warn("%s GPIO handle specifies active low - ignored\n", 145a603a2b8SLinus Walleij of_node_full_name(np)); 146a603a2b8SLinus Walleij *flags &= ~OF_GPIO_ACTIVE_LOW; 147a603a2b8SLinus Walleij } 148a603a2b8SLinus Walleij if (!of_property_read_bool(np, "enable-active-high")) 149a603a2b8SLinus Walleij *flags |= OF_GPIO_ACTIVE_LOW; 150a603a2b8SLinus Walleij } 151a603a2b8SLinus Walleij /* 152a603a2b8SLinus Walleij * Legacy open drain handling for fixed voltage regulators. 153a603a2b8SLinus Walleij */ 154a603a2b8SLinus Walleij if (IS_ENABLED(CONFIG_REGULATOR) && 155a603a2b8SLinus Walleij of_device_is_compatible(np, "reg-fixed-voltage") && 156a603a2b8SLinus Walleij of_property_read_bool(np, "gpio-open-drain")) { 157a603a2b8SLinus Walleij *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN); 158a603a2b8SLinus Walleij pr_info("%s uses legacy open drain flag - update the DTS if you can\n", 159a603a2b8SLinus Walleij of_node_full_name(np)); 160a603a2b8SLinus Walleij } 1616953c57aSLinus Walleij 1626953c57aSLinus Walleij /* 1636953c57aSLinus Walleij * Legacy handling of SPI active high chip select. If we have a 1646953c57aSLinus Walleij * property named "cs-gpios" we need to inspect the child node 1656953c57aSLinus Walleij * to determine if the flags should have inverted semantics. 1666953c57aSLinus Walleij */ 167da7f1349SLinus Walleij if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") && 168a71a81e7SGeert Uytterhoeven of_property_read_bool(np, "cs-gpios")) { 1696953c57aSLinus Walleij struct device_node *child; 1706953c57aSLinus Walleij u32 cs; 1716953c57aSLinus Walleij int ret; 1726953c57aSLinus Walleij 1736953c57aSLinus Walleij for_each_child_of_node(np, child) { 1746953c57aSLinus Walleij ret = of_property_read_u32(child, "reg", &cs); 175c1c04ceaSLinus Walleij if (ret) 1766953c57aSLinus Walleij continue; 1776953c57aSLinus Walleij if (cs == index) { 1786953c57aSLinus Walleij /* 1796953c57aSLinus Walleij * SPI children have active low chip selects 1806953c57aSLinus Walleij * by default. This can be specified negatively 1816953c57aSLinus Walleij * by just omitting "spi-cs-high" in the 1826953c57aSLinus Walleij * device node, or actively by tagging on 1836953c57aSLinus Walleij * GPIO_ACTIVE_LOW as flag in the device 1846953c57aSLinus Walleij * tree. If the line is simultaneously 1856953c57aSLinus Walleij * tagged as active low in the device tree 1866953c57aSLinus Walleij * and has the "spi-cs-high" set, we get a 1876953c57aSLinus Walleij * conflict and the "spi-cs-high" flag will 1886953c57aSLinus Walleij * take precedence. 1896953c57aSLinus Walleij */ 1907ce40277SAndrey Smirnov if (of_property_read_bool(child, "spi-cs-high")) { 1916953c57aSLinus Walleij if (*flags & OF_GPIO_ACTIVE_LOW) { 1926953c57aSLinus Walleij pr_warn("%s GPIO handle specifies active low - ignored\n", 1937ce40277SAndrey Smirnov of_node_full_name(child)); 1946953c57aSLinus Walleij *flags &= ~OF_GPIO_ACTIVE_LOW; 1956953c57aSLinus Walleij } 1966953c57aSLinus Walleij } else { 1976953c57aSLinus Walleij if (!(*flags & OF_GPIO_ACTIVE_LOW)) 1986953c57aSLinus Walleij pr_info("%s enforce active low on chipselect handle\n", 1997ce40277SAndrey Smirnov of_node_full_name(child)); 2006953c57aSLinus Walleij *flags |= OF_GPIO_ACTIVE_LOW; 2016953c57aSLinus Walleij } 20289fea04cSNishka Dasgupta of_node_put(child); 2036953c57aSLinus Walleij break; 2046953c57aSLinus Walleij } 2056953c57aSLinus Walleij } 2066953c57aSLinus Walleij } 207edc1ef3fSMartin Blumenstingl 208edc1ef3fSMartin Blumenstingl /* Legacy handling of stmmac's active-low PHY reset line */ 209edc1ef3fSMartin Blumenstingl if (IS_ENABLED(CONFIG_STMMAC_ETH) && 210edc1ef3fSMartin Blumenstingl !strcmp(propname, "snps,reset-gpio") && 211edc1ef3fSMartin Blumenstingl of_property_read_bool(np, "snps,reset-active-low")) 212edc1ef3fSMartin Blumenstingl *flags |= OF_GPIO_ACTIVE_LOW; 213a603a2b8SLinus Walleij } 214a603a2b8SLinus Walleij 215f141ed65SGrant Likely /** 216af8b6375SAlexandre Courbot * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API 217f141ed65SGrant Likely * @np: device node to get GPIO from 218f141ed65SGrant Likely * @propname: property name containing gpio specifier(s) 219f141ed65SGrant Likely * @index: index of the GPIO 220f141ed65SGrant Likely * @flags: a flags pointer to fill in 221f141ed65SGrant Likely * 222af8b6375SAlexandre Courbot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 223f141ed65SGrant Likely * value on the error condition. If @flags is not NULL the function also fills 224f141ed65SGrant Likely * in flags for the GPIO. 225f141ed65SGrant Likely */ 226c83d3c77SGeert Uytterhoeven static struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np, 227af8b6375SAlexandre Courbot const char *propname, int index, enum of_gpio_flags *flags) 228f141ed65SGrant Likely { 229762c2e46SMasahiro Yamada struct of_phandle_args gpiospec; 230762c2e46SMasahiro Yamada struct gpio_chip *chip; 231762c2e46SMasahiro Yamada struct gpio_desc *desc; 232f141ed65SGrant Likely int ret; 233f141ed65SGrant Likely 234c11e6f0fSStephen Boyd ret = of_parse_phandle_with_args_map(np, propname, "gpio", index, 235762c2e46SMasahiro Yamada &gpiospec); 2363d0f7cf0SGrant Likely if (ret) { 2377eb6ce2fSRob Herring pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n", 2387eb6ce2fSRob Herring __func__, propname, np, index); 239af8b6375SAlexandre Courbot return ERR_PTR(ret); 2403d0f7cf0SGrant Likely } 241f141ed65SGrant Likely 242c7e9d398SMasahiro Yamada chip = of_find_gpiochip_by_xlate(&gpiospec); 243762c2e46SMasahiro Yamada if (!chip) { 244762c2e46SMasahiro Yamada desc = ERR_PTR(-EPROBE_DEFER); 245762c2e46SMasahiro Yamada goto out; 246762c2e46SMasahiro Yamada } 2473d0f7cf0SGrant Likely 24899468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags); 249762c2e46SMasahiro Yamada if (IS_ERR(desc)) 250762c2e46SMasahiro Yamada goto out; 251762c2e46SMasahiro Yamada 252605f2d34SLinus Walleij if (flags) 25389a5e15bSLinus Walleij of_gpio_flags_quirks(np, propname, flags, index); 254a603a2b8SLinus Walleij 2557eb6ce2fSRob Herring pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n", 2567eb6ce2fSRob Herring __func__, propname, np, index, 257762c2e46SMasahiro Yamada PTR_ERR_OR_ZERO(desc)); 258762c2e46SMasahiro Yamada 259762c2e46SMasahiro Yamada out: 260762c2e46SMasahiro Yamada of_node_put(gpiospec.np); 261762c2e46SMasahiro Yamada 262762c2e46SMasahiro Yamada return desc; 263f141ed65SGrant Likely } 264f141ed65SGrant Likely 265f01d9075SAlexandre Courbot int of_get_named_gpio_flags(struct device_node *np, const char *list_name, 266f01d9075SAlexandre Courbot int index, enum of_gpio_flags *flags) 267f01d9075SAlexandre Courbot { 268f01d9075SAlexandre Courbot struct gpio_desc *desc; 269f01d9075SAlexandre Courbot 270f01d9075SAlexandre Courbot desc = of_get_named_gpiod_flags(np, list_name, index, flags); 271f01d9075SAlexandre Courbot 272f01d9075SAlexandre Courbot if (IS_ERR(desc)) 273f01d9075SAlexandre Courbot return PTR_ERR(desc); 274f01d9075SAlexandre Courbot else 275f01d9075SAlexandre Courbot return desc_to_gpio(desc); 276f01d9075SAlexandre Courbot } 2776d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_get_named_gpio_flags); 278f01d9075SAlexandre Courbot 279f626d6dfSLinus Walleij /** 280f626d6dfSLinus Walleij * gpiod_get_from_of_node() - obtain a GPIO from an OF node 281f626d6dfSLinus Walleij * @node: handle of the OF node 282f626d6dfSLinus Walleij * @propname: name of the DT property representing the GPIO 283f626d6dfSLinus Walleij * @index: index of the GPIO to obtain for the consumer 284f626d6dfSLinus Walleij * @dflags: GPIO initialization flags 285f626d6dfSLinus Walleij * @label: label to attach to the requested GPIO 286f626d6dfSLinus Walleij * 287f626d6dfSLinus Walleij * Returns: 288f626d6dfSLinus Walleij * On successful request the GPIO pin is configured in accordance with 289f626d6dfSLinus Walleij * provided @dflags. 290f626d6dfSLinus Walleij * 291f626d6dfSLinus Walleij * In case of error an ERR_PTR() is returned. 292f626d6dfSLinus Walleij */ 293f626d6dfSLinus Walleij struct gpio_desc *gpiod_get_from_of_node(struct device_node *node, 294f626d6dfSLinus Walleij const char *propname, int index, 295f626d6dfSLinus Walleij enum gpiod_flags dflags, 296f626d6dfSLinus Walleij const char *label) 297f626d6dfSLinus Walleij { 298f626d6dfSLinus Walleij unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 299f626d6dfSLinus Walleij struct gpio_desc *desc; 300f626d6dfSLinus Walleij enum of_gpio_flags flags; 301f626d6dfSLinus Walleij bool active_low = false; 302f626d6dfSLinus Walleij bool single_ended = false; 303f626d6dfSLinus Walleij bool open_drain = false; 304f626d6dfSLinus Walleij bool transitory = false; 305f626d6dfSLinus Walleij int ret; 306f626d6dfSLinus Walleij 307f626d6dfSLinus Walleij desc = of_get_named_gpiod_flags(node, propname, 308f626d6dfSLinus Walleij index, &flags); 309f626d6dfSLinus Walleij 310f626d6dfSLinus Walleij if (!desc || IS_ERR(desc)) { 311f626d6dfSLinus Walleij return desc; 312f626d6dfSLinus Walleij } 313f626d6dfSLinus Walleij 314f626d6dfSLinus Walleij active_low = flags & OF_GPIO_ACTIVE_LOW; 315f626d6dfSLinus Walleij single_ended = flags & OF_GPIO_SINGLE_ENDED; 316f626d6dfSLinus Walleij open_drain = flags & OF_GPIO_OPEN_DRAIN; 317f626d6dfSLinus Walleij transitory = flags & OF_GPIO_TRANSITORY; 318f626d6dfSLinus Walleij 319f626d6dfSLinus Walleij ret = gpiod_request(desc, label); 320f626d6dfSLinus Walleij if (ret == -EBUSY && (flags & GPIOD_FLAGS_BIT_NONEXCLUSIVE)) 321f626d6dfSLinus Walleij return desc; 322f626d6dfSLinus Walleij if (ret) 323f626d6dfSLinus Walleij return ERR_PTR(ret); 324f626d6dfSLinus Walleij 325f626d6dfSLinus Walleij if (active_low) 326f626d6dfSLinus Walleij lflags |= GPIO_ACTIVE_LOW; 327f626d6dfSLinus Walleij 328f626d6dfSLinus Walleij if (single_ended) { 329f626d6dfSLinus Walleij if (open_drain) 330f626d6dfSLinus Walleij lflags |= GPIO_OPEN_DRAIN; 331f626d6dfSLinus Walleij else 332f626d6dfSLinus Walleij lflags |= GPIO_OPEN_SOURCE; 333f626d6dfSLinus Walleij } 334f626d6dfSLinus Walleij 335f626d6dfSLinus Walleij if (transitory) 336f626d6dfSLinus Walleij lflags |= GPIO_TRANSITORY; 337f626d6dfSLinus Walleij 338f626d6dfSLinus Walleij ret = gpiod_configure_flags(desc, propname, lflags, dflags); 339f626d6dfSLinus Walleij if (ret < 0) { 340f626d6dfSLinus Walleij gpiod_put(desc); 341f626d6dfSLinus Walleij return ERR_PTR(ret); 342f626d6dfSLinus Walleij } 343f626d6dfSLinus Walleij 344f626d6dfSLinus Walleij return desc; 345f626d6dfSLinus Walleij } 3466d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(gpiod_get_from_of_node); 347f626d6dfSLinus Walleij 348c8582339SLinus Walleij /* 349c8582339SLinus Walleij * The SPI GPIO bindings happened before we managed to establish that GPIO 350c8582339SLinus Walleij * properties should be named "foo-gpios" so we have this special kludge for 351c8582339SLinus Walleij * them. 352c8582339SLinus Walleij */ 353c8582339SLinus Walleij static struct gpio_desc *of_find_spi_gpio(struct device *dev, const char *con_id, 354c8582339SLinus Walleij enum of_gpio_flags *of_flags) 355c8582339SLinus Walleij { 356c8582339SLinus Walleij char prop_name[32]; /* 32 is max size of property name */ 357c8582339SLinus Walleij struct device_node *np = dev->of_node; 358c8582339SLinus Walleij struct gpio_desc *desc; 359c8582339SLinus Walleij 360c8582339SLinus Walleij /* 361c8582339SLinus Walleij * Hopefully the compiler stubs the rest of the function if this 362c8582339SLinus Walleij * is false. 363c8582339SLinus Walleij */ 364c8582339SLinus Walleij if (!IS_ENABLED(CONFIG_SPI_MASTER)) 365c8582339SLinus Walleij return ERR_PTR(-ENOENT); 366c8582339SLinus Walleij 367c8582339SLinus Walleij /* Allow this specifically for "spi-gpio" devices */ 368c8582339SLinus Walleij if (!of_device_is_compatible(np, "spi-gpio") || !con_id) 369c8582339SLinus Walleij return ERR_PTR(-ENOENT); 370c8582339SLinus Walleij 371c8582339SLinus Walleij /* Will be "gpio-sck", "gpio-mosi" or "gpio-miso" */ 372c8582339SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s-%s", "gpio", con_id); 373c8582339SLinus Walleij 374c8582339SLinus Walleij desc = of_get_named_gpiod_flags(np, prop_name, 0, of_flags); 375c8582339SLinus Walleij return desc; 376c8582339SLinus Walleij } 377c8582339SLinus Walleij 3786a537d48SLinus Walleij /* 379e3023bf8SLinus Walleij * The old Freescale bindings use simply "gpios" as name for the chip select 380e3023bf8SLinus Walleij * lines rather than "cs-gpios" like all other SPI hardware. Account for this 381e3023bf8SLinus Walleij * with a special quirk. 382e3023bf8SLinus Walleij */ 383e3023bf8SLinus Walleij static struct gpio_desc *of_find_spi_cs_gpio(struct device *dev, 384e3023bf8SLinus Walleij const char *con_id, 385e3023bf8SLinus Walleij unsigned int idx, 386e3023bf8SLinus Walleij unsigned long *flags) 387e3023bf8SLinus Walleij { 388e3023bf8SLinus Walleij struct device_node *np = dev->of_node; 389e3023bf8SLinus Walleij 390e3023bf8SLinus Walleij if (!IS_ENABLED(CONFIG_SPI_MASTER)) 391e3023bf8SLinus Walleij return ERR_PTR(-ENOENT); 392e3023bf8SLinus Walleij 393e3023bf8SLinus Walleij /* Allow this specifically for Freescale devices */ 394e3023bf8SLinus Walleij if (!of_device_is_compatible(np, "fsl,spi") && 395e3023bf8SLinus Walleij !of_device_is_compatible(np, "aeroflexgaisler,spictrl")) 396e3023bf8SLinus Walleij return ERR_PTR(-ENOENT); 397e3023bf8SLinus Walleij /* Allow only if asking for "cs-gpios" */ 398e3023bf8SLinus Walleij if (!con_id || strcmp(con_id, "cs")) 399e3023bf8SLinus Walleij return ERR_PTR(-ENOENT); 400e3023bf8SLinus Walleij 401e3023bf8SLinus Walleij /* 402e3023bf8SLinus Walleij * While all other SPI controllers use "cs-gpios" the Freescale 403e3023bf8SLinus Walleij * uses just "gpios" so translate to that when "cs-gpios" is 404e3023bf8SLinus Walleij * requested. 405e3023bf8SLinus Walleij */ 406e3023bf8SLinus Walleij return of_find_gpio(dev, NULL, idx, flags); 407e3023bf8SLinus Walleij } 408e3023bf8SLinus Walleij 409e3023bf8SLinus Walleij /* 4106a537d48SLinus Walleij * Some regulator bindings happened before we managed to establish that GPIO 4116a537d48SLinus Walleij * properties should be named "foo-gpios" so we have this special kludge for 4126a537d48SLinus Walleij * them. 4136a537d48SLinus Walleij */ 4146a537d48SLinus Walleij static struct gpio_desc *of_find_regulator_gpio(struct device *dev, const char *con_id, 4156a537d48SLinus Walleij enum of_gpio_flags *of_flags) 4166a537d48SLinus Walleij { 4176a537d48SLinus Walleij /* These are the connection IDs we accept as legacy GPIO phandles */ 4186a537d48SLinus Walleij const char *whitelist[] = { 4196a537d48SLinus Walleij "wlf,ldoena", /* Arizona */ 4206a537d48SLinus Walleij "wlf,ldo1ena", /* WM8994 */ 4216a537d48SLinus Walleij "wlf,ldo2ena", /* WM8994 */ 4226a537d48SLinus Walleij }; 4236a537d48SLinus Walleij struct device_node *np = dev->of_node; 4246a537d48SLinus Walleij struct gpio_desc *desc; 4256a537d48SLinus Walleij int i; 4266a537d48SLinus Walleij 4276a537d48SLinus Walleij if (!IS_ENABLED(CONFIG_REGULATOR)) 4286a537d48SLinus Walleij return ERR_PTR(-ENOENT); 4296a537d48SLinus Walleij 4306a537d48SLinus Walleij if (!con_id) 4316a537d48SLinus Walleij return ERR_PTR(-ENOENT); 4326a537d48SLinus Walleij 4334b21f94aSAndy Shevchenko i = match_string(whitelist, ARRAY_SIZE(whitelist), con_id); 4344b21f94aSAndy Shevchenko if (i < 0) 4356a537d48SLinus Walleij return ERR_PTR(-ENOENT); 4366a537d48SLinus Walleij 4376a537d48SLinus Walleij desc = of_get_named_gpiod_flags(np, con_id, 0, of_flags); 4386a537d48SLinus Walleij return desc; 4396a537d48SLinus Walleij } 4406a537d48SLinus Walleij 441ea713bc4SLinus Walleij struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id, 442fed7026aSAndy Shevchenko unsigned int idx, unsigned long *flags) 443ea713bc4SLinus Walleij { 444ea713bc4SLinus Walleij char prop_name[32]; /* 32 is max size of property name */ 445ea713bc4SLinus Walleij enum of_gpio_flags of_flags; 446ea713bc4SLinus Walleij struct gpio_desc *desc; 447ea713bc4SLinus Walleij unsigned int i; 448ea713bc4SLinus Walleij 449c8582339SLinus Walleij /* Try GPIO property "foo-gpios" and "foo-gpio" */ 450ea713bc4SLinus Walleij for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { 451ea713bc4SLinus Walleij if (con_id) 452ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id, 453ea713bc4SLinus Walleij gpio_suffixes[i]); 454ea713bc4SLinus Walleij else 455ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s", 456ea713bc4SLinus Walleij gpio_suffixes[i]); 457ea713bc4SLinus Walleij 458ea713bc4SLinus Walleij desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx, 459ea713bc4SLinus Walleij &of_flags); 4606662ae6aSMaxime Ripard /* 4616662ae6aSMaxime Ripard * -EPROBE_DEFER in our case means that we found a 4626662ae6aSMaxime Ripard * valid GPIO property, but no controller has been 4636662ae6aSMaxime Ripard * registered so far. 4646662ae6aSMaxime Ripard * 4656662ae6aSMaxime Ripard * This means we don't need to look any further for 4666662ae6aSMaxime Ripard * alternate name conventions, and we should really 4676662ae6aSMaxime Ripard * preserve the return code for our user to be able to 4686662ae6aSMaxime Ripard * retry probing later. 4696662ae6aSMaxime Ripard */ 4706662ae6aSMaxime Ripard if (IS_ERR(desc) && PTR_ERR(desc) == -EPROBE_DEFER) 4716662ae6aSMaxime Ripard return desc; 4726662ae6aSMaxime Ripard 473ea713bc4SLinus Walleij if (!IS_ERR(desc) || (PTR_ERR(desc) != -ENOENT)) 474ea713bc4SLinus Walleij break; 475ea713bc4SLinus Walleij } 476ea713bc4SLinus Walleij 477c8582339SLinus Walleij /* Special handling for SPI GPIOs if used */ 478c8582339SLinus Walleij if (IS_ERR(desc)) 479c8582339SLinus Walleij desc = of_find_spi_gpio(dev, con_id, &of_flags); 480df451f83SAndreas Kemnade if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER) { 481e3023bf8SLinus Walleij /* This quirk looks up flags and all */ 482e3023bf8SLinus Walleij desc = of_find_spi_cs_gpio(dev, con_id, idx, flags); 483e3023bf8SLinus Walleij if (!IS_ERR(desc)) 484e3023bf8SLinus Walleij return desc; 485e3023bf8SLinus Walleij } 486c8582339SLinus Walleij 4876a537d48SLinus Walleij /* Special handling for regulator GPIOs if used */ 488ce27fb2cSChen-Yu Tsai if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER) 4896a537d48SLinus Walleij desc = of_find_regulator_gpio(dev, con_id, &of_flags); 4906a537d48SLinus Walleij 491ea713bc4SLinus Walleij if (IS_ERR(desc)) 492ea713bc4SLinus Walleij return desc; 493ea713bc4SLinus Walleij 494ea713bc4SLinus Walleij if (of_flags & OF_GPIO_ACTIVE_LOW) 495ea713bc4SLinus Walleij *flags |= GPIO_ACTIVE_LOW; 496ea713bc4SLinus Walleij 497ea713bc4SLinus Walleij if (of_flags & OF_GPIO_SINGLE_ENDED) { 4984c0facddSLaxman Dewangan if (of_flags & OF_GPIO_OPEN_DRAIN) 499ea713bc4SLinus Walleij *flags |= GPIO_OPEN_DRAIN; 500ea713bc4SLinus Walleij else 501ea713bc4SLinus Walleij *flags |= GPIO_OPEN_SOURCE; 502ea713bc4SLinus Walleij } 503ea713bc4SLinus Walleij 504e10f72bfSAndrew Jeffery if (of_flags & OF_GPIO_TRANSITORY) 505e10f72bfSAndrew Jeffery *flags |= GPIO_TRANSITORY; 50605f479bfSCharles Keepax 507d449991cSThomas Petazzoni if (of_flags & OF_GPIO_PULL_UP) 508d449991cSThomas Petazzoni *flags |= GPIO_PULL_UP; 509d449991cSThomas Petazzoni if (of_flags & OF_GPIO_PULL_DOWN) 510d449991cSThomas Petazzoni *flags |= GPIO_PULL_DOWN; 511d449991cSThomas Petazzoni 512ea713bc4SLinus Walleij return desc; 513ea713bc4SLinus Walleij } 514ea713bc4SLinus Walleij 515f141ed65SGrant Likely /** 516fd7337fdSMarkus Pargmann * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API 517f625d460SBenoit Parrot * @np: device node to get GPIO from 518be715343SMasahiro Yamada * @chip: GPIO chip whose hog is parsed 519a79fead5SGeert Uytterhoeven * @idx: Index of the GPIO to parse 520f625d460SBenoit Parrot * @name: GPIO line name 521fed7026aSAndy Shevchenko * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from 522fed7026aSAndy Shevchenko * of_find_gpio() or of_parse_own_gpio() 523f625d460SBenoit Parrot * @dflags: gpiod_flags - optional GPIO initialization flags 524f625d460SBenoit Parrot * 525f625d460SBenoit Parrot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 526f625d460SBenoit Parrot * value on the error condition. 527f625d460SBenoit Parrot */ 528fd7337fdSMarkus Pargmann static struct gpio_desc *of_parse_own_gpio(struct device_node *np, 529be715343SMasahiro Yamada struct gpio_chip *chip, 530a79fead5SGeert Uytterhoeven unsigned int idx, const char **name, 531fed7026aSAndy Shevchenko unsigned long *lflags, 532f625d460SBenoit Parrot enum gpiod_flags *dflags) 533f625d460SBenoit Parrot { 534f625d460SBenoit Parrot struct device_node *chip_np; 535f625d460SBenoit Parrot enum of_gpio_flags xlate_flags; 536be715343SMasahiro Yamada struct of_phandle_args gpiospec; 537be715343SMasahiro Yamada struct gpio_desc *desc; 538a79fead5SGeert Uytterhoeven unsigned int i; 539f625d460SBenoit Parrot u32 tmp; 5403f9547e1SMasahiro Yamada int ret; 541f625d460SBenoit Parrot 542be715343SMasahiro Yamada chip_np = chip->of_node; 543f625d460SBenoit Parrot if (!chip_np) 544f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 545f625d460SBenoit Parrot 546f625d460SBenoit Parrot xlate_flags = 0; 5472d6c06f5SAndy Shevchenko *lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 548f625d460SBenoit Parrot *dflags = 0; 549f625d460SBenoit Parrot 550f625d460SBenoit Parrot ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp); 551f625d460SBenoit Parrot if (ret) 552f625d460SBenoit Parrot return ERR_PTR(ret); 553f625d460SBenoit Parrot 554be715343SMasahiro Yamada gpiospec.np = chip_np; 555be715343SMasahiro Yamada gpiospec.args_count = tmp; 556f625d460SBenoit Parrot 557a79fead5SGeert Uytterhoeven for (i = 0; i < tmp; i++) { 558a79fead5SGeert Uytterhoeven ret = of_property_read_u32_index(np, "gpios", idx * tmp + i, 559a79fead5SGeert Uytterhoeven &gpiospec.args[i]); 560f625d460SBenoit Parrot if (ret) 561f625d460SBenoit Parrot return ERR_PTR(ret); 562a79fead5SGeert Uytterhoeven } 563f625d460SBenoit Parrot 56499468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags); 565be715343SMasahiro Yamada if (IS_ERR(desc)) 566be715343SMasahiro Yamada return desc; 567f625d460SBenoit Parrot 568f625d460SBenoit Parrot if (xlate_flags & OF_GPIO_ACTIVE_LOW) 569f625d460SBenoit Parrot *lflags |= GPIO_ACTIVE_LOW; 570e10f72bfSAndrew Jeffery if (xlate_flags & OF_GPIO_TRANSITORY) 571e10f72bfSAndrew Jeffery *lflags |= GPIO_TRANSITORY; 572f625d460SBenoit Parrot 573f625d460SBenoit Parrot if (of_property_read_bool(np, "input")) 574f625d460SBenoit Parrot *dflags |= GPIOD_IN; 575f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-low")) 576f625d460SBenoit Parrot *dflags |= GPIOD_OUT_LOW; 577f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-high")) 578f625d460SBenoit Parrot *dflags |= GPIOD_OUT_HIGH; 579f625d460SBenoit Parrot else { 58062cdcb6cSRob Herring pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n", 58162cdcb6cSRob Herring desc_to_gpio(desc), np); 582f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 583f625d460SBenoit Parrot } 584f625d460SBenoit Parrot 585f625d460SBenoit Parrot if (name && of_property_read_string(np, "line-name", name)) 586f625d460SBenoit Parrot *name = np->name; 587f625d460SBenoit Parrot 588be715343SMasahiro Yamada return desc; 589f625d460SBenoit Parrot } 590f625d460SBenoit Parrot 591f625d460SBenoit Parrot /** 592fd7337fdSMarkus Pargmann * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions 593f625d460SBenoit Parrot * @chip: gpio chip to act on 594f625d460SBenoit Parrot * 595f625d460SBenoit Parrot * This is only used by of_gpiochip_add to request/set GPIO initial 596f625d460SBenoit Parrot * configuration. 597ead066e6SGeert Uytterhoeven * It returns error if it fails otherwise 0 on success. 598f625d460SBenoit Parrot */ 599dfbd379bSLaxman Dewangan static int of_gpiochip_scan_gpios(struct gpio_chip *chip) 600f625d460SBenoit Parrot { 601f625d460SBenoit Parrot struct gpio_desc *desc = NULL; 602f625d460SBenoit Parrot struct device_node *np; 603f625d460SBenoit Parrot const char *name; 604fed7026aSAndy Shevchenko unsigned long lflags; 605f625d460SBenoit Parrot enum gpiod_flags dflags; 606a79fead5SGeert Uytterhoeven unsigned int i; 607dfbd379bSLaxman Dewangan int ret; 608f625d460SBenoit Parrot 609d1279d94SLaxman Dewangan for_each_available_child_of_node(chip->of_node, np) { 610f625d460SBenoit Parrot if (!of_property_read_bool(np, "gpio-hog")) 611f625d460SBenoit Parrot continue; 612f625d460SBenoit Parrot 613a79fead5SGeert Uytterhoeven for (i = 0;; i++) { 614a79fead5SGeert Uytterhoeven desc = of_parse_own_gpio(np, chip, i, &name, &lflags, 615a79fead5SGeert Uytterhoeven &dflags); 616f625d460SBenoit Parrot if (IS_ERR(desc)) 617a79fead5SGeert Uytterhoeven break; 618f625d460SBenoit Parrot 619dfbd379bSLaxman Dewangan ret = gpiod_hog(desc, name, lflags, dflags); 62009e258afSWei Yongjun if (ret < 0) { 62109e258afSWei Yongjun of_node_put(np); 622dfbd379bSLaxman Dewangan return ret; 623f625d460SBenoit Parrot } 62409e258afSWei Yongjun } 625a79fead5SGeert Uytterhoeven } 626dfbd379bSLaxman Dewangan 627dfbd379bSLaxman Dewangan return 0; 628f625d460SBenoit Parrot } 629f625d460SBenoit Parrot 630f625d460SBenoit Parrot /** 63167049c50SThierry Reding * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags 632f141ed65SGrant Likely * @gc: pointer to the gpio_chip structure 63367049c50SThierry Reding * @gpiospec: GPIO specifier as found in the device tree 634f141ed65SGrant Likely * @flags: a flags pointer to fill in 635f141ed65SGrant Likely * 636f141ed65SGrant Likely * This is simple translation function, suitable for the most 1:1 mapped 63767049c50SThierry Reding * GPIO chips. This function performs only one sanity check: whether GPIO 638f141ed65SGrant Likely * is less than ngpios (that is specified in the gpio_chip). 639f141ed65SGrant Likely */ 640b0c7e73bSGeert Uytterhoeven static int of_gpio_simple_xlate(struct gpio_chip *gc, 641b0c7e73bSGeert Uytterhoeven const struct of_phandle_args *gpiospec, 642b0c7e73bSGeert Uytterhoeven u32 *flags) 643f141ed65SGrant Likely { 644f141ed65SGrant Likely /* 645f141ed65SGrant Likely * We're discouraging gpio_cells < 2, since that way you'll have to 64620a8a968SColin Cronin * write your own xlate function (that will have to retrieve the GPIO 647f141ed65SGrant Likely * number and the flags from a single gpio cell -- this is possible, 648f141ed65SGrant Likely * but not recommended). 649f141ed65SGrant Likely */ 650f141ed65SGrant Likely if (gc->of_gpio_n_cells < 2) { 651f141ed65SGrant Likely WARN_ON(1); 652f141ed65SGrant Likely return -EINVAL; 653f141ed65SGrant Likely } 654f141ed65SGrant Likely 655f141ed65SGrant Likely if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells)) 656f141ed65SGrant Likely return -EINVAL; 657f141ed65SGrant Likely 6587b96c686SGrant Likely if (gpiospec->args[0] >= gc->ngpio) 659f141ed65SGrant Likely return -EINVAL; 660f141ed65SGrant Likely 661f141ed65SGrant Likely if (flags) 662f141ed65SGrant Likely *flags = gpiospec->args[1]; 663f141ed65SGrant Likely 664f141ed65SGrant Likely return gpiospec->args[0]; 665f141ed65SGrant Likely } 666f141ed65SGrant Likely 667f141ed65SGrant Likely /** 6683208b0f0SLinus Walleij * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank) 669f141ed65SGrant Likely * @np: device node of the GPIO chip 670f141ed65SGrant Likely * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 6713208b0f0SLinus Walleij * @data: driver data to store in the struct gpio_chip 672f141ed65SGrant Likely * 673f141ed65SGrant Likely * To use this function you should allocate and fill mm_gc with: 674f141ed65SGrant Likely * 675f141ed65SGrant Likely * 1) In the gpio_chip structure: 676f141ed65SGrant Likely * - all the callbacks 677f141ed65SGrant Likely * - of_gpio_n_cells 678f141ed65SGrant Likely * - of_xlate callback (optional) 679f141ed65SGrant Likely * 680f141ed65SGrant Likely * 3) In the of_mm_gpio_chip structure: 681f141ed65SGrant Likely * - save_regs callback (optional) 682f141ed65SGrant Likely * 683f141ed65SGrant Likely * If succeeded, this function will map bank's memory and will 684f141ed65SGrant Likely * do all necessary work for you. Then you'll able to use .regs 685f141ed65SGrant Likely * to manage GPIOs from the callbacks. 686f141ed65SGrant Likely */ 6873208b0f0SLinus Walleij int of_mm_gpiochip_add_data(struct device_node *np, 6883208b0f0SLinus Walleij struct of_mm_gpio_chip *mm_gc, 6893208b0f0SLinus Walleij void *data) 690f141ed65SGrant Likely { 691f141ed65SGrant Likely int ret = -ENOMEM; 692f141ed65SGrant Likely struct gpio_chip *gc = &mm_gc->gc; 693f141ed65SGrant Likely 6947eb6ce2fSRob Herring gc->label = kasprintf(GFP_KERNEL, "%pOF", np); 695f141ed65SGrant Likely if (!gc->label) 696f141ed65SGrant Likely goto err0; 697f141ed65SGrant Likely 698f141ed65SGrant Likely mm_gc->regs = of_iomap(np, 0); 699f141ed65SGrant Likely if (!mm_gc->regs) 700f141ed65SGrant Likely goto err1; 701f141ed65SGrant Likely 702f141ed65SGrant Likely gc->base = -1; 703f141ed65SGrant Likely 704f141ed65SGrant Likely if (mm_gc->save_regs) 705f141ed65SGrant Likely mm_gc->save_regs(mm_gc); 706f141ed65SGrant Likely 707f141ed65SGrant Likely mm_gc->gc.of_node = np; 708f141ed65SGrant Likely 7093208b0f0SLinus Walleij ret = gpiochip_add_data(gc, data); 710f141ed65SGrant Likely if (ret) 711f141ed65SGrant Likely goto err2; 712f141ed65SGrant Likely 713f141ed65SGrant Likely return 0; 714f141ed65SGrant Likely err2: 715f141ed65SGrant Likely iounmap(mm_gc->regs); 716f141ed65SGrant Likely err1: 717f141ed65SGrant Likely kfree(gc->label); 718f141ed65SGrant Likely err0: 7197eb6ce2fSRob Herring pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret); 720f141ed65SGrant Likely return ret; 721f141ed65SGrant Likely } 7226d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data); 723f141ed65SGrant Likely 724d621e8baSRicardo Ribalda Delgado /** 725d621e8baSRicardo Ribalda Delgado * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank) 726d621e8baSRicardo Ribalda Delgado * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 727d621e8baSRicardo Ribalda Delgado */ 728d621e8baSRicardo Ribalda Delgado void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc) 729d621e8baSRicardo Ribalda Delgado { 730d621e8baSRicardo Ribalda Delgado struct gpio_chip *gc = &mm_gc->gc; 731d621e8baSRicardo Ribalda Delgado 732d621e8baSRicardo Ribalda Delgado if (!mm_gc) 733d621e8baSRicardo Ribalda Delgado return; 734d621e8baSRicardo Ribalda Delgado 735d621e8baSRicardo Ribalda Delgado gpiochip_remove(gc); 736d621e8baSRicardo Ribalda Delgado iounmap(mm_gc->regs); 737d621e8baSRicardo Ribalda Delgado kfree(gc->label); 738d621e8baSRicardo Ribalda Delgado } 7396d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove); 740d621e8baSRicardo Ribalda Delgado 741726cb3baSStephen Boyd static void of_gpiochip_init_valid_mask(struct gpio_chip *chip) 742726cb3baSStephen Boyd { 743726cb3baSStephen Boyd int len, i; 744726cb3baSStephen Boyd u32 start, count; 745726cb3baSStephen Boyd struct device_node *np = chip->of_node; 746726cb3baSStephen Boyd 747726cb3baSStephen Boyd len = of_property_count_u32_elems(np, "gpio-reserved-ranges"); 748726cb3baSStephen Boyd if (len < 0 || len % 2 != 0) 749726cb3baSStephen Boyd return; 750726cb3baSStephen Boyd 751726cb3baSStephen Boyd for (i = 0; i < len; i += 2) { 752726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 753726cb3baSStephen Boyd i, &start); 754726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 755726cb3baSStephen Boyd i + 1, &count); 756726cb3baSStephen Boyd if (start >= chip->ngpio || start + count >= chip->ngpio) 757726cb3baSStephen Boyd continue; 758726cb3baSStephen Boyd 759726cb3baSStephen Boyd bitmap_clear(chip->valid_mask, start, count); 760726cb3baSStephen Boyd } 761726cb3baSStephen Boyd }; 762726cb3baSStephen Boyd 763f23f1516SShiraz Hashim #ifdef CONFIG_PINCTRL 76428355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) 765f23f1516SShiraz Hashim { 766f23f1516SShiraz Hashim struct device_node *np = chip->of_node; 767f23f1516SShiraz Hashim struct of_phandle_args pinspec; 7681e63d7b9SLinus Walleij struct pinctrl_dev *pctldev; 769f23f1516SShiraz Hashim int index = 0, ret; 770586a87e6SChristian Ruppert const char *name; 771586a87e6SChristian Ruppert static const char group_names_propname[] = "gpio-ranges-group-names"; 772586a87e6SChristian Ruppert struct property *group_names; 773f23f1516SShiraz Hashim 774f23f1516SShiraz Hashim if (!np) 77528355f81STomeu Vizoso return 0; 776f23f1516SShiraz Hashim 777586a87e6SChristian Ruppert group_names = of_find_property(np, group_names_propname, NULL); 778586a87e6SChristian Ruppert 779ad4e1a7cSHaojian Zhuang for (;; index++) { 780d9fe0039SStephen Warren ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 781d9fe0039SStephen Warren index, &pinspec); 782f23f1516SShiraz Hashim if (ret) 783f23f1516SShiraz Hashim break; 784f23f1516SShiraz Hashim 7851e63d7b9SLinus Walleij pctldev = of_pinctrl_get(pinspec.np); 786602cf638SMasahiro Yamada of_node_put(pinspec.np); 7871e63d7b9SLinus Walleij if (!pctldev) 78828355f81STomeu Vizoso return -EPROBE_DEFER; 789f23f1516SShiraz Hashim 790586a87e6SChristian Ruppert if (pinspec.args[2]) { 791586a87e6SChristian Ruppert if (group_names) { 79272858602SLaurent Navet of_property_read_string_index(np, 793586a87e6SChristian Ruppert group_names_propname, 794586a87e6SChristian Ruppert index, &name); 795586a87e6SChristian Ruppert if (strlen(name)) { 7967eb6ce2fSRob Herring pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n", 7977eb6ce2fSRob Herring np); 798586a87e6SChristian Ruppert break; 799586a87e6SChristian Ruppert } 800586a87e6SChristian Ruppert } 801586a87e6SChristian Ruppert /* npins != 0: linear range */ 8021e63d7b9SLinus Walleij ret = gpiochip_add_pin_range(chip, 803ef5e3eefSHaojian Zhuang pinctrl_dev_get_devname(pctldev), 8041e63d7b9SLinus Walleij pinspec.args[0], 80586853c83SHaojian Zhuang pinspec.args[1], 80686853c83SHaojian Zhuang pinspec.args[2]); 8071e63d7b9SLinus Walleij if (ret) 80828355f81STomeu Vizoso return ret; 809586a87e6SChristian Ruppert } else { 810586a87e6SChristian Ruppert /* npins == 0: special range */ 811586a87e6SChristian Ruppert if (pinspec.args[1]) { 8127eb6ce2fSRob Herring pr_err("%pOF: Illegal gpio-range format.\n", 8137eb6ce2fSRob Herring np); 814586a87e6SChristian Ruppert break; 815586a87e6SChristian Ruppert } 816586a87e6SChristian Ruppert 817586a87e6SChristian Ruppert if (!group_names) { 8187eb6ce2fSRob Herring pr_err("%pOF: GPIO group range requested but no %s property.\n", 8197eb6ce2fSRob Herring np, group_names_propname); 820586a87e6SChristian Ruppert break; 821586a87e6SChristian Ruppert } 822586a87e6SChristian Ruppert 823586a87e6SChristian Ruppert ret = of_property_read_string_index(np, 824586a87e6SChristian Ruppert group_names_propname, 825586a87e6SChristian Ruppert index, &name); 826586a87e6SChristian Ruppert if (ret) 827586a87e6SChristian Ruppert break; 828586a87e6SChristian Ruppert 829586a87e6SChristian Ruppert if (!strlen(name)) { 8307eb6ce2fSRob Herring pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n", 8317eb6ce2fSRob Herring np); 832586a87e6SChristian Ruppert break; 833586a87e6SChristian Ruppert } 834586a87e6SChristian Ruppert 835586a87e6SChristian Ruppert ret = gpiochip_add_pingroup_range(chip, pctldev, 836586a87e6SChristian Ruppert pinspec.args[0], name); 837586a87e6SChristian Ruppert if (ret) 83828355f81STomeu Vizoso return ret; 839586a87e6SChristian Ruppert } 840ad4e1a7cSHaojian Zhuang } 84128355f81STomeu Vizoso 84228355f81STomeu Vizoso return 0; 843f23f1516SShiraz Hashim } 844f23f1516SShiraz Hashim 845f23f1516SShiraz Hashim #else 84628355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; } 847f23f1516SShiraz Hashim #endif 848f23f1516SShiraz Hashim 84928355f81STomeu Vizoso int of_gpiochip_add(struct gpio_chip *chip) 850f141ed65SGrant Likely { 851f0d1ab05SLinus Walleij int ret; 85228355f81STomeu Vizoso 853f141ed65SGrant Likely if (!chip->of_node) 85428355f81STomeu Vizoso return 0; 855f141ed65SGrant Likely 856f141ed65SGrant Likely if (!chip->of_xlate) { 857f141ed65SGrant Likely chip->of_gpio_n_cells = 2; 858f141ed65SGrant Likely chip->of_xlate = of_gpio_simple_xlate; 859f141ed65SGrant Likely } 860f141ed65SGrant Likely 8611020dfd1SMasahiro Yamada if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS) 8621020dfd1SMasahiro Yamada return -EINVAL; 8631020dfd1SMasahiro Yamada 864726cb3baSStephen Boyd of_gpiochip_init_valid_mask(chip); 865726cb3baSStephen Boyd 866f0d1ab05SLinus Walleij ret = of_gpiochip_add_pin_range(chip); 867f0d1ab05SLinus Walleij if (ret) 868f0d1ab05SLinus Walleij return ret; 86928355f81STomeu Vizoso 870fd9c5531SLinus Walleij /* If the chip defines names itself, these take precedence */ 871fd9c5531SLinus Walleij if (!chip->names) 87282270335SChristophe Leroy devprop_gpiochip_set_names(chip, 87382270335SChristophe Leroy of_fwnode_handle(chip->of_node)); 874fd9c5531SLinus Walleij 875f141ed65SGrant Likely of_node_get(chip->of_node); 876f625d460SBenoit Parrot 877f0d1ab05SLinus Walleij ret = of_gpiochip_scan_gpios(chip); 878f0d1ab05SLinus Walleij if (ret) { 879f7299d44SGeert Uytterhoeven of_node_put(chip->of_node); 880f7299d44SGeert Uytterhoeven gpiochip_remove_pin_ranges(chip); 881f7299d44SGeert Uytterhoeven } 882f7299d44SGeert Uytterhoeven 883f0d1ab05SLinus Walleij return ret; 884f141ed65SGrant Likely } 885f141ed65SGrant Likely 886f141ed65SGrant Likely void of_gpiochip_remove(struct gpio_chip *chip) 887f141ed65SGrant Likely { 888e93fa3f2SLinus Walleij gpiochip_remove_pin_ranges(chip); 889f141ed65SGrant Likely of_node_put(chip->of_node); 890f141ed65SGrant Likely } 891