[PATCH 08/15] scripts: Add Layerscape image tool

[Sascha Hauer <s.hauer@pengutronix.de>]

This adds the Layerscape image tool based on the corresponding U-Boot
tool. PBL in the name is for "Pre-Boot Loader", just like the barebox
PBL support, but here the name is for the Layerscape image format which
has the same name.

Layerscape SoCs load the initial image portion into SRAM, so only a
fraction of the barebox image can initially be loaded. This tool expects
the full barebox image and the size of the PBL part of this image
specified to the -m option. The full barebox image is then placed in the
output image at offset 128KiB.

Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
---
 scripts/Makefile   |   1 +
 scripts/pblimage.c | 432 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 433 insertions(+)
 create mode 100644 scripts/pblimage.c

diff --git a/scripts/Makefile b/scripts/Makefile
index ff0a3c2a07..712cf99217 100644
--- a/scripts/Makefile
+++ b/scripts/Makefile
@@ -20,6 +20,7 @@ hostprogs-$(CONFIG_ARCH_DAVINCI) += mkublheader
 hostprogs-$(CONFIG_ARCH_ZYNQ)	 += zynq_mkimage
 hostprogs-$(CONFIG_ARCH_SOCFPGA) += socfpga_mkimage
 hostprogs-$(CONFIG_MXS_HOSTTOOLS)+= mxsimage mxsboot
+hostprogs-$(CONFIG_ARCH_LAYERSCAPE) += pblimage
 HOSTCFLAGS += -I$(srctree)/scripts/include/
 HOSTLDLIBS_mxsimage  = `pkg-config --libs openssl`
 HOSTCFLAGS_omap3-usb-loader.o = `pkg-config --cflags libusb-1.0`
diff --git a/scripts/pblimage.c b/scripts/pblimage.c
new file mode 100644
index 0000000000..6e83c523e5
--- /dev/null
+++ b/scripts/pblimage.c
@@ -0,0 +1,432 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright 2012-2014 Freescale Semiconductor, Inc.
+ */
+#include <stdio.h>
+#include <stdlib.h>
+#include <errno.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <string.h>
+#include <stdint.h>
+#include <getopt.h>
+#include <endian.h>
+
+#define roundup(x, y)		((((x) + ((y) - 1)) / (y)) * (y))
+#define PBL_ACS_CONT_CMD	0x81000000
+#define PBL_ADDR_24BIT_MASK	0x00ffffff
+
+#define RCW_BYTES	64
+#define RCW_PREAMBLE	0xaa55aa55
+#define RCW_HEADER	0x010e0100
+
+/*
+ * The maximum PBL size we support. The PBL portion in the input image shouldn't
+ * get bigger than this
+ */
+#define MAX_PBL_SIZE	(64 * 1024)
+
+/*
+ * The offset of the 2nd stage image in the output file. This must match with the
+ * offset barebox expects the 2nd stage image.
+ */
+#define BAREBOX_START	(128 * 1024)
+
+/*
+ * Initialize to an invalid value.
+ */
+static uint32_t next_pbl_cmd = 0x82000000;
+/*
+ * need to store all bytes in memory for calculating crc32, then write the
+ * bytes to image file for PBL boot.
+ */
+static unsigned char mem_buf[1000000];
+static unsigned char *pmem_buf = mem_buf;
+static int pbl_size;
+static int pbl_end;
+static int image_size;
+static int out_fd;
+static int in_fd;
+
+static uint32_t pbl_cmd_initaddr;
+static uint32_t pbi_crc_cmd1;
+static uint32_t pbi_crc_cmd2;
+static uint32_t pbl_end_cmd[4];
+
+enum arch {
+	ARCH_ARM,
+	ARCH_POWERPC,
+};
+
+enum arch architecture;
+static char *rcwfile;
+static char *pbifile;
+static char *outfile;
+static unsigned long loadaddr = 0x10000000;
+static char *infile;
+
+static uint32_t crc_table[256];
+static int crc_table_valid;
+
+static void make_crc_table(void)
+{
+	uint32_t mask;
+	int i, j;
+	uint32_t poly; /* polynomial exclusive-or pattern */
+
+	if (crc_table_valid)
+		return;
+
+	/*
+	 * the polynomial used by PBL is 1 + x1 + x2 + x4 + x5 + x7 + x8 + x10
+	 * + x11 + x12 + x16 + x22 + x23 + x26 + x32.
+	 */
+	poly = 0x04c11db7;
+
+	for (i = 0; i < 256; i++) {
+		mask = i << 24;
+		for (j = 0; j < 8; j++) {
+			if (mask & 0x80000000)
+				mask = (mask << 1) ^ poly;
+			else
+				mask <<= 1;
+		}
+		crc_table[i] = mask;
+	}
+
+	crc_table_valid = 1;
+}
+
+uint32_t pbl_crc32(uint32_t in_crc, const char *buf, uint32_t len)
+{
+	uint32_t crc32_val;
+	int i;
+
+	make_crc_table();
+
+	crc32_val = ~in_crc;
+
+	for (i = 0; i < len; i++)
+		crc32_val = (crc32_val << 8) ^
+			crc_table[(crc32_val >> 24) ^ (*buf++ & 0xff)];
+
+	return crc32_val;
+}
+
+/*
+ * The PBL can load up to 64 bytes at a time, so we split the image into 64 byte
+ * chunks. PBL needs a command for each piece, of the form "81xxxxxx", where
+ * "xxxxxx" is the offset. Calculate the start offset by subtracting the size of
+ * the image from the top of the allowable 24-bit range.
+ */
+static void generate_pbl_cmd(void)
+{
+	uint32_t val = next_pbl_cmd;
+	next_pbl_cmd += 0x40;
+	int i;
+
+	for (i = 3; i >= 0; i--) {
+		*pmem_buf++ = (val >> (i * 8)) & 0xff;
+		pbl_size++;
+	}
+}
+
+static void pbl_fget(size_t size, int fd)
+{
+	int r;
+
+	r = read(fd, pmem_buf, size);
+	if (r < 0) {
+		perror("read");
+		exit(EXIT_FAILURE);
+	}
+
+	pmem_buf += r;
+
+	if (r < size) {
+		memset(pmem_buf, 0xff, size - r);
+		pmem_buf += size - r;
+	}
+
+	pbl_size += size;
+}
+
+static void check_get_hexval(const char *filename, int lineno, char *token)
+{
+	uint32_t hexval;
+	int i;
+
+	if (!sscanf(token, "%x", &hexval)) {
+		fprintf(stderr, "Error:%s[%d] - Invalid hex data(%s)\n",
+			filename, lineno, token);
+		exit(EXIT_FAILURE);
+	}
+
+	for (i = 3; i >= 0; i--) {
+		*pmem_buf++ = (hexval >> (i * 8)) & 0xff;
+		pbl_size++;
+	}
+}
+
+static void pbl_parser(char *name)
+{
+	FILE *f = NULL;
+	char *line = NULL;
+	char *token, *saveptr1, *saveptr2;
+	size_t len = 0;
+	int lineno = 0;
+
+	f = fopen(name, "r");
+	if (!f) {
+		fprintf(stderr, "Error: Cannot open %s: %s\n", name,
+			strerror(errno));
+		exit(EXIT_FAILURE);
+	}
+
+	while ((getline(&line, &len, f)) > 0) {
+		lineno++;
+		token = strtok_r(line, "\r\n", &saveptr1);
+		/* drop all lines with zero tokens (= empty lines) */
+		if (!token)
+			continue;
+		for (line = token;; line = NULL) {
+			token = strtok_r(line, " \t", &saveptr2);
+			if (!token)
+				break;
+			/* Drop all text starting with '#' as comments */
+			if (token[0] == '#')
+				break;
+			check_get_hexval(name, lineno, token);
+		}
+	}
+	if (line)
+		free(line);
+	fclose(f);
+}
+
+/* write end command and crc command to memory. */
+static void add_end_cmd(void)
+{
+	uint32_t crc32_pbl;
+	int i;
+	unsigned char *p = (unsigned char *)&pbl_end_cmd;
+
+	for (i = 0; i < 4; i++)
+		pbl_end_cmd[i] = htobe32(pbl_end_cmd[i]);
+
+	for (i = 0; i < 16; i++) {
+		*pmem_buf++ = *p++;
+		pbl_size++;
+	}
+
+	/* Add PBI CRC command. */
+	*pmem_buf++ = 0x08;
+	*pmem_buf++ = pbi_crc_cmd1;
+	*pmem_buf++ = pbi_crc_cmd2;
+	*pmem_buf++ = 0x40;
+	pbl_size += 4;
+
+	/* calculated CRC32 and write it to memory. */
+	crc32_pbl = pbl_crc32(0, (const char *)mem_buf, pbl_size);
+	*pmem_buf++ = (crc32_pbl >> 24) & 0xff;
+	*pmem_buf++ = (crc32_pbl >> 16) & 0xff;
+	*pmem_buf++ = (crc32_pbl >> 8) & 0xff;
+	*pmem_buf++ = (crc32_pbl) & 0xff;
+	pbl_size += 4;
+}
+
+static void pbl_load_image(void)
+{
+	int size;
+
+	/* parse the rcw.cfg file. */
+	pbl_parser(rcwfile);
+
+	/* parse the pbi.cfg file. */
+	if (pbifile)
+		pbl_parser(pbifile);
+
+	next_pbl_cmd = pbl_cmd_initaddr - image_size;
+	while (next_pbl_cmd < pbl_cmd_initaddr) {
+		generate_pbl_cmd();
+		pbl_fget(64, in_fd);
+	}
+
+	add_end_cmd();
+
+	size = pbl_size;
+
+	if (write(out_fd, (const void *)&mem_buf, size) != size) {
+		fprintf(stderr, "Write error on %s: %s\n",
+			outfile, strerror(errno));
+		exit(EXIT_FAILURE);
+	}
+}
+
+static int pblimage_check_params(void)
+{
+	struct stat st;
+
+	in_fd = open(infile, O_RDONLY);
+	if (in_fd < 0) {
+		fprintf(stderr, "Error: Cannot open %s: %s\n", infile,
+			strerror(errno));
+		exit(EXIT_FAILURE);
+	}
+
+	if (fstat(in_fd, &st) == -1) {
+		fprintf(stderr, "Error: Could not determine u-boot image size. %s\n",
+		       strerror(errno));
+		exit(EXIT_FAILURE);
+	}
+
+	/* For the variable size, pad it to 64 byte boundary */
+	image_size = roundup(pbl_end, 64);
+
+	if (image_size > MAX_PBL_SIZE) {
+		fprintf(stderr, "Error: pbl size %d in %s exceeds maximum size %d\n",
+		       pbl_end, infile, MAX_PBL_SIZE);
+		exit(EXIT_FAILURE);
+	}
+
+	if (architecture == ARCH_ARM) {
+		pbi_crc_cmd1 = 0x61;
+		pbi_crc_cmd2 = 0;
+		pbl_cmd_initaddr = loadaddr & PBL_ADDR_24BIT_MASK;
+		pbl_cmd_initaddr |= PBL_ACS_CONT_CMD;
+		pbl_cmd_initaddr += image_size;
+		pbl_end_cmd[0] = 0x09610000;
+		pbl_end_cmd[1] = 0x00000000;
+		pbl_end_cmd[2] = 0x096100c0;
+		pbl_end_cmd[3] = 0x00000000;
+	} else {
+		pbi_crc_cmd1 = 0x13;
+		pbi_crc_cmd2 = 0x80;
+		pbl_cmd_initaddr = 0x82000000;
+		pbl_end_cmd[0] = 0x091380c0;
+		pbl_end_cmd[1] = 0x00000000;
+		pbl_end_cmd[2] = 0x091380c0;
+		pbl_end_cmd[3] = 0x00000000;
+	}
+
+	next_pbl_cmd = pbl_cmd_initaddr;
+	return 0;
+};
+
+static int copy_fd(int in, int out)
+{
+	int bs = 4096;
+	void *buf = malloc(bs);
+
+	if (!buf)
+		exit(EXIT_FAILURE);
+
+	while (1) {
+		int now, wr;
+
+		now = read(in, buf, bs);
+		if (now < 0) {
+			fprintf(stderr, "read failed with %s\n", strerror(errno));
+			exit(EXIT_FAILURE);
+		}
+
+		if (!now)
+			break;
+
+		wr = write(out, buf, now);
+		if (wr < 0) {
+			fprintf(stderr, "write failed with %s\n", strerror(errno));
+			exit(EXIT_FAILURE);
+		}
+
+		if (wr != now) {
+			fprintf(stderr, "short write\n");
+			exit(EXIT_FAILURE);
+		}
+	}
+
+	free(buf);
+
+	return 0;
+}
+
+int main(int argc, char *argv[])
+{
+	int opt, ret;
+	off_t pos;
+
+	while ((opt = getopt(argc, argv, "i:r:p:o:m:")) != -1) {
+		switch (opt) {
+		case 'i':
+			infile = optarg;
+			break;
+		case 'r':
+			rcwfile = optarg;
+			break;
+		case 'p':
+			pbifile = optarg;
+			break;
+		case 'o':
+			outfile = optarg;
+			break;
+		case 'm':
+			pbl_end = atoi(optarg);
+			break;
+		default:
+			exit(EXIT_FAILURE);
+		}
+	}
+
+	if (!infile) {
+		fprintf(stderr, "No infile given\n");
+		exit(EXIT_FAILURE);
+	}
+
+	if (!outfile) {
+		fprintf(stderr, "No outfile given\n");
+		exit(EXIT_FAILURE);
+	}
+
+	if (!rcwfile) {
+		fprintf(stderr, "No rcwfile given\n");
+		exit(EXIT_FAILURE);
+	}
+
+	pblimage_check_params();
+
+	out_fd = open(outfile, O_WRONLY | O_CREAT | O_TRUNC, 0644);
+	if (out_fd < 0) {
+		fprintf(stderr, "Cannot open %s for writing: %s\n",
+			outfile, strerror(errno));
+		exit(EXIT_FAILURE);
+	}
+
+	pbl_load_image();
+
+	ret = ftruncate(out_fd, BAREBOX_START);
+	if (ret) {
+		fprintf(stderr, "Cannot truncate\n");
+		exit(EXIT_FAILURE);
+	}
+
+	pos = lseek(out_fd, BAREBOX_START, SEEK_SET);
+	if (pos == (off_t)-1) {
+		fprintf(stderr, "Cannot lseek 1\n");
+		exit(EXIT_FAILURE);
+	}
+
+	pos = lseek(in_fd, 0, SEEK_SET);
+	if (pos == (off_t)-1) {
+		fprintf(stderr, "Cannot lseek 2\n");
+		exit(EXIT_FAILURE);
+	}
+
+	copy_fd(in_fd, out_fd);
+
+	close(in_fd);
+	close(out_fd);
+
+	exit(EXIT_SUCCESS);
+}
-- 
2.20.1


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox