Commit | Line | Data |
---|---|---|
9130ba88 RH |
1 | #ifndef DTC_H |
2 | #define DTC_H | |
a4da2e3e DG |
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> | |
cd296721 | 28 | #include <stdbool.h> |
a4da2e3e DG |
29 | #include <stdarg.h> |
30 | #include <assert.h> | |
31 | #include <ctype.h> | |
32 | #include <errno.h> | |
33 | #include <unistd.h> | |
4201d057 | 34 | #include <inttypes.h> |
a4da2e3e | 35 | |
ed95d745 | 36 | #include <libfdt_env.h> |
a4da2e3e DG |
37 | #include <fdt.h> |
38 | ||
658f29a5 JB |
39 | #include "util.h" |
40 | ||
41 | #ifdef DEBUG | |
47605971 | 42 | #define debug(...) printf(__VA_ARGS__) |
658f29a5 | 43 | #else |
47605971 | 44 | #define debug(...) |
658f29a5 JB |
45 | #endif |
46 | ||
a4da2e3e | 47 | #define DEFAULT_FDT_VERSION 17 |
658f29a5 | 48 | |
a4da2e3e DG |
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 */ | |
6f05afcb | 56 | extern int alignsize; /* Additional padding to blob accroding to the alignsize */ |
658f29a5 | 57 | extern int phandle_format; /* Use linux,phandle or phandle properties */ |
6f05afcb RH |
58 | extern int generate_symbols; /* generate symbols for nodes with labels */ |
59 | extern int generate_fixups; /* generate fixups */ | |
60 | extern int auto_label_aliases; /* auto generate labels -> aliases */ | |
c2e7075c | 61 | extern int annotate; /* annotate .dts with input source location */ |
a4da2e3e | 62 | |
658f29a5 JB |
63 | #define PHANDLE_LEGACY 0x1 |
64 | #define PHANDLE_EPAPR 0x2 | |
65 | #define PHANDLE_BOTH 0x3 | |
a4da2e3e | 66 | |
ed95d745 | 67 | typedef uint32_t cell_t; |
a4da2e3e | 68 | |
a4da2e3e DG |
69 | |
70 | #define streq(a, b) (strcmp((a), (b)) == 0) | |
9130ba88 RH |
71 | #define strstarts(s, prefix) (strncmp((s), (prefix), strlen(prefix)) == 0) |
72 | #define strprefixeq(a, n, b) (strlen(b) == (n) && (memcmp(a, b, n) == 0)) | |
a4da2e3e DG |
73 | |
74 | #define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1)) | |
a4da2e3e DG |
75 | |
76 | /* Data blobs */ | |
77 | enum markertype { | |
f858927f | 78 | TYPE_NONE, |
a4da2e3e DG |
79 | REF_PHANDLE, |
80 | REF_PATH, | |
81 | LABEL, | |
f858927f RH |
82 | TYPE_UINT8, |
83 | TYPE_UINT16, | |
84 | TYPE_UINT32, | |
85 | TYPE_UINT64, | |
86 | TYPE_STRING, | |
a4da2e3e | 87 | }; |
f858927f | 88 | extern const char *markername(enum markertype markertype); |
a4da2e3e DG |
89 | |
90 | struct marker { | |
91 | enum markertype type; | |
92 | int offset; | |
93 | char *ref; | |
94 | struct marker *next; | |
95 | }; | |
96 | ||
97 | struct data { | |
98 | int len; | |
99 | char *val; | |
a4da2e3e DG |
100 | struct marker *markers; |
101 | }; | |
102 | ||
103 | ||
47605971 | 104 | #define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ }) |
a4da2e3e DG |
105 | |
106 | #define for_each_marker(m) \ | |
107 | for (; (m); (m) = (m)->next) | |
108 | #define for_each_marker_of_type(m, t) \ | |
109 | for_each_marker(m) \ | |
110 | if ((m)->type == (t)) | |
111 | ||
f858927f RH |
112 | size_t type_marker_length(struct marker *m); |
113 | ||
a4da2e3e DG |
114 | void data_free(struct data d); |
115 | ||
116 | struct data data_grow_for(struct data d, int xlen); | |
117 | ||
118 | struct data data_copy_mem(const char *mem, int len); | |
119 | struct data data_copy_escape_string(const char *s, int len); | |
120 | struct data data_copy_file(FILE *f, size_t len); | |
121 | ||
122 | struct data data_append_data(struct data d, const void *p, int len); | |
123 | struct data data_insert_at_marker(struct data d, struct marker *m, | |
124 | const void *p, int len); | |
125 | struct data data_merge(struct data d1, struct data d2); | |
126 | struct data data_append_cell(struct data d, cell_t word); | |
cd296721 | 127 | struct data data_append_integer(struct data d, uint64_t word, int bits); |
89d12310 | 128 | struct data data_append_re(struct data d, uint64_t address, uint64_t size); |
ed95d745 | 129 | struct data data_append_addr(struct data d, uint64_t addr); |
a4da2e3e DG |
130 | struct data data_append_byte(struct data d, uint8_t byte); |
131 | struct data data_append_zeroes(struct data d, int len); | |
132 | struct data data_append_align(struct data d, int align); | |
133 | ||
134 | struct data data_add_marker(struct data d, enum markertype type, char *ref); | |
135 | ||
47605971 | 136 | bool data_is_one_string(struct data d); |
a4da2e3e DG |
137 | |
138 | /* DT constraints */ | |
139 | ||
140 | #define MAX_PROPNAME_LEN 31 | |
141 | #define MAX_NODENAME_LEN 31 | |
142 | ||
143 | /* Live trees */ | |
658f29a5 | 144 | struct label { |
47605971 | 145 | bool deleted; |
658f29a5 JB |
146 | char *label; |
147 | struct label *next; | |
148 | }; | |
149 | ||
89d12310 RH |
150 | struct bus_type { |
151 | const char *name; | |
152 | }; | |
153 | ||
a4da2e3e | 154 | struct property { |
47605971 | 155 | bool deleted; |
a4da2e3e DG |
156 | char *name; |
157 | struct data val; | |
158 | ||
159 | struct property *next; | |
160 | ||
658f29a5 | 161 | struct label *labels; |
c2e7075c | 162 | struct srcpos *srcpos; |
a4da2e3e DG |
163 | }; |
164 | ||
165 | struct node { | |
47605971 | 166 | bool deleted; |
a4da2e3e DG |
167 | char *name; |
168 | struct property *proplist; | |
169 | struct node *children; | |
170 | ||
171 | struct node *parent; | |
172 | struct node *next_sibling; | |
173 | ||
174 | char *fullpath; | |
175 | int basenamelen; | |
176 | ||
177 | cell_t phandle; | |
178 | int addr_cells, size_cells; | |
179 | ||
658f29a5 | 180 | struct label *labels; |
89d12310 | 181 | const struct bus_type *bus; |
c2e7075c | 182 | struct srcpos *srcpos; |
50aafd60 RH |
183 | |
184 | bool omit_if_unused, is_referenced; | |
a4da2e3e DG |
185 | }; |
186 | ||
cd296721 | 187 | #define for_each_label_withdel(l0, l) \ |
658f29a5 JB |
188 | for ((l) = (l0); (l); (l) = (l)->next) |
189 | ||
205a8eb7 SW |
190 | #define for_each_label(l0, l) \ |
191 | for_each_label_withdel(l0, l) \ | |
192 | if (!(l)->deleted) | |
cd296721 SW |
193 | |
194 | #define for_each_property_withdel(n, p) \ | |
a4da2e3e DG |
195 | for ((p) = (n)->proplist; (p); (p) = (p)->next) |
196 | ||
205a8eb7 SW |
197 | #define for_each_property(n, p) \ |
198 | for_each_property_withdel(n, p) \ | |
199 | if (!(p)->deleted) | |
cd296721 SW |
200 | |
201 | #define for_each_child_withdel(n, c) \ | |
a4da2e3e DG |
202 | for ((c) = (n)->children; (c); (c) = (c)->next_sibling) |
203 | ||
205a8eb7 SW |
204 | #define for_each_child(n, c) \ |
205 | for_each_child_withdel(n, c) \ | |
206 | if (!(c)->deleted) | |
207 | ||
658f29a5 | 208 | void add_label(struct label **labels, char *label); |
cd296721 | 209 | void delete_labels(struct label **labels); |
658f29a5 | 210 | |
c2e7075c RH |
211 | struct property *build_property(char *name, struct data val, |
212 | struct srcpos *srcpos); | |
cd296721 | 213 | struct property *build_property_delete(char *name); |
a4da2e3e DG |
214 | struct property *chain_property(struct property *first, struct property *list); |
215 | struct property *reverse_properties(struct property *first); | |
216 | ||
c2e7075c RH |
217 | struct node *build_node(struct property *proplist, struct node *children, |
218 | struct srcpos *srcpos); | |
219 | struct node *build_node_delete(struct srcpos *srcpos); | |
658f29a5 | 220 | struct node *name_node(struct node *node, char *name); |
50aafd60 RH |
221 | struct node *omit_node_if_unused(struct node *node); |
222 | struct node *reference_node(struct node *node); | |
a4da2e3e | 223 | struct node *chain_node(struct node *first, struct node *list); |
658f29a5 | 224 | struct node *merge_nodes(struct node *old_node, struct node *new_node); |
9130ba88 | 225 | struct node *add_orphan_node(struct node *old_node, struct node *new_node, char *ref); |
a4da2e3e DG |
226 | |
227 | void add_property(struct node *node, struct property *prop); | |
cd296721 SW |
228 | void delete_property_by_name(struct node *node, char *name); |
229 | void delete_property(struct property *prop); | |
a4da2e3e | 230 | void add_child(struct node *parent, struct node *child); |
cd296721 SW |
231 | void delete_node_by_name(struct node *parent, char *name); |
232 | void delete_node(struct node *node); | |
6f05afcb RH |
233 | void append_to_property(struct node *node, |
234 | char *name, const void *data, int len); | |
a4da2e3e DG |
235 | |
236 | const char *get_unitname(struct node *node); | |
237 | struct property *get_property(struct node *node, const char *propname); | |
238 | cell_t propval_cell(struct property *prop); | |
4201d057 | 239 | cell_t propval_cell_n(struct property *prop, int n); |
658f29a5 JB |
240 | struct property *get_property_by_label(struct node *tree, const char *label, |
241 | struct node **node); | |
242 | struct marker *get_marker_label(struct node *tree, const char *label, | |
243 | struct node **node, struct property **prop); | |
a4da2e3e DG |
244 | struct node *get_subnode(struct node *node, const char *nodename); |
245 | struct node *get_node_by_path(struct node *tree, const char *path); | |
246 | struct node *get_node_by_label(struct node *tree, const char *label); | |
247 | struct node *get_node_by_phandle(struct node *tree, cell_t phandle); | |
248 | struct node *get_node_by_ref(struct node *tree, const char *ref); | |
249 | cell_t get_node_phandle(struct node *root, struct node *node); | |
250 | ||
658f29a5 JB |
251 | uint32_t guess_boot_cpuid(struct node *tree); |
252 | ||
a4da2e3e DG |
253 | /* Boot info (tree plus memreserve information */ |
254 | ||
255 | struct reserve_info { | |
89d12310 | 256 | uint64_t address, size; |
a4da2e3e DG |
257 | |
258 | struct reserve_info *next; | |
259 | ||
658f29a5 | 260 | struct label *labels; |
a4da2e3e DG |
261 | }; |
262 | ||
658f29a5 | 263 | struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len); |
a4da2e3e DG |
264 | struct reserve_info *chain_reserve_entry(struct reserve_info *first, |
265 | struct reserve_info *list); | |
266 | struct reserve_info *add_reserve_entry(struct reserve_info *list, | |
267 | struct reserve_info *new); | |
268 | ||
269 | ||
6f05afcb RH |
270 | struct dt_info { |
271 | unsigned int dtsflags; | |
a4da2e3e | 272 | struct reserve_info *reservelist; |
ed95d745 | 273 | uint32_t boot_cpuid_phys; |
6f05afcb | 274 | struct node *dt; /* the device tree */ |
89d12310 | 275 | const char *outname; /* filename being written to, "-" for stdout */ |
a4da2e3e DG |
276 | }; |
277 | ||
6f05afcb RH |
278 | /* DTS version flags definitions */ |
279 | #define DTSF_V1 0x0001 /* /dts-v1/ */ | |
280 | #define DTSF_PLUGIN 0x0002 /* /plugin/ */ | |
281 | ||
282 | struct dt_info *build_dt_info(unsigned int dtsflags, | |
283 | struct reserve_info *reservelist, | |
284 | struct node *tree, uint32_t boot_cpuid_phys); | |
285 | void sort_tree(struct dt_info *dti); | |
286 | void generate_label_tree(struct dt_info *dti, char *name, bool allocph); | |
287 | void generate_fixups_tree(struct dt_info *dti, char *name); | |
288 | void generate_local_fixups_tree(struct dt_info *dti, char *name); | |
a4da2e3e DG |
289 | |
290 | /* Checks */ | |
291 | ||
47605971 | 292 | void parse_checks_option(bool warn, bool error, const char *arg); |
6f05afcb | 293 | void process_checks(bool force, struct dt_info *dti); |
a4da2e3e DG |
294 | |
295 | /* Flattened trees */ | |
296 | ||
6f05afcb RH |
297 | void dt_to_blob(FILE *f, struct dt_info *dti, int version); |
298 | void dt_to_asm(FILE *f, struct dt_info *dti, int version); | |
a4da2e3e | 299 | |
6f05afcb | 300 | struct dt_info *dt_from_blob(const char *fname); |
a4da2e3e DG |
301 | |
302 | /* Tree source */ | |
303 | ||
6f05afcb RH |
304 | void dt_to_source(FILE *f, struct dt_info *dti); |
305 | struct dt_info *dt_from_source(const char *f); | |
a4da2e3e | 306 | |
f858927f RH |
307 | /* YAML source */ |
308 | ||
309 | void dt_to_yaml(FILE *f, struct dt_info *dti); | |
310 | ||
a4da2e3e DG |
311 | /* FS trees */ |
312 | ||
6f05afcb | 313 | struct dt_info *dt_from_fs(const char *dirname); |
a4da2e3e | 314 | |
9130ba88 | 315 | #endif /* DTC_H */ |