dtc.h revision 204433 
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 <stdarg.h>
29#include <assert.h>
30#include <ctype.h>
31#include <errno.h>
32#include <unistd.h>
33
34#include <libfdt_env.h>
35#include <fdt.h>
36
37#include "util.h"
38
39#ifdef DEBUG
40#define debug(fmt,args...)	printf(fmt, ##args)
41#else
42#define debug(fmt,args...)
43#endif
44
45
46#define DEFAULT_FDT_VERSION	17
47
48/*
49 * Command line options
50 */
51extern int quiet;		/* Level of quietness */
52extern int reservenum;		/* Number of memory reservation slots */
53extern int minsize;		/* Minimum blob size */
54extern int padsize;		/* Additional padding to blob */
55extern int phandle_format;	/* Use linux,phandle or phandle properties */
56
57#define PHANDLE_LEGACY	0x1
58#define PHANDLE_EPAPR	0x2
59#define PHANDLE_BOTH	0x3
60
61typedef uint32_t cell_t;
62
63
64#define streq(a, b)	(strcmp((a), (b)) == 0)
65#define strneq(a, b, n)	(strncmp((a), (b), (n)) == 0)
66
67#define ALIGN(x, a)	(((x) + (a) - 1) & ~((a) - 1))
68#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
69
70/* Data blobs */
71enum markertype {
72	REF_PHANDLE,
73	REF_PATH,
74	LABEL,
75};
76
77struct  marker {
78	enum markertype type;
79	int offset;
80	char *ref;
81	struct marker *next;
82};
83
84struct data {
85	int len;
86	char *val;
87	struct marker *markers;
88};
89
90
91#define empty_data ((struct data){ /* 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
99void data_free(struct data d);
100
101struct data data_grow_for(struct data d, int xlen);
102
103struct data data_copy_mem(const char *mem, int len);
104struct data data_copy_escape_string(const char *s, int len);
105struct data data_copy_file(FILE *f, size_t len);
106
107struct data data_append_data(struct data d, const void *p, int len);
108struct data data_insert_at_marker(struct data d, struct marker *m,
109				  const void *p, int len);
110struct data data_merge(struct data d1, struct data d2);
111struct data data_append_cell(struct data d, cell_t word);
112struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
113struct data data_append_addr(struct data d, uint64_t addr);
114struct data data_append_byte(struct data d, uint8_t byte);
115struct data data_append_zeroes(struct data d, int len);
116struct data data_append_align(struct data d, int align);
117
118struct data data_add_marker(struct data d, enum markertype type, char *ref);
119
120int data_is_one_string(struct data d);
121
122/* DT constraints */
123
124#define MAX_PROPNAME_LEN	31
125#define MAX_NODENAME_LEN	31
126
127/* Live trees */
128struct property {
129	char *name;
130	struct data val;
131
132	struct property *next;
133
134	char *label;
135};
136
137struct node {
138	char *name;
139	struct property *proplist;
140	struct node *children;
141
142	struct node *parent;
143	struct node *next_sibling;
144
145	char *fullpath;
146	int basenamelen;
147
148	cell_t phandle;
149	int addr_cells, size_cells;
150
151	char *label;
152};
153
154#define for_each_property(n, p) \
155	for ((p) = (n)->proplist; (p); (p) = (p)->next)
156
157#define for_each_child(n, c)	\
158	for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
159
160struct property *build_property(char *name, struct data val, char *label);
161struct property *chain_property(struct property *first, struct property *list);
162struct property *reverse_properties(struct property *first);
163
164struct node *build_node(struct property *proplist, struct node *children);
165struct node *name_node(struct node *node, char *name, char *label);
166struct node *chain_node(struct node *first, struct node *list);
167
168void add_property(struct node *node, struct property *prop);
169void add_child(struct node *parent, struct node *child);
170
171const char *get_unitname(struct node *node);
172struct property *get_property(struct node *node, const char *propname);
173cell_t propval_cell(struct property *prop);
174struct node *get_subnode(struct node *node, const char *nodename);
175struct node *get_node_by_path(struct node *tree, const char *path);
176struct node *get_node_by_label(struct node *tree, const char *label);
177struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
178struct node *get_node_by_ref(struct node *tree, const char *ref);
179cell_t get_node_phandle(struct node *root, struct node *node);
180
181/* Boot info (tree plus memreserve information */
182
183struct reserve_info {
184	struct fdt_reserve_entry re;
185
186	struct reserve_info *next;
187
188	char *label;
189};
190
191struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len, char *label);
192struct reserve_info *chain_reserve_entry(struct reserve_info *first,
193					 struct reserve_info *list);
194struct reserve_info *add_reserve_entry(struct reserve_info *list,
195				       struct reserve_info *new);
196
197
198struct boot_info {
199	struct reserve_info *reservelist;
200	struct node *dt;		/* the device tree */
201	uint32_t boot_cpuid_phys;
202};
203
204struct boot_info *build_boot_info(struct reserve_info *reservelist,
205				  struct node *tree, uint32_t boot_cpuid_phys);
206
207/* Checks */
208
209void process_checks(int force, struct boot_info *bi);
210
211/* Flattened trees */
212
213void dt_to_blob(FILE *f, struct boot_info *bi, int version);
214void dt_to_asm(FILE *f, struct boot_info *bi, int version);
215
216struct boot_info *dt_from_blob(const char *fname);
217
218/* Tree source */
219
220void dt_to_source(FILE *f, struct boot_info *bi);
221struct boot_info *dt_from_source(const char *f);
222
223/* FS trees */
224
225struct boot_info *dt_from_fs(const char *dirname);
226
227/* misc */
228
229char *join_path(const char *path, const char *name);
230
231#endif /* _DTC_H */
232