2 * Procedures for creating, accessing and interpreting the device tree.
4 * Paul Mackerras August 1996.
5 * Copyright (C) 1996-2005 Paul Mackerras.
7 * Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
8 * {engebret|bergner}@us.ibm.com
10 * Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net
12 * Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell.
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version
17 * 2 of the License, or (at your option) any later version.
19 #include <linux/module.h>
21 #include <linux/spinlock.h>
23 struct device_node *allnodes;
25 /* use when traversing tree through the allnext, child, sibling,
26 * or parent members of struct device_node.
28 DEFINE_RWLOCK(devtree_lock);
30 int of_n_addr_cells(struct device_node *np)
37 ip = of_get_property(np, "#address-cells", NULL);
41 /* No #address-cells property for the root node */
42 return OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
44 EXPORT_SYMBOL(of_n_addr_cells);
46 int of_n_size_cells(struct device_node *np)
53 ip = of_get_property(np, "#size-cells", NULL);
57 /* No #size-cells property for the root node */
58 return OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
60 EXPORT_SYMBOL(of_n_size_cells);
62 struct property *of_find_property(const struct device_node *np,
68 read_lock(&devtree_lock);
69 for (pp = np->properties; pp != 0; pp = pp->next) {
70 if (of_prop_cmp(pp->name, name) == 0) {
76 read_unlock(&devtree_lock);
80 EXPORT_SYMBOL(of_find_property);
83 * Find a property with a given name for a given node
84 * and return the value.
86 const void *of_get_property(const struct device_node *np, const char *name,
89 struct property *pp = of_find_property(np, name, lenp);
91 return pp ? pp->value : NULL;
93 EXPORT_SYMBOL(of_get_property);
95 /** Checks if the given "compat" string matches one of the strings in
96 * the device's "compatible" property
98 int of_device_is_compatible(const struct device_node *device,
104 cp = of_get_property(device, "compatible", &cplen);
108 if (of_compat_cmp(cp, compat, strlen(compat)) == 0)
117 EXPORT_SYMBOL(of_device_is_compatible);
120 * of_get_parent - Get a node's parent if any
121 * @node: Node to get parent
123 * Returns a node pointer with refcount incremented, use
124 * of_node_put() on it when done.
126 struct device_node *of_get_parent(const struct device_node *node)
128 struct device_node *np;
133 read_lock(&devtree_lock);
134 np = of_node_get(node->parent);
135 read_unlock(&devtree_lock);
138 EXPORT_SYMBOL(of_get_parent);
141 * of_get_next_child - Iterate a node childs
143 * @prev: previous child of the parent node, or NULL to get first
145 * Returns a node pointer with refcount incremented, use
146 * of_node_put() on it when done.
148 struct device_node *of_get_next_child(const struct device_node *node,
149 struct device_node *prev)
151 struct device_node *next;
153 read_lock(&devtree_lock);
154 next = prev ? prev->sibling : node->child;
155 for (; next; next = next->sibling)
156 if (of_node_get(next))
159 read_unlock(&devtree_lock);
162 EXPORT_SYMBOL(of_get_next_child);
165 * of_find_node_by_path - Find a node matching a full OF path
166 * @path: The full path to match
168 * Returns a node pointer with refcount incremented, use
169 * of_node_put() on it when done.
171 struct device_node *of_find_node_by_path(const char *path)
173 struct device_node *np = allnodes;
175 read_lock(&devtree_lock);
176 for (; np; np = np->allnext) {
177 if (np->full_name && (of_node_cmp(np->full_name, path) == 0)
181 read_unlock(&devtree_lock);
184 EXPORT_SYMBOL(of_find_node_by_path);
187 * of_find_node_by_name - Find a node by its "name" property
188 * @from: The node to start searching from or NULL, the node
189 * you pass will not be searched, only the next one
190 * will; typically, you pass what the previous call
191 * returned. of_node_put() will be called on it
192 * @name: The name string to match against
194 * Returns a node pointer with refcount incremented, use
195 * of_node_put() on it when done.
197 struct device_node *of_find_node_by_name(struct device_node *from,
200 struct device_node *np;
202 read_lock(&devtree_lock);
203 np = from ? from->allnext : allnodes;
204 for (; np; np = np->allnext)
205 if (np->name && (of_node_cmp(np->name, name) == 0)
209 read_unlock(&devtree_lock);
212 EXPORT_SYMBOL(of_find_node_by_name);
215 * of_find_node_by_type - Find a node by its "device_type" property
216 * @from: The node to start searching from, or NULL to start searching
217 * the entire device tree. The node you pass will not be
218 * searched, only the next one will; typically, you pass
219 * what the previous call returned. of_node_put() will be
220 * called on from for you.
221 * @type: The type string to match against
223 * Returns a node pointer with refcount incremented, use
224 * of_node_put() on it when done.
226 struct device_node *of_find_node_by_type(struct device_node *from,
229 struct device_node *np;
231 read_lock(&devtree_lock);
232 np = from ? from->allnext : allnodes;
233 for (; np; np = np->allnext)
234 if (np->type && (of_node_cmp(np->type, type) == 0)
238 read_unlock(&devtree_lock);
241 EXPORT_SYMBOL(of_find_node_by_type);
244 * of_find_compatible_node - Find a node based on type and one of the
245 * tokens in its "compatible" property
246 * @from: The node to start searching from or NULL, the node
247 * you pass will not be searched, only the next one
248 * will; typically, you pass what the previous call
249 * returned. of_node_put() will be called on it
250 * @type: The type string to match "device_type" or NULL to ignore
251 * @compatible: The string to match to one of the tokens in the device
254 * Returns a node pointer with refcount incremented, use
255 * of_node_put() on it when done.
257 struct device_node *of_find_compatible_node(struct device_node *from,
258 const char *type, const char *compatible)
260 struct device_node *np;
262 read_lock(&devtree_lock);
263 np = from ? from->allnext : allnodes;
264 for (; np; np = np->allnext) {
266 && !(np->type && (of_node_cmp(np->type, type) == 0)))
268 if (of_device_is_compatible(np, compatible) && of_node_get(np))
272 read_unlock(&devtree_lock);
275 EXPORT_SYMBOL(of_find_compatible_node);
278 * of_match_node - Tell if an device_node has a matching of_match structure
279 * @matches: array of of device match structures to search in
280 * @node: the of device structure to match against
282 * Low level utility function used by device matching.
284 const struct of_device_id *of_match_node(const struct of_device_id *matches,
285 const struct device_node *node)
287 while (matches->name[0] || matches->type[0] || matches->compatible[0]) {
289 if (matches->name[0])
291 && !strcmp(matches->name, node->name);
292 if (matches->type[0])
294 && !strcmp(matches->type, node->type);
295 if (matches->compatible[0])
296 match &= of_device_is_compatible(node,
297 matches->compatible);
304 EXPORT_SYMBOL(of_match_node);
307 * of_find_matching_node - Find a node based on an of_device_id match
309 * @from: The node to start searching from or NULL, the node
310 * you pass will not be searched, only the next one
311 * will; typically, you pass what the previous call
312 * returned. of_node_put() will be called on it
313 * @matches: array of of device match structures to search in
315 * Returns a node pointer with refcount incremented, use
316 * of_node_put() on it when done.
318 struct device_node *of_find_matching_node(struct device_node *from,
319 const struct of_device_id *matches)
321 struct device_node *np;
323 read_lock(&devtree_lock);
324 np = from ? from->allnext : allnodes;
325 for (; np; np = np->allnext) {
326 if (of_match_node(matches, np) && of_node_get(np))
330 read_unlock(&devtree_lock);
333 EXPORT_SYMBOL(of_find_matching_node);