From b5da53046c303d7cff586b366f225dc4c3b64686 Mon Sep 17 00:00:00 2001 From: "Lucien.Jheng" Date: Sun, 17 Aug 2025 23:02:03 +0800 Subject: misc: fs_loader: Add request_firmware_into_buf_via_script() for flexible firmware loading via U-Boot script This commit introduces a new API, request_firmware_into_buf_via_script(), to the fs_loader framework. This function allows firmware to be loaded into memory using a user-defined U-Boot script, providing greater flexibility for firmware loading scenarios that cannot be handled by static file paths or device/partition selection alone. Key features: - The API runs a specified U-Boot script (by name), which is responsible for loading the firmware into memory by any means (e.g., load from MMC, USB, network, etc.). - The script must set two environment variables: 'fw_addr' (the memory address where the firmware is loaded) and 'fw_size' (the size of the firmware in bytes). - The function validates these variables, copies the firmware into a newly allocated buffer (using memdup), and returns the pointer via the provided double pointer argument. - The maximum allowed firmware size is checked to prevent buffer overflows. - The environment variables are cleared after use to avoid stale data. - Detailed error messages are provided for all failure conditions to aid debugging. Usage example: 1. Define a U-Boot script in the environment that loads the firmware and sets the required variables: => env set my_fw_script 'load mmc 0:1 ${loadaddr} firmware.bin && env set fw_addr ${loadaddr} && env set fw_size ${filesize}' 2. In your code, call the new API: void *fw_buf = NULL; int ret = request_firmware_into_buf_via_script(&fw_buf, 0x46000000, "my_fw_script"); if (ret < 0) return ret; This approach allows board integrators and users to customize the firmware loading process without modifying the source code, simply by changing the script in the U-Boot environment. Signed-off-by: Lucien.Jheng Reviewed-by: Marek Vasut [trini: Fix printf of size_t needing to use %zx] Signed-off-by: Tom Rini --- include/fs_loader.h | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'include/fs_loader.h') diff --git a/include/fs_loader.h b/include/fs_loader.h index 5eb5b7ab4a1..a433be1eb99 100644 --- a/include/fs_loader.h +++ b/include/fs_loader.h @@ -64,4 +64,28 @@ int request_firmware_into_buf(struct udevice *dev, * Return: 0 on success, negative value on error */ int get_fs_loader(struct udevice **dev); + +/** + * request_firmware_into_buf_via_script() - + * Load firmware using a U-Boot script and copy to buffer + * @buf: Pointer to a pointer where the firmware buffer will be stored. + * @max_size: Maximum allowed size for the firmware to be loaded. + * @script_name: Name of the U-Boot script to execute for firmware loading. + * + * Executes a U-Boot script (@script_name) that loads firmware into + * memory and sets the environment variables 'fw_addr' (address) and + * 'fw_size' (size in bytes). On success, copies the firmware + * from the given address to user buffer @buf. + * + * The script must set these environment variables: + * fw_addr - Address where firmware is loaded in memory + * fw_size - Size of the firmware in bytes + * + * The script should be defined in the U-Boot environment, for example: + * env set script_name 'load mmc 0:1 ${loadaddr} firmware.bin && + * env set fw_addr ${loadaddr} && env set fw_size ${filesize} + * Return: 0 on success, negative value on error. + */ +int request_firmware_into_buf_via_script(void **buf, size_t max_size, + const char *script_name); #endif -- cgit v1.2.3 From 63585689686fee83b382edacad249a4ec35d7c3d Mon Sep 17 00:00:00 2001 From: Weijie Gao Date: Mon, 8 Sep 2025 16:34:02 +0800 Subject: misc: fs_loader: allow returning actual firmware data size in request_firmware_into_buf_via_script() It's important to return the actual firmware data size as some firmware files may have no checksum and need the size as the only way for firmware validation check. Signed-off-by: Weijie Gao --- include/fs_loader.h | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'include/fs_loader.h') diff --git a/include/fs_loader.h b/include/fs_loader.h index a433be1eb99..1cf6d6dd05f 100644 --- a/include/fs_loader.h +++ b/include/fs_loader.h @@ -71,6 +71,7 @@ int get_fs_loader(struct udevice **dev); * @buf: Pointer to a pointer where the firmware buffer will be stored. * @max_size: Maximum allowed size for the firmware to be loaded. * @script_name: Name of the U-Boot script to execute for firmware loading. + * @retsize: Return the actual firmware data size (optional). * * Executes a U-Boot script (@script_name) that loads firmware into * memory and sets the environment variables 'fw_addr' (address) and @@ -87,5 +88,6 @@ int get_fs_loader(struct udevice **dev); * Return: 0 on success, negative value on error. */ int request_firmware_into_buf_via_script(void **buf, size_t max_size, - const char *script_name); + const char *script_name, + size_t *retsize); #endif -- cgit v1.2.3