[PATCH v1] arch: meson: add helper for boot partitition flashing

Alexey Romanov avromanov at salutedevices.com
Thu Dec 28 16:14:18 CET 2023


Amlogic uses its own scheme for flashing bootloader
partition. This patch adds helper function that can
be used by Amlogic BootROM and custom protocols.

Signed-off-by: Alexey Romanov <avromanov at salutedevices.com>
---
 arch/arm/include/asm/arch-meson/nand.h |  88 ++++++++++++++++
 arch/arm/mach-meson/Kconfig            |  16 +++
 arch/arm/mach-meson/Makefile           |   2 +-
 arch/arm/mach-meson/nand.c             | 133 +++++++++++++++++++++++++
 4 files changed, 238 insertions(+), 1 deletion(-)
 create mode 100644 arch/arm/include/asm/arch-meson/nand.h
 create mode 100644 arch/arm/mach-meson/nand.c

diff --git a/arch/arm/include/asm/arch-meson/nand.h b/arch/arm/include/asm/arch-meson/nand.h
new file mode 100644
index 0000000000..5297d79dd6
--- /dev/null
+++ b/arch/arm/include/asm/arch-meson/nand.h
@@ -0,0 +1,88 @@
+/* SPDX-License-Identifier: GPL-2.0+ */
+/*
+ * (C) Copyright 2023 SaluteDevices, Inc.
+ */
+
+#ifndef __MESON_NAND_H__
+#define __MESON_NAND_H__
+
+#include <linux/mtd/mtd.h>
+
+#define BOOT_LOADER     "bootloader"
+#define BOOT_BL2        "bl2"
+#define BOOT_SPL        "spl"
+#define BOOT_TPL        "tpl"
+#define BOOT_FIP        "fip"
+
+#define BL2_COPY_NUM            (CONFIG_MESON_BL2_COPY_NUM)
+#define TPL_COPY_NUM            (CONFIG_MESON_TPL_COPY_NUM)
+#define BOOT_TOTAL_PAGES        1024
+#define TPL_SIZE_PER_COPY       0x200000
+#define BL2_SIZE                (64 * 1024)
+
+struct meson_spi_nand_info_page {
+	char magic[8];  /* Magic header of info page. */
+	/* Info page version, +1 when you update this struct. */
+	u8 version;     /* 1 for now. */
+	u8 mode;        /* 1 discrete, 0 compact. */
+	u8 bl2_num;     /* bl2 copy number. */
+	u8 fip_num;     /* fip copy number. */
+	union {
+		struct {
+			u8 rd_max;          /* spi nand max read io. */
+			u8 oob_offset;      /* User bytes offset. */
+			u8 planes_per_lun;
+			u8 rsv;
+			u32 fip_start;      /* Start pages. */
+			u32 fip_pages;      /* Pages per fip. */
+			u32 page_size;      /* spi nand page size (bytes). */
+			u32 page_per_blk;   /* Page number per block. */
+			u32 oob_size;       /* Valid oob size (bytes). */
+			u32 bbt_start;      /* BBT start pages. */
+			u32 bbt_valid;      /* BBT valid offset pages. */
+			u32 bbt_size;       /* BBT occupied bytes. */
+		} __packed spinand;     /* spi nand. */
+		struct {
+			u32 reserved;
+		} emmc;
+	} dev;
+} __packed;
+
+/**
+ * meson_bootloader_copy_num - get bootloader numbers of copies
+ *
+ * @part_name: partition name
+ * @return: number of copies of the specified bootloader partition
+ */
+int meson_bootloader_copy_num(const char *part_name);
+
+/**
+ * meson_bootloader_copy_size - get bootloader copy size in bytes
+ *
+ * @mtd: nand mtd instance
+ * @part_name: partition name
+ * @return: bootloader partition (fox example, BL2) copy size in bytes
+ */
+int meson_bootloader_copy_size(struct mtd_info *mtd, const char *part_name);
+
+/**
+ * meson_bootloader_write_info_pages - write bootloader metadata to nand
+ *
+ * @return: zero on success or error code on failure.
+ */
+int meson_bootloader_write_info_pages(void);
+
+/**
+ * meson_bootloader_write_bl2 - write bl2 to nand
+ *
+ * @mtd: nand mtd instance
+ * @buff: buffer to read from
+ * @offset: offset in flash
+ * @size: buffer length
+ * @flags: flags modifying the behaviour of the write to NAND
+ * @return: zero on success or error code on failure
+ */
+int meson_bootloader_write_bl2(struct mtd_info *mtd, void *buff, u32 offset,
+			       size_t size, int flags);
+
+#endif
diff --git a/arch/arm/mach-meson/Kconfig b/arch/arm/mach-meson/Kconfig
index d6c8905806..7b75ed9a2b 100644
--- a/arch/arm/mach-meson/Kconfig
+++ b/arch/arm/mach-meson/Kconfig
@@ -96,4 +96,20 @@ config SYS_CONFIG_NAME
 	  Based on this option include/configs/<CONFIG_SYS_CONFIG_NAME>.h header
 	  will be used for board configuration.
 
+config MESON_BL2_COPY_NUM
+	depends on ADNL || FASTBOOT_FLASH
+	int "Number of BL2 copies written to storage"
+	default 0
+	help
+		The ADNL / fastboot protocol writes several copies of BL2 bootloader
+		during firmware update process.
+
+config MESON_TPL_COPY_NUM
+	depends on ADNL || FASTBOOT_FLASH
+	int "Number of TPL copies written to storage"
+	default 0
+	help
+		The ADNL / fastboot protocol writes several copies of TPL bootloader
+		during firmware update process.
+
 endif
diff --git a/arch/arm/mach-meson/Makefile b/arch/arm/mach-meson/Makefile
index 535b0878b9..460626bca9 100644
--- a/arch/arm/mach-meson/Makefile
+++ b/arch/arm/mach-meson/Makefile
@@ -2,7 +2,7 @@
 #
 # Copyright (c) 2016 Beniamino Galvani <b.galvani at gmail.com>
 
-obj-y += board-common.o sm.o board-info.o
+obj-y += board-common.o sm.o board-info.o nand.o
 obj-$(CONFIG_MESON_GX) += board-gx.o
 obj-$(CONFIG_MESON_AXG) += board-axg.o
 obj-$(CONFIG_MESON_G12A) += board-g12a.o
diff --git a/arch/arm/mach-meson/nand.c b/arch/arm/mach-meson/nand.c
new file mode 100644
index 0000000000..29c10438a1
--- /dev/null
+++ b/arch/arm/mach-meson/nand.c
@@ -0,0 +1,133 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * (C) Copyright 2023 SaluteDevices, Inc.
+ */
+
+#include <nand.h>
+#include <asm/arch/nand.h>
+#include <linux/mtd/nand.h>
+#include <linux/sizes.h>
+
+#define SPINAND_MAGIC		"AMLIFPG"
+#define SPINAND_INFO_VER	1
+#define NAND_RSV_BLOCK_NUM	48
+
+int meson_bootloader_copy_num(const char *part_name)
+{
+	if (!strcmp(part_name, BOOT_BL2) ||
+	    !strcmp(part_name, BOOT_SPL))
+		return BL2_COPY_NUM;
+
+	if (!strcmp(part_name, BOOT_TPL) ||
+	    !strcmp(part_name, BOOT_FIP))
+		return TPL_COPY_NUM;
+
+	return -EINVAL;
+}
+
+int meson_bootloader_copy_size(struct mtd_info *mtd, const char *part_name)
+{
+	if (!strcmp(part_name, BOOT_BL2) ||
+	    !strcmp(part_name, BOOT_SPL))
+		return mtd->writesize * (BOOT_TOTAL_PAGES / BL2_COPY_NUM);
+
+	if (!strcmp(part_name, BOOT_TPL) ||
+	    !strcmp(part_name, BOOT_FIP))
+		return TPL_SIZE_PER_COPY;
+
+	return -EINVAL;
+}
+
+int meson_bootloader_write_info_pages(void)
+{
+	struct meson_spi_nand_info_page info_page;
+	struct nand_device *nand_dev;
+	struct mtd_info *mtd;
+	u32 page_per_blk;
+	size_t retlen;
+	int ret, page;
+
+	mtd = get_mtd_device_nm(BOOT_LOADER);
+	if (IS_ERR_OR_NULL(mtd))
+		return -ENODEV;
+
+	if (mtd->writesize != SZ_2K) {
+		ret = -EINVAL;
+		goto out;
+	}
+
+	if (!mtd->parent) {
+		ret = -ENODEV;
+		goto out;
+	}
+
+	nand_dev = mtd_to_nanddev(mtd->parent);
+	if (!nand_dev) {
+		ret = -ENODEV;
+		goto out;
+	}
+
+	page_per_blk = mtd->erasesize / mtd->writesize;
+	memset(&info_page, 0, sizeof(info_page));
+	memcpy(info_page.magic, SPINAND_MAGIC, sizeof(info_page.magic));
+	info_page.version = SPINAND_INFO_VER;
+	/* DISCRETE only */
+	info_page.mode = 1;
+	info_page.bl2_num = BL2_COPY_NUM;
+	info_page.fip_num = TPL_COPY_NUM;
+	info_page.dev.spinand.rd_max = 2;
+	info_page.dev.spinand.fip_start = BOOT_TOTAL_PAGES + NAND_RSV_BLOCK_NUM * page_per_blk;
+	info_page.dev.spinand.fip_pages = TPL_SIZE_PER_COPY / mtd->writesize;
+	info_page.dev.spinand.page_size = mtd->writesize;
+	info_page.dev.spinand.page_per_blk = page_per_blk;
+	info_page.dev.spinand.oob_size = mtd->oobsize;
+	info_page.dev.spinand.oob_offset = 0;
+	info_page.dev.spinand.bbt_start = 0;
+	info_page.dev.spinand.bbt_valid = 0;
+	info_page.dev.spinand.bbt_size = 0;
+	info_page.dev.spinand.planes_per_lun = nand_dev->memorg.planes_per_lun;
+
+	for (page = 0; page < BOOT_TOTAL_PAGES; page++) {
+		if (page % 128 != ((BL2_SIZE / mtd->writesize) - 1))
+			continue;
+
+		ret = mtd_write(mtd, (page + 1) * mtd->writesize,
+				sizeof(info_page), &retlen,
+				(u8 *)&info_page);
+		if (ret)
+			goto out;
+	}
+
+out:
+	put_mtd_device(mtd);
+
+	return ret;
+}
+
+int meson_bootloader_write_bl2(struct mtd_info *mtd, void *buff, u32 offset,
+			       size_t size, int flags)
+{
+	loff_t off = offset;
+	size_t retlen;
+	size_t sz_write = SZ_2K;
+	int write_cnt = DIV_ROUND_UP(size, sz_write);
+	u64 size_per_copy = meson_bootloader_copy_size(mtd, BOOT_BL2);
+	int i;
+
+	for (i = 0; i < write_cnt; i++) {
+		int ret;
+		size_t len = min(sz_write, (size - i * sz_write));
+
+		ret = nand_write_skip_bad(mtd, off, &len, &retlen,
+					  offset + size_per_copy,
+					  (buff + i * sz_write), flags);
+		if (ret)
+			return ret;
+
+		off += mtd->writesize;
+		if (retlen > len)
+			off += (retlen - len);
+	}
+
+	return 0;
+}
-- 
2.30.1



More information about the U-Boot mailing list