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 rwlock_t devtree_lock;
73 static inline bool of_have_populated_dt(void)
75 return allnodes != NULL;
78 static inline bool of_node_is_root(const struct device_node *node)
80 return node && (node->parent == NULL);
83 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
85 return test_bit(flag, &n->_flags);
88 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
90 set_bit(flag, &n->_flags);
93 extern struct device_node *of_find_all_nodes(struct device_node *prev);
95 #if defined(CONFIG_SPARC)
96 /* Dummy ref counting routines - to be implemented later */
97 static inline struct device_node *of_node_get(struct device_node *node)
101 static inline void of_node_put(struct device_node *node)
106 extern struct device_node *of_node_get(struct device_node *node);
107 extern void of_node_put(struct device_node *node);
111 * OF address retrieval & translation
114 /* Helper to read a big number; size is in cells (not bytes) */
115 static inline u64 of_read_number(const __be32 *cell, int size)
119 r = (r << 32) | be32_to_cpu(*(cell++));
123 /* Like of_read_number, but we want an unsigned long result */
124 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
126 /* toss away upper bits if unsigned long is smaller than u64 */
127 return of_read_number(cell, size);
130 #include <asm/prom.h>
132 /* Default #address and #size cells. Allow arch asm/prom.h to override */
133 #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
134 #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
135 #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
138 /* Default string compare functions, Allow arch asm/prom.h to override */
139 #if !defined(of_compat_cmp)
140 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
141 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
142 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
145 /* flag descriptions */
146 #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
147 #define OF_DETACHED 2 /* node has been detached from the device tree */
149 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
150 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
152 #define OF_BAD_ADDR ((u64)-1)
154 #ifndef of_node_to_nid
155 static inline int of_node_to_nid(struct device_node *np) { return -1; }
156 #define of_node_to_nid of_node_to_nid
159 extern struct device_node *of_find_node_by_name(struct device_node *from,
161 #define for_each_node_by_name(dn, name) \
162 for (dn = of_find_node_by_name(NULL, name); dn; \
163 dn = of_find_node_by_name(dn, name))
164 extern struct device_node *of_find_node_by_type(struct device_node *from,
166 #define for_each_node_by_type(dn, type) \
167 for (dn = of_find_node_by_type(NULL, type); dn; \
168 dn = of_find_node_by_type(dn, type))
169 extern struct device_node *of_find_compatible_node(struct device_node *from,
170 const char *type, const char *compat);
171 #define for_each_compatible_node(dn, type, compatible) \
172 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
173 dn = of_find_compatible_node(dn, type, compatible))
174 extern struct device_node *of_find_matching_node(struct device_node *from,
175 const struct of_device_id *matches);
176 #define for_each_matching_node(dn, matches) \
177 for (dn = of_find_matching_node(NULL, matches); dn; \
178 dn = of_find_matching_node(dn, matches))
179 extern struct device_node *of_find_node_by_path(const char *path);
180 extern struct device_node *of_find_node_by_phandle(phandle handle);
181 extern struct device_node *of_get_parent(const struct device_node *node);
182 extern struct device_node *of_get_next_parent(struct device_node *node);
183 extern struct device_node *of_get_next_child(const struct device_node *node,
184 struct device_node *prev);
185 #define for_each_child_of_node(parent, child) \
186 for (child = of_get_next_child(parent, NULL); child != NULL; \
187 child = of_get_next_child(parent, child))
189 extern struct device_node *of_find_node_with_property(
190 struct device_node *from, const char *prop_name);
191 #define for_each_node_with_property(dn, prop_name) \
192 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
193 dn = of_find_node_with_property(dn, prop_name))
195 extern struct property *of_find_property(const struct device_node *np,
198 extern int of_property_read_u32_array(const struct device_node *np,
199 const char *propname,
203 extern int of_property_read_string(struct device_node *np,
204 const char *propname,
205 const char **out_string);
206 extern int of_property_read_string_index(struct device_node *np,
207 const char *propname,
208 int index, const char **output);
209 extern int of_property_count_strings(struct device_node *np,
210 const char *propname);
211 extern int of_device_is_compatible(const struct device_node *device,
213 extern int of_device_is_available(const struct device_node *device);
214 extern const void *of_get_property(const struct device_node *node,
217 extern int of_n_addr_cells(struct device_node *np);
218 extern int of_n_size_cells(struct device_node *np);
219 extern const struct of_device_id *of_match_node(
220 const struct of_device_id *matches, const struct device_node *node);
221 extern int of_modalias_node(struct device_node *node, char *modalias, int len);
222 extern struct device_node *of_parse_phandle(struct device_node *np,
223 const char *phandle_name,
225 extern int of_parse_phandles_with_args(struct device_node *np,
226 const char *list_name, const char *cells_name, int index,
227 struct device_node **out_node, const void **out_args);
229 extern int of_machine_is_compatible(const char *compat);
231 extern int prom_add_property(struct device_node* np, struct property* prop);
232 extern int prom_remove_property(struct device_node *np, struct property *prop);
233 extern int prom_update_property(struct device_node *np,
234 struct property *newprop,
235 struct property *oldprop);
237 #if defined(CONFIG_OF_DYNAMIC)
238 /* For updating the device tree at runtime */
239 extern void of_attach_node(struct device_node *);
240 extern void of_detach_node(struct device_node *);
243 #else /* CONFIG_OF */
245 static inline bool of_have_populated_dt(void)
250 static inline int of_property_read_u32_array(const struct device_node *np,
251 const char *propname,
252 u32 *out_values, size_t sz)
257 static inline int of_property_read_string(struct device_node *np,
258 const char *propname,
259 const char **out_string)
264 static inline int of_property_read_string_index(struct device_node *np,
265 const char *propname, int index,
266 const char **out_string)
271 static inline int of_property_count_strings(struct device_node *np,
272 const char *propname)
277 static inline const void *of_get_property(const struct device_node *node,
284 #endif /* CONFIG_OF */
286 static inline int of_property_read_u32(const struct device_node *np,
287 const char *propname,
290 return of_property_read_u32_array(np, propname, out_value, 1);
293 #endif /* _LINUX_OF_H */