blob: 09dec54a1c4cadec1bde294a6ffe1242a4aac940 [file] [log] [blame]
David Gibsonfc14dad2005-06-08 17:18:34 +10001#ifndef _DTC_H
2#define _DTC_H
3
4/*
5 * (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2005.
6 *
David Gibson63dc9c72007-09-18 11:44:04 +10007 *
David Gibsonfc14dad2005-06-08 17:18:34 +10008 * 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.
David Gibson63dc9c72007-09-18 11:44:04 +100017 *
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
David Gibsonfc14dad2005-06-08 17:18:34 +100022 */
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#include <netinet/in.h>
David Gibsonf0517db2005-07-15 17:14:24 +100034#include <endian.h>
35#include <byteswap.h>
36
David Gibsonfb7c7ac2007-09-26 13:11:05 +100037#include <fdt.h>
David Gibsonfc14dad2005-06-08 17:18:34 +100038
David Gibsonfb7c7ac2007-09-26 13:11:05 +100039#define DEFAULT_FDT_VERSION 17
Jerry Van Barencd1da872007-03-18 16:49:24 -040040/*
Jerry Van Baren4384b232007-04-04 22:04:33 -040041 * Command line options
Jerry Van Barencd1da872007-03-18 16:49:24 -040042 */
Jerry Van Baren4384b232007-04-04 22:04:33 -040043extern int quiet; /* Level of quietness */
44extern int reservenum; /* Number of memory reservation slots */
45extern int minsize; /* Minimum blob size */
Jerry Van Barencd1da872007-03-18 16:49:24 -040046
David Gibsonbf944972007-08-31 16:21:23 +100047static inline void __attribute__((noreturn)) die(char * str, ...)
David Gibsonfc14dad2005-06-08 17:18:34 +100048{
49 va_list ap;
50
51 va_start(ap, str);
52 fprintf(stderr, "FATAL ERROR: ");
53 vfprintf(stderr, str, ap);
54 exit(1);
55}
56
57static inline void *xmalloc(size_t len)
58{
59 void *new = malloc(len);
60
61 if (! new)
62 die("malloc() failed\n");
63
64 return new;
65}
66
67static inline void *xrealloc(void *p, size_t len)
68{
69 void *new = realloc(p, len);
70
71 if (! new)
72 die("realloc() failed (len=%d)\n", len);
73
74 return new;
75}
76
David Gibson03a9b9d2005-07-11 16:49:52 +100077typedef uint8_t u8;
David Gibsonfc14dad2005-06-08 17:18:34 +100078typedef uint16_t u16;
79typedef uint32_t u32;
80typedef uint64_t u64;
81typedef u32 cell_t;
82
83#define cpu_to_be16(x) htons(x)
84#define be16_to_cpu(x) ntohs(x)
85
86#define cpu_to_be32(x) htonl(x)
87#define be32_to_cpu(x) ntohl(x)
88
David Gibsonf0517db2005-07-15 17:14:24 +100089#if __BYTE_ORDER == __BIG_ENDIAN
90#define cpu_to_be64(x) (x)
91#define be64_to_cpu(x) (x)
92#else
93#define cpu_to_be64(x) bswap_64(x)
94#define be64_to_cpu(x) bswap_64(x)
95#endif
David Gibsonfc14dad2005-06-08 17:18:34 +100096
97#define streq(a, b) (strcmp((a), (b)) == 0)
David Gibson81f2e892005-06-16 17:04:00 +100098#define strneq(a, b, n) (strncmp((a), (b), (n)) == 0)
99
David Gibsonfc14dad2005-06-08 17:18:34 +1000100#define ALIGN(x, a) (((x) + (a) - 1) & ~((a) - 1))
101#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
102
103/* Data blobs */
David Gibson81f2e892005-06-16 17:04:00 +1000104struct fixup {
105 int offset;
106 char *ref;
107 struct fixup *next;
108};
109
David Gibsonfc14dad2005-06-08 17:18:34 +1000110struct data {
111 int len;
112 char *val;
113 int asize;
David Gibson81f2e892005-06-16 17:04:00 +1000114 struct fixup *refs;
Milton Miller6a99b132007-07-07 01:18:51 -0500115 struct fixup *labels;
David Gibsonfc14dad2005-06-08 17:18:34 +1000116};
117
Milton Miller6a99b132007-07-07 01:18:51 -0500118#define empty_data ((struct data){ /* all .members = 0 or NULL */ })
David Gibsonfc14dad2005-06-08 17:18:34 +1000119
David Gibson81f2e892005-06-16 17:04:00 +1000120void fixup_free(struct fixup *f);
David Gibsonfc14dad2005-06-08 17:18:34 +1000121void data_free(struct data d);
122
123struct data data_grow_for(struct data d, int xlen);
124
125struct data data_copy_mem(char *mem, int len);
126struct data data_copy_escape_string(char *s, int len);
127struct data data_copy_file(FILE *f, size_t len);
128
129struct data data_append_data(struct data d, void *p, int len);
David Gibson32da4752007-02-07 16:37:50 +1100130struct data data_merge(struct data d1, struct data d2);
David Gibsonfc14dad2005-06-08 17:18:34 +1000131struct data data_append_cell(struct data d, cell_t word);
David Gibsonfb7c7ac2007-09-26 13:11:05 +1000132struct data data_append_re(struct data d, struct fdt_reserve_entry *re);
David Gibsonf0517db2005-07-15 17:14:24 +1000133struct data data_append_addr(struct data d, u64 addr);
David Gibsonfc14dad2005-06-08 17:18:34 +1000134struct data data_append_byte(struct data d, uint8_t byte);
135struct data data_append_zeroes(struct data d, int len);
136struct data data_append_align(struct data d, int align);
137
David Gibson81f2e892005-06-16 17:04:00 +1000138struct data data_add_fixup(struct data d, char *ref);
Milton Miller6a99b132007-07-07 01:18:51 -0500139struct data data_add_label(struct data d, char *label);
David Gibson81f2e892005-06-16 17:04:00 +1000140
David Gibsonfc14dad2005-06-08 17:18:34 +1000141int data_is_one_string(struct data d);
142
143/* DT constraints */
144
145#define MAX_PROPNAME_LEN 31
146#define MAX_NODENAME_LEN 31
147
148/* Live trees */
149struct property {
150 char *name;
151 struct data val;
152
153 struct property *next;
David Gibson4102d842005-06-16 14:36:37 +1000154
155 char *label;
David Gibsonfc14dad2005-06-08 17:18:34 +1000156};
157
158struct node {
159 char *name;
160 struct property *proplist;
161 struct node *children;
162
163 struct node *parent;
164 struct node *next_sibling;
165
166 char *fullpath;
167 int basenamelen;
168
169 cell_t phandle;
170 int addr_cells, size_cells;
David Gibson4102d842005-06-16 14:36:37 +1000171
172 char *label;
David Gibsonfc14dad2005-06-08 17:18:34 +1000173};
174
175#define for_each_property(n, p) \
176 for ((p) = (n)->proplist; (p); (p) = (p)->next)
177
178#define for_each_child(n, c) \
179 for ((c) = (n)->children; (c); (c) = (c)->next_sibling)
180
David Gibson4102d842005-06-16 14:36:37 +1000181struct property *build_property(char *name, struct data val, char *label);
David Gibsonfc14dad2005-06-08 17:18:34 +1000182struct property *chain_property(struct property *first, struct property *list);
183
184struct node *build_node(struct property *proplist, struct node *children);
David Gibson4102d842005-06-16 14:36:37 +1000185struct node *name_node(struct node *node, char *name, char *label);
David Gibsonfc14dad2005-06-08 17:18:34 +1000186struct node *chain_node(struct node *first, struct node *list);
187
188void add_property(struct node *node, struct property *prop);
189void add_child(struct node *parent, struct node *child);
190
Michael Neuling38e8f8f2006-05-31 08:31:51 +1000191int check_device_tree(struct node *dt, int outversion, int boot_cpuid_phys);
David Gibsonfc14dad2005-06-08 17:18:34 +1000192
David Gibsonf0517db2005-07-15 17:14:24 +1000193/* Boot info (tree plus memreserve information */
194
David Gibsonf040d952005-10-24 18:18:38 +1000195struct reserve_info {
David Gibsonfb7c7ac2007-09-26 13:11:05 +1000196 struct fdt_reserve_entry re;
David Gibsonf040d952005-10-24 18:18:38 +1000197
198 struct reserve_info *next;
199
200 char *label;
201};
202
203struct reserve_info *build_reserve_entry(u64 start, u64 len, char *label);
204struct reserve_info *chain_reserve_entry(struct reserve_info *first,
205 struct reserve_info *list);
206struct reserve_info *add_reserve_entry(struct reserve_info *list,
207 struct reserve_info *new);
208
209
David Gibsonf0517db2005-07-15 17:14:24 +1000210struct boot_info {
David Gibsonf040d952005-10-24 18:18:38 +1000211 struct reserve_info *reservelist;
David Gibsonf0517db2005-07-15 17:14:24 +1000212 struct node *dt; /* the device tree */
213};
214
David Gibsonf040d952005-10-24 18:18:38 +1000215struct boot_info *build_boot_info(struct reserve_info *reservelist,
David Gibsonf0517db2005-07-15 17:14:24 +1000216 struct node *tree);
217
David Gibsonfc14dad2005-06-08 17:18:34 +1000218/* Flattened trees */
219
Michael Neuling38e8f8f2006-05-31 08:31:51 +1000220void dt_to_blob(FILE *f, struct boot_info *bi, int version,
221 int boot_cpuid_phys);
222void dt_to_asm(FILE *f, struct boot_info *bi, int version,
223 int boot_cpuid_phys);
David Gibsonfc14dad2005-06-08 17:18:34 +1000224
David Gibsonf0517db2005-07-15 17:14:24 +1000225struct boot_info *dt_from_blob(FILE *f);
David Gibsonfc14dad2005-06-08 17:18:34 +1000226
227/* Tree source */
228
David Gibson712e52e2005-10-26 16:56:26 +1000229void dt_to_source(FILE *f, struct boot_info *bi);
Jon Loeligere45e6fd2007-03-23 15:18:41 -0500230struct boot_info *dt_from_source(const char *f);
David Gibsonfc14dad2005-06-08 17:18:34 +1000231
232/* FS trees */
233
David Gibsonf0517db2005-07-15 17:14:24 +1000234struct boot_info *dt_from_fs(char *dirname);
David Gibsonfc14dad2005-06-08 17:18:34 +1000235
236/* misc */
237
238char *join_path(char *path, char *name);
239void fill_fullpaths(struct node *tree, char *prefix);
240
241#endif /* _DTC_H */