2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2009
5 * DENX Software Engineering
6 * Wolfgang Denk, wd@denx.de
8 * SPDX-License-Identifier: GPL-2.0+
15 static void copy_file(int, const char *, int);
17 /* parameters initialized by core will be used by the image type code */
18 static struct image_tool_params params = {
21 .type = IH_TYPE_KERNEL,
23 .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
28 static enum ih_category cur_category;
30 static int h_compare_category_name(const void *vtype1, const void *vtype2)
32 const int *type1 = vtype1;
33 const int *type2 = vtype2;
34 const char *name1 = genimg_get_cat_short_name(cur_category, *type1);
35 const char *name2 = genimg_get_cat_short_name(cur_category, *type2);
37 return strcmp(name1, name2);
40 static int show_valid_options(enum ih_category category)
47 count = genimg_get_cat_count(category);
48 order = calloc(count, sizeof(*order));
52 /* Sort the names in order of short name for easier reading */
53 for (item = 0; item < count; item++)
55 cur_category = category;
56 qsort(order, count, sizeof(int), h_compare_category_name);
58 fprintf(stderr, "\nInvalid %s, supported are:\n",
59 genimg_get_cat_desc(category));
60 for (i = 0; i < count; i++) {
62 fprintf(stderr, "\t%-15s %s\n",
63 genimg_get_cat_short_name(category, item),
64 genimg_get_cat_name(category, item));
66 fprintf(stderr, "\n");
71 static void usage(const char *msg)
73 fprintf(stderr, "Error: %s\n", msg);
74 fprintf(stderr, "Usage: %s -l image\n"
75 " -l ==> list image header information\n",
78 " %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
79 " -A ==> set architecture to 'arch'\n"
80 " -O ==> set operating system to 'os'\n"
81 " -T ==> set image type to 'type'\n"
82 " -C ==> set compression type 'comp'\n"
83 " -a ==> set load address to 'addr' (hex)\n"
84 " -e ==> set entry point to 'ep' (hex)\n"
85 " -n ==> set image name to 'name'\n"
86 " -d ==> use image data from 'datafile'\n"
87 " -x ==> set XIP (execute in place)\n",
90 " %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] fit-image\n"
91 " <dtb> file is used with -f auto, it may occour multiple times.\n",
94 " -D => set all options for device tree compiler\n"
95 " -f => input filename for FIT source\n");
96 #ifdef CONFIG_FIT_SIGNATURE
98 "Signing / verified boot options: [-E] [-k keydir] [-K dtb] [ -c <comment>] [-p addr] [-r]\n"
99 " -E => place data outside of the FIT structure\n"
100 " -k => set directory containing private keys\n"
101 " -K => write public keys to this .dtb file\n"
102 " -c => add comment in signature node\n"
103 " -F => re-sign existing FIT image\n"
104 " -p => place external data at a static position\n"
105 " -r => mark keys used as 'required' in dtb\n");
108 "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
110 fprintf(stderr, " %s -V ==> print version information and exit\n",
112 fprintf(stderr, "Use -T to see a list of available image types\n");
117 static int add_content(int type, const char *fname)
119 struct content_info *cont;
121 cont = calloc(1, sizeof(*cont));
126 if (params.content_tail)
127 params.content_tail->next = cont;
129 params.content_head = cont;
130 params.content_tail = cont;
135 static void process_args(int argc, char **argv)
138 int type = IH_TYPE_INVALID;
139 char *datafile = NULL;
142 while ((opt = getopt(argc, argv,
143 "a:A:b:cC:d:D:e:Ef:Fk:K:ln:p:O:rR:qsT:vVx")) != -1) {
146 params.addr = strtoull(optarg, &ptr, 16);
148 fprintf(stderr, "%s: invalid load address %s\n",
149 params.cmdname, optarg);
154 params.arch = genimg_get_arch_id(optarg);
156 usage("Invalid architecture");
159 if (add_content(IH_TYPE_FLATDT, optarg)) {
161 "%s: Out of memory adding content '%s'",
162 params.cmdname, optarg);
167 params.comment = optarg;
170 params.comp = genimg_get_comp_id(optarg);
172 usage("Invalid compression type");
175 params.datafile = optarg;
182 params.ep = strtoull(optarg, &ptr, 16);
184 fprintf(stderr, "%s: invalid entry point %s\n",
185 params.cmdname, optarg);
191 params.external_data = true;
195 params.auto_its = !strcmp(datafile, "auto");
199 * The flattened image tree (FIT) format
200 * requires a flattened device tree image type
202 params.type = IH_TYPE_FLATDT;
206 params.keydir = optarg;
209 params.keydest = optarg;
215 params.imagename = optarg;
218 params.os = genimg_get_os_id(optarg);
220 usage("Invalid operating system");
223 params.external_offset = strtoull(optarg, &ptr, 16);
225 fprintf(stderr, "%s: invalid offset size %s\n",
226 params.cmdname, optarg);
233 params.require_keys = 1;
237 * This entry is for the second configuration
238 * file, if only one is not enough.
240 params.imagename2 = optarg;
246 type = genimg_get_type_id(optarg);
248 show_valid_options(IH_TYPE);
249 usage("Invalid image type");
256 printf("mkimage version %s\n", PLAIN_VERSION);
262 usage("Invalid option");
266 /* The last parameter is expected to be the imagefile */
268 params.imagefile = argv[optind];
271 * For auto-generated FIT images we need to know the image type to put
272 * in the FIT, which is separate from the file's image type (which
273 * will always be IH_TYPE_FLATDT in this case).
275 if (params.type == IH_TYPE_FLATDT) {
276 params.fit_image_type = type ? type : IH_TYPE_KERNEL;
277 /* For auto_its, datafile is always 'auto' */
278 if (!params.auto_its)
279 params.datafile = datafile;
280 else if (!params.datafile)
281 usage("Missing data file for auto-FIT (use -d)");
282 } else if (type != IH_TYPE_INVALID) {
286 if (!params.imagefile)
287 usage("Missing output filename");
290 int main(int argc, char **argv)
296 struct image_type_params *tparams = NULL;
300 params.cmdname = *argv;
304 process_args(argc, argv);
306 /* set tparams as per input type_id */
307 tparams = imagetool_get_type(params.type);
308 if (tparams == NULL) {
309 fprintf (stderr, "%s: unsupported type %s\n",
310 params.cmdname, genimg_get_type_name(params.type));
315 * check the passed arguments parameters meets the requirements
316 * as per image type to be generated/listed
318 if (tparams->check_params)
319 if (tparams->check_params (¶ms))
320 usage("Bad parameters for image type");
323 params.ep = params.addr;
324 /* If XIP, entry point must be after the U-Boot header */
326 params.ep += tparams->header_size;
330 if (tparams->fflag_handle)
332 * in some cases, some additional processing needs
333 * to be done if fflag is defined
335 * For ex. fit_handle_file for Fit file support
337 retval = tparams->fflag_handle(¶ms);
339 if (retval != EXIT_SUCCESS)
343 if (params.lflag || params.fflag) {
344 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
346 ifd = open (params.imagefile,
347 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
351 fprintf (stderr, "%s: Can't open %s: %s\n",
352 params.cmdname, params.imagefile,
357 if (params.lflag || params.fflag) {
359 * list header information of existing image
361 if (fstat(ifd, &sbuf) < 0) {
362 fprintf (stderr, "%s: Can't stat %s: %s\n",
363 params.cmdname, params.imagefile,
368 if ((unsigned)sbuf.st_size < tparams->header_size) {
370 "%s: Bad size: \"%s\" is not valid image\n",
371 params.cmdname, params.imagefile);
375 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
376 if (ptr == MAP_FAILED) {
377 fprintf (stderr, "%s: Can't read %s: %s\n",
378 params.cmdname, params.imagefile,
384 * scan through mkimage registry for all supported image types
385 * and verify the input image file header for match
386 * Print the image information for matched image type
387 * Returns the error code if not matched
389 retval = imagetool_verify_print_header(ptr, &sbuf,
392 (void) munmap((void *)ptr, sbuf.st_size);
398 if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
399 dfd = open(params.datafile, O_RDONLY | O_BINARY);
401 fprintf(stderr, "%s: Can't open %s: %s\n",
402 params.cmdname, params.datafile,
407 if (fstat(dfd, &sbuf) < 0) {
408 fprintf(stderr, "%s: Can't stat %s: %s\n",
409 params.cmdname, params.datafile,
414 params.file_size = sbuf.st_size + tparams->header_size;
419 * In case there an header with a variable
420 * length will be added, the corresponding
421 * function is called. This is responsible to
422 * allocate memory for the header itself.
424 if (tparams->vrec_header)
425 pad_len = tparams->vrec_header(¶ms, tparams);
427 memset(tparams->hdr, 0, tparams->header_size);
429 if (write(ifd, tparams->hdr, tparams->header_size)
430 != tparams->header_size) {
431 fprintf (stderr, "%s: Write error on %s: %s\n",
432 params.cmdname, params.imagefile, strerror(errno));
436 if (!params.skipcpy) {
437 if (params.type == IH_TYPE_MULTI ||
438 params.type == IH_TYPE_SCRIPT) {
439 char *file = params.datafile;
446 if ((sep = strchr(file, ':')) != NULL) {
450 if (stat (file, &sbuf) < 0) {
451 fprintf (stderr, "%s: Can't stat %s: %s\n",
452 params.cmdname, file, strerror(errno));
455 size = cpu_to_uimage (sbuf.st_size);
460 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
461 fprintf (stderr, "%s: Write error on %s: %s\n",
462 params.cmdname, params.imagefile,
479 file = params.datafile;
482 char *sep = strchr(file, ':');
485 copy_file (ifd, file, 1);
489 copy_file (ifd, file, 0);
493 } else if (params.type == IH_TYPE_PBLIMAGE) {
494 /* PBL has special Image format, implements its' own */
495 pbl_load_uboot(ifd, ¶ms);
497 copy_file(ifd, params.datafile, pad_len);
501 /* We're a bit of paranoid */
502 #if defined(_POSIX_SYNCHRONIZED_IO) && \
503 !defined(__sun__) && \
504 !defined(__FreeBSD__) && \
505 !defined(__OpenBSD__) && \
507 (void) fdatasync (ifd);
512 if (fstat(ifd, &sbuf) < 0) {
513 fprintf (stderr, "%s: Can't stat %s: %s\n",
514 params.cmdname, params.imagefile, strerror(errno));
517 params.file_size = sbuf.st_size;
519 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
520 if (ptr == MAP_FAILED) {
521 fprintf (stderr, "%s: Can't map %s: %s\n",
522 params.cmdname, params.imagefile, strerror(errno));
526 /* Setup the image header as per input image type*/
527 if (tparams->set_header)
528 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
530 fprintf (stderr, "%s: Can't set header for %s: %s\n",
531 params.cmdname, tparams->name, strerror(errno));
535 /* Print the image information by processing image header */
536 if (tparams->print_header)
537 tparams->print_header (ptr);
539 fprintf (stderr, "%s: Can't print header for %s: %s\n",
540 params.cmdname, tparams->name, strerror(errno));
544 (void) munmap((void *)ptr, sbuf.st_size);
546 /* We're a bit of paranoid */
547 #if defined(_POSIX_SYNCHRONIZED_IO) && \
548 !defined(__sun__) && \
549 !defined(__FreeBSD__) && \
550 !defined(__OpenBSD__) && \
552 (void) fdatasync (ifd);
558 fprintf (stderr, "%s: Write error on %s: %s\n",
559 params.cmdname, params.imagefile, strerror(errno));
567 copy_file (int ifd, const char *datafile, int pad)
577 struct image_type_params *tparams = imagetool_get_type(params.type);
579 memset(zeros, 0, sizeof(zeros));
582 fprintf (stderr, "Adding Image %s\n", datafile);
585 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
586 fprintf (stderr, "%s: Can't open %s: %s\n",
587 params.cmdname, datafile, strerror(errno));
591 if (fstat(dfd, &sbuf) < 0) {
592 fprintf (stderr, "%s: Can't stat %s: %s\n",
593 params.cmdname, datafile, strerror(errno));
597 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
598 if (ptr == MAP_FAILED) {
599 fprintf (stderr, "%s: Can't read %s: %s\n",
600 params.cmdname, datafile, strerror(errno));
605 unsigned char *p = NULL;
607 * XIP: do not append the image_header_t at the
608 * beginning of the file, but consume the space
612 if ((unsigned)sbuf.st_size < tparams->header_size) {
614 "%s: Bad size: \"%s\" is too small for XIP\n",
615 params.cmdname, datafile);
619 for (p = ptr; p < ptr + tparams->header_size; p++) {
622 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
623 params.cmdname, datafile);
628 offset = tparams->header_size;
631 size = sbuf.st_size - offset;
632 if (write(ifd, ptr + offset, size) != size) {
633 fprintf (stderr, "%s: Write error on %s: %s\n",
634 params.cmdname, params.imagefile, strerror(errno));
639 if ((pad == 1) && (tail != 0)) {
641 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
642 fprintf (stderr, "%s: Write error on %s: %s\n",
643 params.cmdname, params.imagefile,
647 } else if (pad > 1) {
649 int todo = sizeof(zeros);
653 if (write(ifd, (char *)&zeros, todo) != todo) {
654 fprintf(stderr, "%s: Write error on %s: %s\n",
655 params.cmdname, params.imagefile,
663 (void) munmap((void *)ptr, sbuf.st_size);