]> git.sur5r.net Git - u-boot/blobdiff - include/image.h
[new uImage] Fix uImage header pointer use in i386 do_bootm_linux()
[u-boot] / include / image.h
index f9b769e9c58a2cc29dc91b24f7e95bfcc45d5cc9..aab3f44ccbfb0c97859227368abd7784411dd841 100644 (file)
@@ -1,5 +1,7 @@
 /*
- * (C) Copyright 2000
+ * (C) Copyright 2008 Semihalf
+ *
+ * (C) Copyright 2000-2005
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
  *
  * See file CREDITS for list of people who contributed to this
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  * MA 02111-1307 USA
+ *
+ ********************************************************************
+ * NOTE: This header file defines an interface to U-Boot. Including
+ * this (unmodified) header file in another file is considered normal
+ * use of U-Boot, and does *not* fall under the heading of "derived
+ * work".
+ ********************************************************************
  */
 
 #ifndef __IMAGE_H__
 #define __IMAGE_H__
 
+#include <asm/byteorder.h>
+#ifndef USE_HOSTCC
+#include <linux/string.h>
+#endif
+
 /*
  * Operating System Codes
  */
 #define IH_OS_QNX              16      /* QNX          */
 #define IH_OS_U_BOOT           17      /* Firmware     */
 #define IH_OS_RTEMS            18      /* RTEMS        */
+#define IH_OS_ARTOS            19      /* ARTOS        */
+#define IH_OS_UNITY            20      /* Unity OS     */
 
 /*
  * CPU Architecture Codes (supported by Linux)
  */
-#define IH_CPU_INVALID         0       /* Invalid CPU  */
-#define IH_CPU_ALPHA           1       /* Alpha        */
-#define IH_CPU_ARM             2       /* ARM          */
-#define IH_CPU_I386            3       /* Intel x86    */
-#define IH_CPU_IA64            4       /* IA64         */
-#define IH_CPU_MIPS            5       /* MIPS         */
-#define IH_CPU_MIPS64          6       /* MIPS  64 Bit */
-#define IH_CPU_PPC             7       /* PowerPC      */
-#define IH_CPU_S390            8       /* IBM S390     */
-#define IH_CPU_SH              9       /* SuperH       */
-#define IH_CPU_SPARC           10      /* Sparc        */
-#define IH_CPU_SPARC64         11      /* Sparc 64 Bit */
+#define IH_ARCH_INVALID                0       /* Invalid CPU  */
+#define IH_ARCH_ALPHA          1       /* Alpha        */
+#define IH_ARCH_ARM            2       /* ARM          */
+#define IH_ARCH_I386           3       /* Intel x86    */
+#define IH_ARCH_IA64           4       /* IA64         */
+#define IH_ARCH_MIPS           5       /* MIPS         */
+#define IH_ARCH_MIPS64         6       /* MIPS  64 Bit */
+#define IH_ARCH_PPC            7       /* PowerPC      */
+#define IH_ARCH_S390           8       /* IBM S390     */
+#define IH_ARCH_SH             9       /* SuperH       */
+#define IH_ARCH_SPARC          10      /* Sparc        */
+#define IH_ARCH_SPARC64                11      /* Sparc 64 Bit */
+#define IH_ARCH_M68K           12      /* M68K         */
+#define IH_ARCH_NIOS           13      /* Nios-32      */
+#define IH_ARCH_MICROBLAZE     14      /* MicroBlaze   */
+#define IH_ARCH_NIOS2          15      /* Nios-II      */
+#define IH_ARCH_BLACKFIN       16      /* Blackfin     */
+#define IH_ARCH_AVR32          17      /* AVR32        */
+#define IH_ARCH_ST200          18      /* STMicroelectronics ST200  */
 
 /*
  * Image Types
  *     byte order. This list is terminated by an "(uint32_t)0".
  *     Immediately after the terminating 0 follow the images, one by
  *     one, all aligned on "uint32_t" boundaries (size rounded up to
- *     a multiple of 4 bytes).
+ *     a multiple of 4 bytes - except for the last file).
  *
  * "Firmware Images" are binary images containing firmware (like
  *     U-Boot or FPGA images) which usually will be programmed to
  * "Script files" are command sequences that will be executed by
  *     U-Boot's command interpreter; this feature is especially
  *     useful when you configure U-Boot to use a real shell (hush)
- *     as command interpreter.
+ *     as command interpreter (=> Shell Scripts).
  */
 
 #define IH_TYPE_INVALID                0       /* Invalid Image                */
 #define IH_TYPE_MULTI          4       /* Multi-File Image             */
 #define IH_TYPE_FIRMWARE       5       /* Firmware Image               */
 #define IH_TYPE_SCRIPT         6       /* Script file                  */
+#define IH_TYPE_FILESYSTEM     7       /* Filesystem Image (any type)  */
+#define IH_TYPE_FLATDT         8       /* Binary Flat Device Tree Blob */
 
 /*
  * Compression Types
 #define IH_MAGIC       0x27051956      /* Image Magic Number           */
 #define IH_NMLEN               32      /* Image Name Length            */
 
-#ifdef __CYGWIN__
-typedef unsigned long uint32_t;
-typedef unsigned char uint8_t;
-#endif /* __CYGWIN__ */
-
 /*
  * all data in network byte order (aka natural aka bigendian)
  */
@@ -144,5 +164,144 @@ typedef struct image_header {
        uint8_t         ih_name[IH_NMLEN];      /* Image Name           */
 } image_header_t;
 
+/*
+ * Some systems (for example LWMON) have very short watchdog periods;
+ * we must make sure to split long operations like memmove() or
+ * crc32() into reasonable chunks.
+ */
+#define CHUNKSZ (64 * 1024)
+
+#define image_to_cpu(x)                ntohl(x)
+#define cpu_to_image(x)                htonl(x)
+
+static inline uint32_t image_get_header_size (void)
+{
+       return (sizeof (image_header_t));
+}
+
+#define image_get_hdr_l(f) \
+       static inline uint32_t image_get_##f(image_header_t *hdr) \
+       { \
+               return image_to_cpu (hdr->ih_##f); \
+       }
+image_get_hdr_l (magic);
+image_get_hdr_l (hcrc);
+image_get_hdr_l (time);
+image_get_hdr_l (size);
+image_get_hdr_l (load);
+image_get_hdr_l (ep);
+image_get_hdr_l (dcrc);
+
+#define image_get_hdr_b(f) \
+       static inline uint8_t image_get_##f(image_header_t *hdr) \
+       { \
+               return hdr->ih_##f; \
+       }
+image_get_hdr_b (os);
+image_get_hdr_b (arch);
+image_get_hdr_b (type);
+image_get_hdr_b (comp);
+
+static inline char *image_get_name (image_header_t *hdr)
+{
+       return (char *)hdr->ih_name;
+}
+
+static inline uint32_t image_get_data_size (image_header_t *hdr)
+{
+       return image_get_size (hdr);
+}
+static inline uint32_t image_get_image_size (image_header_t *hdr)
+{
+       return (image_get_size (hdr) + image_get_header_size ());
+}
+static inline ulong image_get_data (image_header_t *hdr)
+{
+       return ((ulong)hdr + image_get_header_size ());
+}
+
+#define image_set_hdr_l(f) \
+       static inline void image_set_##f(image_header_t *hdr, uint32_t val) \
+       { \
+               hdr->ih_##f = cpu_to_image (val); \
+       }
+image_set_hdr_l (magic);
+image_set_hdr_l (hcrc);
+image_set_hdr_l (time);
+image_set_hdr_l (size);
+image_set_hdr_l (load);
+image_set_hdr_l (ep);
+image_set_hdr_l (dcrc);
+
+#define image_set_hdr_b(f) \
+       static inline void image_set_##f(image_header_t *hdr, uint8_t val) \
+       { \
+               hdr->ih_##f = val; \
+       }
+image_set_hdr_b (os);
+image_set_hdr_b (arch);
+image_set_hdr_b (type);
+image_set_hdr_b (comp);
+
+static inline void image_set_name (image_header_t *hdr, const char *name)
+{
+       strncpy (image_get_name (hdr), name, IH_NMLEN);
+}
+
+int image_check_hcrc (image_header_t *hdr);
+int image_check_dcrc (image_header_t *hdr);
+int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize);
+int getenv_verify (void);
+
+static inline int image_check_magic (image_header_t *hdr)
+{
+       return (image_get_magic (hdr) == IH_MAGIC);
+}
+static inline int image_check_type (image_header_t *hdr, uint8_t type)
+{
+       return (image_get_type (hdr) == type);
+}
+static inline int image_check_arch (image_header_t *hdr, uint8_t arch)
+{
+       return (image_get_arch (hdr) == arch);
+}
+static inline int image_check_os (image_header_t *hdr, uint8_t os)
+{
+       return (image_get_os (hdr) == os);
+}
+
+#ifndef USE_HOSTCC
+static inline int image_check_target_arch (image_header_t *hdr)
+{
+#if defined(__ARM__)
+       if (!image_check_arch (hdr, IH_ARCH_ARM))
+#elif defined(__avr32__)
+       if (!image_check_arch (hdr, IH_ARCH_AVR32))
+#elif defined(__bfin__)
+       if (!image_check_arch (hdr, IH_ARCH_BLACKFIN))
+#elif defined(__I386__)
+       if (!image_check_arch (hdr, IH_ARCH_I386))
+#elif defined(__M68K__)
+       if (!image_check_arch (hdr, IH_ARCH_M68K))
+#elif defined(__microblaze__)
+       if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE))
+#elif defined(__mips__)
+       if (!image_check_arch (hdr, IH_ARCH_MIPS))
+#elif defined(__nios__)
+       if (!image_check_arch (hdr, IH_ARCH_NIOS))
+#elif defined(__nios2__)
+       if (!image_check_arch (hdr, IH_ARCH_NIOS2))
+#elif defined(__PPC__)
+       if (!image_check_arch (hdr, IH_ARCH_PPC))
+#elif defined(__sh__)
+       if (!image_check_arch (hdr, IH_ARCH_SH))
+#else
+# error Unknown CPU type
+#endif
+               return 0;
+
+       return 1;
+}
+#endif
 
-#endif /* __IMAGE_H__ */
+#endif /* __IMAGE_H__ */