[U-Boot] [PATCH v10 0/4] Generic firmware loader

[U-Boot] [PATCH v10 0/4] Generic firmware loader

[tien.fong.chee at intel.com]

From: Tien Fong Chee <tien.fong.chee@intel.com>

This patchset contains generic firmware loader which is very close to Linux
firmware loader but for U-Boot framework. Generic firmware loader can be used
load whatever into target location, and then consumer driver would use it to
program whatever, ie. the FPGA. This version mainly resolved comments from
Lothar Waßmann in [v9].

This series is working on top of u-boot.git -
 http://git.denx.de/u-boot.git .

[v9]: https://www.mail-archive.com/u-boot at lists.denx.de/msg279152.html

v9 -> v10 changes:
-----------------
- Resolved memory leaking and cleaning up messy codes.

Patchset history
----------------
[v1]: https://www.mail-archive.com/u-boot at lists.denx.de/msg271905.html
[v2]: https://www.mail-archive.com/u-boot at lists.denx.de/msg271979.html
[v3]: https://www.mail-archive.com/u-boot at lists.denx.de/msg272039.html
[v4]: https://www.mail-archive.com/u-boot at lists.denx.de/msg272432.html
[v5]: https://www.mail-archive.com/u-boot at lists.denx.de/msg272771.html
[v6]: https://www.mail-archive.com/u-boot at lists.denx.de/msg273961.html
[v7]: https://www.mail-archive.com/u-boot at lists.denx.de/msg276775.html
[v8]: https://www.mail-archive.com/u-boot at lists.denx.de/msg278735.html

Tien Fong Chee (4):
  spl: Remove static declaration on spl_mmc_find_device function
  cmd: ubifs: Move ubifs_initialized checking into cmd_ubifs_umount()
  cmd: ubifs: Factor out some checking codes into cmd_ubifs_mount()
  common: Generic firmware loader for file system

 cmd/ubifs.c                |  40 ++---
 common/Kconfig             |  10 ++
 common/Makefile            |   1 +
 common/fs_loader.c         | 353 +++++++++++++++++++++++++++++++++++++++++++++
 common/spl/spl_mmc.c       |   2 +-
 doc/README.firmware_loader |  86 +++++++++++
 include/fs_loader.h        |  28 ++++
 include/spl.h              |   2 +
 include/ubi_uboot.h        |   2 +
 9 files changed, 506 insertions(+), 18 deletions(-)
 create mode 100644 common/fs_loader.c
 create mode 100644 doc/README.firmware_loader
 create mode 100644 include/fs_loader.h

-- 
2.2.0

[U-Boot] [PATCH v10 1/4] spl: Remove static declaration on spl_mmc_find_device function

[tien.fong.chee at intel.com]

From: Tien Fong Chee <tien.fong.chee@intel.com>

This patch removes the static declation on spl_mmc_find_device_function
so this function is accessible by the caller from other file. This patch
is required for later patch.

Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
Reviewed-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Marek Vasut <marex@denx.de>
---
 common/spl/spl_mmc.c | 2 +-
 include/spl.h        | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/common/spl/spl_mmc.c b/common/spl/spl_mmc.c
index 351f4ed..f1c4168 100644
--- a/common/spl/spl_mmc.c
+++ b/common/spl/spl_mmc.c
@@ -114,7 +114,7 @@ static int spl_mmc_get_device_index(u32 boot_device)
 	return -ENODEV;
 }
 
-static int spl_mmc_find_device(struct mmc **mmcp, u32 boot_device)
+int spl_mmc_find_device(struct mmc **mmcp, u32 boot_device)
 {
 #if CONFIG_IS_ENABLED(DM_MMC)
 	struct udevice *dev;
diff --git a/include/spl.h b/include/spl.h
index c14448b..60424d7 100644
--- a/include/spl.h
+++ b/include/spl.h
@@ -12,6 +12,7 @@
 /* Platform-specific defines */
 #include <linux/compiler.h>
 #include <asm/spl.h>
+#include <mmc.h>
 
 /* Value in r0 indicates we booted from U-Boot */
 #define UBOOT_NOT_LOADED_FROM_SPL	0x13578642
@@ -83,6 +84,7 @@ void preloader_console_init(void);
 u32 spl_boot_device(void);
 u32 spl_boot_mode(const u32 boot_device);
 void spl_set_bd(void);
+int spl_mmc_find_device(struct mmc **mmcp, u32 boot_device);
 
 /**
  * spl_set_header_raw_uboot() - Set up a standard SPL image structure
-- 
2.2.0

[U-Boot] [PATCH v10 2/4] cmd: ubifs: Move ubifs_initialized checking into cmd_ubifs_umount()

[tien.fong.chee at intel.com]

From: Tien Fong Chee <tien.fong.chee@intel.com>

cmd_ubifs_umount() function would be called directly instead of involving
whole command machinery in generic firmware loader, so checking on
ubifs_initialized status need to be done in cmd_ubifs_umount() without
breaking original functionality design.

Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
Reviewed-by: Marek Vasut <marex@denx.de>
---
 cmd/ubifs.c         | 18 +++++++++---------
 include/ubi_uboot.h |  1 +
 2 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/cmd/ubifs.c b/cmd/ubifs.c
index 5e9d357..0d059ca 100644
--- a/cmd/ubifs.c
+++ b/cmd/ubifs.c
@@ -51,11 +51,18 @@ int ubifs_is_mounted(void)
 	return ubifs_mounted;
 }
 
-void cmd_ubifs_umount(void)
+int cmd_ubifs_umount(void)
 {
+	if (ubifs_initialized == 0) {
+		printf("No UBIFS volume mounted!\n");
+		return -1;
+	}
+
 	uboot_ubifs_umount();
 	ubifs_mounted = 0;
 	ubifs_initialized = 0;
+
+	return 0;
 }
 
 static int do_ubifs_umount(cmd_tbl_t *cmdtp, int flag, int argc,
@@ -64,14 +71,7 @@ static int do_ubifs_umount(cmd_tbl_t *cmdtp, int flag, int argc,
 	if (argc != 1)
 		return CMD_RET_USAGE;
 
-	if (ubifs_initialized == 0) {
-		printf("No UBIFS volume mounted!\n");
-		return -1;
-	}
-
-	cmd_ubifs_umount();
-
-	return 0;
+	return cmd_ubifs_umount();
 }
 
 static int do_ubifs_ls(cmd_tbl_t *cmdtp, int flag, int argc,
diff --git a/include/ubi_uboot.h b/include/ubi_uboot.h
index 80acbcb..827dbfc 100644
--- a/include/ubi_uboot.h
+++ b/include/ubi_uboot.h
@@ -75,5 +75,6 @@ extern int ubi_volume_write(char *volume, void *buf, size_t size);
 extern int ubi_volume_read(char *volume, char *buf, size_t size);
 
 extern struct ubi_device *ubi_devices[];
+int cmd_ubifs_umount(void);
 
 #endif
-- 
2.2.0

[U-Boot] [PATCH v10 2/4] cmd: ubifs: Move ubifs_initialized checking into cmd_ubifs_umount()

[Tom Rini]

On Mon, Mar 05, 2018 at 05:43:36PM +0800, tien.fong.chee at intel.com wrote:

> From: Tien Fong Chee <tien.fong.chee@intel.com>
> 
> cmd_ubifs_umount() function would be called directly instead of involving
> whole command machinery in generic firmware loader, so checking on
> ubifs_initialized status need to be done in cmd_ubifs_umount() without
> breaking original functionality design.
> 
> Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
> Reviewed-by: Marek Vasut <marex@denx.de>

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180305/b42e130e/attachment.sig>

[U-Boot] [PATCH v10 3/4] cmd: ubifs: Factor out some checking codes into cmd_ubifs_mount()

[tien.fong.chee at intel.com]

From: Tien Fong Chee <tien.fong.chee@intel.com>

cmd_ubifs_mount() function would be called directly instead of
involving whole command machinery for mounting ubifs in
generic firmware loader, so some checking codes need to be factored out
into cmd_ubifs_mount() without breaking original functionality design.

Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
Reviewed-by: Marek Vasut <marex@denx.de>
---
 cmd/ubifs.c         | 22 ++++++++++++++--------
 include/ubi_uboot.h |  1 +
 2 files changed, 15 insertions(+), 8 deletions(-)

diff --git a/cmd/ubifs.c b/cmd/ubifs.c
index 0d059ca..8339bed 100644
--- a/cmd/ubifs.c
+++ b/cmd/ubifs.c
@@ -20,16 +20,10 @@
 static int ubifs_initialized;
 static int ubifs_mounted;
 
-static int do_ubifs_mount(cmd_tbl_t *cmdtp, int flag, int argc,
-				char * const argv[])
+int cmd_ubifs_mount(char *vol_name)
 {
-	char *vol_name;
 	int ret;
 
-	if (argc != 2)
-		return CMD_RET_USAGE;
-
-	vol_name = argv[1];
 	debug("Using volume %s\n", vol_name);
 
 	if (ubifs_initialized == 0) {
@@ -43,7 +37,19 @@ static int do_ubifs_mount(cmd_tbl_t *cmdtp, int flag, int argc,
 
 	ubifs_mounted = 1;
 
-	return 0;
+	return ret;
+}
+static int do_ubifs_mount(cmd_tbl_t *cmdtp, int flag, int argc,
+				char * const argv[])
+{
+	char *vol_name;
+
+	if (argc != 2)
+		return CMD_RET_USAGE;
+
+	vol_name = argv[1];
+
+	return cmd_ubifs_mount(vol_name);
 }
 
 int ubifs_is_mounted(void)
diff --git a/include/ubi_uboot.h b/include/ubi_uboot.h
index 827dbfc..0770228 100644
--- a/include/ubi_uboot.h
+++ b/include/ubi_uboot.h
@@ -75,6 +75,7 @@ extern int ubi_volume_write(char *volume, void *buf, size_t size);
 extern int ubi_volume_read(char *volume, char *buf, size_t size);
 
 extern struct ubi_device *ubi_devices[];
+int cmd_ubifs_mount(char *vol_name);
 int cmd_ubifs_umount(void);
 
 #endif
-- 
2.2.0

[U-Boot] [PATCH v10 3/4] cmd: ubifs: Factor out some checking codes into cmd_ubifs_mount()

[Tom Rini]

On Mon, Mar 05, 2018 at 05:43:37PM +0800, tien.fong.chee at intel.com wrote:

> From: Tien Fong Chee <tien.fong.chee@intel.com>
> 
> cmd_ubifs_mount() function would be called directly instead of
> involving whole command machinery for mounting ubifs in
> generic firmware loader, so some checking codes need to be factored out
> into cmd_ubifs_mount() without breaking original functionality design.
> 
> Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
> Reviewed-by: Marek Vasut <marex@denx.de>

Reviewed-by: Tom Rini <trini@konsulko.com>

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180305/c21b2e72/attachment.sig>

[U-Boot] [PATCH v10 4/4] common: Generic firmware loader for file system

[tien.fong.chee at intel.com]

From: Tien Fong Chee <tien.fong.chee@intel.com>

This is file system generic loader which can be used to load
the file image from the storage into target such as memory.
The consumer driver would then use this loader to program whatever,
ie. the FPGA device.

Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
Reviewed-by: Lothar Waßmann <LW@KARO-electronics.de>
---
 common/Kconfig             |  10 ++
 common/Makefile            |   1 +
 common/fs_loader.c         | 353 +++++++++++++++++++++++++++++++++++++++++++++
 doc/README.firmware_loader |  86 +++++++++++
 include/fs_loader.h        |  28 ++++
 5 files changed, 478 insertions(+)
 create mode 100644 common/fs_loader.c
 create mode 100644 doc/README.firmware_loader
 create mode 100644 include/fs_loader.h

diff --git a/common/Kconfig b/common/Kconfig
index d5bc37e..ff88c6e 100644
--- a/common/Kconfig
+++ b/common/Kconfig
@@ -560,6 +560,16 @@ config DISPLAY_BOARDINFO
 	  when U-Boot starts up. The board function checkboard() is called
 	  to do this.
 
+config GENERIC_FIRMWARE_LOADER
+	bool "Enable generic firmware loader driver for file system"
+	depends on SPL
+	help
+	  This is file system generic loader which can be used to load
+	  the file image from the storage into target such as memory.
+
+	  The consumer driver would then use this loader to program whatever,
+	  ie. the FPGA device.
+
 menu "Start-up hooks"
 
 config ARCH_EARLY_INIT_R
diff --git a/common/Makefile b/common/Makefile
index c7bde23..92d8fb3 100644
--- a/common/Makefile
+++ b/common/Makefile
@@ -134,3 +134,4 @@ obj-$(CONFIG_$(SPL_)LOG) += log.o
 obj-$(CONFIG_$(SPL_)LOG_CONSOLE) += log_console.o
 obj-y += s_record.o
 obj-y += xyzModem.o
+obj-$(CONFIG_GENERIC_FIRMWARE_LOADER) += fs_loader.o
diff --git a/common/fs_loader.c b/common/fs_loader.c
new file mode 100644
index 0000000..44c8ee0
--- /dev/null
+++ b/common/fs_loader.c
@@ -0,0 +1,353 @@
+/*
+ * Copyright (C) 2018 Intel Corporation <www.intel.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0
+ */
+
+#include <common.h>
+#include <errno.h>
+#include <fs.h>
+#include <fs_loader.h>
+#include <nand.h>
+#include <sata.h>
+#include <spi.h>
+#include <spi_flash.h>
+#include <spl.h>
+#include <linux/string.h>
+#ifdef CONFIG_CMD_UBIFS
+#include <ubi_uboot.h>
+#include <ubifs_uboot.h>
+#endif
+#include <usb.h>
+
+struct firmware_priv {
+	const char *name;	/* Filename */
+	u32 offset;		/* Offset of reading a file */
+};
+
+static struct device_location default_locations[] = {
+	{
+		.name = "mmc",
+		.devpart = "0:1",
+	},
+	{
+		.name = "usb",
+		.devpart = "0:1",
+	},
+	{
+		.name = "sata",
+		.devpart = "0:1",
+	},
+	{
+		.name = "ubi",
+		.mtdpart = "UBI",
+		.ubivol = "ubi0",
+	},
+};
+
+/* USB build is not supported yet in SPL */
+#ifndef CONFIG_SPL_BUILD
+#ifdef CONFIG_USB_STORAGE
+static int init_usb(void)
+{
+	int err;
+
+	err = usb_init();
+	if (err)
+		return err;
+
+#ifndef CONFIG_DM_USB
+	err = usb_stor_scan(0);
+	if (err)
+		return err;
+#endif
+
+	return err;
+}
+#else
+static int init_usb(void)
+{
+	debug("Error: Cannot load flash image: no USB support\n");
+	return -ENOSYS;
+}
+#endif
+#endif
+
+#ifdef CONFIG_SATA
+static int init_storage_sata(struct device_location *location)
+{
+	int dev;
+
+	/* Get device ID */
+	dev = (int)simple_strtoul(location->devpart, NULL, 10);
+
+	return sata_probe(dev);
+}
+#else
+static int init_storage_sata(struct device_location *location)
+{
+	debug("Error: Cannot load image: no SATA support\n");
+	return -ENOSYS;
+}
+#endif
+
+#ifdef CONFIG_CMD_UBIFS
+static int mount_ubifs(struct device_location *location)
+{
+	int ret = ubi_part(location->mtdpart, NULL);
+
+	if (ret) {
+		debug("Cannot find mtd partition %s\n", location->mtdpart);
+		return ret;
+	}
+
+	return cmd_ubifs_mount(location->ubivol);
+}
+
+static int umount_ubifs(void)
+{
+	return cmd_ubifs_umount();
+}
+#else
+static int mount_ubifs(struct device_location *location)
+{
+	debug("Error: Cannot load image: no UBIFS support\n");
+	return -ENOSYS;
+}
+#endif
+
+#if defined(CONFIG_SPL_MMC_SUPPORT) && defined(CONFIG_SPL_BUILD)
+__weak int init_mmc(void)
+{
+	/* Just for the case MMC is not yet initialized */
+	struct mmc *mmc = NULL;
+	int err;
+
+#ifdef CONFIG_SPL
+	spl_mmc_find_device(&mmc, spl_boot_device());
+#else
+	return -ENOENT;
+#endif
+
+	err = mmc_init(mmc);
+	if (err) {
+		debug("spl: mmc init failed with error: %d\n", err);
+		return err;
+	}
+
+	return err;
+}
+#else
+__weak int init_mmc(void)
+{
+	/* Expect somewhere already initialize MMC */
+	return 0;
+}
+#endif
+
+static int select_fs_dev(struct device_location *location)
+{
+	int ret;
+
+	if (!strcmp("mmc", location->name)) {
+		ret = fs_set_blk_dev("mmc", location->devpart, FS_TYPE_ANY);
+	} else if (!strcmp("usb", location->name)) {
+		ret = fs_set_blk_dev("usb", location->devpart, FS_TYPE_ANY);
+	} else if (!strcmp("sata", location->name)) {
+		ret = fs_set_blk_dev("sata", location->devpart, FS_TYPE_ANY);
+	} else if (!strcmp("ubi", location->name)) {
+		if (location->ubivol)
+			ret = fs_set_blk_dev("ubi", NULL, FS_TYPE_UBIFS);
+		else
+			ret = -ENODEV;
+	} else {
+		debug("Error: unsupported location storage.\n");
+		return -ENODEV;
+	}
+
+	if (ret)
+		debug("Error: could not access storage.\n");
+
+	return ret;
+}
+
+static int init_storage_device(struct device_location *location)
+{
+	int ret;
+
+	if (!strcmp("mmc", location->name)) {
+		ret = init_mmc();
+	} else if (!strcmp("sata", location->name)) {
+		ret = init_storage_sata(location);
+	} else if (location->ubivol) {
+		ret = mount_ubifs(location);
+#ifndef CONFIG_SPL_BUILD
+	/* USB build is not supported yet in SPL */
+	} else if (!strcmp("usb", location->name)) {
+		ret = init_usb();
+#endif
+	} else {
+		debug("Error: no supported storage device is available.\n");
+		ret = -ENODEV;
+	}
+
+	return ret;
+}
+
+static void set_storage_devpart(const char *name, const char *devpart)
+{
+	size_t i;
+
+	for (i = 0; i < ARRAY_SIZE(default_locations); i++) {
+		if (!strcmp(default_locations[i].name, name))
+			default_locations[i].devpart = (char *)devpart;
+	}
+}
+
+static void set_storage_mtdpart(const char *name, const char *mtdpart)
+{
+	size_t i;
+
+	for (i = 0; i < ARRAY_SIZE(default_locations); i++) {
+		if (!strcmp(default_locations[i].name, name))
+			default_locations[i].mtdpart = (char *)mtdpart;
+	}
+}
+
+static void set_storage_ubivol(const char *name, const char *ubivol)
+{
+	size_t i;
+
+	for (i = 0; i < ARRAY_SIZE(default_locations); i++) {
+		if (!strcmp(default_locations[i].name, name))
+			default_locations[i].ubivol = (char *)ubivol;
+	}
+}
+
+/**
+ * _request_firmware_prepare - Prepare firmware struct.
+ *
+ * @firmware_p: Pointer to pointer to firmware image.
+ * @name: Name of firmware file.
+ * @dbuf: Address of buffer to load firmware into.
+ * @size: Size of buffer.
+ * @offset: Offset of a file for start reading into buffer.
+ *
+ * Return: Negative value if fail, 0 for successful.
+ */
+static int _request_firmware_prepare(struct firmware **firmware_p,
+				     const char *name, void *dbuf,
+				     size_t size, u32 offset)
+{
+	struct firmware *firmware;
+	struct firmware_priv *fw_priv;
+
+	*firmware_p = NULL;
+
+	if (!name || name[0] == '\0')
+		return -EINVAL;
+
+	firmware = calloc(1, sizeof(*firmware));
+	if (!firmware)
+		return -ENOMEM;
+
+	fw_priv = calloc(1, sizeof(*fw_priv));
+	if (!fw_priv) {
+		free(firmware);
+		return -ENOMEM;
+	}
+
+	fw_priv->name = name;
+	fw_priv->offset = offset;
+	firmware->data = dbuf;
+	firmware->size = size;
+	firmware->priv = fw_priv;
+	*firmware_p = firmware;
+
+	return 0;
+}
+
+/**
+ * fw_get_filesystem_firmware - load firmware into an allocated buffer.
+ * @location: An array of supported firmware location.
+ * @firmware_p: pointer to firmware image.
+ *
+ * Return: Size of total read, negative value when error.
+ */
+static int fw_get_filesystem_firmware(struct device_location *location,
+				      struct firmware *firmware_p)
+{
+	struct firmware_priv *fw_priv = NULL;
+	loff_t actread;
+	char *dev_part, *ubi_mtdpart, *ubi_volume;
+	int ret;
+
+	dev_part = env_get("fw_dev_part");
+	if (dev_part)
+		set_storage_devpart(location->name, dev_part);
+
+	ubi_mtdpart = env_get("fw_ubi_mtdpart");
+	if (ubi_mtdpart)
+		set_storage_mtdpart(location->name, ubi_mtdpart);
+
+	ubi_volume = env_get("fw_ubi_volume");
+	if (ubi_volume)
+		set_storage_ubivol(location->name, ubi_volume);
+
+	ret = init_storage_device(location);
+	if (ret)
+		goto out;
+
+	ret = select_fs_dev(location);
+	if (ret)
+		goto out;
+
+	fw_priv = firmware_p->priv;
+
+	ret = fs_read(fw_priv->name, (ulong)firmware_p->data, fw_priv->offset,
+		     firmware_p->size, &actread);
+	if (ret) {
+		debug("Error: %d Failed to read %s from flash %lld != %d.\n",
+		      ret, fw_priv->name, actread, firmware_p->size);
+	} else {
+		ret = actread;
+	}
+
+out:
+#ifdef CONFIG_CMD_UBIFS
+	if (location->ubivol)
+		umount_ubifs();
+#endif
+
+	return ret;
+}
+
+/**
+ * request_firmware_into_buf - Load firmware into a previously allocated buffer.
+ * @firmware_p: Pointer to firmware image.
+ * @name: Name of firmware file.
+ * @location: An array of supported firmware location.
+ * @buf: Address of buffer to load firmware into.
+ * @size: Size of buffer.
+ * @offset: Offset of a file for start reading into buffer.
+ *
+ * The firmware is loaded directly into the buffer pointed to by @buf and
+ * the @firmware_p data member is pointed at @buf.
+ *
+ * Return: Size of total read, negative value when error.
+ */
+int request_firmware_into_buf(struct firmware **firmware_p,
+			      const char *name,
+			      struct device_location *location,
+			      void *buf, size_t size, u32 offset)
+{
+	int ret;
+
+	ret = _request_firmware_prepare(firmware_p, name, buf, size, offset);
+	if (ret < 0) /* error */
+		return ret;
+
+	ret = fw_get_filesystem_firmware(location, *firmware_p);
+
+	return ret;
+}
diff --git a/doc/README.firmware_loader b/doc/README.firmware_loader
new file mode 100644
index 0000000..fa86064
--- /dev/null
+++ b/doc/README.firmware_loader
@@ -0,0 +1,86 @@
+/*
+ * Copyright (C) 2017 Intel Corporation <www.intel.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0
+ */
+
+Introduction
+------------
+This is firmware loader for U-Boot framework, which has very close to some Linux
+Firmware API. For the details of Linux Firmware API, you can refer to
+https://01.org/linuxgraphics/gfx-docs/drm/driver-api/firmware/index.html.
+
+Firmware loader can be used to load whatever(firmware, image, and binary) from
+the flash in file system format into target location such as memory, then
+consumer driver such as FPGA driver can program FPGA image from the target
+location into FPGA.
+
+To enable firmware loader, CONFIG_GENERIC_FIRMWARE_LOADER need to be set in
+<board_name>_defconfig such as "CONFIG_GENERIC_FIRMWARE_LOADER=y".
+
+Firmware Loader API core features
+---------------------------------
+=> Firmware storage device partition search
+   ----------------------------------------
+   =>	Default storage device partition search set for mmc, usb, sata and ubi
+	as shown in below:
+	static struct device_location default_locations[] = {
+		{
+			.name = "mmc",
+			.devpart = "0:1",
+		},
+		{
+			.name = "usb",
+			.devpart = "0:1",
+		},
+		{
+			.name = "sata",
+			.devpart = "0:1",
+		},
+		{
+			.name = "ubi",
+			.mtdpart = "UBI",
+			.ubivol= "ubi0",
+		},
+	};
+
+	However, the default storage device .devpart, .mtdpart, and .ubivol
+	values can be overwritten with value which is defined in the environment
+	variable "fw_dev_part", "fw_ubi_mtdpart", and "fw_ubi_volume"
+	respectively.
+	For example: env_set("fw_dev_part", "0:2");
+
+Firmware Loader API
+-------------------
+=> int request_firmware_into_buf(struct firmware **firmware_p,
+			      const char *name,
+			      struct device_location *location,
+			      void *buf, size_t size, u32 offset)
+   --------------------------------------------------------------
+   =>	Load firmware into a previously allocated buffer
+
+	Parameters:
+	struct firmware **firmware_p
+		pointer to firmware image
+
+	const char *name
+		name of firmware file
+
+	struct device_location *location
+		an array of supported firmware location
+
+	void *buf
+		address of buffer to load firmware into
+
+	size_t size
+		size of buffer
+
+	u32 offset
+		offset of a file for start reading into buffer
+
+	return: size of total read
+		-ve when error
+
+	Description:
+	The firmware is loaded directly into the buffer pointed to by buf and
+	the @firmware_p data member is pointed at buf.
diff --git a/include/fs_loader.h b/include/fs_loader.h
new file mode 100644
index 0000000..60a6ba2
--- /dev/null
+++ b/include/fs_loader.h
@@ -0,0 +1,28 @@
+/*
+ * Copyright (C) 2018 Intel Corporation <www.intel.com>
+ *
+ * SPDX-License-Identifier:    GPL-2.0
+ */
+#ifndef _FS_LOADER_H_
+#define _FS_LOADER_H_
+
+#include <linux/types.h>
+
+struct firmware {
+	size_t size;		/* Size of a file */
+	const u8 *data;		/* Buffer for file */
+	void *priv;		/* Firmware loader private fields */
+};
+
+struct device_location {
+	char *name;	/* Such as mmc, usb,and sata. */
+	char *devpart;  /* Use the load command dev:part conventions */
+	char *mtdpart;	/* MTD partition for ubi part */
+	char *ubivol;	/* UBI volume-name for ubifsmount */
+};
+
+int request_firmware_into_buf(struct firmware **firmware_p,
+			      const char *name,
+			      struct device_location *location,
+			      void *buf, size_t size, u32 offset);
+#endif
-- 
2.2.0

[U-Boot] [PATCH v10 4/4] common: Generic firmware loader for file system

[Simon Glass]

Hi,

On 5 March 2018 at 02:43,  <tien.fong.chee@intel.com> wrote:
> From: Tien Fong Chee <tien.fong.chee@intel.com>
>
> This is file system generic loader which can be used to load
> the file image from the storage into target such as memory.
> The consumer driver would then use this loader to program whatever,
> ie. the FPGA device.
>
> Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
> Reviewed-by: Lothar Waßmann <LW@KARO-electronics.de>
> ---
>  common/Kconfig             |  10 ++
>  common/Makefile            |   1 +
>  common/fs_loader.c         | 353 +++++++++++++++++++++++++++++++++++++++++++++
>  doc/README.firmware_loader |  86 +++++++++++
>  include/fs_loader.h        |  28 ++++
>  5 files changed, 478 insertions(+)
>  create mode 100644 common/fs_loader.c
>  create mode 100644 doc/README.firmware_loader
>  create mode 100644 include/fs_loader.h

This looks fine as a concept but I am not keen on the implementation.

1. It should use driver model (only) in U-Boot proper. If there is
some SPL problem then add a specific function or feature for SPL.
2. It should not be necessary ti manually init subsystems - driver
model does this for you
3. You can use the uclass name to find things

Please let me know if you need more info.

Regards,
Simon

[U-Boot] [PATCH v10 4/4] common: Generic firmware loader for file system

[Chee, Tien Fong]

On Tue, 2018-03-06 at 10:51 -0700, Simon Glass wrote:
> Hi,
> 
> On 5 March 2018 at 02:43,  <tien.fong.chee@intel.com> wrote:
> > 
> > From: Tien Fong Chee <tien.fong.chee@intel.com>
> > 
> > This is file system generic loader which can be used to load
> > the file image from the storage into target such as memory.
> > The consumer driver would then use this loader to program whatever,
> > ie. the FPGA device.
> > 
> > Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
> > Reviewed-by: Lothar Waßmann <LW@KARO-electronics.de>
> > ---
> >  common/Kconfig             |  10 ++
> >  common/Makefile            |   1 +
> >  common/fs_loader.c         | 353
> > +++++++++++++++++++++++++++++++++++++++++++++
> >  doc/README.firmware_loader |  86 +++++++++++
> >  include/fs_loader.h        |  28 ++++
> >  5 files changed, 478 insertions(+)
> >  create mode 100644 common/fs_loader.c
> >  create mode 100644 doc/README.firmware_loader
> >  create mode 100644 include/fs_loader.h
> This looks fine as a concept but I am not keen on the implementation.
> 
This patchset has been going through many rounds and a lot of time
spending in review, and it is already working and being tested. I still
have a lot subsequent patches pending on this patchset. I would suggest
to accept this patchset, then we can enhance it to driver model in
later.

> 1. It should use driver model (only) in U-Boot proper. If there is
> some SPL problem then add a specific function or feature for SPL.
We can doing this in later since it is require sometime to figure out
and testing.

> 2. It should not be necessary ti manually init subsystems - driver
> model does this for you
This is for initializing storage driver in very early SPL, where
loading from storage to configure some critical HW need to done first.

> 3. You can use the uclass name to find things
Yeah, once it is converted to driver model, we can use the uclass for
searching HW info in DTS.
> 
> Please let me know if you need more info.
> 
> Regards,
> Simon

[U-Boot] [PATCH v10 4/4] common: Generic firmware loader for file system

[Simon Glass]

Hi,

On 7 March 2018 at 22:03, Chee, Tien Fong <tien.fong.chee@intel.com> wrote:
> On Tue, 2018-03-06 at 10:51 -0700, Simon Glass wrote:
>> Hi,
>>
>> On 5 March 2018 at 02:43,  <tien.fong.chee@intel.com> wrote:
>> >
>> > From: Tien Fong Chee <tien.fong.chee@intel.com>
>> >
>> > This is file system generic loader which can be used to load
>> > the file image from the storage into target such as memory.
>> > The consumer driver would then use this loader to program whatever,
>> > ie. the FPGA device.
>> >
>> > Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
>> > Reviewed-by: Lothar Waßmann <LW@KARO-electronics.de>
>> > ---
>> >  common/Kconfig             |  10 ++
>> >  common/Makefile            |   1 +
>> >  common/fs_loader.c         | 353
>> > +++++++++++++++++++++++++++++++++++++++++++++
>> >  doc/README.firmware_loader |  86 +++++++++++
>> >  include/fs_loader.h        |  28 ++++
>> >  5 files changed, 478 insertions(+)
>> >  create mode 100644 common/fs_loader.c
>> >  create mode 100644 doc/README.firmware_loader
>> >  create mode 100644 include/fs_loader.h
>> This looks fine as a concept but I am not keen on the implementation.
>>
> This patchset has been going through many rounds and a lot of time
> spending in review, and it is already working and being tested. I still
> have a lot subsequent patches pending on this patchset. I would suggest
> to accept this patchset, then we can enhance it to driver model in
> later.
>
>> 1. It should use driver model (only) in U-Boot proper. If there is
>> some SPL problem then add a specific function or feature for SPL.
> We can doing this in later since it is require sometime to figure out
> and testing.
>
>> 2. It should not be necessary ti manually init subsystems - driver
>> model does this for you
> This is for initializing storage driver in very early SPL, where
> loading from storage to configure some critical HW need to done first.
>
>> 3. You can use the uclass name to find things
> Yeah, once it is converted to driver model, we can use the uclass for
> searching HW info in DTS.
>>
>> Please let me know if you need more info.

Well I'm still not keen on this. Are you planning to do the
conversion? It seems like a lot of work for someone else to do.

Regards,
Simon

[U-Boot] [PATCH v10 4/4] common: Generic firmware loader for file system

[Chee, Tien Fong]

On Thu, 2018-03-08 at 14:04 -0700, Simon Glass wrote:
> Hi,
> 
> On 7 March 2018 at 22:03, Chee, Tien Fong <tien.fong.chee@intel.com>
> wrote:
> > 
> > On Tue, 2018-03-06 at 10:51 -0700, Simon Glass wrote:
> > > 
> > > Hi,
> > > 
> > > On 5 March 2018 at 02:43,  <tien.fong.chee@intel.com> wrote:
> > > > 
> > > > 
> > > > From: Tien Fong Chee <tien.fong.chee@intel.com>
> > > > 
> > > > This is file system generic loader which can be used to load
> > > > the file image from the storage into target such as memory.
> > > > The consumer driver would then use this loader to program
> > > > whatever,
> > > > ie. the FPGA device.
> > > > 
> > > > Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
> > > > Reviewed-by: Lothar Waßmann <LW@KARO-electronics.de>
> > > > ---
> > > >  common/Kconfig             |  10 ++
> > > >  common/Makefile            |   1 +
> > > >  common/fs_loader.c         | 353
> > > > +++++++++++++++++++++++++++++++++++++++++++++
> > > >  doc/README.firmware_loader |  86 +++++++++++
> > > >  include/fs_loader.h        |  28 ++++
> > > >  5 files changed, 478 insertions(+)
> > > >  create mode 100644 common/fs_loader.c
> > > >  create mode 100644 doc/README.firmware_loader
> > > >  create mode 100644 include/fs_loader.h
> > > This looks fine as a concept but I am not keen on the
> > > implementation.
> > > 
> > This patchset has been going through many rounds and a lot of time
> > spending in review, and it is already working and being tested. I
> > still
> > have a lot subsequent patches pending on this patchset. I would
> > suggest
> > to accept this patchset, then we can enhance it to driver model in
> > later.
> > 
> > > 
> > > 1. It should use driver model (only) in U-Boot proper. If there
> > > is
> > > some SPL problem then add a specific function or feature for SPL.
> > We can doing this in later since it is require sometime to figure
> > out
> > and testing.
> > 
> > > 
> > > 2. It should not be necessary ti manually init subsystems -
> > > driver
> > > model does this for you
> > This is for initializing storage driver in very early SPL, where
> > loading from storage to configure some critical HW need to done
> > first.
> > 
> > > 
> > > 3. You can use the uclass name to find things
> > Yeah, once it is converted to driver model, we can use the uclass
> > for
> > searching HW info in DTS.
> > > 
> > > 
> > > Please let me know if you need more info.
> Well I'm still not keen on this. Are you planning to do the
> conversion? It seems like a lot of work for someone else to do.
> 
Okay, i will try to convert it into driver model.

> Regards,
> Simon

[U-Boot] [PATCH v10 4/4] common: Generic firmware loader for file system

[Tom Rini]

On Thu, Mar 15, 2018 at 07:18:20AM +0000, Chee, Tien Fong wrote:
> On Thu, 2018-03-08 at 14:04 -0700, Simon Glass wrote:
> > Hi,
> > 
> > On 7 March 2018 at 22:03, Chee, Tien Fong <tien.fong.chee@intel.com>
> > wrote:
> > > 
> > > On Tue, 2018-03-06 at 10:51 -0700, Simon Glass wrote:
> > > > 
> > > > Hi,
> > > > 
> > > > On 5 March 2018 at 02:43,  <tien.fong.chee@intel.com> wrote:
> > > > > 
> > > > > 
> > > > > From: Tien Fong Chee <tien.fong.chee@intel.com>
> > > > > 
> > > > > This is file system generic loader which can be used to load
> > > > > the file image from the storage into target such as memory.
> > > > > The consumer driver would then use this loader to program
> > > > > whatever,
> > > > > ie. the FPGA device.
> > > > > 
> > > > > Signed-off-by: Tien Fong Chee <tien.fong.chee@intel.com>
> > > > > Reviewed-by: Lothar Waßmann <LW@KARO-electronics.de>
> > > > > ---
> > > > >  common/Kconfig             |  10 ++
> > > > >  common/Makefile            |   1 +
> > > > >  common/fs_loader.c         | 353
> > > > > +++++++++++++++++++++++++++++++++++++++++++++
> > > > >  doc/README.firmware_loader |  86 +++++++++++
> > > > >  include/fs_loader.h        |  28 ++++
> > > > >  5 files changed, 478 insertions(+)
> > > > >  create mode 100644 common/fs_loader.c
> > > > >  create mode 100644 doc/README.firmware_loader
> > > > >  create mode 100644 include/fs_loader.h
> > > > This looks fine as a concept but I am not keen on the
> > > > implementation.
> > > > 
> > > This patchset has been going through many rounds and a lot of time
> > > spending in review, and it is already working and being tested. I
> > > still
> > > have a lot subsequent patches pending on this patchset. I would
> > > suggest
> > > to accept this patchset, then we can enhance it to driver model in
> > > later.
> > > 
> > > > 
> > > > 1. It should use driver model (only) in U-Boot proper. If there
> > > > is
> > > > some SPL problem then add a specific function or feature for SPL.
> > > We can doing this in later since it is require sometime to figure
> > > out
> > > and testing.
> > > 
> > > > 
> > > > 2. It should not be necessary ti manually init subsystems -
> > > > driver
> > > > model does this for you
> > > This is for initializing storage driver in very early SPL, where
> > > loading from storage to configure some critical HW need to done
> > > first.
> > > 
> > > > 
> > > > 3. You can use the uclass name to find things
> > > Yeah, once it is converted to driver model, we can use the uclass
> > > for
> > > searching HW info in DTS.
> > > > 
> > > > 
> > > > Please let me know if you need more info.
> > Well I'm still not keen on this. Are you planning to do the
> > conversion? It seems like a lot of work for someone else to do.
> > 
> Okay, i will try to convert it into driver model.

Thanks!

-- 
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20180315/5dcf391a/attachment.sig>

[U-Boot] [PATCH v10 4/4] common: Generic firmware loader for file system

[Wolfgang Denk]

Dear Tien Fong,

In message <1520485397.10181.12.camel@intel.com> you wrote:
>
> > This looks fine as a concept but I am not keen on the implementation.
> > 
> This patchset has been going through many rounds and a lot of time
> spending in review, and it is already working and being tested. I still

That's life....

> have a lot subsequent patches pending on this patchset. I would suggest
> to accept this patchset, then we can enhance it to driver model in
> later.

No.  The usual approach is to _first_ clean up the code, _before_ it
gets added.  there have been just too many cases that interest in
cleaning up disappeared quickly once the unclean version was pulled
into mainline.

> > 1. It should use driver model (only) in U-Boot proper. If there is
> > some SPL problem then add a specific function or feature for SPL.
> We can doing this in later since it is require sometime to figure out
> and testing.

We can also do it now, and that is better.

> > 2. It should not be necessary ti manually init subsystems - driver
> > model does this for you
> This is for initializing storage driver in very early SPL, where
> loading from storage to configure some critical HW need to done first.

The key problem is that your approach does not scale.  We had the
same discussion elsewhere.

> > 3. You can use the uclass name to find things
> Yeah, once it is converted to driver model, we can use the uclass for
> searching HW info in DTS.

Then please convert it.

Thanks.

Best regards,

Wolfgang Denk

-- 
DENX Software Engineering GmbH,      Managing Director: Wolfgang Denk
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: (+49)-8142-66989-10 Fax: (+49)-8142-66989-80 Email: wd at denx.de
I read part of it all the way through.