2
* (C) Copyright David Gibson <dwg@au1.ibm.com>, IBM Corporation. 2005.
5
* This program is free software; you can redistribute it and/or
6
* modify it under the terms of the GNU General Public License as
7
* published by the Free Software Foundation; either version 2 of the
8
* License, or (at your option) any later version.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
* General Public License for more details.
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24
#define FTF_FULLPATH 0x1
25
#define FTF_VARALIGN 0x2
26
#define FTF_NAMEPROPS 0x4
27
#define FTF_BOOTCPUID 0x8
28
#define FTF_STRTABSIZE 0x10
29
#define FTF_STRUCTSIZE 0x20
32
static struct version_info {
34
int last_comp_version;
39
FTF_FULLPATH|FTF_VARALIGN|FTF_NAMEPROPS},
41
FTF_FULLPATH|FTF_VARALIGN|FTF_NAMEPROPS|FTF_BOOTCPUID},
43
FTF_FULLPATH|FTF_VARALIGN|FTF_NAMEPROPS|FTF_BOOTCPUID|FTF_STRTABSIZE},
45
FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_NOPS},
46
{17, 16, FDT_V17_SIZE,
47
FTF_BOOTCPUID|FTF_STRTABSIZE|FTF_STRUCTSIZE|FTF_NOPS},
51
void (*cell)(void *, cell_t);
52
void (*string)(void *, char *, int);
53
void (*align)(void *, int);
54
void (*data)(void *, struct data);
55
void (*beginnode)(void *, const char *);
56
void (*endnode)(void *, const char *);
57
void (*property)(void *, const char *);
60
static void bin_emit_cell(void *e, cell_t val)
62
struct data *dtbuf = e;
64
*dtbuf = data_append_cell(*dtbuf, val);
67
static void bin_emit_string(void *e, char *str, int len)
69
struct data *dtbuf = e;
74
*dtbuf = data_append_data(*dtbuf, str, len);
75
*dtbuf = data_append_byte(*dtbuf, '\0');
78
static void bin_emit_align(void *e, int a)
80
struct data *dtbuf = e;
82
*dtbuf = data_append_align(*dtbuf, a);
85
static void bin_emit_data(void *e, struct data d)
87
struct data *dtbuf = e;
89
*dtbuf = data_append_data(*dtbuf, d.val, d.len);
92
static void bin_emit_beginnode(void *e, const char *label)
94
bin_emit_cell(e, FDT_BEGIN_NODE);
97
static void bin_emit_endnode(void *e, const char *label)
99
bin_emit_cell(e, FDT_END_NODE);
102
static void bin_emit_property(void *e, const char *label)
104
bin_emit_cell(e, FDT_PROP);
107
static struct emitter bin_emitter = {
108
.cell = bin_emit_cell,
109
.string = bin_emit_string,
110
.align = bin_emit_align,
111
.data = bin_emit_data,
112
.beginnode = bin_emit_beginnode,
113
.endnode = bin_emit_endnode,
114
.property = bin_emit_property,
117
static void emit_label(FILE *f, const char *prefix, const char *label)
119
fprintf(f, "\t.globl\t%s_%s\n", prefix, label);
120
fprintf(f, "%s_%s:\n", prefix, label);
121
fprintf(f, "_%s_%s:\n", prefix, label);
124
static void emit_offset_label(FILE *f, const char *label, int offset)
126
fprintf(f, "\t.globl\t%s\n", label);
127
fprintf(f, "%s\t= . + %d\n", label, offset);
130
static void asm_emit_cell(void *e, cell_t val)
134
fprintf(f, "\t.long\t0x%x\n", val);
137
static void asm_emit_string(void *e, char *str, int len)
148
fprintf(f, "\t.string\t\"%s\"\n", str);
155
static void asm_emit_align(void *e, int a)
159
fprintf(f, "\t.balign\t%d\n", a);
162
static void asm_emit_data(void *e, struct data d)
166
struct marker *m = d.markers;
168
for_each_marker_of_type(m, LABEL)
169
emit_offset_label(f, m->ref, m->offset);
171
while ((d.len - off) >= sizeof(uint32_t)) {
172
fprintf(f, "\t.long\t0x%x\n",
173
fdt32_to_cpu(*((uint32_t *)(d.val+off))));
174
off += sizeof(uint32_t);
177
while ((d.len - off) >= 1) {
178
fprintf(f, "\t.byte\t0x%hhx\n", d.val[off]);
182
assert(off == d.len);
185
static void asm_emit_beginnode(void *e, const char *label)
190
fprintf(f, "\t.globl\t%s\n", label);
191
fprintf(f, "%s:\n", label);
193
fprintf(f, "\t.long\tFDT_BEGIN_NODE\n");
196
static void asm_emit_endnode(void *e, const char *label)
200
fprintf(f, "\t.long\tFDT_END_NODE\n");
202
fprintf(f, "\t.globl\t%s_end\n", label);
203
fprintf(f, "%s_end:\n", label);
207
static void asm_emit_property(void *e, const char *label)
212
fprintf(f, "\t.globl\t%s\n", label);
213
fprintf(f, "%s:\n", label);
215
fprintf(f, "\t.long\tFDT_PROP\n");
218
static struct emitter asm_emitter = {
219
.cell = asm_emit_cell,
220
.string = asm_emit_string,
221
.align = asm_emit_align,
222
.data = asm_emit_data,
223
.beginnode = asm_emit_beginnode,
224
.endnode = asm_emit_endnode,
225
.property = asm_emit_property,
228
static int stringtable_insert(struct data *d, const char *str)
232
/* FIXME: do this more efficiently? */
234
for (i = 0; i < d->len; i++) {
235
if (streq(str, d->val + i))
239
*d = data_append_data(*d, str, strlen(str)+1);
243
static void flatten_tree(struct node *tree, struct emitter *emit,
244
void *etarget, struct data *strbuf,
245
struct version_info *vi)
247
struct property *prop;
249
int seen_name_prop = 0;
251
emit->beginnode(etarget, tree->label);
253
if (vi->flags & FTF_FULLPATH)
254
emit->string(etarget, tree->fullpath, 0);
256
emit->string(etarget, tree->name, 0);
258
emit->align(etarget, sizeof(cell_t));
260
for_each_property(tree, prop) {
263
if (streq(prop->name, "name"))
266
nameoff = stringtable_insert(strbuf, prop->name);
268
emit->property(etarget, prop->label);
269
emit->cell(etarget, prop->val.len);
270
emit->cell(etarget, nameoff);
272
if ((vi->flags & FTF_VARALIGN) && (prop->val.len >= 8))
273
emit->align(etarget, 8);
275
emit->data(etarget, prop->val);
276
emit->align(etarget, sizeof(cell_t));
279
if ((vi->flags & FTF_NAMEPROPS) && !seen_name_prop) {
280
emit->property(etarget, NULL);
281
emit->cell(etarget, tree->basenamelen+1);
282
emit->cell(etarget, stringtable_insert(strbuf, "name"));
284
if ((vi->flags & FTF_VARALIGN) && ((tree->basenamelen+1) >= 8))
285
emit->align(etarget, 8);
287
emit->string(etarget, tree->name, tree->basenamelen);
288
emit->align(etarget, sizeof(cell_t));
291
for_each_child(tree, child) {
292
flatten_tree(child, emit, etarget, strbuf, vi);
295
emit->endnode(etarget, tree->label);
298
static struct data flatten_reserve_list(struct reserve_info *reservelist,
299
struct version_info *vi)
301
struct reserve_info *re;
302
struct data d = empty_data;
303
static struct fdt_reserve_entry null_re = {0,0};
306
for (re = reservelist; re; re = re->next) {
307
d = data_append_re(d, &re->re);
310
* Add additional reserved slots if the user asked for them.
312
for (j = 0; j < reservenum; j++) {
313
d = data_append_re(d, &null_re);
319
static void make_fdt_header(struct fdt_header *fdt,
320
struct version_info *vi,
321
int reservesize, int dtsize, int strsize,
326
reservesize += sizeof(struct fdt_reserve_entry);
328
memset(fdt, 0xff, sizeof(*fdt));
330
fdt->magic = cpu_to_fdt32(FDT_MAGIC);
331
fdt->version = cpu_to_fdt32(vi->version);
332
fdt->last_comp_version = cpu_to_fdt32(vi->last_comp_version);
334
/* Reserve map should be doubleword aligned */
335
reserve_off = ALIGN(vi->hdr_size, 8);
337
fdt->off_mem_rsvmap = cpu_to_fdt32(reserve_off);
338
fdt->off_dt_struct = cpu_to_fdt32(reserve_off + reservesize);
339
fdt->off_dt_strings = cpu_to_fdt32(reserve_off + reservesize
341
fdt->totalsize = cpu_to_fdt32(reserve_off + reservesize + dtsize + strsize);
343
if (vi->flags & FTF_BOOTCPUID)
344
fdt->boot_cpuid_phys = cpu_to_fdt32(boot_cpuid_phys);
345
if (vi->flags & FTF_STRTABSIZE)
346
fdt->size_dt_strings = cpu_to_fdt32(strsize);
347
if (vi->flags & FTF_STRUCTSIZE)
348
fdt->size_dt_struct = cpu_to_fdt32(dtsize);
351
void dt_to_blob(FILE *f, struct boot_info *bi, int version)
353
struct version_info *vi = NULL;
355
struct data blob = empty_data;
356
struct data reservebuf = empty_data;
357
struct data dtbuf = empty_data;
358
struct data strbuf = empty_data;
359
struct fdt_header fdt;
362
for (i = 0; i < ARRAY_SIZE(version_table); i++) {
363
if (version_table[i].version == version)
364
vi = &version_table[i];
367
die("Unknown device tree blob version %d\n", version);
369
flatten_tree(bi->dt, &bin_emitter, &dtbuf, &strbuf, vi);
370
bin_emit_cell(&dtbuf, FDT_END);
372
reservebuf = flatten_reserve_list(bi->reservelist, vi);
375
make_fdt_header(&fdt, vi, reservebuf.len, dtbuf.len, strbuf.len,
376
bi->boot_cpuid_phys);
379
* If the user asked for more space than is used, adjust the totalsize.
382
padlen = minsize - fdt32_to_cpu(fdt.totalsize);
383
if ((padlen < 0) && (quiet < 1))
385
"Warning: blob size %d >= minimum size %d\n",
386
fdt32_to_cpu(fdt.totalsize), minsize);
393
int tsize = fdt32_to_cpu(fdt.totalsize);
395
fdt.totalsize = cpu_to_fdt32(tsize);
399
* Assemble the blob: start with the header, add with alignment
400
* the reserve buffer, add the reserve map terminating zeroes,
401
* the device tree itself, and finally the strings.
403
blob = data_append_data(blob, &fdt, vi->hdr_size);
404
blob = data_append_align(blob, 8);
405
blob = data_merge(blob, reservebuf);
406
blob = data_append_zeroes(blob, sizeof(struct fdt_reserve_entry));
407
blob = data_merge(blob, dtbuf);
408
blob = data_merge(blob, strbuf);
411
* If the user asked for more space than is used, pad out the blob.
414
blob = data_append_zeroes(blob, padlen);
416
fwrite(blob.val, blob.len, 1, f);
419
die("Error writing device tree blob: %s\n", strerror(errno));
422
* data_merge() frees the right-hand element so only the blob
423
* remains to be freed.
428
static void dump_stringtable_asm(FILE *f, struct data strbuf)
435
while (p < (strbuf.val + strbuf.len)) {
437
fprintf(f, "\t.string \"%s\"\n", p);
442
void dt_to_asm(FILE *f, struct boot_info *bi, int version)
444
struct version_info *vi = NULL;
446
struct data strbuf = empty_data;
447
struct reserve_info *re;
448
const char *symprefix = "dt";
450
for (i = 0; i < ARRAY_SIZE(version_table); i++) {
451
if (version_table[i].version == version)
452
vi = &version_table[i];
455
die("Unknown device tree blob version %d\n", version);
457
fprintf(f, "/* autogenerated by dtc, do not edit */\n\n");
458
fprintf(f, "#define FDT_MAGIC 0x%x\n", FDT_MAGIC);
459
fprintf(f, "#define FDT_BEGIN_NODE 0x%x\n", FDT_BEGIN_NODE);
460
fprintf(f, "#define FDT_END_NODE 0x%x\n", FDT_END_NODE);
461
fprintf(f, "#define FDT_PROP 0x%x\n", FDT_PROP);
462
fprintf(f, "#define FDT_END 0x%x\n", FDT_END);
465
emit_label(f, symprefix, "blob_start");
466
emit_label(f, symprefix, "header");
467
fprintf(f, "\t.long\tFDT_MAGIC\t\t\t\t/* magic */\n");
468
fprintf(f, "\t.long\t_%s_blob_abs_end - _%s_blob_start\t/* totalsize */\n",
469
symprefix, symprefix);
470
fprintf(f, "\t.long\t_%s_struct_start - _%s_blob_start\t/* off_dt_struct */\n",
471
symprefix, symprefix);
472
fprintf(f, "\t.long\t_%s_strings_start - _%s_blob_start\t/* off_dt_strings */\n",
473
symprefix, symprefix);
474
fprintf(f, "\t.long\t_%s_reserve_map - _%s_blob_start\t/* off_dt_strings */\n",
475
symprefix, symprefix);
476
fprintf(f, "\t.long\t%d\t\t\t\t\t/* version */\n", vi->version);
477
fprintf(f, "\t.long\t%d\t\t\t\t\t/* last_comp_version */\n",
478
vi->last_comp_version);
480
if (vi->flags & FTF_BOOTCPUID)
481
fprintf(f, "\t.long\t%i\t\t\t\t\t/* boot_cpuid_phys */\n",
482
bi->boot_cpuid_phys);
484
if (vi->flags & FTF_STRTABSIZE)
485
fprintf(f, "\t.long\t_%s_strings_end - _%s_strings_start\t/* size_dt_strings */\n",
486
symprefix, symprefix);
488
if (vi->flags & FTF_STRUCTSIZE)
489
fprintf(f, "\t.long\t_%s_struct_end - _%s_struct_start\t/* size_dt_struct */\n",
490
symprefix, symprefix);
493
* Reserve map entries.
494
* Align the reserve map to a doubleword boundary.
495
* Each entry is an (address, size) pair of u64 values.
496
* Always supply a zero-sized temination entry.
498
asm_emit_align(f, 8);
499
emit_label(f, symprefix, "reserve_map");
501
fprintf(f, "/* Memory reserve map from source file */\n");
504
* Use .long on high and low halfs of u64s to avoid .quad
505
* as it appears .quad isn't available in some assemblers.
507
for (re = bi->reservelist; re; re = re->next) {
509
fprintf(f, "\t.globl\t%s\n", re->label);
510
fprintf(f, "%s:\n", re->label);
512
fprintf(f, "\t.long\t0x%08x, 0x%08x\n",
513
(unsigned int)(re->re.address >> 32),
514
(unsigned int)(re->re.address & 0xffffffff));
515
fprintf(f, "\t.long\t0x%08x, 0x%08x\n",
516
(unsigned int)(re->re.size >> 32),
517
(unsigned int)(re->re.size & 0xffffffff));
519
for (i = 0; i < reservenum; i++) {
520
fprintf(f, "\t.long\t0, 0\n\t.long\t0, 0\n");
523
fprintf(f, "\t.long\t0, 0\n\t.long\t0, 0\n");
525
emit_label(f, symprefix, "struct_start");
526
flatten_tree(bi->dt, &asm_emitter, f, &strbuf, vi);
527
fprintf(f, "\t.long\tFDT_END\n");
528
emit_label(f, symprefix, "struct_end");
530
emit_label(f, symprefix, "strings_start");
531
dump_stringtable_asm(f, strbuf);
532
emit_label(f, symprefix, "strings_end");
534
emit_label(f, symprefix, "blob_end");
537
* If the user asked for more space than is used, pad it out.
540
fprintf(f, "\t.space\t%d - (_%s_blob_end - _%s_blob_start), 0\n",
541
minsize, symprefix, symprefix);
544
fprintf(f, "\t.space\t%d, 0\n", padsize);
546
emit_label(f, symprefix, "blob_abs_end");
552
char *base, *limit, *ptr;
555
static void inbuf_init(struct inbuf *inb, void *base, void *limit)
559
inb->ptr = inb->base;
562
static void flat_read_chunk(struct inbuf *inb, void *p, int len)
564
if ((inb->ptr + len) > inb->limit)
565
die("Premature end of data parsing flat device tree\n");
567
memcpy(p, inb->ptr, len);
572
static uint32_t flat_read_word(struct inbuf *inb)
576
assert(((inb->ptr - inb->base) % sizeof(val)) == 0);
578
flat_read_chunk(inb, &val, sizeof(val));
580
return fdt32_to_cpu(val);
583
static void flat_realign(struct inbuf *inb, int align)
585
int off = inb->ptr - inb->base;
587
inb->ptr = inb->base + ALIGN(off, align);
588
if (inb->ptr > inb->limit)
589
die("Premature end of data parsing flat device tree\n");
592
static char *flat_read_string(struct inbuf *inb)
595
const char *p = inb->ptr;
600
die("Premature end of data parsing flat device tree\n");
602
} while ((*p++) != '\0');
604
str = strdup(inb->ptr);
608
flat_realign(inb, sizeof(uint32_t));
613
static struct data flat_read_data(struct inbuf *inb, int len)
615
struct data d = empty_data;
620
d = data_grow_for(d, len);
623
flat_read_chunk(inb, d.val, len);
625
flat_realign(inb, sizeof(uint32_t));
630
static char *flat_read_stringtable(struct inbuf *inb, int offset)
634
p = inb->base + offset;
636
if (p >= inb->limit || p < inb->base)
637
die("String offset %d overruns string table\n",
646
return strdup(inb->base + offset);
649
static struct property *flat_read_property(struct inbuf *dtbuf,
650
struct inbuf *strbuf, int flags)
652
uint32_t proplen, stroff;
656
proplen = flat_read_word(dtbuf);
657
stroff = flat_read_word(dtbuf);
659
name = flat_read_stringtable(strbuf, stroff);
661
if ((flags & FTF_VARALIGN) && (proplen >= 8))
662
flat_realign(dtbuf, 8);
664
val = flat_read_data(dtbuf, proplen);
666
return build_property(name, val, NULL);
670
static struct reserve_info *flat_read_mem_reserve(struct inbuf *inb)
672
struct reserve_info *reservelist = NULL;
673
struct reserve_info *new;
675
struct fdt_reserve_entry re;
678
* Each entry is a pair of u64 (addr, size) values for 4 cell_t's.
679
* List terminates at an entry with size equal to zero.
681
* First pass, count entries.
685
flat_read_chunk(inb, &re, sizeof(re));
686
re.address = fdt64_to_cpu(re.address);
687
re.size = fdt64_to_cpu(re.size);
691
new = build_reserve_entry(re.address, re.size, NULL);
692
reservelist = add_reserve_entry(reservelist, new);
699
static char *nodename_from_path(const char *ppath, const char *cpath)
703
plen = strlen(ppath);
705
if (!strneq(ppath, cpath, plen))
706
die("Path \"%s\" is not valid as a child of \"%s\"\n",
709
/* root node is a special case */
710
if (!streq(ppath, "/"))
713
return strdup(cpath + plen);
716
static struct node *unflatten_tree(struct inbuf *dtbuf,
717
struct inbuf *strbuf,
718
const char *parent_flatname, int flags)
724
node = build_node(NULL, NULL);
726
flatname = flat_read_string(dtbuf);
728
if (flags & FTF_FULLPATH)
729
node->name = nodename_from_path(parent_flatname, flatname);
731
node->name = flatname;
734
struct property *prop;
737
val = flat_read_word(dtbuf);
741
fprintf(stderr, "Warning: Flat tree input has "
742
"subnodes preceding a property.\n");
743
prop = flat_read_property(dtbuf, strbuf, flags);
744
add_property(node, prop);
748
child = unflatten_tree(dtbuf,strbuf, flatname, flags);
749
add_child(node, child);
756
die("Premature FDT_END in device tree blob\n");
760
if (!(flags & FTF_NOPS))
761
fprintf(stderr, "Warning: NOP tag found in flat tree"
768
die("Invalid opcode word %08x in device tree blob\n",
771
} while (val != FDT_END_NODE);
777
struct boot_info *dt_from_blob(const char *fname)
779
struct dtc_file *dtcf;
780
uint32_t magic, totalsize, version, size_dt, boot_cpuid_phys;
781
uint32_t off_dt, off_str, off_mem_rsvmap;
784
struct fdt_header *fdt;
786
struct inbuf dtbuf, strbuf;
787
struct inbuf memresvbuf;
789
struct reserve_info *reservelist;
794
dtcf = dtc_open_file(fname, NULL);
796
rc = fread(&magic, sizeof(magic), 1, dtcf->file);
797
if (ferror(dtcf->file))
798
die("Error reading DT blob magic number: %s\n",
801
if (feof(dtcf->file))
802
die("EOF reading DT blob magic number\n");
804
die("Mysterious short read reading magic number\n");
807
magic = fdt32_to_cpu(magic);
808
if (magic != FDT_MAGIC)
809
die("Blob has incorrect magic number\n");
811
rc = fread(&totalsize, sizeof(totalsize), 1, dtcf->file);
812
if (ferror(dtcf->file))
813
die("Error reading DT blob size: %s\n", strerror(errno));
815
if (feof(dtcf->file))
816
die("EOF reading DT blob size\n");
818
die("Mysterious short read reading blob size\n");
821
totalsize = fdt32_to_cpu(totalsize);
822
if (totalsize < FDT_V1_SIZE)
823
die("DT blob size (%d) is too small\n", totalsize);
825
blob = xmalloc(totalsize);
827
fdt = (struct fdt_header *)blob;
828
fdt->magic = cpu_to_fdt32(magic);
829
fdt->totalsize = cpu_to_fdt32(totalsize);
831
sizeleft = totalsize - sizeof(magic) - sizeof(totalsize);
832
p = blob + sizeof(magic) + sizeof(totalsize);
835
if (feof(dtcf->file))
836
die("EOF before reading %d bytes of DT blob\n",
839
rc = fread(p, 1, sizeleft, dtcf->file);
840
if (ferror(dtcf->file))
841
die("Error reading DT blob: %s\n",
848
off_dt = fdt32_to_cpu(fdt->off_dt_struct);
849
off_str = fdt32_to_cpu(fdt->off_dt_strings);
850
off_mem_rsvmap = fdt32_to_cpu(fdt->off_mem_rsvmap);
851
version = fdt32_to_cpu(fdt->version);
852
boot_cpuid_phys = fdt32_to_cpu(fdt->boot_cpuid_phys);
854
if (off_mem_rsvmap >= totalsize)
855
die("Mem Reserve structure offset exceeds total size\n");
857
if (off_dt >= totalsize)
858
die("DT structure offset exceeds total size\n");
860
if (off_str > totalsize)
861
die("String table offset exceeds total size\n");
864
uint32_t size_str = fdt32_to_cpu(fdt->size_dt_strings);
865
if (off_str+size_str > totalsize)
866
die("String table extends past total size\n");
867
inbuf_init(&strbuf, blob + off_str, blob + off_str + size_str);
869
inbuf_init(&strbuf, blob + off_str, blob + totalsize);
873
size_dt = fdt32_to_cpu(fdt->size_dt_struct);
874
if (off_dt+size_dt > totalsize)
875
die("Structure block extends past total size\n");
879
flags |= FTF_FULLPATH | FTF_NAMEPROPS | FTF_VARALIGN;
884
inbuf_init(&memresvbuf,
885
blob + off_mem_rsvmap, blob + totalsize);
886
inbuf_init(&dtbuf, blob + off_dt, blob + totalsize);
888
reservelist = flat_read_mem_reserve(&memresvbuf);
890
val = flat_read_word(&dtbuf);
892
if (val != FDT_BEGIN_NODE)
893
die("Device tree blob doesn't begin with FDT_BEGIN_NODE (begins with 0x%08x)\n", val);
895
tree = unflatten_tree(&dtbuf, &strbuf, "", flags);
897
val = flat_read_word(&dtbuf);
899
die("Device tree blob doesn't end with FDT_END\n");
903
dtc_close_file(dtcf);
905
return build_boot_info(reservelist, tree, boot_cpuid_phys);