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