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