2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2009
5 * DENX Software Engineering
6 * Wolfgang Denk, wd@denx.de
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License as
10 * published by the Free Software Foundation; either version 2 of
11 * the License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
28 static void copy_file(int, const char *, int);
29 static void usage(void);
31 /* image_type_params link list to maintain registered image type supports */
32 struct image_type_params *mkimage_tparams = NULL;
34 /* parameters initialized by core will be used by the image type code */
35 struct mkimage_params params = {
38 .type = IH_TYPE_KERNEL,
40 .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
48 * It is used to register respective image generation/list support to the
51 * the input struct image_type_params is checked and appended to the link
52 * list, if the input structure is already registered, error
54 void mkimage_register (struct image_type_params *tparams)
56 struct image_type_params **tp;
59 fprintf (stderr, "%s: %s: Null input\n",
60 params.cmdname, __FUNCTION__);
64 /* scan the linked list, check for registry and point the last one */
65 for (tp = &mkimage_tparams; *tp != NULL; tp = &(*tp)->next) {
66 if (!strcmp((*tp)->name, tparams->name)) {
67 fprintf (stderr, "%s: %s already registered\n",
68 params.cmdname, tparams->name);
73 /* add input struct entry at the end of link list */
75 /* mark input entry as last entry in the link list */
78 debug ("Registered %s\n", tparams->name);
84 * It scans all registers image type supports
85 * checks the input type_id for each supported image type
88 * returns respective image_type_params pointer if success
89 * if input type_id is not supported by any of image_type_support
92 struct image_type_params *mkimage_get_type(int type)
94 struct image_type_params *curr;
96 for (curr = mkimage_tparams; curr != NULL; curr = curr->next) {
97 if (curr->check_image_type) {
98 if (!curr->check_image_type (type))
106 * mkimage_verify_print_header -
108 * It scans mkimage_tparams link list,
109 * verifies image_header for each supported image type
110 * if verification is successful, prints respective header
112 * returns negative if input image format does not match with any of
113 * supported image types
115 int mkimage_verify_print_header (void *ptr, struct stat *sbuf)
118 struct image_type_params *curr;
120 for (curr = mkimage_tparams; curr != NULL; curr = curr->next ) {
121 if (curr->verify_header) {
122 retval = curr->verify_header (
123 (unsigned char *)ptr, sbuf->st_size,
128 * Print the image information
129 * if verify is successful
131 if (curr->print_header)
132 curr->print_header (ptr);
135 "%s: print_header undefined for %s\n",
136 params.cmdname, curr->name);
146 main (int argc, char **argv)
152 struct image_type_params *tparams = NULL;
154 /* Init Freescale PBL Boot image generation/list support */
155 init_pbl_image_type();
156 /* Init Kirkwood Boot image generation/list support */
157 init_kwb_image_type ();
158 /* Init Freescale imx Boot image generation/list support */
159 init_imx_image_type ();
160 /* Init FIT image generation/list support */
161 init_fit_image_type ();
162 /* Init TI OMAP Boot image generation/list support */
163 init_omap_image_type();
164 /* Init Default image generation/list support */
165 init_default_image_type ();
166 /* Init Davinci UBL support */
167 init_ubl_image_type();
168 /* Init Davinci AIS support */
169 init_ais_image_type();
171 params.cmdname = *argv;
172 params.addr = params.ep = 0;
174 while (--argc > 0 && **++argv == '-') {
183 genimg_get_arch_id (*++argv)) < 0)
189 params.comment = *++argv;
194 genimg_get_comp_id (*++argv)) < 0)
200 params.dtc = *++argv;
206 genimg_get_os_id (*++argv)) < 0)
212 genimg_get_type_id (*++argv)) < 0)
219 params.addr = strtoul (*++argv, &ptr, 16);
222 "%s: invalid load address %s\n",
223 params.cmdname, *argv);
230 params.datafile = *++argv;
236 params.ep = strtoul (*++argv, &ptr, 16);
239 "%s: invalid entry point %s\n",
240 params.cmdname, *argv);
248 params.datafile = *++argv;
252 * The flattened image tree (FIT) format
253 * requires a flattened device tree image type
255 params.type = IH_TYPE_FLATDT;
261 params.keydir = *++argv;
266 params.keydest = *++argv;
271 params.imagename = *++argv;
274 params.require_keys = 1;
280 * This entry is for the second configuration
281 * file, if only one is not enough.
283 params.imagename2 = *++argv;
292 printf("mkimage version %s\n", PLAIN_VERSION);
307 /* set tparams as per input type_id */
308 tparams = mkimage_get_type(params.type);
309 if (tparams == NULL) {
310 fprintf (stderr, "%s: unsupported type %s\n",
311 params.cmdname, genimg_get_type_name(params.type));
316 * check the passed arguments parameters meets the requirements
317 * as per image type to be generated/listed
319 if (tparams->check_params)
320 if (tparams->check_params (¶ms))
324 params.ep = params.addr;
325 /* If XIP, entry point must be after the U-Boot header */
327 params.ep += tparams->header_size;
330 params.imagefile = *argv;
333 if (tparams->fflag_handle)
335 * in some cases, some additional processing needs
336 * to be done if fflag is defined
338 * For ex. fit_handle_file for Fit file support
340 retval = tparams->fflag_handle(¶ms);
342 if (retval != EXIT_SUCCESS)
346 if (params.lflag || params.fflag) {
347 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
349 ifd = open (params.imagefile,
350 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
354 fprintf (stderr, "%s: Can't open %s: %s\n",
355 params.cmdname, params.imagefile,
360 if (params.lflag || params.fflag) {
362 * list header information of existing image
364 if (fstat(ifd, &sbuf) < 0) {
365 fprintf (stderr, "%s: Can't stat %s: %s\n",
366 params.cmdname, params.imagefile,
371 if ((unsigned)sbuf.st_size < tparams->header_size) {
373 "%s: Bad size: \"%s\" is not valid image\n",
374 params.cmdname, params.imagefile);
378 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
379 if (ptr == MAP_FAILED) {
380 fprintf (stderr, "%s: Can't read %s: %s\n",
381 params.cmdname, params.imagefile,
387 * scan through mkimage registry for all supported image types
388 * and verify the input image file header for match
389 * Print the image information for matched image type
390 * Returns the error code if not matched
392 retval = mkimage_verify_print_header (ptr, &sbuf);
394 (void) munmap((void *)ptr, sbuf.st_size);
401 * In case there an header with a variable
402 * length will be added, the corresponding
403 * function is called. This is responsible to
404 * allocate memory for the header itself.
406 if (tparams->vrec_header)
407 tparams->vrec_header(¶ms, tparams);
409 memset(tparams->hdr, 0, tparams->header_size);
411 if (write(ifd, tparams->hdr, tparams->header_size)
412 != tparams->header_size) {
413 fprintf (stderr, "%s: Write error on %s: %s\n",
414 params.cmdname, params.imagefile, strerror(errno));
418 if (!params.skipcpy) {
419 if (params.type == IH_TYPE_MULTI ||
420 params.type == IH_TYPE_SCRIPT) {
421 char *file = params.datafile;
428 if ((sep = strchr(file, ':')) != NULL) {
432 if (stat (file, &sbuf) < 0) {
433 fprintf (stderr, "%s: Can't stat %s: %s\n",
434 params.cmdname, file, strerror(errno));
437 size = cpu_to_uimage (sbuf.st_size);
442 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
443 fprintf (stderr, "%s: Write error on %s: %s\n",
444 params.cmdname, params.imagefile,
461 file = params.datafile;
464 char *sep = strchr(file, ':');
467 copy_file (ifd, file, 1);
471 copy_file (ifd, file, 0);
475 } else if (params.type == IH_TYPE_PBLIMAGE) {
476 /* PBL has special Image format, implements its' own */
477 pbl_load_uboot(ifd, ¶ms);
479 copy_file (ifd, params.datafile, 0);
483 /* We're a bit of paranoid */
484 #if defined(_POSIX_SYNCHRONIZED_IO) && \
485 !defined(__sun__) && \
486 !defined(__FreeBSD__) && \
488 (void) fdatasync (ifd);
493 if (fstat(ifd, &sbuf) < 0) {
494 fprintf (stderr, "%s: Can't stat %s: %s\n",
495 params.cmdname, params.imagefile, strerror(errno));
499 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
500 if (ptr == MAP_FAILED) {
501 fprintf (stderr, "%s: Can't map %s: %s\n",
502 params.cmdname, params.imagefile, strerror(errno));
506 /* Setup the image header as per input image type*/
507 if (tparams->set_header)
508 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
510 fprintf (stderr, "%s: Can't set header for %s: %s\n",
511 params.cmdname, tparams->name, strerror(errno));
515 /* Print the image information by processing image header */
516 if (tparams->print_header)
517 tparams->print_header (ptr);
519 fprintf (stderr, "%s: Can't print header for %s: %s\n",
520 params.cmdname, tparams->name, strerror(errno));
524 (void) munmap((void *)ptr, sbuf.st_size);
526 /* We're a bit of paranoid */
527 #if defined(_POSIX_SYNCHRONIZED_IO) && \
528 !defined(__sun__) && \
529 !defined(__FreeBSD__) && \
531 (void) fdatasync (ifd);
537 fprintf (stderr, "%s: Write error on %s: %s\n",
538 params.cmdname, params.imagefile, strerror(errno));
546 copy_file (int ifd, const char *datafile, int pad)
555 struct image_type_params *tparams = mkimage_get_type (params.type);
558 fprintf (stderr, "Adding Image %s\n", datafile);
561 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
562 fprintf (stderr, "%s: Can't open %s: %s\n",
563 params.cmdname, datafile, strerror(errno));
567 if (fstat(dfd, &sbuf) < 0) {
568 fprintf (stderr, "%s: Can't stat %s: %s\n",
569 params.cmdname, datafile, strerror(errno));
573 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
574 if (ptr == MAP_FAILED) {
575 fprintf (stderr, "%s: Can't read %s: %s\n",
576 params.cmdname, datafile, strerror(errno));
581 unsigned char *p = NULL;
583 * XIP: do not append the image_header_t at the
584 * beginning of the file, but consume the space
588 if ((unsigned)sbuf.st_size < tparams->header_size) {
590 "%s: Bad size: \"%s\" is too small for XIP\n",
591 params.cmdname, datafile);
595 for (p = ptr; p < ptr + tparams->header_size; p++) {
598 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
599 params.cmdname, datafile);
604 offset = tparams->header_size;
607 size = sbuf.st_size - offset;
608 if (write(ifd, ptr + offset, size) != size) {
609 fprintf (stderr, "%s: Write error on %s: %s\n",
610 params.cmdname, params.imagefile, strerror(errno));
614 if (pad && ((tail = size % 4) != 0)) {
616 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
617 fprintf (stderr, "%s: Write error on %s: %s\n",
618 params.cmdname, params.imagefile,
624 (void) munmap((void *)ptr, sbuf.st_size);
631 fprintf (stderr, "Usage: %s -l image\n"
632 " -l ==> list image header information\n",
634 fprintf (stderr, " %s [-x] -A arch -O os -T type -C comp "
635 "-a addr -e ep -n name -d data_file[:data_file...] image\n"
636 " -A ==> set architecture to 'arch'\n"
637 " -O ==> set operating system to 'os'\n"
638 " -T ==> set image type to 'type'\n"
639 " -C ==> set compression type 'comp'\n"
640 " -a ==> set load address to 'addr' (hex)\n"
641 " -e ==> set entry point to 'ep' (hex)\n"
642 " -n ==> set image name to 'name'\n"
643 " -d ==> use image data from 'datafile'\n"
644 " -x ==> set XIP (execute in place)\n",
646 fprintf(stderr, " %s [-D dtc_options] [-f fit-image.its|-F] fit-image\n",
648 fprintf(stderr, " -D => set options for device tree compiler\n"
649 " -f => input filename for FIT source\n");
650 #ifdef CONFIG_FIT_SIGNATURE
651 fprintf(stderr, "Signing / verified boot options: [-k keydir] [-K dtb] [ -c <comment>] [-r]\n"
652 " -k => set directory containing private keys\n"
653 " -K => write public keys to this .dtb file\n"
654 " -c => add comment in signature node\n"
655 " -F => re-sign existing FIT image\n"
656 " -r => mark keys used as 'required' in dtb\n");
658 fprintf(stderr, "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
660 fprintf (stderr, " %s -V ==> print version information and exit\n",