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 30808b9931SGeert Uytterhoeven * descriptors and let them all use gpiod_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 8714e8c535SRandy Dunlap * @gc: the target gpio_chip 8814e8c535SRandy Dunlap * 8914e8c535SRandy Dunlap * Return: true if the valid mask needs to be set 90f626d6dfSLinus Walleij */ 9149281a22SStephen Boyd bool of_gpio_need_valid_mask(const struct gpio_chip *gc) 92f626d6dfSLinus Walleij { 93f626d6dfSLinus Walleij int size; 94f626d6dfSLinus Walleij struct device_node *np = gc->of_node; 95f626d6dfSLinus Walleij 96f626d6dfSLinus Walleij size = of_property_count_u32_elems(np, "gpio-reserved-ranges"); 97f626d6dfSLinus Walleij if (size > 0 && size % 2 == 0) 98f626d6dfSLinus Walleij return true; 99f626d6dfSLinus Walleij return false; 100f626d6dfSLinus Walleij } 101f626d6dfSLinus Walleij 102a603a2b8SLinus Walleij static void of_gpio_flags_quirks(struct device_node *np, 10389a5e15bSLinus Walleij const char *propname, 1046953c57aSLinus Walleij enum of_gpio_flags *flags, 1056953c57aSLinus Walleij int index) 106a603a2b8SLinus Walleij { 107a603a2b8SLinus Walleij /* 10881c85ec1SLinus Walleij * Handle MMC "cd-inverted" and "wp-inverted" semantics. 10981c85ec1SLinus Walleij */ 11081c85ec1SLinus Walleij if (IS_ENABLED(CONFIG_MMC)) { 11181c85ec1SLinus Walleij /* 11281c85ec1SLinus Walleij * Active low is the default according to the 11389a5e15bSLinus Walleij * SDHCI specification and the device tree 11489a5e15bSLinus Walleij * bindings. However the code in the current 11589a5e15bSLinus Walleij * kernel was written such that the phandle 11689a5e15bSLinus Walleij * flags were always respected, and "cd-inverted" 11789a5e15bSLinus Walleij * would invert the flag from the device phandle. 11881c85ec1SLinus Walleij */ 11989a5e15bSLinus Walleij if (!strcmp(propname, "cd-gpios")) { 12089a5e15bSLinus Walleij if (of_property_read_bool(np, "cd-inverted")) 12189a5e15bSLinus Walleij *flags ^= OF_GPIO_ACTIVE_LOW; 12281c85ec1SLinus Walleij } 12389a5e15bSLinus Walleij if (!strcmp(propname, "wp-gpios")) { 12489a5e15bSLinus Walleij if (of_property_read_bool(np, "wp-inverted")) 12589a5e15bSLinus Walleij *flags ^= OF_GPIO_ACTIVE_LOW; 12681c85ec1SLinus Walleij } 12781c85ec1SLinus Walleij } 12881c85ec1SLinus Walleij /* 129a603a2b8SLinus Walleij * Some GPIO fixed regulator quirks. 130a603a2b8SLinus Walleij * Note that active low is the default. 131a603a2b8SLinus Walleij */ 132a603a2b8SLinus Walleij if (IS_ENABLED(CONFIG_REGULATOR) && 133906402a4SLinus Walleij (of_device_is_compatible(np, "regulator-fixed") || 134906402a4SLinus Walleij of_device_is_compatible(np, "reg-fixed-voltage") || 135a71a81e7SGeert Uytterhoeven (!(strcmp(propname, "enable-gpio") && 136a71a81e7SGeert Uytterhoeven strcmp(propname, "enable-gpios")) && 137a71a81e7SGeert Uytterhoeven of_device_is_compatible(np, "regulator-gpio")))) { 138228fc010SLucas Stach bool active_low = !of_property_read_bool(np, 139228fc010SLucas Stach "enable-active-high"); 140a603a2b8SLinus Walleij /* 141a603a2b8SLinus Walleij * The regulator GPIO handles are specified such that the 142a603a2b8SLinus Walleij * presence or absence of "enable-active-high" solely controls 143a603a2b8SLinus Walleij * the polarity of the GPIO line. Any phandle flags must 144a603a2b8SLinus Walleij * be actively ignored. 145a603a2b8SLinus Walleij */ 146228fc010SLucas Stach if ((*flags & OF_GPIO_ACTIVE_LOW) && !active_low) { 147a603a2b8SLinus Walleij pr_warn("%s GPIO handle specifies active low - ignored\n", 148a603a2b8SLinus Walleij of_node_full_name(np)); 149a603a2b8SLinus Walleij *flags &= ~OF_GPIO_ACTIVE_LOW; 150a603a2b8SLinus Walleij } 151228fc010SLucas Stach if (active_low) 152a603a2b8SLinus Walleij *flags |= OF_GPIO_ACTIVE_LOW; 153a603a2b8SLinus Walleij } 154a603a2b8SLinus Walleij /* 155a603a2b8SLinus Walleij * Legacy open drain handling for fixed voltage regulators. 156a603a2b8SLinus Walleij */ 157a603a2b8SLinus Walleij if (IS_ENABLED(CONFIG_REGULATOR) && 158a603a2b8SLinus Walleij of_device_is_compatible(np, "reg-fixed-voltage") && 159a603a2b8SLinus Walleij of_property_read_bool(np, "gpio-open-drain")) { 160a603a2b8SLinus Walleij *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN); 161a603a2b8SLinus Walleij pr_info("%s uses legacy open drain flag - update the DTS if you can\n", 162a603a2b8SLinus Walleij of_node_full_name(np)); 163a603a2b8SLinus Walleij } 1646953c57aSLinus Walleij 1656953c57aSLinus Walleij /* 1666953c57aSLinus Walleij * Legacy handling of SPI active high chip select. If we have a 1676953c57aSLinus Walleij * property named "cs-gpios" we need to inspect the child node 1686953c57aSLinus Walleij * to determine if the flags should have inverted semantics. 1696953c57aSLinus Walleij */ 170da7f1349SLinus Walleij if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") && 171a71a81e7SGeert Uytterhoeven of_property_read_bool(np, "cs-gpios")) { 1726953c57aSLinus Walleij struct device_node *child; 1736953c57aSLinus Walleij u32 cs; 1746953c57aSLinus Walleij int ret; 1756953c57aSLinus Walleij 1766953c57aSLinus Walleij for_each_child_of_node(np, child) { 1776953c57aSLinus Walleij ret = of_property_read_u32(child, "reg", &cs); 178c1c04ceaSLinus Walleij if (ret) 1796953c57aSLinus Walleij continue; 1806953c57aSLinus Walleij if (cs == index) { 1816953c57aSLinus Walleij /* 1826953c57aSLinus Walleij * SPI children have active low chip selects 1836953c57aSLinus Walleij * by default. This can be specified negatively 1846953c57aSLinus Walleij * by just omitting "spi-cs-high" in the 1856953c57aSLinus Walleij * device node, or actively by tagging on 1866953c57aSLinus Walleij * GPIO_ACTIVE_LOW as flag in the device 1876953c57aSLinus Walleij * tree. If the line is simultaneously 1886953c57aSLinus Walleij * tagged as active low in the device tree 1896953c57aSLinus Walleij * and has the "spi-cs-high" set, we get a 1906953c57aSLinus Walleij * conflict and the "spi-cs-high" flag will 1916953c57aSLinus Walleij * take precedence. 1926953c57aSLinus Walleij */ 1937ce40277SAndrey Smirnov if (of_property_read_bool(child, "spi-cs-high")) { 1946953c57aSLinus Walleij if (*flags & OF_GPIO_ACTIVE_LOW) { 1956953c57aSLinus Walleij pr_warn("%s GPIO handle specifies active low - ignored\n", 1967ce40277SAndrey Smirnov of_node_full_name(child)); 1976953c57aSLinus Walleij *flags &= ~OF_GPIO_ACTIVE_LOW; 1986953c57aSLinus Walleij } 1996953c57aSLinus Walleij } else { 2006953c57aSLinus Walleij if (!(*flags & OF_GPIO_ACTIVE_LOW)) 2016953c57aSLinus Walleij pr_info("%s enforce active low on chipselect handle\n", 2027ce40277SAndrey Smirnov of_node_full_name(child)); 2036953c57aSLinus Walleij *flags |= OF_GPIO_ACTIVE_LOW; 2046953c57aSLinus Walleij } 20589fea04cSNishka Dasgupta of_node_put(child); 2066953c57aSLinus Walleij break; 2076953c57aSLinus Walleij } 2086953c57aSLinus Walleij } 2096953c57aSLinus Walleij } 210edc1ef3fSMartin Blumenstingl 211edc1ef3fSMartin Blumenstingl /* Legacy handling of stmmac's active-low PHY reset line */ 212edc1ef3fSMartin Blumenstingl if (IS_ENABLED(CONFIG_STMMAC_ETH) && 213edc1ef3fSMartin Blumenstingl !strcmp(propname, "snps,reset-gpio") && 214edc1ef3fSMartin Blumenstingl of_property_read_bool(np, "snps,reset-active-low")) 215edc1ef3fSMartin Blumenstingl *flags |= OF_GPIO_ACTIVE_LOW; 216a603a2b8SLinus Walleij } 217a603a2b8SLinus Walleij 218f141ed65SGrant Likely /** 219af8b6375SAlexandre Courbot * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API 220f141ed65SGrant Likely * @np: device node to get GPIO from 221f141ed65SGrant Likely * @propname: property name containing gpio specifier(s) 222f141ed65SGrant Likely * @index: index of the GPIO 223f141ed65SGrant Likely * @flags: a flags pointer to fill in 224f141ed65SGrant Likely * 225af8b6375SAlexandre Courbot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 226f141ed65SGrant Likely * value on the error condition. If @flags is not NULL the function also fills 227f141ed65SGrant Likely * in flags for the GPIO. 228f141ed65SGrant Likely */ 229c83d3c77SGeert Uytterhoeven static struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np, 230af8b6375SAlexandre Courbot const char *propname, int index, enum of_gpio_flags *flags) 231f141ed65SGrant Likely { 232762c2e46SMasahiro Yamada struct of_phandle_args gpiospec; 233762c2e46SMasahiro Yamada struct gpio_chip *chip; 234762c2e46SMasahiro Yamada struct gpio_desc *desc; 235f141ed65SGrant Likely int ret; 236f141ed65SGrant Likely 237c11e6f0fSStephen Boyd ret = of_parse_phandle_with_args_map(np, propname, "gpio", index, 238762c2e46SMasahiro Yamada &gpiospec); 2393d0f7cf0SGrant Likely if (ret) { 2407eb6ce2fSRob Herring pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n", 2417eb6ce2fSRob Herring __func__, propname, np, index); 242af8b6375SAlexandre Courbot return ERR_PTR(ret); 2433d0f7cf0SGrant Likely } 244f141ed65SGrant Likely 245c7e9d398SMasahiro Yamada chip = of_find_gpiochip_by_xlate(&gpiospec); 246762c2e46SMasahiro Yamada if (!chip) { 247762c2e46SMasahiro Yamada desc = ERR_PTR(-EPROBE_DEFER); 248762c2e46SMasahiro Yamada goto out; 249762c2e46SMasahiro Yamada } 2503d0f7cf0SGrant Likely 25199468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags); 252762c2e46SMasahiro Yamada if (IS_ERR(desc)) 253762c2e46SMasahiro Yamada goto out; 254762c2e46SMasahiro Yamada 255605f2d34SLinus Walleij if (flags) 25689a5e15bSLinus Walleij of_gpio_flags_quirks(np, propname, flags, index); 257a603a2b8SLinus Walleij 2587eb6ce2fSRob Herring pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n", 2597eb6ce2fSRob Herring __func__, propname, np, index, 260762c2e46SMasahiro Yamada PTR_ERR_OR_ZERO(desc)); 261762c2e46SMasahiro Yamada 262762c2e46SMasahiro Yamada out: 263762c2e46SMasahiro Yamada of_node_put(gpiospec.np); 264762c2e46SMasahiro Yamada 265762c2e46SMasahiro Yamada return desc; 266f141ed65SGrant Likely } 267f141ed65SGrant Likely 268f01d9075SAlexandre Courbot int of_get_named_gpio_flags(struct device_node *np, const char *list_name, 269f01d9075SAlexandre Courbot int index, enum of_gpio_flags *flags) 270f01d9075SAlexandre Courbot { 271f01d9075SAlexandre Courbot struct gpio_desc *desc; 272f01d9075SAlexandre Courbot 273f01d9075SAlexandre Courbot desc = of_get_named_gpiod_flags(np, list_name, index, flags); 274f01d9075SAlexandre Courbot 275f01d9075SAlexandre Courbot if (IS_ERR(desc)) 276f01d9075SAlexandre Courbot return PTR_ERR(desc); 277f01d9075SAlexandre Courbot else 278f01d9075SAlexandre Courbot return desc_to_gpio(desc); 279f01d9075SAlexandre Courbot } 2806d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_get_named_gpio_flags); 281f01d9075SAlexandre Courbot 282f626d6dfSLinus Walleij /** 283f626d6dfSLinus Walleij * gpiod_get_from_of_node() - obtain a GPIO from an OF node 284f626d6dfSLinus Walleij * @node: handle of the OF node 285f626d6dfSLinus Walleij * @propname: name of the DT property representing the GPIO 286f626d6dfSLinus Walleij * @index: index of the GPIO to obtain for the consumer 287f626d6dfSLinus Walleij * @dflags: GPIO initialization flags 288f626d6dfSLinus Walleij * @label: label to attach to the requested GPIO 289f626d6dfSLinus Walleij * 290f626d6dfSLinus Walleij * Returns: 291f626d6dfSLinus Walleij * On successful request the GPIO pin is configured in accordance with 292f626d6dfSLinus Walleij * provided @dflags. 293f626d6dfSLinus Walleij * 294f626d6dfSLinus Walleij * In case of error an ERR_PTR() is returned. 295f626d6dfSLinus Walleij */ 296f626d6dfSLinus Walleij struct gpio_desc *gpiod_get_from_of_node(struct device_node *node, 297f626d6dfSLinus Walleij const char *propname, int index, 298f626d6dfSLinus Walleij enum gpiod_flags dflags, 299f626d6dfSLinus Walleij const char *label) 300f626d6dfSLinus Walleij { 301f626d6dfSLinus Walleij unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 302f626d6dfSLinus Walleij struct gpio_desc *desc; 303f626d6dfSLinus Walleij enum of_gpio_flags flags; 304f626d6dfSLinus Walleij bool active_low = false; 305f626d6dfSLinus Walleij bool single_ended = false; 306f626d6dfSLinus Walleij bool open_drain = false; 307f626d6dfSLinus Walleij bool transitory = false; 308f626d6dfSLinus Walleij int ret; 309f626d6dfSLinus Walleij 310f626d6dfSLinus Walleij desc = of_get_named_gpiod_flags(node, propname, 311f626d6dfSLinus Walleij index, &flags); 312f626d6dfSLinus Walleij 313f626d6dfSLinus Walleij if (!desc || IS_ERR(desc)) { 314f626d6dfSLinus Walleij return desc; 315f626d6dfSLinus Walleij } 316f626d6dfSLinus Walleij 317f626d6dfSLinus Walleij active_low = flags & OF_GPIO_ACTIVE_LOW; 318f626d6dfSLinus Walleij single_ended = flags & OF_GPIO_SINGLE_ENDED; 319f626d6dfSLinus Walleij open_drain = flags & OF_GPIO_OPEN_DRAIN; 320f626d6dfSLinus Walleij transitory = flags & OF_GPIO_TRANSITORY; 321f626d6dfSLinus Walleij 322f626d6dfSLinus Walleij ret = gpiod_request(desc, label); 323be7ae45cSMarco Felsch if (ret == -EBUSY && (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE)) 324f626d6dfSLinus Walleij return desc; 325f626d6dfSLinus Walleij if (ret) 326f626d6dfSLinus Walleij return ERR_PTR(ret); 327f626d6dfSLinus Walleij 328f626d6dfSLinus Walleij if (active_low) 329f626d6dfSLinus Walleij lflags |= GPIO_ACTIVE_LOW; 330f626d6dfSLinus Walleij 331f626d6dfSLinus Walleij if (single_ended) { 332f626d6dfSLinus Walleij if (open_drain) 333f626d6dfSLinus Walleij lflags |= GPIO_OPEN_DRAIN; 334f626d6dfSLinus Walleij else 335f626d6dfSLinus Walleij lflags |= GPIO_OPEN_SOURCE; 336f626d6dfSLinus Walleij } 337f626d6dfSLinus Walleij 338f626d6dfSLinus Walleij if (transitory) 339f626d6dfSLinus Walleij lflags |= GPIO_TRANSITORY; 340f626d6dfSLinus Walleij 341f626d6dfSLinus Walleij ret = gpiod_configure_flags(desc, propname, lflags, dflags); 342f626d6dfSLinus Walleij if (ret < 0) { 343f626d6dfSLinus Walleij gpiod_put(desc); 344f626d6dfSLinus Walleij return ERR_PTR(ret); 345f626d6dfSLinus Walleij } 346f626d6dfSLinus Walleij 347f626d6dfSLinus Walleij return desc; 348f626d6dfSLinus Walleij } 3496d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(gpiod_get_from_of_node); 350f141ed65SGrant Likely 351c8582339SLinus Walleij /* 352c8582339SLinus Walleij * The SPI GPIO bindings happened before we managed to establish that GPIO 353c8582339SLinus Walleij * properties should be named "foo-gpios" so we have this special kludge for 354c8582339SLinus Walleij * them. 355c8582339SLinus Walleij */ 356c8582339SLinus Walleij static struct gpio_desc *of_find_spi_gpio(struct device *dev, const char *con_id, 357c8582339SLinus Walleij enum of_gpio_flags *of_flags) 358c8582339SLinus Walleij { 359c8582339SLinus Walleij char prop_name[32]; /* 32 is max size of property name */ 360c8582339SLinus Walleij struct device_node *np = dev->of_node; 361c8582339SLinus Walleij struct gpio_desc *desc; 362c8582339SLinus Walleij 363c8582339SLinus Walleij /* 364c8582339SLinus Walleij * Hopefully the compiler stubs the rest of the function if this 365c8582339SLinus Walleij * is false. 366c8582339SLinus Walleij */ 367c8582339SLinus Walleij if (!IS_ENABLED(CONFIG_SPI_MASTER)) 368c8582339SLinus Walleij return ERR_PTR(-ENOENT); 369c8582339SLinus Walleij 370c8582339SLinus Walleij /* Allow this specifically for "spi-gpio" devices */ 371c8582339SLinus Walleij if (!of_device_is_compatible(np, "spi-gpio") || !con_id) 372c8582339SLinus Walleij return ERR_PTR(-ENOENT); 373c8582339SLinus Walleij 374c8582339SLinus Walleij /* Will be "gpio-sck", "gpio-mosi" or "gpio-miso" */ 375c8582339SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s-%s", "gpio", con_id); 376c8582339SLinus Walleij 377c8582339SLinus Walleij desc = of_get_named_gpiod_flags(np, prop_name, 0, of_flags); 378c8582339SLinus Walleij return desc; 379c8582339SLinus Walleij } 380c8582339SLinus Walleij 3816a537d48SLinus Walleij /* 382e3023bf8SLinus Walleij * The old Freescale bindings use simply "gpios" as name for the chip select 383e3023bf8SLinus Walleij * lines rather than "cs-gpios" like all other SPI hardware. Account for this 384e3023bf8SLinus Walleij * with a special quirk. 385e3023bf8SLinus Walleij */ 386e3023bf8SLinus Walleij static struct gpio_desc *of_find_spi_cs_gpio(struct device *dev, 387e3023bf8SLinus Walleij const char *con_id, 388e3023bf8SLinus Walleij unsigned int idx, 389e3023bf8SLinus Walleij unsigned long *flags) 390e3023bf8SLinus Walleij { 391e3023bf8SLinus Walleij struct device_node *np = dev->of_node; 392e3023bf8SLinus Walleij 393e3023bf8SLinus Walleij if (!IS_ENABLED(CONFIG_SPI_MASTER)) 394e3023bf8SLinus Walleij return ERR_PTR(-ENOENT); 395e3023bf8SLinus Walleij 396e3023bf8SLinus Walleij /* Allow this specifically for Freescale devices */ 397e3023bf8SLinus Walleij if (!of_device_is_compatible(np, "fsl,spi") && 398e3023bf8SLinus Walleij !of_device_is_compatible(np, "aeroflexgaisler,spictrl")) 399e3023bf8SLinus Walleij return ERR_PTR(-ENOENT); 400e3023bf8SLinus Walleij /* Allow only if asking for "cs-gpios" */ 401e3023bf8SLinus Walleij if (!con_id || strcmp(con_id, "cs")) 402e3023bf8SLinus Walleij return ERR_PTR(-ENOENT); 403e3023bf8SLinus Walleij 404e3023bf8SLinus Walleij /* 405e3023bf8SLinus Walleij * While all other SPI controllers use "cs-gpios" the Freescale 406e3023bf8SLinus Walleij * uses just "gpios" so translate to that when "cs-gpios" is 407e3023bf8SLinus Walleij * requested. 408e3023bf8SLinus Walleij */ 409e3023bf8SLinus Walleij return of_find_gpio(dev, NULL, idx, flags); 410e3023bf8SLinus Walleij } 411e3023bf8SLinus Walleij 412e3023bf8SLinus Walleij /* 4136a537d48SLinus Walleij * Some regulator bindings happened before we managed to establish that GPIO 4146a537d48SLinus Walleij * properties should be named "foo-gpios" so we have this special kludge for 4156a537d48SLinus Walleij * them. 4166a537d48SLinus Walleij */ 4176a537d48SLinus Walleij static struct gpio_desc *of_find_regulator_gpio(struct device *dev, const char *con_id, 4186a537d48SLinus Walleij enum of_gpio_flags *of_flags) 4196a537d48SLinus Walleij { 4206a537d48SLinus Walleij /* These are the connection IDs we accept as legacy GPIO phandles */ 4216a537d48SLinus Walleij const char *whitelist[] = { 4226a537d48SLinus Walleij "wlf,ldoena", /* Arizona */ 4236a537d48SLinus Walleij "wlf,ldo1ena", /* WM8994 */ 4246a537d48SLinus Walleij "wlf,ldo2ena", /* WM8994 */ 4256a537d48SLinus Walleij }; 4266a537d48SLinus Walleij struct device_node *np = dev->of_node; 4276a537d48SLinus Walleij struct gpio_desc *desc; 4286a537d48SLinus Walleij int i; 4296a537d48SLinus Walleij 4306a537d48SLinus Walleij if (!IS_ENABLED(CONFIG_REGULATOR)) 4316a537d48SLinus Walleij return ERR_PTR(-ENOENT); 4326a537d48SLinus Walleij 4336a537d48SLinus Walleij if (!con_id) 4346a537d48SLinus Walleij return ERR_PTR(-ENOENT); 4356a537d48SLinus Walleij 4364b21f94aSAndy Shevchenko i = match_string(whitelist, ARRAY_SIZE(whitelist), con_id); 4374b21f94aSAndy Shevchenko if (i < 0) 4386a537d48SLinus Walleij return ERR_PTR(-ENOENT); 4396a537d48SLinus Walleij 4406a537d48SLinus Walleij desc = of_get_named_gpiod_flags(np, con_id, 0, of_flags); 4416a537d48SLinus Walleij return desc; 4426a537d48SLinus Walleij } 4436a537d48SLinus Walleij 44411c43bb0SDmitry Torokhov static struct gpio_desc *of_find_arizona_gpio(struct device *dev, 44511c43bb0SDmitry Torokhov const char *con_id, 44611c43bb0SDmitry Torokhov enum of_gpio_flags *of_flags) 44711c43bb0SDmitry Torokhov { 44811c43bb0SDmitry Torokhov if (!IS_ENABLED(CONFIG_MFD_ARIZONA)) 44911c43bb0SDmitry Torokhov return ERR_PTR(-ENOENT); 45011c43bb0SDmitry Torokhov 45111c43bb0SDmitry Torokhov if (!con_id || strcmp(con_id, "wlf,reset")) 45211c43bb0SDmitry Torokhov return ERR_PTR(-ENOENT); 45311c43bb0SDmitry Torokhov 45411c43bb0SDmitry Torokhov return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags); 45511c43bb0SDmitry Torokhov } 45611c43bb0SDmitry Torokhov 457ea713bc4SLinus Walleij struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id, 458fed7026aSAndy Shevchenko unsigned int idx, unsigned long *flags) 459ea713bc4SLinus Walleij { 460ea713bc4SLinus Walleij char prop_name[32]; /* 32 is max size of property name */ 461ea713bc4SLinus Walleij enum of_gpio_flags of_flags; 462ea713bc4SLinus Walleij struct gpio_desc *desc; 463ea713bc4SLinus Walleij unsigned int i; 464ea713bc4SLinus Walleij 465c8582339SLinus Walleij /* Try GPIO property "foo-gpios" and "foo-gpio" */ 466ea713bc4SLinus Walleij for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) { 467ea713bc4SLinus Walleij if (con_id) 468ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id, 469ea713bc4SLinus Walleij gpio_suffixes[i]); 470ea713bc4SLinus Walleij else 471ea713bc4SLinus Walleij snprintf(prop_name, sizeof(prop_name), "%s", 472ea713bc4SLinus Walleij gpio_suffixes[i]); 473ea713bc4SLinus Walleij 474ea713bc4SLinus Walleij desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx, 475ea713bc4SLinus Walleij &of_flags); 4766662ae6aSMaxime Ripard 4771dea33e8SDmitry Torokhov if (!IS_ERR(desc) || PTR_ERR(desc) != -ENOENT) 478ea713bc4SLinus Walleij break; 479ea713bc4SLinus Walleij } 480ea713bc4SLinus Walleij 4811dea33e8SDmitry Torokhov if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) { 482c8582339SLinus Walleij /* Special handling for SPI GPIOs if used */ 483c8582339SLinus Walleij desc = of_find_spi_gpio(dev, con_id, &of_flags); 4841dea33e8SDmitry Torokhov } 4851dea33e8SDmitry Torokhov 4861dea33e8SDmitry Torokhov if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) { 487e3023bf8SLinus Walleij /* This quirk looks up flags and all */ 488e3023bf8SLinus Walleij desc = of_find_spi_cs_gpio(dev, con_id, idx, flags); 489e3023bf8SLinus Walleij if (!IS_ERR(desc)) 490e3023bf8SLinus Walleij return desc; 491e3023bf8SLinus Walleij } 492c8582339SLinus Walleij 4931dea33e8SDmitry Torokhov if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) { 4946a537d48SLinus Walleij /* Special handling for regulator GPIOs if used */ 4956a537d48SLinus Walleij desc = of_find_regulator_gpio(dev, con_id, &of_flags); 4961dea33e8SDmitry Torokhov } 4976a537d48SLinus Walleij 49811c43bb0SDmitry Torokhov if (IS_ERR(desc) && PTR_ERR(desc) == -ENOENT) 49911c43bb0SDmitry Torokhov desc = of_find_arizona_gpio(dev, con_id, &of_flags); 50011c43bb0SDmitry Torokhov 501ea713bc4SLinus Walleij if (IS_ERR(desc)) 502ea713bc4SLinus Walleij return desc; 503ea713bc4SLinus Walleij 504ea713bc4SLinus Walleij if (of_flags & OF_GPIO_ACTIVE_LOW) 505ea713bc4SLinus Walleij *flags |= GPIO_ACTIVE_LOW; 506ea713bc4SLinus Walleij 507ea713bc4SLinus Walleij if (of_flags & OF_GPIO_SINGLE_ENDED) { 5084c0facddSLaxman Dewangan if (of_flags & OF_GPIO_OPEN_DRAIN) 509ea713bc4SLinus Walleij *flags |= GPIO_OPEN_DRAIN; 510ea713bc4SLinus Walleij else 511ea713bc4SLinus Walleij *flags |= GPIO_OPEN_SOURCE; 512ea713bc4SLinus Walleij } 513ea713bc4SLinus Walleij 514e10f72bfSAndrew Jeffery if (of_flags & OF_GPIO_TRANSITORY) 515e10f72bfSAndrew Jeffery *flags |= GPIO_TRANSITORY; 51605f479bfSCharles Keepax 517d449991cSThomas Petazzoni if (of_flags & OF_GPIO_PULL_UP) 518d449991cSThomas Petazzoni *flags |= GPIO_PULL_UP; 519d449991cSThomas Petazzoni if (of_flags & OF_GPIO_PULL_DOWN) 520d449991cSThomas Petazzoni *flags |= GPIO_PULL_DOWN; 521d449991cSThomas Petazzoni 522ea713bc4SLinus Walleij return desc; 523ea713bc4SLinus Walleij } 524ea713bc4SLinus Walleij 525f141ed65SGrant Likely /** 526fd7337fdSMarkus Pargmann * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API 527f625d460SBenoit Parrot * @np: device node to get GPIO from 528be715343SMasahiro Yamada * @chip: GPIO chip whose hog is parsed 529a79fead5SGeert Uytterhoeven * @idx: Index of the GPIO to parse 530f625d460SBenoit Parrot * @name: GPIO line name 531fed7026aSAndy Shevchenko * @lflags: bitmask of gpio_lookup_flags GPIO_* values - returned from 532fed7026aSAndy Shevchenko * of_find_gpio() or of_parse_own_gpio() 533f625d460SBenoit Parrot * @dflags: gpiod_flags - optional GPIO initialization flags 534f625d460SBenoit Parrot * 535f625d460SBenoit Parrot * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno 536f625d460SBenoit Parrot * value on the error condition. 537f625d460SBenoit Parrot */ 538fd7337fdSMarkus Pargmann static struct gpio_desc *of_parse_own_gpio(struct device_node *np, 539be715343SMasahiro Yamada struct gpio_chip *chip, 540a79fead5SGeert Uytterhoeven unsigned int idx, const char **name, 541fed7026aSAndy Shevchenko unsigned long *lflags, 542f625d460SBenoit Parrot enum gpiod_flags *dflags) 543f625d460SBenoit Parrot { 544f625d460SBenoit Parrot struct device_node *chip_np; 545f625d460SBenoit Parrot enum of_gpio_flags xlate_flags; 546be715343SMasahiro Yamada struct of_phandle_args gpiospec; 547be715343SMasahiro Yamada struct gpio_desc *desc; 548a79fead5SGeert Uytterhoeven unsigned int i; 549f625d460SBenoit Parrot u32 tmp; 5503f9547e1SMasahiro Yamada int ret; 551f625d460SBenoit Parrot 552be715343SMasahiro Yamada chip_np = chip->of_node; 553f625d460SBenoit Parrot if (!chip_np) 554f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 555f625d460SBenoit Parrot 556f625d460SBenoit Parrot xlate_flags = 0; 5572d6c06f5SAndy Shevchenko *lflags = GPIO_LOOKUP_FLAGS_DEFAULT; 558f625d460SBenoit Parrot *dflags = 0; 559f625d460SBenoit Parrot 560f625d460SBenoit Parrot ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp); 561f625d460SBenoit Parrot if (ret) 562f625d460SBenoit Parrot return ERR_PTR(ret); 563f625d460SBenoit Parrot 564be715343SMasahiro Yamada gpiospec.np = chip_np; 565be715343SMasahiro Yamada gpiospec.args_count = tmp; 566f625d460SBenoit Parrot 567a79fead5SGeert Uytterhoeven for (i = 0; i < tmp; i++) { 568a79fead5SGeert Uytterhoeven ret = of_property_read_u32_index(np, "gpios", idx * tmp + i, 569a79fead5SGeert Uytterhoeven &gpiospec.args[i]); 570f625d460SBenoit Parrot if (ret) 571f625d460SBenoit Parrot return ERR_PTR(ret); 572a79fead5SGeert Uytterhoeven } 573f625d460SBenoit Parrot 57499468c1aSMasahiro Yamada desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags); 575be715343SMasahiro Yamada if (IS_ERR(desc)) 576be715343SMasahiro Yamada return desc; 577f625d460SBenoit Parrot 578f625d460SBenoit Parrot if (xlate_flags & OF_GPIO_ACTIVE_LOW) 579f625d460SBenoit Parrot *lflags |= GPIO_ACTIVE_LOW; 580e10f72bfSAndrew Jeffery if (xlate_flags & OF_GPIO_TRANSITORY) 581e10f72bfSAndrew Jeffery *lflags |= GPIO_TRANSITORY; 582f625d460SBenoit Parrot 583f625d460SBenoit Parrot if (of_property_read_bool(np, "input")) 584f625d460SBenoit Parrot *dflags |= GPIOD_IN; 585f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-low")) 586f625d460SBenoit Parrot *dflags |= GPIOD_OUT_LOW; 587f625d460SBenoit Parrot else if (of_property_read_bool(np, "output-high")) 588f625d460SBenoit Parrot *dflags |= GPIOD_OUT_HIGH; 589f625d460SBenoit Parrot else { 59062cdcb6cSRob Herring pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n", 59162cdcb6cSRob Herring desc_to_gpio(desc), np); 592f625d460SBenoit Parrot return ERR_PTR(-EINVAL); 593f625d460SBenoit Parrot } 594f625d460SBenoit Parrot 595f625d460SBenoit Parrot if (name && of_property_read_string(np, "line-name", name)) 596f625d460SBenoit Parrot *name = np->name; 597f625d460SBenoit Parrot 598be715343SMasahiro Yamada return desc; 599f625d460SBenoit Parrot } 600f625d460SBenoit Parrot 601f625d460SBenoit Parrot /** 602fd7337fdSMarkus Pargmann * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions 603f625d460SBenoit Parrot * @chip: gpio chip to act on 604f625d460SBenoit Parrot * 605f625d460SBenoit Parrot * This is only used by of_gpiochip_add to request/set GPIO initial 606f625d460SBenoit Parrot * configuration. 607ead066e6SGeert Uytterhoeven * It returns error if it fails otherwise 0 on success. 608f625d460SBenoit Parrot */ 609dfbd379bSLaxman Dewangan static int of_gpiochip_scan_gpios(struct gpio_chip *chip) 610f625d460SBenoit Parrot { 611f625d460SBenoit Parrot struct gpio_desc *desc = NULL; 612f625d460SBenoit Parrot struct device_node *np; 613f625d460SBenoit Parrot const char *name; 614fed7026aSAndy Shevchenko unsigned long lflags; 615f625d460SBenoit Parrot enum gpiod_flags dflags; 616a79fead5SGeert Uytterhoeven unsigned int i; 617dfbd379bSLaxman Dewangan int ret; 618f625d460SBenoit Parrot 619d1279d94SLaxman Dewangan for_each_available_child_of_node(chip->of_node, np) { 620f625d460SBenoit Parrot if (!of_property_read_bool(np, "gpio-hog")) 621f625d460SBenoit Parrot continue; 622f625d460SBenoit Parrot 623a79fead5SGeert Uytterhoeven for (i = 0;; i++) { 624a79fead5SGeert Uytterhoeven desc = of_parse_own_gpio(np, chip, i, &name, &lflags, 625a79fead5SGeert Uytterhoeven &dflags); 626f625d460SBenoit Parrot if (IS_ERR(desc)) 627a79fead5SGeert Uytterhoeven break; 628f625d460SBenoit Parrot 629dfbd379bSLaxman Dewangan ret = gpiod_hog(desc, name, lflags, dflags); 63009e258afSWei Yongjun if (ret < 0) { 63109e258afSWei Yongjun of_node_put(np); 632dfbd379bSLaxman Dewangan return ret; 633f625d460SBenoit Parrot } 63409e258afSWei Yongjun } 635a79fead5SGeert Uytterhoeven } 636dfbd379bSLaxman Dewangan 637dfbd379bSLaxman Dewangan return 0; 638f625d460SBenoit Parrot } 639f625d460SBenoit Parrot 640f625d460SBenoit Parrot /** 64167049c50SThierry Reding * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags 642f141ed65SGrant Likely * @gc: pointer to the gpio_chip structure 64367049c50SThierry Reding * @gpiospec: GPIO specifier as found in the device tree 644f141ed65SGrant Likely * @flags: a flags pointer to fill in 645f141ed65SGrant Likely * 646f141ed65SGrant Likely * This is simple translation function, suitable for the most 1:1 mapped 64767049c50SThierry Reding * GPIO chips. This function performs only one sanity check: whether GPIO 648f141ed65SGrant Likely * is less than ngpios (that is specified in the gpio_chip). 649f141ed65SGrant Likely */ 650b0c7e73bSGeert Uytterhoeven static int of_gpio_simple_xlate(struct gpio_chip *gc, 651b0c7e73bSGeert Uytterhoeven const struct of_phandle_args *gpiospec, 652b0c7e73bSGeert Uytterhoeven u32 *flags) 653f141ed65SGrant Likely { 654f141ed65SGrant Likely /* 655f141ed65SGrant Likely * We're discouraging gpio_cells < 2, since that way you'll have to 65620a8a968SColin Cronin * write your own xlate function (that will have to retrieve the GPIO 657f141ed65SGrant Likely * number and the flags from a single gpio cell -- this is possible, 658f141ed65SGrant Likely * but not recommended). 659f141ed65SGrant Likely */ 660f141ed65SGrant Likely if (gc->of_gpio_n_cells < 2) { 661f141ed65SGrant Likely WARN_ON(1); 662f141ed65SGrant Likely return -EINVAL; 663f141ed65SGrant Likely } 664f141ed65SGrant Likely 665f141ed65SGrant Likely if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells)) 666f141ed65SGrant Likely return -EINVAL; 667f141ed65SGrant Likely 6687b96c686SGrant Likely if (gpiospec->args[0] >= gc->ngpio) 669f141ed65SGrant Likely return -EINVAL; 670f141ed65SGrant Likely 671f141ed65SGrant Likely if (flags) 672f141ed65SGrant Likely *flags = gpiospec->args[1]; 673f141ed65SGrant Likely 674f141ed65SGrant Likely return gpiospec->args[0]; 675f141ed65SGrant Likely } 676f141ed65SGrant Likely 677f141ed65SGrant Likely /** 6783208b0f0SLinus Walleij * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank) 679f141ed65SGrant Likely * @np: device node of the GPIO chip 680f141ed65SGrant Likely * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 6813208b0f0SLinus Walleij * @data: driver data to store in the struct gpio_chip 682f141ed65SGrant Likely * 683f141ed65SGrant Likely * To use this function you should allocate and fill mm_gc with: 684f141ed65SGrant Likely * 685f141ed65SGrant Likely * 1) In the gpio_chip structure: 686f141ed65SGrant Likely * - all the callbacks 687f141ed65SGrant Likely * - of_gpio_n_cells 688f141ed65SGrant Likely * - of_xlate callback (optional) 689f141ed65SGrant Likely * 690f141ed65SGrant Likely * 3) In the of_mm_gpio_chip structure: 691f141ed65SGrant Likely * - save_regs callback (optional) 692f141ed65SGrant Likely * 693f141ed65SGrant Likely * If succeeded, this function will map bank's memory and will 694f141ed65SGrant Likely * do all necessary work for you. Then you'll able to use .regs 695f141ed65SGrant Likely * to manage GPIOs from the callbacks. 696f141ed65SGrant Likely */ 6973208b0f0SLinus Walleij int of_mm_gpiochip_add_data(struct device_node *np, 6983208b0f0SLinus Walleij struct of_mm_gpio_chip *mm_gc, 6993208b0f0SLinus Walleij void *data) 700f141ed65SGrant Likely { 701f141ed65SGrant Likely int ret = -ENOMEM; 702f141ed65SGrant Likely struct gpio_chip *gc = &mm_gc->gc; 703f141ed65SGrant Likely 7047eb6ce2fSRob Herring gc->label = kasprintf(GFP_KERNEL, "%pOF", np); 705f141ed65SGrant Likely if (!gc->label) 706f141ed65SGrant Likely goto err0; 707f141ed65SGrant Likely 708f141ed65SGrant Likely mm_gc->regs = of_iomap(np, 0); 709f141ed65SGrant Likely if (!mm_gc->regs) 710f141ed65SGrant Likely goto err1; 711f141ed65SGrant Likely 712f141ed65SGrant Likely gc->base = -1; 713f141ed65SGrant Likely 714f141ed65SGrant Likely if (mm_gc->save_regs) 715f141ed65SGrant Likely mm_gc->save_regs(mm_gc); 716f141ed65SGrant Likely 717f141ed65SGrant Likely mm_gc->gc.of_node = np; 718f141ed65SGrant Likely 7193208b0f0SLinus Walleij ret = gpiochip_add_data(gc, data); 720f141ed65SGrant Likely if (ret) 721f141ed65SGrant Likely goto err2; 722f141ed65SGrant Likely 723f141ed65SGrant Likely return 0; 724f141ed65SGrant Likely err2: 725f141ed65SGrant Likely iounmap(mm_gc->regs); 726f141ed65SGrant Likely err1: 727f141ed65SGrant Likely kfree(gc->label); 728f141ed65SGrant Likely err0: 7297eb6ce2fSRob Herring pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret); 730f141ed65SGrant Likely return ret; 731f141ed65SGrant Likely } 7326d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data); 733f141ed65SGrant Likely 734d621e8baSRicardo Ribalda Delgado /** 735d621e8baSRicardo Ribalda Delgado * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank) 736d621e8baSRicardo Ribalda Delgado * @mm_gc: pointer to the of_mm_gpio_chip allocated structure 737d621e8baSRicardo Ribalda Delgado */ 738d621e8baSRicardo Ribalda Delgado void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc) 739d621e8baSRicardo Ribalda Delgado { 740d621e8baSRicardo Ribalda Delgado struct gpio_chip *gc = &mm_gc->gc; 741d621e8baSRicardo Ribalda Delgado 742d621e8baSRicardo Ribalda Delgado if (!mm_gc) 743d621e8baSRicardo Ribalda Delgado return; 744d621e8baSRicardo Ribalda Delgado 745d621e8baSRicardo Ribalda Delgado gpiochip_remove(gc); 746d621e8baSRicardo Ribalda Delgado iounmap(mm_gc->regs); 747d621e8baSRicardo Ribalda Delgado kfree(gc->label); 748d621e8baSRicardo Ribalda Delgado } 7496d662455SGeert Uytterhoeven EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove); 750d621e8baSRicardo Ribalda Delgado 751726cb3baSStephen Boyd static void of_gpiochip_init_valid_mask(struct gpio_chip *chip) 752726cb3baSStephen Boyd { 753726cb3baSStephen Boyd int len, i; 754726cb3baSStephen Boyd u32 start, count; 755726cb3baSStephen Boyd struct device_node *np = chip->of_node; 756726cb3baSStephen Boyd 757726cb3baSStephen Boyd len = of_property_count_u32_elems(np, "gpio-reserved-ranges"); 758726cb3baSStephen Boyd if (len < 0 || len % 2 != 0) 759726cb3baSStephen Boyd return; 760726cb3baSStephen Boyd 761726cb3baSStephen Boyd for (i = 0; i < len; i += 2) { 762726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 763726cb3baSStephen Boyd i, &start); 764726cb3baSStephen Boyd of_property_read_u32_index(np, "gpio-reserved-ranges", 765726cb3baSStephen Boyd i + 1, &count); 766726cb3baSStephen Boyd if (start >= chip->ngpio || start + count >= chip->ngpio) 767726cb3baSStephen Boyd continue; 768726cb3baSStephen Boyd 769726cb3baSStephen Boyd bitmap_clear(chip->valid_mask, start, count); 770726cb3baSStephen Boyd } 771726cb3baSStephen Boyd }; 772726cb3baSStephen Boyd 773f23f1516SShiraz Hashim #ifdef CONFIG_PINCTRL 77428355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) 775f23f1516SShiraz Hashim { 776f23f1516SShiraz Hashim struct device_node *np = chip->of_node; 777f23f1516SShiraz Hashim struct of_phandle_args pinspec; 7781e63d7b9SLinus Walleij struct pinctrl_dev *pctldev; 779f23f1516SShiraz Hashim int index = 0, ret; 780586a87e6SChristian Ruppert const char *name; 781586a87e6SChristian Ruppert static const char group_names_propname[] = "gpio-ranges-group-names"; 782586a87e6SChristian Ruppert struct property *group_names; 783f23f1516SShiraz Hashim 784f23f1516SShiraz Hashim if (!np) 78528355f81STomeu Vizoso return 0; 786f23f1516SShiraz Hashim 787586a87e6SChristian Ruppert group_names = of_find_property(np, group_names_propname, NULL); 788586a87e6SChristian Ruppert 789ad4e1a7cSHaojian Zhuang for (;; index++) { 790d9fe0039SStephen Warren ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3, 791d9fe0039SStephen Warren index, &pinspec); 792f23f1516SShiraz Hashim if (ret) 793f23f1516SShiraz Hashim break; 794f23f1516SShiraz Hashim 7951e63d7b9SLinus Walleij pctldev = of_pinctrl_get(pinspec.np); 796602cf638SMasahiro Yamada of_node_put(pinspec.np); 7971e63d7b9SLinus Walleij if (!pctldev) 79828355f81STomeu Vizoso return -EPROBE_DEFER; 799f23f1516SShiraz Hashim 800586a87e6SChristian Ruppert if (pinspec.args[2]) { 801586a87e6SChristian Ruppert if (group_names) { 80272858602SLaurent Navet of_property_read_string_index(np, 803586a87e6SChristian Ruppert group_names_propname, 804586a87e6SChristian Ruppert index, &name); 805586a87e6SChristian Ruppert if (strlen(name)) { 8067eb6ce2fSRob Herring pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n", 8077eb6ce2fSRob Herring np); 808586a87e6SChristian Ruppert break; 809586a87e6SChristian Ruppert } 810586a87e6SChristian Ruppert } 811586a87e6SChristian Ruppert /* npins != 0: linear range */ 8121e63d7b9SLinus Walleij ret = gpiochip_add_pin_range(chip, 813ef5e3eefSHaojian Zhuang pinctrl_dev_get_devname(pctldev), 8141e63d7b9SLinus Walleij pinspec.args[0], 81586853c83SHaojian Zhuang pinspec.args[1], 81686853c83SHaojian Zhuang pinspec.args[2]); 8171e63d7b9SLinus Walleij if (ret) 81828355f81STomeu Vizoso return ret; 819586a87e6SChristian Ruppert } else { 820586a87e6SChristian Ruppert /* npins == 0: special range */ 821586a87e6SChristian Ruppert if (pinspec.args[1]) { 8227eb6ce2fSRob Herring pr_err("%pOF: Illegal gpio-range format.\n", 8237eb6ce2fSRob Herring np); 824586a87e6SChristian Ruppert break; 825586a87e6SChristian Ruppert } 826586a87e6SChristian Ruppert 827586a87e6SChristian Ruppert if (!group_names) { 8287eb6ce2fSRob Herring pr_err("%pOF: GPIO group range requested but no %s property.\n", 8297eb6ce2fSRob Herring np, group_names_propname); 830586a87e6SChristian Ruppert break; 831586a87e6SChristian Ruppert } 832586a87e6SChristian Ruppert 833586a87e6SChristian Ruppert ret = of_property_read_string_index(np, 834586a87e6SChristian Ruppert group_names_propname, 835586a87e6SChristian Ruppert index, &name); 836586a87e6SChristian Ruppert if (ret) 837586a87e6SChristian Ruppert break; 838586a87e6SChristian Ruppert 839586a87e6SChristian Ruppert if (!strlen(name)) { 8407eb6ce2fSRob Herring pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n", 8417eb6ce2fSRob Herring np); 842586a87e6SChristian Ruppert break; 843586a87e6SChristian Ruppert } 844586a87e6SChristian Ruppert 845586a87e6SChristian Ruppert ret = gpiochip_add_pingroup_range(chip, pctldev, 846586a87e6SChristian Ruppert pinspec.args[0], name); 847586a87e6SChristian Ruppert if (ret) 84828355f81STomeu Vizoso return ret; 849586a87e6SChristian Ruppert } 850ad4e1a7cSHaojian Zhuang } 85128355f81STomeu Vizoso 85228355f81STomeu Vizoso return 0; 853f23f1516SShiraz Hashim } 854f23f1516SShiraz Hashim 855f23f1516SShiraz Hashim #else 85628355f81STomeu Vizoso static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; } 857f23f1516SShiraz Hashim #endif 858f23f1516SShiraz Hashim 85928355f81STomeu Vizoso int of_gpiochip_add(struct gpio_chip *chip) 860f141ed65SGrant Likely { 861f0d1ab05SLinus Walleij int ret; 86228355f81STomeu Vizoso 863f141ed65SGrant Likely if (!chip->of_node) 86428355f81STomeu Vizoso return 0; 865f141ed65SGrant Likely 866f141ed65SGrant Likely if (!chip->of_xlate) { 867f141ed65SGrant Likely chip->of_gpio_n_cells = 2; 868f141ed65SGrant Likely chip->of_xlate = of_gpio_simple_xlate; 869f141ed65SGrant Likely } 870f141ed65SGrant Likely 8711020dfd1SMasahiro Yamada if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS) 8721020dfd1SMasahiro Yamada return -EINVAL; 8731020dfd1SMasahiro Yamada 874726cb3baSStephen Boyd of_gpiochip_init_valid_mask(chip); 875726cb3baSStephen Boyd 876f0d1ab05SLinus Walleij ret = of_gpiochip_add_pin_range(chip); 877f0d1ab05SLinus Walleij if (ret) 878f0d1ab05SLinus Walleij return ret; 87928355f81STomeu Vizoso 880fd9c5531SLinus Walleij /* If the chip defines names itself, these take precedence */ 881fd9c5531SLinus Walleij if (!chip->names) 88282270335SChristophe Leroy devprop_gpiochip_set_names(chip, 88382270335SChristophe Leroy of_fwnode_handle(chip->of_node)); 884fd9c5531SLinus Walleij 885f141ed65SGrant Likely of_node_get(chip->of_node); 886f625d460SBenoit Parrot 887f0d1ab05SLinus Walleij ret = of_gpiochip_scan_gpios(chip); 8882f4133bbSAndy Shevchenko if (ret) 889f7299d44SGeert Uytterhoeven of_node_put(chip->of_node); 890f7299d44SGeert Uytterhoeven 891f0d1ab05SLinus Walleij return ret; 892f141ed65SGrant Likely } 893f141ed65SGrant Likely 894f141ed65SGrant Likely void of_gpiochip_remove(struct gpio_chip *chip) 895f141ed65SGrant Likely { 896f141ed65SGrant Likely of_node_put(chip->of_node); 897f141ed65SGrant Likely } 898