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