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 Kirkwood Boot image generation/list support */
152 init_kwb_image_type ();
153 /* Init FIT image generation/list support */
154 init_fit_image_type ();
155 /* Init Default image generation/list support */
156 init_default_image_type ();
158 params.cmdname = *argv;
159 params.addr = params.ep = 0;
161 while (--argc > 0 && **++argv == '-') {
170 genimg_get_arch_id (*++argv)) < 0)
176 genimg_get_comp_id (*++argv)) < 0)
182 params.dtc = *++argv;
188 genimg_get_os_id (*++argv)) < 0)
194 genimg_get_type_id (*++argv)) < 0)
201 params.addr = strtoul (*++argv,
205 "%s: invalid load address %s\n",
206 params.cmdname, *argv);
213 params.datafile = *++argv;
219 params.ep = strtoul (*++argv,
223 "%s: invalid entry point %s\n",
224 params.cmdname, *argv);
233 * The flattened image tree (FIT) format
234 * requires a flattened device tree image type
236 params.type = IH_TYPE_FLATDT;
237 params.datafile = *++argv;
243 params.imagename = *++argv;
261 /* set tparams as per input type_id */
262 tparams = mkimage_get_type(params.type);
263 if (tparams == NULL) {
264 fprintf (stderr, "%s: unsupported type %s\n",
265 params.cmdname, genimg_get_type_name(params.type));
270 * check the passed arguments parameters meets the requirements
271 * as per image type to be generated/listed
273 if (tparams->check_params)
274 if (tparams->check_params (¶ms))
278 params.ep = params.addr;
279 /* If XIP, entry point must be after the U-Boot header */
281 params.ep += tparams->header_size;
285 * If XIP, ensure the entry point is equal to the load address plus
286 * the size of the U-Boot header.
289 if (params.ep != params.addr + tparams->header_size) {
291 "%s: For XIP, the entry point must be the load addr + %lu\n",
293 (unsigned long)tparams->header_size);
298 params.imagefile = *argv;
301 if (tparams->fflag_handle)
303 * in some cases, some additional processing needs
304 * to be done if fflag is defined
306 * For ex. fit_handle_file for Fit file support
308 retval = tparams->fflag_handle(¶ms);
310 if (retval != EXIT_SUCCESS)
314 if (params.lflag || params.fflag) {
315 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
317 ifd = open (params.imagefile,
318 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
322 fprintf (stderr, "%s: Can't open %s: %s\n",
323 params.cmdname, params.imagefile,
328 if (params.lflag || params.fflag) {
330 * list header information of existing image
332 if (fstat(ifd, &sbuf) < 0) {
333 fprintf (stderr, "%s: Can't stat %s: %s\n",
334 params.cmdname, params.imagefile,
339 if ((unsigned)sbuf.st_size < tparams->header_size) {
341 "%s: Bad size: \"%s\" is not valid image\n",
342 params.cmdname, params.imagefile);
346 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
347 if (ptr == MAP_FAILED) {
348 fprintf (stderr, "%s: Can't read %s: %s\n",
349 params.cmdname, params.imagefile,
355 * scan through mkimage registry for all supported image types
356 * and verify the input image file header for match
357 * Print the image information for matched image type
358 * Returns the error code if not matched
360 retval = mkimage_verify_print_header (ptr, &sbuf);
362 (void) munmap((void *)ptr, sbuf.st_size);
371 * write dummy header, to be fixed later
373 memset (tparams->hdr, 0, tparams->header_size);
375 if (write(ifd, tparams->hdr, tparams->header_size)
376 != tparams->header_size) {
377 fprintf (stderr, "%s: Write error on %s: %s\n",
378 params.cmdname, params.imagefile, strerror(errno));
382 if (params.type == IH_TYPE_MULTI || params.type == IH_TYPE_SCRIPT) {
383 char *file = params.datafile;
390 if ((sep = strchr(file, ':')) != NULL) {
394 if (stat (file, &sbuf) < 0) {
395 fprintf (stderr, "%s: Can't stat %s: %s\n",
396 params.cmdname, file, strerror(errno));
399 size = cpu_to_uimage (sbuf.st_size);
404 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
405 fprintf (stderr, "%s: Write error on %s: %s\n",
406 params.cmdname, params.imagefile,
423 file = params.datafile;
426 char *sep = strchr(file, ':');
429 copy_file (ifd, file, 1);
433 copy_file (ifd, file, 0);
438 copy_file (ifd, params.datafile, 0);
441 /* We're a bit of paranoid */
442 #if defined(_POSIX_SYNCHRONIZED_IO) && \
443 !defined(__sun__) && \
444 !defined(__FreeBSD__) && \
446 (void) fdatasync (ifd);
451 if (fstat(ifd, &sbuf) < 0) {
452 fprintf (stderr, "%s: Can't stat %s: %s\n",
453 params.cmdname, params.imagefile, strerror(errno));
457 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
458 if (ptr == MAP_FAILED) {
459 fprintf (stderr, "%s: Can't map %s: %s\n",
460 params.cmdname, params.imagefile, strerror(errno));
464 /* Setup the image header as per input image type*/
465 if (tparams->set_header)
466 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
468 fprintf (stderr, "%s: Can't set header for %s: %s\n",
469 params.cmdname, tparams->name, strerror(errno));
473 /* Print the image information by processing image header */
474 if (tparams->print_header)
475 tparams->print_header (ptr);
477 fprintf (stderr, "%s: Can't print header for %s: %s\n",
478 params.cmdname, tparams->name, strerror(errno));
482 (void) munmap((void *)ptr, sbuf.st_size);
484 /* We're a bit of paranoid */
485 #if defined(_POSIX_SYNCHRONIZED_IO) && \
486 !defined(__sun__) && \
487 !defined(__FreeBSD__) && \
489 (void) fdatasync (ifd);
495 fprintf (stderr, "%s: Write error on %s: %s\n",
496 params.cmdname, params.imagefile, strerror(errno));
504 copy_file (int ifd, const char *datafile, int pad)
513 struct image_type_params *tparams = mkimage_get_type (params.type);
516 fprintf (stderr, "Adding Image %s\n", datafile);
519 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
520 fprintf (stderr, "%s: Can't open %s: %s\n",
521 params.cmdname, datafile, strerror(errno));
525 if (fstat(dfd, &sbuf) < 0) {
526 fprintf (stderr, "%s: Can't stat %s: %s\n",
527 params.cmdname, datafile, strerror(errno));
531 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
532 if (ptr == MAP_FAILED) {
533 fprintf (stderr, "%s: Can't read %s: %s\n",
534 params.cmdname, datafile, strerror(errno));
539 unsigned char *p = NULL;
541 * XIP: do not append the image_header_t at the
542 * beginning of the file, but consume the space
546 if ((unsigned)sbuf.st_size < tparams->header_size) {
548 "%s: Bad size: \"%s\" is too small for XIP\n",
549 params.cmdname, datafile);
553 for (p = ptr; p < ptr + tparams->header_size; p++) {
556 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
557 params.cmdname, datafile);
562 offset = tparams->header_size;
565 size = sbuf.st_size - offset;
566 if (write(ifd, ptr + offset, size) != size) {
567 fprintf (stderr, "%s: Write error on %s: %s\n",
568 params.cmdname, params.imagefile, strerror(errno));
572 if (pad && ((tail = size % 4) != 0)) {
574 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
575 fprintf (stderr, "%s: Write error on %s: %s\n",
576 params.cmdname, params.imagefile,
582 (void) munmap((void *)ptr, sbuf.st_size);
589 fprintf (stderr, "Usage: %s -l image\n"
590 " -l ==> list image header information\n",
592 fprintf (stderr, " %s [-x] -A arch -O os -T type -C comp "
593 "-a addr -e ep -n name -d data_file[:data_file...] image\n"
594 " -A ==> set architecture to 'arch'\n"
595 " -O ==> set operating system to 'os'\n"
596 " -T ==> set image type to 'type'\n"
597 " -C ==> set compression type 'comp'\n"
598 " -a ==> set load address to 'addr' (hex)\n"
599 " -e ==> set entry point to 'ep' (hex)\n"
600 " -n ==> set image name to 'name'\n"
601 " -d ==> use image data from 'datafile'\n"
602 " -x ==> set XIP (execute in place)\n",
604 fprintf (stderr, " %s [-D dtc_options] -f fit-image.its fit-image\n",