misc: fs_loader: reorg and split to FS and FW loader + FIP loader
v3 cover misc: fs_loader: reorg and split to FS and FW loader + FIP loader
This series mainly rework the FS loader to permit reading firmware from container that are not exactly a readable filesystem.
One scenario is when a firmware is shipped in a FIP container as a generic blob with an UUID.
FIP are mostly used on ARM in the context of ATF.
In such context U-Boot is loaded as BL31 and the PHY firmware can't be stored in the FIT image for the kernel as U-Boot should not depend on the presence of the kernel to correctly enable PHY for Ethernet port.
To handle such case the PHY firmware is stored in FIP with a predictable UUID.
One example is with Airoha 8811H firmware where the FIP can have a blob with UUID "d39d2cf2-9bd0-3ca7-93e9-e71b4f9250b2". (generated from command "uuidgen -n @dns --md5 --name en8811h.bin")
With these example DTS entry:
fs_loader0: fip-loader {
bootph-all;
compatible = "u-boot,fip-loader";
phandlepart = <&mmc0 0>;
partoffset = <0x100>;
};mdio {
en8811: ethernet-phy@f {
reg = <0xf>;
firmware-name = "d39d2cf2-9bd0-3ca7-93e9-e71b4f9250b2";
firmware-loader = <&fs_loader0>; };
};
And PHY driver using the get_fw_loader_from_node() and the common request_firmware_into_buf() it's possible to load the PHY firmware transparently by just declaring the required entry in the DTS.
get_fw_loader_from_node() is implemented to actual get the loader from DT. This was something that was already in mind from when the FS loader was implemented but then it was never implemented in favor of a single loader per device.
The first patch is a minor fixup for something that probably won't ever happen.
The second one is a good reworking of the FS and FW loader moving the internal struct to a dedicated header. (this is really to enforce what drivers should use and what driver should not mess with)
Then there is the request_firmware_size() new OP to get only the size of the firmware. Useful for case where the firmware size is not always the same and change across different version. (the patter might be get size -> alloc buffer -> get firmware).
Then the FIP loader as a basic parser of FIP. This only read the FIP header, loop all the entry and search for a matching UUID. If nothing is found then no firmware blob. Very simple implementation.
This is being CI tested on [0]
[0] https://github.com/u-boot/u-boot/pull/884
Changes v3:
- Add review tag where possible
- Check blk_dread ret
- Generalize mount_ubifs with generic_fw_loader_ubi_select
- Fix some typo
- Drop useless ubifs umount (nothing is mounted in FIP) Changes v2:
- Better handle header include to fix compilation error on some devices
- Fix typo for ubifs fix commit
Christian Marangi (5):
misc: fs_loader: fix ubifs not unmounted on dev_get_priv error
misc: fs_loader: reorganize and split to FS and FW loader
misc: fw_loader: implement generic get_fw_loader_from_node()
misc: fw_loader: introduce FIP loader driver
misc: fw_loader: implement request_firmware_size() OP
drivers/misc/Kconfig | 16 +
drivers/misc/Makefile | 2 +-
drivers/misc/fw_loader/Makefile | 5 +
drivers/misc/fw_loader/fip_loader.c | 576 +++++++++++++++++++++++
drivers/misc/{ => fw_loader}/fs_loader.c | 187 +++-----
drivers/misc/fw_loader/fw_loader.c | 207 ++++++++
drivers/misc/fw_loader/internal.h | 64 +++
include/dm/uclass-id.h | 3 +-
include/fs_loader.h | 47 +-
include/fw_loader.h | 43 ++
10 files changed, 975 insertions(+), 175 deletions(-)
create mode 100644 drivers/misc/fw_loader/Makefile
create mode 100644 drivers/misc/fw_loader/fip_loader.c
rename drivers/misc/{ => fw_loader}/fs_loader.c (60%)
create mode 100644 drivers/misc/fw_loader/fw_loader.c
create mode 100644 drivers/misc/fw_loader/internal.hSignature · 1 line
2.53.0
PATCH v3 1/5 misc: fs_loader: fix ubifs not unmounted on dev_get_priv error
When dev_get_priv errors out, the ubifs is not umounted (if used).
Correctly handle this handle condition and while at it also return -EINVAL instead of -ENOMEM as a better error since no memory is allocated but is actually an invalid scenario for fw_get_filesystem_firmware().
--- drivers/misc/fs_loader.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-)
drivers/misc/fs_loader.c +4 -2
@@ -178,8 +178,10 @@ static int fw_get_filesystem_firmware(struct udevice *dev)struct firmware *firmwarep =dev_get_priv (dev); -if (!firmwarep) -return -ENOMEM ; +if (!firmwarep) { + ret = -EINVAL ; + goto out; + } ret =fs_read (firmwarep->name, (ulong )map_to_sysmem (firmwarep->data), firmwarep->offset, firmwarep->size, &actread);
Signature · 1 line
2.53.0
PATCH v3 2/5 misc: fs_loader: reorganize and split to FS and FW loader
In reply to Christian MarangiIn preparation to the introduction of variant of the FS loader, reorganize and split the driver to generic fw_loader function and specific fs_loader function. Create a dedicated directory for the loader and move the internal structs and functions to a dedicated header file.
This will permit to reuse all the property and logic of FS loader with container that are not exactly a readable filesystem.
---
drivers/misc/Kconfig | 5 +
drivers/misc/Makefile | 2 +-
drivers/misc/fw_loader/Makefile | 4 +
drivers/misc/{ => fw_loader}/fs_loader.c | 141 ++--------------------
drivers/misc/fw_loader/fw_loader.c | 144 +++++++++++++++++++++++
drivers/misc/fw_loader/internal.h | 61 ++++++++++
include/fs_loader.h | 47 +-------
include/fw_loader.h | 19 +++
8 files changed, 247 insertions(+), 176 deletions(-)
create mode 100644 drivers/misc/fw_loader/Makefile
rename drivers/misc/{ => fw_loader}/fs_loader.c (58%)
create mode 100644 drivers/misc/fw_loader/fw_loader.c
create mode 100644 drivers/misc/fw_loader/internal.hdrivers/misc/Kconfig +5 -0
@@ -610,8 +610,12 @@ config MPC83XX_SERDES help Support for serdes found on MPC83xx SoCs. +config FW_LOADER + bool + config FS_LOADER bool "Enable loader driver for file system" + select FW_LOADER help This is file system generic loader which can be used to load the file image from the storage into target such as memory.
@@ -621,6 +625,7 @@ config FS_LOADER config SPL_FS_LOADER bool "Enable loader driver for file system in SPL" + select FW_LOADER depends on SPL help This is file system generic loader which can be used to load
drivers/misc/Makefile +1 -1
@@ -36,7 +36,7 @@ obj-$(CONFIG_FSL_DEVICE_DISABLE) += fsl_devdis.o obj-$(CONFIG_FSL_IFC) += fsl_ifc.o obj-$(CONFIG_FSL_IIM) += fsl_iim.o obj-$(CONFIG_FSL_SEC_MON) += fsl_sec_mon.o -obj-$(CONFIG_$(PHASE_)FS_LOADER) += fs_loader.o +obj-$(CONFIG_FW_LOADER) += fw_loader/ obj-$(CONFIG_GATEWORKS_SC) += gsc.o obj-$(CONFIG_GDSYS_IOEP) += gdsys_ioep.o obj-$(CONFIG_GDSYS_RXAUI_CTRL) += gdsys_rxaui_ctrl.o
drivers/misc/fw_loader/Makefile new file +4 -0
@@ -0,0 +1,4 @@ +# SPDX-License-Identifier: GPL-2.0+ + +obj-y += fw_loader.o +obj-$(CONFIG_$(PHASE_)FS_LOADER) += fs_loader.o
drivers/misc/fw_loader/fs_loader.c renamed from drivers/misc/fs_loader.c +11 -130
177 lines not on this page · raw message
drivers/misc/fw_loader/fw_loader.c new file +144 -0
144 lines not on this page · raw message
drivers/misc/fw_loader/internal.h new file +61 -0
61 lines not on this page · raw message
include/fs_loader.h +2 -45
54 lines not on this page · raw message
include/fw_loader.h +19 -0
@@ -1,10 +1,29 @@/* SPDX-License-Identifier: GPL-2.0 */ /* +* Copyright (C) 2018-2019 Intel Corporation <www.intel.com> * Copyright (C) 2025 Lucien Jheng <[email protected]> */ #ifndef _FW_LOADER_H_#define _FW_LOADER_H_ +struct udevice ; + +/** +* request_firmware_into_buf - Load firmware into a previously allocated buffer. +* @dev: An instance of a driver. +* @name: Name of firmware file. +* @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. +* +* Return: Size of total read, negative value when error. +*/ +int request_firmware_into_buf (struct udevice *dev, +const char *name, +void *buf,size_t size,u32 offset); +/** * request_firmware_into_buf_via_script() - * Load firmware using a U-Boot script and copy to buffer
Signature · 1 line
2.53.0
PATCH v3 3/5 misc: fw_loader: implement generic get_fw_loader_from_node()
In reply to Christian MarangiImplement a generic function to get a FW loader dev from a node.
There is currently only get_fs_loader() but that is limited to chosen node and is limited only to FS loader.
Introduce get_fw_loader_from_node() that will parse the "firmware-loader" from a specified node and will loop over all the available FW loader until one is found (as it will be probed by the dedicated compatible)
--- drivers/misc/fw_loader/fw_loader.c | 40 ++++++++++++++++++++++++++++++ include/fw_loader.h | 15 +++++++++++ 2 files changed, 55 insertions(+)
drivers/misc/fw_loader/fw_loader.c +40 -0
@@ -8,6 +8,7 @@#include <blk.h> #include <linux/types.h> #include <dm/device.h> +#include <dm/uclass.h> #include <fw_loader.h> #ifdef CONFIG_CMD_UBIFS
@@ -90,6 +91,45 @@ int generic_fw_loader_probe(struct udevice *dev)return 0 ; } +static int fw_loaders[] = { +#if CONFIG_IS_ENABLED(FS_LOADER) +UCLASS_FS_FIRMWARE_LOADER , +#endif +}; + +/** +* get_fw_loader_from_node - Get FW loader dev from @node. +* +* @node: ofnode where "firmware-loader" phandle is stored. +* @dev: pointer where to store the FW loader dev. +* +* Loop over all the supported FW loader and find a matching +* one. +* +* Return: Negative value if fail, 0 for successful. +*/ +int get_fw_loader_from_node (ofnode node,struct udevice **dev) +{ +int i, ret; + + node =ofnode_parse_phandle (node,"firmware-loader" ,0 ); +if (!ofnode_valid (node)) +return -ENODEV ; + +/* +* Loop over all the available FW loaders and stop when +* found one. +*/ +for (i =0 ; i <ARRAY_SIZE (fw_loaders); i++) { + ret =uclass_get_device_by_ofnode (fw_loaders[i], + node, dev); +if (!ret) +return 0 ; + } + +return -ENODEV ; +} +/** * _request_firmware_prepare - Prepare firmware struct. *
include/fw_loader.h +15 -0
@@ -6,8 +6,23 @@#ifndef _FW_LOADER_H_#define _FW_LOADER_H_ +#include <dm/ofnode_decl.h> +struct udevice ; +/** +* get_fw_loader_from_node - Get FW loader dev from @node. +* +* @node: ofnode where "firmware-loader" phandle is stored. +* @dev: pointer where to store the FW loader dev. +* +* Loop over all the supported FW loader and find a matching +* one. +* +* Return: Negative value if fail, 0 for successful. +*/ +int get_fw_loader_from_node (ofnode node,struct udevice **dev); +/** * request_firmware_into_buf - Load firmware into a previously allocated buffer. * @dev: An instance of a driver.
Signature · 1 line
2.53.0
PATCH v3 4/5 misc: fw_loader: introduce FIP loader driver
In reply to Christian MarangiIntroduce a variant of the FS loader driver to extract images from FIP image. These image can contain additional binary used to init Network accellerator or PHY firmware blob.
The way FIP handle image type is with the usage of UUID.
This FIP loader driver implement a simple FIP image parser that check every entry for a matching UUID.
Similar to FS loader, this driver also support both UBI and Block devices.
Also an additional property is added to handle special case with eMMC that doesn't have a GPT partition and require a global offset to reference the FIP partition.
An example usage of this driver is the following:
Entry in DTS:
fs_loader0: fip-loader {
bootph-all;
compatible = "u-boot,fip-loader";
phandlepart = <&mmc0 0>;
partoffset = <0x100>;
};
ethernet@1fb50000 {
firmware-loader = <&fs_loader0>;
}FIP loader user:
/* get the FW loader from the ethernet node */ get_fw_loader_from_node(dev_ofnode(dev), &fw_loader); /* read the blob identified by "58704aef-389f-3e52-b475-e0bf2234a6a2" UUID */ request_firmware_into_buf(fw_loader, "58704aef-389f-3e52-b475-e0bf2234a6a2", buf, 261400, 0);
--- drivers/misc/Kconfig | 11 + drivers/misc/fw_loader/Makefile | 1 + drivers/misc/fw_loader/fip_loader.c | 547 ++++++++++++++++++++++++++++ drivers/misc/fw_loader/fw_loader.c | 3 + drivers/misc/fw_loader/internal.h | 2 + include/dm/uclass-id.h | 3 +- 6 files changed, 566 insertions(+), 1 deletion(-) create mode 100644 drivers/misc/fw_loader/fip_loader.c
drivers/misc/Kconfig +11 -0
@@ -613,6 +613,17 @@ config MPC83XX_SERDES config FW_LOADER bool +config FIP_LOADER + bool "Enable loader driver from FIP partition" + select LIB_UUID + select FW_LOADER + help + This is FIP partition generic loader which can be used to load + the file image from the FIP image into target such as memory. + + The consumer driver would then use this loader to program whatever, + ie. the FPGA device/PHY firmware. + config FS_LOADER bool "Enable loader driver for file system" select FW_LOADER
drivers/misc/fw_loader/Makefile +1 -0
@@ -1,4 +1,5 @@ # SPDX-License-Identifier: GPL-2.0+ obj-y += fw_loader.o +obj-$(CONFIG_FIP_LOADER) += fip_loader.o obj-$(CONFIG_$(PHASE_)FS_LOADER) += fs_loader.o
drivers/misc/fw_loader/fip_loader.c new file +547 -0
547 lines not on this page · raw message
drivers/misc/fw_loader/fw_loader.c +3 -0
@@ -95,6 +95,9 @@ static int fw_loaders[] = {#if CONFIG_IS_ENABLED (FS_LOADER ) UCLASS_FS_FIRMWARE_LOADER,#endif +#if CONFIG_IS_ENABLED (FIP_LOADER ) + UCLASS_FIP_FIRMWARE_LOADER, +#endif };/**
drivers/misc/fw_loader/internal.h +2 -0
@@ -25,11 +25,13 @@ struct phandle_part {* This holds information about all supported storage devices for driver use. * * @phandlepart: Attribute data for block device. +* @partoffset: Global offset for BLK partition. * @mtdpart: MTD partition for ubi partition. * @ubivol: UBI volume-name for ubifsmount. */ struct device_plat {struct phandle_part phandlepart; +int partoffset;char *mtdpart;char *ubivol;
include/dm/uclass-id.h +2 -1
@@ -69,7 +69,8 @@ enum uclass_id {UCLASS_FIRMWARE ,/* Firmware */ UCLASS_FPGA ,/* FPGA device */ UCLASS_FUZZING_ENGINE ,/* Fuzzing engine */ -UCLASS_FS_FIRMWARE_LOADER ,/* Generic loader */ +UCLASS_FIP_FIRMWARE_LOADER ,/* FIP image loader */ +UCLASS_FS_FIRMWARE_LOADER ,/* Generic loader */ UCLASS_FWU_MDATA ,/* FWU Metadata Access */ UCLASS_GPIO ,/* Bank of general-purpose I/O pins */ UCLASS_HASH, /* Hash device */
Signature · 1 line
2.53.0
PATCH v3 5/5 misc: fw_loader: implement request_firmware_size() OP
In reply to Christian MarangiIt might be useful to get the firmware size before reading it to allocate the correct size. This is needed for case where the firmware size change across different firmware version and is not always the same. In such case the only way to handle this scenario is to allocate a big-enough buffer to read the firmware.
To better handle this, introduce the request_firmware_size() OP to get the firmware size before reading it. This way proper buffer can be allocated and dynamic firmware size can be better supported.
Both FS and FIP lodaer are updated to handle the new .get_size() handler.
--- drivers/misc/fw_loader/fip_loader.c | 29 ++++++++++++ drivers/misc/fw_loader/fs_loader.c | 70 ++++++++++++++++++++++++----- drivers/misc/fw_loader/fw_loader.c | 20 +++++++++ drivers/misc/fw_loader/internal.h | 1 + include/fw_loader.h | 9 ++++ 5 files changed, 118 insertions(+), 11 deletions(-)
drivers/misc/fw_loader/fip_loader.c +29 -0
@@ -495,6 +495,34 @@ static int fw_get_fip_firmware(struct udevice *dev)return ret; } +/** +* fw_get_fip_firmware_size - get firmware size. +* @dev: An instance of a driver. +* +* Return: Size of firmware, negative value when error. +*/ +static int fw_get_fip_firmware_size (struct udevice *dev) +{ +struct fip_toc_entry ent; +struct fip_storage_info info = { }; +int ret; + + ret =fw_parse_storage_info (dev, &info); +if (ret) +return ret; + +struct firmware *firmwarep =dev_get_priv (dev); + +if (!firmwarep) +return -EINVAL ; + + ret =parse_fip_firmware (firmwarep, &info, &ent); +if (ret) +return ret; + +return ent.size; +} +static int fip_loader_probe (struct udevice *dev) {struct device_plat *plat =dev_get_plat (dev);
@@ -505,6 +533,7 @@ static int fip_loader_probe(struct udevice *dev)return ret; plat->get_firmware = fw_get_fip_firmware; + plat->get_size = fw_get_fip_firmware_size;return 0 ; };
drivers/misc/fw_loader/fs_loader.c +59 -11
95 lines not on this page · raw message
drivers/misc/fw_loader/fw_loader.c +20 -0
@@ -185,3 +185,23 @@ int request_firmware_into_buf(struct udevice *dev,return plat->get_firmware (dev); } + +int request_firmware_size (struct udevice *dev,const char *name) +{ +struct device_plat *plat; +int ret; + +if (!dev) +return -EINVAL ; + + ret =_request_firmware_prepare (dev, name,NULL ,0 ,0 ); +if (ret <0 )/* error */ +return ret; + + plat =dev_get_plat (dev); + +if (!plat->get_size) +return -EOPNOTSUPP ; + +return plat->get_size (dev); +}
drivers/misc/fw_loader/internal.h +1 -0
@@ -36,6 +36,7 @@ struct device_plat {char *ubivol;int (*get_firmware)(struct udevice *dev); +int (*get_size)(struct udevice *dev); };/**
include/fw_loader.h +9 -0
@@ -39,6 +39,15 @@ int request_firmware_into_buf(struct udevice *dev,const char *name, void *buf, size_t size, u32 offset); +/** +* request_firmware_size - Get firmware size. +* @dev: An instance of a driver. +* @name: Name of firmware file. +* +* Return: Size of firmware, negative value when error. +*/ +int request_firmware_size (struct udevice *dev,const char *name); +/** * request_firmware_into_buf_via_script() - * Load firmware using a U-Boot script and copy to buffer
Signature · 1 line
2.53.0
Quoted 59 lines · Christian Marangi
This series mainly rework the FS loader to permit reading firmware from container that are not exactly a readable filesystem.
One scenario is when a firmware is shipped in a FIP container as a generic blob with an UUID.
FIP are mostly used on ARM in the context of ATF.
In such context U-Boot is loaded as BL31 and the PHY firmware can't be stored in the FIT image for the kernel as U-Boot should not depend on the presence of the kernel to correctly enable PHY for Ethernet port.To handle such case the PHY firmware is stored in FIP with a predictable UUID.
One example is with Airoha 8811H firmware where the FIP can have a blob with UUID "d39d2cf2-9bd0-3ca7-93e9-e71b4f9250b2". (generated from command "uuidgen -n @dns --md5 --name en8811h.bin")
With these example DTS entry:
fs_loader0: fip-loader { bootph-all; compatible = "u-boot,fip-loader"; phandlepart = <&mmc0 0>; partoffset = <0x100>; };mdio {
en8811: ethernet-phy@f { reg = <0xf>; firmware-name = "d39d2cf2-9bd0-3ca7-93e9-e71b4f9250b2"; firmware-loader = <&fs_loader0>;};
};And PHY driver using the
get_fw_loader_from_node()and the commonrequest_firmware_into_buf()it's possible to load the PHY firmware transparently by just declaring the required entry in the DTS.
get_fw_loader_from_node()is implemented to actual get the loader from DT. This was something that was already in mind from when the FS loader was implemented but then it was never implemented in favor of a single loader per device.The first patch is a minor fixup for something that probably won't ever happen.
The second one is a good reworking of the FS and FW loader moving the internal struct to a dedicated header. (this is really to enforce what drivers should use and what driver should not mess with)
Then there is the
request_firmware_size()new OP to get only the size of the firmware. Useful for case where the firmware size is not always the same and change across different version. (the patter might be get size -> alloc buffer -> get firmware).
Quoted 6 lines
Then the FIP loader as a basic parser of FIP. This only read the FIP header, loop all the entry and search for a matching UUID. If nothing is found then no firmware blob. Very simple implementation.
This is being CI tested on [0]
Both "git am" and "b4 shazam" fail to apply the second patch here, can you please rebase on top of current next and repost? Thanks.
Signature · 1 line
Tom
Quoted 66 lines · Tom Rini
Quoted 64 lines · Christian Marangi
This series mainly rework the FS loader to permit reading firmware from container that are not exactly a readable filesystem.
One scenario is when a firmware is shipped in a FIP container as a generic blob with an UUID.
FIP are mostly used on ARM in the context of ATF.
In such context U-Boot is loaded as BL31 and the PHY firmware can't be stored in the FIT image for the kernel as U-Boot should not depend on the presence of the kernel to correctly enable PHY for Ethernet port.To handle such case the PHY firmware is stored in FIP with a predictable UUID.
One example is with Airoha 8811H firmware where the FIP can have a blob with UUID "d39d2cf2-9bd0-3ca7-93e9-e71b4f9250b2". (generated from command "uuidgen -n @dns --md5 --name en8811h.bin")
With these example DTS entry:
fs_loader0: fip-loader { bootph-all; compatible = "u-boot,fip-loader"; phandlepart = <&mmc0 0>; partoffset = <0x100>; };mdio {
en8811: ethernet-phy@f { reg = <0xf>; firmware-name = "d39d2cf2-9bd0-3ca7-93e9-e71b4f9250b2"; firmware-loader = <&fs_loader0>;};
};And PHY driver using the
get_fw_loader_from_node()and the commonrequest_firmware_into_buf()it's possible to load the PHY firmware transparently by just declaring the required entry in the DTS.
get_fw_loader_from_node()is implemented to actual get the loader from DT. This was something that was already in mind from when the FS loader was implemented but then it was never implemented in favor of a single loader per device.The first patch is a minor fixup for something that probably won't ever happen.
The second one is a good reworking of the FS and FW loader moving the internal struct to a dedicated header. (this is really to enforce what drivers should use and what driver should not mess with)
Then there is the
request_firmware_size()new OP to get only the size of the firmware. Useful for case where the firmware size is not always the same and change across different version. (the patter might be get size -> alloc buffer -> get firmware).Then the FIP loader as a basic parser of FIP. This only read the FIP header, loop all the entry and search for a matching UUID. If nothing is found then no firmware blob. Very simple implementation.
Quoted 5 lines
Quoted 1 line
This is being CI tested on [0]
Both "git am" and "b4 shazam" fail to apply the second patch here, can you please rebase on top of current next and repost? Thanks.
Sorry I was targetting master instead of next. Just sent v4 with the conflict fixed (it was the global declare dropped commit).
Signature · 1 line
Ansuel