2013-01-28 18:56:17 +01:00
|
|
|
/*
|
|
|
|
* CBFS Image Manipulation
|
|
|
|
*
|
|
|
|
* Copyright (C) 2013 The Chromium OS Authors. All rights reserved.
|
|
|
|
*
|
|
|
|
* 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; version 2 of the License.
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __CBFS_IMAGE_H
|
|
|
|
#define __CBFS_IMAGE_H
|
|
|
|
#include "common.h"
|
|
|
|
#include "cbfs.h"
|
|
|
|
|
|
|
|
/* CBFS image processing */
|
|
|
|
|
|
|
|
struct cbfs_image {
|
|
|
|
struct buffer buffer;
|
cbfstool: New image format w/ required FMAP and w/o CBFS master header
These new-style firmware images use the FMAP of the root of knowledge
about their layout, which allows them to have sections containing raw
data whose offset and size can easily be determined at runtime or when
modifying or flashing the image. Furthermore, they can even have
multiple CBFSes, each of which occupies a different FMAP region. It is
assumed that the first entry of each CBFS, including the primary one,
will be located right at the start of its region. This means that the
bootblock needs to be moved into its own FMAP region, but makes the
CBFS master header obsolete because, with the exception of the version
and alignment, all its fields are redundant once its CBFS has an entry
in the FMAP. The version code will be addressed in a future commit
before the new format comes into use, while the alignment will just be
defined to 64 bytes in both cbfstool and coreboot itself, since
there's almost no reason to ever change it in practice. The version
code field and all necessary coreboot changes will come separately.
BUG=chromium:470407
TEST=Build panther and nyan_big coreboot.rom and image.bin images with
and without this patch, diff their hexdumps, and note that no
locations differ except for those that do between subsequent builds of
the same codebase. Try working with new-style images: use fmaptool to
produce an FMAP section from an fmd file having raw sections and
multiple CBFSes, pass the resulting file to cbfstool create -M -F,
then try printing its layout and CBFSes' contents, add and remove CBFS
files, and read and write raw sections.
BRANCH=None
Change-Id: I7dd2578d2143d0cedd652fdba5b22221fcc2184a
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 8a670322297f83135b929a5b20ff2bd0e7d2abd3
Original-Change-Id: Ib86fb50edc66632f4e6f717909bbe4efb6c874e5
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/265863
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/10135
Tested-by: build bot (Jenkins)
2015-03-18 20:36:27 +01:00
|
|
|
/* An image has a header iff it's a legacy CBFS. */
|
|
|
|
bool has_header;
|
|
|
|
/* Only meaningful if has_header is selected. */
|
2015-05-06 00:40:15 +02:00
|
|
|
struct cbfs_header header;
|
2013-01-28 18:56:17 +01:00
|
|
|
};
|
|
|
|
|
2015-05-08 06:00:05 +02:00
|
|
|
/* Given the string name of a compression algorithm, return the corresponding
|
|
|
|
* enum comp_algo if it's supported, or a number < 0 otherwise. */
|
|
|
|
int cbfs_parse_comp_algo(const char *name);
|
|
|
|
|
2015-10-01 15:54:04 +02:00
|
|
|
/* Given the string name of a hash algorithm, return the corresponding
|
|
|
|
* id if it's supported, or a number < 0 otherwise. */
|
|
|
|
int cbfs_parse_hash_algo(const char *name);
|
|
|
|
|
2014-01-06 17:38:15 +01:00
|
|
|
/* 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);
|
2014-02-05 08:10:08 +01:00
|
|
|
/* Or deserialize into host-native format */
|
2015-03-06 00:38:03 +01:00
|
|
|
void cbfs_get_header(struct cbfs_header *header, void *src);
|
2014-01-06 17:38:15 +01:00
|
|
|
|
cbfstool: New image format w/ required FMAP and w/o CBFS master header
These new-style firmware images use the FMAP of the root of knowledge
about their layout, which allows them to have sections containing raw
data whose offset and size can easily be determined at runtime or when
modifying or flashing the image. Furthermore, they can even have
multiple CBFSes, each of which occupies a different FMAP region. It is
assumed that the first entry of each CBFS, including the primary one,
will be located right at the start of its region. This means that the
bootblock needs to be moved into its own FMAP region, but makes the
CBFS master header obsolete because, with the exception of the version
and alignment, all its fields are redundant once its CBFS has an entry
in the FMAP. The version code will be addressed in a future commit
before the new format comes into use, while the alignment will just be
defined to 64 bytes in both cbfstool and coreboot itself, since
there's almost no reason to ever change it in practice. The version
code field and all necessary coreboot changes will come separately.
BUG=chromium:470407
TEST=Build panther and nyan_big coreboot.rom and image.bin images with
and without this patch, diff their hexdumps, and note that no
locations differ except for those that do between subsequent builds of
the same codebase. Try working with new-style images: use fmaptool to
produce an FMAP section from an fmd file having raw sections and
multiple CBFSes, pass the resulting file to cbfstool create -M -F,
then try printing its layout and CBFSes' contents, add and remove CBFS
files, and read and write raw sections.
BRANCH=None
Change-Id: I7dd2578d2143d0cedd652fdba5b22221fcc2184a
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 8a670322297f83135b929a5b20ff2bd0e7d2abd3
Original-Change-Id: Ib86fb50edc66632f4e6f717909bbe4efb6c874e5
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/265863
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/10135
Tested-by: build bot (Jenkins)
2015-03-18 20:36:27 +01:00
|
|
|
/* Populates a CBFS with a single empty entry filling all available space
|
|
|
|
* (entries_size bytes). If image's header field is already present, its
|
|
|
|
* contents will be used to place an empty entry of the requested length at the
|
|
|
|
* appropriate position in the existing buffer; otherwise, if not has_header,
|
|
|
|
* the first entries_size bytes of buffer will be filled exclusively with the
|
|
|
|
* single empty entry (and no CBFS master header).
|
|
|
|
* Returns 0 on success, otherwise nonzero. */
|
|
|
|
int cbfs_image_create(struct cbfs_image *image, size_t entries_size);
|
|
|
|
|
2013-01-29 02:45:12 +01:00
|
|
|
/* Creates an empty CBFS image by given size, and description to its content
|
cbfstool: Restructure around support for reading/writing portions of files
The buffer API that cbfstool uses to read and write files only directly supports
one-shot operations on whole files. This adds an intermediate partitioned_file
module that sits on top of the buffer system and has an awareness of FMAP
entries. It provides an easy way to get a buffer for an individual region of a
larger image file based on FMAP section name, as well as incrementally write
those smaller buffers back to the backing file at the appropriate offset. The
module has two distinct modes of operation:
- For new images whose layout is described exclusively by an FMAP section, all
the aforementioned functionality will be available.
- For images in the current format, where the CBFS master header serves as the
root of knowledge of the image's size and layout, the module falls back to a
legacy operation mode, where it only allows manipulation of the entire image
as one unit, but exposes this support through the same interface by mapping
the region named SECTION_NAME_PRIMARY_CBFS ("COREBOOT") to the whole file.
The tool is presently only ported onto the new module running in legacy mode:
higher-level support for true "partitioned" images will be forthcoming. However,
as part of this change, the crusty cbfs_image_from_file() and
cbfs_image_write_file() abstractions are removed and replaced with a single
cbfs_image function, cbfs_image_from_buffer(), as well as centralized image
reading/writing directly in cbfstool's main() function. This reduces the
boilerplate required to implement each new action, makes the create action much
more similar to the others, and will make implementing additional actions and
adding in support for the new format much easier.
BUG=chromium:470407
TEST=Build panther and nyan_big coreboot.rom images with and without this patch
and diff their hexdumps. Ensure that no differences occur at different locations
from the diffs between subsequent builds of an identical source tree. Then flash
a full new build onto nyan_big and watch it boot normally.
BRANCH=None
Change-Id: I25578c7b223bc8434c3074cb0dd8894534f8c500
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 7e1c96a48e7a27fc6b90289d35e6e169d5e7ad20
Original-Change-Id: Ia4a1a4c48df42b9ec2d6b9471b3a10eb7b24bb39
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/265581
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/10134
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2015-03-25 21:40:08 +01:00
|
|
|
* (bootblock, align, header location, starting offset of CBFS entries).
|
2013-01-29 02:45:12 +01:00
|
|
|
* The output image will contain a valid cbfs_header, with one cbfs_file
|
|
|
|
* entry with type CBFS_COMPONENT_NULL, with max available size.
|
cbfstool: New image format w/ required FMAP and w/o CBFS master header
These new-style firmware images use the FMAP of the root of knowledge
about their layout, which allows them to have sections containing raw
data whose offset and size can easily be determined at runtime or when
modifying or flashing the image. Furthermore, they can even have
multiple CBFSes, each of which occupies a different FMAP region. It is
assumed that the first entry of each CBFS, including the primary one,
will be located right at the start of its region. This means that the
bootblock needs to be moved into its own FMAP region, but makes the
CBFS master header obsolete because, with the exception of the version
and alignment, all its fields are redundant once its CBFS has an entry
in the FMAP. The version code will be addressed in a future commit
before the new format comes into use, while the alignment will just be
defined to 64 bytes in both cbfstool and coreboot itself, since
there's almost no reason to ever change it in practice. The version
code field and all necessary coreboot changes will come separately.
BUG=chromium:470407
TEST=Build panther and nyan_big coreboot.rom and image.bin images with
and without this patch, diff their hexdumps, and note that no
locations differ except for those that do between subsequent builds of
the same codebase. Try working with new-style images: use fmaptool to
produce an FMAP section from an fmd file having raw sections and
multiple CBFSes, pass the resulting file to cbfstool create -M -F,
then try printing its layout and CBFSes' contents, add and remove CBFS
files, and read and write raw sections.
BRANCH=None
Change-Id: I7dd2578d2143d0cedd652fdba5b22221fcc2184a
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 8a670322297f83135b929a5b20ff2bd0e7d2abd3
Original-Change-Id: Ib86fb50edc66632f4e6f717909bbe4efb6c874e5
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/265863
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/10135
Tested-by: build bot (Jenkins)
2015-03-18 20:36:27 +01:00
|
|
|
* Only call this if you want a legacy CBFS with a master header.
|
|
|
|
* Returns 0 on success, otherwise nonzero. */
|
|
|
|
int cbfs_legacy_image_create(struct cbfs_image *image,
|
|
|
|
uint32_t arch,
|
|
|
|
uint32_t align,
|
|
|
|
struct buffer *bootblock,
|
|
|
|
uint32_t bootblock_offset,
|
|
|
|
uint32_t header_offset,
|
|
|
|
uint32_t entries_offset);
|
2013-01-29 02:45:12 +01:00
|
|
|
|
cbfstool: Restructure around support for reading/writing portions of files
The buffer API that cbfstool uses to read and write files only directly supports
one-shot operations on whole files. This adds an intermediate partitioned_file
module that sits on top of the buffer system and has an awareness of FMAP
entries. It provides an easy way to get a buffer for an individual region of a
larger image file based on FMAP section name, as well as incrementally write
those smaller buffers back to the backing file at the appropriate offset. The
module has two distinct modes of operation:
- For new images whose layout is described exclusively by an FMAP section, all
the aforementioned functionality will be available.
- For images in the current format, where the CBFS master header serves as the
root of knowledge of the image's size and layout, the module falls back to a
legacy operation mode, where it only allows manipulation of the entire image
as one unit, but exposes this support through the same interface by mapping
the region named SECTION_NAME_PRIMARY_CBFS ("COREBOOT") to the whole file.
The tool is presently only ported onto the new module running in legacy mode:
higher-level support for true "partitioned" images will be forthcoming. However,
as part of this change, the crusty cbfs_image_from_file() and
cbfs_image_write_file() abstractions are removed and replaced with a single
cbfs_image function, cbfs_image_from_buffer(), as well as centralized image
reading/writing directly in cbfstool's main() function. This reduces the
boilerplate required to implement each new action, makes the create action much
more similar to the others, and will make implementing additional actions and
adding in support for the new format much easier.
BUG=chromium:470407
TEST=Build panther and nyan_big coreboot.rom images with and without this patch
and diff their hexdumps. Ensure that no differences occur at different locations
from the diffs between subsequent builds of an identical source tree. Then flash
a full new build onto nyan_big and watch it boot normally.
BRANCH=None
Change-Id: I25578c7b223bc8434c3074cb0dd8894534f8c500
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 7e1c96a48e7a27fc6b90289d35e6e169d5e7ad20
Original-Change-Id: Ia4a1a4c48df42b9ec2d6b9471b3a10eb7b24bb39
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/265581
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/10134
Tested-by: build bot (Jenkins)
Reviewed-by: Patrick Georgi <pgeorgi@google.com>
2015-03-25 21:40:08 +01:00
|
|
|
/* Constructs a cbfs_image from a buffer. The resulting image contains a shallow
|
|
|
|
* copy of the buffer; releasing either one is the legal way to clean up after
|
|
|
|
* both of them at once. Always produces a cbfs_image, but...
|
|
|
|
* Returns 0 if it contains a valid CBFS, non-zero if it's unrecognized data. */
|
|
|
|
int cbfs_image_from_buffer(struct cbfs_image *out, struct buffer *in,
|
|
|
|
uint32_t offset);
|
2013-01-28 18:56:17 +01:00
|
|
|
|
cbfstool: New image format w/ required FMAP and w/o CBFS master header
These new-style firmware images use the FMAP of the root of knowledge
about their layout, which allows them to have sections containing raw
data whose offset and size can easily be determined at runtime or when
modifying or flashing the image. Furthermore, they can even have
multiple CBFSes, each of which occupies a different FMAP region. It is
assumed that the first entry of each CBFS, including the primary one,
will be located right at the start of its region. This means that the
bootblock needs to be moved into its own FMAP region, but makes the
CBFS master header obsolete because, with the exception of the version
and alignment, all its fields are redundant once its CBFS has an entry
in the FMAP. The version code will be addressed in a future commit
before the new format comes into use, while the alignment will just be
defined to 64 bytes in both cbfstool and coreboot itself, since
there's almost no reason to ever change it in practice. The version
code field and all necessary coreboot changes will come separately.
BUG=chromium:470407
TEST=Build panther and nyan_big coreboot.rom and image.bin images with
and without this patch, diff their hexdumps, and note that no
locations differ except for those that do between subsequent builds of
the same codebase. Try working with new-style images: use fmaptool to
produce an FMAP section from an fmd file having raw sections and
multiple CBFSes, pass the resulting file to cbfstool create -M -F,
then try printing its layout and CBFSes' contents, add and remove CBFS
files, and read and write raw sections.
BRANCH=None
Change-Id: I7dd2578d2143d0cedd652fdba5b22221fcc2184a
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 8a670322297f83135b929a5b20ff2bd0e7d2abd3
Original-Change-Id: Ib86fb50edc66632f4e6f717909bbe4efb6c874e5
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/265863
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/10135
Tested-by: build bot (Jenkins)
2015-03-18 20:36:27 +01:00
|
|
|
/* Create a duplicate CBFS image. Returns 0 on success, otherwise non-zero.
|
|
|
|
* Will not succeed on new-style images without a master header. */
|
2015-11-20 19:22:50 +01:00
|
|
|
int cbfs_copy_instance(struct cbfs_image *image, struct buffer *dst);
|
cbfstool: add a command to duplicate a cbfs instance
The new command allows to create a file where the original CBFS image
is duplicated at a different offset.
The required options of the new command are -D, the offset where the
copy CBFS header is placed, and -s, the size of the new CBFS copy.
When a CBFS is copied, the bootblock area of the source CBFS is
ignored, as well as empty and deleted files in the source CBFS. The
size of the destination CBFS is calculated as the rombase size of the
source CBFS less the bootblock size.
The copy instance can be created in the image only above the original,
which rules out the use of this new command for x86 images. If
necessary, this limitation could be addressed later.
As with other cbfstool commands, unless explicitly specified the
lowest CBFS instance in the image is considered the source. If
necessary, the user can specify the source CBFS using the -H option.
BRANCH=storm
BUG=chrome-os-partner:34161, chromium:445938
TEST=run multiple cbfstool commands on a storm image:
$ cd /tmp
$ cp /build/storm/firmware/image.serial.bin storm.bin
$ cbfstool storm.bin print
storm.bin: 8192 kB, bootblocksize 34472, romsize 458752, offset 0x8700
alignment: 64 bytes, architecture: arm
Name Offset Type Size
cdt.mbn 0x8700 raw 416
ddr.mbn 0x8900 raw 25836
rpm.mbn 0xee40 raw 78576
tz.mbn 0x22180 raw 85360
fallback/verstage 0x36f40 stage 41620
fallback/romstage 0x41240 stage 19556
fallback/ramstage 0x45f00 stage 25579
config 0x4c340 raw 2878
fallback/payload 0x4cec0 payload 64811
u-boot.dtb 0x5cc40 (unknown) 2993
(empty) 0x5d840 null 75608
$ cbfstool storm.bin copy -D 0x420000
E: You need to specify -s/--size.
$ cbfstool storm.bin copy -D 0x420000 -s 0x70000
$ cbfstool storm.bin print
W: Multiple (2) CBFS headers found, using the first one.
storm.bin: 8192 kB, bootblocksize 34472, romsize 458752, offset 0x8700
alignment: 64 bytes, architecture: arm
Name Offset Type Size
cdt.mbn 0x8700 raw 416
ddr.mbn 0x8900 raw 25836
rpm.mbn 0xee40 raw 78576
tz.mbn 0x22180 raw 85360
fallback/verstage 0x36f40 stage 41620
fallback/romstage 0x41240 stage 19556
fallback/ramstage 0x45f00 stage 25579
config 0x4c340 raw 2878
fallback/payload 0x4cec0 payload 64811
u-boot.dtb 0x5cc40 (unknown) 2993
(empty) 0x5d840 null 75608
cbfstool storm.bin print -H 0x420000
storm.bin: 8192 kB, bootblocksize 0, romsize 4784128, offset 0x420040
alignment: 64 bytes, architecture: arm
Name Offset Type Size
cdt.mbn 0x420040 raw 416
ddr.mbn 0x420240 raw 25836
rpm.mbn 0x426780 raw 78576
tz.mbn 0x439ac0 raw 85360
fallback/verstage 0x44e880 stage 41620
fallback/romstage 0x458b80 stage 19556
fallback/ramstage 0x45d840 stage 25579
config 0x463c80 raw 2878
fallback/payload 0x464800 payload 64811
u-boot.dtb 0x474580 (unknown) 2993
(empty) 0x475180 null 110168
$ cbfstool storm.bin remove -n config -H 0x420000
$ cbfstool storm.bin copy -H 0x420000 -D 0x620000 -s 0x70000
$ cbfstool storm.bin print -H 0x620000
storm.bin: 8192 kB, bootblocksize 0, romsize 6881280, offset 0x620040
alignment: 64 bytes, architecture: arm
Name Offset Type Size
cdt.mbn 0x620040 raw 416
ddr.mbn 0x620240 raw 25836
rpm.mbn 0x626780 raw 78576
tz.mbn 0x639ac0 raw 85360
fallback/verstage 0x64e880 stage 41620
fallback/romstage 0x658b80 stage 19556
fallback/ramstage 0x65d840 stage 25579
fallback/payload 0x663c80 payload 64811
u-boot.dtb 0x673a00 (unknown) 2993
(empty) 0x674600 null 113112
$ cbfstool /build/storm/firmware/image.serial.bin extract -n fallback/payload -f payload1
[..]
$ cbfstool storm.bin extract -H 0x620000 -n fallback/payload -f payload2
[..]
$ diff payload1 payload2
Change-Id: Ieb9205848aec361bb870de0d284dff06c597564f
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: b8d3c1b09a47ca24d2d2effc6de0e89d1b0a8903
Original-Signed-off-by: Aaron Durbin <adurbin@chromium.org>
Original-Signed-off-by: Vadim Bendebury <vbendeb@chromium.org>
Original-Change-Id: I227e607ccf7a9a8e2a1f3c6bbc506b8d29a35b1b
Original-Reviewed-on: https://chromium-review.googlesource.com/237561
Reviewed-on: http://review.coreboot.org/9742
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
2014-12-24 04:26:54 +01:00
|
|
|
|
2016-01-27 00:08:56 +01:00
|
|
|
/* Compact a fragmented CBFS image by placing all the non-empty files at the
|
|
|
|
* beginning of the image. Returns 0 on success, otherwise non-zero. */
|
|
|
|
int cbfs_compact_instance(struct cbfs_image *image);
|
|
|
|
|
2017-09-19 14:39:58 +02:00
|
|
|
/* Expand a CBFS image inside an fmap region to the entire region's space.
|
|
|
|
Returns 0 on success, otherwise non-zero. */
|
|
|
|
int cbfs_expand_to_region(struct buffer *region);
|
|
|
|
|
2017-09-20 11:59:18 +02:00
|
|
|
/* Truncate a CBFS by removing a trailing "empty" file if it exists.
|
|
|
|
Returns 0 on success, otherwise non-zero and passes the CBFS' remaining
|
|
|
|
size in the size argument. */
|
|
|
|
int cbfs_truncate_space(struct buffer *region, uint32_t *size);
|
|
|
|
|
2013-01-28 18:56:17 +01:00
|
|
|
/* Releases the CBFS image. Returns 0 on success, otherwise non-zero. */
|
|
|
|
int cbfs_image_delete(struct cbfs_image *image);
|
|
|
|
|
2013-01-28 19:29:49 +01:00
|
|
|
/* Returns a pointer to entry by name, or NULL if name is not found. */
|
|
|
|
struct cbfs_file *cbfs_get_entry(struct cbfs_image *image, const char *name);
|
|
|
|
|
2018-08-09 11:49:52 +02:00
|
|
|
/* Exports an entry to external file. If do_processing is true, file contents
|
|
|
|
* will be decompressed, and also turned into an ELF if appropriate.
|
2013-01-28 19:29:49 +01:00
|
|
|
* Returns 0 on success, otherwise (ex, not found) non-zero. */
|
|
|
|
int cbfs_export_entry(struct cbfs_image *image, const char *entry_name,
|
2018-08-09 11:49:52 +02:00
|
|
|
const char *filename, uint32_t arch, bool do_processing);
|
2013-01-28 19:29:49 +01:00
|
|
|
|
2013-01-29 03:24:00 +01:00
|
|
|
/* Adds an entry to CBFS image by given name and type. If content_offset is
|
|
|
|
* non-zero, try to align "content" (CBFS_SUBHEADER(p)) at content_offset.
|
2015-05-07 11:39:22 +02:00
|
|
|
* Never pass this function a top-aligned address: convert it to an offset.
|
2013-01-29 03:24:00 +01:00
|
|
|
* Returns 0 on success, otherwise non-zero. */
|
|
|
|
int cbfs_add_entry(struct cbfs_image *image, struct buffer *buffer,
|
2015-08-25 22:27:57 +02:00
|
|
|
uint32_t content_offset, struct cbfs_file *header);
|
2013-01-29 03:24:00 +01:00
|
|
|
|
2013-01-28 19:38:40 +01:00
|
|
|
/* Removes an entry from CBFS image. Returns 0 on success, otherwise non-zero. */
|
|
|
|
int cbfs_remove_entry(struct cbfs_image *image, const char *name);
|
|
|
|
|
2015-08-12 09:20:11 +02:00
|
|
|
/* Create a new cbfs file header structure to work with.
|
|
|
|
Returns newly allocated memory that the caller needs to free after use. */
|
|
|
|
struct cbfs_file *cbfs_create_file_header(int type, size_t len,
|
|
|
|
const char *name);
|
|
|
|
|
2013-01-28 20:46:02 +01:00
|
|
|
/* Initializes a new empty (type = NULL) entry with size and name in CBFS image.
|
|
|
|
* Returns 0 on success, otherwise (ex, not found) non-zero. */
|
2015-08-12 09:12:06 +02:00
|
|
|
int cbfs_create_empty_entry(struct cbfs_file *entry, int type,
|
2013-01-28 20:46:02 +01:00
|
|
|
size_t len, const char *name);
|
|
|
|
|
2013-03-19 05:24:43 +01:00
|
|
|
/* Finds a location to put given content by specified criteria:
|
|
|
|
* "page_size" limits the content to fit on same memory page, and
|
|
|
|
* "align" specifies starting address alignment.
|
2013-01-28 20:46:02 +01:00
|
|
|
* Returns a valid offset, or -1 on failure. */
|
2015-09-15 19:50:14 +02:00
|
|
|
int32_t cbfs_locate_entry(struct cbfs_image *image, size_t size,
|
|
|
|
size_t page_size, size_t align, size_t metadata_size);
|
2013-01-28 20:46:02 +01:00
|
|
|
|
2013-01-28 19:15:49 +01:00
|
|
|
/* Callback function used by cbfs_walk.
|
|
|
|
* Returns 0 on success, or non-zero to stop further iteration. */
|
|
|
|
typedef int (*cbfs_entry_callback)(struct cbfs_image *image,
|
|
|
|
struct cbfs_file *file,
|
|
|
|
void *arg);
|
|
|
|
|
|
|
|
/* Iterates through all entries in CBFS image, and invoke with callback.
|
|
|
|
* Stops if callback returns non-zero values.
|
|
|
|
* Returns number of entries invoked. */
|
|
|
|
int cbfs_walk(struct cbfs_image *image, cbfs_entry_callback callback, void *arg);
|
|
|
|
|
2013-01-28 18:56:17 +01:00
|
|
|
/* Primitive CBFS utilities */
|
|
|
|
|
|
|
|
/* Returns a pointer to the only valid CBFS header in give buffer, otherwise
|
|
|
|
* NULL (including when multiple headers were found). If there is a X86 ROM
|
|
|
|
* style signature (pointer at 0xfffffffc) found in ROM, it will be selected as
|
|
|
|
* the only header.*/
|
cbfstool: allow user to explicitly specify header location
There potentially could be multiple CBFS instances present in the
firmware image. cbfstool should be able to operate on any of them, not
just the first one present.
To accomplish that, allow all CBFS commands to accept the -H parameter
(which specifies the exact CBFS header location in the image).
If this parameter is specified, the image is not searched for the CBFS
header, only the specified location is checked for validity, If the
location is valid, it is considered to be the CBFS header, if not -
the tool exits with an error status.
Note, that default behavior of the tool does not change.
BRANCH=storm
BUG=chrome-os-partner:34161, chromium:445938
TEST=run the following experiments:
- examined an image with three CBFS instances, was able to print all
of them.
- built a rambi coreboot image and tried the following (cbfstool output abbreviated):
$ ./util/cbfstool/cbfstool /build/rambi/firmware/coreboot.rom print
coreboot.rom: 8192 kB, bootblocksize 2448, romsize 8388608, offset 0x700000
alignment: 64 bytes, architecture: x86
Name Offset Type Size
cmos_layout.bin 0x700000 cmos_layout 1164
...
(empty) 0x7ec600 null 77848
$ \od -tx4 -Ax /build/rambi/firmware/coreboot.rom | tail -2
7ffff0 fff67de9 000000ff fff6dfe9 fffff650
800000
$ ./util/cbfstool/cbfstool /build/rambi/firmware/coreboot.rom print -H 0x7ff650
coreboot.rom: 8192 kB, bootblocksize 2448, romsize 8388608, offset 0x700000
alignment: 64 bytes, architecture: x86
Name Offset Type Size
cmos_layout.bin 0x700000 cmos_layout 1164
...
(empty) 0x7ec600 null 77848
$ ./util/cbfstool/cbfstool /build/rambi/firmware/coreboot.rom print -H 0x7ff654
E: /build/rambi/firmware/coreboot.rom does not have CBFS master header.
E: Could not load ROM image '/build/rambi/firmware/coreboot.rom'.
$
Change-Id: I64cbdc79096f3c7a113762b641305542af7bbd60
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: 86b88222df6eed25bb176d653305e2e57e18b73a
Original-Change-Id: I486092e222c96c65868ae7d41a9e8976ffcc93c4
Original-Signed-off-by: Vadim Bendebury <vbendeb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/237485
Original-Reviewed-by: David Hendricks <dhendrix@chromium.org>
Original-Reviewed-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Reviewed-by: Stefan Reinauer <reinauer@google.com>
Reviewed-on: http://review.coreboot.org/9741
Tested-by: build bot (Jenkins)
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
2014-12-24 00:10:12 +01:00
|
|
|
struct cbfs_header *cbfs_find_header(char *data, size_t size,
|
|
|
|
uint32_t forced_offset);
|
2013-01-28 18:56:17 +01:00
|
|
|
|
|
|
|
/* Returns the first cbfs_file entry in CBFS image by CBFS header (no matter if
|
|
|
|
* the entry has valid content or not), otherwise NULL. */
|
|
|
|
struct cbfs_file *cbfs_find_first_entry(struct cbfs_image *image);
|
|
|
|
|
|
|
|
/* Returns next cbfs_file entry (no matter if its content is valid or not), or
|
|
|
|
* NULL on failure. */
|
|
|
|
struct cbfs_file *cbfs_find_next_entry(struct cbfs_image *image,
|
|
|
|
struct cbfs_file *entry);
|
|
|
|
|
|
|
|
/* Returns ROM address (offset) of entry.
|
|
|
|
* This is different from entry->offset (pointer to content). */
|
|
|
|
uint32_t cbfs_get_entry_addr(struct cbfs_image *image, struct cbfs_file *entry);
|
|
|
|
|
cbfstool: New image format w/ required FMAP and w/o CBFS master header
These new-style firmware images use the FMAP of the root of knowledge
about their layout, which allows them to have sections containing raw
data whose offset and size can easily be determined at runtime or when
modifying or flashing the image. Furthermore, they can even have
multiple CBFSes, each of which occupies a different FMAP region. It is
assumed that the first entry of each CBFS, including the primary one,
will be located right at the start of its region. This means that the
bootblock needs to be moved into its own FMAP region, but makes the
CBFS master header obsolete because, with the exception of the version
and alignment, all its fields are redundant once its CBFS has an entry
in the FMAP. The version code will be addressed in a future commit
before the new format comes into use, while the alignment will just be
defined to 64 bytes in both cbfstool and coreboot itself, since
there's almost no reason to ever change it in practice. The version
code field and all necessary coreboot changes will come separately.
BUG=chromium:470407
TEST=Build panther and nyan_big coreboot.rom and image.bin images with
and without this patch, diff their hexdumps, and note that no
locations differ except for those that do between subsequent builds of
the same codebase. Try working with new-style images: use fmaptool to
produce an FMAP section from an fmd file having raw sections and
multiple CBFSes, pass the resulting file to cbfstool create -M -F,
then try printing its layout and CBFSes' contents, add and remove CBFS
files, and read and write raw sections.
BRANCH=None
Change-Id: I7dd2578d2143d0cedd652fdba5b22221fcc2184a
Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Commit-Id: 8a670322297f83135b929a5b20ff2bd0e7d2abd3
Original-Change-Id: Ib86fb50edc66632f4e6f717909bbe4efb6c874e5
Original-Signed-off-by: Sol Boucher <solb@chromium.org>
Original-Reviewed-on: https://chromium-review.googlesource.com/265863
Original-Reviewed-by: Aaron Durbin <adurbin@chromium.org>
Reviewed-on: http://review.coreboot.org/10135
Tested-by: build bot (Jenkins)
2015-03-18 20:36:27 +01:00
|
|
|
/* Returns 1 if valid new-format CBFS (without a master header), otherwise 0. */
|
|
|
|
int cbfs_is_valid_cbfs(struct cbfs_image *image);
|
|
|
|
|
|
|
|
/* Returns 1 if valid legacy CBFS (with a master header), otherwise 0. */
|
|
|
|
int cbfs_is_legacy_cbfs(struct cbfs_image *image);
|
|
|
|
|
2013-01-28 18:56:17 +01:00
|
|
|
/* Returns 1 if entry has valid data (by checking magic number), otherwise 0. */
|
2013-02-09 03:38:55 +01:00
|
|
|
int cbfs_is_valid_entry(struct cbfs_image *image, struct cbfs_file *entry);
|
2013-01-28 18:56:17 +01:00
|
|
|
|
2013-01-28 19:15:49 +01:00
|
|
|
/* Print CBFS component information. */
|
|
|
|
int cbfs_print_directory(struct cbfs_image *image);
|
2016-01-26 22:35:34 +01:00
|
|
|
int cbfs_print_parseable_directory(struct cbfs_image *image);
|
2013-01-28 19:15:49 +01:00
|
|
|
int cbfs_print_header_info(struct cbfs_image *image);
|
|
|
|
int cbfs_print_entry_info(struct cbfs_image *image, struct cbfs_file *entry,
|
|
|
|
void *arg);
|
|
|
|
|
2013-01-28 20:46:02 +01:00
|
|
|
/* Merge empty entries starting from given entry.
|
|
|
|
* Returns 0 on success, otherwise non-zero. */
|
|
|
|
int cbfs_merge_empty_entry(struct cbfs_image *image, struct cbfs_file *entry,
|
|
|
|
void *arg);
|
|
|
|
|
2015-08-11 15:10:02 +02:00
|
|
|
/* Returns the size of a cbfs file header with no extensions */
|
|
|
|
size_t cbfs_calculate_file_header_size(const char *name);
|
2015-07-15 20:49:00 +02:00
|
|
|
|
|
|
|
/* Given a cbfs_file, return the first file attribute, or NULL. */
|
|
|
|
struct cbfs_file_attribute *cbfs_file_first_attr(struct cbfs_file *file);
|
|
|
|
|
|
|
|
/* Given a cbfs_file and a cbfs_file_attribute, return the attribute that
|
|
|
|
* follows it, or NULL. */
|
|
|
|
struct cbfs_file_attribute *cbfs_file_next_attr(struct cbfs_file *file,
|
|
|
|
struct cbfs_file_attribute *attr);
|
|
|
|
|
|
|
|
/* Adds to header a new extended attribute tagged 'tag', sized 'size'.
|
|
|
|
* Returns pointer to the new attribute, or NULL on error. */
|
|
|
|
struct cbfs_file_attribute *cbfs_add_file_attr(struct cbfs_file *header,
|
|
|
|
uint32_t tag,
|
|
|
|
uint32_t size);
|
2015-10-01 15:54:04 +02:00
|
|
|
|
|
|
|
/* Adds an extended attribute to header, containing a hash of buffer's data of
|
|
|
|
* the type specified by hash_type.
|
|
|
|
* Returns 0 on success, -1 on error. */
|
|
|
|
int cbfs_add_file_hash(struct cbfs_file *header, struct buffer *buffer,
|
|
|
|
enum vb2_hash_algorithm hash_type);
|
2013-01-28 18:56:17 +01:00
|
|
|
#endif
|