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