[mirror_edk2.git] / EmbeddedPkg / Include / fdt.h

#ifndef _FDT_H\r
#define _FDT_H\r
/*\r
 * libfdt - Flat Device Tree manipulation\r
 * Copyright (C) 2006 David Gibson, IBM Corporation.\r
 * Copyright 2012 Kim Phillips, Freescale Semiconductor.\r
 *\r
 * libfdt is dual licensed: you can use it either under the terms of\r
 * the GPL, or the BSD license, at your option.\r
 *\r
 *  a) This library is free software; you can redistribute it and/or\r
 *     modify it under the terms of the GNU General Public License as\r
 *     published by the Free Software Foundation; either version 2 of the\r
 *     License, or (at your option) any later version.\r
 *\r
 *     This library is distributed in the hope that it will be useful,\r
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 *     GNU General Public License for more details.\r
 *\r
 *     You should have received a copy of the GNU General Public\r
 *     License along with this library; if not, write to the Free\r
 *     Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,\r
 *     MA 02110-1301 USA\r
 *\r
 * Alternatively,\r
 *\r
 *  b) Redistribution and use in source and binary forms, with or\r
 *     without modification, are permitted provided that the following\r
 *     conditions are met:\r
 *\r
 *     1. Redistributions of source code must retain the above\r
 *        copyright notice, this list of conditions and the following\r
 *        disclaimer.\r
 *     2. Redistributions in binary form must reproduce the above\r
 *        copyright notice, this list of conditions and the following\r
 *        disclaimer in the documentation and/or other materials\r
 *        provided with the distribution.\r
 *\r
 *     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\r
 *     CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,\r
 *     INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
 *     MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
 *     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\r
 *     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
 *     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
 *     NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
 *     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
 *     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
 *     CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\r
 *     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
 *     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
 */\r
\r
#ifndef __ASSEMBLY__\r
\r
struct fdt_header {\r
	fdt32_t magic;			 /* magic word FDT_MAGIC */\r
	fdt32_t totalsize;		 /* total size of DT block */\r
	fdt32_t off_dt_struct;		 /* offset to structure */\r
	fdt32_t off_dt_strings;		 /* offset to strings */\r
	fdt32_t off_mem_rsvmap;		 /* offset to memory reserve map */\r
	fdt32_t version;		 /* format version */\r
	fdt32_t last_comp_version;	 /* last compatible version */\r
\r
	/* version 2 fields below */\r
	fdt32_t boot_cpuid_phys;	 /* Which physical CPU id we're\r
					    booting on */\r
	/* version 3 fields below */\r
	fdt32_t size_dt_strings;	 /* size of the strings block */\r
\r
	/* version 17 fields below */\r
	fdt32_t size_dt_struct;		 /* size of the structure block */\r
};\r
\r
struct fdt_reserve_entry {\r
	fdt64_t address;\r
	fdt64_t size;\r
};\r
\r
struct fdt_node_header {\r
	fdt32_t tag;\r
	char name[0];\r
};\r
\r
struct fdt_property {\r
	fdt32_t tag;\r
	fdt32_t len;\r
	fdt32_t nameoff;\r
	char data[0];\r
};\r
\r
#endif /* !__ASSEMBLY */\r
\r
#define FDT_MAGIC	0xd00dfeed	/* 4: version, 4: total size */\r
#define FDT_TAGSIZE	sizeof(fdt32_t)\r
\r
#define FDT_BEGIN_NODE	0x1		/* Start node: full name */\r
#define FDT_END_NODE	0x2		/* End node */\r
#define FDT_PROP	0x3		/* Property: name off,\r
					   size, content */\r
#define FDT_NOP		0x4		/* nop */\r
#define FDT_END		0x9\r
\r
#define FDT_V1_SIZE	(7*sizeof(fdt32_t))\r
#define FDT_V2_SIZE	(FDT_V1_SIZE + sizeof(fdt32_t))\r
#define FDT_V3_SIZE	(FDT_V2_SIZE + sizeof(fdt32_t))\r
#define FDT_V16_SIZE	FDT_V3_SIZE\r
#define FDT_V17_SIZE	(FDT_V16_SIZE + sizeof(fdt32_t))\r
\r
#endif /* _FDT_H */\r
Commit	Line	Data
1e57a462	1	#ifndef _FDT_H\r
1e57a462	2	#define _FDT_H\r
3e8576dd OM	3	/*\r
	4	* libfdt - Flat Device Tree manipulation\r
	5	* Copyright (C) 2006 David Gibson, IBM Corporation.\r
	6	* Copyright 2012 Kim Phillips, Freescale Semiconductor.\r
	7	*\r
	8	* libfdt is dual licensed: you can use it either under the terms of\r
	9	* the GPL, or the BSD license, at your option.\r
	10	*\r
	11	* a) This library is free software; you can redistribute it and/or\r
	12	* modify it under the terms of the GNU General Public License as\r
	13	* published by the Free Software Foundation; either version 2 of the\r
	14	* License, or (at your option) any later version.\r
	15	*\r
	16	* This library is distributed in the hope that it will be useful,\r
	17	* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
	18	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
	19	* GNU General Public License for more details.\r
	20	*\r
	21	* You should have received a copy of the GNU General Public\r
	22	* License along with this library; if not, write to the Free\r
	23	* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,\r
	24	* MA 02110-1301 USA\r
	25	*\r
	26	* Alternatively,\r
	27	*\r
	28	* b) Redistribution and use in source and binary forms, with or\r
	29	* without modification, are permitted provided that the following\r
	30	* conditions are met:\r
	31	*\r
	32	* 1. Redistributions of source code must retain the above\r
	33	* copyright notice, this list of conditions and the following\r
	34	* disclaimer.\r
	35	* 2. Redistributions in binary form must reproduce the above\r
	36	* copyright notice, this list of conditions and the following\r
	37	* disclaimer in the documentation and/or other materials\r
	38	* provided with the distribution.\r
	39	*\r
	40	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND\r
	41	* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,\r
	42	* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
	43	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
	44	* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR\r
	45	* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\r
	46	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT\r
	47	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;\r
	48	* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
	49	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN\r
	50	* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR\r
	51	* OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
	52	* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
	53	*/\r
1e57a462	54	\r
	55	#ifndef __ASSEMBLY__\r
	56	\r
	57	struct fdt_header {\r
3e8576dd OM	58	fdt32_t magic; /* magic word FDT_MAGIC */\r
	59	fdt32_t totalsize; /* total size of DT block */\r
	60	fdt32_t off_dt_struct; /* offset to structure */\r
	61	fdt32_t off_dt_strings; /* offset to strings */\r
	62	fdt32_t off_mem_rsvmap; /* offset to memory reserve map */\r
	63	fdt32_t version; /* format version */\r
	64	fdt32_t last_comp_version; /* last compatible version */\r
1e57a462	65	\r
1e57a462	66	/* version 2 fields below */\r
3e8576dd	67	fdt32_t boot_cpuid_phys; /* Which physical CPU id we're\r
1e57a462	68	booting on */\r
1e57a462	69	/* version 3 fields below */\r
3e8576dd	70	fdt32_t size_dt_strings; /* size of the strings block */\r
1e57a462	71	\r
1e57a462	72	/* version 17 fields below */\r
3e8576dd	73	fdt32_t size_dt_struct; /* size of the structure block */\r
1e57a462	74	};\r
	75	\r
	76	struct fdt_reserve_entry {\r
3e8576dd OM	77	fdt64_t address;\r
3e8576dd OM	78	fdt64_t size;\r
1e57a462	79	};\r
	80	\r
	81	struct fdt_node_header {\r
3e8576dd	82	fdt32_t tag;\r
1e57a462	83	char name[0];\r
	84	};\r
	85	\r
	86	struct fdt_property {\r
3e8576dd OM	87	fdt32_t tag;\r
	88	fdt32_t len;\r
	89	fdt32_t nameoff;\r
1e57a462	90	char data[0];\r
	91	};\r
	92	\r
	93	#endif /* !__ASSEMBLY */\r
	94	\r
	95	#define FDT_MAGIC 0xd00dfeed /* 4: version, 4: total size */\r
3e8576dd	96	#define FDT_TAGSIZE sizeof(fdt32_t)\r
1e57a462	97	\r
	98	#define FDT_BEGIN_NODE 0x1 /* Start node: full name */\r
	99	#define FDT_END_NODE 0x2 /* End node */\r
	100	#define FDT_PROP 0x3 /* Property: name off,\r
	101	size, content */\r
	102	#define FDT_NOP 0x4 /* nop */\r
	103	#define FDT_END 0x9\r
	104	\r
3e8576dd OM	105	#define FDT_V1_SIZE (7*sizeof(fdt32_t))\r
	106	#define FDT_V2_SIZE (FDT_V1_SIZE + sizeof(fdt32_t))\r
	107	#define FDT_V3_SIZE (FDT_V2_SIZE + sizeof(fdt32_t))\r
1e57a462	108	#define FDT_V16_SIZE FDT_V3_SIZE\r
3e8576dd	109	#define FDT_V17_SIZE (FDT_V16_SIZE + sizeof(fdt32_t))\r
1e57a462	110	\r
1e57a462	111	#endif /* _FDT_H */\r