wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 1 | /* |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 2 | * (C) Copyright 2008 Semihalf |
| 3 | * |
Wolfgang Denk | f3f4518 | 2005-11-25 16:38:03 +0100 | [diff] [blame] | 4 | * (C) Copyright 2000-2005 |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 5 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
| 6 | * |
Wolfgang Denk | d79de1d | 2013-07-08 09:37:19 +0200 | [diff] [blame] | 7 | * SPDX-License-Identifier: GPL-2.0+ |
Wolfgang Denk | f3f4518 | 2005-11-25 16:38:03 +0100 | [diff] [blame] | 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 | ******************************************************************** |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 14 | */ |
| 15 | |
| 16 | #ifndef __IMAGE_H__ |
| 17 | #define __IMAGE_H__ |
| 18 | |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 19 | #include "compiler.h" |
Kim Phillips | e69030c | 2012-10-29 13:34:30 +0000 | [diff] [blame] | 20 | #include <asm/byteorder.h> |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 21 | |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 22 | /* Define this to avoid #ifdefs later on */ |
| 23 | struct lmb; |
| 24 | |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 25 | #ifdef USE_HOSTCC |
Jörg Krause | 983487f | 2015-04-22 21:36:22 +0200 | [diff] [blame] | 26 | #include <sys/types.h> |
Marian Balakowicz | f4891a1 | 2008-02-21 17:20:18 +0100 | [diff] [blame] | 27 | |
Bartlomiej Sieka | d7816fb | 2008-03-11 12:34:47 +0100 | [diff] [blame] | 28 | /* new uImage format support enabled on host */ |
Simon Glass | 8b42692 | 2016-02-22 22:55:45 -0700 | [diff] [blame] | 29 | #define IMAGE_ENABLE_FIT 1 |
| 30 | #define IMAGE_ENABLE_OF_LIBFDT 1 |
Bartlomiej Sieka | d7816fb | 2008-03-11 12:34:47 +0100 | [diff] [blame] | 31 | #define CONFIG_FIT_VERBOSE 1 /* enable fit_format_{error,warning}() */ |
Tom Rini | cc54a10 | 2017-05-15 12:17:48 -0400 | [diff] [blame] | 32 | #define CONFIG_FIT_ENABLE_SHA256_SUPPORT |
Tom Rini | 5bdd919 | 2017-05-15 12:17:49 -0400 | [diff] [blame] | 33 | #define CONFIG_SHA1 |
| 34 | #define CONFIG_SHA256 |
Marian Balakowicz | f4891a1 | 2008-02-21 17:20:18 +0100 | [diff] [blame] | 35 | |
Simon Glass | f0fd511 | 2013-05-07 06:11:58 +0000 | [diff] [blame] | 36 | #define IMAGE_ENABLE_IGNORE 0 |
Simon Glass | 1030f16 | 2013-05-08 08:05:58 +0000 | [diff] [blame] | 37 | #define IMAGE_INDENT_STRING "" |
Simon Glass | f0fd511 | 2013-05-07 06:11:58 +0000 | [diff] [blame] | 38 | |
Wolfgang Denk | bf36877 | 2008-10-21 11:23:56 +0200 | [diff] [blame] | 39 | #else |
| 40 | |
| 41 | #include <lmb.h> |
Wolfgang Denk | bf36877 | 2008-10-21 11:23:56 +0200 | [diff] [blame] | 42 | #include <asm/u-boot.h> |
Mike Frysinger | 175467a | 2010-01-21 04:03:20 -0500 | [diff] [blame] | 43 | #include <command.h> |
Wolfgang Denk | bf36877 | 2008-10-21 11:23:56 +0200 | [diff] [blame] | 44 | |
Simon Glass | f0fd511 | 2013-05-07 06:11:58 +0000 | [diff] [blame] | 45 | /* Take notice of the 'ignore' property for hashes */ |
| 46 | #define IMAGE_ENABLE_IGNORE 1 |
Simon Glass | 1030f16 | 2013-05-08 08:05:58 +0000 | [diff] [blame] | 47 | #define IMAGE_INDENT_STRING " " |
Simon Glass | f0fd511 | 2013-05-07 06:11:58 +0000 | [diff] [blame] | 48 | |
Simon Glass | 8b42692 | 2016-02-22 22:55:45 -0700 | [diff] [blame] | 49 | #define IMAGE_ENABLE_FIT CONFIG_IS_ENABLED(FIT) |
| 50 | #define IMAGE_ENABLE_OF_LIBFDT CONFIG_IS_ENABLED(OF_LIBFDT) |
Simon Glass | e3ee2fb | 2016-02-22 22:55:43 -0700 | [diff] [blame] | 51 | |
Bartlomiej Sieka | d7816fb | 2008-03-11 12:34:47 +0100 | [diff] [blame] | 52 | #endif /* USE_HOSTCC */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 53 | |
Simon Glass | e3ee2fb | 2016-02-22 22:55:43 -0700 | [diff] [blame] | 54 | #if IMAGE_ENABLE_FIT |
Michael van der Westhuizen | e36c6c3 | 2014-05-30 20:59:00 +0200 | [diff] [blame] | 55 | #include <hash.h> |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 56 | #include <libfdt.h> |
| 57 | #include <fdt_support.h> |
Simon Glass | 82d9453 | 2013-05-08 08:05:59 +0000 | [diff] [blame] | 58 | # ifdef CONFIG_SPL_BUILD |
Masahiro Yamada | 191413c | 2016-05-31 20:41:54 +0900 | [diff] [blame] | 59 | # ifdef CONFIG_SPL_CRC32_SUPPORT |
| 60 | # define IMAGE_ENABLE_CRC32 1 |
| 61 | # endif |
| 62 | # ifdef CONFIG_SPL_MD5_SUPPORT |
| 63 | # define IMAGE_ENABLE_MD5 1 |
| 64 | # endif |
| 65 | # ifdef CONFIG_SPL_SHA1_SUPPORT |
| 66 | # define IMAGE_ENABLE_SHA1 1 |
| 67 | # endif |
Simon Glass | 82d9453 | 2013-05-08 08:05:59 +0000 | [diff] [blame] | 68 | # else |
| 69 | # define CONFIG_CRC32 /* FIT images need CRC32 support */ |
Simon Glass | 82d9453 | 2013-05-08 08:05:59 +0000 | [diff] [blame] | 70 | # define IMAGE_ENABLE_CRC32 1 |
| 71 | # define IMAGE_ENABLE_MD5 1 |
| 72 | # define IMAGE_ENABLE_SHA1 1 |
| 73 | # endif |
Masahiro Yamada | 191413c | 2016-05-31 20:41:54 +0900 | [diff] [blame] | 74 | |
Masahiro Yamada | 191413c | 2016-05-31 20:41:54 +0900 | [diff] [blame] | 75 | #ifndef IMAGE_ENABLE_CRC32 |
| 76 | #define IMAGE_ENABLE_CRC32 0 |
| 77 | #endif |
| 78 | |
| 79 | #ifndef IMAGE_ENABLE_MD5 |
| 80 | #define IMAGE_ENABLE_MD5 0 |
| 81 | #endif |
| 82 | |
| 83 | #ifndef IMAGE_ENABLE_SHA1 |
| 84 | #define IMAGE_ENABLE_SHA1 0 |
| 85 | #endif |
| 86 | |
Tom Rini | cc54a10 | 2017-05-15 12:17:48 -0400 | [diff] [blame] | 87 | #if defined(CONFIG_FIT_ENABLE_SHA256_SUPPORT) || \ |
| 88 | defined(CONFIG_SPL_SHA256_SUPPORT) |
Tom Rini | cc54a10 | 2017-05-15 12:17:48 -0400 | [diff] [blame] | 89 | #define IMAGE_ENABLE_SHA256 1 |
| 90 | #else |
Masahiro Yamada | 191413c | 2016-05-31 20:41:54 +0900 | [diff] [blame] | 91 | #define IMAGE_ENABLE_SHA256 0 |
| 92 | #endif |
| 93 | |
Simon Glass | e3ee2fb | 2016-02-22 22:55:43 -0700 | [diff] [blame] | 94 | #endif /* IMAGE_ENABLE_FIT */ |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 95 | |
Masahiro Yamada | 191413c | 2016-05-31 20:41:54 +0900 | [diff] [blame] | 96 | #ifdef CONFIG_SYS_BOOT_GET_CMDLINE |
| 97 | # define IMAGE_BOOT_GET_CMDLINE 1 |
| 98 | #else |
| 99 | # define IMAGE_BOOT_GET_CMDLINE 0 |
| 100 | #endif |
| 101 | |
| 102 | #ifdef CONFIG_OF_BOARD_SETUP |
| 103 | # define IMAGE_OF_BOARD_SETUP 1 |
| 104 | #else |
| 105 | # define IMAGE_OF_BOARD_SETUP 0 |
| 106 | #endif |
| 107 | |
| 108 | #ifdef CONFIG_OF_SYSTEM_SETUP |
| 109 | # define IMAGE_OF_SYSTEM_SETUP 1 |
| 110 | #else |
| 111 | # define IMAGE_OF_SYSTEM_SETUP 0 |
| 112 | #endif |
Simon Glass | 6c0be91 | 2014-10-23 18:58:54 -0600 | [diff] [blame] | 113 | |
Simon Glass | 7da41d5 | 2016-06-30 10:52:14 -0600 | [diff] [blame] | 114 | enum ih_category { |
| 115 | IH_ARCH, |
| 116 | IH_COMP, |
| 117 | IH_OS, |
| 118 | IH_TYPE, |
| 119 | |
| 120 | IH_COUNT, |
| 121 | }; |
| 122 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 123 | /* |
| 124 | * Operating System Codes |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 125 | * |
| 126 | * The following are exposed to uImage header. |
| 127 | * Do not change values for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 128 | */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 129 | enum { |
| 130 | IH_OS_INVALID = 0, /* Invalid OS */ |
| 131 | IH_OS_OPENBSD, /* OpenBSD */ |
| 132 | IH_OS_NETBSD, /* NetBSD */ |
| 133 | IH_OS_FREEBSD, /* FreeBSD */ |
| 134 | IH_OS_4_4BSD, /* 4.4BSD */ |
| 135 | IH_OS_LINUX, /* Linux */ |
| 136 | IH_OS_SVR4, /* SVR4 */ |
| 137 | IH_OS_ESIX, /* Esix */ |
| 138 | IH_OS_SOLARIS, /* Solaris */ |
| 139 | IH_OS_IRIX, /* Irix */ |
| 140 | IH_OS_SCO, /* SCO */ |
| 141 | IH_OS_DELL, /* Dell */ |
| 142 | IH_OS_NCR, /* NCR */ |
| 143 | IH_OS_LYNXOS, /* LynxOS */ |
| 144 | IH_OS_VXWORKS, /* VxWorks */ |
| 145 | IH_OS_PSOS, /* pSOS */ |
| 146 | IH_OS_QNX, /* QNX */ |
| 147 | IH_OS_U_BOOT, /* Firmware */ |
| 148 | IH_OS_RTEMS, /* RTEMS */ |
| 149 | IH_OS_ARTOS, /* ARTOS */ |
| 150 | IH_OS_UNITY, /* Unity OS */ |
| 151 | IH_OS_INTEGRITY, /* INTEGRITY */ |
| 152 | IH_OS_OSE, /* OSE */ |
| 153 | IH_OS_PLAN9, /* Plan 9 */ |
| 154 | IH_OS_OPENRTOS, /* OpenRTOS */ |
| 155 | |
| 156 | IH_OS_COUNT, |
| 157 | }; |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 158 | |
| 159 | /* |
| 160 | * CPU Architecture Codes (supported by Linux) |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 161 | * |
| 162 | * The following are exposed to uImage header. |
| 163 | * Do not change values for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 164 | */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 165 | enum { |
| 166 | IH_ARCH_INVALID = 0, /* Invalid CPU */ |
| 167 | IH_ARCH_ALPHA, /* Alpha */ |
| 168 | IH_ARCH_ARM, /* ARM */ |
| 169 | IH_ARCH_I386, /* Intel x86 */ |
| 170 | IH_ARCH_IA64, /* IA64 */ |
| 171 | IH_ARCH_MIPS, /* MIPS */ |
| 172 | IH_ARCH_MIPS64, /* MIPS 64 Bit */ |
| 173 | IH_ARCH_PPC, /* PowerPC */ |
| 174 | IH_ARCH_S390, /* IBM S390 */ |
| 175 | IH_ARCH_SH, /* SuperH */ |
| 176 | IH_ARCH_SPARC, /* Sparc */ |
| 177 | IH_ARCH_SPARC64, /* Sparc 64 Bit */ |
| 178 | IH_ARCH_M68K, /* M68K */ |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 179 | IH_ARCH_NIOS, /* Nios-32 */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 180 | IH_ARCH_MICROBLAZE, /* MicroBlaze */ |
| 181 | IH_ARCH_NIOS2, /* Nios-II */ |
| 182 | IH_ARCH_BLACKFIN, /* Blackfin */ |
| 183 | IH_ARCH_AVR32, /* AVR32 */ |
| 184 | IH_ARCH_ST200, /* STMicroelectronics ST200 */ |
| 185 | IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */ |
| 186 | IH_ARCH_NDS32, /* ANDES Technology - NDS32 */ |
| 187 | IH_ARCH_OPENRISC, /* OpenRISC 1000 */ |
| 188 | IH_ARCH_ARM64, /* ARM64 */ |
| 189 | IH_ARCH_ARC, /* Synopsys DesignWare ARC */ |
| 190 | IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */ |
Chris Zankel | 41e3737 | 2016-08-10 18:36:43 +0300 | [diff] [blame] | 191 | IH_ARCH_XTENSA, /* Xtensa */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 192 | |
| 193 | IH_ARCH_COUNT, |
| 194 | }; |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 195 | |
| 196 | /* |
| 197 | * Image Types |
| 198 | * |
| 199 | * "Standalone Programs" are directly runnable in the environment |
| 200 | * provided by U-Boot; it is expected that (if they behave |
| 201 | * well) you can continue to work in U-Boot after return from |
| 202 | * the Standalone Program. |
| 203 | * "OS Kernel Images" are usually images of some Embedded OS which |
| 204 | * will take over control completely. Usually these programs |
| 205 | * will install their own set of exception handlers, device |
| 206 | * drivers, set up the MMU, etc. - this means, that you cannot |
| 207 | * expect to re-enter U-Boot except by resetting the CPU. |
| 208 | * "RAMDisk Images" are more or less just data blocks, and their |
| 209 | * parameters (address, size) are passed to an OS kernel that is |
| 210 | * being started. |
| 211 | * "Multi-File Images" contain several images, typically an OS |
| 212 | * (Linux) kernel image and one or more data images like |
| 213 | * RAMDisks. This construct is useful for instance when you want |
| 214 | * to boot over the network using BOOTP etc., where the boot |
| 215 | * server provides just a single image file, but you want to get |
| 216 | * for instance an OS kernel and a RAMDisk image. |
| 217 | * |
| 218 | * "Multi-File Images" start with a list of image sizes, each |
| 219 | * image size (in bytes) specified by an "uint32_t" in network |
| 220 | * byte order. This list is terminated by an "(uint32_t)0". |
| 221 | * Immediately after the terminating 0 follow the images, one by |
| 222 | * one, all aligned on "uint32_t" boundaries (size rounded up to |
wdenk | 391b574 | 2004-10-10 23:27:33 +0000 | [diff] [blame] | 223 | * a multiple of 4 bytes - except for the last file). |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 224 | * |
| 225 | * "Firmware Images" are binary images containing firmware (like |
| 226 | * U-Boot or FPGA images) which usually will be programmed to |
| 227 | * flash memory. |
| 228 | * |
| 229 | * "Script files" are command sequences that will be executed by |
| 230 | * U-Boot's command interpreter; this feature is especially |
| 231 | * useful when you configure U-Boot to use a real shell (hush) |
wdenk | 874ac26 | 2003-07-24 23:38:38 +0000 | [diff] [blame] | 232 | * as command interpreter (=> Shell Scripts). |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 233 | * |
| 234 | * The following are exposed to uImage header. |
| 235 | * Do not change values for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 236 | */ |
| 237 | |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 238 | enum { |
| 239 | IH_TYPE_INVALID = 0, /* Invalid Image */ |
| 240 | IH_TYPE_STANDALONE, /* Standalone Program */ |
| 241 | IH_TYPE_KERNEL, /* OS Kernel Image */ |
| 242 | IH_TYPE_RAMDISK, /* RAMDisk Image */ |
| 243 | IH_TYPE_MULTI, /* Multi-File Image */ |
| 244 | IH_TYPE_FIRMWARE, /* Firmware Image */ |
| 245 | IH_TYPE_SCRIPT, /* Script file */ |
| 246 | IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */ |
| 247 | IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */ |
| 248 | IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */ |
| 249 | IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */ |
| 250 | IH_TYPE_UBLIMAGE, /* Davinci UBL Image */ |
| 251 | IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */ |
| 252 | IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */ |
| 253 | /* OS Kernel Image, can run from any load address */ |
| 254 | IH_TYPE_KERNEL_NOLOAD, |
| 255 | IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */ |
| 256 | IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */ |
| 257 | IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */ |
| 258 | IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */ |
| 259 | IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA Preloader */ |
| 260 | IH_TYPE_X86_SETUP, /* x86 setup.bin Image */ |
| 261 | IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */ |
| 262 | IH_TYPE_LOADABLE, /* A list of typeless images */ |
| 263 | IH_TYPE_RKIMAGE, /* Rockchip Boot Image */ |
| 264 | IH_TYPE_RKSD, /* Rockchip SD card */ |
| 265 | IH_TYPE_RKSPI, /* Rockchip SPI image */ |
| 266 | IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */ |
| 267 | IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */ |
| 268 | IH_TYPE_FPGA, /* FPGA Image */ |
Albert ARIBAUD \(3ADEV\) | 2e9f494 | 2016-09-26 09:08:06 +0200 | [diff] [blame] | 269 | IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */ |
Andrew F. Davis | 378bcff | 2016-11-29 16:33:21 -0600 | [diff] [blame] | 270 | IH_TYPE_TEE, /* Trusted Execution Environment OS Image */ |
Sven Ebenfeld | 59697a2 | 2016-11-06 16:37:56 +0100 | [diff] [blame] | 271 | IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */ |
Andrew F. Davis | 30f9d56 | 2017-07-31 10:58:20 -0500 | [diff] [blame] | 272 | IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 273 | |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 274 | IH_TYPE_COUNT, /* Number of image types */ |
| 275 | }; |
Simon Glass | 434a31b | 2015-06-23 15:38:25 -0600 | [diff] [blame] | 276 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 277 | /* |
| 278 | * Compression Types |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 279 | * |
| 280 | * The following are exposed to uImage header. |
| 281 | * Do not change values for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 282 | */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 283 | enum { |
| 284 | IH_COMP_NONE = 0, /* No Compression Used */ |
| 285 | IH_COMP_GZIP, /* gzip Compression Used */ |
| 286 | IH_COMP_BZIP2, /* bzip2 Compression Used */ |
| 287 | IH_COMP_LZMA, /* lzma Compression Used */ |
| 288 | IH_COMP_LZO, /* lzo Compression Used */ |
| 289 | IH_COMP_LZ4, /* lz4 Compression Used */ |
| 290 | |
| 291 | IH_COMP_COUNT, |
| 292 | }; |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 293 | |
| 294 | #define IH_MAGIC 0x27051956 /* Image Magic Number */ |
| 295 | #define IH_NMLEN 32 /* Image Name Length */ |
| 296 | |
Fabio Estevam | 5fd7c5d | 2013-01-03 08:24:33 +0000 | [diff] [blame] | 297 | /* Reused from common.h */ |
| 298 | #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1)) |
| 299 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 300 | /* |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 301 | * Legacy format image header, |
| 302 | * all data in network byte order (aka natural aka bigendian). |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 303 | */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 304 | typedef struct image_header { |
Kim Phillips | e69030c | 2012-10-29 13:34:30 +0000 | [diff] [blame] | 305 | __be32 ih_magic; /* Image Header Magic Number */ |
| 306 | __be32 ih_hcrc; /* Image Header CRC Checksum */ |
| 307 | __be32 ih_time; /* Image Creation Timestamp */ |
| 308 | __be32 ih_size; /* Image Data Size */ |
| 309 | __be32 ih_load; /* Data Load Address */ |
| 310 | __be32 ih_ep; /* Entry Point Address */ |
| 311 | __be32 ih_dcrc; /* Image Data CRC Checksum */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 312 | uint8_t ih_os; /* Operating System */ |
| 313 | uint8_t ih_arch; /* CPU architecture */ |
| 314 | uint8_t ih_type; /* Image Type */ |
| 315 | uint8_t ih_comp; /* Compression Type */ |
| 316 | uint8_t ih_name[IH_NMLEN]; /* Image Name */ |
| 317 | } image_header_t; |
| 318 | |
Kumar Gala | bd70bbe | 2008-08-15 08:24:41 -0500 | [diff] [blame] | 319 | typedef struct image_info { |
| 320 | ulong start, end; /* start/end of blob */ |
| 321 | ulong image_start, image_len; /* start of image within blob, len of image */ |
| 322 | ulong load; /* load addr for the image */ |
| 323 | uint8_t comp, type, os; /* compression, type of image, os type */ |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 324 | uint8_t arch; /* CPU architecture */ |
Kumar Gala | bd70bbe | 2008-08-15 08:24:41 -0500 | [diff] [blame] | 325 | } image_info_t; |
| 326 | |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 327 | /* |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 328 | * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() |
| 329 | * routines. |
| 330 | */ |
| 331 | typedef struct bootm_headers { |
| 332 | /* |
| 333 | * Legacy os image header, if it is a multi component image |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 334 | * then boot_get_ramdisk() and get_fdt() will attempt to get |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 335 | * data from second and third component accordingly. |
| 336 | */ |
Marian Balakowicz | ab00e02 | 2008-04-11 11:07:49 +0200 | [diff] [blame] | 337 | image_header_t *legacy_hdr_os; /* image header pointer */ |
| 338 | image_header_t legacy_hdr_os_copy; /* header copy */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 339 | ulong legacy_hdr_valid; |
| 340 | |
Simon Glass | e3ee2fb | 2016-02-22 22:55:43 -0700 | [diff] [blame] | 341 | #if IMAGE_ENABLE_FIT |
Marian Balakowicz | 0cd4f3d | 2008-03-12 10:35:46 +0100 | [diff] [blame] | 342 | const char *fit_uname_cfg; /* configuration node unit name */ |
| 343 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 344 | void *fit_hdr_os; /* os FIT image header */ |
Marian Balakowicz | 6a2b2c2 | 2008-03-10 17:53:49 +0100 | [diff] [blame] | 345 | const char *fit_uname_os; /* os subimage node unit name */ |
Marian Balakowicz | 61c1ad5 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 346 | int fit_noffset_os; /* os subimage node offset */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 347 | |
| 348 | void *fit_hdr_rd; /* init ramdisk FIT image header */ |
Marian Balakowicz | 61c1ad5 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 349 | const char *fit_uname_rd; /* init ramdisk subimage node unit name */ |
| 350 | int fit_noffset_rd; /* init ramdisk subimage node offset */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 351 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 352 | void *fit_hdr_fdt; /* FDT blob FIT image header */ |
Marian Balakowicz | 61c1ad5 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 353 | const char *fit_uname_fdt; /* FDT blob subimage node unit name */ |
| 354 | int fit_noffset_fdt;/* FDT blob subimage node offset */ |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 355 | |
| 356 | void *fit_hdr_setup; /* x86 setup FIT image header */ |
| 357 | const char *fit_uname_setup; /* x86 setup subimage node name */ |
| 358 | int fit_noffset_setup;/* x86 setup subimage node offset */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 359 | #endif |
Marian Balakowicz | aa6aae4 | 2008-03-12 10:35:52 +0100 | [diff] [blame] | 360 | |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 361 | #ifndef USE_HOSTCC |
Kumar Gala | bd70bbe | 2008-08-15 08:24:41 -0500 | [diff] [blame] | 362 | image_info_t os; /* os image info */ |
Kumar Gala | 93467bc | 2008-08-15 08:24:36 -0500 | [diff] [blame] | 363 | ulong ep; /* entry point of OS */ |
| 364 | |
Kumar Gala | fffb143 | 2008-08-15 08:24:37 -0500 | [diff] [blame] | 365 | ulong rd_start, rd_end;/* ramdisk start/end */ |
| 366 | |
Kumar Gala | a5130ad | 2008-08-15 08:24:38 -0500 | [diff] [blame] | 367 | char *ft_addr; /* flat dev tree address */ |
Kumar Gala | a5130ad | 2008-08-15 08:24:38 -0500 | [diff] [blame] | 368 | ulong ft_len; /* length of flat device tree */ |
| 369 | |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 370 | ulong initrd_start; |
| 371 | ulong initrd_end; |
| 372 | ulong cmdline_start; |
| 373 | ulong cmdline_end; |
| 374 | bd_t *kbd; |
| 375 | #endif |
| 376 | |
Simon Glass | 64b723f | 2017-08-03 12:22:12 -0600 | [diff] [blame] | 377 | int verify; /* env_get("verify")[0] != 'n' */ |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 378 | |
| 379 | #define BOOTM_STATE_START (0x00000001) |
Simon Glass | 3081e2e | 2013-06-11 11:14:47 -0700 | [diff] [blame] | 380 | #define BOOTM_STATE_FINDOS (0x00000002) |
| 381 | #define BOOTM_STATE_FINDOTHER (0x00000004) |
| 382 | #define BOOTM_STATE_LOADOS (0x00000008) |
| 383 | #define BOOTM_STATE_RAMDISK (0x00000010) |
| 384 | #define BOOTM_STATE_FDT (0x00000020) |
| 385 | #define BOOTM_STATE_OS_CMDLINE (0x00000040) |
| 386 | #define BOOTM_STATE_OS_BD_T (0x00000080) |
| 387 | #define BOOTM_STATE_OS_PREP (0x00000100) |
Simon Glass | 0013488 | 2013-06-11 11:14:48 -0700 | [diff] [blame] | 388 | #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */ |
| 389 | #define BOOTM_STATE_OS_GO (0x00000400) |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 390 | int state; |
| 391 | |
Mike Frysinger | a0dadf8 | 2009-11-03 11:35:59 -0500 | [diff] [blame] | 392 | #ifdef CONFIG_LMB |
Kumar Gala | da6d11e | 2008-08-15 08:24:40 -0500 | [diff] [blame] | 393 | struct lmb lmb; /* for memory mgmt */ |
| 394 | #endif |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 395 | } bootm_headers_t; |
| 396 | |
Simon Schwarz | af775a0 | 2012-03-15 04:01:34 +0000 | [diff] [blame] | 397 | extern bootm_headers_t images; |
| 398 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 399 | /* |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 400 | * Some systems (for example LWMON) have very short watchdog periods; |
| 401 | * we must make sure to split long operations like memmove() or |
Bartlomiej Sieka | 222e2ca | 2008-04-25 13:54:02 +0200 | [diff] [blame] | 402 | * checksum calculations into reasonable chunks. |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 403 | */ |
Bartlomiej Sieka | 222e2ca | 2008-04-25 13:54:02 +0200 | [diff] [blame] | 404 | #ifndef CHUNKSZ |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 405 | #define CHUNKSZ (64 * 1024) |
Bartlomiej Sieka | 222e2ca | 2008-04-25 13:54:02 +0200 | [diff] [blame] | 406 | #endif |
| 407 | |
| 408 | #ifndef CHUNKSZ_CRC32 |
| 409 | #define CHUNKSZ_CRC32 (64 * 1024) |
| 410 | #endif |
| 411 | |
| 412 | #ifndef CHUNKSZ_MD5 |
| 413 | #define CHUNKSZ_MD5 (64 * 1024) |
| 414 | #endif |
| 415 | |
| 416 | #ifndef CHUNKSZ_SHA1 |
| 417 | #define CHUNKSZ_SHA1 (64 * 1024) |
| 418 | #endif |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 419 | |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 420 | #define uimage_to_cpu(x) be32_to_cpu(x) |
| 421 | #define cpu_to_uimage(x) cpu_to_be32(x) |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 422 | |
Prafulla Wadaskar | 4454c9e | 2009-09-07 14:59:08 +0530 | [diff] [blame] | 423 | /* |
| 424 | * Translation table for entries of a specific type; used by |
| 425 | * get_table_entry_id() and get_table_entry_name(). |
| 426 | */ |
| 427 | typedef struct table_entry { |
| 428 | int id; |
| 429 | char *sname; /* short (input) name to find table entry */ |
| 430 | char *lname; /* long (output) name to print for messages */ |
| 431 | } table_entry_t; |
| 432 | |
| 433 | /* |
| 434 | * get_table_entry_id() scans the translation table trying to find an |
| 435 | * entry that matches the given short name. If a matching entry is |
| 436 | * found, it's id is returned to the caller. |
| 437 | */ |
Mike Frysinger | cf2feb1 | 2010-10-20 07:17:39 -0400 | [diff] [blame] | 438 | int get_table_entry_id(const table_entry_t *table, |
Prafulla Wadaskar | 4454c9e | 2009-09-07 14:59:08 +0530 | [diff] [blame] | 439 | const char *table_name, const char *name); |
| 440 | /* |
| 441 | * get_table_entry_name() scans the translation table trying to find |
| 442 | * an entry that matches the given id. If a matching entry is found, |
| 443 | * its long name is returned to the caller. |
| 444 | */ |
Mike Frysinger | cf2feb1 | 2010-10-20 07:17:39 -0400 | [diff] [blame] | 445 | char *get_table_entry_name(const table_entry_t *table, char *msg, int id); |
Prafulla Wadaskar | 4454c9e | 2009-09-07 14:59:08 +0530 | [diff] [blame] | 446 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 447 | const char *genimg_get_os_name(uint8_t os); |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 448 | |
| 449 | /** |
| 450 | * genimg_get_os_short_name() - get the short name for an OS |
| 451 | * |
| 452 | * @param os OS (IH_OS_...) |
| 453 | * @return OS short name, or "unknown" if unknown |
| 454 | */ |
| 455 | const char *genimg_get_os_short_name(uint8_t comp); |
| 456 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 457 | const char *genimg_get_arch_name(uint8_t arch); |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 458 | |
| 459 | /** |
| 460 | * genimg_get_arch_short_name() - get the short name for an architecture |
| 461 | * |
| 462 | * @param arch Architecture type (IH_ARCH_...) |
| 463 | * @return architecture short name, or "unknown" if unknown |
| 464 | */ |
| 465 | const char *genimg_get_arch_short_name(uint8_t arch); |
| 466 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 467 | const char *genimg_get_type_name(uint8_t type); |
Simon Glass | 434a31b | 2015-06-23 15:38:25 -0600 | [diff] [blame] | 468 | |
| 469 | /** |
| 470 | * genimg_get_type_short_name() - get the short name for an image type |
| 471 | * |
| 472 | * @param type Image type (IH_TYPE_...) |
| 473 | * @return image short name, or "unknown" if unknown |
| 474 | */ |
| 475 | const char *genimg_get_type_short_name(uint8_t type); |
| 476 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 477 | const char *genimg_get_comp_name(uint8_t comp); |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 478 | |
| 479 | /** |
| 480 | * genimg_get_comp_short_name() - get the short name for a compression method |
| 481 | * |
| 482 | * @param comp compression method (IH_COMP_...) |
| 483 | * @return compression method short name, or "unknown" if unknown |
| 484 | */ |
| 485 | const char *genimg_get_comp_short_name(uint8_t comp); |
| 486 | |
Simon Glass | 1986433 | 2016-06-30 10:52:16 -0600 | [diff] [blame] | 487 | /** |
| 488 | * genimg_get_cat_name() - Get the name of an item in a category |
| 489 | * |
| 490 | * @category: Category of item |
| 491 | * @id: Item ID |
| 492 | * @return name of item, or "Unknown ..." if unknown |
| 493 | */ |
| 494 | const char *genimg_get_cat_name(enum ih_category category, uint id); |
| 495 | |
| 496 | /** |
| 497 | * genimg_get_cat_short_name() - Get the short name of an item in a category |
| 498 | * |
| 499 | * @category: Category of item |
| 500 | * @id: Item ID |
| 501 | * @return short name of item, or "Unknown ..." if unknown |
| 502 | */ |
| 503 | const char *genimg_get_cat_short_name(enum ih_category category, uint id); |
| 504 | |
| 505 | /** |
| 506 | * genimg_get_cat_count() - Get the number of items in a category |
| 507 | * |
| 508 | * @category: Category to check |
| 509 | * @return the number of items in the category (IH_xxx_COUNT) |
| 510 | */ |
| 511 | int genimg_get_cat_count(enum ih_category category); |
| 512 | |
| 513 | /** |
| 514 | * genimg_get_cat_desc() - Get the description of a category |
| 515 | * |
| 516 | * @return the description of a category, e.g. "architecture". This |
| 517 | * effectively converts the enum to a string. |
| 518 | */ |
| 519 | const char *genimg_get_cat_desc(enum ih_category category); |
| 520 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 521 | int genimg_get_os_id(const char *name); |
| 522 | int genimg_get_arch_id(const char *name); |
| 523 | int genimg_get_type_id(const char *name); |
| 524 | int genimg_get_comp_id(const char *name); |
| 525 | void genimg_print_size(uint32_t size); |
Marian Balakowicz | c3c7eb2 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 526 | |
Simon Glass | af0ec0d | 2013-05-07 06:11:51 +0000 | [diff] [blame] | 527 | #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || \ |
| 528 | defined(USE_HOSTCC) |
| 529 | #define IMAGE_ENABLE_TIMESTAMP 1 |
| 530 | #else |
| 531 | #define IMAGE_ENABLE_TIMESTAMP 0 |
| 532 | #endif |
| 533 | void genimg_print_time(time_t timestamp); |
| 534 | |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 535 | /* What to do with a image load address ('load = <> 'in the FIT) */ |
| 536 | enum fit_load_op { |
| 537 | FIT_LOAD_IGNORED, /* Ignore load address */ |
| 538 | FIT_LOAD_OPTIONAL, /* Can be provided, but optional */ |
Simon Glass | 05a9ad7 | 2014-08-22 14:26:43 -0600 | [diff] [blame] | 539 | FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */ |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 540 | FIT_LOAD_REQUIRED, /* Must be provided */ |
| 541 | }; |
| 542 | |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 543 | int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start, |
| 544 | ulong *setup_len); |
| 545 | |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 546 | #ifndef USE_HOSTCC |
| 547 | /* Image format types, returned by _get_format() routine */ |
| 548 | #define IMAGE_FORMAT_INVALID 0x00 |
Heiko Schocher | 515eb12 | 2014-05-28 11:33:33 +0200 | [diff] [blame] | 549 | #if defined(CONFIG_IMAGE_FORMAT_LEGACY) |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 550 | #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ |
Heiko Schocher | 515eb12 | 2014-05-28 11:33:33 +0200 | [diff] [blame] | 551 | #endif |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 552 | #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ |
Sebastian Siewior | 686d667 | 2014-05-05 15:08:09 -0500 | [diff] [blame] | 553 | #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */ |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 554 | |
Bryan Wu | f5c377a | 2014-08-15 16:51:38 -0700 | [diff] [blame] | 555 | ulong genimg_get_kernel_addr_fit(char * const img_addr, |
| 556 | const char **fit_uname_config, |
| 557 | const char **fit_uname_kernel); |
Bryan Wu | af7b0de | 2014-07-31 17:39:58 -0700 | [diff] [blame] | 558 | ulong genimg_get_kernel_addr(char * const img_addr); |
Simon Glass | 4964806 | 2013-05-07 06:12:03 +0000 | [diff] [blame] | 559 | int genimg_get_format(const void *img_addr); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 560 | int genimg_has_config(bootm_headers_t *images); |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 561 | |
Michal Simek | ebae78b | 2016-05-17 14:03:50 +0200 | [diff] [blame] | 562 | int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images, |
| 563 | uint8_t arch, const ulong *ld_start, ulong * const ld_len); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 564 | int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images, |
Marian Balakowicz | a0ffb42 | 2008-03-12 10:14:38 +0100 | [diff] [blame] | 565 | uint8_t arch, ulong *rd_start, ulong *rd_end); |
Karl Apsite | 1b21c28 | 2015-05-21 09:52:48 -0400 | [diff] [blame] | 566 | |
| 567 | /** |
| 568 | * boot_get_loadable - routine to load a list of binaries to memory |
| 569 | * @argc: Ignored Argument |
| 570 | * @argv: Ignored Argument |
| 571 | * @images: pointer to the bootm images structure |
| 572 | * @arch: expected architecture for the image |
| 573 | * @ld_start: Ignored Argument |
| 574 | * @ld_len: Ignored Argument |
| 575 | * |
| 576 | * boot_get_loadable() will take the given FIT configuration, and look |
| 577 | * for a field named "loadables". Loadables, is a list of elements in |
| 578 | * the FIT given as strings. exe: |
| 579 | * loadables = "linux_kernel@1", "fdt@2"; |
| 580 | * this function will attempt to parse each string, and load the |
| 581 | * corresponding element from the FIT into memory. Once placed, |
| 582 | * no aditional actions are taken. |
| 583 | * |
| 584 | * @return: |
| 585 | * 0, if only valid images or no images are found |
| 586 | * error code, if an error occurs during fit_image_load |
| 587 | */ |
| 588 | int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images, |
| 589 | uint8_t arch, const ulong *ld_start, ulong * const ld_len); |
| 590 | #endif /* !USE_HOSTCC */ |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 591 | |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 592 | int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch, |
| 593 | ulong *setup_start, ulong *setup_len); |
| 594 | |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 595 | /** |
Pantelis Antoniou | 6e51fb2 | 2017-09-04 23:12:16 +0300 | [diff] [blame] | 596 | * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays) |
| 597 | * |
| 598 | * This deals with all aspects of loading an DTB from a FIT. |
| 599 | * The correct base image based on configuration will be selected, and |
| 600 | * then any overlays specified will be applied (as present in fit_uname_configp). |
| 601 | * |
| 602 | * @param images Boot images structure |
| 603 | * @param addr Address of FIT in memory |
| 604 | * @param fit_unamep On entry this is the requested image name |
| 605 | * (e.g. "kernel@1") or NULL to use the default. On exit |
| 606 | * points to the selected image name |
| 607 | * @param fit_uname_configp On entry this is the requested configuration |
| 608 | * name (e.g. "conf@1") or NULL to use the default. On |
| 609 | * exit points to the selected configuration name. |
| 610 | * @param arch Expected architecture (IH_ARCH_...) |
| 611 | * @param datap Returns address of loaded image |
| 612 | * @param lenp Returns length of loaded image |
| 613 | * |
| 614 | * @return node offset of base image, or -ve error code on error |
| 615 | */ |
| 616 | int boot_get_fdt_fit(bootm_headers_t *images, ulong addr, |
| 617 | const char **fit_unamep, const char **fit_uname_configp, |
| 618 | int arch, ulong *datap, ulong *lenp); |
| 619 | |
| 620 | /** |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 621 | * fit_image_load() - load an image from a FIT |
| 622 | * |
| 623 | * This deals with all aspects of loading an image from a FIT, including |
| 624 | * selecting the right image based on configuration, verifying it, printing |
| 625 | * out progress messages, checking the type/arch/os and optionally copying it |
| 626 | * to the right load address. |
| 627 | * |
Simon Glass | a0c0b63 | 2014-06-12 07:24:47 -0600 | [diff] [blame] | 628 | * The property to look up is defined by image_type. |
| 629 | * |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 630 | * @param images Boot images structure |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 631 | * @param addr Address of FIT in memory |
| 632 | * @param fit_unamep On entry this is the requested image name |
| 633 | * (e.g. "kernel@1") or NULL to use the default. On exit |
| 634 | * points to the selected image name |
Simon Glass | ad68fc3 | 2013-07-10 23:08:10 -0700 | [diff] [blame] | 635 | * @param fit_uname_configp On entry this is the requested configuration |
| 636 | * name (e.g. "conf@1") or NULL to use the default. On |
| 637 | * exit points to the selected configuration name. |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 638 | * @param arch Expected architecture (IH_ARCH_...) |
| 639 | * @param image_type Required image type (IH_TYPE_...). If this is |
| 640 | * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD |
| 641 | * also. |
| 642 | * @param bootstage_id ID of starting bootstage to use for progress updates. |
| 643 | * This will be added to the BOOTSTAGE_SUB values when |
| 644 | * calling bootstage_mark() |
| 645 | * @param load_op Decribes what to do with the load address |
| 646 | * @param datap Returns address of loaded image |
| 647 | * @param lenp Returns length of loaded image |
Simon Glass | a51991d | 2014-06-12 07:24:53 -0600 | [diff] [blame] | 648 | * @return node offset of image, or -ve error code on error |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 649 | */ |
Simon Glass | a0c0b63 | 2014-06-12 07:24:47 -0600 | [diff] [blame] | 650 | int fit_image_load(bootm_headers_t *images, ulong addr, |
Simon Glass | ad68fc3 | 2013-07-10 23:08:10 -0700 | [diff] [blame] | 651 | const char **fit_unamep, const char **fit_uname_configp, |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 652 | int arch, int image_type, int bootstage_id, |
| 653 | enum fit_load_op load_op, ulong *datap, ulong *lenp); |
| 654 | |
Simon Glass | a51991d | 2014-06-12 07:24:53 -0600 | [diff] [blame] | 655 | #ifndef USE_HOSTCC |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 656 | /** |
| 657 | * fit_get_node_from_config() - Look up an image a FIT by type |
| 658 | * |
| 659 | * This looks in the selected conf@ node (images->fit_uname_cfg) for a |
| 660 | * particular image type (e.g. "kernel") and then finds the image that is |
| 661 | * referred to. |
| 662 | * |
| 663 | * For example, for something like: |
| 664 | * |
| 665 | * images { |
| 666 | * kernel@1 { |
| 667 | * ... |
| 668 | * }; |
| 669 | * }; |
| 670 | * configurations { |
| 671 | * conf@1 { |
| 672 | * kernel = "kernel@1"; |
| 673 | * }; |
| 674 | * }; |
| 675 | * |
| 676 | * the function will return the node offset of the kernel@1 node, assuming |
| 677 | * that conf@1 is the chosen configuration. |
| 678 | * |
| 679 | * @param images Boot images structure |
| 680 | * @param prop_name Property name to look up (FIT_..._PROP) |
| 681 | * @param addr Address of FIT in memory |
| 682 | */ |
| 683 | int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name, |
| 684 | ulong addr); |
| 685 | |
Simon Glass | b1b7992 | 2013-05-16 13:53:23 +0000 | [diff] [blame] | 686 | int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch, |
| 687 | bootm_headers_t *images, |
| 688 | char **of_flat_tree, ulong *of_size); |
Grant Likely | 20f5492 | 2011-03-28 09:59:01 +0000 | [diff] [blame] | 689 | void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 690 | int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size); |
Kumar Gala | a5130ad | 2008-08-15 08:24:38 -0500 | [diff] [blame] | 691 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 692 | int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len, |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 693 | ulong *initrd_start, ulong *initrd_end); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 694 | int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end); |
John Rigby | eea8e69 | 2010-10-13 13:57:35 -0600 | [diff] [blame] | 695 | #ifdef CONFIG_SYS_BOOT_GET_KBD |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 696 | int boot_get_kbd(struct lmb *lmb, bd_t **kbd); |
John Rigby | eea8e69 | 2010-10-13 13:57:35 -0600 | [diff] [blame] | 697 | #endif /* CONFIG_SYS_BOOT_GET_KBD */ |
Marian Balakowicz | c3c7eb2 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 698 | #endif /* !USE_HOSTCC */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 699 | |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 700 | /*******************************************************************/ |
| 701 | /* Legacy format specific code (prefixed with image_) */ |
| 702 | /*******************************************************************/ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 703 | static inline uint32_t image_get_header_size(void) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 704 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 705 | return (sizeof(image_header_t)); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 706 | } |
| 707 | |
| 708 | #define image_get_hdr_l(f) \ |
Wolfgang Denk | 3b50677 | 2009-08-19 11:42:56 +0200 | [diff] [blame] | 709 | static inline uint32_t image_get_##f(const image_header_t *hdr) \ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 710 | { \ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 711 | return uimage_to_cpu(hdr->ih_##f); \ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 712 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 713 | image_get_hdr_l(magic) /* image_get_magic */ |
| 714 | image_get_hdr_l(hcrc) /* image_get_hcrc */ |
| 715 | image_get_hdr_l(time) /* image_get_time */ |
| 716 | image_get_hdr_l(size) /* image_get_size */ |
| 717 | image_get_hdr_l(load) /* image_get_load */ |
| 718 | image_get_hdr_l(ep) /* image_get_ep */ |
| 719 | image_get_hdr_l(dcrc) /* image_get_dcrc */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 720 | |
| 721 | #define image_get_hdr_b(f) \ |
Wolfgang Denk | 3b50677 | 2009-08-19 11:42:56 +0200 | [diff] [blame] | 722 | static inline uint8_t image_get_##f(const image_header_t *hdr) \ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 723 | { \ |
| 724 | return hdr->ih_##f; \ |
| 725 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 726 | image_get_hdr_b(os) /* image_get_os */ |
| 727 | image_get_hdr_b(arch) /* image_get_arch */ |
| 728 | image_get_hdr_b(type) /* image_get_type */ |
| 729 | image_get_hdr_b(comp) /* image_get_comp */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 730 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 731 | static inline char *image_get_name(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 732 | { |
| 733 | return (char *)hdr->ih_name; |
| 734 | } |
| 735 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 736 | static inline uint32_t image_get_data_size(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 737 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 738 | return image_get_size(hdr); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 739 | } |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 740 | |
| 741 | /** |
| 742 | * image_get_data - get image payload start address |
| 743 | * @hdr: image header |
| 744 | * |
| 745 | * image_get_data() returns address of the image payload. For single |
| 746 | * component images it is image data start. For multi component |
| 747 | * images it points to the null terminated table of sub-images sizes. |
| 748 | * |
| 749 | * returns: |
| 750 | * image payload data start address |
| 751 | */ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 752 | static inline ulong image_get_data(const image_header_t *hdr) |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 753 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 754 | return ((ulong)hdr + image_get_header_size()); |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 755 | } |
| 756 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 757 | static inline uint32_t image_get_image_size(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 758 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 759 | return (image_get_size(hdr) + image_get_header_size()); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 760 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 761 | static inline ulong image_get_image_end(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 762 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 763 | return ((ulong)hdr + image_get_image_size(hdr)); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 764 | } |
| 765 | |
| 766 | #define image_set_hdr_l(f) \ |
| 767 | static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ |
| 768 | { \ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 769 | hdr->ih_##f = cpu_to_uimage(val); \ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 770 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 771 | image_set_hdr_l(magic) /* image_set_magic */ |
| 772 | image_set_hdr_l(hcrc) /* image_set_hcrc */ |
| 773 | image_set_hdr_l(time) /* image_set_time */ |
| 774 | image_set_hdr_l(size) /* image_set_size */ |
| 775 | image_set_hdr_l(load) /* image_set_load */ |
| 776 | image_set_hdr_l(ep) /* image_set_ep */ |
| 777 | image_set_hdr_l(dcrc) /* image_set_dcrc */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 778 | |
| 779 | #define image_set_hdr_b(f) \ |
| 780 | static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ |
| 781 | { \ |
| 782 | hdr->ih_##f = val; \ |
| 783 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 784 | image_set_hdr_b(os) /* image_set_os */ |
| 785 | image_set_hdr_b(arch) /* image_set_arch */ |
| 786 | image_set_hdr_b(type) /* image_set_type */ |
| 787 | image_set_hdr_b(comp) /* image_set_comp */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 788 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 789 | static inline void image_set_name(image_header_t *hdr, const char *name) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 790 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 791 | strncpy(image_get_name(hdr), name, IH_NMLEN); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 792 | } |
| 793 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 794 | int image_check_hcrc(const image_header_t *hdr); |
| 795 | int image_check_dcrc(const image_header_t *hdr); |
Marian Balakowicz | f9a67bd | 2008-01-08 18:11:45 +0100 | [diff] [blame] | 796 | #ifndef USE_HOSTCC |
Simon Glass | da1a134 | 2017-08-03 12:22:15 -0600 | [diff] [blame] | 797 | ulong env_get_bootm_low(void); |
| 798 | phys_size_t env_get_bootm_size(void); |
| 799 | phys_size_t env_get_bootm_mapsize(void); |
Marian Balakowicz | f9a67bd | 2008-01-08 18:11:45 +0100 | [diff] [blame] | 800 | #endif |
Simon Glass | a51991d | 2014-06-12 07:24:53 -0600 | [diff] [blame] | 801 | void memmove_wd(void *to, void *from, size_t len, ulong chunksz); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 802 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 803 | static inline int image_check_magic(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 804 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 805 | return (image_get_magic(hdr) == IH_MAGIC); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 806 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 807 | static inline int image_check_type(const image_header_t *hdr, uint8_t type) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 808 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 809 | return (image_get_type(hdr) == type); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 810 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 811 | static inline int image_check_arch(const image_header_t *hdr, uint8_t arch) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 812 | { |
Alison Wang | 42664e0 | 2017-06-06 15:32:40 +0800 | [diff] [blame] | 813 | return (image_get_arch(hdr) == arch) || |
| 814 | (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 815 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 816 | static inline int image_check_os(const image_header_t *hdr, uint8_t os) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 817 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 818 | return (image_get_os(hdr) == os); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 819 | } |
| 820 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 821 | ulong image_multi_count(const image_header_t *hdr); |
| 822 | void image_multi_getimg(const image_header_t *hdr, ulong idx, |
Marian Balakowicz | 05c1d3f | 2008-01-31 13:20:07 +0100 | [diff] [blame] | 823 | ulong *data, ulong *len); |
| 824 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 825 | void image_print_contents(const void *hdr); |
Marian Balakowicz | c3c7eb2 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 826 | |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 827 | #ifndef USE_HOSTCC |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 828 | static inline int image_check_target_arch(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 829 | { |
Mike Frysinger | 5da0bed | 2011-10-03 14:50:33 +0000 | [diff] [blame] | 830 | #ifndef IH_ARCH_DEFAULT |
| 831 | # error "please define IH_ARCH_DEFAULT in your arch asm/u-boot.h" |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 832 | #endif |
Mike Frysinger | 5da0bed | 2011-10-03 14:50:33 +0000 | [diff] [blame] | 833 | return image_check_arch(hdr, IH_ARCH_DEFAULT); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 834 | } |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 835 | #endif /* USE_HOSTCC */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 836 | |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 837 | /** |
| 838 | * Set up properties in the FDT |
| 839 | * |
| 840 | * This sets up properties in the FDT that is to be passed to linux. |
| 841 | * |
| 842 | * @images: Images information |
| 843 | * @blob: FDT to update |
| 844 | * @of_size: Size of the FDT |
| 845 | * @lmb: Points to logical memory block structure |
| 846 | * @return 0 if ok, <0 on failure |
| 847 | */ |
| 848 | int image_setup_libfdt(bootm_headers_t *images, void *blob, |
| 849 | int of_size, struct lmb *lmb); |
| 850 | |
| 851 | /** |
| 852 | * Set up the FDT to use for booting a kernel |
| 853 | * |
| 854 | * This performs ramdisk setup, sets up the FDT if required, and adds |
| 855 | * paramters to the FDT if libfdt is available. |
| 856 | * |
| 857 | * @param images Images information |
| 858 | * @return 0 if ok, <0 on failure |
| 859 | */ |
| 860 | int image_setup_linux(bootm_headers_t *images); |
| 861 | |
Simon Glass | 5f1afdd | 2013-07-04 13:26:10 -0700 | [diff] [blame] | 862 | /** |
| 863 | * bootz_setup() - Extract stat and size of a Linux xImage |
| 864 | * |
| 865 | * @image: Address of image |
| 866 | * @start: Returns start address of image |
| 867 | * @end : Returns end address of image |
| 868 | * @return 0 if OK, 1 if the image was not recognised |
| 869 | */ |
| 870 | int bootz_setup(ulong image, ulong *start, ulong *end); |
| 871 | |
| 872 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 873 | /*******************************************************************/ |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 874 | /* New uImage format specific code (prefixed with fit_) */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 875 | /*******************************************************************/ |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 876 | |
| 877 | #define FIT_IMAGES_PATH "/images" |
| 878 | #define FIT_CONFS_PATH "/configurations" |
| 879 | |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 880 | /* hash/signature node */ |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 881 | #define FIT_HASH_NODENAME "hash" |
| 882 | #define FIT_ALGO_PROP "algo" |
| 883 | #define FIT_VALUE_PROP "value" |
Joe Hershberger | 8b7d32a | 2012-08-17 10:34:39 +0000 | [diff] [blame] | 884 | #define FIT_IGNORE_PROP "uboot-ignore" |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 885 | #define FIT_SIG_NODENAME "signature" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 886 | |
| 887 | /* image node */ |
| 888 | #define FIT_DATA_PROP "data" |
tomas.melin@vaisala.com | 45ee790 | 2017-01-13 13:20:14 +0200 | [diff] [blame] | 889 | #define FIT_DATA_OFFSET_PROP "data-offset" |
| 890 | #define FIT_DATA_SIZE_PROP "data-size" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 891 | #define FIT_TIMESTAMP_PROP "timestamp" |
| 892 | #define FIT_DESC_PROP "description" |
| 893 | #define FIT_ARCH_PROP "arch" |
| 894 | #define FIT_TYPE_PROP "type" |
| 895 | #define FIT_OS_PROP "os" |
| 896 | #define FIT_COMP_PROP "compression" |
| 897 | #define FIT_ENTRY_PROP "entry" |
| 898 | #define FIT_LOAD_PROP "load" |
| 899 | |
| 900 | /* configuration node */ |
| 901 | #define FIT_KERNEL_PROP "kernel" |
| 902 | #define FIT_RAMDISK_PROP "ramdisk" |
| 903 | #define FIT_FDT_PROP "fdt" |
Karl Apsite | 8f0537d | 2015-05-21 09:52:47 -0400 | [diff] [blame] | 904 | #define FIT_LOADABLE_PROP "loadables" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 905 | #define FIT_DEFAULT_PROP "default" |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 906 | #define FIT_SETUP_PROP "setup" |
Michal Simek | 0a130b1 | 2016-05-17 13:58:44 +0200 | [diff] [blame] | 907 | #define FIT_FPGA_PROP "fpga" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 908 | |
Michael van der Westhuizen | e36c6c3 | 2014-05-30 20:59:00 +0200 | [diff] [blame] | 909 | #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 910 | |
Simon Glass | a6131a2 | 2016-02-22 22:55:56 -0700 | [diff] [blame] | 911 | #if IMAGE_ENABLE_FIT |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 912 | /* cmdline argument format parsing */ |
Mike Frysinger | 711453d | 2012-04-22 06:59:06 +0000 | [diff] [blame] | 913 | int fit_parse_conf(const char *spec, ulong addr_curr, |
Marian Balakowicz | 3413e22 | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 914 | ulong *addr, const char **conf_name); |
Mike Frysinger | 711453d | 2012-04-22 06:59:06 +0000 | [diff] [blame] | 915 | int fit_parse_subimage(const char *spec, ulong addr_curr, |
Marian Balakowicz | 3413e22 | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 916 | ulong *addr, const char **image_name); |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 917 | |
Guilherme Maciel Ferreira | 3c46bcd | 2015-01-15 02:54:42 -0200 | [diff] [blame] | 918 | int fit_get_subimage_count(const void *fit, int images_noffset); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 919 | void fit_print_contents(const void *fit); |
| 920 | void fit_image_print(const void *fit, int noffset, const char *p); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 921 | |
| 922 | /** |
| 923 | * fit_get_end - get FIT image size |
| 924 | * @fit: pointer to the FIT format image header |
| 925 | * |
| 926 | * returns: |
| 927 | * size of the FIT image (blob) in memory |
| 928 | */ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 929 | static inline ulong fit_get_size(const void *fit) |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 930 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 931 | return fdt_totalsize(fit); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 932 | } |
| 933 | |
| 934 | /** |
| 935 | * fit_get_end - get FIT image end |
| 936 | * @fit: pointer to the FIT format image header |
| 937 | * |
| 938 | * returns: |
| 939 | * end address of the FIT image (blob) in memory |
| 940 | */ |
Simon Glass | 5b539a0 | 2016-02-24 09:14:42 -0700 | [diff] [blame] | 941 | ulong fit_get_end(const void *fit); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 942 | |
| 943 | /** |
| 944 | * fit_get_name - get FIT node name |
| 945 | * @fit: pointer to the FIT format image header |
| 946 | * |
| 947 | * returns: |
| 948 | * NULL, on error |
| 949 | * pointer to node name, on success |
| 950 | */ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 951 | static inline const char *fit_get_name(const void *fit_hdr, |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 952 | int noffset, int *len) |
| 953 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 954 | return fdt_get_name(fit_hdr, noffset, len); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 955 | } |
| 956 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 957 | int fit_get_desc(const void *fit, int noffset, char **desc); |
| 958 | int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 959 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 960 | int fit_image_get_node(const void *fit, const char *image_uname); |
| 961 | int fit_image_get_os(const void *fit, int noffset, uint8_t *os); |
| 962 | int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); |
| 963 | int fit_image_get_type(const void *fit, int noffset, uint8_t *type); |
| 964 | int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); |
| 965 | int fit_image_get_load(const void *fit, int noffset, ulong *load); |
| 966 | int fit_image_get_entry(const void *fit, int noffset, ulong *entry); |
| 967 | int fit_image_get_data(const void *fit, int noffset, |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 968 | const void **data, size_t *size); |
tomas.melin@vaisala.com | 45ee790 | 2017-01-13 13:20:14 +0200 | [diff] [blame] | 969 | int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset); |
| 970 | int fit_image_get_data_size(const void *fit, int noffset, int *data_size); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 971 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 972 | int fit_image_hash_get_algo(const void *fit, int noffset, char **algo); |
| 973 | int fit_image_hash_get_value(const void *fit, int noffset, uint8_t **value, |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 974 | int *value_len); |
| 975 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 976 | int fit_set_timestamp(void *fit, int noffset, time_t timestamp); |
Simon Glass | ee38265 | 2013-05-07 06:12:01 +0000 | [diff] [blame] | 977 | |
| 978 | /** |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 979 | * fit_add_verification_data() - add verification data to FIT image nodes |
Simon Glass | ee38265 | 2013-05-07 06:12:01 +0000 | [diff] [blame] | 980 | * |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 981 | * @keydir: Directory containing keys |
| 982 | * @kwydest: FDT blob to write public key information to |
| 983 | * @fit: Pointer to the FIT format image header |
| 984 | * @comment: Comment to add to signature nodes |
| 985 | * @require_keys: Mark all keys as 'required' |
George McCollister | 23d1489 | 2017-01-06 13:14:17 -0600 | [diff] [blame] | 986 | * @engine_id: Engine to use for signing |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 987 | * |
| 988 | * Adds hash values for all component images in the FIT blob. |
| 989 | * Hashes are calculated for all component images which have hash subnodes |
| 990 | * with algorithm property set to one of the supported hash algorithms. |
| 991 | * |
| 992 | * Also add signatures if signature nodes are present. |
| 993 | * |
| 994 | * returns |
| 995 | * 0, on success |
| 996 | * libfdt error code, on failure |
Simon Glass | ee38265 | 2013-05-07 06:12:01 +0000 | [diff] [blame] | 997 | */ |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 998 | int fit_add_verification_data(const char *keydir, void *keydest, void *fit, |
George McCollister | 23d1489 | 2017-01-06 13:14:17 -0600 | [diff] [blame] | 999 | const char *comment, int require_keys, |
| 1000 | const char *engine_id); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1001 | |
Simon Glass | 7428ad1 | 2013-05-07 06:11:57 +0000 | [diff] [blame] | 1002 | int fit_image_verify(const void *fit, int noffset); |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1003 | int fit_config_verify(const void *fit, int conf_noffset); |
Simon Glass | 7428ad1 | 2013-05-07 06:11:57 +0000 | [diff] [blame] | 1004 | int fit_all_image_verify(const void *fit); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1005 | int fit_image_check_os(const void *fit, int noffset, uint8_t os); |
| 1006 | int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); |
| 1007 | int fit_image_check_type(const void *fit, int noffset, uint8_t type); |
| 1008 | int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); |
| 1009 | int fit_check_format(const void *fit); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1010 | |
Gabe Black | d572e16 | 2012-10-25 16:31:10 +0000 | [diff] [blame] | 1011 | int fit_conf_find_compat(const void *fit, const void *fdt); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1012 | int fit_conf_get_node(const void *fit, const char *conf_uname); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1013 | |
Simon Glass | dc0f52c | 2013-05-07 06:12:00 +0000 | [diff] [blame] | 1014 | /** |
| 1015 | * fit_conf_get_prop_node() - Get node refered to by a configuration |
| 1016 | * @fit: FIT to check |
| 1017 | * @noffset: Offset of conf@xxx node to check |
| 1018 | * @prop_name: Property to read from the conf node |
| 1019 | * |
| 1020 | * The conf@ nodes contain references to other nodes, using properties |
| 1021 | * like 'kernel = "kernel@1"'. Given such a property name (e.g. "kernel"), |
| 1022 | * return the offset of the node referred to (e.g. offset of node |
| 1023 | * "/images/kernel@1". |
| 1024 | */ |
| 1025 | int fit_conf_get_prop_node(const void *fit, int noffset, |
| 1026 | const char *prop_name); |
| 1027 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1028 | void fit_conf_print(const void *fit, int noffset, const char *p); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1029 | |
Simon Glass | 36b916a | 2013-05-07 06:11:52 +0000 | [diff] [blame] | 1030 | int fit_check_ramdisk(const void *fit, int os_noffset, |
| 1031 | uint8_t arch, int verify); |
| 1032 | |
Simon Glass | 10a1eca | 2013-05-07 06:11:54 +0000 | [diff] [blame] | 1033 | int calculate_hash(const void *data, int data_len, const char *algo, |
| 1034 | uint8_t *value, int *value_len); |
| 1035 | |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1036 | /* |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1037 | * At present we only support signing on the host, and verification on the |
| 1038 | * device |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1039 | */ |
| 1040 | #if defined(CONFIG_FIT_SIGNATURE) |
| 1041 | # ifdef USE_HOSTCC |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1042 | # define IMAGE_ENABLE_SIGN 1 |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1043 | # define IMAGE_ENABLE_VERIFY 1 |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1044 | # include <openssl/evp.h> |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1045 | #else |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1046 | # define IMAGE_ENABLE_SIGN 0 |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1047 | # define IMAGE_ENABLE_VERIFY 1 |
| 1048 | # endif |
| 1049 | #else |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1050 | # define IMAGE_ENABLE_SIGN 0 |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1051 | # define IMAGE_ENABLE_VERIFY 0 |
| 1052 | #endif |
| 1053 | |
| 1054 | #ifdef USE_HOSTCC |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1055 | void *image_get_host_blob(void); |
| 1056 | void image_set_host_blob(void *host_blob); |
| 1057 | # define gd_fdt_blob() image_get_host_blob() |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1058 | #else |
| 1059 | # define gd_fdt_blob() (gd->fdt_blob) |
| 1060 | #endif |
| 1061 | |
| 1062 | #ifdef CONFIG_FIT_BEST_MATCH |
| 1063 | #define IMAGE_ENABLE_BEST_MATCH 1 |
| 1064 | #else |
| 1065 | #define IMAGE_ENABLE_BEST_MATCH 0 |
| 1066 | #endif |
| 1067 | |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1068 | /* Information passed to the signing routines */ |
| 1069 | struct image_sign_info { |
| 1070 | const char *keydir; /* Directory conaining keys */ |
| 1071 | const char *keyname; /* Name of key to use */ |
| 1072 | void *fit; /* Pointer to FIT blob */ |
| 1073 | int node_offset; /* Offset of signature node */ |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1074 | const char *name; /* Algorithm name */ |
| 1075 | struct checksum_algo *checksum; /* Checksum algorithm information */ |
| 1076 | struct crypto_algo *crypto; /* Crypto algorithm information */ |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1077 | const void *fdt_blob; /* FDT containing public keys */ |
| 1078 | int required_keynode; /* Node offset of key to use: -1=any */ |
| 1079 | const char *require_keys; /* Value for 'required' property */ |
George McCollister | 23d1489 | 2017-01-06 13:14:17 -0600 | [diff] [blame] | 1080 | const char *engine_id; /* Engine to use for signing */ |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1081 | }; |
Simon Glass | e3ee2fb | 2016-02-22 22:55:43 -0700 | [diff] [blame] | 1082 | #endif /* Allow struct image_region to always be defined for rsa.h */ |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1083 | |
| 1084 | /* A part of an image, used for hashing */ |
| 1085 | struct image_region { |
| 1086 | const void *data; |
| 1087 | int size; |
| 1088 | }; |
| 1089 | |
Simon Glass | e3ee2fb | 2016-02-22 22:55:43 -0700 | [diff] [blame] | 1090 | #if IMAGE_ENABLE_FIT |
| 1091 | |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1092 | #if IMAGE_ENABLE_VERIFY |
Jeroen Hofstee | bfe88fe | 2014-06-12 22:27:12 +0200 | [diff] [blame] | 1093 | # include <u-boot/rsa-checksum.h> |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1094 | #endif |
| 1095 | struct checksum_algo { |
| 1096 | const char *name; |
| 1097 | const int checksum_len; |
Andrew Duda | 3db9ff0 | 2016-11-08 18:53:40 +0000 | [diff] [blame] | 1098 | const int der_len; |
| 1099 | const uint8_t *der_prefix; |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1100 | #if IMAGE_ENABLE_SIGN |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1101 | const EVP_MD *(*calculate_sign)(void); |
| 1102 | #endif |
Ruchika Gupta | 2c8987f | 2015-01-23 16:01:59 +0530 | [diff] [blame] | 1103 | int (*calculate)(const char *name, |
| 1104 | const struct image_region region[], |
| 1105 | int region_count, uint8_t *checksum); |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1106 | }; |
| 1107 | |
Andrew Duda | 06ca6d6 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1108 | struct crypto_algo { |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1109 | const char *name; /* Name of algorithm */ |
Andrew Duda | 06ca6d6 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1110 | const int key_len; |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1111 | |
| 1112 | /** |
| 1113 | * sign() - calculate and return signature for given input data |
| 1114 | * |
| 1115 | * @info: Specifies key and FIT information |
| 1116 | * @data: Pointer to the input data |
| 1117 | * @data_len: Data length |
| 1118 | * @sigp: Set to an allocated buffer holding the signature |
| 1119 | * @sig_len: Set to length of the calculated hash |
| 1120 | * |
| 1121 | * This computes input data signature according to selected algorithm. |
| 1122 | * Resulting signature value is placed in an allocated buffer, the |
| 1123 | * pointer is returned as *sigp. The length of the calculated |
| 1124 | * signature is returned via the sig_len pointer argument. The caller |
| 1125 | * should free *sigp. |
| 1126 | * |
| 1127 | * @return: 0, on success, -ve on error |
| 1128 | */ |
| 1129 | int (*sign)(struct image_sign_info *info, |
| 1130 | const struct image_region region[], |
| 1131 | int region_count, uint8_t **sigp, uint *sig_len); |
| 1132 | |
| 1133 | /** |
| 1134 | * add_verify_data() - Add verification information to FDT |
| 1135 | * |
| 1136 | * Add public key information to the FDT node, suitable for |
| 1137 | * verification at run-time. The information added depends on the |
| 1138 | * algorithm being used. |
| 1139 | * |
| 1140 | * @info: Specifies key and FIT information |
| 1141 | * @keydest: Destination FDT blob for public key data |
| 1142 | * @return: 0, on success, -ve on error |
| 1143 | */ |
| 1144 | int (*add_verify_data)(struct image_sign_info *info, void *keydest); |
| 1145 | |
| 1146 | /** |
| 1147 | * verify() - Verify a signature against some data |
| 1148 | * |
| 1149 | * @info: Specifies key and FIT information |
| 1150 | * @data: Pointer to the input data |
| 1151 | * @data_len: Data length |
| 1152 | * @sig: Signature |
| 1153 | * @sig_len: Number of bytes in signature |
| 1154 | * @return 0 if verified, -ve on error |
| 1155 | */ |
| 1156 | int (*verify)(struct image_sign_info *info, |
| 1157 | const struct image_region region[], int region_count, |
| 1158 | uint8_t *sig, uint sig_len); |
Andrew Duda | 06ca6d6 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1159 | }; |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1160 | |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1161 | /** |
| 1162 | * image_get_checksum_algo() - Look up a checksum algorithm |
| 1163 | * |
| 1164 | * @param full_name Name of algorithm in the form "checksum,crypto" |
| 1165 | * @return pointer to algorithm information, or NULL if not found |
| 1166 | */ |
| 1167 | struct checksum_algo *image_get_checksum_algo(const char *full_name); |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1168 | |
| 1169 | /** |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1170 | * image_get_crypto_algo() - Look up a cryptosystem algorithm |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1171 | * |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1172 | * @param full_name Name of algorithm in the form "checksum,crypto" |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1173 | * @return pointer to algorithm information, or NULL if not found |
| 1174 | */ |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1175 | struct crypto_algo *image_get_crypto_algo(const char *full_name); |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1176 | |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1177 | /** |
| 1178 | * fit_image_verify_required_sigs() - Verify signatures marked as 'required' |
| 1179 | * |
| 1180 | * @fit: FIT to check |
| 1181 | * @image_noffset: Offset of image node to check |
| 1182 | * @data: Image data to check |
| 1183 | * @size: Size of image data |
| 1184 | * @sig_blob: FDT containing public keys |
| 1185 | * @no_sigsp: Returns 1 if no signatures were required, and |
| 1186 | * therefore nothing was checked. The caller may wish |
| 1187 | * to fall back to other mechanisms, or refuse to |
| 1188 | * boot. |
| 1189 | * @return 0 if all verified ok, <0 on error |
| 1190 | */ |
| 1191 | int fit_image_verify_required_sigs(const void *fit, int image_noffset, |
| 1192 | const char *data, size_t size, const void *sig_blob, |
| 1193 | int *no_sigsp); |
| 1194 | |
| 1195 | /** |
| 1196 | * fit_image_check_sig() - Check a single image signature node |
| 1197 | * |
| 1198 | * @fit: FIT to check |
| 1199 | * @noffset: Offset of signature node to check |
| 1200 | * @data: Image data to check |
| 1201 | * @size: Size of image data |
| 1202 | * @required_keynode: Offset in the control FDT of the required key node, |
| 1203 | * if any. If this is given, then the image wil not |
| 1204 | * pass verification unless that key is used. If this is |
| 1205 | * -1 then any signature will do. |
| 1206 | * @err_msgp: In the event of an error, this will be pointed to a |
| 1207 | * help error string to display to the user. |
| 1208 | * @return 0 if all verified ok, <0 on error |
| 1209 | */ |
| 1210 | int fit_image_check_sig(const void *fit, int noffset, const void *data, |
| 1211 | size_t size, int required_keynode, char **err_msgp); |
| 1212 | |
Simon Glass | 56ab8d6 | 2013-06-13 15:10:09 -0700 | [diff] [blame] | 1213 | /** |
| 1214 | * fit_region_make_list() - Make a list of regions to hash |
| 1215 | * |
| 1216 | * Given a list of FIT regions (offset, size) provided by libfdt, create |
| 1217 | * a list of regions (void *, size) for use by the signature creationg |
| 1218 | * and verification code. |
| 1219 | * |
| 1220 | * @fit: FIT image to process |
| 1221 | * @fdt_regions: Regions as returned by libfdt |
| 1222 | * @count: Number of regions returned by libfdt |
| 1223 | * @region: Place to put list of regions (NULL to allocate it) |
| 1224 | * @return pointer to list of regions, or NULL if out of memory |
| 1225 | */ |
| 1226 | struct image_region *fit_region_make_list(const void *fit, |
| 1227 | struct fdt_region *fdt_regions, int count, |
| 1228 | struct image_region *region); |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1229 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1230 | static inline int fit_image_check_target_arch(const void *fdt, int node) |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1231 | { |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1232 | #ifndef USE_HOSTCC |
Thierry Reding | 7d731a9 | 2011-10-27 08:58:25 +0000 | [diff] [blame] | 1233 | return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1234 | #else |
| 1235 | return 0; |
| 1236 | #endif |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1237 | } |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1238 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 1239 | #ifdef CONFIG_FIT_VERBOSE |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1240 | #define fit_unsupported(msg) printf("! %s:%d " \ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 1241 | "FIT images not supported for '%s'\n", \ |
| 1242 | __FILE__, __LINE__, (msg)) |
| 1243 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1244 | #define fit_unsupported_reset(msg) printf("! %s:%d " \ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 1245 | "FIT images not supported for '%s' " \ |
| 1246 | "- must reset board to recover!\n", \ |
| 1247 | __FILE__, __LINE__, (msg)) |
| 1248 | #else |
| 1249 | #define fit_unsupported(msg) |
| 1250 | #define fit_unsupported_reset(msg) |
| 1251 | #endif /* CONFIG_FIT_VERBOSE */ |
Marian Balakowicz | 3413e22 | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 1252 | #endif /* CONFIG_FIT */ |
Marian Balakowicz | 9541850 | 2008-01-31 13:55:39 +0100 | [diff] [blame] | 1253 | |
Sebastian Siewior | 686d667 | 2014-05-05 15:08:09 -0500 | [diff] [blame] | 1254 | #if defined(CONFIG_ANDROID_BOOT_IMAGE) |
| 1255 | struct andr_img_hdr; |
| 1256 | int android_image_check_header(const struct andr_img_hdr *hdr); |
| 1257 | int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify, |
| 1258 | ulong *os_data, ulong *os_len); |
| 1259 | int android_image_get_ramdisk(const struct andr_img_hdr *hdr, |
| 1260 | ulong *rd_data, ulong *rd_len); |
| 1261 | ulong android_image_get_end(const struct andr_img_hdr *hdr); |
| 1262 | ulong android_image_get_kload(const struct andr_img_hdr *hdr); |
Michael Trimarchi | 44af20b | 2016-06-10 19:54:37 +0200 | [diff] [blame] | 1263 | void android_print_contents(const struct andr_img_hdr *hdr); |
Sebastian Siewior | 686d667 | 2014-05-05 15:08:09 -0500 | [diff] [blame] | 1264 | |
| 1265 | #endif /* CONFIG_ANDROID_BOOT_IMAGE */ |
| 1266 | |
Simon Glass | f287dfd | 2016-02-22 22:55:55 -0700 | [diff] [blame] | 1267 | /** |
| 1268 | * board_fit_config_name_match() - Check for a matching board name |
| 1269 | * |
| 1270 | * This is used when SPL loads a FIT containing multiple device tree files |
| 1271 | * and wants to work out which one to use. The description of each one is |
| 1272 | * passed to this function. The description comes from the 'description' field |
| 1273 | * in each (FDT) image node. |
| 1274 | * |
| 1275 | * @name: Device tree description |
| 1276 | * @return 0 if this device tree should be used, non-zero to try the next |
| 1277 | */ |
| 1278 | int board_fit_config_name_match(const char *name); |
| 1279 | |
Madan Srinivas | a2f8c94 | 2017-04-07 10:00:02 -0500 | [diff] [blame] | 1280 | #if defined(CONFIG_SPL_FIT_IMAGE_POST_PROCESS) || \ |
| 1281 | defined(CONFIG_FIT_IMAGE_POST_PROCESS) |
Daniel Allred | cf839bd | 2016-06-27 09:19:21 -0500 | [diff] [blame] | 1282 | /** |
| 1283 | * board_fit_image_post_process() - Do any post-process on FIT binary data |
| 1284 | * |
| 1285 | * This is used to do any sort of image manipulation, verification, decryption |
| 1286 | * etc. in a platform or board specific way. Obviously, anything done here would |
| 1287 | * need to be comprehended in how the images were prepared before being injected |
| 1288 | * into the FIT creation (i.e. the binary blobs would have been pre-processed |
| 1289 | * before being added to the FIT image). |
| 1290 | * |
| 1291 | * @image: pointer to the image start pointer |
| 1292 | * @size: pointer to the image size |
| 1293 | * @return no return value (failure should be handled internally) |
| 1294 | */ |
| 1295 | void board_fit_image_post_process(void **p_image, size_t *p_size); |
| 1296 | #endif /* CONFIG_SPL_FIT_IMAGE_POST_PROCESS */ |
| 1297 | |
Cooper Jr., Franklin | e679240 | 2017-06-16 17:25:05 -0500 | [diff] [blame] | 1298 | #define FDT_ERROR ((ulong)(-1)) |
| 1299 | |
Cooper Jr., Franklin | 899aad2 | 2017-06-16 17:25:06 -0500 | [diff] [blame] | 1300 | ulong fdt_getprop_u32(const void *fdt, int node, const char *prop); |
Jean-Jacques Hiblot | 5e7c12e | 2017-09-15 12:57:27 +0200 | [diff] [blame] | 1301 | |
| 1302 | /** |
| 1303 | * fit_find_config_node() - Find the node for the best DTB in a FIT image |
| 1304 | * |
| 1305 | * A FIT image contains one or more DTBs. This function parses the |
| 1306 | * configurations described in the FIT images and returns the node of |
| 1307 | * the first matching DTB. To check if a DTB matches a board, this function |
| 1308 | * calls board_fit_config_name_match(). If no matching DTB is found, it returns |
| 1309 | * the node described by the default configuration if it exists. |
| 1310 | * |
| 1311 | * @fdt: pointer to flat device tree |
| 1312 | * @return the node if found, -ve otherwise |
| 1313 | */ |
Cooper Jr., Franklin | 899aad2 | 2017-06-16 17:25:06 -0500 | [diff] [blame] | 1314 | int fit_find_config_node(const void *fdt); |
| 1315 | |
Andrew F. Davis | 28b28f7 | 2016-11-29 16:33:20 -0600 | [diff] [blame] | 1316 | /** |
| 1317 | * Mapping of image types to function handlers to be invoked on the associated |
| 1318 | * loaded images |
| 1319 | * |
| 1320 | * @type: Type of image, I.E. IH_TYPE_* |
| 1321 | * @handler: Function to call on loaded image |
| 1322 | */ |
| 1323 | struct fit_loadable_tbl { |
| 1324 | int type; |
| 1325 | /** |
| 1326 | * handler() - Process a loaded image |
| 1327 | * |
| 1328 | * @data: Pointer to start of loaded image data |
| 1329 | * @size: Size of loaded image data |
| 1330 | */ |
| 1331 | void (*handler)(ulong data, size_t size); |
| 1332 | }; |
| 1333 | |
| 1334 | /* |
| 1335 | * Define a FIT loadable image type handler |
| 1336 | * |
| 1337 | * _type is a valid uimage_type ID as defined in the "Image Type" enum above |
| 1338 | * _handler is the handler function to call after this image type is loaded |
| 1339 | */ |
| 1340 | #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \ |
| 1341 | ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \ |
| 1342 | .type = _type, \ |
| 1343 | .handler = _handler, \ |
| 1344 | } |
| 1345 | |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 1346 | #endif /* __IMAGE_H__ */ |