drivers/pinctrl/devicetree.c

   1 /*
   2  * Device tree integration for the pin control subsystem
   3  *
   4  * Copyright (C) 2012 NVIDIA CORPORATION. All rights reserved.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #include <linux/device.h>
  20 #include <linux/of.h>
  21 #include <linux/pinctrl/pinctrl.h>
  22 #include <linux/slab.h>
  23
  24 #include "core.h"
  25 #include "devicetree.h"
  26
  27 /**
  28  * struct pinctrl_dt_map - mapping table chunk parsed from device tree
  29  * @node: list node for struct pinctrl's @dt_maps field
  30  * @pctldev: the pin controller that allocated this struct, and will free it
  31  * @maps: the mapping table entries
  32  */
  33 struct pinctrl_dt_map {
  34         struct list_head node;
  35         struct pinctrl_dev *pctldev;
  36         struct pinctrl_map *map;
  37         unsigned num_maps;
  38 };
  39
  40 static void dt_free_map(struct pinctrl_dev *pctldev,
  41                      struct pinctrl_map *map, unsigned num_maps)
  42 {
  43         int i;
  44
  45         for (i = 0; i < num_maps; ++i) {
  46                 kfree_const(map[i].dev_name);
  47                 map[i].dev_name = NULL;
  48         }
  49
  50         if (pctldev) {
  51                 const struct pinctrl_ops *ops = pctldev->desc->pctlops;
  52                 if (ops->dt_free_map)
  53                         ops->dt_free_map(pctldev, map, num_maps);
  54         } else {
  55                 /* There is no pctldev for PIN_MAP_TYPE_DUMMY_STATE */
  56                 kfree(map);
  57         }
  58 }
  59
  60 void pinctrl_dt_free_maps(struct pinctrl *p)
  61 {
  62         struct pinctrl_dt_map *dt_map, *n1;
  63
  64         list_for_each_entry_safe(dt_map, n1, &p->dt_maps, node) {
  65                 pinctrl_unregister_map(dt_map->map);
  66                 list_del(&dt_map->node);
  67                 dt_free_map(dt_map->pctldev, dt_map->map,
  68                             dt_map->num_maps);
  69                 kfree(dt_map);
  70         }
  71
  72         of_node_put(p->dev->of_node);
  73 }
  74
  75 static int dt_remember_or_free_map(struct pinctrl *p, const char *statename,
  76                                    struct pinctrl_dev *pctldev,
  77                                    struct pinctrl_map *map, unsigned num_maps)
  78 {
  79         int i;
  80         struct pinctrl_dt_map *dt_map;
  81
  82         /* Initialize common mapping table entry fields */
  83         for (i = 0; i < num_maps; i++) {
  84                 const char *devname;
  85
  86                 devname = kstrdup_const(dev_name(p->dev), GFP_KERNEL);
  87                 if (!devname)
  88                         goto err_free_map;
  89
  90                 map[i].dev_name = devname;
  91                 map[i].name = statename;
  92                 if (pctldev)
  93                         map[i].ctrl_dev_name = dev_name(pctldev->dev);
  94         }
  95
  96         /* Remember the converted mapping table entries */
  97         dt_map = kzalloc(sizeof(*dt_map), GFP_KERNEL);
  98         if (!dt_map)
  99                 goto err_free_map;
 100
 101         dt_map->pctldev = pctldev;
 102         dt_map->map = map;
 103         dt_map->num_maps = num_maps;
 104         list_add_tail(&dt_map->node, &p->dt_maps);
 105
 106         return pinctrl_register_map(map, num_maps, false);
 107
 108 err_free_map:
 109         dt_free_map(pctldev, map, num_maps);
 110         return -ENOMEM;
 111 }
 112
 113 struct pinctrl_dev *of_pinctrl_get(struct device_node *np)
 114 {
 115         return get_pinctrl_dev_from_of_node(np);
 116 }
 117
 118 static int dt_to_map_one_config(struct pinctrl *p,
 119                                 struct pinctrl_dev *hog_pctldev,
 120                                 const char *statename,
 121                                 struct device_node *np_config)
 122 {
 123         struct pinctrl_dev *pctldev = NULL;
 124         struct device_node *np_pctldev;
 125         const struct pinctrl_ops *ops;
 126         int ret;
 127         struct pinctrl_map *map;
 128         unsigned num_maps;
 129
 130         /* Find the pin controller containing np_config */
 131         np_pctldev = of_node_get(np_config);
 132         for (;;) {
 133                 np_pctldev = of_get_next_parent(np_pctldev);
 134                 if (!np_pctldev || of_node_is_root(np_pctldev)) {
 135                         dev_info(p->dev, "could not find pctldev for node %pOF, deferring probe\n",
 136                                 np_config);
 137                         of_node_put(np_pctldev);
 138                         /* OK let's just assume this will appear later then */
 139                         return -EPROBE_DEFER;
 140                 }
 141                 /* If we're creating a hog we can use the passed pctldev */
 142                 if (hog_pctldev && (np_pctldev == p->dev->of_node)) {
 143                         pctldev = hog_pctldev;
 144                         break;
 145                 }
 146                 pctldev = get_pinctrl_dev_from_of_node(np_pctldev);
 147                 if (pctldev)
 148                         break;
 149                 /* Do not defer probing of hogs (circular loop) */
 150                 if (np_pctldev == p->dev->of_node) {
 151                         of_node_put(np_pctldev);
 152                         return -ENODEV;
 153                 }
 154         }
 155         of_node_put(np_pctldev);
 156
 157         /*
 158          * Call pinctrl driver to parse device tree node, and
 159          * generate mapping table entries
 160          */
 161         ops = pctldev->desc->pctlops;
 162         if (!ops->dt_node_to_map) {
 163                 dev_err(p->dev, "pctldev %s doesn't support DT\n",
 164                         dev_name(pctldev->dev));
 165                 return -ENODEV;
 166         }
 167         ret = ops->dt_node_to_map(pctldev, np_config, &map, &num_maps);
 168         if (ret < 0)
 169                 return ret;
 170
 171         /* Stash the mapping table chunk away for later use */
 172         return dt_remember_or_free_map(p, statename, pctldev, map, num_maps);
 173 }
 174
 175 static int dt_remember_dummy_state(struct pinctrl *p, const char *statename)
 176 {
 177         struct pinctrl_map *map;
 178
 179         map = kzalloc(sizeof(*map), GFP_KERNEL);
 180         if (!map)
 181                 return -ENOMEM;
 182
 183         /* There is no pctldev for PIN_MAP_TYPE_DUMMY_STATE */
 184         map->type = PIN_MAP_TYPE_DUMMY_STATE;
 185
 186         return dt_remember_or_free_map(p, statename, NULL, map, 1);
 187 }
 188
 189 bool pinctrl_dt_has_hogs(struct pinctrl_dev *pctldev)
 190 {
 191         struct device_node *np;
 192         struct property *prop;
 193         int size;
 194
 195         np = pctldev->dev->of_node;
 196         if (!np)
 197                 return false;
 198
 199         prop = of_find_property(np, "pinctrl-0", &size);
 200
 201         return prop ? true : false;
 202 }
 203
 204 int pinctrl_dt_to_map(struct pinctrl *p, struct pinctrl_dev *pctldev)
 205 {
 206         struct device_node *np = p->dev->of_node;
 207         int state, ret;
 208         char *propname;
 209         struct property *prop;
 210         const char *statename;
 211         const __be32 *list;
 212         int size, config;
 213         phandle phandle;
 214         struct device_node *np_config;
 215
 216         /* CONFIG_OF enabled, p->dev not instantiated from DT */
 217         if (!np) {
 218                 if (of_have_populated_dt())
 219                         dev_dbg(p->dev,
 220                                 "no of_node; not parsing pinctrl DT\n");
 221                 return 0;
 222         }
 223
 224         /* We may store pointers to property names within the node */
 225         of_node_get(np);
 226
 227         /* For each defined state ID */
 228         for (state = 0; ; state++) {
 229                 /* Retrieve the pinctrl-* property */
 230                 propname = kasprintf(GFP_KERNEL, "pinctrl-%d", state);
 231                 prop = of_find_property(np, propname, &size);
 232                 kfree(propname);
 233                 if (!prop) {
 234                         if (state == 0) {
 235                                 of_node_put(np);
 236                                 return -ENODEV;
 237                         }
 238                         break;
 239                 }
 240                 list = prop->value;
 241                 size /= sizeof(*list);
 242
 243                 /* Determine whether pinctrl-names property names the state */
 244                 ret = of_property_read_string_index(np, "pinctrl-names",
 245                                                     state, &statename);
 246                 /*
 247                  * If not, statename is just the integer state ID. But rather
 248                  * than dynamically allocate it and have to free it later,
 249                  * just point part way into the property name for the string.
 250                  */
 251                 if (ret < 0) {
 252                         /* strlen("pinctrl-") == 8 */
 253                         statename = prop->name + 8;
 254                 }
 255
 256                 /* For every referenced pin configuration node in it */
 257                 for (config = 0; config < size; config++) {
 258                         phandle = be32_to_cpup(list++);
 259
 260                         /* Look up the pin configuration node */
 261                         np_config = of_find_node_by_phandle(phandle);
 262                         if (!np_config) {
 263                                 dev_err(p->dev,
 264                                         "prop %s index %i invalid phandle\n",
 265                                         prop->name, config);
 266                                 ret = -EINVAL;
 267                                 goto err;
 268                         }
 269
 270                         /* Parse the node */
 271                         ret = dt_to_map_one_config(p, pctldev, statename,
 272                                                    np_config);
 273                         of_node_put(np_config);
 274                         if (ret < 0)
 275                                 goto err;
 276                 }
 277
 278                 /* No entries in DT? Generate a dummy state table entry */
 279                 if (!size) {
 280                         ret = dt_remember_dummy_state(p, statename);
 281                         if (ret < 0)
 282                                 goto err;
 283                 }
 284         }
 285
 286         return 0;
 287
 288 err:
 289         pinctrl_dt_free_maps(p);
 290         return ret;
 291 }
 292
 293 /*
 294  * For pinctrl binding, typically #pinctrl-cells is for the pin controller
 295  * device, so either parent or grandparent. See pinctrl-bindings.txt.
 296  */
 297 static int pinctrl_find_cells_size(const struct device_node *np)
 298 {
 299         const char *cells_name = "#pinctrl-cells";
 300         int cells_size, error;
 301
 302         error = of_property_read_u32(np->parent, cells_name, &cells_size);
 303         if (error) {
 304                 error = of_property_read_u32(np->parent->parent,
 305                                              cells_name, &cells_size);
 306                 if (error)
 307                         return -ENOENT;
 308         }
 309
 310         return cells_size;
 311 }
 312
 313 /**
 314  * pinctrl_get_list_and_count - Gets the list and it's cell size and number
 315  * @np: pointer to device node with the property
 316  * @list_name: property that contains the list
 317  * @list: pointer for the list found
 318  * @cells_size: pointer for the cell size found
 319  * @nr_elements: pointer for the number of elements found
 320  *
 321  * Typically np is a single pinctrl entry containing the list.
 322  */
 323 static int pinctrl_get_list_and_count(const struct device_node *np,
 324                                       const char *list_name,
 325                                       const __be32 **list,
 326                                       int *cells_size,
 327                                       int *nr_elements)
 328 {
 329         int size;
 330
 331         *cells_size = 0;
 332         *nr_elements = 0;
 333
 334         *list = of_get_property(np, list_name, &size);
 335         if (!*list)
 336                 return -ENOENT;
 337
 338         *cells_size = pinctrl_find_cells_size(np);
 339         if (*cells_size < 0)
 340                 return -ENOENT;
 341
 342         /* First element is always the index within the pinctrl device */
 343         *nr_elements = (size / sizeof(**list)) / (*cells_size + 1);
 344
 345         return 0;
 346 }
 347
 348 /**
 349  * pinctrl_count_index_with_args - Count number of elements in a pinctrl entry
 350  * @np: pointer to device node with the property
 351  * @list_name: property that contains the list
 352  *
 353  * Counts the number of elements in a pinctrl array consisting of an index
 354  * within the controller and a number of u32 entries specified for each
 355  * entry. Note that device_node is always for the parent pin controller device.
 356  */
 357 int pinctrl_count_index_with_args(const struct device_node *np,
 358                                   const char *list_name)
 359 {
 360         const __be32 *list;
 361         int size, nr_cells, error;
 362
 363         error = pinctrl_get_list_and_count(np, list_name, &list,
 364                                            &nr_cells, &size);
 365         if (error)
 366                 return error;
 367
 368         return size;
 369 }
 370 EXPORT_SYMBOL_GPL(pinctrl_count_index_with_args);
 371
 372 /**
 373  * pinctrl_copy_args - Populates of_phandle_args based on index
 374  * @np: pointer to device node with the property
 375  * @list: pointer to a list with the elements
 376  * @index: entry within the list of elements
 377  * @nr_cells: number of cells in the list
 378  * @nr_elem: number of elements for each entry in the list
 379  * @out_args: returned values
 380  *
 381  * Populates the of_phandle_args based on the index in the list.
 382  */
 383 static int pinctrl_copy_args(const struct device_node *np,
 384                              const __be32 *list,
 385                              int index, int nr_cells, int nr_elem,
 386                              struct of_phandle_args *out_args)
 387 {
 388         int i;
 389
 390         memset(out_args, 0, sizeof(*out_args));
 391         out_args->np = (struct device_node *)np;
 392         out_args->args_count = nr_cells + 1;
 393
 394         if (index >= nr_elem)
 395                 return -EINVAL;
 396
 397         list += index * (nr_cells + 1);
 398
 399         for (i = 0; i < nr_cells + 1; i++)
 400                 out_args->args[i] = be32_to_cpup(list++);
 401
 402         return 0;
 403 }
 404
 405 /**
 406  * pinctrl_parse_index_with_args - Find a node pointed by index in a list
 407  * @np: pointer to device node with the property
 408  * @list_name: property that contains the list
 409  * @index: index within the list
 410  * @out_arts: entries in the list pointed by index
 411  *
 412  * Finds the selected element in a pinctrl array consisting of an index
 413  * within the controller and a number of u32 entries specified for each
 414  * entry. Note that device_node is always for the parent pin controller device.
 415  */
 416 int pinctrl_parse_index_with_args(const struct device_node *np,
 417                                   const char *list_name, int index,
 418                                   struct of_phandle_args *out_args)
 419 {
 420         const __be32 *list;
 421         int nr_elem, nr_cells, error;
 422
 423         error = pinctrl_get_list_and_count(np, list_name, &list,
 424                                            &nr_cells, &nr_elem);
 425         if (error || !nr_cells)
 426                 return error;
 427
 428         error = pinctrl_copy_args(np, list, index, nr_cells, nr_elem,
 429                                   out_args);
 430         if (error)
 431                 return error;
 432
 433         return 0;
 434 }
 435 EXPORT_SYMBOL_GPL(pinctrl_parse_index_with_args);