diff options
| author | Sughosh Ganu <[email protected]> | 2023-10-10 14:40:55 +0530 |
|---|---|---|
| committer | Simon Glass <[email protected]> | 2023-10-13 14:01:42 -0600 |
| commit | ba5b960dcb753bdd99e1f718f78624a40ad2fdd2 (patch) | |
| tree | 69cd1dfab54f472386b664f43f8cbdf6d3566c4f /doc | |
| parent | 6984077de0a1240d68ea2b247a9041da30493f7b (diff) | |
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 <[email protected]>
Reviewed-by: Simon Glass <[email protected]>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/develop/uefi/uefi.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index f8510d31d7a..fb16ac743a0 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 \ + <capsule_file_name> + Performing the update ********************* |