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];
77 /* Pointer for first entry in chain of all nodes. */
78 extern struct device_node *allnodes;
79 extern struct device_node *of_chosen;
80 extern struct device_node *of_aliases;
81 extern rwlock_t devtree_lock;
83 static inline bool of_have_populated_dt(void)
85 return allnodes != NULL;
88 static inline bool of_node_is_root(const struct device_node *node)
90 return node && (node->parent == NULL);
93 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
95 return test_bit(flag, &n->_flags);
98 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
100 set_bit(flag, &n->_flags);
103 extern struct device_node *of_find_all_nodes(struct device_node *prev);
105 #if defined(CONFIG_SPARC)
106 /* Dummy ref counting routines - to be implemented later */
107 static inline struct device_node *of_node_get(struct device_node *node)
111 static inline void of_node_put(struct device_node *node)
116 extern struct device_node *of_node_get(struct device_node *node);
117 extern void of_node_put(struct device_node *node);
121 * OF address retrieval & translation
124 /* Helper to read a big number; size is in cells (not bytes) */
125 static inline u64 of_read_number(const __be32 *cell, int size)
129 r = (r << 32) | be32_to_cpu(*(cell++));
133 /* Like of_read_number, but we want an unsigned long result */
134 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
136 /* toss away upper bits if unsigned long is smaller than u64 */
137 return of_read_number(cell, size);
140 #include <asm/prom.h>
142 /* Default #address and #size cells. Allow arch asm/prom.h to override */
143 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
144 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
145 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
148 /* Default string compare functions, Allow arch asm/prom.h to override */
149 #if !defined(of_compat_cmp)
150 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
151 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
152 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
155 /* flag descriptions */
156 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
157 #define OF_DETACHED 2 /* node has been detached from the device tree */
159 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
160 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
162 #define OF_BAD_ADDR ((u64)-1)
164 #ifndef of_node_to_nid
165 static inline int of_node_to_nid(struct device_node *np) { return -1; }
166 #define of_node_to_nid of_node_to_nid
169 extern struct device_node *of_find_node_by_name(struct device_node *from,
171 #define for_each_node_by_name(dn, name) \
172 for (dn = of_find_node_by_name(NULL, name); dn; \
173 dn = of_find_node_by_name(dn, name))
174 extern struct device_node *of_find_node_by_type(struct device_node *from,
176 #define for_each_node_by_type(dn, type) \
177 for (dn = of_find_node_by_type(NULL, type); dn; \
178 dn = of_find_node_by_type(dn, type))
179 extern struct device_node *of_find_compatible_node(struct device_node *from,
180 const char *type, const char *compat);
181 #define for_each_compatible_node(dn, type, compatible) \
182 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
183 dn = of_find_compatible_node(dn, type, compatible))
184 extern struct device_node *of_find_matching_node(struct device_node *from,
185 const struct of_device_id *matches);
186 #define for_each_matching_node(dn, matches) \
187 for (dn = of_find_matching_node(NULL, matches); dn; \
188 dn = of_find_matching_node(dn, matches))
189 extern struct device_node *of_find_node_by_path(const char *path);
190 extern struct device_node *of_find_node_by_phandle(phandle handle);
191 extern struct device_node *of_get_parent(const struct device_node *node);
192 extern struct device_node *of_get_next_parent(struct device_node *node);
193 extern struct device_node *of_get_next_child(const struct device_node *node,
194 struct device_node *prev);
195 #define for_each_child_of_node(parent, child) \
196 for (child = of_get_next_child(parent, NULL); child != NULL; \
197 child = of_get_next_child(parent, child))
199 extern struct device_node *of_find_node_with_property(
200 struct device_node *from, const char *prop_name);
201 #define for_each_node_with_property(dn, prop_name) \
202 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
203 dn = of_find_node_with_property(dn, prop_name))
205 extern struct property *of_find_property(const struct device_node *np,
208 extern int of_property_read_u32_array(const struct device_node *np,
209 const char *propname,
212 extern int of_property_read_u64(const struct device_node *np,
213 const char *propname, u64 *out_value);
215 extern int of_property_read_string(struct device_node *np,
216 const char *propname,
217 const char **out_string);
218 extern int of_property_read_string_index(struct device_node *np,
219 const char *propname,
220 int index, const char **output);
221 extern int of_property_count_strings(struct device_node *np,
222 const char *propname);
223 extern int of_device_is_compatible(const struct device_node *device,
225 extern int of_device_is_available(const struct device_node *device);
226 extern const void *of_get_property(const struct device_node *node,
229 #define for_each_property(pp, properties) \
230 for (pp = properties; pp != NULL; pp = pp->next)
232 extern int of_n_addr_cells(struct device_node *np);
233 extern int of_n_size_cells(struct device_node *np);
234 extern const struct of_device_id *of_match_node(
235 const struct of_device_id *matches, const struct device_node *node);
236 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
237 extern struct device_node *of_parse_phandle(struct device_node *np,
238 const char *phandle_name,
240 extern int of_parse_phandle_with_args(struct device_node *np,
241 const char *list_name, const char *cells_name, int index,
242 struct of_phandle_args *out_args);
244 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
245 extern int of_alias_get_id(struct device_node *np, const char *stem);
247 extern int of_machine_is_compatible(const char *compat);
249 extern int prom_add_property(struct device_node* np, struct property* prop);
250 extern int prom_remove_property(struct device_node *np, struct property *prop);
251 extern int prom_update_property(struct device_node *np,
252 struct property *newprop,
253 struct property *oldprop);
255 #if defined(CONFIG_OF_DYNAMIC)
256 /* For updating the device tree at runtime */
257 extern void of_attach_node(struct device_node *);
258 extern void of_detach_node(struct device_node *);
261 #define of_match_ptr(_ptr) (_ptr)
262 #else /* CONFIG_OF */
264 static inline bool of_have_populated_dt(void)
269 #define for_each_child_of_node(parent, child) \
272 static inline int of_device_is_compatible(const struct device_node *device,
278 static inline struct property *of_find_property(const struct device_node *np,
285 static inline int of_property_read_u32_array(const struct device_node *np,
286 const char *propname,
287 u32 *out_values, size_t sz)
292 static inline int of_property_read_string(struct device_node *np,
293 const char *propname,
294 const char **out_string)
299 static inline int of_property_read_string_index(struct device_node *np,
300 const char *propname, int index,
301 const char **out_string)
306 static inline int of_property_count_strings(struct device_node *np,
307 const char *propname)
312 static inline const void *of_get_property(const struct device_node *node,
319 static inline int of_property_read_u64(const struct device_node *np,
320 const char *propname, u64 *out_value)
325 static inline struct device_node *of_parse_phandle(struct device_node *np,
326 const char *phandle_name,
332 static inline int of_alias_get_id(struct device_node *np, const char *stem)
337 static inline int of_machine_is_compatible(const char *compat)
342 #define of_match_ptr(_ptr) NULL
343 #define of_match_node(_matches, _node) NULL
344 #endif /* CONFIG_OF */
346 static inline int of_property_read_u32(const struct device_node *np,
347 const char *propname,
350 return of_property_read_u32_array(np, propname, out_value, 1);
353 #endif /* _LINUX_OF_H */