1 /* 2 * (C) Copyright 2008 Semihalf 3 * 4 * (C) Copyright 2000-2005 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 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 ******************************************************************** 31 */ 32 33 #ifndef __IMAGE_H__ 34 #define __IMAGE_H__ 35 36 #include "compiler.h" 37 #include <asm/byteorder.h> 38 39 /* Define this to avoid #ifdefs later on */ 40 struct lmb; 41 42 #ifdef USE_HOSTCC 43 44 /* new uImage format support enabled on host */ 45 #define CONFIG_FIT 1 46 #define CONFIG_OF_LIBFDT 1 47 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ 48 49 #define IMAGE_ENABLE_IGNORE 0 50 #define IMAGE_INDENT_STRING "" 51 52 #else 53 54 #include <lmb.h> 55 #include <asm/u-boot.h> 56 #include <command.h> 57 58 /* Take notice of the 'ignore' property for hashes */ 59 #define IMAGE_ENABLE_IGNORE 1 60 #define IMAGE_INDENT_STRING " " 61 62 #endif /* USE_HOSTCC */ 63 64 #if defined(CONFIG_FIT) 65 #include <libfdt.h> 66 #include <fdt_support.h> 67 # ifdef CONFIG_SPL_BUILD 68 # ifdef CONFIG_SPL_CRC32_SUPPORT 69 # define IMAGE_ENABLE_CRC32 1 70 # endif 71 # ifdef CONFIG_SPL_MD5_SUPPORT 72 # define IMAGE_ENABLE_MD5 1 73 # endif 74 # ifdef CONFIG_SPL_SHA1_SUPPORT 75 # define IMAGE_ENABLE_SHA1 1 76 # endif 77 # else 78 # define CONFIG_CRC32 /* FIT images need CRC32 support */ 79 # define CONFIG_MD5 /* and MD5 */ 80 # define CONFIG_SHA1 /* and SHA1 */ 81 # define IMAGE_ENABLE_CRC32 1 82 # define IMAGE_ENABLE_MD5 1 83 # define IMAGE_ENABLE_SHA1 1 84 # endif 85 86 #ifndef IMAGE_ENABLE_CRC32 87 #define IMAGE_ENABLE_CRC32 0 88 #endif 89 90 #ifndef IMAGE_ENABLE_MD5 91 #define IMAGE_ENABLE_MD5 0 92 #endif 93 94 #ifndef IMAGE_ENABLE_SHA1 95 #define IMAGE_ENABLE_SHA1 0 96 #endif 97 98 #endif /* CONFIG_FIT */ 99 100 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH 101 # define IMAGE_ENABLE_RAMDISK_HIGH 1 102 #else 103 # define IMAGE_ENABLE_RAMDISK_HIGH 0 104 #endif 105 106 #ifdef CONFIG_OF_LIBFDT 107 # define IMAGE_ENABLE_OF_LIBFDT 1 108 #else 109 # define IMAGE_ENABLE_OF_LIBFDT 0 110 #endif 111 112 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE 113 # define IMAGE_BOOT_GET_CMDLINE 1 114 #else 115 # define IMAGE_BOOT_GET_CMDLINE 0 116 #endif 117 118 #ifdef CONFIG_OF_BOARD_SETUP 119 # define IMAAGE_OF_BOARD_SETUP 1 120 #else 121 # define IMAAGE_OF_BOARD_SETUP 0 122 #endif 123 124 /* 125 * Operating System Codes 126 */ 127 #define IH_OS_INVALID 0 /* Invalid OS */ 128 #define IH_OS_OPENBSD 1 /* OpenBSD */ 129 #define IH_OS_NETBSD 2 /* NetBSD */ 130 #define IH_OS_FREEBSD 3 /* FreeBSD */ 131 #define IH_OS_4_4BSD 4 /* 4.4BSD */ 132 #define IH_OS_LINUX 5 /* Linux */ 133 #define IH_OS_SVR4 6 /* SVR4 */ 134 #define IH_OS_ESIX 7 /* Esix */ 135 #define IH_OS_SOLARIS 8 /* Solaris */ 136 #define IH_OS_IRIX 9 /* Irix */ 137 #define IH_OS_SCO 10 /* SCO */ 138 #define IH_OS_DELL 11 /* Dell */ 139 #define IH_OS_NCR 12 /* NCR */ 140 #define IH_OS_LYNXOS 13 /* LynxOS */ 141 #define IH_OS_VXWORKS 14 /* VxWorks */ 142 #define IH_OS_PSOS 15 /* pSOS */ 143 #define IH_OS_QNX 16 /* QNX */ 144 #define IH_OS_U_BOOT 17 /* Firmware */ 145 #define IH_OS_RTEMS 18 /* RTEMS */ 146 #define IH_OS_ARTOS 19 /* ARTOS */ 147 #define IH_OS_UNITY 20 /* Unity OS */ 148 #define IH_OS_INTEGRITY 21 /* INTEGRITY */ 149 #define IH_OS_OSE 22 /* OSE */ 150 #define IH_OS_PLAN9 23 /* Plan 9 */ 151 152 /* 153 * CPU Architecture Codes (supported by Linux) 154 */ 155 #define IH_ARCH_INVALID 0 /* Invalid CPU */ 156 #define IH_ARCH_ALPHA 1 /* Alpha */ 157 #define IH_ARCH_ARM 2 /* ARM */ 158 #define IH_ARCH_I386 3 /* Intel x86 */ 159 #define IH_ARCH_IA64 4 /* IA64 */ 160 #define IH_ARCH_MIPS 5 /* MIPS */ 161 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */ 162 #define IH_ARCH_PPC 7 /* PowerPC */ 163 #define IH_ARCH_S390 8 /* IBM S390 */ 164 #define IH_ARCH_SH 9 /* SuperH */ 165 #define IH_ARCH_SPARC 10 /* Sparc */ 166 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */ 167 #define IH_ARCH_M68K 12 /* M68K */ 168 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */ 169 #define IH_ARCH_NIOS2 15 /* Nios-II */ 170 #define IH_ARCH_BLACKFIN 16 /* Blackfin */ 171 #define IH_ARCH_AVR32 17 /* AVR32 */ 172 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */ 173 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */ 174 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */ 175 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */ 176 177 /* 178 * Image Types 179 * 180 * "Standalone Programs" are directly runnable in the environment 181 * provided by U-Boot; it is expected that (if they behave 182 * well) you can continue to work in U-Boot after return from 183 * the Standalone Program. 184 * "OS Kernel Images" are usually images of some Embedded OS which 185 * will take over control completely. Usually these programs 186 * will install their own set of exception handlers, device 187 * drivers, set up the MMU, etc. - this means, that you cannot 188 * expect to re-enter U-Boot except by resetting the CPU. 189 * "RAMDisk Images" are more or less just data blocks, and their 190 * parameters (address, size) are passed to an OS kernel that is 191 * being started. 192 * "Multi-File Images" contain several images, typically an OS 193 * (Linux) kernel image and one or more data images like 194 * RAMDisks. This construct is useful for instance when you want 195 * to boot over the network using BOOTP etc., where the boot 196 * server provides just a single image file, but you want to get 197 * for instance an OS kernel and a RAMDisk image. 198 * 199 * "Multi-File Images" start with a list of image sizes, each 200 * image size (in bytes) specified by an "uint32_t" in network 201 * byte order. This list is terminated by an "(uint32_t)0". 202 * Immediately after the terminating 0 follow the images, one by 203 * one, all aligned on "uint32_t" boundaries (size rounded up to 204 * a multiple of 4 bytes - except for the last file). 205 * 206 * "Firmware Images" are binary images containing firmware (like 207 * U-Boot or FPGA images) which usually will be programmed to 208 * flash memory. 209 * 210 * "Script files" are command sequences that will be executed by 211 * U-Boot's command interpreter; this feature is especially 212 * useful when you configure U-Boot to use a real shell (hush) 213 * as command interpreter (=> Shell Scripts). 214 */ 215 216 #define IH_TYPE_INVALID 0 /* Invalid Image */ 217 #define IH_TYPE_STANDALONE 1 /* Standalone Program */ 218 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ 219 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ 220 #define IH_TYPE_MULTI 4 /* Multi-File Image */ 221 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ 222 #define IH_TYPE_SCRIPT 6 /* Script file */ 223 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */ 224 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */ 225 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */ 226 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */ 227 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */ 228 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */ 229 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */ 230 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */ 231 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */ 232 233 /* 234 * Compression Types 235 */ 236 #define IH_COMP_NONE 0 /* No Compression Used */ 237 #define IH_COMP_GZIP 1 /* gzip Compression Used */ 238 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */ 239 #define IH_COMP_LZMA 3 /* lzma Compression Used */ 240 #define IH_COMP_LZO 4 /* lzo Compression Used */ 241 242 #define IH_MAGIC 0x27051956 /* Image Magic Number */ 243 #define IH_NMLEN 32 /* Image Name Length */ 244 245 /* Reused from common.h */ 246 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1)) 247 248 /* 249 * Legacy format image header, 250 * all data in network byte order (aka natural aka bigendian). 251 */ 252 typedef struct image_header { 253 __be32 ih_magic; /* Image Header Magic Number */ 254 __be32 ih_hcrc; /* Image Header CRC Checksum */ 255 __be32 ih_time; /* Image Creation Timestamp */ 256 __be32 ih_size; /* Image Data Size */ 257 __be32 ih_load; /* Data Load Address */ 258 __be32 ih_ep; /* Entry Point Address */ 259 __be32 ih_dcrc; /* Image Data CRC Checksum */ 260 uint8_t ih_os; /* Operating System */ 261 uint8_t ih_arch; /* CPU architecture */ 262 uint8_t ih_type; /* Image Type */ 263 uint8_t ih_comp; /* Compression Type */ 264 uint8_t ih_name[IH_NMLEN]; /* Image Name */ 265 } image_header_t; 266 267 typedef struct image_info { 268 ulong start, end; /* start/end of blob */ 269 ulong image_start, image_len; /* start of image within blob, len of image */ 270 ulong load; /* load addr for the image */ 271 uint8_t comp, type, os; /* compression, type of image, os type */ 272 } image_info_t; 273 274 /* 275 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() 276 * routines. 277 */ 278 typedef struct bootm_headers { 279 /* 280 * Legacy os image header, if it is a multi component image 281 * then boot_get_ramdisk() and get_fdt() will attempt to get 282 * data from second and third component accordingly. 283 */ 284 image_header_t *legacy_hdr_os; /* image header pointer */ 285 image_header_t legacy_hdr_os_copy; /* header copy */ 286 ulong legacy_hdr_valid; 287 288 #if defined(CONFIG_FIT) 289 const char *fit_uname_cfg; /* configuration node unit name */ 290 291 void *fit_hdr_os; /* os FIT image header */ 292 const char *fit_uname_os; /* os subimage node unit name */ 293 int fit_noffset_os; /* os subimage node offset */ 294 295 void *fit_hdr_rd; /* init ramdisk FIT image header */ 296 const char *fit_uname_rd; /* init ramdisk subimage node unit name */ 297 int fit_noffset_rd; /* init ramdisk subimage node offset */ 298 299 void *fit_hdr_fdt; /* FDT blob FIT image header */ 300 const char *fit_uname_fdt; /* FDT blob subimage node unit name */ 301 int fit_noffset_fdt;/* FDT blob subimage node offset */ 302 #endif 303 304 #ifndef USE_HOSTCC 305 image_info_t os; /* os image info */ 306 ulong ep; /* entry point of OS */ 307 308 ulong rd_start, rd_end;/* ramdisk start/end */ 309 310 char *ft_addr; /* flat dev tree address */ 311 ulong ft_len; /* length of flat device tree */ 312 313 ulong initrd_start; 314 ulong initrd_end; 315 ulong cmdline_start; 316 ulong cmdline_end; 317 bd_t *kbd; 318 #endif 319 320 int verify; /* getenv("verify")[0] != 'n' */ 321 322 #define BOOTM_STATE_START (0x00000001) 323 #define BOOTM_STATE_FINDOS (0x00000002) 324 #define BOOTM_STATE_FINDOTHER (0x00000004) 325 #define BOOTM_STATE_LOADOS (0x00000008) 326 #define BOOTM_STATE_RAMDISK (0x00000010) 327 #define BOOTM_STATE_FDT (0x00000020) 328 #define BOOTM_STATE_OS_CMDLINE (0x00000040) 329 #define BOOTM_STATE_OS_BD_T (0x00000080) 330 #define BOOTM_STATE_OS_PREP (0x00000100) 331 #define BOOTM_STATE_OS_GO (0x00000200) 332 int state; 333 334 #ifdef CONFIG_LMB 335 struct lmb lmb; /* for memory mgmt */ 336 #endif 337 } bootm_headers_t; 338 339 extern bootm_headers_t images; 340 341 /* 342 * Some systems (for example LWMON) have very short watchdog periods; 343 * we must make sure to split long operations like memmove() or 344 * checksum calculations into reasonable chunks. 345 */ 346 #ifndef CHUNKSZ 347 #define CHUNKSZ (64 * 1024) 348 #endif 349 350 #ifndef CHUNKSZ_CRC32 351 #define CHUNKSZ_CRC32 (64 * 1024) 352 #endif 353 354 #ifndef CHUNKSZ_MD5 355 #define CHUNKSZ_MD5 (64 * 1024) 356 #endif 357 358 #ifndef CHUNKSZ_SHA1 359 #define CHUNKSZ_SHA1 (64 * 1024) 360 #endif 361 362 #define uimage_to_cpu(x) be32_to_cpu(x) 363 #define cpu_to_uimage(x) cpu_to_be32(x) 364 365 /* 366 * Translation table for entries of a specific type; used by 367 * get_table_entry_id() and get_table_entry_name(). 368 */ 369 typedef struct table_entry { 370 int id; 371 char *sname; /* short (input) name to find table entry */ 372 char *lname; /* long (output) name to print for messages */ 373 } table_entry_t; 374 375 /* 376 * get_table_entry_id() scans the translation table trying to find an 377 * entry that matches the given short name. If a matching entry is 378 * found, it's id is returned to the caller. 379 */ 380 int get_table_entry_id(const table_entry_t *table, 381 const char *table_name, const char *name); 382 /* 383 * get_table_entry_name() scans the translation table trying to find 384 * an entry that matches the given id. If a matching entry is found, 385 * its long name is returned to the caller. 386 */ 387 char *get_table_entry_name(const table_entry_t *table, char *msg, int id); 388 389 const char *genimg_get_os_name(uint8_t os); 390 const char *genimg_get_arch_name(uint8_t arch); 391 const char *genimg_get_type_name(uint8_t type); 392 const char *genimg_get_comp_name(uint8_t comp); 393 int genimg_get_os_id(const char *name); 394 int genimg_get_arch_id(const char *name); 395 int genimg_get_type_id(const char *name); 396 int genimg_get_comp_id(const char *name); 397 void genimg_print_size(uint32_t size); 398 399 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \ 400 defined(USE_HOSTCC) 401 #define IMAGE_ENABLE_TIMESTAMP 1 402 #else 403 #define IMAGE_ENABLE_TIMESTAMP 0 404 #endif 405 void genimg_print_time(time_t timestamp); 406 407 /* What to do with a image load address ('load = <> 'in the FIT) */ 408 enum fit_load_op { 409 FIT_LOAD_IGNORED, /* Ignore load address */ 410 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */ 411 FIT_LOAD_REQUIRED, /* Must be provided */ 412 }; 413 414 #ifndef USE_HOSTCC 415 /* Image format types, returned by _get_format() routine */ 416 #define IMAGE_FORMAT_INVALID 0x00 417 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 418 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 419 420 int genimg_get_format(const void *img_addr); 421 int genimg_has_config(bootm_headers_t *images); 422 ulong genimg_get_image(ulong img_addr); 423 424 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images, 425 uint8_t arch, ulong *rd_start, ulong *rd_end); 426 427 /** 428 * fit_image_load() - load an image from a FIT 429 * 430 * This deals with all aspects of loading an image from a FIT, including 431 * selecting the right image based on configuration, verifying it, printing 432 * out progress messages, checking the type/arch/os and optionally copying it 433 * to the right load address. 434 * 435 * @param images Boot images structure 436 * @param prop_name Property name to look up (FIT_..._PROP) 437 * @param addr Address of FIT in memory 438 * @param fit_unamep On entry this is the requested image name 439 * (e.g. "kernel@1") or NULL to use the default. On exit 440 * points to the selected image name 441 * @param fit_uname_config Requested configuration name, or NULL for the 442 * default 443 * @param arch Expected architecture (IH_ARCH_...) 444 * @param image_type Required image type (IH_TYPE_...). If this is 445 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD 446 * also. 447 * @param bootstage_id ID of starting bootstage to use for progress updates. 448 * This will be added to the BOOTSTAGE_SUB values when 449 * calling bootstage_mark() 450 * @param load_op Decribes what to do with the load address 451 * @param datap Returns address of loaded image 452 * @param lenp Returns length of loaded image 453 */ 454 int fit_image_load(bootm_headers_t *images, const char *prop_name, ulong addr, 455 const char **fit_unamep, const char *fit_uname_config, 456 int arch, int image_type, int bootstage_id, 457 enum fit_load_op load_op, ulong *datap, ulong *lenp); 458 459 /** 460 * fit_get_node_from_config() - Look up an image a FIT by type 461 * 462 * This looks in the selected conf@ node (images->fit_uname_cfg) for a 463 * particular image type (e.g. "kernel") and then finds the image that is 464 * referred to. 465 * 466 * For example, for something like: 467 * 468 * images { 469 * kernel@1 { 470 * ... 471 * }; 472 * }; 473 * configurations { 474 * conf@1 { 475 * kernel = "kernel@1"; 476 * }; 477 * }; 478 * 479 * the function will return the node offset of the kernel@1 node, assuming 480 * that conf@1 is the chosen configuration. 481 * 482 * @param images Boot images structure 483 * @param prop_name Property name to look up (FIT_..._PROP) 484 * @param addr Address of FIT in memory 485 */ 486 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name, 487 ulong addr); 488 489 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch, 490 bootm_headers_t *images, 491 char **of_flat_tree, ulong *of_size); 492 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob); 493 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size); 494 495 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len, 496 ulong *initrd_start, ulong *initrd_end); 497 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end); 498 #ifdef CONFIG_SYS_BOOT_GET_KBD 499 int boot_get_kbd(struct lmb *lmb, bd_t **kbd); 500 #endif /* CONFIG_SYS_BOOT_GET_KBD */ 501 #endif /* !USE_HOSTCC */ 502 503 /*******************************************************************/ 504 /* Legacy format specific code (prefixed with image_) */ 505 /*******************************************************************/ 506 static inline uint32_t image_get_header_size(void) 507 { 508 return (sizeof(image_header_t)); 509 } 510 511 #define image_get_hdr_l(f) \ 512 static inline uint32_t image_get_##f(const image_header_t *hdr) \ 513 { \ 514 return uimage_to_cpu(hdr->ih_##f); \ 515 } 516 image_get_hdr_l(magic) /* image_get_magic */ 517 image_get_hdr_l(hcrc) /* image_get_hcrc */ 518 image_get_hdr_l(time) /* image_get_time */ 519 image_get_hdr_l(size) /* image_get_size */ 520 image_get_hdr_l(load) /* image_get_load */ 521 image_get_hdr_l(ep) /* image_get_ep */ 522 image_get_hdr_l(dcrc) /* image_get_dcrc */ 523 524 #define image_get_hdr_b(f) \ 525 static inline uint8_t image_get_##f(const image_header_t *hdr) \ 526 { \ 527 return hdr->ih_##f; \ 528 } 529 image_get_hdr_b(os) /* image_get_os */ 530 image_get_hdr_b(arch) /* image_get_arch */ 531 image_get_hdr_b(type) /* image_get_type */ 532 image_get_hdr_b(comp) /* image_get_comp */ 533 534 static inline char *image_get_name(const image_header_t *hdr) 535 { 536 return (char *)hdr->ih_name; 537 } 538 539 static inline uint32_t image_get_data_size(const image_header_t *hdr) 540 { 541 return image_get_size(hdr); 542 } 543 544 /** 545 * image_get_data - get image payload start address 546 * @hdr: image header 547 * 548 * image_get_data() returns address of the image payload. For single 549 * component images it is image data start. For multi component 550 * images it points to the null terminated table of sub-images sizes. 551 * 552 * returns: 553 * image payload data start address 554 */ 555 static inline ulong image_get_data(const image_header_t *hdr) 556 { 557 return ((ulong)hdr + image_get_header_size()); 558 } 559 560 static inline uint32_t image_get_image_size(const image_header_t *hdr) 561 { 562 return (image_get_size(hdr) + image_get_header_size()); 563 } 564 static inline ulong image_get_image_end(const image_header_t *hdr) 565 { 566 return ((ulong)hdr + image_get_image_size(hdr)); 567 } 568 569 #define image_set_hdr_l(f) \ 570 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ 571 { \ 572 hdr->ih_##f = cpu_to_uimage(val); \ 573 } 574 image_set_hdr_l(magic) /* image_set_magic */ 575 image_set_hdr_l(hcrc) /* image_set_hcrc */ 576 image_set_hdr_l(time) /* image_set_time */ 577 image_set_hdr_l(size) /* image_set_size */ 578 image_set_hdr_l(load) /* image_set_load */ 579 image_set_hdr_l(ep) /* image_set_ep */ 580 image_set_hdr_l(dcrc) /* image_set_dcrc */ 581 582 #define image_set_hdr_b(f) \ 583 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ 584 { \ 585 hdr->ih_##f = val; \ 586 } 587 image_set_hdr_b(os) /* image_set_os */ 588 image_set_hdr_b(arch) /* image_set_arch */ 589 image_set_hdr_b(type) /* image_set_type */ 590 image_set_hdr_b(comp) /* image_set_comp */ 591 592 static inline void image_set_name(image_header_t *hdr, const char *name) 593 { 594 strncpy(image_get_name(hdr), name, IH_NMLEN); 595 } 596 597 int image_check_hcrc(const image_header_t *hdr); 598 int image_check_dcrc(const image_header_t *hdr); 599 #ifndef USE_HOSTCC 600 ulong getenv_bootm_low(void); 601 phys_size_t getenv_bootm_size(void); 602 phys_size_t getenv_bootm_mapsize(void); 603 void memmove_wd(void *to, void *from, size_t len, ulong chunksz); 604 #endif 605 606 static inline int image_check_magic(const image_header_t *hdr) 607 { 608 return (image_get_magic(hdr) == IH_MAGIC); 609 } 610 static inline int image_check_type(const image_header_t *hdr, uint8_t type) 611 { 612 return (image_get_type(hdr) == type); 613 } 614 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch) 615 { 616 return (image_get_arch(hdr) == arch); 617 } 618 static inline int image_check_os(const image_header_t *hdr, uint8_t os) 619 { 620 return (image_get_os(hdr) == os); 621 } 622 623 ulong image_multi_count(const image_header_t *hdr); 624 void image_multi_getimg(const image_header_t *hdr, ulong idx, 625 ulong *data, ulong *len); 626 627 void image_print_contents(const void *hdr); 628 629 #ifndef USE_HOSTCC 630 static inline int image_check_target_arch(const image_header_t *hdr) 631 { 632 #ifndef IH_ARCH_DEFAULT 633 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h" 634 #endif 635 return image_check_arch(hdr, IH_ARCH_DEFAULT); 636 } 637 #endif /* USE_HOSTCC */ 638 639 /** 640 * Set up properties in the FDT 641 * 642 * This sets up properties in the FDT that is to be passed to linux. 643 * 644 * @images: Images information 645 * @blob: FDT to update 646 * @of_size: Size of the FDT 647 * @lmb: Points to logical memory block structure 648 * @return 0 if ok, <0 on failure 649 */ 650 int image_setup_libfdt(bootm_headers_t *images, void *blob, 651 int of_size, struct lmb *lmb); 652 653 /** 654 * Set up the FDT to use for booting a kernel 655 * 656 * This performs ramdisk setup, sets up the FDT if required, and adds 657 * paramters to the FDT if libfdt is available. 658 * 659 * @param images Images information 660 * @return 0 if ok, <0 on failure 661 */ 662 int image_setup_linux(bootm_headers_t *images); 663 664 /*******************************************************************/ 665 /* New uImage format specific code (prefixed with fit_) */ 666 /*******************************************************************/ 667 #if defined(CONFIG_FIT) 668 669 #define FIT_IMAGES_PATH "/images" 670 #define FIT_CONFS_PATH "/configurations" 671 672 /* hash node */ 673 #define FIT_HASH_NODENAME "hash" 674 #define FIT_ALGO_PROP "algo" 675 #define FIT_VALUE_PROP "value" 676 #define FIT_IGNORE_PROP "uboot-ignore" 677 678 /* image node */ 679 #define FIT_DATA_PROP "data" 680 #define FIT_TIMESTAMP_PROP "timestamp" 681 #define FIT_DESC_PROP "description" 682 #define FIT_ARCH_PROP "arch" 683 #define FIT_TYPE_PROP "type" 684 #define FIT_OS_PROP "os" 685 #define FIT_COMP_PROP "compression" 686 #define FIT_ENTRY_PROP "entry" 687 #define FIT_LOAD_PROP "load" 688 689 /* configuration node */ 690 #define FIT_KERNEL_PROP "kernel" 691 #define FIT_RAMDISK_PROP "ramdisk" 692 #define FIT_FDT_PROP "fdt" 693 #define FIT_DEFAULT_PROP "default" 694 695 #define FIT_MAX_HASH_LEN 20 /* max(crc32_len(4), sha1_len(20)) */ 696 697 /* cmdline argument format parsing */ 698 int fit_parse_conf(const char *spec, ulong addr_curr, 699 ulong *addr, const char **conf_name); 700 int fit_parse_subimage(const char *spec, ulong addr_curr, 701 ulong *addr, const char **image_name); 702 703 void fit_print_contents(const void *fit); 704 void fit_image_print(const void *fit, int noffset, const char *p); 705 706 /** 707 * fit_get_end - get FIT image size 708 * @fit: pointer to the FIT format image header 709 * 710 * returns: 711 * size of the FIT image (blob) in memory 712 */ 713 static inline ulong fit_get_size(const void *fit) 714 { 715 return fdt_totalsize(fit); 716 } 717 718 /** 719 * fit_get_end - get FIT image end 720 * @fit: pointer to the FIT format image header 721 * 722 * returns: 723 * end address of the FIT image (blob) in memory 724 */ 725 static inline ulong fit_get_end(const void *fit) 726 { 727 return (ulong)fit + fdt_totalsize(fit); 728 } 729 730 /** 731 * fit_get_name - get FIT node name 732 * @fit: pointer to the FIT format image header 733 * 734 * returns: 735 * NULL, on error 736 * pointer to node name, on success 737 */ 738 static inline const char *fit_get_name(const void *fit_hdr, 739 int noffset, int *len) 740 { 741 return fdt_get_name(fit_hdr, noffset, len); 742 } 743 744 int fit_get_desc(const void *fit, int noffset, char **desc); 745 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); 746 747 int fit_image_get_node(const void *fit, const char *image_uname); 748 int fit_image_get_os(const void *fit, int noffset, uint8_t *os); 749 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); 750 int fit_image_get_type(const void *fit, int noffset, uint8_t *type); 751 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); 752 int fit_image_get_load(const void *fit, int noffset, ulong *load); 753 int fit_image_get_entry(const void *fit, int noffset, ulong *entry); 754 int fit_image_get_data(const void *fit, int noffset, 755 const void **data, size_t *size); 756 757 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo); 758 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value, 759 int *value_len); 760 761 int fit_set_timestamp(void *fit, int noffset, time_t timestamp); 762 763 /** 764 * fit_add_verification_data() - Calculate and add hashes to FIT 765 * 766 * @fit: Fit image to process 767 * @return 0 if ok, <0 for error 768 */ 769 int fit_add_verification_data(void *fit); 770 771 int fit_image_verify(const void *fit, int noffset); 772 int fit_config_verify(const void *fit, int conf_noffset); 773 int fit_all_image_verify(const void *fit); 774 int fit_image_check_os(const void *fit, int noffset, uint8_t os); 775 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); 776 int fit_image_check_type(const void *fit, int noffset, uint8_t type); 777 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); 778 int fit_check_format(const void *fit); 779 780 int fit_conf_find_compat(const void *fit, const void *fdt); 781 int fit_conf_get_node(const void *fit, const char *conf_uname); 782 783 /** 784 * fit_conf_get_prop_node() - Get node refered to by a configuration 785 * @fit: FIT to check 786 * @noffset: Offset of conf@xxx node to check 787 * @prop_name: Property to read from the conf node 788 * 789 * The conf@ nodes contain references to other nodes, using properties 790 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"), 791 * return the offset of the node referred to (e.g. offset of node 792 * "/images/kernel@1". 793 */ 794 int fit_conf_get_prop_node(const void *fit, int noffset, 795 const char *prop_name); 796 797 void fit_conf_print(const void *fit, int noffset, const char *p); 798 799 int fit_check_ramdisk(const void *fit, int os_noffset, 800 uint8_t arch, int verify); 801 802 int calculate_hash(const void *data, int data_len, const char *algo, 803 uint8_t *value, int *value_len); 804 805 /* 806 * At present we only support verification on the device 807 */ 808 #if defined(CONFIG_FIT_SIGNATURE) 809 # ifdef USE_HOSTCC 810 # define IMAGE_ENABLE_VERIFY 0 811 #else 812 # define IMAGE_ENABLE_VERIFY 1 813 # endif 814 #else 815 # define IMAGE_ENABLE_VERIFY 0 816 #endif 817 818 #ifdef USE_HOSTCC 819 # define gd_fdt_blob() NULL 820 #else 821 # define gd_fdt_blob() (gd->fdt_blob) 822 #endif 823 824 #ifdef CONFIG_FIT_BEST_MATCH 825 #define IMAGE_ENABLE_BEST_MATCH 1 826 #else 827 #define IMAGE_ENABLE_BEST_MATCH 0 828 #endif 829 830 static inline int fit_image_check_target_arch(const void *fdt, int node) 831 { 832 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); 833 } 834 835 #ifdef CONFIG_FIT_VERBOSE 836 #define fit_unsupported(msg) printf("! %s:%d " \ 837 "FIT images not supported for '%s'\n", \ 838 __FILE__, __LINE__, (msg)) 839 840 #define fit_unsupported_reset(msg) printf("! %s:%d " \ 841 "FIT images not supported for '%s' " \ 842 "- must reset board to recover!\n", \ 843 __FILE__, __LINE__, (msg)) 844 #else 845 #define fit_unsupported(msg) 846 #define fit_unsupported_reset(msg) 847 #endif /* CONFIG_FIT_VERBOSE */ 848 #endif /* CONFIG_FIT */ 849 850 #endif /* __IMAGE_H__ */ 851