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