4 * Definitions for talking to the Open Firmware PROM on
5 * Power Macintosh and other computers.
7 * Copyright (C) 1996-2005 Paul Mackerras.
9 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
10 * Updates for SPARC64 by David S. Miller
11 * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
18 #include <linux/types.h>
19 #include <linux/bitops.h>
20 #include <linux/errno.h>
21 #include <linux/kref.h>
22 #include <linux/mod_devicetable.h>
23 #include <linux/spinlock.h>
25 #include <asm/byteorder.h>
26 #include <asm/errno.h>
35 struct property
*next
;
37 unsigned int unique_id
;
40 #if defined(CONFIG_SPARC)
41 struct of_irq_controller
;
50 struct property
*properties
;
51 struct property
*deadprops
; /* removed properties */
52 struct device_node
*parent
;
53 struct device_node
*child
;
54 struct device_node
*sibling
;
55 struct device_node
*next
; /* next device of same type */
56 struct device_node
*allnext
; /* next in list of all nodes */
57 struct proc_dir_entry
*pde
; /* this node's proc directory */
61 #if defined(CONFIG_SPARC)
62 char *path_component_name
;
63 unsigned int unique_id
;
64 struct of_irq_controller
*irq_trans
;
68 #define MAX_PHANDLE_ARGS 8
69 struct of_phandle_args
{
70 struct device_node
*np
;
72 uint32_t args
[MAX_PHANDLE_ARGS
];
75 #ifdef CONFIG_OF_DYNAMIC
76 extern struct device_node
*of_node_get(struct device_node
*node
);
77 extern void of_node_put(struct device_node
*node
);
78 #else /* CONFIG_OF_DYNAMIC */
79 /* Dummy ref counting routines - to be implemented later */
80 static inline struct device_node
*of_node_get(struct device_node
*node
)
84 static inline void of_node_put(struct device_node
*node
) { }
85 #endif /* !CONFIG_OF_DYNAMIC */
89 /* Pointer for first entry in chain of all nodes. */
90 extern struct device_node
*allnodes
;
91 extern struct device_node
*of_chosen
;
92 extern struct device_node
*of_aliases
;
93 extern rwlock_t devtree_lock
;
95 static inline bool of_have_populated_dt(void)
97 return allnodes
!= NULL
;
100 static inline bool of_node_is_root(const struct device_node
*node
)
102 return node
&& (node
->parent
== NULL
);
105 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
107 return test_bit(flag
, &n
->_flags
);
110 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
112 set_bit(flag
, &n
->_flags
);
115 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
118 * OF address retrieval & translation
121 /* Helper to read a big number; size is in cells (not bytes) */
122 static inline u64
of_read_number(const __be32
*cell
, int size
)
126 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
130 /* Like of_read_number, but we want an unsigned long result */
131 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
133 /* toss away upper bits if unsigned long is smaller than u64 */
134 return of_read_number(cell
, size
);
137 #include <asm/prom.h>
139 /* Default #address and #size cells. Allow arch asm/prom.h to override */
140 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
141 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
142 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
145 /* Default string compare functions, Allow arch asm/prom.h to override */
146 #if !defined(of_compat_cmp)
147 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
148 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
149 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
152 /* flag descriptions */
153 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
154 #define OF_DETACHED 2 /* node has been detached from the device tree */
156 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
157 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
159 #define OF_BAD_ADDR ((u64)-1)
161 #ifndef of_node_to_nid
162 static inline int of_node_to_nid(struct device_node
*np
) { return -1; }
163 #define of_node_to_nid of_node_to_nid
166 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
168 #define for_each_node_by_name(dn, name) \
169 for (dn = of_find_node_by_name(NULL, name); dn; \
170 dn = of_find_node_by_name(dn, name))
171 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
173 #define for_each_node_by_type(dn, type) \
174 for (dn = of_find_node_by_type(NULL, type); dn; \
175 dn = of_find_node_by_type(dn, type))
176 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
177 const char *type
, const char *compat
);
178 #define for_each_compatible_node(dn, type, compatible) \
179 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
180 dn = of_find_compatible_node(dn, type, compatible))
181 extern struct device_node
*of_find_matching_node(struct device_node
*from
,
182 const struct of_device_id
*matches
);
183 #define for_each_matching_node(dn, matches) \
184 for (dn = of_find_matching_node(NULL, matches); dn; \
185 dn = of_find_matching_node(dn, matches))
186 extern struct device_node
*of_find_node_by_path(const char *path
);
187 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
188 extern struct device_node
*of_get_parent(const struct device_node
*node
);
189 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
190 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
191 struct device_node
*prev
);
192 #define for_each_child_of_node(parent, child) \
193 for (child = of_get_next_child(parent, NULL); child != NULL; \
194 child = of_get_next_child(parent, child))
196 static inline int of_get_child_count(const struct device_node
*np
)
198 struct device_node
*child
;
201 for_each_child_of_node(np
, child
)
207 extern struct device_node
*of_find_node_with_property(
208 struct device_node
*from
, const char *prop_name
);
209 #define for_each_node_with_property(dn, prop_name) \
210 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
211 dn = of_find_node_with_property(dn, prop_name))
213 extern struct property
*of_find_property(const struct device_node
*np
,
216 extern int of_property_read_u32_array(const struct device_node
*np
,
217 const char *propname
,
220 extern int of_property_read_u64(const struct device_node
*np
,
221 const char *propname
, u64
*out_value
);
223 extern int of_property_read_string(struct device_node
*np
,
224 const char *propname
,
225 const char **out_string
);
226 extern int of_property_read_string_index(struct device_node
*np
,
227 const char *propname
,
228 int index
, const char **output
);
229 extern int of_property_match_string(struct device_node
*np
,
230 const char *propname
,
232 extern int of_property_count_strings(struct device_node
*np
,
233 const char *propname
);
234 extern int of_device_is_compatible(const struct device_node
*device
,
236 extern int of_device_is_available(const struct device_node
*device
);
237 extern const void *of_get_property(const struct device_node
*node
,
240 #define for_each_property_of_node(dn, pp) \
241 for (pp = dn->properties; pp != NULL; pp = pp->next)
243 extern int of_n_addr_cells(struct device_node
*np
);
244 extern int of_n_size_cells(struct device_node
*np
);
245 extern const struct of_device_id
*of_match_node(
246 const struct of_device_id
*matches
, const struct device_node
*node
);
247 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
248 extern struct device_node
*of_parse_phandle(struct device_node
*np
,
249 const char *phandle_name
,
251 extern int of_parse_phandle_with_args(struct device_node
*np
,
252 const char *list_name
, const char *cells_name
, int index
,
253 struct of_phandle_args
*out_args
);
255 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
256 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
258 extern int of_machine_is_compatible(const char *compat
);
260 extern int prom_add_property(struct device_node
* np
, struct property
* prop
);
261 extern int prom_remove_property(struct device_node
*np
, struct property
*prop
);
262 extern int prom_update_property(struct device_node
*np
,
263 struct property
*newprop
,
264 struct property
*oldprop
);
266 #if defined(CONFIG_OF_DYNAMIC)
267 /* For updating the device tree at runtime */
268 extern void of_attach_node(struct device_node
*);
269 extern void of_detach_node(struct device_node
*);
272 #define of_match_ptr(_ptr) (_ptr)
275 * struct property *prop;
279 * of_property_for_each_u32(np, "propname", prop, p, u)
280 * printk("U32 value: %x\n", u);
282 const __be32
*of_prop_next_u32(struct property
*prop
, const __be32
*cur
,
284 #define of_property_for_each_u32(np, propname, prop, p, u) \
285 for (prop = of_find_property(np, propname, NULL), \
286 p = of_prop_next_u32(prop, NULL, &u); \
288 p = of_prop_next_u32(prop, p, &u))
291 * struct property *prop;
294 * of_property_for_each_string(np, "propname", prop, s)
295 * printk("String value: %s\n", s);
297 const char *of_prop_next_string(struct property
*prop
, const char *cur
);
298 #define of_property_for_each_string(np, propname, prop, s) \
299 for (prop = of_find_property(np, propname, NULL), \
300 s = of_prop_next_string(prop, NULL); \
302 s = of_prop_next_string(prop, s))
304 #else /* CONFIG_OF */
306 static inline bool of_have_populated_dt(void)
311 #define for_each_child_of_node(parent, child) \
314 static inline int of_get_child_count(const struct device_node
*np
)
319 static inline int of_device_is_compatible(const struct device_node
*device
,
325 static inline struct property
*of_find_property(const struct device_node
*np
,
332 static inline struct device_node
*of_find_compatible_node(
333 struct device_node
*from
,
340 static inline int of_property_read_u32_array(const struct device_node
*np
,
341 const char *propname
,
342 u32
*out_values
, size_t sz
)
347 static inline int of_property_read_string(struct device_node
*np
,
348 const char *propname
,
349 const char **out_string
)
354 static inline int of_property_read_string_index(struct device_node
*np
,
355 const char *propname
, int index
,
356 const char **out_string
)
361 static inline int of_property_count_strings(struct device_node
*np
,
362 const char *propname
)
367 static inline const void *of_get_property(const struct device_node
*node
,
374 static inline int of_property_read_u64(const struct device_node
*np
,
375 const char *propname
, u64
*out_value
)
380 static inline int of_property_match_string(struct device_node
*np
,
381 const char *propname
,
387 static inline struct device_node
*of_parse_phandle(struct device_node
*np
,
388 const char *phandle_name
,
394 static inline int of_parse_phandle_with_args(struct device_node
*np
,
395 const char *list_name
,
396 const char *cells_name
,
398 struct of_phandle_args
*out_args
)
403 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
408 static inline int of_machine_is_compatible(const char *compat
)
413 #define of_match_ptr(_ptr) NULL
414 #define of_match_node(_matches, _node) NULL
415 #define of_property_for_each_u32(np, propname, prop, p, u) \
417 #define of_property_for_each_string(np, propname, prop, s) \
419 #endif /* CONFIG_OF */
422 * of_property_read_bool - Findfrom a property
423 * @np: device node from which the property value is to be read.
424 * @propname: name of the property to be searched.
426 * Search for a property in a device node.
427 * Returns true if the property exist false otherwise.
429 static inline bool of_property_read_bool(const struct device_node
*np
,
430 const char *propname
)
432 struct property
*prop
= of_find_property(np
, propname
, NULL
);
434 return prop
? true : false;
437 static inline int of_property_read_u32(const struct device_node
*np
,
438 const char *propname
,
441 return of_property_read_u32_array(np
, propname
, out_value
, 1);
444 #endif /* _LINUX_OF_H */