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