]>
Commit | Line | Data |
---|---|---|
76c1ce78 SR |
1 | #ifndef _LINUX_OF_H |
2 | #define _LINUX_OF_H | |
3 | /* | |
4 | * Definitions for talking to the Open Firmware PROM on | |
5 | * Power Macintosh and other computers. | |
6 | * | |
7 | * Copyright (C) 1996-2005 Paul Mackerras. | |
8 | * | |
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. | |
12 | * | |
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. | |
17 | */ | |
18 | #include <linux/types.h> | |
1977f032 | 19 | #include <linux/bitops.h> |
e51130c0 | 20 | #include <linux/errno.h> |
6f192492 | 21 | #include <linux/kref.h> |
283029d1 | 22 | #include <linux/mod_devicetable.h> |
0d351c3e | 23 | #include <linux/spinlock.h> |
5ca4db61 | 24 | #include <linux/topology.h> |
1cf3d8b3 | 25 | #include <linux/notifier.h> |
76c1ce78 | 26 | |
2e89e685 | 27 | #include <asm/byteorder.h> |
d0a99402 | 28 | #include <asm/errno.h> |
2e89e685 | 29 | |
731581e6 GL |
30 | typedef u32 phandle; |
31 | typedef u32 ihandle; | |
32 | ||
33 | struct property { | |
34 | char *name; | |
35 | int length; | |
36 | void *value; | |
37 | struct property *next; | |
38 | unsigned long _flags; | |
39 | unsigned int unique_id; | |
40 | }; | |
41 | ||
6f192492 GL |
42 | #if defined(CONFIG_SPARC) |
43 | struct of_irq_controller; | |
44 | #endif | |
45 | ||
46 | struct device_node { | |
47 | const char *name; | |
48 | const char *type; | |
6016a363 | 49 | phandle phandle; |
6f192492 GL |
50 | char *full_name; |
51 | ||
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 */ | |
60 | struct kref kref; | |
61 | unsigned long _flags; | |
62 | void *data; | |
63 | #if defined(CONFIG_SPARC) | |
64 | char *path_component_name; | |
65 | unsigned int unique_id; | |
66 | struct of_irq_controller *irq_trans; | |
67 | #endif | |
68 | }; | |
69 | ||
15c9a0ac GL |
70 | #define MAX_PHANDLE_ARGS 8 |
71 | struct of_phandle_args { | |
72 | struct device_node *np; | |
73 | int args_count; | |
74 | uint32_t args[MAX_PHANDLE_ARGS]; | |
75 | }; | |
76 | ||
0f22dd39 GL |
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 */ | |
3ecdd051 RH |
81 | /* Dummy ref counting routines - to be implemented later */ |
82 | static inline struct device_node *of_node_get(struct device_node *node) | |
83 | { | |
84 | return node; | |
85 | } | |
0f22dd39 GL |
86 | static inline void of_node_put(struct device_node *node) { } |
87 | #endif /* !CONFIG_OF_DYNAMIC */ | |
3ecdd051 | 88 | |
c9e358df GL |
89 | #ifdef CONFIG_OF |
90 | ||
41f88009 GL |
91 | /* Pointer for first entry in chain of all nodes. */ |
92 | extern struct device_node *allnodes; | |
fc0bdae4 | 93 | extern struct device_node *of_chosen; |
611cad72 | 94 | extern struct device_node *of_aliases; |
0d351c3e | 95 | extern rwlock_t devtree_lock; |
41f88009 | 96 | |
3bcbaf6e SAS |
97 | static inline bool of_have_populated_dt(void) |
98 | { | |
99 | return allnodes != NULL; | |
100 | } | |
101 | ||
035ebefc AS |
102 | static inline bool of_node_is_root(const struct device_node *node) |
103 | { | |
104 | return node && (node->parent == NULL); | |
105 | } | |
106 | ||
50436312 GL |
107 | static inline int of_node_check_flag(struct device_node *n, unsigned long flag) |
108 | { | |
109 | return test_bit(flag, &n->_flags); | |
110 | } | |
111 | ||
112 | static inline void of_node_set_flag(struct device_node *n, unsigned long flag) | |
113 | { | |
114 | set_bit(flag, &n->_flags); | |
115 | } | |
116 | ||
e91edcf5 GL |
117 | extern struct device_node *of_find_all_nodes(struct device_node *prev); |
118 | ||
b6caf2ad | 119 | /* |
3d6b8828 | 120 | * OF address retrieval & translation |
b6caf2ad GL |
121 | */ |
122 | ||
123 | /* Helper to read a big number; size is in cells (not bytes) */ | |
2e89e685 | 124 | static inline u64 of_read_number(const __be32 *cell, int size) |
b6caf2ad GL |
125 | { |
126 | u64 r = 0; | |
127 | while (size--) | |
2e89e685 | 128 | r = (r << 32) | be32_to_cpu(*(cell++)); |
b6caf2ad GL |
129 | return r; |
130 | } | |
131 | ||
132 | /* Like of_read_number, but we want an unsigned long result */ | |
2e89e685 | 133 | static inline unsigned long of_read_ulong(const __be32 *cell, int size) |
b6caf2ad | 134 | { |
2be09cb9 GL |
135 | /* toss away upper bits if unsigned long is smaller than u64 */ |
136 | return of_read_number(cell, size); | |
b6caf2ad | 137 | } |
b6caf2ad | 138 | |
76c1ce78 SR |
139 | #include <asm/prom.h> |
140 | ||
7c7b60cb GL |
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 | |
145 | #endif | |
146 | ||
147 | /* Default string compare functions, Allow arch asm/prom.h to override */ | |
148 | #if !defined(of_compat_cmp) | |
1976152f | 149 | #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2)) |
7c7b60cb GL |
150 | #define of_prop_cmp(s1, s2) strcmp((s1), (s2)) |
151 | #define of_node_cmp(s1, s2) strcasecmp((s1), (s2)) | |
152 | #endif | |
153 | ||
76c1ce78 SR |
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 */ | |
157 | ||
61e955db GL |
158 | #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags) |
159 | #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags) | |
160 | ||
76c1ce78 SR |
161 | #define OF_BAD_ADDR ((u64)-1) |
162 | ||
74a7f084 GL |
163 | static inline const char* of_node_full_name(struct device_node *np) |
164 | { | |
165 | return np ? np->full_name : "<no-node>"; | |
166 | } | |
167 | ||
76c1ce78 SR |
168 | extern struct device_node *of_find_node_by_name(struct device_node *from, |
169 | const char *name); | |
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, | |
174 | const char *type); | |
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)) | |
283029d1 GL |
183 | extern struct device_node *of_find_matching_node(struct device_node *from, |
184 | const struct of_device_id *matches); | |
185 | #define for_each_matching_node(dn, matches) \ | |
186 | for (dn = of_find_matching_node(NULL, matches); dn; \ | |
187 | dn = of_find_matching_node(dn, matches)) | |
76c1ce78 SR |
188 | extern struct device_node *of_find_node_by_path(const char *path); |
189 | extern struct device_node *of_find_node_by_phandle(phandle handle); | |
190 | extern struct device_node *of_get_parent(const struct device_node *node); | |
f4eb0107 | 191 | extern struct device_node *of_get_next_parent(struct device_node *node); |
76c1ce78 SR |
192 | extern struct device_node *of_get_next_child(const struct device_node *node, |
193 | struct device_node *prev); | |
3296193d TT |
194 | extern struct device_node *of_get_next_available_child( |
195 | const struct device_node *node, struct device_node *prev); | |
196 | ||
9c19761a SK |
197 | extern struct device_node *of_get_child_by_name(const struct device_node *node, |
198 | const char *name); | |
aabc08dc ME |
199 | #define for_each_child_of_node(parent, child) \ |
200 | for (child = of_get_next_child(parent, NULL); child != NULL; \ | |
201 | child = of_get_next_child(parent, child)) | |
202 | ||
3296193d TT |
203 | #define for_each_available_child_of_node(parent, child) \ |
204 | for (child = of_get_next_available_child(parent, NULL); child != NULL; \ | |
205 | child = of_get_next_available_child(parent, child)) | |
206 | ||
183f1d0c DA |
207 | static inline int of_get_child_count(const struct device_node *np) |
208 | { | |
209 | struct device_node *child; | |
210 | int num = 0; | |
211 | ||
212 | for_each_child_of_node(np, child) | |
213 | num++; | |
214 | ||
215 | return num; | |
216 | } | |
217 | ||
1e291b14 ME |
218 | extern struct device_node *of_find_node_with_property( |
219 | struct device_node *from, const char *prop_name); | |
220 | #define for_each_node_with_property(dn, prop_name) \ | |
221 | for (dn = of_find_node_with_property(NULL, prop_name); dn; \ | |
222 | dn = of_find_node_with_property(dn, prop_name)) | |
223 | ||
76c1ce78 SR |
224 | extern struct property *of_find_property(const struct device_node *np, |
225 | const char *name, | |
226 | int *lenp); | |
0e373639 | 227 | extern int of_property_read_u32_array(const struct device_node *np, |
aac285c6 | 228 | const char *propname, |
0e373639 RH |
229 | u32 *out_values, |
230 | size_t sz); | |
4cd7f7a3 JI |
231 | extern int of_property_read_u64(const struct device_node *np, |
232 | const char *propname, u64 *out_value); | |
0e373639 | 233 | |
aac285c6 JI |
234 | extern int of_property_read_string(struct device_node *np, |
235 | const char *propname, | |
236 | const char **out_string); | |
4fcd15a0 BC |
237 | extern int of_property_read_string_index(struct device_node *np, |
238 | const char *propname, | |
239 | int index, const char **output); | |
7aff0fe3 GL |
240 | extern int of_property_match_string(struct device_node *np, |
241 | const char *propname, | |
242 | const char *string); | |
4fcd15a0 BC |
243 | extern int of_property_count_strings(struct device_node *np, |
244 | const char *propname); | |
76c1ce78 SR |
245 | extern int of_device_is_compatible(const struct device_node *device, |
246 | const char *); | |
834d97d4 | 247 | extern int of_device_is_available(const struct device_node *device); |
76c1ce78 SR |
248 | extern const void *of_get_property(const struct device_node *node, |
249 | const char *name, | |
250 | int *lenp); | |
8af0da93 DA |
251 | #define for_each_property_of_node(dn, pp) \ |
252 | for (pp = dn->properties; pp != NULL; pp = pp->next) | |
611cad72 | 253 | |
76c1ce78 SR |
254 | extern int of_n_addr_cells(struct device_node *np); |
255 | extern int of_n_size_cells(struct device_node *np); | |
283029d1 GL |
256 | extern const struct of_device_id *of_match_node( |
257 | const struct of_device_id *matches, const struct device_node *node); | |
3f07af49 | 258 | extern int of_modalias_node(struct device_node *node, char *modalias, int len); |
739649c5 GL |
259 | extern struct device_node *of_parse_phandle(struct device_node *np, |
260 | const char *phandle_name, | |
261 | int index); | |
15c9a0ac | 262 | extern int of_parse_phandle_with_args(struct device_node *np, |
64b60e09 | 263 | const char *list_name, const char *cells_name, int index, |
15c9a0ac | 264 | struct of_phandle_args *out_args); |
76c1ce78 | 265 | |
611cad72 SG |
266 | extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); |
267 | extern int of_alias_get_id(struct device_node *np, const char *stem); | |
268 | ||
21b082ec GL |
269 | extern int of_machine_is_compatible(const char *compat); |
270 | ||
271 | extern int prom_add_property(struct device_node* np, struct property* prop); | |
272 | extern int prom_remove_property(struct device_node *np, struct property *prop); | |
273 | extern int prom_update_property(struct device_node *np, | |
475d0094 | 274 | struct property *newprop); |
21b082ec | 275 | |
fcdeb7fe | 276 | /* For updating the device tree at runtime */ |
1cf3d8b3 NF |
277 | #define OF_RECONFIG_ATTACH_NODE 0x0001 |
278 | #define OF_RECONFIG_DETACH_NODE 0x0002 | |
279 | #define OF_RECONFIG_ADD_PROPERTY 0x0003 | |
280 | #define OF_RECONFIG_REMOVE_PROPERTY 0x0004 | |
281 | #define OF_RECONFIG_UPDATE_PROPERTY 0x0005 | |
282 | ||
283 | struct of_prop_reconfig { | |
284 | struct device_node *dn; | |
285 | struct property *prop; | |
286 | }; | |
287 | ||
288 | extern int of_reconfig_notifier_register(struct notifier_block *); | |
289 | extern int of_reconfig_notifier_unregister(struct notifier_block *); | |
290 | extern int of_reconfig_notify(unsigned long, void *); | |
291 | ||
292 | extern int of_attach_node(struct device_node *); | |
293 | extern int of_detach_node(struct device_node *); | |
fcdeb7fe | 294 | |
3a1e362e | 295 | #define of_match_ptr(_ptr) (_ptr) |
c541adc6 SW |
296 | |
297 | /* | |
298 | * struct property *prop; | |
299 | * const __be32 *p; | |
300 | * u32 u; | |
301 | * | |
302 | * of_property_for_each_u32(np, "propname", prop, p, u) | |
303 | * printk("U32 value: %x\n", u); | |
304 | */ | |
305 | const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, | |
306 | u32 *pu); | |
307 | #define of_property_for_each_u32(np, propname, prop, p, u) \ | |
308 | for (prop = of_find_property(np, propname, NULL), \ | |
309 | p = of_prop_next_u32(prop, NULL, &u); \ | |
310 | p; \ | |
311 | p = of_prop_next_u32(prop, p, &u)) | |
312 | ||
313 | /* | |
314 | * struct property *prop; | |
315 | * const char *s; | |
316 | * | |
317 | * of_property_for_each_string(np, "propname", prop, s) | |
318 | * printk("String value: %s\n", s); | |
319 | */ | |
320 | const char *of_prop_next_string(struct property *prop, const char *cur); | |
321 | #define of_property_for_each_string(np, propname, prop, s) \ | |
322 | for (prop = of_find_property(np, propname, NULL), \ | |
323 | s = of_prop_next_string(prop, NULL); \ | |
324 | s; \ | |
325 | s = of_prop_next_string(prop, s)) | |
326 | ||
b98c0239 | 327 | #else /* CONFIG_OF */ |
3bcbaf6e | 328 | |
74a7f084 GL |
329 | static inline const char* of_node_full_name(struct device_node *np) |
330 | { | |
331 | return "<no-node>"; | |
332 | } | |
333 | ||
1cc44f43 PU |
334 | static inline struct device_node *of_find_node_by_name(struct device_node *from, |
335 | const char *name) | |
336 | { | |
337 | return NULL; | |
338 | } | |
339 | ||
3bcbaf6e SAS |
340 | static inline bool of_have_populated_dt(void) |
341 | { | |
342 | return false; | |
343 | } | |
344 | ||
aba3dfff SW |
345 | #define for_each_child_of_node(parent, child) \ |
346 | while (0) | |
347 | ||
183f1d0c DA |
348 | static inline int of_get_child_count(const struct device_node *np) |
349 | { | |
350 | return 0; | |
351 | } | |
352 | ||
36a0904e RN |
353 | static inline int of_device_is_compatible(const struct device_node *device, |
354 | const char *name) | |
355 | { | |
356 | return 0; | |
357 | } | |
358 | ||
aba3dfff SW |
359 | static inline struct property *of_find_property(const struct device_node *np, |
360 | const char *name, | |
361 | int *lenp) | |
362 | { | |
363 | return NULL; | |
364 | } | |
365 | ||
2261cc62 SG |
366 | static inline struct device_node *of_find_compatible_node( |
367 | struct device_node *from, | |
368 | const char *type, | |
369 | const char *compat) | |
370 | { | |
371 | return NULL; | |
372 | } | |
373 | ||
b98c0239 | 374 | static inline int of_property_read_u32_array(const struct device_node *np, |
aac285c6 JI |
375 | const char *propname, |
376 | u32 *out_values, size_t sz) | |
b98c0239 SG |
377 | { |
378 | return -ENOSYS; | |
379 | } | |
380 | ||
381 | static inline int of_property_read_string(struct device_node *np, | |
aac285c6 JI |
382 | const char *propname, |
383 | const char **out_string) | |
b98c0239 SG |
384 | { |
385 | return -ENOSYS; | |
386 | } | |
387 | ||
4fcd15a0 BC |
388 | static inline int of_property_read_string_index(struct device_node *np, |
389 | const char *propname, int index, | |
390 | const char **out_string) | |
391 | { | |
392 | return -ENOSYS; | |
393 | } | |
394 | ||
395 | static inline int of_property_count_strings(struct device_node *np, | |
396 | const char *propname) | |
397 | { | |
398 | return -ENOSYS; | |
399 | } | |
400 | ||
89272b8c SW |
401 | static inline const void *of_get_property(const struct device_node *node, |
402 | const char *name, | |
403 | int *lenp) | |
404 | { | |
405 | return NULL; | |
406 | } | |
407 | ||
4cd7f7a3 JI |
408 | static inline int of_property_read_u64(const struct device_node *np, |
409 | const char *propname, u64 *out_value) | |
410 | { | |
411 | return -ENOSYS; | |
412 | } | |
413 | ||
bd3d5500 TR |
414 | static inline int of_property_match_string(struct device_node *np, |
415 | const char *propname, | |
416 | const char *string) | |
417 | { | |
418 | return -ENOSYS; | |
419 | } | |
420 | ||
36a0904e RN |
421 | static inline struct device_node *of_parse_phandle(struct device_node *np, |
422 | const char *phandle_name, | |
423 | int index) | |
424 | { | |
425 | return NULL; | |
426 | } | |
427 | ||
e05e5070 TR |
428 | static inline int of_parse_phandle_with_args(struct device_node *np, |
429 | const char *list_name, | |
430 | const char *cells_name, | |
431 | int index, | |
432 | struct of_phandle_args *out_args) | |
433 | { | |
434 | return -ENOSYS; | |
435 | } | |
436 | ||
ed5f886d NF |
437 | static inline int of_alias_get_id(struct device_node *np, const char *stem) |
438 | { | |
439 | return -ENOSYS; | |
440 | } | |
441 | ||
50e07f88 SW |
442 | static inline int of_machine_is_compatible(const char *compat) |
443 | { | |
444 | return 0; | |
445 | } | |
446 | ||
3a1e362e | 447 | #define of_match_ptr(_ptr) NULL |
5762c205 | 448 | #define of_match_node(_matches, _node) NULL |
c541adc6 SW |
449 | #define of_property_for_each_u32(np, propname, prop, p, u) \ |
450 | while (0) | |
451 | #define of_property_for_each_string(np, propname, prop, s) \ | |
452 | while (0) | |
9dfbf207 | 453 | #endif /* CONFIG_OF */ |
b98c0239 | 454 | |
5ca4db61 PM |
455 | #ifndef of_node_to_nid |
456 | static inline int of_node_to_nid(struct device_node *np) | |
457 | { | |
458 | return numa_node_id(); | |
459 | } | |
460 | ||
461 | #define of_node_to_nid of_node_to_nid | |
462 | #endif | |
463 | ||
fa4d34cc JCPV |
464 | /** |
465 | * of_property_read_bool - Findfrom a property | |
466 | * @np: device node from which the property value is to be read. | |
467 | * @propname: name of the property to be searched. | |
468 | * | |
469 | * Search for a property in a device node. | |
470 | * Returns true if the property exist false otherwise. | |
471 | */ | |
472 | static inline bool of_property_read_bool(const struct device_node *np, | |
473 | const char *propname) | |
474 | { | |
475 | struct property *prop = of_find_property(np, propname, NULL); | |
476 | ||
477 | return prop ? true : false; | |
478 | } | |
479 | ||
b98c0239 | 480 | static inline int of_property_read_u32(const struct device_node *np, |
aac285c6 | 481 | const char *propname, |
b98c0239 SG |
482 | u32 *out_value) |
483 | { | |
484 | return of_property_read_u32_array(np, propname, out_value, 1); | |
485 | } | |
486 | ||
76c1ce78 | 487 | #endif /* _LINUX_OF_H */ |