diff mbox series

[RFC,4/6] doc: uefi: Update the capsule update related documentation

Message ID 20220324123901.429472-5-sughosh.ganu@linaro.org
State RFC
Delegated to: Heinrich Schuchardt
Headers show
Series efi: capsule: Image GUID usage cleanup | expand

Commit Message

Sughosh Ganu March 24, 2022, 12:38 p.m. UTC 
Update the capsule update functionality related documentation to
refect the fact that a unique image GUID is to be used per image
that forms part of the capsule file.

Signed-off-by: Sughosh Ganu <sughosh.ganu@linaro.org>
---
 doc/develop/uefi/uefi.rst | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index fe337c88bd..0d2825ce88 100644
--- a/doc/develop/uefi/uefi.rst
+++ b/doc/develop/uefi/uefi.rst
@@ -312,8 +312,8 @@  Run the following command
 .. code-block:: console
 
     $ mkeficapsule \
-      --index 1 --instance 0 \
-      [--fit <FIT image> | --raw <raw image>] \
+      --index <index> --instance 0 \
+      --guid <image GUID> \
       <capsule_file_name>
 
 Performing the update
@@ -333,6 +333,12 @@  won't be taken over across the reboot. If this is the case, you can skip
 this feature check with the Kconfig option (CONFIG_EFI_IGNORE_OSINDICATIONS)
 set.
 
+Define GUID values of the images that are to be updated through the
+capsule update feature in the platform file. The GUID values are to be
+defined as part of the fw_images array. These GUID values would be
+used by the Firmware Management Protocol(FMP) to populate the image
+descriptor array and also displayed as part of the ESRT table.
+
 Finally, the capsule update can be initiated by rebooting the board.
 
 Enabling Capsule Authentication