]>
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> |
75b57ecf | 21 | #include <linux/kobject.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; | |
75b57ecf | 40 | struct bin_attribute attr; |
731581e6 GL |
41 | }; |
42 | ||
6f192492 GL |
43 | #if defined(CONFIG_SPARC) |
44 | struct of_irq_controller; | |
45 | #endif | |
46 | ||
47 | struct device_node { | |
48 | const char *name; | |
49 | const char *type; | |
6016a363 | 50 | phandle phandle; |
c22618a1 | 51 | const char *full_name; |
6f192492 GL |
52 | |
53 | struct property *properties; | |
54 | struct property *deadprops; /* removed properties */ | |
55 | struct device_node *parent; | |
56 | struct device_node *child; | |
57 | struct device_node *sibling; | |
58 | struct device_node *next; /* next device of same type */ | |
75b57ecf | 59 | struct kobject kobj; |
6f192492 GL |
60 | unsigned long _flags; |
61 | void *data; | |
62 | #if defined(CONFIG_SPARC) | |
c22618a1 | 63 | const char *path_component_name; |
6f192492 GL |
64 | unsigned int unique_id; |
65 | struct of_irq_controller *irq_trans; | |
66 | #endif | |
67 | }; | |
68 | ||
b66548e2 | 69 | #define MAX_PHANDLE_ARGS 16 |
15c9a0ac GL |
70 | struct of_phandle_args { |
71 | struct device_node *np; | |
72 | int args_count; | |
73 | uint32_t args[MAX_PHANDLE_ARGS]; | |
74 | }; | |
75 | ||
0829f6d1 PA |
76 | /* initialize a node */ |
77 | extern struct kobj_type of_node_ktype; | |
78 | static inline void of_node_init(struct device_node *node) | |
79 | { | |
80 | kobject_init(&node->kobj, &of_node_ktype); | |
81 | } | |
82 | ||
83 | /* true when node is initialized */ | |
84 | static inline int of_node_is_initialized(struct device_node *node) | |
85 | { | |
86 | return node && node->kobj.state_initialized; | |
87 | } | |
88 | ||
89 | /* true when node is attached (i.e. present on sysfs) */ | |
90 | static inline int of_node_is_attached(struct device_node *node) | |
91 | { | |
92 | return node && node->kobj.state_in_sysfs; | |
93 | } | |
94 | ||
0f22dd39 GL |
95 | #ifdef CONFIG_OF_DYNAMIC |
96 | extern struct device_node *of_node_get(struct device_node *node); | |
97 | extern void of_node_put(struct device_node *node); | |
98 | #else /* CONFIG_OF_DYNAMIC */ | |
3ecdd051 RH |
99 | /* Dummy ref counting routines - to be implemented later */ |
100 | static inline struct device_node *of_node_get(struct device_node *node) | |
101 | { | |
102 | return node; | |
103 | } | |
0f22dd39 GL |
104 | static inline void of_node_put(struct device_node *node) { } |
105 | #endif /* !CONFIG_OF_DYNAMIC */ | |
3ecdd051 | 106 | |
c9e358df GL |
107 | #ifdef CONFIG_OF |
108 | ||
41f88009 | 109 | /* Pointer for first entry in chain of all nodes. */ |
5063e25a | 110 | extern struct device_node *of_root; |
fc0bdae4 | 111 | extern struct device_node *of_chosen; |
611cad72 | 112 | extern struct device_node *of_aliases; |
a752ee56 | 113 | extern struct device_node *of_stdout; |
d6d3c4e6 | 114 | extern raw_spinlock_t devtree_lock; |
41f88009 | 115 | |
3bcbaf6e SAS |
116 | static inline bool of_have_populated_dt(void) |
117 | { | |
5063e25a | 118 | return of_root != NULL; |
3bcbaf6e SAS |
119 | } |
120 | ||
035ebefc AS |
121 | static inline bool of_node_is_root(const struct device_node *node) |
122 | { | |
123 | return node && (node->parent == NULL); | |
124 | } | |
125 | ||
50436312 GL |
126 | static inline int of_node_check_flag(struct device_node *n, unsigned long flag) |
127 | { | |
128 | return test_bit(flag, &n->_flags); | |
129 | } | |
130 | ||
c6e126de PM |
131 | static inline int of_node_test_and_set_flag(struct device_node *n, |
132 | unsigned long flag) | |
133 | { | |
134 | return test_and_set_bit(flag, &n->_flags); | |
135 | } | |
136 | ||
50436312 GL |
137 | static inline void of_node_set_flag(struct device_node *n, unsigned long flag) |
138 | { | |
139 | set_bit(flag, &n->_flags); | |
140 | } | |
141 | ||
588453c6 PA |
142 | static inline void of_node_clear_flag(struct device_node *n, unsigned long flag) |
143 | { | |
144 | clear_bit(flag, &n->_flags); | |
145 | } | |
146 | ||
147 | static inline int of_property_check_flag(struct property *p, unsigned long flag) | |
148 | { | |
149 | return test_bit(flag, &p->_flags); | |
150 | } | |
151 | ||
152 | static inline void of_property_set_flag(struct property *p, unsigned long flag) | |
153 | { | |
154 | set_bit(flag, &p->_flags); | |
155 | } | |
156 | ||
157 | static inline void of_property_clear_flag(struct property *p, unsigned long flag) | |
158 | { | |
159 | clear_bit(flag, &p->_flags); | |
160 | } | |
161 | ||
5063e25a | 162 | extern struct device_node *__of_find_all_nodes(struct device_node *prev); |
e91edcf5 GL |
163 | extern struct device_node *of_find_all_nodes(struct device_node *prev); |
164 | ||
b6caf2ad | 165 | /* |
3d6b8828 | 166 | * OF address retrieval & translation |
b6caf2ad GL |
167 | */ |
168 | ||
169 | /* Helper to read a big number; size is in cells (not bytes) */ | |
2e89e685 | 170 | static inline u64 of_read_number(const __be32 *cell, int size) |
b6caf2ad GL |
171 | { |
172 | u64 r = 0; | |
173 | while (size--) | |
2e89e685 | 174 | r = (r << 32) | be32_to_cpu(*(cell++)); |
b6caf2ad GL |
175 | return r; |
176 | } | |
177 | ||
178 | /* Like of_read_number, but we want an unsigned long result */ | |
2e89e685 | 179 | static inline unsigned long of_read_ulong(const __be32 *cell, int size) |
b6caf2ad | 180 | { |
2be09cb9 GL |
181 | /* toss away upper bits if unsigned long is smaller than u64 */ |
182 | return of_read_number(cell, size); | |
b6caf2ad | 183 | } |
b6caf2ad | 184 | |
b5b4bb3f | 185 | #if defined(CONFIG_SPARC) |
76c1ce78 | 186 | #include <asm/prom.h> |
b5b4bb3f | 187 | #endif |
76c1ce78 | 188 | |
7c7b60cb GL |
189 | /* Default #address and #size cells. Allow arch asm/prom.h to override */ |
190 | #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT) | |
191 | #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1 | |
192 | #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1 | |
193 | #endif | |
194 | ||
195 | /* Default string compare functions, Allow arch asm/prom.h to override */ | |
196 | #if !defined(of_compat_cmp) | |
1976152f | 197 | #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2)) |
7c7b60cb GL |
198 | #define of_prop_cmp(s1, s2) strcmp((s1), (s2)) |
199 | #define of_node_cmp(s1, s2) strcasecmp((s1), (s2)) | |
200 | #endif | |
201 | ||
76c1ce78 SR |
202 | /* flag descriptions */ |
203 | #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */ | |
204 | #define OF_DETACHED 2 /* node has been detached from the device tree */ | |
c6e126de | 205 | #define OF_POPULATED 3 /* device already created for the node */ |
75f353b6 | 206 | #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */ |
76c1ce78 | 207 | |
61e955db GL |
208 | #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags) |
209 | #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags) | |
210 | ||
76c1ce78 SR |
211 | #define OF_BAD_ADDR ((u64)-1) |
212 | ||
c0a05bf0 | 213 | static inline const char *of_node_full_name(const struct device_node *np) |
74a7f084 GL |
214 | { |
215 | return np ? np->full_name : "<no-node>"; | |
216 | } | |
217 | ||
5063e25a GL |
218 | #define for_each_of_allnodes_from(from, dn) \ |
219 | for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn)) | |
220 | #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn) | |
76c1ce78 SR |
221 | extern struct device_node *of_find_node_by_name(struct device_node *from, |
222 | const char *name); | |
76c1ce78 SR |
223 | extern struct device_node *of_find_node_by_type(struct device_node *from, |
224 | const char *type); | |
76c1ce78 SR |
225 | extern struct device_node *of_find_compatible_node(struct device_node *from, |
226 | const char *type, const char *compat); | |
50c8af4c SW |
227 | extern struct device_node *of_find_matching_node_and_match( |
228 | struct device_node *from, | |
229 | const struct of_device_id *matches, | |
230 | const struct of_device_id **match); | |
662372e4 | 231 | |
76c1ce78 SR |
232 | extern struct device_node *of_find_node_by_path(const char *path); |
233 | extern struct device_node *of_find_node_by_phandle(phandle handle); | |
234 | extern struct device_node *of_get_parent(const struct device_node *node); | |
f4eb0107 | 235 | extern struct device_node *of_get_next_parent(struct device_node *node); |
76c1ce78 SR |
236 | extern struct device_node *of_get_next_child(const struct device_node *node, |
237 | struct device_node *prev); | |
3296193d TT |
238 | extern struct device_node *of_get_next_available_child( |
239 | const struct device_node *node, struct device_node *prev); | |
240 | ||
9c19761a SK |
241 | extern struct device_node *of_get_child_by_name(const struct device_node *node, |
242 | const char *name); | |
954e04b9 | 243 | |
a3e31b45 SH |
244 | /* cache lookup */ |
245 | extern struct device_node *of_find_next_cache_node(const struct device_node *); | |
1e291b14 ME |
246 | extern struct device_node *of_find_node_with_property( |
247 | struct device_node *from, const char *prop_name); | |
1e291b14 | 248 | |
76c1ce78 SR |
249 | extern struct property *of_find_property(const struct device_node *np, |
250 | const char *name, | |
251 | int *lenp); | |
ad54a0cf HS |
252 | extern int of_property_count_elems_of_size(const struct device_node *np, |
253 | const char *propname, int elem_size); | |
3daf3726 TP |
254 | extern int of_property_read_u32_index(const struct device_node *np, |
255 | const char *propname, | |
256 | u32 index, u32 *out_value); | |
be193249 VK |
257 | extern int of_property_read_u8_array(const struct device_node *np, |
258 | const char *propname, u8 *out_values, size_t sz); | |
259 | extern int of_property_read_u16_array(const struct device_node *np, | |
260 | const char *propname, u16 *out_values, size_t sz); | |
0e373639 | 261 | extern int of_property_read_u32_array(const struct device_node *np, |
aac285c6 | 262 | const char *propname, |
0e373639 RH |
263 | u32 *out_values, |
264 | size_t sz); | |
4cd7f7a3 JI |
265 | extern int of_property_read_u64(const struct device_node *np, |
266 | const char *propname, u64 *out_value); | |
0e373639 | 267 | |
aac285c6 JI |
268 | extern int of_property_read_string(struct device_node *np, |
269 | const char *propname, | |
270 | const char **out_string); | |
7aff0fe3 GL |
271 | extern int of_property_match_string(struct device_node *np, |
272 | const char *propname, | |
273 | const char *string); | |
a87fa1d8 GL |
274 | extern int of_property_read_string_helper(struct device_node *np, |
275 | const char *propname, | |
276 | const char **out_strs, size_t sz, int index); | |
76c1ce78 SR |
277 | extern int of_device_is_compatible(const struct device_node *device, |
278 | const char *); | |
53a4ab96 | 279 | extern bool of_device_is_available(const struct device_node *device); |
76c1ce78 SR |
280 | extern const void *of_get_property(const struct device_node *node, |
281 | const char *name, | |
282 | int *lenp); | |
183912d3 | 283 | extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread); |
8af0da93 DA |
284 | #define for_each_property_of_node(dn, pp) \ |
285 | for (pp = dn->properties; pp != NULL; pp = pp->next) | |
611cad72 | 286 | |
76c1ce78 SR |
287 | extern int of_n_addr_cells(struct device_node *np); |
288 | extern int of_n_size_cells(struct device_node *np); | |
283029d1 GL |
289 | extern const struct of_device_id *of_match_node( |
290 | const struct of_device_id *matches, const struct device_node *node); | |
3f07af49 | 291 | extern int of_modalias_node(struct device_node *node, char *modalias, int len); |
624cfca5 | 292 | extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args); |
b8fbdc42 | 293 | extern struct device_node *of_parse_phandle(const struct device_node *np, |
739649c5 GL |
294 | const char *phandle_name, |
295 | int index); | |
93c667ca | 296 | extern int of_parse_phandle_with_args(const struct device_node *np, |
64b60e09 | 297 | const char *list_name, const char *cells_name, int index, |
15c9a0ac | 298 | struct of_phandle_args *out_args); |
035fd948 SW |
299 | extern int of_parse_phandle_with_fixed_args(const struct device_node *np, |
300 | const char *list_name, int cells_count, int index, | |
301 | struct of_phandle_args *out_args); | |
bd69f73f GL |
302 | extern int of_count_phandle_with_args(const struct device_node *np, |
303 | const char *list_name, const char *cells_name); | |
76c1ce78 | 304 | |
611cad72 SG |
305 | extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); |
306 | extern int of_alias_get_id(struct device_node *np, const char *stem); | |
307 | ||
21b082ec GL |
308 | extern int of_machine_is_compatible(const char *compat); |
309 | ||
79d1c712 NF |
310 | extern int of_add_property(struct device_node *np, struct property *prop); |
311 | extern int of_remove_property(struct device_node *np, struct property *prop); | |
312 | extern int of_update_property(struct device_node *np, struct property *newprop); | |
21b082ec | 313 | |
fcdeb7fe | 314 | /* For updating the device tree at runtime */ |
1cf3d8b3 NF |
315 | #define OF_RECONFIG_ATTACH_NODE 0x0001 |
316 | #define OF_RECONFIG_DETACH_NODE 0x0002 | |
317 | #define OF_RECONFIG_ADD_PROPERTY 0x0003 | |
318 | #define OF_RECONFIG_REMOVE_PROPERTY 0x0004 | |
319 | #define OF_RECONFIG_UPDATE_PROPERTY 0x0005 | |
320 | ||
321 | struct of_prop_reconfig { | |
322 | struct device_node *dn; | |
323 | struct property *prop; | |
259092a3 | 324 | struct property *old_prop; |
1cf3d8b3 NF |
325 | }; |
326 | ||
1cf3d8b3 NF |
327 | extern int of_attach_node(struct device_node *); |
328 | extern int of_detach_node(struct device_node *); | |
fcdeb7fe | 329 | |
3a1e362e | 330 | #define of_match_ptr(_ptr) (_ptr) |
c541adc6 SW |
331 | |
332 | /* | |
333 | * struct property *prop; | |
334 | * const __be32 *p; | |
335 | * u32 u; | |
336 | * | |
337 | * of_property_for_each_u32(np, "propname", prop, p, u) | |
338 | * printk("U32 value: %x\n", u); | |
339 | */ | |
340 | const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, | |
341 | u32 *pu); | |
c541adc6 SW |
342 | /* |
343 | * struct property *prop; | |
344 | * const char *s; | |
345 | * | |
346 | * of_property_for_each_string(np, "propname", prop, s) | |
347 | * printk("String value: %s\n", s); | |
348 | */ | |
349 | const char *of_prop_next_string(struct property *prop, const char *cur); | |
c541adc6 | 350 | |
3482f2c5 | 351 | bool of_console_check(struct device_node *dn, char *name, int index); |
5c19e952 | 352 | |
b98c0239 | 353 | #else /* CONFIG_OF */ |
3bcbaf6e | 354 | |
4c358e15 | 355 | static inline const char* of_node_full_name(const struct device_node *np) |
74a7f084 GL |
356 | { |
357 | return "<no-node>"; | |
358 | } | |
359 | ||
1cc44f43 PU |
360 | static inline struct device_node *of_find_node_by_name(struct device_node *from, |
361 | const char *name) | |
362 | { | |
363 | return NULL; | |
364 | } | |
365 | ||
662372e4 RH |
366 | static inline struct device_node *of_find_node_by_type(struct device_node *from, |
367 | const char *type) | |
066ec1dd AS |
368 | { |
369 | return NULL; | |
370 | } | |
371 | ||
662372e4 RH |
372 | static inline struct device_node *of_find_matching_node_and_match( |
373 | struct device_node *from, | |
374 | const struct of_device_id *matches, | |
375 | const struct of_device_id **match) | |
3bcbaf6e | 376 | { |
662372e4 | 377 | return NULL; |
3bcbaf6e SAS |
378 | } |
379 | ||
20cd477c AS |
380 | static inline struct device_node *of_find_node_by_path(const char *path) |
381 | { | |
382 | return NULL; | |
383 | } | |
384 | ||
662372e4 | 385 | static inline struct device_node *of_get_parent(const struct device_node *node) |
00b2c76a | 386 | { |
662372e4 | 387 | return NULL; |
00b2c76a DH |
388 | } |
389 | ||
662372e4 RH |
390 | static inline struct device_node *of_get_next_child( |
391 | const struct device_node *node, struct device_node *prev) | |
392 | { | |
393 | return NULL; | |
394 | } | |
aba3dfff | 395 | |
662372e4 RH |
396 | static inline struct device_node *of_get_next_available_child( |
397 | const struct device_node *node, struct device_node *prev) | |
398 | { | |
399 | return NULL; | |
400 | } | |
f6f0747e | 401 | |
662372e4 RH |
402 | static inline struct device_node *of_find_node_with_property( |
403 | struct device_node *from, const char *prop_name) | |
25c040c9 OJ |
404 | { |
405 | return NULL; | |
406 | } | |
407 | ||
662372e4 | 408 | static inline bool of_have_populated_dt(void) |
183f1d0c | 409 | { |
662372e4 | 410 | return false; |
183f1d0c DA |
411 | } |
412 | ||
662372e4 RH |
413 | static inline struct device_node *of_get_child_by_name( |
414 | const struct device_node *node, | |
415 | const char *name) | |
954e04b9 | 416 | { |
662372e4 | 417 | return NULL; |
954e04b9 BW |
418 | } |
419 | ||
36a0904e RN |
420 | static inline int of_device_is_compatible(const struct device_node *device, |
421 | const char *name) | |
422 | { | |
423 | return 0; | |
424 | } | |
425 | ||
53a4ab96 | 426 | static inline bool of_device_is_available(const struct device_node *device) |
d7195696 | 427 | { |
53a4ab96 | 428 | return false; |
d7195696 RH |
429 | } |
430 | ||
aba3dfff SW |
431 | static inline struct property *of_find_property(const struct device_node *np, |
432 | const char *name, | |
433 | int *lenp) | |
434 | { | |
435 | return NULL; | |
436 | } | |
437 | ||
2261cc62 SG |
438 | static inline struct device_node *of_find_compatible_node( |
439 | struct device_node *from, | |
440 | const char *type, | |
441 | const char *compat) | |
442 | { | |
443 | return NULL; | |
444 | } | |
445 | ||
ad54a0cf HS |
446 | static inline int of_property_count_elems_of_size(const struct device_node *np, |
447 | const char *propname, int elem_size) | |
448 | { | |
449 | return -ENOSYS; | |
450 | } | |
451 | ||
3daf3726 TP |
452 | static inline int of_property_read_u32_index(const struct device_node *np, |
453 | const char *propname, u32 index, u32 *out_value) | |
454 | { | |
455 | return -ENOSYS; | |
456 | } | |
457 | ||
be193249 VK |
458 | static inline int of_property_read_u8_array(const struct device_node *np, |
459 | const char *propname, u8 *out_values, size_t sz) | |
460 | { | |
461 | return -ENOSYS; | |
462 | } | |
463 | ||
464 | static inline int of_property_read_u16_array(const struct device_node *np, | |
465 | const char *propname, u16 *out_values, size_t sz) | |
466 | { | |
467 | return -ENOSYS; | |
468 | } | |
469 | ||
b98c0239 | 470 | static inline int of_property_read_u32_array(const struct device_node *np, |
aac285c6 JI |
471 | const char *propname, |
472 | u32 *out_values, size_t sz) | |
b98c0239 SG |
473 | { |
474 | return -ENOSYS; | |
475 | } | |
476 | ||
477 | static inline int of_property_read_string(struct device_node *np, | |
aac285c6 JI |
478 | const char *propname, |
479 | const char **out_string) | |
b98c0239 SG |
480 | { |
481 | return -ENOSYS; | |
482 | } | |
483 | ||
a87fa1d8 GL |
484 | static inline int of_property_read_string_helper(struct device_node *np, |
485 | const char *propname, | |
486 | const char **out_strs, size_t sz, int index) | |
4fcd15a0 BC |
487 | { |
488 | return -ENOSYS; | |
489 | } | |
490 | ||
89272b8c SW |
491 | static inline const void *of_get_property(const struct device_node *node, |
492 | const char *name, | |
493 | int *lenp) | |
494 | { | |
495 | return NULL; | |
496 | } | |
497 | ||
183912d3 SH |
498 | static inline struct device_node *of_get_cpu_node(int cpu, |
499 | unsigned int *thread) | |
500 | { | |
501 | return NULL; | |
502 | } | |
503 | ||
4cd7f7a3 JI |
504 | static inline int of_property_read_u64(const struct device_node *np, |
505 | const char *propname, u64 *out_value) | |
506 | { | |
507 | return -ENOSYS; | |
508 | } | |
509 | ||
bd3d5500 TR |
510 | static inline int of_property_match_string(struct device_node *np, |
511 | const char *propname, | |
512 | const char *string) | |
513 | { | |
514 | return -ENOSYS; | |
515 | } | |
516 | ||
b8fbdc42 | 517 | static inline struct device_node *of_parse_phandle(const struct device_node *np, |
36a0904e RN |
518 | const char *phandle_name, |
519 | int index) | |
520 | { | |
521 | return NULL; | |
522 | } | |
523 | ||
e05e5070 TR |
524 | static inline int of_parse_phandle_with_args(struct device_node *np, |
525 | const char *list_name, | |
526 | const char *cells_name, | |
527 | int index, | |
528 | struct of_phandle_args *out_args) | |
529 | { | |
530 | return -ENOSYS; | |
531 | } | |
532 | ||
035fd948 SW |
533 | static inline int of_parse_phandle_with_fixed_args(const struct device_node *np, |
534 | const char *list_name, int cells_count, int index, | |
535 | struct of_phandle_args *out_args) | |
536 | { | |
537 | return -ENOSYS; | |
538 | } | |
539 | ||
bd69f73f GL |
540 | static inline int of_count_phandle_with_args(struct device_node *np, |
541 | const char *list_name, | |
542 | const char *cells_name) | |
543 | { | |
544 | return -ENOSYS; | |
545 | } | |
546 | ||
ed5f886d NF |
547 | static inline int of_alias_get_id(struct device_node *np, const char *stem) |
548 | { | |
549 | return -ENOSYS; | |
550 | } | |
551 | ||
50e07f88 SW |
552 | static inline int of_machine_is_compatible(const char *compat) |
553 | { | |
554 | return 0; | |
555 | } | |
556 | ||
3482f2c5 | 557 | static inline bool of_console_check(const struct device_node *dn, const char *name, int index) |
5c19e952 | 558 | { |
3482f2c5 | 559 | return false; |
5c19e952 SH |
560 | } |
561 | ||
2adfffa2 SAS |
562 | static inline const __be32 *of_prop_next_u32(struct property *prop, |
563 | const __be32 *cur, u32 *pu) | |
564 | { | |
565 | return NULL; | |
566 | } | |
567 | ||
568 | static inline const char *of_prop_next_string(struct property *prop, | |
569 | const char *cur) | |
570 | { | |
571 | return NULL; | |
572 | } | |
573 | ||
3a1e362e | 574 | #define of_match_ptr(_ptr) NULL |
5762c205 | 575 | #define of_match_node(_matches, _node) NULL |
9dfbf207 | 576 | #endif /* CONFIG_OF */ |
b98c0239 | 577 | |
0c3f061c RH |
578 | #if defined(CONFIG_OF) && defined(CONFIG_NUMA) |
579 | extern int of_node_to_nid(struct device_node *np); | |
580 | #else | |
581 | static inline int of_node_to_nid(struct device_node *device) { return 0; } | |
5ca4db61 PM |
582 | #endif |
583 | ||
662372e4 RH |
584 | static inline struct device_node *of_find_matching_node( |
585 | struct device_node *from, | |
586 | const struct of_device_id *matches) | |
587 | { | |
588 | return of_find_matching_node_and_match(from, matches, NULL); | |
589 | } | |
590 | ||
ad54a0cf HS |
591 | /** |
592 | * of_property_count_u8_elems - Count the number of u8 elements in a property | |
593 | * | |
594 | * @np: device node from which the property value is to be read. | |
595 | * @propname: name of the property to be searched. | |
596 | * | |
597 | * Search for a property in a device node and count the number of u8 elements | |
598 | * in it. Returns number of elements on sucess, -EINVAL if the property does | |
599 | * not exist or its length does not match a multiple of u8 and -ENODATA if the | |
600 | * property does not have a value. | |
601 | */ | |
602 | static inline int of_property_count_u8_elems(const struct device_node *np, | |
603 | const char *propname) | |
604 | { | |
605 | return of_property_count_elems_of_size(np, propname, sizeof(u8)); | |
606 | } | |
607 | ||
608 | /** | |
609 | * of_property_count_u16_elems - Count the number of u16 elements in a property | |
610 | * | |
611 | * @np: device node from which the property value is to be read. | |
612 | * @propname: name of the property to be searched. | |
613 | * | |
614 | * Search for a property in a device node and count the number of u16 elements | |
615 | * in it. Returns number of elements on sucess, -EINVAL if the property does | |
616 | * not exist or its length does not match a multiple of u16 and -ENODATA if the | |
617 | * property does not have a value. | |
618 | */ | |
619 | static inline int of_property_count_u16_elems(const struct device_node *np, | |
620 | const char *propname) | |
621 | { | |
622 | return of_property_count_elems_of_size(np, propname, sizeof(u16)); | |
623 | } | |
624 | ||
625 | /** | |
626 | * of_property_count_u32_elems - Count the number of u32 elements in a property | |
627 | * | |
628 | * @np: device node from which the property value is to be read. | |
629 | * @propname: name of the property to be searched. | |
630 | * | |
631 | * Search for a property in a device node and count the number of u32 elements | |
632 | * in it. Returns number of elements on sucess, -EINVAL if the property does | |
633 | * not exist or its length does not match a multiple of u32 and -ENODATA if the | |
634 | * property does not have a value. | |
635 | */ | |
636 | static inline int of_property_count_u32_elems(const struct device_node *np, | |
637 | const char *propname) | |
638 | { | |
639 | return of_property_count_elems_of_size(np, propname, sizeof(u32)); | |
640 | } | |
641 | ||
642 | /** | |
643 | * of_property_count_u64_elems - Count the number of u64 elements in a property | |
644 | * | |
645 | * @np: device node from which the property value is to be read. | |
646 | * @propname: name of the property to be searched. | |
647 | * | |
648 | * Search for a property in a device node and count the number of u64 elements | |
649 | * in it. Returns number of elements on sucess, -EINVAL if the property does | |
650 | * not exist or its length does not match a multiple of u64 and -ENODATA if the | |
651 | * property does not have a value. | |
652 | */ | |
653 | static inline int of_property_count_u64_elems(const struct device_node *np, | |
654 | const char *propname) | |
655 | { | |
656 | return of_property_count_elems_of_size(np, propname, sizeof(u64)); | |
657 | } | |
658 | ||
a87fa1d8 GL |
659 | /** |
660 | * of_property_read_string_array() - Read an array of strings from a multiple | |
661 | * strings property. | |
662 | * @np: device node from which the property value is to be read. | |
663 | * @propname: name of the property to be searched. | |
664 | * @out_strs: output array of string pointers. | |
665 | * @sz: number of array elements to read. | |
666 | * | |
667 | * Search for a property in a device tree node and retrieve a list of | |
668 | * terminated string values (pointer to data, not a copy) in that property. | |
669 | * | |
670 | * If @out_strs is NULL, the number of strings in the property is returned. | |
671 | */ | |
672 | static inline int of_property_read_string_array(struct device_node *np, | |
673 | const char *propname, const char **out_strs, | |
674 | size_t sz) | |
675 | { | |
676 | return of_property_read_string_helper(np, propname, out_strs, sz, 0); | |
677 | } | |
678 | ||
679 | /** | |
680 | * of_property_count_strings() - Find and return the number of strings from a | |
681 | * multiple strings property. | |
682 | * @np: device node from which the property value is to be read. | |
683 | * @propname: name of the property to be searched. | |
684 | * | |
685 | * Search for a property in a device tree node and retrieve the number of null | |
686 | * terminated string contain in it. Returns the number of strings on | |
687 | * success, -EINVAL if the property does not exist, -ENODATA if property | |
688 | * does not have a value, and -EILSEQ if the string is not null-terminated | |
689 | * within the length of the property data. | |
690 | */ | |
691 | static inline int of_property_count_strings(struct device_node *np, | |
692 | const char *propname) | |
693 | { | |
694 | return of_property_read_string_helper(np, propname, NULL, 0, 0); | |
695 | } | |
696 | ||
697 | /** | |
698 | * of_property_read_string_index() - Find and read a string from a multiple | |
699 | * strings property. | |
700 | * @np: device node from which the property value is to be read. | |
701 | * @propname: name of the property to be searched. | |
702 | * @index: index of the string in the list of strings | |
703 | * @out_string: pointer to null terminated return string, modified only if | |
704 | * return value is 0. | |
705 | * | |
706 | * Search for a property in a device tree node and retrieve a null | |
707 | * terminated string value (pointer to data, not a copy) in the list of strings | |
708 | * contained in that property. | |
709 | * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if | |
710 | * property does not have a value, and -EILSEQ if the string is not | |
711 | * null-terminated within the length of the property data. | |
712 | * | |
713 | * The out_string pointer is modified only if a valid string can be decoded. | |
714 | */ | |
715 | static inline int of_property_read_string_index(struct device_node *np, | |
716 | const char *propname, | |
717 | int index, const char **output) | |
718 | { | |
719 | int rc = of_property_read_string_helper(np, propname, output, 1, index); | |
720 | return rc < 0 ? rc : 0; | |
721 | } | |
722 | ||
fa4d34cc JCPV |
723 | /** |
724 | * of_property_read_bool - Findfrom a property | |
725 | * @np: device node from which the property value is to be read. | |
726 | * @propname: name of the property to be searched. | |
727 | * | |
728 | * Search for a property in a device node. | |
729 | * Returns true if the property exist false otherwise. | |
730 | */ | |
731 | static inline bool of_property_read_bool(const struct device_node *np, | |
732 | const char *propname) | |
733 | { | |
734 | struct property *prop = of_find_property(np, propname, NULL); | |
735 | ||
736 | return prop ? true : false; | |
737 | } | |
738 | ||
be193249 VK |
739 | static inline int of_property_read_u8(const struct device_node *np, |
740 | const char *propname, | |
741 | u8 *out_value) | |
742 | { | |
743 | return of_property_read_u8_array(np, propname, out_value, 1); | |
744 | } | |
745 | ||
746 | static inline int of_property_read_u16(const struct device_node *np, | |
747 | const char *propname, | |
748 | u16 *out_value) | |
749 | { | |
750 | return of_property_read_u16_array(np, propname, out_value, 1); | |
751 | } | |
752 | ||
b98c0239 | 753 | static inline int of_property_read_u32(const struct device_node *np, |
aac285c6 | 754 | const char *propname, |
b98c0239 SG |
755 | u32 *out_value) |
756 | { | |
757 | return of_property_read_u32_array(np, propname, out_value, 1); | |
758 | } | |
759 | ||
e7a00e42 SR |
760 | static inline int of_property_read_s32(const struct device_node *np, |
761 | const char *propname, | |
762 | s32 *out_value) | |
763 | { | |
764 | return of_property_read_u32(np, propname, (u32*) out_value); | |
765 | } | |
766 | ||
2adfffa2 SAS |
767 | #define of_property_for_each_u32(np, propname, prop, p, u) \ |
768 | for (prop = of_find_property(np, propname, NULL), \ | |
769 | p = of_prop_next_u32(prop, NULL, &u); \ | |
770 | p; \ | |
771 | p = of_prop_next_u32(prop, p, &u)) | |
772 | ||
773 | #define of_property_for_each_string(np, propname, prop, s) \ | |
774 | for (prop = of_find_property(np, propname, NULL), \ | |
775 | s = of_prop_next_string(prop, NULL); \ | |
776 | s; \ | |
777 | s = of_prop_next_string(prop, s)) | |
778 | ||
662372e4 RH |
779 | #define for_each_node_by_name(dn, name) \ |
780 | for (dn = of_find_node_by_name(NULL, name); dn; \ | |
781 | dn = of_find_node_by_name(dn, name)) | |
782 | #define for_each_node_by_type(dn, type) \ | |
783 | for (dn = of_find_node_by_type(NULL, type); dn; \ | |
784 | dn = of_find_node_by_type(dn, type)) | |
785 | #define for_each_compatible_node(dn, type, compatible) \ | |
786 | for (dn = of_find_compatible_node(NULL, type, compatible); dn; \ | |
787 | dn = of_find_compatible_node(dn, type, compatible)) | |
788 | #define for_each_matching_node(dn, matches) \ | |
789 | for (dn = of_find_matching_node(NULL, matches); dn; \ | |
790 | dn = of_find_matching_node(dn, matches)) | |
791 | #define for_each_matching_node_and_match(dn, matches, match) \ | |
792 | for (dn = of_find_matching_node_and_match(NULL, matches, match); \ | |
793 | dn; dn = of_find_matching_node_and_match(dn, matches, match)) | |
794 | ||
795 | #define for_each_child_of_node(parent, child) \ | |
796 | for (child = of_get_next_child(parent, NULL); child != NULL; \ | |
797 | child = of_get_next_child(parent, child)) | |
798 | #define for_each_available_child_of_node(parent, child) \ | |
799 | for (child = of_get_next_available_child(parent, NULL); child != NULL; \ | |
800 | child = of_get_next_available_child(parent, child)) | |
801 | ||
802 | #define for_each_node_with_property(dn, prop_name) \ | |
803 | for (dn = of_find_node_with_property(NULL, prop_name); dn; \ | |
804 | dn = of_find_node_with_property(dn, prop_name)) | |
805 | ||
806 | static inline int of_get_child_count(const struct device_node *np) | |
807 | { | |
808 | struct device_node *child; | |
809 | int num = 0; | |
810 | ||
811 | for_each_child_of_node(np, child) | |
812 | num++; | |
813 | ||
814 | return num; | |
815 | } | |
816 | ||
817 | static inline int of_get_available_child_count(const struct device_node *np) | |
818 | { | |
819 | struct device_node *child; | |
820 | int num = 0; | |
821 | ||
822 | for_each_available_child_of_node(np, child) | |
823 | num++; | |
824 | ||
825 | return num; | |
826 | } | |
827 | ||
54196ccb RH |
828 | #ifdef CONFIG_OF |
829 | #define _OF_DECLARE(table, name, compat, fn, fn_type) \ | |
830 | static const struct of_device_id __of_table_##name \ | |
831 | __used __section(__##table##_of_table) \ | |
832 | = { .compatible = compat, \ | |
833 | .data = (fn == (fn_type)NULL) ? fn : fn } | |
834 | #else | |
5f563585 | 835 | #define _OF_DECLARE(table, name, compat, fn, fn_type) \ |
54196ccb RH |
836 | static const struct of_device_id __of_table_##name \ |
837 | __attribute__((unused)) \ | |
838 | = { .compatible = compat, \ | |
839 | .data = (fn == (fn_type)NULL) ? fn : fn } | |
840 | #endif | |
841 | ||
842 | typedef int (*of_init_fn_2)(struct device_node *, struct device_node *); | |
843 | typedef void (*of_init_fn_1)(struct device_node *); | |
844 | ||
845 | #define OF_DECLARE_1(table, name, compat, fn) \ | |
846 | _OF_DECLARE(table, name, compat, fn, of_init_fn_1) | |
847 | #define OF_DECLARE_2(table, name, compat, fn) \ | |
848 | _OF_DECLARE(table, name, compat, fn, of_init_fn_2) | |
849 | ||
201c910b PA |
850 | /** |
851 | * struct of_changeset_entry - Holds a changeset entry | |
852 | * | |
853 | * @node: list_head for the log list | |
854 | * @action: notifier action | |
855 | * @np: pointer to the device node affected | |
856 | * @prop: pointer to the property affected | |
857 | * @old_prop: hold a pointer to the original property | |
858 | * | |
859 | * Every modification of the device tree during a changeset | |
860 | * is held in a list of of_changeset_entry structures. | |
861 | * That way we can recover from a partial application, or we can | |
862 | * revert the changeset | |
863 | */ | |
864 | struct of_changeset_entry { | |
865 | struct list_head node; | |
866 | unsigned long action; | |
867 | struct device_node *np; | |
868 | struct property *prop; | |
869 | struct property *old_prop; | |
870 | }; | |
871 | ||
872 | /** | |
873 | * struct of_changeset - changeset tracker structure | |
874 | * | |
875 | * @entries: list_head for the changeset entries | |
876 | * | |
877 | * changesets are a convenient way to apply bulk changes to the | |
878 | * live tree. In case of an error, changes are rolled-back. | |
879 | * changesets live on after initial application, and if not | |
880 | * destroyed after use, they can be reverted in one single call. | |
881 | */ | |
882 | struct of_changeset { | |
883 | struct list_head entries; | |
884 | }; | |
885 | ||
b53a2340 PA |
886 | enum of_reconfig_change { |
887 | OF_RECONFIG_NO_CHANGE = 0, | |
888 | OF_RECONFIG_CHANGE_ADD, | |
889 | OF_RECONFIG_CHANGE_REMOVE, | |
890 | }; | |
891 | ||
201c910b | 892 | #ifdef CONFIG_OF_DYNAMIC |
f6892d19 GL |
893 | extern int of_reconfig_notifier_register(struct notifier_block *); |
894 | extern int of_reconfig_notifier_unregister(struct notifier_block *); | |
895 | extern int of_reconfig_notify(unsigned long, void *); | |
896 | extern int of_reconfig_get_state_change(unsigned long action, void *arg); | |
897 | ||
201c910b PA |
898 | extern void of_changeset_init(struct of_changeset *ocs); |
899 | extern void of_changeset_destroy(struct of_changeset *ocs); | |
900 | extern int of_changeset_apply(struct of_changeset *ocs); | |
901 | extern int of_changeset_revert(struct of_changeset *ocs); | |
902 | extern int of_changeset_action(struct of_changeset *ocs, | |
903 | unsigned long action, struct device_node *np, | |
904 | struct property *prop); | |
905 | ||
906 | static inline int of_changeset_attach_node(struct of_changeset *ocs, | |
907 | struct device_node *np) | |
908 | { | |
909 | return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL); | |
910 | } | |
911 | ||
912 | static inline int of_changeset_detach_node(struct of_changeset *ocs, | |
913 | struct device_node *np) | |
914 | { | |
915 | return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL); | |
916 | } | |
917 | ||
918 | static inline int of_changeset_add_property(struct of_changeset *ocs, | |
919 | struct device_node *np, struct property *prop) | |
920 | { | |
921 | return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop); | |
922 | } | |
923 | ||
924 | static inline int of_changeset_remove_property(struct of_changeset *ocs, | |
925 | struct device_node *np, struct property *prop) | |
926 | { | |
927 | return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop); | |
928 | } | |
929 | ||
930 | static inline int of_changeset_update_property(struct of_changeset *ocs, | |
931 | struct device_node *np, struct property *prop) | |
932 | { | |
933 | return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop); | |
934 | } | |
f6892d19 GL |
935 | #else /* CONFIG_OF_DYNAMIC */ |
936 | static inline int of_reconfig_notifier_register(struct notifier_block *nb) | |
937 | { | |
938 | return -EINVAL; | |
939 | } | |
940 | static inline int of_reconfig_notifier_unregister(struct notifier_block *nb) | |
941 | { | |
942 | return -EINVAL; | |
943 | } | |
944 | static inline int of_reconfig_notify(unsigned long action, void *arg) | |
945 | { | |
946 | return -EINVAL; | |
947 | } | |
948 | static inline int of_reconfig_get_state_change(unsigned long action, void *arg) | |
949 | { | |
950 | return -EINVAL; | |
951 | } | |
952 | #endif /* CONFIG_OF_DYNAMIC */ | |
201c910b | 953 | |
7941b27b PA |
954 | /* CONFIG_OF_RESOLVE api */ |
955 | extern int of_resolve_phandles(struct device_node *tree); | |
956 | ||
76c1ce78 | 957 | #endif /* _LINUX_OF_H */ |