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 struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
 442                                unsigned int idx, unsigned long *flags)
 443 {
 444         char prop_name[32]; /* 32 is max size of property name */
 445         enum of_gpio_flags of_flags;
 446         struct gpio_desc *desc;
 447         unsigned int i;
 448
 449         /* Try GPIO property "foo-gpios" and "foo-gpio" */
 450         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
 451                 if (con_id)
 452                         snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
 453                                  gpio_suffixes[i]);
 454                 else
 455                         snprintf(prop_name, sizeof(prop_name), "%s",
 456                                  gpio_suffixes[i]);
 457
 458                 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
 459                                                 &of_flags);
 460                 /*
 461                  * -EPROBE_DEFER in our case means that we found a
 462                  * valid GPIO property, but no controller has been
 463                  * registered so far.
 464                  *
 465                  * This means we don't need to look any further for
 466                  * alternate name conventions, and we should really
 467                  * preserve the return code for our user to be able to
 468                  * retry probing later.
 469                  */
 470                 if (IS_ERR(desc) && PTR_ERR(desc) == -EPROBE_DEFER)
 471                         return desc;
 472
 473                 if (!IS_ERR(desc) || (PTR_ERR(desc) != -ENOENT))
 474                         break;
 475         }
 476
 477         /* Special handling for SPI GPIOs if used */
 478         if (IS_ERR(desc))
 479                 desc = of_find_spi_gpio(dev, con_id, &of_flags);
 480         if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER) {
 481                 /* This quirk looks up flags and all */
 482                 desc = of_find_spi_cs_gpio(dev, con_id, idx, flags);
 483                 if (!IS_ERR(desc))
 484                         return desc;
 485         }
 486
 487         /* Special handling for regulator GPIOs if used */
 488         if (IS_ERR(desc) && PTR_ERR(desc) != -EPROBE_DEFER)
 489                 desc = of_find_regulator_gpio(dev, con_id, &of_flags);
 490
 491         if (IS_ERR(desc))
 492                 return desc;
 493
 494         if (of_flags & OF_GPIO_ACTIVE_LOW)
 495                 *flags |= GPIO_ACTIVE_LOW;
 496
 497         if (of_flags & OF_GPIO_SINGLE_ENDED) {
 498                 if (of_flags & OF_GPIO_OPEN_DRAIN)
 499                         *flags |= GPIO_OPEN_DRAIN;
 500                 else
 501                         *flags |= GPIO_OPEN_SOURCE;
 502         }
 503
 504         if (of_flags & OF_GPIO_TRANSITORY)
 505                 *flags |= GPIO_TRANSITORY;
 506
 507         if (of_flags & OF_GPIO_PULL_UP)
 508                 *flags |= GPIO_PULL_UP;
 509         if (of_flags & OF_GPIO_PULL_DOWN)
 510                 *flags |= GPIO_PULL_DOWN;
 511
 512         return desc;
 513 }
 514
 515 /**
 516  * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
 517  * @np:         device node to get GPIO from
 518  * @chip:       GPIO chip whose hog is parsed
 519  * @idx:        Index of the GPIO to parse
 520  * @name:       GPIO line name
 521  * @lflags:     bitmask of gpio_lookup_flags GPIO_* values - returned from
 522  *              of_find_gpio() or of_parse_own_gpio()
 523  * @dflags:     gpiod_flags - optional GPIO initialization flags
 524  *
 525  * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
 526  * value on the error condition.
 527  */
 528 static struct gpio_desc *of_parse_own_gpio(struct device_node *np,
 529                                            struct gpio_chip *chip,
 530                                            unsigned int idx, const char **name,
 531                                            unsigned long *lflags,
 532                                            enum gpiod_flags *dflags)
 533 {
 534         struct device_node *chip_np;
 535         enum of_gpio_flags xlate_flags;
 536         struct of_phandle_args gpiospec;
 537         struct gpio_desc *desc;
 538         unsigned int i;
 539         u32 tmp;
 540         int ret;
 541
 542         chip_np = chip->of_node;
 543         if (!chip_np)
 544                 return ERR_PTR(-EINVAL);
 545
 546         xlate_flags = 0;
 547         *lflags = GPIO_LOOKUP_FLAGS_DEFAULT;
 548         *dflags = 0;
 549
 550         ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
 551         if (ret)
 552                 return ERR_PTR(ret);
 553
 554         gpiospec.np = chip_np;
 555         gpiospec.args_count = tmp;
 556
 557         for (i = 0; i < tmp; i++) {
 558                 ret = of_property_read_u32_index(np, "gpios", idx * tmp + i,
 559                                                  &gpiospec.args[i]);
 560                 if (ret)
 561                         return ERR_PTR(ret);
 562         }
 563
 564         desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
 565         if (IS_ERR(desc))
 566                 return desc;
 567
 568         if (xlate_flags & OF_GPIO_ACTIVE_LOW)
 569                 *lflags |= GPIO_ACTIVE_LOW;
 570         if (xlate_flags & OF_GPIO_TRANSITORY)
 571                 *lflags |= GPIO_TRANSITORY;
 572
 573         if (of_property_read_bool(np, "input"))
 574                 *dflags |= GPIOD_IN;
 575         else if (of_property_read_bool(np, "output-low"))
 576                 *dflags |= GPIOD_OUT_LOW;
 577         else if (of_property_read_bool(np, "output-high"))
 578                 *dflags |= GPIOD_OUT_HIGH;
 579         else {
 580                 pr_warn("GPIO line %d (%pOFn): no hogging state specified, bailing out\n",
 581                         desc_to_gpio(desc), np);
 582                 return ERR_PTR(-EINVAL);
 583         }
 584
 585         if (name && of_property_read_string(np, "line-name", name))
 586                 *name = np->name;
 587
 588         return desc;
 589 }
 590
 591 /**
 592  * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
 593  * @chip:       gpio chip to act on
 594  *
 595  * This is only used by of_gpiochip_add to request/set GPIO initial
 596  * configuration.
 597  * It returns error if it fails otherwise 0 on success.
 598  */
 599 static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
 600 {
 601         struct gpio_desc *desc = NULL;
 602         struct device_node *np;
 603         const char *name;
 604         unsigned long lflags;
 605         enum gpiod_flags dflags;
 606         unsigned int i;
 607         int ret;
 608
 609         for_each_available_child_of_node(chip->of_node, np) {
 610                 if (!of_property_read_bool(np, "gpio-hog"))
 611                         continue;
 612
 613                 for (i = 0;; i++) {
 614                         desc = of_parse_own_gpio(np, chip, i, &name, &lflags,
 615                                                  &dflags);
 616                         if (IS_ERR(desc))
 617                                 break;
 618
 619                         ret = gpiod_hog(desc, name, lflags, dflags);
 620                         if (ret < 0) {
 621                                 of_node_put(np);
 622                                 return ret;
 623                         }
 624                 }
 625         }
 626
 627         return 0;
 628 }
 629
 630 /**
 631  * of_gpio_simple_xlate - translate gpiospec to the GPIO number and flags
 632  * @gc:         pointer to the gpio_chip structure
 633  * @gpiospec:   GPIO specifier as found in the device tree
 634  * @flags:      a flags pointer to fill in
 635  *
 636  * This is simple translation function, suitable for the most 1:1 mapped
 637  * GPIO chips. This function performs only one sanity check: whether GPIO
 638  * is less than ngpios (that is specified in the gpio_chip).
 639  */
 640 static int of_gpio_simple_xlate(struct gpio_chip *gc,
 641                                 const struct of_phandle_args *gpiospec,
 642                                 u32 *flags)
 643 {
 644         /*
 645          * We're discouraging gpio_cells < 2, since that way you'll have to
 646          * write your own xlate function (that will have to retrieve the GPIO
 647          * number and the flags from a single gpio cell -- this is possible,
 648          * but not recommended).
 649          */
 650         if (gc->of_gpio_n_cells < 2) {
 651                 WARN_ON(1);
 652                 return -EINVAL;
 653         }
 654
 655         if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
 656                 return -EINVAL;
 657
 658         if (gpiospec->args[0] >= gc->ngpio)
 659                 return -EINVAL;
 660
 661         if (flags)
 662                 *flags = gpiospec->args[1];
 663
 664         return gpiospec->args[0];
 665 }
 666
 667 /**
 668  * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank)
 669  * @np:         device node of the GPIO chip
 670  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 671  * @data:       driver data to store in the struct gpio_chip
 672  *
 673  * To use this function you should allocate and fill mm_gc with:
 674  *
 675  * 1) In the gpio_chip structure:
 676  *    - all the callbacks
 677  *    - of_gpio_n_cells
 678  *    - of_xlate callback (optional)
 679  *
 680  * 3) In the of_mm_gpio_chip structure:
 681  *    - save_regs callback (optional)
 682  *
 683  * If succeeded, this function will map bank's memory and will
 684  * do all necessary work for you. Then you'll able to use .regs
 685  * to manage GPIOs from the callbacks.
 686  */
 687 int of_mm_gpiochip_add_data(struct device_node *np,
 688                             struct of_mm_gpio_chip *mm_gc,
 689                             void *data)
 690 {
 691         int ret = -ENOMEM;
 692         struct gpio_chip *gc = &mm_gc->gc;
 693
 694         gc->label = kasprintf(GFP_KERNEL, "%pOF", np);
 695         if (!gc->label)
 696                 goto err0;
 697
 698         mm_gc->regs = of_iomap(np, 0);
 699         if (!mm_gc->regs)
 700                 goto err1;
 701
 702         gc->base = -1;
 703
 704         if (mm_gc->save_regs)
 705                 mm_gc->save_regs(mm_gc);
 706
 707         mm_gc->gc.of_node = np;
 708
 709         ret = gpiochip_add_data(gc, data);
 710         if (ret)
 711                 goto err2;
 712
 713         return 0;
 714 err2:
 715         iounmap(mm_gc->regs);
 716 err1:
 717         kfree(gc->label);
 718 err0:
 719         pr_err("%pOF: GPIO chip registration failed with status %d\n", np, ret);
 720         return ret;
 721 }
 722 EXPORT_SYMBOL_GPL(of_mm_gpiochip_add_data);
 723
 724 /**
 725  * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
 726  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 727  */
 728 void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
 729 {
 730         struct gpio_chip *gc = &mm_gc->gc;
 731
 732         if (!mm_gc)
 733                 return;
 734
 735         gpiochip_remove(gc);
 736         iounmap(mm_gc->regs);
 737         kfree(gc->label);
 738 }
 739 EXPORT_SYMBOL_GPL(of_mm_gpiochip_remove);
 740
 741 static void of_gpiochip_init_valid_mask(struct gpio_chip *chip)
 742 {
 743         int len, i;
 744         u32 start, count;
 745         struct device_node *np = chip->of_node;
 746
 747         len = of_property_count_u32_elems(np,  "gpio-reserved-ranges");
 748         if (len < 0 || len % 2 != 0)
 749                 return;
 750
 751         for (i = 0; i < len; i += 2) {
 752                 of_property_read_u32_index(np, "gpio-reserved-ranges",
 753                                            i, &start);
 754                 of_property_read_u32_index(np, "gpio-reserved-ranges",
 755                                            i + 1, &count);
 756                 if (start >= chip->ngpio || start + count >= chip->ngpio)
 757                         continue;
 758
 759                 bitmap_clear(chip->valid_mask, start, count);
 760         }
 761 };
 762
 763 #ifdef CONFIG_PINCTRL
 764 static int of_gpiochip_add_pin_range(struct gpio_chip *chip)
 765 {
 766         struct device_node *np = chip->of_node;
 767         struct of_phandle_args pinspec;
 768         struct pinctrl_dev *pctldev;
 769         int index = 0, ret;
 770         const char *name;
 771         static const char group_names_propname[] = "gpio-ranges-group-names";
 772         struct property *group_names;
 773
 774         if (!np)
 775                 return 0;
 776
 777         group_names = of_find_property(np, group_names_propname, NULL);
 778
 779         for (;; index++) {
 780                 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
 781                                 index, &pinspec);
 782                 if (ret)
 783                         break;
 784
 785                 pctldev = of_pinctrl_get(pinspec.np);
 786                 of_node_put(pinspec.np);
 787                 if (!pctldev)
 788                         return -EPROBE_DEFER;
 789
 790                 if (pinspec.args[2]) {
 791                         if (group_names) {
 792                                 of_property_read_string_index(np,
 793                                                 group_names_propname,
 794                                                 index, &name);
 795                                 if (strlen(name)) {
 796                                         pr_err("%pOF: Group name of numeric GPIO ranges must be the empty string.\n",
 797                                                 np);
 798                                         break;
 799                                 }
 800                         }
 801                         /* npins != 0: linear range */
 802                         ret = gpiochip_add_pin_range(chip,
 803                                         pinctrl_dev_get_devname(pctldev),
 804                                         pinspec.args[0],
 805                                         pinspec.args[1],
 806                                         pinspec.args[2]);
 807                         if (ret)
 808                                 return ret;
 809                 } else {
 810                         /* npins == 0: special range */
 811                         if (pinspec.args[1]) {
 812                                 pr_err("%pOF: Illegal gpio-range format.\n",
 813                                         np);
 814                                 break;
 815                         }
 816
 817                         if (!group_names) {
 818                                 pr_err("%pOF: GPIO group range requested but no %s property.\n",
 819                                         np, group_names_propname);
 820                                 break;
 821                         }
 822
 823                         ret = of_property_read_string_index(np,
 824                                                 group_names_propname,
 825                                                 index, &name);
 826                         if (ret)
 827                                 break;
 828
 829                         if (!strlen(name)) {
 830                                 pr_err("%pOF: Group name of GPIO group range cannot be the empty string.\n",
 831                                 np);
 832                                 break;
 833                         }
 834
 835                         ret = gpiochip_add_pingroup_range(chip, pctldev,
 836                                                 pinspec.args[0], name);
 837                         if (ret)
 838                                 return ret;
 839                 }
 840         }
 841
 842         return 0;
 843 }
 844
 845 #else
 846 static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
 847 #endif
 848
 849 int of_gpiochip_add(struct gpio_chip *chip)
 850 {
 851         int ret;
 852
 853         if (!chip->of_node)
 854                 return 0;
 855
 856         if (!chip->of_xlate) {
 857                 chip->of_gpio_n_cells = 2;
 858                 chip->of_xlate = of_gpio_simple_xlate;
 859         }
 860
 861         if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
 862                 return -EINVAL;
 863
 864         of_gpiochip_init_valid_mask(chip);
 865
 866         ret = of_gpiochip_add_pin_range(chip);
 867         if (ret)
 868                 return ret;
 869
 870         /* If the chip defines names itself, these take precedence */
 871         if (!chip->names)
 872                 devprop_gpiochip_set_names(chip,
 873                                            of_fwnode_handle(chip->of_node));
 874
 875         of_node_get(chip->of_node);
 876
 877         ret = of_gpiochip_scan_gpios(chip);
 878         if (ret) {
 879                 of_node_put(chip->of_node);
 880                 gpiochip_remove_pin_ranges(chip);
 881         }
 882
 883         return ret;
 884 }
 885
 886 void of_gpiochip_remove(struct gpio_chip *chip)
 887 {
 888         gpiochip_remove_pin_ranges(chip);
 889         of_node_put(chip->of_node);
 890 }