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/kref.h>
21 #include <linux/mod_devicetable.h>
22 #include <linux/spinlock.h>
24 #include <asm/byteorder.h>
33 struct property
*next
;
35 unsigned int unique_id
;
38 #if defined(CONFIG_SPARC)
39 struct of_irq_controller
;
48 struct property
*properties
;
49 struct property
*deadprops
; /* removed properties */
50 struct device_node
*parent
;
51 struct device_node
*child
;
52 struct device_node
*sibling
;
53 struct device_node
*next
; /* next device of same type */
54 struct device_node
*allnext
; /* next in list of all nodes */
55 struct proc_dir_entry
*pde
; /* this node's proc directory */
59 #if defined(CONFIG_SPARC)
60 char *path_component_name
;
61 unsigned int unique_id
;
62 struct of_irq_controller
*irq_trans
;
68 /* Pointer for first entry in chain of all nodes. */
69 extern struct device_node
*allnodes
;
70 extern struct device_node
*of_chosen
;
71 extern struct device_node
*of_aliases
;
72 extern rwlock_t devtree_lock
;
74 static inline bool of_have_populated_dt(void)
76 return allnodes
!= NULL
;
79 static inline bool of_node_is_root(const struct device_node
*node
)
81 return node
&& (node
->parent
== NULL
);
84 static inline int of_node_check_flag(struct device_node
*n
, unsigned long flag
)
86 return test_bit(flag
, &n
->_flags
);
89 static inline void of_node_set_flag(struct device_node
*n
, unsigned long flag
)
91 set_bit(flag
, &n
->_flags
);
94 extern struct device_node
*of_find_all_nodes(struct device_node
*prev
);
96 #if defined(CONFIG_SPARC)
97 /* Dummy ref counting routines - to be implemented later */
98 static inline struct device_node
*of_node_get(struct device_node
*node
)
102 static inline void of_node_put(struct device_node
*node
)
107 extern struct device_node
*of_node_get(struct device_node
*node
);
108 extern void of_node_put(struct device_node
*node
);
112 * OF address retrieval & translation
115 /* Helper to read a big number; size is in cells (not bytes) */
116 static inline u64
of_read_number(const __be32
*cell
, int size
)
120 r
= (r
<< 32) | be32_to_cpu(*(cell
++));
124 /* Like of_read_number, but we want an unsigned long result */
125 static inline unsigned long of_read_ulong(const __be32
*cell
, int size
)
127 /* toss away upper bits if unsigned long is smaller than u64 */
128 return of_read_number(cell
, size
);
131 #include <asm/prom.h>
133 /* Default #address and #size cells. Allow arch asm/prom.h to override */
134 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
135 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
136 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
139 /* Default string compare functions, Allow arch asm/prom.h to override */
140 #if !defined(of_compat_cmp)
141 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
142 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
143 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
146 /* flag descriptions */
147 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
148 #define OF_DETACHED 2 /* node has been detached from the device tree */
150 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
151 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
153 #define OF_BAD_ADDR ((u64)-1)
155 #ifndef of_node_to_nid
156 static inline int of_node_to_nid(struct device_node
*np
) { return -1; }
157 #define of_node_to_nid of_node_to_nid
160 extern struct device_node
*of_find_node_by_name(struct device_node
*from
,
162 #define for_each_node_by_name(dn, name) \
163 for (dn = of_find_node_by_name(NULL, name); dn; \
164 dn = of_find_node_by_name(dn, name))
165 extern struct device_node
*of_find_node_by_type(struct device_node
*from
,
167 #define for_each_node_by_type(dn, type) \
168 for (dn = of_find_node_by_type(NULL, type); dn; \
169 dn = of_find_node_by_type(dn, type))
170 extern struct device_node
*of_find_compatible_node(struct device_node
*from
,
171 const char *type
, const char *compat
);
172 #define for_each_compatible_node(dn, type, compatible) \
173 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
174 dn = of_find_compatible_node(dn, type, compatible))
175 extern struct device_node
*of_find_matching_node(struct device_node
*from
,
176 const struct of_device_id
*matches
);
177 #define for_each_matching_node(dn, matches) \
178 for (dn = of_find_matching_node(NULL, matches); dn; \
179 dn = of_find_matching_node(dn, matches))
180 extern struct device_node
*of_find_node_by_path(const char *path
);
181 extern struct device_node
*of_find_node_by_phandle(phandle handle
);
182 extern struct device_node
*of_get_parent(const struct device_node
*node
);
183 extern struct device_node
*of_get_next_parent(struct device_node
*node
);
184 extern struct device_node
*of_get_next_child(const struct device_node
*node
,
185 struct device_node
*prev
);
186 #define for_each_child_of_node(parent, child) \
187 for (child = of_get_next_child(parent, NULL); child != NULL; \
188 child = of_get_next_child(parent, child))
190 extern struct device_node
*of_find_node_with_property(
191 struct device_node
*from
, const char *prop_name
);
192 #define for_each_node_with_property(dn, prop_name) \
193 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
194 dn = of_find_node_with_property(dn, prop_name))
196 extern struct property
*of_find_property(const struct device_node
*np
,
199 extern int of_property_read_u32_array(const struct device_node
*np
,
200 const char *propname
,
203 extern int of_property_read_u64(const struct device_node
*np
,
204 const char *propname
, u64
*out_value
);
206 extern int of_property_read_string(struct device_node
*np
,
207 const char *propname
,
208 const char **out_string
);
209 extern int of_device_is_compatible(const struct device_node
*device
,
211 extern int of_device_is_available(const struct device_node
*device
);
212 extern const void *of_get_property(const struct device_node
*node
,
215 #define for_each_property(pp, properties) \
216 for (pp = properties; pp != NULL; pp = pp->next)
218 extern int of_n_addr_cells(struct device_node
*np
);
219 extern int of_n_size_cells(struct device_node
*np
);
220 extern const struct of_device_id
*of_match_node(
221 const struct of_device_id
*matches
, const struct device_node
*node
);
222 extern int of_modalias_node(struct device_node
*node
, char *modalias
, int len
);
223 extern struct device_node
*of_parse_phandle(struct device_node
*np
,
224 const char *phandle_name
,
226 extern int of_parse_phandles_with_args(struct device_node
*np
,
227 const char *list_name
, const char *cells_name
, int index
,
228 struct device_node
**out_node
, const void **out_args
);
230 extern void of_alias_scan(void * (*dt_alloc
)(u64 size
, u64 align
));
231 extern int of_alias_get_id(struct device_node
*np
, const char *stem
);
233 extern int of_machine_is_compatible(const char *compat
);
235 extern int prom_add_property(struct device_node
* np
, struct property
* prop
);
236 extern int prom_remove_property(struct device_node
*np
, struct property
*prop
);
237 extern int prom_update_property(struct device_node
*np
,
238 struct property
*newprop
,
239 struct property
*oldprop
);
241 #if defined(CONFIG_OF_DYNAMIC)
242 /* For updating the device tree at runtime */
243 extern void of_attach_node(struct device_node
*);
244 extern void of_detach_node(struct device_node
*);
247 #define of_match_ptr(_ptr) (_ptr)
248 #else /* CONFIG_OF */
250 static inline bool of_have_populated_dt(void)
255 #define for_each_child_of_node(parent, child) \
258 static inline struct property
*of_find_property(const struct device_node
*np
,
265 static inline int of_property_read_u32_array(const struct device_node
*np
,
266 const char *propname
,
267 u32
*out_values
, size_t sz
)
272 static inline int of_property_read_string(struct device_node
*np
,
273 const char *propname
,
274 const char **out_string
)
279 static inline const void *of_get_property(const struct device_node
*node
,
286 static inline int of_property_read_u64(const struct device_node
*np
,
287 const char *propname
, u64
*out_value
)
292 #define of_match_ptr(_ptr) NULL
293 #endif /* CONFIG_OF */
295 static inline int of_property_read_u32(const struct device_node
*np
,
296 const char *propname
,
299 return of_property_read_u32_array(np
, propname
, out_value
, 1);
302 #endif /* _LINUX_OF_H */