Commit | Line | Data |
---|---|---|
af6074fc | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
76c1ce78 SR |
2 | #ifndef _LINUX_OF_H |
3 | #define _LINUX_OF_H | |
4 | /* | |
5 | * Definitions for talking to the Open Firmware PROM on | |
6 | * Power Macintosh and other computers. | |
7 | * | |
8 | * Copyright (C) 1996-2005 Paul Mackerras. | |
9 | * | |
10 | * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp. | |
11 | * Updates for SPARC64 by David S. Miller | |
12 | * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp. | |
76c1ce78 SR |
13 | */ |
14 | #include <linux/types.h> | |
1977f032 | 15 | #include <linux/bitops.h> |
e51130c0 | 16 | #include <linux/errno.h> |
75b57ecf | 17 | #include <linux/kobject.h> |
283029d1 | 18 | #include <linux/mod_devicetable.h> |
0d351c3e | 19 | #include <linux/spinlock.h> |
5ca4db61 | 20 | #include <linux/topology.h> |
1cf3d8b3 | 21 | #include <linux/notifier.h> |
b31384fa | 22 | #include <linux/property.h> |
7518b589 | 23 | #include <linux/list.h> |
76c1ce78 | 24 | |
2e89e685 | 25 | #include <asm/byteorder.h> |
d0a99402 | 26 | #include <asm/errno.h> |
2e89e685 | 27 | |
731581e6 GL |
28 | typedef u32 phandle; |
29 | typedef u32 ihandle; | |
30 | ||
31 | struct property { | |
32 | char *name; | |
33 | int length; | |
34 | void *value; | |
35 | struct property *next; | |
16bba30e | 36 | #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC) |
731581e6 | 37 | unsigned long _flags; |
16bba30e | 38 | #endif |
36689ecd | 39 | #if defined(CONFIG_OF_PROMTREE) |
731581e6 | 40 | unsigned int unique_id; |
36689ecd | 41 | #endif |
b56b5528 | 42 | #if defined(CONFIG_OF_KOBJ) |
75b57ecf | 43 | struct bin_attribute attr; |
b56b5528 | 44 | #endif |
731581e6 GL |
45 | }; |
46 | ||
6f192492 GL |
47 | #if defined(CONFIG_SPARC) |
48 | struct of_irq_controller; | |
49 | #endif | |
50 | ||
51 | struct device_node { | |
52 | const char *name; | |
6016a363 | 53 | phandle phandle; |
c22618a1 | 54 | const char *full_name; |
8a0662d9 | 55 | struct fwnode_handle fwnode; |
6f192492 GL |
56 | |
57 | struct property *properties; | |
58 | struct property *deadprops; /* removed properties */ | |
59 | struct device_node *parent; | |
60 | struct device_node *child; | |
61 | struct device_node *sibling; | |
b56b5528 | 62 | #if defined(CONFIG_OF_KOBJ) |
75b57ecf | 63 | struct kobject kobj; |
b56b5528 | 64 | #endif |
6f192492 GL |
65 | unsigned long _flags; |
66 | void *data; | |
67 | #if defined(CONFIG_SPARC) | |
6f192492 GL |
68 | unsigned int unique_id; |
69 | struct of_irq_controller *irq_trans; | |
70 | #endif | |
71 | }; | |
72 | ||
b66548e2 | 73 | #define MAX_PHANDLE_ARGS 16 |
15c9a0ac GL |
74 | struct of_phandle_args { |
75 | struct device_node *np; | |
76 | int args_count; | |
77 | uint32_t args[MAX_PHANDLE_ARGS]; | |
78 | }; | |
79 | ||
74e1fbb1 JR |
80 | struct of_phandle_iterator { |
81 | /* Common iterator information */ | |
82 | const char *cells_name; | |
83 | int cell_count; | |
84 | const struct device_node *parent; | |
85 | ||
86 | /* List size information */ | |
87 | const __be32 *list_end; | |
88 | const __be32 *phandle_end; | |
89 | ||
90 | /* Current position state */ | |
91 | const __be32 *cur; | |
92 | uint32_t cur_count; | |
93 | phandle phandle; | |
94 | struct device_node *node; | |
95 | }; | |
96 | ||
f5242e5a GL |
97 | struct of_reconfig_data { |
98 | struct device_node *dn; | |
99 | struct property *prop; | |
100 | struct property *old_prop; | |
101 | }; | |
102 | ||
0829f6d1 PA |
103 | /* initialize a node */ |
104 | extern struct kobj_type of_node_ktype; | |
3708184a | 105 | extern const struct fwnode_operations of_fwnode_ops; |
0829f6d1 PA |
106 | static inline void of_node_init(struct device_node *node) |
107 | { | |
b56b5528 | 108 | #if defined(CONFIG_OF_KOBJ) |
0829f6d1 | 109 | kobject_init(&node->kobj, &of_node_ktype); |
b56b5528 | 110 | #endif |
01bb86b3 | 111 | fwnode_init(&node->fwnode, &of_fwnode_ops); |
0829f6d1 PA |
112 | } |
113 | ||
b56b5528 | 114 | #if defined(CONFIG_OF_KOBJ) |
0c3c234b | 115 | #define of_node_kobj(n) (&(n)->kobj) |
b56b5528 RH |
116 | #else |
117 | #define of_node_kobj(n) NULL | |
118 | #endif | |
0829f6d1 | 119 | |
0f22dd39 GL |
120 | #ifdef CONFIG_OF_DYNAMIC |
121 | extern struct device_node *of_node_get(struct device_node *node); | |
122 | extern void of_node_put(struct device_node *node); | |
123 | #else /* CONFIG_OF_DYNAMIC */ | |
3ecdd051 RH |
124 | /* Dummy ref counting routines - to be implemented later */ |
125 | static inline struct device_node *of_node_get(struct device_node *node) | |
126 | { | |
127 | return node; | |
128 | } | |
0f22dd39 GL |
129 | static inline void of_node_put(struct device_node *node) { } |
130 | #endif /* !CONFIG_OF_DYNAMIC */ | |
3ecdd051 | 131 | |
41f88009 | 132 | /* Pointer for first entry in chain of all nodes. */ |
5063e25a | 133 | extern struct device_node *of_root; |
fc0bdae4 | 134 | extern struct device_node *of_chosen; |
611cad72 | 135 | extern struct device_node *of_aliases; |
a752ee56 | 136 | extern struct device_node *of_stdout; |
d6d3c4e6 | 137 | extern raw_spinlock_t devtree_lock; |
41f88009 | 138 | |
144552c7 FR |
139 | /* |
140 | * struct device_node flag descriptions | |
141 | * (need to be visible even when !CONFIG_OF) | |
142 | */ | |
143 | #define OF_DYNAMIC 1 /* (and properties) allocated via kmalloc */ | |
144 | #define OF_DETACHED 2 /* detached from the device tree */ | |
145 | #define OF_POPULATED 3 /* device already created */ | |
146 | #define OF_POPULATED_BUS 4 /* platform bus created for children */ | |
147 | #define OF_OVERLAY 5 /* allocated for an overlay */ | |
148 | #define OF_OVERLAY_FREE_CSET 6 /* in overlay cset being freed */ | |
391b459d | 149 | |
b1d06b60 GR |
150 | #define OF_BAD_ADDR ((u64)-1) |
151 | ||
6d09dc6b | 152 | #ifdef CONFIG_OF |
194ec936 SH |
153 | void of_core_init(void); |
154 | ||
d20dc149 | 155 | static inline bool is_of_node(const struct fwnode_handle *fwnode) |
8a0662d9 | 156 | { |
db3e50f3 | 157 | return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &of_fwnode_ops; |
8a0662d9 RW |
158 | } |
159 | ||
d20dc149 SA |
160 | #define to_of_node(__fwnode) \ |
161 | ({ \ | |
162 | typeof(__fwnode) __to_of_node_fwnode = (__fwnode); \ | |
163 | \ | |
164 | is_of_node(__to_of_node_fwnode) ? \ | |
165 | container_of(__to_of_node_fwnode, \ | |
166 | struct device_node, fwnode) : \ | |
167 | NULL; \ | |
168 | }) | |
8a0662d9 | 169 | |
debd3a3b SA |
170 | #define of_fwnode_handle(node) \ |
171 | ({ \ | |
172 | typeof(node) __of_fwnode_handle_node = (node); \ | |
173 | \ | |
174 | __of_fwnode_handle_node ? \ | |
175 | &__of_fwnode_handle_node->fwnode : NULL; \ | |
176 | }) | |
67831837 | 177 | |
3bcbaf6e SAS |
178 | static inline bool of_have_populated_dt(void) |
179 | { | |
5063e25a | 180 | return of_root != NULL; |
3bcbaf6e SAS |
181 | } |
182 | ||
035ebefc AS |
183 | static inline bool of_node_is_root(const struct device_node *node) |
184 | { | |
185 | return node && (node->parent == NULL); | |
186 | } | |
187 | ||
50436312 GL |
188 | static inline int of_node_check_flag(struct device_node *n, unsigned long flag) |
189 | { | |
190 | return test_bit(flag, &n->_flags); | |
191 | } | |
192 | ||
c6e126de PM |
193 | static inline int of_node_test_and_set_flag(struct device_node *n, |
194 | unsigned long flag) | |
195 | { | |
196 | return test_and_set_bit(flag, &n->_flags); | |
197 | } | |
198 | ||
50436312 GL |
199 | static inline void of_node_set_flag(struct device_node *n, unsigned long flag) |
200 | { | |
201 | set_bit(flag, &n->_flags); | |
202 | } | |
203 | ||
588453c6 PA |
204 | static inline void of_node_clear_flag(struct device_node *n, unsigned long flag) |
205 | { | |
206 | clear_bit(flag, &n->_flags); | |
207 | } | |
208 | ||
16bba30e | 209 | #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC) |
588453c6 PA |
210 | static inline int of_property_check_flag(struct property *p, unsigned long flag) |
211 | { | |
212 | return test_bit(flag, &p->_flags); | |
213 | } | |
214 | ||
215 | static inline void of_property_set_flag(struct property *p, unsigned long flag) | |
216 | { | |
217 | set_bit(flag, &p->_flags); | |
218 | } | |
219 | ||
220 | static inline void of_property_clear_flag(struct property *p, unsigned long flag) | |
221 | { | |
222 | clear_bit(flag, &p->_flags); | |
223 | } | |
16bba30e | 224 | #endif |
588453c6 | 225 | |
5063e25a | 226 | extern struct device_node *__of_find_all_nodes(struct device_node *prev); |
e91edcf5 GL |
227 | extern struct device_node *of_find_all_nodes(struct device_node *prev); |
228 | ||
b6caf2ad | 229 | /* |
3d6b8828 | 230 | * OF address retrieval & translation |
b6caf2ad GL |
231 | */ |
232 | ||
233 | /* Helper to read a big number; size is in cells (not bytes) */ | |
2e89e685 | 234 | static inline u64 of_read_number(const __be32 *cell, int size) |
b6caf2ad GL |
235 | { |
236 | u64 r = 0; | |
44086866 PT |
237 | for (; size--; cell++) |
238 | r = (r << 32) | be32_to_cpu(*cell); | |
b6caf2ad GL |
239 | return r; |
240 | } | |
241 | ||
242 | /* Like of_read_number, but we want an unsigned long result */ | |
2e89e685 | 243 | static inline unsigned long of_read_ulong(const __be32 *cell, int size) |
b6caf2ad | 244 | { |
2be09cb9 GL |
245 | /* toss away upper bits if unsigned long is smaller than u64 */ |
246 | return of_read_number(cell, size); | |
b6caf2ad | 247 | } |
b6caf2ad | 248 | |
b5b4bb3f | 249 | #if defined(CONFIG_SPARC) |
76c1ce78 | 250 | #include <asm/prom.h> |
b5b4bb3f | 251 | #endif |
76c1ce78 | 252 | |
61e955db GL |
253 | #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags) |
254 | #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags) | |
255 | ||
f42b0e18 RH |
256 | extern bool of_node_name_eq(const struct device_node *np, const char *name); |
257 | extern bool of_node_name_prefix(const struct device_node *np, const char *prefix); | |
258 | ||
c0a05bf0 | 259 | static inline const char *of_node_full_name(const struct device_node *np) |
74a7f084 GL |
260 | { |
261 | return np ? np->full_name : "<no-node>"; | |
262 | } | |
263 | ||
5063e25a GL |
264 | #define for_each_of_allnodes_from(from, dn) \ |
265 | for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn)) | |
266 | #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn) | |
76c1ce78 SR |
267 | extern struct device_node *of_find_node_by_name(struct device_node *from, |
268 | const char *name); | |
76c1ce78 SR |
269 | extern struct device_node *of_find_node_by_type(struct device_node *from, |
270 | const char *type); | |
76c1ce78 SR |
271 | extern struct device_node *of_find_compatible_node(struct device_node *from, |
272 | const char *type, const char *compat); | |
50c8af4c SW |
273 | extern struct device_node *of_find_matching_node_and_match( |
274 | struct device_node *from, | |
275 | const struct of_device_id *matches, | |
276 | const struct of_device_id **match); | |
662372e4 | 277 | |
75c28c09 LL |
278 | extern struct device_node *of_find_node_opts_by_path(const char *path, |
279 | const char **opts); | |
280 | static inline struct device_node *of_find_node_by_path(const char *path) | |
281 | { | |
282 | return of_find_node_opts_by_path(path, NULL); | |
283 | } | |
284 | ||
76c1ce78 SR |
285 | extern struct device_node *of_find_node_by_phandle(phandle handle); |
286 | extern struct device_node *of_get_parent(const struct device_node *node); | |
f4eb0107 | 287 | extern struct device_node *of_get_next_parent(struct device_node *node); |
76c1ce78 SR |
288 | extern struct device_node *of_get_next_child(const struct device_node *node, |
289 | struct device_node *prev); | |
3296193d TT |
290 | extern struct device_node *of_get_next_available_child( |
291 | const struct device_node *node, struct device_node *prev); | |
292 | ||
36156f92 JH |
293 | extern struct device_node *of_get_compatible_child(const struct device_node *parent, |
294 | const char *compatible); | |
9c19761a SK |
295 | extern struct device_node *of_get_child_by_name(const struct device_node *node, |
296 | const char *name); | |
954e04b9 | 297 | |
a3e31b45 SK |
298 | /* cache lookup */ |
299 | extern struct device_node *of_find_next_cache_node(const struct device_node *); | |
5fa23530 | 300 | extern int of_find_last_cache_level(unsigned int cpu); |
1e291b14 ME |
301 | extern struct device_node *of_find_node_with_property( |
302 | struct device_node *from, const char *prop_name); | |
1e291b14 | 303 | |
76c1ce78 SR |
304 | extern struct property *of_find_property(const struct device_node *np, |
305 | const char *name, | |
306 | int *lenp); | |
ad54a0cf HS |
307 | extern int of_property_count_elems_of_size(const struct device_node *np, |
308 | const char *propname, int elem_size); | |
3daf3726 TP |
309 | extern int of_property_read_u32_index(const struct device_node *np, |
310 | const char *propname, | |
311 | u32 index, u32 *out_value); | |
2475a2b6 AP |
312 | extern int of_property_read_u64_index(const struct device_node *np, |
313 | const char *propname, | |
314 | u32 index, u64 *out_value); | |
a67e9472 RF |
315 | extern int of_property_read_variable_u8_array(const struct device_node *np, |
316 | const char *propname, u8 *out_values, | |
317 | size_t sz_min, size_t sz_max); | |
318 | extern int of_property_read_variable_u16_array(const struct device_node *np, | |
319 | const char *propname, u16 *out_values, | |
320 | size_t sz_min, size_t sz_max); | |
321 | extern int of_property_read_variable_u32_array(const struct device_node *np, | |
322 | const char *propname, | |
323 | u32 *out_values, | |
324 | size_t sz_min, | |
325 | size_t sz_max); | |
4cd7f7a3 JI |
326 | extern int of_property_read_u64(const struct device_node *np, |
327 | const char *propname, u64 *out_value); | |
a67e9472 RF |
328 | extern int of_property_read_variable_u64_array(const struct device_node *np, |
329 | const char *propname, | |
330 | u64 *out_values, | |
331 | size_t sz_min, | |
332 | size_t sz_max); | |
0e373639 | 333 | |
fe99c707 | 334 | extern int of_property_read_string(const struct device_node *np, |
aac285c6 JI |
335 | const char *propname, |
336 | const char **out_string); | |
fe99c707 | 337 | extern int of_property_match_string(const struct device_node *np, |
7aff0fe3 GL |
338 | const char *propname, |
339 | const char *string); | |
fe99c707 | 340 | extern int of_property_read_string_helper(const struct device_node *np, |
a87fa1d8 GL |
341 | const char *propname, |
342 | const char **out_strs, size_t sz, int index); | |
76c1ce78 SR |
343 | extern int of_device_is_compatible(const struct device_node *device, |
344 | const char *); | |
b9c13fe3 BH |
345 | extern int of_device_compatible_match(struct device_node *device, |
346 | const char *const *compat); | |
53a4ab96 | 347 | extern bool of_device_is_available(const struct device_node *device); |
37786c7f | 348 | extern bool of_device_is_big_endian(const struct device_node *device); |
76c1ce78 SR |
349 | extern const void *of_get_property(const struct device_node *node, |
350 | const char *name, | |
351 | int *lenp); | |
183912d3 | 352 | extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread); |
f1f207e4 | 353 | extern struct device_node *of_get_next_cpu_node(struct device_node *prev); |
b9f8c26a UH |
354 | extern struct device_node *of_get_cpu_state_node(struct device_node *cpu_node, |
355 | int index); | |
795e92ec | 356 | extern u64 of_get_cpu_hwid(struct device_node *cpun, unsigned int thread); |
f1f207e4 | 357 | |
8af0da93 DA |
358 | #define for_each_property_of_node(dn, pp) \ |
359 | for (pp = dn->properties; pp != NULL; pp = pp->next) | |
611cad72 | 360 | |
76c1ce78 SR |
361 | extern int of_n_addr_cells(struct device_node *np); |
362 | extern int of_n_size_cells(struct device_node *np); | |
283029d1 GL |
363 | extern const struct of_device_id *of_match_node( |
364 | const struct of_device_id *matches, const struct device_node *node); | |
3f07af49 | 365 | extern int of_modalias_node(struct device_node *node, char *modalias, int len); |
624cfca5 | 366 | extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args); |
b8fbdc42 | 367 | extern struct device_node *of_parse_phandle(const struct device_node *np, |
739649c5 GL |
368 | const char *phandle_name, |
369 | int index); | |
93c667ca | 370 | extern int of_parse_phandle_with_args(const struct device_node *np, |
64b60e09 | 371 | const char *list_name, const char *cells_name, int index, |
15c9a0ac | 372 | struct of_phandle_args *out_args); |
bd6f2fd5 SB |
373 | extern int of_parse_phandle_with_args_map(const struct device_node *np, |
374 | const char *list_name, const char *stem_name, int index, | |
375 | struct of_phandle_args *out_args); | |
035fd948 SW |
376 | extern int of_parse_phandle_with_fixed_args(const struct device_node *np, |
377 | const char *list_name, int cells_count, int index, | |
378 | struct of_phandle_args *out_args); | |
bd69f73f GL |
379 | extern int of_count_phandle_with_args(const struct device_node *np, |
380 | const char *list_name, const char *cells_name); | |
76c1ce78 | 381 | |
74e1fbb1 JR |
382 | /* phandle iterator functions */ |
383 | extern int of_phandle_iterator_init(struct of_phandle_iterator *it, | |
384 | const struct device_node *np, | |
385 | const char *list_name, | |
386 | const char *cells_name, | |
387 | int cell_count); | |
388 | ||
cd209b41 | 389 | extern int of_phandle_iterator_next(struct of_phandle_iterator *it); |
abdaa77b JR |
390 | extern int of_phandle_iterator_args(struct of_phandle_iterator *it, |
391 | uint32_t *args, | |
392 | int size); | |
cd209b41 | 393 | |
611cad72 SG |
394 | extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align)); |
395 | extern int of_alias_get_id(struct device_node *np, const char *stem); | |
351d224f | 396 | extern int of_alias_get_highest_id(const char *stem); |
b1078c35 MS |
397 | extern int of_alias_get_alias_list(const struct of_device_id *matches, |
398 | const char *stem, unsigned long *bitmap, | |
399 | unsigned int nbits); | |
611cad72 | 400 | |
21b082ec GL |
401 | extern int of_machine_is_compatible(const char *compat); |
402 | ||
79d1c712 NF |
403 | extern int of_add_property(struct device_node *np, struct property *prop); |
404 | extern int of_remove_property(struct device_node *np, struct property *prop); | |
405 | extern int of_update_property(struct device_node *np, struct property *newprop); | |
21b082ec | 406 | |
fcdeb7fe | 407 | /* For updating the device tree at runtime */ |
1cf3d8b3 NF |
408 | #define OF_RECONFIG_ATTACH_NODE 0x0001 |
409 | #define OF_RECONFIG_DETACH_NODE 0x0002 | |
410 | #define OF_RECONFIG_ADD_PROPERTY 0x0003 | |
411 | #define OF_RECONFIG_REMOVE_PROPERTY 0x0004 | |
412 | #define OF_RECONFIG_UPDATE_PROPERTY 0x0005 | |
413 | ||
1cf3d8b3 NF |
414 | extern int of_attach_node(struct device_node *); |
415 | extern int of_detach_node(struct device_node *); | |
fcdeb7fe | 416 | |
3a1e362e | 417 | #define of_match_ptr(_ptr) (_ptr) |
c541adc6 | 418 | |
a67e9472 RF |
419 | /** |
420 | * of_property_read_u8_array - Find and read an array of u8 from a property. | |
421 | * | |
422 | * @np: device node from which the property value is to be read. | |
423 | * @propname: name of the property to be searched. | |
424 | * @out_values: pointer to return value, modified only if return value is 0. | |
425 | * @sz: number of array elements to read | |
426 | * | |
427 | * Search for a property in a device node and read 8-bit value(s) from | |
8c8239c2 | 428 | * it. |
a67e9472 RF |
429 | * |
430 | * dts entry of array should be like: | |
8c8239c2 RH |
431 | * ``property = /bits/ 8 <0x50 0x60 0x70>;`` |
432 | * | |
433 | * Return: 0 on success, -EINVAL if the property does not exist, | |
434 | * -ENODATA if property does not have a value, and -EOVERFLOW if the | |
435 | * property data isn't large enough. | |
a67e9472 RF |
436 | * |
437 | * The out_values is modified only if a valid u8 value can be decoded. | |
438 | */ | |
439 | static inline int of_property_read_u8_array(const struct device_node *np, | |
440 | const char *propname, | |
441 | u8 *out_values, size_t sz) | |
442 | { | |
443 | int ret = of_property_read_variable_u8_array(np, propname, out_values, | |
444 | sz, 0); | |
445 | if (ret >= 0) | |
446 | return 0; | |
447 | else | |
448 | return ret; | |
449 | } | |
450 | ||
451 | /** | |
452 | * of_property_read_u16_array - Find and read an array of u16 from a property. | |
453 | * | |
454 | * @np: device node from which the property value is to be read. | |
455 | * @propname: name of the property to be searched. | |
456 | * @out_values: pointer to return value, modified only if return value is 0. | |
457 | * @sz: number of array elements to read | |
458 | * | |
459 | * Search for a property in a device node and read 16-bit value(s) from | |
8c8239c2 | 460 | * it. |
a67e9472 RF |
461 | * |
462 | * dts entry of array should be like: | |
8c8239c2 RH |
463 | * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;`` |
464 | * | |
465 | * Return: 0 on success, -EINVAL if the property does not exist, | |
466 | * -ENODATA if property does not have a value, and -EOVERFLOW if the | |
467 | * property data isn't large enough. | |
a67e9472 RF |
468 | * |
469 | * The out_values is modified only if a valid u16 value can be decoded. | |
470 | */ | |
471 | static inline int of_property_read_u16_array(const struct device_node *np, | |
472 | const char *propname, | |
473 | u16 *out_values, size_t sz) | |
474 | { | |
475 | int ret = of_property_read_variable_u16_array(np, propname, out_values, | |
476 | sz, 0); | |
477 | if (ret >= 0) | |
478 | return 0; | |
479 | else | |
480 | return ret; | |
481 | } | |
482 | ||
483 | /** | |
484 | * of_property_read_u32_array - Find and read an array of 32 bit integers | |
485 | * from a property. | |
486 | * | |
487 | * @np: device node from which the property value is to be read. | |
488 | * @propname: name of the property to be searched. | |
489 | * @out_values: pointer to return value, modified only if return value is 0. | |
490 | * @sz: number of array elements to read | |
491 | * | |
492 | * Search for a property in a device node and read 32-bit value(s) from | |
8c8239c2 RH |
493 | * it. |
494 | * | |
495 | * Return: 0 on success, -EINVAL if the property does not exist, | |
a67e9472 RF |
496 | * -ENODATA if property does not have a value, and -EOVERFLOW if the |
497 | * property data isn't large enough. | |
498 | * | |
499 | * The out_values is modified only if a valid u32 value can be decoded. | |
500 | */ | |
501 | static inline int of_property_read_u32_array(const struct device_node *np, | |
502 | const char *propname, | |
503 | u32 *out_values, size_t sz) | |
504 | { | |
505 | int ret = of_property_read_variable_u32_array(np, propname, out_values, | |
506 | sz, 0); | |
507 | if (ret >= 0) | |
508 | return 0; | |
509 | else | |
510 | return ret; | |
511 | } | |
512 | ||
513 | /** | |
514 | * of_property_read_u64_array - Find and read an array of 64 bit integers | |
515 | * from a property. | |
516 | * | |
517 | * @np: device node from which the property value is to be read. | |
518 | * @propname: name of the property to be searched. | |
519 | * @out_values: pointer to return value, modified only if return value is 0. | |
520 | * @sz: number of array elements to read | |
521 | * | |
522 | * Search for a property in a device node and read 64-bit value(s) from | |
8c8239c2 RH |
523 | * it. |
524 | * | |
525 | * Return: 0 on success, -EINVAL if the property does not exist, | |
a67e9472 RF |
526 | * -ENODATA if property does not have a value, and -EOVERFLOW if the |
527 | * property data isn't large enough. | |
528 | * | |
529 | * The out_values is modified only if a valid u64 value can be decoded. | |
530 | */ | |
531 | static inline int of_property_read_u64_array(const struct device_node *np, | |
532 | const char *propname, | |
533 | u64 *out_values, size_t sz) | |
534 | { | |
535 | int ret = of_property_read_variable_u64_array(np, propname, out_values, | |
536 | sz, 0); | |
537 | if (ret >= 0) | |
538 | return 0; | |
539 | else | |
540 | return ret; | |
541 | } | |
542 | ||
c541adc6 SW |
543 | /* |
544 | * struct property *prop; | |
545 | * const __be32 *p; | |
546 | * u32 u; | |
547 | * | |
548 | * of_property_for_each_u32(np, "propname", prop, p, u) | |
549 | * printk("U32 value: %x\n", u); | |
550 | */ | |
551 | const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur, | |
552 | u32 *pu); | |
c541adc6 SW |
553 | /* |
554 | * struct property *prop; | |
555 | * const char *s; | |
556 | * | |
557 | * of_property_for_each_string(np, "propname", prop, s) | |
558 | * printk("String value: %s\n", s); | |
559 | */ | |
560 | const char *of_prop_next_string(struct property *prop, const char *cur); | |
c541adc6 | 561 | |
3482f2c5 | 562 | bool of_console_check(struct device_node *dn, char *name, int index); |
5c19e952 | 563 | |
a0e71cd9 SP |
564 | extern int of_cpu_node_to_id(struct device_node *np); |
565 | ||
746a71d0 | 566 | int of_map_id(struct device_node *np, u32 id, |
2a6db719 NG |
567 | const char *map_name, const char *map_mask_name, |
568 | struct device_node **target, u32 *id_out); | |
569 | ||
964db79d NSJ |
570 | phys_addr_t of_dma_get_max_cpu_address(struct device_node *np); |
571 | ||
b30be4dc RH |
572 | struct kimage; |
573 | void *of_kexec_alloc_and_setup_fdt(const struct kimage *image, | |
574 | unsigned long initrd_load_addr, | |
575 | unsigned long initrd_len, | |
576 | const char *cmdline, size_t extra_fdt_size); | |
fee3ff99 LR |
577 | int ima_get_kexec_buffer(void **addr, size_t *size); |
578 | int ima_free_kexec_buffer(void); | |
b98c0239 | 579 | #else /* CONFIG_OF */ |
3bcbaf6e | 580 | |
194ec936 SH |
581 | static inline void of_core_init(void) |
582 | { | |
583 | } | |
584 | ||
d20dc149 | 585 | static inline bool is_of_node(const struct fwnode_handle *fwnode) |
8a0662d9 RW |
586 | { |
587 | return false; | |
588 | } | |
589 | ||
d20dc149 | 590 | static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode) |
8a0662d9 RW |
591 | { |
592 | return NULL; | |
593 | } | |
594 | ||
f42b0e18 RH |
595 | static inline bool of_node_name_eq(const struct device_node *np, const char *name) |
596 | { | |
597 | return false; | |
598 | } | |
599 | ||
600 | static inline bool of_node_name_prefix(const struct device_node *np, const char *prefix) | |
601 | { | |
602 | return false; | |
603 | } | |
604 | ||
4c358e15 | 605 | static inline const char* of_node_full_name(const struct device_node *np) |
74a7f084 GL |
606 | { |
607 | return "<no-node>"; | |
608 | } | |
609 | ||
1cc44f43 PU |
610 | static inline struct device_node *of_find_node_by_name(struct device_node *from, |
611 | const char *name) | |
612 | { | |
613 | return NULL; | |
614 | } | |
615 | ||
662372e4 RH |
616 | static inline struct device_node *of_find_node_by_type(struct device_node *from, |
617 | const char *type) | |
066ec1dd AS |
618 | { |
619 | return NULL; | |
620 | } | |
621 | ||
662372e4 RH |
622 | static inline struct device_node *of_find_matching_node_and_match( |
623 | struct device_node *from, | |
624 | const struct of_device_id *matches, | |
625 | const struct of_device_id **match) | |
3bcbaf6e | 626 | { |
662372e4 | 627 | return NULL; |
3bcbaf6e SAS |
628 | } |
629 | ||
20cd477c AS |
630 | static inline struct device_node *of_find_node_by_path(const char *path) |
631 | { | |
632 | return NULL; | |
633 | } | |
634 | ||
75c28c09 LL |
635 | static inline struct device_node *of_find_node_opts_by_path(const char *path, |
636 | const char **opts) | |
637 | { | |
638 | return NULL; | |
639 | } | |
640 | ||
ce16b9d2 SA |
641 | static inline struct device_node *of_find_node_by_phandle(phandle handle) |
642 | { | |
643 | return NULL; | |
644 | } | |
645 | ||
662372e4 | 646 | static inline struct device_node *of_get_parent(const struct device_node *node) |
00b2c76a | 647 | { |
662372e4 | 648 | return NULL; |
00b2c76a DH |
649 | } |
650 | ||
943c8a80 RD |
651 | static inline struct device_node *of_get_next_parent(struct device_node *node) |
652 | { | |
653 | return NULL; | |
654 | } | |
655 | ||
662372e4 RH |
656 | static inline struct device_node *of_get_next_child( |
657 | const struct device_node *node, struct device_node *prev) | |
658 | { | |
659 | return NULL; | |
660 | } | |
aba3dfff | 661 | |
662372e4 RH |
662 | static inline struct device_node *of_get_next_available_child( |
663 | const struct device_node *node, struct device_node *prev) | |
664 | { | |
665 | return NULL; | |
666 | } | |
f6f0747e | 667 | |
662372e4 RH |
668 | static inline struct device_node *of_find_node_with_property( |
669 | struct device_node *from, const char *prop_name) | |
25c040c9 OJ |
670 | { |
671 | return NULL; | |
672 | } | |
673 | ||
67831837 SA |
674 | #define of_fwnode_handle(node) NULL |
675 | ||
662372e4 | 676 | static inline bool of_have_populated_dt(void) |
183f1d0c | 677 | { |
662372e4 | 678 | return false; |
183f1d0c DA |
679 | } |
680 | ||
36156f92 JH |
681 | static inline struct device_node *of_get_compatible_child(const struct device_node *parent, |
682 | const char *compatible) | |
683 | { | |
684 | return NULL; | |
685 | } | |
686 | ||
662372e4 RH |
687 | static inline struct device_node *of_get_child_by_name( |
688 | const struct device_node *node, | |
689 | const char *name) | |
954e04b9 | 690 | { |
662372e4 | 691 | return NULL; |
954e04b9 BW |
692 | } |
693 | ||
36a0904e RN |
694 | static inline int of_device_is_compatible(const struct device_node *device, |
695 | const char *name) | |
696 | { | |
697 | return 0; | |
698 | } | |
699 | ||
3bc16307 GU |
700 | static inline int of_device_compatible_match(struct device_node *device, |
701 | const char *const *compat) | |
702 | { | |
703 | return 0; | |
704 | } | |
705 | ||
53a4ab96 | 706 | static inline bool of_device_is_available(const struct device_node *device) |
d7195696 | 707 | { |
53a4ab96 | 708 | return false; |
d7195696 RH |
709 | } |
710 | ||
37786c7f KC |
711 | static inline bool of_device_is_big_endian(const struct device_node *device) |
712 | { | |
713 | return false; | |
d7195696 RH |
714 | } |
715 | ||
aba3dfff SW |
716 | static inline struct property *of_find_property(const struct device_node *np, |
717 | const char *name, | |
718 | int *lenp) | |
719 | { | |
720 | return NULL; | |
721 | } | |
722 | ||
2261cc62 SG |
723 | static inline struct device_node *of_find_compatible_node( |
724 | struct device_node *from, | |
725 | const char *type, | |
726 | const char *compat) | |
727 | { | |
728 | return NULL; | |
729 | } | |
730 | ||
ad54a0cf HS |
731 | static inline int of_property_count_elems_of_size(const struct device_node *np, |
732 | const char *propname, int elem_size) | |
733 | { | |
734 | return -ENOSYS; | |
735 | } | |
736 | ||
be193249 VK |
737 | static inline int of_property_read_u8_array(const struct device_node *np, |
738 | const char *propname, u8 *out_values, size_t sz) | |
739 | { | |
740 | return -ENOSYS; | |
741 | } | |
742 | ||
743 | static inline int of_property_read_u16_array(const struct device_node *np, | |
744 | const char *propname, u16 *out_values, size_t sz) | |
745 | { | |
746 | return -ENOSYS; | |
747 | } | |
748 | ||
b98c0239 | 749 | static inline int of_property_read_u32_array(const struct device_node *np, |
aac285c6 JI |
750 | const char *propname, |
751 | u32 *out_values, size_t sz) | |
b98c0239 SG |
752 | { |
753 | return -ENOSYS; | |
754 | } | |
755 | ||
b31384fa RW |
756 | static inline int of_property_read_u64_array(const struct device_node *np, |
757 | const char *propname, | |
758 | u64 *out_values, size_t sz) | |
759 | { | |
760 | return -ENOSYS; | |
761 | } | |
762 | ||
96c623e5 AB |
763 | static inline int of_property_read_u32_index(const struct device_node *np, |
764 | const char *propname, u32 index, u32 *out_value) | |
b98c0239 SG |
765 | { |
766 | return -ENOSYS; | |
767 | } | |
768 | ||
96c623e5 AB |
769 | static inline int of_property_read_u64_index(const struct device_node *np, |
770 | const char *propname, u32 index, u64 *out_value) | |
4fcd15a0 BC |
771 | { |
772 | return -ENOSYS; | |
773 | } | |
774 | ||
89272b8c SW |
775 | static inline const void *of_get_property(const struct device_node *node, |
776 | const char *name, | |
777 | int *lenp) | |
778 | { | |
779 | return NULL; | |
780 | } | |
781 | ||
183912d3 SK |
782 | static inline struct device_node *of_get_cpu_node(int cpu, |
783 | unsigned int *thread) | |
784 | { | |
785 | return NULL; | |
786 | } | |
787 | ||
f1f207e4 RH |
788 | static inline struct device_node *of_get_next_cpu_node(struct device_node *prev) |
789 | { | |
790 | return NULL; | |
791 | } | |
792 | ||
b9f8c26a UH |
793 | static inline struct device_node *of_get_cpu_state_node(struct device_node *cpu_node, |
794 | int index) | |
795 | { | |
796 | return NULL; | |
797 | } | |
798 | ||
8a1ac5dc AB |
799 | static inline int of_n_addr_cells(struct device_node *np) |
800 | { | |
801 | return 0; | |
802 | ||
803 | } | |
804 | static inline int of_n_size_cells(struct device_node *np) | |
805 | { | |
806 | return 0; | |
807 | } | |
808 | ||
96c623e5 AB |
809 | static inline int of_property_read_variable_u8_array(const struct device_node *np, |
810 | const char *propname, u8 *out_values, | |
811 | size_t sz_min, size_t sz_max) | |
812 | { | |
813 | return -ENOSYS; | |
814 | } | |
815 | ||
816 | static inline int of_property_read_variable_u16_array(const struct device_node *np, | |
817 | const char *propname, u16 *out_values, | |
818 | size_t sz_min, size_t sz_max) | |
819 | { | |
820 | return -ENOSYS; | |
821 | } | |
822 | ||
823 | static inline int of_property_read_variable_u32_array(const struct device_node *np, | |
824 | const char *propname, | |
825 | u32 *out_values, | |
826 | size_t sz_min, | |
827 | size_t sz_max) | |
828 | { | |
829 | return -ENOSYS; | |
830 | } | |
831 | ||
4cd7f7a3 JI |
832 | static inline int of_property_read_u64(const struct device_node *np, |
833 | const char *propname, u64 *out_value) | |
834 | { | |
835 | return -ENOSYS; | |
836 | } | |
837 | ||
96c623e5 AB |
838 | static inline int of_property_read_variable_u64_array(const struct device_node *np, |
839 | const char *propname, | |
840 | u64 *out_values, | |
841 | size_t sz_min, | |
842 | size_t sz_max) | |
843 | { | |
844 | return -ENOSYS; | |
845 | } | |
846 | ||
847 | static inline int of_property_read_string(const struct device_node *np, | |
848 | const char *propname, | |
849 | const char **out_string) | |
850 | { | |
851 | return -ENOSYS; | |
852 | } | |
853 | ||
fe99c707 | 854 | static inline int of_property_match_string(const struct device_node *np, |
bd3d5500 TR |
855 | const char *propname, |
856 | const char *string) | |
857 | { | |
858 | return -ENOSYS; | |
859 | } | |
860 | ||
96c623e5 AB |
861 | static inline int of_property_read_string_helper(const struct device_node *np, |
862 | const char *propname, | |
863 | const char **out_strs, size_t sz, int index) | |
864 | { | |
865 | return -ENOSYS; | |
866 | } | |
867 | ||
b8fbdc42 | 868 | static inline struct device_node *of_parse_phandle(const struct device_node *np, |
36a0904e RN |
869 | const char *phandle_name, |
870 | int index) | |
871 | { | |
872 | return NULL; | |
873 | } | |
874 | ||
e93aeeae | 875 | static inline int of_parse_phandle_with_args(const struct device_node *np, |
e05e5070 TR |
876 | const char *list_name, |
877 | const char *cells_name, | |
878 | int index, | |
879 | struct of_phandle_args *out_args) | |
880 | { | |
881 | return -ENOSYS; | |
882 | } | |
883 | ||
bd6f2fd5 SB |
884 | static inline int of_parse_phandle_with_args_map(const struct device_node *np, |
885 | const char *list_name, | |
886 | const char *stem_name, | |
887 | int index, | |
888 | struct of_phandle_args *out_args) | |
889 | { | |
890 | return -ENOSYS; | |
891 | } | |
892 | ||
035fd948 SW |
893 | static inline int of_parse_phandle_with_fixed_args(const struct device_node *np, |
894 | const char *list_name, int cells_count, int index, | |
895 | struct of_phandle_args *out_args) | |
896 | { | |
897 | return -ENOSYS; | |
898 | } | |
899 | ||
a065d561 | 900 | static inline int of_count_phandle_with_args(const struct device_node *np, |
bd69f73f GL |
901 | const char *list_name, |
902 | const char *cells_name) | |
903 | { | |
904 | return -ENOSYS; | |
905 | } | |
906 | ||
74e1fbb1 JR |
907 | static inline int of_phandle_iterator_init(struct of_phandle_iterator *it, |
908 | const struct device_node *np, | |
909 | const char *list_name, | |
910 | const char *cells_name, | |
911 | int cell_count) | |
912 | { | |
913 | return -ENOSYS; | |
914 | } | |
915 | ||
cd209b41 JR |
916 | static inline int of_phandle_iterator_next(struct of_phandle_iterator *it) |
917 | { | |
918 | return -ENOSYS; | |
919 | } | |
920 | ||
abdaa77b JR |
921 | static inline int of_phandle_iterator_args(struct of_phandle_iterator *it, |
922 | uint32_t *args, | |
923 | int size) | |
924 | { | |
925 | return 0; | |
926 | } | |
927 | ||
ed5f886d NF |
928 | static inline int of_alias_get_id(struct device_node *np, const char *stem) |
929 | { | |
930 | return -ENOSYS; | |
931 | } | |
932 | ||
351d224f WS |
933 | static inline int of_alias_get_highest_id(const char *stem) |
934 | { | |
935 | return -ENOSYS; | |
936 | } | |
937 | ||
b1078c35 MS |
938 | static inline int of_alias_get_alias_list(const struct of_device_id *matches, |
939 | const char *stem, unsigned long *bitmap, | |
940 | unsigned int nbits) | |
941 | { | |
942 | return -ENOSYS; | |
943 | } | |
944 | ||
50e07f88 SW |
945 | static inline int of_machine_is_compatible(const char *compat) |
946 | { | |
947 | return 0; | |
948 | } | |
949 | ||
fe794e39 WC |
950 | static inline int of_add_property(struct device_node *np, struct property *prop) |
951 | { | |
952 | return 0; | |
953 | } | |
954 | ||
0f7c5317 FF |
955 | static inline int of_remove_property(struct device_node *np, struct property *prop) |
956 | { | |
957 | return 0; | |
958 | } | |
959 | ||
3482f2c5 | 960 | static inline bool of_console_check(const struct device_node *dn, const char *name, int index) |
5c19e952 | 961 | { |
3482f2c5 | 962 | return false; |
5c19e952 SH |
963 | } |
964 | ||
2adfffa2 SAS |
965 | static inline const __be32 *of_prop_next_u32(struct property *prop, |
966 | const __be32 *cur, u32 *pu) | |
967 | { | |
968 | return NULL; | |
969 | } | |
970 | ||
971 | static inline const char *of_prop_next_string(struct property *prop, | |
972 | const char *cur) | |
973 | { | |
974 | return NULL; | |
975 | } | |
976 | ||
0384e8c6 PA |
977 | static inline int of_node_check_flag(struct device_node *n, unsigned long flag) |
978 | { | |
979 | return 0; | |
980 | } | |
981 | ||
982 | static inline int of_node_test_and_set_flag(struct device_node *n, | |
983 | unsigned long flag) | |
984 | { | |
985 | return 0; | |
986 | } | |
987 | ||
988 | static inline void of_node_set_flag(struct device_node *n, unsigned long flag) | |
989 | { | |
990 | } | |
991 | ||
992 | static inline void of_node_clear_flag(struct device_node *n, unsigned long flag) | |
993 | { | |
994 | } | |
995 | ||
996 | static inline int of_property_check_flag(struct property *p, unsigned long flag) | |
997 | { | |
998 | return 0; | |
999 | } | |
1000 | ||
1001 | static inline void of_property_set_flag(struct property *p, unsigned long flag) | |
1002 | { | |
1003 | } | |
1004 | ||
1005 | static inline void of_property_clear_flag(struct property *p, unsigned long flag) | |
1006 | { | |
1007 | } | |
1008 | ||
a0e71cd9 SP |
1009 | static inline int of_cpu_node_to_id(struct device_node *np) |
1010 | { | |
1011 | return -ENODEV; | |
1012 | } | |
1013 | ||
746a71d0 | 1014 | static inline int of_map_id(struct device_node *np, u32 id, |
2a6db719 NG |
1015 | const char *map_name, const char *map_mask_name, |
1016 | struct device_node **target, u32 *id_out) | |
1017 | { | |
1018 | return -EINVAL; | |
1019 | } | |
1020 | ||
964db79d NSJ |
1021 | static inline phys_addr_t of_dma_get_max_cpu_address(struct device_node *np) |
1022 | { | |
1023 | return PHYS_ADDR_MAX; | |
1024 | } | |
1025 | ||
3a1e362e | 1026 | #define of_match_ptr(_ptr) NULL |
5762c205 | 1027 | #define of_match_node(_matches, _node) NULL |
9dfbf207 | 1028 | #endif /* CONFIG_OF */ |
b98c0239 | 1029 | |
613e9721 AT |
1030 | /* Default string compare functions, Allow arch asm/prom.h to override */ |
1031 | #if !defined(of_compat_cmp) | |
1032 | #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2)) | |
1033 | #define of_prop_cmp(s1, s2) strcmp((s1), (s2)) | |
1034 | #define of_node_cmp(s1, s2) strcasecmp((s1), (s2)) | |
1035 | #endif | |
1036 | ||
6f751188 FR |
1037 | static inline int of_prop_val_eq(struct property *p1, struct property *p2) |
1038 | { | |
1039 | return p1->length == p2->length && | |
1040 | !memcmp(p1->value, p2->value, (size_t)p1->length); | |
1041 | } | |
1042 | ||
0c3f061c RH |
1043 | #if defined(CONFIG_OF) && defined(CONFIG_NUMA) |
1044 | extern int of_node_to_nid(struct device_node *np); | |
1045 | #else | |
c8fff7bc KK |
1046 | static inline int of_node_to_nid(struct device_node *device) |
1047 | { | |
1048 | return NUMA_NO_NODE; | |
1049 | } | |
5ca4db61 PM |
1050 | #endif |
1051 | ||
298535c0 DD |
1052 | #ifdef CONFIG_OF_NUMA |
1053 | extern int of_numa_init(void); | |
1054 | #else | |
1055 | static inline int of_numa_init(void) | |
1056 | { | |
1057 | return -ENOSYS; | |
1058 | } | |
1059 | #endif | |
1060 | ||
662372e4 RH |
1061 | static inline struct device_node *of_find_matching_node( |
1062 | struct device_node *from, | |
1063 | const struct of_device_id *matches) | |
1064 | { | |
1065 | return of_find_matching_node_and_match(from, matches, NULL); | |
1066 | } | |
1067 | ||
0413beda RH |
1068 | static inline const char *of_node_get_device_type(const struct device_node *np) |
1069 | { | |
5d5a0ab1 | 1070 | return of_get_property(np, "device_type", NULL); |
0413beda RH |
1071 | } |
1072 | ||
1073 | static inline bool of_node_is_type(const struct device_node *np, const char *type) | |
1074 | { | |
1075 | const char *match = of_node_get_device_type(np); | |
1076 | ||
1077 | return np && match && type && !strcmp(match, type); | |
1078 | } | |
1079 | ||
ad54a0cf HS |
1080 | /** |
1081 | * of_property_count_u8_elems - Count the number of u8 elements in a property | |
1082 | * | |
1083 | * @np: device node from which the property value is to be read. | |
1084 | * @propname: name of the property to be searched. | |
1085 | * | |
1086 | * Search for a property in a device node and count the number of u8 elements | |
8c8239c2 RH |
1087 | * in it. |
1088 | * | |
1089 | * Return: The number of elements on sucess, -EINVAL if the property does | |
ad54a0cf HS |
1090 | * not exist or its length does not match a multiple of u8 and -ENODATA if the |
1091 | * property does not have a value. | |
1092 | */ | |
1093 | static inline int of_property_count_u8_elems(const struct device_node *np, | |
1094 | const char *propname) | |
1095 | { | |
1096 | return of_property_count_elems_of_size(np, propname, sizeof(u8)); | |
1097 | } | |
1098 | ||
1099 | /** | |
1100 | * of_property_count_u16_elems - Count the number of u16 elements in a property | |
1101 | * | |
1102 | * @np: device node from which the property value is to be read. | |
1103 | * @propname: name of the property to be searched. | |
1104 | * | |
1105 | * Search for a property in a device node and count the number of u16 elements | |
8c8239c2 RH |
1106 | * in it. |
1107 | * | |
1108 | * Return: The number of elements on sucess, -EINVAL if the property does | |
ad54a0cf HS |
1109 | * not exist or its length does not match a multiple of u16 and -ENODATA if the |
1110 | * property does not have a value. | |
1111 | */ | |
1112 | static inline int of_property_count_u16_elems(const struct device_node *np, | |
1113 | const char *propname) | |
1114 | { | |
1115 | return of_property_count_elems_of_size(np, propname, sizeof(u16)); | |
1116 | } | |
1117 | ||
1118 | /** | |
1119 | * of_property_count_u32_elems - Count the number of u32 elements in a property | |
1120 | * | |
1121 | * @np: device node from which the property value is to be read. | |
1122 | * @propname: name of the property to be searched. | |
1123 | * | |
1124 | * Search for a property in a device node and count the number of u32 elements | |
8c8239c2 RH |
1125 | * in it. |
1126 | * | |
1127 | * Return: The number of elements on sucess, -EINVAL if the property does | |
ad54a0cf HS |
1128 | * not exist or its length does not match a multiple of u32 and -ENODATA if the |
1129 | * property does not have a value. | |
1130 | */ | |
1131 | static inline int of_property_count_u32_elems(const struct device_node *np, | |
1132 | const char *propname) | |
1133 | { | |
1134 | return of_property_count_elems_of_size(np, propname, sizeof(u32)); | |
1135 | } | |
1136 | ||
1137 | /** | |
1138 | * of_property_count_u64_elems - Count the number of u64 elements in a property | |
1139 | * | |
1140 | * @np: device node from which the property value is to be read. | |
1141 | * @propname: name of the property to be searched. | |
1142 | * | |
1143 | * Search for a property in a device node and count the number of u64 elements | |
8c8239c2 RH |
1144 | * in it. |
1145 | * | |
1146 | * Return: The number of elements on sucess, -EINVAL if the property does | |
ad54a0cf HS |
1147 | * not exist or its length does not match a multiple of u64 and -ENODATA if the |
1148 | * property does not have a value. | |
1149 | */ | |
1150 | static inline int of_property_count_u64_elems(const struct device_node *np, | |
1151 | const char *propname) | |
1152 | { | |
1153 | return of_property_count_elems_of_size(np, propname, sizeof(u64)); | |
1154 | } | |
1155 | ||
a87fa1d8 GL |
1156 | /** |
1157 | * of_property_read_string_array() - Read an array of strings from a multiple | |
1158 | * strings property. | |
1159 | * @np: device node from which the property value is to be read. | |
1160 | * @propname: name of the property to be searched. | |
1161 | * @out_strs: output array of string pointers. | |
1162 | * @sz: number of array elements to read. | |
1163 | * | |
1164 | * Search for a property in a device tree node and retrieve a list of | |
1165 | * terminated string values (pointer to data, not a copy) in that property. | |
1166 | * | |
8c8239c2 | 1167 | * Return: If @out_strs is NULL, the number of strings in the property is returned. |
a87fa1d8 | 1168 | */ |
fe99c707 | 1169 | static inline int of_property_read_string_array(const struct device_node *np, |
a87fa1d8 GL |
1170 | const char *propname, const char **out_strs, |
1171 | size_t sz) | |
1172 | { | |
1173 | return of_property_read_string_helper(np, propname, out_strs, sz, 0); | |
1174 | } | |
1175 | ||
1176 | /** | |
1177 | * of_property_count_strings() - Find and return the number of strings from a | |
1178 | * multiple strings property. | |
1179 | * @np: device node from which the property value is to be read. | |
1180 | * @propname: name of the property to be searched. | |
1181 | * | |
1182 | * Search for a property in a device tree node and retrieve the number of null | |
8c8239c2 RH |
1183 | * terminated string contain in it. |
1184 | * | |
1185 | * Return: The number of strings on success, -EINVAL if the property does not | |
1186 | * exist, -ENODATA if property does not have a value, and -EILSEQ if the string | |
1187 | * is not null-terminated within the length of the property data. | |
a87fa1d8 | 1188 | */ |
fe99c707 | 1189 | static inline int of_property_count_strings(const struct device_node *np, |
a87fa1d8 GL |
1190 | const char *propname) |
1191 | { | |
1192 | return of_property_read_string_helper(np, propname, NULL, 0, 0); | |
1193 | } | |
1194 | ||
1195 | /** | |
1196 | * of_property_read_string_index() - Find and read a string from a multiple | |
1197 | * strings property. | |
1198 | * @np: device node from which the property value is to be read. | |
1199 | * @propname: name of the property to be searched. | |
1200 | * @index: index of the string in the list of strings | |
c968b89a | 1201 | * @output: pointer to null terminated return string, modified only if |
a87fa1d8 GL |
1202 | * return value is 0. |
1203 | * | |
1204 | * Search for a property in a device tree node and retrieve a null | |
1205 | * terminated string value (pointer to data, not a copy) in the list of strings | |
1206 | * contained in that property. | |
8c8239c2 RH |
1207 | * |
1208 | * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if | |
a87fa1d8 GL |
1209 | * property does not have a value, and -EILSEQ if the string is not |
1210 | * null-terminated within the length of the property data. | |
1211 | * | |
1212 | * The out_string pointer is modified only if a valid string can be decoded. | |
1213 | */ | |
fe99c707 | 1214 | static inline int of_property_read_string_index(const struct device_node *np, |
a87fa1d8 GL |
1215 | const char *propname, |
1216 | int index, const char **output) | |
1217 | { | |
1218 | int rc = of_property_read_string_helper(np, propname, output, 1, index); | |
1219 | return rc < 0 ? rc : 0; | |
1220 | } | |
1221 | ||
fa4d34cc | 1222 | /** |
f1765a18 | 1223 | * of_property_read_bool - Find a property |
fa4d34cc JCPV |
1224 | * @np: device node from which the property value is to be read. |
1225 | * @propname: name of the property to be searched. | |
1226 | * | |
1227 | * Search for a property in a device node. | |
8c8239c2 RH |
1228 | * |
1229 | * Return: true if the property exists false otherwise. | |
fa4d34cc JCPV |
1230 | */ |
1231 | static inline bool of_property_read_bool(const struct device_node *np, | |
1232 | const char *propname) | |
1233 | { | |
1234 | struct property *prop = of_find_property(np, propname, NULL); | |
1235 | ||
1236 | return prop ? true : false; | |
1237 | } | |
1238 | ||
be193249 VK |
1239 | static inline int of_property_read_u8(const struct device_node *np, |
1240 | const char *propname, | |
1241 | u8 *out_value) | |
1242 | { | |
1243 | return of_property_read_u8_array(np, propname, out_value, 1); | |
1244 | } | |
1245 | ||
1246 | static inline int of_property_read_u16(const struct device_node *np, | |
1247 | const char *propname, | |
1248 | u16 *out_value) | |
1249 | { | |
1250 | return of_property_read_u16_array(np, propname, out_value, 1); | |
1251 | } | |
1252 | ||
b98c0239 | 1253 | static inline int of_property_read_u32(const struct device_node *np, |
aac285c6 | 1254 | const char *propname, |
b98c0239 SG |
1255 | u32 *out_value) |
1256 | { | |
1257 | return of_property_read_u32_array(np, propname, out_value, 1); | |
1258 | } | |
1259 | ||
e7a00e42 SR |
1260 | static inline int of_property_read_s32(const struct device_node *np, |
1261 | const char *propname, | |
1262 | s32 *out_value) | |
1263 | { | |
1264 | return of_property_read_u32(np, propname, (u32*) out_value); | |
1265 | } | |
1266 | ||
f623ce95 JR |
1267 | #define of_for_each_phandle(it, err, np, ln, cn, cc) \ |
1268 | for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \ | |
1269 | err = of_phandle_iterator_next(it); \ | |
1270 | err == 0; \ | |
1271 | err = of_phandle_iterator_next(it)) | |
1272 | ||
2adfffa2 SAS |
1273 | #define of_property_for_each_u32(np, propname, prop, p, u) \ |
1274 | for (prop = of_find_property(np, propname, NULL), \ | |
1275 | p = of_prop_next_u32(prop, NULL, &u); \ | |
1276 | p; \ | |
1277 | p = of_prop_next_u32(prop, p, &u)) | |
1278 | ||
1279 | #define of_property_for_each_string(np, propname, prop, s) \ | |
1280 | for (prop = of_find_property(np, propname, NULL), \ | |
1281 | s = of_prop_next_string(prop, NULL); \ | |
1282 | s; \ | |
1283 | s = of_prop_next_string(prop, s)) | |
1284 | ||
662372e4 RH |
1285 | #define for_each_node_by_name(dn, name) \ |
1286 | for (dn = of_find_node_by_name(NULL, name); dn; \ | |
1287 | dn = of_find_node_by_name(dn, name)) | |
1288 | #define for_each_node_by_type(dn, type) \ | |
1289 | for (dn = of_find_node_by_type(NULL, type); dn; \ | |
1290 | dn = of_find_node_by_type(dn, type)) | |
1291 | #define for_each_compatible_node(dn, type, compatible) \ | |
1292 | for (dn = of_find_compatible_node(NULL, type, compatible); dn; \ | |
1293 | dn = of_find_compatible_node(dn, type, compatible)) | |
1294 | #define for_each_matching_node(dn, matches) \ | |
1295 | for (dn = of_find_matching_node(NULL, matches); dn; \ | |
1296 | dn = of_find_matching_node(dn, matches)) | |
1297 | #define for_each_matching_node_and_match(dn, matches, match) \ | |
1298 | for (dn = of_find_matching_node_and_match(NULL, matches, match); \ | |
1299 | dn; dn = of_find_matching_node_and_match(dn, matches, match)) | |
1300 | ||
1301 | #define for_each_child_of_node(parent, child) \ | |
1302 | for (child = of_get_next_child(parent, NULL); child != NULL; \ | |
1303 | child = of_get_next_child(parent, child)) | |
1304 | #define for_each_available_child_of_node(parent, child) \ | |
1305 | for (child = of_get_next_available_child(parent, NULL); child != NULL; \ | |
1306 | child = of_get_next_available_child(parent, child)) | |
1307 | ||
f1f207e4 RH |
1308 | #define for_each_of_cpu_node(cpu) \ |
1309 | for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \ | |
1310 | cpu = of_get_next_cpu_node(cpu)) | |
1311 | ||
662372e4 RH |
1312 | #define for_each_node_with_property(dn, prop_name) \ |
1313 | for (dn = of_find_node_with_property(NULL, prop_name); dn; \ | |
1314 | dn = of_find_node_with_property(dn, prop_name)) | |
1315 | ||
1316 | static inline int of_get_child_count(const struct device_node *np) | |
1317 | { | |
1318 | struct device_node *child; | |
1319 | int num = 0; | |
1320 | ||
1321 | for_each_child_of_node(np, child) | |
1322 | num++; | |
1323 | ||
1324 | return num; | |
1325 | } | |
1326 | ||
1327 | static inline int of_get_available_child_count(const struct device_node *np) | |
1328 | { | |
1329 | struct device_node *child; | |
1330 | int num = 0; | |
1331 | ||
1332 | for_each_available_child_of_node(np, child) | |
1333 | num++; | |
1334 | ||
1335 | return num; | |
1336 | } | |
1337 | ||
67a066b3 DO |
1338 | #define _OF_DECLARE_STUB(table, name, compat, fn, fn_type) \ |
1339 | static const struct of_device_id __of_table_##name \ | |
1340 | __attribute__((unused)) \ | |
1341 | = { .compatible = compat, \ | |
1342 | .data = (fn == (fn_type)NULL) ? fn : fn } | |
1343 | ||
71f50c6d | 1344 | #if defined(CONFIG_OF) && !defined(MODULE) |
54196ccb RH |
1345 | #define _OF_DECLARE(table, name, compat, fn, fn_type) \ |
1346 | static const struct of_device_id __of_table_##name \ | |
33def849 | 1347 | __used __section("__" #table "_of_table") \ |
5812b32e | 1348 | __aligned(__alignof__(struct of_device_id)) \ |
54196ccb RH |
1349 | = { .compatible = compat, \ |
1350 | .data = (fn == (fn_type)NULL) ? fn : fn } | |
1351 | #else | |
5f563585 | 1352 | #define _OF_DECLARE(table, name, compat, fn, fn_type) \ |
67a066b3 | 1353 | _OF_DECLARE_STUB(table, name, compat, fn, fn_type) |
54196ccb RH |
1354 | #endif |
1355 | ||
1356 | typedef int (*of_init_fn_2)(struct device_node *, struct device_node *); | |
c35d9292 | 1357 | typedef int (*of_init_fn_1_ret)(struct device_node *); |
54196ccb RH |
1358 | typedef void (*of_init_fn_1)(struct device_node *); |
1359 | ||
1360 | #define OF_DECLARE_1(table, name, compat, fn) \ | |
1361 | _OF_DECLARE(table, name, compat, fn, of_init_fn_1) | |
c35d9292 DL |
1362 | #define OF_DECLARE_1_RET(table, name, compat, fn) \ |
1363 | _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret) | |
54196ccb RH |
1364 | #define OF_DECLARE_2(table, name, compat, fn) \ |
1365 | _OF_DECLARE(table, name, compat, fn, of_init_fn_2) | |
1366 | ||
201c910b PA |
1367 | /** |
1368 | * struct of_changeset_entry - Holds a changeset entry | |
1369 | * | |
1370 | * @node: list_head for the log list | |
1371 | * @action: notifier action | |
1372 | * @np: pointer to the device node affected | |
1373 | * @prop: pointer to the property affected | |
1374 | * @old_prop: hold a pointer to the original property | |
1375 | * | |
1376 | * Every modification of the device tree during a changeset | |
1377 | * is held in a list of of_changeset_entry structures. | |
1378 | * That way we can recover from a partial application, or we can | |
1379 | * revert the changeset | |
1380 | */ | |
1381 | struct of_changeset_entry { | |
1382 | struct list_head node; | |
1383 | unsigned long action; | |
1384 | struct device_node *np; | |
1385 | struct property *prop; | |
1386 | struct property *old_prop; | |
1387 | }; | |
1388 | ||
1389 | /** | |
1390 | * struct of_changeset - changeset tracker structure | |
1391 | * | |
1392 | * @entries: list_head for the changeset entries | |
1393 | * | |
1394 | * changesets are a convenient way to apply bulk changes to the | |
1395 | * live tree. In case of an error, changes are rolled-back. | |
1396 | * changesets live on after initial application, and if not | |
1397 | * destroyed after use, they can be reverted in one single call. | |
1398 | */ | |
1399 | struct of_changeset { | |
1400 | struct list_head entries; | |
1401 | }; | |
1402 | ||
b53a2340 PA |
1403 | enum of_reconfig_change { |
1404 | OF_RECONFIG_NO_CHANGE = 0, | |
1405 | OF_RECONFIG_CHANGE_ADD, | |
1406 | OF_RECONFIG_CHANGE_REMOVE, | |
1407 | }; | |
1408 | ||
201c910b | 1409 | #ifdef CONFIG_OF_DYNAMIC |
f6892d19 GL |
1410 | extern int of_reconfig_notifier_register(struct notifier_block *); |
1411 | extern int of_reconfig_notifier_unregister(struct notifier_block *); | |
f5242e5a GL |
1412 | extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd); |
1413 | extern int of_reconfig_get_state_change(unsigned long action, | |
1414 | struct of_reconfig_data *arg); | |
f6892d19 | 1415 | |
201c910b PA |
1416 | extern void of_changeset_init(struct of_changeset *ocs); |
1417 | extern void of_changeset_destroy(struct of_changeset *ocs); | |
1418 | extern int of_changeset_apply(struct of_changeset *ocs); | |
1419 | extern int of_changeset_revert(struct of_changeset *ocs); | |
1420 | extern int of_changeset_action(struct of_changeset *ocs, | |
1421 | unsigned long action, struct device_node *np, | |
1422 | struct property *prop); | |
1423 | ||
1424 | static inline int of_changeset_attach_node(struct of_changeset *ocs, | |
1425 | struct device_node *np) | |
1426 | { | |
1427 | return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL); | |
1428 | } | |
1429 | ||
1430 | static inline int of_changeset_detach_node(struct of_changeset *ocs, | |
1431 | struct device_node *np) | |
1432 | { | |
1433 | return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL); | |
1434 | } | |
1435 | ||
1436 | static inline int of_changeset_add_property(struct of_changeset *ocs, | |
1437 | struct device_node *np, struct property *prop) | |
1438 | { | |
1439 | return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop); | |
1440 | } | |
1441 | ||
1442 | static inline int of_changeset_remove_property(struct of_changeset *ocs, | |
1443 | struct device_node *np, struct property *prop) | |
1444 | { | |
1445 | return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop); | |
1446 | } | |
1447 | ||
1448 | static inline int of_changeset_update_property(struct of_changeset *ocs, | |
1449 | struct device_node *np, struct property *prop) | |
1450 | { | |
1451 | return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop); | |
1452 | } | |
f6892d19 GL |
1453 | #else /* CONFIG_OF_DYNAMIC */ |
1454 | static inline int of_reconfig_notifier_register(struct notifier_block *nb) | |
1455 | { | |
1456 | return -EINVAL; | |
1457 | } | |
1458 | static inline int of_reconfig_notifier_unregister(struct notifier_block *nb) | |
1459 | { | |
1460 | return -EINVAL; | |
1461 | } | |
f5242e5a GL |
1462 | static inline int of_reconfig_notify(unsigned long action, |
1463 | struct of_reconfig_data *arg) | |
f6892d19 GL |
1464 | { |
1465 | return -EINVAL; | |
1466 | } | |
f5242e5a GL |
1467 | static inline int of_reconfig_get_state_change(unsigned long action, |
1468 | struct of_reconfig_data *arg) | |
f6892d19 GL |
1469 | { |
1470 | return -EINVAL; | |
1471 | } | |
1472 | #endif /* CONFIG_OF_DYNAMIC */ | |
201c910b | 1473 | |
a4b4e046 | 1474 | /** |
8f73110f | 1475 | * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node |
a4b4e046 RP |
1476 | * @np: Pointer to the given device_node |
1477 | * | |
8c8239c2 | 1478 | * Return: true if present false otherwise |
a4b4e046 | 1479 | */ |
8f73110f | 1480 | static inline bool of_device_is_system_power_controller(const struct device_node *np) |
a4b4e046 | 1481 | { |
8f73110f | 1482 | return of_property_read_bool(np, "system-power-controller"); |
a4b4e046 RP |
1483 | } |
1484 | ||
c968b89a | 1485 | /* |
7518b589 PA |
1486 | * Overlay support |
1487 | */ | |
1488 | ||
39a842e2 | 1489 | enum of_overlay_notify_action { |
24789c5c | 1490 | OF_OVERLAY_PRE_APPLY = 0, |
39a842e2 AT |
1491 | OF_OVERLAY_POST_APPLY, |
1492 | OF_OVERLAY_PRE_REMOVE, | |
1493 | OF_OVERLAY_POST_REMOVE, | |
1494 | }; | |
1495 | ||
1496 | struct of_overlay_notify_data { | |
1497 | struct device_node *overlay; | |
1498 | struct device_node *target; | |
1499 | }; | |
1500 | ||
7518b589 PA |
1501 | #ifdef CONFIG_OF_OVERLAY |
1502 | ||
39a751a4 FR |
1503 | int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size, |
1504 | int *ovcs_id); | |
24789c5c | 1505 | int of_overlay_remove(int *ovcs_id); |
0290c4ca | 1506 | int of_overlay_remove_all(void); |
7518b589 | 1507 | |
39a842e2 AT |
1508 | int of_overlay_notifier_register(struct notifier_block *nb); |
1509 | int of_overlay_notifier_unregister(struct notifier_block *nb); | |
1510 | ||
7518b589 PA |
1511 | #else |
1512 | ||
ecb0abc1 CP |
1513 | static inline int of_overlay_fdt_apply(void *overlay_fdt, u32 overlay_fdt_size, |
1514 | int *ovcs_id) | |
7518b589 PA |
1515 | { |
1516 | return -ENOTSUPP; | |
1517 | } | |
1518 | ||
24789c5c | 1519 | static inline int of_overlay_remove(int *ovcs_id) |
7518b589 PA |
1520 | { |
1521 | return -ENOTSUPP; | |
1522 | } | |
1523 | ||
0290c4ca | 1524 | static inline int of_overlay_remove_all(void) |
7518b589 PA |
1525 | { |
1526 | return -ENOTSUPP; | |
1527 | } | |
1528 | ||
39a842e2 AT |
1529 | static inline int of_overlay_notifier_register(struct notifier_block *nb) |
1530 | { | |
1531 | return 0; | |
1532 | } | |
1533 | ||
1534 | static inline int of_overlay_notifier_unregister(struct notifier_block *nb) | |
1535 | { | |
1536 | return 0; | |
1537 | } | |
1538 | ||
7518b589 PA |
1539 | #endif |
1540 | ||
76c1ce78 | 1541 | #endif /* _LINUX_OF_H */ |