[PATCH v4 06/11] tools: mkeficapsule: add man page

AKASHI Takahiro takahiro.akashi at linaro.org
Thu Oct 7 08:23:35 CEST 2021

Add a man page for mkeficapsule command.

Signed-off-by: AKASHI Takahiro <takahiro.akashi at linaro.org>
 MAINTAINERS        |  1 +
 doc/mkeficapsule.1 | 95 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 96 insertions(+)
 create mode 100644 doc/mkeficapsule.1

index 650e428b6cb4..1ef3aae41328 100644
@@ -694,6 +694,7 @@ S:	Maintained
 T:	git https://source.denx.de/u-boot/custodians/u-boot-efi.git
 F:	doc/api/efi.rst
 F:	doc/develop/uefi/*
+F:	doc/mkeficapsule.1
 F:	doc/usage/bootefi.rst
 F:	drivers/rtc/emul_rtc.c
 F:	include/capitalization.h
diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1
new file mode 100644
index 000000000000..837e09ab451e
--- /dev/null
+++ b/doc/mkeficapsule.1
@@ -0,0 +1,95 @@
+.TH MAEFICAPSULE 1 "May 2021"
+mkeficapsule \- Generate EFI capsule file for U-Boot
+.B mkeficapsule
+.RB [\fIoptions\fP] " \fIcapsule-file\fP"
+command is used to create an EFI capsule file for use with the U-Boot
+EFI capsule update.
+A capsule file may contain various type of firmware blobs which
+are to be applied to the system and must be placed in the specific
+directory on the UEFI system partition. An update will be automatically
+executed at next reboot.
+Optionally, a capsule file can be signed with a given private key.
+In this case, the update will be authenticated by verifying the signature
+before applying.
+\fBmkeficapsule\fP supports two different format of image files:
+.I raw image
+format is a single binary blob of any type of firmware.
+.I FIT (Flattened Image Tree) image
+is the same as used in the new \fIuImage\fP format and allows for
+multiple binary blobs in a single capsule file.
+This type of image file can be generated by \fBmkimage\fP.
+One of \fB--fit\fP or \fB--raw\fP option must be specified.
+.BI "-f, --fit \fIfit-image-file\fP"
+Specify a FIT image file
+.BI "-r, --raw \fIraw-image-file\fP"
+Specify a raw image file
+.BI "-i, --index \fIindex\fP"
+Specify an image index
+.BI "-I, --instance \fIinstance\fP"
+Specify a hardware instance
+.BI "-h, --help"
+Print a help message
+.TP 0
+.B With signing:
+\fB--private-key\fP, \fB--certificate\fP and \fB--monotonic-count\fP are
+all mandatory.
+.BI "-p, --private-key \fIprivate-key-file\fP"
+Specify signer's private key file in PEM
+.BI "-c, --certificate \fIcertificate-file\fP"
+Specify signer's certificate file in EFI certificate list format
+.BI "-m, --monotonic-count \fIcount\fP"
+Specify a monotonic count which is set to be monotonically incremented
+at every firmware update.
+.BI "-d, --dump_sig"
+Dump signature data into *.p7 file
+.BI "\fI/EFI/UpdateCapsule\fP"
+The directory in which all capsule files be placed
+.B mkimage
+Written by AKASHI Takahiro <takahiro.akashi at linaro.org>

More information about the U-Boot mailing list