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>
24 #include <linux/topology.h>
25 #include <linux/notifier.h>
27 #include <asm/byteorder.h>
28 #include <asm/errno.h>
37 struct property
*next
;
39 unsigned int unique_id
;
42 #if defined(CONFIG_SPARC)
43 struct of_irq_controller
;
50 const char *full_name
;
52 struct property
*properties
;
53 struct property
*deadprops
; /* removed properties */
54 struct device_node
*parent
;
55 struct device_node
*child
;
56 struct device_node
*sibling
;
57 struct device_node
*next
; /* next device of same type */
58 struct device_node
*allnext
; /* next in list of all nodes */
59 struct proc_dir_entry
*pde
; /* this node's proc directory */
63 #if defined(CONFIG_SPARC)
64 const char *path_component_name
;
65 unsigned int unique_id
;
66 struct of_irq_controller
*irq_trans
;
70 #define MAX_PHANDLE_ARGS 8
71 struct of_phandle_args
{
72 struct device_node
*np
;
74 uint32_t args
[MAX_PHANDLE_ARGS
];
77 #ifdef CONFIG_OF_DYNAMIC
78 extern struct device_node
*of_node_get(struct device_node
*node
);
79 extern void of_node_put(struct device_node
*node
);
80 #else /* CONFIG_OF_DYNAMIC */
81 /* Dummy ref counting routines - to be implemented later */
82 static inline struct device_node
*of_node_get(struct device_node
*node
)
86 static inline void of_node_put(struct device_node
*node
) { }
87 #endif /* !CONFIG_OF_DYNAMIC */
91 /* Pointer for first entry in chain of all nodes. */
92 extern struct device_node
*of_allnodes
;
93 extern struct device_node
*of_chosen
;
94 extern struct device_node
*of_aliases
;
95 extern raw_spinlock_t devtree_lock
;
97 static inline bool of_have_populated_dt(void)
99 return of_allnodes
!= NULL
;
102 static inline bool of_node_is_root(const struct device_node
*node
)
104 return node
&& (node
->parent
== NULL
);
107 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
109 return test_bit(flag
, &n
->_flags
);
112 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
114 set_bit(flag
, &n
->_flags
);
117 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
120 * OF address retrieval & translation
123 /* Helper to read a big number; size is in cells (not bytes) */
124 static inline u64
of_read_number(const __be32
*cell
, int size
)
128 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
132 /* Like of_read_number, but we want an unsigned long result */
133 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
135 /* toss away upper bits if unsigned long is smaller than u64 */
136 return of_read_number(cell
, size
);
139 #include <asm/prom.h>
141 /* Default #address and #size cells. Allow arch asm/prom.h to override */
142 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
143 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
144 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
147 /* Default string compare functions, Allow arch asm/prom.h to override */
148 #if !defined(of_compat_cmp)
149 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
150 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
151 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
154 /* flag descriptions */
155 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
156 #define OF_DETACHED 2 /* node has been detached from the device tree */
158 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
159 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
161 #define OF_BAD_ADDR ((u64)-1)
163 static inline const char *of_node_full_name(const struct device_node
*np
)
165 return np
? np
->full_name
: "<no-node>";
168 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
170 #define for_each_node_by_name(dn, name) \
171 for (dn = of_find_node_by_name(NULL, name); dn; \
172 dn = of_find_node_by_name(dn, name))
173 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
175 #define for_each_node_by_type(dn, type) \
176 for (dn = of_find_node_by_type(NULL, type); dn; \
177 dn = of_find_node_by_type(dn, type))
178 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
179 const char *type
, const char *compat
);
180 #define for_each_compatible_node(dn, type, compatible) \
181 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
182 dn = of_find_compatible_node(dn, type, compatible))
183 extern struct device_node
*of_find_matching_node_and_match(
184 struct device_node
*from
,
185 const struct of_device_id
*matches
,
186 const struct of_device_id
**match
);
187 static inline struct device_node
*of_find_matching_node(
188 struct device_node
*from
,
189 const struct of_device_id
*matches
)
191 return of_find_matching_node_and_match(from
, matches
, NULL
);
193 #define for_each_matching_node(dn, matches) \
194 for (dn = of_find_matching_node(NULL, matches); dn; \
195 dn = of_find_matching_node(dn, matches))
196 #define for_each_matching_node_and_match(dn, matches, match) \
197 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
198 dn; dn = of_find_matching_node_and_match(dn, matches, match))
199 extern struct device_node
*of_find_node_by_path(const char *path
);
200 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
201 extern struct device_node
*of_get_parent(const struct device_node
*node
);
202 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
203 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
204 struct device_node
*prev
);
205 extern struct device_node
*of_get_next_available_child(
206 const struct device_node
*node
, struct device_node
*prev
);
208 extern struct device_node
*of_get_child_by_name(const struct device_node
*node
,
210 #define for_each_child_of_node(parent, child) \
211 for (child = of_get_next_child(parent, NULL); child != NULL; \
212 child = of_get_next_child(parent, child))
214 #define for_each_available_child_of_node(parent, child) \
215 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
216 child = of_get_next_available_child(parent, child))
218 static inline int of_get_child_count(const struct device_node
*np
)
220 struct device_node
*child
;
223 for_each_child_of_node(np
, child
)
229 extern struct device_node
*of_find_node_with_property(
230 struct device_node
*from
, const char *prop_name
);
231 #define for_each_node_with_property(dn, prop_name) \
232 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
233 dn = of_find_node_with_property(dn, prop_name))
235 extern struct property
*of_find_property(const struct device_node
*np
,
238 extern int of_property_read_u32_index(const struct device_node
*np
,
239 const char *propname
,
240 u32 index
, u32
*out_value
);
241 extern int of_property_read_u8_array(const struct device_node
*np
,
242 const char *propname
, u8
*out_values
, size_t sz
);
243 extern int of_property_read_u16_array(const struct device_node
*np
,
244 const char *propname
, u16
*out_values
, size_t sz
);
245 extern int of_property_read_u32_array(const struct device_node
*np
,
246 const char *propname
,
249 extern int of_property_read_u64(const struct device_node
*np
,
250 const char *propname
, u64
*out_value
);
252 extern int of_property_read_string(struct device_node
*np
,
253 const char *propname
,
254 const char **out_string
);
255 extern int of_property_read_string_index(struct device_node
*np
,
256 const char *propname
,
257 int index
, const char **output
);
258 extern int of_property_match_string(struct device_node
*np
,
259 const char *propname
,
261 extern int of_property_count_strings(struct device_node
*np
,
262 const char *propname
);
263 extern int of_device_is_compatible(const struct device_node
*device
,
265 extern int of_device_is_available(const struct device_node
*device
);
266 extern const void *of_get_property(const struct device_node
*node
,
269 extern struct device_node
*of_get_cpu_node(int cpu
, unsigned int *thread
);
270 #define for_each_property_of_node(dn, pp) \
271 for (pp = dn->properties; pp != NULL; pp = pp->next)
273 extern int of_n_addr_cells(struct device_node
*np
);
274 extern int of_n_size_cells(struct device_node
*np
);
275 extern const struct of_device_id
*of_match_node(
276 const struct of_device_id
*matches
, const struct device_node
*node
);
277 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
278 extern struct device_node
*of_parse_phandle(const struct device_node
*np
,
279 const char *phandle_name
,
281 extern int of_parse_phandle_with_args(const struct device_node
*np
,
282 const char *list_name
, const char *cells_name
, int index
,
283 struct of_phandle_args
*out_args
);
284 extern int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
285 const char *list_name
, int cells_count
, int index
,
286 struct of_phandle_args
*out_args
);
287 extern int of_count_phandle_with_args(const struct device_node
*np
,
288 const char *list_name
, const char *cells_name
);
290 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
291 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
293 extern int of_machine_is_compatible(const char *compat
);
295 extern int of_add_property(struct device_node
*np
, struct property
*prop
);
296 extern int of_remove_property(struct device_node
*np
, struct property
*prop
);
297 extern int of_update_property(struct device_node
*np
, struct property
*newprop
);
299 /* For updating the device tree at runtime */
300 #define OF_RECONFIG_ATTACH_NODE 0x0001
301 #define OF_RECONFIG_DETACH_NODE 0x0002
302 #define OF_RECONFIG_ADD_PROPERTY 0x0003
303 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
304 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
306 struct of_prop_reconfig
{
307 struct device_node
*dn
;
308 struct property
*prop
;
311 extern int of_reconfig_notifier_register(struct notifier_block
*);
312 extern int of_reconfig_notifier_unregister(struct notifier_block
*);
313 extern int of_reconfig_notify(unsigned long, void *);
315 extern int of_attach_node(struct device_node
*);
316 extern int of_detach_node(struct device_node
*);
318 #define of_match_ptr(_ptr) (_ptr)
321 * struct property *prop;
325 * of_property_for_each_u32(np, "propname", prop, p, u)
326 * printk("U32 value: %x\n", u);
328 const __be32
*of_prop_next_u32(struct property
*prop
, const __be32
*cur
,
331 * struct property *prop;
334 * of_property_for_each_string(np, "propname", prop, s)
335 * printk("String value: %s\n", s);
337 const char *of_prop_next_string(struct property
*prop
, const char *cur
);
339 int of_device_is_stdout_path(struct device_node
*dn
);
341 #else /* CONFIG_OF */
343 static inline const char* of_node_full_name(struct device_node
*np
)
348 static inline struct device_node
*of_find_node_by_name(struct device_node
*from
,
354 static inline struct device_node
*of_get_parent(const struct device_node
*node
)
359 static inline bool of_have_populated_dt(void)
364 #define for_each_child_of_node(parent, child) \
367 static inline struct device_node
*of_get_child_by_name(
368 const struct device_node
*node
,
374 static inline int of_get_child_count(const struct device_node
*np
)
379 static inline int of_device_is_compatible(const struct device_node
*device
,
385 static inline int of_device_is_available(const struct device_node
*device
)
390 static inline struct property
*of_find_property(const struct device_node
*np
,
397 static inline struct device_node
*of_find_compatible_node(
398 struct device_node
*from
,
405 static inline int of_property_read_u32_index(const struct device_node
*np
,
406 const char *propname
, u32 index
, u32
*out_value
)
411 static inline int of_property_read_u8_array(const struct device_node
*np
,
412 const char *propname
, u8
*out_values
, size_t sz
)
417 static inline int of_property_read_u16_array(const struct device_node
*np
,
418 const char *propname
, u16
*out_values
, size_t sz
)
423 static inline int of_property_read_u32_array(const struct device_node
*np
,
424 const char *propname
,
425 u32
*out_values
, size_t sz
)
430 static inline int of_property_read_string(struct device_node
*np
,
431 const char *propname
,
432 const char **out_string
)
437 static inline int of_property_read_string_index(struct device_node
*np
,
438 const char *propname
, int index
,
439 const char **out_string
)
444 static inline int of_property_count_strings(struct device_node
*np
,
445 const char *propname
)
450 static inline const void *of_get_property(const struct device_node
*node
,
457 static inline struct device_node
*of_get_cpu_node(int cpu
,
458 unsigned int *thread
)
463 static inline int of_property_read_u64(const struct device_node
*np
,
464 const char *propname
, u64
*out_value
)
469 static inline int of_property_match_string(struct device_node
*np
,
470 const char *propname
,
476 static inline struct device_node
*of_parse_phandle(const struct device_node
*np
,
477 const char *phandle_name
,
483 static inline int of_parse_phandle_with_args(struct device_node
*np
,
484 const char *list_name
,
485 const char *cells_name
,
487 struct of_phandle_args
*out_args
)
492 static inline int of_parse_phandle_with_fixed_args(const struct device_node
*np
,
493 const char *list_name
, int cells_count
, int index
,
494 struct of_phandle_args
*out_args
)
499 static inline int of_count_phandle_with_args(struct device_node
*np
,
500 const char *list_name
,
501 const char *cells_name
)
506 static inline int of_alias_get_id(struct device_node
*np
, const char *stem
)
511 static inline int of_machine_is_compatible(const char *compat
)
516 static inline int of_device_is_stdout_path(struct device_node
*dn
)
521 static inline const __be32
*of_prop_next_u32(struct property
*prop
,
522 const __be32
*cur
, u32
*pu
)
527 static inline const char *of_prop_next_string(struct property
*prop
,
533 #define of_match_ptr(_ptr) NULL
534 #define of_match_node(_matches, _node) NULL
535 #endif /* CONFIG_OF */
537 #ifndef of_node_to_nid
538 static inline int of_node_to_nid(struct device_node
*np
)
540 return numa_node_id();
543 #define of_node_to_nid of_node_to_nid
547 * of_property_read_bool - Findfrom a property
548 * @np: device node from which the property value is to be read.
549 * @propname: name of the property to be searched.
551 * Search for a property in a device node.
552 * Returns true if the property exist false otherwise.
554 static inline bool of_property_read_bool(const struct device_node
*np
,
555 const char *propname
)
557 struct property
*prop
= of_find_property(np
, propname
, NULL
);
559 return prop
? true : false;
562 static inline int of_property_read_u8(const struct device_node
*np
,
563 const char *propname
,
566 return of_property_read_u8_array(np
, propname
, out_value
, 1);
569 static inline int of_property_read_u16(const struct device_node
*np
,
570 const char *propname
,
573 return of_property_read_u16_array(np
, propname
, out_value
, 1);
576 static inline int of_property_read_u32(const struct device_node
*np
,
577 const char *propname
,
580 return of_property_read_u32_array(np
, propname
, out_value
, 1);
583 #define of_property_for_each_u32(np, propname, prop, p, u) \
584 for (prop = of_find_property(np, propname, NULL), \
585 p = of_prop_next_u32(prop, NULL, &u); \
587 p = of_prop_next_u32(prop, p, &u))
589 #define of_property_for_each_string(np, propname, prop, s) \
590 for (prop = of_find_property(np, propname, NULL), \
591 s = of_prop_next_string(prop, NULL); \
593 s = of_prop_next_string(prop, s))
595 #if defined(CONFIG_PROC_FS) && defined(CONFIG_PROC_DEVICETREE)
596 extern void proc_device_tree_add_node(struct device_node
*, struct proc_dir_entry
*);
597 extern void proc_device_tree_add_prop(struct proc_dir_entry
*pde
, struct property
*prop
);
598 extern void proc_device_tree_remove_prop(struct proc_dir_entry
*pde
,
599 struct property
*prop
);
600 extern void proc_device_tree_update_prop(struct proc_dir_entry
*pde
,
601 struct property
*newprop
,
602 struct property
*oldprop
);
605 #endif /* _LINUX_OF_H */