2 * (C) Copyright 2008 Semihalf
4 * (C) Copyright 2000-2006
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * SPDX-License-Identifier: GPL-2.0+
14 #ifdef CONFIG_SHOW_BOOT_PROGRESS
15 #include <status_led.h>
20 #include <environment.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 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
40 DECLARE_GLOBAL_DATA_PTR;
42 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
43 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
48 #include <u-boot/md5.h>
52 #ifndef __maybe_unused
53 # define __maybe_unused /* unimplemented */
55 #endif /* !USE_HOSTCC*/
57 #include <u-boot/crc.h>
59 #ifndef CONFIG_SYS_BARGSIZE
60 #define CONFIG_SYS_BARGSIZE 512
63 static const table_entry_t uimage_arch[] = {
64 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
65 { IH_ARCH_ALPHA, "alpha", "Alpha", },
66 { IH_ARCH_ARM, "arm", "ARM", },
67 { IH_ARCH_I386, "x86", "Intel x86", },
68 { IH_ARCH_IA64, "ia64", "IA64", },
69 { IH_ARCH_M68K, "m68k", "M68K", },
70 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
71 { IH_ARCH_MIPS, "mips", "MIPS", },
72 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
73 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
74 { IH_ARCH_PPC, "powerpc", "PowerPC", },
75 { IH_ARCH_PPC, "ppc", "PowerPC", },
76 { IH_ARCH_S390, "s390", "IBM S390", },
77 { IH_ARCH_SH, "sh", "SuperH", },
78 { IH_ARCH_SPARC, "sparc", "SPARC", },
79 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
80 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
81 { IH_ARCH_AVR32, "avr32", "AVR32", },
82 { IH_ARCH_NDS32, "nds32", "NDS32", },
83 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
84 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
85 { IH_ARCH_ARM64, "arm64", "AArch64", },
86 { IH_ARCH_ARC, "arc", "ARC", },
87 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
88 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
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_U_BOOT, "u-boot", "U-Boot", },
104 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
105 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
106 { IH_OS_QNX, "qnx", "QNX", },
108 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
109 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
112 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
113 { IH_OS_DELL, "dell", "Dell", },
114 { IH_OS_ESIX, "esix", "Esix", },
115 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
116 { IH_OS_IRIX, "irix", "Irix", },
117 { IH_OS_NCR, "ncr", "NCR", },
118 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
119 { IH_OS_PSOS, "psos", "pSOS", },
120 { IH_OS_SCO, "sco", "SCO", },
121 { IH_OS_SOLARIS, "solaris", "Solaris", },
122 { IH_OS_SVR4, "svr4", "SVR4", },
124 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
125 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
131 static const table_entry_t uimage_type[] = {
132 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
133 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
134 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
135 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
136 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
137 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
138 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
139 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
140 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
141 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
142 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
143 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
144 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
145 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
146 { IH_TYPE_SCRIPT, "script", "Script", },
147 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SOCFPGA preloader",},
148 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
149 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
150 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
151 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
152 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
153 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
154 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
155 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
156 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
157 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
158 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
159 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
160 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
161 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
162 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
163 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
164 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
168 static const table_entry_t uimage_comp[] = {
169 { IH_COMP_NONE, "none", "uncompressed", },
170 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
171 { IH_COMP_GZIP, "gzip", "gzip compressed", },
172 { IH_COMP_LZMA, "lzma", "lzma compressed", },
173 { IH_COMP_LZO, "lzo", "lzo compressed", },
174 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
181 const table_entry_t *table;
184 static const struct table_info table_info[IH_COUNT] = {
185 { "architecture", IH_ARCH_COUNT, uimage_arch },
186 { "compression", IH_COMP_COUNT, uimage_comp },
187 { "operating system", IH_OS_COUNT, uimage_os },
188 { "image type", IH_TYPE_COUNT, uimage_type },
191 /*****************************************************************************/
192 /* Legacy format routines */
193 /*****************************************************************************/
194 int image_check_hcrc(const image_header_t *hdr)
197 ulong len = image_get_header_size();
198 image_header_t header;
200 /* Copy header so we can blank CRC field for re-calculation */
201 memmove(&header, (char *)hdr, image_get_header_size());
202 image_set_hcrc(&header, 0);
204 hcrc = crc32(0, (unsigned char *)&header, len);
206 return (hcrc == image_get_hcrc(hdr));
209 int image_check_dcrc(const image_header_t *hdr)
211 ulong data = image_get_data(hdr);
212 ulong len = image_get_data_size(hdr);
213 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
215 return (dcrc == image_get_dcrc(hdr));
219 * image_multi_count - get component (sub-image) count
220 * @hdr: pointer to the header of the multi component image
222 * image_multi_count() returns number of components in a multi
225 * Note: no checking of the image type is done, caller must pass
226 * a valid multi component image.
229 * number of components
231 ulong image_multi_count(const image_header_t *hdr)
236 /* get start of the image payload, which in case of multi
237 * component images that points to a table of component sizes */
238 size = (uint32_t *)image_get_data(hdr);
240 /* count non empty slots */
241 for (i = 0; size[i]; ++i)
248 * image_multi_getimg - get component data address and size
249 * @hdr: pointer to the header of the multi component image
250 * @idx: index of the requested component
251 * @data: pointer to a ulong variable, will hold component data address
252 * @len: pointer to a ulong variable, will hold component size
254 * image_multi_getimg() returns size and data address for the requested
255 * component in a multi component image.
257 * Note: no checking of the image type is done, caller must pass
258 * a valid multi component image.
261 * data address and size of the component, if idx is valid
262 * 0 in data and len, if idx is out of range
264 void image_multi_getimg(const image_header_t *hdr, ulong idx,
265 ulong *data, ulong *len)
269 ulong offset, count, img_data;
271 /* get number of component */
272 count = image_multi_count(hdr);
274 /* get start of the image payload, which in case of multi
275 * component images that points to a table of component sizes */
276 size = (uint32_t *)image_get_data(hdr);
278 /* get address of the proper component data start, which means
279 * skipping sizes table (add 1 for last, null entry) */
280 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
283 *len = uimage_to_cpu(size[idx]);
286 /* go over all indices preceding requested component idx */
287 for (i = 0; i < idx; i++) {
288 /* add up i-th component size, rounding up to 4 bytes */
289 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
292 /* calculate idx-th component data address */
293 *data = img_data + offset;
300 static void image_print_type(const image_header_t *hdr)
302 const char __maybe_unused *os, *arch, *type, *comp;
304 os = genimg_get_os_name(image_get_os(hdr));
305 arch = genimg_get_arch_name(image_get_arch(hdr));
306 type = genimg_get_type_name(image_get_type(hdr));
307 comp = genimg_get_comp_name(image_get_comp(hdr));
309 printf("%s %s %s (%s)\n", arch, os, type, comp);
313 * image_print_contents - prints out the contents of the legacy format image
314 * @ptr: pointer to the legacy format image header
315 * @p: pointer to prefix string
317 * image_print_contents() formats a multi line legacy image contents description.
318 * The routine prints out all header fields followed by the size/offset data
319 * for MULTI/SCRIPT images.
322 * no returned results
324 void image_print_contents(const void *ptr)
326 const image_header_t *hdr = (const image_header_t *)ptr;
327 const char __maybe_unused *p;
329 p = IMAGE_INDENT_STRING;
330 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
331 if (IMAGE_ENABLE_TIMESTAMP) {
332 printf("%sCreated: ", p);
333 genimg_print_time((time_t)image_get_time(hdr));
335 printf("%sImage Type: ", p);
336 image_print_type(hdr);
337 printf("%sData Size: ", p);
338 genimg_print_size(image_get_data_size(hdr));
339 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
340 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
342 if (image_check_type(hdr, IH_TYPE_MULTI) ||
343 image_check_type(hdr, IH_TYPE_SCRIPT)) {
346 ulong count = image_multi_count(hdr);
348 printf("%sContents:\n", p);
349 for (i = 0; i < count; i++) {
350 image_multi_getimg(hdr, i, &data, &len);
352 printf("%s Image %d: ", p, i);
353 genimg_print_size(len);
355 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
357 * the user may need to know offsets
358 * if planning to do something with
361 printf("%s Offset = 0x%08lx\n", p, data);
364 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
365 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
366 image_get_load(hdr) - image_get_header_size(),
367 image_get_size(hdr) + image_get_header_size()
374 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
376 * image_get_ramdisk - get and verify ramdisk image
377 * @rd_addr: ramdisk image start address
378 * @arch: expected ramdisk architecture
379 * @verify: checksum verification flag
381 * image_get_ramdisk() returns a pointer to the verified ramdisk image
382 * header. Routine receives image start address and expected architecture
383 * flag. Verification done covers data and header integrity and os/type/arch
387 * pointer to a ramdisk image header, if image was found and valid
388 * otherwise, return NULL
390 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
393 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
395 if (!image_check_magic(rd_hdr)) {
396 puts("Bad Magic Number\n");
397 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
401 if (!image_check_hcrc(rd_hdr)) {
402 puts("Bad Header Checksum\n");
403 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
407 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
408 image_print_contents(rd_hdr);
411 puts(" Verifying Checksum ... ");
412 if (!image_check_dcrc(rd_hdr)) {
413 puts("Bad Data CRC\n");
414 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
420 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
422 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
423 !image_check_arch(rd_hdr, arch) ||
424 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
425 printf("No Linux %s Ramdisk Image\n",
426 genimg_get_arch_name(arch));
427 bootstage_error(BOOTSTAGE_ID_RAMDISK);
434 #endif /* !USE_HOSTCC */
436 /*****************************************************************************/
437 /* Shared dual-format routines */
438 /*****************************************************************************/
440 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
441 ulong save_addr; /* Default Save Address */
442 ulong save_size; /* Default Save Size (in bytes) */
444 static int on_loadaddr(const char *name, const char *value, enum env_op op,
449 case env_op_overwrite:
450 load_addr = simple_strtoul(value, NULL, 16);
458 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
460 ulong env_get_bootm_low(void)
462 char *s = env_get("bootm_low");
464 ulong tmp = simple_strtoul(s, NULL, 16);
468 #if defined(CONFIG_SYS_SDRAM_BASE)
469 return CONFIG_SYS_SDRAM_BASE;
470 #elif defined(CONFIG_ARM)
471 return gd->bd->bi_dram[0].start;
477 phys_size_t env_get_bootm_size(void)
479 phys_size_t tmp, size;
481 char *s = env_get("bootm_size");
483 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
487 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
488 start = gd->bd->bi_dram[0].start;
489 size = gd->bd->bi_dram[0].size;
491 start = gd->bd->bi_memstart;
492 size = gd->bd->bi_memsize;
495 s = env_get("bootm_low");
497 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
501 return size - (tmp - start);
504 phys_size_t env_get_bootm_mapsize(void)
507 char *s = env_get("bootm_mapsize");
509 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
513 #if defined(CONFIG_SYS_BOOTMAPSZ)
514 return CONFIG_SYS_BOOTMAPSZ;
516 return env_get_bootm_size();
520 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
525 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
531 size_t tail = (len > chunksz) ? chunksz : len;
537 memmove(to, from, tail);
544 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
545 memmove(to, from, len);
546 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
548 #endif /* !USE_HOSTCC */
550 void genimg_print_size(uint32_t size)
553 printf("%d Bytes = ", size);
554 print_size(size, "\n");
556 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
557 size, (double)size / 1.024e3,
558 (double)size / 1.048576e6);
562 #if IMAGE_ENABLE_TIMESTAMP
563 void genimg_print_time(time_t timestamp)
568 rtc_to_tm(timestamp, &tm);
569 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
570 tm.tm_year, tm.tm_mon, tm.tm_mday,
571 tm.tm_hour, tm.tm_min, tm.tm_sec);
573 printf("%s", ctime(×tamp));
578 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
580 for (; table->id >= 0; ++table) {
587 static const char *unknown_msg(enum ih_category category)
589 static const char unknown_str[] = "Unknown ";
592 strcpy(msg, unknown_str);
593 strncat(msg, table_info[category].desc,
594 sizeof(msg) - sizeof(unknown_str));
600 * get_cat_table_entry_name - translate entry id to long name
601 * @category: category to look up (enum ih_category)
602 * @id: entry id to be translated
604 * This will scan the translation table trying to find the entry that matches
607 * @retur long entry name if translation succeeds; error string on failure
609 const char *genimg_get_cat_name(enum ih_category category, uint id)
611 const table_entry_t *entry;
613 entry = get_table_entry(table_info[category].table, id);
615 return unknown_msg(category);
616 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
619 return entry->lname + gd->reloc_off;
624 * get_cat_table_entry_short_name - translate entry id to short name
625 * @category: category to look up (enum ih_category)
626 * @id: entry id to be translated
628 * This will scan the translation table trying to find the entry that matches
631 * @retur short entry name if translation succeeds; error string on failure
633 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
635 const table_entry_t *entry;
637 entry = get_table_entry(table_info[category].table, id);
639 return unknown_msg(category);
640 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
643 return entry->sname + gd->reloc_off;
647 int genimg_get_cat_count(enum ih_category category)
649 return table_info[category].count;
652 const char *genimg_get_cat_desc(enum ih_category category)
654 return table_info[category].desc;
658 * get_table_entry_name - translate entry id to long name
659 * @table: pointer to a translation table for entries of a specific type
660 * @msg: message to be returned when translation fails
661 * @id: entry id to be translated
663 * get_table_entry_name() will go over translation table trying to find
664 * entry that matches given id. If matching entry is found, its long
665 * name is returned to the caller.
668 * long entry name if translation succeeds
671 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
673 table = get_table_entry(table, id);
676 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
679 return table->lname + gd->reloc_off;
683 const char *genimg_get_os_name(uint8_t os)
685 return (get_table_entry_name(uimage_os, "Unknown OS", os));
688 const char *genimg_get_arch_name(uint8_t arch)
690 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
694 const char *genimg_get_type_name(uint8_t type)
696 return (get_table_entry_name(uimage_type, "Unknown Image", type));
699 static const char *genimg_get_short_name(const table_entry_t *table, int val)
701 table = get_table_entry(table, val);
704 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
707 return table->sname + gd->reloc_off;
711 const char *genimg_get_type_short_name(uint8_t type)
713 return genimg_get_short_name(uimage_type, type);
716 const char *genimg_get_comp_name(uint8_t comp)
718 return (get_table_entry_name(uimage_comp, "Unknown Compression",
722 const char *genimg_get_comp_short_name(uint8_t comp)
724 return genimg_get_short_name(uimage_comp, comp);
727 const char *genimg_get_os_short_name(uint8_t os)
729 return genimg_get_short_name(uimage_os, os);
732 const char *genimg_get_arch_short_name(uint8_t arch)
734 return genimg_get_short_name(uimage_arch, arch);
738 * get_table_entry_id - translate short entry name to id
739 * @table: pointer to a translation table for entries of a specific type
740 * @table_name: to be used in case of error
741 * @name: entry short name to be translated
743 * get_table_entry_id() will go over translation table trying to find
744 * entry that matches given short name. If matching entry is found,
745 * its id returned to the caller.
748 * entry id if translation succeeds
751 int get_table_entry_id(const table_entry_t *table,
752 const char *table_name, const char *name)
754 const table_entry_t *t;
756 for (t = table; t->id >= 0; ++t) {
757 #ifdef CONFIG_NEEDS_MANUAL_RELOC
758 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
760 if (t->sname && strcasecmp(t->sname, name) == 0)
764 debug("Invalid %s Type: %s\n", table_name, name);
769 int genimg_get_os_id(const char *name)
771 return (get_table_entry_id(uimage_os, "OS", name));
774 int genimg_get_arch_id(const char *name)
776 return (get_table_entry_id(uimage_arch, "CPU", name));
779 int genimg_get_type_id(const char *name)
781 return (get_table_entry_id(uimage_type, "Image", name));
784 int genimg_get_comp_id(const char *name)
786 return (get_table_entry_id(uimage_comp, "Compression", name));
791 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
793 * @img_addr: a string might contain real image address
794 * @fit_uname_config: double pointer to a char, will hold pointer to a
795 * configuration unit name
796 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
799 * genimg_get_kernel_addr_fit get the real kernel start address from a string
800 * which is normally the first argv of bootm/bootz
803 * kernel start address
805 ulong genimg_get_kernel_addr_fit(char * const img_addr,
806 const char **fit_uname_config,
807 const char **fit_uname_kernel)
811 /* find out kernel image address */
813 kernel_addr = load_addr;
814 debug("* kernel: default image load address = 0x%08lx\n",
816 #if CONFIG_IS_ENABLED(FIT)
817 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
819 debug("* kernel: config '%s' from image at 0x%08lx\n",
820 *fit_uname_config, kernel_addr);
821 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
823 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
824 *fit_uname_kernel, kernel_addr);
827 kernel_addr = simple_strtoul(img_addr, NULL, 16);
828 debug("* kernel: cmdline image address = 0x%08lx\n",
836 * genimg_get_kernel_addr() is the simple version of
837 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
839 ulong genimg_get_kernel_addr(char * const img_addr)
841 const char *fit_uname_config = NULL;
842 const char *fit_uname_kernel = NULL;
844 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
849 * genimg_get_format - get image format type
850 * @img_addr: image start address
852 * genimg_get_format() checks whether provided address points to a valid
853 * legacy or FIT image.
855 * New uImage format and FDT blob are based on a libfdt. FDT blob
856 * may be passed directly or embedded in a FIT image. In both situations
857 * genimg_get_format() must be able to dectect libfdt header.
860 * image format type or IMAGE_FORMAT_INVALID if no image is present
862 int genimg_get_format(const void *img_addr)
864 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
865 const image_header_t *hdr;
867 hdr = (const image_header_t *)img_addr;
868 if (image_check_magic(hdr))
869 return IMAGE_FORMAT_LEGACY;
871 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
872 if (fdt_check_header(img_addr) == 0)
873 return IMAGE_FORMAT_FIT;
875 #ifdef CONFIG_ANDROID_BOOT_IMAGE
876 if (android_image_check_header(img_addr) == 0)
877 return IMAGE_FORMAT_ANDROID;
880 return IMAGE_FORMAT_INVALID;
884 * fit_has_config - check if there is a valid FIT configuration
885 * @images: pointer to the bootm command headers structure
887 * fit_has_config() checks if there is a FIT configuration in use
888 * (if FTI support is present).
891 * 0, no FIT support or no configuration found
892 * 1, configuration found
894 int genimg_has_config(bootm_headers_t *images)
897 if (images->fit_uname_cfg)
904 * boot_get_ramdisk - main ramdisk handling routine
905 * @argc: command argument count
906 * @argv: command argument list
907 * @images: pointer to the bootm images structure
908 * @arch: expected ramdisk architecture
909 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
910 * @rd_end: pointer to a ulong variable, will hold ramdisk end
912 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
913 * Curently supported are the following ramdisk sources:
914 * - multicomponent kernel/ramdisk image,
915 * - commandline provided address of decicated ramdisk image.
918 * 0, if ramdisk image was found and valid, or skiped
919 * rd_start and rd_end are set to ramdisk start/end addresses if
920 * ramdisk image is found and valid
922 * 1, if ramdisk image is found but corrupted, or invalid
923 * rd_start and rd_end are set to 0 if no ramdisk exists
925 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
926 uint8_t arch, ulong *rd_start, ulong *rd_end)
928 ulong rd_addr, rd_load;
929 ulong rd_data, rd_len;
930 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
931 const image_header_t *rd_hdr;
934 #ifdef CONFIG_SUPPORT_RAW_INITRD
938 const char *fit_uname_config = images->fit_uname_cfg;
939 const char *fit_uname_ramdisk = NULL;
943 const char *select = NULL;
948 #ifdef CONFIG_ANDROID_BOOT_IMAGE
950 * Look for an Android boot image.
952 buf = map_sysmem(images->os.start, 0);
953 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
961 * Look for a '-' which indicates to ignore the
964 if (select && strcmp(select, "-") == 0) {
965 debug("## Skipping init Ramdisk\n");
966 rd_len = rd_data = 0;
967 } else if (select || genimg_has_config(images)) {
971 * If the init ramdisk comes from the FIT image and
972 * the FIT image address is omitted in the command
973 * line argument, try to use os FIT image address or
974 * default load address.
976 if (images->fit_uname_os)
977 default_addr = (ulong)images->fit_hdr_os;
979 default_addr = load_addr;
981 if (fit_parse_conf(select, default_addr,
982 &rd_addr, &fit_uname_config)) {
983 debug("* ramdisk: config '%s' from image at "
985 fit_uname_config, rd_addr);
986 } else if (fit_parse_subimage(select, default_addr,
987 &rd_addr, &fit_uname_ramdisk)) {
988 debug("* ramdisk: subimage '%s' from image at "
990 fit_uname_ramdisk, rd_addr);
994 rd_addr = simple_strtoul(select, NULL, 16);
995 debug("* ramdisk: cmdline image address = "
1001 /* use FIT configuration provided in first bootm
1002 * command argument. If the property is not defined,
1005 rd_addr = map_to_sysmem(images->fit_hdr_os);
1006 rd_noffset = fit_get_node_from_config(images,
1007 FIT_RAMDISK_PROP, rd_addr);
1008 if (rd_noffset == -ENOENT)
1010 else if (rd_noffset < 0)
1016 * Check if there is an initrd image at the
1017 * address provided in the second bootm argument
1018 * check image type, for FIT images get FIT node.
1020 buf = map_sysmem(rd_addr, 0);
1021 switch (genimg_get_format(buf)) {
1022 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1023 case IMAGE_FORMAT_LEGACY:
1024 printf("## Loading init Ramdisk from Legacy "
1025 "Image at %08lx ...\n", rd_addr);
1027 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1028 rd_hdr = image_get_ramdisk(rd_addr, arch,
1034 rd_data = image_get_data(rd_hdr);
1035 rd_len = image_get_data_size(rd_hdr);
1036 rd_load = image_get_load(rd_hdr);
1039 #if IMAGE_ENABLE_FIT
1040 case IMAGE_FORMAT_FIT:
1041 rd_noffset = fit_image_load(images,
1042 rd_addr, &fit_uname_ramdisk,
1043 &fit_uname_config, arch,
1045 BOOTSTAGE_ID_FIT_RD_START,
1046 FIT_LOAD_OPTIONAL_NON_ZERO,
1051 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1052 images->fit_uname_rd = fit_uname_ramdisk;
1053 images->fit_noffset_rd = rd_noffset;
1056 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1057 case IMAGE_FORMAT_ANDROID:
1058 android_image_get_ramdisk((void *)images->os.start,
1063 #ifdef CONFIG_SUPPORT_RAW_INITRD
1066 end = strchr(select, ':');
1068 rd_len = simple_strtoul(++end, NULL, 16);
1073 puts("Wrong Ramdisk Image Format\n");
1074 rd_data = rd_len = rd_load = 0;
1078 } else if (images->legacy_hdr_valid &&
1079 image_check_type(&images->legacy_hdr_os_copy,
1083 * Now check if we have a legacy mult-component image,
1084 * get second entry data start address and len.
1086 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1087 printf("## Loading init Ramdisk from multi component "
1088 "Legacy Image at %08lx ...\n",
1089 (ulong)images->legacy_hdr_os);
1091 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1096 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1097 rd_len = rd_data = 0;
1101 debug("## No init Ramdisk\n");
1103 *rd_start = rd_data;
1104 *rd_end = rd_data + rd_len;
1106 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1107 *rd_start, *rd_end);
1112 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1114 * boot_ramdisk_high - relocate init ramdisk
1115 * @lmb: pointer to lmb handle, will be used for memory mgmt
1116 * @rd_data: ramdisk data start address
1117 * @rd_len: ramdisk data length
1118 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1119 * start address (after possible relocation)
1120 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1121 * end address (after possible relocation)
1123 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1124 * variable and if requested ramdisk data is moved to a specified location.
1126 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1127 * start/end addresses if ramdisk image start and len were provided,
1128 * otherwise set initrd_start and initrd_end set to zeros.
1134 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1135 ulong *initrd_start, ulong *initrd_end)
1139 int initrd_copy_to_ram = 1;
1141 s = env_get("initrd_high");
1143 /* a value of "no" or a similar string will act like 0,
1144 * turning the "load high" feature off. This is intentional.
1146 initrd_high = simple_strtoul(s, NULL, 16);
1147 if (initrd_high == ~0)
1148 initrd_copy_to_ram = 0;
1150 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1154 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1155 initrd_high, initrd_copy_to_ram);
1158 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1159 debug(" in-place initrd\n");
1160 *initrd_start = rd_data;
1161 *initrd_end = rd_data + rd_len;
1162 lmb_reserve(lmb, rd_data, rd_len);
1165 *initrd_start = (ulong)lmb_alloc_base(lmb,
1166 rd_len, 0x1000, initrd_high);
1168 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1171 if (*initrd_start == 0) {
1172 puts("ramdisk - allocation error\n");
1175 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1177 *initrd_end = *initrd_start + rd_len;
1178 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1179 *initrd_start, *initrd_end);
1181 memmove_wd((void *)*initrd_start,
1182 (void *)rd_data, rd_len, CHUNKSZ);
1186 * Ensure the image is flushed to memory to handle
1187 * AMP boot scenarios in which we might not be
1190 flush_cache((unsigned long)*initrd_start,
1191 ALIGN(rd_len, ARCH_DMA_MINALIGN));
1199 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1200 *initrd_start, *initrd_end);
1207 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1209 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1210 ulong *setup_start, ulong *setup_len)
1212 #if IMAGE_ENABLE_FIT
1213 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1219 #if IMAGE_ENABLE_FIT
1220 #if defined(CONFIG_FPGA)
1221 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1222 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1224 ulong tmp_img_addr, img_data, img_len;
1228 const char *uname, *name;
1230 int devnum = 0; /* TODO support multi fpga platforms */
1232 /* Check to see if the images struct has a FIT configuration */
1233 if (!genimg_has_config(images)) {
1234 debug("## FIT configuration was not specified\n");
1239 * Obtain the os FIT header from the images struct
1241 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1242 buf = map_sysmem(tmp_img_addr, 0);
1244 * Check image type. For FIT images get FIT node
1245 * and attempt to locate a generic binary.
1247 switch (genimg_get_format(buf)) {
1248 case IMAGE_FORMAT_FIT:
1249 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1251 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1254 debug("## FPGA image is not specified\n");
1257 fit_img_result = fit_image_load(images,
1259 (const char **)&uname,
1260 &(images->fit_uname_cfg),
1263 BOOTSTAGE_ID_FPGA_INIT,
1264 FIT_LOAD_OPTIONAL_NON_ZERO,
1265 &img_data, &img_len);
1267 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1268 uname, img_data, img_len);
1270 if (fit_img_result < 0) {
1271 /* Something went wrong! */
1272 return fit_img_result;
1275 if (!fpga_is_partial_data(devnum, img_len)) {
1277 err = fpga_loadbitstream(devnum, (char *)img_data,
1280 err = fpga_load(devnum, (const void *)img_data,
1284 err = fpga_loadbitstream(devnum, (char *)img_data,
1285 img_len, BIT_PARTIAL);
1287 err = fpga_load(devnum, (const void *)img_data,
1288 img_len, BIT_PARTIAL);
1294 printf(" Programming %s bitstream... OK\n", name);
1297 printf("The given image format is not supported (corrupt?)\n");
1305 static void fit_loadable_process(uint8_t img_type,
1310 const unsigned int count =
1311 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1312 struct fit_loadable_tbl *fit_loadable_handler =
1313 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1314 /* For each loadable handler */
1315 for (i = 0; i < count; i++, fit_loadable_handler++)
1316 /* matching this type */
1317 if (fit_loadable_handler->type == img_type)
1318 /* call that handler with this image data */
1319 fit_loadable_handler->handler(img_data, img_len);
1322 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1323 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1326 * These variables are used to hold the current image location
1331 * These two variables are requirements for fit_image_load, but
1332 * their values are not used
1334 ulong img_data, img_len;
1336 int loadables_index;
1342 /* Check to see if the images struct has a FIT configuration */
1343 if (!genimg_has_config(images)) {
1344 debug("## FIT configuration was not specified\n");
1349 * Obtain the os FIT header from the images struct
1351 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1352 buf = map_sysmem(tmp_img_addr, 0);
1354 * Check image type. For FIT images get FIT node
1355 * and attempt to locate a generic binary.
1357 switch (genimg_get_format(buf)) {
1358 case IMAGE_FORMAT_FIT:
1359 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1361 for (loadables_index = 0;
1362 uname = fdt_stringlist_get(buf, conf_noffset,
1363 FIT_LOADABLE_PROP, loadables_index,
1367 fit_img_result = fit_image_load(images,
1370 &(images->fit_uname_cfg), arch,
1372 BOOTSTAGE_ID_FIT_LOADABLE_START,
1373 FIT_LOAD_OPTIONAL_NON_ZERO,
1374 &img_data, &img_len);
1375 if (fit_img_result < 0) {
1376 /* Something went wrong! */
1377 return fit_img_result;
1380 fit_img_result = fit_image_get_node(buf, uname);
1381 if (fit_img_result < 0) {
1382 /* Something went wrong! */
1383 return fit_img_result;
1385 fit_img_result = fit_image_get_type(buf,
1388 if (fit_img_result < 0) {
1389 /* Something went wrong! */
1390 return fit_img_result;
1393 fit_loadable_process(img_type, img_data, img_len);
1397 printf("The given image format is not supported (corrupt?)\n");
1405 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1407 * boot_get_cmdline - allocate and initialize kernel cmdline
1408 * @lmb: pointer to lmb handle, will be used for memory mgmt
1409 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1410 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1412 * boot_get_cmdline() allocates space for kernel command line below
1413 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environemnt
1414 * variable is present its contents is copied to allocated kernel
1421 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1426 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1427 env_get_bootm_mapsize() + env_get_bootm_low());
1429 if (cmdline == NULL)
1432 s = env_get("bootargs");
1438 *cmd_start = (ulong) & cmdline[0];
1439 *cmd_end = *cmd_start + strlen(cmdline);
1441 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1445 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1447 #ifdef CONFIG_SYS_BOOT_GET_KBD
1449 * boot_get_kbd - allocate and initialize kernel copy of board info
1450 * @lmb: pointer to lmb handle, will be used for memory mgmt
1451 * @kbd: double pointer to board info data
1453 * boot_get_kbd() allocates space for kernel copy of board info data below
1454 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1455 * with the current u-boot board info data.
1461 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1463 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1464 env_get_bootm_mapsize() + env_get_bootm_low());
1470 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1472 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1473 do_bdinfo(NULL, 0, 0, NULL);
1478 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1481 int image_setup_linux(bootm_headers_t *images)
1483 ulong of_size = images->ft_len;
1484 char **of_flat_tree = &images->ft_addr;
1485 struct lmb *lmb = &images->lmb;
1488 if (IMAGE_ENABLE_OF_LIBFDT)
1489 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1491 if (IMAGE_BOOT_GET_CMDLINE) {
1492 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1493 &images->cmdline_end);
1495 puts("ERROR with allocation of cmdline\n");
1500 if (IMAGE_ENABLE_OF_LIBFDT) {
1501 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1506 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1507 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1514 #endif /* CONFIG_LMB */
1515 #endif /* !USE_HOSTCC */