blob: 264a20cf66a8c6548c2f41b7266dac953937fd38 [file] [log] [blame]
David Gibsona4da2e32007-12-18 15:06:42 +11001#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>
Stephen Warrencd296722012-09-28 21:25:59 +000028#include <stdbool.h>
David Gibsona4da2e32007-12-18 15:06:42 +110029#include <stdarg.h>
30#include <assert.h>
31#include <ctype.h>
32#include <errno.h>
33#include <unistd.h>
David Gibsona4da2e32007-12-18 15:06:42 +110034
David Gibsoned95d742008-08-07 12:24:17 +100035#include <libfdt_env.h>
David Gibsona4da2e32007-12-18 15:06:42 +110036#include <fdt.h>
37
John Bonesio658f29a2010-11-17 15:28:20 -080038#include "util.h"
39
40#ifdef DEBUG
41#define debug(fmt,args...) printf(fmt, ##args)
42#else
43#define debug(fmt,args...)
44#endif
45
46
David Gibsona4da2e32007-12-18 15:06:42 +110047#define DEFAULT_FDT_VERSION 17
John Bonesio658f29a2010-11-17 15:28:20 -080048
David Gibsona4da2e32007-12-18 15:06:42 +110049/*
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 */
John Bonesio658f29a2010-11-17 15:28:20 -080056extern int phandle_format; /* Use linux,phandle or phandle properties */
David Gibsona4da2e32007-12-18 15:06:42 +110057
John Bonesio658f29a2010-11-17 15:28:20 -080058#define PHANDLE_LEGACY 0x1
59#define PHANDLE_EPAPR 0x2
60#define PHANDLE_BOTH 0x3
David Gibsona4da2e32007-12-18 15:06:42 +110061
David Gibsoned95d742008-08-07 12:24:17 +100062typedef uint32_t cell_t;
David Gibsona4da2e32007-12-18 15:06:42 +110063
David Gibsona4da2e32007-12-18 15:06:42 +110064
65#define streq(a, b) (strcmp((a), (b)) == 0)
66#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
67
68#define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
David Gibsona4da2e32007-12-18 15:06:42 +110069
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;
David Gibsona4da2e32007-12-18 15:06:42 +110087 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);
Stephen Warrencd296722012-09-28 21:25:59 +0000112struct data data_append_integer(struct data d, uint64_t word, int bits);
David Gibsona4da2e32007-12-18 15:06:42 +1100113struct data data_append_re(struct data d, const struct fdt_reserve_entry *re);
David Gibsoned95d742008-08-07 12:24:17 +1000114struct data data_append_addr(struct data d, uint64_t addr);
David Gibsona4da2e32007-12-18 15:06:42 +1100115struct 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
121int 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 */
John Bonesio658f29a2010-11-17 15:28:20 -0800129struct label {
Stephen Warrencd296722012-09-28 21:25:59 +0000130 int deleted;
John Bonesio658f29a2010-11-17 15:28:20 -0800131 char *label;
132 struct label *next;
133};
134
David Gibsona4da2e32007-12-18 15:06:42 +1100135struct property {
Stephen Warrencd296722012-09-28 21:25:59 +0000136 int deleted;
David Gibsona4da2e32007-12-18 15:06:42 +1100137 char *name;
138 struct data val;
139
140 struct property *next;
141
John Bonesio658f29a2010-11-17 15:28:20 -0800142 struct label *labels;
David Gibsona4da2e32007-12-18 15:06:42 +1100143};
144
145struct node {
Stephen Warrencd296722012-09-28 21:25:59 +0000146 int deleted;
David Gibsona4da2e32007-12-18 15:06:42 +1100147 char *name;
148 struct property *proplist;
149 struct node *children;
150
151 struct node *parent;
152 struct node *next_sibling;
153
154 char *fullpath;
155 int basenamelen;
156
157 cell_t phandle;
158 int addr_cells, size_cells;
159
John Bonesio658f29a2010-11-17 15:28:20 -0800160 struct label *labels;
David Gibsona4da2e32007-12-18 15:06:42 +1100161};
162
Stephen Warrencd296722012-09-28 21:25:59 +0000163#define for_each_label_withdel(l0, l) \
John Bonesio658f29a2010-11-17 15:28:20 -0800164 for ((l) = (l0); (l); (l) = (l)->next)
165
Stephen Warren205a8eb2012-10-08 16:15:26 -0600166#define for_each_label(l0, l) \
167 for_each_label_withdel(l0, l) \
168 if (!(l)->deleted)
Stephen Warrencd296722012-09-28 21:25:59 +0000169
170#define for_each_property_withdel(n, p) \
David Gibsona4da2e32007-12-18 15:06:42 +1100171 for ((p) = (n)->proplist; (p); (p) = (p)->next)
172
Stephen Warren205a8eb2012-10-08 16:15:26 -0600173#define for_each_property(n, p) \
174 for_each_property_withdel(n, p) \
175 if (!(p)->deleted)
Stephen Warrencd296722012-09-28 21:25:59 +0000176
177#define for_each_child_withdel(n, c) \
David Gibsona4da2e32007-12-18 15:06:42 +1100178 for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
179
Stephen Warren205a8eb2012-10-08 16:15:26 -0600180#define for_each_child(n, c) \
181 for_each_child_withdel(n, c) \
182 if (!(c)->deleted)
183
John Bonesio658f29a2010-11-17 15:28:20 -0800184void add_label(struct label **labels, char *label);
Stephen Warrencd296722012-09-28 21:25:59 +0000185void delete_labels(struct label **labels);
John Bonesio658f29a2010-11-17 15:28:20 -0800186
187struct property *build_property(char *name, struct data val);
Stephen Warrencd296722012-09-28 21:25:59 +0000188struct property *build_property_delete(char *name);
David Gibsona4da2e32007-12-18 15:06:42 +1100189struct property *chain_property(struct property *first, struct property *list);
190struct property *reverse_properties(struct property *first);
191
192struct node *build_node(struct property *proplist, struct node *children);
Stephen Warrencd296722012-09-28 21:25:59 +0000193struct node *build_node_delete(void);
John Bonesio658f29a2010-11-17 15:28:20 -0800194struct node *name_node(struct node *node, char *name);
David Gibsona4da2e32007-12-18 15:06:42 +1100195struct node *chain_node(struct node *first, struct node *list);
John Bonesio658f29a2010-11-17 15:28:20 -0800196struct node *merge_nodes(struct node *old_node, struct node *new_node);
David Gibsona4da2e32007-12-18 15:06:42 +1100197
198void add_property(struct node *node, struct property *prop);
Stephen Warrencd296722012-09-28 21:25:59 +0000199void delete_property_by_name(struct node *node, char *name);
200void delete_property(struct property *prop);
David Gibsona4da2e32007-12-18 15:06:42 +1100201void add_child(struct node *parent, struct node *child);
Stephen Warrencd296722012-09-28 21:25:59 +0000202void delete_node_by_name(struct node *parent, char *name);
203void delete_node(struct node *node);
David Gibsona4da2e32007-12-18 15:06:42 +1100204
205const char *get_unitname(struct node *node);
206struct property *get_property(struct node *node, const char *propname);
207cell_t propval_cell(struct property *prop);
John Bonesio658f29a2010-11-17 15:28:20 -0800208struct property *get_property_by_label(struct node *tree, const char *label,
209 struct node **node);
210struct marker *get_marker_label(struct node *tree, const char *label,
211 struct node **node, struct property **prop);
David Gibsona4da2e32007-12-18 15:06:42 +1100212struct node *get_subnode(struct node *node, const char *nodename);
213struct node *get_node_by_path(struct node *tree, const char *path);
214struct node *get_node_by_label(struct node *tree, const char *label);
215struct node *get_node_by_phandle(struct node *tree, cell_t phandle);
216struct node *get_node_by_ref(struct node *tree, const char *ref);
217cell_t get_node_phandle(struct node *root, struct node *node);
218
John Bonesio658f29a2010-11-17 15:28:20 -0800219uint32_t guess_boot_cpuid(struct node *tree);
220
David Gibsona4da2e32007-12-18 15:06:42 +1100221/* Boot info (tree plus memreserve information */
222
223struct reserve_info {
224 struct fdt_reserve_entry re;
225
226 struct reserve_info *next;
227
John Bonesio658f29a2010-11-17 15:28:20 -0800228 struct label *labels;
David Gibsona4da2e32007-12-18 15:06:42 +1100229};
230
John Bonesio658f29a2010-11-17 15:28:20 -0800231struct reserve_info *build_reserve_entry(uint64_t start, uint64_t len);
David Gibsona4da2e32007-12-18 15:06:42 +1100232struct reserve_info *chain_reserve_entry(struct reserve_info *first,
233 struct reserve_info *list);
234struct reserve_info *add_reserve_entry(struct reserve_info *list,
235 struct reserve_info *new);
236
237
238struct boot_info {
239 struct reserve_info *reservelist;
240 struct node *dt; /* the device tree */
David Gibsoned95d742008-08-07 12:24:17 +1000241 uint32_t boot_cpuid_phys;
David Gibsona4da2e32007-12-18 15:06:42 +1100242};
243
244struct boot_info *build_boot_info(struct reserve_info *reservelist,
David Gibsoned95d742008-08-07 12:24:17 +1000245 struct node *tree, uint32_t boot_cpuid_phys);
John Bonesio658f29a2010-11-17 15:28:20 -0800246void sort_tree(struct boot_info *bi);
David Gibsona4da2e32007-12-18 15:06:42 +1100247
248/* Checks */
249
Stephen Warrencd296722012-09-28 21:25:59 +0000250void parse_checks_option(bool warn, bool error, const char *optarg);
David Gibsoned95d742008-08-07 12:24:17 +1000251void process_checks(int force, struct boot_info *bi);
David Gibsona4da2e32007-12-18 15:06:42 +1100252
253/* Flattened trees */
254
David Gibsoned95d742008-08-07 12:24:17 +1000255void dt_to_blob(FILE *f, struct boot_info *bi, int version);
256void dt_to_asm(FILE *f, struct boot_info *bi, int version);
David Gibsona4da2e32007-12-18 15:06:42 +1100257
David Gibsoned95d742008-08-07 12:24:17 +1000258struct boot_info *dt_from_blob(const char *fname);
David Gibsona4da2e32007-12-18 15:06:42 +1100259
260/* Tree source */
261
262void dt_to_source(FILE *f, struct boot_info *bi);
263struct boot_info *dt_from_source(const char *f);
264
265/* FS trees */
266
267struct boot_info *dt_from_fs(const char *dirname);
268
David Gibsona4da2e32007-12-18 15:06:42 +1100269#endif /* _DTC_H */