[U-Boot] [RFC PATCH] imx: add writebcb command

Stefan Agner stefan at agner.ch
Wed Apr 11 15:06:25 UTC 2018


From: Stefan Agner <stefan.agner at toradex.com>

Add writebcb command which creates a NAND Boot Configuration Block
(BCB) at the beginning of the active flash device. The BCB stores
the information for the SoC internal boot ROM where the application
with a valid IVT header can be found on the NAND device. The first
two argument of the command need an offset of the NAND device where
the primary and secondary application can be found.

Typically, U-Boot is the application which gets loaded by the boot
ROM. Hence, the offset address need to be the address where U-Boot
(u-boot.imx along with a 0x400 long prefix) is stored on the device.
At least one location is mandatory.

Currently only the FCB (Firmware Configuration Block) is written to
the device. The DBBT (Discovered Bad Block Table) is optional and
not created by writebcb currently.

Signed-off-by: Stefan Agner <stefan.agner at toradex.com>
Acked-by: Max Krummenacher <max.krummenacher at toradex.com>
---
Hi, 

I send this a s a discussion base for "i.MX6: nand: add nandbcb
update command"
https://www.mail-archive.com/u-boot@lists.denx.de/msg277500.html

This is the implementation for Vybrid which has a different NAND
flash controller IP than i.MX 6. It was based on do_nand_boot_update
from the downstream U-Boot for Vybrid:
http://git.toradex.com/cgit/u-boot-toradex.git/tree/drivers/mtd/nand/fsl_nfc.c?h=2011.12-colibri_vf#n1048

We used this as a base for a very similar implementation for
i.MX 7 and i.MX 6ULL support. Those SoCs use the GPMI NAND IP like
i.MX 6.

Compared to Jagan's proposal this command only does a minimal
thing, especially it does not write the firmware length
(sectors_in_firmware1/2, which is fw1/2_pages in Jagans patchset).
It seems not to be strictly required by any NXP boot ROMs so far.
This allows to update the firmware (SPL/U-Boot) independently of
the boot block, which is nice since boot block is usually written
to the first erease block which is often only has a limited erase
cycle guaranteed by the NAND flash manufacturer.

Furthermore, it does not mandates a particular spacing between
the boot loaders. One can simply pass the offset for each instance.

Note that I think the final patch should be based on Jagans
proposal since the implemenation is more advanced and clear. It
is just that aspect which I like more in this implementation.

--
Stefam

 arch/arm/imx-common/Makefile       |   1 +
 arch/arm/imx-common/cmd_writebcb.c | 187 +++++++++++++++++++++++++++++
 include/configs/colibri_vf.h       |   1 +
 scripts/config_whitelist.txt       |   1 +
 4 files changed, 190 insertions(+)
 create mode 100644 arch/arm/imx-common/cmd_writebcb.c

diff --git a/arch/arm/imx-common/Makefile b/arch/arm/imx-common/Makefile
index aae776349e..b9cf281ca9 100644
--- a/arch/arm/imx-common/Makefile
+++ b/arch/arm/imx-common/Makefile
@@ -37,6 +37,7 @@ endif
 obj-$(CONFIG_CMD_BMODE) += cmd_bmode.o
 obj-$(CONFIG_CMD_HDMIDETECT) += cmd_hdmidet.o
 obj-$(CONFIG_CMD_DEKBLOB) += cmd_dek.o
+obj-$(CONFIG_CMD_WRITEBCB) += cmd_writebcb.o
 
 PLUGIN = board/$(BOARDDIR)/plugin
 
diff --git a/arch/arm/imx-common/cmd_writebcb.c b/arch/arm/imx-common/cmd_writebcb.c
new file mode 100644
index 0000000000..8abf1b0ba7
--- /dev/null
+++ b/arch/arm/imx-common/cmd_writebcb.c
@@ -0,0 +1,187 @@
+/*
+ * Copyright (c) 2013, Toradex AG.  All rights reserved.
+ *
+ * Derived from downstream U-Boot (drivers/mtd/nand/fsl_nfc.c)
+ * and mxsboot
+ *
+ * SPDX-License-Identifier:	GPL-2.0+
+ */
+
+#include <common.h>
+#include <nand.h>
+#include <malloc.h>
+
+struct mxs_nand_fcb {
+	uint32_t		checksum;
+	uint32_t		fingerprint;
+	uint32_t		version;
+	struct {
+		uint8_t			data_setup;
+		uint8_t			data_hold;
+		uint8_t			address_setup;
+		uint8_t			dsample_time;
+		uint8_t			nand_timing_state;
+		uint8_t			rea;
+		uint8_t			rloh;
+		uint8_t			rhoh;
+	}			timing;
+	uint32_t		page_data_size;
+	uint32_t		total_page_size;
+	uint32_t		sectors_per_block;
+	uint32_t		number_of_nands;		/* Ignored */
+	uint32_t		total_internal_die;		/* Ignored */
+	uint32_t		cell_type;			/* Ignored */
+	uint32_t		ecc_block_n_ecc_type;
+	uint32_t		ecc_block_0_size;
+	uint32_t		ecc_block_n_size;
+	uint32_t		ecc_block_0_ecc_type;
+	uint32_t		metadata_bytes;
+	uint32_t		num_ecc_blocks_per_page;
+	uint32_t		ecc_block_n_ecc_level_sdk;	/* Ignored */
+	uint32_t		ecc_block_0_size_sdk;		/* Ignored */
+	uint32_t		ecc_block_n_size_sdk;		/* Ignored */
+	uint32_t		ecc_block_0_ecc_level_sdk;	/* Ignored */
+	uint32_t		num_ecc_blocks_per_page_sdk;	/* Ignored */
+	uint32_t		metadata_bytes_sdk;		/* Ignored */
+	uint32_t		erase_threshold;
+	uint32_t		boot_patch;
+	uint32_t		patch_sectors;
+	uint32_t		firmware1_starting_sector;
+	uint32_t		firmware2_starting_sector;
+	uint32_t		sectors_in_firmware1;
+	uint32_t		sectors_in_firmware2;
+	uint32_t		dbbt_search_area_start_address;
+	uint32_t		badblock_marker_byte;
+	uint32_t		badblock_marker_start_bit;
+	uint32_t		bb_marker_physical_offset;
+	uint32_t		reserved1[9];
+	uint32_t		disbbm;
+	uint32_t		reserved2[10];
+	uint32_t		disbbm_search;
+	uint32_t		disbbm_search_limit;
+};
+
+struct mxs_nand_dbbt {
+	uint32_t		checksum;
+	uint32_t		fingerprint;
+	uint32_t		version;
+	uint32_t		number_bb;
+	uint32_t		number_2k_pages_bb;
+};
+
+struct mxs_nand_bbt {
+	uint32_t		nand;
+	uint32_t		number_bb;
+	uint32_t		badblock[510];
+};
+
+static inline uint8_t parity_13_8(const uint8_t b)
+{
+	uint32_t parity = 0, tmp;
+
+	tmp = ((b >> 6) ^ (b >> 5) ^ (b >> 3) ^ (b >> 2)) & 1;
+	parity |= tmp << 0;
+
+	tmp = ((b >> 7) ^ (b >> 5) ^ (b >> 4) ^ (b >> 2) ^ (b >> 1)) & 1;
+	parity |= tmp << 1;
+
+	tmp = ((b >> 7) ^ (b >> 6) ^ (b >> 5) ^ (b >> 1) ^ (b >> 0)) & 1;
+	parity |= tmp << 2;
+
+	tmp = ((b >> 7) ^ (b >> 4) ^ (b >> 3) ^ (b >> 0)) & 1;
+	parity |= tmp << 3;
+
+	tmp = ((b >> 6) ^ (b >> 4) ^ (b >> 3) ^
+		(b >> 2) ^ (b >> 1) ^ (b >> 0)) & 1;
+	parity |= tmp << 4;
+
+	return parity;
+}
+
+static void create_fcb(struct mtd_info *nand, uint8_t *buf,
+		       int fw1_start_address, int fw2_start_address)
+{
+	int i;
+	uint8_t *ecc;
+	struct mxs_nand_fcb *fcb = (struct mxs_nand_fcb *)buf;
+
+	fcb->fingerprint =		0x46434220;
+	fcb->version =			0x00000001;
+
+	fcb->page_data_size =		nand->writesize;
+	fcb->total_page_size =		nand->writesize + nand->oobsize;
+	fcb->sectors_per_block =	nand->erasesize / nand->writesize;
+
+	/* 45 or 60-bytes BCH ECC, also used by Linux/U-Boot */
+#if defined(CONFIG_SYS_NAND_VF610_NFC_45_ECC_BYTES)
+	fcb->ecc_block_0_ecc_type = 6;
+#elif defined(CONFIG_SYS_NAND_VF610_NFC_60_ECC_BYTES)
+	fcb->ecc_block_0_ecc_type = 7;
+#endif
+
+	fcb->firmware1_starting_sector = fw1_start_address / nand->writesize;
+	fcb->firmware2_starting_sector = fw2_start_address / nand->writesize;
+
+	fcb->dbbt_search_area_start_address =	0;
+
+	/* This is typically the first byte of the pages OOB area */
+	fcb->bb_marker_physical_offset = nand->writesize;
+
+	/*
+	 * Enable swapping of bad block marker byte (required for boot ROM in
+	 * order to detect factory marked bad blocks)
+	 */
+	fcb->disbbm = 0;
+
+	fcb->disbbm_search = 0;
+	fcb->disbbm_search_limit = 8;
+
+	ecc = buf + 512;
+
+	for (i = 0; i < sizeof(struct mxs_nand_fcb); i++)
+		ecc[i] = parity_13_8(buf[i]);
+}
+
+static int do_write_bcb(cmd_tbl_t *cmdtp, int flag, int argc,
+		       char * const argv[])
+{
+	int ret;
+	struct mtd_info *nand;
+	int dev = nand_curr_device;
+	ulong off = 0;
+	uint8_t *buf;
+	size_t rwsize, maxsize;
+	ulong fw1_off, fw2_off = 0;
+
+	if (argc < 2)
+		return -1;
+
+	fw1_off = simple_strtoul(argv[1], NULL, 16);
+	if (argc > 2)
+		fw2_off = simple_strtoul(argv[2], NULL, 16);
+
+	nand = nand_info[dev];
+
+	/* Allocate one page, should be enought */
+	rwsize = nand->writesize;
+	buf = malloc(nand->writesize);
+
+	/* Set only the first page empty... */
+	memset(buf, 0, nand->writesize);
+
+	create_fcb(nand, buf, fw1_off, fw2_off);
+
+	puts("Write FCB...\n");
+	rwsize = maxsize = nand->writesize;
+	ret = nand_write(nand, off, &rwsize, (unsigned char *)buf);
+
+	printf("FCB %d bytes written to 0x0: %s\n", rwsize, 
+			ret ? "ERROR" : "OK");
+	return 0;
+}
+
+U_BOOT_CMD(
+	writebcb, 3, 0, do_write_bcb,
+	"Write Boot Control Block (FCB and DBBT)",
+	"fw1-off [fw2-off]"
+);
diff --git a/include/configs/colibri_vf.h b/include/configs/colibri_vf.h
index 0cd77fff51..9d9c908e94 100644
--- a/include/configs/colibri_vf.h
+++ b/include/configs/colibri_vf.h
@@ -43,6 +43,7 @@
 
 /* NAND support */
 #define CONFIG_CMD_NAND
+#define CONFIG_CMD_WRITEBCB
 #define CONFIG_SYS_NAND_ONFI_DETECTION
 #define CONFIG_SYS_MAX_NAND_DEVICE	1
 #define CONFIG_SYS_NAND_BASE		NFC_BASE_ADDR
diff --git a/scripts/config_whitelist.txt b/scripts/config_whitelist.txt
index 1b769c4b0d..f292f566a6 100644
--- a/scripts/config_whitelist.txt
+++ b/scripts/config_whitelist.txt
@@ -649,6 +649,7 @@ CONFIG_CMD_UNIVERSE
 CONFIG_CMD_UNZIP
 CONFIG_CMD_USB_STORAGE
 CONFIG_CMD_UUID
+CONFIG_CMD_WRITEBCB
 CONFIG_CMD_ZBOOT
 CONFIG_CMD_ZFS
 CONFIG_CM_INIT
-- 
2.17.0



More information about the U-Boot mailing list