Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 2 | /* |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 3 | * (C) Copyright 2008 Semihalf |
| 4 | * |
Wolfgang Denk | f3f4518 | 2005-11-25 16:38:03 +0100 | [diff] [blame] | 5 | * (C) Copyright 2000-2005 |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 6 | * Wolfgang Denk, DENX Software Engineering, wd@denx.de. |
Wolfgang Denk | f3f4518 | 2005-11-25 16:38:03 +0100 | [diff] [blame] | 7 | ******************************************************************** |
| 8 | * NOTE: This header file defines an interface to U-Boot. Including |
| 9 | * this (unmodified) header file in another file is considered normal |
| 10 | * use of U-Boot, and does *not* fall under the heading of "derived |
| 11 | * work". |
| 12 | ******************************************************************** |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 13 | */ |
| 14 | |
| 15 | #ifndef __IMAGE_H__ |
| 16 | #define __IMAGE_H__ |
| 17 | |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 18 | #include "compiler.h" |
Kim Phillips | e69030c | 2012-10-29 13:34:30 +0000 | [diff] [blame] | 19 | #include <asm/byteorder.h> |
Marek Vasut | 85ed289 | 2018-06-13 06:13:32 +0200 | [diff] [blame] | 20 | #include <stdbool.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; |
Masahiro Yamada | fe11aee | 2018-03-21 18:03:35 +0900 | [diff] [blame] | 24 | struct fdt_region; |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 25 | |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 26 | #ifdef USE_HOSTCC |
Jörg Krause | 983487f | 2015-04-22 21:36:22 +0200 | [diff] [blame] | 27 | #include <sys/types.h> |
Simon Glass | e719d3b | 2021-09-25 19:43:20 -0600 | [diff] [blame] | 28 | #include <linux/kconfig.h> |
Marian Balakowicz | f4891a1 | 2008-02-21 17:20:18 +0100 | [diff] [blame] | 29 | |
Simon Glass | 1030f16 | 2013-05-08 08:05:58 +0000 | [diff] [blame] | 30 | #define IMAGE_INDENT_STRING "" |
Simon Glass | f0fd511 | 2013-05-07 06:11:58 +0000 | [diff] [blame] | 31 | |
Wolfgang Denk | bf36877 | 2008-10-21 11:23:56 +0200 | [diff] [blame] | 32 | #else |
| 33 | |
| 34 | #include <lmb.h> |
Wolfgang Denk | bf36877 | 2008-10-21 11:23:56 +0200 | [diff] [blame] | 35 | #include <asm/u-boot.h> |
Mike Frysinger | 175467a | 2010-01-21 04:03:20 -0500 | [diff] [blame] | 36 | #include <command.h> |
Alexandru Gagniuc | b04e918 | 2021-07-14 17:05:39 -0500 | [diff] [blame] | 37 | #include <linker_lists.h> |
Wolfgang Denk | bf36877 | 2008-10-21 11:23:56 +0200 | [diff] [blame] | 38 | |
Simon Glass | 1030f16 | 2013-05-08 08:05:58 +0000 | [diff] [blame] | 39 | #define IMAGE_INDENT_STRING " " |
Simon Glass | f0fd511 | 2013-05-07 06:11:58 +0000 | [diff] [blame] | 40 | |
Bartlomiej Sieka | d7816fb | 2008-03-11 12:34:47 +0100 | [diff] [blame] | 41 | #endif /* USE_HOSTCC */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 42 | |
Michael van der Westhuizen | e36c6c3 | 2014-05-30 20:59:00 +0200 | [diff] [blame] | 43 | #include <hash.h> |
Masahiro Yamada | 75f82d0 | 2018-03-05 01:20:11 +0900 | [diff] [blame] | 44 | #include <linux/libfdt.h> |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 45 | #include <fdt_support.h> |
Simon Glass | 2c6a1b0 | 2021-09-25 19:43:33 -0600 | [diff] [blame] | 46 | #include <u-boot/hash-checksum.h> |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 47 | |
Simon Glass | 85f1378 | 2019-12-28 10:45:03 -0700 | [diff] [blame] | 48 | extern ulong image_load_addr; /* Default Load Address */ |
| 49 | extern ulong image_save_addr; /* Default Save Address */ |
| 50 | extern ulong image_save_size; /* Default Save Size */ |
Philippe Reynes | d28484e | 2022-03-28 22:56:59 +0200 | [diff] [blame] | 51 | extern ulong image_load_offset; /* Default Load Address Offset */ |
Simon Glass | 85f1378 | 2019-12-28 10:45:03 -0700 | [diff] [blame] | 52 | |
Simon Glass | d563c25 | 2021-02-15 17:08:09 -0700 | [diff] [blame] | 53 | /* An invalid size, meaning that the image size is not known */ |
| 54 | #define IMAGE_SIZE_INVAL (-1UL) |
| 55 | |
Simon Glass | 7da41d5 | 2016-06-30 10:52:14 -0600 | [diff] [blame] | 56 | enum ih_category { |
| 57 | IH_ARCH, |
| 58 | IH_COMP, |
| 59 | IH_OS, |
| 60 | IH_TYPE, |
| 61 | |
| 62 | IH_COUNT, |
| 63 | }; |
| 64 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 65 | /* |
| 66 | * Operating System Codes |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 67 | * |
| 68 | * The following are exposed to uImage header. |
Stefano Babic | 10d7c4b | 2018-12-17 11:02:00 +0100 | [diff] [blame] | 69 | * New IDs *MUST* be appended at the end of the list and *NEVER* |
| 70 | * inserted for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 71 | */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 72 | enum { |
| 73 | IH_OS_INVALID = 0, /* Invalid OS */ |
| 74 | IH_OS_OPENBSD, /* OpenBSD */ |
| 75 | IH_OS_NETBSD, /* NetBSD */ |
| 76 | IH_OS_FREEBSD, /* FreeBSD */ |
| 77 | IH_OS_4_4BSD, /* 4.4BSD */ |
| 78 | IH_OS_LINUX, /* Linux */ |
| 79 | IH_OS_SVR4, /* SVR4 */ |
| 80 | IH_OS_ESIX, /* Esix */ |
| 81 | IH_OS_SOLARIS, /* Solaris */ |
| 82 | IH_OS_IRIX, /* Irix */ |
| 83 | IH_OS_SCO, /* SCO */ |
| 84 | IH_OS_DELL, /* Dell */ |
| 85 | IH_OS_NCR, /* NCR */ |
| 86 | IH_OS_LYNXOS, /* LynxOS */ |
| 87 | IH_OS_VXWORKS, /* VxWorks */ |
| 88 | IH_OS_PSOS, /* pSOS */ |
| 89 | IH_OS_QNX, /* QNX */ |
| 90 | IH_OS_U_BOOT, /* Firmware */ |
| 91 | IH_OS_RTEMS, /* RTEMS */ |
| 92 | IH_OS_ARTOS, /* ARTOS */ |
| 93 | IH_OS_UNITY, /* Unity OS */ |
| 94 | IH_OS_INTEGRITY, /* INTEGRITY */ |
| 95 | IH_OS_OSE, /* OSE */ |
| 96 | IH_OS_PLAN9, /* Plan 9 */ |
| 97 | IH_OS_OPENRTOS, /* OpenRTOS */ |
Philipp Tomsich | 1bf3eb2 | 2017-09-13 21:29:29 +0200 | [diff] [blame] | 98 | IH_OS_ARM_TRUSTED_FIRMWARE, /* ARM Trusted Firmware */ |
Bryan O'Donoghue | 2f72dec | 2018-03-13 16:50:35 +0000 | [diff] [blame] | 99 | IH_OS_TEE, /* Trusted Execution Environment */ |
Lukas Auer | 515b934 | 2019-08-21 21:14:44 +0200 | [diff] [blame] | 100 | IH_OS_OPENSBI, /* RISC-V OpenSBI */ |
Cristian Ciocaltea | 217f964 | 2019-12-24 18:05:38 +0200 | [diff] [blame] | 101 | IH_OS_EFI, /* EFI Firmware (e.g. GRUB2) */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 102 | |
| 103 | IH_OS_COUNT, |
| 104 | }; |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 105 | |
| 106 | /* |
| 107 | * CPU Architecture Codes (supported by Linux) |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 108 | * |
| 109 | * The following are exposed to uImage header. |
Stefano Babic | 10d7c4b | 2018-12-17 11:02:00 +0100 | [diff] [blame] | 110 | * New IDs *MUST* be appended at the end of the list and *NEVER* |
| 111 | * inserted for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 112 | */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 113 | enum { |
| 114 | IH_ARCH_INVALID = 0, /* Invalid CPU */ |
| 115 | IH_ARCH_ALPHA, /* Alpha */ |
| 116 | IH_ARCH_ARM, /* ARM */ |
| 117 | IH_ARCH_I386, /* Intel x86 */ |
| 118 | IH_ARCH_IA64, /* IA64 */ |
| 119 | IH_ARCH_MIPS, /* MIPS */ |
| 120 | IH_ARCH_MIPS64, /* MIPS 64 Bit */ |
| 121 | IH_ARCH_PPC, /* PowerPC */ |
| 122 | IH_ARCH_S390, /* IBM S390 */ |
| 123 | IH_ARCH_SH, /* SuperH */ |
| 124 | IH_ARCH_SPARC, /* Sparc */ |
| 125 | IH_ARCH_SPARC64, /* Sparc 64 Bit */ |
| 126 | IH_ARCH_M68K, /* M68K */ |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 127 | IH_ARCH_NIOS, /* Nios-32 */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 128 | IH_ARCH_MICROBLAZE, /* MicroBlaze */ |
| 129 | IH_ARCH_NIOS2, /* Nios-II */ |
| 130 | IH_ARCH_BLACKFIN, /* Blackfin */ |
| 131 | IH_ARCH_AVR32, /* AVR32 */ |
| 132 | IH_ARCH_ST200, /* STMicroelectronics ST200 */ |
| 133 | IH_ARCH_SANDBOX, /* Sandbox architecture (test only) */ |
| 134 | IH_ARCH_NDS32, /* ANDES Technology - NDS32 */ |
| 135 | IH_ARCH_OPENRISC, /* OpenRISC 1000 */ |
| 136 | IH_ARCH_ARM64, /* ARM64 */ |
| 137 | IH_ARCH_ARC, /* Synopsys DesignWare ARC */ |
| 138 | IH_ARCH_X86_64, /* AMD x86_64, Intel and Via */ |
Chris Zankel | 41e3737 | 2016-08-10 18:36:43 +0300 | [diff] [blame] | 139 | IH_ARCH_XTENSA, /* Xtensa */ |
Rick Chen | 3301bfc | 2017-12-26 13:55:58 +0800 | [diff] [blame] | 140 | IH_ARCH_RISCV, /* RISC-V */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 141 | |
| 142 | IH_ARCH_COUNT, |
| 143 | }; |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 144 | |
| 145 | /* |
| 146 | * Image Types |
| 147 | * |
| 148 | * "Standalone Programs" are directly runnable in the environment |
| 149 | * provided by U-Boot; it is expected that (if they behave |
| 150 | * well) you can continue to work in U-Boot after return from |
| 151 | * the Standalone Program. |
| 152 | * "OS Kernel Images" are usually images of some Embedded OS which |
| 153 | * will take over control completely. Usually these programs |
| 154 | * will install their own set of exception handlers, device |
| 155 | * drivers, set up the MMU, etc. - this means, that you cannot |
| 156 | * expect to re-enter U-Boot except by resetting the CPU. |
| 157 | * "RAMDisk Images" are more or less just data blocks, and their |
| 158 | * parameters (address, size) are passed to an OS kernel that is |
| 159 | * being started. |
| 160 | * "Multi-File Images" contain several images, typically an OS |
| 161 | * (Linux) kernel image and one or more data images like |
| 162 | * RAMDisks. This construct is useful for instance when you want |
| 163 | * to boot over the network using BOOTP etc., where the boot |
| 164 | * server provides just a single image file, but you want to get |
| 165 | * for instance an OS kernel and a RAMDisk image. |
| 166 | * |
| 167 | * "Multi-File Images" start with a list of image sizes, each |
| 168 | * image size (in bytes) specified by an "uint32_t" in network |
| 169 | * byte order. This list is terminated by an "(uint32_t)0". |
| 170 | * Immediately after the terminating 0 follow the images, one by |
| 171 | * one, all aligned on "uint32_t" boundaries (size rounded up to |
wdenk | 391b574 | 2004-10-10 23:27:33 +0000 | [diff] [blame] | 172 | * a multiple of 4 bytes - except for the last file). |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 173 | * |
| 174 | * "Firmware Images" are binary images containing firmware (like |
| 175 | * U-Boot or FPGA images) which usually will be programmed to |
| 176 | * flash memory. |
| 177 | * |
| 178 | * "Script files" are command sequences that will be executed by |
| 179 | * U-Boot's command interpreter; this feature is especially |
| 180 | * useful when you configure U-Boot to use a real shell (hush) |
wdenk | 874ac26 | 2003-07-24 23:38:38 +0000 | [diff] [blame] | 181 | * as command interpreter (=> Shell Scripts). |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 182 | * |
| 183 | * The following are exposed to uImage header. |
Stefano Babic | 10d7c4b | 2018-12-17 11:02:00 +0100 | [diff] [blame] | 184 | * New IDs *MUST* be appended at the end of the list and *NEVER* |
| 185 | * inserted for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 186 | */ |
| 187 | |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 188 | enum { |
| 189 | IH_TYPE_INVALID = 0, /* Invalid Image */ |
| 190 | IH_TYPE_STANDALONE, /* Standalone Program */ |
| 191 | IH_TYPE_KERNEL, /* OS Kernel Image */ |
| 192 | IH_TYPE_RAMDISK, /* RAMDisk Image */ |
| 193 | IH_TYPE_MULTI, /* Multi-File Image */ |
| 194 | IH_TYPE_FIRMWARE, /* Firmware Image */ |
| 195 | IH_TYPE_SCRIPT, /* Script file */ |
| 196 | IH_TYPE_FILESYSTEM, /* Filesystem Image (any type) */ |
| 197 | IH_TYPE_FLATDT, /* Binary Flat Device Tree Blob */ |
| 198 | IH_TYPE_KWBIMAGE, /* Kirkwood Boot Image */ |
| 199 | IH_TYPE_IMXIMAGE, /* Freescale IMXBoot Image */ |
| 200 | IH_TYPE_UBLIMAGE, /* Davinci UBL Image */ |
| 201 | IH_TYPE_OMAPIMAGE, /* TI OMAP Config Header Image */ |
| 202 | IH_TYPE_AISIMAGE, /* TI Davinci AIS Image */ |
| 203 | /* OS Kernel Image, can run from any load address */ |
| 204 | IH_TYPE_KERNEL_NOLOAD, |
| 205 | IH_TYPE_PBLIMAGE, /* Freescale PBL Boot Image */ |
| 206 | IH_TYPE_MXSIMAGE, /* Freescale MXSBoot Image */ |
| 207 | IH_TYPE_GPIMAGE, /* TI Keystone GPHeader Image */ |
| 208 | IH_TYPE_ATMELIMAGE, /* ATMEL ROM bootable Image */ |
Marek Vasut | 83f6928 | 2018-04-15 13:15:33 +0200 | [diff] [blame] | 209 | IH_TYPE_SOCFPGAIMAGE, /* Altera SOCFPGA CV/AV Preloader */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 210 | IH_TYPE_X86_SETUP, /* x86 setup.bin Image */ |
| 211 | IH_TYPE_LPC32XXIMAGE, /* x86 setup.bin Image */ |
| 212 | IH_TYPE_LOADABLE, /* A list of typeless images */ |
| 213 | IH_TYPE_RKIMAGE, /* Rockchip Boot Image */ |
| 214 | IH_TYPE_RKSD, /* Rockchip SD card */ |
| 215 | IH_TYPE_RKSPI, /* Rockchip SPI image */ |
| 216 | IH_TYPE_ZYNQIMAGE, /* Xilinx Zynq Boot Image */ |
| 217 | IH_TYPE_ZYNQMPIMAGE, /* Xilinx ZynqMP Boot Image */ |
Alexander Graf | 5329d67 | 2018-04-13 14:18:52 +0200 | [diff] [blame] | 218 | IH_TYPE_ZYNQMPBIF, /* Xilinx ZynqMP Boot Image (bif) */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 219 | IH_TYPE_FPGA, /* FPGA Image */ |
Albert ARIBAUD \(3ADEV\) | 2e9f494 | 2016-09-26 09:08:06 +0200 | [diff] [blame] | 220 | IH_TYPE_VYBRIDIMAGE, /* VYBRID .vyb Image */ |
Andrew F. Davis | 378bcff | 2016-11-29 16:33:21 -0600 | [diff] [blame] | 221 | IH_TYPE_TEE, /* Trusted Execution Environment OS Image */ |
Sven Ebenfeld | 59697a2 | 2016-11-06 16:37:56 +0100 | [diff] [blame] | 222 | IH_TYPE_FIRMWARE_IVT, /* Firmware Image with HABv4 IVT */ |
Andrew F. Davis | 30f9d56 | 2017-07-31 10:58:20 -0500 | [diff] [blame] | 223 | IH_TYPE_PMMC, /* TI Power Management Micro-Controller Firmware */ |
Patrick Delaunay | e6db5df | 2018-03-12 10:46:04 +0100 | [diff] [blame] | 224 | IH_TYPE_STM32IMAGE, /* STMicroelectronics STM32 Image */ |
Marek Vasut | 83f6928 | 2018-04-15 13:15:33 +0200 | [diff] [blame] | 225 | IH_TYPE_SOCFPGAIMAGE_V1, /* Altera SOCFPGA A10 Preloader */ |
developer | e1de5d4 | 2018-11-15 10:07:49 +0800 | [diff] [blame] | 226 | IH_TYPE_MTKIMAGE, /* MediaTek BootROM loadable Image */ |
Stefano Babic | 10d7c4b | 2018-12-17 11:02:00 +0100 | [diff] [blame] | 227 | IH_TYPE_IMX8MIMAGE, /* Freescale IMX8MBoot Image */ |
| 228 | IH_TYPE_IMX8IMAGE, /* Freescale IMX8Boot Image */ |
Patrick Delaunay | 42594db | 2019-08-02 15:07:19 +0200 | [diff] [blame] | 229 | IH_TYPE_COPRO, /* Coprocessor Image for remoteproc*/ |
Andre Przywara | e53f9d9 | 2018-12-20 01:15:18 +0000 | [diff] [blame] | 230 | IH_TYPE_SUNXI_EGON, /* Allwinner eGON Boot Image */ |
Samuel Holland | 7572878 | 2022-03-18 00:00:43 -0500 | [diff] [blame] | 231 | IH_TYPE_SUNXI_TOC0, /* Allwinner TOC0 Boot Image */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 232 | |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 233 | IH_TYPE_COUNT, /* Number of image types */ |
| 234 | }; |
Simon Glass | 434a31b | 2015-06-23 15:38:25 -0600 | [diff] [blame] | 235 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 236 | /* |
| 237 | * Compression Types |
Masahiro Yamada | 166829f | 2016-07-21 15:16:00 +0900 | [diff] [blame] | 238 | * |
| 239 | * The following are exposed to uImage header. |
Stefano Babic | 10d7c4b | 2018-12-17 11:02:00 +0100 | [diff] [blame] | 240 | * New IDs *MUST* be appended at the end of the list and *NEVER* |
| 241 | * inserted for backward compatibility. |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 242 | */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 243 | enum { |
| 244 | IH_COMP_NONE = 0, /* No Compression Used */ |
| 245 | IH_COMP_GZIP, /* gzip Compression Used */ |
| 246 | IH_COMP_BZIP2, /* bzip2 Compression Used */ |
| 247 | IH_COMP_LZMA, /* lzma Compression Used */ |
| 248 | IH_COMP_LZO, /* lzo Compression Used */ |
| 249 | IH_COMP_LZ4, /* lz4 Compression Used */ |
Robert Marko | d1c2484 | 2020-04-25 19:37:21 +0200 | [diff] [blame] | 250 | IH_COMP_ZSTD, /* zstd Compression Used */ |
Simon Glass | 3c536ed | 2016-06-30 10:52:13 -0600 | [diff] [blame] | 251 | |
| 252 | IH_COMP_COUNT, |
| 253 | }; |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 254 | |
Eugeniu Rosca | 1403f39 | 2019-04-08 17:35:27 +0200 | [diff] [blame] | 255 | #define LZ4F_MAGIC 0x184D2204 /* LZ4 Magic Number */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 256 | #define IH_MAGIC 0x27051956 /* Image Magic Number */ |
| 257 | #define IH_NMLEN 32 /* Image Name Length */ |
| 258 | |
Fabio Estevam | 5fd7c5d | 2013-01-03 08:24:33 +0000 | [diff] [blame] | 259 | /* Reused from common.h */ |
| 260 | #define ROUND(a, b) (((a) + (b) - 1) & ~((b) - 1)) |
| 261 | |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 262 | /* |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 263 | * Legacy format image header, |
| 264 | * all data in network byte order (aka natural aka bigendian). |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 265 | */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 266 | typedef struct image_header { |
Bin Meng | f0b8eb1 | 2019-10-27 05:19:40 -0700 | [diff] [blame] | 267 | uint32_t ih_magic; /* Image Header Magic Number */ |
| 268 | uint32_t ih_hcrc; /* Image Header CRC Checksum */ |
| 269 | uint32_t ih_time; /* Image Creation Timestamp */ |
| 270 | uint32_t ih_size; /* Image Data Size */ |
| 271 | uint32_t ih_load; /* Data Load Address */ |
| 272 | uint32_t ih_ep; /* Entry Point Address */ |
| 273 | uint32_t ih_dcrc; /* Image Data CRC Checksum */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 274 | uint8_t ih_os; /* Operating System */ |
| 275 | uint8_t ih_arch; /* CPU architecture */ |
| 276 | uint8_t ih_type; /* Image Type */ |
| 277 | uint8_t ih_comp; /* Compression Type */ |
| 278 | uint8_t ih_name[IH_NMLEN]; /* Image Name */ |
| 279 | } image_header_t; |
| 280 | |
Kumar Gala | bd70bbe | 2008-08-15 08:24:41 -0500 | [diff] [blame] | 281 | typedef struct image_info { |
| 282 | ulong start, end; /* start/end of blob */ |
| 283 | ulong image_start, image_len; /* start of image within blob, len of image */ |
| 284 | ulong load; /* load addr for the image */ |
| 285 | uint8_t comp, type, os; /* compression, type of image, os type */ |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 286 | uint8_t arch; /* CPU architecture */ |
Kumar Gala | bd70bbe | 2008-08-15 08:24:41 -0500 | [diff] [blame] | 287 | } image_info_t; |
| 288 | |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 289 | /* |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 290 | * Legacy and FIT format headers used by do_bootm() and do_bootm_<os>() |
| 291 | * routines. |
| 292 | */ |
| 293 | typedef struct bootm_headers { |
| 294 | /* |
| 295 | * Legacy os image header, if it is a multi component image |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 296 | * then boot_get_ramdisk() and get_fdt() will attempt to get |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 297 | * data from second and third component accordingly. |
| 298 | */ |
Marian Balakowicz | ab00e02 | 2008-04-11 11:07:49 +0200 | [diff] [blame] | 299 | image_header_t *legacy_hdr_os; /* image header pointer */ |
| 300 | image_header_t legacy_hdr_os_copy; /* header copy */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 301 | ulong legacy_hdr_valid; |
| 302 | |
Simon Glass | 0f78138 | 2021-09-25 19:43:35 -0600 | [diff] [blame] | 303 | /* |
| 304 | * The fit_ members are only used with FIT, but it involves a lot of |
| 305 | * #ifdefs to avoid compiling that code. Since FIT is the standard |
| 306 | * format, even for SPL, this extra data size seems worth it. |
| 307 | */ |
Marian Balakowicz | 0cd4f3d | 2008-03-12 10:35:46 +0100 | [diff] [blame] | 308 | const char *fit_uname_cfg; /* configuration node unit name */ |
| 309 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 310 | void *fit_hdr_os; /* os FIT image header */ |
Marian Balakowicz | 6a2b2c2 | 2008-03-10 17:53:49 +0100 | [diff] [blame] | 311 | const char *fit_uname_os; /* os subimage node unit name */ |
Marian Balakowicz | 61c1ad5 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 312 | int fit_noffset_os; /* os subimage node offset */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 313 | |
| 314 | void *fit_hdr_rd; /* init ramdisk FIT image header */ |
Marian Balakowicz | 61c1ad5 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 315 | const char *fit_uname_rd; /* init ramdisk subimage node unit name */ |
| 316 | int fit_noffset_rd; /* init ramdisk subimage node offset */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 317 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 318 | void *fit_hdr_fdt; /* FDT blob FIT image header */ |
Marian Balakowicz | 61c1ad5 | 2008-03-12 10:32:59 +0100 | [diff] [blame] | 319 | const char *fit_uname_fdt; /* FDT blob subimage node unit name */ |
| 320 | int fit_noffset_fdt;/* FDT blob subimage node offset */ |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 321 | |
| 322 | void *fit_hdr_setup; /* x86 setup FIT image header */ |
| 323 | const char *fit_uname_setup; /* x86 setup subimage node name */ |
| 324 | int fit_noffset_setup;/* x86 setup subimage node offset */ |
Marian Balakowicz | aa6aae4 | 2008-03-12 10:35:52 +0100 | [diff] [blame] | 325 | |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 326 | #ifndef USE_HOSTCC |
Kumar Gala | bd70bbe | 2008-08-15 08:24:41 -0500 | [diff] [blame] | 327 | image_info_t os; /* os image info */ |
Kumar Gala | 93467bc | 2008-08-15 08:24:36 -0500 | [diff] [blame] | 328 | ulong ep; /* entry point of OS */ |
| 329 | |
Kumar Gala | fffb143 | 2008-08-15 08:24:37 -0500 | [diff] [blame] | 330 | ulong rd_start, rd_end;/* ramdisk start/end */ |
| 331 | |
Kumar Gala | a5130ad | 2008-08-15 08:24:38 -0500 | [diff] [blame] | 332 | char *ft_addr; /* flat dev tree address */ |
Kumar Gala | a5130ad | 2008-08-15 08:24:38 -0500 | [diff] [blame] | 333 | ulong ft_len; /* length of flat device tree */ |
| 334 | |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 335 | ulong initrd_start; |
| 336 | ulong initrd_end; |
| 337 | ulong cmdline_start; |
| 338 | ulong cmdline_end; |
Masahiro Yamada | f7ed78b | 2020-06-26 15:13:33 +0900 | [diff] [blame] | 339 | struct bd_info *kbd; |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 340 | #endif |
| 341 | |
Simon Glass | 64b723f | 2017-08-03 12:22:12 -0600 | [diff] [blame] | 342 | int verify; /* env_get("verify")[0] != 'n' */ |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 343 | |
| 344 | #define BOOTM_STATE_START (0x00000001) |
Simon Glass | 3081e2e | 2013-06-11 11:14:47 -0700 | [diff] [blame] | 345 | #define BOOTM_STATE_FINDOS (0x00000002) |
| 346 | #define BOOTM_STATE_FINDOTHER (0x00000004) |
| 347 | #define BOOTM_STATE_LOADOS (0x00000008) |
| 348 | #define BOOTM_STATE_RAMDISK (0x00000010) |
| 349 | #define BOOTM_STATE_FDT (0x00000020) |
| 350 | #define BOOTM_STATE_OS_CMDLINE (0x00000040) |
| 351 | #define BOOTM_STATE_OS_BD_T (0x00000080) |
| 352 | #define BOOTM_STATE_OS_PREP (0x00000100) |
Simon Glass | 0013488 | 2013-06-11 11:14:48 -0700 | [diff] [blame] | 353 | #define BOOTM_STATE_OS_FAKE_GO (0x00000200) /* 'Almost' run the OS */ |
| 354 | #define BOOTM_STATE_OS_GO (0x00000400) |
Philippe Reynes | ae1f2ca | 2022-03-28 22:57:00 +0200 | [diff] [blame] | 355 | #define BOOTM_STATE_PRE_LOAD 0x00000800 |
Kumar Gala | 18178bc | 2008-10-21 17:25:45 -0500 | [diff] [blame] | 356 | int state; |
| 357 | |
Patrick Delaunay | d62063d | 2021-03-10 10:16:25 +0100 | [diff] [blame] | 358 | #if defined(CONFIG_LMB) && !defined(USE_HOSTCC) |
Kumar Gala | da6d11e | 2008-08-15 08:24:40 -0500 | [diff] [blame] | 359 | struct lmb lmb; /* for memory mgmt */ |
| 360 | #endif |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 361 | } bootm_headers_t; |
| 362 | |
Simon Schwarz | af775a0 | 2012-03-15 04:01:34 +0000 | [diff] [blame] | 363 | extern bootm_headers_t images; |
| 364 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 365 | /* |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 366 | * Some systems (for example LWMON) have very short watchdog periods; |
| 367 | * we must make sure to split long operations like memmove() or |
Bartlomiej Sieka | 222e2ca | 2008-04-25 13:54:02 +0200 | [diff] [blame] | 368 | * checksum calculations into reasonable chunks. |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 369 | */ |
Bartlomiej Sieka | 222e2ca | 2008-04-25 13:54:02 +0200 | [diff] [blame] | 370 | #ifndef CHUNKSZ |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 371 | #define CHUNKSZ (64 * 1024) |
Bartlomiej Sieka | 222e2ca | 2008-04-25 13:54:02 +0200 | [diff] [blame] | 372 | #endif |
| 373 | |
| 374 | #ifndef CHUNKSZ_CRC32 |
| 375 | #define CHUNKSZ_CRC32 (64 * 1024) |
| 376 | #endif |
| 377 | |
| 378 | #ifndef CHUNKSZ_MD5 |
| 379 | #define CHUNKSZ_MD5 (64 * 1024) |
| 380 | #endif |
| 381 | |
| 382 | #ifndef CHUNKSZ_SHA1 |
| 383 | #define CHUNKSZ_SHA1 (64 * 1024) |
| 384 | #endif |
Marian Balakowicz | 20c4372 | 2008-01-08 18:11:44 +0100 | [diff] [blame] | 385 | |
Mike Frysinger | 4ad8e9f | 2009-07-02 19:23:25 -0400 | [diff] [blame] | 386 | #define uimage_to_cpu(x) be32_to_cpu(x) |
| 387 | #define cpu_to_uimage(x) cpu_to_be32(x) |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 388 | |
Prafulla Wadaskar | 4454c9e | 2009-09-07 14:59:08 +0530 | [diff] [blame] | 389 | /* |
| 390 | * Translation table for entries of a specific type; used by |
| 391 | * get_table_entry_id() and get_table_entry_name(). |
| 392 | */ |
| 393 | typedef struct table_entry { |
| 394 | int id; |
| 395 | char *sname; /* short (input) name to find table entry */ |
| 396 | char *lname; /* long (output) name to print for messages */ |
| 397 | } table_entry_t; |
| 398 | |
| 399 | /* |
Atish Patra | 04e8cd8 | 2020-03-05 16:24:22 -0800 | [diff] [blame] | 400 | * Compression type and magic number mapping table. |
| 401 | */ |
| 402 | struct comp_magic_map { |
| 403 | int comp_id; |
| 404 | const char *name; |
| 405 | unsigned char magic[2]; |
| 406 | }; |
| 407 | |
| 408 | /* |
Prafulla Wadaskar | 4454c9e | 2009-09-07 14:59:08 +0530 | [diff] [blame] | 409 | * get_table_entry_id() scans the translation table trying to find an |
| 410 | * entry that matches the given short name. If a matching entry is |
| 411 | * found, it's id is returned to the caller. |
| 412 | */ |
Mike Frysinger | cf2feb1 | 2010-10-20 07:17:39 -0400 | [diff] [blame] | 413 | int get_table_entry_id(const table_entry_t *table, |
Prafulla Wadaskar | 4454c9e | 2009-09-07 14:59:08 +0530 | [diff] [blame] | 414 | const char *table_name, const char *name); |
| 415 | /* |
| 416 | * get_table_entry_name() scans the translation table trying to find |
| 417 | * an entry that matches the given id. If a matching entry is found, |
| 418 | * its long name is returned to the caller. |
| 419 | */ |
Mike Frysinger | cf2feb1 | 2010-10-20 07:17:39 -0400 | [diff] [blame] | 420 | 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] | 421 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 422 | const char *genimg_get_os_name(uint8_t os); |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 423 | |
| 424 | /** |
| 425 | * genimg_get_os_short_name() - get the short name for an OS |
| 426 | * |
| 427 | * @param os OS (IH_OS_...) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 428 | * Return: OS short name, or "unknown" if unknown |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 429 | */ |
| 430 | const char *genimg_get_os_short_name(uint8_t comp); |
| 431 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 432 | const char *genimg_get_arch_name(uint8_t arch); |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 433 | |
| 434 | /** |
| 435 | * genimg_get_arch_short_name() - get the short name for an architecture |
| 436 | * |
| 437 | * @param arch Architecture type (IH_ARCH_...) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 438 | * Return: architecture short name, or "unknown" if unknown |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 439 | */ |
| 440 | const char *genimg_get_arch_short_name(uint8_t arch); |
| 441 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 442 | const char *genimg_get_type_name(uint8_t type); |
Simon Glass | 434a31b | 2015-06-23 15:38:25 -0600 | [diff] [blame] | 443 | |
| 444 | /** |
| 445 | * genimg_get_type_short_name() - get the short name for an image type |
| 446 | * |
| 447 | * @param type Image type (IH_TYPE_...) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 448 | * Return: image short name, or "unknown" if unknown |
Simon Glass | 434a31b | 2015-06-23 15:38:25 -0600 | [diff] [blame] | 449 | */ |
| 450 | const char *genimg_get_type_short_name(uint8_t type); |
| 451 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 452 | const char *genimg_get_comp_name(uint8_t comp); |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 453 | |
| 454 | /** |
| 455 | * genimg_get_comp_short_name() - get the short name for a compression method |
| 456 | * |
| 457 | * @param comp compression method (IH_COMP_...) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 458 | * Return: compression method short name, or "unknown" if unknown |
Simon Glass | 86c362d | 2016-02-22 22:55:50 -0700 | [diff] [blame] | 459 | */ |
| 460 | const char *genimg_get_comp_short_name(uint8_t comp); |
| 461 | |
Simon Glass | 1986433 | 2016-06-30 10:52:16 -0600 | [diff] [blame] | 462 | /** |
| 463 | * genimg_get_cat_name() - Get the name of an item in a category |
| 464 | * |
| 465 | * @category: Category of item |
| 466 | * @id: Item ID |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 467 | * Return: name of item, or "Unknown ..." if unknown |
Simon Glass | 1986433 | 2016-06-30 10:52:16 -0600 | [diff] [blame] | 468 | */ |
| 469 | const char *genimg_get_cat_name(enum ih_category category, uint id); |
| 470 | |
| 471 | /** |
| 472 | * genimg_get_cat_short_name() - Get the short name of an item in a category |
| 473 | * |
| 474 | * @category: Category of item |
| 475 | * @id: Item ID |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 476 | * Return: short name of item, or "Unknown ..." if unknown |
Simon Glass | 1986433 | 2016-06-30 10:52:16 -0600 | [diff] [blame] | 477 | */ |
| 478 | const char *genimg_get_cat_short_name(enum ih_category category, uint id); |
| 479 | |
| 480 | /** |
| 481 | * genimg_get_cat_count() - Get the number of items in a category |
| 482 | * |
| 483 | * @category: Category to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 484 | * Return: the number of items in the category (IH_xxx_COUNT) |
Simon Glass | 1986433 | 2016-06-30 10:52:16 -0600 | [diff] [blame] | 485 | */ |
| 486 | int genimg_get_cat_count(enum ih_category category); |
| 487 | |
| 488 | /** |
| 489 | * genimg_get_cat_desc() - Get the description of a category |
| 490 | * |
Naoki Hayama | 9f1622f | 2020-10-07 11:22:24 +0900 | [diff] [blame] | 491 | * @category: Category to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 492 | * Return: the description of a category, e.g. "architecture". This |
Simon Glass | 1986433 | 2016-06-30 10:52:16 -0600 | [diff] [blame] | 493 | * effectively converts the enum to a string. |
| 494 | */ |
| 495 | const char *genimg_get_cat_desc(enum ih_category category); |
| 496 | |
Naoki Hayama | d7e8291 | 2020-10-07 11:21:25 +0900 | [diff] [blame] | 497 | /** |
| 498 | * genimg_cat_has_id() - Check whether a category has an item |
| 499 | * |
| 500 | * @category: Category to check |
| 501 | * @id: Item ID |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 502 | * Return: true or false as to whether a category has an item |
Naoki Hayama | d7e8291 | 2020-10-07 11:21:25 +0900 | [diff] [blame] | 503 | */ |
| 504 | bool genimg_cat_has_id(enum ih_category category, uint id); |
| 505 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 506 | int genimg_get_os_id(const char *name); |
| 507 | int genimg_get_arch_id(const char *name); |
| 508 | int genimg_get_type_id(const char *name); |
| 509 | int genimg_get_comp_id(const char *name); |
| 510 | void genimg_print_size(uint32_t size); |
Marian Balakowicz | c3c7eb2 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 511 | |
Simon Glass | 2c6a1b0 | 2021-09-25 19:43:33 -0600 | [diff] [blame] | 512 | #if defined(CONFIG_TIMESTAMP) || defined(CONFIG_CMD_DATE) || defined(USE_HOSTCC) |
Simon Glass | af0ec0d | 2013-05-07 06:11:51 +0000 | [diff] [blame] | 513 | #define IMAGE_ENABLE_TIMESTAMP 1 |
| 514 | #else |
| 515 | #define IMAGE_ENABLE_TIMESTAMP 0 |
| 516 | #endif |
| 517 | void genimg_print_time(time_t timestamp); |
| 518 | |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 519 | /* What to do with a image load address ('load = <> 'in the FIT) */ |
| 520 | enum fit_load_op { |
| 521 | FIT_LOAD_IGNORED, /* Ignore load address */ |
| 522 | FIT_LOAD_OPTIONAL, /* Can be provided, but optional */ |
Simon Glass | 05a9ad7 | 2014-08-22 14:26:43 -0600 | [diff] [blame] | 523 | FIT_LOAD_OPTIONAL_NON_ZERO, /* Optional, a value of 0 is ignored */ |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 524 | FIT_LOAD_REQUIRED, /* Must be provided */ |
| 525 | }; |
| 526 | |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 527 | int boot_get_setup(bootm_headers_t *images, uint8_t arch, ulong *setup_start, |
| 528 | ulong *setup_len); |
| 529 | |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 530 | /* Image format types, returned by _get_format() routine */ |
| 531 | #define IMAGE_FORMAT_INVALID 0x00 |
| 532 | #define IMAGE_FORMAT_LEGACY 0x01 /* legacy image_header based format */ |
| 533 | #define IMAGE_FORMAT_FIT 0x02 /* new, libfdt based format */ |
Sebastian Siewior | 686d667 | 2014-05-05 15:08:09 -0500 | [diff] [blame] | 534 | #define IMAGE_FORMAT_ANDROID 0x03 /* Android boot image */ |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 535 | |
Bryan Wu | f5c377a | 2014-08-15 16:51:38 -0700 | [diff] [blame] | 536 | ulong genimg_get_kernel_addr_fit(char * const img_addr, |
| 537 | const char **fit_uname_config, |
| 538 | const char **fit_uname_kernel); |
Bryan Wu | af7b0de | 2014-07-31 17:39:58 -0700 | [diff] [blame] | 539 | ulong genimg_get_kernel_addr(char * const img_addr); |
Simon Glass | 4964806 | 2013-05-07 06:12:03 +0000 | [diff] [blame] | 540 | int genimg_get_format(const void *img_addr); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 541 | int genimg_has_config(bootm_headers_t *images); |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 542 | |
Simon Glass | ed38aef | 2020-05-10 11:40:03 -0600 | [diff] [blame] | 543 | int boot_get_fpga(int argc, char *const argv[], bootm_headers_t *images, |
| 544 | uint8_t arch, const ulong *ld_start, ulong * const ld_len); |
| 545 | int boot_get_ramdisk(int argc, char *const argv[], bootm_headers_t *images, |
| 546 | uint8_t arch, ulong *rd_start, ulong *rd_end); |
Karl Apsite | 1b21c28 | 2015-05-21 09:52:48 -0400 | [diff] [blame] | 547 | |
| 548 | /** |
| 549 | * boot_get_loadable - routine to load a list of binaries to memory |
| 550 | * @argc: Ignored Argument |
| 551 | * @argv: Ignored Argument |
| 552 | * @images: pointer to the bootm images structure |
| 553 | * @arch: expected architecture for the image |
| 554 | * @ld_start: Ignored Argument |
| 555 | * @ld_len: Ignored Argument |
| 556 | * |
| 557 | * boot_get_loadable() will take the given FIT configuration, and look |
| 558 | * for a field named "loadables". Loadables, is a list of elements in |
| 559 | * the FIT given as strings. exe: |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 560 | * loadables = "linux_kernel", "fdt-2"; |
Karl Apsite | 1b21c28 | 2015-05-21 09:52:48 -0400 | [diff] [blame] | 561 | * this function will attempt to parse each string, and load the |
| 562 | * corresponding element from the FIT into memory. Once placed, |
| 563 | * no aditional actions are taken. |
| 564 | * |
| 565 | * @return: |
| 566 | * 0, if only valid images or no images are found |
| 567 | * error code, if an error occurs during fit_image_load |
| 568 | */ |
Simon Glass | ed38aef | 2020-05-10 11:40:03 -0600 | [diff] [blame] | 569 | int boot_get_loadable(int argc, char *const argv[], bootm_headers_t *images, |
| 570 | uint8_t arch, const ulong *ld_start, ulong *const ld_len); |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 571 | |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 572 | int boot_get_setup_fit(bootm_headers_t *images, uint8_t arch, |
| 573 | ulong *setup_start, ulong *setup_len); |
| 574 | |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 575 | /** |
Pantelis Antoniou | 6e51fb2 | 2017-09-04 23:12:16 +0300 | [diff] [blame] | 576 | * boot_get_fdt_fit() - load a DTB from a FIT file (applying overlays) |
| 577 | * |
| 578 | * This deals with all aspects of loading an DTB from a FIT. |
| 579 | * The correct base image based on configuration will be selected, and |
| 580 | * then any overlays specified will be applied (as present in fit_uname_configp). |
| 581 | * |
| 582 | * @param images Boot images structure |
| 583 | * @param addr Address of FIT in memory |
| 584 | * @param fit_unamep On entry this is the requested image name |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 585 | * (e.g. "kernel") or NULL to use the default. On exit |
Pantelis Antoniou | 6e51fb2 | 2017-09-04 23:12:16 +0300 | [diff] [blame] | 586 | * points to the selected image name |
| 587 | * @param fit_uname_configp On entry this is the requested configuration |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 588 | * name (e.g. "conf-1") or NULL to use the default. On |
Pantelis Antoniou | 6e51fb2 | 2017-09-04 23:12:16 +0300 | [diff] [blame] | 589 | * exit points to the selected configuration name. |
| 590 | * @param arch Expected architecture (IH_ARCH_...) |
| 591 | * @param datap Returns address of loaded image |
| 592 | * @param lenp Returns length of loaded image |
| 593 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 594 | * Return: node offset of base image, or -ve error code on error |
Pantelis Antoniou | 6e51fb2 | 2017-09-04 23:12:16 +0300 | [diff] [blame] | 595 | */ |
| 596 | int boot_get_fdt_fit(bootm_headers_t *images, ulong addr, |
| 597 | const char **fit_unamep, const char **fit_uname_configp, |
| 598 | int arch, ulong *datap, ulong *lenp); |
| 599 | |
| 600 | /** |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 601 | * fit_image_load() - load an image from a FIT |
| 602 | * |
| 603 | * This deals with all aspects of loading an image from a FIT, including |
| 604 | * selecting the right image based on configuration, verifying it, printing |
| 605 | * out progress messages, checking the type/arch/os and optionally copying it |
| 606 | * to the right load address. |
| 607 | * |
Simon Glass | a0c0b63 | 2014-06-12 07:24:47 -0600 | [diff] [blame] | 608 | * The property to look up is defined by image_type. |
| 609 | * |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 610 | * @param images Boot images structure |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 611 | * @param addr Address of FIT in memory |
| 612 | * @param fit_unamep On entry this is the requested image name |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 613 | * (e.g. "kernel") or NULL to use the default. On exit |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 614 | * points to the selected image name |
Simon Glass | ad68fc3 | 2013-07-10 23:08:10 -0700 | [diff] [blame] | 615 | * @param fit_uname_configp On entry this is the requested configuration |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 616 | * name (e.g. "conf-1") or NULL to use the default. On |
Simon Glass | ad68fc3 | 2013-07-10 23:08:10 -0700 | [diff] [blame] | 617 | * exit points to the selected configuration name. |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 618 | * @param arch Expected architecture (IH_ARCH_...) |
| 619 | * @param image_type Required image type (IH_TYPE_...). If this is |
| 620 | * IH_TYPE_KERNEL then we allow IH_TYPE_KERNEL_NOLOAD |
| 621 | * also. |
| 622 | * @param bootstage_id ID of starting bootstage to use for progress updates. |
| 623 | * This will be added to the BOOTSTAGE_SUB values when |
| 624 | * calling bootstage_mark() |
| 625 | * @param load_op Decribes what to do with the load address |
| 626 | * @param datap Returns address of loaded image |
| 627 | * @param lenp Returns length of loaded image |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 628 | * Return: node offset of image, or -ve error code on error |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 629 | */ |
Simon Glass | a0c0b63 | 2014-06-12 07:24:47 -0600 | [diff] [blame] | 630 | int fit_image_load(bootm_headers_t *images, ulong addr, |
Simon Glass | ad68fc3 | 2013-07-10 23:08:10 -0700 | [diff] [blame] | 631 | const char **fit_unamep, const char **fit_uname_configp, |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 632 | int arch, int image_type, int bootstage_id, |
| 633 | enum fit_load_op load_op, ulong *datap, ulong *lenp); |
| 634 | |
Simon Glass | 606f09b | 2019-12-28 10:45:04 -0700 | [diff] [blame] | 635 | /** |
| 636 | * image_source_script() - Execute a script |
| 637 | * |
| 638 | * Executes a U-Boot script at a particular address in memory. The script should |
| 639 | * have a header (FIT or legacy) with the script type (IH_TYPE_SCRIPT). |
| 640 | * |
| 641 | * @addr: Address of script |
| 642 | * @fit_uname: FIT subimage name |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 643 | * Return: result code (enum command_ret_t) |
Simon Glass | 606f09b | 2019-12-28 10:45:04 -0700 | [diff] [blame] | 644 | */ |
| 645 | int image_source_script(ulong addr, const char *fit_uname); |
| 646 | |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 647 | /** |
| 648 | * fit_get_node_from_config() - Look up an image a FIT by type |
| 649 | * |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 650 | * This looks in the selected conf- node (images->fit_uname_cfg) for a |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 651 | * particular image type (e.g. "kernel") and then finds the image that is |
| 652 | * referred to. |
| 653 | * |
| 654 | * For example, for something like: |
| 655 | * |
| 656 | * images { |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 657 | * kernel { |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 658 | * ... |
| 659 | * }; |
| 660 | * }; |
| 661 | * configurations { |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 662 | * conf-1 { |
| 663 | * kernel = "kernel"; |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 664 | * }; |
| 665 | * }; |
| 666 | * |
| 667 | * the function will return the node offset of the kernel@1 node, assuming |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 668 | * that conf-1 is the chosen configuration. |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 669 | * |
| 670 | * @param images Boot images structure |
| 671 | * @param prop_name Property name to look up (FIT_..._PROP) |
| 672 | * @param addr Address of FIT in memory |
| 673 | */ |
| 674 | int fit_get_node_from_config(bootm_headers_t *images, const char *prop_name, |
| 675 | ulong addr); |
| 676 | |
Simon Glass | ed38aef | 2020-05-10 11:40:03 -0600 | [diff] [blame] | 677 | int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch, |
Simon Glass | b1b7992 | 2013-05-16 13:53:23 +0000 | [diff] [blame] | 678 | bootm_headers_t *images, |
| 679 | char **of_flat_tree, ulong *of_size); |
Grant Likely | 20f5492 | 2011-03-28 09:59:01 +0000 | [diff] [blame] | 680 | 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] | 681 | 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] | 682 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 683 | 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] | 684 | ulong *initrd_start, ulong *initrd_end); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 685 | int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end); |
Masahiro Yamada | f7ed78b | 2020-06-26 15:13:33 +0900 | [diff] [blame] | 686 | int boot_get_kbd(struct lmb *lmb, struct bd_info **kbd); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 687 | |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 688 | /*******************************************************************/ |
| 689 | /* Legacy format specific code (prefixed with image_) */ |
| 690 | /*******************************************************************/ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 691 | static inline uint32_t image_get_header_size(void) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 692 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 693 | return (sizeof(image_header_t)); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 694 | } |
| 695 | |
| 696 | #define image_get_hdr_l(f) \ |
Wolfgang Denk | 3b50677 | 2009-08-19 11:42:56 +0200 | [diff] [blame] | 697 | static inline uint32_t image_get_##f(const image_header_t *hdr) \ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 698 | { \ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 699 | return uimage_to_cpu(hdr->ih_##f); \ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 700 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 701 | image_get_hdr_l(magic) /* image_get_magic */ |
| 702 | image_get_hdr_l(hcrc) /* image_get_hcrc */ |
| 703 | image_get_hdr_l(time) /* image_get_time */ |
| 704 | image_get_hdr_l(size) /* image_get_size */ |
| 705 | image_get_hdr_l(load) /* image_get_load */ |
| 706 | image_get_hdr_l(ep) /* image_get_ep */ |
| 707 | image_get_hdr_l(dcrc) /* image_get_dcrc */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 708 | |
| 709 | #define image_get_hdr_b(f) \ |
Wolfgang Denk | 3b50677 | 2009-08-19 11:42:56 +0200 | [diff] [blame] | 710 | static inline uint8_t image_get_##f(const image_header_t *hdr) \ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 711 | { \ |
| 712 | return hdr->ih_##f; \ |
| 713 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 714 | image_get_hdr_b(os) /* image_get_os */ |
| 715 | image_get_hdr_b(arch) /* image_get_arch */ |
| 716 | image_get_hdr_b(type) /* image_get_type */ |
| 717 | image_get_hdr_b(comp) /* image_get_comp */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 718 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 719 | static inline char *image_get_name(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 720 | { |
| 721 | return (char *)hdr->ih_name; |
| 722 | } |
| 723 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 724 | 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] | 725 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 726 | return image_get_size(hdr); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 727 | } |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 728 | |
| 729 | /** |
| 730 | * image_get_data - get image payload start address |
| 731 | * @hdr: image header |
| 732 | * |
| 733 | * image_get_data() returns address of the image payload. For single |
| 734 | * component images it is image data start. For multi component |
| 735 | * images it points to the null terminated table of sub-images sizes. |
| 736 | * |
| 737 | * returns: |
| 738 | * image payload data start address |
| 739 | */ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 740 | static inline ulong image_get_data(const image_header_t *hdr) |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 741 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 742 | return ((ulong)hdr + image_get_header_size()); |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 743 | } |
| 744 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 745 | 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] | 746 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 747 | return (image_get_size(hdr) + image_get_header_size()); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 748 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 749 | static inline ulong image_get_image_end(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 750 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 751 | return ((ulong)hdr + image_get_image_size(hdr)); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 752 | } |
| 753 | |
| 754 | #define image_set_hdr_l(f) \ |
| 755 | static inline void image_set_##f(image_header_t *hdr, uint32_t val) \ |
| 756 | { \ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 757 | hdr->ih_##f = cpu_to_uimage(val); \ |
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 | image_set_hdr_l(magic) /* image_set_magic */ |
| 760 | image_set_hdr_l(hcrc) /* image_set_hcrc */ |
| 761 | image_set_hdr_l(time) /* image_set_time */ |
| 762 | image_set_hdr_l(size) /* image_set_size */ |
| 763 | image_set_hdr_l(load) /* image_set_load */ |
| 764 | image_set_hdr_l(ep) /* image_set_ep */ |
| 765 | image_set_hdr_l(dcrc) /* image_set_dcrc */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 766 | |
| 767 | #define image_set_hdr_b(f) \ |
| 768 | static inline void image_set_##f(image_header_t *hdr, uint8_t val) \ |
| 769 | { \ |
| 770 | hdr->ih_##f = val; \ |
| 771 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 772 | image_set_hdr_b(os) /* image_set_os */ |
| 773 | image_set_hdr_b(arch) /* image_set_arch */ |
| 774 | image_set_hdr_b(type) /* image_set_type */ |
| 775 | image_set_hdr_b(comp) /* image_set_comp */ |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 776 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 777 | 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] | 778 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 779 | strncpy(image_get_name(hdr), name, IH_NMLEN); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 780 | } |
| 781 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 782 | int image_check_hcrc(const image_header_t *hdr); |
| 783 | int image_check_dcrc(const image_header_t *hdr); |
Marian Balakowicz | f9a67bd | 2008-01-08 18:11:45 +0100 | [diff] [blame] | 784 | #ifndef USE_HOSTCC |
Simon Glass | da1a134 | 2017-08-03 12:22:15 -0600 | [diff] [blame] | 785 | ulong env_get_bootm_low(void); |
| 786 | phys_size_t env_get_bootm_size(void); |
| 787 | phys_size_t env_get_bootm_mapsize(void); |
Marian Balakowicz | f9a67bd | 2008-01-08 18:11:45 +0100 | [diff] [blame] | 788 | #endif |
Simon Glass | a51991d | 2014-06-12 07:24:53 -0600 | [diff] [blame] | 789 | void memmove_wd(void *to, void *from, size_t len, ulong chunksz); |
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 | static inline int image_check_magic(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 792 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 793 | return (image_get_magic(hdr) == IH_MAGIC); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 794 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 795 | 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] | 796 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 797 | return (image_get_type(hdr) == type); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 798 | } |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 799 | 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] | 800 | { |
Simon Glass | 062e79f | 2021-03-15 18:11:12 +1300 | [diff] [blame] | 801 | /* Let's assume that sandbox can load any architecture */ |
Simon Glass | 2c6a1b0 | 2021-09-25 19:43:33 -0600 | [diff] [blame] | 802 | if (!tools_build() && IS_ENABLED(CONFIG_SANDBOX)) |
Simon Glass | 062e79f | 2021-03-15 18:11:12 +1300 | [diff] [blame] | 803 | return true; |
Alison Wang | 42664e0 | 2017-06-06 15:32:40 +0800 | [diff] [blame] | 804 | return (image_get_arch(hdr) == arch) || |
| 805 | (image_get_arch(hdr) == IH_ARCH_ARM && arch == IH_ARCH_ARM64); |
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_os(const image_header_t *hdr, uint8_t os) |
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_os(hdr) == os); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 810 | } |
| 811 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 812 | ulong image_multi_count(const image_header_t *hdr); |
| 813 | void image_multi_getimg(const image_header_t *hdr, ulong idx, |
Marian Balakowicz | 05c1d3f | 2008-01-31 13:20:07 +0100 | [diff] [blame] | 814 | ulong *data, ulong *len); |
| 815 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 816 | void image_print_contents(const void *hdr); |
Marian Balakowicz | c3c7eb2 | 2008-02-29 15:59:59 +0100 | [diff] [blame] | 817 | |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 818 | #ifndef USE_HOSTCC |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 819 | static inline int image_check_target_arch(const image_header_t *hdr) |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 820 | { |
Mike Frysinger | 5da0bed | 2011-10-03 14:50:33 +0000 | [diff] [blame] | 821 | #ifndef IH_ARCH_DEFAULT |
| 822 | # 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] | 823 | #endif |
Mike Frysinger | 5da0bed | 2011-10-03 14:50:33 +0000 | [diff] [blame] | 824 | return image_check_arch(hdr, IH_ARCH_DEFAULT); |
Marian Balakowicz | 41d71ed | 2008-01-08 18:14:09 +0100 | [diff] [blame] | 825 | } |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 826 | #endif /* USE_HOSTCC */ |
wdenk | 5b1d713 | 2002-11-03 00:07:02 +0000 | [diff] [blame] | 827 | |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 828 | /** |
Atish Patra | 04e8cd8 | 2020-03-05 16:24:22 -0800 | [diff] [blame] | 829 | * image_decomp_type() - Find out compression type of an image |
| 830 | * |
| 831 | * @buf: Address in U-Boot memory where image is loaded. |
| 832 | * @len: Length of the compressed image. |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 833 | * Return: compression type or IH_COMP_NONE if not compressed. |
Atish Patra | 04e8cd8 | 2020-03-05 16:24:22 -0800 | [diff] [blame] | 834 | * |
| 835 | * Note: Only following compression types are supported now. |
| 836 | * lzo, lzma, gzip, bzip2 |
| 837 | */ |
| 838 | int image_decomp_type(const unsigned char *buf, ulong len); |
| 839 | |
| 840 | /** |
Julius Werner | 47ef986 | 2019-07-24 19:37:54 -0700 | [diff] [blame] | 841 | * image_decomp() - decompress an image |
| 842 | * |
| 843 | * @comp: Compression algorithm that is used (IH_COMP_...) |
| 844 | * @load: Destination load address in U-Boot memory |
| 845 | * @image_start Image start address (where we are decompressing from) |
| 846 | * @type: OS type (IH_OS_...) |
| 847 | * @load_bug: Place to decompress to |
| 848 | * @image_buf: Address to decompress from |
| 849 | * @image_len: Number of bytes in @image_buf to decompress |
| 850 | * @unc_len: Available space for decompression |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 851 | * Return: 0 if OK, -ve on error (BOOTM_ERR_...) |
Julius Werner | 47ef986 | 2019-07-24 19:37:54 -0700 | [diff] [blame] | 852 | */ |
| 853 | int image_decomp(int comp, ulong load, ulong image_start, int type, |
| 854 | void *load_buf, void *image_buf, ulong image_len, |
| 855 | uint unc_len, ulong *load_end); |
| 856 | |
| 857 | /** |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 858 | * Set up properties in the FDT |
| 859 | * |
| 860 | * This sets up properties in the FDT that is to be passed to linux. |
| 861 | * |
| 862 | * @images: Images information |
| 863 | * @blob: FDT to update |
| 864 | * @of_size: Size of the FDT |
| 865 | * @lmb: Points to logical memory block structure |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 866 | * Return: 0 if ok, <0 on failure |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 867 | */ |
| 868 | int image_setup_libfdt(bootm_headers_t *images, void *blob, |
| 869 | int of_size, struct lmb *lmb); |
| 870 | |
| 871 | /** |
| 872 | * Set up the FDT to use for booting a kernel |
| 873 | * |
| 874 | * This performs ramdisk setup, sets up the FDT if required, and adds |
| 875 | * paramters to the FDT if libfdt is available. |
| 876 | * |
| 877 | * @param images Images information |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 878 | * Return: 0 if ok, <0 on failure |
Simon Glass | 9ca3742 | 2013-05-08 08:06:01 +0000 | [diff] [blame] | 879 | */ |
| 880 | int image_setup_linux(bootm_headers_t *images); |
| 881 | |
Simon Glass | 5f1afdd | 2013-07-04 13:26:10 -0700 | [diff] [blame] | 882 | /** |
| 883 | * bootz_setup() - Extract stat and size of a Linux xImage |
| 884 | * |
| 885 | * @image: Address of image |
| 886 | * @start: Returns start address of image |
| 887 | * @end : Returns end address of image |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 888 | * Return: 0 if OK, 1 if the image was not recognised |
Simon Glass | 5f1afdd | 2013-07-04 13:26:10 -0700 | [diff] [blame] | 889 | */ |
| 890 | int bootz_setup(ulong image, ulong *start, ulong *end); |
| 891 | |
Bin Chen | dac184b | 2018-01-27 16:59:09 +1100 | [diff] [blame] | 892 | /** |
| 893 | * Return the correct start address and size of a Linux aarch64 Image. |
| 894 | * |
| 895 | * @image: Address of image |
| 896 | * @start: Returns start address of image |
| 897 | * @size : Returns size image |
Marek Vasut | 85ed289 | 2018-06-13 06:13:32 +0200 | [diff] [blame] | 898 | * @force_reloc: Ignore image->ep field, always place image to RAM start |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 899 | * Return: 0 if OK, 1 if the image was not recognised |
Bin Chen | dac184b | 2018-01-27 16:59:09 +1100 | [diff] [blame] | 900 | */ |
Marek Vasut | 85ed289 | 2018-06-13 06:13:32 +0200 | [diff] [blame] | 901 | int booti_setup(ulong image, ulong *relocated_addr, ulong *size, |
| 902 | bool force_reloc); |
Simon Glass | 5f1afdd | 2013-07-04 13:26:10 -0700 | [diff] [blame] | 903 | |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 904 | /*******************************************************************/ |
Marian Balakowicz | d7c88a4 | 2008-02-29 14:58:34 +0100 | [diff] [blame] | 905 | /* New uImage format specific code (prefixed with fit_) */ |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 906 | /*******************************************************************/ |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 907 | |
| 908 | #define FIT_IMAGES_PATH "/images" |
| 909 | #define FIT_CONFS_PATH "/configurations" |
| 910 | |
Simon Glass | d7aabcc | 2020-03-18 11:44:06 -0600 | [diff] [blame] | 911 | /* hash/signature/key node */ |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 912 | #define FIT_HASH_NODENAME "hash" |
| 913 | #define FIT_ALGO_PROP "algo" |
| 914 | #define FIT_VALUE_PROP "value" |
Joe Hershberger | 8b7d32a | 2012-08-17 10:34:39 +0000 | [diff] [blame] | 915 | #define FIT_IGNORE_PROP "uboot-ignore" |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 916 | #define FIT_SIG_NODENAME "signature" |
Simon Glass | d7aabcc | 2020-03-18 11:44:06 -0600 | [diff] [blame] | 917 | #define FIT_KEY_REQUIRED "required" |
| 918 | #define FIT_KEY_HINT "key-name-hint" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 919 | |
Philippe Reynes | 3148e42 | 2019-12-18 18:25:41 +0100 | [diff] [blame] | 920 | /* cipher node */ |
| 921 | #define FIT_CIPHER_NODENAME "cipher" |
| 922 | #define FIT_ALGO_PROP "algo" |
| 923 | |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 924 | /* image node */ |
| 925 | #define FIT_DATA_PROP "data" |
Peng Fan | 8876c7e | 2017-12-05 13:20:59 +0800 | [diff] [blame] | 926 | #define FIT_DATA_POSITION_PROP "data-position" |
tomas.melin@vaisala.com | 45ee790 | 2017-01-13 13:20:14 +0200 | [diff] [blame] | 927 | #define FIT_DATA_OFFSET_PROP "data-offset" |
| 928 | #define FIT_DATA_SIZE_PROP "data-size" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 929 | #define FIT_TIMESTAMP_PROP "timestamp" |
| 930 | #define FIT_DESC_PROP "description" |
| 931 | #define FIT_ARCH_PROP "arch" |
| 932 | #define FIT_TYPE_PROP "type" |
| 933 | #define FIT_OS_PROP "os" |
| 934 | #define FIT_COMP_PROP "compression" |
| 935 | #define FIT_ENTRY_PROP "entry" |
| 936 | #define FIT_LOAD_PROP "load" |
| 937 | |
| 938 | /* configuration node */ |
| 939 | #define FIT_KERNEL_PROP "kernel" |
| 940 | #define FIT_RAMDISK_PROP "ramdisk" |
| 941 | #define FIT_FDT_PROP "fdt" |
Karl Apsite | 8f0537d | 2015-05-21 09:52:47 -0400 | [diff] [blame] | 942 | #define FIT_LOADABLE_PROP "loadables" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 943 | #define FIT_DEFAULT_PROP "default" |
Simon Glass | 0129b52 | 2014-10-19 21:11:24 -0600 | [diff] [blame] | 944 | #define FIT_SETUP_PROP "setup" |
Michal Simek | 0a130b1 | 2016-05-17 13:58:44 +0200 | [diff] [blame] | 945 | #define FIT_FPGA_PROP "fpga" |
Michal Simek | b766e8f | 2018-03-26 16:31:26 +0200 | [diff] [blame] | 946 | #define FIT_FIRMWARE_PROP "firmware" |
Marek Vasut | 93e9575 | 2018-05-13 00:22:54 +0200 | [diff] [blame] | 947 | #define FIT_STANDALONE_PROP "standalone" |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 948 | |
Michael van der Westhuizen | e36c6c3 | 2014-05-30 20:59:00 +0200 | [diff] [blame] | 949 | #define FIT_MAX_HASH_LEN HASH_MAX_DIGEST_SIZE |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 950 | |
| 951 | /* cmdline argument format parsing */ |
Mike Frysinger | 711453d | 2012-04-22 06:59:06 +0000 | [diff] [blame] | 952 | int fit_parse_conf(const char *spec, ulong addr_curr, |
Marian Balakowicz | 3413e22 | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 953 | ulong *addr, const char **conf_name); |
Mike Frysinger | 711453d | 2012-04-22 06:59:06 +0000 | [diff] [blame] | 954 | int fit_parse_subimage(const char *spec, ulong addr_curr, |
Marian Balakowicz | 3413e22 | 2008-02-21 17:20:20 +0100 | [diff] [blame] | 955 | ulong *addr, const char **image_name); |
Marian Balakowicz | dbdd16a | 2008-02-04 08:28:09 +0100 | [diff] [blame] | 956 | |
Guilherme Maciel Ferreira | 3c46bcd | 2015-01-15 02:54:42 -0200 | [diff] [blame] | 957 | int fit_get_subimage_count(const void *fit, int images_noffset); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 958 | void fit_print_contents(const void *fit); |
| 959 | void fit_image_print(const void *fit, int noffset, const char *p); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 960 | |
| 961 | /** |
| 962 | * fit_get_end - get FIT image size |
| 963 | * @fit: pointer to the FIT format image header |
| 964 | * |
| 965 | * returns: |
| 966 | * size of the FIT image (blob) in memory |
| 967 | */ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 968 | static inline ulong fit_get_size(const void *fit) |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 969 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 970 | return fdt_totalsize(fit); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 971 | } |
| 972 | |
| 973 | /** |
| 974 | * fit_get_end - get FIT image end |
| 975 | * @fit: pointer to the FIT format image header |
| 976 | * |
| 977 | * returns: |
| 978 | * end address of the FIT image (blob) in memory |
| 979 | */ |
Simon Glass | 5b539a0 | 2016-02-24 09:14:42 -0700 | [diff] [blame] | 980 | ulong fit_get_end(const void *fit); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 981 | |
| 982 | /** |
| 983 | * fit_get_name - get FIT node name |
| 984 | * @fit: pointer to the FIT format image header |
| 985 | * |
| 986 | * returns: |
| 987 | * NULL, on error |
| 988 | * pointer to node name, on success |
| 989 | */ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 990 | static inline const char *fit_get_name(const void *fit_hdr, |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 991 | int noffset, int *len) |
| 992 | { |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 993 | return fdt_get_name(fit_hdr, noffset, len); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 994 | } |
| 995 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 996 | int fit_get_desc(const void *fit, int noffset, char **desc); |
| 997 | int fit_get_timestamp(const void *fit, int noffset, time_t *timestamp); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 998 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 999 | int fit_image_get_node(const void *fit, const char *image_uname); |
| 1000 | int fit_image_get_os(const void *fit, int noffset, uint8_t *os); |
| 1001 | int fit_image_get_arch(const void *fit, int noffset, uint8_t *arch); |
| 1002 | int fit_image_get_type(const void *fit, int noffset, uint8_t *type); |
| 1003 | int fit_image_get_comp(const void *fit, int noffset, uint8_t *comp); |
| 1004 | int fit_image_get_load(const void *fit, int noffset, ulong *load); |
| 1005 | int fit_image_get_entry(const void *fit, int noffset, ulong *entry); |
| 1006 | int fit_image_get_data(const void *fit, int noffset, |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1007 | const void **data, size_t *size); |
tomas.melin@vaisala.com | 45ee790 | 2017-01-13 13:20:14 +0200 | [diff] [blame] | 1008 | int fit_image_get_data_offset(const void *fit, int noffset, int *data_offset); |
Peng Fan | 8876c7e | 2017-12-05 13:20:59 +0800 | [diff] [blame] | 1009 | int fit_image_get_data_position(const void *fit, int noffset, |
| 1010 | int *data_position); |
tomas.melin@vaisala.com | 45ee790 | 2017-01-13 13:20:14 +0200 | [diff] [blame] | 1011 | int fit_image_get_data_size(const void *fit, int noffset, int *data_size); |
Philippe Reynes | 3d96470 | 2019-12-18 18:25:42 +0100 | [diff] [blame] | 1012 | int fit_image_get_data_size_unciphered(const void *fit, int noffset, |
| 1013 | size_t *data_size); |
Kelvin Cheung | 186cc99 | 2018-05-19 18:21:37 +0800 | [diff] [blame] | 1014 | int fit_image_get_data_and_size(const void *fit, int noffset, |
| 1015 | const void **data, size_t *size); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1016 | |
Sean Anderson | 080d3a0 | 2022-08-16 11:16:03 -0400 | [diff] [blame] | 1017 | /** |
| 1018 | * fit_get_data_node() - Get verified image data for an image |
| 1019 | * @fit: Pointer to the FIT format image header |
| 1020 | * @image_uname: The name of the image node |
| 1021 | * @data: A pointer which will be filled with the location of the image data |
| 1022 | * @size: A pointer which will be filled with the size of the image data |
| 1023 | * |
| 1024 | * This function looks up the location and size of an image specified by its |
| 1025 | * name. For example, if you had a FIT like:: |
| 1026 | * |
| 1027 | * images { |
| 1028 | * my-firmware { |
| 1029 | * ... |
| 1030 | * }; |
| 1031 | * }; |
| 1032 | * |
| 1033 | * Then you could look up the data location and size of the my-firmware image |
| 1034 | * by calling this function with @image_uname set to "my-firmware". This |
| 1035 | * function also verifies the image data (if enabled) before returning. The |
| 1036 | * image description is printed out on success. @data and @size will not be |
| 1037 | * modified on faulure. |
| 1038 | * |
| 1039 | * Return: |
| 1040 | * * 0 on success |
| 1041 | * * -EINVAL if the image could not be verified |
| 1042 | * * -ENOENT if there was a problem getting the data/size |
| 1043 | * * Another negative error if there was a problem looking up the image node. |
| 1044 | */ |
| 1045 | int fit_get_data_node(const void *fit, const char *image_uname, |
| 1046 | const void **data, size_t *size); |
| 1047 | |
| 1048 | /** |
| 1049 | * fit_get_data_conf_prop() - Get verified image data for a property in /conf |
| 1050 | * @fit: Pointer to the FIT format image header |
| 1051 | * @prop_name: The name of the property in /conf referencing the image |
| 1052 | * @data: A pointer which will be filled with the location of the image data |
| 1053 | * @size: A pointer which will be filled with the size of the image data |
| 1054 | * |
| 1055 | * This function looks up the location and size of an image specified by a |
| 1056 | * property in /conf. For example, if you had a FIT like:: |
| 1057 | * |
| 1058 | * images { |
| 1059 | * my-firmware { |
| 1060 | * ... |
| 1061 | * }; |
| 1062 | * }; |
| 1063 | * |
| 1064 | * configurations { |
| 1065 | * default = "conf-1"; |
| 1066 | * conf-1 { |
| 1067 | * some-firmware = "my-firmware"; |
| 1068 | * }; |
| 1069 | * }; |
| 1070 | * |
| 1071 | * Then you could look up the data location and size of the my-firmware image |
| 1072 | * by calling this function with @prop_name set to "some-firmware". This |
| 1073 | * function also verifies the image data (if enabled) before returning. The |
| 1074 | * image description is printed out on success. @data and @size will not be |
| 1075 | * modified on faulure. |
| 1076 | * |
| 1077 | * Return: |
| 1078 | * * 0 on success |
| 1079 | * * -EINVAL if the image could not be verified |
| 1080 | * * -ENOENT if there was a problem getting the data/size |
| 1081 | * * Another negative error if there was a problem looking up the configuration |
| 1082 | * or image node. |
| 1083 | */ |
| 1084 | int fit_get_data_conf_prop(const void *fit, const char *prop_name, |
| 1085 | const void **data, size_t *size); |
| 1086 | |
Jan Kiszka | 27beec2 | 2022-01-14 10:21:17 +0100 | [diff] [blame] | 1087 | int fit_image_hash_get_algo(const void *fit, int noffset, const char **algo); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1088 | 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] | 1089 | int *value_len); |
| 1090 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1091 | int fit_set_timestamp(void *fit, int noffset, time_t timestamp); |
Simon Glass | ee38265 | 2013-05-07 06:12:01 +0000 | [diff] [blame] | 1092 | |
Philippe Reynes | 3e3899c | 2022-03-28 22:57:02 +0200 | [diff] [blame] | 1093 | /** |
| 1094 | * fit_pre_load_data() - add public key to fdt blob |
| 1095 | * |
| 1096 | * Adds public key to the node pre load. |
| 1097 | * |
| 1098 | * @keydir: Directory containing keys |
| 1099 | * @keydest: FDT blob to write public key |
| 1100 | * @fit: Pointer to the FIT format image header |
| 1101 | * |
| 1102 | * returns: |
| 1103 | * 0, on success |
| 1104 | * < 0, on failure |
| 1105 | */ |
| 1106 | int fit_pre_load_data(const char *keydir, void *keydest, void *fit); |
| 1107 | |
Philippe Reynes | 3148e42 | 2019-12-18 18:25:41 +0100 | [diff] [blame] | 1108 | int fit_cipher_data(const char *keydir, void *keydest, void *fit, |
| 1109 | const char *comment, int require_keys, |
| 1110 | const char *engine_id, const char *cmdname); |
| 1111 | |
Simon Glass | e460726 | 2021-11-12 12:28:13 -0700 | [diff] [blame] | 1112 | #define NODE_MAX_NAME_LEN 80 |
| 1113 | |
| 1114 | /** |
| 1115 | * struct image_summary - Provides information about signing info added |
| 1116 | * |
| 1117 | * @sig_offset: Offset of the node in the blob devicetree where the signature |
| 1118 | * was wriiten |
| 1119 | * @sig_path: Path to @sig_offset |
| 1120 | * @keydest_offset: Offset of the node in the keydest devicetree where the |
| 1121 | * public key was written (-1 if none) |
| 1122 | * @keydest_path: Path to @keydest_offset |
| 1123 | */ |
| 1124 | struct image_summary { |
| 1125 | int sig_offset; |
| 1126 | char sig_path[NODE_MAX_NAME_LEN]; |
| 1127 | int keydest_offset; |
| 1128 | char keydest_path[NODE_MAX_NAME_LEN]; |
| 1129 | }; |
| 1130 | |
Simon Glass | ee38265 | 2013-05-07 06:12:01 +0000 | [diff] [blame] | 1131 | /** |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1132 | * fit_add_verification_data() - add verification data to FIT image nodes |
Simon Glass | ee38265 | 2013-05-07 06:12:01 +0000 | [diff] [blame] | 1133 | * |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1134 | * @keydir: Directory containing keys |
Simon Glass | 6a0efc8 | 2021-11-12 12:28:06 -0700 | [diff] [blame] | 1135 | * @kwydest: FDT blob to write public key information to (NULL if none) |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1136 | * @fit: Pointer to the FIT format image header |
| 1137 | * @comment: Comment to add to signature nodes |
| 1138 | * @require_keys: Mark all keys as 'required' |
George McCollister | 23d1489 | 2017-01-06 13:14:17 -0600 | [diff] [blame] | 1139 | * @engine_id: Engine to use for signing |
Alex Kiernan | 697fcdc | 2018-06-20 20:10:52 +0000 | [diff] [blame] | 1140 | * @cmdname: Command name used when reporting errors |
Jan Kiszka | 4043f32 | 2022-01-14 10:21:19 +0100 | [diff] [blame] | 1141 | * @algo_name: Algorithm name, or NULL if to be read from FIT |
Simon Glass | e460726 | 2021-11-12 12:28:13 -0700 | [diff] [blame] | 1142 | * @summary: Returns information about what data was written |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1143 | * |
| 1144 | * Adds hash values for all component images in the FIT blob. |
| 1145 | * Hashes are calculated for all component images which have hash subnodes |
| 1146 | * with algorithm property set to one of the supported hash algorithms. |
| 1147 | * |
| 1148 | * Also add signatures if signature nodes are present. |
| 1149 | * |
| 1150 | * returns |
| 1151 | * 0, on success |
| 1152 | * libfdt error code, on failure |
Simon Glass | ee38265 | 2013-05-07 06:12:01 +0000 | [diff] [blame] | 1153 | */ |
Alexandru Gagniuc | 8fcea12 | 2021-02-19 12:45:17 -0600 | [diff] [blame] | 1154 | int fit_add_verification_data(const char *keydir, const char *keyfile, |
| 1155 | void *keydest, void *fit, const char *comment, |
| 1156 | int require_keys, const char *engine_id, |
Simon Glass | e460726 | 2021-11-12 12:28:13 -0700 | [diff] [blame] | 1157 | const char *cmdname, const char *algo_name, |
| 1158 | struct image_summary *summary); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1159 | |
Simon Glass | e10e2ee | 2021-11-12 12:28:10 -0700 | [diff] [blame] | 1160 | /** |
| 1161 | * fit_image_verify_with_data() - Verify an image with given data |
| 1162 | * |
| 1163 | * @fit: Pointer to the FIT format image header |
| 1164 | * @image_offset: Offset in @fit of image to verify |
| 1165 | * @key_blob: FDT containing public keys |
| 1166 | * @data: Image data to verify |
| 1167 | * @size: Size of image data |
| 1168 | */ |
Jun Nie | adf5d1c | 2018-02-27 16:55:58 +0800 | [diff] [blame] | 1169 | int fit_image_verify_with_data(const void *fit, int image_noffset, |
Simon Glass | e10e2ee | 2021-11-12 12:28:10 -0700 | [diff] [blame] | 1170 | const void *key_blob, const void *data, |
| 1171 | size_t size); |
| 1172 | |
Simon Glass | 7428ad1 | 2013-05-07 06:11:57 +0000 | [diff] [blame] | 1173 | int fit_image_verify(const void *fit, int noffset); |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1174 | int fit_config_verify(const void *fit, int conf_noffset); |
Simon Glass | 7428ad1 | 2013-05-07 06:11:57 +0000 | [diff] [blame] | 1175 | int fit_all_image_verify(const void *fit); |
Philippe Reynes | 3d96470 | 2019-12-18 18:25:42 +0100 | [diff] [blame] | 1176 | int fit_config_decrypt(const void *fit, int conf_noffset); |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1177 | int fit_image_check_os(const void *fit, int noffset, uint8_t os); |
| 1178 | int fit_image_check_arch(const void *fit, int noffset, uint8_t arch); |
| 1179 | int fit_image_check_type(const void *fit, int noffset, uint8_t type); |
| 1180 | int fit_image_check_comp(const void *fit, int noffset, uint8_t comp); |
Simon Glass | d563c25 | 2021-02-15 17:08:09 -0700 | [diff] [blame] | 1181 | |
| 1182 | /** |
| 1183 | * fit_check_format() - Check that the FIT is valid |
| 1184 | * |
| 1185 | * This performs various checks on the FIT to make sure it is suitable for |
| 1186 | * use, looking for mandatory properties, nodes, etc. |
| 1187 | * |
| 1188 | * If FIT_FULL_CHECK is enabled, it also runs it through libfdt to make |
| 1189 | * sure that there are no strange tags or broken nodes in the FIT. |
| 1190 | * |
| 1191 | * @fit: pointer to the FIT format image header |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1192 | * Return: 0 if OK, -ENOEXEC if not an FDT file, -EINVAL if the full FDT check |
Simon Glass | d563c25 | 2021-02-15 17:08:09 -0700 | [diff] [blame] | 1193 | * failed (e.g. due to bad structure), -ENOMSG if the description is |
Simon Glass | b641de8 | 2021-02-24 08:50:32 -0500 | [diff] [blame] | 1194 | * missing, -EBADMSG if the timestamp is missing, -ENOENT if the /images |
Simon Glass | d563c25 | 2021-02-15 17:08:09 -0700 | [diff] [blame] | 1195 | * path is missing |
| 1196 | */ |
| 1197 | int fit_check_format(const void *fit, ulong size); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1198 | |
Gabe Black | d572e16 | 2012-10-25 16:31:10 +0000 | [diff] [blame] | 1199 | int fit_conf_find_compat(const void *fit, const void *fdt); |
Simon Glass | 2f3c6c5 | 2020-03-18 11:43:55 -0600 | [diff] [blame] | 1200 | |
| 1201 | /** |
| 1202 | * fit_conf_get_node - get node offset for configuration of a given unit name |
| 1203 | * @fit: pointer to the FIT format image header |
| 1204 | * @conf_uname: configuration node unit name (NULL to use default) |
| 1205 | * |
| 1206 | * fit_conf_get_node() finds a configuration (within the '/configurations' |
| 1207 | * parent node) of a provided unit name. If configuration is found its node |
| 1208 | * offset is returned to the caller. |
| 1209 | * |
| 1210 | * When NULL is provided in second argument fit_conf_get_node() will search |
| 1211 | * for a default configuration node instead. Default configuration node unit |
| 1212 | * name is retrieved from FIT_DEFAULT_PROP property of the '/configurations' |
| 1213 | * node. |
| 1214 | * |
| 1215 | * returns: |
| 1216 | * configuration node offset when found (>=0) |
| 1217 | * negative number on failure (FDT_ERR_* code) |
| 1218 | */ |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1219 | int fit_conf_get_node(const void *fit, const char *conf_uname); |
Simon Glass | 2f3c6c5 | 2020-03-18 11:43:55 -0600 | [diff] [blame] | 1220 | |
Tien Fong Chee | ca99a8a | 2019-05-07 17:42:28 +0800 | [diff] [blame] | 1221 | int fit_conf_get_prop_node_count(const void *fit, int noffset, |
| 1222 | const char *prop_name); |
| 1223 | int fit_conf_get_prop_node_index(const void *fit, int noffset, |
| 1224 | const char *prop_name, int index); |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1225 | |
Simon Glass | dc0f52c | 2013-05-07 06:12:00 +0000 | [diff] [blame] | 1226 | /** |
| 1227 | * fit_conf_get_prop_node() - Get node refered to by a configuration |
| 1228 | * @fit: FIT to check |
| 1229 | * @noffset: Offset of conf@xxx node to check |
| 1230 | * @prop_name: Property to read from the conf node |
| 1231 | * |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 1232 | * The conf- nodes contain references to other nodes, using properties |
| 1233 | * like 'kernel = "kernel"'. Given such a property name (e.g. "kernel"), |
Simon Glass | dc0f52c | 2013-05-07 06:12:00 +0000 | [diff] [blame] | 1234 | * return the offset of the node referred to (e.g. offset of node |
Andre Przywara | 3234ecd | 2017-12-04 02:05:10 +0000 | [diff] [blame] | 1235 | * "/images/kernel". |
Simon Glass | dc0f52c | 2013-05-07 06:12:00 +0000 | [diff] [blame] | 1236 | */ |
| 1237 | int fit_conf_get_prop_node(const void *fit, int noffset, |
| 1238 | const char *prop_name); |
| 1239 | |
Simon Glass | 36b916a | 2013-05-07 06:11:52 +0000 | [diff] [blame] | 1240 | int fit_check_ramdisk(const void *fit, int os_noffset, |
| 1241 | uint8_t arch, int verify); |
| 1242 | |
Simon Glass | 10a1eca | 2013-05-07 06:11:54 +0000 | [diff] [blame] | 1243 | int calculate_hash(const void *data, int data_len, const char *algo, |
| 1244 | uint8_t *value, int *value_len); |
| 1245 | |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1246 | /* |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1247 | * At present we only support signing on the host, and verification on the |
| 1248 | * device |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1249 | */ |
Alex Kiernan | bb6abce | 2019-04-18 20:34:55 +0000 | [diff] [blame] | 1250 | #if defined(USE_HOSTCC) |
| 1251 | # if defined(CONFIG_FIT_SIGNATURE) |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1252 | # define IMAGE_ENABLE_SIGN 1 |
AKASHI Takahiro | 2223c7d | 2020-02-21 15:12:55 +0900 | [diff] [blame] | 1253 | # define FIT_IMAGE_ENABLE_VERIFY 1 |
Alex Kiernan | bb6abce | 2019-04-18 20:34:55 +0000 | [diff] [blame] | 1254 | # include <openssl/evp.h> |
| 1255 | # else |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1256 | # define IMAGE_ENABLE_SIGN 0 |
AKASHI Takahiro | 2223c7d | 2020-02-21 15:12:55 +0900 | [diff] [blame] | 1257 | # define FIT_IMAGE_ENABLE_VERIFY 0 |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1258 | # endif |
| 1259 | #else |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1260 | # define IMAGE_ENABLE_SIGN 0 |
AKASHI Takahiro | 2223c7d | 2020-02-21 15:12:55 +0900 | [diff] [blame] | 1261 | # define FIT_IMAGE_ENABLE_VERIFY CONFIG_IS_ENABLED(FIT_SIGNATURE) |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1262 | #endif |
| 1263 | |
| 1264 | #ifdef USE_HOSTCC |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1265 | void *image_get_host_blob(void); |
| 1266 | void image_set_host_blob(void *host_blob); |
| 1267 | # define gd_fdt_blob() image_get_host_blob() |
Simon Glass | 384d86d | 2013-05-16 13:53:21 +0000 | [diff] [blame] | 1268 | #else |
| 1269 | # define gd_fdt_blob() (gd->fdt_blob) |
| 1270 | #endif |
| 1271 | |
Alexandru Gagniuc | 8fcea12 | 2021-02-19 12:45:17 -0600 | [diff] [blame] | 1272 | /* |
| 1273 | * Information passed to the signing routines |
| 1274 | * |
| 1275 | * Either 'keydir', 'keyname', or 'keyfile' can be NULL. However, either |
| 1276 | * 'keyfile', or both 'keydir' and 'keyname' should have valid values. If |
| 1277 | * neither are valid, some operations might fail with EINVAL. |
| 1278 | */ |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1279 | struct image_sign_info { |
| 1280 | const char *keydir; /* Directory conaining keys */ |
| 1281 | const char *keyname; /* Name of key to use */ |
Alexandru Gagniuc | 8fcea12 | 2021-02-19 12:45:17 -0600 | [diff] [blame] | 1282 | const char *keyfile; /* Filename of private or public key */ |
Hannu Lounento | e2b1e1f | 2021-10-18 08:49:03 +0300 | [diff] [blame] | 1283 | const void *fit; /* Pointer to FIT blob */ |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1284 | int node_offset; /* Offset of signature node */ |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1285 | const char *name; /* Algorithm name */ |
| 1286 | struct checksum_algo *checksum; /* Checksum algorithm information */ |
Philippe Reynes | 1246835 | 2018-11-14 13:51:00 +0100 | [diff] [blame] | 1287 | struct padding_algo *padding; /* Padding algorithm information */ |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1288 | struct crypto_algo *crypto; /* Crypto algorithm information */ |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1289 | const void *fdt_blob; /* FDT containing public keys */ |
| 1290 | int required_keynode; /* Node offset of key to use: -1=any */ |
| 1291 | const char *require_keys; /* Value for 'required' property */ |
George McCollister | 23d1489 | 2017-01-06 13:14:17 -0600 | [diff] [blame] | 1292 | const char *engine_id; /* Engine to use for signing */ |
AKASHI Takahiro | 3eae5fd | 2020-02-21 15:12:57 +0900 | [diff] [blame] | 1293 | /* |
| 1294 | * Note: the following two fields are always valid even w/o |
| 1295 | * RSA_VERIFY_WITH_PKEY in order to make sure this structure is |
| 1296 | * the same on target and host. Otherwise, vboot test may fail. |
| 1297 | */ |
| 1298 | const void *key; /* Pointer to public key in DER */ |
| 1299 | int keylen; /* Length of public key */ |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1300 | }; |
Philippe Reynes | 3148e42 | 2019-12-18 18:25:41 +0100 | [diff] [blame] | 1301 | |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1302 | /* A part of an image, used for hashing */ |
| 1303 | struct image_region { |
| 1304 | const void *data; |
| 1305 | int size; |
| 1306 | }; |
| 1307 | |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1308 | struct checksum_algo { |
| 1309 | const char *name; |
| 1310 | const int checksum_len; |
Andrew Duda | 3db9ff0 | 2016-11-08 18:53:40 +0000 | [diff] [blame] | 1311 | const int der_len; |
| 1312 | const uint8_t *der_prefix; |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1313 | #if IMAGE_ENABLE_SIGN |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1314 | const EVP_MD *(*calculate_sign)(void); |
| 1315 | #endif |
Ruchika Gupta | 2c8987f | 2015-01-23 16:01:59 +0530 | [diff] [blame] | 1316 | int (*calculate)(const char *name, |
Simon Glass | 2c6a1b0 | 2021-09-25 19:43:33 -0600 | [diff] [blame] | 1317 | const struct image_region *region, |
Ruchika Gupta | 2c8987f | 2015-01-23 16:01:59 +0530 | [diff] [blame] | 1318 | int region_count, uint8_t *checksum); |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1319 | }; |
| 1320 | |
Andrew Duda | 06ca6d6 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1321 | struct crypto_algo { |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1322 | const char *name; /* Name of algorithm */ |
Andrew Duda | 06ca6d6 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1323 | const int key_len; |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1324 | |
| 1325 | /** |
| 1326 | * sign() - calculate and return signature for given input data |
| 1327 | * |
| 1328 | * @info: Specifies key and FIT information |
| 1329 | * @data: Pointer to the input data |
| 1330 | * @data_len: Data length |
| 1331 | * @sigp: Set to an allocated buffer holding the signature |
| 1332 | * @sig_len: Set to length of the calculated hash |
| 1333 | * |
| 1334 | * This computes input data signature according to selected algorithm. |
| 1335 | * Resulting signature value is placed in an allocated buffer, the |
| 1336 | * pointer is returned as *sigp. The length of the calculated |
| 1337 | * signature is returned via the sig_len pointer argument. The caller |
| 1338 | * should free *sigp. |
| 1339 | * |
| 1340 | * @return: 0, on success, -ve on error |
| 1341 | */ |
| 1342 | int (*sign)(struct image_sign_info *info, |
| 1343 | const struct image_region region[], |
| 1344 | int region_count, uint8_t **sigp, uint *sig_len); |
| 1345 | |
| 1346 | /** |
| 1347 | * add_verify_data() - Add verification information to FDT |
| 1348 | * |
| 1349 | * Add public key information to the FDT node, suitable for |
| 1350 | * verification at run-time. The information added depends on the |
| 1351 | * algorithm being used. |
| 1352 | * |
| 1353 | * @info: Specifies key and FIT information |
| 1354 | * @keydest: Destination FDT blob for public key data |
Simon Glass | 94336dc | 2021-11-12 12:28:11 -0700 | [diff] [blame] | 1355 | * @return: node offset within the FDT blob where the data was written, |
| 1356 | * or -ve on error |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1357 | */ |
| 1358 | int (*add_verify_data)(struct image_sign_info *info, void *keydest); |
| 1359 | |
| 1360 | /** |
| 1361 | * verify() - Verify a signature against some data |
| 1362 | * |
| 1363 | * @info: Specifies key and FIT information |
| 1364 | * @data: Pointer to the input data |
| 1365 | * @data_len: Data length |
| 1366 | * @sig: Signature |
| 1367 | * @sig_len: Number of bytes in signature |
| 1368 | * @return 0 if verified, -ve on error |
| 1369 | */ |
| 1370 | int (*verify)(struct image_sign_info *info, |
| 1371 | const struct image_region region[], int region_count, |
| 1372 | uint8_t *sig, uint sig_len); |
Andrew Duda | 06ca6d6 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1373 | }; |
Heiko Schocher | edaf9b1 | 2014-03-03 12:19:26 +0100 | [diff] [blame] | 1374 | |
Alexandru Gagniuc | b04e918 | 2021-07-14 17:05:39 -0500 | [diff] [blame] | 1375 | /* Declare a new U-Boot crypto algorithm handler */ |
| 1376 | #define U_BOOT_CRYPTO_ALGO(__name) \ |
| 1377 | ll_entry_declare(struct crypto_algo, __name, cryptos) |
| 1378 | |
Philippe Reynes | 1246835 | 2018-11-14 13:51:00 +0100 | [diff] [blame] | 1379 | struct padding_algo { |
| 1380 | const char *name; |
| 1381 | int (*verify)(struct image_sign_info *info, |
SESA644425 | 1304b46 | 2022-03-09 01:27:15 -0800 | [diff] [blame] | 1382 | const uint8_t *pad, int pad_len, |
Philippe Reynes | 1246835 | 2018-11-14 13:51:00 +0100 | [diff] [blame] | 1383 | const uint8_t *hash, int hash_len); |
| 1384 | }; |
| 1385 | |
Alexandru Gagniuc | f3b5e58 | 2021-08-18 17:49:02 -0500 | [diff] [blame] | 1386 | /* Declare a new U-Boot padding algorithm handler */ |
| 1387 | #define U_BOOT_PADDING_ALGO(__name) \ |
| 1388 | ll_entry_declare(struct padding_algo, __name, paddings) |
| 1389 | |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1390 | /** |
| 1391 | * image_get_checksum_algo() - Look up a checksum algorithm |
| 1392 | * |
| 1393 | * @param full_name Name of algorithm in the form "checksum,crypto" |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1394 | * Return: pointer to algorithm information, or NULL if not found |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1395 | */ |
| 1396 | struct checksum_algo *image_get_checksum_algo(const char *full_name); |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1397 | |
| 1398 | /** |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1399 | * image_get_crypto_algo() - Look up a cryptosystem algorithm |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1400 | * |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1401 | * @param full_name Name of algorithm in the form "checksum,crypto" |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1402 | * Return: pointer to algorithm information, or NULL if not found |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1403 | */ |
Andrew Duda | 6616c82 | 2016-11-08 18:53:41 +0000 | [diff] [blame] | 1404 | struct crypto_algo *image_get_crypto_algo(const char *full_name); |
Simon Glass | 58fe7e5 | 2013-06-13 15:10:00 -0700 | [diff] [blame] | 1405 | |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1406 | /** |
Philippe Reynes | 1246835 | 2018-11-14 13:51:00 +0100 | [diff] [blame] | 1407 | * image_get_padding_algo() - Look up a padding algorithm |
| 1408 | * |
| 1409 | * @param name Name of padding algorithm |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1410 | * Return: pointer to algorithm information, or NULL if not found |
Philippe Reynes | 1246835 | 2018-11-14 13:51:00 +0100 | [diff] [blame] | 1411 | */ |
| 1412 | struct padding_algo *image_get_padding_algo(const char *name); |
| 1413 | |
| 1414 | /** |
Philippe Reynes | d28484e | 2022-03-28 22:56:59 +0200 | [diff] [blame] | 1415 | * image_pre_load() - Manage pre load header |
| 1416 | * |
| 1417 | * Manage the pre-load header before launching the image. |
| 1418 | * It checks the signature of the image. It also set the |
| 1419 | * variable image_load_offset to skip this header before |
| 1420 | * launching the image. |
| 1421 | * |
| 1422 | * @param addr Address of the image |
| 1423 | * @return: 0 on success, -ve on error |
| 1424 | */ |
| 1425 | int image_pre_load(ulong addr); |
| 1426 | |
| 1427 | /** |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1428 | * fit_image_verify_required_sigs() - Verify signatures marked as 'required' |
| 1429 | * |
| 1430 | * @fit: FIT to check |
| 1431 | * @image_noffset: Offset of image node to check |
| 1432 | * @data: Image data to check |
| 1433 | * @size: Size of image data |
Simon Glass | e10e2ee | 2021-11-12 12:28:10 -0700 | [diff] [blame] | 1434 | * @key_blob: FDT containing public keys |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1435 | * @no_sigsp: Returns 1 if no signatures were required, and |
| 1436 | * therefore nothing was checked. The caller may wish |
| 1437 | * to fall back to other mechanisms, or refuse to |
| 1438 | * boot. |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1439 | * Return: 0 if all verified ok, <0 on error |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1440 | */ |
| 1441 | int fit_image_verify_required_sigs(const void *fit, int image_noffset, |
Simon Glass | e10e2ee | 2021-11-12 12:28:10 -0700 | [diff] [blame] | 1442 | const char *data, size_t size, const void *key_blob, |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1443 | int *no_sigsp); |
| 1444 | |
| 1445 | /** |
| 1446 | * fit_image_check_sig() - Check a single image signature node |
| 1447 | * |
| 1448 | * @fit: FIT to check |
| 1449 | * @noffset: Offset of signature node to check |
| 1450 | * @data: Image data to check |
| 1451 | * @size: Size of image data |
Simon Glass | e10e2ee | 2021-11-12 12:28:10 -0700 | [diff] [blame] | 1452 | * @keyblob: Key blob to check (typically the control FDT) |
| 1453 | * @required_keynode: Offset in the keyblob of the required key node, |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1454 | * if any. If this is given, then the image wil not |
| 1455 | * pass verification unless that key is used. If this is |
| 1456 | * -1 then any signature will do. |
| 1457 | * @err_msgp: In the event of an error, this will be pointed to a |
| 1458 | * help error string to display to the user. |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1459 | * Return: 0 if all verified ok, <0 on error |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1460 | */ |
| 1461 | int fit_image_check_sig(const void *fit, int noffset, const void *data, |
Simon Glass | e10e2ee | 2021-11-12 12:28:10 -0700 | [diff] [blame] | 1462 | size_t size, const void *key_blob, int required_keynode, |
| 1463 | char **err_msgp); |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1464 | |
Philippe Reynes | 3d96470 | 2019-12-18 18:25:42 +0100 | [diff] [blame] | 1465 | int fit_image_decrypt_data(const void *fit, |
| 1466 | int image_noffset, int cipher_noffset, |
| 1467 | const void *data, size_t size, |
| 1468 | void **data_unciphered, size_t *size_unciphered); |
| 1469 | |
Simon Glass | 56ab8d6 | 2013-06-13 15:10:09 -0700 | [diff] [blame] | 1470 | /** |
| 1471 | * fit_region_make_list() - Make a list of regions to hash |
| 1472 | * |
| 1473 | * Given a list of FIT regions (offset, size) provided by libfdt, create |
| 1474 | * a list of regions (void *, size) for use by the signature creationg |
| 1475 | * and verification code. |
| 1476 | * |
| 1477 | * @fit: FIT image to process |
| 1478 | * @fdt_regions: Regions as returned by libfdt |
| 1479 | * @count: Number of regions returned by libfdt |
| 1480 | * @region: Place to put list of regions (NULL to allocate it) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1481 | * Return: pointer to list of regions, or NULL if out of memory |
Simon Glass | 56ab8d6 | 2013-06-13 15:10:09 -0700 | [diff] [blame] | 1482 | */ |
| 1483 | struct image_region *fit_region_make_list(const void *fit, |
| 1484 | struct fdt_region *fdt_regions, int count, |
| 1485 | struct image_region *region); |
Simon Glass | fbabc0f | 2013-06-13 15:10:01 -0700 | [diff] [blame] | 1486 | |
Stephen Warren | 6904b6e | 2011-10-18 11:11:49 +0000 | [diff] [blame] | 1487 | 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] | 1488 | { |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1489 | #ifndef USE_HOSTCC |
Thierry Reding | 7d731a9 | 2011-10-27 08:58:25 +0000 | [diff] [blame] | 1490 | return fit_image_check_arch(fdt, node, IH_ARCH_DEFAULT); |
Heiko Schocher | d7b4232 | 2014-03-03 12:19:30 +0100 | [diff] [blame] | 1491 | #else |
| 1492 | return 0; |
| 1493 | #endif |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1494 | } |
Marian Balakowicz | e227fbb | 2008-02-29 21:24:06 +0100 | [diff] [blame] | 1495 | |
Philippe Reynes | 3148e42 | 2019-12-18 18:25:41 +0100 | [diff] [blame] | 1496 | /* |
| 1497 | * At present we only support ciphering on the host, and unciphering on the |
| 1498 | * device |
| 1499 | */ |
| 1500 | #if defined(USE_HOSTCC) |
| 1501 | # if defined(CONFIG_FIT_CIPHER) |
| 1502 | # define IMAGE_ENABLE_ENCRYPT 1 |
| 1503 | # define IMAGE_ENABLE_DECRYPT 1 |
| 1504 | # include <openssl/evp.h> |
| 1505 | # else |
| 1506 | # define IMAGE_ENABLE_ENCRYPT 0 |
| 1507 | # define IMAGE_ENABLE_DECRYPT 0 |
| 1508 | # endif |
| 1509 | #else |
| 1510 | # define IMAGE_ENABLE_ENCRYPT 0 |
| 1511 | # define IMAGE_ENABLE_DECRYPT CONFIG_IS_ENABLED(FIT_CIPHER) |
| 1512 | #endif |
| 1513 | |
| 1514 | /* Information passed to the ciphering routines */ |
| 1515 | struct image_cipher_info { |
| 1516 | const char *keydir; /* Directory containing keys */ |
| 1517 | const char *keyname; /* Name of key to use */ |
| 1518 | const char *ivname; /* Name of IV to use */ |
| 1519 | const void *fit; /* Pointer to FIT blob */ |
| 1520 | int node_noffset; /* Offset of the cipher node */ |
| 1521 | const char *name; /* Algorithm name */ |
| 1522 | struct cipher_algo *cipher; /* Cipher algorithm information */ |
| 1523 | const void *fdt_blob; /* FDT containing key and IV */ |
| 1524 | const void *key; /* Value of the key */ |
| 1525 | const void *iv; /* Value of the IV */ |
| 1526 | size_t size_unciphered; /* Size of the unciphered data */ |
| 1527 | }; |
| 1528 | |
| 1529 | struct cipher_algo { |
| 1530 | const char *name; /* Name of algorithm */ |
| 1531 | int key_len; /* Length of the key */ |
| 1532 | int iv_len; /* Length of the IV */ |
| 1533 | |
| 1534 | #if IMAGE_ENABLE_ENCRYPT |
| 1535 | const EVP_CIPHER * (*calculate_type)(void); |
| 1536 | #endif |
| 1537 | |
| 1538 | int (*encrypt)(struct image_cipher_info *info, |
| 1539 | const unsigned char *data, int data_len, |
| 1540 | unsigned char **cipher, int *cipher_len); |
| 1541 | |
| 1542 | int (*add_cipher_data)(struct image_cipher_info *info, |
Philippe Reynes | 64d67c4 | 2020-09-17 15:01:46 +0200 | [diff] [blame] | 1543 | void *keydest, void *fit, int node_noffset); |
Philippe Reynes | 3d96470 | 2019-12-18 18:25:42 +0100 | [diff] [blame] | 1544 | |
| 1545 | int (*decrypt)(struct image_cipher_info *info, |
| 1546 | const void *cipher, size_t cipher_len, |
| 1547 | void **data, size_t *data_len); |
Philippe Reynes | 3148e42 | 2019-12-18 18:25:41 +0100 | [diff] [blame] | 1548 | }; |
| 1549 | |
| 1550 | int fit_image_cipher_get_algo(const void *fit, int noffset, char **algo); |
| 1551 | |
| 1552 | struct cipher_algo *image_get_cipher_algo(const char *full_name); |
| 1553 | |
Sebastian Siewior | 686d667 | 2014-05-05 15:08:09 -0500 | [diff] [blame] | 1554 | struct andr_img_hdr; |
| 1555 | int android_image_check_header(const struct andr_img_hdr *hdr); |
| 1556 | int android_image_get_kernel(const struct andr_img_hdr *hdr, int verify, |
| 1557 | ulong *os_data, ulong *os_len); |
| 1558 | int android_image_get_ramdisk(const struct andr_img_hdr *hdr, |
| 1559 | ulong *rd_data, ulong *rd_len); |
Bin Chen | 909f140 | 2018-01-27 16:59:08 +1100 | [diff] [blame] | 1560 | int android_image_get_second(const struct andr_img_hdr *hdr, |
| 1561 | ulong *second_data, ulong *second_len); |
Sam Protsenko | 2666a1a | 2020-01-24 17:53:41 +0200 | [diff] [blame] | 1562 | bool android_image_get_dtbo(ulong hdr_addr, ulong *addr, u32 *size); |
Sam Protsenko | 4fabf40 | 2020-01-24 17:53:40 +0200 | [diff] [blame] | 1563 | bool android_image_get_dtb_by_index(ulong hdr_addr, u32 index, ulong *addr, |
| 1564 | u32 *size); |
Sebastian Siewior | 686d667 | 2014-05-05 15:08:09 -0500 | [diff] [blame] | 1565 | ulong android_image_get_end(const struct andr_img_hdr *hdr); |
| 1566 | ulong android_image_get_kload(const struct andr_img_hdr *hdr); |
Eugeniu Rosca | 1403f39 | 2019-04-08 17:35:27 +0200 | [diff] [blame] | 1567 | ulong android_image_get_kcomp(const struct andr_img_hdr *hdr); |
Michael Trimarchi | 44af20b | 2016-06-10 19:54:37 +0200 | [diff] [blame] | 1568 | void android_print_contents(const struct andr_img_hdr *hdr); |
Sam Protsenko | 4fabf40 | 2020-01-24 17:53:40 +0200 | [diff] [blame] | 1569 | bool android_image_print_dtb_contents(ulong hdr_addr); |
Sebastian Siewior | 686d667 | 2014-05-05 15:08:09 -0500 | [diff] [blame] | 1570 | |
Simon Glass | f287dfd | 2016-02-22 22:55:55 -0700 | [diff] [blame] | 1571 | /** |
| 1572 | * board_fit_config_name_match() - Check for a matching board name |
| 1573 | * |
| 1574 | * This is used when SPL loads a FIT containing multiple device tree files |
| 1575 | * and wants to work out which one to use. The description of each one is |
| 1576 | * passed to this function. The description comes from the 'description' field |
| 1577 | * in each (FDT) image node. |
| 1578 | * |
| 1579 | * @name: Device tree description |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1580 | * Return: 0 if this device tree should be used, non-zero to try the next |
Simon Glass | f287dfd | 2016-02-22 22:55:55 -0700 | [diff] [blame] | 1581 | */ |
| 1582 | int board_fit_config_name_match(const char *name); |
| 1583 | |
Daniel Allred | cf839bd | 2016-06-27 09:19:21 -0500 | [diff] [blame] | 1584 | /** |
| 1585 | * board_fit_image_post_process() - Do any post-process on FIT binary data |
| 1586 | * |
| 1587 | * This is used to do any sort of image manipulation, verification, decryption |
| 1588 | * etc. in a platform or board specific way. Obviously, anything done here would |
| 1589 | * need to be comprehended in how the images were prepared before being injected |
| 1590 | * into the FIT creation (i.e. the binary blobs would have been pre-processed |
| 1591 | * before being added to the FIT image). |
| 1592 | * |
Lokesh Vutla | b36dd3e | 2021-06-11 11:45:05 +0300 | [diff] [blame] | 1593 | * @fit: pointer to fit image |
| 1594 | * @node: offset of image node |
Daniel Allred | cf839bd | 2016-06-27 09:19:21 -0500 | [diff] [blame] | 1595 | * @image: pointer to the image start pointer |
| 1596 | * @size: pointer to the image size |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1597 | * Return: no return value (failure should be handled internally) |
Daniel Allred | cf839bd | 2016-06-27 09:19:21 -0500 | [diff] [blame] | 1598 | */ |
Lokesh Vutla | b36dd3e | 2021-06-11 11:45:05 +0300 | [diff] [blame] | 1599 | void board_fit_image_post_process(const void *fit, int node, void **p_image, |
| 1600 | size_t *p_size); |
Daniel Allred | cf839bd | 2016-06-27 09:19:21 -0500 | [diff] [blame] | 1601 | |
Cooper Jr., Franklin | e679240 | 2017-06-16 17:25:05 -0500 | [diff] [blame] | 1602 | #define FDT_ERROR ((ulong)(-1)) |
| 1603 | |
Cooper Jr., Franklin | 899aad2 | 2017-06-16 17:25:06 -0500 | [diff] [blame] | 1604 | 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] | 1605 | |
| 1606 | /** |
| 1607 | * fit_find_config_node() - Find the node for the best DTB in a FIT image |
| 1608 | * |
| 1609 | * A FIT image contains one or more DTBs. This function parses the |
| 1610 | * configurations described in the FIT images and returns the node of |
| 1611 | * the first matching DTB. To check if a DTB matches a board, this function |
| 1612 | * calls board_fit_config_name_match(). If no matching DTB is found, it returns |
| 1613 | * the node described by the default configuration if it exists. |
| 1614 | * |
| 1615 | * @fdt: pointer to flat device tree |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 1616 | * Return: the node if found, -ve otherwise |
Jean-Jacques Hiblot | 5e7c12e | 2017-09-15 12:57:27 +0200 | [diff] [blame] | 1617 | */ |
Cooper Jr., Franklin | 899aad2 | 2017-06-16 17:25:06 -0500 | [diff] [blame] | 1618 | int fit_find_config_node(const void *fdt); |
| 1619 | |
Andrew F. Davis | 28b28f7 | 2016-11-29 16:33:20 -0600 | [diff] [blame] | 1620 | /** |
| 1621 | * Mapping of image types to function handlers to be invoked on the associated |
| 1622 | * loaded images |
| 1623 | * |
| 1624 | * @type: Type of image, I.E. IH_TYPE_* |
| 1625 | * @handler: Function to call on loaded image |
| 1626 | */ |
| 1627 | struct fit_loadable_tbl { |
| 1628 | int type; |
| 1629 | /** |
| 1630 | * handler() - Process a loaded image |
| 1631 | * |
| 1632 | * @data: Pointer to start of loaded image data |
| 1633 | * @size: Size of loaded image data |
| 1634 | */ |
| 1635 | void (*handler)(ulong data, size_t size); |
| 1636 | }; |
| 1637 | |
| 1638 | /* |
| 1639 | * Define a FIT loadable image type handler |
| 1640 | * |
| 1641 | * _type is a valid uimage_type ID as defined in the "Image Type" enum above |
| 1642 | * _handler is the handler function to call after this image type is loaded |
| 1643 | */ |
| 1644 | #define U_BOOT_FIT_LOADABLE_HANDLER(_type, _handler) \ |
| 1645 | ll_entry_declare(struct fit_loadable_tbl, _function, fit_loadable) = { \ |
| 1646 | .type = _type, \ |
| 1647 | .handler = _handler, \ |
| 1648 | } |
| 1649 | |
AKASHI Takahiro | 768d58d | 2020-10-29 13:47:43 +0900 | [diff] [blame] | 1650 | /** |
| 1651 | * fit_update - update storage with FIT image |
| 1652 | * @fit: Pointer to FIT image |
| 1653 | * |
| 1654 | * Update firmware on storage using FIT image as input. |
| 1655 | * The storage area to be update will be identified by the name |
| 1656 | * in FIT and matching it to "dfu_alt_info" variable. |
| 1657 | * |
| 1658 | * Return: 0 on success, non-zero otherwise |
| 1659 | */ |
| 1660 | int fit_update(const void *fit); |
| 1661 | |
Marian Balakowicz | b4a12a9 | 2008-01-08 18:12:17 +0100 | [diff] [blame] | 1662 | #endif /* __IMAGE_H__ */ |