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.
13 #include <u-boot/crc.h>
16 #ifdef CONFIG_SHOW_BOOT_PROGRESS
17 #include <status_led.h>
27 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
28 #include <linux/libfdt.h>
29 #include <fdt_support.h>
34 #include <u-boot/md5.h>
35 #include <u-boot/sha1.h>
36 #include <linux/errno.h>
40 #include <linux/lzo.h>
41 #include <lzma/LzmaTypes.h>
42 #include <lzma/LzmaDec.h>
43 #include <lzma/LzmaTools.h>
46 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
49 DECLARE_GLOBAL_DATA_PTR;
51 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
52 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
57 #include <u-boot/md5.h>
61 #ifndef __maybe_unused
62 # define __maybe_unused /* unimplemented */
64 #endif /* !USE_HOSTCC*/
66 #include <u-boot/crc.h>
69 #ifndef CONFIG_SYS_BARGSIZE
70 #define CONFIG_SYS_BARGSIZE 512
73 static const table_entry_t uimage_arch[] = {
74 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
75 { IH_ARCH_ALPHA, "alpha", "Alpha", },
76 { IH_ARCH_ARM, "arm", "ARM", },
77 { IH_ARCH_I386, "x86", "Intel x86", },
78 { IH_ARCH_IA64, "ia64", "IA64", },
79 { IH_ARCH_M68K, "m68k", "M68K", },
80 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
81 { IH_ARCH_MIPS, "mips", "MIPS", },
82 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
83 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
84 { IH_ARCH_PPC, "powerpc", "PowerPC", },
85 { IH_ARCH_PPC, "ppc", "PowerPC", },
86 { IH_ARCH_S390, "s390", "IBM S390", },
87 { IH_ARCH_SH, "sh", "SuperH", },
88 { IH_ARCH_SPARC, "sparc", "SPARC", },
89 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
90 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
91 { IH_ARCH_AVR32, "avr32", "AVR32", },
92 { IH_ARCH_NDS32, "nds32", "NDS32", },
93 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
94 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
95 { IH_ARCH_ARM64, "arm64", "AArch64", },
96 { IH_ARCH_ARC, "arc", "ARC", },
97 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
98 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
99 { IH_ARCH_RISCV, "riscv", "RISC-V", },
103 static const table_entry_t uimage_os[] = {
104 { IH_OS_INVALID, "invalid", "Invalid OS", },
105 { IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware" },
106 { IH_OS_LINUX, "linux", "Linux", },
107 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
108 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
110 { IH_OS_NETBSD, "netbsd", "NetBSD", },
111 { IH_OS_OSE, "ose", "Enea OSE", },
112 { IH_OS_PLAN9, "plan9", "Plan 9", },
113 { IH_OS_RTEMS, "rtems", "RTEMS", },
114 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
115 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
116 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
117 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
118 { IH_OS_QNX, "qnx", "QNX", },
120 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
121 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
124 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
125 { IH_OS_DELL, "dell", "Dell", },
126 { IH_OS_ESIX, "esix", "Esix", },
127 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
128 { IH_OS_IRIX, "irix", "Irix", },
129 { IH_OS_NCR, "ncr", "NCR", },
130 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
131 { IH_OS_PSOS, "psos", "pSOS", },
132 { IH_OS_SCO, "sco", "SCO", },
133 { IH_OS_SOLARIS, "solaris", "Solaris", },
134 { IH_OS_SVR4, "svr4", "SVR4", },
136 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
137 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
139 { IH_OS_OPENSBI, "opensbi", "RISC-V OpenSBI", },
140 { IH_OS_EFI, "efi", "EFI Firmware" },
145 static const table_entry_t uimage_type[] = {
146 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
147 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
148 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
149 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
150 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
151 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
152 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
153 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
154 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
155 { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
156 { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
157 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
158 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
159 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
160 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
161 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
162 { IH_TYPE_SCRIPT, "script", "Script", },
163 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
164 { IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
165 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
166 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
167 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
168 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
169 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
170 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
171 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
172 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
173 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
174 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
175 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
176 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
177 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
178 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
179 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
180 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
181 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
182 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
183 { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
184 { IH_TYPE_COPRO, "copro", "Coprocessor Image"},
188 static const table_entry_t uimage_comp[] = {
189 { IH_COMP_NONE, "none", "uncompressed", },
190 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
191 { IH_COMP_GZIP, "gzip", "gzip compressed", },
192 { IH_COMP_LZMA, "lzma", "lzma compressed", },
193 { IH_COMP_LZO, "lzo", "lzo compressed", },
194 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
201 const table_entry_t *table;
204 static const struct table_info table_info[IH_COUNT] = {
205 { "architecture", IH_ARCH_COUNT, uimage_arch },
206 { "compression", IH_COMP_COUNT, uimage_comp },
207 { "operating system", IH_OS_COUNT, uimage_os },
208 { "image type", IH_TYPE_COUNT, uimage_type },
211 /*****************************************************************************/
212 /* Legacy format routines */
213 /*****************************************************************************/
214 int image_check_hcrc(const image_header_t *hdr)
217 ulong len = image_get_header_size();
218 image_header_t header;
220 /* Copy header so we can blank CRC field for re-calculation */
221 memmove(&header, (char *)hdr, image_get_header_size());
222 image_set_hcrc(&header, 0);
224 hcrc = crc32(0, (unsigned char *)&header, len);
226 return (hcrc == image_get_hcrc(hdr));
229 int image_check_dcrc(const image_header_t *hdr)
231 ulong data = image_get_data(hdr);
232 ulong len = image_get_data_size(hdr);
233 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
235 return (dcrc == image_get_dcrc(hdr));
239 * image_multi_count - get component (sub-image) count
240 * @hdr: pointer to the header of the multi component image
242 * image_multi_count() returns number of components in a multi
245 * Note: no checking of the image type is done, caller must pass
246 * a valid multi component image.
249 * number of components
251 ulong image_multi_count(const image_header_t *hdr)
256 /* get start of the image payload, which in case of multi
257 * component images that points to a table of component sizes */
258 size = (uint32_t *)image_get_data(hdr);
260 /* count non empty slots */
261 for (i = 0; size[i]; ++i)
268 * image_multi_getimg - get component data address and size
269 * @hdr: pointer to the header of the multi component image
270 * @idx: index of the requested component
271 * @data: pointer to a ulong variable, will hold component data address
272 * @len: pointer to a ulong variable, will hold component size
274 * image_multi_getimg() returns size and data address for the requested
275 * component in a multi component image.
277 * Note: no checking of the image type is done, caller must pass
278 * a valid multi component image.
281 * data address and size of the component, if idx is valid
282 * 0 in data and len, if idx is out of range
284 void image_multi_getimg(const image_header_t *hdr, ulong idx,
285 ulong *data, ulong *len)
289 ulong offset, count, img_data;
291 /* get number of component */
292 count = image_multi_count(hdr);
294 /* get start of the image payload, which in case of multi
295 * component images that points to a table of component sizes */
296 size = (uint32_t *)image_get_data(hdr);
298 /* get address of the proper component data start, which means
299 * skipping sizes table (add 1 for last, null entry) */
300 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
303 *len = uimage_to_cpu(size[idx]);
306 /* go over all indices preceding requested component idx */
307 for (i = 0; i < idx; i++) {
308 /* add up i-th component size, rounding up to 4 bytes */
309 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
312 /* calculate idx-th component data address */
313 *data = img_data + offset;
320 static void image_print_type(const image_header_t *hdr)
322 const char __maybe_unused *os, *arch, *type, *comp;
324 os = genimg_get_os_name(image_get_os(hdr));
325 arch = genimg_get_arch_name(image_get_arch(hdr));
326 type = genimg_get_type_name(image_get_type(hdr));
327 comp = genimg_get_comp_name(image_get_comp(hdr));
329 printf("%s %s %s (%s)\n", arch, os, type, comp);
333 * image_print_contents - prints out the contents of the legacy format image
334 * @ptr: pointer to the legacy format image header
335 * @p: pointer to prefix string
337 * image_print_contents() formats a multi line legacy image contents description.
338 * The routine prints out all header fields followed by the size/offset data
339 * for MULTI/SCRIPT images.
342 * no returned results
344 void image_print_contents(const void *ptr)
346 const image_header_t *hdr = (const image_header_t *)ptr;
347 const char __maybe_unused *p;
349 p = IMAGE_INDENT_STRING;
350 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
351 if (IMAGE_ENABLE_TIMESTAMP) {
352 printf("%sCreated: ", p);
353 genimg_print_time((time_t)image_get_time(hdr));
355 printf("%sImage Type: ", p);
356 image_print_type(hdr);
357 printf("%sData Size: ", p);
358 genimg_print_size(image_get_data_size(hdr));
359 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
360 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
362 if (image_check_type(hdr, IH_TYPE_MULTI) ||
363 image_check_type(hdr, IH_TYPE_SCRIPT)) {
366 ulong count = image_multi_count(hdr);
368 printf("%sContents:\n", p);
369 for (i = 0; i < count; i++) {
370 image_multi_getimg(hdr, i, &data, &len);
372 printf("%s Image %d: ", p, i);
373 genimg_print_size(len);
375 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
377 * the user may need to know offsets
378 * if planning to do something with
381 printf("%s Offset = 0x%08lx\n", p, data);
384 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
385 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
386 image_get_load(hdr) - image_get_header_size(),
387 (int)(image_get_size(hdr) + image_get_header_size()
388 + sizeof(flash_header_v2_t) - 0x2060));
393 * print_decomp_msg() - Print a suitable decompression/loading message
395 * @type: OS type (IH_OS_...)
396 * @comp_type: Compression type being used (IH_COMP_...)
397 * @is_xip: true if the load address matches the image start
399 static void print_decomp_msg(int comp_type, int type, bool is_xip)
401 const char *name = genimg_get_type_name(type);
403 if (comp_type == IH_COMP_NONE)
404 printf(" %s %s\n", is_xip ? "XIP" : "Loading", name);
406 printf(" Uncompressing %s\n", name);
409 int image_decomp(int comp, ulong load, ulong image_start, int type,
410 void *load_buf, void *image_buf, ulong image_len,
411 uint unc_len, ulong *load_end)
416 print_decomp_msg(comp, type, load == image_start);
419 * Load the image to the right place, decompressing if needed. After
420 * this, image_len will be set to the number of uncompressed bytes
421 * loaded, ret will be non-zero on error.
425 if (load == image_start)
427 if (image_len <= unc_len)
428 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
434 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
437 #endif /* CONFIG_GZIP */
439 case IH_COMP_BZIP2: {
443 * If we've got less than 4 MB of malloc() space,
444 * use slower decompression algorithm which requires
445 * at most 2300 KB of memory.
447 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
448 image_buf, image_len,
449 CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
453 #endif /* CONFIG_BZIP2 */
456 SizeT lzma_len = unc_len;
458 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
459 image_buf, image_len);
460 image_len = lzma_len;
463 #endif /* CONFIG_LZMA */
466 size_t size = unc_len;
468 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
472 #endif /* CONFIG_LZO */
475 size_t size = unc_len;
477 ret = ulz4fn(image_buf, image_len, load_buf, &size);
481 #endif /* CONFIG_LZ4 */
483 printf("Unimplemented compression type %d\n", comp);
487 *load_end = load + image_len;
494 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
496 * image_get_ramdisk - get and verify ramdisk image
497 * @rd_addr: ramdisk image start address
498 * @arch: expected ramdisk architecture
499 * @verify: checksum verification flag
501 * image_get_ramdisk() returns a pointer to the verified ramdisk image
502 * header. Routine receives image start address and expected architecture
503 * flag. Verification done covers data and header integrity and os/type/arch
507 * pointer to a ramdisk image header, if image was found and valid
508 * otherwise, return NULL
510 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
513 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
515 if (!image_check_magic(rd_hdr)) {
516 puts("Bad Magic Number\n");
517 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
521 if (!image_check_hcrc(rd_hdr)) {
522 puts("Bad Header Checksum\n");
523 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
527 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
528 image_print_contents(rd_hdr);
531 puts(" Verifying Checksum ... ");
532 if (!image_check_dcrc(rd_hdr)) {
533 puts("Bad Data CRC\n");
534 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
540 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
542 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
543 !image_check_arch(rd_hdr, arch) ||
544 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
545 printf("No Linux %s Ramdisk Image\n",
546 genimg_get_arch_name(arch));
547 bootstage_error(BOOTSTAGE_ID_RAMDISK);
554 #endif /* !USE_HOSTCC */
556 /*****************************************************************************/
557 /* Shared dual-format routines */
558 /*****************************************************************************/
560 ulong image_load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
561 ulong image_save_addr; /* Default Save Address */
562 ulong image_save_size; /* Default Save Size (in bytes) */
564 static int on_loadaddr(const char *name, const char *value, enum env_op op,
569 case env_op_overwrite:
570 image_load_addr = simple_strtoul(value, NULL, 16);
578 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
580 ulong env_get_bootm_low(void)
582 char *s = env_get("bootm_low");
584 ulong tmp = simple_strtoul(s, NULL, 16);
588 #if defined(CONFIG_SYS_SDRAM_BASE)
589 return CONFIG_SYS_SDRAM_BASE;
590 #elif defined(CONFIG_ARM) || defined(CONFIG_MICROBLAZE)
591 return gd->bd->bi_dram[0].start;
597 phys_size_t env_get_bootm_size(void)
599 phys_size_t tmp, size;
601 char *s = env_get("bootm_size");
603 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
607 #if (defined(CONFIG_ARM) || defined(CONFIG_MICROBLAZE)) && \
608 defined(CONFIG_NR_DRAM_BANKS)
609 start = gd->bd->bi_dram[0].start;
610 size = gd->bd->bi_dram[0].size;
612 start = gd->bd->bi_memstart;
613 size = gd->bd->bi_memsize;
616 s = env_get("bootm_low");
618 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
622 return size - (tmp - start);
625 phys_size_t env_get_bootm_mapsize(void)
628 char *s = env_get("bootm_mapsize");
630 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
634 #if defined(CONFIG_SYS_BOOTMAPSZ)
635 return CONFIG_SYS_BOOTMAPSZ;
637 return env_get_bootm_size();
641 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
646 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
652 size_t tail = (len > chunksz) ? chunksz : len;
658 memmove(to, from, tail);
665 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
666 memmove(to, from, len);
667 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
669 #else /* USE_HOSTCC */
670 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
672 memmove(to, from, len);
674 #endif /* !USE_HOSTCC */
676 void genimg_print_size(uint32_t size)
679 printf("%d Bytes = ", size);
680 print_size(size, "\n");
682 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
683 size, (double)size / 1.024e3,
684 (double)size / 1.048576e6);
688 #if IMAGE_ENABLE_TIMESTAMP
689 void genimg_print_time(time_t timestamp)
694 rtc_to_tm(timestamp, &tm);
695 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
696 tm.tm_year, tm.tm_mon, tm.tm_mday,
697 tm.tm_hour, tm.tm_min, tm.tm_sec);
699 printf("%s", ctime(×tamp));
704 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
706 for (; table->id >= 0; ++table) {
713 static const char *unknown_msg(enum ih_category category)
715 static const char unknown_str[] = "Unknown ";
718 strcpy(msg, unknown_str);
719 strncat(msg, table_info[category].desc,
720 sizeof(msg) - sizeof(unknown_str));
726 * get_cat_table_entry_name - translate entry id to long name
727 * @category: category to look up (enum ih_category)
728 * @id: entry id to be translated
730 * This will scan the translation table trying to find the entry that matches
733 * @retur long entry name if translation succeeds; error string on failure
735 const char *genimg_get_cat_name(enum ih_category category, uint id)
737 const table_entry_t *entry;
739 entry = get_table_entry(table_info[category].table, id);
741 return unknown_msg(category);
742 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
745 return entry->lname + gd->reloc_off;
750 * get_cat_table_entry_short_name - translate entry id to short name
751 * @category: category to look up (enum ih_category)
752 * @id: entry id to be translated
754 * This will scan the translation table trying to find the entry that matches
757 * @retur short entry name if translation succeeds; error string on failure
759 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
761 const table_entry_t *entry;
763 entry = get_table_entry(table_info[category].table, id);
765 return unknown_msg(category);
766 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
769 return entry->sname + gd->reloc_off;
773 int genimg_get_cat_count(enum ih_category category)
775 return table_info[category].count;
778 const char *genimg_get_cat_desc(enum ih_category category)
780 return table_info[category].desc;
784 * get_table_entry_name - translate entry id to long name
785 * @table: pointer to a translation table for entries of a specific type
786 * @msg: message to be returned when translation fails
787 * @id: entry id to be translated
789 * get_table_entry_name() will go over translation table trying to find
790 * entry that matches given id. If matching entry is found, its long
791 * name is returned to the caller.
794 * long entry name if translation succeeds
797 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
799 table = get_table_entry(table, id);
802 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
805 return table->lname + gd->reloc_off;
809 const char *genimg_get_os_name(uint8_t os)
811 return (get_table_entry_name(uimage_os, "Unknown OS", os));
814 const char *genimg_get_arch_name(uint8_t arch)
816 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
820 const char *genimg_get_type_name(uint8_t type)
822 return (get_table_entry_name(uimage_type, "Unknown Image", type));
825 static const char *genimg_get_short_name(const table_entry_t *table, int val)
827 table = get_table_entry(table, val);
830 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
833 return table->sname + gd->reloc_off;
837 const char *genimg_get_type_short_name(uint8_t type)
839 return genimg_get_short_name(uimage_type, type);
842 const char *genimg_get_comp_name(uint8_t comp)
844 return (get_table_entry_name(uimage_comp, "Unknown Compression",
848 const char *genimg_get_comp_short_name(uint8_t comp)
850 return genimg_get_short_name(uimage_comp, comp);
853 const char *genimg_get_os_short_name(uint8_t os)
855 return genimg_get_short_name(uimage_os, os);
858 const char *genimg_get_arch_short_name(uint8_t arch)
860 return genimg_get_short_name(uimage_arch, arch);
864 * get_table_entry_id - translate short entry name to id
865 * @table: pointer to a translation table for entries of a specific type
866 * @table_name: to be used in case of error
867 * @name: entry short name to be translated
869 * get_table_entry_id() will go over translation table trying to find
870 * entry that matches given short name. If matching entry is found,
871 * its id returned to the caller.
874 * entry id if translation succeeds
877 int get_table_entry_id(const table_entry_t *table,
878 const char *table_name, const char *name)
880 const table_entry_t *t;
882 for (t = table; t->id >= 0; ++t) {
883 #ifdef CONFIG_NEEDS_MANUAL_RELOC
884 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
886 if (t->sname && strcasecmp(t->sname, name) == 0)
890 debug("Invalid %s Type: %s\n", table_name, name);
895 int genimg_get_os_id(const char *name)
897 return (get_table_entry_id(uimage_os, "OS", name));
900 int genimg_get_arch_id(const char *name)
902 return (get_table_entry_id(uimage_arch, "CPU", name));
905 int genimg_get_type_id(const char *name)
907 return (get_table_entry_id(uimage_type, "Image", name));
910 int genimg_get_comp_id(const char *name)
912 return (get_table_entry_id(uimage_comp, "Compression", name));
917 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
919 * @img_addr: a string might contain real image address
920 * @fit_uname_config: double pointer to a char, will hold pointer to a
921 * configuration unit name
922 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
925 * genimg_get_kernel_addr_fit get the real kernel start address from a string
926 * which is normally the first argv of bootm/bootz
929 * kernel start address
931 ulong genimg_get_kernel_addr_fit(char * const img_addr,
932 const char **fit_uname_config,
933 const char **fit_uname_kernel)
937 /* find out kernel image address */
939 kernel_addr = image_load_addr;
940 debug("* kernel: default image load address = 0x%08lx\n",
942 #if CONFIG_IS_ENABLED(FIT)
943 } else if (fit_parse_conf(img_addr, image_load_addr, &kernel_addr,
945 debug("* kernel: config '%s' from image at 0x%08lx\n",
946 *fit_uname_config, kernel_addr);
947 } else if (fit_parse_subimage(img_addr, image_load_addr, &kernel_addr,
949 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
950 *fit_uname_kernel, kernel_addr);
953 kernel_addr = simple_strtoul(img_addr, NULL, 16);
954 debug("* kernel: cmdline image address = 0x%08lx\n",
962 * genimg_get_kernel_addr() is the simple version of
963 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
965 ulong genimg_get_kernel_addr(char * const img_addr)
967 const char *fit_uname_config = NULL;
968 const char *fit_uname_kernel = NULL;
970 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
975 * genimg_get_format - get image format type
976 * @img_addr: image start address
978 * genimg_get_format() checks whether provided address points to a valid
979 * legacy or FIT image.
981 * New uImage format and FDT blob are based on a libfdt. FDT blob
982 * may be passed directly or embedded in a FIT image. In both situations
983 * genimg_get_format() must be able to dectect libfdt header.
986 * image format type or IMAGE_FORMAT_INVALID if no image is present
988 int genimg_get_format(const void *img_addr)
990 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
991 const image_header_t *hdr;
993 hdr = (const image_header_t *)img_addr;
994 if (image_check_magic(hdr))
995 return IMAGE_FORMAT_LEGACY;
997 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
998 if (fdt_check_header(img_addr) == 0)
999 return IMAGE_FORMAT_FIT;
1001 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1002 if (android_image_check_header(img_addr) == 0)
1003 return IMAGE_FORMAT_ANDROID;
1006 return IMAGE_FORMAT_INVALID;
1010 * fit_has_config - check if there is a valid FIT configuration
1011 * @images: pointer to the bootm command headers structure
1013 * fit_has_config() checks if there is a FIT configuration in use
1014 * (if FTI support is present).
1017 * 0, no FIT support or no configuration found
1018 * 1, configuration found
1020 int genimg_has_config(bootm_headers_t *images)
1022 #if IMAGE_ENABLE_FIT
1023 if (images->fit_uname_cfg)
1030 * boot_get_ramdisk - main ramdisk handling routine
1031 * @argc: command argument count
1032 * @argv: command argument list
1033 * @images: pointer to the bootm images structure
1034 * @arch: expected ramdisk architecture
1035 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
1036 * @rd_end: pointer to a ulong variable, will hold ramdisk end
1038 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
1039 * Curently supported are the following ramdisk sources:
1040 * - multicomponent kernel/ramdisk image,
1041 * - commandline provided address of decicated ramdisk image.
1044 * 0, if ramdisk image was found and valid, or skiped
1045 * rd_start and rd_end are set to ramdisk start/end addresses if
1046 * ramdisk image is found and valid
1048 * 1, if ramdisk image is found but corrupted, or invalid
1049 * rd_start and rd_end are set to 0 if no ramdisk exists
1051 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1052 uint8_t arch, ulong *rd_start, ulong *rd_end)
1054 ulong rd_addr, rd_load;
1055 ulong rd_data, rd_len;
1056 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1057 const image_header_t *rd_hdr;
1060 #ifdef CONFIG_SUPPORT_RAW_INITRD
1063 #if IMAGE_ENABLE_FIT
1064 const char *fit_uname_config = images->fit_uname_cfg;
1065 const char *fit_uname_ramdisk = NULL;
1069 const char *select = NULL;
1074 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1076 * Look for an Android boot image.
1078 buf = map_sysmem(images->os.start, 0);
1079 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1080 select = (argc == 0) ? env_get("loadaddr") : argv[0];
1087 * Look for a '-' which indicates to ignore the
1090 if (select && strcmp(select, "-") == 0) {
1091 debug("## Skipping init Ramdisk\n");
1092 rd_len = rd_data = 0;
1093 } else if (select || genimg_has_config(images)) {
1094 #if IMAGE_ENABLE_FIT
1097 * If the init ramdisk comes from the FIT image and
1098 * the FIT image address is omitted in the command
1099 * line argument, try to use os FIT image address or
1100 * default load address.
1102 if (images->fit_uname_os)
1103 default_addr = (ulong)images->fit_hdr_os;
1105 default_addr = image_load_addr;
1107 if (fit_parse_conf(select, default_addr,
1108 &rd_addr, &fit_uname_config)) {
1109 debug("* ramdisk: config '%s' from image at "
1111 fit_uname_config, rd_addr);
1112 } else if (fit_parse_subimage(select, default_addr,
1113 &rd_addr, &fit_uname_ramdisk)) {
1114 debug("* ramdisk: subimage '%s' from image at "
1116 fit_uname_ramdisk, rd_addr);
1120 rd_addr = simple_strtoul(select, NULL, 16);
1121 debug("* ramdisk: cmdline image address = "
1125 #if IMAGE_ENABLE_FIT
1127 /* use FIT configuration provided in first bootm
1128 * command argument. If the property is not defined,
1131 rd_addr = map_to_sysmem(images->fit_hdr_os);
1132 rd_noffset = fit_get_node_from_config(images,
1133 FIT_RAMDISK_PROP, rd_addr);
1134 if (rd_noffset == -ENOENT)
1136 else if (rd_noffset < 0)
1142 * Check if there is an initrd image at the
1143 * address provided in the second bootm argument
1144 * check image type, for FIT images get FIT node.
1146 buf = map_sysmem(rd_addr, 0);
1147 switch (genimg_get_format(buf)) {
1148 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1149 case IMAGE_FORMAT_LEGACY:
1150 printf("## Loading init Ramdisk from Legacy "
1151 "Image at %08lx ...\n", rd_addr);
1153 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1154 rd_hdr = image_get_ramdisk(rd_addr, arch,
1160 rd_data = image_get_data(rd_hdr);
1161 rd_len = image_get_data_size(rd_hdr);
1162 rd_load = image_get_load(rd_hdr);
1165 #if IMAGE_ENABLE_FIT
1166 case IMAGE_FORMAT_FIT:
1167 rd_noffset = fit_image_load(images,
1168 rd_addr, &fit_uname_ramdisk,
1169 &fit_uname_config, arch,
1171 BOOTSTAGE_ID_FIT_RD_START,
1172 FIT_LOAD_OPTIONAL_NON_ZERO,
1177 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1178 images->fit_uname_rd = fit_uname_ramdisk;
1179 images->fit_noffset_rd = rd_noffset;
1182 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1183 case IMAGE_FORMAT_ANDROID:
1184 android_image_get_ramdisk((void *)images->os.start,
1189 #ifdef CONFIG_SUPPORT_RAW_INITRD
1192 end = strchr(select, ':');
1194 rd_len = simple_strtoul(++end, NULL, 16);
1199 puts("Wrong Ramdisk Image Format\n");
1200 rd_data = rd_len = rd_load = 0;
1204 } else if (images->legacy_hdr_valid &&
1205 image_check_type(&images->legacy_hdr_os_copy,
1209 * Now check if we have a legacy mult-component image,
1210 * get second entry data start address and len.
1212 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1213 printf("## Loading init Ramdisk from multi component "
1214 "Legacy Image at %08lx ...\n",
1215 (ulong)images->legacy_hdr_os);
1217 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1222 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1223 rd_len = rd_data = 0;
1227 debug("## No init Ramdisk\n");
1229 *rd_start = rd_data;
1230 *rd_end = rd_data + rd_len;
1232 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1233 *rd_start, *rd_end);
1238 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1240 * boot_ramdisk_high - relocate init ramdisk
1241 * @lmb: pointer to lmb handle, will be used for memory mgmt
1242 * @rd_data: ramdisk data start address
1243 * @rd_len: ramdisk data length
1244 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1245 * start address (after possible relocation)
1246 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1247 * end address (after possible relocation)
1249 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1250 * variable and if requested ramdisk data is moved to a specified location.
1252 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1253 * start/end addresses if ramdisk image start and len were provided,
1254 * otherwise set initrd_start and initrd_end set to zeros.
1260 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1261 ulong *initrd_start, ulong *initrd_end)
1265 int initrd_copy_to_ram = 1;
1267 s = env_get("initrd_high");
1269 /* a value of "no" or a similar string will act like 0,
1270 * turning the "load high" feature off. This is intentional.
1272 initrd_high = simple_strtoul(s, NULL, 16);
1273 if (initrd_high == ~0)
1274 initrd_copy_to_ram = 0;
1276 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1280 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1281 initrd_high, initrd_copy_to_ram);
1284 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1285 debug(" in-place initrd\n");
1286 *initrd_start = rd_data;
1287 *initrd_end = rd_data + rd_len;
1288 lmb_reserve(lmb, rd_data, rd_len);
1291 *initrd_start = (ulong)lmb_alloc_base(lmb,
1292 rd_len, 0x1000, initrd_high);
1294 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1297 if (*initrd_start == 0) {
1298 puts("ramdisk - allocation error\n");
1301 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1303 *initrd_end = *initrd_start + rd_len;
1304 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1305 *initrd_start, *initrd_end);
1307 memmove_wd((void *)*initrd_start,
1308 (void *)rd_data, rd_len, CHUNKSZ);
1312 * Ensure the image is flushed to memory to handle
1313 * AMP boot scenarios in which we might not be
1316 flush_cache((unsigned long)*initrd_start,
1317 ALIGN(rd_len, ARCH_DMA_MINALIGN));
1325 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1326 *initrd_start, *initrd_end);
1333 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1335 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1336 ulong *setup_start, ulong *setup_len)
1338 #if IMAGE_ENABLE_FIT
1339 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1345 #if IMAGE_ENABLE_FIT
1346 #if defined(CONFIG_FPGA)
1347 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1348 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1350 ulong tmp_img_addr, img_data, img_len;
1354 const char *uname, *name;
1356 int devnum = 0; /* TODO support multi fpga platforms */
1358 /* Check to see if the images struct has a FIT configuration */
1359 if (!genimg_has_config(images)) {
1360 debug("## FIT configuration was not specified\n");
1365 * Obtain the os FIT header from the images struct
1367 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1368 buf = map_sysmem(tmp_img_addr, 0);
1370 * Check image type. For FIT images get FIT node
1371 * and attempt to locate a generic binary.
1373 switch (genimg_get_format(buf)) {
1374 case IMAGE_FORMAT_FIT:
1375 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1377 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1380 debug("## FPGA image is not specified\n");
1383 fit_img_result = fit_image_load(images,
1385 (const char **)&uname,
1386 &(images->fit_uname_cfg),
1389 BOOTSTAGE_ID_FPGA_INIT,
1390 FIT_LOAD_OPTIONAL_NON_ZERO,
1391 &img_data, &img_len);
1393 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1394 uname, img_data, img_len);
1396 if (fit_img_result < 0) {
1397 /* Something went wrong! */
1398 return fit_img_result;
1401 if (!fpga_is_partial_data(devnum, img_len)) {
1403 err = fpga_loadbitstream(devnum, (char *)img_data,
1406 err = fpga_load(devnum, (const void *)img_data,
1410 err = fpga_loadbitstream(devnum, (char *)img_data,
1411 img_len, BIT_PARTIAL);
1413 err = fpga_load(devnum, (const void *)img_data,
1414 img_len, BIT_PARTIAL);
1420 printf(" Programming %s bitstream... OK\n", name);
1423 printf("The given image format is not supported (corrupt?)\n");
1431 static void fit_loadable_process(uint8_t img_type,
1436 const unsigned int count =
1437 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1438 struct fit_loadable_tbl *fit_loadable_handler =
1439 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1440 /* For each loadable handler */
1441 for (i = 0; i < count; i++, fit_loadable_handler++)
1442 /* matching this type */
1443 if (fit_loadable_handler->type == img_type)
1444 /* call that handler with this image data */
1445 fit_loadable_handler->handler(img_data, img_len);
1448 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1449 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1452 * These variables are used to hold the current image location
1457 * These two variables are requirements for fit_image_load, but
1458 * their values are not used
1460 ulong img_data, img_len;
1462 int loadables_index;
1468 /* Check to see if the images struct has a FIT configuration */
1469 if (!genimg_has_config(images)) {
1470 debug("## FIT configuration was not specified\n");
1475 * Obtain the os FIT header from the images struct
1477 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1478 buf = map_sysmem(tmp_img_addr, 0);
1480 * Check image type. For FIT images get FIT node
1481 * and attempt to locate a generic binary.
1483 switch (genimg_get_format(buf)) {
1484 case IMAGE_FORMAT_FIT:
1485 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1487 for (loadables_index = 0;
1488 uname = fdt_stringlist_get(buf, conf_noffset,
1489 FIT_LOADABLE_PROP, loadables_index,
1493 fit_img_result = fit_image_load(images,
1496 &(images->fit_uname_cfg), arch,
1498 BOOTSTAGE_ID_FIT_LOADABLE_START,
1499 FIT_LOAD_OPTIONAL_NON_ZERO,
1500 &img_data, &img_len);
1501 if (fit_img_result < 0) {
1502 /* Something went wrong! */
1503 return fit_img_result;
1506 fit_img_result = fit_image_get_node(buf, uname);
1507 if (fit_img_result < 0) {
1508 /* Something went wrong! */
1509 return fit_img_result;
1511 fit_img_result = fit_image_get_type(buf,
1514 if (fit_img_result < 0) {
1515 /* Something went wrong! */
1516 return fit_img_result;
1519 fit_loadable_process(img_type, img_data, img_len);
1523 printf("The given image format is not supported (corrupt?)\n");
1531 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1533 * boot_get_cmdline - allocate and initialize kernel cmdline
1534 * @lmb: pointer to lmb handle, will be used for memory mgmt
1535 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1536 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1538 * boot_get_cmdline() allocates space for kernel command line below
1539 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environment
1540 * variable is present its contents is copied to allocated kernel
1547 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1552 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1553 env_get_bootm_mapsize() + env_get_bootm_low());
1555 if (cmdline == NULL)
1558 s = env_get("bootargs");
1564 *cmd_start = (ulong) & cmdline[0];
1565 *cmd_end = *cmd_start + strlen(cmdline);
1567 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1571 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1573 #ifdef CONFIG_SYS_BOOT_GET_KBD
1575 * boot_get_kbd - allocate and initialize kernel copy of board info
1576 * @lmb: pointer to lmb handle, will be used for memory mgmt
1577 * @kbd: double pointer to board info data
1579 * boot_get_kbd() allocates space for kernel copy of board info data below
1580 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1581 * with the current u-boot board info data.
1587 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1589 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1590 env_get_bootm_mapsize() + env_get_bootm_low());
1596 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1598 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1599 do_bdinfo(NULL, 0, 0, NULL);
1604 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1607 int image_setup_linux(bootm_headers_t *images)
1609 ulong of_size = images->ft_len;
1610 char **of_flat_tree = &images->ft_addr;
1611 struct lmb *lmb = &images->lmb;
1614 if (IMAGE_ENABLE_OF_LIBFDT)
1615 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1617 if (IMAGE_BOOT_GET_CMDLINE) {
1618 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1619 &images->cmdline_end);
1621 puts("ERROR with allocation of cmdline\n");
1626 if (IMAGE_ENABLE_OF_LIBFDT) {
1627 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1632 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1633 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1640 #endif /* CONFIG_LMB */
1641 #endif /* !USE_HOSTCC */