xref: /openbmc/linux/include/linux/of_fdt.h (revision 4a5f8ae5)
1 /*
2  * Definitions for working with the Flattened Device Tree data format
3  *
4  * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
5  * benh@kernel.crashing.org
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * version 2 as published by the Free Software Foundation.
10  */
11 
12 #ifndef _LINUX_OF_FDT_H
13 #define _LINUX_OF_FDT_H
14 
15 #include <linux/types.h>
16 #include <linux/init.h>
17 #include <linux/errno.h>
18 
19 /* Definitions used by the flattened device tree */
20 #define OF_DT_HEADER		0xd00dfeed	/* marker */
21 
22 #ifndef __ASSEMBLY__
23 
24 #if defined(CONFIG_OF_FLATTREE)
25 
26 struct device_node;
27 
28 /* For scanning an arbitrary device-tree at any time */
29 extern char *of_fdt_get_string(const void *blob, u32 offset);
30 extern void *of_fdt_get_property(const void *blob,
31 				 unsigned long node,
32 				 const char *name,
33 				 int *size);
34 extern int of_fdt_is_compatible(const void *blob,
35 				unsigned long node,
36 				const char *compat);
37 extern bool of_fdt_is_big_endian(const void *blob,
38 				 unsigned long node);
39 extern int of_fdt_match(const void *blob, unsigned long node,
40 			const char *const *compat);
41 extern void *of_fdt_unflatten_tree(const unsigned long *blob,
42 				   struct device_node *dad,
43 				   struct device_node **mynodes);
44 
45 /* TBD: Temporary export of fdt globals - remove when code fully merged */
46 extern int __initdata dt_root_addr_cells;
47 extern int __initdata dt_root_size_cells;
48 extern void *initial_boot_params;
49 
50 extern char __dtb_start[];
51 extern char __dtb_end[];
52 
53 /* For scanning the flat device-tree at boot time */
54 extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
55 				     int depth, void *data),
56 			   void *data);
57 extern int of_scan_flat_dt_subnodes(unsigned long node,
58 				    int (*it)(unsigned long node,
59 					      const char *uname,
60 					      void *data),
61 				    void *data);
62 extern int of_get_flat_dt_subnode_by_name(unsigned long node,
63 					  const char *uname);
64 extern const void *of_get_flat_dt_prop(unsigned long node, const char *name,
65 				       int *size);
66 extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
67 extern int of_flat_dt_match(unsigned long node, const char *const *matches);
68 extern unsigned long of_get_flat_dt_root(void);
69 extern int of_get_flat_dt_size(void);
70 extern uint32_t of_get_flat_dt_phandle(unsigned long node);
71 
72 extern int early_init_dt_scan_chosen(unsigned long node, const char *uname,
73 				     int depth, void *data);
74 extern int early_init_dt_scan_memory(unsigned long node, const char *uname,
75 				     int depth, void *data);
76 extern int early_init_dt_scan_chosen_stdout(void);
77 extern void early_init_fdt_scan_reserved_mem(void);
78 extern void early_init_fdt_reserve_self(void);
79 extern void early_init_dt_add_memory_arch(u64 base, u64 size);
80 extern int early_init_dt_mark_hotplug_memory_arch(u64 base, u64 size);
81 extern int early_init_dt_reserve_memory_arch(phys_addr_t base, phys_addr_t size,
82 					     bool no_map);
83 extern void * early_init_dt_alloc_memory_arch(u64 size, u64 align);
84 extern u64 dt_mem_next_cell(int s, const __be32 **cellp);
85 
86 /* Early flat tree scan hooks */
87 extern int early_init_dt_scan_root(unsigned long node, const char *uname,
88 				   int depth, void *data);
89 
90 extern bool early_init_dt_scan(void *params);
91 extern bool early_init_dt_verify(void *params);
92 extern void early_init_dt_scan_nodes(void);
93 
94 extern const char *of_flat_dt_get_machine_name(void);
95 extern const void *of_flat_dt_match_machine(const void *default_match,
96 		const void * (*get_next_compat)(const char * const**));
97 
98 /* Other Prototypes */
99 extern void unflatten_device_tree(void);
100 extern void unflatten_and_copy_device_tree(void);
101 extern void early_init_devtree(void *);
102 extern void early_get_first_memblock_info(void *, phys_addr_t *);
103 extern u64 of_flat_dt_translate_address(unsigned long node);
104 extern void of_fdt_limit_memory(int limit);
105 #else /* CONFIG_OF_FLATTREE */
106 static inline int early_init_dt_scan_chosen_stdout(void) { return -ENODEV; }
107 static inline void early_init_fdt_scan_reserved_mem(void) {}
108 static inline void early_init_fdt_reserve_self(void) {}
109 static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
110 static inline void unflatten_device_tree(void) {}
111 static inline void unflatten_and_copy_device_tree(void) {}
112 #endif /* CONFIG_OF_FLATTREE */
113 
114 #endif /* __ASSEMBLY__ */
115 #endif /* _LINUX_OF_FDT_H */
116