1 /* 2 * (C) Copyright 2000 3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4 * 5 * See file CREDITS for list of people who contributed to this 6 * project. 7 * 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. 12 * 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. 17 * 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, 21 * MA 02111-1307 USA 22 */ 23 24 #ifndef __IMAGE_H__ 25 #define __IMAGE_H__ 26 27 /* 28 * Operating System Codes 29 */ 30 #define IH_OS_INVALID 0 /* Invalid OS */ 31 #define IH_OS_OPENBSD 1 /* OpenBSD */ 32 #define IH_OS_NETBSD 2 /* NetBSD */ 33 #define IH_OS_FREEBSD 3 /* FreeBSD */ 34 #define IH_OS_4_4BSD 4 /* 4.4BSD */ 35 #define IH_OS_LINUX 5 /* Linux */ 36 #define IH_OS_SVR4 6 /* SVR4 */ 37 #define IH_OS_ESIX 7 /* Esix */ 38 #define IH_OS_SOLARIS 8 /* Solaris */ 39 #define IH_OS_IRIX 9 /* Irix */ 40 #define IH_OS_SCO 10 /* SCO */ 41 #define IH_OS_DELL 11 /* Dell */ 42 #define IH_OS_NCR 12 /* NCR */ 43 #define IH_OS_LYNXOS 13 /* LynxOS */ 44 #define IH_OS_VXWORKS 14 /* VxWorks */ 45 #define IH_OS_PSOS 15 /* pSOS */ 46 #define IH_OS_QNX 16 /* QNX */ 47 #define IH_OS_U_BOOT 17 /* Firmware */ 48 #define IH_OS_RTEMS 18 /* RTEMS */ 49 50 /* 51 * CPU Architecture Codes (supported by Linux) 52 */ 53 #define IH_CPU_INVALID 0 /* Invalid CPU */ 54 #define IH_CPU_ALPHA 1 /* Alpha */ 55 #define IH_CPU_ARM 2 /* ARM */ 56 #define IH_CPU_I386 3 /* Intel x86 */ 57 #define IH_CPU_IA64 4 /* IA64 */ 58 #define IH_CPU_MIPS 5 /* MIPS */ 59 #define IH_CPU_MIPS64 6 /* MIPS 64 Bit */ 60 #define IH_CPU_PPC 7 /* PowerPC */ 61 #define IH_CPU_S390 8 /* IBM S390 */ 62 #define IH_CPU_SH 9 /* SuperH */ 63 #define IH_CPU_SPARC 10 /* Sparc */ 64 #define IH_CPU_SPARC64 11 /* Sparc 64 Bit */ 65 66 /* 67 * Image Types 68 * 69 * "Standalone Programs" are directly runnable in the environment 70 * provided by U-Boot; it is expected that (if they behave 71 * well) you can continue to work in U-Boot after return from 72 * the Standalone Program. 73 * "OS Kernel Images" are usually images of some Embedded OS which 74 * will take over control completely. Usually these programs 75 * will install their own set of exception handlers, device 76 * drivers, set up the MMU, etc. - this means, that you cannot 77 * expect to re-enter U-Boot except by resetting the CPU. 78 * "RAMDisk Images" are more or less just data blocks, and their 79 * parameters (address, size) are passed to an OS kernel that is 80 * being started. 81 * "Multi-File Images" contain several images, typically an OS 82 * (Linux) kernel image and one or more data images like 83 * RAMDisks. This construct is useful for instance when you want 84 * to boot over the network using BOOTP etc., where the boot 85 * server provides just a single image file, but you want to get 86 * for instance an OS kernel and a RAMDisk image. 87 * 88 * "Multi-File Images" start with a list of image sizes, each 89 * image size (in bytes) specified by an "uint32_t" in network 90 * byte order. This list is terminated by an "(uint32_t)0". 91 * Immediately after the terminating 0 follow the images, one by 92 * one, all aligned on "uint32_t" boundaries (size rounded up to 93 * a multiple of 4 bytes). 94 * 95 * "Firmware Images" are binary images containing firmware (like 96 * U-Boot or FPGA images) which usually will be programmed to 97 * flash memory. 98 * 99 * "Script files" are command sequences that will be executed by 100 * U-Boot's command interpreter; this feature is especially 101 * useful when you configure U-Boot to use a real shell (hush) 102 * as command interpreter. 103 */ 104 105 #define IH_TYPE_INVALID 0 /* Invalid Image */ 106 #define IH_TYPE_STANDALONE 1 /* Standalone Program */ 107 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ 108 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ 109 #define IH_TYPE_MULTI 4 /* Multi-File Image */ 110 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ 111 #define IH_TYPE_SCRIPT 6 /* Script file */ 112 113 /* 114 * Compression Types 115 */ 116 #define IH_COMP_NONE 0 /* No Compression Used */ 117 #define IH_COMP_GZIP 1 /* gzip Compression Used */ 118 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */ 119 120 #define IH_MAGIC 0x27051956 /* Image Magic Number */ 121 #define IH_NMLEN 32 /* Image Name Length */ 122 123 #ifdef __CYGWIN__ 124 typedef unsigned long uint32_t; 125 typedef unsigned char uint8_t; 126 #endif /* __CYGWIN__ */ 127 128 /* 129 * all data in network byte order (aka natural aka bigendian) 130 */ 131 132 typedef struct image_header { 133 uint32_t ih_magic; /* Image Header Magic Number */ 134 uint32_t ih_hcrc; /* Image Header CRC Checksum */ 135 uint32_t ih_time; /* Image Creation Timestamp */ 136 uint32_t ih_size; /* Image Data Size */ 137 uint32_t ih_load; /* Data Load Address */ 138 uint32_t ih_ep; /* Entry Point Address */ 139 uint32_t ih_dcrc; /* Image Data CRC Checksum */ 140 uint8_t ih_os; /* Operating System */ 141 uint8_t ih_arch; /* CPU architecture */ 142 uint8_t ih_type; /* Image Type */ 143 uint8_t ih_comp; /* Compression Type */ 144 uint8_t ih_name[IH_NMLEN]; /* Image Name */ 145 } image_header_t; 146 147 148 #endif /* __IMAGE_H__ */ 149