2 * common utility functions for cbfstool
4 * Copyright (C) 2009 coresystems GmbH
5 * written by Patrick Georgi <patrick.georgi@coresystems.de>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
31 uint32_t getfilesize(const char *filename)
34 FILE *file = fopen(filename, "rb");
35 fseek(file, 0, SEEK_END);
41 void *loadfile(const char *filename, uint32_t * romsize_p, void *content,
44 FILE *file = fopen(filename, "rb");
47 fseek(file, 0, SEEK_END);
48 *romsize_p = ftell(file);
49 fseek(file, 0, SEEK_SET);
51 content = malloc(*romsize_p);
53 printf("Could not get %d bytes for file %s\n",
54 *romsize_p, filename);
57 } else if (place == SEEK_END)
58 content -= *romsize_p;
60 if (!fread(content, *romsize_p, 1, file)) {
61 printf("failed to read %s\n", filename);
68 struct cbfs_header *master_header;
69 uint32_t phys_start, phys_end, align, romsize;
72 void recalculate_rom_geometry(void *romarea)
74 offset = romarea + romsize - 0x100000000ULL;
75 master_header = (struct cbfs_header *)
76 phys_to_virt(*((uint32_t *) phys_to_virt(0xfffffffc)));
77 phys_start = (0 - romsize + ntohl(master_header->offset)) & 0xffffffff;
79 (0 - ntohl(master_header->bootblocksize) -
80 sizeof(struct cbfs_header)) & 0xffffffff;
81 align = ntohl(master_header->align);
84 void *loadrom(const char *filename)
86 void *romarea = loadfile(filename, &romsize, 0, SEEK_SET);
89 recalculate_rom_geometry(romarea);
93 int writerom(const char *filename, void *start, uint32_t size)
95 FILE *file = fopen(filename, "wb");
97 fprintf(stderr, "Could not open '%s' for writing: ", filename);
102 if (fwrite(start, size, 1, file) != 1) {
103 fprintf(stderr, "Could not write to '%s': ", filename);
112 int cbfs_file_header(uint32_t physaddr)
114 /* maybe improve this test */
115 return (strncmp(phys_to_virt(physaddr), "LARCHIVE", 8) == 0);
118 struct cbfs_file *cbfs_create_empty_file(uint32_t physaddr, uint32_t size)
120 struct cbfs_file *nextfile = (struct cbfs_file *)phys_to_virt(physaddr);
121 strncpy((char *)(nextfile->magic), "LARCHIVE", 8);
122 nextfile->len = htonl(size);
123 nextfile->type = htonl(0xffffffff);
124 nextfile->checksum = 0; // FIXME?
125 nextfile->offset = htonl(sizeof(struct cbfs_file) + 16);
126 memset(((void *)nextfile) + sizeof(struct cbfs_file), 0, 16);
130 int iself(unsigned char *input)
132 Elf32_Ehdr *ehdr = (Elf32_Ehdr *) input;
133 return !memcmp(ehdr->e_ident, ELFMAG, 4);
140 {CBFS_COMPONENT_STAGE, "stage"},
141 {CBFS_COMPONENT_PAYLOAD, "payload"},
142 {CBFS_COMPONENT_OPTIONROM, "optionrom"},
143 {CBFS_COMPONENT_BOOTSPLASH, "bootsplash"},
144 {CBFS_COMPONENT_RAW, "raw"},
145 {CBFS_COMPONENT_VSA, "vsa"},
146 {CBFS_COMPONENT_MBI, "mbi"},
147 {CBFS_COMPONENT_MICROCODE, "microcode"},
148 {CBFS_COMPONENT_CMOS_DEFAULT, "cmos default"},
149 {CBFS_COMPONENT_DELETED, "deleted"},
150 {CBFS_COMPONENT_NULL, "null"}
153 void print_supported_filetypes(void)
155 int i, number = ARRAY_SIZE(filetypes);
157 for (i=0; i<number; i++) {
158 printf(" %s%c", filetypes[i].name, (i==(number-1))?'\n':',');
164 const char *strfiletype(uint32_t number)
167 for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
168 if (filetypes[i].type == number)
169 return filetypes[i].name;
173 uint64_t intfiletype(const char *name)
176 for (i = 0; i < (sizeof(filetypes) / sizeof(struct filetypes_t)); i++)
177 if (strcmp(filetypes[i].name, name) == 0)
178 return filetypes[i].type;
182 void print_cbfs_directory(const char *filename)
185 ("%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
186 basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
187 romsize, ntohl(master_header->offset), align);
188 printf("%-30s %-10s %-12s Size\n", "Name", "Offset", "Type");
189 uint32_t current = phys_start;
190 while (current < phys_end) {
191 if (!cbfs_file_header(current)) {
195 struct cbfs_file *thisfile =
196 (struct cbfs_file *)phys_to_virt(current);
197 uint32_t length = ntohl(thisfile->len);
198 char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));
199 if (strlen(fname) == 0)
202 printf("%-30s 0x%-8x %-12s %d\n", fname,
203 current - phys_start, strfiletype(ntohl(thisfile->type)),
206 ALIGN(current + ntohl(thisfile->len) +
207 ntohl(thisfile->offset), align);
211 int extract_file_from_cbfs(const char *filename, const char *payloadname, const char *outpath)
213 // Identify the coreboot image.
215 "%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
216 basename((char *)filename), romsize / 1024, ntohl(master_header->bootblocksize),
217 romsize, ntohl(master_header->offset), align);
219 FILE *outfile = NULL;
220 uint32_t current = phys_start;
221 while (current < phys_end) {
222 if (!cbfs_file_header(current)) {
227 // Locate the file start struct
228 struct cbfs_file *thisfile =
229 (struct cbfs_file *)phys_to_virt(current);
231 uint32_t length = ntohl(thisfile->len);
232 // Locate the file name
233 char *fname = (char *)(phys_to_virt(current) + sizeof(struct cbfs_file));
235 // It's not the file we are looking for..
236 if (strcmp(fname, payloadname) != 0)
239 ALIGN(current + ntohl(thisfile->len) +
240 ntohl(thisfile->offset), align);
244 // Else, it's our file.
245 printf("Found file %.30s at 0x%x, type %.12s, size %d\n", fname,
246 current - phys_start, strfiletype(ntohl(thisfile->type)),
249 // If we are not dumping to stdout, open the out file.
250 outfile = fopen(outpath, "wb");
253 printf("Could not open the file %s for writing. Aborting.\n", outpath);
257 if (ntohl(thisfile->type) != CBFS_COMPONENT_RAW)
259 printf("Warning: only 'raw' files are safe to extract.\n");
262 fwrite(((char *)thisfile)
263 + ntohl(thisfile->offset), length, 1, outfile);
266 printf("Successfully dumped the file.\n");
268 // We'll only dump one file.
271 printf("File %s not found.\n", payloadname);
276 int add_file_to_cbfs(void *content, uint32_t contentsize, uint32_t location)
278 uint32_t current = phys_start;
279 while (current < phys_end) {
280 if (!cbfs_file_header(current)) {
284 struct cbfs_file *thisfile =
285 (struct cbfs_file *)phys_to_virt(current);
286 uint32_t length = ntohl(thisfile->len);
288 dprintf("at %x, %x bytes\n", current, length);
289 /* Is this a free chunk? */
290 if ((thisfile->type == CBFS_COMPONENT_DELETED)
291 || (thisfile->type == CBFS_COMPONENT_NULL)) {
292 dprintf("null||deleted at %x, %x bytes\n", current,
294 /* if this is the right size, and if specified, the right location, use it */
295 if ((contentsize <= length)
296 && ((location == 0) || (current == location))) {
297 if (contentsize < length) {
299 ("this chunk is %x bytes, we need %x. create a new chunk at %x with %x bytes\n",
301 ALIGN(current + contentsize,
303 length - contentsize);
305 ALIGN(current + contentsize, align);
307 current + ntohl(thisfile->offset)
308 + length - start - 16 -
309 sizeof(struct cbfs_file);
310 cbfs_create_empty_file(start, size);
312 dprintf("copying data\n");
313 memcpy(phys_to_virt(current), content,
318 /* CBFS has the constraint that the chain always moves up in memory. so once
319 we're past the place we seek, we don't need to look any further */
320 if (current > location) {
322 ("the requested space is not available\n");
326 /* Is the requested location inside the current chunk? */
327 if ((current < location)
328 && ((location + contentsize) <=
329 (current + length))) {
330 /* Split it up. In the next iteration the code will be at the right place. */
331 dprintf("split up. new length: %x\n",
333 ntohl(thisfile->offset));
335 htonl(location - current -
336 ntohl(thisfile->offset));
337 cbfs_create_empty_file(location,
345 ALIGN(current + ntohl(thisfile->len) +
346 ntohl(thisfile->offset), align);
348 printf("Could not add the file to CBFS, it's probably too big.\n");
349 printf("File size: %d bytes (%d KB).\n", contentsize, contentsize/1024);
354 static struct cbfs_file *merge_adjacent_files(struct cbfs_file *first,
355 struct cbfs_file *second)
357 uint32_t new_length =
358 ntohl(first->len) + ntohl(second->len) + ntohl(second->offset);
359 first->len = htonl(new_length);
360 first->checksum = 0; // FIXME?
364 static struct cbfs_file *next_file(struct cbfs_file *prev)
366 uint32_t pos = (prev == NULL) ? phys_start :
367 ALIGN(virt_to_phys(prev) + ntohl(prev->len) + ntohl(prev->offset),
370 for (; pos < phys_end; pos += align) {
371 if (cbfs_file_header(pos))
372 return (struct cbfs_file *)phys_to_virt(pos);
378 int remove_file_from_cbfs(const char *filename)
380 struct cbfs_file *prev = NULL;
381 struct cbfs_file *cur = next_file(prev);
382 struct cbfs_file *next = next_file(cur);
383 for (; cur; prev = cur, cur = next, next = next_file(next)) {
385 /* Check if this is the file to remove. */
386 char *name = (char *)cur + sizeof(*cur);
387 if (strcmp(name, filename))
390 /* Mark the file as free space and erase its name. */
391 cur->type = CBFS_COMPONENT_NULL;
394 /* Merge it with the previous file if possible. */
395 if (prev && prev->type == CBFS_COMPONENT_NULL)
396 cur = merge_adjacent_files(prev, cur);
398 /* Merge it with the next file if possible. */
399 if (next && next->type == CBFS_COMPONENT_NULL)
400 merge_adjacent_files(cur, next);
404 printf("CBFS file %s not found.\n", filename);
409 /* returns new data block with cbfs_file header, suitable to dump into the ROM. location returns
410 the new location that points to the cbfs_file header */
411 void *create_cbfs_file(const char *filename, void *data, uint32_t * datasize,
412 uint32_t type, uint32_t * location)
414 uint32_t filename_len = ALIGN(strlen(filename) + 1, 16);
415 uint32_t headersize = sizeof(struct cbfs_file) + filename_len;
416 if ((location != 0) && (*location != 0)) {
417 uint32_t offset = *location % align;
418 /* If offset >= (headersize % align), we can stuff the header into the offset.
419 Otherwise the header has to be aligned itself, and put before the offset data */
420 if (offset >= (headersize % align)) {
421 offset -= (headersize % align);
423 offset += align - (headersize % align);
425 headersize += offset;
426 *location -= headersize;
428 void *newdata = malloc(*datasize + headersize);
430 printf("Could not get %d bytes for CBFS file.\n", *datasize +
434 memset(newdata, 0xff, *datasize + headersize);
435 struct cbfs_file *nextfile = (struct cbfs_file *)newdata;
436 strncpy((char *)(nextfile->magic), "LARCHIVE", 8);
437 nextfile->len = htonl(*datasize);
438 nextfile->type = htonl(type);
439 nextfile->checksum = 0; // FIXME?
440 nextfile->offset = htonl(headersize);
441 strcpy(newdata + sizeof(struct cbfs_file), filename);
442 memcpy(newdata + headersize, data, *datasize);
443 *datasize += headersize;
447 int create_cbfs_image(const char *romfile, uint32_t _romsize,
448 const char *bootblock, uint32_t align)
451 unsigned char *romarea = malloc(romsize);
453 printf("Could not get %d bytes of memory for CBFS image.\n",
457 memset(romarea, 0xff, romsize);
459 // Set up physical/virtual mapping
460 offset = romarea + romsize - 0x100000000ULL;
465 uint32_t bootblocksize = 0;
466 loadfile(bootblock, &bootblocksize, romarea + romsize, SEEK_END);
467 struct cbfs_header *master_header =
468 (struct cbfs_header *)(romarea + romsize - bootblocksize -
469 sizeof(struct cbfs_header));
470 master_header->magic = ntohl(0x4f524243);
471 master_header->version = ntohl(0x31313131);
472 master_header->romsize = htonl(romsize);
473 master_header->bootblocksize = htonl(bootblocksize);
474 master_header->align = htonl(align);
475 master_header->offset = htonl(0);
476 ((uint32_t *) phys_to_virt(0xfffffffc))[0] =
477 virt_to_phys(master_header);
479 recalculate_rom_geometry(romarea);
481 cbfs_create_empty_file((0 - romsize) & 0xffffffff,
482 romsize - bootblocksize -
483 sizeof(struct cbfs_header) -
484 sizeof(struct cbfs_file) - 16);
486 writerom(romfile, romarea, romsize);
490 static int in_segment(int addr, int size, int gran)
492 return ((addr & ~(gran - 1)) == ((addr + size) & ~(gran - 1)));
495 uint32_t cbfs_find_location(const char *romfile, uint32_t filesize,
496 const char *filename, uint32_t alignment)
499 int filename_size = strlen(filename);
502 sizeof(struct cbfs_file) + ALIGN(filename_size + 1,
503 16) + sizeof(struct cbfs_stage);
504 int totalsize = headersize + filesize;
506 uint32_t current = phys_start;
507 while (current < phys_end) {
508 if (!cbfs_file_header(current)) {
512 struct cbfs_file *thisfile =
513 (struct cbfs_file *)phys_to_virt(current);
516 current + ntohl(thisfile->len) + ntohl(thisfile->offset);
517 if (((ntohl(thisfile->type) == 0x0)
518 || (ntohl(thisfile->type) == 0xffffffff))
519 && (ntohl(thisfile->len) + ntohl(thisfile->offset) >=
522 (current + headersize, filesize, alignment))
523 return current + headersize;
524 if ((ALIGN(current, alignment) + filesize < top)
525 && (ALIGN(current, alignment) - headersize >
527 && in_segment(ALIGN(current, alignment), filesize,
529 return ALIGN(current, alignment);
530 if ((ALIGN(current, alignment) + alignment + filesize <
532 && (ALIGN(current, alignment) + alignment -
533 headersize > current)
534 && in_segment(ALIGN(current, alignment) + alignment,
535 filesize, alignment))
536 return ALIGN(current, alignment) + alignment;
539 ALIGN(current + ntohl(thisfile->len) +
540 ntohl(thisfile->offset), align);