drivers/pinctrl/devicetree.c

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