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" },
170 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
174 static const table_entry_t uimage_comp[] = {
175 { IH_COMP_NONE, "none", "uncompressed", },
176 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
177 { IH_COMP_GZIP, "gzip", "gzip compressed", },
178 { IH_COMP_LZMA, "lzma", "lzma compressed", },
179 { IH_COMP_LZO, "lzo", "lzo compressed", },
180 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
187 const table_entry_t *table;
190 static const struct table_info table_info[IH_COUNT] = {
191 { "architecture", IH_ARCH_COUNT, uimage_arch },
192 { "compression", IH_COMP_COUNT, uimage_comp },
193 { "operating system", IH_OS_COUNT, uimage_os },
194 { "image type", IH_TYPE_COUNT, uimage_type },
197 /*****************************************************************************/
198 /* Legacy format routines */
199 /*****************************************************************************/
200 int image_check_hcrc(const image_header_t *hdr)
203 ulong len = image_get_header_size();
204 image_header_t header;
206 /* Copy header so we can blank CRC field for re-calculation */
207 memmove(&header, (char *)hdr, image_get_header_size());
208 image_set_hcrc(&header, 0);
210 hcrc = crc32(0, (unsigned char *)&header, len);
212 return (hcrc == image_get_hcrc(hdr));
215 int image_check_dcrc(const image_header_t *hdr)
217 ulong data = image_get_data(hdr);
218 ulong len = image_get_data_size(hdr);
219 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
221 return (dcrc == image_get_dcrc(hdr));
225 * image_multi_count - get component (sub-image) count
226 * @hdr: pointer to the header of the multi component image
228 * image_multi_count() returns number of components in a multi
231 * Note: no checking of the image type is done, caller must pass
232 * a valid multi component image.
235 * number of components
237 ulong image_multi_count(const image_header_t *hdr)
242 /* get start of the image payload, which in case of multi
243 * component images that points to a table of component sizes */
244 size = (uint32_t *)image_get_data(hdr);
246 /* count non empty slots */
247 for (i = 0; size[i]; ++i)
254 * image_multi_getimg - get component data address and size
255 * @hdr: pointer to the header of the multi component image
256 * @idx: index of the requested component
257 * @data: pointer to a ulong variable, will hold component data address
258 * @len: pointer to a ulong variable, will hold component size
260 * image_multi_getimg() returns size and data address for the requested
261 * component in a multi component image.
263 * Note: no checking of the image type is done, caller must pass
264 * a valid multi component image.
267 * data address and size of the component, if idx is valid
268 * 0 in data and len, if idx is out of range
270 void image_multi_getimg(const image_header_t *hdr, ulong idx,
271 ulong *data, ulong *len)
275 ulong offset, count, img_data;
277 /* get number of component */
278 count = image_multi_count(hdr);
280 /* get start of the image payload, which in case of multi
281 * component images that points to a table of component sizes */
282 size = (uint32_t *)image_get_data(hdr);
284 /* get address of the proper component data start, which means
285 * skipping sizes table (add 1 for last, null entry) */
286 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
289 *len = uimage_to_cpu(size[idx]);
292 /* go over all indices preceding requested component idx */
293 for (i = 0; i < idx; i++) {
294 /* add up i-th component size, rounding up to 4 bytes */
295 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
298 /* calculate idx-th component data address */
299 *data = img_data + offset;
306 static void image_print_type(const image_header_t *hdr)
308 const char __maybe_unused *os, *arch, *type, *comp;
310 os = genimg_get_os_name(image_get_os(hdr));
311 arch = genimg_get_arch_name(image_get_arch(hdr));
312 type = genimg_get_type_name(image_get_type(hdr));
313 comp = genimg_get_comp_name(image_get_comp(hdr));
315 printf("%s %s %s (%s)\n", arch, os, type, comp);
319 * image_print_contents - prints out the contents of the legacy format image
320 * @ptr: pointer to the legacy format image header
321 * @p: pointer to prefix string
323 * image_print_contents() formats a multi line legacy image contents description.
324 * The routine prints out all header fields followed by the size/offset data
325 * for MULTI/SCRIPT images.
328 * no returned results
330 void image_print_contents(const void *ptr)
332 const image_header_t *hdr = (const image_header_t *)ptr;
333 const char __maybe_unused *p;
335 p = IMAGE_INDENT_STRING;
336 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
337 if (IMAGE_ENABLE_TIMESTAMP) {
338 printf("%sCreated: ", p);
339 genimg_print_time((time_t)image_get_time(hdr));
341 printf("%sImage Type: ", p);
342 image_print_type(hdr);
343 printf("%sData Size: ", p);
344 genimg_print_size(image_get_data_size(hdr));
345 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
346 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
348 if (image_check_type(hdr, IH_TYPE_MULTI) ||
349 image_check_type(hdr, IH_TYPE_SCRIPT)) {
352 ulong count = image_multi_count(hdr);
354 printf("%sContents:\n", p);
355 for (i = 0; i < count; i++) {
356 image_multi_getimg(hdr, i, &data, &len);
358 printf("%s Image %d: ", p, i);
359 genimg_print_size(len);
361 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
363 * the user may need to know offsets
364 * if planning to do something with
367 printf("%s Offset = 0x%08lx\n", p, data);
370 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
371 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
372 image_get_load(hdr) - image_get_header_size(),
373 image_get_size(hdr) + image_get_header_size()
380 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
382 * image_get_ramdisk - get and verify ramdisk image
383 * @rd_addr: ramdisk image start address
384 * @arch: expected ramdisk architecture
385 * @verify: checksum verification flag
387 * image_get_ramdisk() returns a pointer to the verified ramdisk image
388 * header. Routine receives image start address and expected architecture
389 * flag. Verification done covers data and header integrity and os/type/arch
392 * If dataflash support is enabled routine checks for dataflash addresses
393 * and handles required dataflash reads.
396 * pointer to a ramdisk image header, if image was found and valid
397 * otherwise, return NULL
399 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
402 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
404 if (!image_check_magic(rd_hdr)) {
405 puts("Bad Magic Number\n");
406 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
410 if (!image_check_hcrc(rd_hdr)) {
411 puts("Bad Header Checksum\n");
412 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
416 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
417 image_print_contents(rd_hdr);
420 puts(" Verifying Checksum ... ");
421 if (!image_check_dcrc(rd_hdr)) {
422 puts("Bad Data CRC\n");
423 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
429 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
431 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
432 !image_check_arch(rd_hdr, arch) ||
433 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
434 printf("No Linux %s Ramdisk Image\n",
435 genimg_get_arch_name(arch));
436 bootstage_error(BOOTSTAGE_ID_RAMDISK);
443 #endif /* !USE_HOSTCC */
445 /*****************************************************************************/
446 /* Shared dual-format routines */
447 /*****************************************************************************/
449 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
450 ulong save_addr; /* Default Save Address */
451 ulong save_size; /* Default Save Size (in bytes) */
453 static int on_loadaddr(const char *name, const char *value, enum env_op op,
458 case env_op_overwrite:
459 load_addr = simple_strtoul(value, NULL, 16);
467 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
469 ulong env_get_bootm_low(void)
471 char *s = env_get("bootm_low");
473 ulong tmp = simple_strtoul(s, NULL, 16);
477 #if defined(CONFIG_SYS_SDRAM_BASE)
478 return CONFIG_SYS_SDRAM_BASE;
479 #elif defined(CONFIG_ARM)
480 return gd->bd->bi_dram[0].start;
486 phys_size_t env_get_bootm_size(void)
488 phys_size_t tmp, size;
490 char *s = env_get("bootm_size");
492 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
496 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
497 start = gd->bd->bi_dram[0].start;
498 size = gd->bd->bi_dram[0].size;
500 start = gd->bd->bi_memstart;
501 size = gd->bd->bi_memsize;
504 s = env_get("bootm_low");
506 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
510 return size - (tmp - start);
513 phys_size_t env_get_bootm_mapsize(void)
516 char *s = env_get("bootm_mapsize");
518 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
522 #if defined(CONFIG_SYS_BOOTMAPSZ)
523 return CONFIG_SYS_BOOTMAPSZ;
525 return env_get_bootm_size();
529 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
534 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
540 size_t tail = (len > chunksz) ? chunksz : len;
546 memmove(to, from, tail);
553 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
554 memmove(to, from, len);
555 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
557 #endif /* !USE_HOSTCC */
559 void genimg_print_size(uint32_t size)
562 printf("%d Bytes = ", size);
563 print_size(size, "\n");
565 printf("%d Bytes = %.2f KiB = %.2f MiB\n",
566 size, (double)size / 1.024e3,
567 (double)size / 1.048576e6);
571 #if IMAGE_ENABLE_TIMESTAMP
572 void genimg_print_time(time_t timestamp)
577 rtc_to_tm(timestamp, &tm);
578 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
579 tm.tm_year, tm.tm_mon, tm.tm_mday,
580 tm.tm_hour, tm.tm_min, tm.tm_sec);
582 printf("%s", ctime(×tamp));
587 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
589 for (; table->id >= 0; ++table) {
596 static const char *unknown_msg(enum ih_category category)
598 static const char unknown_str[] = "Unknown ";
601 strcpy(msg, unknown_str);
602 strncat(msg, table_info[category].desc,
603 sizeof(msg) - sizeof(unknown_str));
609 * get_cat_table_entry_name - translate entry id to long name
610 * @category: category to look up (enum ih_category)
611 * @id: entry id to be translated
613 * This will scan the translation table trying to find the entry that matches
616 * @retur long entry name if translation succeeds; error string on failure
618 const char *genimg_get_cat_name(enum ih_category category, uint id)
620 const table_entry_t *entry;
622 entry = get_table_entry(table_info[category].table, id);
624 return unknown_msg(category);
625 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
628 return entry->lname + gd->reloc_off;
633 * get_cat_table_entry_short_name - translate entry id to short name
634 * @category: category to look up (enum ih_category)
635 * @id: entry id to be translated
637 * This will scan the translation table trying to find the entry that matches
640 * @retur short entry name if translation succeeds; error string on failure
642 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
644 const table_entry_t *entry;
646 entry = get_table_entry(table_info[category].table, id);
648 return unknown_msg(category);
649 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
652 return entry->sname + gd->reloc_off;
656 int genimg_get_cat_count(enum ih_category category)
658 return table_info[category].count;
661 const char *genimg_get_cat_desc(enum ih_category category)
663 return table_info[category].desc;
667 * get_table_entry_name - translate entry id to long name
668 * @table: pointer to a translation table for entries of a specific type
669 * @msg: message to be returned when translation fails
670 * @id: entry id to be translated
672 * get_table_entry_name() will go over translation table trying to find
673 * entry that matches given id. If matching entry is found, its long
674 * name is returned to the caller.
677 * long entry name if translation succeeds
680 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
682 table = get_table_entry(table, id);
685 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
688 return table->lname + gd->reloc_off;
692 const char *genimg_get_os_name(uint8_t os)
694 return (get_table_entry_name(uimage_os, "Unknown OS", os));
697 const char *genimg_get_arch_name(uint8_t arch)
699 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
703 const char *genimg_get_type_name(uint8_t type)
705 return (get_table_entry_name(uimage_type, "Unknown Image", type));
708 static const char *genimg_get_short_name(const table_entry_t *table, int val)
710 table = get_table_entry(table, val);
713 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
716 return table->sname + gd->reloc_off;
720 const char *genimg_get_type_short_name(uint8_t type)
722 return genimg_get_short_name(uimage_type, type);
725 const char *genimg_get_comp_name(uint8_t comp)
727 return (get_table_entry_name(uimage_comp, "Unknown Compression",
731 const char *genimg_get_comp_short_name(uint8_t comp)
733 return genimg_get_short_name(uimage_comp, comp);
736 const char *genimg_get_os_short_name(uint8_t os)
738 return genimg_get_short_name(uimage_os, os);
741 const char *genimg_get_arch_short_name(uint8_t arch)
743 return genimg_get_short_name(uimage_arch, arch);
747 * get_table_entry_id - translate short entry name to id
748 * @table: pointer to a translation table for entries of a specific type
749 * @table_name: to be used in case of error
750 * @name: entry short name to be translated
752 * get_table_entry_id() will go over translation table trying to find
753 * entry that matches given short name. If matching entry is found,
754 * its id returned to the caller.
757 * entry id if translation succeeds
760 int get_table_entry_id(const table_entry_t *table,
761 const char *table_name, const char *name)
763 const table_entry_t *t;
765 for (t = table; t->id >= 0; ++t) {
766 #ifdef CONFIG_NEEDS_MANUAL_RELOC
767 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
769 if (t->sname && strcasecmp(t->sname, name) == 0)
773 debug("Invalid %s Type: %s\n", table_name, name);
778 int genimg_get_os_id(const char *name)
780 return (get_table_entry_id(uimage_os, "OS", name));
783 int genimg_get_arch_id(const char *name)
785 return (get_table_entry_id(uimage_arch, "CPU", name));
788 int genimg_get_type_id(const char *name)
790 return (get_table_entry_id(uimage_type, "Image", name));
793 int genimg_get_comp_id(const char *name)
795 return (get_table_entry_id(uimage_comp, "Compression", name));
800 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
802 * @img_addr: a string might contain real image address
803 * @fit_uname_config: double pointer to a char, will hold pointer to a
804 * configuration unit name
805 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
808 * genimg_get_kernel_addr_fit get the real kernel start address from a string
809 * which is normally the first argv of bootm/bootz
812 * kernel start address
814 ulong genimg_get_kernel_addr_fit(char * const img_addr,
815 const char **fit_uname_config,
816 const char **fit_uname_kernel)
820 /* find out kernel image address */
822 kernel_addr = load_addr;
823 debug("* kernel: default image load address = 0x%08lx\n",
825 #if CONFIG_IS_ENABLED(FIT)
826 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
828 debug("* kernel: config '%s' from image at 0x%08lx\n",
829 *fit_uname_config, kernel_addr);
830 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
832 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
833 *fit_uname_kernel, kernel_addr);
836 kernel_addr = simple_strtoul(img_addr, NULL, 16);
837 debug("* kernel: cmdline image address = 0x%08lx\n",
845 * genimg_get_kernel_addr() is the simple version of
846 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
848 ulong genimg_get_kernel_addr(char * const img_addr)
850 const char *fit_uname_config = NULL;
851 const char *fit_uname_kernel = NULL;
853 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
858 * genimg_get_format - get image format type
859 * @img_addr: image start address
861 * genimg_get_format() checks whether provided address points to a valid
862 * legacy or FIT image.
864 * New uImage format and FDT blob are based on a libfdt. FDT blob
865 * may be passed directly or embedded in a FIT image. In both situations
866 * genimg_get_format() must be able to dectect libfdt header.
869 * image format type or IMAGE_FORMAT_INVALID if no image is present
871 int genimg_get_format(const void *img_addr)
873 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
874 const image_header_t *hdr;
876 hdr = (const image_header_t *)img_addr;
877 if (image_check_magic(hdr))
878 return IMAGE_FORMAT_LEGACY;
880 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
881 if (fdt_check_header(img_addr) == 0)
882 return IMAGE_FORMAT_FIT;
884 #ifdef CONFIG_ANDROID_BOOT_IMAGE
885 if (android_image_check_header(img_addr) == 0)
886 return IMAGE_FORMAT_ANDROID;
889 return IMAGE_FORMAT_INVALID;
893 * genimg_get_image - get image from special storage (if necessary)
894 * @img_addr: image start address
896 * genimg_get_image() checks if provided image start address is located
897 * in a dataflash storage. If so, image is moved to a system RAM memory.
900 * image start address after possible relocation from special storage
902 ulong genimg_get_image(ulong img_addr)
904 ulong ram_addr = img_addr;
906 #ifdef CONFIG_HAS_DATAFLASH
907 ulong h_size, d_size;
909 if (addr_dataflash(img_addr)) {
912 /* ger RAM address */
913 ram_addr = CONFIG_SYS_LOAD_ADDR;
915 /* get header size */
916 h_size = image_get_header_size();
918 if (sizeof(struct fdt_header) > h_size)
919 h_size = sizeof(struct fdt_header);
923 debug(" Reading image header from dataflash address "
924 "%08lx to RAM address %08lx\n", img_addr, ram_addr);
926 buf = map_sysmem(ram_addr, 0);
927 read_dataflash(img_addr, h_size, buf);
930 switch (genimg_get_format(buf)) {
931 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
932 case IMAGE_FORMAT_LEGACY:
933 d_size = image_get_data_size(buf);
934 debug(" Legacy format image found at 0x%08lx, "
940 case IMAGE_FORMAT_FIT:
941 d_size = fit_get_size(buf) - h_size;
942 debug(" FIT/FDT format image found at 0x%08lx, "
948 printf(" No valid image found at 0x%08lx\n",
953 /* read in image data */
954 debug(" Reading image remaining data from dataflash address "
955 "%08lx to RAM address %08lx\n", img_addr + h_size,
958 read_dataflash(img_addr + h_size, d_size,
959 (char *)(buf + h_size));
962 #endif /* CONFIG_HAS_DATAFLASH */
968 * fit_has_config - check if there is a valid FIT configuration
969 * @images: pointer to the bootm command headers structure
971 * fit_has_config() checks if there is a FIT configuration in use
972 * (if FTI support is present).
975 * 0, no FIT support or no configuration found
976 * 1, configuration found
978 int genimg_has_config(bootm_headers_t *images)
981 if (images->fit_uname_cfg)
988 * boot_get_ramdisk - main ramdisk handling routine
989 * @argc: command argument count
990 * @argv: command argument list
991 * @images: pointer to the bootm images structure
992 * @arch: expected ramdisk architecture
993 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
994 * @rd_end: pointer to a ulong variable, will hold ramdisk end
996 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
997 * Curently supported are the following ramdisk sources:
998 * - multicomponent kernel/ramdisk image,
999 * - commandline provided address of decicated ramdisk image.
1002 * 0, if ramdisk image was found and valid, or skiped
1003 * rd_start and rd_end are set to ramdisk start/end addresses if
1004 * ramdisk image is found and valid
1006 * 1, if ramdisk image is found but corrupted, or invalid
1007 * rd_start and rd_end are set to 0 if no ramdisk exists
1009 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1010 uint8_t arch, ulong *rd_start, ulong *rd_end)
1012 ulong rd_addr, rd_load;
1013 ulong rd_data, rd_len;
1014 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1015 const image_header_t *rd_hdr;
1018 #ifdef CONFIG_SUPPORT_RAW_INITRD
1021 #if IMAGE_ENABLE_FIT
1022 const char *fit_uname_config = images->fit_uname_cfg;
1023 const char *fit_uname_ramdisk = NULL;
1027 const char *select = NULL;
1032 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1034 * Look for an Android boot image.
1036 buf = map_sysmem(images->os.start, 0);
1037 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1045 * Look for a '-' which indicates to ignore the
1048 if (select && strcmp(select, "-") == 0) {
1049 debug("## Skipping init Ramdisk\n");
1050 rd_len = rd_data = 0;
1051 } else if (select || genimg_has_config(images)) {
1052 #if IMAGE_ENABLE_FIT
1055 * If the init ramdisk comes from the FIT image and
1056 * the FIT image address is omitted in the command
1057 * line argument, try to use os FIT image address or
1058 * default load address.
1060 if (images->fit_uname_os)
1061 default_addr = (ulong)images->fit_hdr_os;
1063 default_addr = load_addr;
1065 if (fit_parse_conf(select, default_addr,
1066 &rd_addr, &fit_uname_config)) {
1067 debug("* ramdisk: config '%s' from image at "
1069 fit_uname_config, rd_addr);
1070 } else if (fit_parse_subimage(select, default_addr,
1071 &rd_addr, &fit_uname_ramdisk)) {
1072 debug("* ramdisk: subimage '%s' from image at "
1074 fit_uname_ramdisk, rd_addr);
1078 rd_addr = simple_strtoul(select, NULL, 16);
1079 debug("* ramdisk: cmdline image address = "
1083 #if IMAGE_ENABLE_FIT
1085 /* use FIT configuration provided in first bootm
1086 * command argument. If the property is not defined,
1089 rd_addr = map_to_sysmem(images->fit_hdr_os);
1090 rd_noffset = fit_get_node_from_config(images,
1091 FIT_RAMDISK_PROP, rd_addr);
1092 if (rd_noffset == -ENOENT)
1094 else if (rd_noffset < 0)
1099 /* copy from dataflash if needed */
1100 rd_addr = genimg_get_image(rd_addr);
1103 * Check if there is an initrd image at the
1104 * address provided in the second bootm argument
1105 * check image type, for FIT images get FIT node.
1107 buf = map_sysmem(rd_addr, 0);
1108 switch (genimg_get_format(buf)) {
1109 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1110 case IMAGE_FORMAT_LEGACY:
1111 printf("## Loading init Ramdisk from Legacy "
1112 "Image at %08lx ...\n", rd_addr);
1114 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1115 rd_hdr = image_get_ramdisk(rd_addr, arch,
1121 rd_data = image_get_data(rd_hdr);
1122 rd_len = image_get_data_size(rd_hdr);
1123 rd_load = image_get_load(rd_hdr);
1126 #if IMAGE_ENABLE_FIT
1127 case IMAGE_FORMAT_FIT:
1128 rd_noffset = fit_image_load(images,
1129 rd_addr, &fit_uname_ramdisk,
1130 &fit_uname_config, arch,
1132 BOOTSTAGE_ID_FIT_RD_START,
1133 FIT_LOAD_OPTIONAL_NON_ZERO,
1138 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1139 images->fit_uname_rd = fit_uname_ramdisk;
1140 images->fit_noffset_rd = rd_noffset;
1143 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1144 case IMAGE_FORMAT_ANDROID:
1145 android_image_get_ramdisk((void *)images->os.start,
1150 #ifdef CONFIG_SUPPORT_RAW_INITRD
1153 end = strchr(select, ':');
1155 rd_len = simple_strtoul(++end, NULL, 16);
1160 puts("Wrong Ramdisk Image Format\n");
1161 rd_data = rd_len = rd_load = 0;
1165 } else if (images->legacy_hdr_valid &&
1166 image_check_type(&images->legacy_hdr_os_copy,
1170 * Now check if we have a legacy mult-component image,
1171 * get second entry data start address and len.
1173 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1174 printf("## Loading init Ramdisk from multi component "
1175 "Legacy Image at %08lx ...\n",
1176 (ulong)images->legacy_hdr_os);
1178 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1183 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1184 rd_len = rd_data = 0;
1188 debug("## No init Ramdisk\n");
1190 *rd_start = rd_data;
1191 *rd_end = rd_data + rd_len;
1193 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1194 *rd_start, *rd_end);
1199 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1201 * boot_ramdisk_high - relocate init ramdisk
1202 * @lmb: pointer to lmb handle, will be used for memory mgmt
1203 * @rd_data: ramdisk data start address
1204 * @rd_len: ramdisk data length
1205 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1206 * start address (after possible relocation)
1207 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1208 * end address (after possible relocation)
1210 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1211 * variable and if requested ramdisk data is moved to a specified location.
1213 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1214 * start/end addresses if ramdisk image start and len were provided,
1215 * otherwise set initrd_start and initrd_end set to zeros.
1221 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1222 ulong *initrd_start, ulong *initrd_end)
1226 int initrd_copy_to_ram = 1;
1228 s = env_get("initrd_high");
1230 /* a value of "no" or a similar string will act like 0,
1231 * turning the "load high" feature off. This is intentional.
1233 initrd_high = simple_strtoul(s, NULL, 16);
1234 if (initrd_high == ~0)
1235 initrd_copy_to_ram = 0;
1237 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1241 #ifdef CONFIG_LOGBUFFER
1242 /* Prevent initrd from overwriting logbuffer */
1243 lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1246 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1247 initrd_high, initrd_copy_to_ram);
1250 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1251 debug(" in-place initrd\n");
1252 *initrd_start = rd_data;
1253 *initrd_end = rd_data + rd_len;
1254 lmb_reserve(lmb, rd_data, rd_len);
1257 *initrd_start = (ulong)lmb_alloc_base(lmb,
1258 rd_len, 0x1000, initrd_high);
1260 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1263 if (*initrd_start == 0) {
1264 puts("ramdisk - allocation error\n");
1267 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1269 *initrd_end = *initrd_start + rd_len;
1270 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1271 *initrd_start, *initrd_end);
1273 memmove_wd((void *)*initrd_start,
1274 (void *)rd_data, rd_len, CHUNKSZ);
1278 * Ensure the image is flushed to memory to handle
1279 * AMP boot scenarios in which we might not be
1282 flush_cache((unsigned long)*initrd_start, rd_len);
1290 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1291 *initrd_start, *initrd_end);
1298 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1300 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1301 ulong *setup_start, ulong *setup_len)
1303 #if IMAGE_ENABLE_FIT
1304 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1310 #if IMAGE_ENABLE_FIT
1311 #if defined(CONFIG_FPGA) && defined(CONFIG_FPGA_XILINX)
1312 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1313 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1315 ulong tmp_img_addr, img_data, img_len;
1319 const char *uname, *name;
1321 int devnum = 0; /* TODO support multi fpga platforms */
1322 const fpga_desc * const desc = fpga_get_desc(devnum);
1323 xilinx_desc *desc_xilinx = desc->devdesc;
1325 /* Check to see if the images struct has a FIT configuration */
1326 if (!genimg_has_config(images)) {
1327 debug("## FIT configuration was not specified\n");
1332 * Obtain the os FIT header from the images struct
1333 * copy from dataflash if needed
1335 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1336 tmp_img_addr = genimg_get_image(tmp_img_addr);
1337 buf = map_sysmem(tmp_img_addr, 0);
1339 * Check image type. For FIT images get FIT node
1340 * and attempt to locate a generic binary.
1342 switch (genimg_get_format(buf)) {
1343 case IMAGE_FORMAT_FIT:
1344 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1346 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1349 debug("## FPGA image is not specified\n");
1352 fit_img_result = fit_image_load(images,
1354 (const char **)&uname,
1355 &(images->fit_uname_cfg),
1358 BOOTSTAGE_ID_FPGA_INIT,
1359 FIT_LOAD_OPTIONAL_NON_ZERO,
1360 &img_data, &img_len);
1362 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1363 uname, img_data, img_len);
1365 if (fit_img_result < 0) {
1366 /* Something went wrong! */
1367 return fit_img_result;
1370 if (img_len >= desc_xilinx->size) {
1372 err = fpga_loadbitstream(devnum, (char *)img_data,
1375 err = fpga_load(devnum, (const void *)img_data,
1379 err = fpga_loadbitstream(devnum, (char *)img_data,
1380 img_len, BIT_PARTIAL);
1382 err = fpga_load(devnum, (const void *)img_data,
1383 img_len, BIT_PARTIAL);
1389 printf(" Programming %s bitstream... OK\n", name);
1392 printf("The given image format is not supported (corrupt?)\n");
1400 static void fit_loadable_process(uint8_t img_type,
1405 const unsigned int count =
1406 ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1407 struct fit_loadable_tbl *fit_loadable_handler =
1408 ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1409 /* For each loadable handler */
1410 for (i = 0; i < count; i++, fit_loadable_handler++)
1411 /* matching this type */
1412 if (fit_loadable_handler->type == img_type)
1413 /* call that handler with this image data */
1414 fit_loadable_handler->handler(img_data, img_len);
1417 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1418 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1421 * These variables are used to hold the current image location
1426 * These two variables are requirements for fit_image_load, but
1427 * their values are not used
1429 ulong img_data, img_len;
1431 int loadables_index;
1437 /* Check to see if the images struct has a FIT configuration */
1438 if (!genimg_has_config(images)) {
1439 debug("## FIT configuration was not specified\n");
1444 * Obtain the os FIT header from the images struct
1445 * copy from dataflash if needed
1447 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1448 tmp_img_addr = genimg_get_image(tmp_img_addr);
1449 buf = map_sysmem(tmp_img_addr, 0);
1451 * Check image type. For FIT images get FIT node
1452 * and attempt to locate a generic binary.
1454 switch (genimg_get_format(buf)) {
1455 case IMAGE_FORMAT_FIT:
1456 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1458 for (loadables_index = 0;
1459 uname = fdt_stringlist_get(buf, conf_noffset,
1460 FIT_LOADABLE_PROP, loadables_index,
1464 fit_img_result = fit_image_load(images,
1467 &(images->fit_uname_cfg), arch,
1469 BOOTSTAGE_ID_FIT_LOADABLE_START,
1470 FIT_LOAD_OPTIONAL_NON_ZERO,
1471 &img_data, &img_len);
1472 if (fit_img_result < 0) {
1473 /* Something went wrong! */
1474 return fit_img_result;
1477 fit_img_result = fit_image_get_node(buf, uname);
1478 if (fit_img_result < 0) {
1479 /* Something went wrong! */
1480 return fit_img_result;
1482 fit_img_result = fit_image_get_type(buf,
1485 if (fit_img_result < 0) {
1486 /* Something went wrong! */
1487 return fit_img_result;
1490 fit_loadable_process(img_type, img_data, img_len);
1494 printf("The given image format is not supported (corrupt?)\n");
1502 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1504 * boot_get_cmdline - allocate and initialize kernel cmdline
1505 * @lmb: pointer to lmb handle, will be used for memory mgmt
1506 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1507 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1509 * boot_get_cmdline() allocates space for kernel command line below
1510 * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environemnt
1511 * variable is present its contents is copied to allocated kernel
1518 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1523 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1524 env_get_bootm_mapsize() + env_get_bootm_low());
1526 if (cmdline == NULL)
1529 s = env_get("bootargs");
1535 *cmd_start = (ulong) & cmdline[0];
1536 *cmd_end = *cmd_start + strlen(cmdline);
1538 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1542 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1544 #ifdef CONFIG_SYS_BOOT_GET_KBD
1546 * boot_get_kbd - allocate and initialize kernel copy of board info
1547 * @lmb: pointer to lmb handle, will be used for memory mgmt
1548 * @kbd: double pointer to board info data
1550 * boot_get_kbd() allocates space for kernel copy of board info data below
1551 * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1552 * with the current u-boot board info data.
1558 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1560 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1561 env_get_bootm_mapsize() + env_get_bootm_low());
1567 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1569 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1570 do_bdinfo(NULL, 0, 0, NULL);
1575 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1578 int image_setup_linux(bootm_headers_t *images)
1580 ulong of_size = images->ft_len;
1581 char **of_flat_tree = &images->ft_addr;
1582 struct lmb *lmb = &images->lmb;
1585 if (IMAGE_ENABLE_OF_LIBFDT)
1586 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1588 if (IMAGE_BOOT_GET_CMDLINE) {
1589 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1590 &images->cmdline_end);
1592 puts("ERROR with allocation of cmdline\n");
1597 if (IMAGE_ENABLE_OF_LIBFDT) {
1598 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1603 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1604 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1611 #endif /* CONFIG_LMB */
1612 #endif /* !USE_HOSTCC */