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 * [email protected]
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;
34*b2473a35SUsama Arif extern phys_addr_t initial_boot_params_pa;
35e169cfbeSGrant Likely
36ccf3356eSRob Herring extern char __dtb_start[];
37ccf3356eSRob Herring extern char __dtb_end[];
38ccf3356eSRob Herring
39f347c367SGeert Uytterhoeven /* Other Prototypes */
40f347c367SGeert Uytterhoeven extern u64 of_flat_dt_translate_address(unsigned long node);
41f347c367SGeert Uytterhoeven extern void of_fdt_limit_memory(int limit);
42f347c367SGeert Uytterhoeven #endif /* CONFIG_OF_FLATTREE */
43f347c367SGeert Uytterhoeven
44f347c367SGeert Uytterhoeven #ifdef CONFIG_OF_EARLY_FLATTREE
458482f568SGrant Likely /* For scanning the flat device-tree at boot time */
4631a6a87dSGrant Likely extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
4731a6a87dSGrant Likely int depth, void *data),
488482f568SGrant Likely void *data);
49ea47dd19SNicholas Piggin extern int of_scan_flat_dt_subnodes(unsigned long node,
50ea47dd19SNicholas Piggin int (*it)(unsigned long node,
51ea47dd19SNicholas Piggin const char *uname,
52ea47dd19SNicholas Piggin void *data),
53ea47dd19SNicholas Piggin void *data);
549c609868SShannon Zhao extern int of_get_flat_dt_subnode_by_name(unsigned long node,
559c609868SShannon Zhao const char *uname);
569d0c4dfeSRob Herring extern const void *of_get_flat_dt_prop(unsigned long node, const char *name,
579d0c4dfeSRob Herring int *size);
5831a6a87dSGrant Likely extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
5931a6a87dSGrant Likely extern unsigned long of_get_flat_dt_root(void);
60ea47dd19SNicholas Piggin extern uint32_t of_get_flat_dt_phandle(unsigned long node);
6132c97689SGrant Likely
6260f20d84SRob Herring extern int early_init_dt_scan_chosen(char *cmdline);
631f012283SRob Herring extern int early_init_dt_scan_memory(void);
64b398123bSPingfan Liu extern void early_init_dt_check_for_usable_mem_range(void);
65d503187bSLeif Lindholm extern int early_init_dt_scan_chosen_stdout(void);
66e8d9d1f5SMarek Szyprowski extern void early_init_fdt_scan_reserved_mem(void);
6724bbd929SArd Biesheuvel extern void early_init_fdt_reserve_self(void);
6851975db0SGrant Likely extern void early_init_dt_add_memory_arch(u64 base, u64 size);
699d0c4dfeSRob Herring extern u64 dt_mem_next_cell(int s, const __be32 **cellp);
708482f568SGrant Likely
71f00abd94SGrant Likely /* Early flat tree scan hooks */
72d665881dSRob Herring extern int early_init_dt_scan_root(void);
73f00abd94SGrant Likely
74*b2473a35SUsama Arif extern bool early_init_dt_scan(void *dt_virt, phys_addr_t dt_phys);
75*b2473a35SUsama Arif extern bool early_init_dt_verify(void *dt_virt, phys_addr_t dt_phys);
764972a74bSLaura Abbott extern void early_init_dt_scan_nodes(void);
770288ffcbSRob Herring
786a903a25SRob Herring extern const char *of_flat_dt_get_machine_name(void);
796a903a25SRob Herring extern const void *of_flat_dt_match_machine(const void *default_match,
806a903a25SRob Herring const void * (*get_next_compat)(const char * const**));
816a903a25SRob Herring
8282b2928cSGrant Likely /* Other Prototypes */
8382b2928cSGrant Likely extern void unflatten_device_tree(void);
84a8bf7527SRob Herring extern void unflatten_and_copy_device_tree(void);
8582b2928cSGrant Likely extern void early_init_devtree(void *);
86b27652ddSKevin Hao extern void early_get_first_memblock_info(void *, phys_addr_t *);
87f347c367SGeert Uytterhoeven #else /* CONFIG_OF_EARLY_FLATTREE */
early_init_dt_check_for_usable_mem_range(void)88b398123bSPingfan Liu static inline void early_init_dt_check_for_usable_mem_range(void) {}
early_init_dt_scan_chosen_stdout(void)89d503187bSLeif Lindholm static inline int early_init_dt_scan_chosen_stdout(void) { return -ENODEV; }
early_init_fdt_scan_reserved_mem(void)90e8d9d1f5SMarek Szyprowski static inline void early_init_fdt_scan_reserved_mem(void) {}
early_init_fdt_reserve_self(void)9124bbd929SArd Biesheuvel static inline void early_init_fdt_reserve_self(void) {}
of_flat_dt_get_machine_name(void)926a903a25SRob Herring static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
unflatten_device_tree(void)938bfe9b5cSGrant Likely static inline void unflatten_device_tree(void) {}
unflatten_and_copy_device_tree(void)94a8bf7527SRob Herring static inline void unflatten_and_copy_device_tree(void) {}
95f347c367SGeert Uytterhoeven #endif /* CONFIG_OF_EARLY_FLATTREE */
9682b2928cSGrant Likely
97d45d94f6SGrant Likely #endif /* __ASSEMBLY__ */
98d8678b58SGrant Likely #endif /* _LINUX_OF_FDT_H */
99