doc/mkeficapsule.1

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