1af6074fcSRob Herring /* SPDX-License-Identifier: GPL-2.0 */
2d8678b58SGrant Likely /*
3d8678b58SGrant Likely * Definitions for working with the Flattened Device Tree data format
4d8678b58SGrant Likely *
5d8678b58SGrant Likely * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
6d8678b58SGrant Likely * benh@kernel.crashing.org
7d8678b58SGrant Likely */
8d8678b58SGrant Likely
9d8678b58SGrant Likely #ifndef _LINUX_OF_FDT_H
10d8678b58SGrant Likely #define _LINUX_OF_FDT_H
11d8678b58SGrant Likely
128482f568SGrant Likely #include <linux/types.h>
138482f568SGrant Likely #include <linux/init.h>
14d503187bSLeif Lindholm #include <linux/errno.h>
158482f568SGrant Likely
16d8678b58SGrant Likely /* Definitions used by the flattened device tree */
17d8678b58SGrant Likely #define OF_DT_HEADER 0xd00dfeed /* marker */
18d8678b58SGrant Likely
19d45d94f6SGrant Likely #ifndef __ASSEMBLY__
20d45d94f6SGrant Likely
21cf32eb89SGrant Likely #if defined(CONFIG_OF_FLATTREE)
229706a36eSStephen Neuendorffer
23a0817487SGrant Likely struct device_node;
24a0817487SGrant Likely
259706a36eSStephen Neuendorffer /* For scanning an arbitrary device-tree at any time */
2683262418SGavin Shan extern void *of_fdt_unflatten_tree(const unsigned long *blob,
27c4263233SGavin Shan struct device_node *dad,
28fe140423SStephen Neuendorffer struct device_node **mynodes);
299706a36eSStephen Neuendorffer
30e169cfbeSGrant Likely /* TBD: Temporary export of fdt globals - remove when code fully merged */
31f00abd94SGrant Likely extern int __initdata dt_root_addr_cells;
32f00abd94SGrant Likely extern int __initdata dt_root_size_cells;
331daa0c4cSRob Herring extern void *initial_boot_params;
34e169cfbeSGrant Likely
35ccf3356eSRob Herring extern char __dtb_start[];
36ccf3356eSRob Herring extern char __dtb_end[];
37ccf3356eSRob Herring
38f347c367SGeert Uytterhoeven /* Other Prototypes */
39f347c367SGeert Uytterhoeven extern u64 of_flat_dt_translate_address(unsigned long node);
40f347c367SGeert Uytterhoeven extern void of_fdt_limit_memory(int limit);
41f347c367SGeert Uytterhoeven #endif /* CONFIG_OF_FLATTREE */
42f347c367SGeert Uytterhoeven
43f347c367SGeert Uytterhoeven #ifdef CONFIG_OF_EARLY_FLATTREE
448482f568SGrant Likely /* For scanning the flat device-tree at boot time */
4531a6a87dSGrant Likely extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
4631a6a87dSGrant Likely int depth, void *data),
478482f568SGrant Likely void *data);
48ea47dd19SNicholas Piggin extern int of_scan_flat_dt_subnodes(unsigned long node,
49ea47dd19SNicholas Piggin int (*it)(unsigned long node,
50ea47dd19SNicholas Piggin const char *uname,
51ea47dd19SNicholas Piggin void *data),
52ea47dd19SNicholas Piggin void *data);
539c609868SShannon Zhao extern int of_get_flat_dt_subnode_by_name(unsigned long node,
549c609868SShannon Zhao const char *uname);
559d0c4dfeSRob Herring extern const void *of_get_flat_dt_prop(unsigned long node, const char *name,
569d0c4dfeSRob Herring int *size);
5731a6a87dSGrant Likely extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
5831a6a87dSGrant Likely extern unsigned long of_get_flat_dt_root(void);
59ea47dd19SNicholas Piggin extern uint32_t of_get_flat_dt_phandle(unsigned long node);
6032c97689SGrant Likely
6186e03221SGrant Likely extern int early_init_dt_scan_chosen(char *cmdline);
6286e03221SGrant Likely extern int early_init_dt_scan_memory(void);
6351975db0SGrant Likely extern void early_init_dt_check_for_usable_mem_range(void);
6451975db0SGrant Likely extern int early_init_dt_scan_chosen_stdout(void);
65*b398123bSPingfan Liu extern void early_init_fdt_scan_reserved_mem(void);
66d503187bSLeif Lindholm extern void early_init_fdt_reserve_self(void);
67e8d9d1f5SMarek Szyprowski extern void early_init_dt_add_memory_arch(u64 base, u64 size);
6824bbd929SArd Biesheuvel extern u64 dt_mem_next_cell(int s, const __be32 **cellp);
6951975db0SGrant Likely
709d0c4dfeSRob Herring /* Early flat tree scan hooks */
718482f568SGrant Likely extern int early_init_dt_scan_root(void);
72f00abd94SGrant Likely
73f00abd94SGrant Likely extern bool early_init_dt_scan(void *params);
74f00abd94SGrant Likely extern bool early_init_dt_verify(void *params);
75f00abd94SGrant Likely extern void early_init_dt_scan_nodes(void);
760288ffcbSRob Herring
774972a74bSLaura Abbott extern const char *of_flat_dt_get_machine_name(void);
784972a74bSLaura Abbott extern const void *of_flat_dt_match_machine(const void *default_match,
790288ffcbSRob Herring const void * (*get_next_compat)(const char * const**));
806a903a25SRob Herring
816a903a25SRob Herring /* Other Prototypes */
826a903a25SRob Herring extern void unflatten_device_tree(void);
836a903a25SRob Herring extern void unflatten_and_copy_device_tree(void);
8482b2928cSGrant Likely extern void early_init_devtree(void *);
8582b2928cSGrant Likely extern void early_get_first_memblock_info(void *, phys_addr_t *);
86a8bf7527SRob Herring #else /* CONFIG_OF_EARLY_FLATTREE */
early_init_dt_check_for_usable_mem_range(void)8782b2928cSGrant Likely static inline void early_init_dt_check_for_usable_mem_range(void) {}
early_init_dt_scan_chosen_stdout(void)88b27652ddSKevin Hao static inline int early_init_dt_scan_chosen_stdout(void) { return -ENODEV; }
early_init_fdt_scan_reserved_mem(void)89f347c367SGeert Uytterhoeven static inline void early_init_fdt_scan_reserved_mem(void) {}
early_init_fdt_reserve_self(void)90*b398123bSPingfan Liu static inline void early_init_fdt_reserve_self(void) {}
of_flat_dt_get_machine_name(void)91d503187bSLeif Lindholm static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
unflatten_device_tree(void)92e8d9d1f5SMarek Szyprowski static inline void unflatten_device_tree(void) {}
unflatten_and_copy_device_tree(void)9324bbd929SArd Biesheuvel static inline void unflatten_and_copy_device_tree(void) {}
946a903a25SRob Herring #endif /* CONFIG_OF_EARLY_FLATTREE */
958bfe9b5cSGrant Likely
96a8bf7527SRob Herring #endif /* __ASSEMBLY__ */
97f347c367SGeert Uytterhoeven #endif /* _LINUX_OF_FDT_H */
9882b2928cSGrant Likely