Re: [PATCH v6 6/6] doc: dtbinding: Update documentation for Generic Firmware loader

[Heinrich Schuchardt]

Am 9. April 2026 15:33:02 MESZ schrieb Christian Marangi <ansuelsmth at gmail.com>:
>Update documentation for Generic Firmware loader, generalize it from FS
>specific and add new property and example for FIP loader.
>
>Also add details on the usage of 'phandlepart', 'mtdpart' and 'ubivol'
>property.

The sevice-tree documents should be integrated into the generated html documentation.

Shouldn't we use the same yaml schema format as the kernel to enable automated CI tests?

Best regards

Heinrich


>
>Signed-off-by: Christian Marangi <ansuelsmth at gmail.com>
>---
> .../misc/{fs_loader.txt => fw_loader.txt}     | 29 +++++++++++++++++--
> 1 file changed, 26 insertions(+), 3 deletions(-)
> rename doc/device-tree-bindings/misc/{fs_loader.txt => fw_loader.txt} (60%)
>
>diff --git a/doc/device-tree-bindings/misc/fs_loader.txt b/doc/device-tree-bindings/misc/fw_loader.txt
>similarity index 60%
>rename from doc/device-tree-bindings/misc/fs_loader.txt
>rename to doc/device-tree-bindings/misc/fw_loader.txt
>index 542be4b25a0a..9b00b2c887c0 100644
>--- a/doc/device-tree-bindings/misc/fs_loader.txt
>+++ b/doc/device-tree-bindings/misc/fw_loader.txt
>@@ -1,17 +1,23 @@
>-* File system firmware loader
>+* Generic Firmware loader
> 
> Required properties:
> --------------------
> 
>-- compatible: should contain "u-boot,fs-loader"
>+- compatible: should contain "u-boot,fs-loader" or "u-boot,fip-loader"
> - phandlepart: which block storage device and partition the image loading from,
> 	       this property is required for mmc, usb and sata. This is unsigned
> 	       32-bit array. For example phandlepart=<&mmc_0 1>, meaning use
> 	       that MMC0 node pointer, partition 1.
>-- mdtpart: which partition of ubi the image loading from, this property is
>+- mtdpart: which partition of ubi the image loading from, this property is
> 	   required for ubi and mounting.
> - ubivol: which volume of ubi the image loading from, this property is required
> 	  for ubi and mounting.
>+- partoffset: valid ONLY for "u-boot,fip-loader". Offset of the partition to
>+	      parse the FIP partition from.
>+
>+Either 'phandlepart' or 'mtdpart' can be used. For Block device, 'phandlepart'
>+should be used and for MTD device, 'mtdpart' should be used. With UBI device,
>+in addition to 'mtdpart' also 'ubivol' is required.
> 
> Example of storage device and partition search set for mmc, usb, sata and
> ubi in device tree source as shown in below:
>@@ -46,3 +52,20 @@ ubi in device tree source as shown in below:
> 		mtdpart = "UBI",
> 		ubivol = "ubi0";
> 	};
>+
>+	Example for FIP from eMMC:
>+	fs_loader4: fip-loader at 4 {
>+		bootph-all;
>+		compatible = "u-boot,fip-loader";
>+		phandlepart = <&mmc0 0>;
>+		partoffset = <0x100>;
>+	};
>+
>+	Example for FIP from ubi:
>+	fs_loader4: fip-loader at 4 {
>+		bootph-all;
>+		compatible = "u-boot,fip-loader";
>+		mtdpart = "ubi",
>+		ubivol = "bl31";
>+	};
>+