xref: /openbmc/linux/include/linux/of_fdt.h (revision 2c684d89)
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 
18 /* Definitions used by the flattened device tree */
19 #define OF_DT_HEADER		0xd00dfeed	/* marker */
20 
21 #ifndef __ASSEMBLY__
22 
23 #if defined(CONFIG_OF_FLATTREE)
24 
25 struct device_node;
26 
27 /* For scanning an arbitrary device-tree at any time */
28 extern char *of_fdt_get_string(const void *blob, u32 offset);
29 extern void *of_fdt_get_property(const void *blob,
30 				 unsigned long node,
31 				 const char *name,
32 				 int *size);
33 extern int of_fdt_is_compatible(const void *blob,
34 				unsigned long node,
35 				const char *compat);
36 extern bool of_fdt_is_big_endian(const void *blob,
37 				 unsigned long node);
38 extern int of_fdt_match(const void *blob, unsigned long node,
39 			const char *const *compat);
40 extern void of_fdt_unflatten_tree(const unsigned long *blob,
41 			       struct device_node **mynodes);
42 
43 /* TBD: Temporary export of fdt globals - remove when code fully merged */
44 extern int __initdata dt_root_addr_cells;
45 extern int __initdata dt_root_size_cells;
46 extern void *initial_boot_params;
47 
48 extern char __dtb_start[];
49 extern char __dtb_end[];
50 
51 /* For scanning the flat device-tree at boot time */
52 extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
53 				     int depth, void *data),
54 			   void *data);
55 extern const void *of_get_flat_dt_prop(unsigned long node, const char *name,
56 				       int *size);
57 extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
58 extern int of_flat_dt_match(unsigned long node, const char *const *matches);
59 extern unsigned long of_get_flat_dt_root(void);
60 extern int of_get_flat_dt_size(void);
61 
62 extern int early_init_dt_scan_chosen(unsigned long node, const char *uname,
63 				     int depth, void *data);
64 extern int early_init_dt_scan_memory(unsigned long node, const char *uname,
65 				     int depth, void *data);
66 extern void early_init_fdt_scan_reserved_mem(void);
67 extern void early_init_fdt_reserve_self(void);
68 extern void early_init_dt_add_memory_arch(u64 base, u64 size);
69 extern int early_init_dt_reserve_memory_arch(phys_addr_t base, phys_addr_t size,
70 					     bool no_map);
71 extern void * early_init_dt_alloc_memory_arch(u64 size, u64 align);
72 extern u64 dt_mem_next_cell(int s, const __be32 **cellp);
73 
74 /* Early flat tree scan hooks */
75 extern int early_init_dt_scan_root(unsigned long node, const char *uname,
76 				   int depth, void *data);
77 
78 extern bool early_init_dt_scan(void *params);
79 extern bool early_init_dt_verify(void *params);
80 extern void early_init_dt_scan_nodes(void);
81 
82 extern const char *of_flat_dt_get_machine_name(void);
83 extern const void *of_flat_dt_match_machine(const void *default_match,
84 		const void * (*get_next_compat)(const char * const**));
85 
86 /* Other Prototypes */
87 extern void unflatten_device_tree(void);
88 extern void unflatten_and_copy_device_tree(void);
89 extern void early_init_devtree(void *);
90 extern void early_get_first_memblock_info(void *, phys_addr_t *);
91 extern u64 fdt_translate_address(const void *blob, int node_offset);
92 extern void of_fdt_limit_memory(int limit);
93 #else /* CONFIG_OF_FLATTREE */
94 static inline void early_init_fdt_scan_reserved_mem(void) {}
95 static inline void early_init_fdt_reserve_self(void) {}
96 static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
97 static inline void unflatten_device_tree(void) {}
98 static inline void unflatten_and_copy_device_tree(void) {}
99 #endif /* CONFIG_OF_FLATTREE */
100 
101 #endif /* __ASSEMBLY__ */
102 #endif /* _LINUX_OF_FDT_H */
103