mkeficapsule.c 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  1. // SPDX-License-Identifier: GPL-2.0
  2. /*
  3. * Copyright 2018 Linaro Limited
  4. * Author: AKASHI Takahiro
  5. */
  6. #include <errno.h>
  7. #include <getopt.h>
  8. #include <malloc.h>
  9. #include <stdbool.h>
  10. #include <stdio.h>
  11. #include <stdlib.h>
  12. #include <string.h>
  13. #include <unistd.h>
  14. #include <linux/types.h>
  15. #include <sys/mman.h>
  16. #include <sys/stat.h>
  17. #include <sys/types.h>
  18. #include "fdt_host.h"
  19. typedef __u8 u8;
  20. typedef __u16 u16;
  21. typedef __u32 u32;
  22. typedef __u64 u64;
  23. typedef __s16 s16;
  24. typedef __s32 s32;
  25. #define aligned_u64 __aligned_u64
  26. #define SIGNATURE_NODENAME "signature"
  27. #define OVERLAY_NODENAME "__overlay__"
  28. #ifndef __packed
  29. #define __packed __attribute__((packed))
  30. #endif
  31. #include <efi.h>
  32. #include <efi_api.h>
  33. static const char *tool_name = "mkeficapsule";
  34. efi_guid_t efi_guid_fm_capsule = EFI_FIRMWARE_MANAGEMENT_CAPSULE_ID_GUID;
  35. efi_guid_t efi_guid_image_type_uboot_fit =
  36. EFI_FIRMWARE_IMAGE_TYPE_UBOOT_FIT_GUID;
  37. efi_guid_t efi_guid_image_type_uboot_raw =
  38. EFI_FIRMWARE_IMAGE_TYPE_UBOOT_RAW_GUID;
  39. static struct option options[] = {
  40. {"fit", required_argument, NULL, 'f'},
  41. {"raw", required_argument, NULL, 'r'},
  42. {"index", required_argument, NULL, 'i'},
  43. {"instance", required_argument, NULL, 'I'},
  44. {"dtb", required_argument, NULL, 'D'},
  45. {"public key", required_argument, NULL, 'K'},
  46. {"overlay", no_argument, NULL, 'O'},
  47. {"help", no_argument, NULL, 'h'},
  48. {NULL, 0, NULL, 0},
  49. };
  50. static void print_usage(void)
  51. {
  52. printf("Usage: %s [options] <output file>\n"
  53. "Options:\n"
  54. "\t-f, --fit <fit image> new FIT image file\n"
  55. "\t-r, --raw <raw image> new raw image file\n"
  56. "\t-i, --index <index> update image index\n"
  57. "\t-I, --instance <instance> update hardware instance\n"
  58. "\t-K, --public-key <key file> public key esl file\n"
  59. "\t-D, --dtb <dtb file> dtb file\n"
  60. "\t-O, --overlay the dtb file is an overlay\n"
  61. "\t-h, --help print a help message\n",
  62. tool_name);
  63. }
  64. static int fdt_add_pub_key_data(void *sptr, void *dptr, size_t key_size,
  65. bool overlay)
  66. {
  67. int parent;
  68. int ov_node;
  69. int frag_node;
  70. int ret = 0;
  71. if (overlay) {
  72. /*
  73. * The signature would be stored in the
  74. * first fragment node of the overlay
  75. */
  76. frag_node = fdt_first_subnode(dptr, 0);
  77. if (frag_node == -FDT_ERR_NOTFOUND) {
  78. fprintf(stderr,
  79. "Couldn't find the fragment node: %s\n",
  80. fdt_strerror(frag_node));
  81. goto done;
  82. }
  83. ov_node = fdt_subnode_offset(dptr, frag_node, OVERLAY_NODENAME);
  84. if (ov_node == -FDT_ERR_NOTFOUND) {
  85. fprintf(stderr,
  86. "Couldn't find the __overlay__ node: %s\n",
  87. fdt_strerror(ov_node));
  88. goto done;
  89. }
  90. } else {
  91. ov_node = 0;
  92. }
  93. parent = fdt_subnode_offset(dptr, ov_node, SIGNATURE_NODENAME);
  94. if (parent == -FDT_ERR_NOTFOUND) {
  95. parent = fdt_add_subnode(dptr, ov_node, SIGNATURE_NODENAME);
  96. if (parent < 0) {
  97. ret = parent;
  98. if (ret != -FDT_ERR_NOSPACE) {
  99. fprintf(stderr,
  100. "Couldn't create signature node: %s\n",
  101. fdt_strerror(parent));
  102. }
  103. }
  104. }
  105. if (ret)
  106. goto done;
  107. /* Write the key to the FDT node */
  108. ret = fdt_setprop(dptr, parent, "capsule-key",
  109. sptr, key_size);
  110. done:
  111. if (ret)
  112. ret = ret == -FDT_ERR_NOSPACE ? -ENOSPC : -EIO;
  113. return ret;
  114. }
  115. static int add_public_key(const char *pkey_file, const char *dtb_file,
  116. bool overlay)
  117. {
  118. int ret;
  119. int srcfd = -1;
  120. int destfd = -1;
  121. void *sptr = NULL;
  122. void *dptr = NULL;
  123. off_t src_size;
  124. struct stat pub_key;
  125. struct stat dtb;
  126. /* Find out the size of the public key */
  127. srcfd = open(pkey_file, O_RDONLY);
  128. if (srcfd == -1) {
  129. fprintf(stderr, "%s: Can't open %s: %s\n",
  130. __func__, pkey_file, strerror(errno));
  131. ret = -1;
  132. goto err;
  133. }
  134. ret = fstat(srcfd, &pub_key);
  135. if (ret == -1) {
  136. fprintf(stderr, "%s: Can't stat %s: %s\n",
  137. __func__, pkey_file, strerror(errno));
  138. ret = -1;
  139. goto err;
  140. }
  141. src_size = pub_key.st_size;
  142. /* mmap the public key esl file */
  143. sptr = mmap(0, src_size, PROT_READ, MAP_SHARED, srcfd, 0);
  144. if (sptr == MAP_FAILED) {
  145. fprintf(stderr, "%s: Failed to mmap %s:%s\n",
  146. __func__, pkey_file, strerror(errno));
  147. ret = -1;
  148. goto err;
  149. }
  150. /* Open the dest FDT */
  151. destfd = open(dtb_file, O_RDWR);
  152. if (destfd == -1) {
  153. fprintf(stderr, "%s: Can't open %s: %s\n",
  154. __func__, dtb_file, strerror(errno));
  155. ret = -1;
  156. goto err;
  157. }
  158. ret = fstat(destfd, &dtb);
  159. if (ret == -1) {
  160. fprintf(stderr, "%s: Can't stat %s: %s\n",
  161. __func__, dtb_file, strerror(errno));
  162. goto err;
  163. }
  164. dtb.st_size += src_size + 0x30;
  165. if (ftruncate(destfd, dtb.st_size)) {
  166. fprintf(stderr, "%s: Can't expand %s: %s\n",
  167. __func__, dtb_file, strerror(errno));
  168. ret = -1;
  169. goto err;
  170. }
  171. errno = 0;
  172. /* mmap the dtb file */
  173. dptr = mmap(0, dtb.st_size, PROT_READ | PROT_WRITE, MAP_SHARED,
  174. destfd, 0);
  175. if (dptr == MAP_FAILED) {
  176. fprintf(stderr, "%s: Failed to mmap %s:%s\n",
  177. __func__, dtb_file, strerror(errno));
  178. ret = -1;
  179. goto err;
  180. }
  181. if (fdt_check_header(dptr)) {
  182. fprintf(stderr, "%s: Invalid FDT header\n", __func__);
  183. ret = -1;
  184. goto err;
  185. }
  186. ret = fdt_open_into(dptr, dptr, dtb.st_size);
  187. if (ret) {
  188. fprintf(stderr, "%s: Cannot expand FDT: %s\n",
  189. __func__, fdt_strerror(ret));
  190. ret = -1;
  191. goto err;
  192. }
  193. /* Copy the esl file to the expanded FDT */
  194. ret = fdt_add_pub_key_data(sptr, dptr, src_size, overlay);
  195. if (ret < 0) {
  196. fprintf(stderr, "%s: Unable to add public key to the FDT\n",
  197. __func__);
  198. ret = -1;
  199. goto err;
  200. }
  201. ret = 0;
  202. err:
  203. if (sptr)
  204. munmap(sptr, src_size);
  205. if (dptr)
  206. munmap(dptr, dtb.st_size);
  207. if (srcfd != -1)
  208. close(srcfd);
  209. if (destfd != -1)
  210. close(destfd);
  211. return ret;
  212. }
  213. static int create_fwbin(char *path, char *bin, efi_guid_t *guid,
  214. unsigned long index, unsigned long instance)
  215. {
  216. struct efi_capsule_header header;
  217. struct efi_firmware_management_capsule_header capsule;
  218. struct efi_firmware_management_capsule_image_header image;
  219. FILE *f, *g;
  220. struct stat bin_stat;
  221. u8 *data;
  222. size_t size;
  223. u64 offset;
  224. #ifdef DEBUG
  225. printf("For output: %s\n", path);
  226. printf("\tbin: %s\n\ttype: %pUl\n", bin, guid);
  227. printf("\tindex: %ld\n\tinstance: %ld\n", index, instance);
  228. #endif
  229. g = fopen(bin, "r");
  230. if (!g) {
  231. printf("cannot open %s\n", bin);
  232. return -1;
  233. }
  234. if (stat(bin, &bin_stat) < 0) {
  235. printf("cannot determine the size of %s\n", bin);
  236. goto err_1;
  237. }
  238. data = malloc(bin_stat.st_size);
  239. if (!data) {
  240. printf("cannot allocate memory: %zx\n", (size_t)bin_stat.st_size);
  241. goto err_1;
  242. }
  243. f = fopen(path, "w");
  244. if (!f) {
  245. printf("cannot open %s\n", path);
  246. goto err_2;
  247. }
  248. header.capsule_guid = efi_guid_fm_capsule;
  249. header.header_size = sizeof(header);
  250. /* TODO: The current implementation ignores flags */
  251. header.flags = CAPSULE_FLAGS_PERSIST_ACROSS_RESET;
  252. header.capsule_image_size = sizeof(header)
  253. + sizeof(capsule) + sizeof(u64)
  254. + sizeof(image)
  255. + bin_stat.st_size;
  256. size = fwrite(&header, 1, sizeof(header), f);
  257. if (size < sizeof(header)) {
  258. printf("write failed (%zx)\n", size);
  259. goto err_3;
  260. }
  261. capsule.version = 0x00000001;
  262. capsule.embedded_driver_count = 0;
  263. capsule.payload_item_count = 1;
  264. size = fwrite(&capsule, 1, sizeof(capsule), f);
  265. if (size < (sizeof(capsule))) {
  266. printf("write failed (%zx)\n", size);
  267. goto err_3;
  268. }
  269. offset = sizeof(capsule) + sizeof(u64);
  270. size = fwrite(&offset, 1, sizeof(offset), f);
  271. if (size < sizeof(offset)) {
  272. printf("write failed (%zx)\n", size);
  273. goto err_3;
  274. }
  275. image.version = 0x00000003;
  276. memcpy(&image.update_image_type_id, guid, sizeof(*guid));
  277. image.update_image_index = index;
  278. image.reserved[0] = 0;
  279. image.reserved[1] = 0;
  280. image.reserved[2] = 0;
  281. image.update_image_size = bin_stat.st_size;
  282. image.update_vendor_code_size = 0; /* none */
  283. image.update_hardware_instance = instance;
  284. image.image_capsule_support = 0;
  285. size = fwrite(&image, 1, sizeof(image), f);
  286. if (size < sizeof(image)) {
  287. printf("write failed (%zx)\n", size);
  288. goto err_3;
  289. }
  290. size = fread(data, 1, bin_stat.st_size, g);
  291. if (size < bin_stat.st_size) {
  292. printf("read failed (%zx)\n", size);
  293. goto err_3;
  294. }
  295. size = fwrite(data, 1, bin_stat.st_size, f);
  296. if (size < bin_stat.st_size) {
  297. printf("write failed (%zx)\n", size);
  298. goto err_3;
  299. }
  300. fclose(f);
  301. fclose(g);
  302. free(data);
  303. return 0;
  304. err_3:
  305. fclose(f);
  306. err_2:
  307. free(data);
  308. err_1:
  309. fclose(g);
  310. return -1;
  311. }
  312. /*
  313. * Usage:
  314. * $ mkeficapsule -f <firmware binary> <output file>
  315. */
  316. int main(int argc, char **argv)
  317. {
  318. char *file;
  319. char *pkey_file;
  320. char *dtb_file;
  321. efi_guid_t *guid;
  322. unsigned long index, instance;
  323. int c, idx;
  324. int ret;
  325. bool overlay = false;
  326. file = NULL;
  327. pkey_file = NULL;
  328. dtb_file = NULL;
  329. guid = NULL;
  330. index = 0;
  331. instance = 0;
  332. for (;;) {
  333. c = getopt_long(argc, argv, "f:r:i:I:v:D:K:Oh", options, &idx);
  334. if (c == -1)
  335. break;
  336. switch (c) {
  337. case 'f':
  338. if (file) {
  339. printf("Image already specified\n");
  340. return -1;
  341. }
  342. file = optarg;
  343. guid = &efi_guid_image_type_uboot_fit;
  344. break;
  345. case 'r':
  346. if (file) {
  347. printf("Image already specified\n");
  348. return -1;
  349. }
  350. file = optarg;
  351. guid = &efi_guid_image_type_uboot_raw;
  352. break;
  353. case 'i':
  354. index = strtoul(optarg, NULL, 0);
  355. break;
  356. case 'I':
  357. instance = strtoul(optarg, NULL, 0);
  358. break;
  359. case 'K':
  360. if (pkey_file) {
  361. printf("Public Key already specified\n");
  362. return -1;
  363. }
  364. pkey_file = optarg;
  365. break;
  366. case 'D':
  367. if (dtb_file) {
  368. printf("DTB file already specified\n");
  369. return -1;
  370. }
  371. dtb_file = optarg;
  372. break;
  373. case 'O':
  374. overlay = true;
  375. break;
  376. case 'h':
  377. print_usage();
  378. return 0;
  379. }
  380. }
  381. /* need a fit image file or raw image file */
  382. if (!file && !pkey_file && !dtb_file) {
  383. print_usage();
  384. exit(EXIT_FAILURE);
  385. }
  386. if (pkey_file && dtb_file) {
  387. ret = add_public_key(pkey_file, dtb_file, overlay);
  388. if (ret == -1) {
  389. printf("Adding public key to the dtb failed\n");
  390. exit(EXIT_FAILURE);
  391. } else {
  392. exit(EXIT_SUCCESS);
  393. }
  394. }
  395. if (create_fwbin(argv[optind], file, guid, index, instance)
  396. < 0) {
  397. printf("Creating firmware capsule failed\n");
  398. exit(EXIT_FAILURE);
  399. }
  400. exit(EXIT_SUCCESS);
  401. }