1 /* 2 * (C) Copyright 2008 Semihalf 3 * 4 * (C) Copyright 2000-2005 5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 6 * 7 * SPDX-License-Identifier: GPL-2.0+ 8 ******************************************************************** 9 * NOTE: This header file defines an interface to U-Boot. Including 10 * this (unmodified) header file in another file is considered normal 11 * use of U-Boot, and does *not* fall under the heading of "derived 12 * work". 13 ******************************************************************** 14 */ 15 16 #ifndef __IMAGE_H__ 17 #define __IMAGE_H__ 18 19 #include "compiler.h" 20 #include <asm/byteorder.h> 21 22 /* Define this to avoid #ifdefs later on */ 23 struct lmb; 24 25 #ifdef USE_HOSTCC 26 27 /* new uImage format support enabled on host */ 28 #define CONFIG_FIT 1 29 #define CONFIG_OF_LIBFDT 1 30 #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ 31 32 #define IMAGE_ENABLE_IGNORE 0 33 #define IMAGE_INDENT_STRING "" 34 35 #else 36 37 #include <lmb.h> 38 #include <asm/u-boot.h> 39 #include <command.h> 40 41 /* Take notice of the 'ignore' property for hashes */ 42 #define IMAGE_ENABLE_IGNORE 1 43 #define IMAGE_INDENT_STRING " " 44 45 #endif /* USE_HOSTCC */ 46 47 #if defined(CONFIG_FIT) 48 #include <hash.h> 49 #include <libfdt.h> 50 #include <fdt_support.h> 51 # ifdef CONFIG_SPL_BUILD 52 # ifdef CONFIG_SPL_CRC32_SUPPORT 53 # define IMAGE_ENABLE_CRC32 1 54 # endif 55 # ifdef CONFIG_SPL_MD5_SUPPORT 56 # define IMAGE_ENABLE_MD5 1 57 # endif 58 # ifdef CONFIG_SPL_SHA1_SUPPORT 59 # define IMAGE_ENABLE_SHA1 1 60 # endif 61 # ifdef CONFIG_SPL_SHA256_SUPPORT 62 # define IMAGE_ENABLE_SHA256 1 63 # endif 64 # else 65 # define CONFIG_CRC32 /* FIT images need CRC32 support */ 66 # define CONFIG_MD5 /* and MD5 */ 67 # define CONFIG_SHA1 /* and SHA1 */ 68 # define CONFIG_SHA256 /* and SHA256 */ 69 # define IMAGE_ENABLE_CRC32 1 70 # define IMAGE_ENABLE_MD5 1 71 # define IMAGE_ENABLE_SHA1 1 72 # define IMAGE_ENABLE_SHA256 1 73 # endif 74 75 #ifdef CONFIG_FIT_DISABLE_SHA256 76 #undef CONFIG_SHA256 77 #undef IMAGE_ENABLE_SHA256 78 #endif 79 80 #ifndef IMAGE_ENABLE_CRC32 81 #define IMAGE_ENABLE_CRC32 0 82 #endif 83 84 #ifndef IMAGE_ENABLE_MD5 85 #define IMAGE_ENABLE_MD5 0 86 #endif 87 88 #ifndef IMAGE_ENABLE_SHA1 89 #define IMAGE_ENABLE_SHA1 0 90 #endif 91 92 #ifndef IMAGE_ENABLE_SHA256 93 #define IMAGE_ENABLE_SHA256 0 94 #endif 95 96 #endif /* CONFIG_FIT */ 97 98 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH 99 # define IMAGE_ENABLE_RAMDISK_HIGH 1 100 #else 101 # define IMAGE_ENABLE_RAMDISK_HIGH 0 102 #endif 103 104 #ifdef CONFIG_OF_LIBFDT 105 # define IMAGE_ENABLE_OF_LIBFDT 1 106 #else 107 # define IMAGE_ENABLE_OF_LIBFDT 0 108 #endif 109 110 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE 111 # define IMAGE_BOOT_GET_CMDLINE 1 112 #else 113 # define IMAGE_BOOT_GET_CMDLINE 0 114 #endif 115 116 #ifdef CONFIG_OF_BOARD_SETUP 117 # define IMAGE_OF_BOARD_SETUP 1 118 #else 119 # define IMAGE_OF_BOARD_SETUP 0 120 #endif 121 122 #ifdef CONFIG_OF_SYSTEM_SETUP 123 # define IMAGE_OF_SYSTEM_SETUP 1 124 #else 125 # define IMAGE_OF_SYSTEM_SETUP 0 126 #endif 127 128 /* 129 * Operating System Codes 130 */ 131 #define IH_OS_INVALID 0 /* Invalid OS */ 132 #define IH_OS_OPENBSD 1 /* OpenBSD */ 133 #define IH_OS_NETBSD 2 /* NetBSD */ 134 #define IH_OS_FREEBSD 3 /* FreeBSD */ 135 #define IH_OS_4_4BSD 4 /* 4.4BSD */ 136 #define IH_OS_LINUX 5 /* Linux */ 137 #define IH_OS_SVR4 6 /* SVR4 */ 138 #define IH_OS_ESIX 7 /* Esix */ 139 #define IH_OS_SOLARIS 8 /* Solaris */ 140 #define IH_OS_IRIX 9 /* Irix */ 141 #define IH_OS_SCO 10 /* SCO */ 142 #define IH_OS_DELL 11 /* Dell */ 143 #define IH_OS_NCR 12 /* NCR */ 144 #define IH_OS_LYNXOS 13 /* LynxOS */ 145 #define IH_OS_VXWORKS 14 /* VxWorks */ 146 #define IH_OS_PSOS 15 /* pSOS */ 147 #define IH_OS_QNX 16 /* QNX */ 148 #define IH_OS_U_BOOT 17 /* Firmware */ 149 #define IH_OS_RTEMS 18 /* RTEMS */ 150 #define IH_OS_ARTOS 19 /* ARTOS */ 151 #define IH_OS_UNITY 20 /* Unity OS */ 152 #define IH_OS_INTEGRITY 21 /* INTEGRITY */ 153 #define IH_OS_OSE 22 /* OSE */ 154 #define IH_OS_PLAN9 23 /* Plan 9 */ 155 #define IH_OS_OPENRTOS 24 /* OpenRTOS */ 156 157 /* 158 * CPU Architecture Codes (supported by Linux) 159 */ 160 #define IH_ARCH_INVALID 0 /* Invalid CPU */ 161 #define IH_ARCH_ALPHA 1 /* Alpha */ 162 #define IH_ARCH_ARM 2 /* ARM */ 163 #define IH_ARCH_I386 3 /* Intel x86 */ 164 #define IH_ARCH_IA64 4 /* IA64 */ 165 #define IH_ARCH_MIPS 5 /* MIPS */ 166 #define IH_ARCH_MIPS64 6 /* MIPS 64 Bit */ 167 #define IH_ARCH_PPC 7 /* PowerPC */ 168 #define IH_ARCH_S390 8 /* IBM S390 */ 169 #define IH_ARCH_SH 9 /* SuperH */ 170 #define IH_ARCH_SPARC 10 /* Sparc */ 171 #define IH_ARCH_SPARC64 11 /* Sparc 64 Bit */ 172 #define IH_ARCH_M68K 12 /* M68K */ 173 #define IH_ARCH_MICROBLAZE 14 /* MicroBlaze */ 174 #define IH_ARCH_NIOS2 15 /* Nios-II */ 175 #define IH_ARCH_BLACKFIN 16 /* Blackfin */ 176 #define IH_ARCH_AVR32 17 /* AVR32 */ 177 #define IH_ARCH_ST200 18 /* STMicroelectronics ST200 */ 178 #define IH_ARCH_SANDBOX 19 /* Sandbox architecture (test only) */ 179 #define IH_ARCH_NDS32 20 /* ANDES Technology - NDS32 */ 180 #define IH_ARCH_OPENRISC 21 /* OpenRISC 1000 */ 181 #define IH_ARCH_ARM64 22 /* ARM64 */ 182 #define IH_ARCH_ARC 23 /* Synopsys DesignWare ARC */ 183 #define IH_ARCH_X86_64 24 /* AMD x86_64, Intel and Via */ 184 185 /* 186 * Image Types 187 * 188 * "Standalone Programs" are directly runnable in the environment 189 * provided by U-Boot; it is expected that (if they behave 190 * well) you can continue to work in U-Boot after return from 191 * the Standalone Program. 192 * "OS Kernel Images" are usually images of some Embedded OS which 193 * will take over control completely. Usually these programs 194 * will install their own set of exception handlers, device 195 * drivers, set up the MMU, etc. - this means, that you cannot 196 * expect to re-enter U-Boot except by resetting the CPU. 197 * "RAMDisk Images" are more or less just data blocks, and their 198 * parameters (address, size) are passed to an OS kernel that is 199 * being started. 200 * "Multi-File Images" contain several images, typically an OS 201 * (Linux) kernel image and one or more data images like 202 * RAMDisks. This construct is useful for instance when you want 203 * to boot over the network using BOOTP etc., where the boot 204 * server provides just a single image file, but you want to get 205 * for instance an OS kernel and a RAMDisk image. 206 * 207 * "Multi-File Images" start with a list of image sizes, each 208 * image size (in bytes) specified by an "uint32_t" in network 209 * byte order. This list is terminated by an "(uint32_t)0". 210 * Immediately after the terminating 0 follow the images, one by 211 * one, all aligned on "uint32_t" boundaries (size rounded up to 212 * a multiple of 4 bytes - except for the last file). 213 * 214 * "Firmware Images" are binary images containing firmware (like 215 * U-Boot or FPGA images) which usually will be programmed to 216 * flash memory. 217 * 218 * "Script files" are command sequences that will be executed by 219 * U-Boot's command interpreter; this feature is especially 220 * useful when you configure U-Boot to use a real shell (hush) 221 * as command interpreter (=> Shell Scripts). 222 */ 223 224 #define IH_TYPE_INVALID 0 /* Invalid Image */ 225 #define IH_TYPE_STANDALONE 1 /* Standalone Program */ 226 #define IH_TYPE_KERNEL 2 /* OS Kernel Image */ 227 #define IH_TYPE_RAMDISK 3 /* RAMDisk Image */ 228 #define IH_TYPE_MULTI 4 /* Multi-File Image */ 229 #define IH_TYPE_FIRMWARE 5 /* Firmware Image */ 230 #define IH_TYPE_SCRIPT 6 /* Script file */ 231 #define IH_TYPE_FILESYSTEM 7 /* Filesystem Image (any type) */ 232 #define IH_TYPE_FLATDT 8 /* Binary Flat Device Tree Blob */ 233 #define IH_TYPE_KWBIMAGE 9 /* Kirkwood Boot Image */ 234 #define IH_TYPE_IMXIMAGE 10 /* Freescale IMXBoot Image */ 235 #define IH_TYPE_UBLIMAGE 11 /* Davinci UBL Image */ 236 #define IH_TYPE_OMAPIMAGE 12 /* TI OMAP Config Header Image */ 237 #define IH_TYPE_AISIMAGE 13 /* TI Davinci AIS Image */ 238 #define IH_TYPE_KERNEL_NOLOAD 14 /* OS Kernel Image, can run from any load address */ 239 #define IH_TYPE_PBLIMAGE 15 /* Freescale PBL Boot Image */ 240 #define IH_TYPE_MXSIMAGE 16 /* Freescale MXSBoot Image */ 241 #define IH_TYPE_GPIMAGE 17 /* TI Keystone GPHeader Image */ 242 #define IH_TYPE_ATMELIMAGE 18 /* ATMEL ROM bootable Image */ 243 #define IH_TYPE_SOCFPGAIMAGE 19 /* Altera SOCFPGA Preloader */ 244 #define IH_TYPE_X86_SETUP 20 /* x86 setup.bin Image */ 245 #define IH_TYPE_LPC32XXIMAGE 21 /* x86 setup.bin Image */ 246 247 /* 248 * Compression Types 249 */ 250 #define IH_COMP_NONE 0 /* No Compression Used */ 251 #define IH_COMP_GZIP 1 /* gzip Compression Used */ 252 #define IH_COMP_BZIP2 2 /* bzip2 Compression Used */ 253 #define IH_COMP_LZMA 3 /* lzma Compression Used */ 254 #define IH_COMP_LZO 4 /* lzo Compression Used */ 255 256 #define IH_MAGIC 0x27051956 /* Image Magic Number */ 257 #define IH_NMLEN 32 /* Image Name Length */ 258 259 /* Reused from common.h */ 260 #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1)) 261 262 /* 263 * Legacy format image header, 264 * all data in network byte order (aka natural aka bigendian). 265 */ 266 typedef struct image_header { 267 __be32 ih_magic; /* Image Header Magic Number */ 268 __be32 ih_hcrc; /* Image Header CRC Checksum */ 269 __be32 ih_time; /* Image Creation Timestamp */ 270 __be32 ih_size; /* Image Data Size */ 271 __be32 ih_load; /* Data Load Address */ 272 __be32 ih_ep; /* Entry Point Address */ 273 __be32 ih_dcrc; /* Image Data CRC Checksum */ 274 uint8_t ih_os; /* Operating System */ 275 uint8_t ih_arch; /* CPU architecture */ 276 uint8_t ih_type; /* Image Type */ 277 uint8_t ih_comp; /* Compression Type */ 278 uint8_t ih_name[IH_NMLEN]; /* Image Name */ 279 } image_header_t; 280 281 typedef struct image_info { 282 ulong start, end; /* start/end of blob */ 283 ulong image_start, image_len; /* start of image within blob, len of image */ 284 ulong load; /* load addr for the image */ 285 uint8_t comp, type, os; /* compression, type of image, os type */ 286 uint8_t arch; /* CPU architecture */ 287 } image_info_t; 288 289 /* 290 * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() 291 * routines. 292 */ 293 typedef struct bootm_headers { 294 /* 295 * Legacy os image header, if it is a multi component image 296 * then boot_get_ramdisk() and get_fdt() will attempt to get 297 * data from second and third component accordingly. 298 */ 299 image_header_t *legacy_hdr_os; /* image header pointer */ 300 image_header_t legacy_hdr_os_copy; /* header copy */ 301 ulong legacy_hdr_valid; 302 303 #if defined(CONFIG_FIT) 304 const char *fit_uname_cfg; /* configuration node unit name */ 305 306 void *fit_hdr_os; /* os FIT image header */ 307 const char *fit_uname_os; /* os subimage node unit name */ 308 int fit_noffset_os; /* os subimage node offset */ 309 310 void *fit_hdr_rd; /* init ramdisk FIT image header */ 311 const char *fit_uname_rd; /* init ramdisk subimage node unit name */ 312 int fit_noffset_rd; /* init ramdisk subimage node offset */ 313 314 void *fit_hdr_fdt; /* FDT blob FIT image header */ 315 const char *fit_uname_fdt; /* FDT blob subimage node unit name */ 316 int fit_noffset_fdt;/* FDT blob subimage node offset */ 317 318 void *fit_hdr_setup; /* x86 setup FIT image header */ 319 const char *fit_uname_setup; /* x86 setup subimage node name */ 320 int fit_noffset_setup;/* x86 setup subimage node offset */ 321 #endif 322 323 #ifndef USE_HOSTCC 324 image_info_t os; /* os image info */ 325 ulong ep; /* entry point of OS */ 326 327 ulong rd_start, rd_end;/* ramdisk start/end */ 328 329 char *ft_addr; /* flat dev tree address */ 330 ulong ft_len; /* length of flat device tree */ 331 332 ulong initrd_start; 333 ulong initrd_end; 334 ulong cmdline_start; 335 ulong cmdline_end; 336 bd_t *kbd; 337 #endif 338 339 int verify; /* getenv("verify")[0] != 'n' */ 340 341 #define BOOTM_STATE_START (0x00000001) 342 #define BOOTM_STATE_FINDOS (0x00000002) 343 #define BOOTM_STATE_FINDOTHER (0x00000004) 344 #define BOOTM_STATE_LOADOS (0x00000008) 345 #define BOOTM_STATE_RAMDISK (0x00000010) 346 #define BOOTM_STATE_FDT (0x00000020) 347 #define BOOTM_STATE_OS_CMDLINE (0x00000040) 348 #define BOOTM_STATE_OS_BD_T (0x00000080) 349 #define BOOTM_STATE_OS_PREP (0x00000100) 350 #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */ 351 #define BOOTM_STATE_OS_GO (0x00000400) 352 int state; 353 354 #ifdef CONFIG_LMB 355 struct lmb lmb; /* for memory mgmt */ 356 #endif 357 } bootm_headers_t; 358 359 extern bootm_headers_t images; 360 361 /* 362 * Some systems (for example LWMON) have very short watchdog periods; 363 * we must make sure to split long operations like memmove() or 364 * checksum calculations into reasonable chunks. 365 */ 366 #ifndef CHUNKSZ 367 #define CHUNKSZ (64 * 1024) 368 #endif 369 370 #ifndef CHUNKSZ_CRC32 371 #define CHUNKSZ_CRC32 (64 * 1024) 372 #endif 373 374 #ifndef CHUNKSZ_MD5 375 #define CHUNKSZ_MD5 (64 * 1024) 376 #endif 377 378 #ifndef CHUNKSZ_SHA1 379 #define CHUNKSZ_SHA1 (64 * 1024) 380 #endif 381 382 #define uimage_to_cpu(x) be32_to_cpu(x) 383 #define cpu_to_uimage(x) cpu_to_be32(x) 384 385 /* 386 * Translation table for entries of a specific type; used by 387 * get_table_entry_id() and get_table_entry_name(). 388 */ 389 typedef struct table_entry { 390 int id; 391 char *sname; /* short (input) name to find table entry */ 392 char *lname; /* long (output) name to print for messages */ 393 } table_entry_t; 394 395 /* 396 * get_table_entry_id() scans the translation table trying to find an 397 * entry that matches the given short name. If a matching entry is 398 * found, it's id is returned to the caller. 399 */ 400 int get_table_entry_id(const table_entry_t *table, 401 const char *table_name, const char *name); 402 /* 403 * get_table_entry_name() scans the translation table trying to find 404 * an entry that matches the given id. If a matching entry is found, 405 * its long name is returned to the caller. 406 */ 407 char *get_table_entry_name(const table_entry_t *table, char *msg, int id); 408 409 const char *genimg_get_os_name(uint8_t os); 410 const char *genimg_get_arch_name(uint8_t arch); 411 const char *genimg_get_type_name(uint8_t type); 412 const char *genimg_get_comp_name(uint8_t comp); 413 int genimg_get_os_id(const char *name); 414 int genimg_get_arch_id(const char *name); 415 int genimg_get_type_id(const char *name); 416 int genimg_get_comp_id(const char *name); 417 void genimg_print_size(uint32_t size); 418 419 #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \ 420 defined(USE_HOSTCC) 421 #define IMAGE_ENABLE_TIMESTAMP 1 422 #else 423 #define IMAGE_ENABLE_TIMESTAMP 0 424 #endif 425 void genimg_print_time(time_t timestamp); 426 427 /* What to do with a image load address ('load = <> 'in the FIT) */ 428 enum fit_load_op { 429 FIT_LOAD_IGNORED, /* Ignore load address */ 430 FIT_LOAD_OPTIONAL, /* Can be provided, but optional */ 431 FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */ 432 FIT_LOAD_REQUIRED, /* Must be provided */ 433 }; 434 435 int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start, 436 ulong *setup_len); 437 438 #ifndef USE_HOSTCC 439 /* Image format types, returned by _get_format() routine */ 440 #define IMAGE_FORMAT_INVALID 0x00 441 #if defined(CONFIG_IMAGE_FORMAT_LEGACY) 442 #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 443 #endif 444 #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 445 #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */ 446 447 ulong genimg_get_kernel_addr_fit(char * const img_addr, 448 const char **fit_uname_config, 449 const char **fit_uname_kernel); 450 ulong genimg_get_kernel_addr(char * const img_addr); 451 int genimg_get_format(const void *img_addr); 452 int genimg_has_config(bootm_headers_t *images); 453 ulong genimg_get_image(ulong img_addr); 454 455 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images, 456 uint8_t arch, ulong *rd_start, ulong *rd_end); 457 #endif 458 459 int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch, 460 ulong *setup_start, ulong *setup_len); 461 462 /** 463 * fit_image_load() - load an image from a FIT 464 * 465 * This deals with all aspects of loading an image from a FIT, including 466 * selecting the right image based on configuration, verifying it, printing 467 * out progress messages, checking the type/arch/os and optionally copying it 468 * to the right load address. 469 * 470 * The property to look up is defined by image_type. 471 * 472 * @param images Boot images structure 473 * @param addr Address of FIT in memory 474 * @param fit_unamep On entry this is the requested image name 475 * (e.g. "kernel@1") or NULL to use the default. On exit 476 * points to the selected image name 477 * @param fit_uname_configp On entry this is the requested configuration 478 * name (e.g. "conf@1") or NULL to use the default. On 479 * exit points to the selected configuration name. 480 * @param arch Expected architecture (IH_ARCH_...) 481 * @param image_type Required image type (IH_TYPE_...). If this is 482 * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD 483 * also. 484 * @param bootstage_id ID of starting bootstage to use for progress updates. 485 * This will be added to the BOOTSTAGE_SUB values when 486 * calling bootstage_mark() 487 * @param load_op Decribes what to do with the load address 488 * @param datap Returns address of loaded image 489 * @param lenp Returns length of loaded image 490 * @return node offset of image, or -ve error code on error 491 */ 492 int fit_image_load(bootm_headers_t *images, ulong addr, 493 const char **fit_unamep, const char **fit_uname_configp, 494 int arch, int image_type, int bootstage_id, 495 enum fit_load_op load_op, ulong *datap, ulong *lenp); 496 497 #ifndef USE_HOSTCC 498 /** 499 * fit_get_node_from_config() - Look up an image a FIT by type 500 * 501 * This looks in the selected conf@ node (images->fit_uname_cfg) for a 502 * particular image type (e.g. "kernel") and then finds the image that is 503 * referred to. 504 * 505 * For example, for something like: 506 * 507 * images { 508 * kernel@1 { 509 * ... 510 * }; 511 * }; 512 * configurations { 513 * conf@1 { 514 * kernel = "kernel@1"; 515 * }; 516 * }; 517 * 518 * the function will return the node offset of the kernel@1 node, assuming 519 * that conf@1 is the chosen configuration. 520 * 521 * @param images Boot images structure 522 * @param prop_name Property name to look up (FIT_..._PROP) 523 * @param addr Address of FIT in memory 524 */ 525 int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name, 526 ulong addr); 527 528 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch, 529 bootm_headers_t *images, 530 char **of_flat_tree, ulong *of_size); 531 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob); 532 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size); 533 534 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len, 535 ulong *initrd_start, ulong *initrd_end); 536 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end); 537 #ifdef CONFIG_SYS_BOOT_GET_KBD 538 int boot_get_kbd(struct lmb *lmb, bd_t **kbd); 539 #endif /* CONFIG_SYS_BOOT_GET_KBD */ 540 #endif /* !USE_HOSTCC */ 541 542 /*******************************************************************/ 543 /* Legacy format specific code (prefixed with image_) */ 544 /*******************************************************************/ 545 static inline uint32_t image_get_header_size(void) 546 { 547 return (sizeof(image_header_t)); 548 } 549 550 #define image_get_hdr_l(f) \ 551 static inline uint32_t image_get_##f(const image_header_t *hdr) \ 552 { \ 553 return uimage_to_cpu(hdr->ih_##f); \ 554 } 555 image_get_hdr_l(magic) /* image_get_magic */ 556 image_get_hdr_l(hcrc) /* image_get_hcrc */ 557 image_get_hdr_l(time) /* image_get_time */ 558 image_get_hdr_l(size) /* image_get_size */ 559 image_get_hdr_l(load) /* image_get_load */ 560 image_get_hdr_l(ep) /* image_get_ep */ 561 image_get_hdr_l(dcrc) /* image_get_dcrc */ 562 563 #define image_get_hdr_b(f) \ 564 static inline uint8_t image_get_##f(const image_header_t *hdr) \ 565 { \ 566 return hdr->ih_##f; \ 567 } 568 image_get_hdr_b(os) /* image_get_os */ 569 image_get_hdr_b(arch) /* image_get_arch */ 570 image_get_hdr_b(type) /* image_get_type */ 571 image_get_hdr_b(comp) /* image_get_comp */ 572 573 static inline char *image_get_name(const image_header_t *hdr) 574 { 575 return (char *)hdr->ih_name; 576 } 577 578 static inline uint32_t image_get_data_size(const image_header_t *hdr) 579 { 580 return image_get_size(hdr); 581 } 582 583 /** 584 * image_get_data - get image payload start address 585 * @hdr: image header 586 * 587 * image_get_data() returns address of the image payload. For single 588 * component images it is image data start. For multi component 589 * images it points to the null terminated table of sub-images sizes. 590 * 591 * returns: 592 * image payload data start address 593 */ 594 static inline ulong image_get_data(const image_header_t *hdr) 595 { 596 return ((ulong)hdr + image_get_header_size()); 597 } 598 599 static inline uint32_t image_get_image_size(const image_header_t *hdr) 600 { 601 return (image_get_size(hdr) + image_get_header_size()); 602 } 603 static inline ulong image_get_image_end(const image_header_t *hdr) 604 { 605 return ((ulong)hdr + image_get_image_size(hdr)); 606 } 607 608 #define image_set_hdr_l(f) \ 609 static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ 610 { \ 611 hdr->ih_##f = cpu_to_uimage(val); \ 612 } 613 image_set_hdr_l(magic) /* image_set_magic */ 614 image_set_hdr_l(hcrc) /* image_set_hcrc */ 615 image_set_hdr_l(time) /* image_set_time */ 616 image_set_hdr_l(size) /* image_set_size */ 617 image_set_hdr_l(load) /* image_set_load */ 618 image_set_hdr_l(ep) /* image_set_ep */ 619 image_set_hdr_l(dcrc) /* image_set_dcrc */ 620 621 #define image_set_hdr_b(f) \ 622 static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ 623 { \ 624 hdr->ih_##f = val; \ 625 } 626 image_set_hdr_b(os) /* image_set_os */ 627 image_set_hdr_b(arch) /* image_set_arch */ 628 image_set_hdr_b(type) /* image_set_type */ 629 image_set_hdr_b(comp) /* image_set_comp */ 630 631 static inline void image_set_name(image_header_t *hdr, const char *name) 632 { 633 strncpy(image_get_name(hdr), name, IH_NMLEN); 634 } 635 636 int image_check_hcrc(const image_header_t *hdr); 637 int image_check_dcrc(const image_header_t *hdr); 638 #ifndef USE_HOSTCC 639 ulong getenv_bootm_low(void); 640 phys_size_t getenv_bootm_size(void); 641 phys_size_t getenv_bootm_mapsize(void); 642 #endif 643 void memmove_wd(void *to, void *from, size_t len, ulong chunksz); 644 645 static inline int image_check_magic(const image_header_t *hdr) 646 { 647 return (image_get_magic(hdr) == IH_MAGIC); 648 } 649 static inline int image_check_type(const image_header_t *hdr, uint8_t type) 650 { 651 return (image_get_type(hdr) == type); 652 } 653 static inline int image_check_arch(const image_header_t *hdr, uint8_t arch) 654 { 655 return (image_get_arch(hdr) == arch); 656 } 657 static inline int image_check_os(const image_header_t *hdr, uint8_t os) 658 { 659 return (image_get_os(hdr) == os); 660 } 661 662 ulong image_multi_count(const image_header_t *hdr); 663 void image_multi_getimg(const image_header_t *hdr, ulong idx, 664 ulong *data, ulong *len); 665 666 void image_print_contents(const void *hdr); 667 668 #ifndef USE_HOSTCC 669 static inline int image_check_target_arch(const image_header_t *hdr) 670 { 671 #ifndef IH_ARCH_DEFAULT 672 # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h" 673 #endif 674 return image_check_arch(hdr, IH_ARCH_DEFAULT); 675 } 676 #endif /* USE_HOSTCC */ 677 678 /** 679 * Set up properties in the FDT 680 * 681 * This sets up properties in the FDT that is to be passed to linux. 682 * 683 * @images: Images information 684 * @blob: FDT to update 685 * @of_size: Size of the FDT 686 * @lmb: Points to logical memory block structure 687 * @return 0 if ok, <0 on failure 688 */ 689 int image_setup_libfdt(bootm_headers_t *images, void *blob, 690 int of_size, struct lmb *lmb); 691 692 /** 693 * Set up the FDT to use for booting a kernel 694 * 695 * This performs ramdisk setup, sets up the FDT if required, and adds 696 * paramters to the FDT if libfdt is available. 697 * 698 * @param images Images information 699 * @return 0 if ok, <0 on failure 700 */ 701 int image_setup_linux(bootm_headers_t *images); 702 703 /** 704 * bootz_setup() - Extract stat and size of a Linux xImage 705 * 706 * @image: Address of image 707 * @start: Returns start address of image 708 * @end : Returns end address of image 709 * @return 0 if OK, 1 if the image was not recognised 710 */ 711 int bootz_setup(ulong image, ulong *start, ulong *end); 712 713 714 /*******************************************************************/ 715 /* New uImage format specific code (prefixed with fit_) */ 716 /*******************************************************************/ 717 #if defined(CONFIG_FIT) 718 719 #define FIT_IMAGES_PATH "/images" 720 #define FIT_CONFS_PATH "/configurations" 721 722 /* hash/signature node */ 723 #define FIT_HASH_NODENAME "hash" 724 #define FIT_ALGO_PROP "algo" 725 #define FIT_VALUE_PROP "value" 726 #define FIT_IGNORE_PROP "uboot-ignore" 727 #define FIT_SIG_NODENAME "signature" 728 729 /* image node */ 730 #define FIT_DATA_PROP "data" 731 #define FIT_TIMESTAMP_PROP "timestamp" 732 #define FIT_DESC_PROP "description" 733 #define FIT_ARCH_PROP "arch" 734 #define FIT_TYPE_PROP "type" 735 #define FIT_OS_PROP "os" 736 #define FIT_COMP_PROP "compression" 737 #define FIT_ENTRY_PROP "entry" 738 #define FIT_LOAD_PROP "load" 739 740 /* configuration node */ 741 #define FIT_KERNEL_PROP "kernel" 742 #define FIT_RAMDISK_PROP "ramdisk" 743 #define FIT_FDT_PROP "fdt" 744 #define FIT_DEFAULT_PROP "default" 745 #define FIT_SETUP_PROP "setup" 746 747 #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE 748 749 /* cmdline argument format parsing */ 750 int fit_parse_conf(const char *spec, ulong addr_curr, 751 ulong *addr, const char **conf_name); 752 int fit_parse_subimage(const char *spec, ulong addr_curr, 753 ulong *addr, const char **image_name); 754 755 int fit_get_subimage_count(const void *fit, int images_noffset); 756 void fit_print_contents(const void *fit); 757 void fit_image_print(const void *fit, int noffset, const char *p); 758 759 /** 760 * fit_get_end - get FIT image size 761 * @fit: pointer to the FIT format image header 762 * 763 * returns: 764 * size of the FIT image (blob) in memory 765 */ 766 static inline ulong fit_get_size(const void *fit) 767 { 768 return fdt_totalsize(fit); 769 } 770 771 /** 772 * fit_get_end - get FIT image end 773 * @fit: pointer to the FIT format image header 774 * 775 * returns: 776 * end address of the FIT image (blob) in memory 777 */ 778 static inline ulong fit_get_end(const void *fit) 779 { 780 return (ulong)fit + fdt_totalsize(fit); 781 } 782 783 /** 784 * fit_get_name - get FIT node name 785 * @fit: pointer to the FIT format image header 786 * 787 * returns: 788 * NULL, on error 789 * pointer to node name, on success 790 */ 791 static inline const char *fit_get_name(const void *fit_hdr, 792 int noffset, int *len) 793 { 794 return fdt_get_name(fit_hdr, noffset, len); 795 } 796 797 int fit_get_desc(const void *fit, int noffset, char **desc); 798 int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); 799 800 int fit_image_get_node(const void *fit, const char *image_uname); 801 int fit_image_get_os(const void *fit, int noffset, uint8_t *os); 802 int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); 803 int fit_image_get_type(const void *fit, int noffset, uint8_t *type); 804 int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); 805 int fit_image_get_load(const void *fit, int noffset, ulong *load); 806 int fit_image_get_entry(const void *fit, int noffset, ulong *entry); 807 int fit_image_get_data(const void *fit, int noffset, 808 const void **data, size_t *size); 809 810 int fit_image_hash_get_algo(const void *fit, int noffset, char **algo); 811 int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value, 812 int *value_len); 813 814 int fit_set_timestamp(void *fit, int noffset, time_t timestamp); 815 816 /** 817 * fit_add_verification_data() - add verification data to FIT image nodes 818 * 819 * @keydir: Directory containing keys 820 * @kwydest: FDT blob to write public key information to 821 * @fit: Pointer to the FIT format image header 822 * @comment: Comment to add to signature nodes 823 * @require_keys: Mark all keys as 'required' 824 * 825 * Adds hash values for all component images in the FIT blob. 826 * Hashes are calculated for all component images which have hash subnodes 827 * with algorithm property set to one of the supported hash algorithms. 828 * 829 * Also add signatures if signature nodes are present. 830 * 831 * returns 832 * 0, on success 833 * libfdt error code, on failure 834 */ 835 int fit_add_verification_data(const char *keydir, void *keydest, void *fit, 836 const char *comment, int require_keys); 837 838 int fit_image_verify(const void *fit, int noffset); 839 int fit_config_verify(const void *fit, int conf_noffset); 840 int fit_all_image_verify(const void *fit); 841 int fit_image_check_os(const void *fit, int noffset, uint8_t os); 842 int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); 843 int fit_image_check_type(const void *fit, int noffset, uint8_t type); 844 int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); 845 int fit_check_format(const void *fit); 846 847 int fit_conf_find_compat(const void *fit, const void *fdt); 848 int fit_conf_get_node(const void *fit, const char *conf_uname); 849 850 /** 851 * fit_conf_get_prop_node() - Get node refered to by a configuration 852 * @fit: FIT to check 853 * @noffset: Offset of conf@xxx node to check 854 * @prop_name: Property to read from the conf node 855 * 856 * The conf@ nodes contain references to other nodes, using properties 857 * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"), 858 * return the offset of the node referred to (e.g. offset of node 859 * "/images/kernel@1". 860 */ 861 int fit_conf_get_prop_node(const void *fit, int noffset, 862 const char *prop_name); 863 864 void fit_conf_print(const void *fit, int noffset, const char *p); 865 866 int fit_check_ramdisk(const void *fit, int os_noffset, 867 uint8_t arch, int verify); 868 869 int calculate_hash(const void *data, int data_len, const char *algo, 870 uint8_t *value, int *value_len); 871 872 /* 873 * At present we only support signing on the host, and verification on the 874 * device 875 */ 876 #if defined(CONFIG_FIT_SIGNATURE) 877 # ifdef USE_HOSTCC 878 # define IMAGE_ENABLE_SIGN 1 879 # define IMAGE_ENABLE_VERIFY 1 880 # include <openssl/evp.h> 881 #else 882 # define IMAGE_ENABLE_SIGN 0 883 # define IMAGE_ENABLE_VERIFY 1 884 # endif 885 #else 886 # define IMAGE_ENABLE_SIGN 0 887 # define IMAGE_ENABLE_VERIFY 0 888 #endif 889 890 #ifdef USE_HOSTCC 891 void *image_get_host_blob(void); 892 void image_set_host_blob(void *host_blob); 893 # define gd_fdt_blob() image_get_host_blob() 894 #else 895 # define gd_fdt_blob() (gd->fdt_blob) 896 #endif 897 898 #ifdef CONFIG_FIT_BEST_MATCH 899 #define IMAGE_ENABLE_BEST_MATCH 1 900 #else 901 #define IMAGE_ENABLE_BEST_MATCH 0 902 #endif 903 904 /* Information passed to the signing routines */ 905 struct image_sign_info { 906 const char *keydir; /* Directory conaining keys */ 907 const char *keyname; /* Name of key to use */ 908 void *fit; /* Pointer to FIT blob */ 909 int node_offset; /* Offset of signature node */ 910 struct image_sig_algo *algo; /* Algorithm information */ 911 const void *fdt_blob; /* FDT containing public keys */ 912 int required_keynode; /* Node offset of key to use: -1=any */ 913 const char *require_keys; /* Value for 'required' property */ 914 }; 915 916 /* A part of an image, used for hashing */ 917 struct image_region { 918 const void *data; 919 int size; 920 }; 921 922 #if IMAGE_ENABLE_VERIFY 923 # include <u-boot/rsa-checksum.h> 924 #endif 925 struct checksum_algo { 926 const char *name; 927 const int checksum_len; 928 const int pad_len; 929 #if IMAGE_ENABLE_SIGN 930 const EVP_MD *(*calculate_sign)(void); 931 #endif 932 int (*calculate)(const char *name, 933 const struct image_region region[], 934 int region_count, uint8_t *checksum); 935 const uint8_t *rsa_padding; 936 }; 937 938 struct image_sig_algo { 939 const char *name; /* Name of algorithm */ 940 941 /** 942 * sign() - calculate and return signature for given input data 943 * 944 * @info: Specifies key and FIT information 945 * @data: Pointer to the input data 946 * @data_len: Data length 947 * @sigp: Set to an allocated buffer holding the signature 948 * @sig_len: Set to length of the calculated hash 949 * 950 * This computes input data signature according to selected algorithm. 951 * Resulting signature value is placed in an allocated buffer, the 952 * pointer is returned as *sigp. The length of the calculated 953 * signature is returned via the sig_len pointer argument. The caller 954 * should free *sigp. 955 * 956 * @return: 0, on success, -ve on error 957 */ 958 int (*sign)(struct image_sign_info *info, 959 const struct image_region region[], 960 int region_count, uint8_t **sigp, uint *sig_len); 961 962 /** 963 * add_verify_data() - Add verification information to FDT 964 * 965 * Add public key information to the FDT node, suitable for 966 * verification at run-time. The information added depends on the 967 * algorithm being used. 968 * 969 * @info: Specifies key and FIT information 970 * @keydest: Destination FDT blob for public key data 971 * @return: 0, on success, -ve on error 972 */ 973 int (*add_verify_data)(struct image_sign_info *info, void *keydest); 974 975 /** 976 * verify() - Verify a signature against some data 977 * 978 * @info: Specifies key and FIT information 979 * @data: Pointer to the input data 980 * @data_len: Data length 981 * @sig: Signature 982 * @sig_len: Number of bytes in signature 983 * @return 0 if verified, -ve on error 984 */ 985 int (*verify)(struct image_sign_info *info, 986 const struct image_region region[], int region_count, 987 uint8_t *sig, uint sig_len); 988 989 /* pointer to checksum algorithm */ 990 struct checksum_algo *checksum; 991 }; 992 993 /** 994 * image_get_sig_algo() - Look up a signature algortihm 995 * 996 * @param name Name of algorithm 997 * @return pointer to algorithm information, or NULL if not found 998 */ 999 struct image_sig_algo *image_get_sig_algo(const char *name); 1000 1001 /** 1002 * fit_image_verify_required_sigs() - Verify signatures marked as 'required' 1003 * 1004 * @fit: FIT to check 1005 * @image_noffset: Offset of image node to check 1006 * @data: Image data to check 1007 * @size: Size of image data 1008 * @sig_blob: FDT containing public keys 1009 * @no_sigsp: Returns 1 if no signatures were required, and 1010 * therefore nothing was checked. The caller may wish 1011 * to fall back to other mechanisms, or refuse to 1012 * boot. 1013 * @return 0 if all verified ok, <0 on error 1014 */ 1015 int fit_image_verify_required_sigs(const void *fit, int image_noffset, 1016 const char *data, size_t size, const void *sig_blob, 1017 int *no_sigsp); 1018 1019 /** 1020 * fit_image_check_sig() - Check a single image signature node 1021 * 1022 * @fit: FIT to check 1023 * @noffset: Offset of signature node to check 1024 * @data: Image data to check 1025 * @size: Size of image data 1026 * @required_keynode: Offset in the control FDT of the required key node, 1027 * if any. If this is given, then the image wil not 1028 * pass verification unless that key is used. If this is 1029 * -1 then any signature will do. 1030 * @err_msgp: In the event of an error, this will be pointed to a 1031 * help error string to display to the user. 1032 * @return 0 if all verified ok, <0 on error 1033 */ 1034 int fit_image_check_sig(const void *fit, int noffset, const void *data, 1035 size_t size, int required_keynode, char **err_msgp); 1036 1037 /** 1038 * fit_region_make_list() - Make a list of regions to hash 1039 * 1040 * Given a list of FIT regions (offset, size) provided by libfdt, create 1041 * a list of regions (void *, size) for use by the signature creationg 1042 * and verification code. 1043 * 1044 * @fit: FIT image to process 1045 * @fdt_regions: Regions as returned by libfdt 1046 * @count: Number of regions returned by libfdt 1047 * @region: Place to put list of regions (NULL to allocate it) 1048 * @return pointer to list of regions, or NULL if out of memory 1049 */ 1050 struct image_region *fit_region_make_list(const void *fit, 1051 struct fdt_region *fdt_regions, int count, 1052 struct image_region *region); 1053 1054 static inline int fit_image_check_target_arch(const void *fdt, int node) 1055 { 1056 #ifndef USE_HOSTCC 1057 return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); 1058 #else 1059 return 0; 1060 #endif 1061 } 1062 1063 #ifdef CONFIG_FIT_VERBOSE 1064 #define fit_unsupported(msg) printf("! %s:%d " \ 1065 "FIT images not supported for '%s'\n", \ 1066 __FILE__, __LINE__, (msg)) 1067 1068 #define fit_unsupported_reset(msg) printf("! %s:%d " \ 1069 "FIT images not supported for '%s' " \ 1070 "- must reset board to recover!\n", \ 1071 __FILE__, __LINE__, (msg)) 1072 #else 1073 #define fit_unsupported(msg) 1074 #define fit_unsupported_reset(msg) 1075 #endif /* CONFIG_FIT_VERBOSE */ 1076 #endif /* CONFIG_FIT */ 1077 1078 #if defined(CONFIG_ANDROID_BOOT_IMAGE) 1079 struct andr_img_hdr; 1080 int android_image_check_header(const struct andr_img_hdr *hdr); 1081 int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify, 1082 ulong *os_data, ulong *os_len); 1083 int android_image_get_ramdisk(const struct andr_img_hdr *hdr, 1084 ulong *rd_data, ulong *rd_len); 1085 ulong android_image_get_end(const struct andr_img_hdr *hdr); 1086 ulong android_image_get_kload(const struct andr_img_hdr *hdr); 1087 1088 #endif /* CONFIG_ANDROID_BOOT_IMAGE */ 1089 1090 #endif /* __IMAGE_H__ */ 1091