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.
14 #include <u-boot/crc.h>
17 #ifdef CONFIG_SHOW_BOOT_PROGRESS
18 #include <status_led.h>
28 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
29 #include <linux/libfdt.h>
30 #include <fdt_support.h>
35 #include <u-boot/md5.h>
36 #include <u-boot/sha1.h>
37 #include <linux/errno.h>
41 #include <linux/lzo.h>
42 #include <lzma/LzmaTypes.h>
43 #include <lzma/LzmaDec.h>
44 #include <lzma/LzmaTools.h>
47 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
50 DECLARE_GLOBAL_DATA_PTR;
52 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
53 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
58 #include <u-boot/md5.h>
62 #ifndef __maybe_unused
63 # define __maybe_unused /* unimplemented */
65 #endif /* !USE_HOSTCC*/
67 #include <u-boot/crc.h>
70 #ifndef CONFIG_SYS_BARGSIZE
71 #define CONFIG_SYS_BARGSIZE 512
74 static const table_entry_t uimage_arch[] = {
75 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
76 { IH_ARCH_ALPHA, "alpha", "Alpha", },
77 { IH_ARCH_ARM, "arm", "ARM", },
78 { IH_ARCH_I386, "x86", "Intel x86", },
79 { IH_ARCH_IA64, "ia64", "IA64", },
80 { IH_ARCH_M68K, "m68k", "M68K", },
81 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
82 { IH_ARCH_MIPS, "mips", "MIPS", },
83 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
84 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
85 { IH_ARCH_PPC, "powerpc", "PowerPC", },
86 { IH_ARCH_PPC, "ppc", "PowerPC", },
87 { IH_ARCH_S390, "s390", "IBM S390", },
88 { IH_ARCH_SH, "sh", "SuperH", },
89 { IH_ARCH_SPARC, "sparc", "SPARC", },
90 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
91 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
92 { IH_ARCH_AVR32, "avr32", "AVR32", },
93 { IH_ARCH_NDS32, "nds32", "NDS32", },
94 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
95 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
96 { IH_ARCH_ARM64, "arm64", "AArch64", },
97 { IH_ARCH_ARC, "arc", "ARC", },
98 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
99 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
100 { IH_ARCH_RISCV, "riscv", "RISC-V", },
104 static const table_entry_t uimage_os[] = {
105 { IH_OS_INVALID, "invalid", "Invalid OS", },
106 { IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware" },
107 { IH_OS_LINUX, "linux", "Linux", },
108 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
109 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
111 { IH_OS_NETBSD, "netbsd", "NetBSD", },
112 { IH_OS_OSE, "ose", "Enea OSE", },
113 { IH_OS_PLAN9, "plan9", "Plan 9", },
114 { IH_OS_RTEMS, "rtems", "RTEMS", },
115 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
116 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
117 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
118 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
119 { IH_OS_QNX, "qnx", "QNX", },
121 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
122 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
125 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
126 { IH_OS_DELL, "dell", "Dell", },
127 { IH_OS_ESIX, "esix", "Esix", },
128 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
129 { IH_OS_IRIX, "irix", "Irix", },
130 { IH_OS_NCR, "ncr", "NCR", },
131 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
132 { IH_OS_PSOS, "psos", "pSOS", },
133 { IH_OS_SCO, "sco", "SCO", },
134 { IH_OS_SOLARIS, "solaris", "Solaris", },
135 { IH_OS_SVR4, "svr4", "SVR4", },
137 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
138 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
140 { IH_OS_OPENSBI, "opensbi", "RISC-V OpenSBI", },
141 { IH_OS_EFI, "efi", "EFI Firmware" },
146 static const table_entry_t uimage_type[] = {
147 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
148 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
149 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
150 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
151 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
152 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
153 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
154 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
155 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
156 { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
157 { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
158 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
159 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
160 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
161 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
162 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
163 { IH_TYPE_SCRIPT, "script", "Script", },
164 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
165 { IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
166 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
167 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
168 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
169 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
170 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
171 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
172 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
173 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
174 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
175 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
176 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
177 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
178 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
179 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
180 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
181 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
182 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
183 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
184 { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
185 { IH_TYPE_COPRO, "copro", "Coprocessor Image"},
189 static const table_entry_t uimage_comp[] = {
190 { IH_COMP_NONE, "none", "uncompressed", },
191 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
192 { IH_COMP_GZIP, "gzip", "gzip compressed", },
193 { IH_COMP_LZMA, "lzma", "lzma compressed", },
194 { IH_COMP_LZO, "lzo", "lzo compressed", },
195 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
202 const table_entry_t *table;
205 static const struct table_info table_info[IH_COUNT] = {
206 { "architecture", IH_ARCH_COUNT, uimage_arch },
207 { "compression", IH_COMP_COUNT, uimage_comp },
208 { "operating system", IH_OS_COUNT, uimage_os },
209 { "image type", IH_TYPE_COUNT, uimage_type },
212 /*****************************************************************************/
213 /* Legacy format routines */
214 /*****************************************************************************/
215 int image_check_hcrc(const image_header_t *hdr)
218 ulong len = image_get_header_size();
219 image_header_t header;
221 /* Copy header so we can blank CRC field for re-calculation */
222 memmove(&header, (char *)hdr, image_get_header_size());
223 image_set_hcrc(&header, 0);
225 hcrc = crc32(0, (unsigned char *)&header, len);
227 return (hcrc == image_get_hcrc(hdr));
230 int image_check_dcrc(const image_header_t *hdr)
232 ulong data = image_get_data(hdr);
233 ulong len = image_get_data_size(hdr);
234 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
236 return (dcrc == image_get_dcrc(hdr));
240 * image_multi_count - get component (sub-image) count
241 * @hdr: pointer to the header of the multi component image
243 * image_multi_count() returns number of components in a multi
246 * Note: no checking of the image type is done, caller must pass
247 * a valid multi component image.
250 * number of components
252 ulong image_multi_count(const image_header_t *hdr)
257 /* get start of the image payload, which in case of multi
258 * component images that points to a table of component sizes */
259 size = (uint32_t *)image_get_data(hdr);
261 /* count non empty slots */
262 for (i = 0; size[i]; ++i)
269 * image_multi_getimg - get component data address and size
270 * @hdr: pointer to the header of the multi component image
271 * @idx: index of the requested component
272 * @data: pointer to a ulong variable, will hold component data address
273 * @len: pointer to a ulong variable, will hold component size
275 * image_multi_getimg() returns size and data address for the requested
276 * component in a multi component image.
278 * Note: no checking of the image type is done, caller must pass
279 * a valid multi component image.
282 * data address and size of the component, if idx is valid
283 * 0 in data and len, if idx is out of range
285 void image_multi_getimg(const image_header_t *hdr, ulong idx,
286 ulong *data, ulong *len)
290 ulong offset, count, img_data;
292 /* get number of component */
293 count = image_multi_count(hdr);
295 /* get start of the image payload, which in case of multi
296 * component images that points to a table of component sizes */
297 size = (uint32_t *)image_get_data(hdr);
299 /* get address of the proper component data start, which means
300 * skipping sizes table (add 1 for last, null entry) */
301 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
304 *len = uimage_to_cpu(size[idx]);
307 /* go over all indices preceding requested component idx */
308 for (i = 0; i < idx; i++) {
309 /* add up i-th component size, rounding up to 4 bytes */
310 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
313 /* calculate idx-th component data address */
314 *data = img_data + offset;
321 static void image_print_type(const image_header_t *hdr)
323 const char __maybe_unused *os, *arch, *type, *comp;
325 os = genimg_get_os_name(image_get_os(hdr));
326 arch = genimg_get_arch_name(image_get_arch(hdr));
327 type = genimg_get_type_name(image_get_type(hdr));
328 comp = genimg_get_comp_name(image_get_comp(hdr));
330 printf("%s %s %s (%s)\n", arch, os, type, comp);
334 * image_print_contents - prints out the contents of the legacy format image
335 * @ptr: pointer to the legacy format image header
336 * @p: pointer to prefix string
338 * image_print_contents() formats a multi line legacy image contents description.
339 * The routine prints out all header fields followed by the size/offset data
340 * for MULTI/SCRIPT images.
343 * no returned results
345 void image_print_contents(const void *ptr)
347 const image_header_t *hdr = (const image_header_t *)ptr;
348 const char __maybe_unused *p;
350 p = IMAGE_INDENT_STRING;
351 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
352 if (IMAGE_ENABLE_TIMESTAMP) {
353 printf("%sCreated: ", p);
354 genimg_print_time((time_t)image_get_time(hdr));
356 printf("%sImage Type: ", p);
357 image_print_type(hdr);
358 printf("%sData Size: ", p);
359 genimg_print_size(image_get_data_size(hdr));
360 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
361 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
363 if (image_check_type(hdr, IH_TYPE_MULTI) ||
364 image_check_type(hdr, IH_TYPE_SCRIPT)) {
367 ulong count = image_multi_count(hdr);
369 printf("%sContents:\n", p);
370 for (i = 0; i < count; i++) {
371 image_multi_getimg(hdr, i, &data, &len);
373 printf("%s Image %d: ", p, i);
374 genimg_print_size(len);
376 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
378 * the user may need to know offsets
379 * if planning to do something with
382 printf("%s Offset = 0x%08lx\n", p, data);
385 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
386 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
387 image_get_load(hdr) - image_get_header_size(),
388 (int)(image_get_size(hdr) + image_get_header_size()
389 + sizeof(flash_header_v2_t) - 0x2060));
394 * print_decomp_msg() - Print a suitable decompression/loading message
396 * @type: OS type (IH_OS_...)
397 * @comp_type: Compression type being used (IH_COMP_...)
398 * @is_xip: true if the load address matches the image start
400 static void print_decomp_msg(int comp_type, int type, bool is_xip)
402 const char *name = genimg_get_type_name(type);
404 if (comp_type == IH_COMP_NONE)
405 printf(" %s %s\n", is_xip ? "XIP" : "Loading", name);
407 printf(" Uncompressing %s\n", name);
410 int image_decomp(int comp, ulong load, ulong image_start, int type,
411 void *load_buf, void *image_buf, ulong image_len,
412 uint unc_len, ulong *load_end)
417 print_decomp_msg(comp, type, load == image_start);
420 * Load the image to the right place, decompressing if needed. After
421 * this, image_len will be set to the number of uncompressed bytes
422 * loaded, ret will be non-zero on error.
426 if (load == image_start)
428 if (image_len <= unc_len)
429 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
435 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
438 #endif /* CONFIG_GZIP */
440 case IH_COMP_BZIP2: {
444 * If we've got less than 4 MB of malloc() space,
445 * use slower decompression algorithm which requires
446 * at most 2300 KB of memory.
448 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
449 image_buf, image_len,
450 CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
454 #endif /* CONFIG_BZIP2 */
457 SizeT lzma_len = unc_len;
459 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
460 image_buf, image_len);
461 image_len = lzma_len;
464 #endif /* CONFIG_LZMA */
467 size_t size = unc_len;
469 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
473 #endif /* CONFIG_LZO */
476 size_t size = unc_len;
478 ret = ulz4fn(image_buf, image_len, load_buf, &size);
482 #endif /* CONFIG_LZ4 */
484 printf("Unimplemented compression type %d\n", comp);
488 *load_end = load + image_len;
495 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
497 * image_get_ramdisk - get and verify ramdisk image
498 * @rd_addr: ramdisk image start address
499 * @arch: expected ramdisk architecture
500 * @verify: checksum verification flag
502 * image_get_ramdisk() returns a pointer to the verified ramdisk image
503 * header. Routine receives image start address and expected architecture
504 * flag. Verification done covers data and header integrity and os/type/arch
508 * pointer to a ramdisk image header, if image was found and valid
509 * otherwise, return NULL
511 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
514 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
516 if (!image_check_magic(rd_hdr)) {
517 puts("Bad Magic Number\n");
518 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
522 if (!image_check_hcrc(rd_hdr)) {
523 puts("Bad Header Checksum\n");
524 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
528 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
529 image_print_contents(rd_hdr);
532 puts(" Verifying Checksum ... ");
533 if (!image_check_dcrc(rd_hdr)) {
534 puts("Bad Data CRC\n");
535 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
541 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
543 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
544 !image_check_arch(rd_hdr, arch) ||
545 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
546 printf("No Linux %s Ramdisk Image\n",
547 genimg_get_arch_name(arch));
548 bootstage_error(BOOTSTAGE_ID_RAMDISK);
555 #endif /* !USE_HOSTCC */
557 /*****************************************************************************/
558 /* Shared dual-format routines */
559 /*****************************************************************************/
561 ulong image_load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
562 ulong image_save_addr; /* Default Save Address */
563 ulong image_save_size; /* Default Save Size (in bytes) */
565 static int on_loadaddr(const char *name, const char *value, enum env_op op,
570 case env_op_overwrite:
571 image_load_addr = simple_strtoul(value, NULL, 16);
579 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
581 ulong env_get_bootm_low(void)
583 char *s = env_get("bootm_low");
585 ulong tmp = simple_strtoul(s, NULL, 16);
589 #if defined(CONFIG_SYS_SDRAM_BASE)
590 return CONFIG_SYS_SDRAM_BASE;
591 #elif defined(CONFIG_ARM) || defined(CONFIG_MICROBLAZE)
592 return gd->bd->bi_dram[0].start;
598 phys_size_t env_get_bootm_size(void)
600 phys_size_t tmp, size;
602 char *s = env_get("bootm_size");
604 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
608 #if (defined(CONFIG_ARM) || defined(CONFIG_MICROBLAZE)) && \
609 defined(CONFIG_NR_DRAM_BANKS)
610 start = gd->bd->bi_dram[0].start;
611 size = gd->bd->bi_dram[0].size;
613 start = gd->bd->bi_memstart;
614 size = gd->bd->bi_memsize;
617 s = env_get("bootm_low");
619 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
623 return size - (tmp - start);
626 phys_size_t env_get_bootm_mapsize(void)
629 char *s = env_get("bootm_mapsize");
631 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
635 #if defined(CONFIG_SYS_BOOTMAPSZ)
636 return CONFIG_SYS_BOOTMAPSZ;
638 return env_get_bootm_size();
642 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
647 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
653 size_t tail = (len > chunksz) ? chunksz : len;
659 memmove(to, from, tail);
666 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
667 memmove(to, from, len);
668 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
670 #else /* USE_HOSTCC */
671 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
673 memmove(to, from, len);
675 #endif /* !USE_HOSTCC */
677 void genimg_print_size(uint32_t size)
680 printf("%d Bytes = ", size);
681 print_size(size, "\n");
683 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
684 size, (double)size / 1.024e3,
685 (double)size / 1.048576e6);
689 #if IMAGE_ENABLE_TIMESTAMP
690 void genimg_print_time(time_t timestamp)
695 rtc_to_tm(timestamp, &tm);
696 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
697 tm.tm_year, tm.tm_mon, tm.tm_mday,
698 tm.tm_hour, tm.tm_min, tm.tm_sec);
700 printf("%s", ctime(×tamp));
705 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
707 for (; table->id >= 0; ++table) {
714 static const char *unknown_msg(enum ih_category category)
716 static const char unknown_str[] = "Unknown ";
719 strcpy(msg, unknown_str);
720 strncat(msg, table_info[category].desc,
721 sizeof(msg) - sizeof(unknown_str));
727 * get_cat_table_entry_name - translate entry id to long name
728 * @category: category to look up (enum ih_category)
729 * @id: entry id to be translated
731 * This will scan the translation table trying to find the entry that matches
734 * @retur long entry name if translation succeeds; error string on failure
736 const char *genimg_get_cat_name(enum ih_category category, uint id)
738 const table_entry_t *entry;
740 entry = get_table_entry(table_info[category].table, id);
742 return unknown_msg(category);
743 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
746 return entry->lname + gd->reloc_off;
751 * get_cat_table_entry_short_name - translate entry id to short name
752 * @category: category to look up (enum ih_category)
753 * @id: entry id to be translated
755 * This will scan the translation table trying to find the entry that matches
758 * @retur short entry name if translation succeeds; error string on failure
760 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
762 const table_entry_t *entry;
764 entry = get_table_entry(table_info[category].table, id);
766 return unknown_msg(category);
767 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
770 return entry->sname + gd->reloc_off;
774 int genimg_get_cat_count(enum ih_category category)
776 return table_info[category].count;
779 const char *genimg_get_cat_desc(enum ih_category category)
781 return table_info[category].desc;
785 * get_table_entry_name - translate entry id to long name
786 * @table: pointer to a translation table for entries of a specific type
787 * @msg: message to be returned when translation fails
788 * @id: entry id to be translated
790 * get_table_entry_name() will go over translation table trying to find
791 * entry that matches given id. If matching entry is found, its long
792 * name is returned to the caller.
795 * long entry name if translation succeeds
798 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
800 table = get_table_entry(table, id);
803 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
806 return table->lname + gd->reloc_off;
810 const char *genimg_get_os_name(uint8_t os)
812 return (get_table_entry_name(uimage_os, "Unknown OS", os));
815 const char *genimg_get_arch_name(uint8_t arch)
817 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
821 const char *genimg_get_type_name(uint8_t type)
823 return (get_table_entry_name(uimage_type, "Unknown Image", type));
826 static const char *genimg_get_short_name(const table_entry_t *table, int val)
828 table = get_table_entry(table, val);
831 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
834 return table->sname + gd->reloc_off;
838 const char *genimg_get_type_short_name(uint8_t type)
840 return genimg_get_short_name(uimage_type, type);
843 const char *genimg_get_comp_name(uint8_t comp)
845 return (get_table_entry_name(uimage_comp, "Unknown Compression",
849 const char *genimg_get_comp_short_name(uint8_t comp)
851 return genimg_get_short_name(uimage_comp, comp);
854 const char *genimg_get_os_short_name(uint8_t os)
856 return genimg_get_short_name(uimage_os, os);
859 const char *genimg_get_arch_short_name(uint8_t arch)
861 return genimg_get_short_name(uimage_arch, arch);
865 * get_table_entry_id - translate short entry name to id
866 * @table: pointer to a translation table for entries of a specific type
867 * @table_name: to be used in case of error
868 * @name: entry short name to be translated
870 * get_table_entry_id() will go over translation table trying to find
871 * entry that matches given short name. If matching entry is found,
872 * its id returned to the caller.
875 * entry id if translation succeeds
878 int get_table_entry_id(const table_entry_t *table,
879 const char *table_name, const char *name)
881 const table_entry_t *t;
883 for (t = table; t->id >= 0; ++t) {
884 #ifdef CONFIG_NEEDS_MANUAL_RELOC
885 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
887 if (t->sname && strcasecmp(t->sname, name) == 0)
891 debug("Invalid %s Type: %s\n", table_name, name);
896 int genimg_get_os_id(const char *name)
898 return (get_table_entry_id(uimage_os, "OS", name));
901 int genimg_get_arch_id(const char *name)
903 return (get_table_entry_id(uimage_arch, "CPU", name));
906 int genimg_get_type_id(const char *name)
908 return (get_table_entry_id(uimage_type, "Image", name));
911 int genimg_get_comp_id(const char *name)
913 return (get_table_entry_id(uimage_comp, "Compression", name));
918 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
920 * @img_addr: a string might contain real image address
921 * @fit_uname_config: double pointer to a char, will hold pointer to a
922 * configuration unit name
923 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
926 * genimg_get_kernel_addr_fit get the real kernel start address from a string
927 * which is normally the first argv of bootm/bootz
930 * kernel start address
932 ulong genimg_get_kernel_addr_fit(char * const img_addr,
933 const char **fit_uname_config,
934 const char **fit_uname_kernel)
938 /* find out kernel image address */
940 kernel_addr = image_load_addr;
941 debug("* kernel: default image load address = 0x%08lx\n",
943 #if CONFIG_IS_ENABLED(FIT)
944 } else if (fit_parse_conf(img_addr, image_load_addr, &kernel_addr,
946 debug("* kernel: config '%s' from image at 0x%08lx\n",
947 *fit_uname_config, kernel_addr);
948 } else if (fit_parse_subimage(img_addr, image_load_addr, &kernel_addr,
950 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
951 *fit_uname_kernel, kernel_addr);
954 kernel_addr = simple_strtoul(img_addr, NULL, 16);
955 debug("* kernel: cmdline image address = 0x%08lx\n",
963 * genimg_get_kernel_addr() is the simple version of
964 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
966 ulong genimg_get_kernel_addr(char * const img_addr)
968 const char *fit_uname_config = NULL;
969 const char *fit_uname_kernel = NULL;
971 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
976 * genimg_get_format - get image format type
977 * @img_addr: image start address
979 * genimg_get_format() checks whether provided address points to a valid
980 * legacy or FIT image.
982 * New uImage format and FDT blob are based on a libfdt. FDT blob
983 * may be passed directly or embedded in a FIT image. In both situations
984 * genimg_get_format() must be able to dectect libfdt header.
987 * image format type or IMAGE_FORMAT_INVALID if no image is present
989 int genimg_get_format(const void *img_addr)
991 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
992 const image_header_t *hdr;
994 hdr = (const image_header_t *)img_addr;
995 if (image_check_magic(hdr))
996 return IMAGE_FORMAT_LEGACY;
998 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
999 if (fdt_check_header(img_addr) == 0)
1000 return IMAGE_FORMAT_FIT;
1002 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1003 if (android_image_check_header(img_addr) == 0)
1004 return IMAGE_FORMAT_ANDROID;
1007 return IMAGE_FORMAT_INVALID;
1011 * fit_has_config - check if there is a valid FIT configuration
1012 * @images: pointer to the bootm command headers structure
1014 * fit_has_config() checks if there is a FIT configuration in use
1015 * (if FTI support is present).
1018 * 0, no FIT support or no configuration found
1019 * 1, configuration found
1021 int genimg_has_config(bootm_headers_t *images)
1023 #if IMAGE_ENABLE_FIT
1024 if (images->fit_uname_cfg)
1031 * boot_get_ramdisk - main ramdisk handling routine
1032 * @argc: command argument count
1033 * @argv: command argument list
1034 * @images: pointer to the bootm images structure
1035 * @arch: expected ramdisk architecture
1036 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
1037 * @rd_end: pointer to a ulong variable, will hold ramdisk end
1039 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
1040 * Curently supported are the following ramdisk sources:
1041 * - multicomponent kernel/ramdisk image,
1042 * - commandline provided address of decicated ramdisk image.
1045 * 0, if ramdisk image was found and valid, or skiped
1046 * rd_start and rd_end are set to ramdisk start/end addresses if
1047 * ramdisk image is found and valid
1049 * 1, if ramdisk image is found but corrupted, or invalid
1050 * rd_start and rd_end are set to 0 if no ramdisk exists
1052 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1053 uint8_t arch, ulong *rd_start, ulong *rd_end)
1055 ulong rd_addr, rd_load;
1056 ulong rd_data, rd_len;
1057 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1058 const image_header_t *rd_hdr;
1061 #ifdef CONFIG_SUPPORT_RAW_INITRD
1064 #if IMAGE_ENABLE_FIT
1065 const char *fit_uname_config = images->fit_uname_cfg;
1066 const char *fit_uname_ramdisk = NULL;
1070 const char *select = NULL;
1075 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1077 * Look for an Android boot image.
1079 buf = map_sysmem(images->os.start, 0);
1080 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1081 select = (argc == 0) ? env_get("loadaddr") : argv[0];
1088 * Look for a '-' which indicates to ignore the
1091 if (select && strcmp(select, "-") == 0) {
1092 debug("## Skipping init Ramdisk\n");
1093 rd_len = rd_data = 0;
1094 } else if (select || genimg_has_config(images)) {
1095 #if IMAGE_ENABLE_FIT
1098 * If the init ramdisk comes from the FIT image and
1099 * the FIT image address is omitted in the command
1100 * line argument, try to use os FIT image address or
1101 * default load address.
1103 if (images->fit_uname_os)
1104 default_addr = (ulong)images->fit_hdr_os;
1106 default_addr = image_load_addr;
1108 if (fit_parse_conf(select, default_addr,
1109 &rd_addr, &fit_uname_config)) {
1110 debug("* ramdisk: config '%s' from image at "
1112 fit_uname_config, rd_addr);
1113 } else if (fit_parse_subimage(select, default_addr,
1114 &rd_addr, &fit_uname_ramdisk)) {
1115 debug("* ramdisk: subimage '%s' from image at "
1117 fit_uname_ramdisk, rd_addr);
1121 rd_addr = simple_strtoul(select, NULL, 16);
1122 debug("* ramdisk: cmdline image address = "
1126 #if IMAGE_ENABLE_FIT
1128 /* use FIT configuration provided in first bootm
1129 * command argument. If the property is not defined,
1132 rd_addr = map_to_sysmem(images->fit_hdr_os);
1133 rd_noffset = fit_get_node_from_config(images,
1134 FIT_RAMDISK_PROP, rd_addr);
1135 if (rd_noffset == -ENOENT)
1137 else if (rd_noffset < 0)
1143 * Check if there is an initrd image at the
1144 * address provided in the second bootm argument
1145 * check image type, for FIT images get FIT node.
1147 buf = map_sysmem(rd_addr, 0);
1148 switch (genimg_get_format(buf)) {
1149 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1150 case IMAGE_FORMAT_LEGACY:
1151 printf("## Loading init Ramdisk from Legacy "
1152 "Image at %08lx ...\n", rd_addr);
1154 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1155 rd_hdr = image_get_ramdisk(rd_addr, arch,
1161 rd_data = image_get_data(rd_hdr);
1162 rd_len = image_get_data_size(rd_hdr);
1163 rd_load = image_get_load(rd_hdr);
1166 #if IMAGE_ENABLE_FIT
1167 case IMAGE_FORMAT_FIT:
1168 rd_noffset = fit_image_load(images,
1169 rd_addr, &fit_uname_ramdisk,
1170 &fit_uname_config, arch,
1172 BOOTSTAGE_ID_FIT_RD_START,
1173 FIT_LOAD_OPTIONAL_NON_ZERO,
1178 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1179 images->fit_uname_rd = fit_uname_ramdisk;
1180 images->fit_noffset_rd = rd_noffset;
1183 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1184 case IMAGE_FORMAT_ANDROID:
1185 android_image_get_ramdisk((void *)images->os.start,
1190 #ifdef CONFIG_SUPPORT_RAW_INITRD
1193 end = strchr(select, ':');
1195 rd_len = simple_strtoul(++end, NULL, 16);
1200 puts("Wrong Ramdisk Image Format\n");
1201 rd_data = rd_len = rd_load = 0;
1205 } else if (images->legacy_hdr_valid &&
1206 image_check_type(&images->legacy_hdr_os_copy,
1210 * Now check if we have a legacy mult-component image,
1211 * get second entry data start address and len.
1213 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1214 printf("## Loading init Ramdisk from multi component "
1215 "Legacy Image at %08lx ...\n",
1216 (ulong)images->legacy_hdr_os);
1218 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1223 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1224 rd_len = rd_data = 0;
1228 debug("## No init Ramdisk\n");
1230 *rd_start = rd_data;
1231 *rd_end = rd_data + rd_len;
1233 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1234 *rd_start, *rd_end);
1239 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1241 * boot_ramdisk_high - relocate init ramdisk
1242 * @lmb: pointer to lmb handle, will be used for memory mgmt
1243 * @rd_data: ramdisk data start address
1244 * @rd_len: ramdisk data length
1245 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1246 * start address (after possible relocation)
1247 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1248 * end address (after possible relocation)
1250 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1251 * variable and if requested ramdisk data is moved to a specified location.
1253 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1254 * start/end addresses if ramdisk image start and len were provided,
1255 * otherwise set initrd_start and initrd_end set to zeros.
1261 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1262 ulong *initrd_start, ulong *initrd_end)
1266 int initrd_copy_to_ram = 1;
1268 s = env_get("initrd_high");
1270 /* a value of "no" or a similar string will act like 0,
1271 * turning the "load high" feature off. This is intentional.
1273 initrd_high = simple_strtoul(s, NULL, 16);
1274 if (initrd_high == ~0)
1275 initrd_copy_to_ram = 0;
1277 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1281 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1282 initrd_high, initrd_copy_to_ram);
1285 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1286 debug(" in-place initrd\n");
1287 *initrd_start = rd_data;
1288 *initrd_end = rd_data + rd_len;
1289 lmb_reserve(lmb, rd_data, rd_len);
1292 *initrd_start = (ulong)lmb_alloc_base(lmb,
1293 rd_len, 0x1000, initrd_high);
1295 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1298 if (*initrd_start == 0) {
1299 puts("ramdisk - allocation error\n");
1302 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1304 *initrd_end = *initrd_start + rd_len;
1305 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1306 *initrd_start, *initrd_end);
1308 memmove_wd((void *)*initrd_start,
1309 (void *)rd_data, rd_len, CHUNKSZ);
1313 * Ensure the image is flushed to memory to handle
1314 * AMP boot scenarios in which we might not be
1317 flush_cache((unsigned long)*initrd_start,
1318 ALIGN(rd_len, ARCH_DMA_MINALIGN));
1326 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1327 *initrd_start, *initrd_end);
1334 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1336 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1337 ulong *setup_start, ulong *setup_len)
1339 #if IMAGE_ENABLE_FIT
1340 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1346 #if IMAGE_ENABLE_FIT
1347 #if defined(CONFIG_FPGA)
1348 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1349 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1351 ulong tmp_img_addr, img_data, img_len;
1355 const char *uname, *name;
1357 int devnum = 0; /* TODO support multi fpga platforms */
1359 /* Check to see if the images struct has a FIT configuration */
1360 if (!genimg_has_config(images)) {
1361 debug("## FIT configuration was not specified\n");
1366 * Obtain the os FIT header from the images struct
1368 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1369 buf = map_sysmem(tmp_img_addr, 0);
1371 * Check image type. For FIT images get FIT node
1372 * and attempt to locate a generic binary.
1374 switch (genimg_get_format(buf)) {
1375 case IMAGE_FORMAT_FIT:
1376 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1378 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1381 debug("## FPGA image is not specified\n");
1384 fit_img_result = fit_image_load(images,
1386 (const char **)&uname,
1387 &(images->fit_uname_cfg),
1390 BOOTSTAGE_ID_FPGA_INIT,
1391 FIT_LOAD_OPTIONAL_NON_ZERO,
1392 &img_data, &img_len);
1394 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1395 uname, img_data, img_len);
1397 if (fit_img_result < 0) {
1398 /* Something went wrong! */
1399 return fit_img_result;
1402 if (!fpga_is_partial_data(devnum, img_len)) {
1404 err = fpga_loadbitstream(devnum, (char *)img_data,
1407 err = fpga_load(devnum, (const void *)img_data,
1411 err = fpga_loadbitstream(devnum, (char *)img_data,
1412 img_len, BIT_PARTIAL);
1414 err = fpga_load(devnum, (const void *)img_data,
1415 img_len, BIT_PARTIAL);
1421 printf(" Programming %s bitstream... OK\n", name);
1424 printf("The given image format is not supported (corrupt?)\n");
1432 static void fit_loadable_process(uint8_t img_type,
1437 const unsigned int count =
1438 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1439 struct fit_loadable_tbl *fit_loadable_handler =
1440 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1441 /* For each loadable handler */
1442 for (i = 0; i < count; i++, fit_loadable_handler++)
1443 /* matching this type */
1444 if (fit_loadable_handler->type == img_type)
1445 /* call that handler with this image data */
1446 fit_loadable_handler->handler(img_data, img_len);
1449 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1450 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1453 * These variables are used to hold the current image location
1458 * These two variables are requirements for fit_image_load, but
1459 * their values are not used
1461 ulong img_data, img_len;
1463 int loadables_index;
1469 /* Check to see if the images struct has a FIT configuration */
1470 if (!genimg_has_config(images)) {
1471 debug("## FIT configuration was not specified\n");
1476 * Obtain the os FIT header from the images struct
1478 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1479 buf = map_sysmem(tmp_img_addr, 0);
1481 * Check image type. For FIT images get FIT node
1482 * and attempt to locate a generic binary.
1484 switch (genimg_get_format(buf)) {
1485 case IMAGE_FORMAT_FIT:
1486 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1488 for (loadables_index = 0;
1489 uname = fdt_stringlist_get(buf, conf_noffset,
1490 FIT_LOADABLE_PROP, loadables_index,
1494 fit_img_result = fit_image_load(images,
1497 &(images->fit_uname_cfg), arch,
1499 BOOTSTAGE_ID_FIT_LOADABLE_START,
1500 FIT_LOAD_OPTIONAL_NON_ZERO,
1501 &img_data, &img_len);
1502 if (fit_img_result < 0) {
1503 /* Something went wrong! */
1504 return fit_img_result;
1507 fit_img_result = fit_image_get_node(buf, uname);
1508 if (fit_img_result < 0) {
1509 /* Something went wrong! */
1510 return fit_img_result;
1512 fit_img_result = fit_image_get_type(buf,
1515 if (fit_img_result < 0) {
1516 /* Something went wrong! */
1517 return fit_img_result;
1520 fit_loadable_process(img_type, img_data, img_len);
1524 printf("The given image format is not supported (corrupt?)\n");
1532 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1534 * boot_get_cmdline - allocate and initialize kernel cmdline
1535 * @lmb: pointer to lmb handle, will be used for memory mgmt
1536 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1537 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1539 * boot_get_cmdline() allocates space for kernel command line below
1540 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environment
1541 * variable is present its contents is copied to allocated kernel
1548 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1553 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1554 env_get_bootm_mapsize() + env_get_bootm_low());
1556 if (cmdline == NULL)
1559 s = env_get("bootargs");
1565 *cmd_start = (ulong) & cmdline[0];
1566 *cmd_end = *cmd_start + strlen(cmdline);
1568 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1572 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1574 #ifdef CONFIG_SYS_BOOT_GET_KBD
1576 * boot_get_kbd - allocate and initialize kernel copy of board info
1577 * @lmb: pointer to lmb handle, will be used for memory mgmt
1578 * @kbd: double pointer to board info data
1580 * boot_get_kbd() allocates space for kernel copy of board info data below
1581 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1582 * with the current u-boot board info data.
1588 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1590 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1591 env_get_bootm_mapsize() + env_get_bootm_low());
1597 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1599 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1600 do_bdinfo(NULL, 0, 0, NULL);
1605 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1608 int image_setup_linux(bootm_headers_t *images)
1610 ulong of_size = images->ft_len;
1611 char **of_flat_tree = &images->ft_addr;
1612 struct lmb *lmb = &images->lmb;
1615 if (IMAGE_ENABLE_OF_LIBFDT)
1616 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1618 if (IMAGE_BOOT_GET_CMDLINE) {
1619 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1620 &images->cmdline_end);
1622 puts("ERROR with allocation of cmdline\n");
1627 if (IMAGE_ENABLE_OF_LIBFDT) {
1628 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1633 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1634 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1641 #endif /* CONFIG_LMB */
1642 #endif /* !USE_HOSTCC */