/* * (C) Copyright David Gibson , IBM Corporation. 2005. * * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation; either version 2 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA */ #include "dtc.h" #include "flat_dt.h" #define FTF_FULLPATH 0x1 #define FTF_VARALIGN 0x2 #define FTF_NAMEPROPS 0x4 #define FTF_BOOTCPUID 0x8 #define FTF_STRTABSIZE 0x10 struct version_info { int version; int last_comp_version; int hdr_size; int flags; } version_table[] = { {1, 1, BPH_V1_SIZE, FTF_FULLPATH|FTF_VARALIGN|FTF_NAMEPROPS}, {2, 1, BPH_V2_SIZE, FTF_FULLPATH|FTF_VARALIGN|FTF_NAMEPROPS|FTF_BOOTCPUID}, {3, 1, BPH_V3_SIZE, FTF_FULLPATH|FTF_VARALIGN|FTF_NAMEPROPS|FTF_BOOTCPUID|FTF_STRTABSIZE}, {0x10, 0x10, BPH_V3_SIZE, FTF_BOOTCPUID|FTF_STRTABSIZE}, }; struct emitter { void (*cell)(void *, cell_t); void (*string)(void *, char *, int); void (*align)(void *, int); void (*data)(void *, struct data); void (*beginnode)(void *, char *); void (*endnode)(void *, char *); void (*property)(void *, char *); }; static void bin_emit_cell(void *e, cell_t val) { struct data *dtbuf = e; *dtbuf = data_append_cell(*dtbuf, val); } static void bin_emit_string(void *e, char *str, int len) { struct data *dtbuf = e; if (len == 0) len = strlen(str); *dtbuf = data_append_data(*dtbuf, str, len); *dtbuf = data_append_byte(*dtbuf, '\0'); } static void bin_emit_align(void *e, int a) { struct data *dtbuf = e; *dtbuf = data_append_align(*dtbuf, a); } static void bin_emit_data(void *e, struct data d) { struct data *dtbuf = e; *dtbuf = data_append_data(*dtbuf, d.val, d.len); } static void bin_emit_beginnode(void *e, char *label) { bin_emit_cell(e, OF_DT_BEGIN_NODE); } static void bin_emit_endnode(void *e, char *label) { bin_emit_cell(e, OF_DT_END_NODE); } static void bin_emit_property(void *e, char *label) { bin_emit_cell(e, OF_DT_PROP); } struct emitter bin_emitter = { .cell = bin_emit_cell, .string = bin_emit_string, .align = bin_emit_align, .data = bin_emit_data, .beginnode = bin_emit_beginnode, .endnode = bin_emit_endnode, .property = bin_emit_property, }; void emit_label(FILE *f, char *prefix, char *label) { fprintf(f, "\t.globl\t%s_%s\n", prefix, label); fprintf(f, "%s_%s:\n", prefix, label); fprintf(f, "_%s_%s:\n", prefix, label); } static void asm_emit_cell(void *e, cell_t val) { FILE *f = e; fprintf(f, "\t.long\t0x%x\n", be32_to_cpu(val)); } static void asm_emit_string(void *e, char *str, int len) { FILE *f = e; char c; if (len != 0) { /* XXX: ewww */ c = str[len]; str[len] = '\0'; } fprintf(f, "\t.string\t\"%s\"\n", str); if (len != 0) { str[len] = c; } } static void asm_emit_align(void *e, int a) { FILE *f = e; fprintf(f, "\t.balign\t%d\n", a); } static void asm_emit_data(void *e, struct data d) { FILE *f = e; int off = 0; while ((d.len - off) >= sizeof(u32)) { fprintf(f, "\t.long\t0x%x\n", be32_to_cpu(*((u32 *)(d.val+off)))); off += sizeof(u32); } if ((d.len - off) >= sizeof(u16)) { fprintf(f, "\t.short\t0x%hx\n", be16_to_cpu(*((u16 *)(d.val+off)))); off += sizeof(u16); } if ((d.len - off) >= 1) { fprintf(f, "\t.byte\t0x%hhx\n", d.val[off]); off += 1; } assert(off == d.len); } static void asm_emit_beginnode(void *e, char *label) { FILE *f = e; if (label) { fprintf(f, "\t.globl\t%s\n", label); fprintf(f, "%s:\n", label); } fprintf(f, "\t.long\tOF_DT_BEGIN_NODE\n"); } static void asm_emit_endnode(void *e, char *label) { FILE *f = e; fprintf(f, "\t.long\tOF_DT_END_NODE\n"); if (label) { fprintf(f, "\t.globl\t%s_end\n", label); fprintf(f, "%s_end:\n", label); } } static void asm_emit_property(void *e, char *label) { FILE *f = e; if (label) { fprintf(f, "\t.globl\t%s\n", label); fprintf(f, "%s:\n", label); } fprintf(f, "\t.long\tOF_DT_PROP\n"); } struct emitter asm_emitter = { .cell = asm_emit_cell, .string = asm_emit_string, .align = asm_emit_align, .data = asm_emit_data, .beginnode = asm_emit_beginnode, .endnode = asm_emit_endnode, .property = asm_emit_property, }; static int stringtable_insert(struct data *d, char *str) { int i; /* FIXME: do this more efficiently? */ for (i = 0; i < d->len; i++) { if (streq(str, d->val + i)) return i; } *d = data_append_data(*d, str, strlen(str)+1); return i; } static void flatten_tree(struct node *tree, struct emitter *emit, void *etarget, struct data *strbuf, struct version_info *vi) { struct property *prop; struct node *child; int seen_name_prop = 0; emit->beginnode(etarget, tree->label); if (vi->flags & FTF_FULLPATH) emit->string(etarget, tree->fullpath, 0); else emit->string(etarget, tree->name, 0); emit->align(etarget, sizeof(cell_t)); for_each_property(tree, prop) { int nameoff; if (streq(prop->name, "name")) seen_name_prop = 1; nameoff = stringtable_insert(strbuf, prop->name); emit->property(etarget, prop->label); emit->cell(etarget, prop->val.len); emit->cell(etarget, nameoff); if ((vi->flags & FTF_VARALIGN) && (prop->val.len >= 8)) emit->align(etarget, 8); emit->data(etarget, prop->val); emit->align(etarget, sizeof(cell_t)); } if ((vi->flags & FTF_NAMEPROPS) && !seen_name_prop) { emit->property(etarget, NULL); emit->cell(etarget, tree->basenamelen+1); emit->cell(etarget, stringtable_insert(strbuf, "name")); if ((vi->flags & FTF_VARALIGN) && ((tree->basenamelen+1) >= 8)) emit->align(etarget, 8); emit->string(etarget, tree->name, tree->basenamelen); } for_each_child(tree, child) { flatten_tree(child, emit, etarget, strbuf, vi); } emit->endnode(etarget, tree->label); } static void make_bph(struct boot_param_header *bph, struct version_info *vi, struct data *mem_reserve_data, int dtsize, int strsize) { int reserve_off; int reservenum = mem_reserve_data->len / sizeof(struct reserve_entry); int reservesize = (reservenum+1) * sizeof(struct reserve_entry); memset(bph, 0xff, sizeof(*bph)); bph->magic = cpu_to_be32(OF_DT_HEADER); bph->version = cpu_to_be32(vi->version); bph->last_comp_version = cpu_to_be32(vi->last_comp_version); /* Reserve map should be doubleword aligned */ reserve_off = ALIGN(vi->hdr_size, 8); bph->off_mem_rsvmap = cpu_to_be32(reserve_off); bph->off_dt_struct = cpu_to_be32(reserve_off + reservesize); bph->off_dt_strings = cpu_to_be32(reserve_off + reservesize + dtsize); bph->totalsize = cpu_to_be32(reserve_off + reservesize + dtsize + strsize); if (vi->flags & FTF_BOOTCPUID) bph->boot_cpuid_phys = 0xfeedbeef; if (vi->flags & FTF_STRTABSIZE) bph->size_dt_strings = cpu_to_be32(strsize); } void write_dt_blob(FILE *f, struct boot_info *bi, int version) { struct version_info *vi = NULL; int i; struct data dtbuf = empty_data; struct data strbuf = empty_data; struct boot_param_header bph; struct reserve_entry termre = {.address = 0, .size = 0}; for (i = 0; i < ARRAY_SIZE(version_table); i++) { if (version_table[i].version == version) vi = &version_table[i]; } if (!vi) die("Unknown device tree blob version %d\n", version); dtbuf = empty_data; strbuf = empty_data; flatten_tree(bi->dt, &bin_emitter, &dtbuf, &strbuf, vi); bin_emit_cell(&dtbuf, OF_DT_END); /* Make header */ make_bph(&bph, vi, &bi->mem_reserve_data, dtbuf.len, strbuf.len); fwrite(&bph, vi->hdr_size, 1, f); /* Align the reserve map to an 8 byte boundary */ for (i = vi->hdr_size; i < be32_to_cpu(bph.off_mem_rsvmap); i++) fputc(0, f); /* * Reserve map entries. * Since the blob is relocatable, the address of the map is not * determinable here, so no entry is made for the DT itself. * Each entry is an (address, size) pair of u64 values. * Always supply a zero-sized temination entry. */ fwrite(bi->mem_reserve_data.val, bi->mem_reserve_data.len, 1, f); fwrite(&termre, sizeof(termre), 1, f); fwrite(dtbuf.val, dtbuf.len, 1, f); fwrite(strbuf.val, strbuf.len, 1, f); if (ferror(f)) die("Error writing device tree blob: %s\n", strerror(errno)); data_free(dtbuf); data_free(strbuf); } void dump_stringtable_asm(FILE *f, struct data strbuf) { char *p; int len; p = strbuf.val; while (p < (strbuf.val + strbuf.len)) { len = strlen(p); fprintf(f, "\t.string \"%s\"\n", p); p += len+1; } } void write_dt_asm(FILE *f, struct boot_info *bi, int version) { struct version_info *vi = NULL; int i; struct data strbuf = empty_data; char *symprefix = "dt"; for (i = 0; i < ARRAY_SIZE(version_table); i++) { if (version_table[i].version == version) vi = &version_table[i]; } if (!vi) die("Unknown device tree blob version %d\n", version); fprintf(f, "/* autogenerated by dtc, do not edit */\n\n"); fprintf(f, "#define OF_DT_HEADER 0x%x\n", OF_DT_HEADER); fprintf(f, "#define OF_DT_BEGIN_NODE 0x%x\n", OF_DT_BEGIN_NODE); fprintf(f, "#define OF_DT_END_NODE 0x%x\n", OF_DT_END_NODE); fprintf(f, "#define OF_DT_PROP 0x%x\n", OF_DT_PROP); fprintf(f, "#define OF_DT_END 0x%x\n", OF_DT_END); fprintf(f, "\n"); emit_label(f, symprefix, "blob_start"); emit_label(f, symprefix, "header"); fprintf(f, "\t.long\tOF_DT_HEADER /* magic */\n"); fprintf(f, "\t.long\t_%s_blob_end - _%s_blob_start /* totalsize */\n", symprefix, symprefix); fprintf(f, "\t.long\t_%s_struct_start - _%s_blob_start /* off_dt_struct */\n", symprefix, symprefix); fprintf(f, "\t.long\t_%s_strings_start - _%s_blob_start /* off_dt_strings */\n", symprefix, symprefix); fprintf(f, "\t.long\t_%s_reserve_map - _%s_blob_start /* off_dt_strings */\n", symprefix, symprefix); fprintf(f, "\t.long\t%d /* version */\n", vi->version); fprintf(f, "\t.long\t%d /* last_comp_version */\n", vi->last_comp_version); if (vi->flags & FTF_BOOTCPUID) fprintf(f, "\t.long\t0xdeadbeef\t/*boot_cpuid_phys*/\n"); if (vi->flags & FTF_STRTABSIZE) fprintf(f, "\t.long\t_%s_strings_end - _%s_strings_start\t/* size_dt_strings */\n", symprefix, symprefix); /* * Reserve map entries. * Align the reserve map to a doubleword boundary. * Each entry is an (address, size) pair of u64 values. * Since the ASM file variant can relocate and compute the address * and size of the the device tree itself, and an entry for it. * Always supply a zero-sized temination entry. */ asm_emit_align(f, 8); emit_label(f, symprefix, "reserve_map"); fprintf(f, "\t.long\t0, _%s_blob_start\n", symprefix); fprintf(f, "\t.long\t0, _%s_blob_end - _%s_blob_start\n", symprefix, symprefix); if (bi->mem_reserve_data.len > 0) { fprintf(f, "/* Memory reserve map from source file */\n"); asm_emit_data(f, bi->mem_reserve_data); } fprintf(f, "\t.llong\t0\n"); fprintf(f, "\t.llong\t0\n"); emit_label(f, symprefix, "struct_start"); flatten_tree(bi->dt, &asm_emitter, f, &strbuf, vi); fprintf(f, "\t.long\tOF_DT_END\n"); emit_label(f, symprefix, "struct_end"); emit_label(f, symprefix, "strings_start"); dump_stringtable_asm(f, strbuf); emit_label(f, symprefix, "strings_end"); emit_label(f, symprefix, "blob_end"); data_free(strbuf); } struct inbuf { char *base, *limit, *ptr; }; static void inbuf_init(struct inbuf *inb, void *base, void *limit) { inb->base = base; inb->limit = limit; inb->ptr = inb->base; } static void flat_read_chunk(struct inbuf *inb, void *p, int len) { if ((inb->ptr + len) > inb->limit) die("Premature end of data parsing flat device tree\n"); memcpy(p, inb->ptr, len); inb->ptr += len; } static u32 flat_read_word(struct inbuf *inb) { u32 val; assert(((inb->ptr - inb->base) % sizeof(val)) == 0); flat_read_chunk(inb, &val, sizeof(val)); return be32_to_cpu(val); } static void flat_realign(struct inbuf *inb, int align) { int off = inb->ptr - inb->base; inb->ptr = inb->base + ALIGN(off, align); if (inb->ptr > inb->limit) die("Premature end of data parsing flat device tree\n"); } static char *flat_read_string(struct inbuf *inb) { int len = 0; char *p = inb->ptr; char *str; do { if (p >= inb->limit) die("Premature end of data parsing flat device tree\n"); len++; } while ((*p++) != '\0'); str = strdup(inb->ptr); inb->ptr += len; flat_realign(inb, sizeof(u32)); return str; } static struct data flat_read_data(struct inbuf *inb, int len) { struct data d = empty_data; if (len == 0) return empty_data; d = data_grow_for(d, len); d.len = len; flat_read_chunk(inb, d.val, len); flat_realign(inb, sizeof(u32)); return d; } static char *flat_read_stringtable(struct inbuf *inb, int offset) { char *p; p = inb->base + offset; while (1) { if (p >= inb->limit || p < inb->base) die("String offset %d overruns string table\n", offset); if (*p == '\0') break; p++; } return strdup(inb->base + offset); } struct property *flat_read_property(struct inbuf *dtbuf, struct inbuf *strbuf, int flags) { u32 proplen, stroff; char *name; struct data val; proplen = flat_read_word(dtbuf); stroff = flat_read_word(dtbuf); name = flat_read_stringtable(strbuf, stroff); if ((flags & FTF_VARALIGN) && (proplen >= 8)) flat_realign(dtbuf, 8); val = flat_read_data(dtbuf, proplen); return build_property(name, val, NULL); } static struct data flat_read_mem_reserve(struct inbuf *inb) { char *p; int len = 0; int done = 0; cell_t cells[4]; struct data d; d = empty_data; /* * Each entry is a pair of u64 (addr, size) values for 4 cell_t's. * List terminates at an entry with size equal to zero. * * First pass, count entries. */ p = inb->ptr; do { flat_read_chunk(inb, &cells[0], 4 * sizeof(cell_t)); if (cells[2] == 0 && cells[3] == 0) { done = 1; } else { ++len; } } while (!done); /* * Back up for pass two, reading the whole data value. */ inb->ptr = p; d = flat_read_data(inb, len * 4 * sizeof(cell_t)); return d; } static char *nodename_from_path(char *ppath, char *cpath) { char *lslash; int plen; lslash = strrchr(cpath, '/'); if (! lslash) return NULL; plen = lslash - cpath; if (streq(cpath, "/") && streq(ppath, "")) return ""; if ((plen == 0) && streq(ppath, "/")) return strdup(lslash+1); if (! strneq(ppath, cpath, plen)) return NULL; return strdup(lslash+1); } static const char PROPCHAR[] = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789,._+*#?-"; static const char UNITCHAR[] = "0123456789abcdef,"; static int check_node_name(char *name) { char *atpos; int basenamelen; atpos = strrchr(name, '@'); if (atpos) basenamelen = atpos - name; else basenamelen = strlen(name); if (strspn(name, PROPCHAR) < basenamelen) return -1; if (atpos && ((basenamelen + 1 + strspn(atpos+1, UNITCHAR)) < strlen(name))) return -1; return basenamelen; } static struct node *unflatten_tree(struct inbuf *dtbuf, struct inbuf *strbuf, char *parent_path, int flags) { struct node *node; u32 val; node = build_node(NULL, NULL); if (flags & FTF_FULLPATH) { node->fullpath = flat_read_string(dtbuf); node->name = nodename_from_path(parent_path, node->fullpath); if (! node->name) die("Path \"%s\" is not valid as a child of \"%s\"\n", node->fullpath, parent_path); } else { node->name = flat_read_string(dtbuf); node->fullpath = join_path(parent_path, node->name); } node->basenamelen = check_node_name(node->name); if (node->basenamelen < 0) { fprintf(stderr, "Warning \"%s\" has incorrect format\n", node->name); } do { struct property *prop; struct node *child; val = flat_read_word(dtbuf); switch (val) { case OF_DT_PROP: prop = flat_read_property(dtbuf, strbuf, flags); add_property(node, prop); break; case OF_DT_BEGIN_NODE: child = unflatten_tree(dtbuf,strbuf, node->fullpath, flags); add_child(node, child); break; case OF_DT_END_NODE: break; case OF_DT_END: die("Premature OF_DT_END in device tree blob\n"); break; default: die("Invalid opcode word %08x in device tree blob\n", val); } } while (val != OF_DT_END_NODE); return node; } struct boot_info *dt_from_blob(FILE *f) { u32 magic, totalsize, version, size_str; u32 off_dt, off_str, off_mem_rsvmap; int rc; char *blob; struct boot_param_header *bph; char *p; struct inbuf dtbuf, strbuf; struct inbuf memresvbuf; int sizeleft; struct data mem_reserve_data; struct node *tree; u32 val; int flags = 0; rc = fread(&magic, sizeof(magic), 1, f); if (ferror(f)) die("Error reading DT blob magic number: %s\n", strerror(errno)); if (rc < 1) { if (feof(f)) die("EOF reading DT blob magic number\n"); else die("Mysterious short read reading magic number\n"); } magic = be32_to_cpu(magic); if (magic != OF_DT_HEADER) die("Blob has incorrect magic number\n"); rc = fread(&totalsize, sizeof(totalsize), 1, f); if (ferror(f)) die("Error reading DT blob size: %s\n", strerror(errno)); if (rc < 1) { if (feof(f)) die("EOF reading DT blob size\n"); else die("Mysterious short read reading blob size\n"); } totalsize = be32_to_cpu(totalsize); if (totalsize < BPH_V1_SIZE) die("DT blob size (%d) is too small\n", totalsize); blob = xmalloc(totalsize); bph = (struct boot_param_header *)blob; bph->magic = cpu_to_be32(magic); bph->totalsize = cpu_to_be32(totalsize); sizeleft = totalsize - sizeof(magic) - sizeof(totalsize); p = blob + sizeof(magic) + sizeof(totalsize); while (sizeleft) { if (feof(f)) die("EOF before reading %d bytes of DT blob\n", totalsize); rc = fread(p, 1, sizeleft, f); if (ferror(f)) die("Error reading DT blob: %s\n", strerror(errno)); sizeleft -= rc; p += rc; } off_dt = be32_to_cpu(bph->off_dt_struct); off_str = be32_to_cpu(bph->off_dt_strings); off_mem_rsvmap = be32_to_cpu(bph->off_mem_rsvmap); version = be32_to_cpu(bph->version); fprintf(stderr, "\tmagic:\t\t\t0x%x\n", magic); fprintf(stderr, "\ttotalsize:\t\t%d\n", totalsize); fprintf(stderr, "\toff_dt_struct:\t\t0x%x\n", off_dt); fprintf(stderr, "\toff_dt_strings:\t\t0x%x\n", off_str); fprintf(stderr, "\toff_mem_rsvmap:\t\t0x%x\n", off_mem_rsvmap); fprintf(stderr, "\tversion:\t\t0x%x\n", version ); fprintf(stderr, "\tlast_comp_version:\t0x%x\n", be32_to_cpu(bph->last_comp_version)); if (off_mem_rsvmap >= totalsize) die("Mem Reserve structure offset exceeds total size\n"); if (off_dt >= totalsize) die("DT structure offset exceeds total size\n"); if (off_str > totalsize) die("String table offset exceeds total size\n"); if (version >= 2) fprintf(stderr, "\tboot_cpuid_phys:\t0x%x\n", be32_to_cpu(bph->boot_cpuid_phys)); if (version >= 3) { size_str = be32_to_cpu(bph->size_dt_strings); fprintf(stderr, "\tsize_dt_strings:\t%d\n", size_str); if (off_str+size_str > totalsize) die("String table extends past total size\n"); } if (version < 0x10) { flags |= FTF_FULLPATH | FTF_NAMEPROPS | FTF_VARALIGN; } inbuf_init(&memresvbuf, blob + off_mem_rsvmap, blob + totalsize); inbuf_init(&dtbuf, blob + off_dt, blob + totalsize); inbuf_init(&strbuf, blob + off_str, blob + totalsize); if (version >= 3) strbuf.limit = strbuf.base + size_str; mem_reserve_data = flat_read_mem_reserve(&memresvbuf); val = flat_read_word(&dtbuf); if (val != OF_DT_BEGIN_NODE) die("Device tree blob doesn't begin with OF_DT_BEGIN_NODE\n"); tree = unflatten_tree(&dtbuf, &strbuf, "", flags); val = flat_read_word(&dtbuf); if (val != OF_DT_END) die("Device tree blob doesn't end with OF_DT_END\n"); free(blob); return build_boot_info(mem_reserve_data, tree); }