From: Sughosh Ganu Date: Tue, 10 Oct 2023 09:10:55 +0000 (+0530) Subject: doc: capsule: Add documentation for the capsule dump feature X-Git-Url: http://git.dujemihanovic.xyz/img/static/gitweb.css?a=commitdiff_plain;h=ba5b960dcb753bdd99e1f718f78624a40ad2fdd2;p=u-boot.git doc: capsule: Add documentation for the capsule dump feature Add documentation to explain the printing of the capsule headers through the mkeficapsule tool. Signed-off-by: Sughosh Ganu Reviewed-by: Simon Glass --- diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index f8510d31d7..fb16ac743a 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -385,6 +385,23 @@ capsules. Refer :ref:`etype_efi_capsule` for documentation about the efi-capsule binman entry type, which describes all the properties that can be specified. +Dumping capsule headers +*********************** + +The mkeficapsule tool also provides a command-line option to dump the +contents of the capsule header. This is a useful functionality when +trying to understand the structure of a capsule and is also used in +capsule verification. This feature is used in testing the capsule +contents in binman's test framework. + +To check the contents of the capsule headers, the mkeficapsule command +can be used. + +.. code-block:: console + + $ mkeficapsule --dump-capsule \ + + Performing the update *********************