[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / of_fdt.h

/*
 * Definitions for working with the Flattened Device Tree data format
 *
 * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
 * benh@kernel.crashing.org
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 */

#ifndef _LINUX_OF_FDT_H
#define _LINUX_OF_FDT_H

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

/* Definitions used by the flattened device tree */
#define OF_DT_HEADER		0xd00dfeed	/* marker */
#define OF_DT_BEGIN_NODE	0x1		/* Start of node, full name */
#define OF_DT_END_NODE		0x2		/* End node */
#define OF_DT_PROP		0x3		/* Property: name off, size,
						 * content */
#define OF_DT_NOP		0x4		/* nop */
#define OF_DT_END		0x9

#define OF_DT_VERSION		0x10

#ifndef __ASSEMBLY__
/*
 * This is what gets passed to the kernel by prom_init or kexec
 *
 * The dt struct contains the device tree structure, full pathes and
 * property contents. The dt strings contain a separate block with just
 * the strings for the property names, and is fully page aligned and
 * self contained in a page, so that it can be kept around by the kernel,
 * each property name appears only once in this page (cheap compression)
 *
 * the mem_rsvmap contains a map of reserved ranges of physical memory,
 * passing it here instead of in the device-tree itself greatly simplifies
 * the job of everybody. It's just a list of u64 pairs (base/size) that
 * ends when size is 0
 */
struct boot_param_header {
	__be32	magic;			/* magic word OF_DT_HEADER */
	__be32	totalsize;		/* total size of DT block */
	__be32	off_dt_struct;		/* offset to structure */
	__be32	off_dt_strings;		/* offset to strings */
	__be32	off_mem_rsvmap;		/* offset to memory reserve map */
	__be32	version;		/* format version */
	__be32	last_comp_version;	/* last compatible version */
	/* version 2 fields below */
	__be32	boot_cpuid_phys;	/* Physical CPU id we're booting on */
	/* version 3 fields below */
	__be32	dt_strings_size;	/* size of the DT strings block */
	/* version 17 fields below */
	__be32	dt_struct_size;		/* size of the DT structure block */
};

#if defined(CONFIG_OF_FLATTREE)

struct device_node;

/* For scanning an arbitrary device-tree at any time */
extern char *of_fdt_get_string(struct boot_param_header *blob, u32 offset);
extern void *of_fdt_get_property(struct boot_param_header *blob,
				 unsigned long node,
				 const char *name,
				 unsigned long *size);
extern int of_fdt_is_compatible(struct boot_param_header *blob,
				unsigned long node,
				const char *compat);
extern int of_fdt_match(struct boot_param_header *blob, unsigned long node,
			const char *const *compat);
extern void of_fdt_unflatten_tree(unsigned long *blob,
			       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 struct boot_param_header *initial_boot_params;

/* For scanning the flat device-tree at boot time */
extern char *find_flat_dt_string(u32 offset);
extern int of_scan_flat_dt(int (*it)(unsigned long node, const char *uname,
				     int depth, void *data),
			   void *data);
extern void *of_get_flat_dt_prop(unsigned long node, const char *name,
				 unsigned long *size);
extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
extern int of_flat_dt_match(unsigned long node, const char *const *matches);
extern unsigned long of_get_flat_dt_root(void);
extern int of_scan_flat_dt_by_path(const char *path,
	int (*it)(unsigned long node, const char *name, int depth, void *data),
	void *data);

/*
 * early_init_dt_scan_chosen - scan the device tree for ramdisk and bootargs
 *
 * The boot arguments will be placed into the memory pointed to by @data.
 * That memory should be COMMAND_LINE_SIZE big and initialized to be a valid
 * (possibly empty) string.  Logic for what will be in @data after this
 * function finishes:
 *
 * - CONFIG_CMDLINE_FORCE=true
 *     CONFIG_CMDLINE
 * - CONFIG_CMDLINE_EXTEND=true, @data is non-empty string
 *     @data + dt bootargs (even if dt bootargs are empty)
 * - CONFIG_CMDLINE_EXTEND=true, @data is empty string
 *     CONFIG_CMDLINE + dt bootargs (even if dt bootargs are empty)
 * - CMDLINE_FROM_BOOTLOADER=true, dt bootargs=non-empty:
 *     dt bootargs
 * - CMDLINE_FROM_BOOTLOADER=true, dt bootargs=empty, @data is non-empty string
 *     @data is left unchanged
 * - CMDLINE_FROM_BOOTLOADER=true, dt bootargs=empty, @data is empty string
 *     CONFIG_CMDLINE (or "" if that's not defined)
 */
extern int early_init_dt_scan_chosen(unsigned long node, const char *uname,
				     int depth, void *data);
extern void early_init_dt_check_for_initrd(unsigned long node);
extern int early_init_dt_scan_memory(unsigned long node, const char *uname,
				     int depth, void *data);
extern void early_init_fdt_scan_reserved_mem(void);
extern void early_init_dt_add_memory_arch(u64 base, u64 size);
extern int early_init_dt_reserve_memory_arch(phys_addr_t base, phys_addr_t size,
					     bool no_map);
extern void * early_init_dt_alloc_memory_arch(u64 size, u64 align);
extern u64 dt_mem_next_cell(int s, __be32 **cellp);

/*
 * If BLK_DEV_INITRD, the fdt early init code will call this function,
 * to be provided by the arch code. start and end are specified as
 * physical addresses.
 */
#ifdef CONFIG_BLK_DEV_INITRD
extern void early_init_dt_setup_initrd_arch(unsigned long start,
					    unsigned long end);
#endif

/* Early flat tree scan hooks */
extern int early_init_dt_scan_root(unsigned long node, const char *uname,
				   int depth, void *data);

/* Other Prototypes */
extern void unflatten_device_tree(void);
extern void early_init_devtree(void *);
#else /* CONFIG_OF_FLATTREE */
static inline void unflatten_device_tree(void) {}
static inline void early_init_fdt_scan_reserved_mem(void) {}
#endif /* CONFIG_OF_FLATTREE */

#endif /* __ASSEMBLY__ */
#endif /* _LINUX_OF_FDT_H */
Commit	Line	Data
d8678b58 GL	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
8482f568 GL	15	#include <linux/types.h>
	16	#include <linux/init.h>
	17
d8678b58 GL	18	/* Definitions used by the flattened device tree */
	19	#define OF_DT_HEADER 0xd00dfeed /* marker */
	20	#define OF_DT_BEGIN_NODE 0x1 /* Start of node, full name */
	21	#define OF_DT_END_NODE 0x2 /* End node */
	22	#define OF_DT_PROP 0x3 /* Property: name off, size,
	23	* content */
	24	#define OF_DT_NOP 0x4 /* nop */
	25	#define OF_DT_END 0x9
	26
	27	#define OF_DT_VERSION 0x10
	28
d45d94f6 GL	29	#ifndef __ASSEMBLY__
	30	/*
	31	* This is what gets passed to the kernel by prom_init or kexec
	32	*
	33	* The dt struct contains the device tree structure, full pathes and
	34	* property contents. The dt strings contain a separate block with just
	35	* the strings for the property names, and is fully page aligned and
	36	* self contained in a page, so that it can be kept around by the kernel,
	37	* each property name appears only once in this page (cheap compression)
	38	*
	39	* the mem_rsvmap contains a map of reserved ranges of physical memory,
	40	* passing it here instead of in the device-tree itself greatly simplifies
	41	* the job of everybody. It's just a list of u64 pairs (base/size) that
	42	* ends when size is 0
	43	*/
	44	struct boot_param_header {
087f79c4 JK	45	__be32 magic; /* magic word OF_DT_HEADER */
	46	__be32 totalsize; /* total size of DT block */
	47	__be32 off_dt_struct; /* offset to structure */
	48	__be32 off_dt_strings; /* offset to strings */
	49	__be32 off_mem_rsvmap; /* offset to memory reserve map */
	50	__be32 version; /* format version */
	51	__be32 last_comp_version; /* last compatible version */
d45d94f6	52	/* version 2 fields below */
087f79c4	53	__be32 boot_cpuid_phys; /* Physical CPU id we're booting on */
d45d94f6	54	/* version 3 fields below */
087f79c4	55	__be32 dt_strings_size; /* size of the DT strings block */
d45d94f6	56	/* version 17 fields below */
087f79c4	57	__be32 dt_struct_size; /* size of the DT structure block */
d45d94f6 GL	58	};
d45d94f6 GL	59
cf32eb89	60	#if defined(CONFIG_OF_FLATTREE)
9706a36e	61
a0817487 GL	62	struct device_node;
a0817487 GL	63
9706a36e SN	64	/* For scanning an arbitrary device-tree at any time */
	65	extern char of_fdt_get_string(struct boot_param_header blob, u32 offset);
	66	extern void of_fdt_get_property(struct boot_param_header blob,
	67	unsigned long node,
	68	const char *name,
	69	unsigned long *size);
	70	extern int of_fdt_is_compatible(struct boot_param_header *blob,
	71	unsigned long node,
	72	const char *compat);
a4f740cf	73	extern int of_fdt_match(struct boot_param_header *blob, unsigned long node,
7b482c83	74	const char const compat);
fe140423 SN	75	extern void of_fdt_unflatten_tree(unsigned long *blob,
fe140423 SN	76	struct device_node **mynodes);
9706a36e	77
e169cfbe	78	/* TBD: Temporary export of fdt globals - remove when code fully merged */
f00abd94 GL	79	extern int __initdata dt_root_addr_cells;
f00abd94 GL	80	extern int __initdata dt_root_size_cells;
e169cfbe GL	81	extern struct boot_param_header *initial_boot_params;
e169cfbe GL	82
8482f568	83	/* For scanning the flat device-tree at boot time */
e169cfbe	84	extern char *find_flat_dt_string(u32 offset);
31a6a87d GL	85	extern int of_scan_flat_dt(int (it)(unsigned long node, const char uname,
	86	int depth, void *data),
	87	void *data);
	88	extern void of_get_flat_dt_prop(unsigned long node, const char name,
	89	unsigned long *size);
	90	extern int of_flat_dt_is_compatible(unsigned long node, const char *name);
7b482c83	91	extern int of_flat_dt_match(unsigned long node, const char const matches);
31a6a87d	92	extern unsigned long of_get_flat_dt_root(void);
6fa3eb70 S	93	extern int of_scan_flat_dt_by_path(const char *path,
	94	int (it)(unsigned long node, const char name, int depth, void *data),
	95	void *data);
32c97689	96
6fa3eb70 S	97	/*
	98	* early_init_dt_scan_chosen - scan the device tree for ramdisk and bootargs
	99	*
	100	* The boot arguments will be placed into the memory pointed to by @data.
	101	* That memory should be COMMAND_LINE_SIZE big and initialized to be a valid
	102	* (possibly empty) string. Logic for what will be in @data after this
	103	* function finishes:
	104	*
	105	* - CONFIG_CMDLINE_FORCE=true
	106	* CONFIG_CMDLINE
	107	* - CONFIG_CMDLINE_EXTEND=true, @data is non-empty string
	108	* @data + dt bootargs (even if dt bootargs are empty)
	109	* - CONFIG_CMDLINE_EXTEND=true, @data is empty string
	110	* CONFIG_CMDLINE + dt bootargs (even if dt bootargs are empty)
	111	* - CMDLINE_FROM_BOOTLOADER=true, dt bootargs=non-empty:
	112	* dt bootargs
	113	* - CMDLINE_FROM_BOOTLOADER=true, dt bootargs=empty, @data is non-empty string
	114	* @data is left unchanged
	115	* - CMDLINE_FROM_BOOTLOADER=true, dt bootargs=empty, @data is empty string
	116	* CONFIG_CMDLINE (or "" if that's not defined)
	117	*/
86e03221 GL	118	extern int early_init_dt_scan_chosen(unsigned long node, const char *uname,
86e03221 GL	119	int depth, void *data);
f7b3a835	120	extern void early_init_dt_check_for_initrd(unsigned long node);
51975db0 GL	121	extern int early_init_dt_scan_memory(unsigned long node, const char *uname,
51975db0 GL	122	int depth, void *data);
6fa3eb70	123	extern void early_init_fdt_scan_reserved_mem(void);
51975db0	124	extern void early_init_dt_add_memory_arch(u64 base, u64 size);
6fa3eb70 S	125	extern int early_init_dt_reserve_memory_arch(phys_addr_t base, phys_addr_t size,
6fa3eb70 S	126	bool no_map);
fe55c184	127	extern void * early_init_dt_alloc_memory_arch(u64 size, u64 align);
2e89e685	128	extern u64 dt_mem_next_cell(int s, __be32 **cellp);
8482f568	129
1406bc2f JK	130	/*
	131	* If BLK_DEV_INITRD, the fdt early init code will call this function,
	132	* to be provided by the arch code. start and end are specified as
	133	* physical addresses.
	134	*/
	135	#ifdef CONFIG_BLK_DEV_INITRD
	136	extern void early_init_dt_setup_initrd_arch(unsigned long start,
	137	unsigned long end);
	138	#endif
	139
f00abd94 GL	140	/* Early flat tree scan hooks */
	141	extern int early_init_dt_scan_root(unsigned long node, const char *uname,
	142	int depth, void *data);
	143
82b2928c	144	/* Other Prototypes */
82b2928c GL	145	extern void unflatten_device_tree(void);
82b2928c GL	146	extern void early_init_devtree(void *);
8bfe9b5c GL	147	#else /* CONFIG_OF_FLATTREE */
8bfe9b5c GL	148	static inline void unflatten_device_tree(void) {}
6fa3eb70	149	static inline void early_init_fdt_scan_reserved_mem(void) {}
cf32eb89	150	#endif /* CONFIG_OF_FLATTREE */
82b2928c	151
d45d94f6	152	#endif /* __ASSEMBLY__ */
d8678b58	153	#endif /* _LINUX_OF_FDT_H */