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