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