Add support to get layout from fmap (e.g. coreboot rom)
Flashmap, or simply fmap, is a binary data format for describing
region offsets, sizes, and certain attributes and is widely used by
coreboot. This patch adds support for the fmap data format version 1.1
and adds --fmap and --fmap-file arguments.
Using --fmap will make flashrom to search the ROM content for fmap
data. Using --fmap-file will make flashrom search a supplied file
for fmap data.
An example of how to update the COREBOOT region of a ROM:
flashrom -p programmer --fmap -w coreboot.rom -i COREBOOT
flashrom -p programmer --fmap-file coreboot.rom -w coreboot.rom -i COREBOOT
The fmap functions are mostly copied from cbfstool.
Currently it is made mutually exclusive with other layout options until
we are more clever about this input.
Change-Id: I0e7fad38ed79a84d41358e1f175c36d255786c12
Signed-off-by: Arthur Heymans <arthur@aheymans.xyz>
Signed-off-by: David Hendricks <dhendricks@fb.com>
Reviewed-on: https://review.coreboot.org/23203
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Tested-by: David Hendricks <david.hendricks@gmail.com>
Reviewed-by: Werner Zeh <werner.zeh@siemens.com>
Reviewed-by: Nico Huber <nico.h@gmx.de>
diff --git a/cli_classic.c b/cli_classic.c
index 119c6f8..df9fa67 100644
--- a/cli_classic.c
+++ b/cli_classic.c
@@ -25,6 +25,7 @@
#include <getopt.h>
#include "flash.h"
#include "flashchips.h"
+#include "fmap.h"
#include "programmer.h"
#include "libflashrom.h"
@@ -53,6 +54,8 @@
" -n | --noverify don't auto-verify\n"
" -N | --noverify-all verify included regions only (cf. -i)\n"
" -l | --layout <layoutfile> read ROM layout from <layoutfile>\n"
+ " --fmap read ROM layout from fmap embedded in ROM\n"
+ " --fmap-file <fmapfile> read ROM layout from fmap in <fmapfile>\n"
" --ifd read layout from an Intel Firmware Descriptor\n"
" -i | --image <name> only flash image <name> from flash layout\n"
" -o | --output <logfile> log output to <logfile>\n"
@@ -97,7 +100,7 @@
struct flashctx *fill_flash;
const char *name;
int namelen, opt, i, j;
- int startchip = -1, chipcount = 0, option_index = 0, force = 0, ifd = 0;
+ int startchip = -1, chipcount = 0, option_index = 0, force = 0, ifd = 0, fmap = 0;
#if CONFIG_PRINT_WIKI == 1
int list_supported_wiki = 0;
#endif
@@ -107,6 +110,8 @@
enum programmer prog = PROGRAMMER_INVALID;
enum {
OPTION_IFD = 0x0100,
+ OPTION_FMAP,
+ OPTION_FMAP_FILE,
OPTION_FLASH_CONTENTS,
};
int ret = 0;
@@ -124,6 +129,8 @@
{"force", 0, NULL, 'f'},
{"layout", 1, NULL, 'l'},
{"ifd", 0, NULL, OPTION_IFD},
+ {"fmap", 0, NULL, OPTION_FMAP},
+ {"fmap-file", 1, NULL, OPTION_FMAP_FILE},
{"image", 1, NULL, 'i'},
{"flash-contents", 1, NULL, OPTION_FLASH_CONTENTS},
{"list-supported", 0, NULL, 'L'},
@@ -138,6 +145,7 @@
char *filename = NULL;
char *referencefile = NULL;
char *layoutfile = NULL;
+ char *fmapfile = NULL;
#ifndef STANDALONE
char *logfile = NULL;
#endif /* !STANDALONE */
@@ -230,6 +238,10 @@
fprintf(stderr, "Error: --layout and --ifd both specified. Aborting.\n");
cli_classic_abort_usage();
}
+ if (fmap) {
+ fprintf(stderr, "Error: --layout and --fmap-file both specified. Aborting.\n");
+ cli_classic_abort_usage();
+ }
layoutfile = strdup(optarg);
break;
case OPTION_IFD:
@@ -237,8 +249,45 @@
fprintf(stderr, "Error: --layout and --ifd both specified. Aborting.\n");
cli_classic_abort_usage();
}
+ if (fmap) {
+ fprintf(stderr, "Error: --fmap-file and --ifd both specified. Aborting.\n");
+ cli_classic_abort_usage();
+ }
ifd = 1;
break;
+ case OPTION_FMAP_FILE:
+ if (fmap) {
+ fprintf(stderr, "Error: --fmap or --fmap-file specified "
+ "more than once. Aborting.\n");
+ cli_classic_abort_usage();
+ }
+ if (ifd) {
+ fprintf(stderr, "Error: --fmap-file and --ifd both specified. Aborting.\n");
+ cli_classic_abort_usage();
+ }
+ if (layoutfile) {
+ fprintf(stderr, "Error: --fmap-file and --layout both specified. Aborting.\n");
+ cli_classic_abort_usage();
+ }
+ fmapfile = strdup(optarg);
+ fmap = 1;
+ break;
+ case OPTION_FMAP:
+ if (fmap) {
+ fprintf(stderr, "Error: --fmap or --fmap-file specified "
+ "more than once. Aborting.\n");
+ cli_classic_abort_usage();
+ }
+ if (ifd) {
+ fprintf(stderr, "Error: --fmap and --ifd both specified. Aborting.\n");
+ cli_classic_abort_usage();
+ }
+ if (layoutfile) {
+ fprintf(stderr, "Error: --layout and --fmap both specified. Aborting.\n");
+ cli_classic_abort_usage();
+ }
+ fmap = 1;
+ break;
case 'i':
tempstr = strdup(optarg);
if (register_include_arg(tempstr)) {
@@ -360,6 +409,9 @@
if (layoutfile && check_filename(layoutfile, "layout")) {
cli_classic_abort_usage();
}
+ if (fmapfile && check_filename(fmapfile, "fmap")) {
+ cli_classic_abort_usage();
+ }
if (referencefile && check_filename(referencefile, "reference")) {
cli_classic_abort_usage();
}
@@ -399,7 +451,8 @@
ret = 1;
goto out;
}
- if (!ifd && process_include_args(get_global_layout())) {
+
+ if (!ifd && !fmap && process_include_args(get_global_layout())) {
ret = 1;
goto out;
}
@@ -558,6 +611,38 @@
process_include_args(layout))) {
ret = 1;
goto out_shutdown;
+ } else if (fmap && fmapfile) {
+ struct stat s;
+ if (stat(fmapfile, &s) != 0) {
+ msg_gerr("Failed to stat fmapfile \"%s\"\n", fmapfile);
+ ret = 1;
+ goto out_shutdown;
+ }
+
+ size_t fmapfile_size = s.st_size;
+ uint8_t *fmapfile_buffer = malloc(fmapfile_size);
+ if (!fmapfile_buffer) {
+ ret = 1;
+ goto out_shutdown;
+ }
+
+ if (read_buf_from_file(fmapfile_buffer, fmapfile_size, fmapfile)) {
+ ret = 1;
+ free(fmapfile_buffer);
+ goto out_shutdown;
+ }
+
+ if (flashrom_layout_read_fmap_from_buffer(&layout, fill_flash, fmapfile_buffer, fmapfile_size) ||
+ process_include_args(layout)) {
+ ret = 1;
+ free(fmapfile_buffer);
+ goto out_shutdown;
+ }
+ free(fmapfile_buffer);
+ } else if (fmap && (flashrom_layout_read_fmap_from_rom(&layout, fill_flash, 0,
+ fill_flash->chip->total_size * 1024) || process_include_args(layout))) {
+ ret = 1;
+ goto out_shutdown;
}
flashrom_layout_set(fill_flash, layout);