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,
27 static void copy_file(int, const char *, int);
28 static void usage(void);
30 /* image_type_params link list to maintain registered image type supports */
31 struct image_type_params *mkimage_tparams = NULL;
33 /* parameters initialized by core will be used by the image type code */
34 struct mkimage_params params = {
37 .type = IH_TYPE_KERNEL,
39 .dtc = MKIMAGE_DEFAULT_DTC_OPTIONS,
45 * It is used to register respective image generation/list support to the
48 * the input struct image_type_params is checked and appended to the link
49 * list, if the input structure is already registered, error
51 void mkimage_register (struct image_type_params *tparams)
53 struct image_type_params **tp;
56 fprintf (stderr, "%s: %s: Null input\n",
57 params.cmdname, __FUNCTION__);
61 /* scan the linked list, check for registry and point the last one */
62 for (tp = &mkimage_tparams; *tp != NULL; tp = &(*tp)->next) {
63 if (!strcmp((*tp)->name, tparams->name)) {
64 fprintf (stderr, "%s: %s already registered\n",
65 params.cmdname, tparams->name);
70 /* add input struct entry at the end of link list */
72 /* mark input entry as last entry in the link list */
75 debug ("Registered %s\n", tparams->name);
81 * It scans all registers image type supports
82 * checks the input type_id for each supported image type
85 * returns respective image_type_params pointer if success
86 * if input type_id is not supported by any of image_type_support
89 struct image_type_params *mkimage_get_type(int type)
91 struct image_type_params *curr;
93 for (curr = mkimage_tparams; curr != NULL; curr = curr->next) {
94 if (curr->check_image_type) {
95 if (!curr->check_image_type (type))
103 * mkimage_verify_print_header -
105 * It scans mkimage_tparams link list,
106 * verifies image_header for each supported image type
107 * if verification is successful, prints respective header
109 * returns negative if input image format does not match with any of
110 * supported image types
112 int mkimage_verify_print_header (void *ptr, struct stat *sbuf)
115 struct image_type_params *curr;
117 for (curr = mkimage_tparams; curr != NULL; curr = curr->next ) {
118 if (curr->verify_header) {
119 retval = curr->verify_header (
120 (unsigned char *)ptr, sbuf->st_size,
125 * Print the image information
126 * if verify is successful
128 if (curr->print_header)
129 curr->print_header (ptr);
132 "%s: print_header undefined for %s\n",
133 params.cmdname, curr->name);
143 main (int argc, char **argv)
149 struct image_type_params *tparams = NULL;
151 /* Init FIT image generation/list support */
152 init_fit_image_type ();
153 /* Init Default image generation/list support */
154 init_default_image_type ();
156 params.cmdname = *argv;
157 params.addr = params.ep = 0;
159 while (--argc > 0 && **++argv == '-') {
168 genimg_get_arch_id (*++argv)) < 0)
174 genimg_get_comp_id (*++argv)) < 0)
180 params.dtc = *++argv;
186 genimg_get_os_id (*++argv)) < 0)
192 genimg_get_type_id (*++argv)) < 0)
199 params.addr = strtoul (*++argv,
203 "%s: invalid load address %s\n",
204 params.cmdname, *argv);
211 params.datafile = *++argv;
217 params.ep = strtoul (*++argv,
221 "%s: invalid entry point %s\n",
222 params.cmdname, *argv);
230 params.datafile = *++argv;
236 params.imagename = *++argv;
254 /* set tparams as per input type_id */
255 tparams = mkimage_get_type(params.type);
256 if (tparams == NULL) {
257 fprintf (stderr, "%s: unsupported type %s\n",
258 params.cmdname, genimg_get_type_name(params.type));
263 * check the passed arguments parameters meets the requirements
264 * as per image type to be generated/listed
266 if (tparams->check_params)
267 if (tparams->check_params (¶ms))
271 params.ep = params.addr;
272 /* If XIP, entry point must be after the U-Boot header */
274 params.ep += tparams->header_size;
278 * If XIP, ensure the entry point is equal to the load address plus
279 * the size of the U-Boot header.
282 if (params.ep != params.addr + tparams->header_size) {
284 "%s: For XIP, the entry point must be the load addr + %lu\n",
286 (unsigned long)tparams->header_size);
291 params.imagefile = *argv;
295 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
297 ifd = open (params.imagefile,
298 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
302 fprintf (stderr, "%s: Can't open %s: %s\n",
303 params.cmdname, params.imagefile,
311 * list header information of existing image
313 if (fstat(ifd, &sbuf) < 0) {
314 fprintf (stderr, "%s: Can't stat %s: %s\n",
315 params.cmdname, params.imagefile,
320 if ((unsigned)sbuf.st_size < tparams->header_size) {
322 "%s: Bad size: \"%s\" is not valid image\n",
323 params.cmdname, params.imagefile);
327 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
328 if (ptr == MAP_FAILED) {
329 fprintf (stderr, "%s: Can't read %s: %s\n",
330 params.cmdname, params.imagefile,
336 * scan through mkimage registry for all supported image types
337 * and verify the input image file header for match
338 * Print the image information for matched image type
339 * Returns the error code if not matched
341 retval = mkimage_verify_print_header (ptr, &sbuf);
343 (void) munmap((void *)ptr, sbuf.st_size);
347 } else if (params.fflag) {
348 if (tparams->fflag_handle)
350 * in some cases, some additional processing needs
351 * to be done if fflag is defined
353 * For ex. fit_handle_file for Fit file support
355 retval = tparams->fflag_handle(¶ms);
363 * write dummy header, to be fixed later
365 memset (tparams->hdr, 0, tparams->header_size);
367 if (write(ifd, tparams->hdr, tparams->header_size)
368 != tparams->header_size) {
369 fprintf (stderr, "%s: Write error on %s: %s\n",
370 params.cmdname, params.imagefile, strerror(errno));
374 if (params.type == IH_TYPE_MULTI || params.type == IH_TYPE_SCRIPT) {
375 char *file = params.datafile;
382 if ((sep = strchr(file, ':')) != NULL) {
386 if (stat (file, &sbuf) < 0) {
387 fprintf (stderr, "%s: Can't stat %s: %s\n",
388 params.cmdname, file, strerror(errno));
391 size = cpu_to_uimage (sbuf.st_size);
396 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
397 fprintf (stderr, "%s: Write error on %s: %s\n",
398 params.cmdname, params.imagefile,
415 file = params.datafile;
418 char *sep = strchr(file, ':');
421 copy_file (ifd, file, 1);
425 copy_file (ifd, file, 0);
430 copy_file (ifd, params.datafile, 0);
433 /* We're a bit of paranoid */
434 #if defined(_POSIX_SYNCHRONIZED_IO) && \
435 !defined(__sun__) && \
436 !defined(__FreeBSD__) && \
438 (void) fdatasync (ifd);
443 if (fstat(ifd, &sbuf) < 0) {
444 fprintf (stderr, "%s: Can't stat %s: %s\n",
445 params.cmdname, params.imagefile, strerror(errno));
449 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
450 if (ptr == MAP_FAILED) {
451 fprintf (stderr, "%s: Can't map %s: %s\n",
452 params.cmdname, params.imagefile, strerror(errno));
456 /* Setup the image header as per input image type*/
457 if (tparams->set_header)
458 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
460 fprintf (stderr, "%s: Can't set header for %s: %s\n",
461 params.cmdname, tparams->name, strerror(errno));
465 /* Print the image information by processing image header */
466 if (tparams->print_header)
467 tparams->print_header (ptr);
469 fprintf (stderr, "%s: Can't print header for %s: %s\n",
470 params.cmdname, tparams->name, strerror(errno));
474 (void) munmap((void *)ptr, sbuf.st_size);
476 /* We're a bit of paranoid */
477 #if defined(_POSIX_SYNCHRONIZED_IO) && \
478 !defined(__sun__) && \
479 !defined(__FreeBSD__) && \
481 (void) fdatasync (ifd);
487 fprintf (stderr, "%s: Write error on %s: %s\n",
488 params.cmdname, params.imagefile, strerror(errno));
496 copy_file (int ifd, const char *datafile, int pad)
505 struct image_type_params *tparams = mkimage_get_type (params.type);
508 fprintf (stderr, "Adding Image %s\n", datafile);
511 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
512 fprintf (stderr, "%s: Can't open %s: %s\n",
513 params.cmdname, datafile, strerror(errno));
517 if (fstat(dfd, &sbuf) < 0) {
518 fprintf (stderr, "%s: Can't stat %s: %s\n",
519 params.cmdname, datafile, strerror(errno));
523 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
524 if (ptr == MAP_FAILED) {
525 fprintf (stderr, "%s: Can't read %s: %s\n",
526 params.cmdname, datafile, strerror(errno));
531 unsigned char *p = NULL;
533 * XIP: do not append the image_header_t at the
534 * beginning of the file, but consume the space
538 if ((unsigned)sbuf.st_size < tparams->header_size) {
540 "%s: Bad size: \"%s\" is too small for XIP\n",
541 params.cmdname, datafile);
545 for (p = ptr; p < ptr + tparams->header_size; p++) {
548 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
549 params.cmdname, datafile);
554 offset = tparams->header_size;
557 size = sbuf.st_size - offset;
558 if (write(ifd, ptr + offset, size) != size) {
559 fprintf (stderr, "%s: Write error on %s: %s\n",
560 params.cmdname, params.imagefile, strerror(errno));
564 if (pad && ((tail = size % 4) != 0)) {
566 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
567 fprintf (stderr, "%s: Write error on %s: %s\n",
568 params.cmdname, params.imagefile,
574 (void) munmap((void *)ptr, sbuf.st_size);
581 fprintf (stderr, "Usage: %s -l image\n"
582 " -l ==> list image header information\n",
584 fprintf (stderr, " %s [-x] -A arch -O os -T type -C comp "
585 "-a addr -e ep -n name -d data_file[:data_file...] image\n"
586 " -A ==> set architecture to 'arch'\n"
587 " -O ==> set operating system to 'os'\n"
588 " -T ==> set image type to 'type'\n"
589 " -C ==> set compression type 'comp'\n"
590 " -a ==> set load address to 'addr' (hex)\n"
591 " -e ==> set entry point to 'ep' (hex)\n"
592 " -n ==> set image name to 'name'\n"
593 " -d ==> use image data from 'datafile'\n"
594 " -x ==> set XIP (execute in place)\n",
596 fprintf (stderr, " %s [-D dtc_options] -f fit-image.its fit-image\n",