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 #ifdef CONFIG_SHOW_BOOT_PROGRESS
14 #include <status_led.h>
19 #include <environment.h>
23 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
24 #include <linux/libfdt.h>
25 #include <fdt_support.h>
30 #include <u-boot/md5.h>
31 #include <u-boot/sha1.h>
32 #include <linux/errno.h>
36 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
39 DECLARE_GLOBAL_DATA_PTR;
41 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
42 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
47 #include <u-boot/md5.h>
51 #ifndef __maybe_unused
52 # define __maybe_unused /* unimplemented */
54 #endif /* !USE_HOSTCC*/
56 #include <u-boot/crc.h>
58 #ifndef CONFIG_SYS_BARGSIZE
59 #define CONFIG_SYS_BARGSIZE 512
62 static const table_entry_t uimage_arch[] = {
63 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
64 { IH_ARCH_ALPHA, "alpha", "Alpha", },
65 { IH_ARCH_ARM, "arm", "ARM", },
66 { IH_ARCH_I386, "x86", "Intel x86", },
67 { IH_ARCH_IA64, "ia64", "IA64", },
68 { IH_ARCH_M68K, "m68k", "M68K", },
69 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
70 { IH_ARCH_MIPS, "mips", "MIPS", },
71 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
72 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
73 { IH_ARCH_PPC, "powerpc", "PowerPC", },
74 { IH_ARCH_PPC, "ppc", "PowerPC", },
75 { IH_ARCH_S390, "s390", "IBM S390", },
76 { IH_ARCH_SH, "sh", "SuperH", },
77 { IH_ARCH_SPARC, "sparc", "SPARC", },
78 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
79 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
80 { IH_ARCH_AVR32, "avr32", "AVR32", },
81 { IH_ARCH_NDS32, "nds32", "NDS32", },
82 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
83 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
84 { IH_ARCH_ARM64, "arm64", "AArch64", },
85 { IH_ARCH_ARC, "arc", "ARC", },
86 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
87 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
88 { IH_ARCH_RISCV, "riscv", "RISC-V", },
92 static const table_entry_t uimage_os[] = {
93 { IH_OS_INVALID, "invalid", "Invalid OS", },
94 { IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware" },
95 { IH_OS_LINUX, "linux", "Linux", },
96 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
97 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
99 { IH_OS_NETBSD, "netbsd", "NetBSD", },
100 { IH_OS_OSE, "ose", "Enea OSE", },
101 { IH_OS_PLAN9, "plan9", "Plan 9", },
102 { IH_OS_RTEMS, "rtems", "RTEMS", },
103 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
104 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
105 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
106 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
107 { IH_OS_QNX, "qnx", "QNX", },
109 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
110 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
113 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
114 { IH_OS_DELL, "dell", "Dell", },
115 { IH_OS_ESIX, "esix", "Esix", },
116 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
117 { IH_OS_IRIX, "irix", "Irix", },
118 { IH_OS_NCR, "ncr", "NCR", },
119 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
120 { IH_OS_PSOS, "psos", "pSOS", },
121 { IH_OS_SCO, "sco", "SCO", },
122 { IH_OS_SOLARIS, "solaris", "Solaris", },
123 { IH_OS_SVR4, "svr4", "SVR4", },
125 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
126 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
132 static const table_entry_t uimage_type[] = {
133 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
134 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
135 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
136 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
137 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
138 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
139 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
140 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
141 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
142 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
143 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
144 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
145 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
146 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
147 { IH_TYPE_SCRIPT, "script", "Script", },
148 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SOCFPGA preloader",},
149 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
150 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
151 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
152 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
153 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
154 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
155 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
156 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
157 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
158 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
159 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
160 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
161 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
162 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
163 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
164 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
165 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
166 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
170 static const table_entry_t uimage_comp[] = {
171 { IH_COMP_NONE, "none", "uncompressed", },
172 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
173 { IH_COMP_GZIP, "gzip", "gzip compressed", },
174 { IH_COMP_LZMA, "lzma", "lzma compressed", },
175 { IH_COMP_LZO, "lzo", "lzo compressed", },
176 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
183 const table_entry_t *table;
186 static const struct table_info table_info[IH_COUNT] = {
187 { "architecture", IH_ARCH_COUNT, uimage_arch },
188 { "compression", IH_COMP_COUNT, uimage_comp },
189 { "operating system", IH_OS_COUNT, uimage_os },
190 { "image type", IH_TYPE_COUNT, uimage_type },
193 /*****************************************************************************/
194 /* Legacy format routines */
195 /*****************************************************************************/
196 int image_check_hcrc(const image_header_t *hdr)
199 ulong len = image_get_header_size();
200 image_header_t header;
202 /* Copy header so we can blank CRC field for re-calculation */
203 memmove(&header, (char *)hdr, image_get_header_size());
204 image_set_hcrc(&header, 0);
206 hcrc = crc32(0, (unsigned char *)&header, len);
208 return (hcrc == image_get_hcrc(hdr));
211 int image_check_dcrc(const image_header_t *hdr)
213 ulong data = image_get_data(hdr);
214 ulong len = image_get_data_size(hdr);
215 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
217 return (dcrc == image_get_dcrc(hdr));
221 * image_multi_count - get component (sub-image) count
222 * @hdr: pointer to the header of the multi component image
224 * image_multi_count() returns number of components in a multi
227 * Note: no checking of the image type is done, caller must pass
228 * a valid multi component image.
231 * number of components
233 ulong image_multi_count(const image_header_t *hdr)
238 /* get start of the image payload, which in case of multi
239 * component images that points to a table of component sizes */
240 size = (uint32_t *)image_get_data(hdr);
242 /* count non empty slots */
243 for (i = 0; size[i]; ++i)
250 * image_multi_getimg - get component data address and size
251 * @hdr: pointer to the header of the multi component image
252 * @idx: index of the requested component
253 * @data: pointer to a ulong variable, will hold component data address
254 * @len: pointer to a ulong variable, will hold component size
256 * image_multi_getimg() returns size and data address for the requested
257 * component in a multi component image.
259 * Note: no checking of the image type is done, caller must pass
260 * a valid multi component image.
263 * data address and size of the component, if idx is valid
264 * 0 in data and len, if idx is out of range
266 void image_multi_getimg(const image_header_t *hdr, ulong idx,
267 ulong *data, ulong *len)
271 ulong offset, count, img_data;
273 /* get number of component */
274 count = image_multi_count(hdr);
276 /* get start of the image payload, which in case of multi
277 * component images that points to a table of component sizes */
278 size = (uint32_t *)image_get_data(hdr);
280 /* get address of the proper component data start, which means
281 * skipping sizes table (add 1 for last, null entry) */
282 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
285 *len = uimage_to_cpu(size[idx]);
288 /* go over all indices preceding requested component idx */
289 for (i = 0; i < idx; i++) {
290 /* add up i-th component size, rounding up to 4 bytes */
291 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
294 /* calculate idx-th component data address */
295 *data = img_data + offset;
302 static void image_print_type(const image_header_t *hdr)
304 const char __maybe_unused *os, *arch, *type, *comp;
306 os = genimg_get_os_name(image_get_os(hdr));
307 arch = genimg_get_arch_name(image_get_arch(hdr));
308 type = genimg_get_type_name(image_get_type(hdr));
309 comp = genimg_get_comp_name(image_get_comp(hdr));
311 printf("%s %s %s (%s)\n", arch, os, type, comp);
315 * image_print_contents - prints out the contents of the legacy format image
316 * @ptr: pointer to the legacy format image header
317 * @p: pointer to prefix string
319 * image_print_contents() formats a multi line legacy image contents description.
320 * The routine prints out all header fields followed by the size/offset data
321 * for MULTI/SCRIPT images.
324 * no returned results
326 void image_print_contents(const void *ptr)
328 const image_header_t *hdr = (const image_header_t *)ptr;
329 const char __maybe_unused *p;
331 p = IMAGE_INDENT_STRING;
332 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
333 if (IMAGE_ENABLE_TIMESTAMP) {
334 printf("%sCreated: ", p);
335 genimg_print_time((time_t)image_get_time(hdr));
337 printf("%sImage Type: ", p);
338 image_print_type(hdr);
339 printf("%sData Size: ", p);
340 genimg_print_size(image_get_data_size(hdr));
341 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
342 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
344 if (image_check_type(hdr, IH_TYPE_MULTI) ||
345 image_check_type(hdr, IH_TYPE_SCRIPT)) {
348 ulong count = image_multi_count(hdr);
350 printf("%sContents:\n", p);
351 for (i = 0; i < count; i++) {
352 image_multi_getimg(hdr, i, &data, &len);
354 printf("%s Image %d: ", p, i);
355 genimg_print_size(len);
357 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
359 * the user may need to know offsets
360 * if planning to do something with
363 printf("%s Offset = 0x%08lx\n", p, data);
366 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
367 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
368 image_get_load(hdr) - image_get_header_size(),
369 image_get_size(hdr) + image_get_header_size()
376 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
378 * image_get_ramdisk - get and verify ramdisk image
379 * @rd_addr: ramdisk image start address
380 * @arch: expected ramdisk architecture
381 * @verify: checksum verification flag
383 * image_get_ramdisk() returns a pointer to the verified ramdisk image
384 * header. Routine receives image start address and expected architecture
385 * flag. Verification done covers data and header integrity and os/type/arch
389 * pointer to a ramdisk image header, if image was found and valid
390 * otherwise, return NULL
392 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
395 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
397 if (!image_check_magic(rd_hdr)) {
398 puts("Bad Magic Number\n");
399 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
403 if (!image_check_hcrc(rd_hdr)) {
404 puts("Bad Header Checksum\n");
405 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
409 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
410 image_print_contents(rd_hdr);
413 puts(" Verifying Checksum ... ");
414 if (!image_check_dcrc(rd_hdr)) {
415 puts("Bad Data CRC\n");
416 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
422 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
424 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
425 !image_check_arch(rd_hdr, arch) ||
426 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
427 printf("No Linux %s Ramdisk Image\n",
428 genimg_get_arch_name(arch));
429 bootstage_error(BOOTSTAGE_ID_RAMDISK);
436 #endif /* !USE_HOSTCC */
438 /*****************************************************************************/
439 /* Shared dual-format routines */
440 /*****************************************************************************/
442 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
443 ulong save_addr; /* Default Save Address */
444 ulong save_size; /* Default Save Size (in bytes) */
446 static int on_loadaddr(const char *name, const char *value, enum env_op op,
451 case env_op_overwrite:
452 load_addr = simple_strtoul(value, NULL, 16);
460 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
462 ulong env_get_bootm_low(void)
464 char *s = env_get("bootm_low");
466 ulong tmp = simple_strtoul(s, NULL, 16);
470 #if defined(CONFIG_SYS_SDRAM_BASE)
471 return CONFIG_SYS_SDRAM_BASE;
472 #elif defined(CONFIG_ARM)
473 return gd->bd->bi_dram[0].start;
479 phys_size_t env_get_bootm_size(void)
481 phys_size_t tmp, size;
483 char *s = env_get("bootm_size");
485 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
489 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
490 start = gd->bd->bi_dram[0].start;
491 size = gd->bd->bi_dram[0].size;
493 start = gd->bd->bi_memstart;
494 size = gd->bd->bi_memsize;
497 s = env_get("bootm_low");
499 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
503 return size - (tmp - start);
506 phys_size_t env_get_bootm_mapsize(void)
509 char *s = env_get("bootm_mapsize");
511 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
515 #if defined(CONFIG_SYS_BOOTMAPSZ)
516 return CONFIG_SYS_BOOTMAPSZ;
518 return env_get_bootm_size();
522 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
527 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
533 size_t tail = (len > chunksz) ? chunksz : len;
539 memmove(to, from, tail);
546 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
547 memmove(to, from, len);
548 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
550 #endif /* !USE_HOSTCC */
552 void genimg_print_size(uint32_t size)
555 printf("%d Bytes = ", size);
556 print_size(size, "\n");
558 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
559 size, (double)size / 1.024e3,
560 (double)size / 1.048576e6);
564 #if IMAGE_ENABLE_TIMESTAMP
565 void genimg_print_time(time_t timestamp)
570 rtc_to_tm(timestamp, &tm);
571 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
572 tm.tm_year, tm.tm_mon, tm.tm_mday,
573 tm.tm_hour, tm.tm_min, tm.tm_sec);
575 printf("%s", ctime(×tamp));
580 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
582 for (; table->id >= 0; ++table) {
589 static const char *unknown_msg(enum ih_category category)
591 static const char unknown_str[] = "Unknown ";
594 strcpy(msg, unknown_str);
595 strncat(msg, table_info[category].desc,
596 sizeof(msg) - sizeof(unknown_str));
602 * get_cat_table_entry_name - translate entry id to long name
603 * @category: category to look up (enum ih_category)
604 * @id: entry id to be translated
606 * This will scan the translation table trying to find the entry that matches
609 * @retur long entry name if translation succeeds; error string on failure
611 const char *genimg_get_cat_name(enum ih_category category, uint id)
613 const table_entry_t *entry;
615 entry = get_table_entry(table_info[category].table, id);
617 return unknown_msg(category);
618 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
621 return entry->lname + gd->reloc_off;
626 * get_cat_table_entry_short_name - translate entry id to short name
627 * @category: category to look up (enum ih_category)
628 * @id: entry id to be translated
630 * This will scan the translation table trying to find the entry that matches
633 * @retur short entry name if translation succeeds; error string on failure
635 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
637 const table_entry_t *entry;
639 entry = get_table_entry(table_info[category].table, id);
641 return unknown_msg(category);
642 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
645 return entry->sname + gd->reloc_off;
649 int genimg_get_cat_count(enum ih_category category)
651 return table_info[category].count;
654 const char *genimg_get_cat_desc(enum ih_category category)
656 return table_info[category].desc;
660 * get_table_entry_name - translate entry id to long name
661 * @table: pointer to a translation table for entries of a specific type
662 * @msg: message to be returned when translation fails
663 * @id: entry id to be translated
665 * get_table_entry_name() will go over translation table trying to find
666 * entry that matches given id. If matching entry is found, its long
667 * name is returned to the caller.
670 * long entry name if translation succeeds
673 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
675 table = get_table_entry(table, id);
678 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
681 return table->lname + gd->reloc_off;
685 const char *genimg_get_os_name(uint8_t os)
687 return (get_table_entry_name(uimage_os, "Unknown OS", os));
690 const char *genimg_get_arch_name(uint8_t arch)
692 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
696 const char *genimg_get_type_name(uint8_t type)
698 return (get_table_entry_name(uimage_type, "Unknown Image", type));
701 static const char *genimg_get_short_name(const table_entry_t *table, int val)
703 table = get_table_entry(table, val);
706 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
709 return table->sname + gd->reloc_off;
713 const char *genimg_get_type_short_name(uint8_t type)
715 return genimg_get_short_name(uimage_type, type);
718 const char *genimg_get_comp_name(uint8_t comp)
720 return (get_table_entry_name(uimage_comp, "Unknown Compression",
724 const char *genimg_get_comp_short_name(uint8_t comp)
726 return genimg_get_short_name(uimage_comp, comp);
729 const char *genimg_get_os_short_name(uint8_t os)
731 return genimg_get_short_name(uimage_os, os);
734 const char *genimg_get_arch_short_name(uint8_t arch)
736 return genimg_get_short_name(uimage_arch, arch);
740 * get_table_entry_id - translate short entry name to id
741 * @table: pointer to a translation table for entries of a specific type
742 * @table_name: to be used in case of error
743 * @name: entry short name to be translated
745 * get_table_entry_id() will go over translation table trying to find
746 * entry that matches given short name. If matching entry is found,
747 * its id returned to the caller.
750 * entry id if translation succeeds
753 int get_table_entry_id(const table_entry_t *table,
754 const char *table_name, const char *name)
756 const table_entry_t *t;
758 for (t = table; t->id >= 0; ++t) {
759 #ifdef CONFIG_NEEDS_MANUAL_RELOC
760 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
762 if (t->sname && strcasecmp(t->sname, name) == 0)
766 debug("Invalid %s Type: %s\n", table_name, name);
771 int genimg_get_os_id(const char *name)
773 return (get_table_entry_id(uimage_os, "OS", name));
776 int genimg_get_arch_id(const char *name)
778 return (get_table_entry_id(uimage_arch, "CPU", name));
781 int genimg_get_type_id(const char *name)
783 return (get_table_entry_id(uimage_type, "Image", name));
786 int genimg_get_comp_id(const char *name)
788 return (get_table_entry_id(uimage_comp, "Compression", name));
793 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
795 * @img_addr: a string might contain real image address
796 * @fit_uname_config: double pointer to a char, will hold pointer to a
797 * configuration unit name
798 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
801 * genimg_get_kernel_addr_fit get the real kernel start address from a string
802 * which is normally the first argv of bootm/bootz
805 * kernel start address
807 ulong genimg_get_kernel_addr_fit(char * const img_addr,
808 const char **fit_uname_config,
809 const char **fit_uname_kernel)
813 /* find out kernel image address */
815 kernel_addr = load_addr;
816 debug("* kernel: default image load address = 0x%08lx\n",
818 #if CONFIG_IS_ENABLED(FIT)
819 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
821 debug("* kernel: config '%s' from image at 0x%08lx\n",
822 *fit_uname_config, kernel_addr);
823 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
825 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
826 *fit_uname_kernel, kernel_addr);
829 kernel_addr = simple_strtoul(img_addr, NULL, 16);
830 debug("* kernel: cmdline image address = 0x%08lx\n",
838 * genimg_get_kernel_addr() is the simple version of
839 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
841 ulong genimg_get_kernel_addr(char * const img_addr)
843 const char *fit_uname_config = NULL;
844 const char *fit_uname_kernel = NULL;
846 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
851 * genimg_get_format - get image format type
852 * @img_addr: image start address
854 * genimg_get_format() checks whether provided address points to a valid
855 * legacy or FIT image.
857 * New uImage format and FDT blob are based on a libfdt. FDT blob
858 * may be passed directly or embedded in a FIT image. In both situations
859 * genimg_get_format() must be able to dectect libfdt header.
862 * image format type or IMAGE_FORMAT_INVALID if no image is present
864 int genimg_get_format(const void *img_addr)
866 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
867 const image_header_t *hdr;
869 hdr = (const image_header_t *)img_addr;
870 if (image_check_magic(hdr))
871 return IMAGE_FORMAT_LEGACY;
873 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
874 if (fdt_check_header(img_addr) == 0)
875 return IMAGE_FORMAT_FIT;
877 #ifdef CONFIG_ANDROID_BOOT_IMAGE
878 if (android_image_check_header(img_addr) == 0)
879 return IMAGE_FORMAT_ANDROID;
882 return IMAGE_FORMAT_INVALID;
886 * fit_has_config - check if there is a valid FIT configuration
887 * @images: pointer to the bootm command headers structure
889 * fit_has_config() checks if there is a FIT configuration in use
890 * (if FTI support is present).
893 * 0, no FIT support or no configuration found
894 * 1, configuration found
896 int genimg_has_config(bootm_headers_t *images)
899 if (images->fit_uname_cfg)
906 * boot_get_ramdisk - main ramdisk handling routine
907 * @argc: command argument count
908 * @argv: command argument list
909 * @images: pointer to the bootm images structure
910 * @arch: expected ramdisk architecture
911 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
912 * @rd_end: pointer to a ulong variable, will hold ramdisk end
914 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
915 * Curently supported are the following ramdisk sources:
916 * - multicomponent kernel/ramdisk image,
917 * - commandline provided address of decicated ramdisk image.
920 * 0, if ramdisk image was found and valid, or skiped
921 * rd_start and rd_end are set to ramdisk start/end addresses if
922 * ramdisk image is found and valid
924 * 1, if ramdisk image is found but corrupted, or invalid
925 * rd_start and rd_end are set to 0 if no ramdisk exists
927 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
928 uint8_t arch, ulong *rd_start, ulong *rd_end)
930 ulong rd_addr, rd_load;
931 ulong rd_data, rd_len;
932 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
933 const image_header_t *rd_hdr;
936 #ifdef CONFIG_SUPPORT_RAW_INITRD
940 const char *fit_uname_config = images->fit_uname_cfg;
941 const char *fit_uname_ramdisk = NULL;
945 const char *select = NULL;
950 #ifdef CONFIG_ANDROID_BOOT_IMAGE
952 * Look for an Android boot image.
954 buf = map_sysmem(images->os.start, 0);
955 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
963 * Look for a '-' which indicates to ignore the
966 if (select && strcmp(select, "-") == 0) {
967 debug("## Skipping init Ramdisk\n");
968 rd_len = rd_data = 0;
969 } else if (select || genimg_has_config(images)) {
973 * If the init ramdisk comes from the FIT image and
974 * the FIT image address is omitted in the command
975 * line argument, try to use os FIT image address or
976 * default load address.
978 if (images->fit_uname_os)
979 default_addr = (ulong)images->fit_hdr_os;
981 default_addr = load_addr;
983 if (fit_parse_conf(select, default_addr,
984 &rd_addr, &fit_uname_config)) {
985 debug("* ramdisk: config '%s' from image at "
987 fit_uname_config, rd_addr);
988 } else if (fit_parse_subimage(select, default_addr,
989 &rd_addr, &fit_uname_ramdisk)) {
990 debug("* ramdisk: subimage '%s' from image at "
992 fit_uname_ramdisk, rd_addr);
996 rd_addr = simple_strtoul(select, NULL, 16);
997 debug("* ramdisk: cmdline image address = "
1001 #if IMAGE_ENABLE_FIT
1003 /* use FIT configuration provided in first bootm
1004 * command argument. If the property is not defined,
1007 rd_addr = map_to_sysmem(images->fit_hdr_os);
1008 rd_noffset = fit_get_node_from_config(images,
1009 FIT_RAMDISK_PROP, rd_addr);
1010 if (rd_noffset == -ENOENT)
1012 else if (rd_noffset < 0)
1018 * Check if there is an initrd image at the
1019 * address provided in the second bootm argument
1020 * check image type, for FIT images get FIT node.
1022 buf = map_sysmem(rd_addr, 0);
1023 switch (genimg_get_format(buf)) {
1024 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1025 case IMAGE_FORMAT_LEGACY:
1026 printf("## Loading init Ramdisk from Legacy "
1027 "Image at %08lx ...\n", rd_addr);
1029 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1030 rd_hdr = image_get_ramdisk(rd_addr, arch,
1036 rd_data = image_get_data(rd_hdr);
1037 rd_len = image_get_data_size(rd_hdr);
1038 rd_load = image_get_load(rd_hdr);
1041 #if IMAGE_ENABLE_FIT
1042 case IMAGE_FORMAT_FIT:
1043 rd_noffset = fit_image_load(images,
1044 rd_addr, &fit_uname_ramdisk,
1045 &fit_uname_config, arch,
1047 BOOTSTAGE_ID_FIT_RD_START,
1048 FIT_LOAD_OPTIONAL_NON_ZERO,
1053 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1054 images->fit_uname_rd = fit_uname_ramdisk;
1055 images->fit_noffset_rd = rd_noffset;
1058 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1059 case IMAGE_FORMAT_ANDROID:
1060 android_image_get_ramdisk((void *)images->os.start,
1065 #ifdef CONFIG_SUPPORT_RAW_INITRD
1068 end = strchr(select, ':');
1070 rd_len = simple_strtoul(++end, NULL, 16);
1075 puts("Wrong Ramdisk Image Format\n");
1076 rd_data = rd_len = rd_load = 0;
1080 } else if (images->legacy_hdr_valid &&
1081 image_check_type(&images->legacy_hdr_os_copy,
1085 * Now check if we have a legacy mult-component image,
1086 * get second entry data start address and len.
1088 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1089 printf("## Loading init Ramdisk from multi component "
1090 "Legacy Image at %08lx ...\n",
1091 (ulong)images->legacy_hdr_os);
1093 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1098 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1099 rd_len = rd_data = 0;
1103 debug("## No init Ramdisk\n");
1105 *rd_start = rd_data;
1106 *rd_end = rd_data + rd_len;
1108 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1109 *rd_start, *rd_end);
1114 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1116 * boot_ramdisk_high - relocate init ramdisk
1117 * @lmb: pointer to lmb handle, will be used for memory mgmt
1118 * @rd_data: ramdisk data start address
1119 * @rd_len: ramdisk data length
1120 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1121 * start address (after possible relocation)
1122 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1123 * end address (after possible relocation)
1125 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1126 * variable and if requested ramdisk data is moved to a specified location.
1128 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1129 * start/end addresses if ramdisk image start and len were provided,
1130 * otherwise set initrd_start and initrd_end set to zeros.
1136 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1137 ulong *initrd_start, ulong *initrd_end)
1141 int initrd_copy_to_ram = 1;
1143 s = env_get("initrd_high");
1145 /* a value of "no" or a similar string will act like 0,
1146 * turning the "load high" feature off. This is intentional.
1148 initrd_high = simple_strtoul(s, NULL, 16);
1149 if (initrd_high == ~0)
1150 initrd_copy_to_ram = 0;
1152 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1156 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1157 initrd_high, initrd_copy_to_ram);
1160 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1161 debug(" in-place initrd\n");
1162 *initrd_start = rd_data;
1163 *initrd_end = rd_data + rd_len;
1164 lmb_reserve(lmb, rd_data, rd_len);
1167 *initrd_start = (ulong)lmb_alloc_base(lmb,
1168 rd_len, 0x1000, initrd_high);
1170 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1173 if (*initrd_start == 0) {
1174 puts("ramdisk - allocation error\n");
1177 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1179 *initrd_end = *initrd_start + rd_len;
1180 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1181 *initrd_start, *initrd_end);
1183 memmove_wd((void *)*initrd_start,
1184 (void *)rd_data, rd_len, CHUNKSZ);
1188 * Ensure the image is flushed to memory to handle
1189 * AMP boot scenarios in which we might not be
1192 flush_cache((unsigned long)*initrd_start,
1193 ALIGN(rd_len, ARCH_DMA_MINALIGN));
1201 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1202 *initrd_start, *initrd_end);
1209 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1211 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1212 ulong *setup_start, ulong *setup_len)
1214 #if IMAGE_ENABLE_FIT
1215 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1221 #if IMAGE_ENABLE_FIT
1222 #if defined(CONFIG_FPGA)
1223 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1224 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1226 ulong tmp_img_addr, img_data, img_len;
1230 const char *uname, *name;
1232 int devnum = 0; /* TODO support multi fpga platforms */
1234 /* Check to see if the images struct has a FIT configuration */
1235 if (!genimg_has_config(images)) {
1236 debug("## FIT configuration was not specified\n");
1241 * Obtain the os FIT header from the images struct
1243 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1244 buf = map_sysmem(tmp_img_addr, 0);
1246 * Check image type. For FIT images get FIT node
1247 * and attempt to locate a generic binary.
1249 switch (genimg_get_format(buf)) {
1250 case IMAGE_FORMAT_FIT:
1251 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1253 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1256 debug("## FPGA image is not specified\n");
1259 fit_img_result = fit_image_load(images,
1261 (const char **)&uname,
1262 &(images->fit_uname_cfg),
1265 BOOTSTAGE_ID_FPGA_INIT,
1266 FIT_LOAD_OPTIONAL_NON_ZERO,
1267 &img_data, &img_len);
1269 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1270 uname, img_data, img_len);
1272 if (fit_img_result < 0) {
1273 /* Something went wrong! */
1274 return fit_img_result;
1277 if (!fpga_is_partial_data(devnum, img_len)) {
1279 err = fpga_loadbitstream(devnum, (char *)img_data,
1282 err = fpga_load(devnum, (const void *)img_data,
1286 err = fpga_loadbitstream(devnum, (char *)img_data,
1287 img_len, BIT_PARTIAL);
1289 err = fpga_load(devnum, (const void *)img_data,
1290 img_len, BIT_PARTIAL);
1296 printf(" Programming %s bitstream... OK\n", name);
1299 printf("The given image format is not supported (corrupt?)\n");
1307 static void fit_loadable_process(uint8_t img_type,
1312 const unsigned int count =
1313 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1314 struct fit_loadable_tbl *fit_loadable_handler =
1315 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1316 /* For each loadable handler */
1317 for (i = 0; i < count; i++, fit_loadable_handler++)
1318 /* matching this type */
1319 if (fit_loadable_handler->type == img_type)
1320 /* call that handler with this image data */
1321 fit_loadable_handler->handler(img_data, img_len);
1324 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1325 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1328 * These variables are used to hold the current image location
1333 * These two variables are requirements for fit_image_load, but
1334 * their values are not used
1336 ulong img_data, img_len;
1338 int loadables_index;
1344 /* Check to see if the images struct has a FIT configuration */
1345 if (!genimg_has_config(images)) {
1346 debug("## FIT configuration was not specified\n");
1351 * Obtain the os FIT header from the images struct
1353 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1354 buf = map_sysmem(tmp_img_addr, 0);
1356 * Check image type. For FIT images get FIT node
1357 * and attempt to locate a generic binary.
1359 switch (genimg_get_format(buf)) {
1360 case IMAGE_FORMAT_FIT:
1361 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1363 for (loadables_index = 0;
1364 uname = fdt_stringlist_get(buf, conf_noffset,
1365 FIT_LOADABLE_PROP, loadables_index,
1369 fit_img_result = fit_image_load(images,
1372 &(images->fit_uname_cfg), arch,
1374 BOOTSTAGE_ID_FIT_LOADABLE_START,
1375 FIT_LOAD_OPTIONAL_NON_ZERO,
1376 &img_data, &img_len);
1377 if (fit_img_result < 0) {
1378 /* Something went wrong! */
1379 return fit_img_result;
1382 fit_img_result = fit_image_get_node(buf, uname);
1383 if (fit_img_result < 0) {
1384 /* Something went wrong! */
1385 return fit_img_result;
1387 fit_img_result = fit_image_get_type(buf,
1390 if (fit_img_result < 0) {
1391 /* Something went wrong! */
1392 return fit_img_result;
1395 fit_loadable_process(img_type, img_data, img_len);
1399 printf("The given image format is not supported (corrupt?)\n");
1407 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1409 * boot_get_cmdline - allocate and initialize kernel cmdline
1410 * @lmb: pointer to lmb handle, will be used for memory mgmt
1411 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1412 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1414 * boot_get_cmdline() allocates space for kernel command line below
1415 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environemnt
1416 * variable is present its contents is copied to allocated kernel
1423 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1428 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1429 env_get_bootm_mapsize() + env_get_bootm_low());
1431 if (cmdline == NULL)
1434 s = env_get("bootargs");
1440 *cmd_start = (ulong) & cmdline[0];
1441 *cmd_end = *cmd_start + strlen(cmdline);
1443 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1447 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1449 #ifdef CONFIG_SYS_BOOT_GET_KBD
1451 * boot_get_kbd - allocate and initialize kernel copy of board info
1452 * @lmb: pointer to lmb handle, will be used for memory mgmt
1453 * @kbd: double pointer to board info data
1455 * boot_get_kbd() allocates space for kernel copy of board info data below
1456 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1457 * with the current u-boot board info data.
1463 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1465 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1466 env_get_bootm_mapsize() + env_get_bootm_low());
1472 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1474 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1475 do_bdinfo(NULL, 0, 0, NULL);
1480 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1483 int image_setup_linux(bootm_headers_t *images)
1485 ulong of_size = images->ft_len;
1486 char **of_flat_tree = &images->ft_addr;
1487 struct lmb *lmb = &images->lmb;
1490 if (IMAGE_ENABLE_OF_LIBFDT)
1491 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1493 if (IMAGE_BOOT_GET_CMDLINE) {
1494 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1495 &images->cmdline_end);
1497 puts("ERROR with allocation of cmdline\n");
1502 if (IMAGE_ENABLE_OF_LIBFDT) {
1503 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1508 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1509 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1516 #endif /* CONFIG_LMB */
1517 #endif /* !USE_HOSTCC */