Root/
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> |
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> |
26 | |
27 | #include <asm/byteorder.h> |
28 | #include <asm/errno.h> |
29 | |
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 | |
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; |
49 | phandle phandle; |
50 | const 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 | const char *path_component_name; |
65 | unsigned int unique_id; |
66 | struct of_irq_controller *irq_trans; |
67 | #endif |
68 | }; |
69 | |
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 | |
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) |
83 | { |
84 | return node; |
85 | } |
86 | static inline void of_node_put(struct device_node *node) { } |
87 | #endif /* !CONFIG_OF_DYNAMIC */ |
88 | |
89 | #ifdef CONFIG_OF |
90 | |
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; |
96 | |
97 | static inline bool of_have_populated_dt(void) |
98 | { |
99 | return of_allnodes != NULL; |
100 | } |
101 | |
102 | static inline bool of_node_is_root(const struct device_node *node) |
103 | { |
104 | return node && (node->parent == NULL); |
105 | } |
106 | |
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 | |
117 | extern struct device_node *of_find_all_nodes(struct device_node *prev); |
118 | |
119 | /* |
120 | * OF address retrieval & translation |
121 | */ |
122 | |
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) |
125 | { |
126 | u64 r = 0; |
127 | while (size--) |
128 | r = (r << 32) | be32_to_cpu(*(cell++)); |
129 | return r; |
130 | } |
131 | |
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) |
134 | { |
135 | /* toss away upper bits if unsigned long is smaller than u64 */ |
136 | return of_read_number(cell, size); |
137 | } |
138 | |
139 | #include <asm/prom.h> |
140 | |
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) |
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)) |
152 | #endif |
153 | |
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 | |
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 | |
161 | #define OF_BAD_ADDR ((u64)-1) |
162 | |
163 | static inline const char *of_node_full_name(const struct device_node *np) |
164 | { |
165 | return np ? np->full_name : "<no-node>"; |
166 | } |
167 | |
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)) |
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) |
190 | { |
191 | return of_find_matching_node_and_match(from, matches, NULL); |
192 | } |
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); |
207 | |
208 | extern struct device_node *of_get_child_by_name(const struct device_node *node, |
209 | const char *name); |
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)) |
213 | |
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)) |
217 | |
218 | static inline int of_get_child_count(const struct device_node *np) |
219 | { |
220 | struct device_node *child; |
221 | int num = 0; |
222 | |
223 | for_each_child_of_node(np, child) |
224 | num++; |
225 | |
226 | return num; |
227 | } |
228 | |
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)) |
234 | |
235 | extern struct property *of_find_property(const struct device_node *np, |
236 | const char *name, |
237 | int *lenp); |
238 | extern int of_property_read_u8_array(const struct device_node *np, |
239 | const char *propname, u8 *out_values, size_t sz); |
240 | extern int of_property_read_u16_array(const struct device_node *np, |
241 | const char *propname, u16 *out_values, size_t sz); |
242 | extern int of_property_read_u32_array(const struct device_node *np, |
243 | const char *propname, |
244 | u32 *out_values, |
245 | size_t sz); |
246 | extern int of_property_read_u64(const struct device_node *np, |
247 | const char *propname, u64 *out_value); |
248 | |
249 | extern int of_property_read_string(struct device_node *np, |
250 | const char *propname, |
251 | const char **out_string); |
252 | extern int of_property_read_string_index(struct device_node *np, |
253 | const char *propname, |
254 | int index, const char **output); |
255 | extern int of_property_match_string(struct device_node *np, |
256 | const char *propname, |
257 | const char *string); |
258 | extern int of_property_count_strings(struct device_node *np, |
259 | const char *propname); |
260 | extern int of_device_is_compatible(const struct device_node *device, |
261 | const char *); |
262 | extern int of_device_is_available(const struct device_node *device); |
263 | extern const void *of_get_property(const struct device_node *node, |
264 | const char *name, |
265 | int *lenp); |
266 | #define for_each_property_of_node(dn, pp) \ |
267 | for (pp = dn->properties; pp != NULL; pp = pp->next) |
268 | |
269 | extern int of_n_addr_cells(struct device_node *np); |
270 | extern int of_n_size_cells(struct device_node *np); |
271 | extern const struct of_device_id *of_match_node( |
272 | const struct of_device_id *matches, const struct device_node *node); |
273 | extern int of_modalias_node(struct device_node *node, char *modalias, int len); |
274 | extern struct device_node *of_parse_phandle(const struct device_node *np, |
275 | const char *phandle_name, |
276 | int index); |
277 | extern int of_parse_phandle_with_args(const struct device_node *np, |
278 | const char *list_name, const char *cells_name, int index, |
279 | struct of_phandle_args *out_args); |
280 | extern int of_count_phandle_with_args(const struct device_node *np, |
281 | const char *list_name, const char *cells_name); |
282 | |
283 | extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); |
284 | extern int of_alias_get_id(struct device_node *np, const char *stem); |
285 | |
286 | extern int of_machine_is_compatible(const char *compat); |
287 | |
288 | extern int of_add_property(struct device_node *np, struct property *prop); |
289 | extern int of_remove_property(struct device_node *np, struct property *prop); |
290 | extern int of_update_property(struct device_node *np, struct property *newprop); |
291 | |
292 | /* For updating the device tree at runtime */ |
293 | #define OF_RECONFIG_ATTACH_NODE 0x0001 |
294 | #define OF_RECONFIG_DETACH_NODE 0x0002 |
295 | #define OF_RECONFIG_ADD_PROPERTY 0x0003 |
296 | #define OF_RECONFIG_REMOVE_PROPERTY 0x0004 |
297 | #define OF_RECONFIG_UPDATE_PROPERTY 0x0005 |
298 | |
299 | struct of_prop_reconfig { |
300 | struct device_node *dn; |
301 | struct property *prop; |
302 | }; |
303 | |
304 | extern int of_reconfig_notifier_register(struct notifier_block *); |
305 | extern int of_reconfig_notifier_unregister(struct notifier_block *); |
306 | extern int of_reconfig_notify(unsigned long, void *); |
307 | |
308 | extern int of_attach_node(struct device_node *); |
309 | extern int of_detach_node(struct device_node *); |
310 | |
311 | #define of_match_ptr(_ptr) (_ptr) |
312 | |
313 | /* |
314 | * struct property *prop; |
315 | * const __be32 *p; |
316 | * u32 u; |
317 | * |
318 | * of_property_for_each_u32(np, "propname", prop, p, u) |
319 | * printk("U32 value: %x\n", u); |
320 | */ |
321 | const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, |
322 | u32 *pu); |
323 | #define of_property_for_each_u32(np, propname, prop, p, u) \ |
324 | for (prop = of_find_property(np, propname, NULL), \ |
325 | p = of_prop_next_u32(prop, NULL, &u); \ |
326 | p; \ |
327 | p = of_prop_next_u32(prop, p, &u)) |
328 | |
329 | /* |
330 | * struct property *prop; |
331 | * const char *s; |
332 | * |
333 | * of_property_for_each_string(np, "propname", prop, s) |
334 | * printk("String value: %s\n", s); |
335 | */ |
336 | const char *of_prop_next_string(struct property *prop, const char *cur); |
337 | #define of_property_for_each_string(np, propname, prop, s) \ |
338 | for (prop = of_find_property(np, propname, NULL), \ |
339 | s = of_prop_next_string(prop, NULL); \ |
340 | s; \ |
341 | s = of_prop_next_string(prop, s)) |
342 | |
343 | #else /* CONFIG_OF */ |
344 | |
345 | static inline const char* of_node_full_name(struct device_node *np) |
346 | { |
347 | return "<no-node>"; |
348 | } |
349 | |
350 | static inline struct device_node *of_find_node_by_name(struct device_node *from, |
351 | const char *name) |
352 | { |
353 | return NULL; |
354 | } |
355 | |
356 | static inline bool of_have_populated_dt(void) |
357 | { |
358 | return false; |
359 | } |
360 | |
361 | #define for_each_child_of_node(parent, child) \ |
362 | while (0) |
363 | |
364 | static inline struct device_node *of_get_child_by_name( |
365 | const struct device_node *node, |
366 | const char *name) |
367 | { |
368 | return NULL; |
369 | } |
370 | |
371 | static inline int of_get_child_count(const struct device_node *np) |
372 | { |
373 | return 0; |
374 | } |
375 | |
376 | static inline int of_device_is_compatible(const struct device_node *device, |
377 | const char *name) |
378 | { |
379 | return 0; |
380 | } |
381 | |
382 | static inline struct property *of_find_property(const struct device_node *np, |
383 | const char *name, |
384 | int *lenp) |
385 | { |
386 | return NULL; |
387 | } |
388 | |
389 | static inline struct device_node *of_find_compatible_node( |
390 | struct device_node *from, |
391 | const char *type, |
392 | const char *compat) |
393 | { |
394 | return NULL; |
395 | } |
396 | |
397 | static inline int of_property_read_u8_array(const struct device_node *np, |
398 | const char *propname, u8 *out_values, size_t sz) |
399 | { |
400 | return -ENOSYS; |
401 | } |
402 | |
403 | static inline int of_property_read_u16_array(const struct device_node *np, |
404 | const char *propname, u16 *out_values, size_t sz) |
405 | { |
406 | return -ENOSYS; |
407 | } |
408 | |
409 | static inline int of_property_read_u32_array(const struct device_node *np, |
410 | const char *propname, |
411 | u32 *out_values, size_t sz) |
412 | { |
413 | return -ENOSYS; |
414 | } |
415 | |
416 | static inline int of_property_read_string(struct device_node *np, |
417 | const char *propname, |
418 | const char **out_string) |
419 | { |
420 | return -ENOSYS; |
421 | } |
422 | |
423 | static inline int of_property_read_string_index(struct device_node *np, |
424 | const char *propname, int index, |
425 | const char **out_string) |
426 | { |
427 | return -ENOSYS; |
428 | } |
429 | |
430 | static inline int of_property_count_strings(struct device_node *np, |
431 | const char *propname) |
432 | { |
433 | return -ENOSYS; |
434 | } |
435 | |
436 | static inline const void *of_get_property(const struct device_node *node, |
437 | const char *name, |
438 | int *lenp) |
439 | { |
440 | return NULL; |
441 | } |
442 | |
443 | static inline int of_property_read_u64(const struct device_node *np, |
444 | const char *propname, u64 *out_value) |
445 | { |
446 | return -ENOSYS; |
447 | } |
448 | |
449 | static inline int of_property_match_string(struct device_node *np, |
450 | const char *propname, |
451 | const char *string) |
452 | { |
453 | return -ENOSYS; |
454 | } |
455 | |
456 | static inline struct device_node *of_parse_phandle(const struct device_node *np, |
457 | const char *phandle_name, |
458 | int index) |
459 | { |
460 | return NULL; |
461 | } |
462 | |
463 | static inline int of_parse_phandle_with_args(struct device_node *np, |
464 | const char *list_name, |
465 | const char *cells_name, |
466 | int index, |
467 | struct of_phandle_args *out_args) |
468 | { |
469 | return -ENOSYS; |
470 | } |
471 | |
472 | static inline int of_count_phandle_with_args(struct device_node *np, |
473 | const char *list_name, |
474 | const char *cells_name) |
475 | { |
476 | return -ENOSYS; |
477 | } |
478 | |
479 | static inline int of_alias_get_id(struct device_node *np, const char *stem) |
480 | { |
481 | return -ENOSYS; |
482 | } |
483 | |
484 | static inline int of_machine_is_compatible(const char *compat) |
485 | { |
486 | return 0; |
487 | } |
488 | |
489 | #define of_match_ptr(_ptr) NULL |
490 | #define of_match_node(_matches, _node) NULL |
491 | #define of_property_for_each_u32(np, propname, prop, p, u) \ |
492 | while (0) |
493 | #define of_property_for_each_string(np, propname, prop, s) \ |
494 | while (0) |
495 | #endif /* CONFIG_OF */ |
496 | |
497 | #ifndef of_node_to_nid |
498 | static inline int of_node_to_nid(struct device_node *np) |
499 | { |
500 | return numa_node_id(); |
501 | } |
502 | |
503 | #define of_node_to_nid of_node_to_nid |
504 | #endif |
505 | |
506 | /** |
507 | * of_property_read_bool - Findfrom a property |
508 | * @np: device node from which the property value is to be read. |
509 | * @propname: name of the property to be searched. |
510 | * |
511 | * Search for a property in a device node. |
512 | * Returns true if the property exist false otherwise. |
513 | */ |
514 | static inline bool of_property_read_bool(const struct device_node *np, |
515 | const char *propname) |
516 | { |
517 | struct property *prop = of_find_property(np, propname, NULL); |
518 | |
519 | return prop ? true : false; |
520 | } |
521 | |
522 | static inline int of_property_read_u8(const struct device_node *np, |
523 | const char *propname, |
524 | u8 *out_value) |
525 | { |
526 | return of_property_read_u8_array(np, propname, out_value, 1); |
527 | } |
528 | |
529 | static inline int of_property_read_u16(const struct device_node *np, |
530 | const char *propname, |
531 | u16 *out_value) |
532 | { |
533 | return of_property_read_u16_array(np, propname, out_value, 1); |
534 | } |
535 | |
536 | static inline int of_property_read_u32(const struct device_node *np, |
537 | const char *propname, |
538 | u32 *out_value) |
539 | { |
540 | return of_property_read_u32_array(np, propname, out_value, 1); |
541 | } |
542 | |
543 | #endif /* _LINUX_OF_H */ |
544 |
Branches:
ben-wpan
ben-wpan-stefan
javiroman/ks7010
jz-2.6.34
jz-2.6.34-rc5
jz-2.6.34-rc6
jz-2.6.34-rc7
jz-2.6.35
jz-2.6.36
jz-2.6.37
jz-2.6.38
jz-2.6.39
jz-3.0
jz-3.1
jz-3.11
jz-3.12
jz-3.13
jz-3.15
jz-3.16
jz-3.18-dt
jz-3.2
jz-3.3
jz-3.4
jz-3.5
jz-3.6
jz-3.6-rc2-pwm
jz-3.9
jz-3.9-clk
jz-3.9-rc8
jz47xx
jz47xx-2.6.38
master
Tags:
od-2011-09-04
od-2011-09-18
v2.6.34-rc5
v2.6.34-rc6
v2.6.34-rc7
v3.9