2 * Device tree integration for the pin control subsystem
4 * Copyright (C) 2012 NVIDIA CORPORATION. All rights reserved.
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.
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
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/>.
19 #include <linux/device.h>
21 #include <linux/pinctrl/pinctrl.h>
22 #include <linux/slab.h>
25 #include "devicetree.h"
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
33 struct pinctrl_dt_map {
34 struct list_head node;
35 struct pinctrl_dev *pctldev;
36 struct pinctrl_map *map;
40 static void dt_free_map(struct pinctrl_dev *pctldev,
41 struct pinctrl_map *map, unsigned num_maps)
44 const struct pinctrl_ops *ops = pctldev->desc->pctlops;
46 ops->dt_free_map(pctldev, map, num_maps);
48 /* There is no pctldev for PIN_MAP_TYPE_DUMMY_STATE */
53 void pinctrl_dt_free_maps(struct pinctrl *p)
55 struct pinctrl_dt_map *dt_map, *n1;
57 list_for_each_entry_safe(dt_map, n1, &p->dt_maps, node) {
58 pinctrl_unregister_map(dt_map->map);
59 list_del(&dt_map->node);
60 dt_free_map(dt_map->pctldev, dt_map->map,
65 of_node_put(p->dev->of_node);
68 static int dt_remember_or_free_map(struct pinctrl *p, const char *statename,
69 struct pinctrl_dev *pctldev,
70 struct pinctrl_map *map, unsigned num_maps)
73 struct pinctrl_dt_map *dt_map;
75 /* Initialize common mapping table entry fields */
76 for (i = 0; i < num_maps; i++) {
77 map[i].dev_name = dev_name(p->dev);
78 map[i].name = statename;
80 map[i].ctrl_dev_name = dev_name(pctldev->dev);
83 /* Remember the converted mapping table entries */
84 dt_map = kzalloc(sizeof(*dt_map), GFP_KERNEL);
86 dt_free_map(pctldev, map, num_maps);
90 dt_map->pctldev = pctldev;
92 dt_map->num_maps = num_maps;
93 list_add_tail(&dt_map->node, &p->dt_maps);
95 return pinctrl_register_map(map, num_maps, false);
98 struct pinctrl_dev *of_pinctrl_get(struct device_node *np)
100 return get_pinctrl_dev_from_of_node(np);
103 static int dt_to_map_one_config(struct pinctrl *p,
104 struct pinctrl_dev *pctldev,
105 const char *statename,
106 struct device_node *np_config)
108 struct device_node *np_pctldev;
109 const struct pinctrl_ops *ops;
111 struct pinctrl_map *map;
114 /* Find the pin controller containing np_config */
115 np_pctldev = of_node_get(np_config);
117 np_pctldev = of_get_next_parent(np_pctldev);
118 if (!np_pctldev || of_node_is_root(np_pctldev)) {
119 dev_info(p->dev, "could not find pctldev for node %pOF, deferring probe\n",
121 of_node_put(np_pctldev);
122 /* OK let's just assume this will appear later then */
123 return -EPROBE_DEFER;
126 pctldev = get_pinctrl_dev_from_of_node(np_pctldev);
129 /* Do not defer probing of hogs (circular loop) */
130 if (np_pctldev == p->dev->of_node) {
131 of_node_put(np_pctldev);
135 of_node_put(np_pctldev);
138 * Call pinctrl driver to parse device tree node, and
139 * generate mapping table entries
141 ops = pctldev->desc->pctlops;
142 if (!ops->dt_node_to_map) {
143 dev_err(p->dev, "pctldev %s doesn't support DT\n",
144 dev_name(pctldev->dev));
147 ret = ops->dt_node_to_map(pctldev, np_config, &map, &num_maps);
151 /* Stash the mapping table chunk away for later use */
152 return dt_remember_or_free_map(p, statename, pctldev, map, num_maps);
155 static int dt_remember_dummy_state(struct pinctrl *p, const char *statename)
157 struct pinctrl_map *map;
159 map = kzalloc(sizeof(*map), GFP_KERNEL);
163 /* There is no pctldev for PIN_MAP_TYPE_DUMMY_STATE */
164 map->type = PIN_MAP_TYPE_DUMMY_STATE;
166 return dt_remember_or_free_map(p, statename, NULL, map, 1);
169 bool pinctrl_dt_has_hogs(struct pinctrl_dev *pctldev)
171 struct device_node *np;
172 struct property *prop;
175 np = pctldev->dev->of_node;
179 prop = of_find_property(np, "pinctrl-0", &size);
181 return prop ? true : false;
184 int pinctrl_dt_to_map(struct pinctrl *p, struct pinctrl_dev *pctldev)
186 struct device_node *np = p->dev->of_node;
189 struct property *prop;
190 const char *statename;
194 struct device_node *np_config;
196 /* CONFIG_OF enabled, p->dev not instantiated from DT */
198 if (of_have_populated_dt())
200 "no of_node; not parsing pinctrl DT\n");
204 /* We may store pointers to property names within the node */
207 /* For each defined state ID */
208 for (state = 0; ; state++) {
209 /* Retrieve the pinctrl-* property */
210 propname = kasprintf(GFP_KERNEL, "pinctrl-%d", state);
211 prop = of_find_property(np, propname, &size);
221 size /= sizeof(*list);
223 /* Determine whether pinctrl-names property names the state */
224 ret = of_property_read_string_index(np, "pinctrl-names",
227 * If not, statename is just the integer state ID. But rather
228 * than dynamically allocate it and have to free it later,
229 * just point part way into the property name for the string.
232 /* strlen("pinctrl-") == 8 */
233 statename = prop->name + 8;
236 /* For every referenced pin configuration node in it */
237 for (config = 0; config < size; config++) {
238 phandle = be32_to_cpup(list++);
240 /* Look up the pin configuration node */
241 np_config = of_find_node_by_phandle(phandle);
244 "prop %s index %i invalid phandle\n",
251 ret = dt_to_map_one_config(p, pctldev, statename,
253 of_node_put(np_config);
258 /* No entries in DT? Generate a dummy state table entry */
260 ret = dt_remember_dummy_state(p, statename);
269 pinctrl_dt_free_maps(p);
274 * For pinctrl binding, typically #pinctrl-cells is for the pin controller
275 * device, so either parent or grandparent. See pinctrl-bindings.txt.
277 static int pinctrl_find_cells_size(const struct device_node *np)
279 const char *cells_name = "#pinctrl-cells";
280 int cells_size, error;
282 error = of_property_read_u32(np->parent, cells_name, &cells_size);
284 error = of_property_read_u32(np->parent->parent,
285 cells_name, &cells_size);
294 * pinctrl_get_list_and_count - Gets the list and it's cell size and number
295 * @np: pointer to device node with the property
296 * @list_name: property that contains the list
297 * @list: pointer for the list found
298 * @cells_size: pointer for the cell size found
299 * @nr_elements: pointer for the number of elements found
301 * Typically np is a single pinctrl entry containing the list.
303 static int pinctrl_get_list_and_count(const struct device_node *np,
304 const char *list_name,
314 *list = of_get_property(np, list_name, &size);
318 *cells_size = pinctrl_find_cells_size(np);
322 /* First element is always the index within the pinctrl device */
323 *nr_elements = (size / sizeof(**list)) / (*cells_size + 1);
329 * pinctrl_count_index_with_args - Count number of elements in a pinctrl entry
330 * @np: pointer to device node with the property
331 * @list_name: property that contains the list
333 * Counts the number of elements in a pinctrl array consisting of an index
334 * within the controller and a number of u32 entries specified for each
335 * entry. Note that device_node is always for the parent pin controller device.
337 int pinctrl_count_index_with_args(const struct device_node *np,
338 const char *list_name)
341 int size, nr_cells, error;
343 error = pinctrl_get_list_and_count(np, list_name, &list,
350 EXPORT_SYMBOL_GPL(pinctrl_count_index_with_args);
353 * pinctrl_copy_args - Populates of_phandle_args based on index
354 * @np: pointer to device node with the property
355 * @list: pointer to a list with the elements
356 * @index: entry within the list of elements
357 * @nr_cells: number of cells in the list
358 * @nr_elem: number of elements for each entry in the list
359 * @out_args: returned values
361 * Populates the of_phandle_args based on the index in the list.
363 static int pinctrl_copy_args(const struct device_node *np,
365 int index, int nr_cells, int nr_elem,
366 struct of_phandle_args *out_args)
370 memset(out_args, 0, sizeof(*out_args));
371 out_args->np = (struct device_node *)np;
372 out_args->args_count = nr_cells + 1;
374 if (index >= nr_elem)
377 list += index * (nr_cells + 1);
379 for (i = 0; i < nr_cells + 1; i++)
380 out_args->args[i] = be32_to_cpup(list++);
386 * pinctrl_parse_index_with_args - Find a node pointed by index in a list
387 * @np: pointer to device node with the property
388 * @list_name: property that contains the list
389 * @index: index within the list
390 * @out_arts: entries in the list pointed by index
392 * Finds the selected element in a pinctrl array consisting of an index
393 * within the controller and a number of u32 entries specified for each
394 * entry. Note that device_node is always for the parent pin controller device.
396 int pinctrl_parse_index_with_args(const struct device_node *np,
397 const char *list_name, int index,
398 struct of_phandle_args *out_args)
401 int nr_elem, nr_cells, error;
403 error = pinctrl_get_list_and_count(np, list_name, &list,
404 &nr_cells, &nr_elem);
405 if (error || !nr_cells)
408 error = pinctrl_copy_args(np, list, index, nr_cells, nr_elem,
415 EXPORT_SYMBOL_GPL(pinctrl_parse_index_with_args);