kbuild: Fix compiler warning with assertion when calling 'fwrite'
[linux-2.6.git] / scripts / dtc / dtc.h
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  */
51 extern int quiet;               /* Level of quietness */
52 extern int reservenum;          /* Number of memory reservation slots */
53 extern int minsize;             /* Minimum blob size */
54 extern int padsize;             /* Additional padding to blob */
55 extern 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
61 typedef 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 */
71 enum markertype {
72         REF_PHANDLE,
73         REF_PATH,
74         LABEL,
75 };
76
77 struct  marker {
78         enum markertype type;
79         int offset;
80         char *ref;
81         struct marker *next;
82 };
83
84 struct 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
99 void data_free(struct data d);
100
101 struct data data_grow_for(struct data d, int xlen);
102
103 struct data data_copy_mem(const char *mem, int len);
104 struct data data_copy_escape_string(const char *s, int len);
105 struct data data_copy_file(FILE *f, size_t len);
106
107 struct data data_append_data(struct data d, const void *p, int len);
108 struct data data_insert_at_marker(struct data d, struct marker *m,
109                                   const void *p, int len);
110 struct data data_merge(struct data d1, struct data d2);
111 struct data data_append_cell(struct data d, cell_t word);
112 struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
113 struct data data_append_addr(struct data d, uint64_t addr);
114 struct data data_append_byte(struct data d, uint8_t byte);
115 struct data data_append_zeroes(struct data d, int len);
116 struct data data_append_align(struct data d, int align);
117
118 struct data data_add_marker(struct data d, enum markertype type, char *ref);
119
120 int 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 */
128 struct label {
129         char *label;
130         struct label *next;
131 };
132
133 struct property {
134         char *name;
135         struct data val;
136
137         struct property *next;
138
139         struct label *labels;
140 };
141
142 struct node {
143         char *name;
144         struct property *proplist;
145         struct node *children;
146
147         struct node *parent;
148         struct node *next_sibling;
149
150         char *fullpath;
151         int basenamelen;
152
153         cell_t phandle;
154         int addr_cells, size_cells;
155
156         struct label *labels;
157 };
158
159 #define for_each_label(l0, l) \
160         for ((l) = (l0); (l); (l) = (l)->next)
161
162 #define for_each_property(n, p) \
163         for ((p) = (n)->proplist; (p); (p) = (p)->next)
164
165 #define for_each_child(n, c)    \
166         for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
167
168 void add_label(struct label **labels, char *label);
169
170 struct property *build_property(char *name, struct data val);
171 struct property *chain_property(struct property *first, struct property *list);
172 struct property *reverse_properties(struct property *first);
173
174 struct node *build_node(struct property *proplist, struct node *children);
175 struct node *name_node(struct node *node, char *name);
176 struct node *chain_node(struct node *first, struct node *list);
177 struct node *merge_nodes(struct node *old_node, struct node *new_node);
178
179 void add_property(struct node *node, struct property *prop);
180 void add_child(struct node *parent, struct node *child);
181
182 const char *get_unitname(struct node *node);
183 struct property *get_property(struct node *node, const char *propname);
184 cell_t propval_cell(struct property *prop);
185 struct property *get_property_by_label(struct node *tree, const char *label,
186                                        struct node **node);
187 struct marker *get_marker_label(struct node *tree, const char *label,
188                                 struct node **node, struct property **prop);
189 struct node *get_subnode(struct node *node, const char *nodename);
190 struct node *get_node_by_path(struct node *tree, const char *path);
191 struct node *get_node_by_label(struct node *tree, const char *label);
192 struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
193 struct node *get_node_by_ref(struct node *tree, const char *ref);
194 cell_t get_node_phandle(struct node *root, struct node *node);
195
196 uint32_t guess_boot_cpuid(struct node *tree);
197
198 /* Boot info (tree plus memreserve information */
199
200 struct reserve_info {
201         struct fdt_reserve_entry re;
202
203         struct reserve_info *next;
204
205         struct label *labels;
206 };
207
208 struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
209 struct reserve_info *chain_reserve_entry(struct reserve_info *first,
210                                          struct reserve_info *list);
211 struct reserve_info *add_reserve_entry(struct reserve_info *list,
212                                        struct reserve_info *new);
213
214
215 struct boot_info {
216         struct reserve_info *reservelist;
217         struct node *dt;                /* the device tree */
218         uint32_t boot_cpuid_phys;
219 };
220
221 struct boot_info *build_boot_info(struct reserve_info *reservelist,
222                                   struct node *tree, uint32_t boot_cpuid_phys);
223 void sort_tree(struct boot_info *bi);
224
225 /* Checks */
226
227 void process_checks(int force, struct boot_info *bi);
228
229 /* Flattened trees */
230
231 void dt_to_blob(FILE *f, struct boot_info *bi, int version);
232 void dt_to_asm(FILE *f, struct boot_info *bi, int version);
233
234 struct boot_info *dt_from_blob(const char *fname);
235
236 /* Tree source */
237
238 void dt_to_source(FILE *f, struct boot_info *bi);
239 struct boot_info *dt_from_source(const char *f);
240
241 /* FS trees */
242
243 struct boot_info *dt_from_fs(const char *dirname);
244
245 #endif /* _DTC_H */