Change in em100[master]: Add compatibility mode - coreboot-gerrit

26 Nov 2019

Stefan Reinauer has uploaded this change for review. ( https://review.coreboot.org/c/em100/+/37258 )
Change subject: Add compatibility mode
......................................................................
Add compatibility mode
Add a compatibility mode to the em100 tool. Right now coreboot
and the Chrome OS build system carry a bunch of work-arounds to
produce two sets of images, one for "real SPI chips" and one for
use with the EM100Pro. Instead, we can (and should) just recognize
these images and have the em100 tool handle them correctly during
upload. em100 --compatibility ... does exactly that.
Signed-off-by: Stefan Reinauer stefan.reinauer@coreboot.org
Change-Id: Ie02264facb028841d18ed84680ffa40f45987510
---
M Makefile
M em100.c
M em100.h
A ifd.h
A image.c
5 files changed, 251 insertions(+), 4 deletions(-)
git pull ssh://review.coreboot.org:29418/em100 refs/changes/58/37258/1

diff --git a/Makefile b/Makefile
index 0b7c217..3bdb103 100644
--- a/Makefile
+++ b/Makefile
@@ -40,7 +40,7 @@
XZ = xz/xz_crc32.c  xz/xz_crc64.c  xz/xz_dec_bcj.c  xz/xz_dec_lzma2.c  xz/xz_dec_stream.c
 SOURCES = em100.c firmware.c fpga.c hexdump.c sdram.c spi.c system.c trace.c usb.c
-SOURCES += curl.c chips.c tar.c $(XZ)
+SOURCES += image.c curl.c chips.c tar.c $(XZ)
 OBJECTS = $(SOURCES:.c=.o)
all: dep em100
diff --git a/em100.c b/em100.c
index e52222b..abd8415 100644
--- a/em100.c
+++ b/em100.c
@@ -758,7 +758,8 @@
    {"device", 1, 0, 'x'},
    {"list-devices", 0, 0, 'l'},
    {"update-files", 0, 0, 'U'},
-	{"terminal",0 ,0, 'T'},
+	{"terminal", 0, 0, 'T'},
+	{"compatible", 0, 0, 'C'},
    {NULL, 0, 0, 0}
 };
@@ -787,6 +788,7 @@
    	"  -x|--device EMxxxxxx            use EM100pro with serial no EMxxxxxx\n"
    	"  -l|--list-devices               list all connected EM100pro devices\n"
    	"  -U|--update-files               update device (chip) and firmware database\n"
+		"  -C|--compatible                 enable compatibility mode (patch image for EM100Pro)\n"
    	"  -D|--debug:                     print debug information.\n"
    	"  -h|--help:                      this help text\n\n",
    	name);
@@ -802,7 +804,7 @@
    const char *holdpin = NULL;
    int do_start = 0, do_stop = 0;
    int verify = 0, trace = 0, terminal=0;
-	int debug = 0;
+	int debug = 0, compatibility = 0;
    int bus = 0, device = 0;
    int firmware_is_dpfw = 0;
    unsigned int serial_number = 0;
@@ -810,7 +812,7 @@
    unsigned int spi_start_address = 0;
    const char *voltage = NULL;
-	while ((opt = getopt_long(argc, argv, "c:d:a:u:rsvtO:F:f:g:S:V:p:Dx:lUhT",
+	while ((opt = getopt_long(argc, argv, "c:d:a:u:rsvtO:F:f:g:S:V:p:DCx:lUhT",
    			  longopts, &idx)) != -1) {
    	switch (opt) {
    	case 'c':
@@ -881,6 +883,9 @@
    	case 'U':
    		update_all_files();
    		return 0;
+		case 'C':
+			compatibility = 1;
+			break;
    	default:
    	case 'h':
    		usage(argv[0]);
@@ -1074,6 +1079,9 @@
    		return 1;
    	}
+		if (compatibility)
+			autocorrect_image(&em100, data, length);
+
    	if (spi_start_address) {
    		readback = malloc(maxlen);
    		if (readback == NULL) {
diff --git a/em100.h b/em100.h
index f0bacf2..448e6bb 100644
--- a/em100.h
+++ b/em100.h
@@ -196,9 +196,13 @@
#define MB * 1024 * 1024
 #define FILENAME_BUFFER_SIZE 1024
+#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
 char *get_em100_file(const char *name);
/* Chips */
 int parse_dcfg(chipdesc *chip, TFILE *dcfg);
+/* Images */
+int autocorrect_image(struct em100 *em100, char *image, size_t size);
+
 #endif
diff --git a/ifd.h b/ifd.h
new file mode 100644
index 0000000..dac4edb
--- /dev/null
+++ b/ifd.h
@@ -0,0 +1,50 @@
+/*
+ * Copyright 2019 Google LLC
+ *
+ * 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.
+ */
+
+enum ifd_version {
+	IFD_VERSION_1,
+	IFD_VERSION_2,
+};
+
+enum platform {
+	PLATFORM_APL,
+	PLATFORM_CNL,
+	PLATFORM_GLK,
+	PLATFORM_ICL,
+	PLATFORM_SKLKBL,
+	PLATFORM_TGL,
+};
+
+enum spi_frequency {
+	SPI_FREQUENCY_20MHZ = 0,
+	SPI_FREQUENCY_33MHZ = 1,
+	SPI_FREQUENCY_48MHZ = 2,
+	SPI_FREQUENCY_50MHZ_30MHZ = 4,
+	SPI_FREQUENCY_17MHZ = 6,
+};
+
+/* flash descriptor */
+typedef struct {
+	uint32_t flvalsig;
+	uint32_t flmap0;
+	uint32_t flmap1;
+	uint32_t flmap2;
+} __attribute__((packed)) fdbar_t;
+
+/* component section */
+typedef struct {
+	uint32_t flcomp;
+	uint32_t flill;
+	uint32_t flpb;
+} __attribute__((packed)) fcba_t;
+
diff --git a/image.c b/image.c
new file mode 100644
index 0000000..138436b
--- /dev/null
+++ b/image.c
@@ -0,0 +1,185 @@
+/*
+ * Copyright 2019 Google LLC
+ *
+ * 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 <stdlib.h>
+#include <stdint.h>
+#include "em100.h"
+#include "ifd.h"
+
+/**
+ * PTR_IN_RANGE - examine whether a pointer falls in [base, base + limit)
+ * @param ptr:    the non-void* pointer to a single arbitrary-sized object.
+ * @param base:   base address represented with char* type.
+ * @param limit:  upper limit of the legal address.
+ *
+ */
+#define PTR_IN_RANGE(ptr, base, limit)			\
+	((const char *)(ptr) >= (base) &&		\
+	 (const char *)&(ptr)[1] <= (base) + (limit))
+
+static int ifd_version;
+static int platform = -1;
+
+static fdbar_t *find_fd(char *image, int size)
+{
+	int i, found = 0;
+
+	/* Scan for FD signature */
+	for (i = 0; i < (size - 4); i += 4) {
+		if (*(uint32_t *) (image + i) == 0x0FF0A55A) {
+			found = 1;
+			break;	// signature found.
+		}
+	}
+
+	if (!found) {
+		printf("No Flash Descriptor found in this image\n");
+		return NULL;
+	}
+
+	fdbar_t *fdb = (fdbar_t *) (image + i);
+	return PTR_IN_RANGE(fdb, image, size) ? fdb : NULL;
+}
+
+static fcba_t *find_fcba(char *image, int size)
+{
+	fdbar_t *fdb = find_fd(image, size);
+	if (!fdb)
+		return NULL;
+	fcba_t *fcba = (fcba_t *) (image + ((fdb->flmap0 & 0xff) << 4));
+	return PTR_IN_RANGE(fcba, image, size) ? fcba : NULL;
+
+}
+
+/*
+ * Some newer platforms have re-defined the FCBA field that was used to
+ * distinguish IFD v1 v/s v2. Define a list of platforms that we know do not
+ * have the required FCBA field, but are IFD v2 and return true if current
+ * platform is one of them.
+ */
+static int is_platform_ifd_2(void)
+{
+	static const int ifd_2_platforms[] = {
+		PLATFORM_GLK,
+		PLATFORM_CNL,
+		PLATFORM_ICL,
+		PLATFORM_TGL,
+	};
+	unsigned int i;
+
+	for (i = 0; i < ARRAY_SIZE(ifd_2_platforms); i++) {
+		if (platform == ifd_2_platforms[i])
+			return 1;
+	}
+
+	return 0;
+}
+
+/*
+ * There is no version field in the descriptor so to determine
+ * if this is a new descriptor format we check the hardcoded SPI
+ * read frequency to see if it is fixed at 20MHz or 17MHz.
+ */
+static int get_ifd_version_from_fcba(char *image, int size)
+{
+	int read_freq;
+	const fcba_t *fcba = find_fcba(image, size);
+	const fdbar_t *fdb = find_fd(image, size);
+	if (!fcba || !fdb)
+		exit(EXIT_FAILURE);
+
+	read_freq = (fcba->flcomp >> 17) & 7;
+
+	switch (read_freq) {
+	case SPI_FREQUENCY_20MHZ:
+		return IFD_VERSION_1;
+	case SPI_FREQUENCY_17MHZ:
+	case SPI_FREQUENCY_50MHZ_30MHZ:
+		return IFD_VERSION_2;
+	default:
+		fprintf(stderr, "Unknown descriptor version: %d\n",
+			read_freq);
+		exit(EXIT_FAILURE);
+	}
+}
+
+static void check_ifd_version(char *image, int size)
+{
+	if (is_platform_ifd_2())
+		ifd_version = IFD_VERSION_2;
+	else
+		ifd_version = get_ifd_version_from_fcba(image, size);
+}
+
+static void set_spi_frequency(char *image, int size, enum spi_frequency freq)
+{
+	fcba_t *fcba = find_fcba(image, size);
+	if (!fcba)
+		exit(EXIT_FAILURE);
+
+	/* clear bits 21-29 */
+	fcba->flcomp &= ~0x3fe00000;
+	/* Read ID and Read Status Clock Frequency */
+	fcba->flcomp |= freq << 27;
+	/* Write and Erase Clock Frequency */
+	fcba->flcomp |= freq << 24;
+	/* Fast Read Clock Frequency */
+	fcba->flcomp |= freq << 21;
+}
+
+static void set_em100_mode(struct em100 *em100, char *image, int size)
+{
+	fcba_t *fcba = find_fcba(image, size);
+	if (!fcba)
+		exit(EXIT_FAILURE);
+
+	int freq;
+
+	if (em100->hwversion == 6) {
+		printf("EM100Pro-G2 can run at full speed.\n");
+		return;
+	}
+
+	switch (ifd_version) {
+	case IFD_VERSION_1:
+		freq = SPI_FREQUENCY_20MHZ;
+		break;
+	case IFD_VERSION_2:
+		freq = SPI_FREQUENCY_17MHZ;
+		break;
+	default:
+		freq = SPI_FREQUENCY_17MHZ;
+		break;
+	}
+
+	fcba->flcomp &= ~(1 << 30);
+	set_spi_frequency(image, size, freq);
+}
+
+int autocorrect_image(struct em100 *em100, char *image, size_t size)
+{
+	printf("Auto-detecting IFD image ... ");
+	if (find_fd(image, size))
+		printf("OK\n");
+	else
+		return 1; /* No support for other image types (yet). */
+
+	/* Auto-detect IFD version */
+	check_ifd_version(image, size);
+
+	/* Set EM100 mode */
+	set_em100_mode(em100, image, size);
+
+	return 0;
+}
-- 
To view, visit https://review.coreboot.org/c/em100/+/37258
To unsubscribe, or for help writing mail filters, visit https://review.coreboot.org/settings

Gerrit-Project: em100
Gerrit-Branch: master
Gerrit-Change-Id: Ie02264facb028841d18ed84680ffa40f45987510
Gerrit-Change-Number: 37258
Gerrit-PatchSet: 1
Gerrit-Owner: Stefan Reinauer stefan.reinauer@coreboot.org
Gerrit-MessageType: newchange



    