mkeficapsule.1 2.6 KB

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