drivers/gpio/gpiolib-of.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * OF helpers for the GPIO API
   4  *
   5  * Copyright (c) 2007-2008  MontaVista Software, Inc.
   6  *
   7  * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
   8  */
   9
  10 #include <linux/device.h>
  11 #include <linux/err.h>
  12 #include <linux/errno.h>
  13 #include <linux/module.h>
  14 #include <linux/io.h>
  15 #include <linux/gpio/consumer.h>
  16 #include <linux/of.h>
  17 #include <linux/of_address.h>
  18 #include <linux/of_gpio.h>
  19 #include <linux/pinctrl/pinctrl.h>
  20 #include <linux/slab.h>
  21 #include <linux/gpio/machine.h>
  22
  23 #include "gpiolib.h"
  24 #include "gpiolib-of.h"
  25
  26 /**
  27  * of_gpio_spi_cs_get_count() - special GPIO counting for SPI
  28  * @dev:    Consuming device
  29  * @con_id: Function within the GPIO consumer
  30  *
  31  * Some elder GPIO controllers need special quirks. Currently we handle
  32  * the Freescale and PPC GPIO controller with bindings that doesn't use the
  33  * established "cs-gpios" for chip selects but instead rely on
  34  * "gpios" for the chip select lines. If we detect this, we redirect
  35  * the counting of "cs-gpios" to count "gpios" transparent to the
  36  * driver.
  37  */
  38 static int of_gpio_spi_cs_get_count(struct device *dev, const char *con_id)
  39 {
  40         struct device_node *np = dev->of_node;
  41
  42         if (!IS_ENABLED(CONFIG_SPI_MASTER))
  43                 return 0;
  44         if (!con_id || strcmp(con_id, "cs"))
  45                 return 0;
  46         if (!of_device_is_compatible(np, "fsl,spi") &&
  47             !of_device_is_compatible(np, "aeroflexgaisler,spictrl") &&
  48             !of_device_is_compatible(np, "ibm,ppc4xx-spi"))
  49                 return 0;
  50         return of_gpio_named_count(np, "gpios");
  51 }
  52
  53 /*
  54  * This is used by external users of of_gpio_count() from <linux/of_gpio.h>
  55  *
  56  * FIXME: get rid of those external users by converting them to GPIO
  57  * descriptors and let them all use gpiod_count()
  58  */
  59 int of_gpio_get_count(struct device *dev, const char *con_id)
  60 {
  61         int ret;
  62         char propname[32];
  63         unsigned int i;
  64
  65         ret = of_gpio_spi_cs_get_count(dev, con_id);
  66         if (ret > 0)
  67                 return ret;
  68
  69         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
  70                 if (con_id)
  71                         snprintf(propname, sizeof(propname), "%s-%s",
  72                                  con_id, gpio_suffixes[i]);
  73                 else
  74                         snprintf(propname, sizeof(propname), "%s",
  75                                  gpio_suffixes[i]);
  76
  77                 ret = of_gpio_named_count(dev->of_node, propname);
  78                 if (ret > 0)
  79                         break;
  80         }
  81         return ret ? ret : -ENOENT;
  82 }
  83
  84 static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data)
  85 {
  86         struct of_phandle_args *gpiospec = data;
  87
  88         return chip->gpiodev->dev.of_node == gpiospec->np &&
  89                                 chip->of_xlate &&
  90                                 chip->of_xlate(chip, gpiospec, NULL) >= 0;
  91 }
  92
  93 static struct gpio_chip *of_find_gpiochip_by_xlate(
  94                                         struct of_phandle_args *gpiospec)
  95 {
  96         return gpiochip_find(gpiospec, of_gpiochip_match_node_and_xlate);
  97 }
  98
  99 static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip,
 100                                         struct of_phandle_args *gpiospec,
 101                                         enum of_gpio_flags *flags)
 102 {
 103         int ret;
 104
 105         if (chip->of_gpio_n_cells != gpiospec->args_count)
 106                 return ERR_PTR(-EINVAL);
 107
 108         ret = chip->of_xlate(chip, gpiospec, flags);
 109         if (ret < 0)
 110                 return ERR_PTR(ret);
 111
 112         return gpiochip_get_desc(chip, ret);
 113 }
 114
 115 /**
 116  * of_gpio_need_valid_mask() - figure out if the OF GPIO driver needs
 117  * to set the .valid_mask
 118  * @gc: the target gpio_chip
 119  *
 120  * Return: true if the valid mask needs to be set
 121  */
 122 bool of_gpio_need_valid_mask(const struct gpio_chip *gc)
 123 {
 124         int size;
 125         const struct device_node *np = gc->of_node;
 126
 127         size = of_property_count_u32_elems(np,  "gpio-reserved-ranges");
 128         if (size > 0 && size % 2 == 0)
 129                 return true;
 130         return false;
 131 }
 132
 133 static void of_gpio_flags_quirks(const struct device_node *np,
 134                                  const char *propname,
 135                                  enum of_gpio_flags *flags,
 136                                  int index)
 137 {
 138         /*
 139          * Some GPIO fixed regulator quirks.
 140          * Note that active low is the default.
 141          */
 142         if (IS_ENABLED(CONFIG_REGULATOR) &&
 143             (of_device_is_compatible(np, "regulator-fixed") ||
 144              of_device_is_compatible(np, "reg-fixed-voltage") ||
 145              (!(strcmp(propname, "enable-gpio") &&
 146                 strcmp(propname, "enable-gpios")) &&
 147               of_device_is_compatible(np, "regulator-gpio")))) {
 148                 bool active_low = !of_property_read_bool(np,
 149                                                          "enable-active-high");
 150                 /*
 151                  * The regulator GPIO handles are specified such that the
 152                  * presence or absence of "enable-active-high" solely controls
 153                  * the polarity of the GPIO line. Any phandle flags must
 154                  * be actively ignored.
 155                  */
 156                 if ((*flags & OF_GPIO_ACTIVE_LOW) && !active_low) {
 157                         pr_warn("%s GPIO handle specifies active low - ignored\n",
 158                                 of_node_full_name(np));
 159                         *flags &= ~OF_GPIO_ACTIVE_LOW;
 160                 }
 161                 if (active_low)
 162                         *flags |= OF_GPIO_ACTIVE_LOW;
 163         }
 164         /*
 165          * Legacy open drain handling for fixed voltage regulators.
 166          */
 167         if (IS_ENABLED(CONFIG_REGULATOR) &&
 168             of_device_is_compatible(np, "reg-fixed-voltage") &&
 169             of_property_read_bool(np, "gpio-open-drain")) {
 170                 *flags |= (OF_GPIO_SINGLE_ENDED | OF_GPIO_OPEN_DRAIN);
 171                 pr_info("%s uses legacy open drain flag - update the DTS if you can\n",
 172                         of_node_full_name(np));
 173         }
 174
 175         /*
 176          * Legacy handling of SPI active high chip select. If we have a
 177          * property named "cs-gpios" we need to inspect the child node
 178          * to determine if the flags should have inverted semantics.
 179          */
 180         if (IS_ENABLED(CONFIG_SPI_MASTER) && !strcmp(propname, "cs-gpios") &&
 181             of_property_read_bool(np, "cs-gpios")) {
 182                 struct device_node *child;
 183                 u32 cs;
 184                 int ret;
 185
 186                 for_each_child_of_node(np, child) {
 187                         ret = of_property_read_u32(child, "reg", &cs);
 188                         if (ret)
 189                                 continue;
 190                         if (cs == index) {
 191                                 /*
 192                                  * SPI children have active low chip selects
 193                                  * by default. This can be specified negatively
 194                                  * by just omitting "spi-cs-high" in the
 195                                  * device node, or actively by tagging on
 196                                  * GPIO_ACTIVE_LOW as flag in the device
 197                                  * tree. If the line is simultaneously
 198                                  * tagged as active low in the device tree
 199                                  * and has the "spi-cs-high" set, we get a
 200                                  * conflict and the "spi-cs-high" flag will
 201                                  * take precedence.
 202                                  */
 203                                 if (of_property_read_bool(child, "spi-cs-high")) {
 204                                         if (*flags & OF_GPIO_ACTIVE_LOW) {
 205                                                 pr_warn("%s GPIO handle specifies active low - ignored\n",
 206                                                         of_node_full_name(child));
 207                                                 *flags &= ~OF_GPIO_ACTIVE_LOW;
 208                                         }
 209                                 } else {
 210                                         if (!(*flags & OF_GPIO_ACTIVE_LOW))
 211                                                 pr_info("%s enforce active low on chipselect handle\n",
 212                                                         of_node_full_name(child));
 213                                         *flags |= OF_GPIO_ACTIVE_LOW;
 214                                 }
 215                                 of_node_put(child);
 216                                 break;
 217                         }
 218                 }
 219         }
 220
 221         /* Legacy handling of stmmac's active-low PHY reset line */
 222         if (IS_ENABLED(CONFIG_STMMAC_ETH) &&
 223             !strcmp(propname, "snps,reset-gpio") &&
 224             of_property_read_bool(np, "snps,reset-active-low"))
 225                 *flags |= OF_GPIO_ACTIVE_LOW;
 226 }
 227
 228 /**
 229  * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
 230  * @np:         device node to get GPIO from
 231  * @propname:   property name containing gpio specifier(s)
 232  * @index:      index of the GPIO
 233  * @flags:      a flags pointer to fill in
 234  *
 235  * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
 236  * value on the error condition. If @flags is not NULL the function also fills
 237  * in flags for the GPIO.
 238  */
 239 static struct gpio_desc *of_get_named_gpiod_flags(const struct device_node *np,
 240                      const char *propname, int index, enum of_gpio_flags *flags)
 241 {
 242         struct of_phandle_args gpiospec;
 243         struct gpio_chip *chip;
 244         struct gpio_desc *desc;
 245         int ret;
 246
 247         ret = of_parse_phandle_with_args_map(np, propname, "gpio", index,
 248                                              &gpiospec);
 249         if (ret) {
 250                 pr_debug("%s: can't parse '%s' property of node '%pOF[%d]'\n",
 251                         __func__, propname, np, index);
 252                 return ERR_PTR(ret);
 253         }
 254
 255         chip = of_find_gpiochip_by_xlate(&gpiospec);
 256         if (!chip) {
 257                 desc = ERR_PTR(-EPROBE_DEFER);
 258                 goto out;
 259         }
 260
 261         desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags);
 262         if (IS_ERR(desc))
 263                 goto out;
 264
 265         if (flags)
 266                 of_gpio_flags_quirks(np, propname, flags, index);
 267
 268         pr_debug("%s: parsed '%s' property of node '%pOF[%d]' - status (%d)\n",
 269                  __func__, propname, np, index,
 270                  PTR_ERR_OR_ZERO(desc));
 271
 272 out:
 273         of_node_put(gpiospec.np);
 274
 275         return desc;
 276 }
 277
 278 int of_get_named_gpio_flags(const struct device_node *np, const char *list_name,
 279                             int index, enum of_gpio_flags *flags)
 280 {
 281         struct gpio_desc *desc;
 282
 283         desc = of_get_named_gpiod_flags(np, list_name, index, flags);
 284
 285         if (IS_ERR(desc))
 286                 return PTR_ERR(desc);
 287         else
 288                 return desc_to_gpio(desc);
 289 }
 290 EXPORT_SYMBOL_GPL(of_get_named_gpio_flags);
 291
 292 /**
 293  * gpiod_get_from_of_node() - obtain a GPIO from an OF node
 294  * @node:       handle of the OF node
 295  * @propname:   name of the DT property representing the GPIO
 296  * @index:      index of the GPIO to obtain for the consumer
 297  * @dflags:     GPIO initialization flags
 298  * @label:      label to attach to the requested GPIO
 299  *
 300  * Returns:
 301  * On successful request the GPIO pin is configured in accordance with
 302  * provided @dflags.
 303  *
 304  * In case of error an ERR_PTR() is returned.
 305  */
 306 struct gpio_desc *gpiod_get_from_of_node(const struct device_node *node,
 307                                          const char *propname, int index,
 308                                          enum gpiod_flags dflags,
 309                                          const char *label)
 310 {
 311         unsigned long lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
 312         struct gpio_desc *desc;
 313         enum of_gpio_flags flags;
 314         bool active_low = false;
 315         bool single_ended = false;
 316         bool open_drain = false;
 317         bool transitory = false;
 318         int ret;
 319
 320         desc = of_get_named_gpiod_flags(node, propname,
 321                                         index, &flags);
 322
 323         if (!desc || IS_ERR(desc)) {
 324                 return desc;
 325         }
 326
 327         active_low = flags & OF_GPIO_ACTIVE_LOW;
 328         single_ended = flags & OF_GPIO_SINGLE_ENDED;
 329         open_drain = flags & OF_GPIO_OPEN_DRAIN;
 330         transitory = flags & OF_GPIO_TRANSITORY;
 331
 332         ret = gpiod_request(desc, label);
 333         if (ret == -EBUSY && (dflags & GPIOD_FLAGS_BIT_NONEXCLUSIVE))
 334                 return desc;
 335         if (ret)
 336                 return ERR_PTR(ret);
 337
 338         if (active_low)
 339                 lflags |= GPIO_ACTIVE_LOW;
 340
 341         if (single_ended) {
 342                 if (open_drain)
 343                         lflags |= GPIO_OPEN_DRAIN;
 344                 else
 345                         lflags |= GPIO_OPEN_SOURCE;
 346         }
 347
 348         if (transitory)
 349                 lflags |= GPIO_TRANSITORY;
 350
 351         if (flags & OF_GPIO_PULL_UP)
 352                 lflags |= GPIO_PULL_UP;
 353
 354         if (flags & OF_GPIO_PULL_DOWN)
 355                 lflags |= GPIO_PULL_DOWN;
 356
 357         if (flags & OF_GPIO_PULL_DISABLE)
 358                 lflags |= GPIO_PULL_DISABLE;
 359
 360         ret = gpiod_configure_flags(desc, propname, lflags, dflags);
 361         if (ret < 0) {
 362                 gpiod_put(desc);
 363                 return ERR_PTR(ret);
 364         }
 365
 366         return desc;
 367 }
 368 EXPORT_SYMBOL_GPL(gpiod_get_from_of_node);
 369
 370 /*
 371  * The SPI GPIO bindings happened before we managed to establish that GPIO
 372  * properties should be named "foo-gpios" so we have this special kludge for
 373  * them.
 374  */
 375 static struct gpio_desc *of_find_spi_gpio(struct device *dev, const char *con_id,
 376                                           enum of_gpio_flags *of_flags)
 377 {
 378         char prop_name[32]; /* 32 is max size of property name */
 379         const struct device_node *np = dev->of_node;
 380         struct gpio_desc *desc;
 381
 382         /*
 383          * Hopefully the compiler stubs the rest of the function if this
 384          * is false.
 385          */
 386         if (!IS_ENABLED(CONFIG_SPI_MASTER))
 387                 return ERR_PTR(-ENOENT);
 388
 389         /* Allow this specifically for "spi-gpio" devices */
 390         if (!of_device_is_compatible(np, "spi-gpio") || !con_id)
 391                 return ERR_PTR(-ENOENT);
 392
 393         /* Will be "gpio-sck", "gpio-mosi" or "gpio-miso" */
 394         snprintf(prop_name, sizeof(prop_name), "%s-%s", "gpio", con_id);
 395
 396         desc = of_get_named_gpiod_flags(np, prop_name, 0, of_flags);
 397         return desc;
 398 }
 399
 400 /*
 401  * The old Freescale bindings use simply "gpios" as name for the chip select
 402  * lines rather than "cs-gpios" like all other SPI hardware. Account for this
 403  * with a special quirk.
 404  */
 405 static struct gpio_desc *of_find_spi_cs_gpio(struct device *dev,
 406                                              const char *con_id,
 407                                              unsigned int idx,
 408                                              unsigned long *flags)
 409 {
 410         const struct device_node *np = dev->of_node;
 411
 412         if (!IS_ENABLED(CONFIG_SPI_MASTER))
 413                 return ERR_PTR(-ENOENT);
 414
 415         /* Allow this specifically for Freescale and PPC devices */
 416         if (!of_device_is_compatible(np, "fsl,spi") &&
 417             !of_device_is_compatible(np, "aeroflexgaisler,spictrl") &&
 418             !of_device_is_compatible(np, "ibm,ppc4xx-spi"))
 419                 return ERR_PTR(-ENOENT);
 420         /* Allow only if asking for "cs-gpios" */
 421         if (!con_id || strcmp(con_id, "cs"))
 422                 return ERR_PTR(-ENOENT);
 423
 424         /*
 425          * While all other SPI controllers use "cs-gpios" the Freescale
 426          * uses just "gpios" so translate to that when "cs-gpios" is
 427          * requested.
 428          */
 429         return of_find_gpio(dev, NULL, idx, flags);
 430 }
 431
 432 /*
 433  * Some regulator bindings happened before we managed to establish that GPIO
 434  * properties should be named "foo-gpios" so we have this special kludge for
 435  * them.
 436  */
 437 static struct gpio_desc *of_find_regulator_gpio(struct device *dev, const char *con_id,
 438                                                 enum of_gpio_flags *of_flags)
 439 {
 440         /* These are the connection IDs we accept as legacy GPIO phandles */
 441         const char *whitelist[] = {
 442                 "wlf,ldoena", /* Arizona */
 443                 "wlf,ldo1ena", /* WM8994 */
 444                 "wlf,ldo2ena", /* WM8994 */
 445         };
 446         const struct device_node *np = dev->of_node;
 447         struct gpio_desc *desc;
 448         int i;
 449
 450         if (!IS_ENABLED(CONFIG_REGULATOR))
 451                 return ERR_PTR(-ENOENT);
 452
 453         if (!con_id)
 454                 return ERR_PTR(-ENOENT);
 455
 456         i = match_string(whitelist, ARRAY_SIZE(whitelist), con_id);
 457         if (i < 0)
 458                 return ERR_PTR(-ENOENT);
 459
 460         desc = of_get_named_gpiod_flags(np, con_id, 0, of_flags);
 461         return desc;
 462 }
 463
 464 static struct gpio_desc *of_find_arizona_gpio(struct device *dev,
 465                                               const char *con_id,
 466                                               enum of_gpio_flags *of_flags)
 467 {
 468         if (!IS_ENABLED(CONFIG_MFD_ARIZONA))
 469                 return ERR_PTR(-ENOENT);
 470
 471         if (!con_id || strcmp(con_id, "wlf,reset"))
 472                 return ERR_PTR(-ENOENT);
 473
 474         return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
 475 }
 476
 477 static struct gpio_desc *of_find_usb_gpio(struct device *dev,
 478                                           const char *con_id,
 479                                           enum of_gpio_flags *of_flags)
 480 {
 481         /*
 482          * Currently this USB quirk is only for the Fairchild FUSB302 host which is using
 483          * an undocumented DT GPIO line named "fcs,int_n" without the compulsory "-gpios"
 484          * suffix.
 485          */
 486         if (!IS_ENABLED(CONFIG_TYPEC_FUSB302))
 487                 return ERR_PTR(-ENOENT);
 488
 489         if (!con_id || strcmp(con_id, "fcs,int_n"))
 490                 return ERR_PTR(-ENOENT);
 491
 492         return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
 493 }
 494
 495 struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
 496                                unsigned int idx, unsigned long *flags)
 497 {
 498         char prop_name[32]; /* 32 is max size of property name */
 499         enum of_gpio_flags of_flags;
 500         struct gpio_desc *desc;
 501         unsigned int i;
 502
 503         /* Try GPIO property "foo-gpios" and "foo-gpio" */
 504         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
 505                 if (con_id)
 506                         snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
 507                                  gpio_suffixes[i]);
 508                 else
 509                         snprintf(prop_name, sizeof(prop_name), "%s",
 510                                  gpio_suffixes[i]);
 511
 512                 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
 513                                                 &of_flags);
 514
 515                 if (!gpiod_not_found(desc))
 516                         break;
 517         }
 518
 519         if (gpiod_not_found(desc)) {
 520                 /* Special handling for SPI GPIOs if used */
 521                 desc = of_find_spi_gpio(dev, con_id, &of_flags);
 522         }
 523
 524         if (gpiod_not_found(desc)) {
 525                 /* This quirk looks up flags and all */
 526                 desc = of_find_spi_cs_gpio(dev, con_id, idx, flags);
 527                 if (!IS_ERR(desc))
 528                         return desc;
 529         }
 530
 531         if (gpiod_not_found(desc)) {
 532                 /* Special handling for regulator GPIOs if used */
 533                 desc = of_find_regulator_gpio(dev, con_id, &of_flags);
 534         }
 535
 536         if (gpiod_not_found(desc))
 537                 desc = of_find_arizona_gpio(dev, con_id, &of_flags);
 538
 539         if (gpiod_not_found(desc))
 540                 desc = of_find_usb_gpio(dev, con_id, &of_flags);
 541
 542         if (IS_ERR(desc))
 543                 return desc;
 544
 545         if (of_flags & OF_GPIO_ACTIVE_LOW)
 546                 *flags |= GPIO_ACTIVE_LOW;
 547
 548         if (of_flags & OF_GPIO_SINGLE_ENDED) {
 549                 if (of_flags & OF_GPIO_OPEN_DRAIN)
 550                         *flags |= GPIO_OPEN_DRAIN;
 551                 else
 552                         *flags |= GPIO_OPEN_SOURCE;
 553         }
 554
 555         if (of_flags & OF_GPIO_TRANSITORY)
 556                 *flags |= GPIO_TRANSITORY;
 557
 558         if (of_flags & OF_GPIO_PULL_UP)
 559                 *flags |= GPIO_PULL_UP;
 560         if (of_flags & OF_GPIO_PULL_DOWN)
 561                 *flags |= GPIO_PULL_DOWN;
 562         if (of_flags & OF_GPIO_PULL_DISABLE)
 563                 *flags |= GPIO_PULL_DISABLE;
 564
 565         return desc;
 566 }
 567
 568 /**
 569  * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
 570  * @np:         device node to get GPIO from
 571  * @chip:       GPIO chip whose hog is parsed
 572  * @idx:        Index of the GPIO to parse
 573  * @name:       GPIO line name
 574  * @lflags:     bitmask of gpio_lookup_flags GPIO_* values - returned from
 575  *              of_find_gpio() or of_parse_own_gpio()
 576  * @dflags:     gpiod_flags - optional GPIO initialization flags
 577  *
 578  * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
 579  * value on the error condition.
 580  */
 581 static struct gpio_desc *of_parse_own_gpio(struct device_node *np,
 582                                            struct gpio_chip *chip,
 583                                            unsigned int idx, const char **name,
 584                                            unsigned long *lflags,
 585                                            enum gpiod_flags *dflags)
 586 {
 587         struct device_node *chip_np;
 588         enum of_gpio_flags xlate_flags;
 589         struct of_phandle_args gpiospec;
 590         struct gpio_desc *desc;
 591         unsigned int i;
 592         u32 tmp;
 593         int ret;
 594
 595         chip_np = chip->of_node;
 596         if (!chip_np)
 597                 return ERR_PTR(-EINVAL);
 598
 599         xlate_flags = 0;
 600         *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
 601         *dflags = GPIOD_ASIS;
 602
 603         ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
 604         if (ret)
 605                 return ERR_PTR(ret);
 606
 607         gpiospec.np = chip_np;
 608         gpiospec.args_count = tmp;
 609
 610         for (i = 0; i < tmp; i++) {
 611                 ret = of_property_read_u32_index(np, "gpios", idx * tmp + i,
 612                                                  &gpiospec.args[i]);
 613                 if (ret)
 614                         return ERR_PTR(ret);
 615         }
 616
 617         desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
 618         if (IS_ERR(desc))
 619                 return desc;
 620
 621         if (xlate_flags & OF_GPIO_ACTIVE_LOW)
 622                 *lflags |= GPIO_ACTIVE_LOW;
 623         if (xlate_flags & OF_GPIO_TRANSITORY)
 624                 *lflags |= GPIO_TRANSITORY;
 625         if (xlate_flags & OF_GPIO_PULL_UP)
 626                 *lflags |= GPIO_PULL_UP;
 627         if (xlate_flags & OF_GPIO_PULL_DOWN)
 628                 *lflags |= GPIO_PULL_DOWN;
 629         if (xlate_flags & OF_GPIO_PULL_DISABLE)
 630                 *lflags |= GPIO_PULL_DISABLE;
 631
 632         if (of_property_read_bool(np, "input"))
 633                 *dflags |= GPIOD_IN;
 634         else if (of_property_read_bool(np, "output-low"))
 635                 *dflags |= GPIOD_OUT_LOW;
 636         else if (of_property_read_bool(np, "output-high"))
 637                 *dflags |= GPIOD_OUT_HIGH;
 638         else {
 639                 pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n",
 640                         desc_to_gpio(desc), np);
 641                 return ERR_PTR(-EINVAL);
 642         }
 643
 644         if (name && of_property_read_string(np, "line-name", name))
 645                 *name = np->name;
 646
 647         return desc;
 648 }
 649
 650 /**
 651  * of_gpiochip_add_hog - Add all hogs in a hog device node
 652  * @chip:       gpio chip to act on
 653  * @hog:        device node describing the hogs
 654  *
 655  * Returns error if it fails otherwise 0 on success.
 656  */
 657 static int of_gpiochip_add_hog(struct gpio_chip *chip, struct device_node *hog)
 658 {
 659         enum gpiod_flags dflags;
 660         struct gpio_desc *desc;
 661         unsigned long lflags;
 662         const char *name;
 663         unsigned int i;
 664         int ret;
 665
 666         for (i = 0;; i++) {
 667                 desc = of_parse_own_gpio(hog, chip, i, &name, &lflags, &dflags);
 668                 if (IS_ERR(desc))
 669                         break;
 670
 671                 ret = gpiod_hog(desc, name, lflags, dflags);
 672                 if (ret < 0)
 673                         return ret;
 674
 675 #ifdef CONFIG_OF_DYNAMIC
 676                 desc->hog = hog;
 677 #endif
 678         }
 679
 680         return 0;
 681 }
 682
 683 /**
 684  * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
 685  * @chip:       gpio chip to act on
 686  *
 687  * This is only used by of_gpiochip_add to request/set GPIO initial
 688  * configuration.
 689  * It returns error if it fails otherwise 0 on success.
 690  */
 691 static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
 692 {
 693         struct device_node *np;
 694         int ret;
 695
 696         for_each_available_child_of_node(chip->of_node, np) {
 697                 if (!of_property_read_bool(np, "gpio-hog"))
 698                         continue;
 699
 700                 ret = of_gpiochip_add_hog(chip, np);
 701                 if (ret < 0) {
 702                         of_node_put(np);
 703                         return ret;
 704                 }
 705
 706                 of_node_set_flag(np, OF_POPULATED);
 707         }
 708
 709         return 0;
 710 }
 711
 712 #ifdef CONFIG_OF_DYNAMIC
 713 /**
 714  * of_gpiochip_remove_hog - Remove all hogs in a hog device node
 715  * @chip:       gpio chip to act on
 716  * @hog:        device node describing the hogs
 717  */
 718 static void of_gpiochip_remove_hog(struct gpio_chip *chip,
 719                                    struct device_node *hog)
 720 {
 721         struct gpio_desc *desc;
 722
 723         for_each_gpio_desc_with_flag(chip, desc, FLAG_IS_HOGGED)
 724                 if (desc->hog == hog)
 725                         gpiochip_free_own_desc(desc);
 726 }
 727
 728 static int of_gpiochip_match_node(struct gpio_chip *chip, void *data)
 729 {
 730         return device_match_of_node(&chip->gpiodev->dev, data);
 731 }
 732
 733 static struct gpio_chip *of_find_gpiochip_by_node(struct device_node *np)
 734 {
 735         return gpiochip_find(np, of_gpiochip_match_node);
 736 }
 737
 738 static int of_gpio_notify(struct notifier_block *nb, unsigned long action,
 739                           void *arg)
 740 {
 741         struct of_reconfig_data *rd = arg;
 742         struct gpio_chip *chip;
 743         int ret;
 744
 745         /*
 746          * This only supports adding and removing complete gpio-hog nodes.
 747          * Modifying an existing gpio-hog node is not supported (except for
 748          * changing its "status" property, which is treated the same as
 749          * addition/removal).
 750          */
 751         switch (of_reconfig_get_state_change(action, arg)) {
 752         case OF_RECONFIG_CHANGE_ADD:
 753                 if (!of_property_read_bool(rd->dn, "gpio-hog"))
 754                         return NOTIFY_OK;       /* not for us */
 755
 756                 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED))
 757                         return NOTIFY_OK;
 758
 759                 chip = of_find_gpiochip_by_node(rd->dn->parent);
 760                 if (chip == NULL)
 761                         return NOTIFY_OK;       /* not for us */
 762
 763                 ret = of_gpiochip_add_hog(chip, rd->dn);
 764                 if (ret < 0) {
 765                         pr_err("%s: failed to add hogs for %pOF\n", __func__,
 766                                rd->dn);
 767                         of_node_clear_flag(rd->dn, OF_POPULATED);
 768                         return notifier_from_errno(ret);
 769                 }
 770                 break;
 771
 772         case OF_RECONFIG_CHANGE_REMOVE:
 773                 if (!of_node_check_flag(rd->dn, OF_POPULATED))
 774                         return NOTIFY_OK;       /* already depopulated */
 775
 776                 chip = of_find_gpiochip_by_node(rd->dn->parent);
 777                 if (chip == NULL)
 778                         return NOTIFY_OK;       /* not for us */
 779
 780                 of_gpiochip_remove_hog(chip, rd->dn);
 781                 of_node_clear_flag(rd->dn, OF_POPULATED);
 782                 break;
 783         }
 784
 785         return NOTIFY_OK;
 786 }
 787
 788 struct notifier_block gpio_of_notifier = {
 789         .notifier_call = of_gpio_notify,
 790 };
 791 #endif /* CONFIG_OF_DYNAMIC */
 792
 793 /**
 794  * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags
 795  * @gc:         pointer to the gpio_chip structure
 796  * @gpiospec:   GPIO specifier as found in the device tree
 797  * @flags:      a flags pointer to fill in
 798  *
 799  * This is simple translation function, suitable for the most 1:1 mapped
 800  * GPIO chips. This function performs only one sanity check: whether GPIO
 801  * is less than ngpios (that is specified in the gpio_chip).
 802  */
 803 static int of_gpio_simple_xlate(struct gpio_chip *gc,
 804                                 const struct of_phandle_args *gpiospec,
 805                                 u32 *flags)
 806 {
 807         /*
 808          * We're discouraging gpio_cells < 2, since that way you'll have to
 809          * write your own xlate function (that will have to retrieve the GPIO
 810          * number and the flags from a single gpio cell -- this is possible,
 811          * but not recommended).
 812          */
 813         if (gc->of_gpio_n_cells < 2) {
 814                 WARN_ON(1);
 815                 return -EINVAL;
 816         }
 817
 818         if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
 819                 return -EINVAL;
 820
 821         if (gpiospec->args[0] >= gc->ngpio)
 822                 return -EINVAL;
 823
 824         if (flags)
 825                 *flags = gpiospec->args[1];
 826
 827         return gpiospec->args[0];
 828 }
 829
 830 /**
 831  * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank)
 832  * @np:         device node of the GPIO chip
 833  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 834  * @data:       driver data to store in the struct gpio_chip
 835  *
 836  * To use this function you should allocate and fill mm_gc with:
 837  *
 838  * 1) In the gpio_chip structure:
 839  *    - all the callbacks
 840  *    - of_gpio_n_cells
 841  *    - of_xlate callback (optional)
 842  *
 843  * 3) In the of_mm_gpio_chip structure:
 844  *    - save_regs callback (optional)
 845  *
 846  * If succeeded, this function will map bank's memory and will
 847  * do all necessary work for you. Then you'll able to use .regs
 848  * to manage GPIOs from the callbacks.
 849  */
 850 int of_mm_gpiochip_add_data(struct device_node *np,
 851                             struct of_mm_gpio_chip *mm_gc,
 852                             void *data)
 853 {
 854         int ret = -ENOMEM;
 855         struct gpio_chip *gc = &mm_gc->gc;
 856
 857         gc->label = kasprintf(GFP_KERNEL, "%pOF", np);
 858         if (!gc->label)
 859                 goto err0;
 860
 861         mm_gc->regs = of_iomap(np, 0);
 862         if (!mm_gc->regs)
 863                 goto err1;
 864
 865         gc->base = -1;
 866
 867         if (mm_gc->save_regs)
 868                 mm_gc->save_regs(mm_gc);
 869
 870         of_node_put(mm_gc->gc.of_node);
 871         mm_gc->gc.of_node = of_node_get(np);
 872
 873         ret = gpiochip_add_data(gc, data);
 874         if (ret)
 875                 goto err2;
 876
 877         return 0;
 878 err2:
 879         of_node_put(np);
 880         iounmap(mm_gc->regs);
 881 err1:
 882         kfree(gc->label);
 883 err0:
 884         pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret);
 885         return ret;
 886 }
 887 EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data);
 888
 889 /**
 890  * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
 891  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 892  */
 893 void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
 894 {
 895         struct gpio_chip *gc = &mm_gc->gc;
 896
 897         if (!mm_gc)
 898                 return;
 899
 900         gpiochip_remove(gc);
 901         iounmap(mm_gc->regs);
 902         kfree(gc->label);
 903 }
 904 EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove);
 905
 906 static void of_gpiochip_init_valid_mask(struct gpio_chip *chip)
 907 {
 908         int len, i;
 909         u32 start, count;
 910         struct device_node *np = chip->of_node;
 911
 912         len = of_property_count_u32_elems(np,  "gpio-reserved-ranges");
 913         if (len < 0 || len % 2 != 0)
 914                 return;
 915
 916         for (i = 0; i < len; i += 2) {
 917                 of_property_read_u32_index(np, "gpio-reserved-ranges",
 918                                            i, &start);
 919                 of_property_read_u32_index(np, "gpio-reserved-ranges",
 920                                            i + 1, &count);
 921                 if (start >= chip->ngpio || start + count > chip->ngpio)
 922                         continue;
 923
 924                 bitmap_clear(chip->valid_mask, start, count);
 925         }
 926 };
 927
 928 #ifdef CONFIG_PINCTRL
 929 static int of_gpiochip_add_pin_range(struct gpio_chip *chip)
 930 {
 931         struct device_node *np = chip->of_node;
 932         struct of_phandle_args pinspec;
 933         struct pinctrl_dev *pctldev;
 934         int index = 0, ret;
 935         const char *name;
 936         static const char group_names_propname[] = "gpio-ranges-group-names";
 937         struct property *group_names;
 938
 939         if (!np)
 940                 return 0;
 941
 942         if (!of_property_read_bool(np, "gpio-ranges") &&
 943             chip->of_gpio_ranges_fallback) {
 944                 return chip->of_gpio_ranges_fallback(chip, np);
 945         }
 946
 947         group_names = of_find_property(np, group_names_propname, NULL);
 948
 949         for (;; index++) {
 950                 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
 951                                 index, &pinspec);
 952                 if (ret)
 953                         break;
 954
 955                 pctldev = of_pinctrl_get(pinspec.np);
 956                 of_node_put(pinspec.np);
 957                 if (!pctldev)
 958                         return -EPROBE_DEFER;
 959
 960                 if (pinspec.args[2]) {
 961                         if (group_names) {
 962                                 of_property_read_string_index(np,
 963                                                 group_names_propname,
 964                                                 index, &name);
 965                                 if (strlen(name)) {
 966                                         pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n",
 967                                                 np);
 968                                         break;
 969                                 }
 970                         }
 971                         /* npins != 0: linear range */
 972                         ret = gpiochip_add_pin_range(chip,
 973                                         pinctrl_dev_get_devname(pctldev),
 974                                         pinspec.args[0],
 975                                         pinspec.args[1],
 976                                         pinspec.args[2]);
 977                         if (ret)
 978                                 return ret;
 979                 } else {
 980                         /* npins == 0: special range */
 981                         if (pinspec.args[1]) {
 982                                 pr_err("%pOF: Illegal gpio-range format.\n",
 983                                         np);
 984                                 break;
 985                         }
 986
 987                         if (!group_names) {
 988                                 pr_err("%pOF: GPIO group range requested but no %s property.\n",
 989                                         np, group_names_propname);
 990                                 break;
 991                         }
 992
 993                         ret = of_property_read_string_index(np,
 994                                                 group_names_propname,
 995                                                 index, &name);
 996                         if (ret)
 997                                 break;
 998
 999                         if (!strlen(name)) {
1000                                 pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n",
1001                                 np);
1002                                 break;
1003                         }
1004
1005                         ret = gpiochip_add_pingroup_range(chip, pctldev,
1006                                                 pinspec.args[0], name);
1007                         if (ret)
1008                                 return ret;
1009                 }
1010         }
1011
1012         return 0;
1013 }
1014
1015 #else
1016 static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
1017 #endif
1018
1019 int of_gpiochip_add(struct gpio_chip *chip)
1020 {
1021         int ret;
1022
1023         if (!chip->of_node)
1024                 return 0;
1025
1026         if (!chip->of_xlate) {
1027                 chip->of_gpio_n_cells = 2;
1028                 chip->of_xlate = of_gpio_simple_xlate;
1029         }
1030
1031         if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
1032                 return -EINVAL;
1033
1034         of_gpiochip_init_valid_mask(chip);
1035
1036         ret = of_gpiochip_add_pin_range(chip);
1037         if (ret)
1038                 return ret;
1039
1040         of_node_get(chip->of_node);
1041
1042         ret = of_gpiochip_scan_gpios(chip);
1043         if (ret)
1044                 of_node_put(chip->of_node);
1045
1046         return ret;
1047 }
1048
1049 void of_gpiochip_remove(struct gpio_chip *chip)
1050 {
1051         of_node_put(chip->of_node);
1052 }
1053
1054 void of_gpio_dev_init(struct gpio_chip *gc, struct gpio_device *gdev)
1055 {
1056         /* Set default OF node to parent's one if present */
1057         if (gc->parent)
1058                 gdev->dev.of_node = gc->parent->of_node;
1059
1060         if (gc->fwnode)
1061                 gc->of_node = to_of_node(gc->fwnode);
1062
1063         /* If the gpiochip has an assigned OF node this takes precedence */
1064         if (gc->of_node)
1065                 gdev->dev.of_node = gc->of_node;
1066         else
1067                 gc->of_node = gdev->dev.of_node;
1068 }