xref: /openbmc/linux/scripts/dtc/dtc.h (revision 2c684d89)
1 #ifndef _DTC_H
2 #define _DTC_H
3 
4 /*
5  * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation.  2005.
6  *
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of the
11  * License, or (at your option) any later version.
12  *
13  *  This program is distributed in the hope that it will be useful,
14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  *  General Public License for more details.
17  *
18  *  You should have received a copy of the GNU General Public License
19  *  along with this program; if not, write to the Free Software
20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
21  *                                                                   USA
22  */
23 
24 #include <stdio.h>
25 #include <string.h>
26 #include <stdlib.h>
27 #include <stdint.h>
28 #include <stdbool.h>
29 #include <stdarg.h>
30 #include <assert.h>
31 #include <ctype.h>
32 #include <errno.h>
33 #include <unistd.h>
34 
35 #include <libfdt_env.h>
36 #include <fdt.h>
37 
38 #include "util.h"
39 
40 #ifdef DEBUG
41 #define debug(...)	printf(__VA_ARGS__)
42 #else
43 #define debug(...)
44 #endif
45 
46 
47 #define DEFAULT_FDT_VERSION	17
48 
49 /*
50  * Command line options
51  */
52 extern int quiet;		/* Level of quietness */
53 extern int reservenum;		/* Number of memory reservation slots */
54 extern int minsize;		/* Minimum blob size */
55 extern int padsize;		/* Additional padding to blob */
56 extern int phandle_format;	/* Use linux,phandle or phandle properties */
57 
58 #define PHANDLE_LEGACY	0x1
59 #define PHANDLE_EPAPR	0x2
60 #define PHANDLE_BOTH	0x3
61 
62 typedef uint32_t cell_t;
63 
64 
65 #define streq(a, b)	(strcmp((a), (b)) == 0)
66 #define strneq(a, b, n)	(strncmp((a), (b), (n)) == 0)
67 
68 #define ALIGN(x, a)	(((x) + (a) - 1) & ~((a) - 1))
69 
70 /* Data blobs */
71 enum markertype {
72 	REF_PHANDLE,
73 	REF_PATH,
74 	LABEL,
75 };
76 
77 struct  marker {
78 	enum markertype type;
79 	int offset;
80 	char *ref;
81 	struct marker *next;
82 };
83 
84 struct data {
85 	int len;
86 	char *val;
87 	struct marker *markers;
88 };
89 
90 
91 #define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ })
92 
93 #define for_each_marker(m) \
94 	for (; (m); (m) = (m)->next)
95 #define for_each_marker_of_type(m, t) \
96 	for_each_marker(m) \
97 		if ((m)->type == (t))
98 
99 void data_free(struct data d);
100 
101 struct data data_grow_for(struct data d, int xlen);
102 
103 struct data data_copy_mem(const char *mem, int len);
104 struct data data_copy_escape_string(const char *s, int len);
105 struct data data_copy_file(FILE *f, size_t len);
106 
107 struct data data_append_data(struct data d, const void *p, int len);
108 struct data data_insert_at_marker(struct data d, struct marker *m,
109 				  const void *p, int len);
110 struct data data_merge(struct data d1, struct data d2);
111 struct data data_append_cell(struct data d, cell_t word);
112 struct data data_append_integer(struct data d, uint64_t word, int bits);
113 struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
114 struct data data_append_addr(struct data d, uint64_t addr);
115 struct data data_append_byte(struct data d, uint8_t byte);
116 struct data data_append_zeroes(struct data d, int len);
117 struct data data_append_align(struct data d, int align);
118 
119 struct data data_add_marker(struct data d, enum markertype type, char *ref);
120 
121 bool data_is_one_string(struct data d);
122 
123 /* DT constraints */
124 
125 #define MAX_PROPNAME_LEN	31
126 #define MAX_NODENAME_LEN	31
127 
128 /* Live trees */
129 struct label {
130 	bool deleted;
131 	char *label;
132 	struct label *next;
133 };
134 
135 struct property {
136 	bool deleted;
137 	char *name;
138 	struct data val;
139 
140 	struct property *next;
141 
142 	struct label *labels;
143 };
144 
145 struct node {
146 	bool deleted;
147 	char *name;
148 	struct property *proplist;
149 	struct node *children;
150 
151 	struct node *parent;
152 	struct node *next_sibling;
153 
154 	char *fullpath;
155 	int basenamelen;
156 
157 	cell_t phandle;
158 	int addr_cells, size_cells;
159 
160 	struct label *labels;
161 };
162 
163 #define for_each_label_withdel(l0, l) \
164 	for ((l) = (l0); (l); (l) = (l)->next)
165 
166 #define for_each_label(l0, l) \
167 	for_each_label_withdel(l0, l) \
168 		if (!(l)->deleted)
169 
170 #define for_each_property_withdel(n, p) \
171 	for ((p) = (n)->proplist; (p); (p) = (p)->next)
172 
173 #define for_each_property(n, p) \
174 	for_each_property_withdel(n, p) \
175 		if (!(p)->deleted)
176 
177 #define for_each_child_withdel(n, c) \
178 	for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
179 
180 #define for_each_child(n, c) \
181 	for_each_child_withdel(n, c) \
182 		if (!(c)->deleted)
183 
184 void add_label(struct label **labels, char *label);
185 void delete_labels(struct label **labels);
186 
187 struct property *build_property(char *name, struct data val);
188 struct property *build_property_delete(char *name);
189 struct property *chain_property(struct property *first, struct property *list);
190 struct property *reverse_properties(struct property *first);
191 
192 struct node *build_node(struct property *proplist, struct node *children);
193 struct node *build_node_delete(void);
194 struct node *name_node(struct node *node, char *name);
195 struct node *chain_node(struct node *first, struct node *list);
196 struct node *merge_nodes(struct node *old_node, struct node *new_node);
197 
198 void add_property(struct node *node, struct property *prop);
199 void delete_property_by_name(struct node *node, char *name);
200 void delete_property(struct property *prop);
201 void add_child(struct node *parent, struct node *child);
202 void delete_node_by_name(struct node *parent, char *name);
203 void delete_node(struct node *node);
204 
205 const char *get_unitname(struct node *node);
206 struct property *get_property(struct node *node, const char *propname);
207 cell_t propval_cell(struct property *prop);
208 struct property *get_property_by_label(struct node *tree, const char *label,
209 				       struct node **node);
210 struct marker *get_marker_label(struct node *tree, const char *label,
211 				struct node **node, struct property **prop);
212 struct node *get_subnode(struct node *node, const char *nodename);
213 struct node *get_node_by_path(struct node *tree, const char *path);
214 struct node *get_node_by_label(struct node *tree, const char *label);
215 struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
216 struct node *get_node_by_ref(struct node *tree, const char *ref);
217 cell_t get_node_phandle(struct node *root, struct node *node);
218 
219 uint32_t guess_boot_cpuid(struct node *tree);
220 
221 /* Boot info (tree plus memreserve information */
222 
223 struct reserve_info {
224 	struct fdt_reserve_entry re;
225 
226 	struct reserve_info *next;
227 
228 	struct label *labels;
229 };
230 
231 struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
232 struct reserve_info *chain_reserve_entry(struct reserve_info *first,
233 					 struct reserve_info *list);
234 struct reserve_info *add_reserve_entry(struct reserve_info *list,
235 				       struct reserve_info *new);
236 
237 
238 struct boot_info {
239 	struct reserve_info *reservelist;
240 	struct node *dt;		/* the device tree */
241 	uint32_t boot_cpuid_phys;
242 };
243 
244 struct boot_info *build_boot_info(struct reserve_info *reservelist,
245 				  struct node *tree, uint32_t boot_cpuid_phys);
246 void sort_tree(struct boot_info *bi);
247 
248 /* Checks */
249 
250 void parse_checks_option(bool warn, bool error, const char *arg);
251 void process_checks(bool force, struct boot_info *bi);
252 
253 /* Flattened trees */
254 
255 void dt_to_blob(FILE *f, struct boot_info *bi, int version);
256 void dt_to_asm(FILE *f, struct boot_info *bi, int version);
257 
258 struct boot_info *dt_from_blob(const char *fname);
259 
260 /* Tree source */
261 
262 void dt_to_source(FILE *f, struct boot_info *bi);
263 struct boot_info *dt_from_source(const char *f);
264 
265 /* FS trees */
266 
267 struct boot_info *dt_from_fs(const char *dirname);
268 
269 #endif /* _DTC_H */
270