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         bool allow_default = false;
 130
 131         /* Find the pin controller containing np_config */
 132         np_pctldev = of_node_get(np_config);
 133         for (;;) {
 134                 if (!allow_default)
 135                         allow_default = of_property_read_bool(np_pctldev,
 136                                                               "pinctrl-use-default");
 137
 138                 np_pctldev = of_get_next_parent(np_pctldev);
 139                 if (!np_pctldev || of_node_is_root(np_pctldev)) {
 140                         of_node_put(np_pctldev);
 141                         ret = driver_deferred_probe_check_state(p->dev);
 142                         /* keep deferring if modules are enabled unless we've timed out */
 143                         if (IS_ENABLED(CONFIG_MODULES) && !allow_default && ret == -ENODEV)
 144                                 ret = -EPROBE_DEFER;
 145
 146                         return ret;
 147                 }
 148                 /* If we're creating a hog we can use the passed pctldev */
 149                 if (hog_pctldev && (np_pctldev == p->dev->of_node)) {
 150                         pctldev = hog_pctldev;
 151                         break;
 152                 }
 153                 pctldev = get_pinctrl_dev_from_of_node(np_pctldev);
 154                 if (pctldev)
 155                         break;
 156                 /* Do not defer probing of hogs (circular loop) */
 157                 if (np_pctldev == p->dev->of_node) {
 158                         of_node_put(np_pctldev);
 159                         return -ENODEV;
 160                 }
 161         }
 162         of_node_put(np_pctldev);
 163
 164         /*
 165          * Call pinctrl driver to parse device tree node, and
 166          * generate mapping table entries
 167          */
 168         ops = pctldev->desc->pctlops;
 169         if (!ops->dt_node_to_map) {
 170                 dev_err(p->dev, "pctldev %s doesn't support DT\n",
 171                         dev_name(pctldev->dev));
 172                 return -ENODEV;
 173         }
 174         ret = ops->dt_node_to_map(pctldev, np_config, &map, &num_maps);
 175         if (ret < 0)
 176                 return ret;
 177
 178         /* Stash the mapping table chunk away for later use */
 179         return dt_remember_or_free_map(p, statename, pctldev, map, num_maps);
 180 }
 181
 182 static int dt_remember_dummy_state(struct pinctrl *p, const char *statename)
 183 {
 184         struct pinctrl_map *map;
 185
 186         map = kzalloc(sizeof(*map), GFP_KERNEL);
 187         if (!map)
 188                 return -ENOMEM;
 189
 190         /* There is no pctldev for PIN_MAP_TYPE_DUMMY_STATE */
 191         map->type = PIN_MAP_TYPE_DUMMY_STATE;
 192
 193         return dt_remember_or_free_map(p, statename, NULL, map, 1);
 194 }
 195
 196 bool pinctrl_dt_has_hogs(struct pinctrl_dev *pctldev)
 197 {
 198         struct device_node *np;
 199         struct property *prop;
 200         int size;
 201
 202         np = pctldev->dev->of_node;
 203         if (!np)
 204                 return false;
 205
 206         prop = of_find_property(np, "pinctrl-0", &size);
 207
 208         return prop ? true : false;
 209 }
 210
 211 int pinctrl_dt_to_map(struct pinctrl *p, struct pinctrl_dev *pctldev)
 212 {
 213         struct device_node *np = p->dev->of_node;
 214         int state, ret;
 215         char *propname;
 216         struct property *prop;
 217         const char *statename;
 218         const __be32 *list;
 219         int size, config;
 220         phandle phandle;
 221         struct device_node *np_config;
 222
 223         /* CONFIG_OF enabled, p->dev not instantiated from DT */
 224         if (!np) {
 225                 if (of_have_populated_dt())
 226                         dev_dbg(p->dev,
 227                                 "no of_node; not parsing pinctrl DT\n");
 228                 return 0;
 229         }
 230
 231         /* We may store pointers to property names within the node */
 232         of_node_get(np);
 233
 234         /* For each defined state ID */
 235         for (state = 0; ; state++) {
 236                 /* Retrieve the pinctrl-* property */
 237                 propname = kasprintf(GFP_KERNEL, "pinctrl-%d", state);
 238                 if (!propname) {
 239                         ret = -ENOMEM;
 240                         goto err;
 241                 }
 242                 prop = of_find_property(np, propname, &size);
 243                 kfree(propname);
 244                 if (!prop) {
 245                         if (state == 0) {
 246                                 ret = -ENODEV;
 247                                 goto err;
 248                         }
 249                         break;
 250                 }
 251                 list = prop->value;
 252                 size /= sizeof(*list);
 253
 254                 /* Determine whether pinctrl-names property names the state */
 255                 ret = of_property_read_string_index(np, "pinctrl-names",
 256                                                     state, &statename);
 257                 /*
 258                  * If not, statename is just the integer state ID. But rather
 259                  * than dynamically allocate it and have to free it later,
 260                  * just point part way into the property name for the string.
 261                  */
 262                 if (ret < 0) {
 263                         /* strlen("pinctrl-") == 8 */
 264                         statename = prop->name + 8;
 265                 }
 266
 267                 /* For every referenced pin configuration node in it */
 268                 for (config = 0; config < size; config++) {
 269                         phandle = be32_to_cpup(list++);
 270
 271                         /* Look up the pin configuration node */
 272                         np_config = of_find_node_by_phandle(phandle);
 273                         if (!np_config) {
 274                                 dev_err(p->dev,
 275                                         "prop %s index %i invalid phandle\n",
 276                                         prop->name, config);
 277                                 ret = -EINVAL;
 278                                 goto err;
 279                         }
 280
 281                         /* Parse the node */
 282                         ret = dt_to_map_one_config(p, pctldev, statename,
 283                                                    np_config);
 284                         of_node_put(np_config);
 285                         if (ret < 0)
 286                                 goto err;
 287                 }
 288
 289                 /* No entries in DT? Generate a dummy state table entry */
 290                 if (!size) {
 291                         ret = dt_remember_dummy_state(p, statename);
 292                         if (ret < 0)
 293                                 goto err;
 294                 }
 295         }
 296
 297         return 0;
 298
 299 err:
 300         pinctrl_dt_free_maps(p);
 301         return ret;
 302 }
 303
 304 /*
 305  * For pinctrl binding, typically #pinctrl-cells is for the pin controller
 306  * device, so either parent or grandparent. See pinctrl-bindings.txt.
 307  */
 308 static int pinctrl_find_cells_size(const struct device_node *np)
 309 {
 310         const char *cells_name = "#pinctrl-cells";
 311         int cells_size, error;
 312
 313         error = of_property_read_u32(np->parent, cells_name, &cells_size);
 314         if (error) {
 315                 error = of_property_read_u32(np->parent->parent,
 316                                              cells_name, &cells_size);
 317                 if (error)
 318                         return -ENOENT;
 319         }
 320
 321         return cells_size;
 322 }
 323
 324 /**
 325  * pinctrl_get_list_and_count - Gets the list and it's cell size and number
 326  * @np: pointer to device node with the property
 327  * @list_name: property that contains the list
 328  * @list: pointer for the list found
 329  * @cells_size: pointer for the cell size found
 330  * @nr_elements: pointer for the number of elements found
 331  *
 332  * Typically np is a single pinctrl entry containing the list.
 333  */
 334 static int pinctrl_get_list_and_count(const struct device_node *np,
 335                                       const char *list_name,
 336                                       const __be32 **list,
 337                                       int *cells_size,
 338                                       int *nr_elements)
 339 {
 340         int size;
 341
 342         *cells_size = 0;
 343         *nr_elements = 0;
 344
 345         *list = of_get_property(np, list_name, &size);
 346         if (!*list)
 347                 return -ENOENT;
 348
 349         *cells_size = pinctrl_find_cells_size(np);
 350         if (*cells_size < 0)
 351                 return -ENOENT;
 352
 353         /* First element is always the index within the pinctrl device */
 354         *nr_elements = (size / sizeof(**list)) / (*cells_size + 1);
 355
 356         return 0;
 357 }
 358
 359 /**
 360  * pinctrl_count_index_with_args - Count number of elements in a pinctrl entry
 361  * @np: pointer to device node with the property
 362  * @list_name: property that contains the list
 363  *
 364  * Counts the number of elements in a pinctrl array consisting of an index
 365  * within the controller and a number of u32 entries specified for each
 366  * entry. Note that device_node is always for the parent pin controller device.
 367  */
 368 int pinctrl_count_index_with_args(const struct device_node *np,
 369                                   const char *list_name)
 370 {
 371         const __be32 *list;
 372         int size, nr_cells, error;
 373
 374         error = pinctrl_get_list_and_count(np, list_name, &list,
 375                                            &nr_cells, &size);
 376         if (error)
 377                 return error;
 378
 379         return size;
 380 }
 381 EXPORT_SYMBOL_GPL(pinctrl_count_index_with_args);
 382
 383 /**
 384  * pinctrl_copy_args - Populates of_phandle_args based on index
 385  * @np: pointer to device node with the property
 386  * @list: pointer to a list with the elements
 387  * @index: entry within the list of elements
 388  * @nr_cells: number of cells in the list
 389  * @nr_elem: number of elements for each entry in the list
 390  * @out_args: returned values
 391  *
 392  * Populates the of_phandle_args based on the index in the list.
 393  */
 394 static int pinctrl_copy_args(const struct device_node *np,
 395                              const __be32 *list,
 396                              int index, int nr_cells, int nr_elem,
 397                              struct of_phandle_args *out_args)
 398 {
 399         int i;
 400
 401         memset(out_args, 0, sizeof(*out_args));
 402         out_args->np = (struct device_node *)np;
 403         out_args->args_count = nr_cells + 1;
 404
 405         if (index >= nr_elem)
 406                 return -EINVAL;
 407
 408         list += index * (nr_cells + 1);
 409
 410         for (i = 0; i < nr_cells + 1; i++)
 411                 out_args->args[i] = be32_to_cpup(list++);
 412
 413         return 0;
 414 }
 415
 416 /**
 417  * pinctrl_parse_index_with_args - Find a node pointed by index in a list
 418  * @np: pointer to device node with the property
 419  * @list_name: property that contains the list
 420  * @index: index within the list
 421  * @out_arts: entries in the list pointed by index
 422  *
 423  * Finds the selected element in a pinctrl array consisting of an index
 424  * within the controller and a number of u32 entries specified for each
 425  * entry. Note that device_node is always for the parent pin controller device.
 426  */
 427 int pinctrl_parse_index_with_args(const struct device_node *np,
 428                                   const char *list_name, int index,
 429                                   struct of_phandle_args *out_args)
 430 {
 431         const __be32 *list;
 432         int nr_elem, nr_cells, error;
 433
 434         error = pinctrl_get_list_and_count(np, list_name, &list,
 435                                            &nr_cells, &nr_elem);
 436         if (error || !nr_cells)
 437                 return error;
 438
 439         error = pinctrl_copy_args(np, list, index, nr_cells, nr_elem,
 440                                   out_args);
 441         if (error)
 442                 return error;
 443
 444         return 0;
 445 }
 446 EXPORT_SYMBOL_GPL(pinctrl_parse_index_with_args);