1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2008 Semihalf
5 * (C) Copyright 2000-2006
13 #ifdef CONFIG_SHOW_BOOT_PROGRESS
14 #include <status_led.h>
19 #include <environment.h>
23 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
24 #include <linux/libfdt.h>
25 #include <fdt_support.h>
30 #include <u-boot/md5.h>
31 #include <u-boot/sha1.h>
32 #include <linux/errno.h>
36 #include <linux/lzo.h>
37 #include <lzma/LzmaTypes.h>
38 #include <lzma/LzmaDec.h>
39 #include <lzma/LzmaTools.h>
42 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
45 DECLARE_GLOBAL_DATA_PTR;
47 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
48 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
53 #include <u-boot/md5.h>
57 #ifndef __maybe_unused
58 # define __maybe_unused /* unimplemented */
60 #endif /* !USE_HOSTCC*/
62 #include <u-boot/crc.h>
64 #ifndef CONFIG_SYS_BARGSIZE
65 #define CONFIG_SYS_BARGSIZE 512
68 static const table_entry_t uimage_arch[] = {
69 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
70 { IH_ARCH_ALPHA, "alpha", "Alpha", },
71 { IH_ARCH_ARM, "arm", "ARM", },
72 { IH_ARCH_I386, "x86", "Intel x86", },
73 { IH_ARCH_IA64, "ia64", "IA64", },
74 { IH_ARCH_M68K, "m68k", "M68K", },
75 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
76 { IH_ARCH_MIPS, "mips", "MIPS", },
77 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
78 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
79 { IH_ARCH_PPC, "powerpc", "PowerPC", },
80 { IH_ARCH_PPC, "ppc", "PowerPC", },
81 { IH_ARCH_S390, "s390", "IBM S390", },
82 { IH_ARCH_SH, "sh", "SuperH", },
83 { IH_ARCH_SPARC, "sparc", "SPARC", },
84 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
85 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
86 { IH_ARCH_AVR32, "avr32", "AVR32", },
87 { IH_ARCH_NDS32, "nds32", "NDS32", },
88 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
89 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
90 { IH_ARCH_ARM64, "arm64", "AArch64", },
91 { IH_ARCH_ARC, "arc", "ARC", },
92 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
93 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
94 { IH_ARCH_RISCV, "riscv", "RISC-V", },
98 static const table_entry_t uimage_os[] = {
99 { IH_OS_INVALID, "invalid", "Invalid OS", },
100 { IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware" },
101 { IH_OS_LINUX, "linux", "Linux", },
102 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
103 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
105 { IH_OS_NETBSD, "netbsd", "NetBSD", },
106 { IH_OS_OSE, "ose", "Enea OSE", },
107 { IH_OS_PLAN9, "plan9", "Plan 9", },
108 { IH_OS_RTEMS, "rtems", "RTEMS", },
109 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
110 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
111 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
112 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
113 { IH_OS_QNX, "qnx", "QNX", },
115 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
116 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
119 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
120 { IH_OS_DELL, "dell", "Dell", },
121 { IH_OS_ESIX, "esix", "Esix", },
122 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
123 { IH_OS_IRIX, "irix", "Irix", },
124 { IH_OS_NCR, "ncr", "NCR", },
125 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
126 { IH_OS_PSOS, "psos", "pSOS", },
127 { IH_OS_SCO, "sco", "SCO", },
128 { IH_OS_SOLARIS, "solaris", "Solaris", },
129 { IH_OS_SVR4, "svr4", "SVR4", },
131 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
132 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
138 static const table_entry_t uimage_type[] = {
139 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
140 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
141 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
142 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
143 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
144 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
145 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
146 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
147 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
148 { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
149 { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
150 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
151 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
152 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
153 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
154 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
155 { IH_TYPE_SCRIPT, "script", "Script", },
156 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
157 { IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
158 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
159 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
160 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
161 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
162 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
163 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
164 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
165 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
166 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
167 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
168 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
169 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
170 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
171 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
172 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
173 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
174 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
175 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
176 { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
180 static const table_entry_t uimage_comp[] = {
181 { IH_COMP_NONE, "none", "uncompressed", },
182 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
183 { IH_COMP_GZIP, "gzip", "gzip compressed", },
184 { IH_COMP_LZMA, "lzma", "lzma compressed", },
185 { IH_COMP_LZO, "lzo", "lzo compressed", },
186 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
193 const table_entry_t *table;
196 static const struct table_info table_info[IH_COUNT] = {
197 { "architecture", IH_ARCH_COUNT, uimage_arch },
198 { "compression", IH_COMP_COUNT, uimage_comp },
199 { "operating system", IH_OS_COUNT, uimage_os },
200 { "image type", IH_TYPE_COUNT, uimage_type },
203 /*****************************************************************************/
204 /* Legacy format routines */
205 /*****************************************************************************/
206 int image_check_hcrc(const image_header_t *hdr)
209 ulong len = image_get_header_size();
210 image_header_t header;
212 /* Copy header so we can blank CRC field for re-calculation */
213 memmove(&header, (char *)hdr, image_get_header_size());
214 image_set_hcrc(&header, 0);
216 hcrc = crc32(0, (unsigned char *)&header, len);
218 return (hcrc == image_get_hcrc(hdr));
221 int image_check_dcrc(const image_header_t *hdr)
223 ulong data = image_get_data(hdr);
224 ulong len = image_get_data_size(hdr);
225 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
227 return (dcrc == image_get_dcrc(hdr));
231 * image_multi_count - get component (sub-image) count
232 * @hdr: pointer to the header of the multi component image
234 * image_multi_count() returns number of components in a multi
237 * Note: no checking of the image type is done, caller must pass
238 * a valid multi component image.
241 * number of components
243 ulong image_multi_count(const image_header_t *hdr)
248 /* get start of the image payload, which in case of multi
249 * component images that points to a table of component sizes */
250 size = (uint32_t *)image_get_data(hdr);
252 /* count non empty slots */
253 for (i = 0; size[i]; ++i)
260 * image_multi_getimg - get component data address and size
261 * @hdr: pointer to the header of the multi component image
262 * @idx: index of the requested component
263 * @data: pointer to a ulong variable, will hold component data address
264 * @len: pointer to a ulong variable, will hold component size
266 * image_multi_getimg() returns size and data address for the requested
267 * component in a multi component image.
269 * Note: no checking of the image type is done, caller must pass
270 * a valid multi component image.
273 * data address and size of the component, if idx is valid
274 * 0 in data and len, if idx is out of range
276 void image_multi_getimg(const image_header_t *hdr, ulong idx,
277 ulong *data, ulong *len)
281 ulong offset, count, img_data;
283 /* get number of component */
284 count = image_multi_count(hdr);
286 /* get start of the image payload, which in case of multi
287 * component images that points to a table of component sizes */
288 size = (uint32_t *)image_get_data(hdr);
290 /* get address of the proper component data start, which means
291 * skipping sizes table (add 1 for last, null entry) */
292 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
295 *len = uimage_to_cpu(size[idx]);
298 /* go over all indices preceding requested component idx */
299 for (i = 0; i < idx; i++) {
300 /* add up i-th component size, rounding up to 4 bytes */
301 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
304 /* calculate idx-th component data address */
305 *data = img_data + offset;
312 static void image_print_type(const image_header_t *hdr)
314 const char __maybe_unused *os, *arch, *type, *comp;
316 os = genimg_get_os_name(image_get_os(hdr));
317 arch = genimg_get_arch_name(image_get_arch(hdr));
318 type = genimg_get_type_name(image_get_type(hdr));
319 comp = genimg_get_comp_name(image_get_comp(hdr));
321 printf("%s %s %s (%s)\n", arch, os, type, comp);
325 * image_print_contents - prints out the contents of the legacy format image
326 * @ptr: pointer to the legacy format image header
327 * @p: pointer to prefix string
329 * image_print_contents() formats a multi line legacy image contents description.
330 * The routine prints out all header fields followed by the size/offset data
331 * for MULTI/SCRIPT images.
334 * no returned results
336 void image_print_contents(const void *ptr)
338 const image_header_t *hdr = (const image_header_t *)ptr;
339 const char __maybe_unused *p;
341 p = IMAGE_INDENT_STRING;
342 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
343 if (IMAGE_ENABLE_TIMESTAMP) {
344 printf("%sCreated: ", p);
345 genimg_print_time((time_t)image_get_time(hdr));
347 printf("%sImage Type: ", p);
348 image_print_type(hdr);
349 printf("%sData Size: ", p);
350 genimg_print_size(image_get_data_size(hdr));
351 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
352 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
354 if (image_check_type(hdr, IH_TYPE_MULTI) ||
355 image_check_type(hdr, IH_TYPE_SCRIPT)) {
358 ulong count = image_multi_count(hdr);
360 printf("%sContents:\n", p);
361 for (i = 0; i < count; i++) {
362 image_multi_getimg(hdr, i, &data, &len);
364 printf("%s Image %d: ", p, i);
365 genimg_print_size(len);
367 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
369 * the user may need to know offsets
370 * if planning to do something with
373 printf("%s Offset = 0x%08lx\n", p, data);
376 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
377 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
378 image_get_load(hdr) - image_get_header_size(),
379 image_get_size(hdr) + image_get_header_size()
385 * print_decomp_msg() - Print a suitable decompression/loading message
387 * @type: OS type (IH_OS_...)
388 * @comp_type: Compression type being used (IH_COMP_...)
389 * @is_xip: true if the load address matches the image start
391 static void print_decomp_msg(int comp_type, int type, bool is_xip)
393 const char *name = genimg_get_type_name(type);
395 if (comp_type == IH_COMP_NONE)
396 printf(" %s %s\n", is_xip ? "XIP" : "Loading", name);
398 printf(" Uncompressing %s\n", name);
401 int image_decomp(int comp, ulong load, ulong image_start, int type,
402 void *load_buf, void *image_buf, ulong image_len,
403 uint unc_len, ulong *load_end)
408 print_decomp_msg(comp, type, load == image_start);
411 * Load the image to the right place, decompressing if needed. After
412 * this, image_len will be set to the number of uncompressed bytes
413 * loaded, ret will be non-zero on error.
417 if (load == image_start)
419 if (image_len <= unc_len)
420 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
426 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
429 #endif /* CONFIG_GZIP */
431 case IH_COMP_BZIP2: {
435 * If we've got less than 4 MB of malloc() space,
436 * use slower decompression algorithm which requires
437 * at most 2300 KB of memory.
439 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
440 image_buf, image_len,
441 CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
445 #endif /* CONFIG_BZIP2 */
448 SizeT lzma_len = unc_len;
450 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
451 image_buf, image_len);
452 image_len = lzma_len;
455 #endif /* CONFIG_LZMA */
458 size_t size = unc_len;
460 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
464 #endif /* CONFIG_LZO */
467 size_t size = unc_len;
469 ret = ulz4fn(image_buf, image_len, load_buf, &size);
473 #endif /* CONFIG_LZ4 */
475 printf("Unimplemented compression type %d\n", comp);
479 *load_end = load + image_len;
486 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
488 * image_get_ramdisk - get and verify ramdisk image
489 * @rd_addr: ramdisk image start address
490 * @arch: expected ramdisk architecture
491 * @verify: checksum verification flag
493 * image_get_ramdisk() returns a pointer to the verified ramdisk image
494 * header. Routine receives image start address and expected architecture
495 * flag. Verification done covers data and header integrity and os/type/arch
499 * pointer to a ramdisk image header, if image was found and valid
500 * otherwise, return NULL
502 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
505 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
507 if (!image_check_magic(rd_hdr)) {
508 puts("Bad Magic Number\n");
509 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
513 if (!image_check_hcrc(rd_hdr)) {
514 puts("Bad Header Checksum\n");
515 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
519 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
520 image_print_contents(rd_hdr);
523 puts(" Verifying Checksum ... ");
524 if (!image_check_dcrc(rd_hdr)) {
525 puts("Bad Data CRC\n");
526 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
532 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
534 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
535 !image_check_arch(rd_hdr, arch) ||
536 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
537 printf("No Linux %s Ramdisk Image\n",
538 genimg_get_arch_name(arch));
539 bootstage_error(BOOTSTAGE_ID_RAMDISK);
546 #endif /* !USE_HOSTCC */
548 /*****************************************************************************/
549 /* Shared dual-format routines */
550 /*****************************************************************************/
552 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
553 ulong save_addr; /* Default Save Address */
554 ulong save_size; /* Default Save Size (in bytes) */
556 static int on_loadaddr(const char *name, const char *value, enum env_op op,
561 case env_op_overwrite:
562 load_addr = simple_strtoul(value, NULL, 16);
570 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
572 ulong env_get_bootm_low(void)
574 char *s = env_get("bootm_low");
576 ulong tmp = simple_strtoul(s, NULL, 16);
580 #if defined(CONFIG_SYS_SDRAM_BASE)
581 return CONFIG_SYS_SDRAM_BASE;
582 #elif defined(CONFIG_ARM)
583 return gd->bd->bi_dram[0].start;
589 phys_size_t env_get_bootm_size(void)
591 phys_size_t tmp, size;
593 char *s = env_get("bootm_size");
595 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
599 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
600 start = gd->bd->bi_dram[0].start;
601 size = gd->bd->bi_dram[0].size;
603 start = gd->bd->bi_memstart;
604 size = gd->bd->bi_memsize;
607 s = env_get("bootm_low");
609 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
613 return size - (tmp - start);
616 phys_size_t env_get_bootm_mapsize(void)
619 char *s = env_get("bootm_mapsize");
621 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
625 #if defined(CONFIG_SYS_BOOTMAPSZ)
626 return CONFIG_SYS_BOOTMAPSZ;
628 return env_get_bootm_size();
632 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
637 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
643 size_t tail = (len > chunksz) ? chunksz : len;
649 memmove(to, from, tail);
656 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
657 memmove(to, from, len);
658 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
660 #else /* USE_HOSTCC */
661 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
663 memmove(to, from, len);
665 #endif /* !USE_HOSTCC */
667 void genimg_print_size(uint32_t size)
670 printf("%d Bytes = ", size);
671 print_size(size, "\n");
673 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
674 size, (double)size / 1.024e3,
675 (double)size / 1.048576e6);
679 #if IMAGE_ENABLE_TIMESTAMP
680 void genimg_print_time(time_t timestamp)
685 rtc_to_tm(timestamp, &tm);
686 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
687 tm.tm_year, tm.tm_mon, tm.tm_mday,
688 tm.tm_hour, tm.tm_min, tm.tm_sec);
690 printf("%s", ctime(×tamp));
695 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
697 for (; table->id >= 0; ++table) {
704 static const char *unknown_msg(enum ih_category category)
706 static const char unknown_str[] = "Unknown ";
709 strcpy(msg, unknown_str);
710 strncat(msg, table_info[category].desc,
711 sizeof(msg) - sizeof(unknown_str));
717 * get_cat_table_entry_name - translate entry id to long name
718 * @category: category to look up (enum ih_category)
719 * @id: entry id to be translated
721 * This will scan the translation table trying to find the entry that matches
724 * @retur long entry name if translation succeeds; error string on failure
726 const char *genimg_get_cat_name(enum ih_category category, uint id)
728 const table_entry_t *entry;
730 entry = get_table_entry(table_info[category].table, id);
732 return unknown_msg(category);
733 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
736 return entry->lname + gd->reloc_off;
741 * get_cat_table_entry_short_name - translate entry id to short name
742 * @category: category to look up (enum ih_category)
743 * @id: entry id to be translated
745 * This will scan the translation table trying to find the entry that matches
748 * @retur short entry name if translation succeeds; error string on failure
750 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
752 const table_entry_t *entry;
754 entry = get_table_entry(table_info[category].table, id);
756 return unknown_msg(category);
757 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
760 return entry->sname + gd->reloc_off;
764 int genimg_get_cat_count(enum ih_category category)
766 return table_info[category].count;
769 const char *genimg_get_cat_desc(enum ih_category category)
771 return table_info[category].desc;
775 * get_table_entry_name - translate entry id to long name
776 * @table: pointer to a translation table for entries of a specific type
777 * @msg: message to be returned when translation fails
778 * @id: entry id to be translated
780 * get_table_entry_name() will go over translation table trying to find
781 * entry that matches given id. If matching entry is found, its long
782 * name is returned to the caller.
785 * long entry name if translation succeeds
788 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
790 table = get_table_entry(table, id);
793 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
796 return table->lname + gd->reloc_off;
800 const char *genimg_get_os_name(uint8_t os)
802 return (get_table_entry_name(uimage_os, "Unknown OS", os));
805 const char *genimg_get_arch_name(uint8_t arch)
807 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
811 const char *genimg_get_type_name(uint8_t type)
813 return (get_table_entry_name(uimage_type, "Unknown Image", type));
816 static const char *genimg_get_short_name(const table_entry_t *table, int val)
818 table = get_table_entry(table, val);
821 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
824 return table->sname + gd->reloc_off;
828 const char *genimg_get_type_short_name(uint8_t type)
830 return genimg_get_short_name(uimage_type, type);
833 const char *genimg_get_comp_name(uint8_t comp)
835 return (get_table_entry_name(uimage_comp, "Unknown Compression",
839 const char *genimg_get_comp_short_name(uint8_t comp)
841 return genimg_get_short_name(uimage_comp, comp);
844 const char *genimg_get_os_short_name(uint8_t os)
846 return genimg_get_short_name(uimage_os, os);
849 const char *genimg_get_arch_short_name(uint8_t arch)
851 return genimg_get_short_name(uimage_arch, arch);
855 * get_table_entry_id - translate short entry name to id
856 * @table: pointer to a translation table for entries of a specific type
857 * @table_name: to be used in case of error
858 * @name: entry short name to be translated
860 * get_table_entry_id() will go over translation table trying to find
861 * entry that matches given short name. If matching entry is found,
862 * its id returned to the caller.
865 * entry id if translation succeeds
868 int get_table_entry_id(const table_entry_t *table,
869 const char *table_name, const char *name)
871 const table_entry_t *t;
873 for (t = table; t->id >= 0; ++t) {
874 #ifdef CONFIG_NEEDS_MANUAL_RELOC
875 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
877 if (t->sname && strcasecmp(t->sname, name) == 0)
881 debug("Invalid %s Type: %s\n", table_name, name);
886 int genimg_get_os_id(const char *name)
888 return (get_table_entry_id(uimage_os, "OS", name));
891 int genimg_get_arch_id(const char *name)
893 return (get_table_entry_id(uimage_arch, "CPU", name));
896 int genimg_get_type_id(const char *name)
898 return (get_table_entry_id(uimage_type, "Image", name));
901 int genimg_get_comp_id(const char *name)
903 return (get_table_entry_id(uimage_comp, "Compression", name));
908 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
910 * @img_addr: a string might contain real image address
911 * @fit_uname_config: double pointer to a char, will hold pointer to a
912 * configuration unit name
913 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
916 * genimg_get_kernel_addr_fit get the real kernel start address from a string
917 * which is normally the first argv of bootm/bootz
920 * kernel start address
922 ulong genimg_get_kernel_addr_fit(char * const img_addr,
923 const char **fit_uname_config,
924 const char **fit_uname_kernel)
928 /* find out kernel image address */
930 kernel_addr = load_addr;
931 debug("* kernel: default image load address = 0x%08lx\n",
933 #if CONFIG_IS_ENABLED(FIT)
934 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
936 debug("* kernel: config '%s' from image at 0x%08lx\n",
937 *fit_uname_config, kernel_addr);
938 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
940 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
941 *fit_uname_kernel, kernel_addr);
944 kernel_addr = simple_strtoul(img_addr, NULL, 16);
945 debug("* kernel: cmdline image address = 0x%08lx\n",
953 * genimg_get_kernel_addr() is the simple version of
954 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
956 ulong genimg_get_kernel_addr(char * const img_addr)
958 const char *fit_uname_config = NULL;
959 const char *fit_uname_kernel = NULL;
961 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
966 * genimg_get_format - get image format type
967 * @img_addr: image start address
969 * genimg_get_format() checks whether provided address points to a valid
970 * legacy or FIT image.
972 * New uImage format and FDT blob are based on a libfdt. FDT blob
973 * may be passed directly or embedded in a FIT image. In both situations
974 * genimg_get_format() must be able to dectect libfdt header.
977 * image format type or IMAGE_FORMAT_INVALID if no image is present
979 int genimg_get_format(const void *img_addr)
981 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
982 const image_header_t *hdr;
984 hdr = (const image_header_t *)img_addr;
985 if (image_check_magic(hdr))
986 return IMAGE_FORMAT_LEGACY;
988 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
989 if (fdt_check_header(img_addr) == 0)
990 return IMAGE_FORMAT_FIT;
992 #ifdef CONFIG_ANDROID_BOOT_IMAGE
993 if (android_image_check_header(img_addr) == 0)
994 return IMAGE_FORMAT_ANDROID;
997 return IMAGE_FORMAT_INVALID;
1001 * fit_has_config - check if there is a valid FIT configuration
1002 * @images: pointer to the bootm command headers structure
1004 * fit_has_config() checks if there is a FIT configuration in use
1005 * (if FTI support is present).
1008 * 0, no FIT support or no configuration found
1009 * 1, configuration found
1011 int genimg_has_config(bootm_headers_t *images)
1013 #if IMAGE_ENABLE_FIT
1014 if (images->fit_uname_cfg)
1021 * boot_get_ramdisk - main ramdisk handling routine
1022 * @argc: command argument count
1023 * @argv: command argument list
1024 * @images: pointer to the bootm images structure
1025 * @arch: expected ramdisk architecture
1026 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
1027 * @rd_end: pointer to a ulong variable, will hold ramdisk end
1029 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
1030 * Curently supported are the following ramdisk sources:
1031 * - multicomponent kernel/ramdisk image,
1032 * - commandline provided address of decicated ramdisk image.
1035 * 0, if ramdisk image was found and valid, or skiped
1036 * rd_start and rd_end are set to ramdisk start/end addresses if
1037 * ramdisk image is found and valid
1039 * 1, if ramdisk image is found but corrupted, or invalid
1040 * rd_start and rd_end are set to 0 if no ramdisk exists
1042 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1043 uint8_t arch, ulong *rd_start, ulong *rd_end)
1045 ulong rd_addr, rd_load;
1046 ulong rd_data, rd_len;
1047 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1048 const image_header_t *rd_hdr;
1051 #ifdef CONFIG_SUPPORT_RAW_INITRD
1054 #if IMAGE_ENABLE_FIT
1055 const char *fit_uname_config = images->fit_uname_cfg;
1056 const char *fit_uname_ramdisk = NULL;
1060 const char *select = NULL;
1065 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1067 * Look for an Android boot image.
1069 buf = map_sysmem(images->os.start, 0);
1070 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1071 select = (argc == 0) ? env_get("loadaddr") : argv[0];
1078 * Look for a '-' which indicates to ignore the
1081 if (select && strcmp(select, "-") == 0) {
1082 debug("## Skipping init Ramdisk\n");
1083 rd_len = rd_data = 0;
1084 } else if (select || genimg_has_config(images)) {
1085 #if IMAGE_ENABLE_FIT
1088 * If the init ramdisk comes from the FIT image and
1089 * the FIT image address is omitted in the command
1090 * line argument, try to use os FIT image address or
1091 * default load address.
1093 if (images->fit_uname_os)
1094 default_addr = (ulong)images->fit_hdr_os;
1096 default_addr = load_addr;
1098 if (fit_parse_conf(select, default_addr,
1099 &rd_addr, &fit_uname_config)) {
1100 debug("* ramdisk: config '%s' from image at "
1102 fit_uname_config, rd_addr);
1103 } else if (fit_parse_subimage(select, default_addr,
1104 &rd_addr, &fit_uname_ramdisk)) {
1105 debug("* ramdisk: subimage '%s' from image at "
1107 fit_uname_ramdisk, rd_addr);
1111 rd_addr = simple_strtoul(select, NULL, 16);
1112 debug("* ramdisk: cmdline image address = "
1116 #if IMAGE_ENABLE_FIT
1118 /* use FIT configuration provided in first bootm
1119 * command argument. If the property is not defined,
1122 rd_addr = map_to_sysmem(images->fit_hdr_os);
1123 rd_noffset = fit_get_node_from_config(images,
1124 FIT_RAMDISK_PROP, rd_addr);
1125 if (rd_noffset == -ENOENT)
1127 else if (rd_noffset < 0)
1133 * Check if there is an initrd image at the
1134 * address provided in the second bootm argument
1135 * check image type, for FIT images get FIT node.
1137 buf = map_sysmem(rd_addr, 0);
1138 switch (genimg_get_format(buf)) {
1139 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1140 case IMAGE_FORMAT_LEGACY:
1141 printf("## Loading init Ramdisk from Legacy "
1142 "Image at %08lx ...\n", rd_addr);
1144 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1145 rd_hdr = image_get_ramdisk(rd_addr, arch,
1151 rd_data = image_get_data(rd_hdr);
1152 rd_len = image_get_data_size(rd_hdr);
1153 rd_load = image_get_load(rd_hdr);
1156 #if IMAGE_ENABLE_FIT
1157 case IMAGE_FORMAT_FIT:
1158 rd_noffset = fit_image_load(images,
1159 rd_addr, &fit_uname_ramdisk,
1160 &fit_uname_config, arch,
1162 BOOTSTAGE_ID_FIT_RD_START,
1163 FIT_LOAD_OPTIONAL_NON_ZERO,
1168 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1169 images->fit_uname_rd = fit_uname_ramdisk;
1170 images->fit_noffset_rd = rd_noffset;
1173 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1174 case IMAGE_FORMAT_ANDROID:
1175 android_image_get_ramdisk((void *)images->os.start,
1180 #ifdef CONFIG_SUPPORT_RAW_INITRD
1183 end = strchr(select, ':');
1185 rd_len = simple_strtoul(++end, NULL, 16);
1190 puts("Wrong Ramdisk Image Format\n");
1191 rd_data = rd_len = rd_load = 0;
1195 } else if (images->legacy_hdr_valid &&
1196 image_check_type(&images->legacy_hdr_os_copy,
1200 * Now check if we have a legacy mult-component image,
1201 * get second entry data start address and len.
1203 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1204 printf("## Loading init Ramdisk from multi component "
1205 "Legacy Image at %08lx ...\n",
1206 (ulong)images->legacy_hdr_os);
1208 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1213 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1214 rd_len = rd_data = 0;
1218 debug("## No init Ramdisk\n");
1220 *rd_start = rd_data;
1221 *rd_end = rd_data + rd_len;
1223 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1224 *rd_start, *rd_end);
1229 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1231 * boot_ramdisk_high - relocate init ramdisk
1232 * @lmb: pointer to lmb handle, will be used for memory mgmt
1233 * @rd_data: ramdisk data start address
1234 * @rd_len: ramdisk data length
1235 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1236 * start address (after possible relocation)
1237 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1238 * end address (after possible relocation)
1240 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1241 * variable and if requested ramdisk data is moved to a specified location.
1243 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1244 * start/end addresses if ramdisk image start and len were provided,
1245 * otherwise set initrd_start and initrd_end set to zeros.
1251 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1252 ulong *initrd_start, ulong *initrd_end)
1256 int initrd_copy_to_ram = 1;
1258 s = env_get("initrd_high");
1260 /* a value of "no" or a similar string will act like 0,
1261 * turning the "load high" feature off. This is intentional.
1263 initrd_high = simple_strtoul(s, NULL, 16);
1264 if (initrd_high == ~0)
1265 initrd_copy_to_ram = 0;
1267 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1271 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1272 initrd_high, initrd_copy_to_ram);
1275 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1276 debug(" in-place initrd\n");
1277 *initrd_start = rd_data;
1278 *initrd_end = rd_data + rd_len;
1279 lmb_reserve(lmb, rd_data, rd_len);
1282 *initrd_start = (ulong)lmb_alloc_base(lmb,
1283 rd_len, 0x1000, initrd_high);
1285 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1288 if (*initrd_start == 0) {
1289 puts("ramdisk - allocation error\n");
1292 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1294 *initrd_end = *initrd_start + rd_len;
1295 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1296 *initrd_start, *initrd_end);
1298 memmove_wd((void *)*initrd_start,
1299 (void *)rd_data, rd_len, CHUNKSZ);
1303 * Ensure the image is flushed to memory to handle
1304 * AMP boot scenarios in which we might not be
1307 flush_cache((unsigned long)*initrd_start,
1308 ALIGN(rd_len, ARCH_DMA_MINALIGN));
1316 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1317 *initrd_start, *initrd_end);
1324 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1326 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1327 ulong *setup_start, ulong *setup_len)
1329 #if IMAGE_ENABLE_FIT
1330 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1336 #if IMAGE_ENABLE_FIT
1337 #if defined(CONFIG_FPGA)
1338 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1339 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1341 ulong tmp_img_addr, img_data, img_len;
1345 const char *uname, *name;
1347 int devnum = 0; /* TODO support multi fpga platforms */
1349 /* Check to see if the images struct has a FIT configuration */
1350 if (!genimg_has_config(images)) {
1351 debug("## FIT configuration was not specified\n");
1356 * Obtain the os FIT header from the images struct
1358 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1359 buf = map_sysmem(tmp_img_addr, 0);
1361 * Check image type. For FIT images get FIT node
1362 * and attempt to locate a generic binary.
1364 switch (genimg_get_format(buf)) {
1365 case IMAGE_FORMAT_FIT:
1366 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1368 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1371 debug("## FPGA image is not specified\n");
1374 fit_img_result = fit_image_load(images,
1376 (const char **)&uname,
1377 &(images->fit_uname_cfg),
1380 BOOTSTAGE_ID_FPGA_INIT,
1381 FIT_LOAD_OPTIONAL_NON_ZERO,
1382 &img_data, &img_len);
1384 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1385 uname, img_data, img_len);
1387 if (fit_img_result < 0) {
1388 /* Something went wrong! */
1389 return fit_img_result;
1392 if (!fpga_is_partial_data(devnum, img_len)) {
1394 err = fpga_loadbitstream(devnum, (char *)img_data,
1397 err = fpga_load(devnum, (const void *)img_data,
1401 err = fpga_loadbitstream(devnum, (char *)img_data,
1402 img_len, BIT_PARTIAL);
1404 err = fpga_load(devnum, (const void *)img_data,
1405 img_len, BIT_PARTIAL);
1411 printf(" Programming %s bitstream... OK\n", name);
1414 printf("The given image format is not supported (corrupt?)\n");
1422 static void fit_loadable_process(uint8_t img_type,
1427 const unsigned int count =
1428 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1429 struct fit_loadable_tbl *fit_loadable_handler =
1430 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1431 /* For each loadable handler */
1432 for (i = 0; i < count; i++, fit_loadable_handler++)
1433 /* matching this type */
1434 if (fit_loadable_handler->type == img_type)
1435 /* call that handler with this image data */
1436 fit_loadable_handler->handler(img_data, img_len);
1439 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1440 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1443 * These variables are used to hold the current image location
1448 * These two variables are requirements for fit_image_load, but
1449 * their values are not used
1451 ulong img_data, img_len;
1453 int loadables_index;
1459 /* Check to see if the images struct has a FIT configuration */
1460 if (!genimg_has_config(images)) {
1461 debug("## FIT configuration was not specified\n");
1466 * Obtain the os FIT header from the images struct
1468 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1469 buf = map_sysmem(tmp_img_addr, 0);
1471 * Check image type. For FIT images get FIT node
1472 * and attempt to locate a generic binary.
1474 switch (genimg_get_format(buf)) {
1475 case IMAGE_FORMAT_FIT:
1476 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1478 for (loadables_index = 0;
1479 uname = fdt_stringlist_get(buf, conf_noffset,
1480 FIT_LOADABLE_PROP, loadables_index,
1484 fit_img_result = fit_image_load(images,
1487 &(images->fit_uname_cfg), arch,
1489 BOOTSTAGE_ID_FIT_LOADABLE_START,
1490 FIT_LOAD_OPTIONAL_NON_ZERO,
1491 &img_data, &img_len);
1492 if (fit_img_result < 0) {
1493 /* Something went wrong! */
1494 return fit_img_result;
1497 fit_img_result = fit_image_get_node(buf, uname);
1498 if (fit_img_result < 0) {
1499 /* Something went wrong! */
1500 return fit_img_result;
1502 fit_img_result = fit_image_get_type(buf,
1505 if (fit_img_result < 0) {
1506 /* Something went wrong! */
1507 return fit_img_result;
1510 fit_loadable_process(img_type, img_data, img_len);
1514 printf("The given image format is not supported (corrupt?)\n");
1522 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1524 * boot_get_cmdline - allocate and initialize kernel cmdline
1525 * @lmb: pointer to lmb handle, will be used for memory mgmt
1526 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1527 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1529 * boot_get_cmdline() allocates space for kernel command line below
1530 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environment
1531 * variable is present its contents is copied to allocated kernel
1538 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1543 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1544 env_get_bootm_mapsize() + env_get_bootm_low());
1546 if (cmdline == NULL)
1549 s = env_get("bootargs");
1555 *cmd_start = (ulong) & cmdline[0];
1556 *cmd_end = *cmd_start + strlen(cmdline);
1558 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1562 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1564 #ifdef CONFIG_SYS_BOOT_GET_KBD
1566 * boot_get_kbd - allocate and initialize kernel copy of board info
1567 * @lmb: pointer to lmb handle, will be used for memory mgmt
1568 * @kbd: double pointer to board info data
1570 * boot_get_kbd() allocates space for kernel copy of board info data below
1571 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1572 * with the current u-boot board info data.
1578 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1580 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1581 env_get_bootm_mapsize() + env_get_bootm_low());
1587 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1589 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1590 do_bdinfo(NULL, 0, 0, NULL);
1595 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1598 int image_setup_linux(bootm_headers_t *images)
1600 ulong of_size = images->ft_len;
1601 char **of_flat_tree = &images->ft_addr;
1602 struct lmb *lmb = &images->lmb;
1605 if (IMAGE_ENABLE_OF_LIBFDT)
1606 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1608 if (IMAGE_BOOT_GET_CMDLINE) {
1609 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1610 &images->cmdline_end);
1612 puts("ERROR with allocation of cmdline\n");
1617 if (IMAGE_ENABLE_OF_LIBFDT) {
1618 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1623 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1624 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1631 #endif /* CONFIG_LMB */
1632 #endif /* !USE_HOSTCC */