mkeficapsule.1 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  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 "] " 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. supports two different format of image files:
  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. .SH "OPTIONS"
  33. One of
  34. .BR --fit " or " --raw
  35. option must be specified.
  36. .TP
  37. .BI "-f\fR,\fB --fit " fit-image-file
  38. Specify a FIT image file
  39. .TP
  40. .BI "-r\fR,\fB --raw " raw-image-file
  41. Specify a raw image file
  42. .TP
  43. .BI "-i\fR,\fB --index " index
  44. Specify an image index
  45. .TP
  46. .BI "-I\fR,\fB --instance " instance
  47. Specify a hardware instance
  48. .TP
  49. .BR -h ", " --help
  50. Print a help message
  51. .PP
  52. With signing,
  53. .BR --private-key ", " --certificate " and " --monotonic-count
  54. are all mandatory.
  55. .TP
  56. .BI "-p\fR,\fB --private-key " private-key-file
  57. Specify signer's private key file in PEM
  58. .TP
  59. .BI "-c\fR,\fB --certificate " certificate-file
  60. Specify signer's certificate file in EFI certificate list format
  61. .TP
  62. .BI "-m\fR,\fB --monotonic-count " count
  63. Specify a monotonic count which is set to be monotonically incremented
  64. at every firmware update.
  65. .TP
  66. .B "-d\fR,\fB --dump_sig"
  67. Dump signature data into *.p7 file
  68. .PP
  69. .SH FILES
  70. .TP
  71. .I /EFI/UpdateCapsule
  72. The directory in which all capsule files be placed
  73. .SH SEE ALSO
  74. .BR mkimage (1)
  75. .SH AUTHORS
  76. Written by AKASHI Takahiro <takahiro.akashi@linaro.org>
  77. .SH HOMEPAGE
  78. http://www.denx.de/wiki/U-Boot/WebHome