|
@@ -0,0 +1,99 @@
|
|
|
+.\" SPDX-License-Identifier: GPL-2.0+
|
|
|
+.\" Copyright (c) 2021, Linaro Limited
|
|
|
+.\" written by AKASHI Takahiro <takahiro.akashi@linaro.org>
|
|
|
+.TH MAEFICAPSULE 1 "May 2021"
|
|
|
+
|
|
|
+.SH NAME
|
|
|
+mkeficapsule \- Generate EFI capsule file for U-Boot
|
|
|
+
|
|
|
+.SH SYNOPSIS
|
|
|
+.B mkeficapsule
|
|
|
+.RI [ options "] " capsule-file
|
|
|
+
|
|
|
+.SH "DESCRIPTION"
|
|
|
+.B mkeficapsule
|
|
|
+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.
|
|
|
+
|
|
|
+.B mkeficapsule
|
|
|
+supports two different format of image files:
|
|
|
+.TP
|
|
|
+.I raw image
|
|
|
+format is a single binary blob of any type of firmware.
|
|
|
+
|
|
|
+.TP
|
|
|
+.I FIT (Flattened Image Tree) image
|
|
|
+format is the same as used in the new uImage format and allows for
|
|
|
+multiple binary blobs in a single capsule file.
|
|
|
+This type of image file can be generated by
|
|
|
+.BR mkimage .
|
|
|
+
|
|
|
+.SH "OPTIONS"
|
|
|
+One of
|
|
|
+.BR --fit " or " --raw
|
|
|
+option must be specified.
|
|
|
+
|
|
|
+.TP
|
|
|
+.BI "-f\fR,\fB --fit " fit-image-file
|
|
|
+Specify a FIT image file
|
|
|
+
|
|
|
+.TP
|
|
|
+.BI "-r\fR,\fB --raw " raw-image-file
|
|
|
+Specify a raw image file
|
|
|
+
|
|
|
+.TP
|
|
|
+.BI "-i\fR,\fB --index " index
|
|
|
+Specify an image index
|
|
|
+
|
|
|
+.TP
|
|
|
+.BI "-I\fR,\fB --instance " instance
|
|
|
+Specify a hardware instance
|
|
|
+
|
|
|
+.TP
|
|
|
+.BR -h ", " --help
|
|
|
+Print a help message
|
|
|
+
|
|
|
+.PP
|
|
|
+With signing,
|
|
|
+.BR --private-key ", " --certificate " and " --monotonic-count
|
|
|
+are all mandatory.
|
|
|
+
|
|
|
+.TP
|
|
|
+.BI "-p\fR,\fB --private-key " private-key-file
|
|
|
+Specify signer's private key file in PEM
|
|
|
+
|
|
|
+.TP
|
|
|
+.BI "-c\fR,\fB --certificate " certificate-file
|
|
|
+Specify signer's certificate file in EFI certificate list format
|
|
|
+
|
|
|
+.TP
|
|
|
+.BI "-m\fR,\fB --monotonic-count " count
|
|
|
+Specify a monotonic count which is set to be monotonically incremented
|
|
|
+at every firmware update.
|
|
|
+
|
|
|
+.TP
|
|
|
+.B "-d\fR,\fB --dump_sig"
|
|
|
+Dump signature data into *.p7 file
|
|
|
+
|
|
|
+.PP
|
|
|
+.SH FILES
|
|
|
+.TP
|
|
|
+.I /EFI/UpdateCapsule
|
|
|
+The directory in which all capsule files be placed
|
|
|
+
|
|
|
+.SH SEE ALSO
|
|
|
+.BR mkimage (1)
|
|
|
+
|
|
|
+.SH AUTHORS
|
|
|
+Written by AKASHI Takahiro <takahiro.akashi@linaro.org>
|
|
|
+
|
|
|
+.SH HOMEPAGE
|
|
|
+http://www.denx.de/wiki/U-Boot/WebHome
|