2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2009
5 * DENX Software Engineering
8 * SPDX-License-Identifier: GPL-2.0+
16 static void copy_file(int, const char *, int);
18 /* parameters initialized by core will be used by the image type code */
19 static struct image_tool_params params = {
22 .type = IH_TYPE_KERNEL,
24 .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
29 static enum ih_category cur_category;
31 static int h_compare_category_name(const void *vtype1, const void *vtype2)
33 const int *type1 = vtype1;
34 const int *type2 = vtype2;
35 const char *name1 = genimg_get_cat_short_name(cur_category, *type1);
36 const char *name2 = genimg_get_cat_short_name(cur_category, *type2);
38 return strcmp(name1, name2);
41 static int show_valid_options(enum ih_category category)
48 count = genimg_get_cat_count(category);
49 order = calloc(count, sizeof(*order));
53 /* Sort the names in order of short name for easier reading */
54 for (item = 0; item < count; item++)
56 cur_category = category;
57 qsort(order, count, sizeof(int), h_compare_category_name);
59 fprintf(stderr, "\nInvalid %s, supported are:\n",
60 genimg_get_cat_desc(category));
61 for (i = 0; i < count; i++) {
63 fprintf(stderr, "\t%-15s %s\n",
64 genimg_get_cat_short_name(category, item),
65 genimg_get_cat_name(category, item));
67 fprintf(stderr, "\n");
73 static void usage(const char *msg)
75 fprintf(stderr, "Error: %s\n", msg);
76 fprintf(stderr, "Usage: %s -l image\n"
77 " -l ==> list image header information\n",
80 " %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
81 " -A ==> set architecture to 'arch'\n"
82 " -O ==> set operating system to 'os'\n"
83 " -T ==> set image type to 'type'\n"
84 " -C ==> set compression type 'comp'\n"
85 " -a ==> set load address to 'addr' (hex)\n"
86 " -e ==> set entry point to 'ep' (hex)\n"
87 " -n ==> set image name to 'name'\n"
88 " -d ==> use image data from 'datafile'\n"
89 " -x ==> set XIP (execute in place)\n",
92 " %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] [-i <ramdisk.cpio.gz>] fit-image\n"
93 " <dtb> file is used with -f auto, it may occur multiple times.\n",
96 " -D => set all options for device tree compiler\n"
97 " -f => input filename for FIT source\n"
98 " -i => input filename for ramdisk file\n");
99 #ifdef CONFIG_FIT_SIGNATURE
101 "Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r] [-N engine]\n"
102 " -E => place data outside of the FIT structure\n"
103 " -k => set directory containing private keys\n"
104 " -K => write public keys to this .dtb file\n"
105 " -c => add comment in signature node\n"
106 " -F => re-sign existing FIT image\n"
107 " -p => place external data at a static position\n"
108 " -r => mark keys used as 'required' in dtb\n"
109 " -N => engine to use for signing (pkcs11)\n");
112 "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
114 fprintf(stderr, " %s -V ==> print version information and exit\n",
116 fprintf(stderr, "Use '-T list' to see a list of available image types\n");
121 static int add_content(int type, const char *fname)
123 struct content_info *cont;
125 cont = calloc(1, sizeof(*cont));
130 if (params.content_tail)
131 params.content_tail->next = cont;
133 params.content_head = cont;
134 params.content_tail = cont;
139 static void process_args(int argc, char **argv)
142 int type = IH_TYPE_INVALID;
143 char *datafile = NULL;
146 while ((opt = getopt(argc, argv,
147 "a:A:b:c:C:d:D:e:Ef:Fk:i:K:ln:N:p:O:rR:qsT:vVx")) != -1) {
150 params.addr = strtoull(optarg, &ptr, 16);
152 fprintf(stderr, "%s: invalid load address %s\n",
153 params.cmdname, optarg);
158 params.arch = genimg_get_arch_id(optarg);
159 if (params.arch < 0) {
160 show_valid_options(IH_ARCH);
161 usage("Invalid architecture");
165 if (add_content(IH_TYPE_FLATDT, optarg)) {
167 "%s: Out of memory adding content '%s'",
168 params.cmdname, optarg);
173 params.comment = optarg;
176 params.comp = genimg_get_comp_id(optarg);
177 if (params.comp < 0) {
178 show_valid_options(IH_COMP);
179 usage("Invalid compression type");
183 params.datafile = optarg;
190 params.ep = strtoull(optarg, &ptr, 16);
192 fprintf(stderr, "%s: invalid entry point %s\n",
193 params.cmdname, optarg);
199 params.external_data = true;
203 params.auto_its = !strcmp(datafile, "auto");
207 * The flattened image tree (FIT) format
208 * requires a flattened device tree image type
210 params.type = IH_TYPE_FLATDT;
214 params.fit_ramdisk = optarg;
217 params.keydir = optarg;
220 params.keydest = optarg;
226 params.imagename = optarg;
229 params.engine_id = optarg;
232 params.os = genimg_get_os_id(optarg);
234 show_valid_options(IH_OS);
235 usage("Invalid operating system");
239 params.external_offset = strtoull(optarg, &ptr, 16);
241 fprintf(stderr, "%s: invalid offset size %s\n",
242 params.cmdname, optarg);
250 params.require_keys = 1;
254 * This entry is for the second configuration
255 * file, if only one is not enough.
257 params.imagename2 = optarg;
263 if (strcmp(optarg, "list") == 0) {
264 show_valid_options(IH_TYPE);
267 type = genimg_get_type_id(optarg);
269 show_valid_options(IH_TYPE);
270 usage("Invalid image type");
277 printf("mkimage version %s\n", PLAIN_VERSION);
283 usage("Invalid option");
287 /* The last parameter is expected to be the imagefile */
289 params.imagefile = argv[optind];
292 * For auto-generated FIT images we need to know the image type to put
293 * in the FIT, which is separate from the file's image type (which
294 * will always be IH_TYPE_FLATDT in this case).
296 if (params.type == IH_TYPE_FLATDT) {
297 params.fit_image_type = type ? type : IH_TYPE_KERNEL;
298 /* For auto_its, datafile is always 'auto' */
299 if (!params.auto_its)
300 params.datafile = datafile;
301 else if (!params.datafile)
302 usage("Missing data file for auto-FIT (use -d)");
303 } else if (type != IH_TYPE_INVALID) {
304 if (type == IH_TYPE_SCRIPT && !params.datafile)
305 usage("Missing data file for script (use -d)");
309 if (!params.imagefile)
310 usage("Missing output filename");
313 int main(int argc, char **argv)
319 struct image_type_params *tparams = NULL;
323 params.cmdname = *argv;
327 process_args(argc, argv);
329 /* set tparams as per input type_id */
330 tparams = imagetool_get_type(params.type);
331 if (tparams == NULL) {
332 fprintf (stderr, "%s: unsupported type %s\n",
333 params.cmdname, genimg_get_type_name(params.type));
338 * check the passed arguments parameters meets the requirements
339 * as per image type to be generated/listed
341 if (tparams->check_params)
342 if (tparams->check_params (¶ms))
343 usage("Bad parameters for image type");
346 params.ep = params.addr;
347 /* If XIP, entry point must be after the U-Boot header */
349 params.ep += tparams->header_size;
353 if (tparams->fflag_handle)
355 * in some cases, some additional processing needs
356 * to be done if fflag is defined
358 * For ex. fit_handle_file for Fit file support
360 retval = tparams->fflag_handle(¶ms);
362 if (retval != EXIT_SUCCESS)
366 if (params.lflag || params.fflag) {
367 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
369 ifd = open (params.imagefile,
370 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
374 fprintf (stderr, "%s: Can't open %s: %s\n",
375 params.cmdname, params.imagefile,
380 if (params.lflag || params.fflag) {
382 * list header information of existing image
384 if (fstat(ifd, &sbuf) < 0) {
385 fprintf (stderr, "%s: Can't stat %s: %s\n",
386 params.cmdname, params.imagefile,
391 if ((unsigned)sbuf.st_size < tparams->header_size) {
393 "%s: Bad size: \"%s\" is not valid image\n",
394 params.cmdname, params.imagefile);
398 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
399 if (ptr == MAP_FAILED) {
400 fprintf (stderr, "%s: Can't read %s: %s\n",
401 params.cmdname, params.imagefile,
407 * scan through mkimage registry for all supported image types
408 * and verify the input image file header for match
409 * Print the image information for matched image type
410 * Returns the error code if not matched
412 retval = imagetool_verify_print_header(ptr, &sbuf,
415 (void) munmap((void *)ptr, sbuf.st_size);
421 if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
422 dfd = open(params.datafile, O_RDONLY | O_BINARY);
424 fprintf(stderr, "%s: Can't open %s: %s\n",
425 params.cmdname, params.datafile,
430 if (fstat(dfd, &sbuf) < 0) {
431 fprintf(stderr, "%s: Can't stat %s: %s\n",
432 params.cmdname, params.datafile,
437 params.file_size = sbuf.st_size + tparams->header_size;
442 * In case there an header with a variable
443 * length will be added, the corresponding
444 * function is called. This is responsible to
445 * allocate memory for the header itself.
447 if (tparams->vrec_header)
448 pad_len = tparams->vrec_header(¶ms, tparams);
450 memset(tparams->hdr, 0, tparams->header_size);
452 if (write(ifd, tparams->hdr, tparams->header_size)
453 != tparams->header_size) {
454 fprintf (stderr, "%s: Write error on %s: %s\n",
455 params.cmdname, params.imagefile, strerror(errno));
459 if (!params.skipcpy) {
460 if (params.type == IH_TYPE_MULTI ||
461 params.type == IH_TYPE_SCRIPT) {
462 char *file = params.datafile;
469 if ((sep = strchr(file, ':')) != NULL) {
473 if (stat (file, &sbuf) < 0) {
474 fprintf (stderr, "%s: Can't stat %s: %s\n",
475 params.cmdname, file, strerror(errno));
478 size = cpu_to_uimage (sbuf.st_size);
483 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
484 fprintf (stderr, "%s: Write error on %s: %s\n",
485 params.cmdname, params.imagefile,
502 file = params.datafile;
505 char *sep = strchr(file, ':');
508 copy_file (ifd, file, 1);
512 copy_file (ifd, file, 0);
516 } else if (params.type == IH_TYPE_PBLIMAGE) {
517 /* PBL has special Image format, implements its' own */
518 pbl_load_uboot(ifd, ¶ms);
520 copy_file(ifd, params.datafile, pad_len);
522 if (params.type == IH_TYPE_FIRMWARE_IVT) {
523 /* Add alignment and IVT */
524 uint32_t aligned_filesize = (params.file_size + 0x1000
525 - 1) & ~(0x1000 - 1);
526 flash_header_v2_t ivt_header = { { 0xd1, 0x2000, 0x40 },
527 params.addr, 0, 0, 0, params.addr
529 - tparams->header_size,
530 params.addr + aligned_filesize
531 - tparams->header_size
533 int i = params.file_size;
534 for (; i < aligned_filesize; i++) {
535 if (write(ifd, (char *) &i, 1) != 1) {
537 "%s: Write error on %s: %s\n",
544 if (write(ifd, &ivt_header, sizeof(flash_header_v2_t))
545 != sizeof(flash_header_v2_t)) {
546 fprintf(stderr, "%s: Write error on %s: %s\n",
555 /* We're a bit of paranoid */
556 #if defined(_POSIX_SYNCHRONIZED_IO) && \
557 !defined(__sun__) && \
558 !defined(__FreeBSD__) && \
559 !defined(__OpenBSD__) && \
561 (void) fdatasync (ifd);
566 if (fstat(ifd, &sbuf) < 0) {
567 fprintf (stderr, "%s: Can't stat %s: %s\n",
568 params.cmdname, params.imagefile, strerror(errno));
571 params.file_size = sbuf.st_size;
573 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
574 if (ptr == MAP_FAILED) {
575 fprintf (stderr, "%s: Can't map %s: %s\n",
576 params.cmdname, params.imagefile, strerror(errno));
580 /* Setup the image header as per input image type*/
581 if (tparams->set_header)
582 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
584 fprintf (stderr, "%s: Can't set header for %s: %s\n",
585 params.cmdname, tparams->name, strerror(errno));
589 /* Print the image information by processing image header */
590 if (tparams->print_header)
591 tparams->print_header (ptr);
593 fprintf (stderr, "%s: Can't print header for %s\n",
594 params.cmdname, tparams->name);
597 (void) munmap((void *)ptr, sbuf.st_size);
599 /* We're a bit of paranoid */
600 #if defined(_POSIX_SYNCHRONIZED_IO) && \
601 !defined(__sun__) && \
602 !defined(__FreeBSD__) && \
603 !defined(__OpenBSD__) && \
605 (void) fdatasync (ifd);
611 fprintf (stderr, "%s: Write error on %s: %s\n",
612 params.cmdname, params.imagefile, strerror(errno));
620 copy_file (int ifd, const char *datafile, int pad)
630 struct image_type_params *tparams = imagetool_get_type(params.type);
632 memset(zeros, 0, sizeof(zeros));
635 fprintf (stderr, "Adding Image %s\n", datafile);
638 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
639 fprintf (stderr, "%s: Can't open %s: %s\n",
640 params.cmdname, datafile, strerror(errno));
644 if (fstat(dfd, &sbuf) < 0) {
645 fprintf (stderr, "%s: Can't stat %s: %s\n",
646 params.cmdname, datafile, strerror(errno));
650 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
651 if (ptr == MAP_FAILED) {
652 fprintf (stderr, "%s: Can't read %s: %s\n",
653 params.cmdname, datafile, strerror(errno));
658 unsigned char *p = NULL;
660 * XIP: do not append the image_header_t at the
661 * beginning of the file, but consume the space
665 if ((unsigned)sbuf.st_size < tparams->header_size) {
667 "%s: Bad size: \"%s\" is too small for XIP\n",
668 params.cmdname, datafile);
672 for (p = ptr; p < ptr + tparams->header_size; p++) {
675 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
676 params.cmdname, datafile);
681 offset = tparams->header_size;
684 size = sbuf.st_size - offset;
685 if (write(ifd, ptr + offset, size) != size) {
686 fprintf (stderr, "%s: Write error on %s: %s\n",
687 params.cmdname, params.imagefile, strerror(errno));
692 if ((pad == 1) && (tail != 0)) {
694 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
695 fprintf (stderr, "%s: Write error on %s: %s\n",
696 params.cmdname, params.imagefile,
700 } else if (pad > 1) {
702 int todo = sizeof(zeros);
706 if (write(ifd, (char *)&zeros, todo) != todo) {
707 fprintf(stderr, "%s: Write error on %s: %s\n",
708 params.cmdname, params.imagefile,
716 (void) munmap((void *)ptr, sbuf.st_size);