15b1d7137Swdenk /* 2b97a2a0aSMarian Balakowicz * (C) Copyright 2008 Semihalf 3b97a2a0aSMarian Balakowicz * 4f08abe31SWolfgang Denk * (C) Copyright 2000-2005 55b1d7137Swdenk * Wolfgang Denk, DENX Software Engineering, wd@denx.de. 65b1d7137Swdenk * 71a459660SWolfgang Denk * SPDX-License-Identifier: GPL-2.0+ 8f08abe31SWolfgang Denk ******************************************************************** 9f08abe31SWolfgang Denk * NOTE: This header file defines an interface to U-Boot. Including 10f08abe31SWolfgang Denk * this (unmodified) header file in another file is considered normal 11f08abe31SWolfgang Denk * use of U-Boot, and does *not* fall under the heading of "derived 12f08abe31SWolfgang Denk * work". 13f08abe31SWolfgang Denk ******************************************************************** 145b1d7137Swdenk */ 155b1d7137Swdenk 165b1d7137Swdenk #ifndef __IMAGE_H__ 175b1d7137Swdenk #define __IMAGE_H__ 185b1d7137Swdenk 1937566090SMike Frysinger #include "compiler.h" 202f220500SKim Phillips #include <asm/byteorder.h> 2137566090SMike Frysinger 2213d06981SSimon Glass /* Define this to avoid #ifdefs later on */ 2313d06981SSimon Glass struct lmb; 2413d06981SSimon Glass 2537566090SMike Frysinger #ifdef USE_HOSTCC 2626e355d1SJörg Krause #include <sys/types.h> 279d25438fSBartlomiej Sieka 289d25438fSBartlomiej Sieka /* new uImage format support enabled on host */ 2973223f0eSSimon Glass #define IMAGE_ENABLE_FIT 1 30aa34fbc0SSimon Glass #define IMAGE_ENABLE_OF_LIBFDT 1 319d25438fSBartlomiej Sieka #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ 320db7f685STom Rini #define CONFIG_FIT_ENABLE_SHA256_SUPPORT 33089df18bSTom Rini #define CONFIG_SHA1 34089df18bSTom Rini #define CONFIG_SHA256 359d25438fSBartlomiej Sieka 36ab9efc66SSimon Glass #define IMAGE_ENABLE_IGNORE 0 371fe7d938SSimon Glass #define IMAGE_INDENT_STRING "" 38ab9efc66SSimon Glass 39def0819eSWolfgang Denk #else 40def0819eSWolfgang Denk 41def0819eSWolfgang Denk #include <lmb.h> 42def0819eSWolfgang Denk #include <asm/u-boot.h> 435daa1c18SMike Frysinger #include <command.h> 44def0819eSWolfgang Denk 45ab9efc66SSimon Glass /* Take notice of the 'ignore' property for hashes */ 46ab9efc66SSimon Glass #define IMAGE_ENABLE_IGNORE 1 471fe7d938SSimon Glass #define IMAGE_INDENT_STRING " " 48ab9efc66SSimon Glass 4973223f0eSSimon Glass #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT) 50aa34fbc0SSimon Glass #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT) 5173223f0eSSimon Glass 529d25438fSBartlomiej Sieka #endif /* USE_HOSTCC */ 53d5934ad7SMarian Balakowicz 5473223f0eSSimon Glass #if IMAGE_ENABLE_FIT 551de7bb4fSMichael van der Westhuizen #include <hash.h> 565dfb5213SMarian Balakowicz #include <libfdt.h> 575dfb5213SMarian Balakowicz #include <fdt_support.h> 5887ebee39SSimon Glass # ifdef CONFIG_SPL_BUILD 596f41751fSMasahiro Yamada # ifdef CONFIG_SPL_CRC32_SUPPORT 606f41751fSMasahiro Yamada # define IMAGE_ENABLE_CRC32 1 616f41751fSMasahiro Yamada # endif 626f41751fSMasahiro Yamada # ifdef CONFIG_SPL_MD5_SUPPORT 636f41751fSMasahiro Yamada # define IMAGE_ENABLE_MD5 1 646f41751fSMasahiro Yamada # endif 656f41751fSMasahiro Yamada # ifdef CONFIG_SPL_SHA1_SUPPORT 666f41751fSMasahiro Yamada # define IMAGE_ENABLE_SHA1 1 676f41751fSMasahiro Yamada # endif 6887ebee39SSimon Glass # else 6987ebee39SSimon Glass # define CONFIG_CRC32 /* FIT images need CRC32 support */ 7087ebee39SSimon Glass # define IMAGE_ENABLE_CRC32 1 7187ebee39SSimon Glass # define IMAGE_ENABLE_MD5 1 7287ebee39SSimon Glass # define IMAGE_ENABLE_SHA1 1 736f41751fSMasahiro Yamada # endif 746f41751fSMasahiro Yamada 756f41751fSMasahiro Yamada #ifndef IMAGE_ENABLE_CRC32 766f41751fSMasahiro Yamada #define IMAGE_ENABLE_CRC32 0 776f41751fSMasahiro Yamada #endif 786f41751fSMasahiro Yamada 796f41751fSMasahiro Yamada #ifndef IMAGE_ENABLE_MD5 806f41751fSMasahiro Yamada #define IMAGE_ENABLE_MD5 0 816f41751fSMasahiro Yamada #endif 826f41751fSMasahiro Yamada 836f41751fSMasahiro Yamada #ifndef IMAGE_ENABLE_SHA1 846f41751fSMasahiro Yamada #define IMAGE_ENABLE_SHA1 0 856f41751fSMasahiro Yamada #endif 866f41751fSMasahiro Yamada 870db7f685STom Rini #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \ 880db7f685STom Rini defined(CONFIG_SPL_SHA256_SUPPORT) 890db7f685STom Rini #define IMAGE_ENABLE_SHA256 1 900db7f685STom Rini #else 916f41751fSMasahiro Yamada #define IMAGE_ENABLE_SHA256 0 926f41751fSMasahiro Yamada #endif 936f41751fSMasahiro Yamada 9473223f0eSSimon Glass #endif /* IMAGE_ENABLE_FIT */ 9513d06981SSimon Glass 966f41751fSMasahiro Yamada #ifdef CONFIG_SYS_BOOT_GET_CMDLINE 976f41751fSMasahiro Yamada # define IMAGE_BOOT_GET_CMDLINE 1 986f41751fSMasahiro Yamada #else 996f41751fSMasahiro Yamada # define IMAGE_BOOT_GET_CMDLINE 0 1006f41751fSMasahiro Yamada #endif 1016f41751fSMasahiro Yamada 1026f41751fSMasahiro Yamada #ifdef CONFIG_OF_BOARD_SETUP 1036f41751fSMasahiro Yamada # define IMAGE_OF_BOARD_SETUP 1 1046f41751fSMasahiro Yamada #else 1056f41751fSMasahiro Yamada # define IMAGE_OF_BOARD_SETUP 0 1066f41751fSMasahiro Yamada #endif 1076f41751fSMasahiro Yamada 1086f41751fSMasahiro Yamada #ifdef CONFIG_OF_SYSTEM_SETUP 1096f41751fSMasahiro Yamada # define IMAGE_OF_SYSTEM_SETUP 1 1106f41751fSMasahiro Yamada #else 1116f41751fSMasahiro Yamada # define IMAGE_OF_SYSTEM_SETUP 0 1126f41751fSMasahiro Yamada #endif 113c654b517SSimon Glass 11456d7ab74SSimon Glass enum ih_category { 11556d7ab74SSimon Glass IH_ARCH, 11656d7ab74SSimon Glass IH_COMP, 11756d7ab74SSimon Glass IH_OS, 11856d7ab74SSimon Glass IH_TYPE, 11956d7ab74SSimon Glass 12056d7ab74SSimon Glass IH_COUNT, 12156d7ab74SSimon Glass }; 12256d7ab74SSimon Glass 1235b1d7137Swdenk /* 1245b1d7137Swdenk * Operating System Codes 125ff87b081SMasahiro Yamada * 126ff87b081SMasahiro Yamada * The following are exposed to uImage header. 127ff87b081SMasahiro Yamada * Do not change values for backward compatibility. 1285b1d7137Swdenk */ 129555f45d8SSimon Glass enum { 130555f45d8SSimon Glass IH_OS_INVALID = 0, /* Invalid OS */ 131555f45d8SSimon Glass IH_OS_OPENBSD, /* OpenBSD */ 132555f45d8SSimon Glass IH_OS_NETBSD, /* NetBSD */ 133555f45d8SSimon Glass IH_OS_FREEBSD, /* FreeBSD */ 134555f45d8SSimon Glass IH_OS_4_4BSD, /* 4.4BSD */ 135555f45d8SSimon Glass IH_OS_LINUX, /* Linux */ 136555f45d8SSimon Glass IH_OS_SVR4, /* SVR4 */ 137555f45d8SSimon Glass IH_OS_ESIX, /* Esix */ 138555f45d8SSimon Glass IH_OS_SOLARIS, /* Solaris */ 139555f45d8SSimon Glass IH_OS_IRIX, /* Irix */ 140555f45d8SSimon Glass IH_OS_SCO, /* SCO */ 141555f45d8SSimon Glass IH_OS_DELL, /* Dell */ 142555f45d8SSimon Glass IH_OS_NCR, /* NCR */ 143555f45d8SSimon Glass IH_OS_LYNXOS, /* LynxOS */ 144555f45d8SSimon Glass IH_OS_VXWORKS, /* VxWorks */ 145555f45d8SSimon Glass IH_OS_PSOS, /* pSOS */ 146555f45d8SSimon Glass IH_OS_QNX, /* QNX */ 147555f45d8SSimon Glass IH_OS_U_BOOT, /* Firmware */ 148555f45d8SSimon Glass IH_OS_RTEMS, /* RTEMS */ 149555f45d8SSimon Glass IH_OS_ARTOS, /* ARTOS */ 150555f45d8SSimon Glass IH_OS_UNITY, /* Unity OS */ 151555f45d8SSimon Glass IH_OS_INTEGRITY, /* INTEGRITY */ 152555f45d8SSimon Glass IH_OS_OSE, /* OSE */ 153555f45d8SSimon Glass IH_OS_PLAN9, /* Plan 9 */ 154555f45d8SSimon Glass IH_OS_OPENRTOS, /* OpenRTOS */ 155555f45d8SSimon Glass 156555f45d8SSimon Glass IH_OS_COUNT, 157555f45d8SSimon Glass }; 1585b1d7137Swdenk 1595b1d7137Swdenk /* 1605b1d7137Swdenk * CPU Architecture Codes (supported by Linux) 161ff87b081SMasahiro Yamada * 162ff87b081SMasahiro Yamada * The following are exposed to uImage header. 163ff87b081SMasahiro Yamada * Do not change values for backward compatibility. 1645b1d7137Swdenk */ 165555f45d8SSimon Glass enum { 166555f45d8SSimon Glass IH_ARCH_INVALID = 0, /* Invalid CPU */ 167555f45d8SSimon Glass IH_ARCH_ALPHA, /* Alpha */ 168555f45d8SSimon Glass IH_ARCH_ARM, /* ARM */ 169555f45d8SSimon Glass IH_ARCH_I386, /* Intel x86 */ 170555f45d8SSimon Glass IH_ARCH_IA64, /* IA64 */ 171555f45d8SSimon Glass IH_ARCH_MIPS, /* MIPS */ 172555f45d8SSimon Glass IH_ARCH_MIPS64, /* MIPS 64 Bit */ 173555f45d8SSimon Glass IH_ARCH_PPC, /* PowerPC */ 174555f45d8SSimon Glass IH_ARCH_S390, /* IBM S390 */ 175555f45d8SSimon Glass IH_ARCH_SH, /* SuperH */ 176555f45d8SSimon Glass IH_ARCH_SPARC, /* Sparc */ 177555f45d8SSimon Glass IH_ARCH_SPARC64, /* Sparc 64 Bit */ 178555f45d8SSimon Glass IH_ARCH_M68K, /* M68K */ 179ff87b081SMasahiro Yamada IH_ARCH_NIOS, /* Nios-32 */ 180555f45d8SSimon Glass IH_ARCH_MICROBLAZE, /* MicroBlaze */ 181555f45d8SSimon Glass IH_ARCH_NIOS2, /* Nios-II */ 182555f45d8SSimon Glass IH_ARCH_BLACKFIN, /* Blackfin */ 183555f45d8SSimon Glass IH_ARCH_AVR32, /* AVR32 */ 184555f45d8SSimon Glass IH_ARCH_ST200, /* STMicroelectronics ST200 */ 185555f45d8SSimon Glass IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */ 186555f45d8SSimon Glass IH_ARCH_NDS32, /* ANDES Technology - NDS32 */ 187555f45d8SSimon Glass IH_ARCH_OPENRISC, /* OpenRISC 1000 */ 188555f45d8SSimon Glass IH_ARCH_ARM64, /* ARM64 */ 189555f45d8SSimon Glass IH_ARCH_ARC, /* Synopsys DesignWare ARC */ 190555f45d8SSimon Glass IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */ 191de5e5ceaSChris Zankel IH_ARCH_XTENSA, /* Xtensa */ 192555f45d8SSimon Glass 193555f45d8SSimon Glass IH_ARCH_COUNT, 194555f45d8SSimon Glass }; 1955b1d7137Swdenk 1965b1d7137Swdenk /* 1975b1d7137Swdenk * Image Types 1985b1d7137Swdenk * 1995b1d7137Swdenk * "Standalone Programs" are directly runnable in the environment 2005b1d7137Swdenk * provided by U-Boot; it is expected that (if they behave 2015b1d7137Swdenk * well) you can continue to work in U-Boot after return from 2025b1d7137Swdenk * the Standalone Program. 2035b1d7137Swdenk * "OS Kernel Images" are usually images of some Embedded OS which 2045b1d7137Swdenk * will take over control completely. Usually these programs 2055b1d7137Swdenk * will install their own set of exception handlers, device 2065b1d7137Swdenk * drivers, set up the MMU, etc. - this means, that you cannot 2075b1d7137Swdenk * expect to re-enter U-Boot except by resetting the CPU. 2085b1d7137Swdenk * "RAMDisk Images" are more or less just data blocks, and their 2095b1d7137Swdenk * parameters (address, size) are passed to an OS kernel that is 2105b1d7137Swdenk * being started. 2115b1d7137Swdenk * "Multi-File Images" contain several images, typically an OS 2125b1d7137Swdenk * (Linux) kernel image and one or more data images like 2135b1d7137Swdenk * RAMDisks. This construct is useful for instance when you want 2145b1d7137Swdenk * to boot over the network using BOOTP etc., where the boot 2155b1d7137Swdenk * server provides just a single image file, but you want to get 2165b1d7137Swdenk * for instance an OS kernel and a RAMDisk image. 2175b1d7137Swdenk * 2185b1d7137Swdenk * "Multi-File Images" start with a list of image sizes, each 2195b1d7137Swdenk * image size (in bytes) specified by an "uint32_t" in network 2205b1d7137Swdenk * byte order. This list is terminated by an "(uint32_t)0". 2215b1d7137Swdenk * Immediately after the terminating 0 follow the images, one by 2225b1d7137Swdenk * one, all aligned on "uint32_t" boundaries (size rounded up to 223e1599e83Swdenk * a multiple of 4 bytes - except for the last file). 2245b1d7137Swdenk * 2255b1d7137Swdenk * "Firmware Images" are binary images containing firmware (like 2265b1d7137Swdenk * U-Boot or FPGA images) which usually will be programmed to 2275b1d7137Swdenk * flash memory. 2285b1d7137Swdenk * 2295b1d7137Swdenk * "Script files" are command sequences that will be executed by 2305b1d7137Swdenk * U-Boot's command interpreter; this feature is especially 2315b1d7137Swdenk * useful when you configure U-Boot to use a real shell (hush) 23227b207fdSwdenk * as command interpreter (=> Shell Scripts). 233ff87b081SMasahiro Yamada * 234ff87b081SMasahiro Yamada * The following are exposed to uImage header. 235ff87b081SMasahiro Yamada * Do not change values for backward compatibility. 2365b1d7137Swdenk */ 2375b1d7137Swdenk 238555f45d8SSimon Glass enum { 239555f45d8SSimon Glass IH_TYPE_INVALID = 0, /* Invalid Image */ 240555f45d8SSimon Glass IH_TYPE_STANDALONE, /* Standalone Program */ 241555f45d8SSimon Glass IH_TYPE_KERNEL, /* OS Kernel Image */ 242555f45d8SSimon Glass IH_TYPE_RAMDISK, /* RAMDisk Image */ 243555f45d8SSimon Glass IH_TYPE_MULTI, /* Multi-File Image */ 244555f45d8SSimon Glass IH_TYPE_FIRMWARE, /* Firmware Image */ 245555f45d8SSimon Glass IH_TYPE_SCRIPT, /* Script file */ 246555f45d8SSimon Glass IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */ 247555f45d8SSimon Glass IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */ 248555f45d8SSimon Glass IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */ 249555f45d8SSimon Glass IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */ 250555f45d8SSimon Glass IH_TYPE_UBLIMAGE, /* Davinci UBL Image */ 251555f45d8SSimon Glass IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */ 252555f45d8SSimon Glass IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */ 253555f45d8SSimon Glass /* OS Kernel Image, can run from any load address */ 254555f45d8SSimon Glass IH_TYPE_KERNEL_NOLOAD, 255555f45d8SSimon Glass IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */ 256555f45d8SSimon Glass IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */ 257555f45d8SSimon Glass IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */ 258555f45d8SSimon Glass IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */ 259555f45d8SSimon Glass IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */ 260555f45d8SSimon Glass IH_TYPE_X86_SETUP, /* x86 setup.bin Image */ 261555f45d8SSimon Glass IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */ 262555f45d8SSimon Glass IH_TYPE_LOADABLE, /* A list of typeless images */ 263555f45d8SSimon Glass IH_TYPE_RKIMAGE, /* Rockchip Boot Image */ 264555f45d8SSimon Glass IH_TYPE_RKSD, /* Rockchip SD card */ 265555f45d8SSimon Glass IH_TYPE_RKSPI, /* Rockchip SPI image */ 266555f45d8SSimon Glass IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */ 267555f45d8SSimon Glass IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */ 268555f45d8SSimon Glass IH_TYPE_FPGA, /* FPGA Image */ 269ed0c2c0aSAlbert ARIBAUD \(3ADEV\) IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */ 2707e719ee7SAndrew F. Davis IH_TYPE_TEE, /* Trusted Execution Environment OS Image */ 271d21bd69bSSven Ebenfeld IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */ 272*ee0f94feSAndrew F. Davis IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */ 2736f14746bSPaweł Jarosz IH_TYPE_RKNAND, /* Rockchip NAND Boot Image */ 2745b1d7137Swdenk 275555f45d8SSimon Glass IH_TYPE_COUNT, /* Number of image types */ 276555f45d8SSimon Glass }; 2775b9d44dfSSimon Glass 2785b1d7137Swdenk /* 2795b1d7137Swdenk * Compression Types 280ff87b081SMasahiro Yamada * 281ff87b081SMasahiro Yamada * The following are exposed to uImage header. 282ff87b081SMasahiro Yamada * Do not change values for backward compatibility. 2835b1d7137Swdenk */ 284555f45d8SSimon Glass enum { 285555f45d8SSimon Glass IH_COMP_NONE = 0, /* No Compression Used */ 286555f45d8SSimon Glass IH_COMP_GZIP, /* gzip Compression Used */ 287555f45d8SSimon Glass IH_COMP_BZIP2, /* bzip2 Compression Used */ 288555f45d8SSimon Glass IH_COMP_LZMA, /* lzma Compression Used */ 289555f45d8SSimon Glass IH_COMP_LZO, /* lzo Compression Used */ 290555f45d8SSimon Glass IH_COMP_LZ4, /* lz4 Compression Used */ 291555f45d8SSimon Glass 292555f45d8SSimon Glass IH_COMP_COUNT, 293555f45d8SSimon Glass }; 2945b1d7137Swdenk 2955b1d7137Swdenk #define IH_MAGIC 0x27051956 /* Image Magic Number */ 2965b1d7137Swdenk #define IH_NMLEN 32 /* Image Name Length */ 2975b1d7137Swdenk 2981411fb37SFabio Estevam /* Reused from common.h */ 2991411fb37SFabio Estevam #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1)) 3001411fb37SFabio Estevam 3015b1d7137Swdenk /* 3029a4daad0SMarian Balakowicz * Legacy format image header, 3039a4daad0SMarian Balakowicz * all data in network byte order (aka natural aka bigendian). 3045b1d7137Swdenk */ 3055b1d7137Swdenk typedef struct image_header { 3062f220500SKim Phillips __be32 ih_magic; /* Image Header Magic Number */ 3072f220500SKim Phillips __be32 ih_hcrc; /* Image Header CRC Checksum */ 3082f220500SKim Phillips __be32 ih_time; /* Image Creation Timestamp */ 3092f220500SKim Phillips __be32 ih_size; /* Image Data Size */ 3102f220500SKim Phillips __be32 ih_load; /* Data Load Address */ 3112f220500SKim Phillips __be32 ih_ep; /* Entry Point Address */ 3122f220500SKim Phillips __be32 ih_dcrc; /* Image Data CRC Checksum */ 3135b1d7137Swdenk uint8_t ih_os; /* Operating System */ 3145b1d7137Swdenk uint8_t ih_arch; /* CPU architecture */ 3155b1d7137Swdenk uint8_t ih_type; /* Image Type */ 3165b1d7137Swdenk uint8_t ih_comp; /* Compression Type */ 3175b1d7137Swdenk uint8_t ih_name[IH_NMLEN]; /* Image Name */ 3185b1d7137Swdenk } image_header_t; 3195b1d7137Swdenk 320396f635bSKumar Gala typedef struct image_info { 321396f635bSKumar Gala ulong start, end; /* start/end of blob */ 322396f635bSKumar Gala ulong image_start, image_len; /* start of image within blob, len of image */ 323396f635bSKumar Gala ulong load; /* load addr for the image */ 324396f635bSKumar Gala uint8_t comp, type, os; /* compression, type of image, os type */ 32590268b87SSimon Glass uint8_t arch; /* CPU architecture */ 326396f635bSKumar Gala } image_info_t; 327396f635bSKumar Gala 328559316faSMarian Balakowicz /* 329d5934ad7SMarian Balakowicz * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() 330d5934ad7SMarian Balakowicz * routines. 331d5934ad7SMarian Balakowicz */ 332d5934ad7SMarian Balakowicz typedef struct bootm_headers { 333d5934ad7SMarian Balakowicz /* 334d5934ad7SMarian Balakowicz * Legacy os image header, if it is a multi component image 3359a4daad0SMarian Balakowicz * then boot_get_ramdisk() and get_fdt() will attempt to get 336d5934ad7SMarian Balakowicz * data from second and third component accordingly. 337d5934ad7SMarian Balakowicz */ 338cb1c4896SMarian Balakowicz image_header_t *legacy_hdr_os; /* image header pointer */ 339cb1c4896SMarian Balakowicz image_header_t legacy_hdr_os_copy; /* header copy */ 340d5934ad7SMarian Balakowicz ulong legacy_hdr_valid; 341d5934ad7SMarian Balakowicz 34273223f0eSSimon Glass #if IMAGE_ENABLE_FIT 343f773bea8SMarian Balakowicz const char *fit_uname_cfg; /* configuration node unit name */ 344f773bea8SMarian Balakowicz 345d5934ad7SMarian Balakowicz void *fit_hdr_os; /* os FIT image header */ 346eb6175edSMarian Balakowicz const char *fit_uname_os; /* os subimage node unit name */ 3473dfe1101SMarian Balakowicz int fit_noffset_os; /* os subimage node offset */ 348d5934ad7SMarian Balakowicz 349d5934ad7SMarian Balakowicz void *fit_hdr_rd; /* init ramdisk FIT image header */ 3503dfe1101SMarian Balakowicz const char *fit_uname_rd; /* init ramdisk subimage node unit name */ 3513dfe1101SMarian Balakowicz int fit_noffset_rd; /* init ramdisk subimage node offset */ 352d5934ad7SMarian Balakowicz 353d5934ad7SMarian Balakowicz void *fit_hdr_fdt; /* FDT blob FIT image header */ 3543dfe1101SMarian Balakowicz const char *fit_uname_fdt; /* FDT blob subimage node unit name */ 3553dfe1101SMarian Balakowicz int fit_noffset_fdt;/* FDT blob subimage node offset */ 35690268b87SSimon Glass 35790268b87SSimon Glass void *fit_hdr_setup; /* x86 setup FIT image header */ 35890268b87SSimon Glass const char *fit_uname_setup; /* x86 setup subimage node name */ 35990268b87SSimon Glass int fit_noffset_setup;/* x86 setup subimage node offset */ 360d5934ad7SMarian Balakowicz #endif 3611ec73761SMarian Balakowicz 36249c3a861SKumar Gala #ifndef USE_HOSTCC 363396f635bSKumar Gala image_info_t os; /* os image info */ 364c160a954SKumar Gala ulong ep; /* entry point of OS */ 365c160a954SKumar Gala 366c4f9419cSKumar Gala ulong rd_start, rd_end;/* ramdisk start/end */ 367c4f9419cSKumar Gala 36806a09918SKumar Gala char *ft_addr; /* flat dev tree address */ 36906a09918SKumar Gala ulong ft_len; /* length of flat device tree */ 37006a09918SKumar Gala 37149c3a861SKumar Gala ulong initrd_start; 37249c3a861SKumar Gala ulong initrd_end; 37349c3a861SKumar Gala ulong cmdline_start; 37449c3a861SKumar Gala ulong cmdline_end; 37549c3a861SKumar Gala bd_t *kbd; 37649c3a861SKumar Gala #endif 37749c3a861SKumar Gala 37800caae6dSSimon Glass int verify; /* env_get("verify")[0] != 'n' */ 37949c3a861SKumar Gala 38049c3a861SKumar Gala #define BOOTM_STATE_START (0x00000001) 38135fc84faSSimon Glass #define BOOTM_STATE_FINDOS (0x00000002) 38235fc84faSSimon Glass #define BOOTM_STATE_FINDOTHER (0x00000004) 38335fc84faSSimon Glass #define BOOTM_STATE_LOADOS (0x00000008) 38435fc84faSSimon Glass #define BOOTM_STATE_RAMDISK (0x00000010) 38535fc84faSSimon Glass #define BOOTM_STATE_FDT (0x00000020) 38635fc84faSSimon Glass #define BOOTM_STATE_OS_CMDLINE (0x00000040) 38735fc84faSSimon Glass #define BOOTM_STATE_OS_BD_T (0x00000080) 38835fc84faSSimon Glass #define BOOTM_STATE_OS_PREP (0x00000100) 389d0ae31ebSSimon Glass #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */ 390d0ae31ebSSimon Glass #define BOOTM_STATE_OS_GO (0x00000400) 39149c3a861SKumar Gala int state; 39249c3a861SKumar Gala 393a16028daSMike Frysinger #ifdef CONFIG_LMB 394e906cfaeSKumar Gala struct lmb lmb; /* for memory mgmt */ 395e906cfaeSKumar Gala #endif 396d5934ad7SMarian Balakowicz } bootm_headers_t; 397d5934ad7SMarian Balakowicz 3981648a375SSimon Schwarz extern bootm_headers_t images; 3991648a375SSimon Schwarz 400d5934ad7SMarian Balakowicz /* 401559316faSMarian Balakowicz * Some systems (for example LWMON) have very short watchdog periods; 402559316faSMarian Balakowicz * we must make sure to split long operations like memmove() or 4037590378fSBartlomiej Sieka * checksum calculations into reasonable chunks. 404559316faSMarian Balakowicz */ 4057590378fSBartlomiej Sieka #ifndef CHUNKSZ 406559316faSMarian Balakowicz #define CHUNKSZ (64 * 1024) 4077590378fSBartlomiej Sieka #endif 4087590378fSBartlomiej Sieka 4097590378fSBartlomiej Sieka #ifndef CHUNKSZ_CRC32 4107590378fSBartlomiej Sieka #define CHUNKSZ_CRC32 (64 * 1024) 4117590378fSBartlomiej Sieka #endif 4127590378fSBartlomiej Sieka 4137590378fSBartlomiej Sieka #ifndef CHUNKSZ_MD5 4147590378fSBartlomiej Sieka #define CHUNKSZ_MD5 (64 * 1024) 4157590378fSBartlomiej Sieka #endif 4167590378fSBartlomiej Sieka 4177590378fSBartlomiej Sieka #ifndef CHUNKSZ_SHA1 4187590378fSBartlomiej Sieka #define CHUNKSZ_SHA1 (64 * 1024) 4197590378fSBartlomiej Sieka #endif 420559316faSMarian Balakowicz 42137566090SMike Frysinger #define uimage_to_cpu(x) be32_to_cpu(x) 42237566090SMike Frysinger #define cpu_to_uimage(x) cpu_to_be32(x) 423b97a2a0aSMarian Balakowicz 424b029dddcSPrafulla Wadaskar /* 425b029dddcSPrafulla Wadaskar * Translation table for entries of a specific type; used by 426b029dddcSPrafulla Wadaskar * get_table_entry_id() and get_table_entry_name(). 427b029dddcSPrafulla Wadaskar */ 428b029dddcSPrafulla Wadaskar typedef struct table_entry { 429b029dddcSPrafulla Wadaskar int id; 430b029dddcSPrafulla Wadaskar char *sname; /* short (input) name to find table entry */ 431b029dddcSPrafulla Wadaskar char *lname; /* long (output) name to print for messages */ 432b029dddcSPrafulla Wadaskar } table_entry_t; 433b029dddcSPrafulla Wadaskar 434b029dddcSPrafulla Wadaskar /* 435b029dddcSPrafulla Wadaskar * get_table_entry_id() scans the translation table trying to find an 436b029dddcSPrafulla Wadaskar * entry that matches the given short name. If a matching entry is 437b029dddcSPrafulla Wadaskar * found, it's id is returned to the caller. 438b029dddcSPrafulla Wadaskar */ 4397edb186fSMike Frysinger int get_table_entry_id(const table_entry_t *table, 440b029dddcSPrafulla Wadaskar const char *table_name, const char *name); 441b029dddcSPrafulla Wadaskar /* 442b029dddcSPrafulla Wadaskar * get_table_entry_name() scans the translation table trying to find 443b029dddcSPrafulla Wadaskar * an entry that matches the given id. If a matching entry is found, 444b029dddcSPrafulla Wadaskar * its long name is returned to the caller. 445b029dddcSPrafulla Wadaskar */ 4467edb186fSMike Frysinger char *get_table_entry_name(const table_entry_t *table, char *msg, int id); 447b029dddcSPrafulla Wadaskar 448570abb0aSMarian Balakowicz const char *genimg_get_os_name(uint8_t os); 449cef2e514SSimon Glass 450cef2e514SSimon Glass /** 451cef2e514SSimon Glass * genimg_get_os_short_name() - get the short name for an OS 452cef2e514SSimon Glass * 453cef2e514SSimon Glass * @param os OS (IH_OS_...) 454cef2e514SSimon Glass * @return OS short name, or "unknown" if unknown 455cef2e514SSimon Glass */ 456cef2e514SSimon Glass const char *genimg_get_os_short_name(uint8_t comp); 457cef2e514SSimon Glass 458570abb0aSMarian Balakowicz const char *genimg_get_arch_name(uint8_t arch); 459cef2e514SSimon Glass 460cef2e514SSimon Glass /** 461cef2e514SSimon Glass * genimg_get_arch_short_name() - get the short name for an architecture 462cef2e514SSimon Glass * 463cef2e514SSimon Glass * @param arch Architecture type (IH_ARCH_...) 464cef2e514SSimon Glass * @return architecture short name, or "unknown" if unknown 465cef2e514SSimon Glass */ 466cef2e514SSimon Glass const char *genimg_get_arch_short_name(uint8_t arch); 467cef2e514SSimon Glass 468570abb0aSMarian Balakowicz const char *genimg_get_type_name(uint8_t type); 4695b9d44dfSSimon Glass 4705b9d44dfSSimon Glass /** 4715b9d44dfSSimon Glass * genimg_get_type_short_name() - get the short name for an image type 4725b9d44dfSSimon Glass * 4735b9d44dfSSimon Glass * @param type Image type (IH_TYPE_...) 4745b9d44dfSSimon Glass * @return image short name, or "unknown" if unknown 4755b9d44dfSSimon Glass */ 4765b9d44dfSSimon Glass const char *genimg_get_type_short_name(uint8_t type); 4775b9d44dfSSimon Glass 478570abb0aSMarian Balakowicz const char *genimg_get_comp_name(uint8_t comp); 479cef2e514SSimon Glass 480cef2e514SSimon Glass /** 481cef2e514SSimon Glass * genimg_get_comp_short_name() - get the short name for a compression method 482cef2e514SSimon Glass * 483cef2e514SSimon Glass * @param comp compression method (IH_COMP_...) 484cef2e514SSimon Glass * @return compression method short name, or "unknown" if unknown 485cef2e514SSimon Glass */ 486cef2e514SSimon Glass const char *genimg_get_comp_short_name(uint8_t comp); 487cef2e514SSimon Glass 4881426220bSSimon Glass /** 4891426220bSSimon Glass * genimg_get_cat_name() - Get the name of an item in a category 4901426220bSSimon Glass * 4911426220bSSimon Glass * @category: Category of item 4921426220bSSimon Glass * @id: Item ID 4931426220bSSimon Glass * @return name of item, or "Unknown ..." if unknown 4941426220bSSimon Glass */ 4951426220bSSimon Glass const char *genimg_get_cat_name(enum ih_category category, uint id); 4961426220bSSimon Glass 4971426220bSSimon Glass /** 4981426220bSSimon Glass * genimg_get_cat_short_name() - Get the short name of an item in a category 4991426220bSSimon Glass * 5001426220bSSimon Glass * @category: Category of item 5011426220bSSimon Glass * @id: Item ID 5021426220bSSimon Glass * @return short name of item, or "Unknown ..." if unknown 5031426220bSSimon Glass */ 5041426220bSSimon Glass const char *genimg_get_cat_short_name(enum ih_category category, uint id); 5051426220bSSimon Glass 5061426220bSSimon Glass /** 5071426220bSSimon Glass * genimg_get_cat_count() - Get the number of items in a category 5081426220bSSimon Glass * 5091426220bSSimon Glass * @category: Category to check 5101426220bSSimon Glass * @return the number of items in the category (IH_xxx_COUNT) 5111426220bSSimon Glass */ 5121426220bSSimon Glass int genimg_get_cat_count(enum ih_category category); 5131426220bSSimon Glass 5141426220bSSimon Glass /** 5151426220bSSimon Glass * genimg_get_cat_desc() - Get the description of a category 5161426220bSSimon Glass * 5171426220bSSimon Glass * @return the description of a category, e.g. "architecture". This 5181426220bSSimon Glass * effectively converts the enum to a string. 5191426220bSSimon Glass */ 5201426220bSSimon Glass const char *genimg_get_cat_desc(enum ih_category category); 5211426220bSSimon Glass 522570abb0aSMarian Balakowicz int genimg_get_os_id(const char *name); 523570abb0aSMarian Balakowicz int genimg_get_arch_id(const char *name); 524570abb0aSMarian Balakowicz int genimg_get_type_id(const char *name); 525570abb0aSMarian Balakowicz int genimg_get_comp_id(const char *name); 526f666dea8SPrafulla Wadaskar void genimg_print_size(uint32_t size); 527570abb0aSMarian Balakowicz 528859e92b7SSimon Glass #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \ 529859e92b7SSimon Glass defined(USE_HOSTCC) 530859e92b7SSimon Glass #define IMAGE_ENABLE_TIMESTAMP 1 531859e92b7SSimon Glass #else 532859e92b7SSimon Glass #define IMAGE_ENABLE_TIMESTAMP 0 533859e92b7SSimon Glass #endif 534859e92b7SSimon Glass void genimg_print_time(time_t timestamp); 535859e92b7SSimon Glass 536782cfbb2SSimon Glass /* What to do with a image load address ('load = <> 'in the FIT) */ 537782cfbb2SSimon Glass enum fit_load_op { 538782cfbb2SSimon Glass FIT_LOAD_IGNORED, /* Ignore load address */ 539782cfbb2SSimon Glass FIT_LOAD_OPTIONAL, /* Can be provided, but optional */ 540fe20a81aSSimon Glass FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */ 541782cfbb2SSimon Glass FIT_LOAD_REQUIRED, /* Must be provided */ 542782cfbb2SSimon Glass }; 543782cfbb2SSimon Glass 54490268b87SSimon Glass int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start, 54590268b87SSimon Glass ulong *setup_len); 54690268b87SSimon Glass 5479a4daad0SMarian Balakowicz #ifndef USE_HOSTCC 5489a4daad0SMarian Balakowicz /* Image format types, returned by _get_format() routine */ 5499a4daad0SMarian Balakowicz #define IMAGE_FORMAT_INVALID 0x00 55021d29f7fSHeiko Schocher #if defined(CONFIG_IMAGE_FORMAT_LEGACY) 5519a4daad0SMarian Balakowicz #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ 55221d29f7fSHeiko Schocher #endif 5539a4daad0SMarian Balakowicz #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ 5549ace3fc8SSebastian Siewior #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */ 5559a4daad0SMarian Balakowicz 5566c454fedSBryan Wu ulong genimg_get_kernel_addr_fit(char * const img_addr, 5576c454fedSBryan Wu const char **fit_uname_config, 5586c454fedSBryan Wu const char **fit_uname_kernel); 5590f64140bSBryan Wu ulong genimg_get_kernel_addr(char * const img_addr); 56035e7b0f1SSimon Glass int genimg_get_format(const void *img_addr); 561f773bea8SMarian Balakowicz int genimg_has_config(bootm_headers_t *images); 5629a4daad0SMarian Balakowicz ulong genimg_get_image(ulong img_addr); 5639a4daad0SMarian Balakowicz 56462afc601SMichal Simek int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images, 56562afc601SMichal Simek uint8_t arch, const ulong *ld_start, ulong * const ld_len); 56654841ab5SWolfgang Denk int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images, 567d985c849SMarian Balakowicz uint8_t arch, ulong *rd_start, ulong *rd_end); 56884a07dbfSKarl Apsite 56984a07dbfSKarl Apsite /** 57084a07dbfSKarl Apsite * boot_get_loadable - routine to load a list of binaries to memory 57184a07dbfSKarl Apsite * @argc: Ignored Argument 57284a07dbfSKarl Apsite * @argv: Ignored Argument 57384a07dbfSKarl Apsite * @images: pointer to the bootm images structure 57484a07dbfSKarl Apsite * @arch: expected architecture for the image 57584a07dbfSKarl Apsite * @ld_start: Ignored Argument 57684a07dbfSKarl Apsite * @ld_len: Ignored Argument 57784a07dbfSKarl Apsite * 57884a07dbfSKarl Apsite * boot_get_loadable() will take the given FIT configuration, and look 57984a07dbfSKarl Apsite * for a field named "loadables". Loadables, is a list of elements in 58084a07dbfSKarl Apsite * the FIT given as strings. exe: 58184a07dbfSKarl Apsite * loadables = "linux_kernel@1", "fdt@2"; 58284a07dbfSKarl Apsite * this function will attempt to parse each string, and load the 58384a07dbfSKarl Apsite * corresponding element from the FIT into memory. Once placed, 58484a07dbfSKarl Apsite * no aditional actions are taken. 58584a07dbfSKarl Apsite * 58684a07dbfSKarl Apsite * @return: 58784a07dbfSKarl Apsite * 0, if only valid images or no images are found 58884a07dbfSKarl Apsite * error code, if an error occurs during fit_image_load 58984a07dbfSKarl Apsite */ 59084a07dbfSKarl Apsite int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images, 59184a07dbfSKarl Apsite uint8_t arch, const ulong *ld_start, ulong * const ld_len); 59284a07dbfSKarl Apsite #endif /* !USE_HOSTCC */ 5939a4daad0SMarian Balakowicz 59490268b87SSimon Glass int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch, 59590268b87SSimon Glass ulong *setup_start, ulong *setup_len); 59690268b87SSimon Glass 597782cfbb2SSimon Glass /** 598782cfbb2SSimon Glass * fit_image_load() - load an image from a FIT 599782cfbb2SSimon Glass * 600782cfbb2SSimon Glass * This deals with all aspects of loading an image from a FIT, including 601782cfbb2SSimon Glass * selecting the right image based on configuration, verifying it, printing 602782cfbb2SSimon Glass * out progress messages, checking the type/arch/os and optionally copying it 603782cfbb2SSimon Glass * to the right load address. 604782cfbb2SSimon Glass * 605126cc864SSimon Glass * The property to look up is defined by image_type. 606126cc864SSimon Glass * 607782cfbb2SSimon Glass * @param images Boot images structure 608782cfbb2SSimon Glass * @param addr Address of FIT in memory 609782cfbb2SSimon Glass * @param fit_unamep On entry this is the requested image name 610782cfbb2SSimon Glass * (e.g. "kernel@1") or NULL to use the default. On exit 611782cfbb2SSimon Glass * points to the selected image name 612f320a4d8SSimon Glass * @param fit_uname_configp On entry this is the requested configuration 613f320a4d8SSimon Glass * name (e.g. "conf@1") or NULL to use the default. On 614f320a4d8SSimon Glass * exit points to the selected configuration name. 615782cfbb2SSimon Glass * @param arch Expected architecture (IH_ARCH_...) 616782cfbb2SSimon Glass * @param image_type Required image type (IH_TYPE_...). If this is 617782cfbb2SSimon Glass * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD 618782cfbb2SSimon Glass * also. 619782cfbb2SSimon Glass * @param bootstage_id ID of starting bootstage to use for progress updates. 620782cfbb2SSimon Glass * This will be added to the BOOTSTAGE_SUB values when 621782cfbb2SSimon Glass * calling bootstage_mark() 622782cfbb2SSimon Glass * @param load_op Decribes what to do with the load address 623782cfbb2SSimon Glass * @param datap Returns address of loaded image 624782cfbb2SSimon Glass * @param lenp Returns length of loaded image 625ce1400f6SSimon Glass * @return node offset of image, or -ve error code on error 626782cfbb2SSimon Glass */ 627126cc864SSimon Glass int fit_image_load(bootm_headers_t *images, ulong addr, 628f320a4d8SSimon Glass const char **fit_unamep, const char **fit_uname_configp, 629782cfbb2SSimon Glass int arch, int image_type, int bootstage_id, 630782cfbb2SSimon Glass enum fit_load_op load_op, ulong *datap, ulong *lenp); 631782cfbb2SSimon Glass 632ce1400f6SSimon Glass #ifndef USE_HOSTCC 633782cfbb2SSimon Glass /** 634782cfbb2SSimon Glass * fit_get_node_from_config() - Look up an image a FIT by type 635782cfbb2SSimon Glass * 636782cfbb2SSimon Glass * This looks in the selected conf@ node (images->fit_uname_cfg) for a 637782cfbb2SSimon Glass * particular image type (e.g. "kernel") and then finds the image that is 638782cfbb2SSimon Glass * referred to. 639782cfbb2SSimon Glass * 640782cfbb2SSimon Glass * For example, for something like: 641782cfbb2SSimon Glass * 642782cfbb2SSimon Glass * images { 643782cfbb2SSimon Glass * kernel@1 { 644782cfbb2SSimon Glass * ... 645782cfbb2SSimon Glass * }; 646782cfbb2SSimon Glass * }; 647782cfbb2SSimon Glass * configurations { 648782cfbb2SSimon Glass * conf@1 { 649782cfbb2SSimon Glass * kernel = "kernel@1"; 650782cfbb2SSimon Glass * }; 651782cfbb2SSimon Glass * }; 652782cfbb2SSimon Glass * 653782cfbb2SSimon Glass * the function will return the node offset of the kernel@1 node, assuming 654782cfbb2SSimon Glass * that conf@1 is the chosen configuration. 655782cfbb2SSimon Glass * 656782cfbb2SSimon Glass * @param images Boot images structure 657782cfbb2SSimon Glass * @param prop_name Property name to look up (FIT_..._PROP) 658782cfbb2SSimon Glass * @param addr Address of FIT in memory 659782cfbb2SSimon Glass */ 660782cfbb2SSimon Glass int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name, 661782cfbb2SSimon Glass ulong addr); 662782cfbb2SSimon Glass 66353f375faSSimon Glass int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch, 66453f375faSSimon Glass bootm_headers_t *images, 66553f375faSSimon Glass char **of_flat_tree, ulong *of_size); 66655b0a393SGrant Likely void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob); 667590d3cacSGrant Likely int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size); 66806a09918SKumar Gala 6699a4daad0SMarian Balakowicz int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len, 6709a4daad0SMarian Balakowicz ulong *initrd_start, ulong *initrd_end); 671590d3cacSGrant Likely int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end); 672fca43cc8SJohn Rigby #ifdef CONFIG_SYS_BOOT_GET_KBD 673590d3cacSGrant Likely int boot_get_kbd(struct lmb *lmb, bd_t **kbd); 674fca43cc8SJohn Rigby #endif /* CONFIG_SYS_BOOT_GET_KBD */ 675570abb0aSMarian Balakowicz #endif /* !USE_HOSTCC */ 6769a4daad0SMarian Balakowicz 6779a4daad0SMarian Balakowicz /*******************************************************************/ 6789a4daad0SMarian Balakowicz /* Legacy format specific code (prefixed with image_) */ 6799a4daad0SMarian Balakowicz /*******************************************************************/ 680b97a2a0aSMarian Balakowicz static inline uint32_t image_get_header_size(void) 681b97a2a0aSMarian Balakowicz { 682b97a2a0aSMarian Balakowicz return (sizeof(image_header_t)); 683b97a2a0aSMarian Balakowicz } 684b97a2a0aSMarian Balakowicz 685b97a2a0aSMarian Balakowicz #define image_get_hdr_l(f) \ 6863a2003f6SWolfgang Denk static inline uint32_t image_get_##f(const image_header_t *hdr) \ 687b97a2a0aSMarian Balakowicz { \ 6889a4daad0SMarian Balakowicz return uimage_to_cpu(hdr->ih_##f); \ 689b97a2a0aSMarian Balakowicz } 690178e26d7SWolfgang Denk image_get_hdr_l(magic) /* image_get_magic */ 691178e26d7SWolfgang Denk image_get_hdr_l(hcrc) /* image_get_hcrc */ 692178e26d7SWolfgang Denk image_get_hdr_l(time) /* image_get_time */ 693178e26d7SWolfgang Denk image_get_hdr_l(size) /* image_get_size */ 694178e26d7SWolfgang Denk image_get_hdr_l(load) /* image_get_load */ 695178e26d7SWolfgang Denk image_get_hdr_l(ep) /* image_get_ep */ 696178e26d7SWolfgang Denk image_get_hdr_l(dcrc) /* image_get_dcrc */ 697b97a2a0aSMarian Balakowicz 698b97a2a0aSMarian Balakowicz #define image_get_hdr_b(f) \ 6993a2003f6SWolfgang Denk static inline uint8_t image_get_##f(const image_header_t *hdr) \ 700b97a2a0aSMarian Balakowicz { \ 701b97a2a0aSMarian Balakowicz return hdr->ih_##f; \ 702b97a2a0aSMarian Balakowicz } 703178e26d7SWolfgang Denk image_get_hdr_b(os) /* image_get_os */ 704178e26d7SWolfgang Denk image_get_hdr_b(arch) /* image_get_arch */ 705178e26d7SWolfgang Denk image_get_hdr_b(type) /* image_get_type */ 706178e26d7SWolfgang Denk image_get_hdr_b(comp) /* image_get_comp */ 707b97a2a0aSMarian Balakowicz 7083a2003f6SWolfgang Denk static inline char *image_get_name(const image_header_t *hdr) 709b97a2a0aSMarian Balakowicz { 710b97a2a0aSMarian Balakowicz return (char *)hdr->ih_name; 711b97a2a0aSMarian Balakowicz } 712b97a2a0aSMarian Balakowicz 7133a2003f6SWolfgang Denk static inline uint32_t image_get_data_size(const image_header_t *hdr) 714b97a2a0aSMarian Balakowicz { 715b97a2a0aSMarian Balakowicz return image_get_size(hdr); 716b97a2a0aSMarian Balakowicz } 717f13e7b2eSMarian Balakowicz 718f13e7b2eSMarian Balakowicz /** 719f13e7b2eSMarian Balakowicz * image_get_data - get image payload start address 720f13e7b2eSMarian Balakowicz * @hdr: image header 721f13e7b2eSMarian Balakowicz * 722f13e7b2eSMarian Balakowicz * image_get_data() returns address of the image payload. For single 723f13e7b2eSMarian Balakowicz * component images it is image data start. For multi component 724f13e7b2eSMarian Balakowicz * images it points to the null terminated table of sub-images sizes. 725f13e7b2eSMarian Balakowicz * 726f13e7b2eSMarian Balakowicz * returns: 727f13e7b2eSMarian Balakowicz * image payload data start address 728f13e7b2eSMarian Balakowicz */ 7293a2003f6SWolfgang Denk static inline ulong image_get_data(const image_header_t *hdr) 730f13e7b2eSMarian Balakowicz { 731f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_header_size()); 732f13e7b2eSMarian Balakowicz } 733f13e7b2eSMarian Balakowicz 7343a2003f6SWolfgang Denk static inline uint32_t image_get_image_size(const image_header_t *hdr) 735b97a2a0aSMarian Balakowicz { 736b97a2a0aSMarian Balakowicz return (image_get_size(hdr) + image_get_header_size()); 737b97a2a0aSMarian Balakowicz } 7383a2003f6SWolfgang Denk static inline ulong image_get_image_end(const image_header_t *hdr) 739b97a2a0aSMarian Balakowicz { 740f13e7b2eSMarian Balakowicz return ((ulong)hdr + image_get_image_size(hdr)); 741b97a2a0aSMarian Balakowicz } 742b97a2a0aSMarian Balakowicz 743b97a2a0aSMarian Balakowicz #define image_set_hdr_l(f) \ 744b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ 745b97a2a0aSMarian Balakowicz { \ 7469a4daad0SMarian Balakowicz hdr->ih_##f = cpu_to_uimage(val); \ 747b97a2a0aSMarian Balakowicz } 748178e26d7SWolfgang Denk image_set_hdr_l(magic) /* image_set_magic */ 749178e26d7SWolfgang Denk image_set_hdr_l(hcrc) /* image_set_hcrc */ 750178e26d7SWolfgang Denk image_set_hdr_l(time) /* image_set_time */ 751178e26d7SWolfgang Denk image_set_hdr_l(size) /* image_set_size */ 752178e26d7SWolfgang Denk image_set_hdr_l(load) /* image_set_load */ 753178e26d7SWolfgang Denk image_set_hdr_l(ep) /* image_set_ep */ 754178e26d7SWolfgang Denk image_set_hdr_l(dcrc) /* image_set_dcrc */ 755b97a2a0aSMarian Balakowicz 756b97a2a0aSMarian Balakowicz #define image_set_hdr_b(f) \ 757b97a2a0aSMarian Balakowicz static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ 758b97a2a0aSMarian Balakowicz { \ 759b97a2a0aSMarian Balakowicz hdr->ih_##f = val; \ 760b97a2a0aSMarian Balakowicz } 761178e26d7SWolfgang Denk image_set_hdr_b(os) /* image_set_os */ 762178e26d7SWolfgang Denk image_set_hdr_b(arch) /* image_set_arch */ 763178e26d7SWolfgang Denk image_set_hdr_b(type) /* image_set_type */ 764178e26d7SWolfgang Denk image_set_hdr_b(comp) /* image_set_comp */ 765b97a2a0aSMarian Balakowicz 766b97a2a0aSMarian Balakowicz static inline void image_set_name(image_header_t *hdr, const char *name) 767b97a2a0aSMarian Balakowicz { 768b97a2a0aSMarian Balakowicz strncpy(image_get_name(hdr), name, IH_NMLEN); 769b97a2a0aSMarian Balakowicz } 770b97a2a0aSMarian Balakowicz 7713a2003f6SWolfgang Denk int image_check_hcrc(const image_header_t *hdr); 7723a2003f6SWolfgang Denk int image_check_dcrc(const image_header_t *hdr); 773af13cdbcSMarian Balakowicz #ifndef USE_HOSTCC 774723806ccSSimon Glass ulong env_get_bootm_low(void); 775723806ccSSimon Glass phys_size_t env_get_bootm_size(void); 776723806ccSSimon Glass phys_size_t env_get_bootm_mapsize(void); 777af13cdbcSMarian Balakowicz #endif 778ce1400f6SSimon Glass void memmove_wd(void *to, void *from, size_t len, ulong chunksz); 779b97a2a0aSMarian Balakowicz 7803a2003f6SWolfgang Denk static inline int image_check_magic(const image_header_t *hdr) 781b97a2a0aSMarian Balakowicz { 782b97a2a0aSMarian Balakowicz return (image_get_magic(hdr) == IH_MAGIC); 783b97a2a0aSMarian Balakowicz } 7843a2003f6SWolfgang Denk static inline int image_check_type(const image_header_t *hdr, uint8_t type) 785b97a2a0aSMarian Balakowicz { 786b97a2a0aSMarian Balakowicz return (image_get_type(hdr) == type); 787b97a2a0aSMarian Balakowicz } 7883a2003f6SWolfgang Denk static inline int image_check_arch(const image_header_t *hdr, uint8_t arch) 789b97a2a0aSMarian Balakowicz { 7904ac0a32eSAlison Wang return (image_get_arch(hdr) == arch) || 7914ac0a32eSAlison Wang (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64); 792b97a2a0aSMarian Balakowicz } 7933a2003f6SWolfgang Denk static inline int image_check_os(const image_header_t *hdr, uint8_t os) 794b97a2a0aSMarian Balakowicz { 795b97a2a0aSMarian Balakowicz return (image_get_os(hdr) == os); 796b97a2a0aSMarian Balakowicz } 797b97a2a0aSMarian Balakowicz 7983a2003f6SWolfgang Denk ulong image_multi_count(const image_header_t *hdr); 7993a2003f6SWolfgang Denk void image_multi_getimg(const image_header_t *hdr, ulong idx, 80042b73e8eSMarian Balakowicz ulong *data, ulong *len); 80142b73e8eSMarian Balakowicz 8023a2003f6SWolfgang Denk void image_print_contents(const void *hdr); 803570abb0aSMarian Balakowicz 804b97a2a0aSMarian Balakowicz #ifndef USE_HOSTCC 8053a2003f6SWolfgang Denk static inline int image_check_target_arch(const image_header_t *hdr) 806b97a2a0aSMarian Balakowicz { 807476af299SMike Frysinger #ifndef IH_ARCH_DEFAULT 808476af299SMike Frysinger # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h" 809b97a2a0aSMarian Balakowicz #endif 810476af299SMike Frysinger return image_check_arch(hdr, IH_ARCH_DEFAULT); 811b97a2a0aSMarian Balakowicz } 8125dfb5213SMarian Balakowicz #endif /* USE_HOSTCC */ 8135b1d7137Swdenk 81413d06981SSimon Glass /** 81513d06981SSimon Glass * Set up properties in the FDT 81613d06981SSimon Glass * 81713d06981SSimon Glass * This sets up properties in the FDT that is to be passed to linux. 81813d06981SSimon Glass * 81913d06981SSimon Glass * @images: Images information 82013d06981SSimon Glass * @blob: FDT to update 82113d06981SSimon Glass * @of_size: Size of the FDT 82213d06981SSimon Glass * @lmb: Points to logical memory block structure 82313d06981SSimon Glass * @return 0 if ok, <0 on failure 82413d06981SSimon Glass */ 82513d06981SSimon Glass int image_setup_libfdt(bootm_headers_t *images, void *blob, 82613d06981SSimon Glass int of_size, struct lmb *lmb); 82713d06981SSimon Glass 82813d06981SSimon Glass /** 82913d06981SSimon Glass * Set up the FDT to use for booting a kernel 83013d06981SSimon Glass * 83113d06981SSimon Glass * This performs ramdisk setup, sets up the FDT if required, and adds 83213d06981SSimon Glass * paramters to the FDT if libfdt is available. 83313d06981SSimon Glass * 83413d06981SSimon Glass * @param images Images information 83513d06981SSimon Glass * @return 0 if ok, <0 on failure 83613d06981SSimon Glass */ 83713d06981SSimon Glass int image_setup_linux(bootm_headers_t *images); 83813d06981SSimon Glass 839a5266d6bSSimon Glass /** 840a5266d6bSSimon Glass * bootz_setup() - Extract stat and size of a Linux xImage 841a5266d6bSSimon Glass * 842a5266d6bSSimon Glass * @image: Address of image 843a5266d6bSSimon Glass * @start: Returns start address of image 844a5266d6bSSimon Glass * @end : Returns end address of image 845a5266d6bSSimon Glass * @return 0 if OK, 1 if the image was not recognised 846a5266d6bSSimon Glass */ 847a5266d6bSSimon Glass int bootz_setup(ulong image, ulong *start, ulong *end); 848a5266d6bSSimon Glass 849a5266d6bSSimon Glass 850d5934ad7SMarian Balakowicz /*******************************************************************/ 8519a4daad0SMarian Balakowicz /* New uImage format specific code (prefixed with fit_) */ 852d5934ad7SMarian Balakowicz /*******************************************************************/ 8535dfb5213SMarian Balakowicz 8545dfb5213SMarian Balakowicz #define FIT_IMAGES_PATH "/images" 8555dfb5213SMarian Balakowicz #define FIT_CONFS_PATH "/configurations" 8565dfb5213SMarian Balakowicz 8573e569a6bSSimon Glass /* hash/signature node */ 8585dfb5213SMarian Balakowicz #define FIT_HASH_NODENAME "hash" 8595dfb5213SMarian Balakowicz #define FIT_ALGO_PROP "algo" 8605dfb5213SMarian Balakowicz #define FIT_VALUE_PROP "value" 8618ac88f2dSJoe Hershberger #define FIT_IGNORE_PROP "uboot-ignore" 8623e569a6bSSimon Glass #define FIT_SIG_NODENAME "signature" 8635dfb5213SMarian Balakowicz 8645dfb5213SMarian Balakowicz /* image node */ 8655dfb5213SMarian Balakowicz #define FIT_DATA_PROP "data" 866db1b79b8Stomas.melin@vaisala.com #define FIT_DATA_OFFSET_PROP "data-offset" 867db1b79b8Stomas.melin@vaisala.com #define FIT_DATA_SIZE_PROP "data-size" 8685dfb5213SMarian Balakowicz #define FIT_TIMESTAMP_PROP "timestamp" 8695dfb5213SMarian Balakowicz #define FIT_DESC_PROP "description" 8705dfb5213SMarian Balakowicz #define FIT_ARCH_PROP "arch" 8715dfb5213SMarian Balakowicz #define FIT_TYPE_PROP "type" 8725dfb5213SMarian Balakowicz #define FIT_OS_PROP "os" 8735dfb5213SMarian Balakowicz #define FIT_COMP_PROP "compression" 8745dfb5213SMarian Balakowicz #define FIT_ENTRY_PROP "entry" 8755dfb5213SMarian Balakowicz #define FIT_LOAD_PROP "load" 8765dfb5213SMarian Balakowicz 8775dfb5213SMarian Balakowicz /* configuration node */ 8785dfb5213SMarian Balakowicz #define FIT_KERNEL_PROP "kernel" 8795dfb5213SMarian Balakowicz #define FIT_RAMDISK_PROP "ramdisk" 8805dfb5213SMarian Balakowicz #define FIT_FDT_PROP "fdt" 881ecf8cd65SKarl Apsite #define FIT_LOADABLE_PROP "loadables" 8825dfb5213SMarian Balakowicz #define FIT_DEFAULT_PROP "default" 88390268b87SSimon Glass #define FIT_SETUP_PROP "setup" 884ed0cea7cSMichal Simek #define FIT_FPGA_PROP "fpga" 8855dfb5213SMarian Balakowicz 8861de7bb4fSMichael van der Westhuizen #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE 8875dfb5213SMarian Balakowicz 888f1dcee59SSimon Glass #if IMAGE_ENABLE_FIT 8895dfb5213SMarian Balakowicz /* cmdline argument format parsing */ 890314f634bSMike Frysinger int fit_parse_conf(const char *spec, ulong addr_curr, 891f50433d6SMarian Balakowicz ulong *addr, const char **conf_name); 892314f634bSMike Frysinger int fit_parse_subimage(const char *spec, ulong addr_curr, 893f50433d6SMarian Balakowicz ulong *addr, const char **image_name); 894d5934ad7SMarian Balakowicz 89539931f96SGuilherme Maciel Ferreira int fit_get_subimage_count(const void *fit, int images_noffset); 896edbed247SBartlomiej Sieka void fit_print_contents(const void *fit); 8975dfb5213SMarian Balakowicz void fit_image_print(const void *fit, int noffset, const char *p); 8985dfb5213SMarian Balakowicz 8995dfb5213SMarian Balakowicz /** 9005dfb5213SMarian Balakowicz * fit_get_end - get FIT image size 9015dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 9025dfb5213SMarian Balakowicz * 9035dfb5213SMarian Balakowicz * returns: 9045dfb5213SMarian Balakowicz * size of the FIT image (blob) in memory 9055dfb5213SMarian Balakowicz */ 9065dfb5213SMarian Balakowicz static inline ulong fit_get_size(const void *fit) 9075dfb5213SMarian Balakowicz { 9085dfb5213SMarian Balakowicz return fdt_totalsize(fit); 9095dfb5213SMarian Balakowicz } 9105dfb5213SMarian Balakowicz 9115dfb5213SMarian Balakowicz /** 9125dfb5213SMarian Balakowicz * fit_get_end - get FIT image end 9135dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 9145dfb5213SMarian Balakowicz * 9155dfb5213SMarian Balakowicz * returns: 9165dfb5213SMarian Balakowicz * end address of the FIT image (blob) in memory 9175dfb5213SMarian Balakowicz */ 9187a80de46SSimon Glass ulong fit_get_end(const void *fit); 9195dfb5213SMarian Balakowicz 9205dfb5213SMarian Balakowicz /** 9215dfb5213SMarian Balakowicz * fit_get_name - get FIT node name 9225dfb5213SMarian Balakowicz * @fit: pointer to the FIT format image header 9235dfb5213SMarian Balakowicz * 9245dfb5213SMarian Balakowicz * returns: 9255dfb5213SMarian Balakowicz * NULL, on error 9265dfb5213SMarian Balakowicz * pointer to node name, on success 9275dfb5213SMarian Balakowicz */ 9285dfb5213SMarian Balakowicz static inline const char *fit_get_name(const void *fit_hdr, 9295dfb5213SMarian Balakowicz int noffset, int *len) 9305dfb5213SMarian Balakowicz { 9315dfb5213SMarian Balakowicz return fdt_get_name(fit_hdr, noffset, len); 9325dfb5213SMarian Balakowicz } 9335dfb5213SMarian Balakowicz 9345dfb5213SMarian Balakowicz int fit_get_desc(const void *fit, int noffset, char **desc); 9355dfb5213SMarian Balakowicz int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); 9365dfb5213SMarian Balakowicz 9375dfb5213SMarian Balakowicz int fit_image_get_node(const void *fit, const char *image_uname); 9385dfb5213SMarian Balakowicz int fit_image_get_os(const void *fit, int noffset, uint8_t *os); 9395dfb5213SMarian Balakowicz int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); 9405dfb5213SMarian Balakowicz int fit_image_get_type(const void *fit, int noffset, uint8_t *type); 9415dfb5213SMarian Balakowicz int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); 9425dfb5213SMarian Balakowicz int fit_image_get_load(const void *fit, int noffset, ulong *load); 9435dfb5213SMarian Balakowicz int fit_image_get_entry(const void *fit, int noffset, ulong *entry); 9445dfb5213SMarian Balakowicz int fit_image_get_data(const void *fit, int noffset, 9455dfb5213SMarian Balakowicz const void **data, size_t *size); 946db1b79b8Stomas.melin@vaisala.com int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset); 947db1b79b8Stomas.melin@vaisala.com int fit_image_get_data_size(const void *fit, int noffset, int *data_size); 9485dfb5213SMarian Balakowicz 9495dfb5213SMarian Balakowicz int fit_image_hash_get_algo(const void *fit, int noffset, char **algo); 9505dfb5213SMarian Balakowicz int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value, 9515dfb5213SMarian Balakowicz int *value_len); 9525dfb5213SMarian Balakowicz 9535dfb5213SMarian Balakowicz int fit_set_timestamp(void *fit, int noffset, time_t timestamp); 954bbb467dcSSimon Glass 955bbb467dcSSimon Glass /** 95656518e71SSimon Glass * fit_add_verification_data() - add verification data to FIT image nodes 957bbb467dcSSimon Glass * 95856518e71SSimon Glass * @keydir: Directory containing keys 95956518e71SSimon Glass * @kwydest: FDT blob to write public key information to 96056518e71SSimon Glass * @fit: Pointer to the FIT format image header 96156518e71SSimon Glass * @comment: Comment to add to signature nodes 96256518e71SSimon Glass * @require_keys: Mark all keys as 'required' 963f1ca1fdeSGeorge McCollister * @engine_id: Engine to use for signing 96456518e71SSimon Glass * 96556518e71SSimon Glass * Adds hash values for all component images in the FIT blob. 96656518e71SSimon Glass * Hashes are calculated for all component images which have hash subnodes 96756518e71SSimon Glass * with algorithm property set to one of the supported hash algorithms. 96856518e71SSimon Glass * 96956518e71SSimon Glass * Also add signatures if signature nodes are present. 97056518e71SSimon Glass * 97156518e71SSimon Glass * returns 97256518e71SSimon Glass * 0, on success 97356518e71SSimon Glass * libfdt error code, on failure 974bbb467dcSSimon Glass */ 97556518e71SSimon Glass int fit_add_verification_data(const char *keydir, void *keydest, void *fit, 976f1ca1fdeSGeorge McCollister const char *comment, int require_keys, 977f1ca1fdeSGeorge McCollister const char *engine_id); 9785dfb5213SMarian Balakowicz 979b8da8366SSimon Glass int fit_image_verify(const void *fit, int noffset); 980782cfbb2SSimon Glass int fit_config_verify(const void *fit, int conf_noffset); 981b8da8366SSimon Glass int fit_all_image_verify(const void *fit); 9825dfb5213SMarian Balakowicz int fit_image_check_os(const void *fit, int noffset, uint8_t os); 9835dfb5213SMarian Balakowicz int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); 9845dfb5213SMarian Balakowicz int fit_image_check_type(const void *fit, int noffset, uint8_t type); 9855dfb5213SMarian Balakowicz int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); 9865dfb5213SMarian Balakowicz int fit_check_format(const void *fit); 9875dfb5213SMarian Balakowicz 988d95f6ec7SGabe Black int fit_conf_find_compat(const void *fit, const void *fdt); 9895dfb5213SMarian Balakowicz int fit_conf_get_node(const void *fit, const char *conf_uname); 9905dfb5213SMarian Balakowicz 991003efd7dSSimon Glass /** 992003efd7dSSimon Glass * fit_conf_get_prop_node() - Get node refered to by a configuration 993003efd7dSSimon Glass * @fit: FIT to check 994003efd7dSSimon Glass * @noffset: Offset of conf@xxx node to check 995003efd7dSSimon Glass * @prop_name: Property to read from the conf node 996003efd7dSSimon Glass * 997003efd7dSSimon Glass * The conf@ nodes contain references to other nodes, using properties 998003efd7dSSimon Glass * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"), 999003efd7dSSimon Glass * return the offset of the node referred to (e.g. offset of node 1000003efd7dSSimon Glass * "/images/kernel@1". 1001003efd7dSSimon Glass */ 1002003efd7dSSimon Glass int fit_conf_get_prop_node(const void *fit, int noffset, 1003003efd7dSSimon Glass const char *prop_name); 1004003efd7dSSimon Glass 10055dfb5213SMarian Balakowicz void fit_conf_print(const void *fit, int noffset, const char *p); 10065dfb5213SMarian Balakowicz 100761a439a8SSimon Glass int fit_check_ramdisk(const void *fit, int os_noffset, 100861a439a8SSimon Glass uint8_t arch, int verify); 100961a439a8SSimon Glass 1010604f23ddSSimon Glass int calculate_hash(const void *data, int data_len, const char *algo, 1011604f23ddSSimon Glass uint8_t *value, int *value_len); 1012604f23ddSSimon Glass 1013782cfbb2SSimon Glass /* 10143e569a6bSSimon Glass * At present we only support signing on the host, and verification on the 10153e569a6bSSimon Glass * device 1016782cfbb2SSimon Glass */ 1017782cfbb2SSimon Glass #if defined(CONFIG_FIT_SIGNATURE) 1018782cfbb2SSimon Glass # ifdef USE_HOSTCC 10193e569a6bSSimon Glass # define IMAGE_ENABLE_SIGN 1 102029a23f9dSHeiko Schocher # define IMAGE_ENABLE_VERIFY 1 1021646257d1SHeiko Schocher # include <openssl/evp.h> 1022782cfbb2SSimon Glass #else 10233e569a6bSSimon Glass # define IMAGE_ENABLE_SIGN 0 1024782cfbb2SSimon Glass # define IMAGE_ENABLE_VERIFY 1 1025782cfbb2SSimon Glass # endif 1026782cfbb2SSimon Glass #else 10273e569a6bSSimon Glass # define IMAGE_ENABLE_SIGN 0 1028782cfbb2SSimon Glass # define IMAGE_ENABLE_VERIFY 0 1029782cfbb2SSimon Glass #endif 1030782cfbb2SSimon Glass 1031782cfbb2SSimon Glass #ifdef USE_HOSTCC 103229a23f9dSHeiko Schocher void *image_get_host_blob(void); 103329a23f9dSHeiko Schocher void image_set_host_blob(void *host_blob); 103429a23f9dSHeiko Schocher # define gd_fdt_blob() image_get_host_blob() 1035782cfbb2SSimon Glass #else 1036782cfbb2SSimon Glass # define gd_fdt_blob() (gd->fdt_blob) 1037782cfbb2SSimon Glass #endif 1038782cfbb2SSimon Glass 1039782cfbb2SSimon Glass #ifdef CONFIG_FIT_BEST_MATCH 1040782cfbb2SSimon Glass #define IMAGE_ENABLE_BEST_MATCH 1 1041782cfbb2SSimon Glass #else 1042782cfbb2SSimon Glass #define IMAGE_ENABLE_BEST_MATCH 0 1043782cfbb2SSimon Glass #endif 1044782cfbb2SSimon Glass 10453e569a6bSSimon Glass /* Information passed to the signing routines */ 10463e569a6bSSimon Glass struct image_sign_info { 10473e569a6bSSimon Glass const char *keydir; /* Directory conaining keys */ 10483e569a6bSSimon Glass const char *keyname; /* Name of key to use */ 10493e569a6bSSimon Glass void *fit; /* Pointer to FIT blob */ 10503e569a6bSSimon Glass int node_offset; /* Offset of signature node */ 105183dd98e0SAndrew Duda const char *name; /* Algorithm name */ 105283dd98e0SAndrew Duda struct checksum_algo *checksum; /* Checksum algorithm information */ 105383dd98e0SAndrew Duda struct crypto_algo *crypto; /* Crypto algorithm information */ 10543e569a6bSSimon Glass const void *fdt_blob; /* FDT containing public keys */ 10553e569a6bSSimon Glass int required_keynode; /* Node offset of key to use: -1=any */ 10563e569a6bSSimon Glass const char *require_keys; /* Value for 'required' property */ 1057f1ca1fdeSGeorge McCollister const char *engine_id; /* Engine to use for signing */ 10583e569a6bSSimon Glass }; 105973223f0eSSimon Glass #endif /* Allow struct image_region to always be defined for rsa.h */ 10603e569a6bSSimon Glass 10613e569a6bSSimon Glass /* A part of an image, used for hashing */ 10623e569a6bSSimon Glass struct image_region { 10633e569a6bSSimon Glass const void *data; 10643e569a6bSSimon Glass int size; 10653e569a6bSSimon Glass }; 10663e569a6bSSimon Glass 106773223f0eSSimon Glass #if IMAGE_ENABLE_FIT 106873223f0eSSimon Glass 1069646257d1SHeiko Schocher #if IMAGE_ENABLE_VERIFY 10702b9912e6SJeroen Hofstee # include <u-boot/rsa-checksum.h> 1071646257d1SHeiko Schocher #endif 1072646257d1SHeiko Schocher struct checksum_algo { 1073646257d1SHeiko Schocher const char *name; 1074646257d1SHeiko Schocher const int checksum_len; 1075da29f299SAndrew Duda const int der_len; 1076da29f299SAndrew Duda const uint8_t *der_prefix; 1077646257d1SHeiko Schocher #if IMAGE_ENABLE_SIGN 107829a23f9dSHeiko Schocher const EVP_MD *(*calculate_sign)(void); 107929a23f9dSHeiko Schocher #endif 1080b37b46f0SRuchika Gupta int (*calculate)(const char *name, 1081b37b46f0SRuchika Gupta const struct image_region region[], 1082646257d1SHeiko Schocher int region_count, uint8_t *checksum); 1083646257d1SHeiko Schocher }; 1084646257d1SHeiko Schocher 10850c1d74fdSAndrew Duda struct crypto_algo { 10863e569a6bSSimon Glass const char *name; /* Name of algorithm */ 10870c1d74fdSAndrew Duda const int key_len; 10883e569a6bSSimon Glass 10893e569a6bSSimon Glass /** 10903e569a6bSSimon Glass * sign() - calculate and return signature for given input data 10913e569a6bSSimon Glass * 10923e569a6bSSimon Glass * @info: Specifies key and FIT information 10933e569a6bSSimon Glass * @data: Pointer to the input data 10943e569a6bSSimon Glass * @data_len: Data length 10953e569a6bSSimon Glass * @sigp: Set to an allocated buffer holding the signature 10963e569a6bSSimon Glass * @sig_len: Set to length of the calculated hash 10973e569a6bSSimon Glass * 10983e569a6bSSimon Glass * This computes input data signature according to selected algorithm. 10993e569a6bSSimon Glass * Resulting signature value is placed in an allocated buffer, the 11003e569a6bSSimon Glass * pointer is returned as *sigp. The length of the calculated 11013e569a6bSSimon Glass * signature is returned via the sig_len pointer argument. The caller 11023e569a6bSSimon Glass * should free *sigp. 11033e569a6bSSimon Glass * 11043e569a6bSSimon Glass * @return: 0, on success, -ve on error 11053e569a6bSSimon Glass */ 11063e569a6bSSimon Glass int (*sign)(struct image_sign_info *info, 11073e569a6bSSimon Glass const struct image_region region[], 11083e569a6bSSimon Glass int region_count, uint8_t **sigp, uint *sig_len); 11093e569a6bSSimon Glass 11103e569a6bSSimon Glass /** 11113e569a6bSSimon Glass * add_verify_data() - Add verification information to FDT 11123e569a6bSSimon Glass * 11133e569a6bSSimon Glass * Add public key information to the FDT node, suitable for 11143e569a6bSSimon Glass * verification at run-time. The information added depends on the 11153e569a6bSSimon Glass * algorithm being used. 11163e569a6bSSimon Glass * 11173e569a6bSSimon Glass * @info: Specifies key and FIT information 11183e569a6bSSimon Glass * @keydest: Destination FDT blob for public key data 11193e569a6bSSimon Glass * @return: 0, on success, -ve on error 11203e569a6bSSimon Glass */ 11213e569a6bSSimon Glass int (*add_verify_data)(struct image_sign_info *info, void *keydest); 11223e569a6bSSimon Glass 11233e569a6bSSimon Glass /** 11243e569a6bSSimon Glass * verify() - Verify a signature against some data 11253e569a6bSSimon Glass * 11263e569a6bSSimon Glass * @info: Specifies key and FIT information 11273e569a6bSSimon Glass * @data: Pointer to the input data 11283e569a6bSSimon Glass * @data_len: Data length 11293e569a6bSSimon Glass * @sig: Signature 11303e569a6bSSimon Glass * @sig_len: Number of bytes in signature 11313e569a6bSSimon Glass * @return 0 if verified, -ve on error 11323e569a6bSSimon Glass */ 11333e569a6bSSimon Glass int (*verify)(struct image_sign_info *info, 11343e569a6bSSimon Glass const struct image_region region[], int region_count, 11353e569a6bSSimon Glass uint8_t *sig, uint sig_len); 11360c1d74fdSAndrew Duda }; 1137646257d1SHeiko Schocher 11383e569a6bSSimon Glass /** 113983dd98e0SAndrew Duda * image_get_checksum_algo() - Look up a checksum algorithm 11403e569a6bSSimon Glass * 114183dd98e0SAndrew Duda * @param full_name Name of algorithm in the form "checksum,crypto" 11423e569a6bSSimon Glass * @return pointer to algorithm information, or NULL if not found 11433e569a6bSSimon Glass */ 114483dd98e0SAndrew Duda struct checksum_algo *image_get_checksum_algo(const char *full_name); 114583dd98e0SAndrew Duda 114683dd98e0SAndrew Duda /** 114783dd98e0SAndrew Duda * image_get_crypto_algo() - Look up a cryptosystem algorithm 114883dd98e0SAndrew Duda * 114983dd98e0SAndrew Duda * @param full_name Name of algorithm in the form "checksum,crypto" 115083dd98e0SAndrew Duda * @return pointer to algorithm information, or NULL if not found 115183dd98e0SAndrew Duda */ 115283dd98e0SAndrew Duda struct crypto_algo *image_get_crypto_algo(const char *full_name); 11533e569a6bSSimon Glass 115456518e71SSimon Glass /** 115556518e71SSimon Glass * fit_image_verify_required_sigs() - Verify signatures marked as 'required' 115656518e71SSimon Glass * 115756518e71SSimon Glass * @fit: FIT to check 115856518e71SSimon Glass * @image_noffset: Offset of image node to check 115956518e71SSimon Glass * @data: Image data to check 116056518e71SSimon Glass * @size: Size of image data 116156518e71SSimon Glass * @sig_blob: FDT containing public keys 116256518e71SSimon Glass * @no_sigsp: Returns 1 if no signatures were required, and 116356518e71SSimon Glass * therefore nothing was checked. The caller may wish 116456518e71SSimon Glass * to fall back to other mechanisms, or refuse to 116556518e71SSimon Glass * boot. 116656518e71SSimon Glass * @return 0 if all verified ok, <0 on error 116756518e71SSimon Glass */ 116856518e71SSimon Glass int fit_image_verify_required_sigs(const void *fit, int image_noffset, 116956518e71SSimon Glass const char *data, size_t size, const void *sig_blob, 117056518e71SSimon Glass int *no_sigsp); 117156518e71SSimon Glass 117256518e71SSimon Glass /** 117356518e71SSimon Glass * fit_image_check_sig() - Check a single image signature node 117456518e71SSimon Glass * 117556518e71SSimon Glass * @fit: FIT to check 117656518e71SSimon Glass * @noffset: Offset of signature node to check 117756518e71SSimon Glass * @data: Image data to check 117856518e71SSimon Glass * @size: Size of image data 117956518e71SSimon Glass * @required_keynode: Offset in the control FDT of the required key node, 118056518e71SSimon Glass * if any. If this is given, then the image wil not 118156518e71SSimon Glass * pass verification unless that key is used. If this is 118256518e71SSimon Glass * -1 then any signature will do. 118356518e71SSimon Glass * @err_msgp: In the event of an error, this will be pointed to a 118456518e71SSimon Glass * help error string to display to the user. 118556518e71SSimon Glass * @return 0 if all verified ok, <0 on error 118656518e71SSimon Glass */ 118756518e71SSimon Glass int fit_image_check_sig(const void *fit, int noffset, const void *data, 118856518e71SSimon Glass size_t size, int required_keynode, char **err_msgp); 118956518e71SSimon Glass 11904d098529SSimon Glass /** 11914d098529SSimon Glass * fit_region_make_list() - Make a list of regions to hash 11924d098529SSimon Glass * 11934d098529SSimon Glass * Given a list of FIT regions (offset, size) provided by libfdt, create 11944d098529SSimon Glass * a list of regions (void *, size) for use by the signature creationg 11954d098529SSimon Glass * and verification code. 11964d098529SSimon Glass * 11974d098529SSimon Glass * @fit: FIT image to process 11984d098529SSimon Glass * @fdt_regions: Regions as returned by libfdt 11994d098529SSimon Glass * @count: Number of regions returned by libfdt 12004d098529SSimon Glass * @region: Place to put list of regions (NULL to allocate it) 12014d098529SSimon Glass * @return pointer to list of regions, or NULL if out of memory 12024d098529SSimon Glass */ 12034d098529SSimon Glass struct image_region *fit_region_make_list(const void *fit, 12044d098529SSimon Glass struct fdt_region *fdt_regions, int count, 12054d098529SSimon Glass struct image_region *region); 120656518e71SSimon Glass 12075dfb5213SMarian Balakowicz static inline int fit_image_check_target_arch(const void *fdt, int node) 12085dfb5213SMarian Balakowicz { 120929a23f9dSHeiko Schocher #ifndef USE_HOSTCC 12107566832aSThierry Reding return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); 121129a23f9dSHeiko Schocher #else 121229a23f9dSHeiko Schocher return 0; 121329a23f9dSHeiko Schocher #endif 12145dfb5213SMarian Balakowicz } 12155dfb5213SMarian Balakowicz 1216d5934ad7SMarian Balakowicz #ifdef CONFIG_FIT_VERBOSE 1217d5934ad7SMarian Balakowicz #define fit_unsupported(msg) printf("! %s:%d " \ 1218d5934ad7SMarian Balakowicz "FIT images not supported for '%s'\n", \ 1219d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 1220d5934ad7SMarian Balakowicz 1221d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) printf("! %s:%d " \ 1222d5934ad7SMarian Balakowicz "FIT images not supported for '%s' " \ 1223d5934ad7SMarian Balakowicz "- must reset board to recover!\n", \ 1224d5934ad7SMarian Balakowicz __FILE__, __LINE__, (msg)) 1225d5934ad7SMarian Balakowicz #else 1226d5934ad7SMarian Balakowicz #define fit_unsupported(msg) 1227d5934ad7SMarian Balakowicz #define fit_unsupported_reset(msg) 1228d5934ad7SMarian Balakowicz #endif /* CONFIG_FIT_VERBOSE */ 1229f50433d6SMarian Balakowicz #endif /* CONFIG_FIT */ 12305ad03eb3SMarian Balakowicz 12319ace3fc8SSebastian Siewior #if defined(CONFIG_ANDROID_BOOT_IMAGE) 12329ace3fc8SSebastian Siewior struct andr_img_hdr; 12339ace3fc8SSebastian Siewior int android_image_check_header(const struct andr_img_hdr *hdr); 12349ace3fc8SSebastian Siewior int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify, 12359ace3fc8SSebastian Siewior ulong *os_data, ulong *os_len); 12369ace3fc8SSebastian Siewior int android_image_get_ramdisk(const struct andr_img_hdr *hdr, 12379ace3fc8SSebastian Siewior ulong *rd_data, ulong *rd_len); 1238270f9eacSKever Yang int android_image_get_fdt(const struct andr_img_hdr *hdr, 1239270f9eacSKever Yang ulong *rd_data); 12409ace3fc8SSebastian Siewior ulong android_image_get_end(const struct andr_img_hdr *hdr); 12419ace3fc8SSebastian Siewior ulong android_image_get_kload(const struct andr_img_hdr *hdr); 12424f1318b2SMichael Trimarchi void android_print_contents(const struct andr_img_hdr *hdr); 12439ace3fc8SSebastian Siewior 124476e2a5a6SAlex Deymo /** android_image_load - Load an Android Image from storage. 124576e2a5a6SAlex Deymo * 124676e2a5a6SAlex Deymo * Load an Android Image based on the header size in the storage. Return the 124776e2a5a6SAlex Deymo * number of bytes read from storage, which could be bigger than the actual 124876e2a5a6SAlex Deymo * Android Image as described in the header size. In case of error reading the 124976e2a5a6SAlex Deymo * image or if the image size needed to be read from disk is bigger than the 125076e2a5a6SAlex Deymo * the passed |max_size| a negative number is returned. 125176e2a5a6SAlex Deymo * 125276e2a5a6SAlex Deymo * @dev_desc: The device where to read the image from 125376e2a5a6SAlex Deymo * @part_info: The partition in |dev_desc| where to read the image from 125476e2a5a6SAlex Deymo * @load_address: The address where the image will be loaded 125576e2a5a6SAlex Deymo * @max_size: The maximum loaded size, in bytes 125676e2a5a6SAlex Deymo * @return the number of bytes read or a negative number in case of error. 125776e2a5a6SAlex Deymo */ 125876e2a5a6SAlex Deymo long android_image_load(struct blk_desc *dev_desc, 125976e2a5a6SAlex Deymo const disk_partition_t *part_info, 126076e2a5a6SAlex Deymo unsigned long load_address, 126176e2a5a6SAlex Deymo unsigned long max_size); 126276e2a5a6SAlex Deymo 12639ace3fc8SSebastian Siewior #endif /* CONFIG_ANDROID_BOOT_IMAGE */ 12649ace3fc8SSebastian Siewior 12654b307f23SSimon Glass /** 12664b307f23SSimon Glass * board_fit_config_name_match() - Check for a matching board name 12674b307f23SSimon Glass * 12684b307f23SSimon Glass * This is used when SPL loads a FIT containing multiple device tree files 12694b307f23SSimon Glass * and wants to work out which one to use. The description of each one is 12704b307f23SSimon Glass * passed to this function. The description comes from the 'description' field 12714b307f23SSimon Glass * in each (FDT) image node. 12724b307f23SSimon Glass * 12734b307f23SSimon Glass * @name: Device tree description 12744b307f23SSimon Glass * @return 0 if this device tree should be used, non-zero to try the next 12754b307f23SSimon Glass */ 12764b307f23SSimon Glass int board_fit_config_name_match(const char *name); 12774b307f23SSimon Glass 1278a5c7e41bSMadan Srinivas #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \ 1279a5c7e41bSMadan Srinivas defined(CONFIG_FIT_IMAGE_POST_PROCESS) 1280da74d1f3SDaniel Allred /** 1281da74d1f3SDaniel Allred * board_fit_image_post_process() - Do any post-process on FIT binary data 1282da74d1f3SDaniel Allred * 1283da74d1f3SDaniel Allred * This is used to do any sort of image manipulation, verification, decryption 1284da74d1f3SDaniel Allred * etc. in a platform or board specific way. Obviously, anything done here would 1285da74d1f3SDaniel Allred * need to be comprehended in how the images were prepared before being injected 1286da74d1f3SDaniel Allred * into the FIT creation (i.e. the binary blobs would have been pre-processed 1287da74d1f3SDaniel Allred * before being added to the FIT image). 1288da74d1f3SDaniel Allred * 1289da74d1f3SDaniel Allred * @image: pointer to the image start pointer 1290da74d1f3SDaniel Allred * @size: pointer to the image size 1291da74d1f3SDaniel Allred * @return no return value (failure should be handled internally) 1292da74d1f3SDaniel Allred */ 1293da74d1f3SDaniel Allred void board_fit_image_post_process(void **p_image, size_t *p_size); 1294da74d1f3SDaniel Allred #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */ 1295da74d1f3SDaniel Allred 12963863f840SCooper Jr., Franklin #define FDT_ERROR ((ulong)(-1)) 12973863f840SCooper Jr., Franklin 129892926bc8SCooper Jr., Franklin ulong fdt_getprop_u32(const void *fdt, int node, const char *prop); 129992926bc8SCooper Jr., Franklin int fit_find_config_node(const void *fdt); 130092926bc8SCooper Jr., Franklin 1301d7be5092SAndrew F. Davis /** 1302d7be5092SAndrew F. Davis * Mapping of image types to function handlers to be invoked on the associated 1303d7be5092SAndrew F. Davis * loaded images 1304d7be5092SAndrew F. Davis * 1305d7be5092SAndrew F. Davis * @type: Type of image, I.E. IH_TYPE_* 1306d7be5092SAndrew F. Davis * @handler: Function to call on loaded image 1307d7be5092SAndrew F. Davis */ 1308d7be5092SAndrew F. Davis struct fit_loadable_tbl { 1309d7be5092SAndrew F. Davis int type; 1310d7be5092SAndrew F. Davis /** 1311d7be5092SAndrew F. Davis * handler() - Process a loaded image 1312d7be5092SAndrew F. Davis * 1313d7be5092SAndrew F. Davis * @data: Pointer to start of loaded image data 1314d7be5092SAndrew F. Davis * @size: Size of loaded image data 1315d7be5092SAndrew F. Davis */ 1316d7be5092SAndrew F. Davis void (*handler)(ulong data, size_t size); 1317d7be5092SAndrew F. Davis }; 1318d7be5092SAndrew F. Davis 1319d7be5092SAndrew F. Davis /* 1320d7be5092SAndrew F. Davis * Define a FIT loadable image type handler 1321d7be5092SAndrew F. Davis * 1322d7be5092SAndrew F. Davis * _type is a valid uimage_type ID as defined in the "Image Type" enum above 1323d7be5092SAndrew F. Davis * _handler is the handler function to call after this image type is loaded 1324d7be5092SAndrew F. Davis */ 1325d7be5092SAndrew F. Davis #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \ 1326d7be5092SAndrew F. Davis ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \ 1327d7be5092SAndrew F. Davis .type = _type, \ 1328d7be5092SAndrew F. Davis .handler = _handler, \ 1329d7be5092SAndrew F. Davis } 1330d7be5092SAndrew F. Davis 13315b1d7137Swdenk #endif /* __IMAGE_H__ */ 1332