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_list>] fit-image\n"
89 " <dtb_list> is used with -f auto, and is a space-separated list of .dtb files\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
;
139 expecting
= IH_TYPE_COUNT
; /* Unknown */
140 while ((opt
= getopt(argc
, argv
,
141 "-a:A:bcC:d:D:e:f:Fk:K:ln:O:rR:sT:vVx")) != -1) {
144 params
.addr
= strtoull(optarg
, &ptr
, 16);
146 fprintf(stderr
, "%s: invalid load address %s\n",
147 params
.cmdname
, optarg
);
152 params
.arch
= genimg_get_arch_id(optarg
);
154 usage("Invalid architecture");
157 expecting
= IH_TYPE_FLATDT
;
160 params
.comment
= optarg
;
163 params
.comp
= genimg_get_comp_id(optarg
);
165 usage("Invalid compression type");
168 params
.datafile
= optarg
;
175 params
.ep
= strtoull(optarg
, &ptr
, 16);
177 fprintf(stderr
, "%s: invalid entry point %s\n",
178 params
.cmdname
, optarg
);
185 params
.auto_its
= !strcmp(datafile
, "auto");
189 * The flattened image tree (FIT) format
190 * requires a flattened device tree image type
192 params
.fit_image_type
= params
.type
;
193 params
.type
= IH_TYPE_FLATDT
;
197 params
.keydir
= optarg
;
200 params
.keydest
= optarg
;
206 params
.imagename
= optarg
;
209 params
.os
= genimg_get_os_id(optarg
);
211 usage("Invalid operating system");
214 params
.require_keys
= 1;
218 * This entry is for the second configuration
219 * file, if only one is not enough.
221 params
.imagename2
= optarg
;
227 type
= genimg_get_type_id(optarg
);
230 usage("Invalid image type");
238 printf("mkimage version %s\n", PLAIN_VERSION
);
244 if (expecting
== type
|| optind
== argc
) {
245 params
.imagefile
= optarg
;
246 expecting
= IH_TYPE_INVALID
;
247 } else if (expecting
== IH_TYPE_INVALID
) {
249 "%s: Unknown content type: use -b before device tree files",
253 if (add_content(expecting
, optarg
)) {
255 "%s: Out of memory adding content '%s'",
256 params
.cmdname
, optarg
);
262 usage("Invalid option");
267 * For auto-generated FIT images we need to know the image type to put
268 * in the FIT, which is separate from the file's image type (which
269 * will always be IH_TYPE_FLATDT in this case).
271 if (params
.type
== IH_TYPE_FLATDT
) {
272 params
.fit_image_type
= type
;
273 if (!params
.auto_its
)
274 params
.datafile
= datafile
;
275 } else if (type
!= IH_TYPE_INVALID
) {
279 if (!params
.imagefile
)
280 usage("Missing output filename");
284 int main(int argc
, char **argv
)
290 struct image_type_params
*tparams
= NULL
;
294 params
.cmdname
= *argv
;
298 process_args(argc
, argv
);
300 /* set tparams as per input type_id */
301 tparams
= imagetool_get_type(params
.type
);
302 if (tparams
== NULL
) {
303 fprintf (stderr
, "%s: unsupported type %s\n",
304 params
.cmdname
, genimg_get_type_name(params
.type
));
309 * check the passed arguments parameters meets the requirements
310 * as per image type to be generated/listed
312 if (tparams
->check_params
)
313 if (tparams
->check_params (¶ms
))
314 usage("Bad parameters for image type");
317 params
.ep
= params
.addr
;
318 /* If XIP, entry point must be after the U-Boot header */
320 params
.ep
+= tparams
->header_size
;
324 if (tparams
->fflag_handle
)
326 * in some cases, some additional processing needs
327 * to be done if fflag is defined
329 * For ex. fit_handle_file for Fit file support
331 retval
= tparams
->fflag_handle(¶ms
);
333 if (retval
!= EXIT_SUCCESS
)
337 if (params
.lflag
|| params
.fflag
) {
338 ifd
= open (params
.imagefile
, O_RDONLY
|O_BINARY
);
340 ifd
= open (params
.imagefile
,
341 O_RDWR
|O_CREAT
|O_TRUNC
|O_BINARY
, 0666);
345 fprintf (stderr
, "%s: Can't open %s: %s\n",
346 params
.cmdname
, params
.imagefile
,
351 if (params
.lflag
|| params
.fflag
) {
353 * list header information of existing image
355 if (fstat(ifd
, &sbuf
) < 0) {
356 fprintf (stderr
, "%s: Can't stat %s: %s\n",
357 params
.cmdname
, params
.imagefile
,
362 if ((unsigned)sbuf
.st_size
< tparams
->header_size
) {
364 "%s: Bad size: \"%s\" is not valid image\n",
365 params
.cmdname
, params
.imagefile
);
369 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
, MAP_SHARED
, ifd
, 0);
370 if (ptr
== MAP_FAILED
) {
371 fprintf (stderr
, "%s: Can't read %s: %s\n",
372 params
.cmdname
, params
.imagefile
,
378 * scan through mkimage registry for all supported image types
379 * and verify the input image file header for match
380 * Print the image information for matched image type
381 * Returns the error code if not matched
383 retval
= imagetool_verify_print_header(ptr
, &sbuf
,
386 (void) munmap((void *)ptr
, sbuf
.st_size
);
392 if ((params
.type
!= IH_TYPE_MULTI
) && (params
.type
!= IH_TYPE_SCRIPT
)) {
393 dfd
= open(params
.datafile
, O_RDONLY
| O_BINARY
);
395 fprintf(stderr
, "%s: Can't open %s: %s\n",
396 params
.cmdname
, params
.datafile
,
401 if (fstat(dfd
, &sbuf
) < 0) {
402 fprintf(stderr
, "%s: Can't stat %s: %s\n",
403 params
.cmdname
, params
.datafile
,
408 params
.file_size
= sbuf
.st_size
+ tparams
->header_size
;
413 * In case there an header with a variable
414 * length will be added, the corresponding
415 * function is called. This is responsible to
416 * allocate memory for the header itself.
418 if (tparams
->vrec_header
)
419 pad_len
= tparams
->vrec_header(¶ms
, tparams
);
421 memset(tparams
->hdr
, 0, tparams
->header_size
);
423 if (write(ifd
, tparams
->hdr
, tparams
->header_size
)
424 != tparams
->header_size
) {
425 fprintf (stderr
, "%s: Write error on %s: %s\n",
426 params
.cmdname
, params
.imagefile
, strerror(errno
));
430 if (!params
.skipcpy
) {
431 if (params
.type
== IH_TYPE_MULTI
||
432 params
.type
== IH_TYPE_SCRIPT
) {
433 char *file
= params
.datafile
;
440 if ((sep
= strchr(file
, ':')) != NULL
) {
444 if (stat (file
, &sbuf
) < 0) {
445 fprintf (stderr
, "%s: Can't stat %s: %s\n",
446 params
.cmdname
, file
, strerror(errno
));
449 size
= cpu_to_uimage (sbuf
.st_size
);
454 if (write(ifd
, (char *)&size
, sizeof(size
)) != sizeof(size
)) {
455 fprintf (stderr
, "%s: Write error on %s: %s\n",
456 params
.cmdname
, params
.imagefile
,
473 file
= params
.datafile
;
476 char *sep
= strchr(file
, ':');
479 copy_file (ifd
, file
, 1);
483 copy_file (ifd
, file
, 0);
487 } else if (params
.type
== IH_TYPE_PBLIMAGE
) {
488 /* PBL has special Image format, implements its' own */
489 pbl_load_uboot(ifd
, ¶ms
);
491 copy_file(ifd
, params
.datafile
, pad_len
);
495 /* We're a bit of paranoid */
496 #if defined(_POSIX_SYNCHRONIZED_IO) && \
497 !defined(__sun__) && \
498 !defined(__FreeBSD__) && \
499 !defined(__OpenBSD__) && \
501 (void) fdatasync (ifd
);
506 if (fstat(ifd
, &sbuf
) < 0) {
507 fprintf (stderr
, "%s: Can't stat %s: %s\n",
508 params
.cmdname
, params
.imagefile
, strerror(errno
));
511 params
.file_size
= sbuf
.st_size
;
513 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
|PROT_WRITE
, MAP_SHARED
, ifd
, 0);
514 if (ptr
== MAP_FAILED
) {
515 fprintf (stderr
, "%s: Can't map %s: %s\n",
516 params
.cmdname
, params
.imagefile
, strerror(errno
));
520 /* Setup the image header as per input image type*/
521 if (tparams
->set_header
)
522 tparams
->set_header (ptr
, &sbuf
, ifd
, ¶ms
);
524 fprintf (stderr
, "%s: Can't set header for %s: %s\n",
525 params
.cmdname
, tparams
->name
, strerror(errno
));
529 /* Print the image information by processing image header */
530 if (tparams
->print_header
)
531 tparams
->print_header (ptr
);
533 fprintf (stderr
, "%s: Can't print header for %s: %s\n",
534 params
.cmdname
, tparams
->name
, strerror(errno
));
538 (void) munmap((void *)ptr
, sbuf
.st_size
);
540 /* We're a bit of paranoid */
541 #if defined(_POSIX_SYNCHRONIZED_IO) && \
542 !defined(__sun__) && \
543 !defined(__FreeBSD__) && \
544 !defined(__OpenBSD__) && \
546 (void) fdatasync (ifd
);
552 fprintf (stderr
, "%s: Write error on %s: %s\n",
553 params
.cmdname
, params
.imagefile
, strerror(errno
));
561 copy_file (int ifd
, const char *datafile
, int pad
)
571 struct image_type_params
*tparams
= imagetool_get_type(params
.type
);
573 memset(zeros
, 0, sizeof(zeros
));
576 fprintf (stderr
, "Adding Image %s\n", datafile
);
579 if ((dfd
= open(datafile
, O_RDONLY
|O_BINARY
)) < 0) {
580 fprintf (stderr
, "%s: Can't open %s: %s\n",
581 params
.cmdname
, datafile
, strerror(errno
));
585 if (fstat(dfd
, &sbuf
) < 0) {
586 fprintf (stderr
, "%s: Can't stat %s: %s\n",
587 params
.cmdname
, datafile
, strerror(errno
));
591 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
, MAP_SHARED
, dfd
, 0);
592 if (ptr
== MAP_FAILED
) {
593 fprintf (stderr
, "%s: Can't read %s: %s\n",
594 params
.cmdname
, datafile
, strerror(errno
));
599 unsigned char *p
= NULL
;
601 * XIP: do not append the image_header_t at the
602 * beginning of the file, but consume the space
606 if ((unsigned)sbuf
.st_size
< tparams
->header_size
) {
608 "%s: Bad size: \"%s\" is too small for XIP\n",
609 params
.cmdname
, datafile
);
613 for (p
= ptr
; p
< ptr
+ tparams
->header_size
; p
++) {
616 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
617 params
.cmdname
, datafile
);
622 offset
= tparams
->header_size
;
625 size
= sbuf
.st_size
- offset
;
626 if (write(ifd
, ptr
+ offset
, size
) != size
) {
627 fprintf (stderr
, "%s: Write error on %s: %s\n",
628 params
.cmdname
, params
.imagefile
, strerror(errno
));
633 if ((pad
== 1) && (tail
!= 0)) {
635 if (write(ifd
, (char *)&zero
, 4-tail
) != 4-tail
) {
636 fprintf (stderr
, "%s: Write error on %s: %s\n",
637 params
.cmdname
, params
.imagefile
,
641 } else if (pad
> 1) {
643 int todo
= sizeof(zeros
);
647 if (write(ifd
, (char *)&zeros
, todo
) != todo
) {
648 fprintf(stderr
, "%s: Write error on %s: %s\n",
649 params
.cmdname
, params
.imagefile
,
657 (void) munmap((void *)ptr
, sbuf
.st_size
);