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 int h_compare_image_name(const void *vtype1, const void *vtype2)
30 const int *type1 = vtype1;
31 const int *type2 = vtype2;
32 const char *name1 = genimg_get_type_short_name(*type1);
33 const char *name2 = genimg_get_type_short_name(*type2);
35 return strcmp(name1, name2);
38 /* Show all image types supported by mkimage */
39 static void show_image_types(void)
41 struct image_type_params *tparams;
42 int order[IH_TYPE_COUNT];
47 /* Sort the names in order of short name for easier reading */
48 memset(order, '\0', sizeof(order));
49 for (count = 0, type = 0; type < IH_TYPE_COUNT; type++) {
50 tparams = imagetool_get_type(type);
52 order[count++] = type;
54 qsort(order, count, sizeof(int), h_compare_image_name);
56 fprintf(stderr, "\nInvalid image type. Supported image types:\n");
57 for (i = 0; i < count; i++) {
59 tparams = imagetool_get_type(type);
61 fprintf(stderr, "\t%-15s %s\n",
62 genimg_get_type_short_name(type),
63 genimg_get_type_name(type));
66 fprintf(stderr, "\n");
69 static void usage(const char *msg)
71 fprintf(stderr, "Error: %s\n", msg);
72 fprintf(stderr, "Usage: %s -l image\n"
73 " -l ==> list image header information\n",
76 " %s [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d data_file[:data_file...] image\n"
77 " -A ==> set architecture to 'arch'\n"
78 " -O ==> set operating system to 'os'\n"
79 " -T ==> set image type to 'type'\n"
80 " -C ==> set compression type 'comp'\n"
81 " -a ==> set load address to 'addr' (hex)\n"
82 " -e ==> set entry point to 'ep' (hex)\n"
83 " -n ==> set image name to 'name'\n"
84 " -d ==> use image data from 'datafile'\n"
85 " -x ==> set XIP (execute in place)\n",
88 " %s [-D dtc_options] [-f fit-image.its|-f auto|-F] [-b <dtb> [-b <dtb>]] fit-image\n"
89 " <dtb> file is used with -f auto, it may occour multiple times.\n",
92 " -D => set all options for device tree compiler\n"
93 " -f => input filename for FIT source\n");
94 #ifdef CONFIG_FIT_SIGNATURE
96 "Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-r]\n"
97 " -k => set directory containing private keys\n"
98 " -K => write public keys to this .dtb file\n"
99 " -c => add comment in signature node\n"
100 " -F => re-sign existing FIT image\n"
101 " -r => mark keys used as 'required' in dtb\n");
104 "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
106 fprintf(stderr, " %s -V ==> print version information and exit\n",
108 fprintf(stderr, "Use -T to see a list of available image types\n");
113 static int add_content(int type, const char *fname)
115 struct content_info *cont;
117 cont = calloc(1, sizeof(*cont));
122 if (params.content_tail)
123 params.content_tail->next = cont;
125 params.content_head = cont;
126 params.content_tail = cont;
131 static void process_args(int argc, char **argv)
134 int type = IH_TYPE_INVALID;
135 char *datafile = NULL;
138 while ((opt = getopt(argc, argv,
139 "a:A:b:cC:d:D:e:Ef:Fk:K:ln:O:rR:sT:vVx")) != -1) {
142 params.addr = strtoull(optarg, &ptr, 16);
144 fprintf(stderr, "%s: invalid load address %s\n",
145 params.cmdname, optarg);
150 params.arch = genimg_get_arch_id(optarg);
152 usage("Invalid architecture");
155 if (add_content(IH_TYPE_FLATDT, optarg)) {
157 "%s: Out of memory adding content '%s'",
158 params.cmdname, optarg);
163 params.comment = optarg;
166 params.comp = genimg_get_comp_id(optarg);
168 usage("Invalid compression type");
171 params.datafile = optarg;
178 params.ep = strtoull(optarg, &ptr, 16);
180 fprintf(stderr, "%s: invalid entry point %s\n",
181 params.cmdname, optarg);
187 params.external_data = true;
191 params.auto_its = !strcmp(datafile, "auto");
195 * The flattened image tree (FIT) format
196 * requires a flattened device tree image type
198 params.fit_image_type = params.type;
199 params.type = IH_TYPE_FLATDT;
203 params.keydir = optarg;
206 params.keydest = optarg;
212 params.imagename = optarg;
215 params.os = genimg_get_os_id(optarg);
217 usage("Invalid operating system");
220 params.require_keys = 1;
224 * This entry is for the second configuration
225 * file, if only one is not enough.
227 params.imagename2 = optarg;
233 type = genimg_get_type_id(optarg);
236 usage("Invalid image type");
243 printf("mkimage version %s\n", PLAIN_VERSION);
249 usage("Invalid option");
253 /* The last parameter is expected to be the imagefile */
255 params.imagefile = argv[optind];
258 * For auto-generated FIT images we need to know the image type to put
259 * in the FIT, which is separate from the file's image type (which
260 * will always be IH_TYPE_FLATDT in this case).
262 if (params.type == IH_TYPE_FLATDT) {
263 params.fit_image_type = type;
264 if (!params.auto_its)
265 params.datafile = datafile;
266 } else if (type != IH_TYPE_INVALID) {
270 if (!params.imagefile)
271 usage("Missing output filename");
275 int main(int argc, char **argv)
281 struct image_type_params *tparams = NULL;
285 params.cmdname = *argv;
289 process_args(argc, argv);
291 /* set tparams as per input type_id */
292 tparams = imagetool_get_type(params.type);
293 if (tparams == NULL) {
294 fprintf (stderr, "%s: unsupported type %s\n",
295 params.cmdname, genimg_get_type_name(params.type));
300 * check the passed arguments parameters meets the requirements
301 * as per image type to be generated/listed
303 if (tparams->check_params)
304 if (tparams->check_params (¶ms))
305 usage("Bad parameters for image type");
308 params.ep = params.addr;
309 /* If XIP, entry point must be after the U-Boot header */
311 params.ep += tparams->header_size;
315 if (tparams->fflag_handle)
317 * in some cases, some additional processing needs
318 * to be done if fflag is defined
320 * For ex. fit_handle_file for Fit file support
322 retval = tparams->fflag_handle(¶ms);
324 if (retval != EXIT_SUCCESS)
328 if (params.lflag || params.fflag) {
329 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
331 ifd = open (params.imagefile,
332 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
336 fprintf (stderr, "%s: Can't open %s: %s\n",
337 params.cmdname, params.imagefile,
342 if (params.lflag || params.fflag) {
344 * list header information of existing image
346 if (fstat(ifd, &sbuf) < 0) {
347 fprintf (stderr, "%s: Can't stat %s: %s\n",
348 params.cmdname, params.imagefile,
353 if ((unsigned)sbuf.st_size < tparams->header_size) {
355 "%s: Bad size: \"%s\" is not valid image\n",
356 params.cmdname, params.imagefile);
360 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
361 if (ptr == MAP_FAILED) {
362 fprintf (stderr, "%s: Can't read %s: %s\n",
363 params.cmdname, params.imagefile,
369 * scan through mkimage registry for all supported image types
370 * and verify the input image file header for match
371 * Print the image information for matched image type
372 * Returns the error code if not matched
374 retval = imagetool_verify_print_header(ptr, &sbuf,
377 (void) munmap((void *)ptr, sbuf.st_size);
383 if ((params.type != IH_TYPE_MULTI) && (params.type != IH_TYPE_SCRIPT)) {
384 dfd = open(params.datafile, O_RDONLY | O_BINARY);
386 fprintf(stderr, "%s: Can't open %s: %s\n",
387 params.cmdname, params.datafile,
392 if (fstat(dfd, &sbuf) < 0) {
393 fprintf(stderr, "%s: Can't stat %s: %s\n",
394 params.cmdname, params.datafile,
399 params.file_size = sbuf.st_size + tparams->header_size;
404 * In case there an header with a variable
405 * length will be added, the corresponding
406 * function is called. This is responsible to
407 * allocate memory for the header itself.
409 if (tparams->vrec_header)
410 pad_len = tparams->vrec_header(¶ms, tparams);
412 memset(tparams->hdr, 0, tparams->header_size);
414 if (write(ifd, tparams->hdr, tparams->header_size)
415 != tparams->header_size) {
416 fprintf (stderr, "%s: Write error on %s: %s\n",
417 params.cmdname, params.imagefile, strerror(errno));
421 if (!params.skipcpy) {
422 if (params.type == IH_TYPE_MULTI ||
423 params.type == IH_TYPE_SCRIPT) {
424 char *file = params.datafile;
431 if ((sep = strchr(file, ':')) != NULL) {
435 if (stat (file, &sbuf) < 0) {
436 fprintf (stderr, "%s: Can't stat %s: %s\n",
437 params.cmdname, file, strerror(errno));
440 size = cpu_to_uimage (sbuf.st_size);
445 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
446 fprintf (stderr, "%s: Write error on %s: %s\n",
447 params.cmdname, params.imagefile,
464 file = params.datafile;
467 char *sep = strchr(file, ':');
470 copy_file (ifd, file, 1);
474 copy_file (ifd, file, 0);
478 } else if (params.type == IH_TYPE_PBLIMAGE) {
479 /* PBL has special Image format, implements its' own */
480 pbl_load_uboot(ifd, ¶ms);
482 copy_file(ifd, params.datafile, pad_len);
486 /* We're a bit of paranoid */
487 #if defined(_POSIX_SYNCHRONIZED_IO) && \
488 !defined(__sun__) && \
489 !defined(__FreeBSD__) && \
490 !defined(__OpenBSD__) && \
492 (void) fdatasync (ifd);
497 if (fstat(ifd, &sbuf) < 0) {
498 fprintf (stderr, "%s: Can't stat %s: %s\n",
499 params.cmdname, params.imagefile, strerror(errno));
502 params.file_size = sbuf.st_size;
504 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
505 if (ptr == MAP_FAILED) {
506 fprintf (stderr, "%s: Can't map %s: %s\n",
507 params.cmdname, params.imagefile, strerror(errno));
511 /* Setup the image header as per input image type*/
512 if (tparams->set_header)
513 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
515 fprintf (stderr, "%s: Can't set header for %s: %s\n",
516 params.cmdname, tparams->name, strerror(errno));
520 /* Print the image information by processing image header */
521 if (tparams->print_header)
522 tparams->print_header (ptr);
524 fprintf (stderr, "%s: Can't print header for %s: %s\n",
525 params.cmdname, tparams->name, strerror(errno));
529 (void) munmap((void *)ptr, sbuf.st_size);
531 /* We're a bit of paranoid */
532 #if defined(_POSIX_SYNCHRONIZED_IO) && \
533 !defined(__sun__) && \
534 !defined(__FreeBSD__) && \
535 !defined(__OpenBSD__) && \
537 (void) fdatasync (ifd);
543 fprintf (stderr, "%s: Write error on %s: %s\n",
544 params.cmdname, params.imagefile, strerror(errno));
552 copy_file (int ifd, const char *datafile, int pad)
562 struct image_type_params *tparams = imagetool_get_type(params.type);
564 memset(zeros, 0, sizeof(zeros));
567 fprintf (stderr, "Adding Image %s\n", datafile);
570 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
571 fprintf (stderr, "%s: Can't open %s: %s\n",
572 params.cmdname, datafile, strerror(errno));
576 if (fstat(dfd, &sbuf) < 0) {
577 fprintf (stderr, "%s: Can't stat %s: %s\n",
578 params.cmdname, datafile, strerror(errno));
582 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
583 if (ptr == MAP_FAILED) {
584 fprintf (stderr, "%s: Can't read %s: %s\n",
585 params.cmdname, datafile, strerror(errno));
590 unsigned char *p = NULL;
592 * XIP: do not append the image_header_t at the
593 * beginning of the file, but consume the space
597 if ((unsigned)sbuf.st_size < tparams->header_size) {
599 "%s: Bad size: \"%s\" is too small for XIP\n",
600 params.cmdname, datafile);
604 for (p = ptr; p < ptr + tparams->header_size; p++) {
607 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
608 params.cmdname, datafile);
613 offset = tparams->header_size;
616 size = sbuf.st_size - offset;
617 if (write(ifd, ptr + offset, size) != size) {
618 fprintf (stderr, "%s: Write error on %s: %s\n",
619 params.cmdname, params.imagefile, strerror(errno));
624 if ((pad == 1) && (tail != 0)) {
626 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
627 fprintf (stderr, "%s: Write error on %s: %s\n",
628 params.cmdname, params.imagefile,
632 } else if (pad > 1) {
634 int todo = sizeof(zeros);
638 if (write(ifd, (char *)&zeros, todo) != todo) {
639 fprintf(stderr, "%s: Write error on %s: %s\n",
640 params.cmdname, params.imagefile,
648 (void) munmap((void *)ptr, sbuf.st_size);