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 genimg_get_comp_id (*++argv)) < 0)
195 params.dtc = *++argv;
201 genimg_get_os_id (*++argv)) < 0)
207 genimg_get_type_id (*++argv)) < 0)
214 params.addr = strtoul (*++argv, &ptr, 16);
217 "%s: invalid load address %s\n",
218 params.cmdname, *argv);
225 params.datafile = *++argv;
231 params.ep = strtoul (*++argv, &ptr, 16);
234 "%s: invalid entry point %s\n",
235 params.cmdname, *argv);
244 * The flattened image tree (FIT) format
245 * requires a flattened device tree image type
247 params.type = IH_TYPE_FLATDT;
248 params.datafile = *++argv;
254 params.keydir = *++argv;
259 params.imagename = *++argv;
265 * This entry is for the second configuration
266 * file, if only one is not enough.
268 params.imagename2 = *++argv;
277 printf("mkimage version %s\n", PLAIN_VERSION);
292 /* set tparams as per input type_id */
293 tparams = mkimage_get_type(params.type);
294 if (tparams == NULL) {
295 fprintf (stderr, "%s: unsupported type %s\n",
296 params.cmdname, genimg_get_type_name(params.type));
301 * check the passed arguments parameters meets the requirements
302 * as per image type to be generated/listed
304 if (tparams->check_params)
305 if (tparams->check_params (¶ms))
309 params.ep = params.addr;
310 /* If XIP, entry point must be after the U-Boot header */
312 params.ep += tparams->header_size;
315 params.imagefile = *argv;
318 if (tparams->fflag_handle)
320 * in some cases, some additional processing needs
321 * to be done if fflag is defined
323 * For ex. fit_handle_file for Fit file support
325 retval = tparams->fflag_handle(¶ms);
327 if (retval != EXIT_SUCCESS)
331 if (params.lflag || params.fflag) {
332 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
334 ifd = open (params.imagefile,
335 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
339 fprintf (stderr, "%s: Can't open %s: %s\n",
340 params.cmdname, params.imagefile,
345 if (params.lflag || params.fflag) {
347 * list header information of existing image
349 if (fstat(ifd, &sbuf) < 0) {
350 fprintf (stderr, "%s: Can't stat %s: %s\n",
351 params.cmdname, params.imagefile,
356 if ((unsigned)sbuf.st_size < tparams->header_size) {
358 "%s: Bad size: \"%s\" is not valid image\n",
359 params.cmdname, params.imagefile);
363 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
364 if (ptr == MAP_FAILED) {
365 fprintf (stderr, "%s: Can't read %s: %s\n",
366 params.cmdname, params.imagefile,
372 * scan through mkimage registry for all supported image types
373 * and verify the input image file header for match
374 * Print the image information for matched image type
375 * Returns the error code if not matched
377 retval = mkimage_verify_print_header (ptr, &sbuf);
379 (void) munmap((void *)ptr, sbuf.st_size);
386 * In case there an header with a variable
387 * length will be added, the corresponding
388 * function is called. This is responsible to
389 * allocate memory for the header itself.
391 if (tparams->vrec_header)
392 tparams->vrec_header(¶ms, tparams);
394 memset(tparams->hdr, 0, tparams->header_size);
396 if (write(ifd, tparams->hdr, tparams->header_size)
397 != tparams->header_size) {
398 fprintf (stderr, "%s: Write error on %s: %s\n",
399 params.cmdname, params.imagefile, strerror(errno));
403 if (!params.skipcpy) {
404 if (params.type == IH_TYPE_MULTI ||
405 params.type == IH_TYPE_SCRIPT) {
406 char *file = params.datafile;
413 if ((sep = strchr(file, ':')) != NULL) {
417 if (stat (file, &sbuf) < 0) {
418 fprintf (stderr, "%s: Can't stat %s: %s\n",
419 params.cmdname, file, strerror(errno));
422 size = cpu_to_uimage (sbuf.st_size);
427 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
428 fprintf (stderr, "%s: Write error on %s: %s\n",
429 params.cmdname, params.imagefile,
446 file = params.datafile;
449 char *sep = strchr(file, ':');
452 copy_file (ifd, file, 1);
456 copy_file (ifd, file, 0);
460 } else if (params.type == IH_TYPE_PBLIMAGE) {
461 /* PBL has special Image format, implements its' own */
462 pbl_load_uboot(ifd, ¶ms);
464 copy_file (ifd, params.datafile, 0);
468 /* We're a bit of paranoid */
469 #if defined(_POSIX_SYNCHRONIZED_IO) && \
470 !defined(__sun__) && \
471 !defined(__FreeBSD__) && \
473 (void) fdatasync (ifd);
478 if (fstat(ifd, &sbuf) < 0) {
479 fprintf (stderr, "%s: Can't stat %s: %s\n",
480 params.cmdname, params.imagefile, strerror(errno));
484 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
485 if (ptr == MAP_FAILED) {
486 fprintf (stderr, "%s: Can't map %s: %s\n",
487 params.cmdname, params.imagefile, strerror(errno));
491 /* Setup the image header as per input image type*/
492 if (tparams->set_header)
493 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
495 fprintf (stderr, "%s: Can't set header for %s: %s\n",
496 params.cmdname, tparams->name, strerror(errno));
500 /* Print the image information by processing image header */
501 if (tparams->print_header)
502 tparams->print_header (ptr);
504 fprintf (stderr, "%s: Can't print header for %s: %s\n",
505 params.cmdname, tparams->name, strerror(errno));
509 (void) munmap((void *)ptr, sbuf.st_size);
511 /* We're a bit of paranoid */
512 #if defined(_POSIX_SYNCHRONIZED_IO) && \
513 !defined(__sun__) && \
514 !defined(__FreeBSD__) && \
516 (void) fdatasync (ifd);
522 fprintf (stderr, "%s: Write error on %s: %s\n",
523 params.cmdname, params.imagefile, strerror(errno));
531 copy_file (int ifd, const char *datafile, int pad)
540 struct image_type_params *tparams = mkimage_get_type (params.type);
543 fprintf (stderr, "Adding Image %s\n", datafile);
546 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
547 fprintf (stderr, "%s: Can't open %s: %s\n",
548 params.cmdname, datafile, strerror(errno));
552 if (fstat(dfd, &sbuf) < 0) {
553 fprintf (stderr, "%s: Can't stat %s: %s\n",
554 params.cmdname, datafile, strerror(errno));
558 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
559 if (ptr == MAP_FAILED) {
560 fprintf (stderr, "%s: Can't read %s: %s\n",
561 params.cmdname, datafile, strerror(errno));
566 unsigned char *p = NULL;
568 * XIP: do not append the image_header_t at the
569 * beginning of the file, but consume the space
573 if ((unsigned)sbuf.st_size < tparams->header_size) {
575 "%s: Bad size: \"%s\" is too small for XIP\n",
576 params.cmdname, datafile);
580 for (p = ptr; p < ptr + tparams->header_size; p++) {
583 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
584 params.cmdname, datafile);
589 offset = tparams->header_size;
592 size = sbuf.st_size - offset;
593 if (write(ifd, ptr + offset, size) != size) {
594 fprintf (stderr, "%s: Write error on %s: %s\n",
595 params.cmdname, params.imagefile, strerror(errno));
599 if (pad && ((tail = size % 4) != 0)) {
601 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
602 fprintf (stderr, "%s: Write error on %s: %s\n",
603 params.cmdname, params.imagefile,
609 (void) munmap((void *)ptr, sbuf.st_size);
616 fprintf (stderr, "Usage: %s -l image\n"
617 " -l ==> list image header information\n",
619 fprintf (stderr, " %s [-x] -A arch -O os -T type -C comp "
620 "-a addr -e ep -n name -d data_file[:data_file...] image\n"
621 " -A ==> set architecture to 'arch'\n"
622 " -O ==> set operating system to 'os'\n"
623 " -T ==> set image type to 'type'\n"
624 " -C ==> set compression type 'comp'\n"
625 " -a ==> set load address to 'addr' (hex)\n"
626 " -e ==> set entry point to 'ep' (hex)\n"
627 " -n ==> set image name to 'name'\n"
628 " -d ==> use image data from 'datafile'\n"
629 " -x ==> set XIP (execute in place)\n",
631 fprintf(stderr, " %s [-D dtc_options] -f fit-image.its fit-image\n",
633 fprintf(stderr, " -D => set options for device tree compiler\n"
634 " -f => input filename for FIT source\n");
635 #ifdef CONFIG_FIT_SIGNATURE
636 fprintf(stderr, "Signing / verified boot options: [-k keydir]\n"
637 " -k => set directory containing private keys\n");
639 fprintf(stderr, "Signing / verified boot not supported (CONFIG_FIT_SIGNATURE undefined)\n");
641 fprintf (stderr, " %s -V ==> print version information and exit\n",