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 #ifdef CONFIG_SHOW_BOOT_PROGRESS
15 #include <status_led.h>
24 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
25 #include <linux/libfdt.h>
26 #include <fdt_support.h>
31 #include <u-boot/md5.h>
32 #include <u-boot/sha1.h>
33 #include <linux/errno.h>
37 #include <linux/lzo.h>
38 #include <lzma/LzmaTypes.h>
39 #include <lzma/LzmaDec.h>
40 #include <lzma/LzmaTools.h>
43 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
46 DECLARE_GLOBAL_DATA_PTR;
48 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
49 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
54 #include <u-boot/md5.h>
58 #ifndef __maybe_unused
59 # define __maybe_unused /* unimplemented */
61 #endif /* !USE_HOSTCC*/
63 #include <u-boot/crc.h>
65 #ifndef CONFIG_SYS_BARGSIZE
66 #define CONFIG_SYS_BARGSIZE 512
69 static const table_entry_t uimage_arch[] = {
70 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
71 { IH_ARCH_ALPHA, "alpha", "Alpha", },
72 { IH_ARCH_ARM, "arm", "ARM", },
73 { IH_ARCH_I386, "x86", "Intel x86", },
74 { IH_ARCH_IA64, "ia64", "IA64", },
75 { IH_ARCH_M68K, "m68k", "M68K", },
76 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
77 { IH_ARCH_MIPS, "mips", "MIPS", },
78 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
79 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
80 { IH_ARCH_PPC, "powerpc", "PowerPC", },
81 { IH_ARCH_PPC, "ppc", "PowerPC", },
82 { IH_ARCH_S390, "s390", "IBM S390", },
83 { IH_ARCH_SH, "sh", "SuperH", },
84 { IH_ARCH_SPARC, "sparc", "SPARC", },
85 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
86 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
87 { IH_ARCH_AVR32, "avr32", "AVR32", },
88 { IH_ARCH_NDS32, "nds32", "NDS32", },
89 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
90 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
91 { IH_ARCH_ARM64, "arm64", "AArch64", },
92 { IH_ARCH_ARC, "arc", "ARC", },
93 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
94 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
95 { IH_ARCH_RISCV, "riscv", "RISC-V", },
99 static const table_entry_t uimage_os[] = {
100 { IH_OS_INVALID, "invalid", "Invalid OS", },
101 { IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware" },
102 { IH_OS_LINUX, "linux", "Linux", },
103 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
104 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
106 { IH_OS_NETBSD, "netbsd", "NetBSD", },
107 { IH_OS_OSE, "ose", "Enea OSE", },
108 { IH_OS_PLAN9, "plan9", "Plan 9", },
109 { IH_OS_RTEMS, "rtems", "RTEMS", },
110 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
111 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
112 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
113 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
114 { IH_OS_QNX, "qnx", "QNX", },
116 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
117 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
120 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
121 { IH_OS_DELL, "dell", "Dell", },
122 { IH_OS_ESIX, "esix", "Esix", },
123 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
124 { IH_OS_IRIX, "irix", "Irix", },
125 { IH_OS_NCR, "ncr", "NCR", },
126 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
127 { IH_OS_PSOS, "psos", "pSOS", },
128 { IH_OS_SCO, "sco", "SCO", },
129 { IH_OS_SOLARIS, "solaris", "Solaris", },
130 { IH_OS_SVR4, "svr4", "SVR4", },
132 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
133 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
135 { IH_OS_OPENSBI, "opensbi", "RISC-V OpenSBI", },
140 static const table_entry_t uimage_type[] = {
141 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
142 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
143 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
144 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
145 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
146 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
147 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
148 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
149 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
150 { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
151 { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
152 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
153 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
154 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
155 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
156 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
157 { IH_TYPE_SCRIPT, "script", "Script", },
158 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
159 { IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
160 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
161 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
162 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
163 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
164 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
165 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
166 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
167 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
168 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
169 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
170 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
171 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
172 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
173 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
174 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
175 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
176 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
177 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
178 { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
182 static const table_entry_t uimage_comp[] = {
183 { IH_COMP_NONE, "none", "uncompressed", },
184 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
185 { IH_COMP_GZIP, "gzip", "gzip compressed", },
186 { IH_COMP_LZMA, "lzma", "lzma compressed", },
187 { IH_COMP_LZO, "lzo", "lzo compressed", },
188 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
195 const table_entry_t *table;
198 static const struct table_info table_info[IH_COUNT] = {
199 { "architecture", IH_ARCH_COUNT, uimage_arch },
200 { "compression", IH_COMP_COUNT, uimage_comp },
201 { "operating system", IH_OS_COUNT, uimage_os },
202 { "image type", IH_TYPE_COUNT, uimage_type },
205 /*****************************************************************************/
206 /* Legacy format routines */
207 /*****************************************************************************/
208 int image_check_hcrc(const image_header_t *hdr)
211 ulong len = image_get_header_size();
212 image_header_t header;
214 /* Copy header so we can blank CRC field for re-calculation */
215 memmove(&header, (char *)hdr, image_get_header_size());
216 image_set_hcrc(&header, 0);
218 hcrc = crc32(0, (unsigned char *)&header, len);
220 return (hcrc == image_get_hcrc(hdr));
223 int image_check_dcrc(const image_header_t *hdr)
225 ulong data = image_get_data(hdr);
226 ulong len = image_get_data_size(hdr);
227 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
229 return (dcrc == image_get_dcrc(hdr));
233 * image_multi_count - get component (sub-image) count
234 * @hdr: pointer to the header of the multi component image
236 * image_multi_count() returns number of components in a multi
239 * Note: no checking of the image type is done, caller must pass
240 * a valid multi component image.
243 * number of components
245 ulong image_multi_count(const image_header_t *hdr)
250 /* get start of the image payload, which in case of multi
251 * component images that points to a table of component sizes */
252 size = (uint32_t *)image_get_data(hdr);
254 /* count non empty slots */
255 for (i = 0; size[i]; ++i)
262 * image_multi_getimg - get component data address and size
263 * @hdr: pointer to the header of the multi component image
264 * @idx: index of the requested component
265 * @data: pointer to a ulong variable, will hold component data address
266 * @len: pointer to a ulong variable, will hold component size
268 * image_multi_getimg() returns size and data address for the requested
269 * component in a multi component image.
271 * Note: no checking of the image type is done, caller must pass
272 * a valid multi component image.
275 * data address and size of the component, if idx is valid
276 * 0 in data and len, if idx is out of range
278 void image_multi_getimg(const image_header_t *hdr, ulong idx,
279 ulong *data, ulong *len)
283 ulong offset, count, img_data;
285 /* get number of component */
286 count = image_multi_count(hdr);
288 /* get start of the image payload, which in case of multi
289 * component images that points to a table of component sizes */
290 size = (uint32_t *)image_get_data(hdr);
292 /* get address of the proper component data start, which means
293 * skipping sizes table (add 1 for last, null entry) */
294 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
297 *len = uimage_to_cpu(size[idx]);
300 /* go over all indices preceding requested component idx */
301 for (i = 0; i < idx; i++) {
302 /* add up i-th component size, rounding up to 4 bytes */
303 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
306 /* calculate idx-th component data address */
307 *data = img_data + offset;
314 static void image_print_type(const image_header_t *hdr)
316 const char __maybe_unused *os, *arch, *type, *comp;
318 os = genimg_get_os_name(image_get_os(hdr));
319 arch = genimg_get_arch_name(image_get_arch(hdr));
320 type = genimg_get_type_name(image_get_type(hdr));
321 comp = genimg_get_comp_name(image_get_comp(hdr));
323 printf("%s %s %s (%s)\n", arch, os, type, comp);
327 * image_print_contents - prints out the contents of the legacy format image
328 * @ptr: pointer to the legacy format image header
329 * @p: pointer to prefix string
331 * image_print_contents() formats a multi line legacy image contents description.
332 * The routine prints out all header fields followed by the size/offset data
333 * for MULTI/SCRIPT images.
336 * no returned results
338 void image_print_contents(const void *ptr)
340 const image_header_t *hdr = (const image_header_t *)ptr;
341 const char __maybe_unused *p;
343 p = IMAGE_INDENT_STRING;
344 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
345 if (IMAGE_ENABLE_TIMESTAMP) {
346 printf("%sCreated: ", p);
347 genimg_print_time((time_t)image_get_time(hdr));
349 printf("%sImage Type: ", p);
350 image_print_type(hdr);
351 printf("%sData Size: ", p);
352 genimg_print_size(image_get_data_size(hdr));
353 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
354 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
356 if (image_check_type(hdr, IH_TYPE_MULTI) ||
357 image_check_type(hdr, IH_TYPE_SCRIPT)) {
360 ulong count = image_multi_count(hdr);
362 printf("%sContents:\n", p);
363 for (i = 0; i < count; i++) {
364 image_multi_getimg(hdr, i, &data, &len);
366 printf("%s Image %d: ", p, i);
367 genimg_print_size(len);
369 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
371 * the user may need to know offsets
372 * if planning to do something with
375 printf("%s Offset = 0x%08lx\n", p, data);
378 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
379 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
380 image_get_load(hdr) - image_get_header_size(),
381 image_get_size(hdr) + image_get_header_size()
387 * print_decomp_msg() - Print a suitable decompression/loading message
389 * @type: OS type (IH_OS_...)
390 * @comp_type: Compression type being used (IH_COMP_...)
391 * @is_xip: true if the load address matches the image start
393 static void print_decomp_msg(int comp_type, int type, bool is_xip)
395 const char *name = genimg_get_type_name(type);
397 if (comp_type == IH_COMP_NONE)
398 printf(" %s %s\n", is_xip ? "XIP" : "Loading", name);
400 printf(" Uncompressing %s\n", name);
403 int image_decomp(int comp, ulong load, ulong image_start, int type,
404 void *load_buf, void *image_buf, ulong image_len,
405 uint unc_len, ulong *load_end)
410 print_decomp_msg(comp, type, load == image_start);
413 * Load the image to the right place, decompressing if needed. After
414 * this, image_len will be set to the number of uncompressed bytes
415 * loaded, ret will be non-zero on error.
419 if (load == image_start)
421 if (image_len <= unc_len)
422 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
428 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
431 #endif /* CONFIG_GZIP */
433 case IH_COMP_BZIP2: {
437 * If we've got less than 4 MB of malloc() space,
438 * use slower decompression algorithm which requires
439 * at most 2300 KB of memory.
441 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
442 image_buf, image_len,
443 CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
447 #endif /* CONFIG_BZIP2 */
450 SizeT lzma_len = unc_len;
452 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
453 image_buf, image_len);
454 image_len = lzma_len;
457 #endif /* CONFIG_LZMA */
460 size_t size = unc_len;
462 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
466 #endif /* CONFIG_LZO */
469 size_t size = unc_len;
471 ret = ulz4fn(image_buf, image_len, load_buf, &size);
475 #endif /* CONFIG_LZ4 */
477 printf("Unimplemented compression type %d\n", comp);
481 *load_end = load + image_len;
488 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
490 * image_get_ramdisk - get and verify ramdisk image
491 * @rd_addr: ramdisk image start address
492 * @arch: expected ramdisk architecture
493 * @verify: checksum verification flag
495 * image_get_ramdisk() returns a pointer to the verified ramdisk image
496 * header. Routine receives image start address and expected architecture
497 * flag. Verification done covers data and header integrity and os/type/arch
501 * pointer to a ramdisk image header, if image was found and valid
502 * otherwise, return NULL
504 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
507 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
509 if (!image_check_magic(rd_hdr)) {
510 puts("Bad Magic Number\n");
511 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
515 if (!image_check_hcrc(rd_hdr)) {
516 puts("Bad Header Checksum\n");
517 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
521 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
522 image_print_contents(rd_hdr);
525 puts(" Verifying Checksum ... ");
526 if (!image_check_dcrc(rd_hdr)) {
527 puts("Bad Data CRC\n");
528 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
534 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
536 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
537 !image_check_arch(rd_hdr, arch) ||
538 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
539 printf("No Linux %s Ramdisk Image\n",
540 genimg_get_arch_name(arch));
541 bootstage_error(BOOTSTAGE_ID_RAMDISK);
548 #endif /* !USE_HOSTCC */
550 /*****************************************************************************/
551 /* Shared dual-format routines */
552 /*****************************************************************************/
554 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
555 ulong save_addr; /* Default Save Address */
556 ulong save_size; /* Default Save Size (in bytes) */
558 static int on_loadaddr(const char *name, const char *value, enum env_op op,
563 case env_op_overwrite:
564 load_addr = simple_strtoul(value, NULL, 16);
572 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
574 ulong env_get_bootm_low(void)
576 char *s = env_get("bootm_low");
578 ulong tmp = simple_strtoul(s, NULL, 16);
582 #if defined(CONFIG_SYS_SDRAM_BASE)
583 return CONFIG_SYS_SDRAM_BASE;
584 #elif defined(CONFIG_ARM)
585 return gd->bd->bi_dram[0].start;
591 phys_size_t env_get_bootm_size(void)
593 phys_size_t tmp, size;
595 char *s = env_get("bootm_size");
597 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
601 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
602 start = gd->bd->bi_dram[0].start;
603 size = gd->bd->bi_dram[0].size;
605 start = gd->bd->bi_memstart;
606 size = gd->bd->bi_memsize;
609 s = env_get("bootm_low");
611 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
615 return size - (tmp - start);
618 phys_size_t env_get_bootm_mapsize(void)
621 char *s = env_get("bootm_mapsize");
623 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
627 #if defined(CONFIG_SYS_BOOTMAPSZ)
628 return CONFIG_SYS_BOOTMAPSZ;
630 return env_get_bootm_size();
634 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
639 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
645 size_t tail = (len > chunksz) ? chunksz : len;
651 memmove(to, from, tail);
658 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
659 memmove(to, from, len);
660 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
662 #else /* USE_HOSTCC */
663 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
665 memmove(to, from, len);
667 #endif /* !USE_HOSTCC */
669 void genimg_print_size(uint32_t size)
672 printf("%d Bytes = ", size);
673 print_size(size, "\n");
675 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
676 size, (double)size / 1.024e3,
677 (double)size / 1.048576e6);
681 #if IMAGE_ENABLE_TIMESTAMP
682 void genimg_print_time(time_t timestamp)
687 rtc_to_tm(timestamp, &tm);
688 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
689 tm.tm_year, tm.tm_mon, tm.tm_mday,
690 tm.tm_hour, tm.tm_min, tm.tm_sec);
692 printf("%s", ctime(×tamp));
697 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
699 for (; table->id >= 0; ++table) {
706 static const char *unknown_msg(enum ih_category category)
708 static const char unknown_str[] = "Unknown ";
711 strcpy(msg, unknown_str);
712 strncat(msg, table_info[category].desc,
713 sizeof(msg) - sizeof(unknown_str));
719 * get_cat_table_entry_name - translate entry id to long name
720 * @category: category to look up (enum ih_category)
721 * @id: entry id to be translated
723 * This will scan the translation table trying to find the entry that matches
726 * @retur long entry name if translation succeeds; error string on failure
728 const char *genimg_get_cat_name(enum ih_category category, uint id)
730 const table_entry_t *entry;
732 entry = get_table_entry(table_info[category].table, id);
734 return unknown_msg(category);
735 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
738 return entry->lname + gd->reloc_off;
743 * get_cat_table_entry_short_name - translate entry id to short name
744 * @category: category to look up (enum ih_category)
745 * @id: entry id to be translated
747 * This will scan the translation table trying to find the entry that matches
750 * @retur short entry name if translation succeeds; error string on failure
752 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
754 const table_entry_t *entry;
756 entry = get_table_entry(table_info[category].table, id);
758 return unknown_msg(category);
759 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
762 return entry->sname + gd->reloc_off;
766 int genimg_get_cat_count(enum ih_category category)
768 return table_info[category].count;
771 const char *genimg_get_cat_desc(enum ih_category category)
773 return table_info[category].desc;
777 * get_table_entry_name - translate entry id to long name
778 * @table: pointer to a translation table for entries of a specific type
779 * @msg: message to be returned when translation fails
780 * @id: entry id to be translated
782 * get_table_entry_name() will go over translation table trying to find
783 * entry that matches given id. If matching entry is found, its long
784 * name is returned to the caller.
787 * long entry name if translation succeeds
790 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
792 table = get_table_entry(table, id);
795 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
798 return table->lname + gd->reloc_off;
802 const char *genimg_get_os_name(uint8_t os)
804 return (get_table_entry_name(uimage_os, "Unknown OS", os));
807 const char *genimg_get_arch_name(uint8_t arch)
809 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
813 const char *genimg_get_type_name(uint8_t type)
815 return (get_table_entry_name(uimage_type, "Unknown Image", type));
818 static const char *genimg_get_short_name(const table_entry_t *table, int val)
820 table = get_table_entry(table, val);
823 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
826 return table->sname + gd->reloc_off;
830 const char *genimg_get_type_short_name(uint8_t type)
832 return genimg_get_short_name(uimage_type, type);
835 const char *genimg_get_comp_name(uint8_t comp)
837 return (get_table_entry_name(uimage_comp, "Unknown Compression",
841 const char *genimg_get_comp_short_name(uint8_t comp)
843 return genimg_get_short_name(uimage_comp, comp);
846 const char *genimg_get_os_short_name(uint8_t os)
848 return genimg_get_short_name(uimage_os, os);
851 const char *genimg_get_arch_short_name(uint8_t arch)
853 return genimg_get_short_name(uimage_arch, arch);
857 * get_table_entry_id - translate short entry name to id
858 * @table: pointer to a translation table for entries of a specific type
859 * @table_name: to be used in case of error
860 * @name: entry short name to be translated
862 * get_table_entry_id() will go over translation table trying to find
863 * entry that matches given short name. If matching entry is found,
864 * its id returned to the caller.
867 * entry id if translation succeeds
870 int get_table_entry_id(const table_entry_t *table,
871 const char *table_name, const char *name)
873 const table_entry_t *t;
875 for (t = table; t->id >= 0; ++t) {
876 #ifdef CONFIG_NEEDS_MANUAL_RELOC
877 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
879 if (t->sname && strcasecmp(t->sname, name) == 0)
883 debug("Invalid %s Type: %s\n", table_name, name);
888 int genimg_get_os_id(const char *name)
890 return (get_table_entry_id(uimage_os, "OS", name));
893 int genimg_get_arch_id(const char *name)
895 return (get_table_entry_id(uimage_arch, "CPU", name));
898 int genimg_get_type_id(const char *name)
900 return (get_table_entry_id(uimage_type, "Image", name));
903 int genimg_get_comp_id(const char *name)
905 return (get_table_entry_id(uimage_comp, "Compression", name));
910 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
912 * @img_addr: a string might contain real image address
913 * @fit_uname_config: double pointer to a char, will hold pointer to a
914 * configuration unit name
915 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
918 * genimg_get_kernel_addr_fit get the real kernel start address from a string
919 * which is normally the first argv of bootm/bootz
922 * kernel start address
924 ulong genimg_get_kernel_addr_fit(char * const img_addr,
925 const char **fit_uname_config,
926 const char **fit_uname_kernel)
930 /* find out kernel image address */
932 kernel_addr = load_addr;
933 debug("* kernel: default image load address = 0x%08lx\n",
935 #if CONFIG_IS_ENABLED(FIT)
936 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
938 debug("* kernel: config '%s' from image at 0x%08lx\n",
939 *fit_uname_config, kernel_addr);
940 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
942 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
943 *fit_uname_kernel, kernel_addr);
946 kernel_addr = simple_strtoul(img_addr, NULL, 16);
947 debug("* kernel: cmdline image address = 0x%08lx\n",
955 * genimg_get_kernel_addr() is the simple version of
956 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
958 ulong genimg_get_kernel_addr(char * const img_addr)
960 const char *fit_uname_config = NULL;
961 const char *fit_uname_kernel = NULL;
963 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
968 * genimg_get_format - get image format type
969 * @img_addr: image start address
971 * genimg_get_format() checks whether provided address points to a valid
972 * legacy or FIT image.
974 * New uImage format and FDT blob are based on a libfdt. FDT blob
975 * may be passed directly or embedded in a FIT image. In both situations
976 * genimg_get_format() must be able to dectect libfdt header.
979 * image format type or IMAGE_FORMAT_INVALID if no image is present
981 int genimg_get_format(const void *img_addr)
983 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
984 const image_header_t *hdr;
986 hdr = (const image_header_t *)img_addr;
987 if (image_check_magic(hdr))
988 return IMAGE_FORMAT_LEGACY;
990 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
991 if (fdt_check_header(img_addr) == 0)
992 return IMAGE_FORMAT_FIT;
994 #ifdef CONFIG_ANDROID_BOOT_IMAGE
995 if (android_image_check_header(img_addr) == 0)
996 return IMAGE_FORMAT_ANDROID;
999 return IMAGE_FORMAT_INVALID;
1003 * fit_has_config - check if there is a valid FIT configuration
1004 * @images: pointer to the bootm command headers structure
1006 * fit_has_config() checks if there is a FIT configuration in use
1007 * (if FTI support is present).
1010 * 0, no FIT support or no configuration found
1011 * 1, configuration found
1013 int genimg_has_config(bootm_headers_t *images)
1015 #if IMAGE_ENABLE_FIT
1016 if (images->fit_uname_cfg)
1023 * boot_get_ramdisk - main ramdisk handling routine
1024 * @argc: command argument count
1025 * @argv: command argument list
1026 * @images: pointer to the bootm images structure
1027 * @arch: expected ramdisk architecture
1028 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
1029 * @rd_end: pointer to a ulong variable, will hold ramdisk end
1031 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
1032 * Curently supported are the following ramdisk sources:
1033 * - multicomponent kernel/ramdisk image,
1034 * - commandline provided address of decicated ramdisk image.
1037 * 0, if ramdisk image was found and valid, or skiped
1038 * rd_start and rd_end are set to ramdisk start/end addresses if
1039 * ramdisk image is found and valid
1041 * 1, if ramdisk image is found but corrupted, or invalid
1042 * rd_start and rd_end are set to 0 if no ramdisk exists
1044 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1045 uint8_t arch, ulong *rd_start, ulong *rd_end)
1047 ulong rd_addr, rd_load;
1048 ulong rd_data, rd_len;
1049 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1050 const image_header_t *rd_hdr;
1053 #ifdef CONFIG_SUPPORT_RAW_INITRD
1056 #if IMAGE_ENABLE_FIT
1057 const char *fit_uname_config = images->fit_uname_cfg;
1058 const char *fit_uname_ramdisk = NULL;
1062 const char *select = NULL;
1067 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1069 * Look for an Android boot image.
1071 buf = map_sysmem(images->os.start, 0);
1072 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1073 select = (argc == 0) ? env_get("loadaddr") : argv[0];
1080 * Look for a '-' which indicates to ignore the
1083 if (select && strcmp(select, "-") == 0) {
1084 debug("## Skipping init Ramdisk\n");
1085 rd_len = rd_data = 0;
1086 } else if (select || genimg_has_config(images)) {
1087 #if IMAGE_ENABLE_FIT
1090 * If the init ramdisk comes from the FIT image and
1091 * the FIT image address is omitted in the command
1092 * line argument, try to use os FIT image address or
1093 * default load address.
1095 if (images->fit_uname_os)
1096 default_addr = (ulong)images->fit_hdr_os;
1098 default_addr = load_addr;
1100 if (fit_parse_conf(select, default_addr,
1101 &rd_addr, &fit_uname_config)) {
1102 debug("* ramdisk: config '%s' from image at "
1104 fit_uname_config, rd_addr);
1105 } else if (fit_parse_subimage(select, default_addr,
1106 &rd_addr, &fit_uname_ramdisk)) {
1107 debug("* ramdisk: subimage '%s' from image at "
1109 fit_uname_ramdisk, rd_addr);
1113 rd_addr = simple_strtoul(select, NULL, 16);
1114 debug("* ramdisk: cmdline image address = "
1118 #if IMAGE_ENABLE_FIT
1120 /* use FIT configuration provided in first bootm
1121 * command argument. If the property is not defined,
1124 rd_addr = map_to_sysmem(images->fit_hdr_os);
1125 rd_noffset = fit_get_node_from_config(images,
1126 FIT_RAMDISK_PROP, rd_addr);
1127 if (rd_noffset == -ENOENT)
1129 else if (rd_noffset < 0)
1135 * Check if there is an initrd image at the
1136 * address provided in the second bootm argument
1137 * check image type, for FIT images get FIT node.
1139 buf = map_sysmem(rd_addr, 0);
1140 switch (genimg_get_format(buf)) {
1141 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1142 case IMAGE_FORMAT_LEGACY:
1143 printf("## Loading init Ramdisk from Legacy "
1144 "Image at %08lx ...\n", rd_addr);
1146 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1147 rd_hdr = image_get_ramdisk(rd_addr, arch,
1153 rd_data = image_get_data(rd_hdr);
1154 rd_len = image_get_data_size(rd_hdr);
1155 rd_load = image_get_load(rd_hdr);
1158 #if IMAGE_ENABLE_FIT
1159 case IMAGE_FORMAT_FIT:
1160 rd_noffset = fit_image_load(images,
1161 rd_addr, &fit_uname_ramdisk,
1162 &fit_uname_config, arch,
1164 BOOTSTAGE_ID_FIT_RD_START,
1165 FIT_LOAD_OPTIONAL_NON_ZERO,
1170 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1171 images->fit_uname_rd = fit_uname_ramdisk;
1172 images->fit_noffset_rd = rd_noffset;
1175 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1176 case IMAGE_FORMAT_ANDROID:
1177 android_image_get_ramdisk((void *)images->os.start,
1182 #ifdef CONFIG_SUPPORT_RAW_INITRD
1185 end = strchr(select, ':');
1187 rd_len = simple_strtoul(++end, NULL, 16);
1192 puts("Wrong Ramdisk Image Format\n");
1193 rd_data = rd_len = rd_load = 0;
1197 } else if (images->legacy_hdr_valid &&
1198 image_check_type(&images->legacy_hdr_os_copy,
1202 * Now check if we have a legacy mult-component image,
1203 * get second entry data start address and len.
1205 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1206 printf("## Loading init Ramdisk from multi component "
1207 "Legacy Image at %08lx ...\n",
1208 (ulong)images->legacy_hdr_os);
1210 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1215 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1216 rd_len = rd_data = 0;
1220 debug("## No init Ramdisk\n");
1222 *rd_start = rd_data;
1223 *rd_end = rd_data + rd_len;
1225 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1226 *rd_start, *rd_end);
1231 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1233 * boot_ramdisk_high - relocate init ramdisk
1234 * @lmb: pointer to lmb handle, will be used for memory mgmt
1235 * @rd_data: ramdisk data start address
1236 * @rd_len: ramdisk data length
1237 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1238 * start address (after possible relocation)
1239 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1240 * end address (after possible relocation)
1242 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1243 * variable and if requested ramdisk data is moved to a specified location.
1245 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1246 * start/end addresses if ramdisk image start and len were provided,
1247 * otherwise set initrd_start and initrd_end set to zeros.
1253 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1254 ulong *initrd_start, ulong *initrd_end)
1258 int initrd_copy_to_ram = 1;
1260 s = env_get("initrd_high");
1262 /* a value of "no" or a similar string will act like 0,
1263 * turning the "load high" feature off. This is intentional.
1265 initrd_high = simple_strtoul(s, NULL, 16);
1266 if (initrd_high == ~0)
1267 initrd_copy_to_ram = 0;
1269 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1273 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1274 initrd_high, initrd_copy_to_ram);
1277 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1278 debug(" in-place initrd\n");
1279 *initrd_start = rd_data;
1280 *initrd_end = rd_data + rd_len;
1281 lmb_reserve(lmb, rd_data, rd_len);
1284 *initrd_start = (ulong)lmb_alloc_base(lmb,
1285 rd_len, 0x1000, initrd_high);
1287 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1290 if (*initrd_start == 0) {
1291 puts("ramdisk - allocation error\n");
1294 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1296 *initrd_end = *initrd_start + rd_len;
1297 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1298 *initrd_start, *initrd_end);
1300 memmove_wd((void *)*initrd_start,
1301 (void *)rd_data, rd_len, CHUNKSZ);
1305 * Ensure the image is flushed to memory to handle
1306 * AMP boot scenarios in which we might not be
1309 flush_cache((unsigned long)*initrd_start,
1310 ALIGN(rd_len, ARCH_DMA_MINALIGN));
1318 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1319 *initrd_start, *initrd_end);
1326 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1328 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1329 ulong *setup_start, ulong *setup_len)
1331 #if IMAGE_ENABLE_FIT
1332 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1338 #if IMAGE_ENABLE_FIT
1339 #if defined(CONFIG_FPGA)
1340 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1341 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1343 ulong tmp_img_addr, img_data, img_len;
1347 const char *uname, *name;
1349 int devnum = 0; /* TODO support multi fpga platforms */
1351 /* Check to see if the images struct has a FIT configuration */
1352 if (!genimg_has_config(images)) {
1353 debug("## FIT configuration was not specified\n");
1358 * Obtain the os FIT header from the images struct
1360 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1361 buf = map_sysmem(tmp_img_addr, 0);
1363 * Check image type. For FIT images get FIT node
1364 * and attempt to locate a generic binary.
1366 switch (genimg_get_format(buf)) {
1367 case IMAGE_FORMAT_FIT:
1368 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1370 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1373 debug("## FPGA image is not specified\n");
1376 fit_img_result = fit_image_load(images,
1378 (const char **)&uname,
1379 &(images->fit_uname_cfg),
1382 BOOTSTAGE_ID_FPGA_INIT,
1383 FIT_LOAD_OPTIONAL_NON_ZERO,
1384 &img_data, &img_len);
1386 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1387 uname, img_data, img_len);
1389 if (fit_img_result < 0) {
1390 /* Something went wrong! */
1391 return fit_img_result;
1394 if (!fpga_is_partial_data(devnum, img_len)) {
1396 err = fpga_loadbitstream(devnum, (char *)img_data,
1399 err = fpga_load(devnum, (const void *)img_data,
1403 err = fpga_loadbitstream(devnum, (char *)img_data,
1404 img_len, BIT_PARTIAL);
1406 err = fpga_load(devnum, (const void *)img_data,
1407 img_len, BIT_PARTIAL);
1413 printf(" Programming %s bitstream... OK\n", name);
1416 printf("The given image format is not supported (corrupt?)\n");
1424 static void fit_loadable_process(uint8_t img_type,
1429 const unsigned int count =
1430 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1431 struct fit_loadable_tbl *fit_loadable_handler =
1432 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1433 /* For each loadable handler */
1434 for (i = 0; i < count; i++, fit_loadable_handler++)
1435 /* matching this type */
1436 if (fit_loadable_handler->type == img_type)
1437 /* call that handler with this image data */
1438 fit_loadable_handler->handler(img_data, img_len);
1441 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1442 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1445 * These variables are used to hold the current image location
1450 * These two variables are requirements for fit_image_load, but
1451 * their values are not used
1453 ulong img_data, img_len;
1455 int loadables_index;
1461 /* Check to see if the images struct has a FIT configuration */
1462 if (!genimg_has_config(images)) {
1463 debug("## FIT configuration was not specified\n");
1468 * Obtain the os FIT header from the images struct
1470 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1471 buf = map_sysmem(tmp_img_addr, 0);
1473 * Check image type. For FIT images get FIT node
1474 * and attempt to locate a generic binary.
1476 switch (genimg_get_format(buf)) {
1477 case IMAGE_FORMAT_FIT:
1478 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1480 for (loadables_index = 0;
1481 uname = fdt_stringlist_get(buf, conf_noffset,
1482 FIT_LOADABLE_PROP, loadables_index,
1486 fit_img_result = fit_image_load(images,
1489 &(images->fit_uname_cfg), arch,
1491 BOOTSTAGE_ID_FIT_LOADABLE_START,
1492 FIT_LOAD_OPTIONAL_NON_ZERO,
1493 &img_data, &img_len);
1494 if (fit_img_result < 0) {
1495 /* Something went wrong! */
1496 return fit_img_result;
1499 fit_img_result = fit_image_get_node(buf, uname);
1500 if (fit_img_result < 0) {
1501 /* Something went wrong! */
1502 return fit_img_result;
1504 fit_img_result = fit_image_get_type(buf,
1507 if (fit_img_result < 0) {
1508 /* Something went wrong! */
1509 return fit_img_result;
1512 fit_loadable_process(img_type, img_data, img_len);
1516 printf("The given image format is not supported (corrupt?)\n");
1524 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1526 * boot_get_cmdline - allocate and initialize kernel cmdline
1527 * @lmb: pointer to lmb handle, will be used for memory mgmt
1528 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1529 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1531 * boot_get_cmdline() allocates space for kernel command line below
1532 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environment
1533 * variable is present its contents is copied to allocated kernel
1540 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1545 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1546 env_get_bootm_mapsize() + env_get_bootm_low());
1548 if (cmdline == NULL)
1551 s = env_get("bootargs");
1557 *cmd_start = (ulong) & cmdline[0];
1558 *cmd_end = *cmd_start + strlen(cmdline);
1560 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1564 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1566 #ifdef CONFIG_SYS_BOOT_GET_KBD
1568 * boot_get_kbd - allocate and initialize kernel copy of board info
1569 * @lmb: pointer to lmb handle, will be used for memory mgmt
1570 * @kbd: double pointer to board info data
1572 * boot_get_kbd() allocates space for kernel copy of board info data below
1573 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1574 * with the current u-boot board info data.
1580 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1582 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1583 env_get_bootm_mapsize() + env_get_bootm_low());
1589 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1591 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1592 do_bdinfo(NULL, 0, 0, NULL);
1597 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1600 int image_setup_linux(bootm_headers_t *images)
1602 ulong of_size = images->ft_len;
1603 char **of_flat_tree = &images->ft_addr;
1604 struct lmb *lmb = &images->lmb;
1607 if (IMAGE_ENABLE_OF_LIBFDT)
1608 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1610 if (IMAGE_BOOT_GET_CMDLINE) {
1611 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1612 &images->cmdline_end);
1614 puts("ERROR with allocation of cmdline\n");
1619 if (IMAGE_ENABLE_OF_LIBFDT) {
1620 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1625 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1626 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1633 #endif /* CONFIG_LMB */
1634 #endif /* !USE_HOSTCC */