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