2 * common utility functions for cbfstool
4 * Copyright (C) 2009 coresystems GmbH
5 * written by Patrick Georgi <patrick.georgi@coresystems.de>
6 * Copyright (C) 2012 Google, Inc.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
32 size_t getfilesize(const char *filename
)
35 FILE *file
= fopen(filename
, "rb");
39 fseek(file
, 0, SEEK_END
);
45 void *loadfile(const char *filename
, uint32_t * romsize_p
, void *content
,
48 FILE *file
= fopen(filename
, "rb");
52 fseek(file
, 0, SEEK_END
);
53 *romsize_p
= ftell(file
);
54 fseek(file
, 0, SEEK_SET
);
56 content
= malloc(*romsize_p
);
58 printf("Could not get %d bytes for file %s\n",
59 *romsize_p
, filename
);
62 } else if (place
== SEEK_END
)
63 content
-= *romsize_p
;
65 if (!fread(content
, *romsize_p
, 1, file
)) {
66 printf("Failed to read %s\n", filename
);
73 static struct cbfs_header
*master_header
;
74 static uint32_t phys_start
, phys_end
, align
;
77 uint32_t arch
= CBFS_ARCHITECTURE_UNKNOWN
;
83 { CBFS_ARCHITECTURE_ARMV7
, "armv7" },
84 { CBFS_ARCHITECTURE_X86
, "x86" },
85 { CBFS_ARCHITECTURE_UNKNOWN
, "unknown" }
88 uint32_t string_to_arch(const char *arch_string
)
91 uint32_t ret
= CBFS_ARCHITECTURE_UNKNOWN
;
93 for (i
= 0; i
< ARRAY_SIZE(arch_names
); i
++) {
94 if (!strcasecmp(arch_string
, arch_names
[i
].name
)) {
95 ret
= arch_names
[i
].arch
;
103 const char *arch_to_string(uint32_t a
)
106 const char *ret
= NULL
;
108 for (i
= 0; i
< ARRAY_SIZE(arch_names
); i
++) {
109 if (a
== arch_names
[i
].arch
) {
110 ret
= arch_names
[i
].name
;
119 int find_master_header(void *romarea
, size_t size
)
126 for (offset
= 0; offset
< size
- sizeof(struct cbfs_header
); offset
++) {
127 struct cbfs_header
*tmp
= romarea
+ offset
;
129 if (tmp
->magic
== ntohl(CBFS_HEADER_MAGIC
)) {
135 return master_header
? 0 : 1;
138 void recalculate_rom_geometry(void *romarea
)
140 if (find_master_header(romarea
, romsize
)) {
141 fprintf(stderr
, "E: Cannot find master header\n");
145 /* Update old headers */
146 if (master_header
->version
== VERSION1
&&
147 ntohl(master_header
->architecture
) == CBFS_ARCHITECTURE_UNKNOWN
) {
148 printf("Updating CBFS master header to version 2\n");
149 master_header
->architecture
= htonl(CBFS_ARCHITECTURE_X86
);
152 arch
= ntohl(master_header
->architecture
);
155 case CBFS_ARCHITECTURE_ARMV7
:
157 phys_start
= (0 + ntohl(master_header
->offset
)) & 0xffffffff;
158 phys_end
= romsize
& 0xffffffff;
160 case CBFS_ARCHITECTURE_X86
:
161 offset
= romarea
+ romsize
- 0x100000000ULL
;
162 phys_start
= (0 - romsize
+ ntohl(master_header
->offset
)) &
164 phys_end
= (0 - ntohl(master_header
->bootblocksize
) -
165 sizeof(struct cbfs_header
)) & 0xffffffff;
168 fprintf(stderr
, "E: Unknown architecture\n");
172 align
= ntohl(master_header
->align
);
175 void *loadrom(const char *filename
)
177 void *romarea
= loadfile(filename
, &romsize
, 0, SEEK_SET
);
180 recalculate_rom_geometry(romarea
);
184 int writerom(const char *filename
, void *start
, uint32_t size
)
186 FILE *file
= fopen(filename
, "wb");
188 fprintf(stderr
, "Could not open '%s' for writing: ", filename
);
193 if (fwrite(start
, size
, 1, file
) != 1) {
194 fprintf(stderr
, "Could not write to '%s': ", filename
);
203 int cbfs_file_header(unsigned long physaddr
)
205 /* maybe improve this test */
206 return (strncmp(phys_to_virt(physaddr
), "LARCHIVE", 8) == 0);
209 struct cbfs_file
*cbfs_create_empty_file(uint32_t physaddr
, uint32_t size
)
211 struct cbfs_file
*nextfile
= (struct cbfs_file
*)phys_to_virt(physaddr
);
212 strncpy((char *)(nextfile
->magic
), "LARCHIVE", 8);
213 nextfile
->len
= htonl(size
);
214 nextfile
->type
= htonl(0xffffffff);
215 nextfile
->checksum
= 0; // FIXME?
216 nextfile
->offset
= htonl(sizeof(struct cbfs_file
) + 16);
217 memset(((void *)nextfile
) + sizeof(struct cbfs_file
), 0, 16);
221 int iself(unsigned char *input
)
223 Elf32_Ehdr
*ehdr
= (Elf32_Ehdr
*) input
;
224 return !memcmp(ehdr
->e_ident
, ELFMAG
, 4);
227 static struct filetypes_t
{
231 {CBFS_COMPONENT_STAGE
, "stage"},
232 {CBFS_COMPONENT_PAYLOAD
, "payload"},
233 {CBFS_COMPONENT_OPTIONROM
, "optionrom"},
234 {CBFS_COMPONENT_BOOTSPLASH
, "bootsplash"},
235 {CBFS_COMPONENT_RAW
, "raw"},
236 {CBFS_COMPONENT_VSA
, "vsa"},
237 {CBFS_COMPONENT_MBI
, "mbi"},
238 {CBFS_COMPONENT_MICROCODE
, "microcode"},
239 {CBFS_COMPONENT_CMOS_DEFAULT
, "cmos default"},
240 {CBFS_COMPONENT_CMOS_LAYOUT
, "cmos layout"},
241 {CBFS_COMPONENT_DELETED
, "deleted"},
242 {CBFS_COMPONENT_NULL
, "null"}
245 void print_supported_filetypes(void)
247 int i
, number
= ARRAY_SIZE(filetypes
);
249 for (i
=0; i
<number
; i
++) {
250 printf(" %s%c", filetypes
[i
].name
, (i
==(number
-1))?'\n':',');
256 const char *strfiletype(uint32_t number
)
259 for (i
= 0; i
< (sizeof(filetypes
) / sizeof(struct filetypes_t
)); i
++)
260 if (filetypes
[i
].type
== number
)
261 return filetypes
[i
].name
;
265 uint64_t intfiletype(const char *name
)
268 for (i
= 0; i
< (sizeof(filetypes
) / sizeof(struct filetypes_t
)); i
++)
269 if (strcmp(filetypes
[i
].name
, name
) == 0)
270 return filetypes
[i
].type
;
274 void print_cbfs_directory(const char *filename
)
277 ("%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\n"
278 "Alignment: %d bytes, architecture: %s\n\n",
279 basename((char *)filename
), romsize
/ 1024, ntohl(master_header
->bootblocksize
),
280 romsize
, ntohl(master_header
->offset
), align
, arch_to_string(arch
));
281 printf("%-30s %-10s %-12s Size\n", "Name", "Offset", "Type");
282 uint32_t current
= phys_start
;
283 while (current
< phys_end
) {
284 if (!cbfs_file_header(current
)) {
288 struct cbfs_file
*thisfile
=
289 (struct cbfs_file
*)phys_to_virt(current
);
290 uint32_t length
= ntohl(thisfile
->len
);
291 char *fname
= (char *)(phys_to_virt(current
) + sizeof(struct cbfs_file
));
292 if (strlen(fname
) == 0)
295 printf("%-30s 0x%-8x %-12s %d\n", fname
,
296 current
- phys_start
+ ntohl(master_header
->offset
),
297 strfiletype(ntohl(thisfile
->type
)), length
);
299 ALIGN(current
+ ntohl(thisfile
->len
) +
300 ntohl(thisfile
->offset
), align
);
304 int extract_file_from_cbfs(const char *filename
, const char *payloadname
, const char *outpath
)
306 // Identify the coreboot image.
308 "%s: %d kB, bootblocksize %d, romsize %d, offset 0x%x\nAlignment: %d bytes\n\n",
309 basename((char *)filename
), romsize
/ 1024, ntohl(master_header
->bootblocksize
),
310 romsize
, ntohl(master_header
->offset
), align
);
312 FILE *outfile
= NULL
;
313 uint32_t current
= phys_start
;
314 while (current
< phys_end
) {
315 if (!cbfs_file_header(current
)) {
320 // Locate the file start struct
321 struct cbfs_file
*thisfile
=
322 (struct cbfs_file
*)phys_to_virt(current
);
324 uint32_t length
= ntohl(thisfile
->len
);
325 // Locate the file name
326 char *fname
= (char *)(phys_to_virt(current
) + sizeof(struct cbfs_file
));
328 // It's not the file we are looking for..
329 if (strcmp(fname
, payloadname
) != 0)
332 ALIGN(current
+ ntohl(thisfile
->len
) +
333 ntohl(thisfile
->offset
), align
);
337 // Else, it's our file.
338 printf("Found file %.30s at 0x%x, type %.12s, size %d\n", fname
,
339 current
- phys_start
, strfiletype(ntohl(thisfile
->type
)),
342 // If we are not dumping to stdout, open the out file.
343 outfile
= fopen(outpath
, "wb");
346 printf("Could not open the file %s for writing. Aborting.\n", outpath
);
350 if (ntohl(thisfile
->type
) != CBFS_COMPONENT_RAW
)
352 printf("Warning: only 'raw' files are safe to extract.\n");
355 fwrite(((char *)thisfile
)
356 + ntohl(thisfile
->offset
), length
, 1, outfile
);
359 printf("Successfully dumped the file.\n");
361 // We'll only dump one file.
364 printf("File %s not found.\n", payloadname
);
369 int add_file_to_cbfs(void *content
, uint32_t contentsize
, uint32_t location
)
371 uint32_t current
= phys_start
;
372 while (current
< phys_end
) {
373 if (!cbfs_file_header(current
)) {
377 struct cbfs_file
*thisfile
=
378 (struct cbfs_file
*)phys_to_virt(current
);
379 uint32_t length
= ntohl(thisfile
->len
);
381 dprintf("at %x, %x bytes\n", current
, length
);
382 /* Is this a free chunk? */
383 if ((thisfile
->type
== CBFS_COMPONENT_DELETED
)
384 || (thisfile
->type
== CBFS_COMPONENT_NULL
)) {
385 dprintf("null||deleted at %x, %x bytes\n", current
,
387 /* if this is the right size, and if specified, the right location, use it */
388 if ((contentsize
<= length
)
389 && ((location
== 0) || (current
== location
))) {
390 if (contentsize
< length
) {
392 ("this chunk is %x bytes, we need %x. create a new chunk at %x with %x bytes\n",
394 ALIGN(current
+ contentsize
,
396 length
- contentsize
);
398 ALIGN(current
+ contentsize
, align
);
400 current
+ ntohl(thisfile
->offset
)
401 + length
- start
- 16 -
402 sizeof(struct cbfs_file
);
403 cbfs_create_empty_file(start
, size
);
405 dprintf("copying data\n");
406 memcpy(phys_to_virt(current
), content
,
411 /* CBFS has the constraint that the chain always moves up in memory. so once
412 we're past the place we seek, we don't need to look any further */
413 if (current
> location
) {
415 ("the requested space is not available\n");
419 /* Is the requested location inside the current chunk? */
420 if ((current
< location
)
421 && ((location
+ contentsize
) <=
422 (current
+ length
))) {
423 /* Split it up. In the next iteration the code will be at the right place. */
424 dprintf("split up. new length: %x\n",
426 ntohl(thisfile
->offset
));
428 htonl(location
- current
-
429 ntohl(thisfile
->offset
));
430 cbfs_create_empty_file(location
,
438 ALIGN(current
+ ntohl(thisfile
->len
) +
439 ntohl(thisfile
->offset
), align
);
441 printf("Could not add the file to CBFS, it's probably too big.\n");
442 printf("File size: %d bytes (%d KB).\n", contentsize
, contentsize
/1024);
447 static struct cbfs_file
*merge_adjacent_files(struct cbfs_file
*first
,
448 struct cbfs_file
*second
)
450 uint32_t new_length
=
451 ntohl(first
->len
) + ntohl(second
->len
) + ntohl(second
->offset
);
452 first
->len
= htonl(new_length
);
453 first
->checksum
= 0; // FIXME?
457 static struct cbfs_file
*next_file(struct cbfs_file
*prev
)
459 uint32_t pos
= (prev
== NULL
) ? phys_start
:
460 ALIGN(virt_to_phys(prev
) + ntohl(prev
->len
) + ntohl(prev
->offset
),
463 for (; pos
< phys_end
; pos
+= align
) {
464 if (cbfs_file_header(pos
))
465 return (struct cbfs_file
*)phys_to_virt(pos
);
471 int remove_file_from_cbfs(const char *filename
)
473 struct cbfs_file
*prev
= NULL
;
474 struct cbfs_file
*cur
= next_file(prev
);
475 struct cbfs_file
*next
= next_file(cur
);
476 for (; cur
; prev
= cur
, cur
= next
, next
= next_file(next
)) {
478 /* Check if this is the file to remove. */
479 char *name
= (char *)cur
+ sizeof(*cur
);
480 if (strcmp(name
, filename
))
483 /* Mark the file as free space and erase its name. */
484 cur
->type
= CBFS_COMPONENT_NULL
;
487 /* Merge it with the previous file if possible. */
488 if (prev
&& prev
->type
== CBFS_COMPONENT_NULL
)
489 cur
= merge_adjacent_files(prev
, cur
);
491 /* Merge it with the next file if possible. */
492 if (next
&& next
->type
== CBFS_COMPONENT_NULL
)
493 merge_adjacent_files(cur
, next
);
497 printf("CBFS file %s not found.\n", filename
);
502 /* returns new data block with cbfs_file header, suitable to dump into the ROM. location returns
503 the new location that points to the cbfs_file header */
504 void *create_cbfs_file(const char *filename
, void *data
, uint32_t * datasize
,
505 uint32_t type
, uint32_t * location
)
507 uint32_t filename_len
= ALIGN(strlen(filename
) + 1, 16);
508 uint32_t headersize
= sizeof(struct cbfs_file
) + filename_len
;
509 if ((location
!= 0) && (*location
!= 0)) {
510 uint32_t offset
= *location
% align
;
511 /* If offset >= (headersize % align), we can stuff the header into the offset.
512 Otherwise the header has to be aligned itself, and put before the offset data */
513 if (offset
>= (headersize
% align
)) {
514 offset
-= (headersize
% align
);
516 offset
+= align
- (headersize
% align
);
518 headersize
+= offset
;
519 *location
-= headersize
;
521 void *newdata
= malloc(*datasize
+ headersize
);
523 printf("Could not get %d bytes for CBFS file.\n", *datasize
+
527 memset(newdata
, 0xff, *datasize
+ headersize
);
528 struct cbfs_file
*nextfile
= (struct cbfs_file
*)newdata
;
529 strncpy((char *)(nextfile
->magic
), "LARCHIVE", 8);
530 nextfile
->len
= htonl(*datasize
);
531 nextfile
->type
= htonl(type
);
532 nextfile
->checksum
= 0; // FIXME?
533 nextfile
->offset
= htonl(headersize
);
534 strcpy(newdata
+ sizeof(struct cbfs_file
), filename
);
535 memcpy(newdata
+ headersize
, data
, *datasize
);
536 *datasize
+= headersize
;
540 int create_cbfs_image(const char *romfile
, uint32_t _romsize
,
541 const char *bootblock
, uint32_t align
, uint32_t offs
)
543 uint32_t bootblocksize
= 0;
544 struct cbfs_header
*master_header
;
545 unsigned char *romarea
, *bootblk
;
548 romarea
= malloc(romsize
);
550 fprintf(stderr
, "E: Could not get %d bytes of memory"
551 " for CBFS image.\n", romsize
);
554 memset(romarea
, 0xff, romsize
);
559 bootblk
= loadfile(bootblock
, &bootblocksize
,
560 romarea
+ romsize
, SEEK_END
);
562 fprintf(stderr
, "E: Could not load bootblock %s.\n",
568 // TODO(hungte) Replace magic numbers by named constants.
570 case CBFS_ARCHITECTURE_ARMV7
:
571 /* Set up physical/virtual mapping */
574 // should be aligned to align but then we need to dynamically
575 // create the jump to the bootblock
576 loadfile(bootblock
, &bootblocksize
, romarea
+ 0x20 +
577 sizeof(struct cbfs_header
), SEEK_SET
);
578 master_header
= (struct cbfs_header
*)(romarea
+ 0x20);
579 uint32_t *arm_vec
= (uint32_t *)romarea
;
581 * Encoding for this branch instruction is:
582 * 31:28 - condition (0xe for always/unconditional)
584 * 23: 0 - sign-extended offset (in multiples of 4)
586 * When executing the branch, the PC will read as the address
587 * of current instruction + 8.
589 arm_vec
[0] = htonl(0x0e0000ea); // branch to . + 64 bytes
591 master_header
->magic
= ntohl(CBFS_HEADER_MAGIC
);
592 master_header
->version
= ntohl(VERSION
);
593 master_header
->romsize
= htonl(romsize
);
594 master_header
->bootblocksize
= htonl(bootblocksize
);
595 master_header
->align
= htonl(align
);
596 master_header
->offset
= htonl(
597 ALIGN((0x40 + bootblocksize
), align
));
598 master_header
->architecture
= htonl(CBFS_ARCHITECTURE_ARMV7
);
600 ((uint32_t *) phys_to_virt(0x4))[0] =
601 virt_to_phys(master_header
);
603 recalculate_rom_geometry(romarea
);
605 cbfs_create_empty_file(
606 ALIGN((0x40 + bootblocksize
), align
),
607 romsize
- ALIGN((bootblocksize
+ 0x40), align
)
608 //- sizeof(struct cbfs_header)
609 - sizeof(struct cbfs_file
) );
612 case CBFS_ARCHITECTURE_X86
:
613 // Set up physical/virtual mapping
614 offset
= romarea
+ romsize
- 0x100000000ULL
;
616 loadfile(bootblock
, &bootblocksize
, romarea
+ romsize
,
618 master_header
= (struct cbfs_header
*)(romarea
+ romsize
-
619 bootblocksize
- sizeof(struct cbfs_header
));
621 master_header
->magic
= ntohl(CBFS_HEADER_MAGIC
);
622 master_header
->version
= ntohl(VERSION
);
623 master_header
->romsize
= htonl(romsize
);
624 master_header
->bootblocksize
= htonl(bootblocksize
);
625 master_header
->align
= htonl(align
);
626 master_header
->offset
= htonl(offs
);
627 master_header
->architecture
= htonl(CBFS_ARCHITECTURE_X86
);
629 ((uint32_t *) phys_to_virt(CBFS_HEADPTR_ADDR_X86
))[0] =
630 virt_to_phys(master_header
);
632 recalculate_rom_geometry(romarea
);
634 cbfs_create_empty_file((0 - romsize
+ offs
) & 0xffffffff,
635 romsize
- offs
- bootblocksize
-
636 sizeof(struct cbfs_header
) -
637 sizeof(struct cbfs_file
) - 16);
641 // Should not happen.
642 fprintf(stderr
, "E: You found a bug in cbfstool.\n");
646 writerom(romfile
, romarea
, romsize
);
651 static int in_segment(int addr
, int size
, int gran
)
653 return ((addr
& ~(gran
- 1)) == ((addr
+ size
) & ~(gran
- 1)));
656 uint32_t cbfs_find_location(const char *romfile
, uint32_t filesize
,
657 const char *filename
, uint32_t alignment
)
660 size_t filename_size
, headersize
, totalsize
;
664 rom
= loadrom(romfile
);
666 fprintf(stderr
, "E: Could not load ROM image '%s'.\n",
671 filename_size
= strlen(filename
);
672 headersize
= sizeof(struct cbfs_file
) + ALIGN(filename_size
+ 1, 16) +
673 sizeof(struct cbfs_stage
);
674 totalsize
= headersize
+ filesize
;
676 current
= phys_start
;
677 while (current
< phys_end
) {
679 struct cbfs_file
*thisfile
;
681 if (!cbfs_file_header(current
)) {
686 thisfile
= (struct cbfs_file
*)phys_to_virt(current
);
688 top
= current
+ ntohl(thisfile
->len
) + ntohl(thisfile
->offset
);
690 if (((ntohl(thisfile
->type
) == 0x0)
691 || (ntohl(thisfile
->type
) == 0xffffffff))
692 && (ntohl(thisfile
->len
) + ntohl(thisfile
->offset
) >=
695 (current
+ headersize
, filesize
, alignment
)) {
696 ret
= current
+ headersize
;
699 if ((ALIGN(current
, alignment
) + filesize
< top
)
700 && (ALIGN(current
, alignment
) - headersize
>
702 && in_segment(ALIGN(current
, alignment
), filesize
,
704 ret
= ALIGN(current
, alignment
);
707 if ((ALIGN(current
, alignment
) + alignment
+ filesize
<
709 && (ALIGN(current
, alignment
) + alignment
-
710 headersize
> current
)
711 && in_segment(ALIGN(current
, alignment
) + alignment
,
712 filesize
, alignment
)) {
713 ret
= ALIGN(current
, alignment
) + alignment
;
718 ALIGN(current
+ ntohl(thisfile
->len
) +
719 ntohl(thisfile
->offset
), align
);