2 * (C) Copyright 2000-2003
3 * DENX Software Engineering
4 * Wolfgang Denk, wd@denx.de
14 #include <netinet/in.h> /* for host / network byte order conversions */
21 #if defined(__BEOS__) || defined(__NetBSD__) || defined(__APPLE__)
26 typedef unsigned int __u32;
28 #define SWAP_LONG(x) \
30 (((__u32)(x) & (__u32)0x000000ffUL) << 24) | \
31 (((__u32)(x) & (__u32)0x0000ff00UL) << 8) | \
32 (((__u32)(x) & (__u32)0x00ff0000UL) >> 8) | \
33 (((__u32)(x) & (__u32)0xff000000UL) >> 24) ))
34 typedef unsigned char uint8_t;
35 typedef unsigned short uint16_t;
36 typedef unsigned int uint32_t;
38 #define ntohl(a) SWAP_LONG(a)
39 #define htonl(a) SWAP_LONG(a)
40 #endif /* __WIN32__ */
42 #ifndef O_BINARY /* should be define'd on __WIN32__ */
51 #define MAP_FAILED (-1)
56 extern unsigned long crc32 (unsigned long crc, const char *buf, unsigned int len);
58 typedef struct table_entry {
59 int val; /* as defined in image.h */
60 char *sname; /* short (input) name */
61 char *lname; /* long (output) name */
64 table_entry_t arch_name[] = {
65 { IH_CPU_INVALID, NULL, "Invalid CPU", },
66 { IH_CPU_ALPHA, "alpha", "Alpha", },
67 { IH_CPU_ARM, "arm", "ARM", },
68 { IH_CPU_I386, "x86", "Intel x86", },
69 { IH_CPU_IA64, "ia64", "IA64", },
70 { IH_CPU_MIPS, "mips", "MIPS", },
71 { IH_CPU_MIPS64, "mips64", "MIPS 64 Bit", },
72 { IH_CPU_PPC, "ppc", "PowerPC", },
73 { IH_CPU_S390, "s390", "IBM S390", },
74 { IH_CPU_SH, "sh", "SuperH", },
75 { IH_CPU_SPARC, "sparc", "SPARC", },
76 { IH_CPU_SPARC64, "sparc64", "SPARC 64 Bit", },
77 { IH_CPU_M68K, "m68k", "MC68000", },
81 table_entry_t os_name[] = {
82 { IH_OS_INVALID, NULL, "Invalid OS", },
83 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
84 { IH_OS_NETBSD, "netbsd", "NetBSD", },
85 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
86 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
87 { IH_OS_LINUX, "linux", "Linux", },
88 { IH_OS_SVR4, "svr4", "SVR4", },
89 { IH_OS_ESIX, "esix", "Esix", },
90 { IH_OS_SOLARIS, "solaris", "Solaris", },
91 { IH_OS_IRIX, "irix", "Irix", },
92 { IH_OS_SCO, "sco", "SCO", },
93 { IH_OS_DELL, "dell", "Dell", },
94 { IH_OS_NCR, "ncr", "NCR", },
95 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
96 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
97 { IH_OS_PSOS, "psos", "pSOS", },
98 { IH_OS_QNX, "qnx", "QNX", },
99 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
100 { IH_OS_RTEMS, "rtems", "RTEMS", },
101 { IH_OS_ARTOS, "artos", "ARTOS", },
105 table_entry_t type_name[] = {
106 { IH_TYPE_INVALID, NULL, "Invalid Image", },
107 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
108 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
109 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
110 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
111 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
112 { IH_TYPE_SCRIPT, "script", "Script", },
113 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
117 table_entry_t comp_name[] = {
118 { IH_COMP_NONE, "none", "uncompressed", },
119 { IH_COMP_GZIP, "gzip", "gzip compressed", },
120 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
124 static void copy_file (int, const char *, int);
125 static void usage (void);
126 static void print_header (image_header_t *);
127 static void print_type (image_header_t *);
128 static char *put_table_entry (table_entry_t *, char *, int);
129 static char *put_arch (int);
130 static char *put_type (int);
131 static char *put_os (int);
132 static char *put_comp (int);
133 static int get_table_entry (table_entry_t *, char *, char *);
134 static int get_arch(char *);
135 static int get_comp(char *);
136 static int get_os (char *);
137 static int get_type(char *);
148 int opt_os = IH_OS_LINUX;
149 int opt_arch = IH_CPU_PPC;
150 int opt_type = IH_TYPE_KERNEL;
151 int opt_comp = IH_COMP_GZIP;
153 image_header_t header;
154 image_header_t *hdr = &header;
157 main (int argc, char **argv)
171 while (--argc > 0 && **++argv == '-') {
179 (opt_arch = get_arch(*++argv)) < 0)
184 (opt_comp = get_comp(*++argv)) < 0)
189 (opt_os = get_os(*++argv)) < 0)
194 (opt_type = get_type(*++argv)) < 0)
201 addr = strtoul (*++argv, (char **)&ptr, 16);
204 "%s: invalid load address %s\n",
218 ep = strtoul (*++argv, (char **)&ptr, 16);
221 "%s: invalid entry point %s\n",
245 if ((argc != 1) || ((lflag ^ dflag) == 0))
250 /* If XIP, entry point must be after the U-Boot header */
252 ep += sizeof(image_header_t);
256 * If XIP, ensure the entry point is equal to the load address plus
257 * the size of the U-Boot header.
260 if (ep != addr + sizeof(image_header_t)) {
261 fprintf (stderr, "%s: For XIP, the entry point must be the load addr + %lu\n",
263 (unsigned long)sizeof(image_header_t));
271 ifd = open(imagefile, O_RDONLY);
273 ifd = open(imagefile, O_RDWR|O_CREAT|O_TRUNC|O_BINARY, 0666);
277 fprintf (stderr, "%s: Can't open %s: %s\n",
278 cmdname, imagefile, strerror(errno));
286 * list header information of existing image
288 if (fstat(ifd, &sbuf) < 0) {
289 fprintf (stderr, "%s: Can't stat %s: %s\n",
290 cmdname, imagefile, strerror(errno));
294 if (sbuf.st_size < sizeof(image_header_t)) {
296 "%s: Bad size: \"%s\" is no valid image\n",
301 ptr = (unsigned char *)mmap(0, sbuf.st_size,
302 PROT_READ, MAP_SHARED, ifd, 0);
303 if ((caddr_t)ptr == (caddr_t)-1) {
304 fprintf (stderr, "%s: Can't read %s: %s\n",
305 cmdname, imagefile, strerror(errno));
310 * create copy of header so that we can blank out the
311 * checksum field for checking - this can't be done
312 * on the PROT_READ mapped data.
314 memcpy (hdr, ptr, sizeof(image_header_t));
316 if (ntohl(hdr->ih_magic) != IH_MAGIC) {
318 "%s: Bad Magic Number: \"%s\" is no valid image\n",
324 len = sizeof(image_header_t);
326 checksum = ntohl(hdr->ih_hcrc);
327 hdr->ih_hcrc = htonl(0); /* clear for re-calculation */
329 if (crc32 (0, data, len) != checksum) {
331 "*** Warning: \"%s\" has bad header checksum!\n",
335 data = (char *)(ptr + sizeof(image_header_t));
336 len = sbuf.st_size - sizeof(image_header_t) ;
338 if (crc32 (0, data, len) != ntohl(hdr->ih_dcrc)) {
340 "*** Warning: \"%s\" has corrupted data!\n",
344 /* for multi-file images we need the data part, too */
345 print_header ((image_header_t *)ptr);
347 (void) munmap((void *)ptr, sbuf.st_size);
356 * write dummy header, to be fixed later
358 memset (hdr, 0, sizeof(image_header_t));
360 if (write(ifd, hdr, sizeof(image_header_t)) != sizeof(image_header_t)) {
361 fprintf (stderr, "%s: Write error on %s: %s\n",
362 cmdname, imagefile, strerror(errno));
366 if (opt_type == IH_TYPE_MULTI || opt_type == IH_TYPE_SCRIPT) {
367 char *file = datafile;
374 if ((sep = strchr(file, ':')) != NULL) {
378 if (stat (file, &sbuf) < 0) {
379 fprintf (stderr, "%s: Can't stat %s: %s\n",
380 cmdname, file, strerror(errno));
383 size = htonl(sbuf.st_size);
388 if (write(ifd, (char *)&size, sizeof(size)) != sizeof(size)) {
389 fprintf (stderr, "%s: Write error on %s: %s\n",
390 cmdname, imagefile, strerror(errno));
409 char *sep = strchr(file, ':');
412 copy_file (ifd, file, 1);
416 copy_file (ifd, file, 0);
421 copy_file (ifd, datafile, 0);
424 /* We're a bit of paranoid */
425 #if defined(_POSIX_SYNCHRONIZED_IO) && !defined(__sun__) && !defined(__FreeBSD__)
426 (void) fdatasync (ifd);
431 if (fstat(ifd, &sbuf) < 0) {
432 fprintf (stderr, "%s: Can't stat %s: %s\n",
433 cmdname, imagefile, strerror(errno));
437 ptr = (unsigned char *)mmap(0, sbuf.st_size,
438 PROT_READ|PROT_WRITE, MAP_SHARED, ifd, 0);
439 if (ptr == (unsigned char *)MAP_FAILED) {
440 fprintf (stderr, "%s: Can't map %s: %s\n",
441 cmdname, imagefile, strerror(errno));
445 hdr = (image_header_t *)ptr;
448 (const char *)(ptr + sizeof(image_header_t)),
449 sbuf.st_size - sizeof(image_header_t)
452 /* Build new header */
453 hdr->ih_magic = htonl(IH_MAGIC);
454 hdr->ih_time = htonl(sbuf.st_mtime);
455 hdr->ih_size = htonl(sbuf.st_size - sizeof(image_header_t));
456 hdr->ih_load = htonl(addr);
457 hdr->ih_ep = htonl(ep);
458 hdr->ih_dcrc = htonl(checksum);
460 hdr->ih_arch = opt_arch;
461 hdr->ih_type = opt_type;
462 hdr->ih_comp = opt_comp;
464 strncpy((char *)hdr->ih_name, name, IH_NMLEN);
466 checksum = crc32(0,(const char *)hdr,sizeof(image_header_t));
468 hdr->ih_hcrc = htonl(checksum);
472 (void) munmap((void *)ptr, sbuf.st_size);
474 /* We're a bit of paranoid */
475 #if defined(_POSIX_SYNCHRONIZED_IO) && !defined(__sun__) && !defined(__FreeBSD__)
476 (void) fdatasync (ifd);
482 fprintf (stderr, "%s: Write error on %s: %s\n",
483 cmdname, imagefile, strerror(errno));
491 copy_file (int ifd, const char *datafile, int pad)
502 fprintf (stderr, "Adding Image %s\n", datafile);
505 if ((dfd = open(datafile, O_RDONLY)) < 0) {
506 fprintf (stderr, "%s: Can't open %s: %s\n",
507 cmdname, datafile, strerror(errno));
511 if (fstat(dfd, &sbuf) < 0) {
512 fprintf (stderr, "%s: Can't stat %s: %s\n",
513 cmdname, datafile, strerror(errno));
517 ptr = (unsigned char *)mmap(0, sbuf.st_size,
518 PROT_READ, MAP_SHARED, dfd, 0);
519 if (ptr == (unsigned char *)MAP_FAILED) {
520 fprintf (stderr, "%s: Can't read %s: %s\n",
521 cmdname, datafile, strerror(errno));
526 unsigned char *p = NULL;
528 * XIP: do not append the image_header_t at the
529 * beginning of the file, but consume the space
533 if (sbuf.st_size < sizeof(image_header_t)) {
535 "%s: Bad size: \"%s\" is too small for XIP\n",
540 for (p=ptr; p < ptr+sizeof(image_header_t); p++) {
543 "%s: Bad file: \"%s\" has invalid buffer for XIP\n",
549 offset = sizeof(image_header_t);
552 size = sbuf.st_size - offset;
553 if (write(ifd, ptr + offset, size) != size) {
554 fprintf (stderr, "%s: Write error on %s: %s\n",
555 cmdname, imagefile, strerror(errno));
559 if (pad && ((tail = size % 4) != 0)) {
561 if (write(ifd, (char *)&zero, 4-tail) != 4-tail) {
562 fprintf (stderr, "%s: Write error on %s: %s\n",
563 cmdname, imagefile, strerror(errno));
568 (void) munmap((void *)ptr, sbuf.st_size);
575 fprintf (stderr, "Usage: %s -l image\n"
576 " -l ==> list image header information\n"
577 " %s -A arch -O os -T type -C comp "
578 "-a addr -e ep -n name -d data_file[:data_file...] image\n",
580 fprintf (stderr, " -A ==> set architecture to 'arch'\n"
581 " -O ==> set operating system to 'os'\n"
582 " -T ==> set image type to 'type'\n"
583 " -C ==> set compression type 'comp'\n"
584 " -a ==> set load address to 'addr' (hex)\n"
585 " -e ==> set entry point to 'ep' (hex)\n"
586 " -n ==> set image name to 'name'\n"
587 " -d ==> use image data from 'datafile'\n"
588 " -x ==> set XIP (execute in place)\n"
594 print_header (image_header_t *hdr)
599 timestamp = (time_t)ntohl(hdr->ih_time);
600 size = ntohl(hdr->ih_size);
602 printf ("Image Name: %.*s\n", IH_NMLEN, hdr->ih_name);
603 printf ("Created: %s", ctime(×tamp));
604 printf ("Image Type: "); print_type(hdr);
605 printf ("Data Size: %d Bytes = %.2f kB = %.2f MB\n",
606 size, (double)size / 1.024e3, (double)size / 1.048576e6 );
607 printf ("Load Address: 0x%08X\n", ntohl(hdr->ih_load));
608 printf ("Entry Point: 0x%08X\n", ntohl(hdr->ih_ep));
610 if (hdr->ih_type == IH_TYPE_MULTI || hdr->ih_type == IH_TYPE_SCRIPT) {
613 unsigned long *len_ptr = (unsigned long *) (
614 (unsigned long)hdr + sizeof(image_header_t)
617 /* determine number of images first (to calculate image offsets) */
618 for (i=0; len_ptr[i]; ++i) /* null pointer terminates list */
620 ptrs = i; /* null pointer terminates list */
622 pos = sizeof(image_header_t) + ptrs * sizeof(long);
623 printf ("Contents:\n");
624 for (i=0; len_ptr[i]; ++i) {
625 size = ntohl(len_ptr[i]);
627 printf (" Image %d: %8d Bytes = %4d kB = %d MB\n",
628 i, size, size>>10, size>>20);
629 if (hdr->ih_type == IH_TYPE_SCRIPT && i > 0) {
631 * the user may need to know offsets
632 * if planning to do something with
635 printf (" Offset = %08X\n", pos);
637 /* copy_file() will pad the first files to even word align */
647 print_type (image_header_t *hdr)
649 printf ("%s %s %s (%s)\n",
650 put_arch (hdr->ih_arch),
651 put_os (hdr->ih_os ),
652 put_type (hdr->ih_type),
653 put_comp (hdr->ih_comp)
657 static char *put_arch (int arch)
659 return (put_table_entry(arch_name, "Unknown Architecture", arch));
662 static char *put_os (int os)
664 return (put_table_entry(os_name, "Unknown OS", os));
667 static char *put_type (int type)
669 return (put_table_entry(type_name, "Unknown Image", type));
672 static char *put_comp (int comp)
674 return (put_table_entry(comp_name, "Unknown Compression", comp));
677 static char *put_table_entry (table_entry_t *table, char *msg, int type)
679 for (; table->val>=0; ++table) {
680 if (table->val == type)
681 return (table->lname);
686 static int get_arch(char *name)
688 return (get_table_entry(arch_name, "CPU", name));
692 static int get_comp(char *name)
694 return (get_table_entry(comp_name, "Compression", name));
698 static int get_os (char *name)
700 return (get_table_entry(os_name, "OS", name));
704 static int get_type(char *name)
706 return (get_table_entry(type_name, "Image", name));
709 static int get_table_entry (table_entry_t *table, char *msg, char *name)
714 for (t=table; t->val>=0; ++t) {
715 if (t->sname && strcasecmp(t->sname, name)==0)
718 fprintf (stderr, "\nInvalid %s Type - valid names are", msg);
719 for (t=table; t->val>=0; ++t) {
720 if (t->sname == NULL)
722 fprintf (stderr, "%c %s", (first) ? ':' : ',', t->sname);
725 fprintf (stderr, "\n");