wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 1 | /* |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 2 | * (C) Copyright 2008 Semihalf |
| 3 | * |
Wolfgang Denk | f08abe3 | 2005-11-25 16:38:03 +0100 | [diff] [blame] | 4 | * (C) Copyright 2000-2005 |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 5 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
| 6 | * |
| 7 | * See file CREDITS for list of people who contributed to this |
| 8 | * project. |
| 9 | * |
| 10 | * This program is free software; you can redistribute it and/or |
| 11 | * modify it under the terms of the GNU General Public License as |
| 12 | * published by the Free Software Foundation; either version 2 of |
| 13 | * the License, or (at your option) any later version. |
| 14 | * |
| 15 | * This program is distributed in the hope that it will be useful, |
| 16 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 17 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 18 | * GNU General Public License for more details. |
| 19 | * |
| 20 | * You should have received a copy of the GNU General Public License |
| 21 | * along with this program; if not, write to the Free Software |
| 22 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, |
| 23 | * MA 02111-1307 USA |
Wolfgang Denk | f08abe3 | 2005-11-25 16:38:03 +0100 | [diff] [blame] | 24 | * |
| 25 | ******************************************************************** |
| 26 | * NOTE: This header file defines an interface to U-Boot. Including |
| 27 | * this (unmodified) header file in another file is considered normal |
| 28 | * use of U-Boot, and does *not* fall under the heading of "derived |
| 29 | * work". |
| 30 | ******************************************************************** |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 31 | */ |
| 32 | |
| 33 | #ifndef __IMAGE_H__ |
| 34 | #define __IMAGE_H__ |
| 35 | |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 36 | #include <asm/byteorder.h> |
Marian Balakowicz | 5ad03eb | 2008-01-31 13:55:39 +0100 | [diff] [blame] | 37 | #include <command.h> |
Marian Balakowicz | 75d3e8f | 2008-02-21 17:20:18 +0100 | [diff] [blame] | 38 | |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 39 | #ifndef USE_HOSTCC |
Kumar Gala | 4ed6552 | 2008-02-27 21:51:47 -0600 | [diff] [blame] | 40 | #include <lmb.h> |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 41 | #include <linux/string.h> |
Marian Balakowicz | ceaed2b | 2008-01-31 13:57:17 +0100 | [diff] [blame] | 42 | #include <asm/u-boot.h> |
Marian Balakowicz | 75d3e8f | 2008-02-21 17:20:18 +0100 | [diff] [blame] | 43 | |
Bartlomiej Sieka | 9d25438 | 2008-03-11 12:34:47 +0100 | [diff] [blame] | 44 | #else |
| 45 | |
| 46 | /* new uImage format support enabled on host */ |
| 47 | #define CONFIG_FIT 1 |
| 48 | #define CONFIG_OF_LIBFDT 1 |
| 49 | #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ |
| 50 | |
| 51 | #endif /* USE_HOSTCC */ |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 52 | |
Marian Balakowicz | 75d3e8f | 2008-02-21 17:20:18 +0100 | [diff] [blame] | 53 | #if defined(CONFIG_FIT) && !defined(CONFIG_OF_LIBFDT) |
| 54 | #error "CONFIG_OF_LIBFDT not enabled, required by CONFIG_FIT!" |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 55 | #endif |
Marian Balakowicz | 5dfb521 | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 56 | |
| 57 | #if defined(CONFIG_FIT) |
| 58 | #include <fdt.h> |
| 59 | #include <libfdt.h> |
| 60 | #include <fdt_support.h> |
Bartlomiej Sieka | 766529f | 2008-03-14 16:22:34 +0100 | [diff] [blame] | 61 | #define CONFIG_MD5 /* FIT images need MD5 support */ |
Marian Balakowicz | 5dfb521 | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 62 | #endif |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 63 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 64 | /* |
| 65 | * Operating System Codes |
| 66 | */ |
| 67 | #define IH_OS_INVALID 0 /* Invalid OS */ |
| 68 | #define IH_OS_OPENBSD 1 /* OpenBSD */ |
| 69 | #define IH_OS_NETBSD 2 /* NetBSD */ |
| 70 | #define IH_OS_FREEBSD 3 /* FreeBSD */ |
| 71 | #define IH_OS_4_4BSD 4 /* 4.4BSD */ |
| 72 | #define IH_OS_LINUX 5 /* Linux */ |
| 73 | #define IH_OS_SVR4 6 /* SVR4 */ |
| 74 | #define IH_OS_ESIX 7 /* Esix */ |
| 75 | #define IH_OS_SOLARIS 8 /* Solaris */ |
| 76 | #define IH_OS_IRIX 9 /* Irix */ |
| 77 | #define IH_OS_SCO 10 /* SCO */ |
| 78 | #define IH_OS_DELL 11 /* Dell */ |
| 79 | #define IH_OS_NCR 12 /* NCR */ |
| 80 | #define IH_OS_LYNXOS 13 /* LynxOS */ |
| 81 | #define IH_OS_VXWORKS 14 /* VxWorks */ |
| 82 | #define IH_OS_PSOS 15 /* pSOS */ |
| 83 | #define IH_OS_QNX 16 /* QNX */ |
| 84 | #define IH_OS_U_BOOT 17 /* Firmware */ |
wdenk | d791b1d | 2003-04-20 14:04:18 +0000 | [diff] [blame] | 85 | #define IH_OS_RTEMS 18 /* RTEMS */ |
wdenk | 7f70e85 | 2003-05-20 14:25:27 +0000 | [diff] [blame] | 86 | #define IH_OS_ARTOS 19 /* ARTOS */ |
wdenk | 27b207f | 2003-07-24 23:38:38 +0000 | [diff] [blame] | 87 | #define IH_OS_UNITY 20 /* Unity OS */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 88 | |
| 89 | /* |
| 90 | * CPU Architecture Codes (supported by Linux) |
| 91 | */ |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 92 | #define IH_ARCH_INVALID 0 /* Invalid CPU */ |
| 93 | #define IH_ARCH_ALPHA 1 /* Alpha */ |
| 94 | #define IH_ARCH_ARM 2 /* ARM */ |
| 95 | #define IH_ARCH_I386 3 /* Intel x86 */ |
| 96 | #define IH_ARCH_IA64 4 /* IA64 */ |
| 97 | #define IH_ARCH_MIPS 5 /* MIPS */ |
| 98 | #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */ |
| 99 | #define IH_ARCH_PPC 7 /* PowerPC */ |
| 100 | #define IH_ARCH_S390 8 /* IBM S390 */ |
| 101 | #define IH_ARCH_SH 9 /* SuperH */ |
| 102 | #define IH_ARCH_SPARC 10 /* Sparc */ |
| 103 | #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */ |
| 104 | #define IH_ARCH_M68K 12 /* M68K */ |
| 105 | #define IH_ARCH_NIOS 13 /* Nios-32 */ |
| 106 | #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */ |
| 107 | #define IH_ARCH_NIOS2 15 /* Nios-II */ |
| 108 | #define IH_ARCH_BLACKFIN 16 /* Blackfin */ |
| 109 | #define IH_ARCH_AVR32 17 /* AVR32 */ |
| 110 | #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 111 | |
| 112 | /* |
| 113 | * Image Types |
| 114 | * |
| 115 | * "Standalone Programs" are directly runnable in the environment |
| 116 | * provided by U-Boot; it is expected that (if they behave |
| 117 | * well) you can continue to work in U-Boot after return from |
| 118 | * the Standalone Program. |
| 119 | * "OS Kernel Images" are usually images of some Embedded OS which |
| 120 | * will take over control completely. Usually these programs |
| 121 | * will install their own set of exception handlers, device |
| 122 | * drivers, set up the MMU, etc. - this means, that you cannot |
| 123 | * expect to re-enter U-Boot except by resetting the CPU. |
| 124 | * "RAMDisk Images" are more or less just data blocks, and their |
| 125 | * parameters (address, size) are passed to an OS kernel that is |
| 126 | * being started. |
| 127 | * "Multi-File Images" contain several images, typically an OS |
| 128 | * (Linux) kernel image and one or more data images like |
| 129 | * RAMDisks. This construct is useful for instance when you want |
| 130 | * to boot over the network using BOOTP etc., where the boot |
| 131 | * server provides just a single image file, but you want to get |
| 132 | * for instance an OS kernel and a RAMDisk image. |
| 133 | * |
| 134 | * "Multi-File Images" start with a list of image sizes, each |
| 135 | * image size (in bytes) specified by an "uint32_t" in network |
| 136 | * byte order. This list is terminated by an "(uint32_t)0". |
| 137 | * Immediately after the terminating 0 follow the images, one by |
| 138 | * one, all aligned on "uint32_t" boundaries (size rounded up to |
wdenk | e1599e8 | 2004-10-10 23:27:33 +0000 | [diff] [blame] | 139 | * a multiple of 4 bytes - except for the last file). |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 140 | * |
| 141 | * "Firmware Images" are binary images containing firmware (like |
| 142 | * U-Boot or FPGA images) which usually will be programmed to |
| 143 | * flash memory. |
| 144 | * |
| 145 | * "Script files" are command sequences that will be executed by |
| 146 | * U-Boot's command interpreter; this feature is especially |
| 147 | * useful when you configure U-Boot to use a real shell (hush) |
wdenk | 27b207f | 2003-07-24 23:38:38 +0000 | [diff] [blame] | 148 | * as command interpreter (=> Shell Scripts). |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 149 | */ |
| 150 | |
| 151 | #define IH_TYPE_INVALID 0 /* Invalid Image */ |
| 152 | #define IH_TYPE_STANDALONE 1 /* Standalone Program */ |
| 153 | #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ |
| 154 | #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ |
| 155 | #define IH_TYPE_MULTI 4 /* Multi-File Image */ |
| 156 | #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ |
| 157 | #define IH_TYPE_SCRIPT 6 /* Script file */ |
wdenk | fbe4b5c | 2003-10-06 21:55:32 +0000 | [diff] [blame] | 158 | #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */ |
Matthew McClintock | 25c751e | 2006-08-16 10:54:09 -0500 | [diff] [blame] | 159 | #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 160 | |
| 161 | /* |
| 162 | * Compression Types |
| 163 | */ |
| 164 | #define IH_COMP_NONE 0 /* No Compression Used */ |
| 165 | #define IH_COMP_GZIP 1 /* gzip Compression Used */ |
| 166 | #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */ |
| 167 | |
| 168 | #define IH_MAGIC 0x27051956 /* Image Magic Number */ |
| 169 | #define IH_NMLEN 32 /* Image Name Length */ |
| 170 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 171 | /* |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 172 | * Legacy format image header, |
| 173 | * all data in network byte order (aka natural aka bigendian). |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 174 | */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 175 | typedef struct image_header { |
| 176 | uint32_t ih_magic; /* Image Header Magic Number */ |
| 177 | uint32_t ih_hcrc; /* Image Header CRC Checksum */ |
| 178 | uint32_t ih_time; /* Image Creation Timestamp */ |
| 179 | uint32_t ih_size; /* Image Data Size */ |
| 180 | uint32_t ih_load; /* Data Load Address */ |
| 181 | uint32_t ih_ep; /* Entry Point Address */ |
| 182 | uint32_t ih_dcrc; /* Image Data CRC Checksum */ |
| 183 | uint8_t ih_os; /* Operating System */ |
| 184 | uint8_t ih_arch; /* CPU architecture */ |
| 185 | uint8_t ih_type; /* Image Type */ |
| 186 | uint8_t ih_comp; /* Compression Type */ |
| 187 | uint8_t ih_name[IH_NMLEN]; /* Image Name */ |
| 188 | } image_header_t; |
| 189 | |
Marian Balakowicz | 559316f | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 190 | /* |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 191 | * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() |
| 192 | * routines. |
| 193 | */ |
| 194 | typedef struct bootm_headers { |
| 195 | /* |
| 196 | * Legacy os image header, if it is a multi component image |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 197 | * then boot_get_ramdisk() and get_fdt() will attempt to get |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 198 | * data from second and third component accordingly. |
| 199 | */ |
Marian Balakowicz | cb1c489 | 2008-04-11 11:07:49 +0200 | [diff] [blame] | 200 | image_header_t *legacy_hdr_os; /* image header pointer */ |
| 201 | image_header_t legacy_hdr_os_copy; /* header copy */ |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 202 | ulong legacy_hdr_valid; |
| 203 | |
| 204 | #if defined(CONFIG_FIT) |
Marian Balakowicz | f773bea | 2008-03-12 10:35:46 +0100 | [diff] [blame] | 205 | const char *fit_uname_cfg; /* configuration node unit name */ |
| 206 | |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 207 | void *fit_hdr_os; /* os FIT image header */ |
Marian Balakowicz | eb6175e | 2008-03-10 17:53:49 +0100 | [diff] [blame] | 208 | const char *fit_uname_os; /* os subimage node unit name */ |
Marian Balakowicz | 3dfe110 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 209 | int fit_noffset_os; /* os subimage node offset */ |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 210 | |
| 211 | void *fit_hdr_rd; /* init ramdisk FIT image header */ |
Marian Balakowicz | 3dfe110 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 212 | const char *fit_uname_rd; /* init ramdisk subimage node unit name */ |
| 213 | int fit_noffset_rd; /* init ramdisk subimage node offset */ |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 214 | |
| 215 | #if defined(CONFIG_PPC) |
| 216 | void *fit_hdr_fdt; /* FDT blob FIT image header */ |
Marian Balakowicz | 3dfe110 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 217 | const char *fit_uname_fdt; /* FDT blob subimage node unit name */ |
| 218 | int fit_noffset_fdt;/* FDT blob subimage node offset */ |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 219 | #endif |
Marian Balakowicz | 1ec7376 | 2008-03-12 10:35:52 +0100 | [diff] [blame] | 220 | #endif |
| 221 | |
Marian Balakowicz | 8a5ea3e | 2008-02-27 11:01:04 +0100 | [diff] [blame] | 222 | int verify; /* getenv("verify")[0] != 'n' */ |
Kumar Gala | f5614e7 | 2008-02-27 21:51:48 -0600 | [diff] [blame] | 223 | int autostart; /* getenv("autostart")[0] != 'n' */ |
Kumar Gala | 4ed6552 | 2008-02-27 21:51:47 -0600 | [diff] [blame] | 224 | struct lmb *lmb; /* for memory mgmt */ |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 225 | } bootm_headers_t; |
| 226 | |
| 227 | /* |
Marian Balakowicz | 559316f | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 228 | * Some systems (for example LWMON) have very short watchdog periods; |
| 229 | * we must make sure to split long operations like memmove() or |
| 230 | * crc32() into reasonable chunks. |
| 231 | */ |
| 232 | #define CHUNKSZ (64 * 1024) |
| 233 | |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 234 | #define uimage_to_cpu(x) ntohl(x) |
| 235 | #define cpu_to_uimage(x) htonl(x) |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 236 | |
Marian Balakowicz | 570abb0 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 237 | const char *genimg_get_os_name (uint8_t os); |
| 238 | const char *genimg_get_arch_name (uint8_t arch); |
| 239 | const char *genimg_get_type_name (uint8_t type); |
| 240 | const char *genimg_get_comp_name (uint8_t comp); |
| 241 | int genimg_get_os_id (const char *name); |
| 242 | int genimg_get_arch_id (const char *name); |
| 243 | int genimg_get_type_id (const char *name); |
| 244 | int genimg_get_comp_id (const char *name); |
| 245 | |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 246 | #ifndef USE_HOSTCC |
| 247 | /* Image format types, returned by _get_format() routine */ |
| 248 | #define IMAGE_FORMAT_INVALID 0x00 |
| 249 | #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ |
| 250 | #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ |
| 251 | |
| 252 | int genimg_get_format (void *img_addr); |
Marian Balakowicz | f773bea | 2008-03-12 10:35:46 +0100 | [diff] [blame] | 253 | int genimg_has_config (bootm_headers_t *images); |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 254 | ulong genimg_get_image (ulong img_addr); |
| 255 | |
Marian Balakowicz | d985c84 | 2008-03-12 10:14:38 +0100 | [diff] [blame] | 256 | int boot_get_ramdisk (int argc, char *argv[], bootm_headers_t *images, |
| 257 | uint8_t arch, ulong *rd_start, ulong *rd_end); |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 258 | |
| 259 | #if defined(CONFIG_PPC) || defined(CONFIG_M68K) |
| 260 | int boot_ramdisk_high (struct lmb *lmb, ulong rd_data, ulong rd_len, |
| 261 | ulong *initrd_start, ulong *initrd_end); |
| 262 | |
| 263 | int boot_get_cmdline (struct lmb *lmb, ulong *cmd_start, ulong *cmd_end, |
| 264 | ulong bootmap_base); |
| 265 | int boot_get_kbd (struct lmb *lmb, bd_t **kbd, ulong bootmap_base); |
| 266 | #endif /* CONFIG_PPC || CONFIG_M68K */ |
Marian Balakowicz | 570abb0 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 267 | #endif /* !USE_HOSTCC */ |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 268 | |
| 269 | /*******************************************************************/ |
| 270 | /* Legacy format specific code (prefixed with image_) */ |
| 271 | /*******************************************************************/ |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 272 | static inline uint32_t image_get_header_size (void) |
| 273 | { |
| 274 | return (sizeof (image_header_t)); |
| 275 | } |
| 276 | |
| 277 | #define image_get_hdr_l(f) \ |
| 278 | static inline uint32_t image_get_##f(image_header_t *hdr) \ |
| 279 | { \ |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 280 | return uimage_to_cpu (hdr->ih_##f); \ |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 281 | } |
| 282 | image_get_hdr_l (magic); |
| 283 | image_get_hdr_l (hcrc); |
| 284 | image_get_hdr_l (time); |
| 285 | image_get_hdr_l (size); |
| 286 | image_get_hdr_l (load); |
| 287 | image_get_hdr_l (ep); |
| 288 | image_get_hdr_l (dcrc); |
| 289 | |
| 290 | #define image_get_hdr_b(f) \ |
| 291 | static inline uint8_t image_get_##f(image_header_t *hdr) \ |
| 292 | { \ |
| 293 | return hdr->ih_##f; \ |
| 294 | } |
| 295 | image_get_hdr_b (os); |
| 296 | image_get_hdr_b (arch); |
| 297 | image_get_hdr_b (type); |
| 298 | image_get_hdr_b (comp); |
| 299 | |
| 300 | static inline char *image_get_name (image_header_t *hdr) |
| 301 | { |
| 302 | return (char *)hdr->ih_name; |
| 303 | } |
| 304 | |
| 305 | static inline uint32_t image_get_data_size (image_header_t *hdr) |
| 306 | { |
| 307 | return image_get_size (hdr); |
| 308 | } |
Marian Balakowicz | f13e7b2 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 309 | |
| 310 | /** |
| 311 | * image_get_data - get image payload start address |
| 312 | * @hdr: image header |
| 313 | * |
| 314 | * image_get_data() returns address of the image payload. For single |
| 315 | * component images it is image data start. For multi component |
| 316 | * images it points to the null terminated table of sub-images sizes. |
| 317 | * |
| 318 | * returns: |
| 319 | * image payload data start address |
| 320 | */ |
| 321 | static inline ulong image_get_data (image_header_t *hdr) |
| 322 | { |
| 323 | return ((ulong)hdr + image_get_header_size ()); |
| 324 | } |
| 325 | |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 326 | static inline uint32_t image_get_image_size (image_header_t *hdr) |
| 327 | { |
| 328 | return (image_get_size (hdr) + image_get_header_size ()); |
| 329 | } |
Marian Balakowicz | f13e7b2 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 330 | static inline ulong image_get_image_end (image_header_t *hdr) |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 331 | { |
Marian Balakowicz | f13e7b2 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 332 | return ((ulong)hdr + image_get_image_size (hdr)); |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 333 | } |
| 334 | |
| 335 | #define image_set_hdr_l(f) \ |
| 336 | static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ |
| 337 | { \ |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 338 | hdr->ih_##f = cpu_to_uimage (val); \ |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 339 | } |
| 340 | image_set_hdr_l (magic); |
| 341 | image_set_hdr_l (hcrc); |
| 342 | image_set_hdr_l (time); |
| 343 | image_set_hdr_l (size); |
| 344 | image_set_hdr_l (load); |
| 345 | image_set_hdr_l (ep); |
| 346 | image_set_hdr_l (dcrc); |
| 347 | |
| 348 | #define image_set_hdr_b(f) \ |
| 349 | static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ |
| 350 | { \ |
| 351 | hdr->ih_##f = val; \ |
| 352 | } |
| 353 | image_set_hdr_b (os); |
| 354 | image_set_hdr_b (arch); |
| 355 | image_set_hdr_b (type); |
| 356 | image_set_hdr_b (comp); |
| 357 | |
| 358 | static inline void image_set_name (image_header_t *hdr, const char *name) |
| 359 | { |
| 360 | strncpy (image_get_name (hdr), name, IH_NMLEN); |
| 361 | } |
| 362 | |
| 363 | int image_check_hcrc (image_header_t *hdr); |
| 364 | int image_check_dcrc (image_header_t *hdr); |
Marian Balakowicz | af13cdb | 2008-01-08 18:11:45 +0100 | [diff] [blame] | 365 | #ifndef USE_HOSTCC |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 366 | int image_check_dcrc_wd (image_header_t *hdr, ulong chunksize); |
Bartlomiej Sieka | edbed24 | 2008-04-18 12:39:23 +0200 | [diff] [blame] | 367 | int getenv_yesno (char *var); |
Kumar Gala | d3f2fa0 | 2008-02-27 21:51:50 -0600 | [diff] [blame] | 368 | ulong getenv_bootm_low(void); |
| 369 | ulong getenv_bootm_size(void); |
Marian Balakowicz | af13cdb | 2008-01-08 18:11:45 +0100 | [diff] [blame] | 370 | void memmove_wd (void *to, void *from, size_t len, ulong chunksz); |
| 371 | #endif |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 372 | |
| 373 | static inline int image_check_magic (image_header_t *hdr) |
| 374 | { |
| 375 | return (image_get_magic (hdr) == IH_MAGIC); |
| 376 | } |
| 377 | static inline int image_check_type (image_header_t *hdr, uint8_t type) |
| 378 | { |
| 379 | return (image_get_type (hdr) == type); |
| 380 | } |
| 381 | static inline int image_check_arch (image_header_t *hdr, uint8_t arch) |
| 382 | { |
| 383 | return (image_get_arch (hdr) == arch); |
| 384 | } |
| 385 | static inline int image_check_os (image_header_t *hdr, uint8_t os) |
| 386 | { |
| 387 | return (image_get_os (hdr) == os); |
| 388 | } |
| 389 | |
Marian Balakowicz | 42b73e8 | 2008-01-31 13:20:07 +0100 | [diff] [blame] | 390 | ulong image_multi_count (image_header_t *hdr); |
| 391 | void image_multi_getimg (image_header_t *hdr, ulong idx, |
| 392 | ulong *data, ulong *len); |
| 393 | |
Bartlomiej Sieka | edbed24 | 2008-04-18 12:39:23 +0200 | [diff] [blame] | 394 | void image_print_contents (image_header_t *hdr); |
Marian Balakowicz | 570abb0 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 395 | |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 396 | #ifndef USE_HOSTCC |
| 397 | static inline int image_check_target_arch (image_header_t *hdr) |
| 398 | { |
| 399 | #if defined(__ARM__) |
| 400 | if (!image_check_arch (hdr, IH_ARCH_ARM)) |
| 401 | #elif defined(__avr32__) |
| 402 | if (!image_check_arch (hdr, IH_ARCH_AVR32)) |
| 403 | #elif defined(__bfin__) |
| 404 | if (!image_check_arch (hdr, IH_ARCH_BLACKFIN)) |
| 405 | #elif defined(__I386__) |
| 406 | if (!image_check_arch (hdr, IH_ARCH_I386)) |
| 407 | #elif defined(__M68K__) |
| 408 | if (!image_check_arch (hdr, IH_ARCH_M68K)) |
| 409 | #elif defined(__microblaze__) |
| 410 | if (!image_check_arch (hdr, IH_ARCH_MICROBLAZE)) |
| 411 | #elif defined(__mips__) |
| 412 | if (!image_check_arch (hdr, IH_ARCH_MIPS)) |
| 413 | #elif defined(__nios__) |
| 414 | if (!image_check_arch (hdr, IH_ARCH_NIOS)) |
| 415 | #elif defined(__nios2__) |
| 416 | if (!image_check_arch (hdr, IH_ARCH_NIOS2)) |
| 417 | #elif defined(__PPC__) |
| 418 | if (!image_check_arch (hdr, IH_ARCH_PPC)) |
| 419 | #elif defined(__sh__) |
| 420 | if (!image_check_arch (hdr, IH_ARCH_SH)) |
Daniel Hellstrom | bf3d8b3 | 2008-03-28 08:29:26 +0100 | [diff] [blame] | 421 | #elif defined(__sparc__) |
| 422 | if (!image_check_arch (hdr, IH_ARCH_SPARC)) |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 423 | #else |
| 424 | # error Unknown CPU type |
| 425 | #endif |
| 426 | return 0; |
| 427 | |
| 428 | return 1; |
| 429 | } |
Marian Balakowicz | 5dfb521 | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 430 | #endif /* USE_HOSTCC */ |
Marian Balakowicz | b97a2a0 | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 431 | |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 432 | /*******************************************************************/ |
Marian Balakowicz | 9a4daad | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 433 | /* New uImage format specific code (prefixed with fit_) */ |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 434 | /*******************************************************************/ |
Marian Balakowicz | f50433d | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 435 | #if defined(CONFIG_FIT) |
Marian Balakowicz | 5dfb521 | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 436 | |
| 437 | #define FIT_IMAGES_PATH "/images" |
| 438 | #define FIT_CONFS_PATH "/configurations" |
| 439 | |
| 440 | /* hash node */ |
| 441 | #define FIT_HASH_NODENAME "hash" |
| 442 | #define FIT_ALGO_PROP "algo" |
| 443 | #define FIT_VALUE_PROP "value" |
| 444 | |
| 445 | /* image node */ |
| 446 | #define FIT_DATA_PROP "data" |
| 447 | #define FIT_TIMESTAMP_PROP "timestamp" |
| 448 | #define FIT_DESC_PROP "description" |
| 449 | #define FIT_ARCH_PROP "arch" |
| 450 | #define FIT_TYPE_PROP "type" |
| 451 | #define FIT_OS_PROP "os" |
| 452 | #define FIT_COMP_PROP "compression" |
| 453 | #define FIT_ENTRY_PROP "entry" |
| 454 | #define FIT_LOAD_PROP "load" |
| 455 | |
| 456 | /* configuration node */ |
| 457 | #define FIT_KERNEL_PROP "kernel" |
| 458 | #define FIT_RAMDISK_PROP "ramdisk" |
| 459 | #define FIT_FDT_PROP "fdt" |
| 460 | #define FIT_DEFAULT_PROP "default" |
| 461 | |
| 462 | #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */ |
| 463 | |
| 464 | /* cmdline argument format parsing */ |
Marian Balakowicz | f50433d | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 465 | inline int fit_parse_conf (const char *spec, ulong addr_curr, |
| 466 | ulong *addr, const char **conf_name); |
| 467 | inline int fit_parse_subimage (const char *spec, ulong addr_curr, |
| 468 | ulong *addr, const char **image_name); |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 469 | |
Bartlomiej Sieka | edbed24 | 2008-04-18 12:39:23 +0200 | [diff] [blame] | 470 | void fit_print_contents (const void *fit); |
Marian Balakowicz | 5dfb521 | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 471 | void fit_image_print (const void *fit, int noffset, const char *p); |
| 472 | void fit_image_print_hash (const void *fit, int noffset, const char *p); |
| 473 | |
| 474 | /** |
| 475 | * fit_get_end - get FIT image size |
| 476 | * @fit: pointer to the FIT format image header |
| 477 | * |
| 478 | * returns: |
| 479 | * size of the FIT image (blob) in memory |
| 480 | */ |
| 481 | static inline ulong fit_get_size (const void *fit) |
| 482 | { |
| 483 | return fdt_totalsize (fit); |
| 484 | } |
| 485 | |
| 486 | /** |
| 487 | * fit_get_end - get FIT image end |
| 488 | * @fit: pointer to the FIT format image header |
| 489 | * |
| 490 | * returns: |
| 491 | * end address of the FIT image (blob) in memory |
| 492 | */ |
| 493 | static inline ulong fit_get_end (const void *fit) |
| 494 | { |
| 495 | return (ulong)fit + fdt_totalsize (fit); |
| 496 | } |
| 497 | |
| 498 | /** |
| 499 | * fit_get_name - get FIT node name |
| 500 | * @fit: pointer to the FIT format image header |
| 501 | * |
| 502 | * returns: |
| 503 | * NULL, on error |
| 504 | * pointer to node name, on success |
| 505 | */ |
| 506 | static inline const char *fit_get_name (const void *fit_hdr, |
| 507 | int noffset, int *len) |
| 508 | { |
| 509 | return fdt_get_name (fit_hdr, noffset, len); |
| 510 | } |
| 511 | |
| 512 | int fit_get_desc (const void *fit, int noffset, char **desc); |
| 513 | int fit_get_timestamp (const void *fit, int noffset, time_t *timestamp); |
| 514 | |
| 515 | int fit_image_get_node (const void *fit, const char *image_uname); |
| 516 | int fit_image_get_os (const void *fit, int noffset, uint8_t *os); |
| 517 | int fit_image_get_arch (const void *fit, int noffset, uint8_t *arch); |
| 518 | int fit_image_get_type (const void *fit, int noffset, uint8_t *type); |
| 519 | int fit_image_get_comp (const void *fit, int noffset, uint8_t *comp); |
| 520 | int fit_image_get_load (const void *fit, int noffset, ulong *load); |
| 521 | int fit_image_get_entry (const void *fit, int noffset, ulong *entry); |
| 522 | int fit_image_get_data (const void *fit, int noffset, |
| 523 | const void **data, size_t *size); |
| 524 | |
| 525 | int fit_image_hash_get_algo (const void *fit, int noffset, char **algo); |
| 526 | int fit_image_hash_get_value (const void *fit, int noffset, uint8_t **value, |
| 527 | int *value_len); |
| 528 | |
| 529 | int fit_set_timestamp (void *fit, int noffset, time_t timestamp); |
| 530 | int fit_set_hashes (void *fit); |
| 531 | int fit_image_set_hashes (void *fit, int image_noffset); |
| 532 | int fit_image_hash_set_value (void *fit, int noffset, uint8_t *value, |
| 533 | int value_len); |
| 534 | |
| 535 | int fit_image_check_hashes (const void *fit, int noffset); |
| 536 | int fit_image_check_os (const void *fit, int noffset, uint8_t os); |
| 537 | int fit_image_check_arch (const void *fit, int noffset, uint8_t arch); |
| 538 | int fit_image_check_type (const void *fit, int noffset, uint8_t type); |
| 539 | int fit_image_check_comp (const void *fit, int noffset, uint8_t comp); |
| 540 | int fit_check_format (const void *fit); |
| 541 | |
| 542 | int fit_conf_get_node (const void *fit, const char *conf_uname); |
| 543 | int fit_conf_get_kernel_node (const void *fit, int noffset); |
| 544 | int fit_conf_get_ramdisk_node (const void *fit, int noffset); |
| 545 | int fit_conf_get_fdt_node (const void *fit, int noffset); |
| 546 | |
| 547 | void fit_conf_print (const void *fit, int noffset, const char *p); |
| 548 | |
| 549 | #ifndef USE_HOSTCC |
| 550 | static inline int fit_image_check_target_arch (const void *fdt, int node) |
| 551 | { |
| 552 | #if defined(__ARM__) |
| 553 | if (!fit_image_check_arch (fdt, node, IH_ARCH_ARM)) |
| 554 | #elif defined(__avr32__) |
| 555 | if (!fit_image_check_arch (fdt, node, IH_ARCH_AVR32)) |
| 556 | #elif defined(__bfin__) |
| 557 | if (!fit_image_check_arch (fdt, node, IH_ARCH_BLACKFIN)) |
| 558 | #elif defined(__I386__) |
| 559 | if (!fit_image_check_arch (fdt, node, IH_ARCH_I386)) |
| 560 | #elif defined(__M68K__) |
| 561 | if (!fit_image_check_arch (fdt, node, IH_ARCH_M68K)) |
| 562 | #elif defined(__microblaze__) |
| 563 | if (!fit_image_check_arch (fdt, node, IH_ARCH_MICROBLAZE)) |
| 564 | #elif defined(__mips__) |
| 565 | if (!fit_image_check_arch (fdt, node, IH_ARCH_MIPS)) |
| 566 | #elif defined(__nios__) |
| 567 | if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS)) |
| 568 | #elif defined(__nios2__) |
| 569 | if (!fit_image_check_arch (fdt, node, IH_ARCH_NIOS2)) |
| 570 | #elif defined(__PPC__) |
| 571 | if (!fit_image_check_arch (fdt, node, IH_ARCH_PPC)) |
| 572 | #elif defined(__sh__) |
| 573 | if (!fit_image_check_arch (fdt, node, IH_ARCH_SH)) |
Daniel Hellstrom | bf3d8b3 | 2008-03-28 08:29:26 +0100 | [diff] [blame] | 574 | #elif defined(__sparc__) |
| 575 | if (!fit_image_check_arch (fdt, node, IH_ARCH_SPARC)) |
Marian Balakowicz | 5dfb521 | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 576 | #else |
| 577 | # error Unknown CPU type |
| 578 | #endif |
| 579 | return 0; |
| 580 | |
| 581 | return 1; |
| 582 | } |
| 583 | #endif /* USE_HOSTCC */ |
| 584 | |
Marian Balakowicz | d5934ad | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 585 | #ifdef CONFIG_FIT_VERBOSE |
| 586 | #define fit_unsupported(msg) printf ("! %s:%d " \ |
| 587 | "FIT images not supported for '%s'\n", \ |
| 588 | __FILE__, __LINE__, (msg)) |
| 589 | |
| 590 | #define fit_unsupported_reset(msg) printf ("! %s:%d " \ |
| 591 | "FIT images not supported for '%s' " \ |
| 592 | "- must reset board to recover!\n", \ |
| 593 | __FILE__, __LINE__, (msg)) |
| 594 | #else |
| 595 | #define fit_unsupported(msg) |
| 596 | #define fit_unsupported_reset(msg) |
| 597 | #endif /* CONFIG_FIT_VERBOSE */ |
Marian Balakowicz | f50433d | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 598 | #endif /* CONFIG_FIT */ |
Marian Balakowicz | 5ad03eb | 2008-01-31 13:55:39 +0100 | [diff] [blame] | 599 | |
Marian Balakowicz | f13e7b2 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 600 | #endif /* __IMAGE_H__ */ |