[linux-block.git] / include / linux / of_fdt.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Definitions for working with the Flattened Device Tree data format
 *
 * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
 * benh@kernel.crashing.org
 */

#ifndef _LINUX_OF_FDT_H
#define _LINUX_OF_FDT_H

#include <linux/types.h>
#include <linux/init.h>
#include <linux/errno.h>

/* Definitions used by the flattened device tree */
#define OF_DT_HEADER		0xd00dfeed	/* marker */

#ifndef __ASSEMBLY__

#if defined(CONFIG_OF_FLATTREE)

struct device_node;

/* For scanning an arbitrary device-tree at any time */
extern void *of_fdt_unflatten_tree(const unsigned long *blob,
				   struct device_node *dad,
				   struct device_node **mynodes);

/* TBD: Temporary export of fdt globals - remove when code fully merged */
extern int __initdata dt_root_addr_cells;
extern int __initdata dt_root_size_cells;
extern void *initial_boot_params;

extern char __dtb_start[];
extern char __dtb_end[];

/* Other Prototypes */
extern u64 of_flat_dt_translate_address(unsigned long node);
extern void of_fdt_limit_memory(int limit);
#endif /* CONFIG_OF_FLATTREE */

#ifdef CONFIG_OF_EARLY_FLATTREE
/* For scanning the flat device-tree at boot time */
extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
				     int depth, void *data),
			   void *data);
extern int of_scan_flat_dt_subnodes(unsigned long node,
				    int (*it)(unsigned long node,
					      const char *uname,
					      void *data),
				    void *data);
extern int of_get_flat_dt_subnode_by_name(unsigned long node,
					  const char *uname);
extern const void *of_get_flat_dt_prop(unsigned long node, const char *name,
				       int *size);
extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
extern unsigned long of_get_flat_dt_root(void);
extern uint32_t of_get_flat_dt_phandle(unsigned long node);

extern int early_init_dt_scan_chosen(char *cmdline);
extern int early_init_dt_scan_memory(void);
extern void early_init_dt_check_for_usable_mem_range(void);
extern int early_init_dt_scan_chosen_stdout(void);
extern void early_init_fdt_scan_reserved_mem(void);
extern void early_init_fdt_reserve_self(void);
extern void early_init_dt_add_memory_arch(u64 base, u64 size);
extern u64 dt_mem_next_cell(int s, const __be32 **cellp);

/* Early flat tree scan hooks */
extern int early_init_dt_scan_root(void);

extern bool early_init_dt_scan(void *params);
extern bool early_init_dt_verify(void *params);
extern void early_init_dt_scan_nodes(void);

extern const char *of_flat_dt_get_machine_name(void);
extern const void *of_flat_dt_match_machine(const void *default_match,
		const void * (*get_next_compat)(const char * const**));

/* Other Prototypes */
extern void unflatten_device_tree(void);
extern void unflatten_and_copy_device_tree(void);
extern void early_init_devtree(void *);
extern void early_get_first_memblock_info(void *, phys_addr_t *);
#else /* CONFIG_OF_EARLY_FLATTREE */
static inline void early_init_dt_check_for_usable_mem_range(void) {}
static inline int early_init_dt_scan_chosen_stdout(void) { return -ENODEV; }
static inline void early_init_fdt_scan_reserved_mem(void) {}
static inline void early_init_fdt_reserve_self(void) {}
static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
static inline void unflatten_device_tree(void) {}
static inline void unflatten_and_copy_device_tree(void) {}
#endif /* CONFIG_OF_EARLY_FLATTREE */

#endif /* __ASSEMBLY__ */
#endif /* _LINUX_OF_FDT_H */
Commit	Line	Data
af6074fc	1	/* SPDX-License-Identifier: GPL-2.0 */
d8678b58 GL	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
d8678b58 GL	7	*/
	8
	9	#ifndef _LINUX_OF_FDT_H
	10	#define _LINUX_OF_FDT_H
	11
8482f568 GL	12	#include <linux/types.h>
8482f568 GL	13	#include <linux/init.h>
d503187b	14	#include <linux/errno.h>
8482f568	15
d8678b58 GL	16	/* Definitions used by the flattened device tree */
d8678b58 GL	17	#define OF_DT_HEADER 0xd00dfeed /* marker */
d8678b58	18
d45d94f6	19	#ifndef __ASSEMBLY__
d45d94f6	20
cf32eb89	21	#if defined(CONFIG_OF_FLATTREE)
9706a36e	22
a0817487 GL	23	struct device_node;
a0817487 GL	24
9706a36e	25	/* For scanning an arbitrary device-tree at any time */
83262418 GS	26	extern void of_fdt_unflatten_tree(const unsigned long blob,
	27	struct device_node *dad,
	28	struct device_node **mynodes);
9706a36e	29
e169cfbe	30	/* TBD: Temporary export of fdt globals - remove when code fully merged */
f00abd94 GL	31	extern int __initdata dt_root_addr_cells;
f00abd94 GL	32	extern int __initdata dt_root_size_cells;
1daa0c4c	33	extern void *initial_boot_params;
e169cfbe	34
ccf3356e RH	35	extern char __dtb_start[];
	36	extern char __dtb_end[];
	37
f347c367 GU	38	/* Other Prototypes */
	39	extern u64 of_flat_dt_translate_address(unsigned long node);
	40	extern void of_fdt_limit_memory(int limit);
	41	#endif /* CONFIG_OF_FLATTREE */
	42
	43	#ifdef CONFIG_OF_EARLY_FLATTREE
8482f568	44	/* For scanning the flat device-tree at boot time */
31a6a87d GL	45	extern int of_scan_flat_dt(int (it)(unsigned long node, const char uname,
	46	int depth, void *data),
	47	void *data);
ea47dd19 NP	48	extern int of_scan_flat_dt_subnodes(unsigned long node,
	49	int (*it)(unsigned long node,
	50	const char *uname,
	51	void *data),
	52	void *data);
9c609868 SZ	53	extern int of_get_flat_dt_subnode_by_name(unsigned long node,
9c609868 SZ	54	const char *uname);
9d0c4dfe RH	55	extern const void of_get_flat_dt_prop(unsigned long node, const char name,
9d0c4dfe RH	56	int *size);
31a6a87d GL	57	extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
31a6a87d GL	58	extern unsigned long of_get_flat_dt_root(void);
ea47dd19	59	extern uint32_t of_get_flat_dt_phandle(unsigned long node);
32c97689	60
60f20d84	61	extern int early_init_dt_scan_chosen(char *cmdline);
1f012283	62	extern int early_init_dt_scan_memory(void);
b398123b	63	extern void early_init_dt_check_for_usable_mem_range(void);
d503187b	64	extern int early_init_dt_scan_chosen_stdout(void);
e8d9d1f5	65	extern void early_init_fdt_scan_reserved_mem(void);
24bbd929	66	extern void early_init_fdt_reserve_self(void);
51975db0	67	extern void early_init_dt_add_memory_arch(u64 base, u64 size);
9d0c4dfe	68	extern u64 dt_mem_next_cell(int s, const __be32 **cellp);
8482f568	69
f00abd94	70	/* Early flat tree scan hooks */
d665881d	71	extern int early_init_dt_scan_root(void);
f00abd94	72
0288ffcb	73	extern bool early_init_dt_scan(void *params);
4972a74b LA	74	extern bool early_init_dt_verify(void *params);
4972a74b LA	75	extern void early_init_dt_scan_nodes(void);
0288ffcb	76
6a903a25 RH	77	extern const char *of_flat_dt_get_machine_name(void);
	78	extern const void of_flat_dt_match_machine(const void default_match,
	79	const void * (get_next_compat)(const char const**));
	80
82b2928c	81	/* Other Prototypes */
82b2928c	82	extern void unflatten_device_tree(void);
a8bf7527	83	extern void unflatten_and_copy_device_tree(void);
82b2928c	84	extern void early_init_devtree(void *);
b27652dd	85	extern void early_get_first_memblock_info(void , phys_addr_t );
f347c367	86	#else /* CONFIG_OF_EARLY_FLATTREE */
b398123b	87	static inline void early_init_dt_check_for_usable_mem_range(void) {}
d503187b	88	static inline int early_init_dt_scan_chosen_stdout(void) { return -ENODEV; }
e8d9d1f5	89	static inline void early_init_fdt_scan_reserved_mem(void) {}
24bbd929	90	static inline void early_init_fdt_reserve_self(void) {}
6a903a25	91	static inline const char *of_flat_dt_get_machine_name(void) { return NULL; }
8bfe9b5c	92	static inline void unflatten_device_tree(void) {}
a8bf7527	93	static inline void unflatten_and_copy_device_tree(void) {}
f347c367	94	#endif /* CONFIG_OF_EARLY_FLATTREE */
82b2928c	95
d45d94f6	96	#endif /* __ASSEMBLY__ */
d8678b58	97	#endif /* _LINUX_OF_FDT_H */