Skip to contentSkip to conversation

spl: Add support to load FIT from Filesystem

PATCH Superseded Lokesh Vutla 2 participants 6 messages Apr 11, 2016 – Apr 14, 2016

v2 of 6 Superseded Latest is v6 →

lore
Share & tools
lore
#0 lore raw

v2 cover spl: Add support to load FIT from Filesystem

Some devices like MMC, USB can be formatted to a FS and can act as a boot media. Given that FIT image load support in SPL support only raw devices, SPL should also be able to support loading FIT image from a File system.
This series add support to load FIT image from a filesystem and also adding hooks to FAT FS.

Lokesh Vutla (2):
spl: Add an option to load a FIT containing U-Boot from FS
spl: Support loading a FIT from FAT FS

 common/spl/spl_fat.c |  27 +++++++++-
 common/spl/spl_fit.c | 146 +++++++++++++++++++++++++++++++++++++++++++--------
 include/spl.h        |  31 +++++++++++
 3 files changed, 179 insertions(+), 25 deletions(-)
Signature · 1 line
2.1.4
#1 lore raw

PATCH v2 1/2 spl: Add an option to load a FIT containing U-Boot from FS

This provides a way to load a FIT containing U-Boot and a selection of device tree files from a File system.

---
Changes since v1:
- Added comments for function declarations.
- Bring out the common code for parsing fit header.

 common/spl/spl_fit.c | 146 +++++++++++++++++++++++++++++++++++++++++++--------
 include/spl.h        |  31 +++++++++++
 2 files changed, 154 insertions(+), 23 deletions(-)
common/spl/spl_fit.c +123 -23
index 1a5c027..a4ab67e 100644
@@ -82,12 +82,42 @@ static int spl_fit_select_fdt(const void *fdt, int images, int *fdt_offsetp)
 	return -ENOENT;
 }
 
+#define get_fit_size(fit) ALIGN(fdt_totalsize(fit), 4)
+
+static int spl_parse_fit_header(void *fit)
+{
+	int node;
+
+	spl_image.images = fdt_path_offset(fit, FIT_IMAGES_PATH);
+	if (spl_image.images < 0) {
+		debug("%s: Cannot find /images node: %d\n", __func__,
+		      spl_image.images);
+		return -1;
+	}
+	node = fdt_first_subnode(fit, spl_image.images);
+	if (node < 0) {
+		debug("%s: Cannot find first image node: %d\n", __func__, node);
+		return -1;
+	}
+
+	/* Get its information and set up the spl_image structure */
+	spl_image.data_offset = fdt_getprop_u32(fit, node, "data-offset");
+	spl_image.data_size = fdt_getprop_u32(fit, node, "data-size");
+	spl_image.load_addr = fdt_getprop_u32(fit, node, "load");
+	debug("data_offset=%x, data_size=%x\n", spl_image.data_offset,
+	      spl_image.data_size);
+	spl_image.entry_point = spl_image.load_addr;
+	spl_image.os = IH_OS_U_BOOT;
+
+	return 0;
+}
+
 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 {
 	int sectors;
 	ulong size, load;
 	unsigned long count;
-	int node, images;
+	int images, ret;
 	void *load_ptr;
 	int fdt_offset, fdt_len;
 	int data_offset, data_size;
@@ -99,9 +129,8 @@ int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 	 * Figure out where the external images start. This is the base for the
 	 * data-offset properties in each image.
 	 */
-	size = fdt_totalsize(fit);
-	size = (size + 3) & ~3;
-	base_offset = (size + 3) & ~3;
+	size = get_fit_size(fit);
+	base_offset = size;
 
 	/*
 	 * So far we only have one block of data from the FIT. Read the entire
@@ -125,26 +154,13 @@ int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 	if (count == 0)
 		return -EIO;
 
-	/* find the firmware image to load */
-	images = fdt_path_offset(fit, FIT_IMAGES_PATH);
-	if (images < 0) {
-		debug("%s: Cannot find /images node: %d\n", __func__, images);
+	ret = spl_parse_fit_header(fit);
+	if (ret < 0)
 		return -1;
-	}
-	node = fdt_first_subnode(fit, images);
-	if (node < 0) {
-		debug("%s: Cannot find first image node: %d\n", __func__, node);
-		return -1;
-	}
-
-	/* Get its information and set up the spl_image structure */
-	data_offset = fdt_getprop_u32(fit, node, "data-offset");
-	data_size = fdt_getprop_u32(fit, node, "data-size");
-	load = fdt_getprop_u32(fit, node, "load");
-	debug("data_offset=%x, data_size=%x\n", data_offset, data_size);
-	spl_image.load_addr = load;
-	spl_image.entry_point = load;
-	spl_image.os = IH_OS_U_BOOT;
+	data_offset = spl_image.data_offset;
+	data_size = spl_image.data_size;
+	load = spl_image.load_addr;
+	images = spl_image.images;
 
 	/*
 	 * Work out where to place the image. We read it so that the first
@@ -192,3 +208,87 @@ int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 
 	return 0;
 }
+
+int spl_fs_load_simple_fit(struct spl_load_info *info, const char *filename,
+			   void *fit)
+{
+	ulong size, load;
+	unsigned long count;
+	int images, ret;
+	void *load_ptr;
+	int fdt_offset, fdt_len;
+	int data_offset, data_size, file_offset;
+	int base_offset = 0, align_len;
+	void *dst;
+
+	/*
+	 * Figure out where the external images start. This is the base for the
+	 * data-offset properties in each image.
+	 */
+	size = get_fit_size(fit);
+	base_offset = size;
+
+	/*
+	 * Read the entire FIT header, placing it so it finishes before
+	 * where we will load the image. Also the load address is aligned
+	 * ARCH_DMA_MINALIGN.
+	 */
+	align_len = ARCH_DMA_MINALIGN - 1;
+	fit = (void *)((CONFIG_SYS_TEXT_BASE - size - align_len) & ~align_len);
+	debug("FIT header read: destination = 0x%p, size = %lx\n", fit, size);
+	count = info->fs_read(info, filename, fit, 0, size);
+	if (count <= 0)
+		return -EIO;
+
+	ret = spl_parse_fit_header(fit);
+	if (ret < 0)
+		return -1;
+	data_offset = spl_image.data_offset;
+	data_size = spl_image.data_size;
+	load = spl_image.load_addr;
+	images = spl_image.images;
+
+	/*
+	 * Work out where to place the image. Assuming load addr of u-boot.bin
+	 * is always aligned to ARCH_DMA_MINALIGN. It is possible that file
+	 * offset is not aligned. In order to make sure that the file read is
+	 * dma aligned, align the file offset to dma with extra bytes in the
+	 * beginning. Then do a memcpy of image to dst.
+	 */
+	data_offset += base_offset;
+	file_offset = data_offset & ~align_len;
+	load_ptr = (void *)load;
+	dst = load_ptr;
+
+	/* Read the image */
+	debug("Temp u-boot.bin read from fit: dst = 0x%p, file offset = 0x%x, size = 0x%x\n",
+	      dst, file_offset, data_size);
+	count = info->fs_read(info, filename, dst, file_offset, data_size);
+	if (count <= 0)
+		return -EIO;
+	debug("u-boot.bin load: dst = 0x%p, size = 0x%x\n", dst, data_size);
+	memcpy(dst, dst + (data_offset & align_len), data_size);
+
+	/* Figure out which device tree the board wants to use */
+	fdt_len = spl_fit_select_fdt(fit, images, &fdt_offset);
+	if (fdt_len < 0)
+		return fdt_len;
+
+	/*
+	 * Read the device tree and place it after the image. Making sure that
+	 * load addr and file offset are aligned to dma.
+	 */
+	dst = (void *)((load + data_size + align_len) & ~align_len);
+	fdt_offset += base_offset;
+	file_offset = fdt_offset & ~align_len;
+	debug("Temp fdt read from fit: dst = 0x%p, file offset = 0x%x, size = %d\n",
+	      dst, file_offset, data_size);
+	count = info->fs_read(info, filename, dst, file_offset, data_size);
+	if (count <= 0)
+		return -EIO;
+	debug("fdt load: dst = 0x%p, size = 0x%x\n", load_ptr + data_size,
+	      data_size);
+	memcpy(load_ptr + data_size, dst + (fdt_offset & align_len), data_size);
+
+	return 1;
+}
include/spl.h +31 -0
index de4f70a..5f0b0db 100644
@@ -27,6 +27,11 @@ struct spl_image_info {
 	u32 entry_point;
 	u32 size;
 	u32 flags;
+#ifdef CONFIG_SPL_LOAD_FIT
+	int data_offset;
+	int data_size;
+	int images;
+#endif
 };
 
 /*
@@ -36,6 +41,7 @@ struct spl_image_info {
  * @priv: Private data for the device
  * @bl_len: Block length for reading in bytes
  * @read: Function to call to read from the device
+ * @fs_read: Function to call to read from a fs
  */
 struct spl_load_info {
 	void *dev;
@@ -43,10 +49,35 @@ struct spl_load_info {
 	int bl_len;
 	ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
 		      void *buf);
+	int (*fs_read)(struct spl_load_info *load, const char *filename,
+		      void *buf, ulong file_offset, ulong size);
 };
 
+/**
+ * spl_load_simple_fit() - Loads a fit image from a device.
+ * @info:	Structure containing the information required to load data.
+ * @sector:	Sector number where FIT image is located in the device
+ * @fdt:	Pointer to the copied FIT header.
+ *
+ * Reads the FIT image @sector in the device. Loads u-boot image to
+ * specified load address and copies the dtb to end of u-boot image.
+ * Returns 0 on success.
+ */
 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt);
 
+/**
+ * spl_fs_load_simple_fit() - Loads a fit image from a file system.
+ * @info:	Structure containing the information required to load data.
+ * @filename:	Name of the FIT image in the file system.
+ * @fit:	Pointer to the copied FIT header.
+ *
+ * Reads the FIT image in the filesystem. Loads u-boot image to
+ * specified load address and copies the dtb to end of u-boot image.
+ * Returns 1 on success.
+ */
+int spl_fs_load_simple_fit(struct spl_load_info *info, const char *filename,
+			   void *fit);
+
 #define SPL_COPY_PAYLOAD_ONLY	1
 
 extern struct spl_image_info spl_image;
Signature · 1 line
2.1.4
#3 lore raw

PATCH v2 1/2 spl: Add an option to load a FIT containing U-Boot from FS

In reply to Lokesh Vutla
Quoted 156 lines · Lokesh Vutla

This provides a way to load a FIT containing U-Boot and a selection of device tree files from a File system.

---
Changes since v1:
- Added comments for function declarations.
- Bring out the common code for parsing fit header.

 common/spl/spl_fit.c | 146 +++++++++++++++++++++++++++++++++++++++++++--------
 include/spl.h        |  31 +++++++++++
 2 files changed, 154 insertions(+), 23 deletions(-)
common/spl/spl_fit.c +85 -23
index 1a5c027..a4ab67e 100644
@@ -82,12 +82,42 @@ static int spl_fit_select_fdt(const void *fdt, int images, int *fdt_offsetp)
 	return -ENOENT;
 }
 
+#define get_fit_size(fit) ALIGN(fdt_totalsize(fit), 4)
+
+static int spl_parse_fit_header(void *fit)
+{
+	int node;
+
+	spl_image.images = fdt_path_offset(fit, FIT_IMAGES_PATH);
+	if (spl_image.images < 0) {
+		debug("%s: Cannot find /images node: %d\n", __func__,
+		      spl_image.images);
+		return -1;
+	}
+	node = fdt_first_subnode(fit, spl_image.images);
+	if (node < 0) {
+		debug("%s: Cannot find first image node: %d\n", __func__, node);
+		return -1;
+	}
+
+	/* Get its information and set up the spl_image structure */
+	spl_image.data_offset = fdt_getprop_u32(fit, node, "data-offset");
+	spl_image.data_size = fdt_getprop_u32(fit, node, "data-size");
+	spl_image.load_addr = fdt_getprop_u32(fit, node, "load");
+	debug("data_offset=%x, data_size=%x\n", spl_image.data_offset,
+	      spl_image.data_size);
+	spl_image.entry_point = spl_image.load_addr;
+	spl_image.os = IH_OS_U_BOOT;
+
+	return 0;
+}
+
 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 {
 	int sectors;
 	ulong size, load;
 	unsigned long count;
-	int node, images;
+	int images, ret;
 	void *load_ptr;
 	int fdt_offset, fdt_len;
 	int data_offset, data_size;
@@ -99,9 +129,8 @@ int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 	 * Figure out where the external images start. This is the base for the
 	 * data-offset properties in each image.
 	 */
-	size = fdt_totalsize(fit);
-	size = (size + 3) & ~3;
-	base_offset = (size + 3) & ~3;
+	size = get_fit_size(fit);
+	base_offset = size;
 
 	/*
 	 * So far we only have one block of data from the FIT. Read the entire
@@ -125,26 +154,13 @@ int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 	if (count == 0)
 		return -EIO;
 
-	/* find the firmware image to load */
-	images = fdt_path_offset(fit, FIT_IMAGES_PATH);
-	if (images < 0) {
-		debug("%s: Cannot find /images node: %d\n", __func__, images);
+	ret = spl_parse_fit_header(fit);
+	if (ret < 0)
 		return -1;
-	}
-	node = fdt_first_subnode(fit, images);
-	if (node < 0) {
-		debug("%s: Cannot find first image node: %d\n", __func__, node);
-		return -1;
-	}
-
-	/* Get its information and set up the spl_image structure */
-	data_offset = fdt_getprop_u32(fit, node, "data-offset");
-	data_size = fdt_getprop_u32(fit, node, "data-size");
-	load = fdt_getprop_u32(fit, node, "load");
-	debug("data_offset=%x, data_size=%x\n", data_offset, data_size);
-	spl_image.load_addr = load;
-	spl_image.entry_point = load;
-	spl_image.os = IH_OS_U_BOOT;
+	data_offset = spl_image.data_offset;
+	data_size = spl_image.data_size;
+	load = spl_image.load_addr;
+	images = spl_image.images;
 
 	/*
 	 * Work out where to place the image. We read it so that the first
@@ -192,3 +208,87 @@ int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit)
 
 	return 0;
 }
+
+int spl_fs_load_simple_fit(struct spl_load_info *info, const char *filename,
+			   void *fit)
+{
+	ulong size, load;
+	unsigned long count;
+	int images, ret;
+	void *load_ptr;
+	int fdt_offset, fdt_len;
+	int data_offset, data_size, file_offset;
+	int base_offset = 0, align_len;
+	void *dst;
+
+	/*
+	 * Figure out where the external images start. This is the base for the
+	 * data-offset properties in each image.
+	 */
+	size = get_fit_size(fit);
+	base_offset = size;
+
+	/*
+	 * Read the entire FIT header, placing it so it finishes before
+	 * where we will load the image. Also the load address is aligned
+	 * ARCH_DMA_MINALIGN.
+	 */
+	align_len = ARCH_DMA_MINALIGN - 1;
+	fit = (void *)((CONFIG_SYS_TEXT_BASE - size - align_len) & ~align_len);
+	debug("FIT header read: destination = 0x%p, size = %lx\n", fit, size);
+	count = info->fs_read(info, filename, fit, 0, size);
+	if (count <= 0)
+		return -EIO;
+
+	ret = spl_parse_fit_header(fit);
+	if (ret < 0)
+		return -1;
+	data_offset = spl_image.data_offset;
+	data_size = spl_image.data_size;
+	load = spl_image.load_addr;
+	images = spl_image.images;
+
+	/*
+	 * Work out where to place the image. Assuming load addr of u-boot.bin
+	 * is always aligned to ARCH_DMA_MINALIGN. It is possible that file
+	 * offset is not aligned. In order to make sure that the file read is
+	 * dma aligned, align the file offset to dma with extra bytes in the
+	 * beginning. Then do a memcpy of image to dst.

common/spl/spl_fit.c int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fit) · line 266

Quoted 10 lines
common/spl/spl_fit.c +10 -0
+	 */
+	data_offset += base_offset;
+	file_offset = data_offset & ~align_len;
+	load_ptr = (void *)load;
+	dst = load_ptr;
+
+	/* Read the image */
+	debug("Temp u-boot.bin read from fit: dst = 0x%p, file offset = 0x%x, size = 0x%x\n",
+	      dst, file_offset, data_size);
+	count = info->fs_read(info, filename, dst, file_offset, data_size);

After doing a bit more testing, found a bug in the number of bytes being copied. It should be data_size + extra overhead of the file offset. Will repost it.

Thanks and regards,
Lokesh

Quoted 89 lines
common/spl/spl_fit.c +28 -0
+	if (count <= 0)
+		return -EIO;
+	debug("u-boot.bin load: dst = 0x%p, size = 0x%x\n", dst, data_size);
+	memcpy(dst, dst + (data_offset & align_len), data_size);
+
+	/* Figure out which device tree the board wants to use */
+	fdt_len = spl_fit_select_fdt(fit, images, &fdt_offset);
+	if (fdt_len < 0)
+		return fdt_len;
+
+	/*
+	 * Read the device tree and place it after the image. Making sure that
+	 * load addr and file offset are aligned to dma.
+	 */
+	dst = (void *)((load + data_size + align_len) & ~align_len);
+	fdt_offset += base_offset;
+	file_offset = fdt_offset & ~align_len;
+	debug("Temp fdt read from fit: dst = 0x%p, file offset = 0x%x, size = %d\n",
+	      dst, file_offset, data_size);
+	count = info->fs_read(info, filename, dst, file_offset, data_size);
+	if (count <= 0)
+		return -EIO;
+	debug("fdt load: dst = 0x%p, size = 0x%x\n", load_ptr + data_size,
+	      data_size);
+	memcpy(load_ptr + data_size, dst + (fdt_offset & align_len), data_size);
+
+	return 1;
+}
include/spl.h +31 -0
index de4f70a..5f0b0db 100644
@@ -27,6 +27,11 @@ struct spl_image_info {
 	u32 entry_point;
 	u32 size;
 	u32 flags;
+#ifdef CONFIG_SPL_LOAD_FIT
+	int data_offset;
+	int data_size;
+	int images;
+#endif
 };
 
 /*
@@ -36,6 +41,7 @@ struct spl_image_info {
  * @priv: Private data for the device
  * @bl_len: Block length for reading in bytes
  * @read: Function to call to read from the device
+ * @fs_read: Function to call to read from a fs
  */
 struct spl_load_info {
 	void *dev;
@@ -43,10 +49,35 @@ struct spl_load_info {
 	int bl_len;
 	ulong (*read)(struct spl_load_info *load, ulong sector, ulong count,
 		      void *buf);
+	int (*fs_read)(struct spl_load_info *load, const char *filename,
+		      void *buf, ulong file_offset, ulong size);
 };
 
+/**
+ * spl_load_simple_fit() - Loads a fit image from a device.
+ * @info:	Structure containing the information required to load data.
+ * @sector:	Sector number where FIT image is located in the device
+ * @fdt:	Pointer to the copied FIT header.
+ *
+ * Reads the FIT image @sector in the device. Loads u-boot image to
+ * specified load address and copies the dtb to end of u-boot image.
+ * Returns 0 on success.
+ */
 int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt);
 
+/**
+ * spl_fs_load_simple_fit() - Loads a fit image from a file system.
+ * @info:	Structure containing the information required to load data.
+ * @filename:	Name of the FIT image in the file system.
+ * @fit:	Pointer to the copied FIT header.
+ *
+ * Reads the FIT image in the filesystem. Loads u-boot image to
+ * specified load address and copies the dtb to end of u-boot image.
+ * Returns 1 on success.
+ */
+int spl_fs_load_simple_fit(struct spl_load_info *info, const char *filename,
+			   void *fit);
+
 #define SPL_COPY_PAYLOAD_ONLY	1
 
 extern struct spl_image_info spl_image;
#4 lore raw

PATCH v2 2/2 spl: Support loading a FIT from FAT FS

In reply to Lokesh Vutla

Detect a FIT when loading from a FAT File system and handle it using the new FIT SPL support.

---
 common/spl/spl_fat.c | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)
common/spl/spl_fat.c +25 -2
index d761b26..3784f1b 100644
@@ -39,6 +39,19 @@ static int spl_register_fat_device(struct blk_desc *block_dev, int partition)
 	return err;
 }
 
+static int h_spl_fit_read(struct spl_load_info *load, const char *filename,
+			  void *buf, ulong file_offset, ulong size)
+{
+	loff_t actread;
+	int ret;
+
+	ret = fat_read_file(filename, buf, file_offset, size, &actread);
+	if (ret)
+		return ret;
+	else
+		return actread;
+}
+
 int spl_load_image_fat(struct blk_desc *block_dev,
 						int partition,
 						const char *filename)
@@ -57,9 +70,19 @@ int spl_load_image_fat(struct blk_desc *block_dev,
 	if (err <= 0)
 		goto end;
 
-	spl_parse_image_header(header);
+	if (IS_ENABLED(CONFIG_SPL_LOAD_FIT)) {
+		struct spl_load_info load;
 
-	err = file_fat_read(filename, (u8 *)spl_image.load_addr, 0);
+		debug("Found FIT\n");
+		load.priv = NULL;
+		load.fs_read = h_spl_fit_read;
+
+		err = spl_fs_load_simple_fit(&load, filename, header);
+	} else {
+		spl_parse_image_header(header);
+
+		err = file_fat_read(filename, (u8 *)spl_image.load_addr, 0);
+	}
 
 end:
 #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
Signature · 1 line
2.1.4