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_M68K, "m68k", "MC68000", },
86 { IH_CPU_MICROBLAZE, "microblaze", "MicroBlaze", },
87 { IH_CPU_MIPS, "mips", "MIPS", },
88 { IH_CPU_MIPS64, "mips64", "MIPS 64 Bit", },
89 { IH_CPU_NIOS, "nios", "NIOS", },
90 { IH_CPU_NIOS2, "nios2", "NIOS II", },
91 { IH_CPU_PPC, "ppc", "PowerPC", },
92 { IH_CPU_S390, "s390", "IBM S390", },
93 { IH_CPU_SH, "sh", "SuperH", },
94 { IH_CPU_SPARC, "sparc", "SPARC", },
95 { IH_CPU_SPARC64, "sparc64", "SPARC 64 Bit", },
96 { IH_CPU_BLACKFIN, "blackfin", "Blackfin", },
100 table_entry_t os_name[] = {
101 { IH_OS_INVALID, NULL, "Invalid OS", },
102 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
103 { IH_OS_ARTOS, "artos", "ARTOS", },
104 { IH_OS_DELL, "dell", "Dell", },
105 { IH_OS_ESIX, "esix", "Esix", },
106 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
107 { IH_OS_IRIX, "irix", "Irix", },
108 { IH_OS_LINUX, "linux", "Linux", },
109 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
110 { IH_OS_NCR, "ncr", "NCR", },
111 { IH_OS_NETBSD, "netbsd", "NetBSD", },
112 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
113 { IH_OS_PSOS, "psos", "pSOS", },
114 { IH_OS_QNX, "qnx", "QNX", },
115 { IH_OS_RTEMS, "rtems", "RTEMS", },
116 { IH_OS_SCO, "sco", "SCO", },
117 { IH_OS_SOLARIS, "solaris", "Solaris", },
118 { IH_OS_SVR4, "svr4", "SVR4", },
119 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
120 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
124 table_entry_t type_name[] = {
125 { IH_TYPE_INVALID, NULL, "Invalid Image", },
126 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
127 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
128 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
129 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
130 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
131 { IH_TYPE_SCRIPT, "script", "Script", },
132 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
133 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
137 table_entry_t comp_name[] = {
138 { IH_COMP_NONE, "none", "uncompressed", },
139 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
140 { IH_COMP_GZIP, "gzip", "gzip compressed", },
144 static void copy_file (int, const char *, int);
145 static void usage (void);
146 static void print_header (image_header_t *);
147 static void print_type (image_header_t *);
148 static char *put_table_entry (table_entry_t *, char *, int);
149 static char *put_arch (int);
150 static char *put_type (int);
151 static char *put_os (int);
152 static char *put_comp (int);
153 static int get_table_entry (table_entry_t *, char *, char *);
154 static int get_arch(char *);
155 static int get_comp(char *);
156 static int get_os (char *);
157 static int get_type(char *);
168 int opt_os = IH_OS_LINUX;
169 int opt_arch = IH_CPU_PPC;
170 int opt_type = IH_TYPE_KERNEL;
171 int opt_comp = IH_COMP_GZIP;
173 image_header_t header;
174 image_header_t *hdr = &header;
177 main (int argc, char **argv)
191 while (--argc > 0 && **++argv == '-') {
199 (opt_arch = get_arch(*++argv)) < 0)
204 (opt_comp = get_comp(*++argv)) < 0)
209 (opt_os = get_os(*++argv)) < 0)
214 (opt_type = get_type(*++argv)) < 0)
221 addr = strtoul (*++argv, (char **)&ptr, 16);
224 "%s: invalid load address %s\n",
238 ep = strtoul (*++argv, (char **)&ptr, 16);
241 "%s: invalid entry point %s\n",
265 if ((argc != 1) || ((lflag ^ dflag) == 0))
270 /* If XIP, entry point must be after the U-Boot header */
272 ep += sizeof(image_header_t);
276 * If XIP, ensure the entry point is equal to the load address plus
277 * the size of the U-Boot header.
280 if (ep != addr + sizeof(image_header_t)) {
282 "%s: For XIP, the entry point must be the load addr + %lu\n",
284 (unsigned long)sizeof(image_header_t));
292 ifd = open(imagefile, O_RDONLY|O_BINARY);
294 ifd = open(imagefile, O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
298 fprintf (stderr, "%s: Can't open %s: %s\n",
299 cmdname, imagefile, strerror(errno));
307 * list header information of existing image
309 if (fstat(ifd, &sbuf) < 0) {
310 fprintf (stderr, "%s: Can't stat %s: %s\n",
311 cmdname, imagefile, strerror(errno));
315 if ((unsigned)sbuf.st_size < sizeof(image_header_t)) {
317 "%s: Bad size: \"%s\" is no valid image\n",
322 ptr = (unsigned char *)mmap(0, sbuf.st_size,
323 PROT_READ, MAP_SHARED, ifd, 0);
324 if ((caddr_t)ptr == (caddr_t)-1) {
325 fprintf (stderr, "%s: Can't read %s: %s\n",
326 cmdname, imagefile, strerror(errno));
331 * create copy of header so that we can blank out the
332 * checksum field for checking - this can't be done
333 * on the PROT_READ mapped data.
335 memcpy (hdr, ptr, sizeof(image_header_t));
337 if (ntohl(hdr->ih_magic) != IH_MAGIC) {
339 "%s: Bad Magic Number: \"%s\" is no valid image\n",
345 len = sizeof(image_header_t);
347 checksum = ntohl(hdr->ih_hcrc);
348 hdr->ih_hcrc = htonl(0); /* clear for re-calculation */
350 if (crc32 (0, data, len) != checksum) {
352 "%s: ERROR: \"%s\" has bad header checksum!\n",
357 data = (char *)(ptr + sizeof(image_header_t));
358 len = sbuf.st_size - sizeof(image_header_t) ;
360 if (crc32 (0, data, len) != ntohl(hdr->ih_dcrc)) {
362 "%s: ERROR: \"%s\" has corrupted data!\n",
367 /* for multi-file images we need the data part, too */
368 print_header ((image_header_t *)ptr);
370 (void) munmap((void *)ptr, sbuf.st_size);
379 * write dummy header, to be fixed later
381 memset (hdr, 0, sizeof(image_header_t));
383 if (write(ifd, hdr, sizeof(image_header_t)) != sizeof(image_header_t)) {
384 fprintf (stderr, "%s: Write error on %s: %s\n",
385 cmdname, imagefile, strerror(errno));
389 if (opt_type == IH_TYPE_MULTI || opt_type == IH_TYPE_SCRIPT) {
390 char *file = datafile;
397 if ((sep = strchr(file, ':')) != NULL) {
401 if (stat (file, &sbuf) < 0) {
402 fprintf (stderr, "%s: Can't stat %s: %s\n",
403 cmdname, file, strerror(errno));
406 size = htonl(sbuf.st_size);
411 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
412 fprintf (stderr, "%s: Write error on %s: %s\n",
413 cmdname, imagefile, strerror(errno));
432 char *sep = strchr(file, ':');
435 copy_file (ifd, file, 1);
439 copy_file (ifd, file, 0);
444 copy_file (ifd, datafile, 0);
447 /* We're a bit of paranoid */
448 #if defined(_POSIX_SYNCHRONIZED_IO) && !defined(__sun__) && !defined(__FreeBSD__)
449 (void) fdatasync (ifd);
454 if (fstat(ifd, &sbuf) < 0) {
455 fprintf (stderr, "%s: Can't stat %s: %s\n",
456 cmdname, imagefile, strerror(errno));
460 ptr = (unsigned char *)mmap(0, sbuf.st_size,
461 PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
462 if (ptr == (unsigned char *)MAP_FAILED) {
463 fprintf (stderr, "%s: Can't map %s: %s\n",
464 cmdname, imagefile, strerror(errno));
468 hdr = (image_header_t *)ptr;
471 (const char *)(ptr + sizeof(image_header_t)),
472 sbuf.st_size - sizeof(image_header_t)
475 /* Build new header */
476 hdr->ih_magic = htonl(IH_MAGIC);
477 hdr->ih_time = htonl(sbuf.st_mtime);
478 hdr->ih_size = htonl(sbuf.st_size - sizeof(image_header_t));
479 hdr->ih_load = htonl(addr);
480 hdr->ih_ep = htonl(ep);
481 hdr->ih_dcrc = htonl(checksum);
483 hdr->ih_arch = opt_arch;
484 hdr->ih_type = opt_type;
485 hdr->ih_comp = opt_comp;
487 strncpy((char *)hdr->ih_name, name, IH_NMLEN);
489 checksum = crc32(0,(const char *)hdr,sizeof(image_header_t));
491 hdr->ih_hcrc = htonl(checksum);
495 (void) munmap((void *)ptr, sbuf.st_size);
497 /* We're a bit of paranoid */
498 #if defined(_POSIX_SYNCHRONIZED_IO) && !defined(__sun__) && !defined(__FreeBSD__)
499 (void) fdatasync (ifd);
505 fprintf (stderr, "%s: Write error on %s: %s\n",
506 cmdname, imagefile, strerror(errno));
514 copy_file (int ifd, const char *datafile, int pad)
525 fprintf (stderr, "Adding Image %s\n", datafile);
528 if ((dfd = open(datafile, O_RDONLY|O_BINARY)) < 0) {
529 fprintf (stderr, "%s: Can't open %s: %s\n",
530 cmdname, datafile, strerror(errno));
534 if (fstat(dfd, &sbuf) < 0) {
535 fprintf (stderr, "%s: Can't stat %s: %s\n",
536 cmdname, datafile, strerror(errno));
540 ptr = (unsigned char *)mmap(0, sbuf.st_size,
541 PROT_READ, MAP_SHARED, dfd, 0);
542 if (ptr == (unsigned char *)MAP_FAILED) {
543 fprintf (stderr, "%s: Can't read %s: %s\n",
544 cmdname, datafile, strerror(errno));
549 unsigned char *p = NULL;
551 * XIP: do not append the image_header_t at the
552 * beginning of the file, but consume the space
556 if ((unsigned)sbuf.st_size < sizeof(image_header_t)) {
558 "%s: Bad size: \"%s\" is too small for XIP\n",
563 for (p=ptr; p < ptr+sizeof(image_header_t); p++) {
566 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
572 offset = sizeof(image_header_t);
575 size = sbuf.st_size - offset;
576 if (write(ifd, ptr + offset, size) != size) {
577 fprintf (stderr, "%s: Write error on %s: %s\n",
578 cmdname, imagefile, strerror(errno));
582 if (pad && ((tail = size % 4) != 0)) {
584 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
585 fprintf (stderr, "%s: Write error on %s: %s\n",
586 cmdname, imagefile, strerror(errno));
591 (void) munmap((void *)ptr, sbuf.st_size);
598 fprintf (stderr, "Usage: %s -l image\n"
599 " -l ==> list image header information\n"
600 " %s [-x] -A arch -O os -T type -C comp "
601 "-a addr -e ep -n name -d data_file[:data_file...] image\n",
603 fprintf (stderr, " -A ==> set architecture to 'arch'\n"
604 " -O ==> set operating system to 'os'\n"
605 " -T ==> set image type to 'type'\n"
606 " -C ==> set compression type 'comp'\n"
607 " -a ==> set load address to 'addr' (hex)\n"
608 " -e ==> set entry point to 'ep' (hex)\n"
609 " -n ==> set image name to 'name'\n"
610 " -d ==> use image data from 'datafile'\n"
611 " -x ==> set XIP (execute in place)\n"
617 print_header (image_header_t *hdr)
622 timestamp = (time_t)ntohl(hdr->ih_time);
623 size = ntohl(hdr->ih_size);
625 printf ("Image Name: %.*s\n", IH_NMLEN, hdr->ih_name);
626 printf ("Created: %s", ctime(×tamp));
627 printf ("Image Type: "); print_type(hdr);
628 printf ("Data Size: %d Bytes = %.2f kB = %.2f MB\n",
629 size, (double)size / 1.024e3, (double)size / 1.048576e6 );
630 printf ("Load Address: 0x%08X\n", ntohl(hdr->ih_load));
631 printf ("Entry Point: 0x%08X\n", ntohl(hdr->ih_ep));
633 if (hdr->ih_type == IH_TYPE_MULTI || hdr->ih_type == IH_TYPE_SCRIPT) {
636 uint32_t *len_ptr = (uint32_t *) (
637 (unsigned long)hdr + sizeof(image_header_t)
640 /* determine number of images first (to calculate image offsets) */
641 for (i=0; len_ptr[i]; ++i) /* null pointer terminates list */
643 ptrs = i; /* null pointer terminates list */
645 pos = sizeof(image_header_t) + ptrs * sizeof(long);
646 printf ("Contents:\n");
647 for (i=0; len_ptr[i]; ++i) {
648 size = ntohl(len_ptr[i]);
650 printf (" Image %d: %8d Bytes = %4d kB = %d MB\n",
651 i, size, size>>10, size>>20);
652 if (hdr->ih_type == IH_TYPE_SCRIPT && i > 0) {
654 * the user may need to know offsets
655 * if planning to do something with
658 printf (" Offset = %08X\n", pos);
660 /* copy_file() will pad the first files to even word align */
670 print_type (image_header_t *hdr)
672 printf ("%s %s %s (%s)\n",
673 put_arch (hdr->ih_arch),
674 put_os (hdr->ih_os ),
675 put_type (hdr->ih_type),
676 put_comp (hdr->ih_comp)
680 static char *put_arch (int arch)
682 return (put_table_entry(arch_name, "Unknown Architecture", arch));
685 static char *put_os (int os)
687 return (put_table_entry(os_name, "Unknown OS", os));
690 static char *put_type (int type)
692 return (put_table_entry(type_name, "Unknown Image", type));
695 static char *put_comp (int comp)
697 return (put_table_entry(comp_name, "Unknown Compression", comp));
700 static char *put_table_entry (table_entry_t *table, char *msg, int type)
702 for (; table->val>=0; ++table) {
703 if (table->val == type)
704 return (table->lname);
709 static int get_arch(char *name)
711 return (get_table_entry(arch_name, "CPU", name));
715 static int get_comp(char *name)
717 return (get_table_entry(comp_name, "Compression", name));
721 static int get_os (char *name)
723 return (get_table_entry(os_name, "OS", name));
727 static int get_type(char *name)
729 return (get_table_entry(type_name, "Image", name));
732 static int get_table_entry (table_entry_t *table, char *msg, char *name)
737 for (t=table; t->val>=0; ++t) {
738 if (t->sname && strcasecmp(t->sname, name)==0)
741 fprintf (stderr, "\nInvalid %s Type - valid names are", msg);
742 for (t=table; t->val>=0; ++t) {
743 if (t->sname == NULL)
745 fprintf (stderr, "%c %s", (first) ? ':' : ',', t->sname);
748 fprintf (stderr, "\n");