Gitiles
Code Review Sign In
git01.mediatek.com / filogic / uboot / ebedc94c76eb8c88b3f57efb4222798b028e1436 / . / doc / mkeficapsule.1
blob: 8babb27ee8b22000c1883499c356475cf31a9bd5 [file] [log] [blame]
AKASHI Takahiro7889a992022-02-09 19:10:36 +0900[diff] [blame]1.\" SPDX-License-Identifier: GPL-2.0+
2.\" Copyright (c) 2021, Linaro Limited
3.\" written by AKASHI Takahiro <takahiro.akashi@linaro.org>
4.TH MAEFICAPSULE 1 "May 2021"
5
6.SH NAME
7mkeficapsule \- Generate EFI capsule file for U-Boot
8
9.SH SYNOPSIS
10.B mkeficapsule
AKASHI Takahiroba212432022-02-09 19:10:39 +0900[diff] [blame]11.RI [ options "] " image-blob " " capsule-file
AKASHI Takahiro7889a992022-02-09 19:10:36 +0900[diff] [blame]12
13.SH "DESCRIPTION"
14.B mkeficapsule
15command is used to create an EFI capsule file for use with the U-Boot
16EFI capsule update.
17A capsule file may contain various type of firmware blobs which
18are to be applied to the system and must be placed in the specific
19directory on the UEFI system partition.
20An update will be automatically executed at next reboot.
21
22Optionally, a capsule file can be signed with a given private key.
23In this case, the update will be authenticated by verifying the signature
24before applying.
25
26.B mkeficapsule
AKASHI Takahiroba212432022-02-09 19:10:39 +0900[diff] [blame]27takes any type of image files, including:
AKASHI Takahiro7889a992022-02-09 19:10:36 +0900[diff] [blame]28.TP
29.I raw image
30format is a single binary blob of any type of firmware.
31
32.TP
33.I FIT (Flattened Image Tree) image
34format is the same as used in the new uImage format and allows for
35multiple binary blobs in a single capsule file.
36This type of image file can be generated by
37.BR mkimage .
38
AKASHI Takahiroba212432022-02-09 19:10:39 +0900[diff] [blame]39.PP
40If you want to use other types than above two, you should explicitly
41specify a guid for the FMP driver.
42
AKASHI Takahiro7889a992022-02-09 19:10:36 +0900[diff] [blame]43.SH "OPTIONS"
44One of
AKASHI Takahiroba212432022-02-09 19:10:39 +0900[diff] [blame]45.BR --fit ", " --raw " or " --guid
AKASHI Takahiro7889a992022-02-09 19:10:36 +0900[diff] [blame]46option must be specified.
47
48.TP
AKASHI Takahiroba212432022-02-09 19:10:39 +0900[diff] [blame]49.BR -f ", " --fit
50Indicate that the blob is a FIT image file
51
52.TP
53.BR -r ", " --raw
54Indicate that the blob is a raw image file
AKASHI Takahiro7889a992022-02-09 19:10:36 +0900[diff] [blame]55
56.TP
AKASHI Takahiroba212432022-02-09 19:10:39 +0900[diff] [blame]57.BI "-g\fR,\fB --guid " guid-string
58Specify guid for image blob type. The format is:
59 xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
60
61The first three elements are in little endian, while the rest
62is in big endian.
AKASHI Takahiro7889a992022-02-09 19:10:36 +0900[diff] [blame]63
64.TP
65.BI "-i\fR,\fB --index " index
66Specify an image index
67
68.TP
69.BI "-I\fR,\fB --instance " instance
70Specify a hardware instance
71
72.TP
73.BR -h ", " --help
74Print a help message
75
76.PP
77With signing,
78.BR --private-key ", " --certificate " and " --monotonic-count
79are all mandatory.
80
81.TP
82.BI "-p\fR,\fB --private-key " private-key-file
83Specify signer's private key file in PEM
84
85.TP
86.BI "-c\fR,\fB --certificate " certificate-file
87Specify signer's certificate file in EFI certificate list format
88
89.TP
90.BI "-m\fR,\fB --monotonic-count " count
91Specify a monotonic count which is set to be monotonically incremented
92at every firmware update.
93
94.TP
95.B "-d\fR,\fB --dump_sig"
96Dump signature data into *.p7 file
97
98.PP
99.SH FILES
100.TP
101.I /EFI/UpdateCapsule
102The directory in which all capsule files be placed
103
104.SH SEE ALSO
105.BR mkimage (1)
106
107.SH AUTHORS
108Written by AKASHI Takahiro <takahiro.akashi@linaro.org>
109
110.SH HOMEPAGE
111http://www.denx.de/wiki/U-Boot/WebHome