67a0a864be
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)
146 lines
4.4 KiB
C
146 lines
4.4 KiB
C
/*
|
|
* Copyright (C) 2009 coresystems GmbH
|
|
* written by Patrick Georgi <patrick.georgi@coresystems.de>
|
|
*
|
|
* 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.
|
|
*
|
|
* 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., 51 Franklin St, Fifth Floor, Boston, MA, 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef __CBFS_H
|
|
#define __CBFS_H
|
|
|
|
#include <stdint.h>
|
|
|
|
/* create a magic number in host-byte order.
|
|
* b3 is the high order byte.
|
|
* in the coreboot tools, we go with the 32-bit
|
|
* magic number convention.
|
|
* This was an inline func but that breaks anything
|
|
* that uses it in a case statement.
|
|
*/
|
|
|
|
#define makemagic(b3, b2, b1, b0)\
|
|
(((b3)<<24) | ((b2) << 16) | ((b1) << 8) | (b0))
|
|
|
|
// Alignment (in bytes) to be used when no master header is present
|
|
#define CBFS_ENTRY_ALIGNMENT 64
|
|
|
|
#define CBFS_HEADER_MAGIC 0x4F524243
|
|
#define CBFS_HEADPTR_ADDR_X86 0xFFFFFFFC
|
|
#define CBFS_HEADER_VERSION1 0x31313131
|
|
#define CBFS_HEADER_VERSION2 0x31313132
|
|
#define CBFS_HEADER_VERSION CBFS_HEADER_VERSION2
|
|
|
|
struct cbfs_header {
|
|
uint32_t magic;
|
|
uint32_t version;
|
|
uint32_t romsize;
|
|
uint32_t bootblocksize;
|
|
uint32_t align;
|
|
uint32_t offset;
|
|
uint32_t architecture; /* Version 2 */
|
|
uint32_t pad[1];
|
|
} __attribute__ ((packed));
|
|
|
|
#define CBFS_ARCHITECTURE_UNKNOWN 0xFFFFFFFF
|
|
#define CBFS_ARCHITECTURE_X86 0x00000001
|
|
#define CBFS_ARCHITECTURE_ARM 0x00000010
|
|
#define CBFS_ARCHITECTURE_AARCH64 0x0000aa64
|
|
#define CBFS_ARCHITECTURE_MIPS 0x00000100
|
|
#define CBFS_ARCHITECTURE_RISCV 0xc001d0de
|
|
|
|
#define CBFS_FILE_MAGIC "LARCHIVE"
|
|
|
|
struct cbfs_file {
|
|
uint8_t magic[8];
|
|
uint32_t len;
|
|
uint32_t type;
|
|
uint32_t checksum;
|
|
uint32_t offset;
|
|
} __attribute__ ((packed));
|
|
|
|
struct cbfs_stage {
|
|
uint32_t compression;
|
|
uint64_t entry;
|
|
uint64_t load;
|
|
uint32_t len;
|
|
uint32_t memlen;
|
|
} __attribute__ ((packed));
|
|
|
|
#define PAYLOAD_SEGMENT_CODE makemagic('C', 'O', 'D', 'E')
|
|
#define PAYLOAD_SEGMENT_DATA makemagic('D', 'A', 'T', 'A')
|
|
#define PAYLOAD_SEGMENT_BSS makemagic('B', 'S', 'S', ' ')
|
|
#define PAYLOAD_SEGMENT_PARAMS makemagic('P', 'A', 'R', 'A')
|
|
#define PAYLOAD_SEGMENT_ENTRY makemagic('E', 'N', 'T', 'R')
|
|
|
|
struct cbfs_payload_segment {
|
|
uint32_t type;
|
|
uint32_t compression;
|
|
uint32_t offset;
|
|
uint64_t load_addr;
|
|
uint32_t len;
|
|
uint32_t mem_len;
|
|
} __attribute__ ((packed));
|
|
|
|
struct cbfs_payload {
|
|
struct cbfs_payload_segment segments;
|
|
} __attribute__ ((packed));
|
|
|
|
/** These are standard component types for well known
|
|
components (i.e - those that coreboot needs to consume.
|
|
Users are welcome to use any other value for their
|
|
components */
|
|
|
|
#define CBFS_COMPONENT_STAGE 0x10
|
|
#define CBFS_COMPONENT_PAYLOAD 0x20
|
|
#define CBFS_COMPONENT_OPTIONROM 0x30
|
|
#define CBFS_COMPONENT_BOOTSPLASH 0x40
|
|
#define CBFS_COMPONENT_RAW 0x50
|
|
#define CBFS_COMPONENT_VSA 0x51
|
|
#define CBFS_COMPONENT_MBI 0x52
|
|
#define CBFS_COMPONENT_MICROCODE 0x53
|
|
#define CBFS_COMPONENT_FSP 0x60
|
|
#define CBFS_COMPONENT_MRC 0x61
|
|
#define CBFS_COMPONENT_CMOS_DEFAULT 0xaa
|
|
#define CBFS_COMPONENT_SPD 0xab
|
|
#define CBFS_COMPONENT_MRC_CACHE 0xac
|
|
#define CBFS_COMPONENT_CMOS_LAYOUT 0x01aa
|
|
|
|
/* The deleted type is chosen to be a value
|
|
* that can be written in a FLASH from all other
|
|
* values.
|
|
*/
|
|
#define CBFS_COMPONENT_DELETED 0
|
|
|
|
/* for all known FLASH, this value can be changed
|
|
* to all other values. This allows NULL files to be
|
|
* changed without a block erase
|
|
*/
|
|
#define CBFS_COMPONENT_NULL 0xFFFFFFFF
|
|
|
|
#define CBFS_NAME(_c) (((char *) (_c)) + sizeof(struct cbfs_file))
|
|
#define CBFS_SUBHEADER(_p) ( (void *) ((((uint8_t *) (_p)) + ntohl((_p)->offset))) )
|
|
/* cbfs_image.c */
|
|
uint32_t get_cbfs_entry_type(const char *name, uint32_t default_value);
|
|
uint32_t get_cbfs_compression(const char *name, uint32_t unknown);
|
|
|
|
/* common.c */
|
|
void cbfs_file_get_header(struct buffer *buf, struct cbfs_file *file);
|
|
|
|
/* cbfs-mkpayload.c */
|
|
void xdr_segs(struct buffer *output,
|
|
struct cbfs_payload_segment *segs, int nseg);
|
|
void xdr_get_seg(struct cbfs_payload_segment *out,
|
|
struct cbfs_payload_segment *in);
|
|
|
|
#endif
|