summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Rudolph <patrick.rudolph@9elements.com>2019-09-20 12:53:09 +0200
committerNico Huber <nico.h@gmx.de>2020-01-06 10:56:09 +0000
commit9e877ec60d177565776b20e3d61f723a9552ee34 (patch)
tree8e5abc8ac1a90afaa24aa08a1d674fbd19a57694
parent9b5447b7819ac99ffc3787f2ecb0c4428eea8055 (diff)
downloadcoreboot-9e877ec60d177565776b20e3d61f723a9552ee34.tar.xz
util/supermicro: Add and use new tool smcbiosinfo
The BMC and tools interacting with it depend on metadata placed inside the ROM in order the flash the BIOS. Add a new tool smcbiosinfo, integrate it into the build system, and generate a 128byte metadata file called smcbiosinfo.bin on build. You need to provide the BoardID for every SMC mainboard through a new Kconfig symbol: SUPERMICRO_BOARDID Some fields are unknown, but it's sufficient to flash it using SMC vendor tools. Tested on Supermicro X11SSH: * Flashing using the WebUI works * Flashing using SMCIPMITool works No further validation is done on the firmware. Change-Id: Id608c2ce78614b45a2fd0b26d97d666f02223998 Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/35484 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Philipp Deppenwiese <zaolin.daisuki@gmail.com> Reviewed-by: Nico Huber <nico.h@gmx.de>
-rw-r--r--Documentation/mainboard/index.md1
-rw-r--r--Documentation/mainboard/supermicro/flashing_on_vendorbmc.md32
-rw-r--r--Makefile.inc2
-rw-r--r--src/mainboard/supermicro/x11-lga1151-series/Kconfig4
-rw-r--r--util/supermicro/Makefile.inc21
-rw-r--r--util/supermicro/smcbiosinfo/description.md1
-rw-r--r--util/supermicro/smcbiosinfo/smcbiosinfo.c282
7 files changed, 342 insertions, 1 deletions
diff --git a/Documentation/mainboard/index.md b/Documentation/mainboard/index.md
index 038689d192..3e6a985858 100644
--- a/Documentation/mainboard/index.md
+++ b/Documentation/mainboard/index.md
@@ -126,6 +126,7 @@ The boards in this section are not real mainboards, but emulators.
- [X10SLM+-F](supermicro/x10slm-f.md)
- [X11 LGA1151 series](supermicro/x11-lga1151-series/x11-lga1151-series.md)
+- [Flashing using the BMC](supermicro/flashing_on_vendorbmc.md)
## UP
diff --git a/Documentation/mainboard/supermicro/flashing_on_vendorbmc.md b/Documentation/mainboard/supermicro/flashing_on_vendorbmc.md
new file mode 100644
index 0000000000..e02c57bcc4
--- /dev/null
+++ b/Documentation/mainboard/supermicro/flashing_on_vendorbmc.md
@@ -0,0 +1,32 @@
+# Flashing coreboot using SMC IPMI (BMC) firmware
+
+## Metadata
+In order to flash anything to the "BIOS" IC, it needs to contain a valid
+BIOSINFO struct.
+
+The BIOSINFO struct contains a `$FID` marker at the beginning and is
+128 bytes in total. Besides the *BoardID* it contains the *firmware version*
+and *build date*. The BMC verifies that the BoardID is correct and refuses to
+flash if it's not.
+
+The struct has no checksum or cryptographic protection.
+
+## The smcinfobios tool
+
+The smcbiosinfo tool can be found in `util/supermicro/smcbiosinfo`.
+
+It parses the `build/build.h` header to get the current coreboot version and
+build timestamp.
+The *board ID* is passed as command line argument.
+
+It will place a file in CBFS called `smcbiosinfo.bin`, which is then found
+by the vendor tools. The file contains the struct described above.
+
+## Flashing using SMCIPMItool
+
+You can use the *SMCIPMITool* to remotely flash the BIOS:
+
+`SMCIPMITool <remote BMC IP> <user> <password> bios update build/coreboot.rom`
+
+Make sure that the ME isn't in recovery mode, otherwise you get an error
+message on updating the BIOS.
diff --git a/Makefile.inc b/Makefile.inc
index 82adc1d0f9..a54e57bc6c 100644
--- a/Makefile.inc
+++ b/Makefile.inc
@@ -94,7 +94,7 @@ subdirs-y += src/superio
subdirs-y += $(wildcard src/drivers/*) $(wildcard src/drivers/*/*)
subdirs-y += src/cpu src/vendorcode
subdirs-y += util/cbfstool util/sconfig util/nvramtool util/pgtblgen
-subdirs-y += util/futility util/marvell util/bincfg
+subdirs-y += util/futility util/marvell util/bincfg util/supermicro
subdirs-y += $(wildcard src/arch/*)
subdirs-y += src/mainboard/$(MAINBOARDDIR)
subdirs-y += src/security
diff --git a/src/mainboard/supermicro/x11-lga1151-series/Kconfig b/src/mainboard/supermicro/x11-lga1151-series/Kconfig
index 5a99f7aac5..02c9c86441 100644
--- a/src/mainboard/supermicro/x11-lga1151-series/Kconfig
+++ b/src/mainboard/supermicro/x11-lga1151-series/Kconfig
@@ -86,4 +86,8 @@ config DIMM_SPD_SIZE
int
default 512
+config SUPERMICRO_BOARDID
+ string
+ default "089C"
+
endif # BOARD_SUPERMICRO_BASEBOARD_X11_LGA1151_SERIES
diff --git a/util/supermicro/Makefile.inc b/util/supermicro/Makefile.inc
new file mode 100644
index 0000000000..e71cfbdb19
--- /dev/null
+++ b/util/supermicro/Makefile.inc
@@ -0,0 +1,21 @@
+ifeq ($(CONFIG_VENDOR_SUPERMICRO),y)
+ifneq ($(call strip_quotes, $(CONFIG_SUPERMICRO_BOARDID)),)
+
+SMCBIOSINFOTOOL:= $(objutil)/supermicro/smcbiosinfo
+
+$(SMCBIOSINFOTOOL): $(dir)/smcbiosinfo/smcbiosinfo.c
+ printf " HOSTCC Creating SMCBIOSINFO tool\n"
+ mkdir -p $(objutil)/supermicro
+ $(HOSTCC) $< -o $@
+
+cbfs-files-y += smcbiosinfo.bin
+
+smcbiosinfo.bin-file := $(obj)/mainboard/$(MAINBOARDDIR)/smcbiosinfo.bin
+smcbiosinfo.bin-type := raw
+smcbiosinfo.bin-compression := none
+
+$(obj)/mainboard/$(MAINBOARDDIR)/smcbiosinfo.bin: $(SMCBIOSINFOTOOL) $(build_h)
+ printf " TOOL Creating SMC BIOSINFO metadata\n"
+ $(SMCBIOSINFOTOOL) -i $(build_h) -b $(CONFIG_SUPERMICRO_BOARDID) -o $@
+endif
+endif
diff --git a/util/supermicro/smcbiosinfo/description.md b/util/supermicro/smcbiosinfo/description.md
new file mode 100644
index 0000000000..21170eb6f0
--- /dev/null
+++ b/util/supermicro/smcbiosinfo/description.md
@@ -0,0 +1 @@
+Generates SMC biosinfo for BMC BIOS updates `C`
diff --git a/util/supermicro/smcbiosinfo/smcbiosinfo.c b/util/supermicro/smcbiosinfo/smcbiosinfo.c
new file mode 100644
index 0000000000..ae2a17b469
--- /dev/null
+++ b/util/supermicro/smcbiosinfo/smcbiosinfo.c
@@ -0,0 +1,282 @@
+/*
+ * This file is part of the coreboot project.
+ *
+ * Copyright (C) 2019 9elements Agency GmbH <patrick.rudolph@9elements.com>
+ *
+ * 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.
+ */
+
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include <stdint.h>
+#include <unistd.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <getopt.h>
+#include <errno.h>
+#include <stdarg.h>
+
+/* Place the following struct somewhere in the ROM: */
+struct SMC_BIOS_Update {
+ uint8_t magic0[4]; // always 0xaa00b1ed
+ char magic1[4]; // always $FID
+ uint8_t magic2[2]; // always 0x7804
+ uint8_t space0; // always zero
+ // SMCinfotool doesn't care for the first letter
+ // The BMC webinterface does.
+ char boardid[9]; // "100000000"
+ uint8_t space1[15]; // unknown data
+ uint8_t space2; // always 0x1f
+ char ukn_majorVer[2];// unknown
+ uint8_t space3; // always zero
+ char ukn_minorVer[2];// unknown
+ uint8_t space4; // always zero
+ char majorVer[3]; // BIOS major version
+ char minorVer[2]; // BIOS minor version
+ uint8_t space5; // always zero
+ uint16_t year; // year
+ uint8_t month; // month
+ uint8_t day; // day
+ uint32_t space6; // unknown data
+ uint8_t space7; // all ones
+ char str[15]; // "SUPERMSMCI--MB1"
+ uint8_t space8[3]; // always zero
+ uint64_t space9[6]; // all ones
+} __packed;
+
+static const char *optstring = "b:i:o:h";
+
+static struct option long_options[] = {
+ {"boardid", required_argument, 0, 'b' },
+ {"input", required_argument, 0, 'i' },
+ {"output", required_argument, 0, 'o' },
+ {"help", no_argument, 0, 'h' },
+};
+
+static void usage(void)
+{
+ printf("smcbiosinfo: Create BIOSInfo for BMC BIOS updates\n");
+ printf("Usage: smcbiosinfo [options] -i build.h -b <boardid> -o <filename>\n");
+ printf("-b | --boardid <ID> The board ID assigned by SMC\n");
+ printf("-i | --input <FILE> The build.h file to parse\n");
+ printf("-o | --output <FILE> The file to generate\n");
+ printf("-h | --help Print this help\n");
+}
+
+static int bcd2int(int hex)
+{
+ if (hex > 0xff)
+ return -1;
+ return ((hex & 0xF0) >> 4) * 10 + (hex & 0x0F);
+}
+
+static char *get_line(char *fn, char *match)
+{
+ ssize_t read;
+ char *line = NULL;
+ char *ret = NULL;
+ size_t len = 0;
+
+ FILE *fp = fopen(fn, "r");
+ if (fp == NULL) {
+ fprintf(stderr, "E: Couldn't open file '%s'\n", fn);
+ return NULL;
+ }
+
+ while ((read = getline(&line, &len, fp)) != -1) {
+ if (strstr(line, match) != NULL) {
+ ret = strdup(strstr(line, match) + strlen(match));
+ break;
+ }
+ }
+
+ if (!ret)
+ fprintf(stderr, "E: %s not found in %s\n", match, fn);
+
+ fclose(fp);
+ return ret;
+}
+
+static int get_line_as_int(char *fn, char *match, int bcd)
+{
+ int ret = -1;
+ char *s = get_line(fn, match);
+ if (s && strlen(s) > 0) {
+ char *endptr;
+ ret = strtol(s, &endptr, 0);
+ if (*endptr != '\0' && *endptr != '\n') {
+ fprintf(stderr, "E: Couldn't parse number for key '%s'\n", match);
+ return -1;
+ }
+ if (bcd)
+ ret = bcd2int(ret);
+ free(s);
+ } else {
+ fprintf(stderr, "E: Got invalid line for key '%s'\n", match);
+ }
+
+ return ret;
+}
+
+int main(int argc, char **argv)
+{
+ int c;
+ int ret = 1;
+ char *filename = NULL;
+ char *inputfilename = NULL;
+ char *boardid = NULL;
+ int num;
+
+ while (1) {
+ int optindex = 0;
+
+ c = getopt_long(argc, argv, optstring, long_options, &optindex);
+
+ if (c == -1)
+ break;
+
+ switch (c) {
+ case 'b':
+ boardid = strdup(optarg);
+ break;
+ case 'i':
+ inputfilename = strdup(optarg);
+ break;
+ case 'o':
+ filename = strdup(optarg);
+ break;
+ case 'h':
+ ret = 0; /* fallthrough */
+ case '?':
+ usage();
+ goto out;
+ default:
+ break;
+ }
+ }
+
+ if (!inputfilename) {
+ fprintf(stderr, "E: Must specify build.h filename\n");
+ goto out;
+ }
+ if (!filename) {
+ fprintf(stderr, "E: Must specify a destination filename\n");
+ goto out;
+ }
+
+ if (!boardid || strlen(boardid) == 0) {
+ fprintf(stderr, "E: Board ID must be set\n");
+ goto out;
+ }
+ if (strlen(boardid) > 8) {
+ fprintf(stderr, "E: Board ID must be less than 8 characters\n");
+ goto out;
+ }
+
+ // generate the table
+
+ struct SMC_BIOS_Update sbu = {
+ {0xed, 0xb1, 0x00, 0xaa},
+ "$FID",
+ {0x04, 0x78},
+ 0, // space
+ "100000000", // boardid
+ {}, // unknown data
+ 0x1f, // space
+ "05", // unknown data
+ 0, // zero
+ "06", // unknown data
+ 0, // zero
+ "000", // major
+ "00", // minor
+ 0, // zero
+ 0, // year
+ 0, // month
+ 0, //day
+ 0, // unknown data
+ 0xff, // space
+ "SUPERMSMCI--MB1",
+ {0, 0, 0}, // all zero
+ {~0, ~0, ~0, ~0, ~0, ~0}, // all ones
+ };
+
+ num = get_line_as_int(inputfilename, "COREBOOT_MAJOR_VERSION", 0);
+ if (num < 0)
+ goto out;
+
+ if (num < 999) {
+ char tmp[4];
+ snprintf(tmp, sizeof(tmp), "%03d", num);
+ memcpy(&sbu.majorVer, &tmp, sizeof(sbu.majorVer));
+ } else {
+ fprintf(stderr, "E: Unsupported coreboot major version\n");
+ goto out;
+ }
+
+ num = get_line_as_int(inputfilename, "COREBOOT_MINOR_VERSION", 0);
+ if (num < 0)
+ goto out;
+
+ if (num < 99) {
+ char tmp[3];
+ snprintf(tmp, sizeof(tmp), "%02d", num);
+ memcpy(&sbu.minorVer, &tmp, sizeof(sbu.minorVer));
+ } else {
+ fprintf(stderr, "E: Unsupported coreboot minor version\n");
+ goto out;
+ }
+
+ num = get_line_as_int(inputfilename, "COREBOOT_BUILD_YEAR_BCD", 1);
+ if (num < 0)
+ goto out;
+ sbu.year = 2000 + num;
+
+ num = get_line_as_int(inputfilename, "COREBOOT_BUILD_MONTH_BCD", 1);
+ if (num < 0)
+ goto out;
+ sbu.month = num;
+
+ num = get_line_as_int(inputfilename, "COREBOOT_BUILD_DAY_BCD", 1);
+ if (num < 0)
+ goto out;
+ sbu.day = num;
+
+ memcpy(&sbu.boardid[1], boardid, strlen(boardid));
+
+ // write the table
+ FILE *fd = fopen(filename, "wb");
+ if (!fd) {
+ fprintf(stderr, "E: %s open failed: %s\n", filename, strerror(errno));
+ goto out;
+ }
+
+ if (fwrite(&sbu, 1, sizeof(sbu), fd) != sizeof(sbu)) {
+ fprintf(stderr, "E: %s write failed: %s\n", filename, strerror(errno));
+ fclose(fd);
+ goto out;
+ }
+
+ if (fclose(fd)) {
+ fprintf(stderr, "E: %s close failed: %s\n", filename, strerror(errno));
+ goto out;
+ }
+
+ ret = 0;
+out:
+ if (ret > 0)
+ fprintf(stderr, "E: Error creating '%s'\n", filename);
+
+ free(filename);
+
+ exit(ret);
+
+ return 0;
+}