drivers/gpio/gpiolib-of.c

   1 /*
   2  * OF helpers for the GPIO API
   3  *
   4  * Copyright (c) 2007-2008  MontaVista Software, Inc.
   5  *
   6  * Author: Anton Vorontsov <[email protected]>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  */
  13
  14 #include <linux/device.h>
  15 #include <linux/err.h>
  16 #include <linux/errno.h>
  17 #include <linux/module.h>
  18 #include <linux/io.h>
  19 #include <linux/gpio/consumer.h>
  20 #include <linux/of.h>
  21 #include <linux/of_address.h>
  22 #include <linux/of_gpio.h>
  23 #include <linux/pinctrl/pinctrl.h>
  24 #include <linux/slab.h>
  25 #include <linux/gpio/machine.h>
  26
  27 #include "gpiolib.h"
  28
  29 static int of_gpiochip_match_node(struct gpio_chip *chip, void *data)
  30 {
  31         return chip->gpiodev->dev.of_node == data;
  32 }
  33
  34 static struct gpio_chip *of_find_gpiochip_by_node(struct device_node *np)
  35 {
  36         return gpiochip_find(np, of_gpiochip_match_node);
  37 }
  38
  39 static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip,
  40                                         struct of_phandle_args *gpiospec,
  41                                         enum of_gpio_flags *flags)
  42 {
  43         int ret;
  44
  45         if (chip->of_gpio_n_cells != gpiospec->args_count)
  46                 return ERR_PTR(-EINVAL);
  47
  48         ret = chip->of_xlate(chip, gpiospec, flags);
  49         if (ret < 0)
  50                 return ERR_PTR(ret);
  51
  52         return gpiochip_get_desc(chip, ret);
  53 }
  54
  55 /**
  56  * of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API
  57  * @np:         device node to get GPIO from
  58  * @propname:   property name containing gpio specifier(s)
  59  * @index:      index of the GPIO
  60  * @flags:      a flags pointer to fill in
  61  *
  62  * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
  63  * value on the error condition. If @flags is not NULL the function also fills
  64  * in flags for the GPIO.
  65  */
  66 struct gpio_desc *of_get_named_gpiod_flags(struct device_node *np,
  67                      const char *propname, int index, enum of_gpio_flags *flags)
  68 {
  69         struct of_phandle_args gpiospec;
  70         struct gpio_chip *chip;
  71         struct gpio_desc *desc;
  72         int ret;
  73
  74         ret = of_parse_phandle_with_args(np, propname, "#gpio-cells", index,
  75                                          &gpiospec);
  76         if (ret) {
  77                 pr_debug("%s: can't parse '%s' property of node '%s[%d]'\n",
  78                         __func__, propname, np->full_name, index);
  79                 return ERR_PTR(ret);
  80         }
  81
  82         chip = of_find_gpiochip_by_node(gpiospec.np);
  83         if (!chip) {
  84                 desc = ERR_PTR(-EPROBE_DEFER);
  85                 goto out;
  86         }
  87
  88         desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, flags);
  89         if (IS_ERR(desc))
  90                 goto out;
  91
  92         pr_debug("%s: parsed '%s' property of node '%s[%d]' - status (%d)\n",
  93                  __func__, propname, np->full_name, index,
  94                  PTR_ERR_OR_ZERO(desc));
  95
  96 out:
  97         of_node_put(gpiospec.np);
  98
  99         return desc;
 100 }
 101
 102 int of_get_named_gpio_flags(struct device_node *np, const char *list_name,
 103                             int index, enum of_gpio_flags *flags)
 104 {
 105         struct gpio_desc *desc;
 106
 107         desc = of_get_named_gpiod_flags(np, list_name, index, flags);
 108
 109         if (IS_ERR(desc))
 110                 return PTR_ERR(desc);
 111         else
 112                 return desc_to_gpio(desc);
 113 }
 114 EXPORT_SYMBOL(of_get_named_gpio_flags);
 115
 116 struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
 117                                unsigned int idx,
 118                                enum gpio_lookup_flags *flags)
 119 {
 120         char prop_name[32]; /* 32 is max size of property name */
 121         enum of_gpio_flags of_flags;
 122         struct gpio_desc *desc;
 123         unsigned int i;
 124
 125         for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
 126                 if (con_id)
 127                         snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
 128                                  gpio_suffixes[i]);
 129                 else
 130                         snprintf(prop_name, sizeof(prop_name), "%s",
 131                                  gpio_suffixes[i]);
 132
 133                 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
 134                                                 &of_flags);
 135                 if (!IS_ERR(desc) || (PTR_ERR(desc) != -ENOENT))
 136                         break;
 137         }
 138
 139         if (IS_ERR(desc))
 140                 return desc;
 141
 142         if (of_flags & OF_GPIO_ACTIVE_LOW)
 143                 *flags |= GPIO_ACTIVE_LOW;
 144
 145         if (of_flags & OF_GPIO_SINGLE_ENDED) {
 146                 if (of_flags & OF_GPIO_ACTIVE_LOW)
 147                         *flags |= GPIO_OPEN_DRAIN;
 148                 else
 149                         *flags |= GPIO_OPEN_SOURCE;
 150         }
 151
 152         return desc;
 153 }
 154
 155 /**
 156  * of_parse_own_gpio() - Get a GPIO hog descriptor, names and flags for GPIO API
 157  * @np:         device node to get GPIO from
 158  * @chip:       GPIO chip whose hog is parsed
 159  * @name:       GPIO line name
 160  * @lflags:     gpio_lookup_flags - returned from of_find_gpio() or
 161  *              of_parse_own_gpio()
 162  * @dflags:     gpiod_flags - optional GPIO initialization flags
 163  *
 164  * Returns GPIO descriptor to use with Linux GPIO API, or one of the errno
 165  * value on the error condition.
 166  */
 167 static struct gpio_desc *of_parse_own_gpio(struct device_node *np,
 168                                            struct gpio_chip *chip,
 169                                            const char **name,
 170                                            enum gpio_lookup_flags *lflags,
 171                                            enum gpiod_flags *dflags)
 172 {
 173         struct device_node *chip_np;
 174         enum of_gpio_flags xlate_flags;
 175         struct of_phandle_args gpiospec;
 176         struct gpio_desc *desc;
 177         u32 tmp;
 178         int ret;
 179
 180         chip_np = chip->of_node;
 181         if (!chip_np)
 182                 return ERR_PTR(-EINVAL);
 183
 184         xlate_flags = 0;
 185         *lflags = 0;
 186         *dflags = 0;
 187
 188         ret = of_property_read_u32(chip_np, "#gpio-cells", &tmp);
 189         if (ret)
 190                 return ERR_PTR(ret);
 191
 192         gpiospec.np = chip_np;
 193         gpiospec.args_count = tmp;
 194
 195         ret = of_property_read_u32_array(np, "gpios", gpiospec.args, tmp);
 196         if (ret)
 197                 return ERR_PTR(ret);
 198
 199         desc = of_xlate_and_get_gpiod_flags(chip, &gpiospec, &xlate_flags);
 200         if (IS_ERR(desc))
 201                 return desc;
 202
 203         if (xlate_flags & OF_GPIO_ACTIVE_LOW)
 204                 *lflags |= GPIO_ACTIVE_LOW;
 205
 206         if (of_property_read_bool(np, "input"))
 207                 *dflags |= GPIOD_IN;
 208         else if (of_property_read_bool(np, "output-low"))
 209                 *dflags |= GPIOD_OUT_LOW;
 210         else if (of_property_read_bool(np, "output-high"))
 211                 *dflags |= GPIOD_OUT_HIGH;
 212         else {
 213                 pr_warn("GPIO line %d (%s): no hogging state specified, bailing out\n",
 214                         desc_to_gpio(desc), np->name);
 215                 return ERR_PTR(-EINVAL);
 216         }
 217
 218         if (name && of_property_read_string(np, "line-name", name))
 219                 *name = np->name;
 220
 221         return desc;
 222 }
 223
 224 /**
 225  * of_gpiochip_set_names() - set up the names of the lines
 226  * @chip: GPIO chip whose lines should be named, if possible
 227  */
 228 static void of_gpiochip_set_names(struct gpio_chip *gc)
 229 {
 230         struct gpio_device *gdev = gc->gpiodev;
 231         struct device_node *np = gc->of_node;
 232         int i;
 233         int nstrings;
 234
 235         nstrings = of_property_count_strings(np, "gpio-line-names");
 236         if (nstrings <= 0)
 237                 /* Lines names not present */
 238                 return;
 239
 240         /* This is normally not what you want */
 241         if (gdev->ngpio != nstrings)
 242                 dev_info(&gdev->dev, "gpio-line-names specifies %d line "
 243                          "names but there are %d lines on the chip\n",
 244                          nstrings, gdev->ngpio);
 245
 246         /*
 247          * Make sure to not index beyond the end of the number of descriptors
 248          * of the GPIO device.
 249          */
 250         for (i = 0; i < gdev->ngpio; i++) {
 251                 const char *name;
 252                 int ret;
 253
 254                 ret = of_property_read_string_index(np,
 255                                                     "gpio-line-names",
 256                                                     i,
 257                                                     &name);
 258                 if (ret) {
 259                         if (ret != -ENODATA)
 260                                 dev_err(&gdev->dev,
 261                                         "unable to name line %d: %d\n",
 262                                         i, ret);
 263                         break;
 264                 }
 265                 gdev->descs[i].name = name;
 266         }
 267 }
 268
 269 /**
 270  * of_gpiochip_scan_gpios - Scan gpio-controller for gpio definitions
 271  * @chip:       gpio chip to act on
 272  *
 273  * This is only used by of_gpiochip_add to request/set GPIO initial
 274  * configuration.
 275  * It retures error if it fails otherwise 0 on success.
 276  */
 277 static int of_gpiochip_scan_gpios(struct gpio_chip *chip)
 278 {
 279         struct gpio_desc *desc = NULL;
 280         struct device_node *np;
 281         const char *name;
 282         enum gpio_lookup_flags lflags;
 283         enum gpiod_flags dflags;
 284         int ret;
 285
 286         for_each_available_child_of_node(chip->of_node, np) {
 287                 if (!of_property_read_bool(np, "gpio-hog"))
 288                         continue;
 289
 290                 desc = of_parse_own_gpio(np, chip, &name, &lflags, &dflags);
 291                 if (IS_ERR(desc))
 292                         continue;
 293
 294                 ret = gpiod_hog(desc, name, lflags, dflags);
 295                 if (ret < 0)
 296                         return ret;
 297         }
 298
 299         return 0;
 300 }
 301
 302 /**
 303  * of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags
 304  * @gc:         pointer to the gpio_chip structure
 305  * @np:         device node of the GPIO chip
 306  * @gpio_spec:  gpio specifier as found in the device tree
 307  * @flags:      a flags pointer to fill in
 308  *
 309  * This is simple translation function, suitable for the most 1:1 mapped
 310  * gpio chips. This function performs only one sanity check: whether gpio
 311  * is less than ngpios (that is specified in the gpio_chip).
 312  */
 313 int of_gpio_simple_xlate(struct gpio_chip *gc,
 314                          const struct of_phandle_args *gpiospec, u32 *flags)
 315 {
 316         /*
 317          * We're discouraging gpio_cells < 2, since that way you'll have to
 318          * write your own xlate function (that will have to retrieve the GPIO
 319          * number and the flags from a single gpio cell -- this is possible,
 320          * but not recommended).
 321          */
 322         if (gc->of_gpio_n_cells < 2) {
 323                 WARN_ON(1);
 324                 return -EINVAL;
 325         }
 326
 327         if (WARN_ON(gpiospec->args_count < gc->of_gpio_n_cells))
 328                 return -EINVAL;
 329
 330         if (gpiospec->args[0] >= gc->ngpio)
 331                 return -EINVAL;
 332
 333         if (flags)
 334                 *flags = gpiospec->args[1];
 335
 336         return gpiospec->args[0];
 337 }
 338 EXPORT_SYMBOL(of_gpio_simple_xlate);
 339
 340 /**
 341  * of_mm_gpiochip_add_data - Add memory mapped GPIO chip (bank)
 342  * @np:         device node of the GPIO chip
 343  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 344  * @data:       driver data to store in the struct gpio_chip
 345  *
 346  * To use this function you should allocate and fill mm_gc with:
 347  *
 348  * 1) In the gpio_chip structure:
 349  *    - all the callbacks
 350  *    - of_gpio_n_cells
 351  *    - of_xlate callback (optional)
 352  *
 353  * 3) In the of_mm_gpio_chip structure:
 354  *    - save_regs callback (optional)
 355  *
 356  * If succeeded, this function will map bank's memory and will
 357  * do all necessary work for you. Then you'll able to use .regs
 358  * to manage GPIOs from the callbacks.
 359  */
 360 int of_mm_gpiochip_add_data(struct device_node *np,
 361                             struct of_mm_gpio_chip *mm_gc,
 362                             void *data)
 363 {
 364         int ret = -ENOMEM;
 365         struct gpio_chip *gc = &mm_gc->gc;
 366
 367         gc->label = kstrdup(np->full_name, GFP_KERNEL);
 368         if (!gc->label)
 369                 goto err0;
 370
 371         mm_gc->regs = of_iomap(np, 0);
 372         if (!mm_gc->regs)
 373                 goto err1;
 374
 375         gc->base = -1;
 376
 377         if (mm_gc->save_regs)
 378                 mm_gc->save_regs(mm_gc);
 379
 380         mm_gc->gc.of_node = np;
 381
 382         ret = gpiochip_add_data(gc, data);
 383         if (ret)
 384                 goto err2;
 385
 386         return 0;
 387 err2:
 388         iounmap(mm_gc->regs);
 389 err1:
 390         kfree(gc->label);
 391 err0:
 392         pr_err("%s: GPIO chip registration failed with status %d\n",
 393                np->full_name, ret);
 394         return ret;
 395 }
 396 EXPORT_SYMBOL(of_mm_gpiochip_add_data);
 397
 398 /**
 399  * of_mm_gpiochip_remove - Remove memory mapped GPIO chip (bank)
 400  * @mm_gc:      pointer to the of_mm_gpio_chip allocated structure
 401  */
 402 void of_mm_gpiochip_remove(struct of_mm_gpio_chip *mm_gc)
 403 {
 404         struct gpio_chip *gc = &mm_gc->gc;
 405
 406         if (!mm_gc)
 407                 return;
 408
 409         gpiochip_remove(gc);
 410         iounmap(mm_gc->regs);
 411         kfree(gc->label);
 412 }
 413 EXPORT_SYMBOL(of_mm_gpiochip_remove);
 414
 415 #ifdef CONFIG_PINCTRL
 416 static int of_gpiochip_add_pin_range(struct gpio_chip *chip)
 417 {
 418         struct device_node *np = chip->of_node;
 419         struct of_phandle_args pinspec;
 420         struct pinctrl_dev *pctldev;
 421         int index = 0, ret;
 422         const char *name;
 423         static const char group_names_propname[] = "gpio-ranges-group-names";
 424         struct property *group_names;
 425
 426         if (!np)
 427                 return 0;
 428
 429         group_names = of_find_property(np, group_names_propname, NULL);
 430
 431         for (;; index++) {
 432                 ret = of_parse_phandle_with_fixed_args(np, "gpio-ranges", 3,
 433                                 index, &pinspec);
 434                 if (ret)
 435                         break;
 436
 437                 pctldev = of_pinctrl_get(pinspec.np);
 438                 of_node_put(pinspec.np);
 439                 if (!pctldev)
 440                         return -EPROBE_DEFER;
 441
 442                 if (pinspec.args[2]) {
 443                         if (group_names) {
 444                                 of_property_read_string_index(np,
 445                                                 group_names_propname,
 446                                                 index, &name);
 447                                 if (strlen(name)) {
 448                                         pr_err("%s: Group name of numeric GPIO ranges must be the empty string.\n",
 449                                                 np->full_name);
 450                                         break;
 451                                 }
 452                         }
 453                         /* npins != 0: linear range */
 454                         ret = gpiochip_add_pin_range(chip,
 455                                         pinctrl_dev_get_devname(pctldev),
 456                                         pinspec.args[0],
 457                                         pinspec.args[1],
 458                                         pinspec.args[2]);
 459                         if (ret)
 460                                 return ret;
 461                 } else {
 462                         /* npins == 0: special range */
 463                         if (pinspec.args[1]) {
 464                                 pr_err("%s: Illegal gpio-range format.\n",
 465                                         np->full_name);
 466                                 break;
 467                         }
 468
 469                         if (!group_names) {
 470                                 pr_err("%s: GPIO group range requested but no %s property.\n",
 471                                         np->full_name, group_names_propname);
 472                                 break;
 473                         }
 474
 475                         ret = of_property_read_string_index(np,
 476                                                 group_names_propname,
 477                                                 index, &name);
 478                         if (ret)
 479                                 break;
 480
 481                         if (!strlen(name)) {
 482                                 pr_err("%s: Group name of GPIO group range cannot be the empty string.\n",
 483                                 np->full_name);
 484                                 break;
 485                         }
 486
 487                         ret = gpiochip_add_pingroup_range(chip, pctldev,
 488                                                 pinspec.args[0], name);
 489                         if (ret)
 490                                 return ret;
 491                 }
 492         }
 493
 494         return 0;
 495 }
 496
 497 #else
 498 static int of_gpiochip_add_pin_range(struct gpio_chip *chip) { return 0; }
 499 #endif
 500
 501 int of_gpiochip_add(struct gpio_chip *chip)
 502 {
 503         int status;
 504
 505         if ((!chip->of_node) && (chip->parent))
 506                 chip->of_node = chip->parent->of_node;
 507
 508         if (!chip->of_node)
 509                 return 0;
 510
 511         if (!chip->of_xlate) {
 512                 chip->of_gpio_n_cells = 2;
 513                 chip->of_xlate = of_gpio_simple_xlate;
 514         }
 515
 516         if (chip->of_gpio_n_cells > MAX_PHANDLE_ARGS)
 517                 return -EINVAL;
 518
 519         status = of_gpiochip_add_pin_range(chip);
 520         if (status)
 521                 return status;
 522
 523         /* If the chip defines names itself, these take precedence */
 524         if (!chip->names)
 525                 of_gpiochip_set_names(chip);
 526
 527         of_node_get(chip->of_node);
 528
 529         return of_gpiochip_scan_gpios(chip);
 530 }
 531
 532 void of_gpiochip_remove(struct gpio_chip *chip)
 533 {
 534         gpiochip_remove_pin_ranges(chip);
 535         of_node_put(chip->of_node);
 536 }