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>
18 #ifdef CONFIG_HAS_DATAFLASH
19 #include <dataflash.h>
22 #ifdef CONFIG_LOGBUFFER
28 #include <environment.h>
32 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
34 #include <fdt_support.h>
39 #include <u-boot/md5.h>
40 #include <u-boot/sha1.h>
41 #include <linux/errno.h>
45 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
48 DECLARE_GLOBAL_DATA_PTR;
50 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
51 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
56 #include <u-boot/md5.h>
60 #ifndef __maybe_unused
61 # define __maybe_unused /* unimplemented */
63 #endif /* !USE_HOSTCC*/
65 #include <u-boot/crc.h>
67 #ifndef CONFIG_SYS_BARGSIZE
68 #define CONFIG_SYS_BARGSIZE 512
71 static const table_entry_t uimage_arch[] = {
72 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
73 { IH_ARCH_ALPHA, "alpha", "Alpha", },
74 { IH_ARCH_ARM, "arm", "ARM", },
75 { IH_ARCH_I386, "x86", "Intel x86", },
76 { IH_ARCH_IA64, "ia64", "IA64", },
77 { IH_ARCH_M68K, "m68k", "M68K", },
78 { IH_ARCH_MICROBLAZE, "microblaze", "MicroBlaze", },
79 { IH_ARCH_MIPS, "mips", "MIPS", },
80 { IH_ARCH_MIPS64, "mips64", "MIPS 64 Bit", },
81 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
82 { IH_ARCH_PPC, "powerpc", "PowerPC", },
83 { IH_ARCH_PPC, "ppc", "PowerPC", },
84 { IH_ARCH_S390, "s390", "IBM S390", },
85 { IH_ARCH_SH, "sh", "SuperH", },
86 { IH_ARCH_SPARC, "sparc", "SPARC", },
87 { IH_ARCH_SPARC64, "sparc64", "SPARC 64 Bit", },
88 { IH_ARCH_BLACKFIN, "blackfin", "Blackfin", },
89 { IH_ARCH_AVR32, "avr32", "AVR32", },
90 { IH_ARCH_NDS32, "nds32", "NDS32", },
91 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
92 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
93 { IH_ARCH_ARM64, "arm64", "AArch64", },
94 { IH_ARCH_ARC, "arc", "ARC", },
95 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
96 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
100 static const table_entry_t uimage_os[] = {
101 { IH_OS_INVALID, "invalid", "Invalid OS", },
102 { IH_OS_LINUX, "linux", "Linux", },
103 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
104 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
106 { IH_OS_NETBSD, "netbsd", "NetBSD", },
107 { IH_OS_OSE, "ose", "Enea OSE", },
108 { IH_OS_PLAN9, "plan9", "Plan 9", },
109 { IH_OS_RTEMS, "rtems", "RTEMS", },
110 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
111 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
112 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
113 { IH_OS_QNX, "qnx", "QNX", },
115 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
116 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
119 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
120 { IH_OS_DELL, "dell", "Dell", },
121 { IH_OS_ESIX, "esix", "Esix", },
122 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
123 { IH_OS_IRIX, "irix", "Irix", },
124 { IH_OS_NCR, "ncr", "NCR", },
125 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
126 { IH_OS_PSOS, "psos", "pSOS", },
127 { IH_OS_SCO, "sco", "SCO", },
128 { IH_OS_SOLARIS, "solaris", "Solaris", },
129 { IH_OS_SVR4, "svr4", "SVR4", },
131 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
132 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
138 static const table_entry_t uimage_type[] = {
139 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
140 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
141 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
142 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
143 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
144 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
145 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
146 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
147 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
148 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
149 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
150 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
151 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
152 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
153 { IH_TYPE_SCRIPT, "script", "Script", },
154 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SOCFPGA preloader",},
155 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
156 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
157 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
158 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
159 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
160 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
161 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
162 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
163 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
164 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
165 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
166 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
167 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
168 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
169 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
173 static const table_entry_t uimage_comp[] = {
174 { IH_COMP_NONE, "none", "uncompressed", },
175 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
176 { IH_COMP_GZIP, "gzip", "gzip compressed", },
177 { IH_COMP_LZMA, "lzma", "lzma compressed", },
178 { IH_COMP_LZO, "lzo", "lzo compressed", },
179 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
186 const table_entry_t *table;
189 static const struct table_info table_info[IH_COUNT] = {
190 { "architecture", IH_ARCH_COUNT, uimage_arch },
191 { "compression", IH_COMP_COUNT, uimage_comp },
192 { "operating system", IH_OS_COUNT, uimage_os },
193 { "image type", IH_TYPE_COUNT, uimage_type },
196 /*****************************************************************************/
197 /* Legacy format routines */
198 /*****************************************************************************/
199 int image_check_hcrc(const image_header_t *hdr)
202 ulong len = image_get_header_size();
203 image_header_t header;
205 /* Copy header so we can blank CRC field for re-calculation */
206 memmove(&header, (char *)hdr, image_get_header_size());
207 image_set_hcrc(&header, 0);
209 hcrc = crc32(0, (unsigned char *)&header, len);
211 return (hcrc == image_get_hcrc(hdr));
214 int image_check_dcrc(const image_header_t *hdr)
216 ulong data = image_get_data(hdr);
217 ulong len = image_get_data_size(hdr);
218 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
220 return (dcrc == image_get_dcrc(hdr));
224 * image_multi_count - get component (sub-image) count
225 * @hdr: pointer to the header of the multi component image
227 * image_multi_count() returns number of components in a multi
230 * Note: no checking of the image type is done, caller must pass
231 * a valid multi component image.
234 * number of components
236 ulong image_multi_count(const image_header_t *hdr)
241 /* get start of the image payload, which in case of multi
242 * component images that points to a table of component sizes */
243 size = (uint32_t *)image_get_data(hdr);
245 /* count non empty slots */
246 for (i = 0; size[i]; ++i)
253 * image_multi_getimg - get component data address and size
254 * @hdr: pointer to the header of the multi component image
255 * @idx: index of the requested component
256 * @data: pointer to a ulong variable, will hold component data address
257 * @len: pointer to a ulong variable, will hold component size
259 * image_multi_getimg() returns size and data address for the requested
260 * component in a multi component image.
262 * Note: no checking of the image type is done, caller must pass
263 * a valid multi component image.
266 * data address and size of the component, if idx is valid
267 * 0 in data and len, if idx is out of range
269 void image_multi_getimg(const image_header_t *hdr, ulong idx,
270 ulong *data, ulong *len)
274 ulong offset, count, img_data;
276 /* get number of component */
277 count = image_multi_count(hdr);
279 /* get start of the image payload, which in case of multi
280 * component images that points to a table of component sizes */
281 size = (uint32_t *)image_get_data(hdr);
283 /* get address of the proper component data start, which means
284 * skipping sizes table (add 1 for last, null entry) */
285 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
288 *len = uimage_to_cpu(size[idx]);
291 /* go over all indices preceding requested component idx */
292 for (i = 0; i < idx; i++) {
293 /* add up i-th component size, rounding up to 4 bytes */
294 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
297 /* calculate idx-th component data address */
298 *data = img_data + offset;
305 static void image_print_type(const image_header_t *hdr)
307 const char __maybe_unused *os, *arch, *type, *comp;
309 os = genimg_get_os_name(image_get_os(hdr));
310 arch = genimg_get_arch_name(image_get_arch(hdr));
311 type = genimg_get_type_name(image_get_type(hdr));
312 comp = genimg_get_comp_name(image_get_comp(hdr));
314 printf("%s %s %s (%s)\n", arch, os, type, comp);
318 * image_print_contents - prints out the contents of the legacy format image
319 * @ptr: pointer to the legacy format image header
320 * @p: pointer to prefix string
322 * image_print_contents() formats a multi line legacy image contents description.
323 * The routine prints out all header fields followed by the size/offset data
324 * for MULTI/SCRIPT images.
327 * no returned results
329 void image_print_contents(const void *ptr)
331 const image_header_t *hdr = (const image_header_t *)ptr;
332 const char __maybe_unused *p;
334 p = IMAGE_INDENT_STRING;
335 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
336 if (IMAGE_ENABLE_TIMESTAMP) {
337 printf("%sCreated: ", p);
338 genimg_print_time((time_t)image_get_time(hdr));
340 printf("%sImage Type: ", p);
341 image_print_type(hdr);
342 printf("%sData Size: ", p);
343 genimg_print_size(image_get_data_size(hdr));
344 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
345 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
347 if (image_check_type(hdr, IH_TYPE_MULTI) ||
348 image_check_type(hdr, IH_TYPE_SCRIPT)) {
351 ulong count = image_multi_count(hdr);
353 printf("%sContents:\n", p);
354 for (i = 0; i < count; i++) {
355 image_multi_getimg(hdr, i, &data, &len);
357 printf("%s Image %d: ", p, i);
358 genimg_print_size(len);
360 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
362 * the user may need to know offsets
363 * if planning to do something with
366 printf("%s Offset = 0x%08lx\n", p, data);
369 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
370 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
371 image_get_load(hdr) - image_get_header_size(),
372 image_get_size(hdr) + image_get_header_size()
379 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
381 * image_get_ramdisk - get and verify ramdisk image
382 * @rd_addr: ramdisk image start address
383 * @arch: expected ramdisk architecture
384 * @verify: checksum verification flag
386 * image_get_ramdisk() returns a pointer to the verified ramdisk image
387 * header. Routine receives image start address and expected architecture
388 * flag. Verification done covers data and header integrity and os/type/arch
391 * If dataflash support is enabled routine checks for dataflash addresses
392 * and handles required dataflash reads.
395 * pointer to a ramdisk image header, if image was found and valid
396 * otherwise, return NULL
398 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
401 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
403 if (!image_check_magic(rd_hdr)) {
404 puts("Bad Magic Number\n");
405 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
409 if (!image_check_hcrc(rd_hdr)) {
410 puts("Bad Header Checksum\n");
411 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
415 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
416 image_print_contents(rd_hdr);
419 puts(" Verifying Checksum ... ");
420 if (!image_check_dcrc(rd_hdr)) {
421 puts("Bad Data CRC\n");
422 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
428 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
430 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
431 !image_check_arch(rd_hdr, arch) ||
432 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
433 printf("No Linux %s Ramdisk Image\n",
434 genimg_get_arch_name(arch));
435 bootstage_error(BOOTSTAGE_ID_RAMDISK);
442 #endif /* !USE_HOSTCC */
444 /*****************************************************************************/
445 /* Shared dual-format routines */
446 /*****************************************************************************/
448 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
449 ulong save_addr; /* Default Save Address */
450 ulong save_size; /* Default Save Size (in bytes) */
452 static int on_loadaddr(const char *name, const char *value, enum env_op op,
457 case env_op_overwrite:
458 load_addr = simple_strtoul(value, NULL, 16);
466 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
468 ulong getenv_bootm_low(void)
470 char *s = getenv("bootm_low");
472 ulong tmp = simple_strtoul(s, NULL, 16);
476 #if defined(CONFIG_SYS_SDRAM_BASE)
477 return CONFIG_SYS_SDRAM_BASE;
478 #elif defined(CONFIG_ARM)
479 return gd->bd->bi_dram[0].start;
485 phys_size_t getenv_bootm_size(void)
487 phys_size_t tmp, size;
489 char *s = getenv("bootm_size");
491 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
495 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
496 start = gd->bd->bi_dram[0].start;
497 size = gd->bd->bi_dram[0].size;
499 start = gd->bd->bi_memstart;
500 size = gd->bd->bi_memsize;
503 s = getenv("bootm_low");
505 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
509 return size - (tmp - start);
512 phys_size_t getenv_bootm_mapsize(void)
515 char *s = getenv("bootm_mapsize");
517 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
521 #if defined(CONFIG_SYS_BOOTMAPSZ)
522 return CONFIG_SYS_BOOTMAPSZ;
524 return getenv_bootm_size();
528 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
533 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
539 size_t tail = (len > chunksz) ? chunksz : len;
545 memmove(to, from, tail);
552 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
553 memmove(to, from, len);
554 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
556 #endif /* !USE_HOSTCC */
558 void genimg_print_size(uint32_t size)
561 printf("%d Bytes = ", size);
562 print_size(size, "\n");
564 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
565 size, (double)size / 1.024e3,
566 (double)size / 1.048576e6);
570 #if IMAGE_ENABLE_TIMESTAMP
571 void genimg_print_time(time_t timestamp)
576 rtc_to_tm(timestamp, &tm);
577 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
578 tm.tm_year, tm.tm_mon, tm.tm_mday,
579 tm.tm_hour, tm.tm_min, tm.tm_sec);
581 printf("%s", ctime(×tamp));
586 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
588 for (; table->id >= 0; ++table) {
595 static const char *unknown_msg(enum ih_category category)
597 static const char unknown_str[] = "Unknown ";
600 strcpy(msg, unknown_str);
601 strncat(msg, table_info[category].desc,
602 sizeof(msg) - sizeof(unknown_str));
608 * get_cat_table_entry_name - translate entry id to long name
609 * @category: category to look up (enum ih_category)
610 * @id: entry id to be translated
612 * This will scan the translation table trying to find the entry that matches
615 * @retur long entry name if translation succeeds; error string on failure
617 const char *genimg_get_cat_name(enum ih_category category, uint id)
619 const table_entry_t *entry;
621 entry = get_table_entry(table_info[category].table, id);
623 return unknown_msg(category);
624 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
627 return entry->lname + gd->reloc_off;
632 * get_cat_table_entry_short_name - translate entry id to short name
633 * @category: category to look up (enum ih_category)
634 * @id: entry id to be translated
636 * This will scan the translation table trying to find the entry that matches
639 * @retur short entry name if translation succeeds; error string on failure
641 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
643 const table_entry_t *entry;
645 entry = get_table_entry(table_info[category].table, id);
647 return unknown_msg(category);
648 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
651 return entry->sname + gd->reloc_off;
655 int genimg_get_cat_count(enum ih_category category)
657 return table_info[category].count;
660 const char *genimg_get_cat_desc(enum ih_category category)
662 return table_info[category].desc;
666 * get_table_entry_name - translate entry id to long name
667 * @table: pointer to a translation table for entries of a specific type
668 * @msg: message to be returned when translation fails
669 * @id: entry id to be translated
671 * get_table_entry_name() will go over translation table trying to find
672 * entry that matches given id. If matching entry is found, its long
673 * name is returned to the caller.
676 * long entry name if translation succeeds
679 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
681 table = get_table_entry(table, id);
684 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
687 return table->lname + gd->reloc_off;
691 const char *genimg_get_os_name(uint8_t os)
693 return (get_table_entry_name(uimage_os, "Unknown OS", os));
696 const char *genimg_get_arch_name(uint8_t arch)
698 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
702 const char *genimg_get_type_name(uint8_t type)
704 return (get_table_entry_name(uimage_type, "Unknown Image", type));
707 static const char *genimg_get_short_name(const table_entry_t *table, int val)
709 table = get_table_entry(table, val);
712 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
715 return table->sname + gd->reloc_off;
719 const char *genimg_get_type_short_name(uint8_t type)
721 return genimg_get_short_name(uimage_type, type);
724 const char *genimg_get_comp_name(uint8_t comp)
726 return (get_table_entry_name(uimage_comp, "Unknown Compression",
730 const char *genimg_get_comp_short_name(uint8_t comp)
732 return genimg_get_short_name(uimage_comp, comp);
735 const char *genimg_get_os_short_name(uint8_t os)
737 return genimg_get_short_name(uimage_os, os);
740 const char *genimg_get_arch_short_name(uint8_t arch)
742 return genimg_get_short_name(uimage_arch, arch);
746 * get_table_entry_id - translate short entry name to id
747 * @table: pointer to a translation table for entries of a specific type
748 * @table_name: to be used in case of error
749 * @name: entry short name to be translated
751 * get_table_entry_id() will go over translation table trying to find
752 * entry that matches given short name. If matching entry is found,
753 * its id returned to the caller.
756 * entry id if translation succeeds
759 int get_table_entry_id(const table_entry_t *table,
760 const char *table_name, const char *name)
762 const table_entry_t *t;
764 for (t = table; t->id >= 0; ++t) {
765 #ifdef CONFIG_NEEDS_MANUAL_RELOC
766 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
768 if (t->sname && strcasecmp(t->sname, name) == 0)
772 debug("Invalid %s Type: %s\n", table_name, name);
777 int genimg_get_os_id(const char *name)
779 return (get_table_entry_id(uimage_os, "OS", name));
782 int genimg_get_arch_id(const char *name)
784 return (get_table_entry_id(uimage_arch, "CPU", name));
787 int genimg_get_type_id(const char *name)
789 return (get_table_entry_id(uimage_type, "Image", name));
792 int genimg_get_comp_id(const char *name)
794 return (get_table_entry_id(uimage_comp, "Compression", name));
799 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
801 * @img_addr: a string might contain real image address
802 * @fit_uname_config: double pointer to a char, will hold pointer to a
803 * configuration unit name
804 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
807 * genimg_get_kernel_addr_fit get the real kernel start address from a string
808 * which is normally the first argv of bootm/bootz
811 * kernel start address
813 ulong genimg_get_kernel_addr_fit(char * const img_addr,
814 const char **fit_uname_config,
815 const char **fit_uname_kernel)
819 /* find out kernel image address */
821 kernel_addr = load_addr;
822 debug("* kernel: default image load address = 0x%08lx\n",
824 #if CONFIG_IS_ENABLED(FIT)
825 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
827 debug("* kernel: config '%s' from image at 0x%08lx\n",
828 *fit_uname_config, kernel_addr);
829 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
831 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
832 *fit_uname_kernel, kernel_addr);
835 kernel_addr = simple_strtoul(img_addr, NULL, 16);
836 debug("* kernel: cmdline image address = 0x%08lx\n",
844 * genimg_get_kernel_addr() is the simple version of
845 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
847 ulong genimg_get_kernel_addr(char * const img_addr)
849 const char *fit_uname_config = NULL;
850 const char *fit_uname_kernel = NULL;
852 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
857 * genimg_get_format - get image format type
858 * @img_addr: image start address
860 * genimg_get_format() checks whether provided address points to a valid
861 * legacy or FIT image.
863 * New uImage format and FDT blob are based on a libfdt. FDT blob
864 * may be passed directly or embedded in a FIT image. In both situations
865 * genimg_get_format() must be able to dectect libfdt header.
868 * image format type or IMAGE_FORMAT_INVALID if no image is present
870 int genimg_get_format(const void *img_addr)
872 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
873 const image_header_t *hdr;
875 hdr = (const image_header_t *)img_addr;
876 if (image_check_magic(hdr))
877 return IMAGE_FORMAT_LEGACY;
879 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
880 if (fdt_check_header(img_addr) == 0)
881 return IMAGE_FORMAT_FIT;
883 #ifdef CONFIG_ANDROID_BOOT_IMAGE
884 if (android_image_check_header(img_addr) == 0)
885 return IMAGE_FORMAT_ANDROID;
888 return IMAGE_FORMAT_INVALID;
892 * genimg_get_image - get image from special storage (if necessary)
893 * @img_addr: image start address
895 * genimg_get_image() checks if provided image start address is located
896 * in a dataflash storage. If so, image is moved to a system RAM memory.
899 * image start address after possible relocation from special storage
901 ulong genimg_get_image(ulong img_addr)
903 ulong ram_addr = img_addr;
905 #ifdef CONFIG_HAS_DATAFLASH
906 ulong h_size, d_size;
908 if (addr_dataflash(img_addr)) {
911 /* ger RAM address */
912 ram_addr = CONFIG_SYS_LOAD_ADDR;
914 /* get header size */
915 h_size = image_get_header_size();
917 if (sizeof(struct fdt_header) > h_size)
918 h_size = sizeof(struct fdt_header);
922 debug(" Reading image header from dataflash address "
923 "%08lx to RAM address %08lx\n", img_addr, ram_addr);
925 buf = map_sysmem(ram_addr, 0);
926 read_dataflash(img_addr, h_size, buf);
929 switch (genimg_get_format(buf)) {
930 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
931 case IMAGE_FORMAT_LEGACY:
932 d_size = image_get_data_size(buf);
933 debug(" Legacy format image found at 0x%08lx, "
939 case IMAGE_FORMAT_FIT:
940 d_size = fit_get_size(buf) - h_size;
941 debug(" FIT/FDT format image found at 0x%08lx, "
947 printf(" No valid image found at 0x%08lx\n",
952 /* read in image data */
953 debug(" Reading image remaining data from dataflash address "
954 "%08lx to RAM address %08lx\n", img_addr + h_size,
957 read_dataflash(img_addr + h_size, d_size,
958 (char *)(buf + h_size));
961 #endif /* CONFIG_HAS_DATAFLASH */
967 * fit_has_config - check if there is a valid FIT configuration
968 * @images: pointer to the bootm command headers structure
970 * fit_has_config() checks if there is a FIT configuration in use
971 * (if FTI support is present).
974 * 0, no FIT support or no configuration found
975 * 1, configuration found
977 int genimg_has_config(bootm_headers_t *images)
980 if (images->fit_uname_cfg)
987 * boot_get_ramdisk - main ramdisk handling routine
988 * @argc: command argument count
989 * @argv: command argument list
990 * @images: pointer to the bootm images structure
991 * @arch: expected ramdisk architecture
992 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
993 * @rd_end: pointer to a ulong variable, will hold ramdisk end
995 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
996 * Curently supported are the following ramdisk sources:
997 * - multicomponent kernel/ramdisk image,
998 * - commandline provided address of decicated ramdisk image.
1001 * 0, if ramdisk image was found and valid, or skiped
1002 * rd_start and rd_end are set to ramdisk start/end addresses if
1003 * ramdisk image is found and valid
1005 * 1, if ramdisk image is found but corrupted, or invalid
1006 * rd_start and rd_end are set to 0 if no ramdisk exists
1008 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1009 uint8_t arch, ulong *rd_start, ulong *rd_end)
1011 ulong rd_addr, rd_load;
1012 ulong rd_data, rd_len;
1013 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1014 const image_header_t *rd_hdr;
1017 #ifdef CONFIG_SUPPORT_RAW_INITRD
1020 #if IMAGE_ENABLE_FIT
1021 const char *fit_uname_config = images->fit_uname_cfg;
1022 const char *fit_uname_ramdisk = NULL;
1026 const char *select = NULL;
1031 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1033 * Look for an Android boot image.
1035 buf = map_sysmem(images->os.start, 0);
1036 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1044 * Look for a '-' which indicates to ignore the
1047 if (select && strcmp(select, "-") == 0) {
1048 debug("## Skipping init Ramdisk\n");
1049 rd_len = rd_data = 0;
1050 } else if (select || genimg_has_config(images)) {
1051 #if IMAGE_ENABLE_FIT
1054 * If the init ramdisk comes from the FIT image and
1055 * the FIT image address is omitted in the command
1056 * line argument, try to use os FIT image address or
1057 * default load address.
1059 if (images->fit_uname_os)
1060 default_addr = (ulong)images->fit_hdr_os;
1062 default_addr = load_addr;
1064 if (fit_parse_conf(select, default_addr,
1065 &rd_addr, &fit_uname_config)) {
1066 debug("* ramdisk: config '%s' from image at "
1068 fit_uname_config, rd_addr);
1069 } else if (fit_parse_subimage(select, default_addr,
1070 &rd_addr, &fit_uname_ramdisk)) {
1071 debug("* ramdisk: subimage '%s' from image at "
1073 fit_uname_ramdisk, rd_addr);
1077 rd_addr = simple_strtoul(select, NULL, 16);
1078 debug("* ramdisk: cmdline image address = "
1082 #if IMAGE_ENABLE_FIT
1084 /* use FIT configuration provided in first bootm
1085 * command argument. If the property is not defined,
1088 rd_addr = map_to_sysmem(images->fit_hdr_os);
1089 rd_noffset = fit_get_node_from_config(images,
1090 FIT_RAMDISK_PROP, rd_addr);
1091 if (rd_noffset == -ENOENT)
1093 else if (rd_noffset < 0)
1098 /* copy from dataflash if needed */
1099 rd_addr = genimg_get_image(rd_addr);
1102 * Check if there is an initrd image at the
1103 * address provided in the second bootm argument
1104 * check image type, for FIT images get FIT node.
1106 buf = map_sysmem(rd_addr, 0);
1107 switch (genimg_get_format(buf)) {
1108 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1109 case IMAGE_FORMAT_LEGACY:
1110 printf("## Loading init Ramdisk from Legacy "
1111 "Image at %08lx ...\n", rd_addr);
1113 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1114 rd_hdr = image_get_ramdisk(rd_addr, arch,
1120 rd_data = image_get_data(rd_hdr);
1121 rd_len = image_get_data_size(rd_hdr);
1122 rd_load = image_get_load(rd_hdr);
1125 #if IMAGE_ENABLE_FIT
1126 case IMAGE_FORMAT_FIT:
1127 rd_noffset = fit_image_load(images,
1128 rd_addr, &fit_uname_ramdisk,
1129 &fit_uname_config, arch,
1131 BOOTSTAGE_ID_FIT_RD_START,
1132 FIT_LOAD_OPTIONAL_NON_ZERO,
1137 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1138 images->fit_uname_rd = fit_uname_ramdisk;
1139 images->fit_noffset_rd = rd_noffset;
1142 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1143 case IMAGE_FORMAT_ANDROID:
1144 android_image_get_ramdisk((void *)images->os.start,
1149 #ifdef CONFIG_SUPPORT_RAW_INITRD
1152 end = strchr(select, ':');
1154 rd_len = simple_strtoul(++end, NULL, 16);
1159 puts("Wrong Ramdisk Image Format\n");
1160 rd_data = rd_len = rd_load = 0;
1164 } else if (images->legacy_hdr_valid &&
1165 image_check_type(&images->legacy_hdr_os_copy,
1169 * Now check if we have a legacy mult-component image,
1170 * get second entry data start address and len.
1172 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1173 printf("## Loading init Ramdisk from multi component "
1174 "Legacy Image at %08lx ...\n",
1175 (ulong)images->legacy_hdr_os);
1177 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1182 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1183 rd_len = rd_data = 0;
1187 debug("## No init Ramdisk\n");
1189 *rd_start = rd_data;
1190 *rd_end = rd_data + rd_len;
1192 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1193 *rd_start, *rd_end);
1198 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1200 * boot_ramdisk_high - relocate init ramdisk
1201 * @lmb: pointer to lmb handle, will be used for memory mgmt
1202 * @rd_data: ramdisk data start address
1203 * @rd_len: ramdisk data length
1204 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1205 * start address (after possible relocation)
1206 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1207 * end address (after possible relocation)
1209 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1210 * variable and if requested ramdisk data is moved to a specified location.
1212 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1213 * start/end addresses if ramdisk image start and len were provided,
1214 * otherwise set initrd_start and initrd_end set to zeros.
1220 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1221 ulong *initrd_start, ulong *initrd_end)
1225 int initrd_copy_to_ram = 1;
1227 if ((s = getenv("initrd_high")) != NULL) {
1228 /* a value of "no" or a similar string will act like 0,
1229 * turning the "load high" feature off. This is intentional.
1231 initrd_high = simple_strtoul(s, NULL, 16);
1232 if (initrd_high == ~0)
1233 initrd_copy_to_ram = 0;
1235 initrd_high = getenv_bootm_mapsize() + getenv_bootm_low();
1239 #ifdef CONFIG_LOGBUFFER
1240 /* Prevent initrd from overwriting logbuffer */
1241 lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1244 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1245 initrd_high, initrd_copy_to_ram);
1248 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1249 debug(" in-place initrd\n");
1250 *initrd_start = rd_data;
1251 *initrd_end = rd_data + rd_len;
1252 lmb_reserve(lmb, rd_data, rd_len);
1255 *initrd_start = (ulong)lmb_alloc_base(lmb,
1256 rd_len, 0x1000, initrd_high);
1258 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1261 if (*initrd_start == 0) {
1262 puts("ramdisk - allocation error\n");
1265 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1267 *initrd_end = *initrd_start + rd_len;
1268 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1269 *initrd_start, *initrd_end);
1271 memmove_wd((void *)*initrd_start,
1272 (void *)rd_data, rd_len, CHUNKSZ);
1276 * Ensure the image is flushed to memory to handle
1277 * AMP boot scenarios in which we might not be
1280 flush_cache((unsigned long)*initrd_start, rd_len);
1288 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1289 *initrd_start, *initrd_end);
1296 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1298 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1299 ulong *setup_start, ulong *setup_len)
1301 #if IMAGE_ENABLE_FIT
1302 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1308 #if IMAGE_ENABLE_FIT
1309 #if defined(CONFIG_FPGA) && defined(CONFIG_FPGA_XILINX)
1310 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1311 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1313 ulong tmp_img_addr, img_data, img_len;
1317 const char *uname, *name;
1319 int devnum = 0; /* TODO support multi fpga platforms */
1320 const fpga_desc * const desc = fpga_get_desc(devnum);
1321 xilinx_desc *desc_xilinx = desc->devdesc;
1323 /* Check to see if the images struct has a FIT configuration */
1324 if (!genimg_has_config(images)) {
1325 debug("## FIT configuration was not specified\n");
1330 * Obtain the os FIT header from the images struct
1331 * copy from dataflash if needed
1333 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1334 tmp_img_addr = genimg_get_image(tmp_img_addr);
1335 buf = map_sysmem(tmp_img_addr, 0);
1337 * Check image type. For FIT images get FIT node
1338 * and attempt to locate a generic binary.
1340 switch (genimg_get_format(buf)) {
1341 case IMAGE_FORMAT_FIT:
1342 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1344 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1347 debug("## FPGA image is not specified\n");
1350 fit_img_result = fit_image_load(images,
1352 (const char **)&uname,
1353 &(images->fit_uname_cfg),
1356 BOOTSTAGE_ID_FPGA_INIT,
1357 FIT_LOAD_OPTIONAL_NON_ZERO,
1358 &img_data, &img_len);
1360 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1361 uname, img_data, img_len);
1363 if (fit_img_result < 0) {
1364 /* Something went wrong! */
1365 return fit_img_result;
1368 if (img_len >= desc_xilinx->size) {
1370 err = fpga_loadbitstream(devnum, (char *)img_data,
1373 err = fpga_load(devnum, (const void *)img_data,
1377 err = fpga_loadbitstream(devnum, (char *)img_data,
1378 img_len, BIT_PARTIAL);
1380 err = fpga_load(devnum, (const void *)img_data,
1381 img_len, BIT_PARTIAL);
1387 printf(" Programming %s bitstream... OK\n", name);
1390 printf("The given image format is not supported (corrupt?)\n");
1398 static void fit_loadable_process(uint8_t img_type,
1403 const unsigned int count =
1404 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1405 struct fit_loadable_tbl *fit_loadable_handler =
1406 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1407 /* For each loadable handler */
1408 for (i = 0; i < count; i++, fit_loadable_handler++)
1409 /* matching this type */
1410 if (fit_loadable_handler->type == img_type)
1411 /* call that handler with this image data */
1412 fit_loadable_handler->handler(img_data, img_len);
1415 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1416 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1419 * These variables are used to hold the current image location
1424 * These two variables are requirements for fit_image_load, but
1425 * their values are not used
1427 ulong img_data, img_len;
1429 int loadables_index;
1435 /* Check to see if the images struct has a FIT configuration */
1436 if (!genimg_has_config(images)) {
1437 debug("## FIT configuration was not specified\n");
1442 * Obtain the os FIT header from the images struct
1443 * copy from dataflash if needed
1445 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1446 tmp_img_addr = genimg_get_image(tmp_img_addr);
1447 buf = map_sysmem(tmp_img_addr, 0);
1449 * Check image type. For FIT images get FIT node
1450 * and attempt to locate a generic binary.
1452 switch (genimg_get_format(buf)) {
1453 case IMAGE_FORMAT_FIT:
1454 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1456 for (loadables_index = 0;
1457 uname = fdt_stringlist_get(buf, conf_noffset,
1458 FIT_LOADABLE_PROP, loadables_index,
1462 fit_img_result = fit_image_load(images,
1465 &(images->fit_uname_cfg), arch,
1467 BOOTSTAGE_ID_FIT_LOADABLE_START,
1468 FIT_LOAD_OPTIONAL_NON_ZERO,
1469 &img_data, &img_len);
1470 if (fit_img_result < 0) {
1471 /* Something went wrong! */
1472 return fit_img_result;
1475 fit_img_result = fit_image_get_node(buf, uname);
1476 if (fit_img_result < 0) {
1477 /* Something went wrong! */
1478 return fit_img_result;
1480 fit_img_result = fit_image_get_type(buf,
1483 if (fit_img_result < 0) {
1484 /* Something went wrong! */
1485 return fit_img_result;
1488 fit_loadable_process(img_type, img_data, img_len);
1492 printf("The given image format is not supported (corrupt?)\n");
1500 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1502 * boot_get_cmdline - allocate and initialize kernel cmdline
1503 * @lmb: pointer to lmb handle, will be used for memory mgmt
1504 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1505 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1507 * boot_get_cmdline() allocates space for kernel command line below
1508 * BOOTMAPSZ + getenv_bootm_low() address. If "bootargs" U-Boot environemnt
1509 * variable is present its contents is copied to allocated kernel
1516 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1521 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1522 getenv_bootm_mapsize() + getenv_bootm_low());
1524 if (cmdline == NULL)
1527 if ((s = getenv("bootargs")) == NULL)
1532 *cmd_start = (ulong) & cmdline[0];
1533 *cmd_end = *cmd_start + strlen(cmdline);
1535 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1539 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1541 #ifdef CONFIG_SYS_BOOT_GET_KBD
1543 * boot_get_kbd - allocate and initialize kernel copy of board info
1544 * @lmb: pointer to lmb handle, will be used for memory mgmt
1545 * @kbd: double pointer to board info data
1547 * boot_get_kbd() allocates space for kernel copy of board info data below
1548 * BOOTMAPSZ + getenv_bootm_low() address and kernel board info is initialized
1549 * with the current u-boot board info data.
1555 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1557 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1558 getenv_bootm_mapsize() + getenv_bootm_low());
1564 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1566 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1567 do_bdinfo(NULL, 0, 0, NULL);
1572 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1575 int image_setup_linux(bootm_headers_t *images)
1577 ulong of_size = images->ft_len;
1578 char **of_flat_tree = &images->ft_addr;
1579 struct lmb *lmb = &images->lmb;
1582 if (IMAGE_ENABLE_OF_LIBFDT)
1583 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1585 if (IMAGE_BOOT_GET_CMDLINE) {
1586 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1587 &images->cmdline_end);
1589 puts("ERROR with allocation of cmdline\n");
1594 if (IMAGE_ENABLE_OF_LIBFDT) {
1595 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1600 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1601 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1608 #endif /* CONFIG_LMB */
1609 #endif /* !USE_HOSTCC */