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" },
179 { IH_TYPE_COPRO, "copro", "Coprocessor Image"},
183 static const table_entry_t uimage_comp[] = {
184 { IH_COMP_NONE, "none", "uncompressed", },
185 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
186 { IH_COMP_GZIP, "gzip", "gzip compressed", },
187 { IH_COMP_LZMA, "lzma", "lzma compressed", },
188 { IH_COMP_LZO, "lzo", "lzo compressed", },
189 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
196 const table_entry_t *table;
199 static const struct table_info table_info[IH_COUNT] = {
200 { "architecture", IH_ARCH_COUNT, uimage_arch },
201 { "compression", IH_COMP_COUNT, uimage_comp },
202 { "operating system", IH_OS_COUNT, uimage_os },
203 { "image type", IH_TYPE_COUNT, uimage_type },
206 /*****************************************************************************/
207 /* Legacy format routines */
208 /*****************************************************************************/
209 int image_check_hcrc(const image_header_t *hdr)
212 ulong len = image_get_header_size();
213 image_header_t header;
215 /* Copy header so we can blank CRC field for re-calculation */
216 memmove(&header, (char *)hdr, image_get_header_size());
217 image_set_hcrc(&header, 0);
219 hcrc = crc32(0, (unsigned char *)&header, len);
221 return (hcrc == image_get_hcrc(hdr));
224 int image_check_dcrc(const image_header_t *hdr)
226 ulong data = image_get_data(hdr);
227 ulong len = image_get_data_size(hdr);
228 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
230 return (dcrc == image_get_dcrc(hdr));
234 * image_multi_count - get component (sub-image) count
235 * @hdr: pointer to the header of the multi component image
237 * image_multi_count() returns number of components in a multi
240 * Note: no checking of the image type is done, caller must pass
241 * a valid multi component image.
244 * number of components
246 ulong image_multi_count(const image_header_t *hdr)
251 /* get start of the image payload, which in case of multi
252 * component images that points to a table of component sizes */
253 size = (uint32_t *)image_get_data(hdr);
255 /* count non empty slots */
256 for (i = 0; size[i]; ++i)
263 * image_multi_getimg - get component data address and size
264 * @hdr: pointer to the header of the multi component image
265 * @idx: index of the requested component
266 * @data: pointer to a ulong variable, will hold component data address
267 * @len: pointer to a ulong variable, will hold component size
269 * image_multi_getimg() returns size and data address for the requested
270 * component in a multi component image.
272 * Note: no checking of the image type is done, caller must pass
273 * a valid multi component image.
276 * data address and size of the component, if idx is valid
277 * 0 in data and len, if idx is out of range
279 void image_multi_getimg(const image_header_t *hdr, ulong idx,
280 ulong *data, ulong *len)
284 ulong offset, count, img_data;
286 /* get number of component */
287 count = image_multi_count(hdr);
289 /* get start of the image payload, which in case of multi
290 * component images that points to a table of component sizes */
291 size = (uint32_t *)image_get_data(hdr);
293 /* get address of the proper component data start, which means
294 * skipping sizes table (add 1 for last, null entry) */
295 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
298 *len = uimage_to_cpu(size[idx]);
301 /* go over all indices preceding requested component idx */
302 for (i = 0; i < idx; i++) {
303 /* add up i-th component size, rounding up to 4 bytes */
304 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
307 /* calculate idx-th component data address */
308 *data = img_data + offset;
315 static void image_print_type(const image_header_t *hdr)
317 const char __maybe_unused *os, *arch, *type, *comp;
319 os = genimg_get_os_name(image_get_os(hdr));
320 arch = genimg_get_arch_name(image_get_arch(hdr));
321 type = genimg_get_type_name(image_get_type(hdr));
322 comp = genimg_get_comp_name(image_get_comp(hdr));
324 printf("%s %s %s (%s)\n", arch, os, type, comp);
328 * image_print_contents - prints out the contents of the legacy format image
329 * @ptr: pointer to the legacy format image header
330 * @p: pointer to prefix string
332 * image_print_contents() formats a multi line legacy image contents description.
333 * The routine prints out all header fields followed by the size/offset data
334 * for MULTI/SCRIPT images.
337 * no returned results
339 void image_print_contents(const void *ptr)
341 const image_header_t *hdr = (const image_header_t *)ptr;
342 const char __maybe_unused *p;
344 p = IMAGE_INDENT_STRING;
345 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
346 if (IMAGE_ENABLE_TIMESTAMP) {
347 printf("%sCreated: ", p);
348 genimg_print_time((time_t)image_get_time(hdr));
350 printf("%sImage Type: ", p);
351 image_print_type(hdr);
352 printf("%sData Size: ", p);
353 genimg_print_size(image_get_data_size(hdr));
354 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
355 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
357 if (image_check_type(hdr, IH_TYPE_MULTI) ||
358 image_check_type(hdr, IH_TYPE_SCRIPT)) {
361 ulong count = image_multi_count(hdr);
363 printf("%sContents:\n", p);
364 for (i = 0; i < count; i++) {
365 image_multi_getimg(hdr, i, &data, &len);
367 printf("%s Image %d: ", p, i);
368 genimg_print_size(len);
370 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
372 * the user may need to know offsets
373 * if planning to do something with
376 printf("%s Offset = 0x%08lx\n", p, data);
379 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
380 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
381 image_get_load(hdr) - image_get_header_size(),
382 image_get_size(hdr) + image_get_header_size()
388 * print_decomp_msg() - Print a suitable decompression/loading message
390 * @type: OS type (IH_OS_...)
391 * @comp_type: Compression type being used (IH_COMP_...)
392 * @is_xip: true if the load address matches the image start
394 static void print_decomp_msg(int comp_type, int type, bool is_xip)
396 const char *name = genimg_get_type_name(type);
398 if (comp_type == IH_COMP_NONE)
399 printf(" %s %s\n", is_xip ? "XIP" : "Loading", name);
401 printf(" Uncompressing %s\n", name);
404 int image_decomp(int comp, ulong load, ulong image_start, int type,
405 void *load_buf, void *image_buf, ulong image_len,
406 uint unc_len, ulong *load_end)
411 print_decomp_msg(comp, type, load == image_start);
414 * Load the image to the right place, decompressing if needed. After
415 * this, image_len will be set to the number of uncompressed bytes
416 * loaded, ret will be non-zero on error.
420 if (load == image_start)
422 if (image_len <= unc_len)
423 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
429 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
432 #endif /* CONFIG_GZIP */
434 case IH_COMP_BZIP2: {
438 * If we've got less than 4 MB of malloc() space,
439 * use slower decompression algorithm which requires
440 * at most 2300 KB of memory.
442 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
443 image_buf, image_len,
444 CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
448 #endif /* CONFIG_BZIP2 */
451 SizeT lzma_len = unc_len;
453 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
454 image_buf, image_len);
455 image_len = lzma_len;
458 #endif /* CONFIG_LZMA */
461 size_t size = unc_len;
463 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
467 #endif /* CONFIG_LZO */
470 size_t size = unc_len;
472 ret = ulz4fn(image_buf, image_len, load_buf, &size);
476 #endif /* CONFIG_LZ4 */
478 printf("Unimplemented compression type %d\n", comp);
482 *load_end = load + image_len;
489 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
491 * image_get_ramdisk - get and verify ramdisk image
492 * @rd_addr: ramdisk image start address
493 * @arch: expected ramdisk architecture
494 * @verify: checksum verification flag
496 * image_get_ramdisk() returns a pointer to the verified ramdisk image
497 * header. Routine receives image start address and expected architecture
498 * flag. Verification done covers data and header integrity and os/type/arch
502 * pointer to a ramdisk image header, if image was found and valid
503 * otherwise, return NULL
505 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
508 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
510 if (!image_check_magic(rd_hdr)) {
511 puts("Bad Magic Number\n");
512 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
516 if (!image_check_hcrc(rd_hdr)) {
517 puts("Bad Header Checksum\n");
518 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
522 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
523 image_print_contents(rd_hdr);
526 puts(" Verifying Checksum ... ");
527 if (!image_check_dcrc(rd_hdr)) {
528 puts("Bad Data CRC\n");
529 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
535 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
537 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
538 !image_check_arch(rd_hdr, arch) ||
539 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
540 printf("No Linux %s Ramdisk Image\n",
541 genimg_get_arch_name(arch));
542 bootstage_error(BOOTSTAGE_ID_RAMDISK);
549 #endif /* !USE_HOSTCC */
551 /*****************************************************************************/
552 /* Shared dual-format routines */
553 /*****************************************************************************/
555 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
556 ulong save_addr; /* Default Save Address */
557 ulong save_size; /* Default Save Size (in bytes) */
559 static int on_loadaddr(const char *name, const char *value, enum env_op op,
564 case env_op_overwrite:
565 load_addr = simple_strtoul(value, NULL, 16);
573 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
575 ulong env_get_bootm_low(void)
577 char *s = env_get("bootm_low");
579 ulong tmp = simple_strtoul(s, NULL, 16);
583 #if defined(CONFIG_SYS_SDRAM_BASE)
584 return CONFIG_SYS_SDRAM_BASE;
585 #elif defined(CONFIG_ARM)
586 return gd->bd->bi_dram[0].start;
592 phys_size_t env_get_bootm_size(void)
594 phys_size_t tmp, size;
596 char *s = env_get("bootm_size");
598 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
602 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
603 start = gd->bd->bi_dram[0].start;
604 size = gd->bd->bi_dram[0].size;
606 start = gd->bd->bi_memstart;
607 size = gd->bd->bi_memsize;
610 s = env_get("bootm_low");
612 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
616 return size - (tmp - start);
619 phys_size_t env_get_bootm_mapsize(void)
622 char *s = env_get("bootm_mapsize");
624 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
628 #if defined(CONFIG_SYS_BOOTMAPSZ)
629 return CONFIG_SYS_BOOTMAPSZ;
631 return env_get_bootm_size();
635 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
640 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
646 size_t tail = (len > chunksz) ? chunksz : len;
652 memmove(to, from, tail);
659 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
660 memmove(to, from, len);
661 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
663 #else /* USE_HOSTCC */
664 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
666 memmove(to, from, len);
668 #endif /* !USE_HOSTCC */
670 void genimg_print_size(uint32_t size)
673 printf("%d Bytes = ", size);
674 print_size(size, "\n");
676 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
677 size, (double)size / 1.024e3,
678 (double)size / 1.048576e6);
682 #if IMAGE_ENABLE_TIMESTAMP
683 void genimg_print_time(time_t timestamp)
688 rtc_to_tm(timestamp, &tm);
689 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
690 tm.tm_year, tm.tm_mon, tm.tm_mday,
691 tm.tm_hour, tm.tm_min, tm.tm_sec);
693 printf("%s", ctime(×tamp));
698 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
700 for (; table->id >= 0; ++table) {
707 static const char *unknown_msg(enum ih_category category)
709 static const char unknown_str[] = "Unknown ";
712 strcpy(msg, unknown_str);
713 strncat(msg, table_info[category].desc,
714 sizeof(msg) - sizeof(unknown_str));
720 * get_cat_table_entry_name - translate entry id to long name
721 * @category: category to look up (enum ih_category)
722 * @id: entry id to be translated
724 * This will scan the translation table trying to find the entry that matches
727 * @retur long entry name if translation succeeds; error string on failure
729 const char *genimg_get_cat_name(enum ih_category category, uint id)
731 const table_entry_t *entry;
733 entry = get_table_entry(table_info[category].table, id);
735 return unknown_msg(category);
736 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
739 return entry->lname + gd->reloc_off;
744 * get_cat_table_entry_short_name - translate entry id to short name
745 * @category: category to look up (enum ih_category)
746 * @id: entry id to be translated
748 * This will scan the translation table trying to find the entry that matches
751 * @retur short entry name if translation succeeds; error string on failure
753 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
755 const table_entry_t *entry;
757 entry = get_table_entry(table_info[category].table, id);
759 return unknown_msg(category);
760 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
763 return entry->sname + gd->reloc_off;
767 int genimg_get_cat_count(enum ih_category category)
769 return table_info[category].count;
772 const char *genimg_get_cat_desc(enum ih_category category)
774 return table_info[category].desc;
778 * get_table_entry_name - translate entry id to long name
779 * @table: pointer to a translation table for entries of a specific type
780 * @msg: message to be returned when translation fails
781 * @id: entry id to be translated
783 * get_table_entry_name() will go over translation table trying to find
784 * entry that matches given id. If matching entry is found, its long
785 * name is returned to the caller.
788 * long entry name if translation succeeds
791 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
793 table = get_table_entry(table, id);
796 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
799 return table->lname + gd->reloc_off;
803 const char *genimg_get_os_name(uint8_t os)
805 return (get_table_entry_name(uimage_os, "Unknown OS", os));
808 const char *genimg_get_arch_name(uint8_t arch)
810 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
814 const char *genimg_get_type_name(uint8_t type)
816 return (get_table_entry_name(uimage_type, "Unknown Image", type));
819 static const char *genimg_get_short_name(const table_entry_t *table, int val)
821 table = get_table_entry(table, val);
824 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
827 return table->sname + gd->reloc_off;
831 const char *genimg_get_type_short_name(uint8_t type)
833 return genimg_get_short_name(uimage_type, type);
836 const char *genimg_get_comp_name(uint8_t comp)
838 return (get_table_entry_name(uimage_comp, "Unknown Compression",
842 const char *genimg_get_comp_short_name(uint8_t comp)
844 return genimg_get_short_name(uimage_comp, comp);
847 const char *genimg_get_os_short_name(uint8_t os)
849 return genimg_get_short_name(uimage_os, os);
852 const char *genimg_get_arch_short_name(uint8_t arch)
854 return genimg_get_short_name(uimage_arch, arch);
858 * get_table_entry_id - translate short entry name to id
859 * @table: pointer to a translation table for entries of a specific type
860 * @table_name: to be used in case of error
861 * @name: entry short name to be translated
863 * get_table_entry_id() will go over translation table trying to find
864 * entry that matches given short name. If matching entry is found,
865 * its id returned to the caller.
868 * entry id if translation succeeds
871 int get_table_entry_id(const table_entry_t *table,
872 const char *table_name, const char *name)
874 const table_entry_t *t;
876 for (t = table; t->id >= 0; ++t) {
877 #ifdef CONFIG_NEEDS_MANUAL_RELOC
878 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
880 if (t->sname && strcasecmp(t->sname, name) == 0)
884 debug("Invalid %s Type: %s\n", table_name, name);
889 int genimg_get_os_id(const char *name)
891 return (get_table_entry_id(uimage_os, "OS", name));
894 int genimg_get_arch_id(const char *name)
896 return (get_table_entry_id(uimage_arch, "CPU", name));
899 int genimg_get_type_id(const char *name)
901 return (get_table_entry_id(uimage_type, "Image", name));
904 int genimg_get_comp_id(const char *name)
906 return (get_table_entry_id(uimage_comp, "Compression", name));
911 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
913 * @img_addr: a string might contain real image address
914 * @fit_uname_config: double pointer to a char, will hold pointer to a
915 * configuration unit name
916 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
919 * genimg_get_kernel_addr_fit get the real kernel start address from a string
920 * which is normally the first argv of bootm/bootz
923 * kernel start address
925 ulong genimg_get_kernel_addr_fit(char * const img_addr,
926 const char **fit_uname_config,
927 const char **fit_uname_kernel)
931 /* find out kernel image address */
933 kernel_addr = load_addr;
934 debug("* kernel: default image load address = 0x%08lx\n",
936 #if CONFIG_IS_ENABLED(FIT)
937 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
939 debug("* kernel: config '%s' from image at 0x%08lx\n",
940 *fit_uname_config, kernel_addr);
941 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
943 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
944 *fit_uname_kernel, kernel_addr);
947 kernel_addr = simple_strtoul(img_addr, NULL, 16);
948 debug("* kernel: cmdline image address = 0x%08lx\n",
956 * genimg_get_kernel_addr() is the simple version of
957 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
959 ulong genimg_get_kernel_addr(char * const img_addr)
961 const char *fit_uname_config = NULL;
962 const char *fit_uname_kernel = NULL;
964 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
969 * genimg_get_format - get image format type
970 * @img_addr: image start address
972 * genimg_get_format() checks whether provided address points to a valid
973 * legacy or FIT image.
975 * New uImage format and FDT blob are based on a libfdt. FDT blob
976 * may be passed directly or embedded in a FIT image. In both situations
977 * genimg_get_format() must be able to dectect libfdt header.
980 * image format type or IMAGE_FORMAT_INVALID if no image is present
982 int genimg_get_format(const void *img_addr)
984 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
985 const image_header_t *hdr;
987 hdr = (const image_header_t *)img_addr;
988 if (image_check_magic(hdr))
989 return IMAGE_FORMAT_LEGACY;
991 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
992 if (fdt_check_header(img_addr) == 0)
993 return IMAGE_FORMAT_FIT;
995 #ifdef CONFIG_ANDROID_BOOT_IMAGE
996 if (android_image_check_header(img_addr) == 0)
997 return IMAGE_FORMAT_ANDROID;
1000 return IMAGE_FORMAT_INVALID;
1004 * fit_has_config - check if there is a valid FIT configuration
1005 * @images: pointer to the bootm command headers structure
1007 * fit_has_config() checks if there is a FIT configuration in use
1008 * (if FTI support is present).
1011 * 0, no FIT support or no configuration found
1012 * 1, configuration found
1014 int genimg_has_config(bootm_headers_t *images)
1016 #if IMAGE_ENABLE_FIT
1017 if (images->fit_uname_cfg)
1024 * boot_get_ramdisk - main ramdisk handling routine
1025 * @argc: command argument count
1026 * @argv: command argument list
1027 * @images: pointer to the bootm images structure
1028 * @arch: expected ramdisk architecture
1029 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
1030 * @rd_end: pointer to a ulong variable, will hold ramdisk end
1032 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
1033 * Curently supported are the following ramdisk sources:
1034 * - multicomponent kernel/ramdisk image,
1035 * - commandline provided address of decicated ramdisk image.
1038 * 0, if ramdisk image was found and valid, or skiped
1039 * rd_start and rd_end are set to ramdisk start/end addresses if
1040 * ramdisk image is found and valid
1042 * 1, if ramdisk image is found but corrupted, or invalid
1043 * rd_start and rd_end are set to 0 if no ramdisk exists
1045 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1046 uint8_t arch, ulong *rd_start, ulong *rd_end)
1048 ulong rd_addr, rd_load;
1049 ulong rd_data, rd_len;
1050 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1051 const image_header_t *rd_hdr;
1054 #ifdef CONFIG_SUPPORT_RAW_INITRD
1057 #if IMAGE_ENABLE_FIT
1058 const char *fit_uname_config = images->fit_uname_cfg;
1059 const char *fit_uname_ramdisk = NULL;
1063 const char *select = NULL;
1068 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1070 * Look for an Android boot image.
1072 buf = map_sysmem(images->os.start, 0);
1073 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1074 select = (argc == 0) ? env_get("loadaddr") : argv[0];
1081 * Look for a '-' which indicates to ignore the
1084 if (select && strcmp(select, "-") == 0) {
1085 debug("## Skipping init Ramdisk\n");
1086 rd_len = rd_data = 0;
1087 } else if (select || genimg_has_config(images)) {
1088 #if IMAGE_ENABLE_FIT
1091 * If the init ramdisk comes from the FIT image and
1092 * the FIT image address is omitted in the command
1093 * line argument, try to use os FIT image address or
1094 * default load address.
1096 if (images->fit_uname_os)
1097 default_addr = (ulong)images->fit_hdr_os;
1099 default_addr = load_addr;
1101 if (fit_parse_conf(select, default_addr,
1102 &rd_addr, &fit_uname_config)) {
1103 debug("* ramdisk: config '%s' from image at "
1105 fit_uname_config, rd_addr);
1106 } else if (fit_parse_subimage(select, default_addr,
1107 &rd_addr, &fit_uname_ramdisk)) {
1108 debug("* ramdisk: subimage '%s' from image at "
1110 fit_uname_ramdisk, rd_addr);
1114 rd_addr = simple_strtoul(select, NULL, 16);
1115 debug("* ramdisk: cmdline image address = "
1119 #if IMAGE_ENABLE_FIT
1121 /* use FIT configuration provided in first bootm
1122 * command argument. If the property is not defined,
1125 rd_addr = map_to_sysmem(images->fit_hdr_os);
1126 rd_noffset = fit_get_node_from_config(images,
1127 FIT_RAMDISK_PROP, rd_addr);
1128 if (rd_noffset == -ENOENT)
1130 else if (rd_noffset < 0)
1136 * Check if there is an initrd image at the
1137 * address provided in the second bootm argument
1138 * check image type, for FIT images get FIT node.
1140 buf = map_sysmem(rd_addr, 0);
1141 switch (genimg_get_format(buf)) {
1142 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1143 case IMAGE_FORMAT_LEGACY:
1144 printf("## Loading init Ramdisk from Legacy "
1145 "Image at %08lx ...\n", rd_addr);
1147 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1148 rd_hdr = image_get_ramdisk(rd_addr, arch,
1154 rd_data = image_get_data(rd_hdr);
1155 rd_len = image_get_data_size(rd_hdr);
1156 rd_load = image_get_load(rd_hdr);
1159 #if IMAGE_ENABLE_FIT
1160 case IMAGE_FORMAT_FIT:
1161 rd_noffset = fit_image_load(images,
1162 rd_addr, &fit_uname_ramdisk,
1163 &fit_uname_config, arch,
1165 BOOTSTAGE_ID_FIT_RD_START,
1166 FIT_LOAD_OPTIONAL_NON_ZERO,
1171 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1172 images->fit_uname_rd = fit_uname_ramdisk;
1173 images->fit_noffset_rd = rd_noffset;
1176 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1177 case IMAGE_FORMAT_ANDROID:
1178 android_image_get_ramdisk((void *)images->os.start,
1183 #ifdef CONFIG_SUPPORT_RAW_INITRD
1186 end = strchr(select, ':');
1188 rd_len = simple_strtoul(++end, NULL, 16);
1193 puts("Wrong Ramdisk Image Format\n");
1194 rd_data = rd_len = rd_load = 0;
1198 } else if (images->legacy_hdr_valid &&
1199 image_check_type(&images->legacy_hdr_os_copy,
1203 * Now check if we have a legacy mult-component image,
1204 * get second entry data start address and len.
1206 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1207 printf("## Loading init Ramdisk from multi component "
1208 "Legacy Image at %08lx ...\n",
1209 (ulong)images->legacy_hdr_os);
1211 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1216 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1217 rd_len = rd_data = 0;
1221 debug("## No init Ramdisk\n");
1223 *rd_start = rd_data;
1224 *rd_end = rd_data + rd_len;
1226 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1227 *rd_start, *rd_end);
1232 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1234 * boot_ramdisk_high - relocate init ramdisk
1235 * @lmb: pointer to lmb handle, will be used for memory mgmt
1236 * @rd_data: ramdisk data start address
1237 * @rd_len: ramdisk data length
1238 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1239 * start address (after possible relocation)
1240 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1241 * end address (after possible relocation)
1243 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1244 * variable and if requested ramdisk data is moved to a specified location.
1246 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1247 * start/end addresses if ramdisk image start and len were provided,
1248 * otherwise set initrd_start and initrd_end set to zeros.
1254 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1255 ulong *initrd_start, ulong *initrd_end)
1259 int initrd_copy_to_ram = 1;
1261 s = env_get("initrd_high");
1263 /* a value of "no" or a similar string will act like 0,
1264 * turning the "load high" feature off. This is intentional.
1266 initrd_high = simple_strtoul(s, NULL, 16);
1267 if (initrd_high == ~0)
1268 initrd_copy_to_ram = 0;
1270 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1274 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1275 initrd_high, initrd_copy_to_ram);
1278 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1279 debug(" in-place initrd\n");
1280 *initrd_start = rd_data;
1281 *initrd_end = rd_data + rd_len;
1282 lmb_reserve(lmb, rd_data, rd_len);
1285 *initrd_start = (ulong)lmb_alloc_base(lmb,
1286 rd_len, 0x1000, initrd_high);
1288 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1291 if (*initrd_start == 0) {
1292 puts("ramdisk - allocation error\n");
1295 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1297 *initrd_end = *initrd_start + rd_len;
1298 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1299 *initrd_start, *initrd_end);
1301 memmove_wd((void *)*initrd_start,
1302 (void *)rd_data, rd_len, CHUNKSZ);
1306 * Ensure the image is flushed to memory to handle
1307 * AMP boot scenarios in which we might not be
1310 flush_cache((unsigned long)*initrd_start,
1311 ALIGN(rd_len, ARCH_DMA_MINALIGN));
1319 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1320 *initrd_start, *initrd_end);
1327 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1329 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1330 ulong *setup_start, ulong *setup_len)
1332 #if IMAGE_ENABLE_FIT
1333 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1339 #if IMAGE_ENABLE_FIT
1340 #if defined(CONFIG_FPGA)
1341 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1342 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1344 ulong tmp_img_addr, img_data, img_len;
1348 const char *uname, *name;
1350 int devnum = 0; /* TODO support multi fpga platforms */
1352 /* Check to see if the images struct has a FIT configuration */
1353 if (!genimg_has_config(images)) {
1354 debug("## FIT configuration was not specified\n");
1359 * Obtain the os FIT header from the images struct
1361 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1362 buf = map_sysmem(tmp_img_addr, 0);
1364 * Check image type. For FIT images get FIT node
1365 * and attempt to locate a generic binary.
1367 switch (genimg_get_format(buf)) {
1368 case IMAGE_FORMAT_FIT:
1369 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1371 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1374 debug("## FPGA image is not specified\n");
1377 fit_img_result = fit_image_load(images,
1379 (const char **)&uname,
1380 &(images->fit_uname_cfg),
1383 BOOTSTAGE_ID_FPGA_INIT,
1384 FIT_LOAD_OPTIONAL_NON_ZERO,
1385 &img_data, &img_len);
1387 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1388 uname, img_data, img_len);
1390 if (fit_img_result < 0) {
1391 /* Something went wrong! */
1392 return fit_img_result;
1395 if (!fpga_is_partial_data(devnum, img_len)) {
1397 err = fpga_loadbitstream(devnum, (char *)img_data,
1400 err = fpga_load(devnum, (const void *)img_data,
1404 err = fpga_loadbitstream(devnum, (char *)img_data,
1405 img_len, BIT_PARTIAL);
1407 err = fpga_load(devnum, (const void *)img_data,
1408 img_len, BIT_PARTIAL);
1414 printf(" Programming %s bitstream... OK\n", name);
1417 printf("The given image format is not supported (corrupt?)\n");
1425 static void fit_loadable_process(uint8_t img_type,
1430 const unsigned int count =
1431 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1432 struct fit_loadable_tbl *fit_loadable_handler =
1433 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1434 /* For each loadable handler */
1435 for (i = 0; i < count; i++, fit_loadable_handler++)
1436 /* matching this type */
1437 if (fit_loadable_handler->type == img_type)
1438 /* call that handler with this image data */
1439 fit_loadable_handler->handler(img_data, img_len);
1442 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1443 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1446 * These variables are used to hold the current image location
1451 * These two variables are requirements for fit_image_load, but
1452 * their values are not used
1454 ulong img_data, img_len;
1456 int loadables_index;
1462 /* Check to see if the images struct has a FIT configuration */
1463 if (!genimg_has_config(images)) {
1464 debug("## FIT configuration was not specified\n");
1469 * Obtain the os FIT header from the images struct
1471 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1472 buf = map_sysmem(tmp_img_addr, 0);
1474 * Check image type. For FIT images get FIT node
1475 * and attempt to locate a generic binary.
1477 switch (genimg_get_format(buf)) {
1478 case IMAGE_FORMAT_FIT:
1479 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1481 for (loadables_index = 0;
1482 uname = fdt_stringlist_get(buf, conf_noffset,
1483 FIT_LOADABLE_PROP, loadables_index,
1487 fit_img_result = fit_image_load(images,
1490 &(images->fit_uname_cfg), arch,
1492 BOOTSTAGE_ID_FIT_LOADABLE_START,
1493 FIT_LOAD_OPTIONAL_NON_ZERO,
1494 &img_data, &img_len);
1495 if (fit_img_result < 0) {
1496 /* Something went wrong! */
1497 return fit_img_result;
1500 fit_img_result = fit_image_get_node(buf, uname);
1501 if (fit_img_result < 0) {
1502 /* Something went wrong! */
1503 return fit_img_result;
1505 fit_img_result = fit_image_get_type(buf,
1508 if (fit_img_result < 0) {
1509 /* Something went wrong! */
1510 return fit_img_result;
1513 fit_loadable_process(img_type, img_data, img_len);
1517 printf("The given image format is not supported (corrupt?)\n");
1525 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1527 * boot_get_cmdline - allocate and initialize kernel cmdline
1528 * @lmb: pointer to lmb handle, will be used for memory mgmt
1529 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1530 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1532 * boot_get_cmdline() allocates space for kernel command line below
1533 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environment
1534 * variable is present its contents is copied to allocated kernel
1541 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1546 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1547 env_get_bootm_mapsize() + env_get_bootm_low());
1549 if (cmdline == NULL)
1552 s = env_get("bootargs");
1558 *cmd_start = (ulong) & cmdline[0];
1559 *cmd_end = *cmd_start + strlen(cmdline);
1561 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1565 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1567 #ifdef CONFIG_SYS_BOOT_GET_KBD
1569 * boot_get_kbd - allocate and initialize kernel copy of board info
1570 * @lmb: pointer to lmb handle, will be used for memory mgmt
1571 * @kbd: double pointer to board info data
1573 * boot_get_kbd() allocates space for kernel copy of board info data below
1574 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1575 * with the current u-boot board info data.
1581 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1583 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1584 env_get_bootm_mapsize() + env_get_bootm_low());
1590 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1592 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1593 do_bdinfo(NULL, 0, 0, NULL);
1598 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1601 int image_setup_linux(bootm_headers_t *images)
1603 ulong of_size = images->ft_len;
1604 char **of_flat_tree = &images->ft_addr;
1605 struct lmb *lmb = &images->lmb;
1608 if (IMAGE_ENABLE_OF_LIBFDT)
1609 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1611 if (IMAGE_BOOT_GET_CMDLINE) {
1612 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1613 &images->cmdline_end);
1615 puts("ERROR with allocation of cmdline\n");
1620 if (IMAGE_ENABLE_OF_LIBFDT) {
1621 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1626 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1627 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1634 #endif /* CONFIG_LMB */
1635 #endif /* !USE_HOSTCC */