1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2006
6 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
16 #include <u-boot/crc.h>
18 #ifdef CONFIG_SHOW_BOOT_PROGRESS
19 #include <status_led.h>
22 #if CONFIG_IS_ENABLED(FIT) || CONFIG_IS_ENABLED(OF_LIBFDT)
23 #include <linux/libfdt.h>
24 #include <fdt_support.h>
27 #include <asm/global_data.h>
28 #include <u-boot/md5.h>
29 #include <u-boot/sha1.h>
30 #include <linux/errno.h>
33 DECLARE_GLOBAL_DATA_PTR;
35 /* Set this if we have less than 4 MB of malloc() space */
36 #if CONFIG_SYS_MALLOC_LEN < (4096 * 1024)
37 #define CONSERVE_MEMORY true
39 #define CONSERVE_MEMORY false
42 #else /* USE_HOSTCC */
44 #include <u-boot/md5.h>
47 #ifndef __maybe_unused
48 # define __maybe_unused /* unimplemented */
51 #define CONSERVE_MEMORY false
53 #endif /* !USE_HOSTCC*/
57 #include <display_options.h>
62 #include <linux/lzo.h>
63 #include <linux/zstd.h>
64 #include <linux/kconfig.h>
65 #include <lzma/LzmaTypes.h>
66 #include <lzma/LzmaDec.h>
67 #include <lzma/LzmaTools.h>
68 #include <u-boot/crc.h>
69 #include <u-boot/lz4.h>
71 static const table_entry_t uimage_arch[] = {
72 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
73 { IH_ARCH_ALPHA, "alpha", "Alpha", },
74 { IH_ARCH_ARM, "arm", "ARM", },
75 { IH_ARCH_I386, "x86", "Intel x86", },
76 { IH_ARCH_IA64, "ia64", "IA64", },
77 { IH_ARCH_M68K, "m68k", "M68K", },
78 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
79 { IH_ARCH_MIPS, "mips", "MIPS", },
80 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
81 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
82 { IH_ARCH_PPC, "powerpc", "PowerPC", },
83 { IH_ARCH_PPC, "ppc", "PowerPC", },
84 { IH_ARCH_S390, "s390", "IBM S390", },
85 { IH_ARCH_SH, "sh", "SuperH", },
86 { IH_ARCH_SPARC, "sparc", "SPARC", },
87 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
88 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
89 { IH_ARCH_AVR32, "avr32", "AVR32", },
90 { IH_ARCH_NDS32, "nds32", "NDS32", },
91 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
92 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
93 { IH_ARCH_ARM64, "arm64", "AArch64", },
94 { IH_ARCH_ARC, "arc", "ARC", },
95 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
96 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
97 { IH_ARCH_RISCV, "riscv", "RISC-V", },
101 static const table_entry_t uimage_os[] = {
102 { IH_OS_INVALID, "invalid", "Invalid OS", },
103 { IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware" },
104 { IH_OS_LINUX, "linux", "Linux", },
105 #if defined(USE_HOSTCC)
106 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
108 { IH_OS_NETBSD, "netbsd", "NetBSD", },
109 { IH_OS_OSE, "ose", "Enea OSE", },
110 { IH_OS_PLAN9, "plan9", "Plan 9", },
111 { IH_OS_RTEMS, "rtems", "RTEMS", },
112 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
113 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
114 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
115 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
116 { IH_OS_QNX, "qnx", "QNX", },
118 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
119 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
122 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
123 { IH_OS_DELL, "dell", "Dell", },
124 { IH_OS_ESIX, "esix", "Esix", },
125 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
126 { IH_OS_IRIX, "irix", "Irix", },
127 { IH_OS_NCR, "ncr", "NCR", },
128 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
129 { IH_OS_PSOS, "psos", "pSOS", },
130 { IH_OS_SCO, "sco", "SCO", },
131 { IH_OS_SOLARIS, "solaris", "Solaris", },
132 { IH_OS_SVR4, "svr4", "SVR4", },
134 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
135 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
137 { IH_OS_OPENSBI, "opensbi", "RISC-V OpenSBI", },
138 { IH_OS_EFI, "efi", "EFI Firmware" },
143 static const table_entry_t uimage_type[] = {
144 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
145 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
146 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
147 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
148 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
149 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
150 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
151 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
152 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
153 { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
154 { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
155 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
156 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
157 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
158 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
159 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
160 { IH_TYPE_SCRIPT, "script", "Script", },
161 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
162 { IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
163 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
164 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
165 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
166 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
167 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
168 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
169 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
170 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
171 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
172 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
173 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
174 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
175 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
176 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
177 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
178 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
179 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
180 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
181 { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
182 { IH_TYPE_COPRO, "copro", "Coprocessor Image"},
183 { IH_TYPE_SUNXI_EGON, "sunxi_egon", "Allwinner eGON Boot Image" },
187 static const table_entry_t uimage_comp[] = {
188 { IH_COMP_NONE, "none", "uncompressed", },
189 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
190 { IH_COMP_GZIP, "gzip", "gzip compressed", },
191 { IH_COMP_LZMA, "lzma", "lzma compressed", },
192 { IH_COMP_LZO, "lzo", "lzo compressed", },
193 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
194 { IH_COMP_ZSTD, "zstd", "zstd compressed", },
201 const table_entry_t *table;
204 static const struct comp_magic_map image_comp[] = {
205 { IH_COMP_BZIP2, "bzip2", {0x42, 0x5a},},
206 { IH_COMP_GZIP, "gzip", {0x1f, 0x8b},},
207 { IH_COMP_LZMA, "lzma", {0x5d, 0x00},},
208 { IH_COMP_LZO, "lzo", {0x89, 0x4c},},
209 { IH_COMP_LZ4, "lz4", {0x04, 0x22},},
210 { IH_COMP_ZSTD, "zstd", {0x28, 0xb5},},
211 { IH_COMP_NONE, "none", {}, },
214 static const struct table_info table_info[IH_COUNT] = {
215 { "architecture", IH_ARCH_COUNT, uimage_arch },
216 { "compression", IH_COMP_COUNT, uimage_comp },
217 { "operating system", IH_OS_COUNT, uimage_os },
218 { "image type", IH_TYPE_COUNT, uimage_type },
221 /*****************************************************************************/
222 /* Legacy format routines */
223 /*****************************************************************************/
224 int image_check_hcrc(const image_header_t *hdr)
227 ulong len = image_get_header_size();
228 image_header_t header;
230 /* Copy header so we can blank CRC field for re-calculation */
231 memmove(&header, (char *)hdr, image_get_header_size());
232 image_set_hcrc(&header, 0);
234 hcrc = crc32(0, (unsigned char *)&header, len);
236 return (hcrc == image_get_hcrc(hdr));
239 int image_check_dcrc(const image_header_t *hdr)
241 ulong data = image_get_data(hdr);
242 ulong len = image_get_data_size(hdr);
243 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
245 return (dcrc == image_get_dcrc(hdr));
249 * image_multi_count - get component (sub-image) count
250 * @hdr: pointer to the header of the multi component image
252 * image_multi_count() returns number of components in a multi
255 * Note: no checking of the image type is done, caller must pass
256 * a valid multi component image.
259 * number of components
261 ulong image_multi_count(const image_header_t *hdr)
266 /* get start of the image payload, which in case of multi
267 * component images that points to a table of component sizes */
268 size = (uint32_t *)image_get_data(hdr);
270 /* count non empty slots */
271 for (i = 0; size[i]; ++i)
278 * image_multi_getimg - get component data address and size
279 * @hdr: pointer to the header of the multi component image
280 * @idx: index of the requested component
281 * @data: pointer to a ulong variable, will hold component data address
282 * @len: pointer to a ulong variable, will hold component size
284 * image_multi_getimg() returns size and data address for the requested
285 * component in a multi component image.
287 * Note: no checking of the image type is done, caller must pass
288 * a valid multi component image.
291 * data address and size of the component, if idx is valid
292 * 0 in data and len, if idx is out of range
294 void image_multi_getimg(const image_header_t *hdr, ulong idx,
295 ulong *data, ulong *len)
299 ulong offset, count, img_data;
301 /* get number of component */
302 count = image_multi_count(hdr);
304 /* get start of the image payload, which in case of multi
305 * component images that points to a table of component sizes */
306 size = (uint32_t *)image_get_data(hdr);
308 /* get address of the proper component data start, which means
309 * skipping sizes table (add 1 for last, null entry) */
310 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
313 *len = uimage_to_cpu(size[idx]);
316 /* go over all indices preceding requested component idx */
317 for (i = 0; i < idx; i++) {
318 /* add up i-th component size, rounding up to 4 bytes */
319 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
322 /* calculate idx-th component data address */
323 *data = img_data + offset;
330 static void image_print_type(const image_header_t *hdr)
332 const char __maybe_unused *os, *arch, *type, *comp;
334 os = genimg_get_os_name(image_get_os(hdr));
335 arch = genimg_get_arch_name(image_get_arch(hdr));
336 type = genimg_get_type_name(image_get_type(hdr));
337 comp = genimg_get_comp_name(image_get_comp(hdr));
339 printf("%s %s %s (%s)\n", arch, os, type, comp);
343 * image_print_contents - prints out the contents of the legacy format image
344 * @ptr: pointer to the legacy format image header
345 * @p: pointer to prefix string
347 * image_print_contents() formats a multi line legacy image contents description.
348 * The routine prints out all header fields followed by the size/offset data
349 * for MULTI/SCRIPT images.
352 * no returned results
354 void image_print_contents(const void *ptr)
356 const image_header_t *hdr = (const image_header_t *)ptr;
357 const char __maybe_unused *p;
359 p = IMAGE_INDENT_STRING;
360 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
361 if (IMAGE_ENABLE_TIMESTAMP) {
362 printf("%sCreated: ", p);
363 genimg_print_time((time_t)image_get_time(hdr));
365 printf("%sImage Type: ", p);
366 image_print_type(hdr);
367 printf("%sData Size: ", p);
368 genimg_print_size(image_get_data_size(hdr));
369 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
370 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
372 if (image_check_type(hdr, IH_TYPE_MULTI) ||
373 image_check_type(hdr, IH_TYPE_SCRIPT)) {
376 ulong count = image_multi_count(hdr);
378 printf("%sContents:\n", p);
379 for (i = 0; i < count; i++) {
380 image_multi_getimg(hdr, i, &data, &len);
382 printf("%s Image %d: ", p, i);
383 genimg_print_size(len);
385 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
387 * the user may need to know offsets
388 * if planning to do something with
391 printf("%s Offset = 0x%08lx\n", p, data);
394 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
395 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
396 image_get_load(hdr) - image_get_header_size(),
397 (int)(image_get_size(hdr) + image_get_header_size()
398 + sizeof(flash_header_v2_t) - 0x2060));
403 * print_decomp_msg() - Print a suitable decompression/loading message
405 * @type: OS type (IH_OS_...)
406 * @comp_type: Compression type being used (IH_COMP_...)
407 * @is_xip: true if the load address matches the image start
409 static void print_decomp_msg(int comp_type, int type, bool is_xip)
411 const char *name = genimg_get_type_name(type);
413 if (comp_type == IH_COMP_NONE)
414 printf(" %s %s\n", is_xip ? "XIP" : "Loading", name);
416 printf(" Uncompressing %s\n", name);
419 int image_decomp_type(const unsigned char *buf, ulong len)
421 const struct comp_magic_map *cmagic = image_comp;
426 for (; cmagic->comp_id > 0; cmagic++) {
427 if (!memcmp(buf, cmagic->magic, 2))
431 return cmagic->comp_id;
434 int image_decomp(int comp, ulong load, ulong image_start, int type,
435 void *load_buf, void *image_buf, ulong image_len,
436 uint unc_len, ulong *load_end)
441 print_decomp_msg(comp, type, load == image_start);
444 * Load the image to the right place, decompressing if needed. After
445 * this, image_len will be set to the number of uncompressed bytes
446 * loaded, ret will be non-zero on error.
451 if (load == image_start)
453 if (image_len <= unc_len)
454 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
459 if (!tools_build() && CONFIG_IS_ENABLED(GZIP))
460 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
463 if (!tools_build() && CONFIG_IS_ENABLED(BZIP2)) {
467 * If we've got less than 4 MB of malloc() space,
468 * use slower decompression algorithm which requires
469 * at most 2300 KB of memory.
471 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
472 image_buf, image_len, CONSERVE_MEMORY, 0);
477 if (!tools_build() && CONFIG_IS_ENABLED(LZMA)) {
478 SizeT lzma_len = unc_len;
480 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
481 image_buf, image_len);
482 image_len = lzma_len;
486 if (!tools_build() && CONFIG_IS_ENABLED(LZO)) {
487 size_t size = unc_len;
489 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
494 if (!tools_build() && CONFIG_IS_ENABLED(LZ4)) {
495 size_t size = unc_len;
497 ret = ulz4fn(image_buf, image_len, load_buf, &size);
502 if (!tools_build() && CONFIG_IS_ENABLED(ZSTD)) {
505 abuf_init_set(&in, image_buf, image_len);
506 abuf_init_set(&in, load_buf, unc_len);
507 ret = zstd_decompress(&in, &out);
515 if (ret == -ENOSYS) {
516 printf("Unimplemented compression type %d\n", comp);
522 *load_end = load + image_len;
527 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
529 for (; table->id >= 0; ++table) {
536 static const char *unknown_msg(enum ih_category category)
538 static const char unknown_str[] = "Unknown ";
541 strcpy(msg, unknown_str);
542 strncat(msg, table_info[category].desc,
543 sizeof(msg) - sizeof(unknown_str));
549 * genimg_get_cat_name - translate entry id to long name
550 * @category: category to look up (enum ih_category)
551 * @id: entry id to be translated
553 * This will scan the translation table trying to find the entry that matches
556 * @return long entry name if translation succeeds; error string on failure
558 const char *genimg_get_cat_name(enum ih_category category, uint id)
560 const table_entry_t *entry;
562 entry = get_table_entry(table_info[category].table, id);
564 return unknown_msg(category);
565 return manual_reloc(entry->lname);
569 * genimg_get_cat_short_name - translate entry id to short name
570 * @category: category to look up (enum ih_category)
571 * @id: entry id to be translated
573 * This will scan the translation table trying to find the entry that matches
576 * @return short entry name if translation succeeds; error string on failure
578 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
580 const table_entry_t *entry;
582 entry = get_table_entry(table_info[category].table, id);
584 return unknown_msg(category);
585 return manual_reloc(entry->sname);
588 int genimg_get_cat_count(enum ih_category category)
590 return table_info[category].count;
593 const char *genimg_get_cat_desc(enum ih_category category)
595 return table_info[category].desc;
599 * genimg_cat_has_id - check whether category has entry id
600 * @category: category to look up (enum ih_category)
601 * @id: entry id to be checked
603 * This will scan the translation table trying to find the entry that matches
606 * @return true if category has entry id; false if not
608 bool genimg_cat_has_id(enum ih_category category, uint id)
610 if (get_table_entry(table_info[category].table, id))
617 * get_table_entry_name - translate entry id to long name
618 * @table: pointer to a translation table for entries of a specific type
619 * @msg: message to be returned when translation fails
620 * @id: entry id to be translated
622 * get_table_entry_name() will go over translation table trying to find
623 * entry that matches given id. If matching entry is found, its long
624 * name is returned to the caller.
627 * long entry name if translation succeeds
630 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
632 table = get_table_entry(table, id);
635 return manual_reloc(table->lname);
638 const char *genimg_get_os_name(uint8_t os)
640 return (get_table_entry_name(uimage_os, "Unknown OS", os));
643 const char *genimg_get_arch_name(uint8_t arch)
645 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
649 const char *genimg_get_type_name(uint8_t type)
651 return (get_table_entry_name(uimage_type, "Unknown Image", type));
654 const char *genimg_get_comp_name(uint8_t comp)
656 return (get_table_entry_name(uimage_comp, "Unknown Compression",
660 static const char *genimg_get_short_name(const table_entry_t *table, int val)
662 table = get_table_entry(table, val);
665 return manual_reloc(table->sname);
668 const char *genimg_get_type_short_name(uint8_t type)
670 return genimg_get_short_name(uimage_type, type);
673 const char *genimg_get_comp_short_name(uint8_t comp)
675 return genimg_get_short_name(uimage_comp, comp);
678 const char *genimg_get_os_short_name(uint8_t os)
680 return genimg_get_short_name(uimage_os, os);
683 const char *genimg_get_arch_short_name(uint8_t arch)
685 return genimg_get_short_name(uimage_arch, arch);
689 * get_table_entry_id - translate short entry name to id
690 * @table: pointer to a translation table for entries of a specific type
691 * @table_name: to be used in case of error
692 * @name: entry short name to be translated
694 * get_table_entry_id() will go over translation table trying to find
695 * entry that matches given short name. If matching entry is found,
696 * its id returned to the caller.
699 * entry id if translation succeeds
702 int get_table_entry_id(const table_entry_t *table,
703 const char *table_name, const char *name)
705 const table_entry_t *t;
707 for (t = table; t->id >= 0; ++t) {
708 if (t->sname && !strcasecmp(manual_reloc(t->sname), name))
711 debug("Invalid %s Type: %s\n", table_name, name);
716 int genimg_get_os_id(const char *name)
718 return (get_table_entry_id(uimage_os, "OS", name));
721 int genimg_get_arch_id(const char *name)
723 return (get_table_entry_id(uimage_arch, "CPU", name));
726 int genimg_get_type_id(const char *name)
728 return (get_table_entry_id(uimage_type, "Image", name));
731 int genimg_get_comp_id(const char *name)
733 return (get_table_entry_id(uimage_comp, "Compression", name));