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