1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2009
6 * DENX Software Engineering
7 * Wolfgang Denk, wd@denx.de
10 #include "imagetool.h"
16 #include <sys/ioctl.h>
19 static void copy_file(int, const char *, int);
21 /* parameters initialized by core will be used by the image type code */
22 static struct image_tool_params params = {
25 .type = IH_TYPE_KERNEL,
27 .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
32 static enum ih_category cur_category;
34 static int h_compare_category_name(const void *vtype1, const void *vtype2)
36 const int *type1 = vtype1;
37 const int *type2 = vtype2;
38 const char *name1 = genimg_get_cat_short_name(cur_category, *type1);
39 const char *name2 = genimg_get_cat_short_name(cur_category, *type2);
41 return strcmp(name1, name2);
44 static int show_valid_options(enum ih_category category)
51 count = genimg_get_cat_count(category);
52 order = calloc(count, sizeof(*order));
56 /* Sort the names in order of short name for easier reading */
57 for (i = 0, item = 0; i < count; i++, item++) {
58 while (!genimg_cat_has_id(category, item) && i < count) {
64 cur_category = category;
65 qsort(order, count, sizeof(int), h_compare_category_name);
67 fprintf(stderr, "\nInvalid %s, supported are:\n",
68 genimg_get_cat_desc(category));
69 for (i = 0; i < count; i++) {
71 fprintf(stderr, "\t%-15s %s\n",
72 genimg_get_cat_short_name(category, item),
73 genimg_get_cat_name(category, item));
75 fprintf(stderr, "\n");
81 static void usage(const char *msg)
83 fprintf(stderr, "Error: %s\n", msg);
84 fprintf(stderr, "Usage: %s -l image\n"
85 " -l ==> list image header information\n",
88 " %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
89 " -A ==> set architecture to 'arch'\n"
90 " -O ==> set operating system to 'os'\n"
91 " -T ==> set image type to 'type'\n"
92 " -C ==> set compression type 'comp'\n"
93 " -a ==> set load address to 'addr' (hex)\n"
94 " -e ==> set entry point to 'ep' (hex)\n"
95 " -n ==> set image name to 'name'\n"
96 " -d ==> use image data from 'datafile'\n"
97 " -x ==> set XIP (execute in place)\n",
100 " %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] [-E] [-B size] [-i <ramdisk.cpio.gz>] fit-image\n"
101 " <dtb> file is used with -f auto, it may occur multiple times.\n",
104 " -D => set all options for device tree compiler\n"
105 " -f => input filename for FIT source\n"
106 " -i => input filename for ramdisk file\n"
107 " -E => place data outside of the FIT structure\n"
108 " -B => align size in hex for FIT structure and header\n");
109 #ifdef CONFIG_FIT_SIGNATURE
111 "Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
112 " -k => set directory containing private keys\n"
113 " -K => write public keys to this .dtb file\n"
114 " -G => use this signing key (in lieu of -k)\n"
115 " -c => add comment in signature node\n"
116 " -F => re-sign existing FIT image\n"
117 " -p => place external data at a static position\n"
118 " -r => mark keys used as 'required' in dtb\n"
119 " -N => openssl engine to use for signing\n");
122 "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
124 fprintf(stderr, " %s -V ==> print version information and exit\n",
126 fprintf(stderr, "Use '-T list' to see a list of available image types\n");
131 static int add_content(int type, const char *fname)
133 struct content_info *cont;
135 cont = calloc(1, sizeof(*cont));
140 if (params.content_tail)
141 params.content_tail->next = cont;
143 params.content_head = cont;
144 params.content_tail = cont;
149 static void process_args(int argc, char **argv)
152 int type = IH_TYPE_INVALID;
153 char *datafile = NULL;
156 while ((opt = getopt(argc, argv,
157 "a:A:b:B:c:C:d:D:e:Ef:FG:k:i:K:ln:N:p:O:rR:qstT:vVx")) != -1) {
160 params.addr = strtoull(optarg, &ptr, 16);
162 fprintf(stderr, "%s: invalid load address %s\n",
163 params.cmdname, optarg);
168 params.arch = genimg_get_arch_id(optarg);
169 if (params.arch < 0) {
170 show_valid_options(IH_ARCH);
171 usage("Invalid architecture");
175 if (add_content(IH_TYPE_FLATDT, optarg)) {
177 "%s: Out of memory adding content '%s'",
178 params.cmdname, optarg);
183 params.bl_len = strtoull(optarg, &ptr, 16);
185 fprintf(stderr, "%s: invalid block length %s\n",
186 params.cmdname, optarg);
192 params.comment = optarg;
195 params.comp = genimg_get_comp_id(optarg);
196 if (params.comp < 0) {
197 show_valid_options(IH_COMP);
198 usage("Invalid compression type");
202 params.datafile = optarg;
209 params.ep = strtoull(optarg, &ptr, 16);
211 fprintf(stderr, "%s: invalid entry point %s\n",
212 params.cmdname, optarg);
218 params.external_data = true;
222 params.auto_its = !strcmp(datafile, "auto");
226 * The flattened image tree (FIT) format
227 * requires a flattened device tree image type
229 params.type = IH_TYPE_FLATDT;
233 params.keyfile = optarg;
236 params.fit_ramdisk = optarg;
239 params.keydir = optarg;
242 params.keydest = optarg;
248 params.imagename = optarg;
251 params.engine_id = optarg;
254 params.os = genimg_get_os_id(optarg);
256 show_valid_options(IH_OS);
257 usage("Invalid operating system");
261 params.external_offset = strtoull(optarg, &ptr, 16);
263 fprintf(stderr, "%s: invalid offset size %s\n",
264 params.cmdname, optarg);
272 params.require_keys = 1;
276 * This entry is for the second configuration
277 * file, if only one is not enough.
279 params.imagename2 = optarg;
285 params.reset_timestamp = 1;
288 if (strcmp(optarg, "list") == 0) {
289 show_valid_options(IH_TYPE);
292 type = genimg_get_type_id(optarg);
294 show_valid_options(IH_TYPE);
295 usage("Invalid image type");
302 printf("mkimage version %s\n", PLAIN_VERSION);
308 usage("Invalid option");
312 /* The last parameter is expected to be the imagefile */
314 params.imagefile = argv[optind];
317 * For auto-generated FIT images we need to know the image type to put
318 * in the FIT, which is separate from the file's image type (which
319 * will always be IH_TYPE_FLATDT in this case).
321 if (params.type == IH_TYPE_FLATDT) {
322 params.fit_image_type = type ? type : IH_TYPE_KERNEL;
323 /* For auto_its, datafile is always 'auto' */
324 if (!params.auto_its)
325 params.datafile = datafile;
326 else if (!params.datafile)
327 usage("Missing data file for auto-FIT (use -d)");
328 } else if (type != IH_TYPE_INVALID) {
329 if (type == IH_TYPE_SCRIPT && !params.datafile)
330 usage("Missing data file for script (use -d)");
334 if (!params.imagefile)
335 usage("Missing output filename");
338 int main(int argc, char **argv)
344 struct image_type_params *tparams = NULL;
349 params.cmdname = *argv;
353 process_args(argc, argv);
355 /* set tparams as per input type_id */
356 tparams = imagetool_get_type(params.type);
357 if (tparams == NULL) {
358 fprintf (stderr, "%s: unsupported type %s\n",
359 params.cmdname, genimg_get_type_name(params.type));
364 * check the passed arguments parameters meets the requirements
365 * as per image type to be generated/listed
367 if (tparams->check_params)
368 if (tparams->check_params (¶ms))
369 usage("Bad parameters for image type");
372 params.ep = params.addr;
373 /* If XIP, entry point must be after the U-Boot header */
375 params.ep += tparams->header_size;
379 if (tparams->fflag_handle)
381 * in some cases, some additional processing needs
382 * to be done if fflag is defined
384 * For ex. fit_handle_file for Fit file support
386 retval = tparams->fflag_handle(¶ms);
388 if (retval != EXIT_SUCCESS)
392 if (params.lflag || params.fflag) {
393 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
395 ifd = open (params.imagefile,
396 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
400 fprintf (stderr, "%s: Can't open %s: %s\n",
401 params.cmdname, params.imagefile,
406 if (params.lflag || params.fflag) {
409 * list header information of existing image
411 if (fstat(ifd, &sbuf) < 0) {
412 fprintf (stderr, "%s: Can't stat %s: %s\n",
413 params.cmdname, params.imagefile,
418 if ((sbuf.st_mode & S_IFMT) == S_IFBLK) {
420 #if defined(__linux__) && defined(_IOR) && !defined(BLKGETSIZE64)
421 #define BLKGETSIZE64 _IOR(0x12,114,size_t) /* return device size in bytes (u64 *arg) */
423 if (ioctl(ifd, BLKGETSIZE64, &size) < 0) {
425 "%s: failed to get size of block device \"%s\"\n",
426 params.cmdname, params.imagefile);
431 "%s: \"%s\" is block device, don't know how to get its size\n",
432 params.cmdname, params.imagefile);
435 } else if ((unsigned)sbuf.st_size < tparams->header_size) {
437 "%s: Bad size: \"%s\" is not valid image: size %ld < %u\n",
438 params.cmdname, params.imagefile,
439 sbuf.st_size, tparams->header_size);
445 ptr = mmap(0, size, PROT_READ, MAP_SHARED, ifd, 0);
446 if (ptr == MAP_FAILED) {
447 fprintf (stderr, "%s: Can't read %s: %s\n",
448 params.cmdname, params.imagefile,
455 * Verifies the header format based on the expected header for image
458 retval = imagetool_verify_print_header_by_type(ptr, &sbuf,
462 * When listing the image, we are not given the image type. Simply check all
463 * image types to find one that matches our header
465 retval = imagetool_verify_print_header(ptr, &sbuf,
469 (void) munmap((void *)ptr, sbuf.st_size);
475 if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
476 dfd = open(params.datafile, O_RDONLY | O_BINARY);
478 fprintf(stderr, "%s: Can't open %s: %s\n",
479 params.cmdname, params.datafile,
484 if (fstat(dfd, &sbuf) < 0) {
485 fprintf(stderr, "%s: Can't stat %s: %s\n",
486 params.cmdname, params.datafile,
491 params.file_size = sbuf.st_size + tparams->header_size;
496 * In case there an header with a variable
497 * length will be added, the corresponding
498 * function is called. This is responsible to
499 * allocate memory for the header itself.
501 if (tparams->vrec_header)
502 pad_len = tparams->vrec_header(¶ms, tparams);
504 memset(tparams->hdr, 0, tparams->header_size);
506 if (write(ifd, tparams->hdr, tparams->header_size)
507 != tparams->header_size) {
508 fprintf (stderr, "%s: Write error on %s: %s\n",
509 params.cmdname, params.imagefile, strerror(errno));
513 if (!params.skipcpy) {
514 if (params.type == IH_TYPE_MULTI ||
515 params.type == IH_TYPE_SCRIPT) {
516 char *file = params.datafile;
523 if ((sep = strchr(file, ':')) != NULL) {
527 if (stat (file, &sbuf) < 0) {
528 fprintf (stderr, "%s: Can't stat %s: %s\n",
529 params.cmdname, file, strerror(errno));
532 size = cpu_to_uimage (sbuf.st_size);
537 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
538 fprintf (stderr, "%s: Write error on %s: %s\n",
539 params.cmdname, params.imagefile,
556 file = params.datafile;
559 char *sep = strchr(file, ':');
562 copy_file (ifd, file, 1);
566 copy_file (ifd, file, 0);
570 } else if (params.type == IH_TYPE_PBLIMAGE) {
571 /* PBL has special Image format, implements its' own */
572 pbl_load_uboot(ifd, ¶ms);
573 } else if (params.type == IH_TYPE_ZYNQMPBIF) {
574 /* Image file is meta, walk through actual targets */
577 ret = zynqmpbif_copy_image(ifd, ¶ms);
580 } else if (params.type == IH_TYPE_IMX8IMAGE) {
581 /* i.MX8/8X has special Image format */
584 ret = imx8image_copy_image(ifd, ¶ms);
587 } else if (params.type == IH_TYPE_IMX8MIMAGE) {
588 /* i.MX8M has special Image format */
591 ret = imx8mimage_copy_image(ifd, ¶ms);
594 } else if ((params.type == IH_TYPE_RKSD) ||
595 (params.type == IH_TYPE_RKSPI)) {
596 /* Rockchip has special Image format */
599 ret = rockchip_copy_image(ifd, ¶ms);
603 copy_file(ifd, params.datafile, pad_len);
605 if (params.type == IH_TYPE_FIRMWARE_IVT) {
606 /* Add alignment and IVT */
607 uint32_t aligned_filesize = ALIGN(params.file_size,
609 flash_header_v2_t ivt_header = { { 0xd1, 0x2000, 0x40 },
610 params.addr, 0, 0, 0, params.addr
612 - tparams->header_size,
613 params.addr + aligned_filesize
614 - tparams->header_size
616 int i = params.file_size;
617 for (; i < aligned_filesize; i++) {
618 if (write(ifd, (char *) &i, 1) != 1) {
620 "%s: Write error on %s: %s\n",
627 if (write(ifd, &ivt_header, sizeof(flash_header_v2_t))
628 != sizeof(flash_header_v2_t)) {
629 fprintf(stderr, "%s: Write error on %s: %s\n",
638 /* We're a bit of paranoid */
639 #if defined(_POSIX_SYNCHRONIZED_IO) && \
640 !defined(__sun__) && \
641 !defined(__FreeBSD__) && \
642 !defined(__OpenBSD__) && \
644 (void) fdatasync (ifd);
649 if (fstat(ifd, &sbuf) < 0) {
650 fprintf (stderr, "%s: Can't stat %s: %s\n",
651 params.cmdname, params.imagefile, strerror(errno));
654 params.file_size = sbuf.st_size;
656 map_len = sbuf.st_size;
657 ptr = mmap(0, map_len, PROT_READ | PROT_WRITE, MAP_SHARED, ifd, 0);
658 if (ptr == MAP_FAILED) {
659 fprintf (stderr, "%s: Can't map %s: %s\n",
660 params.cmdname, params.imagefile, strerror(errno));
664 /* Setup the image header as per input image type*/
665 if (tparams->set_header)
666 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
668 fprintf (stderr, "%s: Can't set header for %s: %s\n",
669 params.cmdname, tparams->name, strerror(errno));
673 /* Print the image information by processing image header */
674 if (tparams->print_header)
675 tparams->print_header (ptr);
677 fprintf (stderr, "%s: Can't print header for %s\n",
678 params.cmdname, tparams->name);
681 (void)munmap((void *)ptr, map_len);
683 /* We're a bit of paranoid */
684 #if defined(_POSIX_SYNCHRONIZED_IO) && \
685 !defined(__sun__) && \
686 !defined(__FreeBSD__) && \
687 !defined(__OpenBSD__) && \
689 (void) fdatasync (ifd);
695 fprintf (stderr, "%s: Write error on %s: %s\n",
696 params.cmdname, params.imagefile, strerror(errno));
704 copy_file (int ifd, const char *datafile, int pad)
714 struct image_type_params *tparams = imagetool_get_type(params.type);
716 memset(zeros, 0, sizeof(zeros));
719 fprintf (stderr, "Adding Image %s\n", datafile);
722 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
723 fprintf (stderr, "%s: Can't open %s: %s\n",
724 params.cmdname, datafile, strerror(errno));
728 if (fstat(dfd, &sbuf) < 0) {
729 fprintf (stderr, "%s: Can't stat %s: %s\n",
730 params.cmdname, datafile, strerror(errno));
734 if (sbuf.st_size == 0) {
735 fprintf (stderr, "%s: Input file %s is empty, bailing out\n",
736 params.cmdname, datafile);
740 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
741 if (ptr == MAP_FAILED) {
742 fprintf (stderr, "%s: Can't read %s: %s\n",
743 params.cmdname, datafile, strerror(errno));
748 unsigned char *p = NULL;
750 * XIP: do not append the image_header_t at the
751 * beginning of the file, but consume the space
755 if ((unsigned)sbuf.st_size < tparams->header_size) {
757 "%s: Bad size: \"%s\" is too small for XIP\n",
758 params.cmdname, datafile);
762 for (p = ptr; p < ptr + tparams->header_size; p++) {
765 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
766 params.cmdname, datafile);
771 offset = tparams->header_size;
774 size = sbuf.st_size - offset;
776 ret = write(ifd, ptr + offset, size);
779 fprintf (stderr, "%s: Write error on %s: %s\n",
780 params.cmdname, params.imagefile, strerror(errno));
782 fprintf (stderr, "%s: Write only %d/%d bytes, "\
783 "probably no space left on the device\n",
784 params.cmdname, ret, size);
789 if ((pad == 1) && (tail != 0)) {
791 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
792 fprintf (stderr, "%s: Write error on %s: %s\n",
793 params.cmdname, params.imagefile,
797 } else if (pad > 1) {
799 int todo = sizeof(zeros);
803 if (write(ifd, (char *)&zeros, todo) != todo) {
804 fprintf(stderr, "%s: Write error on %s: %s\n",
805 params.cmdname, params.imagefile,
813 (void) munmap((void *)ptr, sbuf.st_size);