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,
46 * It is used to register respective image generation/list support to the
49 * the input struct image_type_params is checked and appended to the link
50 * list, if the input structure is already registered, error
52 void mkimage_register (struct image_type_params *tparams)
54 struct image_type_params **tp;
57 fprintf (stderr, "%s: %s: Null input\n",
58 params.cmdname, __FUNCTION__);
62 /* scan the linked list, check for registry and point the last one */
63 for (tp = &mkimage_tparams; *tp != NULL; tp = &(*tp)->next) {
64 if (!strcmp((*tp)->name, tparams->name)) {
65 fprintf (stderr, "%s: %s already registered\n",
66 params.cmdname, tparams->name);
71 /* add input struct entry at the end of link list */
73 /* mark input entry as last entry in the link list */
76 debug ("Registered %s\n", tparams->name);
82 * It scans all registers image type supports
83 * checks the input type_id for each supported image type
86 * returns respective image_type_params pointer if success
87 * if input type_id is not supported by any of image_type_support
90 struct image_type_params *mkimage_get_type(int type)
92 struct image_type_params *curr;
94 for (curr = mkimage_tparams; curr != NULL; curr = curr->next) {
95 if (curr->check_image_type) {
96 if (!curr->check_image_type (type))
104 * mkimage_verify_print_header -
106 * It scans mkimage_tparams link list,
107 * verifies image_header for each supported image type
108 * if verification is successful, prints respective header
110 * returns negative if input image format does not match with any of
111 * supported image types
113 int mkimage_verify_print_header (void *ptr, struct stat *sbuf)
116 struct image_type_params *curr;
118 for (curr = mkimage_tparams; curr != NULL; curr = curr->next ) {
119 if (curr->verify_header) {
120 retval = curr->verify_header (
121 (unsigned char *)ptr, sbuf->st_size,
126 * Print the image information
127 * if verify is successful
129 if (curr->print_header)
130 curr->print_header (ptr);
133 "%s: print_header undefined for %s\n",
134 params.cmdname, curr->name);
144 main (int argc, char **argv)
150 struct image_type_params *tparams = NULL;
152 /* Init Kirkwood Boot image generation/list support */
153 init_kwb_image_type ();
154 /* Init Freescale imx Boot image generation/list support */
155 init_imx_image_type ();
156 /* Init FIT image generation/list support */
157 init_fit_image_type ();
158 /* Init Default image generation/list support */
159 init_default_image_type ();
161 params.cmdname = *argv;
162 params.addr = params.ep = 0;
164 while (--argc > 0 && **++argv == '-') {
173 genimg_get_arch_id (*++argv)) < 0)
179 genimg_get_comp_id (*++argv)) < 0)
185 params.dtc = *++argv;
191 genimg_get_os_id (*++argv)) < 0)
197 genimg_get_type_id (*++argv)) < 0)
204 params.addr = strtoul (*++argv,
208 "%s: invalid load address %s\n",
209 params.cmdname, *argv);
216 params.datafile = *++argv;
222 params.ep = strtoul (*++argv,
226 "%s: invalid entry point %s\n",
227 params.cmdname, *argv);
236 * The flattened image tree (FIT) format
237 * requires a flattened device tree image type
239 params.type = IH_TYPE_FLATDT;
240 params.datafile = *++argv;
246 params.imagename = *++argv;
264 /* set tparams as per input type_id */
265 tparams = mkimage_get_type(params.type);
266 if (tparams == NULL) {
267 fprintf (stderr, "%s: unsupported type %s\n",
268 params.cmdname, genimg_get_type_name(params.type));
273 * check the passed arguments parameters meets the requirements
274 * as per image type to be generated/listed
276 if (tparams->check_params)
277 if (tparams->check_params (¶ms))
281 params.ep = params.addr;
282 /* If XIP, entry point must be after the U-Boot header */
284 params.ep += tparams->header_size;
287 params.imagefile = *argv;
290 if (tparams->fflag_handle)
292 * in some cases, some additional processing needs
293 * to be done if fflag is defined
295 * For ex. fit_handle_file for Fit file support
297 retval = tparams->fflag_handle(¶ms);
299 if (retval != EXIT_SUCCESS)
303 if (params.lflag || params.fflag) {
304 ifd = open (params.imagefile, O_RDONLY|O_BINARY);
306 ifd = open (params.imagefile,
307 O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
311 fprintf (stderr, "%s: Can't open %s: %s\n",
312 params.cmdname, params.imagefile,
317 if (params.lflag || params.fflag) {
319 * list header information of existing image
321 if (fstat(ifd, &sbuf) < 0) {
322 fprintf (stderr, "%s: Can't stat %s: %s\n",
323 params.cmdname, params.imagefile,
328 if ((unsigned)sbuf.st_size < tparams->header_size) {
330 "%s: Bad size: \"%s\" is not valid image\n",
331 params.cmdname, params.imagefile);
335 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, ifd, 0);
336 if (ptr == MAP_FAILED) {
337 fprintf (stderr, "%s: Can't read %s: %s\n",
338 params.cmdname, params.imagefile,
344 * scan through mkimage registry for all supported image types
345 * and verify the input image file header for match
346 * Print the image information for matched image type
347 * Returns the error code if not matched
349 retval = mkimage_verify_print_header (ptr, &sbuf);
351 (void) munmap((void *)ptr, sbuf.st_size);
360 * write dummy header, to be fixed later
362 memset (tparams->hdr, 0, tparams->header_size);
364 if (write(ifd, tparams->hdr, tparams->header_size)
365 != tparams->header_size) {
366 fprintf (stderr, "%s: Write error on %s: %s\n",
367 params.cmdname, params.imagefile, strerror(errno));
371 if (params.type == IH_TYPE_MULTI || params.type == IH_TYPE_SCRIPT) {
372 char *file = params.datafile;
379 if ((sep = strchr(file, ':')) != NULL) {
383 if (stat (file, &sbuf) < 0) {
384 fprintf (stderr, "%s: Can't stat %s: %s\n",
385 params.cmdname, file, strerror(errno));
388 size = cpu_to_uimage (sbuf.st_size);
393 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
394 fprintf (stderr, "%s: Write error on %s: %s\n",
395 params.cmdname, params.imagefile,
412 file = params.datafile;
415 char *sep = strchr(file, ':');
418 copy_file (ifd, file, 1);
422 copy_file (ifd, file, 0);
427 copy_file (ifd, params.datafile, 0);
430 /* We're a bit of paranoid */
431 #if defined(_POSIX_SYNCHRONIZED_IO) && \
432 !defined(__sun__) && \
433 !defined(__FreeBSD__) && \
435 (void) fdatasync (ifd);
440 if (fstat(ifd, &sbuf) < 0) {
441 fprintf (stderr, "%s: Can't stat %s: %s\n",
442 params.cmdname, params.imagefile, strerror(errno));
446 ptr = mmap(0, sbuf.st_size, PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
447 if (ptr == MAP_FAILED) {
448 fprintf (stderr, "%s: Can't map %s: %s\n",
449 params.cmdname, params.imagefile, strerror(errno));
453 /* Setup the image header as per input image type*/
454 if (tparams->set_header)
455 tparams->set_header (ptr, &sbuf, ifd, ¶ms);
457 fprintf (stderr, "%s: Can't set header for %s: %s\n",
458 params.cmdname, tparams->name, strerror(errno));
462 /* Print the image information by processing image header */
463 if (tparams->print_header)
464 tparams->print_header (ptr);
466 fprintf (stderr, "%s: Can't print header for %s: %s\n",
467 params.cmdname, tparams->name, strerror(errno));
471 (void) munmap((void *)ptr, sbuf.st_size);
473 /* We're a bit of paranoid */
474 #if defined(_POSIX_SYNCHRONIZED_IO) && \
475 !defined(__sun__) && \
476 !defined(__FreeBSD__) && \
478 (void) fdatasync (ifd);
484 fprintf (stderr, "%s: Write error on %s: %s\n",
485 params.cmdname, params.imagefile, strerror(errno));
493 copy_file (int ifd, const char *datafile, int pad)
502 struct image_type_params *tparams = mkimage_get_type (params.type);
505 fprintf (stderr, "Adding Image %s\n", datafile);
508 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
509 fprintf (stderr, "%s: Can't open %s: %s\n",
510 params.cmdname, datafile, strerror(errno));
514 if (fstat(dfd, &sbuf) < 0) {
515 fprintf (stderr, "%s: Can't stat %s: %s\n",
516 params.cmdname, datafile, strerror(errno));
520 ptr = mmap(0, sbuf.st_size, PROT_READ, MAP_SHARED, dfd, 0);
521 if (ptr == MAP_FAILED) {
522 fprintf (stderr, "%s: Can't read %s: %s\n",
523 params.cmdname, datafile, strerror(errno));
528 unsigned char *p = NULL;
530 * XIP: do not append the image_header_t at the
531 * beginning of the file, but consume the space
535 if ((unsigned)sbuf.st_size < tparams->header_size) {
537 "%s: Bad size: \"%s\" is too small for XIP\n",
538 params.cmdname, datafile);
542 for (p = ptr; p < ptr + tparams->header_size; p++) {
545 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
546 params.cmdname, datafile);
551 offset = tparams->header_size;
554 size = sbuf.st_size - offset;
555 if (write(ifd, ptr + offset, size) != size) {
556 fprintf (stderr, "%s: Write error on %s: %s\n",
557 params.cmdname, params.imagefile, strerror(errno));
561 if (pad && ((tail = size % 4) != 0)) {
563 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
564 fprintf (stderr, "%s: Write error on %s: %s\n",
565 params.cmdname, params.imagefile,
571 (void) munmap((void *)ptr, sbuf.st_size);
578 fprintf (stderr, "Usage: %s -l image\n"
579 " -l ==> list image header information\n",
581 fprintf (stderr, " %s [-x] -A arch -O os -T type -C comp "
582 "-a addr -e ep -n name -d data_file[:data_file...] image\n"
583 " -A ==> set architecture to 'arch'\n"
584 " -O ==> set operating system to 'os'\n"
585 " -T ==> set image type to 'type'\n"
586 " -C ==> set compression type 'comp'\n"
587 " -a ==> set load address to 'addr' (hex)\n"
588 " -e ==> set entry point to 'ep' (hex)\n"
589 " -n ==> set image name to 'name'\n"
590 " -d ==> use image data from 'datafile'\n"
591 " -x ==> set XIP (execute in place)\n",
593 fprintf (stderr, " %s [-D dtc_options] -f fit-image.its fit-image\n",