cbfstool: add code to serialize the header using the new xdr functions

This change adds a header serialization function. Programmers can thus just
set up a header as needed, without worrying about forgetting if and how to
use the [hn]to[hn]* functions.

In the long term, we will work to remove swab.h, i.e. we need to get to the
point where programmers don't have to try to remember [hn]to[nh]* and where
it goes. To date, even the best programmers we have have made an error with
those functions, and those errors have persisted for 6 or 7 years now. It's
very easy to make that mistake.

BUG=None
TEST=Build a peppy image and verify that it's bit for bit the same. All
     chromebooks use this code and build and boot correctly.
BRANCH=None

Change-Id: I0f9b8e7cac5f52d0ea330ba948650fa0803aa0d5
Signed-off-by: Ronald G. Minnich <rminnich@google.com>
Reviewed-on: https://chromium-review.googlesource.com/181552
Reviewed-by: Ronald Minnich <rminnich@chromium.org>
Commit-Queue: Ronald Minnich <rminnich@chromium.org>
Tested-by: Ronald Minnich <rminnich@chromium.org>
Reviewed-on: http://review.coreboot.org/5100
Tested-by: build bot (Jenkins)
Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Reviewed-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
Reviewed-by: Ronald G. Minnich <rminnich@gmail.com>
This commit is contained in:
Ronald G. Minnich 2014-01-06 08:38:15 -08:00 committed by Ronald G. Minnich
parent a8a133ded3
commit b5adeee1cc
2 changed files with 32 additions and 13 deletions

View File

@ -139,6 +139,21 @@ static int cbfs_fix_legacy_size(struct cbfs_image *image)
return 0; return 0;
} }
void cbfs_put_header(void *dest, const struct cbfs_header *header)
{
struct buffer outheader;
outheader.data = dest;
outheader.size = 0;
xdr_be.put32(&outheader, header->magic);
xdr_be.put32(&outheader, header->version);
xdr_be.put32(&outheader, header->romsize);
xdr_be.put32(&outheader, header->bootblocksize);
xdr_be.put32(&outheader, header->align);
xdr_be.put32(&outheader, header->offset);
xdr_be.put32(&outheader, header->architecture);
}
int cbfs_image_create(struct cbfs_image *image, int cbfs_image_create(struct cbfs_image *image,
uint32_t myarch, uint32_t myarch,
size_t size, size_t size,
@ -148,7 +163,7 @@ int cbfs_image_create(struct cbfs_image *image,
int32_t header_offset, int32_t header_offset,
int32_t entries_offset) int32_t entries_offset)
{ {
struct cbfs_header *header; struct cbfs_header header;
struct cbfs_file *entry; struct cbfs_file *entry;
uint32_t cbfs_len; uint32_t cbfs_len;
size_t entry_header_len; size_t entry_header_len;
@ -156,7 +171,7 @@ int cbfs_image_create(struct cbfs_image *image,
DEBUG("cbfs_image_create: bootblock=0x%x+0x%zx, " DEBUG("cbfs_image_create: bootblock=0x%x+0x%zx, "
"header=0x%x+0x%zx, entries_offset=0x%x\n", "header=0x%x+0x%zx, entries_offset=0x%x\n",
bootblock_offset, bootblock->size, bootblock_offset, bootblock->size,
header_offset, sizeof(*header), entries_offset); header_offset, sizeof(header), entries_offset);
if (buffer_create(&image->buffer, size, "(new)") != 0) if (buffer_create(&image->buffer, size, "(new)") != 0)
return -1; return -1;
@ -194,20 +209,20 @@ int cbfs_image_create(struct cbfs_image *image,
bootblock->size); bootblock->size);
// Prepare header // Prepare header
if (header_offset + sizeof(*header) > size) { if (header_offset + sizeof(header) > size) {
ERROR("Header (0x%x+0x%zx) exceed ROM size (0x%zx)\n", ERROR("Header (0x%x+0x%zx) exceed ROM size (0x%zx)\n",
header_offset, sizeof(*header), size); header_offset, sizeof(header), size);
return -1; return -1;
} }
header = (struct cbfs_header *)(image->buffer.data + header_offset); image->header = (struct cbfs_header *)(image->buffer.data + header_offset);
image->header = header; header.magic = CBFS_HEADER_MAGIC;
header->magic = htonl(CBFS_HEADER_MAGIC); header.version = CBFS_HEADER_VERSION;
header->version = htonl(CBFS_HEADER_VERSION); header.romsize = size;
header->romsize = htonl(size); header.bootblocksize = bootblock->size;
header->bootblocksize = htonl(bootblock->size); header.align = align;
header->align = htonl(align); header.offset = entries_offset;
header->offset = htonl(entries_offset); header.architecture = myarch;
header->architecture = htonl(myarch); cbfs_put_header(image->header, &header);
// Prepare entries // Prepare entries
if (align_up(entries_offset, align) != entries_offset) { if (align_up(entries_offset, align) != entries_offset) {

View File

@ -31,6 +31,10 @@ struct cbfs_image {
struct cbfs_header *header; struct cbfs_header *header;
}; };
/* Given a pointer, serialize the header from host-native byte format
* to cbfs format, i.e. big-endian. */
void cbfs_put_header(void *dest, const struct cbfs_header *header);
/* Creates an empty CBFS image by given size, and description to its content /* Creates an empty CBFS image by given size, and description to its content
* (bootblock, align, header location, starting offset of CBFS entries. * (bootblock, align, header location, starting offset of CBFS entries.
* The output image will contain a valid cbfs_header, with one cbfs_file * The output image will contain a valid cbfs_header, with one cbfs_file