diff mbox series

[v7,10/11] doc: Add documentation to highlight capsule generation related updates

Message ID 20230805113458.1430239-11-sughosh.ganu@linaro.org
State Changes Requested
Delegated to: Tom Rini
Headers show
Series Integrate EFI capsule tasks into u-boot's build flow | expand

Commit Message

Sughosh Ganu Aug. 5, 2023, 11:34 a.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>
---
Changes since V6: None

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

Comments

Simon Glass Aug. 5, 2023, 3:04 p.m. UTC | #1
Hi Sughosh,

On Sat, 5 Aug 2023 at 05:35, Sughosh Ganu <sughosh.ganu@linaro.org> wrote:
>
> The EFI capsules can now be generated as part of u-boot build, through

Please check your patches for 'U-Boot' throughout.

> binman. Highlight these changes in the documentation.
>
> Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org>
> ---
> Changes since V6: None
>
>  doc/develop/uefi/uefi.rst | 18 ++++++++++++++++++
>  1 file changed, 18 insertions(+)
>
> diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
> index b2854b52a6..3150d6fb9c 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,21 @@ 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

not a config file at present

> +by specifying them as properties in the capsule entry node.
> +
> +Check the arch/sandbox/dts/u-boot.dtsi file for the sandbox platform
> +as reference for how to generate capsules through binman as part of
> +u-boot build.
> +
> +
>  Performing the update
>  *********************
>
> --
> 2.34.1
>

Regards,
Simon
Sughosh Ganu Aug. 5, 2023, 6:27 p.m. UTC | #2
hi Simon,

On Sat, 5 Aug 2023 at 20:34, Simon Glass <sjg@chromium.org> wrote:
>
> Hi Sughosh,
>
> On Sat, 5 Aug 2023 at 05:35, Sughosh Ganu <sughosh.ganu@linaro.org> wrote:
> >
> > The EFI capsules can now be generated as part of u-boot build, through
>
> Please check your patches for 'U-Boot' throughout.

Okay

>
> > binman. Highlight these changes in the documentation.
> >
> > Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org>
> > ---
> > Changes since V6: None
> >
> >  doc/develop/uefi/uefi.rst | 18 ++++++++++++++++++
> >  1 file changed, 18 insertions(+)
> >
> > diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
> > index b2854b52a6..3150d6fb9c 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,21 @@ 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
>
> not a config file at present

Yes, will remove the reference.

-sughosh

>
> > +by specifying them as properties in the capsule entry node.
> > +
> > +Check the arch/sandbox/dts/u-boot.dtsi file for the sandbox platform
> > +as reference for how to generate capsules through binman as part of
> > +u-boot build.
> > +
> > +
> >  Performing the update
> >  *********************
> >
> > --
> > 2.34.1
> >
>
> Regards,
> Simon
diff mbox series

Patch

diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index b2854b52a6..3150d6fb9c 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,21 @@  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/u-boot.dtsi file for the sandbox platform
+as reference for how to generate capsules through binman as part of
+u-boot build.
+
+
 Performing the update
 *********************