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