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
);
155 if (params
.arch
< 0) {
156 show_valid_options(IH_ARCH
);
157 usage("Invalid architecture");
161 if (add_content(IH_TYPE_FLATDT
, optarg
)) {
163 "%s: Out of memory adding content '%s'",
164 params
.cmdname
, optarg
);
169 params
.comment
= optarg
;
172 params
.comp
= genimg_get_comp_id(optarg
);
173 if (params
.comp
< 0) {
174 show_valid_options(IH_COMP
);
175 usage("Invalid compression type");
179 params
.datafile
= optarg
;
186 params
.ep
= strtoull(optarg
, &ptr
, 16);
188 fprintf(stderr
, "%s: invalid entry point %s\n",
189 params
.cmdname
, optarg
);
195 params
.external_data
= true;
199 params
.auto_its
= !strcmp(datafile
, "auto");
203 * The flattened image tree (FIT) format
204 * requires a flattened device tree image type
206 params
.type
= IH_TYPE_FLATDT
;
210 params
.keydir
= optarg
;
213 params
.keydest
= optarg
;
219 params
.imagename
= optarg
;
222 params
.os
= genimg_get_os_id(optarg
);
224 show_valid_options(IH_OS
);
225 usage("Invalid operating system");
229 params
.external_offset
= strtoull(optarg
, &ptr
, 16);
231 fprintf(stderr
, "%s: invalid offset size %s\n",
232 params
.cmdname
, optarg
);
240 params
.require_keys
= 1;
244 * This entry is for the second configuration
245 * file, if only one is not enough.
247 params
.imagename2
= optarg
;
253 type
= genimg_get_type_id(optarg
);
255 show_valid_options(IH_TYPE
);
256 usage("Invalid image type");
263 printf("mkimage version %s\n", PLAIN_VERSION
);
269 usage("Invalid option");
273 /* The last parameter is expected to be the imagefile */
275 params
.imagefile
= argv
[optind
];
278 * For auto-generated FIT images we need to know the image type to put
279 * in the FIT, which is separate from the file's image type (which
280 * will always be IH_TYPE_FLATDT in this case).
282 if (params
.type
== IH_TYPE_FLATDT
) {
283 params
.fit_image_type
= type
? type
: IH_TYPE_KERNEL
;
284 /* For auto_its, datafile is always 'auto' */
285 if (!params
.auto_its
)
286 params
.datafile
= datafile
;
287 else if (!params
.datafile
)
288 usage("Missing data file for auto-FIT (use -d)");
289 } else if (type
!= IH_TYPE_INVALID
) {
293 if (!params
.imagefile
)
294 usage("Missing output filename");
297 int main(int argc
, char **argv
)
303 struct image_type_params
*tparams
= NULL
;
307 params
.cmdname
= *argv
;
311 process_args(argc
, argv
);
313 /* set tparams as per input type_id */
314 tparams
= imagetool_get_type(params
.type
);
315 if (tparams
== NULL
) {
316 fprintf (stderr
, "%s: unsupported type %s\n",
317 params
.cmdname
, genimg_get_type_name(params
.type
));
322 * check the passed arguments parameters meets the requirements
323 * as per image type to be generated/listed
325 if (tparams
->check_params
)
326 if (tparams
->check_params (¶ms
))
327 usage("Bad parameters for image type");
330 params
.ep
= params
.addr
;
331 /* If XIP, entry point must be after the U-Boot header */
333 params
.ep
+= tparams
->header_size
;
337 if (tparams
->fflag_handle
)
339 * in some cases, some additional processing needs
340 * to be done if fflag is defined
342 * For ex. fit_handle_file for Fit file support
344 retval
= tparams
->fflag_handle(¶ms
);
346 if (retval
!= EXIT_SUCCESS
)
350 if (params
.lflag
|| params
.fflag
) {
351 ifd
= open (params
.imagefile
, O_RDONLY
|O_BINARY
);
353 ifd
= open (params
.imagefile
,
354 O_RDWR
|O_CREAT
|O_TRUNC
|O_BINARY
, 0666);
358 fprintf (stderr
, "%s: Can't open %s: %s\n",
359 params
.cmdname
, params
.imagefile
,
364 if (params
.lflag
|| params
.fflag
) {
366 * list header information of existing image
368 if (fstat(ifd
, &sbuf
) < 0) {
369 fprintf (stderr
, "%s: Can't stat %s: %s\n",
370 params
.cmdname
, params
.imagefile
,
375 if ((unsigned)sbuf
.st_size
< tparams
->header_size
) {
377 "%s: Bad size: \"%s\" is not valid image\n",
378 params
.cmdname
, params
.imagefile
);
382 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
, MAP_SHARED
, ifd
, 0);
383 if (ptr
== MAP_FAILED
) {
384 fprintf (stderr
, "%s: Can't read %s: %s\n",
385 params
.cmdname
, params
.imagefile
,
391 * scan through mkimage registry for all supported image types
392 * and verify the input image file header for match
393 * Print the image information for matched image type
394 * Returns the error code if not matched
396 retval
= imagetool_verify_print_header(ptr
, &sbuf
,
399 (void) munmap((void *)ptr
, sbuf
.st_size
);
405 if ((params
.type
!= IH_TYPE_MULTI
) && (params
.type
!= IH_TYPE_SCRIPT
)) {
406 dfd
= open(params
.datafile
, O_RDONLY
| O_BINARY
);
408 fprintf(stderr
, "%s: Can't open %s: %s\n",
409 params
.cmdname
, params
.datafile
,
414 if (fstat(dfd
, &sbuf
) < 0) {
415 fprintf(stderr
, "%s: Can't stat %s: %s\n",
416 params
.cmdname
, params
.datafile
,
421 params
.file_size
= sbuf
.st_size
+ tparams
->header_size
;
426 * In case there an header with a variable
427 * length will be added, the corresponding
428 * function is called. This is responsible to
429 * allocate memory for the header itself.
431 if (tparams
->vrec_header
)
432 pad_len
= tparams
->vrec_header(¶ms
, tparams
);
434 memset(tparams
->hdr
, 0, tparams
->header_size
);
436 if (write(ifd
, tparams
->hdr
, tparams
->header_size
)
437 != tparams
->header_size
) {
438 fprintf (stderr
, "%s: Write error on %s: %s\n",
439 params
.cmdname
, params
.imagefile
, strerror(errno
));
443 if (!params
.skipcpy
) {
444 if (params
.type
== IH_TYPE_MULTI
||
445 params
.type
== IH_TYPE_SCRIPT
) {
446 char *file
= params
.datafile
;
453 if ((sep
= strchr(file
, ':')) != NULL
) {
457 if (stat (file
, &sbuf
) < 0) {
458 fprintf (stderr
, "%s: Can't stat %s: %s\n",
459 params
.cmdname
, file
, strerror(errno
));
462 size
= cpu_to_uimage (sbuf
.st_size
);
467 if (write(ifd
, (char *)&size
, sizeof(size
)) != sizeof(size
)) {
468 fprintf (stderr
, "%s: Write error on %s: %s\n",
469 params
.cmdname
, params
.imagefile
,
486 file
= params
.datafile
;
489 char *sep
= strchr(file
, ':');
492 copy_file (ifd
, file
, 1);
496 copy_file (ifd
, file
, 0);
500 } else if (params
.type
== IH_TYPE_PBLIMAGE
) {
501 /* PBL has special Image format, implements its' own */
502 pbl_load_uboot(ifd
, ¶ms
);
504 copy_file(ifd
, params
.datafile
, pad_len
);
508 /* We're a bit of paranoid */
509 #if defined(_POSIX_SYNCHRONIZED_IO) && \
510 !defined(__sun__) && \
511 !defined(__FreeBSD__) && \
512 !defined(__OpenBSD__) && \
514 (void) fdatasync (ifd
);
519 if (fstat(ifd
, &sbuf
) < 0) {
520 fprintf (stderr
, "%s: Can't stat %s: %s\n",
521 params
.cmdname
, params
.imagefile
, strerror(errno
));
524 params
.file_size
= sbuf
.st_size
;
526 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
|PROT_WRITE
, MAP_SHARED
, ifd
, 0);
527 if (ptr
== MAP_FAILED
) {
528 fprintf (stderr
, "%s: Can't map %s: %s\n",
529 params
.cmdname
, params
.imagefile
, strerror(errno
));
533 /* Setup the image header as per input image type*/
534 if (tparams
->set_header
)
535 tparams
->set_header (ptr
, &sbuf
, ifd
, ¶ms
);
537 fprintf (stderr
, "%s: Can't set header for %s: %s\n",
538 params
.cmdname
, tparams
->name
, strerror(errno
));
542 /* Print the image information by processing image header */
543 if (tparams
->print_header
)
544 tparams
->print_header (ptr
);
546 fprintf (stderr
, "%s: Can't print header for %s: %s\n",
547 params
.cmdname
, tparams
->name
, strerror(errno
));
551 (void) munmap((void *)ptr
, sbuf
.st_size
);
553 /* We're a bit of paranoid */
554 #if defined(_POSIX_SYNCHRONIZED_IO) && \
555 !defined(__sun__) && \
556 !defined(__FreeBSD__) && \
557 !defined(__OpenBSD__) && \
559 (void) fdatasync (ifd
);
565 fprintf (stderr
, "%s: Write error on %s: %s\n",
566 params
.cmdname
, params
.imagefile
, strerror(errno
));
574 copy_file (int ifd
, const char *datafile
, int pad
)
584 struct image_type_params
*tparams
= imagetool_get_type(params
.type
);
586 memset(zeros
, 0, sizeof(zeros
));
589 fprintf (stderr
, "Adding Image %s\n", datafile
);
592 if ((dfd
= open(datafile
, O_RDONLY
|O_BINARY
)) < 0) {
593 fprintf (stderr
, "%s: Can't open %s: %s\n",
594 params
.cmdname
, datafile
, strerror(errno
));
598 if (fstat(dfd
, &sbuf
) < 0) {
599 fprintf (stderr
, "%s: Can't stat %s: %s\n",
600 params
.cmdname
, datafile
, strerror(errno
));
604 ptr
= mmap(0, sbuf
.st_size
, PROT_READ
, MAP_SHARED
, dfd
, 0);
605 if (ptr
== MAP_FAILED
) {
606 fprintf (stderr
, "%s: Can't read %s: %s\n",
607 params
.cmdname
, datafile
, strerror(errno
));
612 unsigned char *p
= NULL
;
614 * XIP: do not append the image_header_t at the
615 * beginning of the file, but consume the space
619 if ((unsigned)sbuf
.st_size
< tparams
->header_size
) {
621 "%s: Bad size: \"%s\" is too small for XIP\n",
622 params
.cmdname
, datafile
);
626 for (p
= ptr
; p
< ptr
+ tparams
->header_size
; p
++) {
629 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
630 params
.cmdname
, datafile
);
635 offset
= tparams
->header_size
;
638 size
= sbuf
.st_size
- offset
;
639 if (write(ifd
, ptr
+ offset
, size
) != size
) {
640 fprintf (stderr
, "%s: Write error on %s: %s\n",
641 params
.cmdname
, params
.imagefile
, strerror(errno
));
646 if ((pad
== 1) && (tail
!= 0)) {
648 if (write(ifd
, (char *)&zero
, 4-tail
) != 4-tail
) {
649 fprintf (stderr
, "%s: Write error on %s: %s\n",
650 params
.cmdname
, params
.imagefile
,
654 } else if (pad
> 1) {
656 int todo
= sizeof(zeros
);
660 if (write(ifd
, (char *)&zeros
, todo
) != todo
) {
661 fprintf(stderr
, "%s: Write error on %s: %s\n",
662 params
.cmdname
, params
.imagefile
,
670 (void) munmap((void *)ptr
, sbuf
.st_size
);