[PATCH v4 0/9] spl: Use common function for loading/parsing images
This series adds support for loading all image types (Legacy, FIT (with and without LOAD_FIT_FULL), and i.MX) to the MMC, SPI, NOR, NET, FAT, and EXT load methods. It does this by introducing a helper function which handles the minutiae of invoking the proper parsing function, and reading the rest of the image.
Hopefully, this will make it easier for load methods to support all image types that U-Boot supports, without having undocumented unsupported image types. I applied this to several loaders which were invoking spl_load_simple_fit and/or spl_parse_image_header, but I did not use it with others (e.g. DFU/RAM) which had complications in the mix.
Here's some bloat-o-meter for j7200_evm_a72_defconfig with ext4 support enabled:
add/remove: 1/0 grow/shrink: 2/4 up/down: 356/-260 (96) Function old new delta spl_load - 308 +308 spl_fit_read 60 104 +44 spl_load_image_ext 364 368 +4 spl_nor_load_image 120 108 -12 spl_load_image_fat 320 256 -64 spl_spi_load_image 304 236 -68 spl_mmc_load 716 600 -116 Total: Before=233350, After=233446, chg +0.04%
ext4 support is +48 bytes, because the original image support was so bare-bones (just legacy/raw images). For most boards with a few load methods (where one of them isn't ext4), this series should be +100 bytes. However, in the worst case this series will add 300 bytes.
I have only tested EXT, FAT, and MMC raw loaders. Please try booting your favorite board with NOR/SPI flash or SPI falcon mode.
Changes in v4: - Fix format specifiers in debug prints - Reword/fix some of the doc comments for spl_load - Rebase on u-boot/master
Changes in v3: - Fix using ffs instead of fls - Fix using not initializing bl_len when info->filename was NULL - Fix failing on success
Changes in v2: - Use reverse-xmas-tree style for locals in spl_simple_read. This is not complete, since overhead depends on bl_mask. - Convert semihosting as well - Consolidate spi_load_image_os into spl_spi_load_image
Sean Anderson (9): spl: Add generic spl_load function spl: Convert ext to use spl_load spl: Convert fat to spl_load spl: Convert mmc to spl_load spl: Convert net to spl_load spl: Convert nor to spl_load spl: Convert semihosting to spl_load spl: Convert spi to spl_load spl: spi: Consolidate spi_load_image_os into spl_spi_load_image
common/spl/spl.c | 68 ++++++++++++++++++ common/spl/spl_ext.c | 24 +++++-- common/spl/spl_fat.c | 40 +++-------- common/spl/spl_mmc.c | 73 ++----------------- common/spl/spl_net.c | 24 ++----- common/spl/spl_nor.c | 39 ++-------- common/spl/spl_semihosting.c | 39 +++++----- common/spl/spl_spi.c | 136 ++++++++++------------------------- include/spl.h | 29 +++++++- 9 files changed, 192 insertions(+), 280 deletions(-)
Implementers of SPL_LOAD_IMAGE_METHOD have to correctly determine what type of image is being loaded and then call the appropriate image load function correctly. This is tricky, because some image load functions expect the whole image to already be loaded (CONFIG_SPL_LOAD_FIT_FULL), some will load the image automatically using spl_load_info.read() (CONFIG_SPL_LOAD_FIT/CONFIG_SPL_LOAD_IMX_CONTAINER), and some just parse the header and expect the caller to do the actual loading afterwards (legacy/raw images). Load methods often only support a subset of the above methods, meaning that not all image types can be used with all load methods. Further, the code to invoke these functions is duplicated between different load functions.
To address this problem, this commit introduces a "spl_load" function. It aims to handle image detection and correct invocation of each of the parse/load functions. spl_simple_read is a wrapper around spl_load_info.read with get_aligned_image* functions inlined for size purposes. Additionally, we assume that bl_len is a power of 2 so we can do bitshifts instead of divisions (which is smaller and faster).
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de ---
Changes in v4: - Fix format specifiers in debug prints - Reword/fix some of the doc comments for spl_load
Changes in v3: - Fix using ffs instead of fls - Fix using not initializing bl_len when info->filename was NULL
Changes in v2: - Use reverse-xmas-tree style for locals in spl_simple_read. This is not complete, since overhead depends on bl_mask.
common/spl/spl.c | 68 ++++++++++++++++++++++++++++++++++++++++++++++++ include/spl.h | 29 ++++++++++++++++++++- 2 files changed, 96 insertions(+), 1 deletion(-)
diff --git a/common/spl/spl.c b/common/spl/spl.c index f09bb977814..3ef064009e8 100644 --- a/common/spl/spl.c +++ b/common/spl/spl.c @@ -450,6 +450,74 @@ int spl_parse_image_header(struct spl_image_info *spl_image, return 0; }
+static int spl_simple_read(struct spl_load_info *info, void *buf, size_t size, + size_t offset) +{ + size_t bl_len = info->filename ? ARCH_DMA_MINALIGN : info->bl_len; + size_t bl_mask = bl_len - 1; + size_t overhead = offset & bl_mask; + size_t bl_shift = fls(bl_mask); + int ret; + + debug("%s: buf=%p size=%lx offset=%lx\n", __func__, buf, (long)size, + (long)offset); + debug("%s: bl_len=%lx bl_mask=%lx bl_shift=%lx\n", __func__, (long)bl_len, + (long)bl_mask, (long)bl_shift); + + buf -= overhead; + size = (size + overhead + bl_mask) >> bl_shift; + offset = offset >> bl_shift; + + debug("info->read(info, %lx, %lx, %p)\n", (ulong)offset, (ulong)size, + buf); + ret = info->read(info, offset, size, buf); + return ret == size ? 0 : -EIO; +} + +int spl_load(struct spl_image_info *spl_image, + const struct spl_boot_device *bootdev, struct spl_load_info *info, + struct legacy_img_hdr *header, size_t size, size_t sector) +{ + int ret; + size_t offset = sector * info->bl_len; + + if (image_get_magic(header) == FDT_MAGIC) { + if (IS_ENABLED(CONFIG_SPL_LOAD_FIT_FULL)) { + void *buf; + + /* + * In order to support verifying images in the FIT, we + * need to load the whole FIT into memory. Try and + * guess how much we need to load by using the total + * size. This will fail for FITs with external data, + * but there's not much we can do about that. + */ + if (!size) + size = roundup(fdt_totalsize(header), 4); + buf = spl_get_load_buffer(0, size); + ret = spl_simple_read(info, buf, size, offset); + if (ret) + return ret; + + return spl_parse_image_header(spl_image, bootdev, buf); + } + + if (IS_ENABLED(CONFIG_SPL_LOAD_FIT)) + return spl_load_simple_fit(spl_image, info, sector, + header); + } + + if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER)) + return spl_load_imx_container(spl_image, info, sector); + + ret = spl_parse_image_header(spl_image, bootdev, header); + if (ret) + return ret; + + return spl_simple_read(info, (void *)spl_image->load_addr, + spl_image->size, offset + spl_image->offset); +} + __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image) { typedef void __noreturn (*image_entry_noargs_t)(void); diff --git a/include/spl.h b/include/spl.h index 92bcaa90a4a..06b34e70a44 100644 --- a/include/spl.h +++ b/include/spl.h @@ -268,7 +268,7 @@ struct spl_image_info { * * @dev: Pointer to the device, e.g. struct mmc * * @priv: Private data for the device - * @bl_len: Block length for reading in bytes + * @bl_len: Block length for reading in bytes; must be a power of 2 * @filename: Name of the fit image file. * @read: Function to call to read from the device */ @@ -677,6 +677,33 @@ int spl_blk_load_image(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, enum uclass_id uclass_id, int devnum, int partnum);
+/** + * spl_load() - Parse a header and load the image + * @spl_image: Image data which will be filled in by this function + * @bootdev: The device to load from + * @info: Describes how to load additional information from @bootdev. At the + * minimum, read() and bl_len must be populated. + * @header: The image header. This should already have been loaded. It may be + * clobbered by the load process (if e.g. the load address overlaps). + * @size: The size of the image, in bytes, if it is known in advance. Some boot + * devices (such as filesystems) know how big an image is before parsing + * the header. If 0, then the size will be determined from the header. + * @sectors: The offset from the start of @bootdev, in units of @info->bl_len. + * This should have the offset @header was loaded from. It will be + * added to any offsets passed to @info->read(). + * + * This function determines the image type (FIT, legacy, i.MX, raw, etc), calls + * the appropriate parsing function, determines the load address, and the loads + * the image from storage. It is designed to replace ad-hoc image loading which + * may not support all image types (especially when config options are + * involved). + * + * Return: 0 on success, or a negative error on failure + */ +int spl_load(struct spl_image_info *spl_image, + const struct spl_boot_device *bootdev, struct spl_load_info *info, + struct legacy_img_hdr *header, size_t size, size_t sector); + /** * spl_early_init() - Set up device tree and driver model in SPL if enabled *
On 7/24/23 19:12, Sean Anderson wrote:
Implementers of SPL_LOAD_IMAGE_METHOD have to correctly determine what type of image is being loaded and then call the appropriate image load function correctly. This is tricky, because some image load functions expect the whole image to already be loaded (CONFIG_SPL_LOAD_FIT_FULL), some will load the image automatically using spl_load_info.read() (CONFIG_SPL_LOAD_FIT/CONFIG_SPL_LOAD_IMX_CONTAINER), and some just parse the header and expect the caller to do the actual loading afterwards (legacy/raw images). Load methods often only support a subset of the above methods, meaning that not all image types can be used with all load methods. Further, the code to invoke these functions is duplicated between different load functions.
To address this problem, this commit introduces a "spl_load" function. It aims to handle image detection and correct invocation of each of the parse/load functions. spl_simple_read is a wrapper around spl_load_info.read with get_aligned_image* functions inlined for size purposes. Additionally, we assume that bl_len is a power of 2 so we can do bitshifts instead of divisions (which is smaller and faster).
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de
Changes in v4:
- Fix format specifiers in debug prints
- Reword/fix some of the doc comments for spl_load
Changes in v3:
- Fix using ffs instead of fls
- Fix using not initializing bl_len when info->filename was NULL
Changes in v2:
Use reverse-xmas-tree style for locals in spl_simple_read. This is not complete, since overhead depends on bl_mask.
common/spl/spl.c | 68 ++++++++++++++++++++++++++++++++++++++++++++++++ include/spl.h | 29 ++++++++++++++++++++- 2 files changed, 96 insertions(+), 1 deletion(-)
diff --git a/common/spl/spl.c b/common/spl/spl.c index f09bb977814..3ef064009e8 100644 --- a/common/spl/spl.c +++ b/common/spl/spl.c @@ -450,6 +450,74 @@ int spl_parse_image_header(struct spl_image_info *spl_image, return 0; }
+static int spl_simple_read(struct spl_load_info *info, void *buf, size_t size,
size_t offset)+{
- size_t bl_len = info->filename ? ARCH_DMA_MINALIGN : info->bl_len;
- size_t bl_mask = bl_len - 1;
- size_t overhead = offset & bl_mask;
- size_t bl_shift = fls(bl_mask);
- int ret;
- debug("%s: buf=%p size=%lx offset=%lx\n", __func__, buf, (long)size,
(long)offset);- debug("%s: bl_len=%lx bl_mask=%lx bl_shift=%lx\n", __func__, (long)bl_len,
(long)bl_mask, (long)bl_shift);- buf -= overhead;
- size = (size + overhead + bl_mask) >> bl_shift;
- offset = offset >> bl_shift;
- debug("info->read(info, %lx, %lx, %p)\n", (ulong)offset, (ulong)size,
buf);- ret = info->read(info, offset, size, buf);
- return ret == size ? 0 : -EIO;
+}
+int spl_load(struct spl_image_info *spl_image,
const struct spl_boot_device *bootdev, struct spl_load_info *info,struct legacy_img_hdr *header, size_t size, size_t sector)
Hello Sean,
carving out common functionality is really a good path forward.
This function spl_load() receives a pointer to a read function in info->read() and additionally the file header.
Why can't we move the reading of the header to spl_load() too?
Best regards
Heinrich
+{
- int ret;
- size_t offset = sector * info->bl_len;
- if (image_get_magic(header) == FDT_MAGIC) {
if (IS_ENABLED(CONFIG_SPL_LOAD_FIT_FULL)) {void *buf;/** In order to support verifying images in the FIT, we* need to load the whole FIT into memory. Try and* guess how much we need to load by using the total* size. This will fail for FITs with external data,* but there's not much we can do about that.*/if (!size)size = roundup(fdt_totalsize(header), 4);buf = spl_get_load_buffer(0, size);ret = spl_simple_read(info, buf, size, offset);if (ret)return ret;return spl_parse_image_header(spl_image, bootdev, buf);}if (IS_ENABLED(CONFIG_SPL_LOAD_FIT))return spl_load_simple_fit(spl_image, info, sector,header);- }
- if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER))
return spl_load_imx_container(spl_image, info, sector);- ret = spl_parse_image_header(spl_image, bootdev, header);
- if (ret)
return ret;- return spl_simple_read(info, (void *)spl_image->load_addr,
spl_image->size, offset + spl_image->offset);+}
- __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image) { typedef void __noreturn (*image_entry_noargs_t)(void);
diff --git a/include/spl.h b/include/spl.h index 92bcaa90a4a..06b34e70a44 100644 --- a/include/spl.h +++ b/include/spl.h @@ -268,7 +268,7 @@ struct spl_image_info {
- @dev: Pointer to the device, e.g. struct mmc *
- @priv: Private data for the device
- @bl_len: Block length for reading in bytes
*/
- @bl_len: Block length for reading in bytes; must be a power of 2
- @filename: Name of the fit image file.
- @read: Function to call to read from the device
@@ -677,6 +677,33 @@ int spl_blk_load_image(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, enum uclass_id uclass_id, int devnum, int partnum);
+/**
- spl_load() - Parse a header and load the image
- @spl_image: Image data which will be filled in by this function
- @bootdev: The device to load from
- @info: Describes how to load additional information from @bootdev. At the
minimum, read() and bl_len must be populated.
- @header: The image header. This should already have been loaded. It may be
clobbered by the load process (if e.g. the load address overlaps).
- @size: The size of the image, in bytes, if it is known in advance. Some boot
devices (such as filesystems) know how big an image is before parsing
the header. If 0, then the size will be determined from the header.
- @sectors: The offset from the start of @bootdev, in units of @info->bl_len.
This should have the offset @header was loaded from. It will be
added to any offsets passed to @info->read().
- This function determines the image type (FIT, legacy, i.MX, raw, etc), calls
- the appropriate parsing function, determines the load address, and the loads
- the image from storage. It is designed to replace ad-hoc image loading which
- may not support all image types (especially when config options are
- involved).
- Return: 0 on success, or a negative error on failure
- */
+int spl_load(struct spl_image_info *spl_image,
const struct spl_boot_device *bootdev, struct spl_load_info *info,struct legacy_img_hdr *header, size_t size, size_t sector);- /**
- spl_early_init() - Set up device tree and driver model in SPL if enabled
On 7/27/23 02:17, Heinrich Schuchardt wrote:
On 7/24/23 19:12, Sean Anderson wrote:
Implementers of SPL_LOAD_IMAGE_METHOD have to correctly determine what type of image is being loaded and then call the appropriate image load function correctly. This is tricky, because some image load functions expect the whole image to already be loaded (CONFIG_SPL_LOAD_FIT_FULL), some will load the image automatically using spl_load_info.read() (CONFIG_SPL_LOAD_FIT/CONFIG_SPL_LOAD_IMX_CONTAINER), and some just parse the header and expect the caller to do the actual loading afterwards (legacy/raw images). Load methods often only support a subset of the above methods, meaning that not all image types can be used with all load methods. Further, the code to invoke these functions is duplicated between different load functions.
To address this problem, this commit introduces a "spl_load" function. It aims to handle image detection and correct invocation of each of the parse/load functions. spl_simple_read is a wrapper around spl_load_info.read with get_aligned_image* functions inlined for size purposes. Additionally, we assume that bl_len is a power of 2 so we can do bitshifts instead of divisions (which is smaller and faster).
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de
Changes in v4:
- Fix format specifiers in debug prints
- Reword/fix some of the doc comments for spl_load
Changes in v3:
- Fix using ffs instead of fls
- Fix using not initializing bl_len when info->filename was NULL
Changes in v2:
- Use reverse-xmas-tree style for locals in spl_simple_read. This is not
complete, since overhead depends on bl_mask.
common/spl/spl.c | 68 ++++++++++++++++++++++++++++++++++++++++++++++++ include/spl.h | 29 ++++++++++++++++++++- 2 files changed, 96 insertions(+), 1 deletion(-)
diff --git a/common/spl/spl.c b/common/spl/spl.c index f09bb977814..3ef064009e8 100644 --- a/common/spl/spl.c +++ b/common/spl/spl.c @@ -450,6 +450,74 @@ int spl_parse_image_header(struct spl_image_info *spl_image, return 0; }
+static int spl_simple_read(struct spl_load_info *info, void *buf, size_t size, + size_t offset) +{ + size_t bl_len = info->filename ? ARCH_DMA_MINALIGN : info->bl_len; + size_t bl_mask = bl_len - 1; + size_t overhead = offset & bl_mask; + size_t bl_shift = fls(bl_mask); + int ret;
+ debug("%s: buf=%p size=%lx offset=%lx\n", __func__, buf, (long)size, + (long)offset); + debug("%s: bl_len=%lx bl_mask=%lx bl_shift=%lx\n", __func__, (long)bl_len, + (long)bl_mask, (long)bl_shift);
+ buf -= overhead; + size = (size + overhead + bl_mask) >> bl_shift; + offset = offset >> bl_shift;
+ debug("info->read(info, %lx, %lx, %p)\n", (ulong)offset, (ulong)size, + buf); + ret = info->read(info, offset, size, buf); + return ret == size ? 0 : -EIO; +}
+int spl_load(struct spl_image_info *spl_image, + const struct spl_boot_device *bootdev, struct spl_load_info *info, + struct legacy_img_hdr *header, size_t size, size_t sector)
Hello Sean,
carving out common functionality is really a good path forward.
This function spl_load() receives a pointer to a read function in info->read() and additionally the file header.
Why can't we move the reading of the header to spl_load() too?
That looks promising. The only downside is that FAT grows a bit since we can't determine the file size when we load the whole image.
--Sean
+{ + int ret; + size_t offset = sector * info->bl_len;
+ if (image_get_magic(header) == FDT_MAGIC) { + if (IS_ENABLED(CONFIG_SPL_LOAD_FIT_FULL)) { + void *buf;
+ /* + * In order to support verifying images in the FIT, we + * need to load the whole FIT into memory. Try and + * guess how much we need to load by using the total + * size. This will fail for FITs with external data, + * but there's not much we can do about that. + */ + if (!size) + size = roundup(fdt_totalsize(header), 4); + buf = spl_get_load_buffer(0, size); + ret = spl_simple_read(info, buf, size, offset); + if (ret) + return ret;
+ return spl_parse_image_header(spl_image, bootdev, buf); + }
+ if (IS_ENABLED(CONFIG_SPL_LOAD_FIT)) + return spl_load_simple_fit(spl_image, info, sector, + header); + }
+ if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER)) + return spl_load_imx_container(spl_image, info, sector);
+ ret = spl_parse_image_header(spl_image, bootdev, header); + if (ret) + return ret;
+ return spl_simple_read(info, (void *)spl_image->load_addr, + spl_image->size, offset + spl_image->offset); +}
__weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image) { typedef void __noreturn (*image_entry_noargs_t)(void); diff --git a/include/spl.h b/include/spl.h index 92bcaa90a4a..06b34e70a44 100644 --- a/include/spl.h +++ b/include/spl.h @@ -268,7 +268,7 @@ struct spl_image_info { * * @dev: Pointer to the device, e.g. struct mmc * * @priv: Private data for the device
- @bl_len: Block length for reading in bytes
- @bl_len: Block length for reading in bytes; must be a power of 2
* @filename: Name of the fit image file. * @read: Function to call to read from the device */ @@ -677,6 +677,33 @@ int spl_blk_load_image(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, enum uclass_id uclass_id, int devnum, int partnum);
+/**
- spl_load() - Parse a header and load the image
- @spl_image: Image data which will be filled in by this function
- @bootdev: The device to load from
- @info: Describes how to load additional information from @bootdev. At the
- * minimum, read() and bl_len must be populated.
- @header: The image header. This should already have been loaded. It may be
- * clobbered by the load process (if e.g. the load address overlaps).
- @size: The size of the image, in bytes, if it is known in advance. Some boot
- * devices (such as filesystems) know how big an image is before parsing
- * the header. If 0, then the size will be determined from the header.
- @sectors: The offset from the start of @bootdev, in units of @info->bl_len.
- * This should have the offset @header was loaded from. It will be
- * added to any offsets passed to @info->read().
- This function determines the image type (FIT, legacy, i.MX, raw, etc), calls
- the appropriate parsing function, determines the load address, and the loads
- the image from storage. It is designed to replace ad-hoc image loading which
- may not support all image types (especially when config options are
- involved).
- Return: 0 on success, or a negative error on failure
- */
+int spl_load(struct spl_image_info *spl_image, + const struct spl_boot_device *bootdev, struct spl_load_info *info, + struct legacy_img_hdr *header, size_t size, size_t sector);
/** * spl_early_init() - Set up device tree and driver model in SPL if enabled *
This converts the ext load method to use spl_load. As a consequence, it also adds support for FIT and IMX images.
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de ---
(no changes since v1)
common/spl/spl_ext.c | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-)
diff --git a/common/spl/spl_ext.c b/common/spl/spl_ext.c index 2bf34344391..2c3079c3aff 100644 --- a/common/spl/spl_ext.c +++ b/common/spl/spl_ext.c @@ -9,6 +9,18 @@ #include <errno.h> #include <image.h>
+static ulong spl_fit_read(struct spl_load_info *load, ulong file_offset, + ulong size, void *buf) +{ + int ret; + loff_t actlen; + + ret = ext4fs_read(buf, file_offset, size, &actlen); + if (ret) + return ret; + return actlen; +} + int spl_load_image_ext(struct spl_image_info *spl_image, struct spl_boot_device *bootdev, struct blk_desc *block_dev, int partition, @@ -18,6 +30,10 @@ int spl_load_image_ext(struct spl_image_info *spl_image, struct legacy_img_hdr *header; loff_t filelen, actlen; struct disk_partition part_info = {}; + struct spl_load_info load = { + .read = spl_fit_read, + .bl_len = 1, + };
header = spl_get_load_buffer(-sizeof(*header), sizeof(*header));
@@ -47,13 +63,7 @@ int spl_load_image_ext(struct spl_image_info *spl_image, goto end; }
- err = spl_parse_image_header(spl_image, bootdev, header); - if (err < 0) { - puts("spl: ext: failed to parse image header\n"); - goto end; - } - - err = ext4fs_read((char *)spl_image->load_addr, 0, filelen, &actlen); + err = spl_load(spl_image, bootdev, &load, header, filelen, 0);
end: #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
This converts the fat loader to use spl_load.
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de ---
(no changes since v3)
Changes in v3: - Fix failing on success
common/spl/spl_fat.c | 40 ++++++++-------------------------------- 1 file changed, 8 insertions(+), 32 deletions(-)
diff --git a/common/spl/spl_fat.c b/common/spl/spl_fat.c index f8a5b80a3bd..d04a5575409 100644 --- a/common/spl/spl_fat.c +++ b/common/spl/spl_fat.c @@ -61,6 +61,11 @@ int spl_load_image_fat(struct spl_image_info *spl_image, { int err; struct legacy_img_hdr *header; + struct spl_load_info load = { + .read = spl_fit_read, + .bl_len = 1, + .filename = filename, + };
err = spl_register_fat_device(block_dev, partition); if (err) @@ -72,45 +77,16 @@ int spl_load_image_fat(struct spl_image_info *spl_image, if (err <= 0) goto end;
- if (IS_ENABLED(CONFIG_SPL_LOAD_FIT_FULL) && - image_get_magic(header) == FDT_MAGIC) { - err = file_fat_read(filename, (void *)CONFIG_SYS_LOAD_ADDR, 0); - if (err <= 0) - goto end; - err = spl_parse_image_header(spl_image, bootdev, - (struct legacy_img_hdr *)CONFIG_SYS_LOAD_ADDR); - if (err == -EAGAIN) - return err; - if (err == 0) - err = 1; - } else if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) && - image_get_magic(header) == FDT_MAGIC) { - struct spl_load_info load; - - debug("Found FIT\n"); - load.read = spl_fit_read; - load.bl_len = 1; - load.filename = (void *)filename; - load.priv = NULL; - - return spl_load_simple_fit(spl_image, &load, 0, header); - } else { - err = spl_parse_image_header(spl_image, bootdev, header); - if (err) - goto end; - - err = file_fat_read(filename, - (u8 *)(uintptr_t)spl_image->load_addr, 0); - } + err = spl_load(spl_image, bootdev, &load, header, err, 0);
end: #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT - if (err <= 0) + if (err < 0) printf("%s: error reading image %s, err - %d\n", __func__, filename, err); #endif
- return (err <= 0); + return err; }
#if CONFIG_IS_ENABLED(OS_BOOT)
This converts the mmc loader to spl_load. Legacy images are handled by spl_load (via spl_parse_image_header), so mmc_load_legacy can be omitted.
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de ---
(no changes since v1)
common/spl/spl_mmc.c | 73 ++++---------------------------------------- 1 file changed, 6 insertions(+), 67 deletions(-)
diff --git a/common/spl/spl_mmc.c b/common/spl/spl_mmc.c index a665091b00f..8f3cda08ec6 100644 --- a/common/spl/spl_mmc.c +++ b/common/spl/spl_mmc.c @@ -17,48 +17,6 @@ #include <mmc.h> #include <image.h>
-static int mmc_load_legacy(struct spl_image_info *spl_image, - struct spl_boot_device *bootdev, - struct mmc *mmc, - ulong sector, struct legacy_img_hdr *header) -{ - u32 image_offset_sectors; - u32 image_size_sectors; - unsigned long count; - u32 image_offset; - int ret; - - ret = spl_parse_image_header(spl_image, bootdev, header); - if (ret) - return ret; - - /* convert offset to sectors - round down */ - image_offset_sectors = spl_image->offset / mmc->read_bl_len; - /* calculate remaining offset */ - image_offset = spl_image->offset % mmc->read_bl_len; - - /* convert size to sectors - round up */ - image_size_sectors = (spl_image->size + mmc->read_bl_len - 1) / - mmc->read_bl_len; - - /* Read the header too to avoid extra memcpy */ - count = blk_dread(mmc_get_blk_desc(mmc), - sector + image_offset_sectors, - image_size_sectors, - (void *)(ulong)spl_image->load_addr); - debug("read %x sectors to %lx\n", image_size_sectors, - spl_image->load_addr); - if (count != image_size_sectors) - return -EIO; - - if (image_offset) - memmove((void *)(ulong)spl_image->load_addr, - (void *)(ulong)spl_image->load_addr + image_offset, - spl_image->size); - - return 0; -} - static ulong h_spl_load_read(struct spl_load_info *load, ulong sector, ulong count, void *buf) { @@ -86,6 +44,11 @@ int mmc_load_image_raw_sector(struct spl_image_info *spl_image, struct legacy_img_hdr *header; struct blk_desc *bd = mmc_get_blk_desc(mmc); int ret = 0; + struct spl_load_info load = { + .dev = mmc, + .bl_len = mmc->read_bl_len, + .read = h_spl_load_read, + };
header = spl_get_load_buffer(-sizeof(*header), bd->blksz);
@@ -97,31 +60,7 @@ int mmc_load_image_raw_sector(struct spl_image_info *spl_image, goto end; }
- if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) && - image_get_magic(header) == FDT_MAGIC) { - struct spl_load_info load; - - debug("Found FIT\n"); - load.dev = mmc; - load.priv = NULL; - load.filename = NULL; - load.bl_len = mmc->read_bl_len; - load.read = h_spl_load_read; - ret = spl_load_simple_fit(spl_image, &load, sector, header); - } else if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER)) { - struct spl_load_info load; - - load.dev = mmc; - load.priv = NULL; - load.filename = NULL; - load.bl_len = mmc->read_bl_len; - load.read = h_spl_load_read; - - ret = spl_load_imx_container(spl_image, &load, sector); - } else { - ret = mmc_load_legacy(spl_image, bootdev, mmc, sector, header); - } - + ret = spl_load(spl_image, bootdev, &load, header, 0, sector); end: if (ret) { #ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
This converts the net load method to use spl_load. As a result, it also adds support for LOAD_FIT_FULL and IMX images.
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de ---
(no changes since v1)
common/spl/spl_net.c | 24 +++++------------------- 1 file changed, 5 insertions(+), 19 deletions(-)
diff --git a/common/spl/spl_net.c b/common/spl/spl_net.c index b2c901b554b..561cad8a1ff 100644 --- a/common/spl/spl_net.c +++ b/common/spl/spl_net.c @@ -29,6 +29,10 @@ static int spl_net_load_image(struct spl_image_info *spl_image, struct spl_boot_device *bootdev) { struct legacy_img_hdr *header = (struct legacy_img_hdr *)image_load_addr; + struct spl_load_info load = { + .bl_len = 1, + .read = spl_net_load_read, + }; int rv;
env_init(); @@ -47,25 +51,7 @@ static int spl_net_load_image(struct spl_image_info *spl_image, return rv; }
- if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) && - image_get_magic(header) == FDT_MAGIC) { - struct spl_load_info load; - - debug("Found FIT\n"); - load.bl_len = 1; - load.read = spl_net_load_read; - rv = spl_load_simple_fit(spl_image, &load, 0, header); - } else { - debug("Legacy image\n"); - - rv = spl_parse_image_header(spl_image, bootdev, header); - if (rv) - return rv; - - memcpy((void *)spl_image->load_addr, header, spl_image->size); - } - - return rv; + return spl_load(spl_image, bootdev, &load, header, 0, 0); } #endif
This converts the nor load method to use spl_load. As a result it also adds support for LOAD_FIT_FULL.
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de ---
(no changes since v1)
common/spl/spl_nor.c | 39 ++++++--------------------------------- 1 file changed, 6 insertions(+), 33 deletions(-)
diff --git a/common/spl/spl_nor.c b/common/spl/spl_nor.c index 5b65b96a77d..1561a9b22ac 100644 --- a/common/spl/spl_nor.c +++ b/common/spl/spl_nor.c @@ -26,8 +26,11 @@ unsigned long __weak spl_nor_get_uboot_base(void) static int spl_nor_load_image(struct spl_image_info *spl_image, struct spl_boot_device *bootdev) { - __maybe_unused const struct legacy_img_hdr *header; - __maybe_unused struct spl_load_info load; + struct legacy_img_hdr *header = (void *)spl_nor_get_uboot_base(); + struct spl_load_info load = { + .bl_len = 1, + .read = spl_nor_load_read, + };
/* * Loading of the payload to SDRAM is done with skipping of @@ -91,36 +94,6 @@ static int spl_nor_load_image(struct spl_image_info *spl_image, * Load real U-Boot from its location in NOR flash to its * defined location in SDRAM */ -#ifdef CONFIG_SPL_LOAD_FIT - header = (const struct legacy_img_hdr *)spl_nor_get_uboot_base(); - if (image_get_magic(header) == FDT_MAGIC) { - debug("Found FIT format U-Boot\n"); - load.bl_len = 1; - load.read = spl_nor_load_read; - return spl_load_simple_fit(spl_image, &load, - spl_nor_get_uboot_base(), - (void *)header); - } -#endif - if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER)) { - load.bl_len = 1; - load.read = spl_nor_load_read; - return spl_load_imx_container(spl_image, &load, - spl_nor_get_uboot_base()); - } - - /* Legacy image handling */ - if (IS_ENABLED(CONFIG_SPL_LEGACY_IMAGE_FORMAT)) { - struct legacy_img_hdr hdr; - - load.bl_len = 1; - load.read = spl_nor_load_read; - spl_nor_load_read(&load, spl_nor_get_uboot_base(), sizeof(hdr), &hdr); - return spl_load_legacy_img(spl_image, bootdev, &load, - spl_nor_get_uboot_base(), - &hdr); - } - - return -EINVAL; + return spl_load(spl_image, bootdev, &load, header, 0, 0); } SPL_LOAD_IMAGE_METHOD("NOR", 0, BOOT_DEVICE_NOR, spl_nor_load_image);
This converts the semihosting load method to use spl_load. As a result, it also adds support for LOAD_FIT_FULL and IMX images.
Signed-off-by: Sean Anderson sean.anderson@seco.com ---
(no changes since v2)
Changes in v2: - New
common/spl/spl_semihosting.c | 39 +++++++++++++++--------------------- 1 file changed, 16 insertions(+), 23 deletions(-)
diff --git a/common/spl/spl_semihosting.c b/common/spl/spl_semihosting.c index 5b5e842a11b..65e7089c5e9 100644 --- a/common/spl/spl_semihosting.c +++ b/common/spl/spl_semihosting.c @@ -9,16 +9,16 @@ #include <semihosting.h> #include <spl.h>
-static int smh_read_full(long fd, void *memp, size_t len) +static ulong spl_smh_fit_read(struct spl_load_info *load, ulong sector, + ulong count, void *buf) { - long read; + int ret, fd = *(int *)load->priv;
- read = smh_read(fd, memp, len); - if (read < 0) - return read; - if (read != len) - return -EIO; - return 0; + if (smh_seek(fd, sector)) + return 0; + + ret = smh_read(fd, buf, count); + return ret < 0 ? 0 : ret; }
static int spl_smh_load_image(struct spl_image_info *spl_image, @@ -29,12 +29,17 @@ static int spl_smh_load_image(struct spl_image_info *spl_image, long fd, len; struct legacy_img_hdr *header = spl_get_load_buffer(-sizeof(*header), sizeof(*header)); + struct spl_load_info load = { + .bl_len = 1, + .read = spl_smh_fit_read, + };
fd = smh_open(filename, MODE_READ | MODE_BINARY); if (fd < 0) { log_debug("could not open %s: %ld\n", filename, fd); return fd; } + load.priv = &fd;
ret = smh_flen(fd); if (ret < 0) { @@ -43,25 +48,13 @@ static int spl_smh_load_image(struct spl_image_info *spl_image, } len = ret;
- ret = smh_read_full(fd, header, sizeof(struct legacy_img_hdr)); - if (ret) { + ret = smh_read(fd, header, sizeof(struct legacy_img_hdr)); + if (ret != sizeof(struct legacy_img_hdr)) { log_debug("could not read image header: %d\n", ret); goto out; }
- ret = spl_parse_image_header(spl_image, bootdev, header); - if (ret) { - log_debug("failed to parse image header: %d\n", ret); - goto out; - } - - ret = smh_seek(fd, 0); - if (ret) { - log_debug("could not seek to start of image: %d\n", ret); - goto out; - } - - ret = smh_read_full(fd, (void *)spl_image->load_addr, len); + ret = spl_load(spl_image, bootdev, &load, header, len, 0); if (ret) log_debug("could not read %s: %d\n", filename, ret); out:
This converts the spi load method to use spl_load. As a consequence, it also adds support for LOAD_FIT_FULL.
Signed-off-by: Sean Anderson sean.anderson@seco.com Reviewed-by: Stefan Roese sr@denx.de ---
(no changes since v1)
common/spl/spl_spi.c | 53 ++++++-------------------------------------- 1 file changed, 7 insertions(+), 46 deletions(-)
diff --git a/common/spl/spl_spi.c b/common/spl/spl_spi.c index 2aff025f76e..75929710935 100644 --- a/common/spl/spl_spi.c +++ b/common/spl/spl_spi.c @@ -95,6 +95,10 @@ static int spl_spi_load_image(struct spl_image_info *spl_image, struct legacy_img_hdr *header; unsigned int sf_bus = spl_spi_boot_bus(); unsigned int sf_cs = spl_spi_boot_cs(); + struct spl_load_info load = { + .bl_len = 1, + .read = spl_spi_fit_read, + };
/* * Load U-Boot image from SPI flash into RAM @@ -109,6 +113,7 @@ static int spl_spi_load_image(struct spl_image_info *spl_image, return -ENODEV; }
+ load.dev = flash; payload_offs = spl_spi_get_uboot_offs(flash);
header = spl_get_load_buffer(-sizeof(*header), sizeof(*header)); @@ -131,52 +136,8 @@ static int spl_spi_load_image(struct spl_image_info *spl_image, return err; }
- if (IS_ENABLED(CONFIG_SPL_LOAD_FIT_FULL) && - image_get_magic(header) == FDT_MAGIC) { - err = spi_flash_read(flash, payload_offs, - roundup(fdt_totalsize(header), 4), - (void *)CONFIG_SYS_LOAD_ADDR); - if (err) - return err; - err = spl_parse_image_header(spl_image, bootdev, - (struct legacy_img_hdr *)CONFIG_SYS_LOAD_ADDR); - } else if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) && - image_get_magic(header) == FDT_MAGIC) { - struct spl_load_info load; - - debug("Found FIT\n"); - load.dev = flash; - load.priv = NULL; - load.filename = NULL; - load.bl_len = 1; - load.read = spl_spi_fit_read; - err = spl_load_simple_fit(spl_image, &load, - payload_offs, - header); - } else if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER)) { - struct spl_load_info load; - - load.dev = flash; - load.priv = NULL; - load.filename = NULL; - load.bl_len = 1; - load.read = spl_spi_fit_read; - - err = spl_load_imx_container(spl_image, &load, - payload_offs); - } else { - err = spl_parse_image_header(spl_image, bootdev, header); - if (err) - return err; - err = spi_flash_read(flash, payload_offs + spl_image->offset, - spl_image->size, - (void *)spl_image->load_addr); - } - if (IS_ENABLED(CONFIG_SPI_FLASH_SOFT_RESET)) { - err = spi_nor_remove(flash); - if (err) - return err; - } + err = spl_load(spl_image, bootdev, &load, header, 0, + payload_offs); }
return err;
spi_load_image_os performs almost the same steps as the non-falcon-boot path of spl_spi_load_image. The load address is different, and it also loads a device tree, but that's it. Refactor the boot process so that they can both use the same load function.
Signed-off-by: Sean Anderson sean.anderson@seco.com ---
(no changes since v2)
Changes in v2: - New
common/spl/spl_spi.c | 87 +++++++++++++++++--------------------------- 1 file changed, 33 insertions(+), 54 deletions(-)
diff --git a/common/spl/spl_spi.c b/common/spl/spl_spi.c index 75929710935..39c528293e2 100644 --- a/common/spl/spl_spi.c +++ b/common/spl/spl_spi.c @@ -18,41 +18,6 @@ #include <asm/global_data.h> #include <dm/ofnode.h>
-#if CONFIG_IS_ENABLED(OS_BOOT) -/* - * Load the kernel, check for a valid header we can parse, and if found load - * the kernel and then device tree. - */ -static int spi_load_image_os(struct spl_image_info *spl_image, - struct spl_boot_device *bootdev, - struct spi_flash *flash, - struct legacy_img_hdr *header) -{ - int err; - - /* Read for a header, parse or error out. */ - spi_flash_read(flash, CFG_SYS_SPI_KERNEL_OFFS, sizeof(*header), - (void *)header); - - if (image_get_magic(header) != IH_MAGIC) - return -1; - - err = spl_parse_image_header(spl_image, bootdev, header); - if (err) - return err; - - spi_flash_read(flash, CFG_SYS_SPI_KERNEL_OFFS, - spl_image->size, (void *)spl_image->load_addr); - - /* Read device tree. */ - spi_flash_read(flash, CFG_SYS_SPI_ARGS_OFFS, - CFG_SYS_SPI_ARGS_SIZE, - (void *)CONFIG_SYS_SPL_ARGS_ADDR); - - return 0; -} -#endif - static ulong spl_spi_fit_read(struct spl_load_info *load, ulong sector, ulong count, void *buf) { @@ -81,6 +46,29 @@ u32 __weak spl_spi_boot_cs(void) return CONFIG_SF_DEFAULT_CS; }
+static int spi_do_load_image(struct spl_image_info *spl_image, + struct spl_boot_device *bootdev, + struct spl_load_info *load, + unsigned int payload_offs) +{ + int ret; + struct spi_flash *flash = load->dev; + struct legacy_img_hdr *header = + spl_get_load_buffer(-sizeof(*header), sizeof(*header)); + + /* mkimage header is 64 bytes. */ + ret = spi_flash_read(flash, payload_offs, sizeof(*header), + (void *)header); + if (ret) { + debug("%s: Failed to read from SPI flash (err=%d)\n", + __func__, ret); + return ret; + } + + return spl_load(spl_image, bootdev, load, header, 0, + payload_offs); +} + /* * The main entry for SPI booting. It's necessary that SDRAM is already * configured and available since this code loads the main U-Boot image @@ -89,10 +77,8 @@ u32 __weak spl_spi_boot_cs(void) static int spl_spi_load_image(struct spl_image_info *spl_image, struct spl_boot_device *bootdev) { - int err = 0; unsigned int payload_offs; struct spi_flash *flash; - struct legacy_img_hdr *header; unsigned int sf_bus = spl_spi_boot_bus(); unsigned int sf_cs = spl_spi_boot_cs(); struct spl_load_info load = { @@ -116,31 +102,24 @@ static int spl_spi_load_image(struct spl_image_info *spl_image, load.dev = flash; payload_offs = spl_spi_get_uboot_offs(flash);
- header = spl_get_load_buffer(-sizeof(*header), sizeof(*header)); - if (CONFIG_IS_ENABLED(OF_REAL)) { payload_offs = ofnode_conf_read_int("u-boot,spl-payload-offset", payload_offs); }
#if CONFIG_IS_ENABLED(OS_BOOT) - if (spl_start_uboot() || spi_load_image_os(spl_image, bootdev, flash, header)) -#endif - { - /* Load u-boot, mkimage header is 64 bytes. */ - err = spi_flash_read(flash, payload_offs, sizeof(*header), - (void *)header); - if (err) { - debug("%s: Failed to read from SPI flash (err=%d)\n", - __func__, err); - return err; - } - - err = spl_load(spl_image, bootdev, &load, header, 0, - payload_offs); + if (spl_start_uboot()) { + int err = spi_do_load_image(spl_image, bootdev, &load, + CFG_SYS_SPI_KERNEL_OFFS); + if (!err) + /* Read device tree. */ + return spi_flash_read(flash, CFG_SYS_SPI_ARGS_OFFS, + CFG_SYS_SPI_ARGS_SIZE, + (void *)CONFIG_SYS_SPL_ARGS_ADDR); } +#endif
- return err; + return spi_do_load_image(spl_image, bootdev, &load, payload_offs); } /* Use priorty 1 so that boards can override this */ SPL_LOAD_IMAGE_METHOD("SPI", 1, BOOT_DEVICE_SPI, spl_spi_load_image);
participants (2)
-
Heinrich Schuchardt -
Sean Anderson