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 <asm/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, NULL, "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", },
99 static const table_entry_t uimage_os[] = {
100 { IH_OS_INVALID, NULL, "Invalid OS", },
101 { IH_OS_LINUX, "linux", "Linux", },
102 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
103 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
105 { IH_OS_NETBSD, "netbsd", "NetBSD", },
106 { IH_OS_OSE, "ose", "Enea OSE", },
107 { IH_OS_PLAN9, "plan9", "Plan 9", },
108 { IH_OS_RTEMS, "rtems", "RTEMS", },
109 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
110 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
111 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
112 { IH_OS_QNX, "qnx", "QNX", },
114 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
115 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
118 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
119 { IH_OS_DELL, "dell", "Dell", },
120 { IH_OS_ESIX, "esix", "Esix", },
121 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
122 { IH_OS_IRIX, "irix", "Irix", },
123 { IH_OS_NCR, "ncr", "NCR", },
124 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
125 { IH_OS_PSOS, "psos", "pSOS", },
126 { IH_OS_SCO, "sco", "SCO", },
127 { IH_OS_SOLARIS, "solaris", "Solaris", },
128 { IH_OS_SVR4, "svr4", "SVR4", },
130 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
131 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
137 static const table_entry_t uimage_type[] = {
138 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
139 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
140 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
141 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
142 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
143 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
144 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
145 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
146 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
147 { IH_TYPE_INVALID, NULL, "Invalid Image", },
148 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
149 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
150 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
151 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
152 { IH_TYPE_SCRIPT, "script", "Script", },
153 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SOCFPGA preloader",},
154 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
155 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
156 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
157 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
158 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
159 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
160 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
161 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
162 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
163 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
164 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
165 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
169 static const table_entry_t uimage_comp[] = {
170 { IH_COMP_NONE, "none", "uncompressed", },
171 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
172 { IH_COMP_GZIP, "gzip", "gzip compressed", },
173 { IH_COMP_LZMA, "lzma", "lzma compressed", },
174 { IH_COMP_LZO, "lzo", "lzo compressed", },
175 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
179 /*****************************************************************************/
180 /* Legacy format routines */
181 /*****************************************************************************/
182 int image_check_hcrc(const image_header_t *hdr)
185 ulong len = image_get_header_size();
186 image_header_t header;
188 /* Copy header so we can blank CRC field for re-calculation */
189 memmove(&header, (char *)hdr, image_get_header_size());
190 image_set_hcrc(&header, 0);
192 hcrc = crc32(0, (unsigned char *)&header, len);
194 return (hcrc == image_get_hcrc(hdr));
197 int image_check_dcrc(const image_header_t *hdr)
199 ulong data = image_get_data(hdr);
200 ulong len = image_get_data_size(hdr);
201 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
203 return (dcrc == image_get_dcrc(hdr));
207 * image_multi_count - get component (sub-image) count
208 * @hdr: pointer to the header of the multi component image
210 * image_multi_count() returns number of components in a multi
213 * Note: no checking of the image type is done, caller must pass
214 * a valid multi component image.
217 * number of components
219 ulong image_multi_count(const image_header_t *hdr)
224 /* get start of the image payload, which in case of multi
225 * component images that points to a table of component sizes */
226 size = (uint32_t *)image_get_data(hdr);
228 /* count non empty slots */
229 for (i = 0; size[i]; ++i)
236 * image_multi_getimg - get component data address and size
237 * @hdr: pointer to the header of the multi component image
238 * @idx: index of the requested component
239 * @data: pointer to a ulong variable, will hold component data address
240 * @len: pointer to a ulong variable, will hold component size
242 * image_multi_getimg() returns size and data address for the requested
243 * component in a multi component image.
245 * Note: no checking of the image type is done, caller must pass
246 * a valid multi component image.
249 * data address and size of the component, if idx is valid
250 * 0 in data and len, if idx is out of range
252 void image_multi_getimg(const image_header_t *hdr, ulong idx,
253 ulong *data, ulong *len)
257 ulong offset, count, img_data;
259 /* get number of component */
260 count = image_multi_count(hdr);
262 /* get start of the image payload, which in case of multi
263 * component images that points to a table of component sizes */
264 size = (uint32_t *)image_get_data(hdr);
266 /* get address of the proper component data start, which means
267 * skipping sizes table (add 1 for last, null entry) */
268 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
271 *len = uimage_to_cpu(size[idx]);
274 /* go over all indices preceding requested component idx */
275 for (i = 0; i < idx; i++) {
276 /* add up i-th component size, rounding up to 4 bytes */
277 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
280 /* calculate idx-th component data address */
281 *data = img_data + offset;
288 static void image_print_type(const image_header_t *hdr)
290 const char __maybe_unused *os, *arch, *type, *comp;
292 os = genimg_get_os_name(image_get_os(hdr));
293 arch = genimg_get_arch_name(image_get_arch(hdr));
294 type = genimg_get_type_name(image_get_type(hdr));
295 comp = genimg_get_comp_name(image_get_comp(hdr));
297 printf("%s %s %s (%s)\n", arch, os, type, comp);
301 * image_print_contents - prints out the contents of the legacy format image
302 * @ptr: pointer to the legacy format image header
303 * @p: pointer to prefix string
305 * image_print_contents() formats a multi line legacy image contents description.
306 * The routine prints out all header fields followed by the size/offset data
307 * for MULTI/SCRIPT images.
310 * no returned results
312 void image_print_contents(const void *ptr)
314 const image_header_t *hdr = (const image_header_t *)ptr;
315 const char __maybe_unused *p;
317 p = IMAGE_INDENT_STRING;
318 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
319 if (IMAGE_ENABLE_TIMESTAMP) {
320 printf("%sCreated: ", p);
321 genimg_print_time((time_t)image_get_time(hdr));
323 printf("%sImage Type: ", p);
324 image_print_type(hdr);
325 printf("%sData Size: ", p);
326 genimg_print_size(image_get_data_size(hdr));
327 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
328 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
330 if (image_check_type(hdr, IH_TYPE_MULTI) ||
331 image_check_type(hdr, IH_TYPE_SCRIPT)) {
334 ulong count = image_multi_count(hdr);
336 printf("%sContents:\n", p);
337 for (i = 0; i < count; i++) {
338 image_multi_getimg(hdr, i, &data, &len);
340 printf("%s Image %d: ", p, i);
341 genimg_print_size(len);
343 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
345 * the user may need to know offsets
346 * if planning to do something with
349 printf("%s Offset = 0x%08lx\n", p, data);
357 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
359 * image_get_ramdisk - get and verify ramdisk image
360 * @rd_addr: ramdisk image start address
361 * @arch: expected ramdisk architecture
362 * @verify: checksum verification flag
364 * image_get_ramdisk() returns a pointer to the verified ramdisk image
365 * header. Routine receives image start address and expected architecture
366 * flag. Verification done covers data and header integrity and os/type/arch
369 * If dataflash support is enabled routine checks for dataflash addresses
370 * and handles required dataflash reads.
373 * pointer to a ramdisk image header, if image was found and valid
374 * otherwise, return NULL
376 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
379 const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
381 if (!image_check_magic(rd_hdr)) {
382 puts("Bad Magic Number\n");
383 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
387 if (!image_check_hcrc(rd_hdr)) {
388 puts("Bad Header Checksum\n");
389 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
393 bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
394 image_print_contents(rd_hdr);
397 puts(" Verifying Checksum ... ");
398 if (!image_check_dcrc(rd_hdr)) {
399 puts("Bad Data CRC\n");
400 bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
406 bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
408 if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
409 !image_check_arch(rd_hdr, arch) ||
410 !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
411 printf("No Linux %s Ramdisk Image\n",
412 genimg_get_arch_name(arch));
413 bootstage_error(BOOTSTAGE_ID_RAMDISK);
420 #endif /* !USE_HOSTCC */
422 /*****************************************************************************/
423 /* Shared dual-format routines */
424 /*****************************************************************************/
426 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
427 ulong save_addr; /* Default Save Address */
428 ulong save_size; /* Default Save Size (in bytes) */
430 static int on_loadaddr(const char *name, const char *value, enum env_op op,
435 case env_op_overwrite:
436 load_addr = simple_strtoul(value, NULL, 16);
444 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
446 ulong getenv_bootm_low(void)
448 char *s = getenv("bootm_low");
450 ulong tmp = simple_strtoul(s, NULL, 16);
454 #if defined(CONFIG_SYS_SDRAM_BASE)
455 return CONFIG_SYS_SDRAM_BASE;
456 #elif defined(CONFIG_ARM)
457 return gd->bd->bi_dram[0].start;
463 phys_size_t getenv_bootm_size(void)
465 phys_size_t tmp, size;
467 char *s = getenv("bootm_size");
469 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
473 #if defined(CONFIG_ARM) && defined(CONFIG_NR_DRAM_BANKS)
474 start = gd->bd->bi_dram[0].start;
475 size = gd->bd->bi_dram[0].size;
477 start = gd->bd->bi_memstart;
478 size = gd->bd->bi_memsize;
481 s = getenv("bootm_low");
483 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
487 return size - (tmp - start);
490 phys_size_t getenv_bootm_mapsize(void)
493 char *s = getenv("bootm_mapsize");
495 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
499 #if defined(CONFIG_SYS_BOOTMAPSZ)
500 return CONFIG_SYS_BOOTMAPSZ;
502 return getenv_bootm_size();
506 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
511 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
517 size_t tail = (len > chunksz) ? chunksz : len;
523 memmove(to, from, tail);
530 #else /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
531 memmove(to, from, len);
532 #endif /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
534 #endif /* !USE_HOSTCC */
536 void genimg_print_size(uint32_t size)
539 printf("%d Bytes = ", size);
540 print_size(size, "\n");
542 printf("%d Bytes = %.2f kB = %.2f MB\n",
543 size, (double)size / 1.024e3,
544 (double)size / 1.048576e6);
548 #if IMAGE_ENABLE_TIMESTAMP
549 void genimg_print_time(time_t timestamp)
554 rtc_to_tm(timestamp, &tm);
555 printf("%4d-%02d-%02d %2d:%02d:%02d UTC\n",
556 tm.tm_year, tm.tm_mon, tm.tm_mday,
557 tm.tm_hour, tm.tm_min, tm.tm_sec);
559 printf("%s", ctime(×tamp));
564 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
566 for (; table->id >= 0; ++table) {
574 * get_table_entry_name - translate entry id to long name
575 * @table: pointer to a translation table for entries of a specific type
576 * @msg: message to be returned when translation fails
577 * @id: entry id to be translated
579 * get_table_entry_name() will go over translation table trying to find
580 * entry that matches given id. If matching entry is found, its long
581 * name is returned to the caller.
584 * long entry name if translation succeeds
587 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
589 table = get_table_entry(table, id);
592 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
595 return table->lname + gd->reloc_off;
599 const char *genimg_get_os_name(uint8_t os)
601 return (get_table_entry_name(uimage_os, "Unknown OS", os));
604 const char *genimg_get_arch_name(uint8_t arch)
606 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
610 const char *genimg_get_type_name(uint8_t type)
612 return (get_table_entry_name(uimage_type, "Unknown Image", type));
615 static const char *genimg_get_short_name(const table_entry_t *table, int val)
617 table = get_table_entry(table, val);
620 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
623 return table->sname + gd->reloc_off;
627 const char *genimg_get_type_short_name(uint8_t type)
629 return genimg_get_short_name(uimage_type, type);
632 const char *genimg_get_comp_name(uint8_t comp)
634 return (get_table_entry_name(uimage_comp, "Unknown Compression",
638 const char *genimg_get_comp_short_name(uint8_t comp)
640 return genimg_get_short_name(uimage_comp, comp);
643 const char *genimg_get_os_short_name(uint8_t os)
645 return genimg_get_short_name(uimage_os, os);
648 const char *genimg_get_arch_short_name(uint8_t arch)
650 return genimg_get_short_name(uimage_arch, arch);
654 * get_table_entry_id - translate short entry name to id
655 * @table: pointer to a translation table for entries of a specific type
656 * @table_name: to be used in case of error
657 * @name: entry short name to be translated
659 * get_table_entry_id() will go over translation table trying to find
660 * entry that matches given short name. If matching entry is found,
661 * its id returned to the caller.
664 * entry id if translation succeeds
667 int get_table_entry_id(const table_entry_t *table,
668 const char *table_name, const char *name)
670 const table_entry_t *t;
672 for (t = table; t->id >= 0; ++t) {
673 #ifdef CONFIG_NEEDS_MANUAL_RELOC
674 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
676 if (t->sname && strcasecmp(t->sname, name) == 0)
680 debug("Invalid %s Type: %s\n", table_name, name);
685 int genimg_get_os_id(const char *name)
687 return (get_table_entry_id(uimage_os, "OS", name));
690 int genimg_get_arch_id(const char *name)
692 return (get_table_entry_id(uimage_arch, "CPU", name));
695 int genimg_get_type_id(const char *name)
697 return (get_table_entry_id(uimage_type, "Image", name));
700 int genimg_get_comp_id(const char *name)
702 return (get_table_entry_id(uimage_comp, "Compression", name));
707 * genimg_get_kernel_addr_fit - get the real kernel address and return 2
709 * @img_addr: a string might contain real image address
710 * @fit_uname_config: double pointer to a char, will hold pointer to a
711 * configuration unit name
712 * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
715 * genimg_get_kernel_addr_fit get the real kernel start address from a string
716 * which is normally the first argv of bootm/bootz
719 * kernel start address
721 ulong genimg_get_kernel_addr_fit(char * const img_addr,
722 const char **fit_uname_config,
723 const char **fit_uname_kernel)
727 /* find out kernel image address */
729 kernel_addr = load_addr;
730 debug("* kernel: default image load address = 0x%08lx\n",
732 #if CONFIG_IS_ENABLED(FIT)
733 } else if (fit_parse_conf(img_addr, load_addr, &kernel_addr,
735 debug("* kernel: config '%s' from image at 0x%08lx\n",
736 *fit_uname_config, kernel_addr);
737 } else if (fit_parse_subimage(img_addr, load_addr, &kernel_addr,
739 debug("* kernel: subimage '%s' from image at 0x%08lx\n",
740 *fit_uname_kernel, kernel_addr);
743 kernel_addr = simple_strtoul(img_addr, NULL, 16);
744 debug("* kernel: cmdline image address = 0x%08lx\n",
752 * genimg_get_kernel_addr() is the simple version of
753 * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
755 ulong genimg_get_kernel_addr(char * const img_addr)
757 const char *fit_uname_config = NULL;
758 const char *fit_uname_kernel = NULL;
760 return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
765 * genimg_get_format - get image format type
766 * @img_addr: image start address
768 * genimg_get_format() checks whether provided address points to a valid
769 * legacy or FIT image.
771 * New uImage format and FDT blob are based on a libfdt. FDT blob
772 * may be passed directly or embedded in a FIT image. In both situations
773 * genimg_get_format() must be able to dectect libfdt header.
776 * image format type or IMAGE_FORMAT_INVALID if no image is present
778 int genimg_get_format(const void *img_addr)
780 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
781 const image_header_t *hdr;
783 hdr = (const image_header_t *)img_addr;
784 if (image_check_magic(hdr))
785 return IMAGE_FORMAT_LEGACY;
787 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
788 if (fdt_check_header(img_addr) == 0)
789 return IMAGE_FORMAT_FIT;
791 #ifdef CONFIG_ANDROID_BOOT_IMAGE
792 if (android_image_check_header(img_addr) == 0)
793 return IMAGE_FORMAT_ANDROID;
796 return IMAGE_FORMAT_INVALID;
800 * genimg_get_image - get image from special storage (if necessary)
801 * @img_addr: image start address
803 * genimg_get_image() checks if provided image start address is located
804 * in a dataflash storage. If so, image is moved to a system RAM memory.
807 * image start address after possible relocation from special storage
809 ulong genimg_get_image(ulong img_addr)
811 ulong ram_addr = img_addr;
813 #ifdef CONFIG_HAS_DATAFLASH
814 ulong h_size, d_size;
816 if (addr_dataflash(img_addr)) {
819 /* ger RAM address */
820 ram_addr = CONFIG_SYS_LOAD_ADDR;
822 /* get header size */
823 h_size = image_get_header_size();
825 if (sizeof(struct fdt_header) > h_size)
826 h_size = sizeof(struct fdt_header);
830 debug(" Reading image header from dataflash address "
831 "%08lx to RAM address %08lx\n", img_addr, ram_addr);
833 buf = map_sysmem(ram_addr, 0);
834 read_dataflash(img_addr, h_size, buf);
837 switch (genimg_get_format(buf)) {
838 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
839 case IMAGE_FORMAT_LEGACY:
840 d_size = image_get_data_size(buf);
841 debug(" Legacy format image found at 0x%08lx, "
847 case IMAGE_FORMAT_FIT:
848 d_size = fit_get_size(buf) - h_size;
849 debug(" FIT/FDT format image found at 0x%08lx, "
855 printf(" No valid image found at 0x%08lx\n",
860 /* read in image data */
861 debug(" Reading image remaining data from dataflash address "
862 "%08lx to RAM address %08lx\n", img_addr + h_size,
865 read_dataflash(img_addr + h_size, d_size,
866 (char *)(buf + h_size));
869 #endif /* CONFIG_HAS_DATAFLASH */
875 * fit_has_config - check if there is a valid FIT configuration
876 * @images: pointer to the bootm command headers structure
878 * fit_has_config() checks if there is a FIT configuration in use
879 * (if FTI support is present).
882 * 0, no FIT support or no configuration found
883 * 1, configuration found
885 int genimg_has_config(bootm_headers_t *images)
888 if (images->fit_uname_cfg)
895 * boot_get_ramdisk - main ramdisk handling routine
896 * @argc: command argument count
897 * @argv: command argument list
898 * @images: pointer to the bootm images structure
899 * @arch: expected ramdisk architecture
900 * @rd_start: pointer to a ulong variable, will hold ramdisk start address
901 * @rd_end: pointer to a ulong variable, will hold ramdisk end
903 * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
904 * Curently supported are the following ramdisk sources:
905 * - multicomponent kernel/ramdisk image,
906 * - commandline provided address of decicated ramdisk image.
909 * 0, if ramdisk image was found and valid, or skiped
910 * rd_start and rd_end are set to ramdisk start/end addresses if
911 * ramdisk image is found and valid
913 * 1, if ramdisk image is found but corrupted, or invalid
914 * rd_start and rd_end are set to 0 if no ramdisk exists
916 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
917 uint8_t arch, ulong *rd_start, ulong *rd_end)
919 ulong rd_addr, rd_load;
920 ulong rd_data, rd_len;
921 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
922 const image_header_t *rd_hdr;
925 #ifdef CONFIG_SUPPORT_RAW_INITRD
929 const char *fit_uname_config = images->fit_uname_cfg;
930 const char *fit_uname_ramdisk = NULL;
934 const char *select = NULL;
939 #ifdef CONFIG_ANDROID_BOOT_IMAGE
941 * Look for an Android boot image.
943 buf = map_sysmem(images->os.start, 0);
944 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
952 * Look for a '-' which indicates to ignore the
955 if (select && strcmp(select, "-") == 0) {
956 debug("## Skipping init Ramdisk\n");
957 rd_len = rd_data = 0;
958 } else if (select || genimg_has_config(images)) {
962 * If the init ramdisk comes from the FIT image and
963 * the FIT image address is omitted in the command
964 * line argument, try to use os FIT image address or
965 * default load address.
967 if (images->fit_uname_os)
968 default_addr = (ulong)images->fit_hdr_os;
970 default_addr = load_addr;
972 if (fit_parse_conf(select, default_addr,
973 &rd_addr, &fit_uname_config)) {
974 debug("* ramdisk: config '%s' from image at "
976 fit_uname_config, rd_addr);
977 } else if (fit_parse_subimage(select, default_addr,
978 &rd_addr, &fit_uname_ramdisk)) {
979 debug("* ramdisk: subimage '%s' from image at "
981 fit_uname_ramdisk, rd_addr);
985 rd_addr = simple_strtoul(select, NULL, 16);
986 debug("* ramdisk: cmdline image address = "
992 /* use FIT configuration provided in first bootm
993 * command argument. If the property is not defined,
996 rd_addr = map_to_sysmem(images->fit_hdr_os);
997 rd_noffset = fit_get_node_from_config(images,
998 FIT_RAMDISK_PROP, rd_addr);
999 if (rd_noffset == -ENOLINK)
1001 else if (rd_noffset < 0)
1006 /* copy from dataflash if needed */
1007 rd_addr = genimg_get_image(rd_addr);
1010 * Check if there is an initrd image at the
1011 * address provided in the second bootm argument
1012 * check image type, for FIT images get FIT node.
1014 buf = map_sysmem(rd_addr, 0);
1015 switch (genimg_get_format(buf)) {
1016 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
1017 case IMAGE_FORMAT_LEGACY:
1018 printf("## Loading init Ramdisk from Legacy "
1019 "Image at %08lx ...\n", rd_addr);
1021 bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1022 rd_hdr = image_get_ramdisk(rd_addr, arch,
1028 rd_data = image_get_data(rd_hdr);
1029 rd_len = image_get_data_size(rd_hdr);
1030 rd_load = image_get_load(rd_hdr);
1033 #if IMAGE_ENABLE_FIT
1034 case IMAGE_FORMAT_FIT:
1035 rd_noffset = fit_image_load(images,
1036 rd_addr, &fit_uname_ramdisk,
1037 &fit_uname_config, arch,
1039 BOOTSTAGE_ID_FIT_RD_START,
1040 FIT_LOAD_OPTIONAL_NON_ZERO,
1045 images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1046 images->fit_uname_rd = fit_uname_ramdisk;
1047 images->fit_noffset_rd = rd_noffset;
1050 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1051 case IMAGE_FORMAT_ANDROID:
1052 android_image_get_ramdisk((void *)images->os.start,
1057 #ifdef CONFIG_SUPPORT_RAW_INITRD
1060 end = strchr(select, ':');
1062 rd_len = simple_strtoul(++end, NULL, 16);
1067 puts("Wrong Ramdisk Image Format\n");
1068 rd_data = rd_len = rd_load = 0;
1072 } else if (images->legacy_hdr_valid &&
1073 image_check_type(&images->legacy_hdr_os_copy,
1077 * Now check if we have a legacy mult-component image,
1078 * get second entry data start address and len.
1080 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1081 printf("## Loading init Ramdisk from multi component "
1082 "Legacy Image at %08lx ...\n",
1083 (ulong)images->legacy_hdr_os);
1085 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1090 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1091 rd_len = rd_data = 0;
1095 debug("## No init Ramdisk\n");
1097 *rd_start = rd_data;
1098 *rd_end = rd_data + rd_len;
1100 debug(" ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1101 *rd_start, *rd_end);
1106 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1108 * boot_ramdisk_high - relocate init ramdisk
1109 * @lmb: pointer to lmb handle, will be used for memory mgmt
1110 * @rd_data: ramdisk data start address
1111 * @rd_len: ramdisk data length
1112 * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1113 * start address (after possible relocation)
1114 * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1115 * end address (after possible relocation)
1117 * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1118 * variable and if requested ramdisk data is moved to a specified location.
1120 * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1121 * start/end addresses if ramdisk image start and len were provided,
1122 * otherwise set initrd_start and initrd_end set to zeros.
1128 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1129 ulong *initrd_start, ulong *initrd_end)
1133 int initrd_copy_to_ram = 1;
1135 if ((s = getenv("initrd_high")) != NULL) {
1136 /* a value of "no" or a similar string will act like 0,
1137 * turning the "load high" feature off. This is intentional.
1139 initrd_high = simple_strtoul(s, NULL, 16);
1140 if (initrd_high == ~0)
1141 initrd_copy_to_ram = 0;
1143 initrd_high = getenv_bootm_mapsize() + getenv_bootm_low();
1147 #ifdef CONFIG_LOGBUFFER
1148 /* Prevent initrd from overwriting logbuffer */
1149 lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1152 debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1153 initrd_high, initrd_copy_to_ram);
1156 if (!initrd_copy_to_ram) { /* zero-copy ramdisk support */
1157 debug(" in-place initrd\n");
1158 *initrd_start = rd_data;
1159 *initrd_end = rd_data + rd_len;
1160 lmb_reserve(lmb, rd_data, rd_len);
1163 *initrd_start = (ulong)lmb_alloc_base(lmb,
1164 rd_len, 0x1000, initrd_high);
1166 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1169 if (*initrd_start == 0) {
1170 puts("ramdisk - allocation error\n");
1173 bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1175 *initrd_end = *initrd_start + rd_len;
1176 printf(" Loading Ramdisk to %08lx, end %08lx ... ",
1177 *initrd_start, *initrd_end);
1179 memmove_wd((void *)*initrd_start,
1180 (void *)rd_data, rd_len, CHUNKSZ);
1184 * Ensure the image is flushed to memory to handle
1185 * AMP boot scenarios in which we might not be
1188 flush_cache((unsigned long)*initrd_start, rd_len);
1196 debug(" ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1197 *initrd_start, *initrd_end);
1204 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1206 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1207 ulong *setup_start, ulong *setup_len)
1209 #if IMAGE_ENABLE_FIT
1210 return boot_get_setup_fit(images, arch, setup_start, setup_len);
1216 #if IMAGE_ENABLE_FIT
1217 #if defined(CONFIG_FPGA) && defined(CONFIG_FPGA_XILINX)
1218 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1219 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1221 ulong tmp_img_addr, img_data, img_len;
1227 int devnum = 0; /* TODO support multi fpga platforms */
1228 const fpga_desc * const desc = fpga_get_desc(devnum);
1229 xilinx_desc *desc_xilinx = desc->devdesc;
1231 /* Check to see if the images struct has a FIT configuration */
1232 if (!genimg_has_config(images)) {
1233 debug("## FIT configuration was not specified\n");
1238 * Obtain the os FIT header from the images struct
1239 * copy from dataflash if needed
1241 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1242 tmp_img_addr = genimg_get_image(tmp_img_addr);
1243 buf = map_sysmem(tmp_img_addr, 0);
1245 * Check image type. For FIT images get FIT node
1246 * and attempt to locate a generic binary.
1248 switch (genimg_get_format(buf)) {
1249 case IMAGE_FORMAT_FIT:
1250 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1252 err = fdt_get_string_index(buf, conf_noffset, FIT_FPGA_PROP, 0,
1253 (const char **)&uname);
1255 debug("## FPGA image is not specified\n");
1258 fit_img_result = fit_image_load(images,
1260 (const char **)&uname,
1261 &(images->fit_uname_cfg),
1264 BOOTSTAGE_ID_FPGA_INIT,
1265 FIT_LOAD_OPTIONAL_NON_ZERO,
1266 &img_data, &img_len);
1268 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1269 uname, img_data, img_len);
1271 if (fit_img_result < 0) {
1272 /* Something went wrong! */
1273 return fit_img_result;
1276 if (img_len >= desc_xilinx->size) {
1278 err = fpga_loadbitstream(devnum, (char *)img_data,
1281 err = fpga_load(devnum, (const void *)img_data,
1285 err = fpga_loadbitstream(devnum, (char *)img_data,
1286 img_len, BIT_PARTIAL);
1288 err = fpga_load(devnum, (const void *)img_data,
1289 img_len, BIT_PARTIAL);
1292 printf(" Programming %s bitstream... ", name);
1299 printf("The given image format is not supported (corrupt?)\n");
1307 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1308 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1311 * These variables are used to hold the current image location
1316 * These two variables are requirements for fit_image_load, but
1317 * their values are not used
1319 ulong img_data, img_len;
1321 int loadables_index;
1326 /* Check to see if the images struct has a FIT configuration */
1327 if (!genimg_has_config(images)) {
1328 debug("## FIT configuration was not specified\n");
1333 * Obtain the os FIT header from the images struct
1334 * copy from dataflash if needed
1336 tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1337 tmp_img_addr = genimg_get_image(tmp_img_addr);
1338 buf = map_sysmem(tmp_img_addr, 0);
1340 * Check image type. For FIT images get FIT node
1341 * and attempt to locate a generic binary.
1343 switch (genimg_get_format(buf)) {
1344 case IMAGE_FORMAT_FIT:
1345 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1347 for (loadables_index = 0;
1348 fdt_get_string_index(buf, conf_noffset,
1351 (const char **)&uname) == 0;
1354 fit_img_result = fit_image_load(images,
1356 (const char **)&uname,
1357 &(images->fit_uname_cfg), arch,
1359 BOOTSTAGE_ID_FIT_LOADABLE_START,
1360 FIT_LOAD_OPTIONAL_NON_ZERO,
1361 &img_data, &img_len);
1362 if (fit_img_result < 0) {
1363 /* Something went wrong! */
1364 return fit_img_result;
1369 printf("The given image format is not supported (corrupt?)\n");
1377 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1379 * boot_get_cmdline - allocate and initialize kernel cmdline
1380 * @lmb: pointer to lmb handle, will be used for memory mgmt
1381 * @cmd_start: pointer to a ulong variable, will hold cmdline start
1382 * @cmd_end: pointer to a ulong variable, will hold cmdline end
1384 * boot_get_cmdline() allocates space for kernel command line below
1385 * BOOTMAPSZ + getenv_bootm_low() address. If "bootargs" U-Boot environemnt
1386 * variable is present its contents is copied to allocated kernel
1393 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1398 cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1399 getenv_bootm_mapsize() + getenv_bootm_low());
1401 if (cmdline == NULL)
1404 if ((s = getenv("bootargs")) == NULL)
1409 *cmd_start = (ulong) & cmdline[0];
1410 *cmd_end = *cmd_start + strlen(cmdline);
1412 debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1416 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1418 #ifdef CONFIG_SYS_BOOT_GET_KBD
1420 * boot_get_kbd - allocate and initialize kernel copy of board info
1421 * @lmb: pointer to lmb handle, will be used for memory mgmt
1422 * @kbd: double pointer to board info data
1424 * boot_get_kbd() allocates space for kernel copy of board info data below
1425 * BOOTMAPSZ + getenv_bootm_low() address and kernel board info is initialized
1426 * with the current u-boot board info data.
1432 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1434 *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1435 getenv_bootm_mapsize() + getenv_bootm_low());
1441 debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1443 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1444 do_bdinfo(NULL, 0, 0, NULL);
1449 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1452 int image_setup_linux(bootm_headers_t *images)
1454 ulong of_size = images->ft_len;
1455 char **of_flat_tree = &images->ft_addr;
1456 ulong *initrd_start = &images->initrd_start;
1457 ulong *initrd_end = &images->initrd_end;
1458 struct lmb *lmb = &images->lmb;
1462 if (IMAGE_ENABLE_OF_LIBFDT)
1463 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1465 if (IMAGE_BOOT_GET_CMDLINE) {
1466 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1467 &images->cmdline_end);
1469 puts("ERROR with allocation of cmdline\n");
1473 if (IMAGE_ENABLE_RAMDISK_HIGH) {
1474 rd_len = images->rd_end - images->rd_start;
1475 ret = boot_ramdisk_high(lmb, images->rd_start, rd_len,
1476 initrd_start, initrd_end);
1481 if (IMAGE_ENABLE_OF_LIBFDT) {
1482 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1487 if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1488 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1495 #endif /* CONFIG_LMB */
1496 #endif /* !USE_HOSTCC */