[U-Boot] [RFC PATCH 0/2] 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.
Tested on DRA74-evm, DRA72-evm using the diff[1] with MMC boot mode: Logs: DRA74-evm: http://pastebin.ubuntu.com/15624158/ DRA72-evm: http://pastebin.ubuntu.com/15624165/
[1] http://pastebin.ubuntu.com/15624172/ Will be posting this diff once this approach gets accepted.
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 | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++ include/spl.h | 5 +++ 3 files changed, 126 insertions(+), 2 deletions(-)

This provides a way to load a FIT containing U-Boot and a selection of device tree files from a File system.
Signed-off-by: Lokesh Vutla lokeshvutla@ti.com --- common/spl/spl_fit.c | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++ include/spl.h | 5 +++ 2 files changed, 101 insertions(+)
diff --git a/common/spl/spl_fit.c b/common/spl/spl_fit.c index 1a5c027..4c9fe7b 100644 --- a/common/spl/spl_fit.c +++ b/common/spl/spl_fit.c @@ -192,3 +192,99 @@ 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 node, images; + 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 = fdt_totalsize(fit); + size = (size + 3) & ~3; + base_offset = (size + 3) & ~3; + + /* + * 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; + + /* find the firmware image to load */ + images = fdt_path_offset(fit, FIT_IMAGES_PATH); + if (images < 0) { + printf("%s: Cannot find /images node: %d\n", __func__, images); + return -1; + } + node = fdt_first_subnode(fit, images); + if (node < 0) { + printf("%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; + + /* + * 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; +} diff --git a/include/spl.h b/include/spl.h index de4f70a..276ca12 100644 --- a/include/spl.h +++ b/include/spl.h @@ -36,6 +36,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 + * @fd_read: Function to call to read from the a fs */ struct spl_load_info { void *dev; @@ -43,9 +44,13 @@ 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); };
int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt); +int spl_fs_load_simple_fit(struct spl_load_info *info, const char *filename, + void *fit);
#define SPL_COPY_PAYLOAD_ONLY 1

On Tue, Apr 05, 2016 at 10:00:54AM +0530, Lokesh Vutla wrote:
This provides a way to load a FIT containing U-Boot and a selection of device tree files from a File system.
Signed-off-by: Lokesh Vutla lokeshvutla@ti.com
Reviewed-by: Tom Rini trini@konsulko.com

Hi Lokesh,
On 4 April 2016 at 22:30, Lokesh Vutla lokeshvutla@ti.com wrote:
This provides a way to load a FIT containing U-Boot and a selection of device tree files from a File system.
Signed-off-by: Lokesh Vutla lokeshvutla@ti.com
common/spl/spl_fit.c | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++ include/spl.h | 5 +++ 2 files changed, 101 insertions(+)
diff --git a/common/spl/spl_fit.c b/common/spl/spl_fit.c index 1a5c027..4c9fe7b 100644 --- a/common/spl/spl_fit.c +++ b/common/spl/spl_fit.c @@ -192,3 +192,99 @@ 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 node, images;
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 = fdt_totalsize(fit);
size = (size + 3) & ~3;
base_offset = (size + 3) & ~3;
Can you please refactor this to share code with spl_load_simple_fit() where possible?
/*
* 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;
/* find the firmware image to load */
images = fdt_path_offset(fit, FIT_IMAGES_PATH);
if (images < 0) {
printf("%s: Cannot find /images node: %d\n", __func__, images);
return -1;
}
node = fdt_first_subnode(fit, images);
if (node < 0) {
printf("%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;
/*
* 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;
+} diff --git a/include/spl.h b/include/spl.h index de4f70a..276ca12 100644 --- a/include/spl.h +++ b/include/spl.h @@ -36,6 +36,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
*/
- @fd_read: Function to call to read from the a fs
struct spl_load_info { void *dev; @@ -43,9 +44,13 @@ 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);
};
int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt); +int spl_fs_load_simple_fit(struct spl_load_info *info, const char *filename,
void *fit);
Please add a function comment (which apparently I missed also :-)
#define SPL_COPY_PAYLOAD_ONLY 1
-- 2.1.4
Regards, Simon

Hi Simon,
On Sunday 10 April 2016 12:05 AM, Simon Glass wrote:
Hi Lokesh,
On 4 April 2016 at 22:30, Lokesh Vutla lokeshvutla@ti.com wrote:
This provides a way to load a FIT containing U-Boot and a selection of device tree files from a File system.
Signed-off-by: Lokesh Vutla lokeshvutla@ti.com
common/spl/spl_fit.c | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++ include/spl.h | 5 +++ 2 files changed, 101 insertions(+)
diff --git a/common/spl/spl_fit.c b/common/spl/spl_fit.c index 1a5c027..4c9fe7b 100644 --- a/common/spl/spl_fit.c +++ b/common/spl/spl_fit.c @@ -192,3 +192,99 @@ 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 node, images;
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 = fdt_totalsize(fit);
size = (size + 3) & ~3;
base_offset = (size + 3) & ~3;
Can you please refactor this to share code with spl_load_simple_fit() where possible?
Sure.
/*
* 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;
/* find the firmware image to load */
images = fdt_path_offset(fit, FIT_IMAGES_PATH);
if (images < 0) {
printf("%s: Cannot find /images node: %d\n", __func__, images);
return -1;
}
node = fdt_first_subnode(fit, images);
if (node < 0) {
printf("%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;
/*
* 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;
+} diff --git a/include/spl.h b/include/spl.h index de4f70a..276ca12 100644 --- a/include/spl.h +++ b/include/spl.h @@ -36,6 +36,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
*/
- @fd_read: Function to call to read from the a fs
struct spl_load_info { void *dev; @@ -43,9 +44,13 @@ 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);
};
int spl_load_simple_fit(struct spl_load_info *info, ulong sector, void *fdt); +int spl_fs_load_simple_fit(struct spl_load_info *info, const char *filename,
void *fit);
Please add a function comment (which apparently I missed also :-)
Will add it in next version.
Just posted an updated series :)
Thanks and regards, Lokesh
#define SPL_COPY_PAYLOAD_ONLY 1
-- 2.1.4
Regards, Simon

Detect a FIT when loading from a FAT File system and handle it using the new FIT SPL support.
Signed-off-by: Lokesh Vutla lokeshvutla@ti.com --- common/spl/spl_fat.c | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-)
diff --git a/common/spl/spl_fat.c b/common/spl/spl_fat.c index d761b26..3784f1b 100644 --- a/common/spl/spl_fat.c +++ b/common/spl/spl_fat.c @@ -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

On Tue, Apr 05, 2016 at 10:00:55AM +0530, Lokesh Vutla wrote:
Detect a FIT when loading from a FAT File system and handle it using the new FIT SPL support.
Signed-off-by: Lokesh Vutla lokeshvutla@ti.com
Reviewed-by: Tom Rini trini@konsulko.com

On 4 April 2016 at 22:30, Lokesh Vutla lokeshvutla@ti.com wrote:
Detect a FIT when loading from a FAT File system and handle it using the new FIT SPL support.
Signed-off-by: Lokesh Vutla lokeshvutla@ti.com
common/spl/spl_fat.c | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-)
Nice!
Reviewed-by: Simon Glass sjg@chromium.org
participants (3)
-
Lokesh Vutla
-
Simon Glass
-
Tom Rini