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