1 /* SPDX-License-Identifier: GPL-2.0+ */
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.
13 */
14 #include <linux/types.h>
15 #include <linux/bitops.h>
16 #include <linux/cleanup.h>
17 #include <linux/errno.h>
18 #include <linux/kobject.h>
19 #include <linux/mod_devicetable.h>
20 #include <linux/property.h>
21 #include <linux/list.h>
22
23 #include <asm/byteorder.h>
24
25 typedef u32 phandle;
26 typedef u32 ihandle;
27
28 struct property {
29 char *name;
30 int length;
31 void *value;
32 struct property *next;
33 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC)
34 unsigned long _flags;
35 #endif
36 #if defined(CONFIG_OF_PROMTREE)
37 unsigned int unique_id;
38 #endif
39 #if defined(CONFIG_OF_KOBJ)
40 struct bin_attribute attr;
41 #endif
42 };
43
44 #if defined(CONFIG_SPARC)
45 struct of_irq_controller;
46 #endif
47
48 struct device_node {
49 const char *name;
50 phandle phandle;
51 const char *full_name;
52 struct fwnode_handle fwnode;
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 #if defined(CONFIG_OF_KOBJ)
60 struct kobject kobj;
61 #endif
62 unsigned long _flags;
63 void *data;
64 #if defined(CONFIG_SPARC)
65 unsigned int unique_id;
66 struct of_irq_controller *irq_trans;
67 #endif
68 };
69
70 #define MAX_PHANDLE_ARGS 16
71 struct of_phandle_args {
72 struct device_node *np;
73 int args_count;
74 uint32_t args[MAX_PHANDLE_ARGS];
75 };
76
77 struct of_phandle_iterator {
78 /* Common iterator information */
79 const char *cells_name;
80 int cell_count;
81 const struct device_node *parent;
82
83 /* List size information */
84 const __be32 *list_end;
85 const __be32 *phandle_end;
86
87 /* Current position state */
88 const __be32 *cur;
89 uint32_t cur_count;
90 phandle phandle;
91 struct device_node *node;
92 };
93
94 struct of_reconfig_data {
95 struct device_node *dn;
96 struct property *prop;
97 struct property *old_prop;
98 };
99
100 extern const struct kobj_type of_node_ktype;
101 extern const struct fwnode_operations of_fwnode_ops;
102
103 /**
104 * of_node_init - initialize a devicetree node
105 * @node: Pointer to device node that has been created by kzalloc()
106 *
107 * On return the device_node refcount is set to one. Use of_node_put()
108 * on @node when done to free the memory allocated for it. If the node
109 * is NOT a dynamic node the memory will not be freed. The decision of
110 * whether to free the memory will be done by node->release(), which is
111 * of_node_release().
112 */
of_node_init(struct device_node * node)113 static inline void of_node_init(struct device_node *node)
114 {
115 #if defined(CONFIG_OF_KOBJ)
116 kobject_init(&node->kobj, &of_node_ktype);
117 #endif
118 fwnode_init(&node->fwnode, &of_fwnode_ops);
119 }
120
121 #if defined(CONFIG_OF_KOBJ)
122 #define of_node_kobj(n) (&(n)->kobj)
123 #else
124 #define of_node_kobj(n) NULL
125 #endif
126
127 #ifdef CONFIG_OF_DYNAMIC
128 extern struct device_node *of_node_get(struct device_node *node);
129 extern void of_node_put(struct device_node *node);
130 #else /* CONFIG_OF_DYNAMIC */
131 /* Dummy ref counting routines - to be implemented later */
of_node_get(struct device_node * node)132 static inline struct device_node *of_node_get(struct device_node *node)
133 {
134 return node;
135 }
of_node_put(struct device_node * node)136 static inline void of_node_put(struct device_node *node) { }
137 #endif /* !CONFIG_OF_DYNAMIC */
138 DEFINE_FREE(device_node, struct device_node *, if (_T) of_node_put(_T))
139
140 /* Pointer for first entry in chain of all nodes. */
141 extern struct device_node *of_root;
142 extern struct device_node *of_chosen;
143 extern struct device_node *of_aliases;
144 extern struct device_node *of_stdout;
145
146 /*
147 * struct device_node flag descriptions
148 * (need to be visible even when !CONFIG_OF)
149 */
150 #define OF_DYNAMIC 1 /* (and properties) allocated via kmalloc */
151 #define OF_DETACHED 2 /* detached from the device tree */
152 #define OF_POPULATED 3 /* device already created */
153 #define OF_POPULATED_BUS 4 /* platform bus created for children */
154 #define OF_OVERLAY 5 /* allocated for an overlay */
155 #define OF_OVERLAY_FREE_CSET 6 /* in overlay cset being freed */
156
157 #define OF_BAD_ADDR ((u64)-1)
158
159 #ifdef CONFIG_OF
160 void of_core_init(void);
161
is_of_node(const struct fwnode_handle * fwnode)162 static inline bool is_of_node(const struct fwnode_handle *fwnode)
163 {
164 return !IS_ERR_OR_NULL(fwnode) && fwnode->ops == &of_fwnode_ops;
165 }
166
167 #define to_of_node(__fwnode) \
168 ({ \
169 typeof(__fwnode) __to_of_node_fwnode = (__fwnode); \
170 \
171 is_of_node(__to_of_node_fwnode) ? \
172 container_of(__to_of_node_fwnode, \
173 struct device_node, fwnode) : \
174 NULL; \
175 })
176
177 #define of_fwnode_handle(node) \
178 ({ \
179 typeof(node) __of_fwnode_handle_node = (node); \
180 \
181 __of_fwnode_handle_node ? \
182 &__of_fwnode_handle_node->fwnode : NULL; \
183 })
184
of_have_populated_dt(void)185 static inline bool of_have_populated_dt(void)
186 {
187 return of_root != NULL;
188 }
189
of_node_is_root(const struct device_node * node)190 static inline bool of_node_is_root(const struct device_node *node)
191 {
192 return node && (node->parent == NULL);
193 }
194
of_node_check_flag(const struct device_node * n,unsigned long flag)195 static inline int of_node_check_flag(const struct device_node *n, unsigned long flag)
196 {
197 return test_bit(flag, &n->_flags);
198 }
199
of_node_test_and_set_flag(struct device_node * n,unsigned long flag)200 static inline int of_node_test_and_set_flag(struct device_node *n,
201 unsigned long flag)
202 {
203 return test_and_set_bit(flag, &n->_flags);
204 }
205
of_node_set_flag(struct device_node * n,unsigned long flag)206 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
207 {
208 set_bit(flag, &n->_flags);
209 }
210
of_node_clear_flag(struct device_node * n,unsigned long flag)211 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
212 {
213 clear_bit(flag, &n->_flags);
214 }
215
216 #if defined(CONFIG_OF_DYNAMIC) || defined(CONFIG_SPARC)
of_property_check_flag(const struct property * p,unsigned long flag)217 static inline int of_property_check_flag(const struct property *p, unsigned long flag)
218 {
219 return test_bit(flag, &p->_flags);
220 }
221
of_property_set_flag(struct property * p,unsigned long flag)222 static inline void of_property_set_flag(struct property *p, unsigned long flag)
223 {
224 set_bit(flag, &p->_flags);
225 }
226
of_property_clear_flag(struct property * p,unsigned long flag)227 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
228 {
229 clear_bit(flag, &p->_flags);
230 }
231 #endif
232
233 extern struct device_node *__of_find_all_nodes(struct device_node *prev);
234 extern struct device_node *of_find_all_nodes(struct device_node *prev);
235
236 /*
237 * OF address retrieval & translation
238 */
239
240 /* Helper to read a big number; size is in cells (not bytes) */
of_read_number(const __be32 * cell,int size)241 static inline u64 of_read_number(const __be32 *cell, int size)
242 {
243 u64 r = 0;
244 for (; size--; cell++)
245 r = (r << 32) | be32_to_cpu(*cell);
246 return r;
247 }
248
249 /* Like of_read_number, but we want an unsigned long result */
of_read_ulong(const __be32 * cell,int size)250 static inline unsigned long of_read_ulong(const __be32 *cell, int size)
251 {
252 /* toss away upper bits if unsigned long is smaller than u64 */
253 return of_read_number(cell, size);
254 }
255
256 #if defined(CONFIG_SPARC)
257 #include <asm/prom.h>
258 #endif
259
260 #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
261 #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
262
263 extern bool of_node_name_eq(const struct device_node *np, const char *name);
264 extern bool of_node_name_prefix(const struct device_node *np, const char *prefix);
265
of_node_full_name(const struct device_node * np)266 static inline const char *of_node_full_name(const struct device_node *np)
267 {
268 return np ? np->full_name : "<no-node>";
269 }
270
271 #define for_each_of_allnodes_from(from, dn) \
272 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
273 #define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
274 extern struct device_node *of_find_node_by_name(struct device_node *from,
275 const char *name);
276 extern struct device_node *of_find_node_by_type(struct device_node *from,
277 const char *type);
278 extern struct device_node *of_find_compatible_node(struct device_node *from,
279 const char *type, const char *compat);
280 extern struct device_node *of_find_matching_node_and_match(
281 struct device_node *from,
282 const struct of_device_id *matches,
283 const struct of_device_id **match);
284
285 extern struct device_node *of_find_node_opts_by_path(const char *path,
286 const char **opts);
of_find_node_by_path(const char * path)287 static inline struct device_node *of_find_node_by_path(const char *path)
288 {
289 return of_find_node_opts_by_path(path, NULL);
290 }
291
292 extern struct device_node *of_find_node_by_phandle(phandle handle);
293 extern struct device_node *of_get_parent(const struct device_node *node);
294 extern struct device_node *of_get_next_parent(struct device_node *node);
295 extern struct device_node *of_get_next_child(const struct device_node *node,
296 struct device_node *prev);
297 extern struct device_node *of_get_next_available_child(
298 const struct device_node *node, struct device_node *prev);
299
300 extern struct device_node *of_get_compatible_child(const struct device_node *parent,
301 const char *compatible);
302 extern struct device_node *of_get_child_by_name(const struct device_node *node,
303 const char *name);
304
305 /* cache lookup */
306 extern struct device_node *of_find_next_cache_node(const struct device_node *);
307 extern int of_find_last_cache_level(unsigned int cpu);
308 extern struct device_node *of_find_node_with_property(
309 struct device_node *from, const char *prop_name);
310
311 extern struct property *of_find_property(const struct device_node *np,
312 const char *name,
313 int *lenp);
314 extern int of_property_count_elems_of_size(const struct device_node *np,
315 const char *propname, int elem_size);
316 extern int of_property_read_u32_index(const struct device_node *np,
317 const char *propname,
318 u32 index, u32 *out_value);
319 extern int of_property_read_u64_index(const struct device_node *np,
320 const char *propname,
321 u32 index, u64 *out_value);
322 extern int of_property_read_variable_u8_array(const struct device_node *np,
323 const char *propname, u8 *out_values,
324 size_t sz_min, size_t sz_max);
325 extern int of_property_read_variable_u16_array(const struct device_node *np,
326 const char *propname, u16 *out_values,
327 size_t sz_min, size_t sz_max);
328 extern int of_property_read_variable_u32_array(const struct device_node *np,
329 const char *propname,
330 u32 *out_values,
331 size_t sz_min,
332 size_t sz_max);
333 extern int of_property_read_u64(const struct device_node *np,
334 const char *propname, u64 *out_value);
335 extern int of_property_read_variable_u64_array(const struct device_node *np,
336 const char *propname,
337 u64 *out_values,
338 size_t sz_min,
339 size_t sz_max);
340
341 extern int of_property_read_string(const struct device_node *np,
342 const char *propname,
343 const char **out_string);
344 extern int of_property_match_string(const struct device_node *np,
345 const char *propname,
346 const char *string);
347 extern int of_property_read_string_helper(const struct device_node *np,
348 const char *propname,
349 const char **out_strs, size_t sz, int index);
350 extern int of_device_is_compatible(const struct device_node *device,
351 const char *);
352 extern int of_device_compatible_match(const struct device_node *device,
353 const char *const *compat);
354 extern bool of_device_is_available(const struct device_node *device);
355 extern bool of_device_is_big_endian(const struct device_node *device);
356 extern const void *of_get_property(const struct device_node *node,
357 const char *name,
358 int *lenp);
359 extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
360 extern struct device_node *of_cpu_device_node_get(int cpu);
361 extern int of_cpu_node_to_id(struct device_node *np);
362 extern struct device_node *of_get_next_cpu_node(struct device_node *prev);
363 extern struct device_node *of_get_cpu_state_node(struct device_node *cpu_node,
364 int index);
365 extern u64 of_get_cpu_hwid(struct device_node *cpun, unsigned int thread);
366
367 #define for_each_property_of_node(dn, pp) \
368 for (pp = dn->properties; pp != NULL; pp = pp->next)
369
370 extern int of_n_addr_cells(struct device_node *np);
371 extern int of_n_size_cells(struct device_node *np);
372 extern const struct of_device_id *of_match_node(
373 const struct of_device_id *matches, const struct device_node *node);
374 extern const void *of_device_get_match_data(const struct device *dev);
375 extern int of_alias_from_compatible(const struct device_node *node, char *alias,
376 int len);
377 extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
378 extern int __of_parse_phandle_with_args(const struct device_node *np,
379 const char *list_name, const char *cells_name, int cell_count,
380 int index, struct of_phandle_args *out_args);
381 extern int of_parse_phandle_with_args_map(const struct device_node *np,
382 const char *list_name, const char *stem_name, int index,
383 struct of_phandle_args *out_args);
384 extern int of_count_phandle_with_args(const struct device_node *np,
385 const char *list_name, const char *cells_name);
386
387 /* module functions */
388 extern ssize_t of_modalias(const struct device_node *np, char *str, ssize_t len);
389 extern int of_request_module(const struct device_node *np);
390
391 /* phandle iterator functions */
392 extern int of_phandle_iterator_init(struct of_phandle_iterator *it,
393 const struct device_node *np,
394 const char *list_name,
395 const char *cells_name,
396 int cell_count);
397
398 extern int of_phandle_iterator_next(struct of_phandle_iterator *it);
399 extern int of_phandle_iterator_args(struct of_phandle_iterator *it,
400 uint32_t *args,
401 int size);
402
403 extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
404 extern int of_alias_get_id(struct device_node *np, const char *stem);
405 extern int of_alias_get_highest_id(const char *stem);
406
407 extern int of_machine_is_compatible(const char *compat);
408
409 extern int of_add_property(struct device_node *np, struct property *prop);
410 extern int of_remove_property(struct device_node *np, struct property *prop);
411 extern int of_update_property(struct device_node *np, struct property *newprop);
412
413 /* For updating the device tree at runtime */
414 #define OF_RECONFIG_ATTACH_NODE 0x0001
415 #define OF_RECONFIG_DETACH_NODE 0x0002
416 #define OF_RECONFIG_ADD_PROPERTY 0x0003
417 #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
418 #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
419
420 extern int of_attach_node(struct device_node *);
421 extern int of_detach_node(struct device_node *);
422
423 #define of_match_ptr(_ptr) (_ptr)
424
425 /*
426 * u32 u;
427 *
428 * of_property_for_each_u32(np, "propname", u)
429 * printk("U32 value: %x\n", u);
430 */
431 const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
432 u32 *pu);
433 /*
434 * struct property *prop;
435 * const char *s;
436 *
437 * of_property_for_each_string(np, "propname", prop, s)
438 * printk("String value: %s\n", s);
439 */
440 const char *of_prop_next_string(struct property *prop, const char *cur);
441
442 bool of_console_check(struct device_node *dn, char *name, int index);
443
444 int of_map_id(struct device_node *np, u32 id,
445 const char *map_name, const char *map_mask_name,
446 struct device_node **target, u32 *id_out);
447
448 phys_addr_t of_dma_get_max_cpu_address(struct device_node *np);
449
450 struct kimage;
451 void *of_kexec_alloc_and_setup_fdt(const struct kimage *image,
452 unsigned long initrd_load_addr,
453 unsigned long initrd_len,
454 const char *cmdline, size_t extra_fdt_size);
455 #else /* CONFIG_OF */
456
of_core_init(void)457 static inline void of_core_init(void)
458 {
459 }
460
is_of_node(const struct fwnode_handle * fwnode)461 static inline bool is_of_node(const struct fwnode_handle *fwnode)
462 {
463 return false;
464 }
465
to_of_node(const struct fwnode_handle * fwnode)466 static inline struct device_node *to_of_node(const struct fwnode_handle *fwnode)
467 {
468 return NULL;
469 }
470
of_node_name_eq(const struct device_node * np,const char * name)471 static inline bool of_node_name_eq(const struct device_node *np, const char *name)
472 {
473 return false;
474 }
475
of_node_name_prefix(const struct device_node * np,const char * prefix)476 static inline bool of_node_name_prefix(const struct device_node *np, const char *prefix)
477 {
478 return false;
479 }
480
of_node_full_name(const struct device_node * np)481 static inline const char* of_node_full_name(const struct device_node *np)
482 {
483 return "<no-node>";
484 }
485
of_find_node_by_name(struct device_node * from,const char * name)486 static inline struct device_node *of_find_node_by_name(struct device_node *from,
487 const char *name)
488 {
489 return NULL;
490 }
491
of_find_node_by_type(struct device_node * from,const char * type)492 static inline struct device_node *of_find_node_by_type(struct device_node *from,
493 const char *type)
494 {
495 return NULL;
496 }
497
of_find_matching_node_and_match(struct device_node * from,const struct of_device_id * matches,const struct of_device_id ** match)498 static inline struct device_node *of_find_matching_node_and_match(
499 struct device_node *from,
500 const struct of_device_id *matches,
501 const struct of_device_id **match)
502 {
503 return NULL;
504 }
505
of_find_node_by_path(const char * path)506 static inline struct device_node *of_find_node_by_path(const char *path)
507 {
508 return NULL;
509 }
510
of_find_node_opts_by_path(const char * path,const char ** opts)511 static inline struct device_node *of_find_node_opts_by_path(const char *path,
512 const char **opts)
513 {
514 return NULL;
515 }
516
of_find_node_by_phandle(phandle handle)517 static inline struct device_node *of_find_node_by_phandle(phandle handle)
518 {
519 return NULL;
520 }
521
of_get_parent(const struct device_node * node)522 static inline struct device_node *of_get_parent(const struct device_node *node)
523 {
524 return NULL;
525 }
526
of_get_next_parent(struct device_node * node)527 static inline struct device_node *of_get_next_parent(struct device_node *node)
528 {
529 return NULL;
530 }
531
of_get_next_child(const struct device_node * node,struct device_node * prev)532 static inline struct device_node *of_get_next_child(
533 const struct device_node *node, struct device_node *prev)
534 {
535 return NULL;
536 }
537
of_get_next_available_child(const struct device_node * node,struct device_node * prev)538 static inline struct device_node *of_get_next_available_child(
539 const struct device_node *node, struct device_node *prev)
540 {
541 return NULL;
542 }
543
of_find_node_with_property(struct device_node * from,const char * prop_name)544 static inline struct device_node *of_find_node_with_property(
545 struct device_node *from, const char *prop_name)
546 {
547 return NULL;
548 }
549
550 #define of_fwnode_handle(node) NULL
551
of_have_populated_dt(void)552 static inline bool of_have_populated_dt(void)
553 {
554 return false;
555 }
556
of_get_compatible_child(const struct device_node * parent,const char * compatible)557 static inline struct device_node *of_get_compatible_child(const struct device_node *parent,
558 const char *compatible)
559 {
560 return NULL;
561 }
562
of_get_child_by_name(const struct device_node * node,const char * name)563 static inline struct device_node *of_get_child_by_name(
564 const struct device_node *node,
565 const char *name)
566 {
567 return NULL;
568 }
569
of_device_is_compatible(const struct device_node * device,const char * name)570 static inline int of_device_is_compatible(const struct device_node *device,
571 const char *name)
572 {
573 return 0;
574 }
575
of_device_compatible_match(const struct device_node * device,const char * const * compat)576 static inline int of_device_compatible_match(const struct device_node *device,
577 const char *const *compat)
578 {
579 return 0;
580 }
581
of_device_is_available(const struct device_node * device)582 static inline bool of_device_is_available(const struct device_node *device)
583 {
584 return false;
585 }
586
of_device_is_big_endian(const struct device_node * device)587 static inline bool of_device_is_big_endian(const struct device_node *device)
588 {
589 return false;
590 }
591
of_find_property(const struct device_node * np,const char * name,int * lenp)592 static inline struct property *of_find_property(const struct device_node *np,
593 const char *name,
594 int *lenp)
595 {
596 return NULL;
597 }
598
of_find_compatible_node(struct device_node * from,const char * type,const char * compat)599 static inline struct device_node *of_find_compatible_node(
600 struct device_node *from,
601 const char *type,
602 const char *compat)
603 {
604 return NULL;
605 }
606
of_property_count_elems_of_size(const struct device_node * np,const char * propname,int elem_size)607 static inline int of_property_count_elems_of_size(const struct device_node *np,
608 const char *propname, int elem_size)
609 {
610 return -ENOSYS;
611 }
612
of_property_read_u32_index(const struct device_node * np,const char * propname,u32 index,u32 * out_value)613 static inline int of_property_read_u32_index(const struct device_node *np,
614 const char *propname, u32 index, u32 *out_value)
615 {
616 return -ENOSYS;
617 }
618
of_property_read_u64_index(const struct device_node * np,const char * propname,u32 index,u64 * out_value)619 static inline int of_property_read_u64_index(const struct device_node *np,
620 const char *propname, u32 index, u64 *out_value)
621 {
622 return -ENOSYS;
623 }
624
of_get_property(const struct device_node * node,const char * name,int * lenp)625 static inline const void *of_get_property(const struct device_node *node,
626 const char *name,
627 int *lenp)
628 {
629 return NULL;
630 }
631
of_get_cpu_node(int cpu,unsigned int * thread)632 static inline struct device_node *of_get_cpu_node(int cpu,
633 unsigned int *thread)
634 {
635 return NULL;
636 }
637
of_cpu_device_node_get(int cpu)638 static inline struct device_node *of_cpu_device_node_get(int cpu)
639 {
640 return NULL;
641 }
642
of_cpu_node_to_id(struct device_node * np)643 static inline int of_cpu_node_to_id(struct device_node *np)
644 {
645 return -ENODEV;
646 }
647
of_get_next_cpu_node(struct device_node * prev)648 static inline struct device_node *of_get_next_cpu_node(struct device_node *prev)
649 {
650 return NULL;
651 }
652
of_get_cpu_state_node(struct device_node * cpu_node,int index)653 static inline struct device_node *of_get_cpu_state_node(struct device_node *cpu_node,
654 int index)
655 {
656 return NULL;
657 }
658
of_n_addr_cells(struct device_node * np)659 static inline int of_n_addr_cells(struct device_node *np)
660 {
661 return 0;
662
663 }
of_n_size_cells(struct device_node * np)664 static inline int of_n_size_cells(struct device_node *np)
665 {
666 return 0;
667 }
668
of_property_read_variable_u8_array(const struct device_node * np,const char * propname,u8 * out_values,size_t sz_min,size_t sz_max)669 static inline int of_property_read_variable_u8_array(const struct device_node *np,
670 const char *propname, u8 *out_values,
671 size_t sz_min, size_t sz_max)
672 {
673 return -ENOSYS;
674 }
675
of_property_read_variable_u16_array(const struct device_node * np,const char * propname,u16 * out_values,size_t sz_min,size_t sz_max)676 static inline int of_property_read_variable_u16_array(const struct device_node *np,
677 const char *propname, u16 *out_values,
678 size_t sz_min, size_t sz_max)
679 {
680 return -ENOSYS;
681 }
682
of_property_read_variable_u32_array(const struct device_node * np,const char * propname,u32 * out_values,size_t sz_min,size_t sz_max)683 static inline int of_property_read_variable_u32_array(const struct device_node *np,
684 const char *propname,
685 u32 *out_values,
686 size_t sz_min,
687 size_t sz_max)
688 {
689 return -ENOSYS;
690 }
691
of_property_read_u64(const struct device_node * np,const char * propname,u64 * out_value)692 static inline int of_property_read_u64(const struct device_node *np,
693 const char *propname, u64 *out_value)
694 {
695 return -ENOSYS;
696 }
697
of_property_read_variable_u64_array(const struct device_node * np,const char * propname,u64 * out_values,size_t sz_min,size_t sz_max)698 static inline int of_property_read_variable_u64_array(const struct device_node *np,
699 const char *propname,
700 u64 *out_values,
701 size_t sz_min,
702 size_t sz_max)
703 {
704 return -ENOSYS;
705 }
706
of_property_read_string(const struct device_node * np,const char * propname,const char ** out_string)707 static inline int of_property_read_string(const struct device_node *np,
708 const char *propname,
709 const char **out_string)
710 {
711 return -ENOSYS;
712 }
713
of_property_match_string(const struct device_node * np,const char * propname,const char * string)714 static inline int of_property_match_string(const struct device_node *np,
715 const char *propname,
716 const char *string)
717 {
718 return -ENOSYS;
719 }
720
of_property_read_string_helper(const struct device_node * np,const char * propname,const char ** out_strs,size_t sz,int index)721 static inline int of_property_read_string_helper(const struct device_node *np,
722 const char *propname,
723 const char **out_strs, size_t sz, int index)
724 {
725 return -ENOSYS;
726 }
727
__of_parse_phandle_with_args(const struct device_node * np,const char * list_name,const char * cells_name,int cell_count,int index,struct of_phandle_args * out_args)728 static inline int __of_parse_phandle_with_args(const struct device_node *np,
729 const char *list_name,
730 const char *cells_name,
731 int cell_count,
732 int index,
733 struct of_phandle_args *out_args)
734 {
735 return -ENOSYS;
736 }
737
of_parse_phandle_with_args_map(const struct device_node * np,const char * list_name,const char * stem_name,int index,struct of_phandle_args * out_args)738 static inline int of_parse_phandle_with_args_map(const struct device_node *np,
739 const char *list_name,
740 const char *stem_name,
741 int index,
742 struct of_phandle_args *out_args)
743 {
744 return -ENOSYS;
745 }
746
of_count_phandle_with_args(const struct device_node * np,const char * list_name,const char * cells_name)747 static inline int of_count_phandle_with_args(const struct device_node *np,
748 const char *list_name,
749 const char *cells_name)
750 {
751 return -ENOSYS;
752 }
753
of_modalias(const struct device_node * np,char * str,ssize_t len)754 static inline ssize_t of_modalias(const struct device_node *np, char *str,
755 ssize_t len)
756 {
757 return -ENODEV;
758 }
759
of_request_module(const struct device_node * np)760 static inline int of_request_module(const struct device_node *np)
761 {
762 return -ENODEV;
763 }
764
of_phandle_iterator_init(struct of_phandle_iterator * it,const struct device_node * np,const char * list_name,const char * cells_name,int cell_count)765 static inline int of_phandle_iterator_init(struct of_phandle_iterator *it,
766 const struct device_node *np,
767 const char *list_name,
768 const char *cells_name,
769 int cell_count)
770 {
771 return -ENOSYS;
772 }
773
of_phandle_iterator_next(struct of_phandle_iterator * it)774 static inline int of_phandle_iterator_next(struct of_phandle_iterator *it)
775 {
776 return -ENOSYS;
777 }
778
of_phandle_iterator_args(struct of_phandle_iterator * it,uint32_t * args,int size)779 static inline int of_phandle_iterator_args(struct of_phandle_iterator *it,
780 uint32_t *args,
781 int size)
782 {
783 return 0;
784 }
785
of_alias_get_id(struct device_node * np,const char * stem)786 static inline int of_alias_get_id(struct device_node *np, const char *stem)
787 {
788 return -ENOSYS;
789 }
790
of_alias_get_highest_id(const char * stem)791 static inline int of_alias_get_highest_id(const char *stem)
792 {
793 return -ENOSYS;
794 }
795
of_machine_is_compatible(const char * compat)796 static inline int of_machine_is_compatible(const char *compat)
797 {
798 return 0;
799 }
800
of_add_property(struct device_node * np,struct property * prop)801 static inline int of_add_property(struct device_node *np, struct property *prop)
802 {
803 return 0;
804 }
805
of_remove_property(struct device_node * np,struct property * prop)806 static inline int of_remove_property(struct device_node *np, struct property *prop)
807 {
808 return 0;
809 }
810
of_console_check(const struct device_node * dn,const char * name,int index)811 static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
812 {
813 return false;
814 }
815
of_prop_next_u32(struct property * prop,const __be32 * cur,u32 * pu)816 static inline const __be32 *of_prop_next_u32(struct property *prop,
817 const __be32 *cur, u32 *pu)
818 {
819 return NULL;
820 }
821
of_prop_next_string(struct property * prop,const char * cur)822 static inline const char *of_prop_next_string(struct property *prop,
823 const char *cur)
824 {
825 return NULL;
826 }
827
of_node_check_flag(struct device_node * n,unsigned long flag)828 static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
829 {
830 return 0;
831 }
832
of_node_test_and_set_flag(struct device_node * n,unsigned long flag)833 static inline int of_node_test_and_set_flag(struct device_node *n,
834 unsigned long flag)
835 {
836 return 0;
837 }
838
of_node_set_flag(struct device_node * n,unsigned long flag)839 static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
840 {
841 }
842
of_node_clear_flag(struct device_node * n,unsigned long flag)843 static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
844 {
845 }
846
of_property_check_flag(const struct property * p,unsigned long flag)847 static inline int of_property_check_flag(const struct property *p,
848 unsigned long flag)
849 {
850 return 0;
851 }
852
of_property_set_flag(struct property * p,unsigned long flag)853 static inline void of_property_set_flag(struct property *p, unsigned long flag)
854 {
855 }
856
of_property_clear_flag(struct property * p,unsigned long flag)857 static inline void of_property_clear_flag(struct property *p, unsigned long flag)
858 {
859 }
860
of_map_id(struct device_node * np,u32 id,const char * map_name,const char * map_mask_name,struct device_node ** target,u32 * id_out)861 static inline int of_map_id(struct device_node *np, u32 id,
862 const char *map_name, const char *map_mask_name,
863 struct device_node **target, u32 *id_out)
864 {
865 return -EINVAL;
866 }
867
of_dma_get_max_cpu_address(struct device_node * np)868 static inline phys_addr_t of_dma_get_max_cpu_address(struct device_node *np)
869 {
870 return PHYS_ADDR_MAX;
871 }
872
of_device_get_match_data(const struct device * dev)873 static inline const void *of_device_get_match_data(const struct device *dev)
874 {
875 return NULL;
876 }
877
878 #define of_match_ptr(_ptr) NULL
879 #define of_match_node(_matches, _node) NULL
880 #endif /* CONFIG_OF */
881
882 /* Default string compare functions, Allow arch asm/prom.h to override */
883 #if !defined(of_compat_cmp)
884 #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
885 #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
886 #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
887 #endif
888
of_prop_val_eq(struct property * p1,struct property * p2)889 static inline int of_prop_val_eq(struct property *p1, struct property *p2)
890 {
891 return p1->length == p2->length &&
892 !memcmp(p1->value, p2->value, (size_t)p1->length);
893 }
894
895 #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
896 extern int of_node_to_nid(struct device_node *np);
897 #else
of_node_to_nid(struct device_node * device)898 static inline int of_node_to_nid(struct device_node *device)
899 {
900 return NUMA_NO_NODE;
901 }
902 #endif
903
904 #ifdef CONFIG_OF_NUMA
905 extern int of_numa_init(void);
906 #else
of_numa_init(void)907 static inline int of_numa_init(void)
908 {
909 return -ENOSYS;
910 }
911 #endif
912
of_find_matching_node(struct device_node * from,const struct of_device_id * matches)913 static inline struct device_node *of_find_matching_node(
914 struct device_node *from,
915 const struct of_device_id *matches)
916 {
917 return of_find_matching_node_and_match(from, matches, NULL);
918 }
919
of_node_get_device_type(const struct device_node * np)920 static inline const char *of_node_get_device_type(const struct device_node *np)
921 {
922 return of_get_property(np, "device_type", NULL);
923 }
924
of_node_is_type(const struct device_node * np,const char * type)925 static inline bool of_node_is_type(const struct device_node *np, const char *type)
926 {
927 const char *match = of_node_get_device_type(np);
928
929 return np && match && type && !strcmp(match, type);
930 }
931
932 /**
933 * of_parse_phandle - Resolve a phandle property to a device_node pointer
934 * @np: Pointer to device node holding phandle property
935 * @phandle_name: Name of property holding a phandle value
936 * @index: For properties holding a table of phandles, this is the index into
937 * the table
938 *
939 * Return: The device_node pointer with refcount incremented. Use
940 * of_node_put() on it when done.
941 */
of_parse_phandle(const struct device_node * np,const char * phandle_name,int index)942 static inline struct device_node *of_parse_phandle(const struct device_node *np,
943 const char *phandle_name,
944 int index)
945 {
946 struct of_phandle_args args;
947
948 if (__of_parse_phandle_with_args(np, phandle_name, NULL, 0,
949 index, &args))
950 return NULL;
951
952 return args.np;
953 }
954
955 /**
956 * of_parse_phandle_with_args() - Find a node pointed by phandle in a list
957 * @np: pointer to a device tree node containing a list
958 * @list_name: property name that contains a list
959 * @cells_name: property name that specifies phandles' arguments count
960 * @index: index of a phandle to parse out
961 * @out_args: optional pointer to output arguments structure (will be filled)
962 *
963 * This function is useful to parse lists of phandles and their arguments.
964 * Returns 0 on success and fills out_args, on error returns appropriate
965 * errno value.
966 *
967 * Caller is responsible to call of_node_put() on the returned out_args->np
968 * pointer.
969 *
970 * Example::
971 *
972 * phandle1: node1 {
973 * #list-cells = <2>;
974 * };
975 *
976 * phandle2: node2 {
977 * #list-cells = <1>;
978 * };
979 *
980 * node3 {
981 * list = <&phandle1 1 2 &phandle2 3>;
982 * };
983 *
984 * To get a device_node of the ``node2`` node you may call this:
985 * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args);
986 */
of_parse_phandle_with_args(const struct device_node * np,const char * list_name,const char * cells_name,int index,struct of_phandle_args * out_args)987 static inline int of_parse_phandle_with_args(const struct device_node *np,
988 const char *list_name,
989 const char *cells_name,
990 int index,
991 struct of_phandle_args *out_args)
992 {
993 int cell_count = -1;
994
995 /* If cells_name is NULL we assume a cell count of 0 */
996 if (!cells_name)
997 cell_count = 0;
998
999 return __of_parse_phandle_with_args(np, list_name, cells_name,
1000 cell_count, index, out_args);
1001 }
1002
1003 /**
1004 * of_parse_phandle_with_fixed_args() - Find a node pointed by phandle in a list
1005 * @np: pointer to a device tree node containing a list
1006 * @list_name: property name that contains a list
1007 * @cell_count: number of argument cells following the phandle
1008 * @index: index of a phandle to parse out
1009 * @out_args: optional pointer to output arguments structure (will be filled)
1010 *
1011 * This function is useful to parse lists of phandles and their arguments.
1012 * Returns 0 on success and fills out_args, on error returns appropriate
1013 * errno value.
1014 *
1015 * Caller is responsible to call of_node_put() on the returned out_args->np
1016 * pointer.
1017 *
1018 * Example::
1019 *
1020 * phandle1: node1 {
1021 * };
1022 *
1023 * phandle2: node2 {
1024 * };
1025 *
1026 * node3 {
1027 * list = <&phandle1 0 2 &phandle2 2 3>;
1028 * };
1029 *
1030 * To get a device_node of the ``node2`` node you may call this:
1031 * of_parse_phandle_with_fixed_args(node3, "list", 2, 1, &args);
1032 */
of_parse_phandle_with_fixed_args(const struct device_node * np,const char * list_name,int cell_count,int index,struct of_phandle_args * out_args)1033 static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
1034 const char *list_name,
1035 int cell_count,
1036 int index,
1037 struct of_phandle_args *out_args)
1038 {
1039 return __of_parse_phandle_with_args(np, list_name, NULL, cell_count,
1040 index, out_args);
1041 }
1042
1043 /**
1044 * of_parse_phandle_with_optional_args() - Find a node pointed by phandle in a list
1045 * @np: pointer to a device tree node containing a list
1046 * @list_name: property name that contains a list
1047 * @cells_name: property name that specifies phandles' arguments count
1048 * @index: index of a phandle to parse out
1049 * @out_args: optional pointer to output arguments structure (will be filled)
1050 *
1051 * Same as of_parse_phandle_with_args() except that if the cells_name property
1052 * is not found, cell_count of 0 is assumed.
1053 *
1054 * This is used to useful, if you have a phandle which didn't have arguments
1055 * before and thus doesn't have a '#*-cells' property but is now migrated to
1056 * having arguments while retaining backwards compatibility.
1057 */
of_parse_phandle_with_optional_args(const struct device_node * np,const char * list_name,const char * cells_name,int index,struct of_phandle_args * out_args)1058 static inline int of_parse_phandle_with_optional_args(const struct device_node *np,
1059 const char *list_name,
1060 const char *cells_name,
1061 int index,
1062 struct of_phandle_args *out_args)
1063 {
1064 return __of_parse_phandle_with_args(np, list_name, cells_name,
1065 0, index, out_args);
1066 }
1067
1068 /**
1069 * of_property_count_u8_elems - Count the number of u8 elements in a property
1070 *
1071 * @np: device node from which the property value is to be read.
1072 * @propname: name of the property to be searched.
1073 *
1074 * Search for a property in a device node and count the number of u8 elements
1075 * in it.
1076 *
1077 * Return: The number of elements on sucess, -EINVAL if the property does
1078 * not exist or its length does not match a multiple of u8 and -ENODATA if the
1079 * property does not have a value.
1080 */
of_property_count_u8_elems(const struct device_node * np,const char * propname)1081 static inline int of_property_count_u8_elems(const struct device_node *np,
1082 const char *propname)
1083 {
1084 return of_property_count_elems_of_size(np, propname, sizeof(u8));
1085 }
1086
1087 /**
1088 * of_property_count_u16_elems - Count the number of u16 elements in a property
1089 *
1090 * @np: device node from which the property value is to be read.
1091 * @propname: name of the property to be searched.
1092 *
1093 * Search for a property in a device node and count the number of u16 elements
1094 * in it.
1095 *
1096 * Return: The number of elements on sucess, -EINVAL if the property does
1097 * not exist or its length does not match a multiple of u16 and -ENODATA if the
1098 * property does not have a value.
1099 */
of_property_count_u16_elems(const struct device_node * np,const char * propname)1100 static inline int of_property_count_u16_elems(const struct device_node *np,
1101 const char *propname)
1102 {
1103 return of_property_count_elems_of_size(np, propname, sizeof(u16));
1104 }
1105
1106 /**
1107 * of_property_count_u32_elems - Count the number of u32 elements in a property
1108 *
1109 * @np: device node from which the property value is to be read.
1110 * @propname: name of the property to be searched.
1111 *
1112 * Search for a property in a device node and count the number of u32 elements
1113 * in it.
1114 *
1115 * Return: The number of elements on sucess, -EINVAL if the property does
1116 * not exist or its length does not match a multiple of u32 and -ENODATA if the
1117 * property does not have a value.
1118 */
of_property_count_u32_elems(const struct device_node * np,const char * propname)1119 static inline int of_property_count_u32_elems(const struct device_node *np,
1120 const char *propname)
1121 {
1122 return of_property_count_elems_of_size(np, propname, sizeof(u32));
1123 }
1124
1125 /**
1126 * of_property_count_u64_elems - Count the number of u64 elements in a property
1127 *
1128 * @np: device node from which the property value is to be read.
1129 * @propname: name of the property to be searched.
1130 *
1131 * Search for a property in a device node and count the number of u64 elements
1132 * in it.
1133 *
1134 * Return: The number of elements on sucess, -EINVAL if the property does
1135 * not exist or its length does not match a multiple of u64 and -ENODATA if the
1136 * property does not have a value.
1137 */
of_property_count_u64_elems(const struct device_node * np,const char * propname)1138 static inline int of_property_count_u64_elems(const struct device_node *np,
1139 const char *propname)
1140 {
1141 return of_property_count_elems_of_size(np, propname, sizeof(u64));
1142 }
1143
1144 /**
1145 * of_property_read_string_array() - Read an array of strings from a multiple
1146 * strings property.
1147 * @np: device node from which the property value is to be read.
1148 * @propname: name of the property to be searched.
1149 * @out_strs: output array of string pointers.
1150 * @sz: number of array elements to read.
1151 *
1152 * Search for a property in a device tree node and retrieve a list of
1153 * terminated string values (pointer to data, not a copy) in that property.
1154 *
1155 * Return: If @out_strs is NULL, the number of strings in the property is returned.
1156 */
of_property_read_string_array(const struct device_node * np,const char * propname,const char ** out_strs,size_t sz)1157 static inline int of_property_read_string_array(const struct device_node *np,
1158 const char *propname, const char **out_strs,
1159 size_t sz)
1160 {
1161 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
1162 }
1163
1164 /**
1165 * of_property_count_strings() - Find and return the number of strings from a
1166 * multiple strings property.
1167 * @np: device node from which the property value is to be read.
1168 * @propname: name of the property to be searched.
1169 *
1170 * Search for a property in a device tree node and retrieve the number of null
1171 * terminated string contain in it.
1172 *
1173 * Return: The number of strings on success, -EINVAL if the property does not
1174 * exist, -ENODATA if property does not have a value, and -EILSEQ if the string
1175 * is not null-terminated within the length of the property data.
1176 */
of_property_count_strings(const struct device_node * np,const char * propname)1177 static inline int of_property_count_strings(const struct device_node *np,
1178 const char *propname)
1179 {
1180 return of_property_read_string_helper(np, propname, NULL, 0, 0);
1181 }
1182
1183 /**
1184 * of_property_read_string_index() - Find and read a string from a multiple
1185 * strings property.
1186 * @np: device node from which the property value is to be read.
1187 * @propname: name of the property to be searched.
1188 * @index: index of the string in the list of strings
1189 * @output: pointer to null terminated return string, modified only if
1190 * return value is 0.
1191 *
1192 * Search for a property in a device tree node and retrieve a null
1193 * terminated string value (pointer to data, not a copy) in the list of strings
1194 * contained in that property.
1195 *
1196 * Return: 0 on success, -EINVAL if the property does not exist, -ENODATA if
1197 * property does not have a value, and -EILSEQ if the string is not
1198 * null-terminated within the length of the property data.
1199 *
1200 * The out_string pointer is modified only if a valid string can be decoded.
1201 */
of_property_read_string_index(const struct device_node * np,const char * propname,int index,const char ** output)1202 static inline int of_property_read_string_index(const struct device_node *np,
1203 const char *propname,
1204 int index, const char **output)
1205 {
1206 int rc = of_property_read_string_helper(np, propname, output, 1, index);
1207 return rc < 0 ? rc : 0;
1208 }
1209
1210 /**
1211 * of_property_read_bool - Find a property
1212 * @np: device node from which the property value is to be read.
1213 * @propname: name of the property to be searched.
1214 *
1215 * Search for a boolean property in a device node. Usage on non-boolean
1216 * property types is deprecated.
1217 *
1218 * Return: true if the property exists false otherwise.
1219 */
of_property_read_bool(const struct device_node * np,const char * propname)1220 static inline bool of_property_read_bool(const struct device_node *np,
1221 const char *propname)
1222 {
1223 struct property *prop = of_find_property(np, propname, NULL);
1224
1225 return prop ? true : false;
1226 }
1227
1228 /**
1229 * of_property_present - Test if a property is present in a node
1230 * @np: device node to search for the property.
1231 * @propname: name of the property to be searched.
1232 *
1233 * Test for a property present in a device node.
1234 *
1235 * Return: true if the property exists false otherwise.
1236 */
of_property_present(const struct device_node * np,const char * propname)1237 static inline bool of_property_present(const struct device_node *np, const char *propname)
1238 {
1239 return of_property_read_bool(np, propname);
1240 }
1241
1242 /**
1243 * of_property_read_u8_array - Find and read an array of u8 from a property.
1244 *
1245 * @np: device node from which the property value is to be read.
1246 * @propname: name of the property to be searched.
1247 * @out_values: pointer to return value, modified only if return value is 0.
1248 * @sz: number of array elements to read
1249 *
1250 * Search for a property in a device node and read 8-bit value(s) from
1251 * it.
1252 *
1253 * dts entry of array should be like:
1254 * ``property = /bits/ 8 <0x50 0x60 0x70>;``
1255 *
1256 * Return: 0 on success, -EINVAL if the property does not exist,
1257 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1258 * property data isn't large enough.
1259 *
1260 * The out_values is modified only if a valid u8 value can be decoded.
1261 */
of_property_read_u8_array(const struct device_node * np,const char * propname,u8 * out_values,size_t sz)1262 static inline int of_property_read_u8_array(const struct device_node *np,
1263 const char *propname,
1264 u8 *out_values, size_t sz)
1265 {
1266 int ret = of_property_read_variable_u8_array(np, propname, out_values,
1267 sz, 0);
1268 if (ret >= 0)
1269 return 0;
1270 else
1271 return ret;
1272 }
1273
1274 /**
1275 * of_property_read_u16_array - Find and read an array of u16 from a property.
1276 *
1277 * @np: device node from which the property value is to be read.
1278 * @propname: name of the property to be searched.
1279 * @out_values: pointer to return value, modified only if return value is 0.
1280 * @sz: number of array elements to read
1281 *
1282 * Search for a property in a device node and read 16-bit value(s) from
1283 * it.
1284 *
1285 * dts entry of array should be like:
1286 * ``property = /bits/ 16 <0x5000 0x6000 0x7000>;``
1287 *
1288 * Return: 0 on success, -EINVAL if the property does not exist,
1289 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1290 * property data isn't large enough.
1291 *
1292 * The out_values is modified only if a valid u16 value can be decoded.
1293 */
of_property_read_u16_array(const struct device_node * np,const char * propname,u16 * out_values,size_t sz)1294 static inline int of_property_read_u16_array(const struct device_node *np,
1295 const char *propname,
1296 u16 *out_values, size_t sz)
1297 {
1298 int ret = of_property_read_variable_u16_array(np, propname, out_values,
1299 sz, 0);
1300 if (ret >= 0)
1301 return 0;
1302 else
1303 return ret;
1304 }
1305
1306 /**
1307 * of_property_read_u32_array - Find and read an array of 32 bit integers
1308 * from a property.
1309 *
1310 * @np: device node from which the property value is to be read.
1311 * @propname: name of the property to be searched.
1312 * @out_values: pointer to return value, modified only if return value is 0.
1313 * @sz: number of array elements to read
1314 *
1315 * Search for a property in a device node and read 32-bit value(s) from
1316 * it.
1317 *
1318 * Return: 0 on success, -EINVAL if the property does not exist,
1319 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1320 * property data isn't large enough.
1321 *
1322 * The out_values is modified only if a valid u32 value can be decoded.
1323 */
of_property_read_u32_array(const struct device_node * np,const char * propname,u32 * out_values,size_t sz)1324 static inline int of_property_read_u32_array(const struct device_node *np,
1325 const char *propname,
1326 u32 *out_values, size_t sz)
1327 {
1328 int ret = of_property_read_variable_u32_array(np, propname, out_values,
1329 sz, 0);
1330 if (ret >= 0)
1331 return 0;
1332 else
1333 return ret;
1334 }
1335
1336 /**
1337 * of_property_read_u64_array - Find and read an array of 64 bit integers
1338 * from a property.
1339 *
1340 * @np: device node from which the property value is to be read.
1341 * @propname: name of the property to be searched.
1342 * @out_values: pointer to return value, modified only if return value is 0.
1343 * @sz: number of array elements to read
1344 *
1345 * Search for a property in a device node and read 64-bit value(s) from
1346 * it.
1347 *
1348 * Return: 0 on success, -EINVAL if the property does not exist,
1349 * -ENODATA if property does not have a value, and -EOVERFLOW if the
1350 * property data isn't large enough.
1351 *
1352 * The out_values is modified only if a valid u64 value can be decoded.
1353 */
of_property_read_u64_array(const struct device_node * np,const char * propname,u64 * out_values,size_t sz)1354 static inline int of_property_read_u64_array(const struct device_node *np,
1355 const char *propname,
1356 u64 *out_values, size_t sz)
1357 {
1358 int ret = of_property_read_variable_u64_array(np, propname, out_values,
1359 sz, 0);
1360 if (ret >= 0)
1361 return 0;
1362 else
1363 return ret;
1364 }
1365
of_property_read_u8(const struct device_node * np,const char * propname,u8 * out_value)1366 static inline int of_property_read_u8(const struct device_node *np,
1367 const char *propname,
1368 u8 *out_value)
1369 {
1370 return of_property_read_u8_array(np, propname, out_value, 1);
1371 }
1372
of_property_read_u16(const struct device_node * np,const char * propname,u16 * out_value)1373 static inline int of_property_read_u16(const struct device_node *np,
1374 const char *propname,
1375 u16 *out_value)
1376 {
1377 return of_property_read_u16_array(np, propname, out_value, 1);
1378 }
1379
of_property_read_u32(const struct device_node * np,const char * propname,u32 * out_value)1380 static inline int of_property_read_u32(const struct device_node *np,
1381 const char *propname,
1382 u32 *out_value)
1383 {
1384 return of_property_read_u32_array(np, propname, out_value, 1);
1385 }
1386
of_property_read_s32(const struct device_node * np,const char * propname,s32 * out_value)1387 static inline int of_property_read_s32(const struct device_node *np,
1388 const char *propname,
1389 s32 *out_value)
1390 {
1391 return of_property_read_u32(np, propname, (u32*) out_value);
1392 }
1393
1394 #define of_for_each_phandle(it, err, np, ln, cn, cc) \
1395 for (of_phandle_iterator_init((it), (np), (ln), (cn), (cc)), \
1396 err = of_phandle_iterator_next(it); \
1397 err == 0; \
1398 err = of_phandle_iterator_next(it))
1399
1400 #define of_property_for_each_u32(np, propname, u) \
1401 for (struct {struct property *prop; const __be32 *item; } _it = \
1402 {of_find_property(np, propname, NULL), \
1403 of_prop_next_u32(_it.prop, NULL, &u)}; \
1404 _it.item; \
1405 _it.item = of_prop_next_u32(_it.prop, _it.item, &u))
1406
1407 #define of_property_for_each_string(np, propname, prop, s) \
1408 for (prop = of_find_property(np, propname, NULL), \
1409 s = of_prop_next_string(prop, NULL); \
1410 s; \
1411 s = of_prop_next_string(prop, s))
1412
1413 #define for_each_node_by_name(dn, name) \
1414 for (dn = of_find_node_by_name(NULL, name); dn; \
1415 dn = of_find_node_by_name(dn, name))
1416 #define for_each_node_by_type(dn, type) \
1417 for (dn = of_find_node_by_type(NULL, type); dn; \
1418 dn = of_find_node_by_type(dn, type))
1419 #define for_each_compatible_node(dn, type, compatible) \
1420 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
1421 dn = of_find_compatible_node(dn, type, compatible))
1422 #define for_each_matching_node(dn, matches) \
1423 for (dn = of_find_matching_node(NULL, matches); dn; \
1424 dn = of_find_matching_node(dn, matches))
1425 #define for_each_matching_node_and_match(dn, matches, match) \
1426 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
1427 dn; dn = of_find_matching_node_and_match(dn, matches, match))
1428
1429 #define for_each_child_of_node(parent, child) \
1430 for (child = of_get_next_child(parent, NULL); child != NULL; \
1431 child = of_get_next_child(parent, child))
1432
1433 #define for_each_child_of_node_scoped(parent, child) \
1434 for (struct device_node *child __free(device_node) = \
1435 of_get_next_child(parent, NULL); \
1436 child != NULL; \
1437 child = of_get_next_child(parent, child))
1438
1439 #define for_each_available_child_of_node(parent, child) \
1440 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
1441 child = of_get_next_available_child(parent, child))
1442
1443 #define for_each_available_child_of_node_scoped(parent, child) \
1444 for (struct device_node *child __free(device_node) = \
1445 of_get_next_available_child(parent, NULL); \
1446 child != NULL; \
1447 child = of_get_next_available_child(parent, child))
1448
1449 #define for_each_of_cpu_node(cpu) \
1450 for (cpu = of_get_next_cpu_node(NULL); cpu != NULL; \
1451 cpu = of_get_next_cpu_node(cpu))
1452
1453 #define for_each_node_with_property(dn, prop_name) \
1454 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
1455 dn = of_find_node_with_property(dn, prop_name))
1456
of_get_child_count(const struct device_node * np)1457 static inline int of_get_child_count(const struct device_node *np)
1458 {
1459 struct device_node *child;
1460 int num = 0;
1461
1462 for_each_child_of_node(np, child)
1463 num++;
1464
1465 return num;
1466 }
1467
of_get_available_child_count(const struct device_node * np)1468 static inline int of_get_available_child_count(const struct device_node *np)
1469 {
1470 struct device_node *child;
1471 int num = 0;
1472
1473 for_each_available_child_of_node(np, child)
1474 num++;
1475
1476 return num;
1477 }
1478
1479 #define _OF_DECLARE_STUB(table, name, compat, fn, fn_type) \
1480 static const struct of_device_id __of_table_##name \
1481 __attribute__((unused)) \
1482 = { .compatible = compat, \
1483 .data = (fn == (fn_type)NULL) ? fn : fn }
1484
1485 #if defined(CONFIG_OF) && !defined(MODULE)
1486 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1487 static const struct of_device_id __of_table_##name \
1488 __used __section("__" #table "_of_table") \
1489 __aligned(__alignof__(struct of_device_id)) \
1490 = { .compatible = compat, \
1491 .data = (fn == (fn_type)NULL) ? fn : fn }
1492 #else
1493 #define _OF_DECLARE(table, name, compat, fn, fn_type) \
1494 _OF_DECLARE_STUB(table, name, compat, fn, fn_type)
1495 #endif
1496
1497 typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
1498 typedef int (*of_init_fn_1_ret)(struct device_node *);
1499 typedef void (*of_init_fn_1)(struct device_node *);
1500
1501 #define OF_DECLARE_1(table, name, compat, fn) \
1502 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
1503 #define OF_DECLARE_1_RET(table, name, compat, fn) \
1504 _OF_DECLARE(table, name, compat, fn, of_init_fn_1_ret)
1505 #define OF_DECLARE_2(table, name, compat, fn) \
1506 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
1507
1508 /**
1509 * struct of_changeset_entry - Holds a changeset entry
1510 *
1511 * @node: list_head for the log list
1512 * @action: notifier action
1513 * @np: pointer to the device node affected
1514 * @prop: pointer to the property affected
1515 * @old_prop: hold a pointer to the original property
1516 *
1517 * Every modification of the device tree during a changeset
1518 * is held in a list of of_changeset_entry structures.
1519 * That way we can recover from a partial application, or we can
1520 * revert the changeset
1521 */
1522 struct of_changeset_entry {
1523 struct list_head node;
1524 unsigned long action;
1525 struct device_node *np;
1526 struct property *prop;
1527 struct property *old_prop;
1528 };
1529
1530 /**
1531 * struct of_changeset - changeset tracker structure
1532 *
1533 * @entries: list_head for the changeset entries
1534 *
1535 * changesets are a convenient way to apply bulk changes to the
1536 * live tree. In case of an error, changes are rolled-back.
1537 * changesets live on after initial application, and if not
1538 * destroyed after use, they can be reverted in one single call.
1539 */
1540 struct of_changeset {
1541 struct list_head entries;
1542 };
1543
1544 enum of_reconfig_change {
1545 OF_RECONFIG_NO_CHANGE = 0,
1546 OF_RECONFIG_CHANGE_ADD,
1547 OF_RECONFIG_CHANGE_REMOVE,
1548 };
1549
1550 struct notifier_block;
1551
1552 #ifdef CONFIG_OF_DYNAMIC
1553 extern int of_reconfig_notifier_register(struct notifier_block *);
1554 extern int of_reconfig_notifier_unregister(struct notifier_block *);
1555 extern int of_reconfig_notify(unsigned long, struct of_reconfig_data *rd);
1556 extern int of_reconfig_get_state_change(unsigned long action,
1557 struct of_reconfig_data *arg);
1558
1559 extern void of_changeset_init(struct of_changeset *ocs);
1560 extern void of_changeset_destroy(struct of_changeset *ocs);
1561 extern int of_changeset_apply(struct of_changeset *ocs);
1562 extern int of_changeset_revert(struct of_changeset *ocs);
1563 extern int of_changeset_action(struct of_changeset *ocs,
1564 unsigned long action, struct device_node *np,
1565 struct property *prop);
1566
of_changeset_attach_node(struct of_changeset * ocs,struct device_node * np)1567 static inline int of_changeset_attach_node(struct of_changeset *ocs,
1568 struct device_node *np)
1569 {
1570 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
1571 }
1572
of_changeset_detach_node(struct of_changeset * ocs,struct device_node * np)1573 static inline int of_changeset_detach_node(struct of_changeset *ocs,
1574 struct device_node *np)
1575 {
1576 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
1577 }
1578
of_changeset_add_property(struct of_changeset * ocs,struct device_node * np,struct property * prop)1579 static inline int of_changeset_add_property(struct of_changeset *ocs,
1580 struct device_node *np, struct property *prop)
1581 {
1582 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
1583 }
1584
of_changeset_remove_property(struct of_changeset * ocs,struct device_node * np,struct property * prop)1585 static inline int of_changeset_remove_property(struct of_changeset *ocs,
1586 struct device_node *np, struct property *prop)
1587 {
1588 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
1589 }
1590
of_changeset_update_property(struct of_changeset * ocs,struct device_node * np,struct property * prop)1591 static inline int of_changeset_update_property(struct of_changeset *ocs,
1592 struct device_node *np, struct property *prop)
1593 {
1594 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
1595 }
1596
1597 struct device_node *of_changeset_create_node(struct of_changeset *ocs,
1598 struct device_node *parent,
1599 const char *full_name);
1600 int of_changeset_add_prop_string(struct of_changeset *ocs,
1601 struct device_node *np,
1602 const char *prop_name, const char *str);
1603 int of_changeset_add_prop_string_array(struct of_changeset *ocs,
1604 struct device_node *np,
1605 const char *prop_name,
1606 const char **str_array, size_t sz);
1607 int of_changeset_add_prop_u32_array(struct of_changeset *ocs,
1608 struct device_node *np,
1609 const char *prop_name,
1610 const u32 *array, size_t sz);
of_changeset_add_prop_u32(struct of_changeset * ocs,struct device_node * np,const char * prop_name,const u32 val)1611 static inline int of_changeset_add_prop_u32(struct of_changeset *ocs,
1612 struct device_node *np,
1613 const char *prop_name,
1614 const u32 val)
1615 {
1616 return of_changeset_add_prop_u32_array(ocs, np, prop_name, &val, 1);
1617 }
1618
1619 #else /* CONFIG_OF_DYNAMIC */
of_reconfig_notifier_register(struct notifier_block * nb)1620 static inline int of_reconfig_notifier_register(struct notifier_block *nb)
1621 {
1622 return -EINVAL;
1623 }
of_reconfig_notifier_unregister(struct notifier_block * nb)1624 static inline int of_reconfig_notifier_unregister(struct notifier_block *nb)
1625 {
1626 return -EINVAL;
1627 }
of_reconfig_notify(unsigned long action,struct of_reconfig_data * arg)1628 static inline int of_reconfig_notify(unsigned long action,
1629 struct of_reconfig_data *arg)
1630 {
1631 return -EINVAL;
1632 }
of_reconfig_get_state_change(unsigned long action,struct of_reconfig_data * arg)1633 static inline int of_reconfig_get_state_change(unsigned long action,
1634 struct of_reconfig_data *arg)
1635 {
1636 return -EINVAL;
1637 }
1638 #endif /* CONFIG_OF_DYNAMIC */
1639
1640 /**
1641 * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
1642 * @np: Pointer to the given device_node
1643 *
1644 * Return: true if present false otherwise
1645 */
of_device_is_system_power_controller(const struct device_node * np)1646 static inline bool of_device_is_system_power_controller(const struct device_node *np)
1647 {
1648 return of_property_read_bool(np, "system-power-controller");
1649 }
1650
1651 /*
1652 * Overlay support
1653 */
1654
1655 enum of_overlay_notify_action {
1656 OF_OVERLAY_INIT = 0, /* kzalloc() of ovcs sets this value */
1657 OF_OVERLAY_PRE_APPLY,
1658 OF_OVERLAY_POST_APPLY,
1659 OF_OVERLAY_PRE_REMOVE,
1660 OF_OVERLAY_POST_REMOVE,
1661 };
1662
of_overlay_action_name(enum of_overlay_notify_action action)1663 static inline const char *of_overlay_action_name(enum of_overlay_notify_action action)
1664 {
1665 static const char *const of_overlay_action_name[] = {
1666 "init",
1667 "pre-apply",
1668 "post-apply",
1669 "pre-remove",
1670 "post-remove",
1671 };
1672
1673 return of_overlay_action_name[action];
1674 }
1675
1676 struct of_overlay_notify_data {
1677 struct device_node *overlay;
1678 struct device_node *target;
1679 };
1680
1681 #ifdef CONFIG_OF_OVERLAY
1682
1683 int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
1684 int *ovcs_id, struct device_node *target_base);
1685 int of_overlay_remove(int *ovcs_id);
1686 int of_overlay_remove_all(void);
1687
1688 int of_overlay_notifier_register(struct notifier_block *nb);
1689 int of_overlay_notifier_unregister(struct notifier_block *nb);
1690
1691 #else
1692
of_overlay_fdt_apply(const void * overlay_fdt,u32 overlay_fdt_size,int * ovcs_id,struct device_node * target_base)1693 static inline int of_overlay_fdt_apply(const void *overlay_fdt, u32 overlay_fdt_size,
1694 int *ovcs_id, struct device_node *target_base)
1695 {
1696 return -ENOTSUPP;
1697 }
1698
of_overlay_remove(int * ovcs_id)1699 static inline int of_overlay_remove(int *ovcs_id)
1700 {
1701 return -ENOTSUPP;
1702 }
1703
of_overlay_remove_all(void)1704 static inline int of_overlay_remove_all(void)
1705 {
1706 return -ENOTSUPP;
1707 }
1708
of_overlay_notifier_register(struct notifier_block * nb)1709 static inline int of_overlay_notifier_register(struct notifier_block *nb)
1710 {
1711 return 0;
1712 }
1713
of_overlay_notifier_unregister(struct notifier_block * nb)1714 static inline int of_overlay_notifier_unregister(struct notifier_block *nb)
1715 {
1716 return 0;
1717 }
1718
1719 #endif
1720
1721 #endif /* _LINUX_OF_H */
1722