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