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