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 .TP
  45 .BI "-g\fR,\fB --guid " guid-string
  46 Specify guid for image blob type. The format is:
  47     xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
  48
  49 The first three elements are in little endian, while the rest
  50 is in big endian.
  51
  52 .TP
  53 .BI "-i\fR,\fB --index " index
  54 Specify an image index
  55
  56 .TP
  57 .BI "-I\fR,\fB --instance " instance
  58 Specify a hardware instance
  59
  60 .TP
  61 .BR -h ", " --help
  62 Print a help message
  63
  64 .PP
  65 With signing,
  66 .BR --private-key ", " --certificate " and " --monotonic-count
  67 are all mandatory.
  68
  69 .TP
  70 .BI "-p\fR,\fB --private-key " private-key-file
  71 Specify signer's private key file in PEM
  72
  73 .TP
  74 .BI "-c\fR,\fB --certificate " certificate-file
  75 Specify signer's certificate file in EFI certificate list format
  76
  77 .TP
  78 .BI "-m\fR,\fB --monotonic-count " count
  79 Specify a monotonic count which is set to be monotonically incremented
  80 at every firmware update.
  81
  82 .TP
  83 .B "-d\fR,\fB --dump_sig"
  84 Dump signature data into *.p7 file
  85
  86 .PP
  87 .SH FILES
  88 .TP
  89 .I /EFI/UpdateCapsule
  90 The directory in which all capsule files be placed
  91
  92 .SH SEE ALSO
  93 .BR mkimage (1)
  94
  95 .SH AUTHORS
  96 Written by AKASHI Takahiro <takahiro.akashi@linaro.org>
  97
  98 .SH HOMEPAGE
  99 http://www.denx.de/wiki/U-Boot/WebHome