Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2#ifndef DTC_H
3#define DTC_H
4
5/*
6 * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2005.
7 */
8
9#include <stdio.h>
10#include <string.h>
11#include <stdlib.h>
12#include <stdint.h>
13#include <stdbool.h>
14#include <stdarg.h>
15#include <assert.h>
16#include <ctype.h>
17#include <errno.h>
18#include <unistd.h>
19#include <inttypes.h>
20
21#include <libfdt_env.h>
22#include <fdt.h>
23
24#include "util.h"
25
26#ifdef DEBUG
27#define debug(...) printf(__VA_ARGS__)
28#else
29#define debug(...)
30#endif
31
32#define DEFAULT_FDT_VERSION 17
33
34/*
35 * Command line options
36 */
37extern int quiet; /* Level of quietness */
38extern int reservenum; /* Number of memory reservation slots */
39extern int minsize; /* Minimum blob size */
40extern int padsize; /* Additional padding to blob */
41extern int alignsize; /* Additional padding to blob accroding to the alignsize */
42extern int phandle_format; /* Use linux,phandle or phandle properties */
43extern int generate_symbols; /* generate symbols for nodes with labels */
44extern int generate_fixups; /* generate fixups */
45extern int auto_label_aliases; /* auto generate labels -> aliases */
46extern int annotate; /* annotate .dts with input source location */
47
48#define PHANDLE_LEGACY 0x1
49#define PHANDLE_EPAPR 0x2
50#define PHANDLE_BOTH 0x3
51
52typedef uint32_t cell_t;
53
54
55#define streq(a, b) (strcmp((a), (b)) == 0)
56#define strstarts(s, prefix) (strncmp((s), (prefix), strlen(prefix)) == 0)
57#define strprefixeq(a, n, b) (strlen(b) == (n) && (memcmp(a, b, n) == 0))
58
59#define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
60
61/* Data blobs */
62enum markertype {
63 TYPE_NONE,
64 REF_PHANDLE,
65 REF_PATH,
66 LABEL,
67 TYPE_UINT8,
68 TYPE_UINT16,
69 TYPE_UINT32,
70 TYPE_UINT64,
71 TYPE_STRING,
72};
73extern const char *markername(enum markertype markertype);
74
75struct marker {
76 enum markertype type;
77 int offset;
78 char *ref;
79 struct marker *next;
80};
81
82struct data {
83 int len;
84 char *val;
85 struct marker *markers;
86};
87
88
89#define empty_data ((struct data){ 0 /* all .members = 0 or NULL */ })
90
91#define for_each_marker(m) \
92 for (; (m); (m) = (m)->next)
93#define for_each_marker_of_type(m, t) \
94 for_each_marker(m) \
95 if ((m)->type == (t))
96
97size_t type_marker_length(struct marker *m);
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_integer(struct data d, uint64_t word, int bits);
113struct data data_append_re(struct data d, uint64_t address, uint64_t size);
114struct data data_append_addr(struct data d, uint64_t addr);
115struct data data_append_byte(struct data d, uint8_t byte);
116struct data data_append_zeroes(struct data d, int len);
117struct data data_append_align(struct data d, int align);
118
119struct data data_add_marker(struct data d, enum markertype type, char *ref);
120
121bool data_is_one_string(struct data d);
122
123/* DT constraints */
124
125#define MAX_PROPNAME_LEN 31
126#define MAX_NODENAME_LEN 31
127
128/* Live trees */
129struct label {
130 bool deleted;
131 char *label;
132 struct label *next;
133};
134
135struct bus_type {
136 const char *name;
137};
138
139struct property {
140 bool deleted;
141 char *name;
142 struct data val;
143
144 struct property *next;
145
146 struct label *labels;
147 struct srcpos *srcpos;
148};
149
150struct node {
151 bool deleted;
152 char *name;
153 struct property *proplist;
154 struct node *children;
155
156 struct node *parent;
157 struct node *next_sibling;
158
159 char *fullpath;
160 int basenamelen;
161
162 cell_t phandle;
163 int addr_cells, size_cells;
164
165 struct label *labels;
166 const struct bus_type *bus;
167 struct srcpos *srcpos;
168
169 bool omit_if_unused, is_referenced;
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,
197 struct srcpos *srcpos);
198struct property *build_property_delete(char *name);
199struct property *chain_property(struct property *first, struct property *list);
200struct property *reverse_properties(struct property *first);
201
202struct node *build_node(struct property *proplist, struct node *children,
203 struct srcpos *srcpos);
204struct node *build_node_delete(struct srcpos *srcpos);
205struct node *name_node(struct node *node, char *name);
206struct node *omit_node_if_unused(struct node *node);
207struct node *reference_node(struct node *node);
208struct node *chain_node(struct node *first, struct node *list);
209struct node *merge_nodes(struct node *old_node, struct node *new_node);
210struct node *add_orphan_node(struct node *old_node, struct node *new_node, char *ref);
211
212void add_property(struct node *node, struct property *prop);
213void delete_property_by_name(struct node *node, char *name);
214void delete_property(struct property *prop);
215void add_child(struct node *parent, struct node *child);
216void delete_node_by_name(struct node *parent, char *name);
217void delete_node(struct node *node);
218void append_to_property(struct node *node,
219 char *name, const void *data, int len);
220
221const char *get_unitname(struct node *node);
222struct property *get_property(struct node *node, const char *propname);
223cell_t propval_cell(struct property *prop);
224cell_t propval_cell_n(struct property *prop, int n);
225struct property *get_property_by_label(struct node *tree, const char *label,
226 struct node **node);
227struct marker *get_marker_label(struct node *tree, const char *label,
228 struct node **node, struct property **prop);
229struct node *get_subnode(struct node *node, const char *nodename);
230struct node *get_node_by_path(struct node *tree, const char *path);
231struct node *get_node_by_label(struct node *tree, const char *label);
232struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
233struct node *get_node_by_ref(struct node *tree, const char *ref);
234cell_t get_node_phandle(struct node *root, struct node *node);
235
236uint32_t guess_boot_cpuid(struct node *tree);
237
238/* Boot info (tree plus memreserve information */
239
240struct reserve_info {
241 uint64_t address, size;
242
243 struct reserve_info *next;
244
245 struct label *labels;
246};
247
248struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
249struct reserve_info *chain_reserve_entry(struct reserve_info *first,
250 struct reserve_info *list);
251struct reserve_info *add_reserve_entry(struct reserve_info *list,
252 struct reserve_info *new);
253
254
255struct dt_info {
256 unsigned int dtsflags;
257 struct reserve_info *reservelist;
258 uint32_t boot_cpuid_phys;
259 struct node *dt; /* the device tree */
260 const char *outname; /* filename being written to, "-" for stdout */
261};
262
263/* DTS version flags definitions */
264#define DTSF_V1 0x0001 /* /dts-v1/ */
265#define DTSF_PLUGIN 0x0002 /* /plugin/ */
266
267struct dt_info *build_dt_info(unsigned int dtsflags,
268 struct reserve_info *reservelist,
269 struct node *tree, uint32_t boot_cpuid_phys);
270void sort_tree(struct dt_info *dti);
271void generate_label_tree(struct dt_info *dti, char *name, bool allocph);
272void generate_fixups_tree(struct dt_info *dti, char *name);
273void generate_local_fixups_tree(struct dt_info *dti, char *name);
274
275/* Checks */
276
277void parse_checks_option(bool warn, bool error, const char *arg);
278void process_checks(bool force, struct dt_info *dti);
279
280/* Flattened trees */
281
282void dt_to_blob(FILE *f, struct dt_info *dti, int version);
283void dt_to_asm(FILE *f, struct dt_info *dti, int version);
284
285struct dt_info *dt_from_blob(const char *fname);
286
287/* Tree source */
288
289void dt_to_source(FILE *f, struct dt_info *dti);
290struct dt_info *dt_from_source(const char *f);
291
292/* YAML source */
293
294void dt_to_yaml(FILE *f, struct dt_info *dti);
295
296/* FS trees */
297
298struct dt_info *dt_from_fs(const char *dirname);
299
300#endif /* DTC_H */