dtc.h revision 238742 
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(fmt,args...)	printf(fmt, ##args)
42#else
43#define debug(fmt,args...)
44#endif
45
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 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
62typedef 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#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
70
71/* Data blobs */
72enum markertype {
73	REF_PHANDLE,
74	REF_PATH,
75	LABEL,
76};
77
78struct  marker {
79	enum markertype type;
80	int offset;
81	char *ref;
82	struct marker *next;
83};
84
85struct data {
86	int len;
87	char *val;
88	struct marker *markers;
89};
90
91
92#define empty_data ((struct data){ /* all .members = 0 or NULL */ })
93
94#define for_each_marker(m) \
95	for (; (m); (m) = (m)->next)
96#define for_each_marker_of_type(m, t) \
97	for_each_marker(m) \
98		if ((m)->type == (t))
99
100void data_free(struct data d);
101
102struct data data_grow_for(struct data d, int xlen);
103
104struct data data_copy_mem(const char *mem, int len);
105struct data data_copy_escape_string(const char *s, int len);
106struct data data_copy_file(FILE *f, size_t len);
107
108struct data data_append_data(struct data d, const void *p, int len);
109struct data data_insert_at_marker(struct data d, struct marker *m,
110				  const void *p, int len);
111struct data data_merge(struct data d1, struct data d2);
112struct data data_append_cell(struct data d, cell_t word);
113struct data data_append_integer(struct data d, uint64_t word, int bits);
114struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
115struct data data_append_addr(struct data d, uint64_t addr);
116struct data data_append_byte(struct data d, uint8_t byte);
117struct data data_append_zeroes(struct data d, int len);
118struct data data_append_align(struct data d, int align);
119
120struct data data_add_marker(struct data d, enum markertype type, char *ref);
121
122int data_is_one_string(struct data d);
123
124/* DT constraints */
125
126#define MAX_PROPNAME_LEN	31
127#define MAX_NODENAME_LEN	31
128
129/* Live trees */
130struct label {
131	char *label;
132	struct label *next;
133};
134
135struct property {
136	char *name;
137	struct data val;
138
139	struct property *next;
140
141	struct label *labels;
142};
143
144struct node {
145	char *name;
146	struct property *proplist;
147	struct node *children;
148
149	struct node *parent;
150	struct node *next_sibling;
151
152	char *fullpath;
153	int basenamelen;
154
155	cell_t phandle;
156	int addr_cells, size_cells;
157
158	struct label *labels;
159};
160
161#define for_each_label(l0, l) \
162	for ((l) = (l0); (l); (l) = (l)->next)
163
164#define for_each_property(n, p) \
165	for ((p) = (n)->proplist; (p); (p) = (p)->next)
166
167#define for_each_child(n, c)	\
168	for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
169
170void add_label(struct label **labels, char *label);
171
172struct property *build_property(char *name, struct data val);
173struct property *chain_property(struct property *first, struct property *list);
174struct property *reverse_properties(struct property *first);
175
176struct node *build_node(struct property *proplist, struct node *children);
177struct node *name_node(struct node *node, char *name);
178struct node *chain_node(struct node *first, struct node *list);
179struct node *merge_nodes(struct node *old_node, struct node *new_node);
180
181void add_property(struct node *node, struct property *prop);
182void add_child(struct node *parent, struct node *child);
183
184const char *get_unitname(struct node *node);
185struct property *get_property(struct node *node, const char *propname);
186cell_t propval_cell(struct property *prop);
187struct property *get_property_by_label(struct node *tree, const char *label,
188				       struct node **node);
189struct marker *get_marker_label(struct node *tree, const char *label,
190				struct node **node, struct property **prop);
191struct node *get_subnode(struct node *node, const char *nodename);
192struct node *get_node_by_path(struct node *tree, const char *path);
193struct node *get_node_by_label(struct node *tree, const char *label);
194struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
195struct node *get_node_by_ref(struct node *tree, const char *ref);
196cell_t get_node_phandle(struct node *root, struct node *node);
197
198uint32_t guess_boot_cpuid(struct node *tree);
199
200/* Boot info (tree plus memreserve information */
201
202struct reserve_info {
203	struct fdt_reserve_entry re;
204
205	struct reserve_info *next;
206
207	struct label *labels;
208};
209
210struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
211struct reserve_info *chain_reserve_entry(struct reserve_info *first,
212					 struct reserve_info *list);
213struct reserve_info *add_reserve_entry(struct reserve_info *list,
214				       struct reserve_info *new);
215
216
217struct boot_info {
218	struct reserve_info *reservelist;
219	struct node *dt;		/* the device tree */
220	uint32_t boot_cpuid_phys;
221};
222
223struct boot_info *build_boot_info(struct reserve_info *reservelist,
224				  struct node *tree, uint32_t boot_cpuid_phys);
225void sort_tree(struct boot_info *bi);
226
227/* Checks */
228
229void parse_checks_option(bool warn, bool error, const char *optarg);
230void process_checks(int force, struct boot_info *bi);
231
232/* Flattened trees */
233
234void dt_to_blob(FILE *f, struct boot_info *bi, int version);
235void dt_to_asm(FILE *f, struct boot_info *bi, int version);
236
237struct boot_info *dt_from_blob(const char *fname);
238
239/* Tree source */
240
241void dt_to_source(FILE *f, struct boot_info *bi);
242struct boot_info *dt_from_source(const char *f);
243
244/* FS trees */
245
246struct boot_info *dt_from_fs(const char *dirname);
247
248#endif /* _DTC_H */
249