1
0

image.h 6.0 KB

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