[PATCH v10 09/10] doc: Add documentation to highlight capsule generation related updates

Sughosh Ganu sughosh.ganu at linaro.org
Sat Aug 12 17:30:23 CEST 2023

The EFI capsules can now be generated as part of U-Boot build, through
binman. Highlight these changes in the documentation.

Signed-off-by: Sughosh Ganu <sughosh.ganu at linaro.org>
Acked-by: Heinrich Schuchardt <xypron.glpk at gmx.de>
Changes since V9:
* s/u-boot/U-Boot/
* Add a link to the binman capsule entry type documentation as
  suggested by Simon Glass.

 doc/develop/uefi/uefi.rst | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index a7a41f2fac..3ce579d46e 100644
--- a/doc/develop/uefi/uefi.rst
+++ b/doc/develop/uefi/uefi.rst
@@ -318,6 +318,9 @@ Run the following command
       --guid <image GUID> \
+Capsule with firmware version
 The UEFI specification does not define the firmware versioning mechanism.
 EDK II reference implementation inserts the FMP Payload Header right before
 the payload. It coutains the fw_version and lowest supported version,
@@ -345,6 +348,20 @@ add --fw-version option in mkeficapsule tool.
 If the --fw-version option is not set, FMP Payload Header is not inserted
 and fw_version is set as 0.
+Capsule Generation through binman
+Support has also been added to generate capsules during U-Boot build
+through binman. This requires the platform's DTB to be populated with
+the capsule entry nodes for binman. The capsules then can be generated
+by specifying the capsule parameters as properties in the capsule
+entry node.
+Check the arch/sandbox/dts/sandbox_capsule.dtsi file for the sandbox
+platform as reference for how to generate capsules through binman as
+part of U-Boot build. Refer :ref:`etype_efi_capsule` for
+documentation about the efi-capsule binman entry type.
 Performing the update

More information about the U-Boot mailing list