util/bimgtool: Use CRC 16 instead of CRC x25.

Switched to CRC 16 as it's 40% faster than CRC x25.
Both CRC 16 and CRC x25 are supported and either can be selected through
define directives.

BUG=chrome-os-partner:31438
TEST=built urara bootblock and verified content of bootblock.bin, observed
     expected content; ran it on Pistachio FPGA and observed that its
     content is read properly by bootrom.
BRANCH=none

Change-Id: I36dec6ec2d6616343f97cc8b6486c0a3e4ea49ba
Signed-off-by: Patrick Georgi <pgeorgi@chromium.org>
Original-Commit-Id: 6d9318097ca9270bc245e7de4aff5f78dfbc1606
Original-Change-Id: If1a78350e0b48d91bfe64ead45f852f44ba3cf9a
Original-Signed-off-by: Ionela Voinescu <ionela.voinescu@imgtec.com>
Original-Reviewed-on: https://chromium-review.googlesource.com/226840
Original-Reviewed-by: Vadim Bendebury <vbendeb@chromium.org>
Original-Commit-Queue: Vadim Bendebury <vbendeb@chromium.org>
Original-Tested-by: Vadim Bendebury <vbendeb@chromium.org>
Reviewed-on: http://review.coreboot.org/9415
Reviewed-by: Stefan Reinauer <stefan.reinauer@coreboot.org>
Tested-by: build bot (Jenkins)

1 files changed, 90 insertions, 8 deletions

diff --git a/util/bimgtool/bimgtool.c b/util/bimgtool/bimgtool.c
index 72de6dbe1bd4..acbfdfb7586e 100644
--- a/util/bimgtool/bimgtool.c
+++ b/util/bimgtool/bimgtool.c
@@ -40,9 +40,18 @@ struct bimg_header {
 struct bimg_data_header {
 	uint32_t size;
 	uint32_t dest_addr;
+	uint16_t dummy;
 	uint16_t crc;
 } __attribute__((packed));
 
+struct crc_t {
+	 uint16_t (*crc_f)(uint16_t crc, void *void_buf, size_t size);
+	 uint32_t crc_init;
+	 uint16_t ver_major;
+	 uint16_t ver_minor;
+};
+
+
 #define BIMG_MAGIC	/* y */	0xabbadaba /* doo! */
 
 #define BIMG_OP_MASK		(0xf << 0)
@@ -52,7 +61,7 @@ struct bimg_data_header {
 
 #define MAX_RECORD_BYTES	0x8000
 
-#define CRC_INIT		0xffff
+#define CRC_16
 
 #define error(msg...) fprintf(stderr, "ERROR: " msg)
 
@@ -80,6 +89,72 @@ static uint16_t crc_x25(uint16_t crc, void *void_buf, size_t size)
 	return crc;
 }
 
+static uint16_t crc_16(uint16_t crc, void *void_buf, size_t size)
+{
+	/*
+	 * CRC table for the CRC-16.
+	 * The poly is 0x8005 (x^16 + x^15 + x^2 + 1)
+	 */
+	static const uint16_t crc16_table[256] = {
+		0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
+		0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
+		0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
+		0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
+		0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
+		0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
+		0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
+		0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
+		0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
+		0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
+		0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
+		0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
+		0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
+		0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
+		0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
+		0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
+		0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
+		0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
+		0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
+		0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
+		0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
+		0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
+		0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
+		0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
+		0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
+		0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
+		0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
+		0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
+		0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
+		0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
+		0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
+		0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040
+	};
+	uint8_t *buf, data;
+
+	for (buf = void_buf; size; size--) {
+		data = *buf++;
+		crc = (crc >> 8) ^ crc16_table[(crc ^ data) & 0xff];
+	}
+
+	return crc;
+
+}
+
+
+static struct crc_t crc_type = {
+#if defined(CRC_16)
+	.crc_f = crc_16,
+	.crc_init = 0,
+	.ver_major = 2,
+	.ver_minor = 0
+#elif defined(CRC_X25)
+	.crc_f = crc_x25,
+	.crc_init = 0xffff,
+	.ver_major = 1,
+	.ver_minor = 0
+#endif
+};
+
 static int write_binary(FILE *out, FILE *in, struct bimg_header *hdr)
 {
 	static uint8_t file_buf[MAX_RECORD_BYTES];
@@ -88,8 +163,13 @@ static int write_binary(FILE *out, FILE *in, struct bimg_header *hdr)
 
 	data_hdr.dest_addr = hdr->entry_addr;
 
+	/*
+	 * The read binary data has to be split in chunks of max 64KiB - 1 byte
+	 * (SPI controller limitation). Each chunk will have its own header in
+	 * order to respect the BIMG format.
+	 */
 	while ((data_hdr.size = fread(file_buf, 1, sizeof(file_buf), in))) {
-		data_hdr.crc = crc_x25(CRC_INIT, &data_hdr,
+		data_hdr.crc = crc_type.crc_f(crc_type.crc_init, &data_hdr,
 			sizeof(data_hdr) - sizeof(data_hdr.crc));
 
 		if (fwrite(&data_hdr, sizeof(data_hdr), 1, out) != 1)
@@ -103,7 +183,8 @@ static int write_binary(FILE *out, FILE *in, struct bimg_header *hdr)
 
 		data_hdr.dest_addr += n_written;
 		hdr->data_size += sizeof(data_hdr) + n_written;
-		hdr->data_crc = crc_x25(hdr->data_crc, file_buf, n_written);
+		hdr->data_crc = crc_type.crc_f(hdr->data_crc,
+						file_buf, n_written);
 	}
 
 	if (ferror(in))
@@ -119,7 +200,7 @@ static int write_final(FILE *out, struct bimg_header *hdr)
 		.dest_addr = ~0,
 	};
 
-	data_hdr.crc = crc_x25(CRC_INIT, &data_hdr,
+	data_hdr.crc = crc_type.crc_f(crc_type.crc_init, &data_hdr,
 		sizeof(data_hdr) - sizeof(data_hdr.crc));
 
 	if (fwrite(&data_hdr, sizeof(data_hdr), 1, out) != 1)
@@ -153,10 +234,10 @@ int main(int argc, char *argv[])
 	int err;
 	struct bimg_header hdr = {
 		.magic = BIMG_MAGIC,
-		.ver_major = 1,
-		.ver_minor = 0,
+		.ver_major = crc_type.ver_major,
+		.ver_minor = crc_type.ver_minor,
 		.flags = BIMG_OP_EXEC_NO_RETURN | BIMG_DATA_CHECKSUM,
-		.data_crc = CRC_INIT,
+		.data_crc = crc_type.crc_init,
 	};
 
 	if (argc != 4) {
@@ -197,7 +278,8 @@ int main(int argc, char *argv[])
 		goto out_err_close_out;
 	}
 
-	hdr.crc = crc_x25(CRC_INIT, &hdr, sizeof(hdr) - sizeof(hdr.crc));
+	hdr.crc = crc_type.crc_f(crc_type.crc_init, &hdr,
+					sizeof(hdr) - sizeof(hdr.crc));
 
 	if (fseek(out_file, 0, SEEK_SET)) {
 		error("Failed to seek to header: %d\n", errno);