2 * (C) Copyright 2000-2004
3 * DENX Software Engineering
4 * Wolfgang Denk, wd@denx.de
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation; either version 2 of
10 * the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 #include <netinet/in.h> /* for host / network byte order conversions */
36 #if defined(__BEOS__) || defined(__NetBSD__) || defined(__APPLE__)
41 typedef unsigned int __u32;
43 #define SWAP_LONG(x) \
45 (((__u32)(x) & (__u32)0x000000ffUL) << 24) | \
46 (((__u32)(x) & (__u32)0x0000ff00UL) << 8) | \
47 (((__u32)(x) & (__u32)0x00ff0000UL) >> 8) | \
48 (((__u32)(x) & (__u32)0xff000000UL) >> 24) ))
49 typedef unsigned char uint8_t;
50 typedef unsigned short uint16_t;
51 typedef unsigned int uint32_t;
53 #define ntohl(a) SWAP_LONG(a)
54 #define htonl(a) SWAP_LONG(a)
55 #endif /* __WIN32__ */
57 #ifndef O_BINARY /* should be define'd on __WIN32__ */
66 #define MAP_FAILED (-1)
71 extern unsigned long crc32 (unsigned long crc, const char *buf, unsigned int len);
73 typedef struct table_entry {
74 int val; /* as defined in image.h */
75 char *sname; /* short (input) name */
76 char *lname; /* long (output) name */
79 table_entry_t arch_name[] = {
80 { IH_CPU_INVALID, NULL, "Invalid CPU", },
81 { IH_CPU_ALPHA, "alpha", "Alpha", },
82 { IH_CPU_ARM, "arm", "ARM", },
83 { IH_CPU_I386, "x86", "Intel x86", },
84 { IH_CPU_IA64, "ia64", "IA64", },
85 { IH_CPU_MIPS, "mips", "MIPS", },
86 { IH_CPU_MIPS64, "mips64", "MIPS 64 Bit", },
87 { IH_CPU_PPC, "ppc", "PowerPC", },
88 { IH_CPU_S390, "s390", "IBM S390", },
89 { IH_CPU_SH, "sh", "SuperH", },
90 { IH_CPU_SPARC, "sparc", "SPARC", },
91 { IH_CPU_SPARC64, "sparc64", "SPARC 64 Bit", },
92 { IH_CPU_M68K, "m68k", "MC68000", },
96 table_entry_t os_name[] = {
97 { IH_OS_INVALID, NULL, "Invalid OS", },
98 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
99 { IH_OS_NETBSD, "netbsd", "NetBSD", },
100 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
101 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
102 { IH_OS_LINUX, "linux", "Linux", },
103 { IH_OS_SVR4, "svr4", "SVR4", },
104 { IH_OS_ESIX, "esix", "Esix", },
105 { IH_OS_SOLARIS, "solaris", "Solaris", },
106 { IH_OS_IRIX, "irix", "Irix", },
107 { IH_OS_SCO, "sco", "SCO", },
108 { IH_OS_DELL, "dell", "Dell", },
109 { IH_OS_NCR, "ncr", "NCR", },
110 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
111 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
112 { IH_OS_PSOS, "psos", "pSOS", },
113 { IH_OS_QNX, "qnx", "QNX", },
114 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
115 { IH_OS_RTEMS, "rtems", "RTEMS", },
116 { IH_OS_ARTOS, "artos", "ARTOS", },
120 table_entry_t type_name[] = {
121 { IH_TYPE_INVALID, NULL, "Invalid Image", },
122 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
123 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
124 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
125 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
126 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
127 { IH_TYPE_SCRIPT, "script", "Script", },
128 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
132 table_entry_t comp_name[] = {
133 { IH_COMP_NONE, "none", "uncompressed", },
134 { IH_COMP_GZIP, "gzip", "gzip compressed", },
135 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
139 static void copy_file (int, const char *, int);
140 static void usage (void);
141 static void print_header (image_header_t *);
142 static void print_type (image_header_t *);
143 static char *put_table_entry (table_entry_t *, char *, int);
144 static char *put_arch (int);
145 static char *put_type (int);
146 static char *put_os (int);
147 static char *put_comp (int);
148 static int get_table_entry (table_entry_t *, char *, char *);
149 static int get_arch(char *);
150 static int get_comp(char *);
151 static int get_os (char *);
152 static int get_type(char *);
163 int opt_os = IH_OS_LINUX;
164 int opt_arch = IH_CPU_PPC;
165 int opt_type = IH_TYPE_KERNEL;
166 int opt_comp = IH_COMP_GZIP;
168 image_header_t header;
169 image_header_t *hdr = &header;
172 main (int argc, char **argv)
186 while (--argc > 0 && **++argv == '-') {
194 (opt_arch = get_arch(*++argv)) < 0)
199 (opt_comp = get_comp(*++argv)) < 0)
204 (opt_os = get_os(*++argv)) < 0)
209 (opt_type = get_type(*++argv)) < 0)
216 addr = strtoul (*++argv, (char **)&ptr, 16);
219 "%s: invalid load address %s\n",
233 ep = strtoul (*++argv, (char **)&ptr, 16);
236 "%s: invalid entry point %s\n",
260 if ((argc != 1) || ((lflag ^ dflag) == 0))
265 /* If XIP, entry point must be after the U-Boot header */
267 ep += sizeof(image_header_t);
271 * If XIP, ensure the entry point is equal to the load address plus
272 * the size of the U-Boot header.
275 if (ep != addr + sizeof(image_header_t)) {
276 fprintf (stderr, "%s: For XIP, the entry point must be the load addr + %lu\n",
278 (unsigned long)sizeof(image_header_t));
286 ifd = open(imagefile, O_RDONLY|O_BINARY);
288 ifd = open(imagefile, O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
292 fprintf (stderr, "%s: Can't open %s: %s\n",
293 cmdname, imagefile, strerror(errno));
301 * list header information of existing image
303 if (fstat(ifd, &sbuf) < 0) {
304 fprintf (stderr, "%s: Can't stat %s: %s\n",
305 cmdname, imagefile, strerror(errno));
309 if ((unsigned)sbuf.st_size < sizeof(image_header_t)) {
311 "%s: Bad size: \"%s\" is no valid image\n",
316 ptr = (unsigned char *)mmap(0, sbuf.st_size,
317 PROT_READ, MAP_SHARED, ifd, 0);
318 if ((caddr_t)ptr == (caddr_t)-1) {
319 fprintf (stderr, "%s: Can't read %s: %s\n",
320 cmdname, imagefile, strerror(errno));
325 * create copy of header so that we can blank out the
326 * checksum field for checking - this can't be done
327 * on the PROT_READ mapped data.
329 memcpy (hdr, ptr, sizeof(image_header_t));
331 if (ntohl(hdr->ih_magic) != IH_MAGIC) {
333 "%s: Bad Magic Number: \"%s\" is no valid image\n",
339 len = sizeof(image_header_t);
341 checksum = ntohl(hdr->ih_hcrc);
342 hdr->ih_hcrc = htonl(0); /* clear for re-calculation */
344 if (crc32 (0, data, len) != checksum) {
346 "*** Warning: \"%s\" has bad header checksum!\n",
350 data = (char *)(ptr + sizeof(image_header_t));
351 len = sbuf.st_size - sizeof(image_header_t) ;
353 if (crc32 (0, data, len) != ntohl(hdr->ih_dcrc)) {
355 "*** Warning: \"%s\" has corrupted data!\n",
359 /* for multi-file images we need the data part, too */
360 print_header ((image_header_t *)ptr);
362 (void) munmap((void *)ptr, sbuf.st_size);
371 * write dummy header, to be fixed later
373 memset (hdr, 0, sizeof(image_header_t));
375 if (write(ifd, hdr, sizeof(image_header_t)) != sizeof(image_header_t)) {
376 fprintf (stderr, "%s: Write error on %s: %s\n",
377 cmdname, imagefile, strerror(errno));
381 if (opt_type == IH_TYPE_MULTI || opt_type == IH_TYPE_SCRIPT) {
382 char *file = datafile;
389 if ((sep = strchr(file, ':')) != NULL) {
393 if (stat (file, &sbuf) < 0) {
394 fprintf (stderr, "%s: Can't stat %s: %s\n",
395 cmdname, file, strerror(errno));
398 size = htonl(sbuf.st_size);
403 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
404 fprintf (stderr, "%s: Write error on %s: %s\n",
405 cmdname, imagefile, strerror(errno));
424 char *sep = strchr(file, ':');
427 copy_file (ifd, file, 1);
431 copy_file (ifd, file, 0);
436 copy_file (ifd, datafile, 0);
439 /* We're a bit of paranoid */
440 #if defined(_POSIX_SYNCHRONIZED_IO) && !defined(__sun__) && !defined(__FreeBSD__)
441 (void) fdatasync (ifd);
446 if (fstat(ifd, &sbuf) < 0) {
447 fprintf (stderr, "%s: Can't stat %s: %s\n",
448 cmdname, imagefile, strerror(errno));
452 ptr = (unsigned char *)mmap(0, sbuf.st_size,
453 PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
454 if (ptr == (unsigned char *)MAP_FAILED) {
455 fprintf (stderr, "%s: Can't map %s: %s\n",
456 cmdname, imagefile, strerror(errno));
460 hdr = (image_header_t *)ptr;
463 (const char *)(ptr + sizeof(image_header_t)),
464 sbuf.st_size - sizeof(image_header_t)
467 /* Build new header */
468 hdr->ih_magic = htonl(IH_MAGIC);
469 hdr->ih_time = htonl(sbuf.st_mtime);
470 hdr->ih_size = htonl(sbuf.st_size - sizeof(image_header_t));
471 hdr->ih_load = htonl(addr);
472 hdr->ih_ep = htonl(ep);
473 hdr->ih_dcrc = htonl(checksum);
475 hdr->ih_arch = opt_arch;
476 hdr->ih_type = opt_type;
477 hdr->ih_comp = opt_comp;
479 strncpy((char *)hdr->ih_name, name, IH_NMLEN);
481 checksum = crc32(0,(const char *)hdr,sizeof(image_header_t));
483 hdr->ih_hcrc = htonl(checksum);
487 (void) munmap((void *)ptr, sbuf.st_size);
489 /* We're a bit of paranoid */
490 #if defined(_POSIX_SYNCHRONIZED_IO) && !defined(__sun__) && !defined(__FreeBSD__)
491 (void) fdatasync (ifd);
497 fprintf (stderr, "%s: Write error on %s: %s\n",
498 cmdname, imagefile, strerror(errno));
506 copy_file (int ifd, const char *datafile, int pad)
517 fprintf (stderr, "Adding Image %s\n", datafile);
520 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
521 fprintf (stderr, "%s: Can't open %s: %s\n",
522 cmdname, datafile, strerror(errno));
526 if (fstat(dfd, &sbuf) < 0) {
527 fprintf (stderr, "%s: Can't stat %s: %s\n",
528 cmdname, datafile, strerror(errno));
532 ptr = (unsigned char *)mmap(0, sbuf.st_size,
533 PROT_READ, MAP_SHARED, dfd, 0);
534 if (ptr == (unsigned char *)MAP_FAILED) {
535 fprintf (stderr, "%s: Can't read %s: %s\n",
536 cmdname, datafile, strerror(errno));
541 unsigned char *p = NULL;
543 * XIP: do not append the image_header_t at the
544 * beginning of the file, but consume the space
548 if ((unsigned)sbuf.st_size < sizeof(image_header_t)) {
550 "%s: Bad size: \"%s\" is too small for XIP\n",
555 for (p=ptr; p < ptr+sizeof(image_header_t); p++) {
558 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
564 offset = sizeof(image_header_t);
567 size = sbuf.st_size - offset;
568 if (write(ifd, ptr + offset, size) != size) {
569 fprintf (stderr, "%s: Write error on %s: %s\n",
570 cmdname, imagefile, strerror(errno));
574 if (pad && ((tail = size % 4) != 0)) {
576 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
577 fprintf (stderr, "%s: Write error on %s: %s\n",
578 cmdname, imagefile, strerror(errno));
583 (void) munmap((void *)ptr, sbuf.st_size);
590 fprintf (stderr, "Usage: %s -l image\n"
591 " -l ==> list image header information\n"
592 " %s -A arch -O os -T type -C comp "
593 "-a addr -e ep -n name -d data_file[:data_file...] image\n",
595 fprintf (stderr, " -A ==> set architecture to 'arch'\n"
596 " -O ==> set operating system to 'os'\n"
597 " -T ==> set image type to 'type'\n"
598 " -C ==> set compression type 'comp'\n"
599 " -a ==> set load address to 'addr' (hex)\n"
600 " -e ==> set entry point to 'ep' (hex)\n"
601 " -n ==> set image name to 'name'\n"
602 " -d ==> use image data from 'datafile'\n"
603 " -x ==> set XIP (execute in place)\n"
609 print_header (image_header_t *hdr)
614 timestamp = (time_t)ntohl(hdr->ih_time);
615 size = ntohl(hdr->ih_size);
617 printf ("Image Name: %.*s\n", IH_NMLEN, hdr->ih_name);
618 printf ("Created: %s", ctime(×tamp));
619 printf ("Image Type: "); print_type(hdr);
620 printf ("Data Size: %d Bytes = %.2f kB = %.2f MB\n",
621 size, (double)size / 1.024e3, (double)size / 1.048576e6 );
622 printf ("Load Address: 0x%08X\n", ntohl(hdr->ih_load));
623 printf ("Entry Point: 0x%08X\n", ntohl(hdr->ih_ep));
625 if (hdr->ih_type == IH_TYPE_MULTI || hdr->ih_type == IH_TYPE_SCRIPT) {
628 unsigned long *len_ptr = (unsigned long *) (
629 (unsigned long)hdr + sizeof(image_header_t)
632 /* determine number of images first (to calculate image offsets) */
633 for (i=0; len_ptr[i]; ++i) /* null pointer terminates list */
635 ptrs = i; /* null pointer terminates list */
637 pos = sizeof(image_header_t) + ptrs * sizeof(long);
638 printf ("Contents:\n");
639 for (i=0; len_ptr[i]; ++i) {
640 size = ntohl(len_ptr[i]);
642 printf (" Image %d: %8d Bytes = %4d kB = %d MB\n",
643 i, size, size>>10, size>>20);
644 if (hdr->ih_type == IH_TYPE_SCRIPT && i > 0) {
646 * the user may need to know offsets
647 * if planning to do something with
650 printf (" Offset = %08X\n", pos);
652 /* copy_file() will pad the first files to even word align */
662 print_type (image_header_t *hdr)
664 printf ("%s %s %s (%s)\n",
665 put_arch (hdr->ih_arch),
666 put_os (hdr->ih_os ),
667 put_type (hdr->ih_type),
668 put_comp (hdr->ih_comp)
672 static char *put_arch (int arch)
674 return (put_table_entry(arch_name, "Unknown Architecture", arch));
677 static char *put_os (int os)
679 return (put_table_entry(os_name, "Unknown OS", os));
682 static char *put_type (int type)
684 return (put_table_entry(type_name, "Unknown Image", type));
687 static char *put_comp (int comp)
689 return (put_table_entry(comp_name, "Unknown Compression", comp));
692 static char *put_table_entry (table_entry_t *table, char *msg, int type)
694 for (; table->val>=0; ++table) {
695 if (table->val == type)
696 return (table->lname);
701 static int get_arch(char *name)
703 return (get_table_entry(arch_name, "CPU", name));
707 static int get_comp(char *name)
709 return (get_table_entry(comp_name, "Compression", name));
713 static int get_os (char *name)
715 return (get_table_entry(os_name, "OS", name));
719 static int get_type(char *name)
721 return (get_table_entry(type_name, "Image", name));
724 static int get_table_entry (table_entry_t *table, char *msg, char *name)
729 for (t=table; t->val>=0; ++t) {
730 if (t->sname && strcasecmp(t->sname, name)==0)
733 fprintf (stderr, "\nInvalid %s Type - valid names are", msg);
734 for (t=table; t->val>=0; ++t) {
735 if (t->sname == NULL)
737 fprintf (stderr, "%c %s", (first) ? ':' : ',', t->sname);
740 fprintf (stderr, "\n");