aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAKASHI Takahiro2022-02-09 19:10:39 +0900
committerHeinrich Schuchardt2022-02-11 20:07:55 +0100
commitd9612f4426b490a5df420083b5aaf812607d4197 (patch)
tree85810db4cb18dde17e9e438de0531e6977dc8a7e /doc
parentbad58cb308acdf739e855e3336dfdf1a8d7b08a4 (diff)
tools: mkeficapsule: allow for specifying GUID explicitly
The existing options, "--fit" and "--raw," are only used to put a proper GUID in a capsule header, where GUID identifies a particular FMP (Firmware Management Protocol) driver which then would handle the firmware binary in a capsule. In fact, mkeficapsule does the exact same job in creating a capsule file whatever the firmware binary type is. To prepare for the future extension, the command syntax will be a bit modified to allow users to specify arbitrary GUID for their own FMP driver. OLD: [--fit <image> | --raw <image>] <capsule file> NEW: [--fit | --raw | --guid <guid-string>] <image> <capsule file> Signed-off-by: AKASHI Takahiro <takahiro.akashi@linaro.org> Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc')
-rw-r--r--doc/develop/uefi/uefi.rst4
-rw-r--r--doc/mkeficapsule.126
2 files changed, 21 insertions, 9 deletions
diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index 52a38c6b231..b7bf1356276 100644
--- a/doc/develop/uefi/uefi.rst
+++ b/doc/develop/uefi/uefi.rst
@@ -375,8 +375,8 @@ and used by the steps highlighted below.
--private-key CRT.key \
--certificate CRT.crt \
--index 1 --instance 0 \
- [--fit <FIT image> | --raw <raw image>] \
- <capsule_file_name>
+ [--fit | --raw | --guid <guid-string] \
+ <image_blob> <capsule_file_name>
4. Insert the signature list into a device tree in the following format::
diff --git a/doc/mkeficapsule.1 b/doc/mkeficapsule.1
index 680362f5c4e..8babb27ee8b 100644
--- a/doc/mkeficapsule.1
+++ b/doc/mkeficapsule.1
@@ -8,7 +8,7 @@ mkeficapsule \- Generate EFI capsule file for U-Boot
.SH SYNOPSIS
.B mkeficapsule
-.RI [ options "] " capsule-file
+.RI [ options "] " image-blob " " capsule-file
.SH "DESCRIPTION"
.B mkeficapsule
@@ -24,7 +24,7 @@ In this case, the update will be authenticated by verifying the signature
before applying.
.B mkeficapsule
-supports two different format of image files:
+takes any type of image files, including:
.TP
.I raw image
format is a single binary blob of any type of firmware.
@@ -36,18 +36,30 @@ multiple binary blobs in a single capsule file.
This type of image file can be generated by
.BR mkimage .
+.PP
+If you want to use other types than above two, you should explicitly
+specify a guid for the FMP driver.
+
.SH "OPTIONS"
One of
-.BR --fit " or " --raw
+.BR --fit ", " --raw " or " --guid
option must be specified.
.TP
-.BI "-f\fR,\fB --fit " fit-image-file
-Specify a FIT image file
+.BR -f ", " --fit
+Indicate that the blob is a FIT image file
.TP
-.BI "-r\fR,\fB --raw " raw-image-file
-Specify a raw image file
+.BR -r ", " --raw
+Indicate that the blob is a raw image file
+
+.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.
.TP
.BI "-i\fR,\fB --index " index