Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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(...) printf(__VA_ARGS__)
42#else
43#define debug(...)
44#endif
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 alignsize; /* Additional padding to blob accroding to the alignsize */
56extern int phandle_format; /* Use linux,phandle or phandle properties */
57extern int generate_symbols; /* generate symbols for nodes with labels */
58extern int generate_fixups; /* generate fixups */
59extern int auto_label_aliases; /* auto generate labels -> aliases */
60
61#define PHANDLE_LEGACY 0x1
62#define PHANDLE_EPAPR 0x2
63#define PHANDLE_BOTH 0x3
64
65typedef uint32_t cell_t;
66
67
68#define streq(a, b) (strcmp((a), (b)) == 0)
69#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
70
71#define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
72
73/* Data blobs */
74enum markertype {
75 REF_PHANDLE,
76 REF_PATH,
77 LABEL,
78};
79
80struct marker {
81 enum markertype type;
82 int offset;
83 char *ref;
84 struct marker *next;
85};
86
87struct data {
88 int len;
89 char *val;
90 struct marker *markers;
91};
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
171#define for_each_label_withdel(l0, l) \
172 for ((l) = (l0); (l); (l) = (l)->next)
173
174#define for_each_label(l0, l) \
175 for_each_label_withdel(l0, l) \
176 if (!(l)->deleted)
177
178#define for_each_property_withdel(n, p) \
179 for ((p) = (n)->proplist; (p); (p) = (p)->next)
180
181#define for_each_property(n, p) \
182 for_each_property_withdel(n, p) \
183 if (!(p)->deleted)
184
185#define for_each_child_withdel(n, c) \
186 for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
187
188#define for_each_child(n, c) \
189 for_each_child_withdel(n, c) \
190 if (!(c)->deleted)
191
192void add_label(struct label **labels, char *label);
193void delete_labels(struct label **labels);
194
195struct property *build_property(char *name, struct data val);
196struct property *build_property_delete(char *name);
197struct property *chain_property(struct property *first, struct property *list);
198struct property *reverse_properties(struct property *first);
199
200struct node *build_node(struct property *proplist, struct node *children);
201struct node *build_node_delete(void);
202struct node *name_node(struct node *node, char *name);
203struct node *chain_node(struct node *first, struct node *list);
204struct node *merge_nodes(struct node *old_node, struct node *new_node);
205
206void add_property(struct node *node, struct property *prop);
207void delete_property_by_name(struct node *node, char *name);
208void delete_property(struct property *prop);
209void add_child(struct node *parent, struct node *child);
210void delete_node_by_name(struct node *parent, char *name);
211void delete_node(struct node *node);
212void append_to_property(struct node *node,
213 char *name, const void *data, int len);
214
215const char *get_unitname(struct node *node);
216struct property *get_property(struct node *node, const char *propname);
217cell_t propval_cell(struct property *prop);
218struct property *get_property_by_label(struct node *tree, const char *label,
219 struct node **node);
220struct marker *get_marker_label(struct node *tree, const char *label,
221 struct node **node, struct property **prop);
222struct node *get_subnode(struct node *node, const char *nodename);
223struct node *get_node_by_path(struct node *tree, const char *path);
224struct node *get_node_by_label(struct node *tree, const char *label);
225struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
226struct node *get_node_by_ref(struct node *tree, const char *ref);
227cell_t get_node_phandle(struct node *root, struct node *node);
228
229uint32_t guess_boot_cpuid(struct node *tree);
230
231/* Boot info (tree plus memreserve information */
232
233struct reserve_info {
234 uint64_t address, size;
235
236 struct reserve_info *next;
237
238 struct label *labels;
239};
240
241struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
242struct reserve_info *chain_reserve_entry(struct reserve_info *first,
243 struct reserve_info *list);
244struct reserve_info *add_reserve_entry(struct reserve_info *list,
245 struct reserve_info *new);
246
247
248struct dt_info {
249 unsigned int dtsflags;
250 struct reserve_info *reservelist;
251 uint32_t boot_cpuid_phys;
252 struct node *dt; /* the device tree */
253 const char *outname; /* filename being written to, "-" for stdout */
254};
255
256/* DTS version flags definitions */
257#define DTSF_V1 0x0001 /* /dts-v1/ */
258#define DTSF_PLUGIN 0x0002 /* /plugin/ */
259
260struct dt_info *build_dt_info(unsigned int dtsflags,
261 struct reserve_info *reservelist,
262 struct node *tree, uint32_t boot_cpuid_phys);
263void sort_tree(struct dt_info *dti);
264void generate_label_tree(struct dt_info *dti, char *name, bool allocph);
265void generate_fixups_tree(struct dt_info *dti, char *name);
266void generate_local_fixups_tree(struct dt_info *dti, char *name);
267
268/* Checks */
269
270void parse_checks_option(bool warn, bool error, const char *arg);
271void process_checks(bool force, struct dt_info *dti);
272
273/* Flattened trees */
274
275void dt_to_blob(FILE *f, struct dt_info *dti, int version);
276void dt_to_asm(FILE *f, struct dt_info *dti, int version);
277
278struct dt_info *dt_from_blob(const char *fname);
279
280/* Tree source */
281
282void dt_to_source(FILE *f, struct dt_info *dti);
283struct dt_info *dt_from_source(const char *f);
284
285/* FS trees */
286
287struct dt_info *dt_from_fs(const char *dirname);
288
289#endif /* _DTC_H */