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         if (flags & OF_GPIO_PULL_UP)
 348                 lflags |= GPIO_PULL_UP;
 349
 350         if (flags & OF_GPIO_PULL_DOWN)
 351                 lflags |= GPIO_PULL_DOWN;
 352
 353         ret = gpiod_configure_flags(desc, propname, lflags, dflags);
 354         if (ret < 0) {
 355                 gpiod_put(desc);
 356                 return ERR_PTR(ret);
 357         }
 358
 359         return desc;
 360 }
 361 EXPORT_SYMBOL_GPL(gpiod_get_from_of_node);
 362
 363 /*
 364  * The SPI GPIO bindings happened before we managed to establish that GPIO
 365  * properties should be named "foo-gpios" so we have this special kludge for
 366  * them.
 367  */
 368 static struct gpio_desc *of_find_spi_gpio(struct device *dev, const char *con_id,
 369                                           enum of_gpio_flags *of_flags)
 370 {
 371         char prop_name[32]; /* 32 is max size of property name */
 372         struct device_node *np = dev->of_node;
 373         struct gpio_desc *desc;
 374
 375         /*
 376          * Hopefully the compiler stubs the rest of the function if this
 377          * is false.
 378          */
 379         if (!IS_ENABLED(CONFIG_SPI_MASTER))
 380                 return ERR_PTR(-ENOENT);
 381
 382         /* Allow this specifically for "spi-gpio" devices */
 383         if (!of_device_is_compatible(np, "spi-gpio") || !con_id)
 384                 return ERR_PTR(-ENOENT);
 385
 386         /* Will be "gpio-sck", "gpio-mosi" or "gpio-miso" */
 387         snprintf(prop_name, sizeof(prop_name), "%s-%s", "gpio", con_id);
 388
 389         desc = of_get_named_gpiod_flags(np, prop_name, 0, of_flags);
 390         return desc;
 391 }
 392
 393 /*
 394  * The old Freescale bindings use simply "gpios" as name for the chip select
 395  * lines rather than "cs-gpios" like all other SPI hardware. Account for this
 396  * with a special quirk.
 397  */
 398 static struct gpio_desc *of_find_spi_cs_gpio(struct device *dev,
 399                                              const char *con_id,
 400                                              unsigned int idx,
 401                                              unsigned long *flags)
 402 {
 403         struct device_node *np = dev->of_node;
 404
 405         if (!IS_ENABLED(CONFIG_SPI_MASTER))
 406                 return ERR_PTR(-ENOENT);
 407
 408         /* Allow this specifically for Freescale devices */
 409         if (!of_device_is_compatible(np, "fsl,spi") &&
 410             !of_device_is_compatible(np, "aeroflexgaisler,spictrl"))
 411                 return ERR_PTR(-ENOENT);
 412         /* Allow only if asking for "cs-gpios" */
 413         if (!con_id || strcmp(con_id, "cs"))
 414                 return ERR_PTR(-ENOENT);
 415
 416         /*
 417          * While all other SPI controllers use "cs-gpios" the Freescale
 418          * uses just "gpios" so translate to that when "cs-gpios" is
 419          * requested.
 420          */
 421         return of_find_gpio(dev, NULL, idx, flags);
 422 }
 423
 424 /*
 425  * Some regulator bindings happened before we managed to establish that GPIO
 426  * properties should be named "foo-gpios" so we have this special kludge for
 427  * them.
 428  */
 429 static struct gpio_desc *of_find_regulator_gpio(struct device *dev, const char *con_id,
 430                                                 enum of_gpio_flags *of_flags)
 431 {
 432         /* These are the connection IDs we accept as legacy GPIO phandles */
 433         const char *whitelist[] = {
 434                 "wlf,ldoena", /* Arizona */
 435                 "wlf,ldo1ena", /* WM8994 */
 436                 "wlf,ldo2ena", /* WM8994 */
 437         };
 438         struct device_node *np = dev->of_node;
 439         struct gpio_desc *desc;
 440         int i;
 441
 442         if (!IS_ENABLED(CONFIG_REGULATOR))
 443                 return ERR_PTR(-ENOENT);
 444
 445         if (!con_id)
 446                 return ERR_PTR(-ENOENT);
 447
 448         i = match_string(whitelist, ARRAY_SIZE(whitelist), con_id);
 449         if (i < 0)
 450                 return ERR_PTR(-ENOENT);
 451
 452         desc = of_get_named_gpiod_flags(np, con_id, 0, of_flags);
 453         return desc;
 454 }
 455
 456 static struct gpio_desc *of_find_arizona_gpio(struct device *dev,
 457                                               const char *con_id,
 458                                               enum of_gpio_flags *of_flags)
 459 {
 460         if (!IS_ENABLED(CONFIG_MFD_ARIZONA))
 461                 return ERR_PTR(-ENOENT);
 462
 463         if (!con_id || strcmp(con_id, "wlf,reset"))
 464                 return ERR_PTR(-ENOENT);
 465
 466         return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
 467 }
 468
 469 static struct gpio_desc *of_find_usb_gpio(struct device *dev,
 470                                           const char *con_id,
 471                                           enum of_gpio_flags *of_flags)
 472 {
 473         /*
 474          * Currently this USB quirk is only for the Fairchild FUSB302 host which is using
 475          * an undocumented DT GPIO line named "fcs,int_n" without the compulsory "-gpios"
 476          * suffix.
 477          */
 478         if (!IS_ENABLED(CONFIG_TYPEC_FUSB302))
 479                 return ERR_PTR(-ENOENT);
 480
 481         if (!con_id || strcmp(con_id, "fcs,int_n"))
 482                 return ERR_PTR(-ENOENT);
 483
 484         return of_get_named_gpiod_flags(dev->of_node, con_id, 0, of_flags);
 485 }
 486
 487 struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
 488                                unsigned int idx, unsigned long *flags)
 489 {
 490         char prop_name[32]; /* 32 is max size of property name */
 491         enum of_gpio_flags of_flags;
 492         struct gpio_desc *desc;
 493         unsigned int i;
 494
 495         /* Try GPIO property "foo-gpios" and "foo-gpio" */
 496         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
 497                 if (con_id)
 498                         snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
 499                                  gpio_suffixes[i]);
 500                 else
 501                         snprintf(prop_name, sizeof(prop_name), "%s",
 502                                  gpio_suffixes[i]);
 503
 504                 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
 505                                                 &of_flags);
 506
 507                 if (!IS_ERR(desc) || PTR_ERR(desc) != -ENOENT)
 508                         break;
 509         }
 510
 511         if (PTR_ERR(desc) == -ENOENT) {
 512                 /* Special handling for SPI GPIOs if used */
 513                 desc = of_find_spi_gpio(dev, con_id, &of_flags);
 514         }
 515
 516         if (PTR_ERR(desc) == -ENOENT) {
 517                 /* This quirk looks up flags and all */
 518                 desc = of_find_spi_cs_gpio(dev, con_id, idx, flags);
 519                 if (!IS_ERR(desc))
 520                         return desc;
 521         }
 522
 523         if (PTR_ERR(desc) == -ENOENT) {
 524                 /* Special handling for regulator GPIOs if used */
 525                 desc = of_find_regulator_gpio(dev, con_id, &of_flags);
 526         }
 527
 528         if (PTR_ERR(desc) == -ENOENT)
 529                 desc = of_find_arizona_gpio(dev, con_id, &of_flags);
 530
 531         if (PTR_ERR(desc) == -ENOENT)
 532                 desc = of_find_usb_gpio(dev, con_id, &of_flags);
 533
 534         if (IS_ERR(desc))
 535                 return desc;
 536
 537         if (of_flags & OF_GPIO_ACTIVE_LOW)
 538                 *flags |= GPIO_ACTIVE_LOW;
 539
 540         if (of_flags & OF_GPIO_SINGLE_ENDED) {
 541                 if (of_flags & OF_GPIO_OPEN_DRAIN)
 542                         *flags |= GPIO_OPEN_DRAIN;
 543                 else
 544                         *flags |= GPIO_OPEN_SOURCE;
 545         }
 546
 547         if (of_flags & OF_GPIO_TRANSITORY)
 548                 *flags |= GPIO_TRANSITORY;
 549
 550         if (of_flags & OF_GPIO_PULL_UP)
 551                 *flags |= GPIO_PULL_UP;
 552         if (of_flags & OF_GPIO_PULL_DOWN)
 553                 *flags |= GPIO_PULL_DOWN;
 554
 555         return desc;
 556 }
 557
 558 /**
 559  * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
 560  * @np:         device node to get GPIO from
 561  * @chip:       GPIO chip whose hog is parsed
 562  * @idx:        Index of the GPIO to parse
 563  * @name:       GPIO line name
 564  * @lflags:     bitmask of gpio_lookup_flags GPIO_* values - returned from
 565  *              of_find_gpio() or of_parse_own_gpio()
 566  * @dflags:     gpiod_flags - optional GPIO initialization flags
 567  *
 568  * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
 569  * value on the error condition.
 570  */
 571 static struct gpio_desc *of_parse_own_gpio(struct device_node *np,
 572                                            struct gpio_chip *chip,
 573                                            unsigned int idx, const char **name,
 574                                            unsigned long *lflags,
 575                                            enum gpiod_flags *dflags)
 576 {
 577         struct device_node *chip_np;
 578         enum of_gpio_flags xlate_flags;
 579         struct of_phandle_args gpiospec;
 580         struct gpio_desc *desc;
 581         unsigned int i;
 582         u32 tmp;
 583         int ret;
 584
 585         chip_np = chip->of_node;
 586         if (!chip_np)
 587                 return ERR_PTR(-EINVAL);
 588
 589         xlate_flags = 0;
 590         *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
 591         *dflags = 0;
 592
 593         ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
 594         if (ret)
 595                 return ERR_PTR(ret);
 596
 597         gpiospec.np = chip_np;
 598         gpiospec.args_count = tmp;
 599
 600         for (i = 0; i < tmp; i++) {
 601                 ret = of_property_read_u32_index(np, "gpios", idx * tmp + i,
 602                                                  &gpiospec.args[i]);
 603                 if (ret)
 604                         return ERR_PTR(ret);
 605         }
 606
 607         desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
 608         if (IS_ERR(desc))
 609                 return desc;
 610
 611         if (xlate_flags & OF_GPIO_ACTIVE_LOW)
 612                 *lflags |= GPIO_ACTIVE_LOW;
 613         if (xlate_flags & OF_GPIO_TRANSITORY)
 614                 *lflags |= GPIO_TRANSITORY;
 615         if (xlate_flags & OF_GPIO_PULL_UP)
 616                 *lflags |= GPIO_PULL_UP;
 617         if (xlate_flags & OF_GPIO_PULL_DOWN)
 618                 *lflags |= GPIO_PULL_DOWN;
 619
 620         if (of_property_read_bool(np, "input"))
 621                 *dflags |= GPIOD_IN;
 622         else if (of_property_read_bool(np, "output-low"))
 623                 *dflags |= GPIOD_OUT_LOW;
 624         else if (of_property_read_bool(np, "output-high"))
 625                 *dflags |= GPIOD_OUT_HIGH;
 626         else {
 627                 pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n",
 628                         desc_to_gpio(desc), np);
 629                 return ERR_PTR(-EINVAL);
 630         }
 631
 632         if (name && of_property_read_string(np, "line-name", name))
 633                 *name = np->name;
 634
 635         return desc;
 636 }
 637
 638 /**
 639  * of_gpiochip_add_hog - Add all hogs in a hog device node
 640  * @chip:       gpio chip to act on
 641  * @hog:        device node describing the hogs
 642  *
 643  * Returns error if it fails otherwise 0 on success.
 644  */
 645 static int of_gpiochip_add_hog(struct gpio_chip *chip, struct device_node *hog)
 646 {
 647         enum gpiod_flags dflags;
 648         struct gpio_desc *desc;
 649         unsigned long lflags;
 650         const char *name;
 651         unsigned int i;
 652         int ret;
 653
 654         for (i = 0;; i++) {
 655                 desc = of_parse_own_gpio(hog, chip, i, &name, &lflags, &dflags);
 656                 if (IS_ERR(desc))
 657                         break;
 658
 659                 ret = gpiod_hog(desc, name, lflags, dflags);
 660                 if (ret < 0)
 661                         return ret;
 662
 663 #ifdef CONFIG_OF_DYNAMIC
 664                 desc->hog = hog;
 665 #endif
 666         }
 667
 668         return 0;
 669 }
 670
 671 /**
 672  * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
 673  * @chip:       gpio chip to act on
 674  *
 675  * This is only used by of_gpiochip_add to request/set GPIO initial
 676  * configuration.
 677  * It returns error if it fails otherwise 0 on success.
 678  */
 679 static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
 680 {
 681         struct device_node *np;
 682         int ret;
 683
 684         for_each_available_child_of_node(chip->of_node, np) {
 685                 if (!of_property_read_bool(np, "gpio-hog"))
 686                         continue;
 687
 688                 ret = of_gpiochip_add_hog(chip, np);
 689                 if (ret < 0) {
 690                         of_node_put(np);
 691                         return ret;
 692                 }
 693
 694                 of_node_set_flag(np, OF_POPULATED);
 695         }
 696
 697         return 0;
 698 }
 699
 700 #ifdef CONFIG_OF_DYNAMIC
 701 /**
 702  * of_gpiochip_remove_hog - Remove all hogs in a hog device node
 703  * @chip:       gpio chip to act on
 704  * @hog:        device node describing the hogs
 705  */
 706 static void of_gpiochip_remove_hog(struct gpio_chip *chip,
 707                                    struct device_node *hog)
 708 {
 709         struct gpio_desc *descs = chip->gpiodev->descs;
 710         unsigned int i;
 711
 712         for (i = 0; i < chip->ngpio; i++) {
 713                 if (test_bit(FLAG_IS_HOGGED, &descs[i].flags) &&
 714                     descs[i].hog == hog)
 715                         gpiochip_free_own_desc(&descs[i]);
 716         }
 717 }
 718
 719 static int of_gpiochip_match_node(struct gpio_chip *chip, void *data)
 720 {
 721         return chip->gpiodev->dev.of_node == data;
 722 }
 723
 724 static struct gpio_chip *of_find_gpiochip_by_node(struct device_node *np)
 725 {
 726         return gpiochip_find(np, of_gpiochip_match_node);
 727 }
 728
 729 static int of_gpio_notify(struct notifier_block *nb, unsigned long action,
 730                           void *arg)
 731 {
 732         struct of_reconfig_data *rd = arg;
 733         struct gpio_chip *chip;
 734         int ret;
 735
 736         /*
 737          * This only supports adding and removing complete gpio-hog nodes.
 738          * Modifying an existing gpio-hog node is not supported (except for
 739          * changing its "status" property, which is treated the same as
 740          * addition/removal).
 741          */
 742         switch (of_reconfig_get_state_change(action, arg)) {
 743         case OF_RECONFIG_CHANGE_ADD:
 744                 if (!of_property_read_bool(rd->dn, "gpio-hog"))
 745                         return NOTIFY_OK;       /* not for us */
 746
 747                 if (of_node_test_and_set_flag(rd->dn, OF_POPULATED))
 748                         return NOTIFY_OK;
 749
 750                 chip = of_find_gpiochip_by_node(rd->dn->parent);
 751                 if (chip == NULL)
 752                         return NOTIFY_OK;       /* not for us */
 753
 754                 ret = of_gpiochip_add_hog(chip, rd->dn);
 755                 if (ret < 0) {
 756                         pr_err("%s: failed to add hogs for %pOF\n", __func__,
 757                                rd->dn);
 758                         of_node_clear_flag(rd->dn, OF_POPULATED);
 759                         return notifier_from_errno(ret);
 760                 }
 761                 break;
 762
 763         case OF_RECONFIG_CHANGE_REMOVE:
 764                 if (!of_node_check_flag(rd->dn, OF_POPULATED))
 765                         return NOTIFY_OK;       /* already depopulated */
 766
 767                 chip = of_find_gpiochip_by_node(rd->dn->parent);
 768                 if (chip == NULL)
 769                         return NOTIFY_OK;       /* not for us */
 770
 771                 of_gpiochip_remove_hog(chip, rd->dn);
 772                 of_node_clear_flag(rd->dn, OF_POPULATED);
 773                 break;
 774         }
 775
 776         return NOTIFY_OK;
 777 }
 778
 779 struct notifier_block gpio_of_notifier = {
 780         .notifier_call = of_gpio_notify,
 781 };
 782 #endif /* CONFIG_OF_DYNAMIC */
 783
 784 /**
 785  * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags
 786  * @gc:         pointer to the gpio_chip structure
 787  * @gpiospec:   GPIO specifier as found in the device tree
 788  * @flags:      a flags pointer to fill in
 789  *
 790  * This is simple translation function, suitable for the most 1:1 mapped
 791  * GPIO chips. This function performs only one sanity check: whether GPIO
 792  * is less than ngpios (that is specified in the gpio_chip).
 793  */
 794 static int of_gpio_simple_xlate(struct gpio_chip *gc,
 795                                 const struct of_phandle_args *gpiospec,
 796                                 u32 *flags)
 797 {
 798         /*
 799          * We're discouraging gpio_cells < 2, since that way you'll have to
 800          * write your own xlate function (that will have to retrieve the GPIO
 801          * number and the flags from a single gpio cell -- this is possible,
 802          * but not recommended).
 803          */
 804         if (gc->of_gpio_n_cells < 2) {
 805                 WARN_ON(1);
 806                 return -EINVAL;
 807         }
 808
 809         if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
 810                 return -EINVAL;
 811
 812         if (gpiospec->args[0] >= gc->ngpio)
 813                 return -EINVAL;
 814
 815         if (flags)
 816                 *flags = gpiospec->args[1];
 817
 818         return gpiospec->args[0];
 819 }
 820
 821 /**
 822  * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank)
 823  * @np:         device node of the GPIO chip
 824  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 825  * @data:       driver data to store in the struct gpio_chip
 826  *
 827  * To use this function you should allocate and fill mm_gc with:
 828  *
 829  * 1) In the gpio_chip structure:
 830  *    - all the callbacks
 831  *    - of_gpio_n_cells
 832  *    - of_xlate callback (optional)
 833  *
 834  * 3) In the of_mm_gpio_chip structure:
 835  *    - save_regs callback (optional)
 836  *
 837  * If succeeded, this function will map bank's memory and will
 838  * do all necessary work for you. Then you'll able to use .regs
 839  * to manage GPIOs from the callbacks.
 840  */
 841 int of_mm_gpiochip_add_data(struct device_node *np,
 842                             struct of_mm_gpio_chip *mm_gc,
 843                             void *data)
 844 {
 845         int ret = -ENOMEM;
 846         struct gpio_chip *gc = &mm_gc->gc;
 847
 848         gc->label = kasprintf(GFP_KERNEL, "%pOF", np);
 849         if (!gc->label)
 850                 goto err0;
 851
 852         mm_gc->regs = of_iomap(np, 0);
 853         if (!mm_gc->regs)
 854                 goto err1;
 855
 856         gc->base = -1;
 857
 858         if (mm_gc->save_regs)
 859                 mm_gc->save_regs(mm_gc);
 860
 861         mm_gc->gc.of_node = np;
 862
 863         ret = gpiochip_add_data(gc, data);
 864         if (ret)
 865                 goto err2;
 866
 867         return 0;
 868 err2:
 869         iounmap(mm_gc->regs);
 870 err1:
 871         kfree(gc->label);
 872 err0:
 873         pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret);
 874         return ret;
 875 }
 876 EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data);
 877
 878 /**
 879  * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
 880  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 881  */
 882 void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
 883 {
 884         struct gpio_chip *gc = &mm_gc->gc;
 885
 886         if (!mm_gc)
 887                 return;
 888
 889         gpiochip_remove(gc);
 890         iounmap(mm_gc->regs);
 891         kfree(gc->label);
 892 }
 893 EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove);
 894
 895 static void of_gpiochip_init_valid_mask(struct gpio_chip *chip)
 896 {
 897         int len, i;
 898         u32 start, count;
 899         struct device_node *np = chip->of_node;
 900
 901         len = of_property_count_u32_elems(np,  "gpio-reserved-ranges");
 902         if (len < 0 || len % 2 != 0)
 903                 return;
 904
 905         for (i = 0; i < len; i += 2) {
 906                 of_property_read_u32_index(np, "gpio-reserved-ranges",
 907                                            i, &start);
 908                 of_property_read_u32_index(np, "gpio-reserved-ranges",
 909                                            i + 1, &count);
 910                 if (start >= chip->ngpio || start + count >= chip->ngpio)
 911                         continue;
 912
 913                 bitmap_clear(chip->valid_mask, start, count);
 914         }
 915 };
 916
 917 #ifdef CONFIG_PINCTRL
 918 static int of_gpiochip_add_pin_range(struct gpio_chip *chip)
 919 {
 920         struct device_node *np = chip->of_node;
 921         struct of_phandle_args pinspec;
 922         struct pinctrl_dev *pctldev;
 923         int index = 0, ret;
 924         const char *name;
 925         static const char group_names_propname[] = "gpio-ranges-group-names";
 926         struct property *group_names;
 927
 928         if (!np)
 929                 return 0;
 930
 931         group_names = of_find_property(np, group_names_propname, NULL);
 932
 933         for (;; index++) {
 934                 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
 935                                 index, &pinspec);
 936                 if (ret)
 937                         break;
 938
 939                 pctldev = of_pinctrl_get(pinspec.np);
 940                 of_node_put(pinspec.np);
 941                 if (!pctldev)
 942                         return -EPROBE_DEFER;
 943
 944                 if (pinspec.args[2]) {
 945                         if (group_names) {
 946                                 of_property_read_string_index(np,
 947                                                 group_names_propname,
 948                                                 index, &name);
 949                                 if (strlen(name)) {
 950                                         pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n",
 951                                                 np);
 952                                         break;
 953                                 }
 954                         }
 955                         /* npins != 0: linear range */
 956                         ret = gpiochip_add_pin_range(chip,
 957                                         pinctrl_dev_get_devname(pctldev),
 958                                         pinspec.args[0],
 959                                         pinspec.args[1],
 960                                         pinspec.args[2]);
 961                         if (ret)
 962                                 return ret;
 963                 } else {
 964                         /* npins == 0: special range */
 965                         if (pinspec.args[1]) {
 966                                 pr_err("%pOF: Illegal gpio-range format.\n",
 967                                         np);
 968                                 break;
 969                         }
 970
 971                         if (!group_names) {
 972                                 pr_err("%pOF: GPIO group range requested but no %s property.\n",
 973                                         np, group_names_propname);
 974                                 break;
 975                         }
 976
 977                         ret = of_property_read_string_index(np,
 978                                                 group_names_propname,
 979                                                 index, &name);
 980                         if (ret)
 981                                 break;
 982
 983                         if (!strlen(name)) {
 984                                 pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n",
 985                                 np);
 986                                 break;
 987                         }
 988
 989                         ret = gpiochip_add_pingroup_range(chip, pctldev,
 990                                                 pinspec.args[0], name);
 991                         if (ret)
 992                                 return ret;
 993                 }
 994         }
 995
 996         return 0;
 997 }
 998
 999 #else
1000 static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
1001 #endif
1002
1003 int of_gpiochip_add(struct gpio_chip *chip)
1004 {
1005         int ret;
1006
1007         if (!chip->of_node)
1008                 return 0;
1009
1010         if (!chip->of_xlate) {
1011                 chip->of_gpio_n_cells = 2;
1012                 chip->of_xlate = of_gpio_simple_xlate;
1013         }
1014
1015         if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
1016                 return -EINVAL;
1017
1018         of_gpiochip_init_valid_mask(chip);
1019
1020         ret = of_gpiochip_add_pin_range(chip);
1021         if (ret)
1022                 return ret;
1023
1024         /* If the chip defines names itself, these take precedence */
1025         if (!chip->names)
1026                 devprop_gpiochip_set_names(chip,
1027                                            of_fwnode_handle(chip->of_node));
1028
1029         of_node_get(chip->of_node);
1030
1031         ret = of_gpiochip_scan_gpios(chip);
1032         if (ret)
1033                 of_node_put(chip->of_node);
1034
1035         return ret;
1036 }
1037
1038 void of_gpiochip_remove(struct gpio_chip *chip)
1039 {
1040         of_node_put(chip->of_node);
1041 }