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+
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 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 type
= genimg_get_type_id(optarg
);
265 show_valid_options(IH_TYPE
);
266 usage("Invalid image type");
273 printf("mkimage version %s\n", PLAIN_VERSION
);
279 usage("Invalid option");
283 /* The last parameter is expected to be the imagefile */
285 params
.imagefile
= argv
[optind
];
288 * For auto-generated FIT images we need to know the image type to put
289 * in the FIT, which is separate from the file's image type (which
290 * will always be IH_TYPE_FLATDT in this case).
292 if (params
.type
== IH_TYPE_FLATDT
) {
293 params
.fit_image_type
= type
? type
: IH_TYPE_KERNEL
;
294 /* For auto_its, datafile is always 'auto' */
295 if (!params
.auto_its
)
296 params
.datafile
= datafile
;
297 else if (!params
.datafile
)
298 usage("Missing data file for auto-FIT (use -d)");
299 } else if (type
!= IH_TYPE_INVALID
) {
303 if (!params
.imagefile
)
304 usage("Missing output filename");
307 int main(int argc
, char **argv
)
313 struct image_type_params
*tparams
= NULL
;
317 params
.cmdname
= *argv
;
321 process_args(argc
, argv
);
323 /* set tparams as per input type_id */
324 tparams
= imagetool_get_type(params
.type
);
325 if (tparams
== NULL
) {
326 fprintf (stderr
, "%s: unsupported type %s\n",
327 params
.cmdname
, genimg_get_type_name(params
.type
));
332 * check the passed arguments parameters meets the requirements
333 * as per image type to be generated/listed
335 if (tparams
->check_params
)
336 if (tparams
->check_params (¶ms
))
337 usage("Bad parameters for image type");
340 params
.ep
= params
.addr
;
341 /* If XIP, entry point must be after the U-Boot header */
343 params
.ep
+= tparams
->header_size
;
347 if (tparams
->fflag_handle
)
349 * in some cases, some additional processing needs
350 * to be done if fflag is defined
352 * For ex. fit_handle_file for Fit file support
354 retval
= tparams
->fflag_handle(¶ms
);
356 if (retval
!= EXIT_SUCCESS
)
360 if (params
.lflag
|| params
.fflag
) {
361 ifd
= open (params
.imagefile
, O_RDONLY
|O_BINARY
);
363 ifd
= open (params
.imagefile
,
364 O_RDWR
|O_CREAT
|O_TRUNC
|O_BINARY
, 0666);
368 fprintf (stderr
, "%s: Can't open %s: %s\n",
369 params
.cmdname
, params
.imagefile
,
374 if (params
.lflag
|| params
.fflag
) {
376 * list header information of existing image
378 if (fstat(ifd
, &sbuf
) < 0) {
379 fprintf (stderr
, "%s: Can't stat %s: %s\n",
380 params
.cmdname
, params
.imagefile
,
385 if ((unsigned)sbuf
.st_size
< tparams
->header_size
) {
387 "%s: Bad size: \"%s\" is not valid image\n",
388 params
.cmdname
, params
.imagefile
);
392 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
, MAP_SHARED
, ifd
, 0);
393 if (ptr
== MAP_FAILED
) {
394 fprintf (stderr
, "%s: Can't read %s: %s\n",
395 params
.cmdname
, params
.imagefile
,
401 * scan through mkimage registry for all supported image types
402 * and verify the input image file header for match
403 * Print the image information for matched image type
404 * Returns the error code if not matched
406 retval
= imagetool_verify_print_header(ptr
, &sbuf
,
409 (void) munmap((void *)ptr
, sbuf
.st_size
);
415 if ((params
.type
!= IH_TYPE_MULTI
) && (params
.type
!= IH_TYPE_SCRIPT
)) {
416 dfd
= open(params
.datafile
, O_RDONLY
| O_BINARY
);
418 fprintf(stderr
, "%s: Can't open %s: %s\n",
419 params
.cmdname
, params
.datafile
,
424 if (fstat(dfd
, &sbuf
) < 0) {
425 fprintf(stderr
, "%s: Can't stat %s: %s\n",
426 params
.cmdname
, params
.datafile
,
431 params
.file_size
= sbuf
.st_size
+ tparams
->header_size
;
436 * In case there an header with a variable
437 * length will be added, the corresponding
438 * function is called. This is responsible to
439 * allocate memory for the header itself.
441 if (tparams
->vrec_header
)
442 pad_len
= tparams
->vrec_header(¶ms
, tparams
);
444 memset(tparams
->hdr
, 0, tparams
->header_size
);
446 if (write(ifd
, tparams
->hdr
, tparams
->header_size
)
447 != tparams
->header_size
) {
448 fprintf (stderr
, "%s: Write error on %s: %s\n",
449 params
.cmdname
, params
.imagefile
, strerror(errno
));
453 if (!params
.skipcpy
) {
454 if (params
.type
== IH_TYPE_MULTI
||
455 params
.type
== IH_TYPE_SCRIPT
) {
456 char *file
= params
.datafile
;
463 if ((sep
= strchr(file
, ':')) != NULL
) {
467 if (stat (file
, &sbuf
) < 0) {
468 fprintf (stderr
, "%s: Can't stat %s: %s\n",
469 params
.cmdname
, file
, strerror(errno
));
472 size
= cpu_to_uimage (sbuf
.st_size
);
477 if (write(ifd
, (char *)&size
, sizeof(size
)) != sizeof(size
)) {
478 fprintf (stderr
, "%s: Write error on %s: %s\n",
479 params
.cmdname
, params
.imagefile
,
496 file
= params
.datafile
;
499 char *sep
= strchr(file
, ':');
502 copy_file (ifd
, file
, 1);
506 copy_file (ifd
, file
, 0);
510 } else if (params
.type
== IH_TYPE_PBLIMAGE
) {
511 /* PBL has special Image format, implements its' own */
512 pbl_load_uboot(ifd
, ¶ms
);
514 copy_file(ifd
, params
.datafile
, pad_len
);
516 if (params
.type
== IH_TYPE_FIRMWARE_IVT
) {
517 /* Add alignment and IVT */
518 uint32_t aligned_filesize
= (params
.file_size
+ 0x1000
519 - 1) & ~(0x1000 - 1);
520 flash_header_v2_t ivt_header
= { { 0xd1, 0x2000, 0x40 },
521 params
.addr
, 0, 0, 0, params
.addr
523 - tparams
->header_size
,
524 params
.addr
+ aligned_filesize
525 - tparams
->header_size
527 int i
= params
.file_size
;
528 for (; i
< aligned_filesize
; i
++) {
529 if (write(ifd
, (char *) &i
, 1) != 1) {
531 "%s: Write error on %s: %s\n",
538 if (write(ifd
, &ivt_header
, sizeof(flash_header_v2_t
))
539 != sizeof(flash_header_v2_t
)) {
540 fprintf(stderr
, "%s: Write error on %s: %s\n",
549 /* We're a bit of paranoid */
550 #if defined(_POSIX_SYNCHRONIZED_IO) && \
551 !defined(__sun__) && \
552 !defined(__FreeBSD__) && \
553 !defined(__OpenBSD__) && \
555 (void) fdatasync (ifd
);
560 if (fstat(ifd
, &sbuf
) < 0) {
561 fprintf (stderr
, "%s: Can't stat %s: %s\n",
562 params
.cmdname
, params
.imagefile
, strerror(errno
));
565 params
.file_size
= sbuf
.st_size
;
567 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
|PROT_WRITE
, MAP_SHARED
, ifd
, 0);
568 if (ptr
== MAP_FAILED
) {
569 fprintf (stderr
, "%s: Can't map %s: %s\n",
570 params
.cmdname
, params
.imagefile
, strerror(errno
));
574 /* Setup the image header as per input image type*/
575 if (tparams
->set_header
)
576 tparams
->set_header (ptr
, &sbuf
, ifd
, ¶ms
);
578 fprintf (stderr
, "%s: Can't set header for %s: %s\n",
579 params
.cmdname
, tparams
->name
, strerror(errno
));
583 /* Print the image information by processing image header */
584 if (tparams
->print_header
)
585 tparams
->print_header (ptr
);
587 fprintf (stderr
, "%s: Can't print header for %s: %s\n",
588 params
.cmdname
, tparams
->name
, strerror(errno
));
592 (void) munmap((void *)ptr
, sbuf
.st_size
);
594 /* We're a bit of paranoid */
595 #if defined(_POSIX_SYNCHRONIZED_IO) && \
596 !defined(__sun__) && \
597 !defined(__FreeBSD__) && \
598 !defined(__OpenBSD__) && \
600 (void) fdatasync (ifd
);
606 fprintf (stderr
, "%s: Write error on %s: %s\n",
607 params
.cmdname
, params
.imagefile
, strerror(errno
));
615 copy_file (int ifd
, const char *datafile
, int pad
)
625 struct image_type_params
*tparams
= imagetool_get_type(params
.type
);
627 memset(zeros
, 0, sizeof(zeros
));
630 fprintf (stderr
, "Adding Image %s\n", datafile
);
633 if ((dfd
= open(datafile
, O_RDONLY
|O_BINARY
)) < 0) {
634 fprintf (stderr
, "%s: Can't open %s: %s\n",
635 params
.cmdname
, datafile
, strerror(errno
));
639 if (fstat(dfd
, &sbuf
) < 0) {
640 fprintf (stderr
, "%s: Can't stat %s: %s\n",
641 params
.cmdname
, datafile
, strerror(errno
));
645 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
, MAP_SHARED
, dfd
, 0);
646 if (ptr
== MAP_FAILED
) {
647 fprintf (stderr
, "%s: Can't read %s: %s\n",
648 params
.cmdname
, datafile
, strerror(errno
));
653 unsigned char *p
= NULL
;
655 * XIP: do not append the image_header_t at the
656 * beginning of the file, but consume the space
660 if ((unsigned)sbuf
.st_size
< tparams
->header_size
) {
662 "%s: Bad size: \"%s\" is too small for XIP\n",
663 params
.cmdname
, datafile
);
667 for (p
= ptr
; p
< ptr
+ tparams
->header_size
; p
++) {
670 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
671 params
.cmdname
, datafile
);
676 offset
= tparams
->header_size
;
679 size
= sbuf
.st_size
- offset
;
680 if (write(ifd
, ptr
+ offset
, size
) != size
) {
681 fprintf (stderr
, "%s: Write error on %s: %s\n",
682 params
.cmdname
, params
.imagefile
, strerror(errno
));
687 if ((pad
== 1) && (tail
!= 0)) {
689 if (write(ifd
, (char *)&zero
, 4-tail
) != 4-tail
) {
690 fprintf (stderr
, "%s: Write error on %s: %s\n",
691 params
.cmdname
, params
.imagefile
,
695 } else if (pad
> 1) {
697 int todo
= sizeof(zeros
);
701 if (write(ifd
, (char *)&zeros
, todo
) != todo
) {
702 fprintf(stderr
, "%s: Write error on %s: %s\n",
703 params
.cmdname
, params
.imagefile
,
711 (void) munmap((void *)ptr
, sbuf
.st_size
);