mirror of
https://xff.cz/git/u-boot/
synced 2025-10-31 18:35:42 +01:00
a13b92ae6f
* Indicate the location of the directory for EFI capsules. * Improve the readability. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
120 lines
2.9 KiB
Groff
120 lines
2.9 KiB
Groff
.\" 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 ] " " [ image-blob ] " " capsule-file
|
|
|
|
.SH "DESCRIPTION"
|
|
The
|
|
.B mkeficapsule
|
|
command is used to create an EFI capsule file to be used by U-Boot for firmware
|
|
updates.
|
|
A capsule file may contain various types of firmware blobs which are to be
|
|
applied to the system.
|
|
If a capsule file is placed in the /EFI/CapusuleUpdate directory of the EFI
|
|
system partition, U-Boot will try to execute the update at the 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.
|
|
|
|
Additionally, an empty capsule file can be generated to indicate the acceptance
|
|
or rejection of firmware images by a governing component like an operating
|
|
system.
|
|
Empty capsules do not require an image-blob input file.
|
|
|
|
.B mkeficapsule
|
|
takes any type of image files when generating non empty capsules, including:
|
|
.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"
|
|
|
|
.TP
|
|
.BI "-g\fR,\fB --guid " guid-string
|
|
Specify guid for image blob type. The format is:
|
|
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
|
|
|
|
The first three elements are in little endian, while the rest
|
|
is in big endian. The option must be specified for all non empty and
|
|
image acceptance capsules
|
|
|
|
.TP
|
|
.BI "-i\fR,\fB --index " index
|
|
Specify an image index
|
|
|
|
.TP
|
|
.BI "-I\fR,\fB --instance " instance
|
|
Specify a hardware instance
|
|
|
|
.PP
|
|
For generation of firmware accept empty capsule
|
|
.BR --guid
|
|
is mandatory
|
|
.TP
|
|
.BI "-A\fR,\fB --fw-accept "
|
|
Generate a firmware acceptance empty capsule
|
|
|
|
.TP
|
|
.BI "-R\fR,\fB --fw-revert "
|
|
Generate a firmware revert empty capsule
|
|
|
|
.TP
|
|
.BI "-o\fR,\fB --capoemflag "
|
|
Capsule OEM flag, value between 0x0000 to 0xffff
|
|
|
|
.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
|