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_device_is_available - check if a device is available for use
122 * @device: Node to check for availability
124 * Returns 1 if the status property is absent or set to "okay" or "ok",
127 int of_device_is_available(const struct device_node
*device
)
132 status
= of_get_property(device
, "status", &statlen
);
137 if (!strcmp(status
, "okay") || !strcmp(status
, "ok"))
143 EXPORT_SYMBOL(of_device_is_available
);
146 * of_get_parent - Get a node's parent if any
147 * @node: Node to get parent
149 * Returns a node pointer with refcount incremented, use
150 * of_node_put() on it when done.
152 struct device_node
*of_get_parent(const struct device_node
*node
)
154 struct device_node
*np
;
159 read_lock(&devtree_lock
);
160 np
= of_node_get(node
->parent
);
161 read_unlock(&devtree_lock
);
164 EXPORT_SYMBOL(of_get_parent
);
167 * of_get_next_parent - Iterate to a node's parent
168 * @node: Node to get parent of
170 * This is like of_get_parent() except that it drops the
171 * refcount on the passed node, making it suitable for iterating
172 * through a node's parents.
174 * Returns a node pointer with refcount incremented, use
175 * of_node_put() on it when done.
177 struct device_node
*of_get_next_parent(struct device_node
*node
)
179 struct device_node
*parent
;
184 read_lock(&devtree_lock
);
185 parent
= of_node_get(node
->parent
);
187 read_unlock(&devtree_lock
);
192 * of_get_next_child - Iterate a node childs
194 * @prev: previous child of the parent node, or NULL to get first
196 * Returns a node pointer with refcount incremented, use
197 * of_node_put() on it when done.
199 struct device_node
*of_get_next_child(const struct device_node
*node
,
200 struct device_node
*prev
)
202 struct device_node
*next
;
204 read_lock(&devtree_lock
);
205 next
= prev
? prev
->sibling
: node
->child
;
206 for (; next
; next
= next
->sibling
)
207 if (of_node_get(next
))
210 read_unlock(&devtree_lock
);
213 EXPORT_SYMBOL(of_get_next_child
);
216 * of_find_node_by_path - Find a node matching a full OF path
217 * @path: The full path to match
219 * Returns a node pointer with refcount incremented, use
220 * of_node_put() on it when done.
222 struct device_node
*of_find_node_by_path(const char *path
)
224 struct device_node
*np
= allnodes
;
226 read_lock(&devtree_lock
);
227 for (; np
; np
= np
->allnext
) {
228 if (np
->full_name
&& (of_node_cmp(np
->full_name
, path
) == 0)
232 read_unlock(&devtree_lock
);
235 EXPORT_SYMBOL(of_find_node_by_path
);
238 * of_find_node_by_name - Find a node by its "name" property
239 * @from: The node to start searching from or NULL, the node
240 * you pass will not be searched, only the next one
241 * will; typically, you pass what the previous call
242 * returned. of_node_put() will be called on it
243 * @name: The name string to match against
245 * Returns a node pointer with refcount incremented, use
246 * of_node_put() on it when done.
248 struct device_node
*of_find_node_by_name(struct device_node
*from
,
251 struct device_node
*np
;
253 read_lock(&devtree_lock
);
254 np
= from
? from
->allnext
: allnodes
;
255 for (; np
; np
= np
->allnext
)
256 if (np
->name
&& (of_node_cmp(np
->name
, name
) == 0)
260 read_unlock(&devtree_lock
);
263 EXPORT_SYMBOL(of_find_node_by_name
);
266 * of_find_node_by_type - Find a node by its "device_type" property
267 * @from: The node to start searching from, or NULL to start searching
268 * the entire device tree. The node you pass will not be
269 * searched, only the next one will; typically, you pass
270 * what the previous call returned. of_node_put() will be
271 * called on from for you.
272 * @type: The type string to match against
274 * Returns a node pointer with refcount incremented, use
275 * of_node_put() on it when done.
277 struct device_node
*of_find_node_by_type(struct device_node
*from
,
280 struct device_node
*np
;
282 read_lock(&devtree_lock
);
283 np
= from
? from
->allnext
: allnodes
;
284 for (; np
; np
= np
->allnext
)
285 if (np
->type
&& (of_node_cmp(np
->type
, type
) == 0)
289 read_unlock(&devtree_lock
);
292 EXPORT_SYMBOL(of_find_node_by_type
);
295 * of_find_compatible_node - Find a node based on type and one of the
296 * tokens in its "compatible" property
297 * @from: The node to start searching from or NULL, the node
298 * you pass will not be searched, only the next one
299 * will; typically, you pass what the previous call
300 * returned. of_node_put() will be called on it
301 * @type: The type string to match "device_type" or NULL to ignore
302 * @compatible: The string to match to one of the tokens in the device
305 * Returns a node pointer with refcount incremented, use
306 * of_node_put() on it when done.
308 struct device_node
*of_find_compatible_node(struct device_node
*from
,
309 const char *type
, const char *compatible
)
311 struct device_node
*np
;
313 read_lock(&devtree_lock
);
314 np
= from
? from
->allnext
: allnodes
;
315 for (; np
; np
= np
->allnext
) {
317 && !(np
->type
&& (of_node_cmp(np
->type
, type
) == 0)))
319 if (of_device_is_compatible(np
, compatible
) && of_node_get(np
))
323 read_unlock(&devtree_lock
);
326 EXPORT_SYMBOL(of_find_compatible_node
);
329 * of_match_node - Tell if an device_node has a matching of_match structure
330 * @matches: array of of device match structures to search in
331 * @node: the of device structure to match against
333 * Low level utility function used by device matching.
335 const struct of_device_id
*of_match_node(const struct of_device_id
*matches
,
336 const struct device_node
*node
)
338 while (matches
->name
[0] || matches
->type
[0] || matches
->compatible
[0]) {
340 if (matches
->name
[0])
342 && !strcmp(matches
->name
, node
->name
);
343 if (matches
->type
[0])
345 && !strcmp(matches
->type
, node
->type
);
346 if (matches
->compatible
[0])
347 match
&= of_device_is_compatible(node
,
348 matches
->compatible
);
355 EXPORT_SYMBOL(of_match_node
);
358 * of_find_matching_node - Find a node based on an of_device_id match
360 * @from: The node to start searching from or NULL, the node
361 * you pass will not be searched, only the next one
362 * will; typically, you pass what the previous call
363 * returned. of_node_put() will be called on it
364 * @matches: array of of device match structures to search in
366 * Returns a node pointer with refcount incremented, use
367 * of_node_put() on it when done.
369 struct device_node
*of_find_matching_node(struct device_node
*from
,
370 const struct of_device_id
*matches
)
372 struct device_node
*np
;
374 read_lock(&devtree_lock
);
375 np
= from
? from
->allnext
: allnodes
;
376 for (; np
; np
= np
->allnext
) {
377 if (of_match_node(matches
, np
) && of_node_get(np
))
381 read_unlock(&devtree_lock
);
384 EXPORT_SYMBOL(of_find_matching_node
);