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