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