diff mbox series

[v8,8/9] doc: Add documentation to highlight capsule generation related updates

Message ID 20230810142338.3402963-9-sughosh.ganu@linaro.org
State Superseded
Headers show
Series Enable EFI capsule generation through binman | expand

Commit Message

Sughosh Ganu Aug. 10, 2023, 2:23 p.m. UTC
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@linaro.org>
---
Changess since V7:
* Change the name of the file which contains the capsule entry binman
  nodes.

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

Comments

Heinrich Schuchardt Aug. 10, 2023, 3:28 p.m. UTC | #1
On 10.08.23 16:23, Sughosh Ganu wrote:
> 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@linaro.org>

Acked-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

> ---
> Changess since V7:
> * Change the name of the file which contains the capsule entry binman
>    nodes.
>
>   doc/develop/uefi/uefi.rst | 16 ++++++++++++++++
>   1 file changed, 16 insertions(+)
>
> diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
> index a7a41f2fac..93266da45e 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_file_name>
>
> +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,19 @@ 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 either through a config file, or
> +by specifying them 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.
> +
>   Performing the update
>   *********************
>
diff mbox series

Patch

diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index a7a41f2fac..93266da45e 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_file_name>
 
+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,19 @@  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 either through a config file, or
+by specifying them 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.
+
 Performing the update
 *********************