efi_loader: create reservations after ft_board_setup
[oweals/u-boot.git] / common / image.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2008 Semihalf
4  *
5  * (C) Copyright 2000-2006
6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7  */
8
9 #ifndef USE_HOSTCC
10 #include <common.h>
11 #include <cpu_func.h>
12 #include <env.h>
13 #include <malloc.h>
14 #include <u-boot/crc.h>
15 #include <watchdog.h>
16
17 #ifdef CONFIG_SHOW_BOOT_PROGRESS
18 #include <status_led.h>
19 #endif
20
21 #include <rtc.h>
22
23 #include <gzip.h>
24 #include <image.h>
25 #include <lz4.h>
26 #include <mapmem.h>
27
28 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
29 #include <linux/libfdt.h>
30 #include <fdt_support.h>
31 #include <fpga.h>
32 #include <xilinx.h>
33 #endif
34
35 #include <u-boot/md5.h>
36 #include <u-boot/sha1.h>
37 #include <linux/errno.h>
38 #include <asm/io.h>
39
40 #include <bzlib.h>
41 #include <linux/lzo.h>
42 #include <lzma/LzmaTypes.h>
43 #include <lzma/LzmaDec.h>
44 #include <lzma/LzmaTools.h>
45
46 #ifdef CONFIG_CMD_BDI
47 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
48 #endif
49
50 DECLARE_GLOBAL_DATA_PTR;
51
52 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
53 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
54                                                 int verify);
55 #endif
56 #else
57 #include "mkimage.h"
58 #include <u-boot/md5.h>
59 #include <time.h>
60 #include <image.h>
61
62 #ifndef __maybe_unused
63 # define __maybe_unused         /* unimplemented */
64 #endif
65 #endif /* !USE_HOSTCC*/
66
67 #include <u-boot/crc.h>
68 #include <imximage.h>
69
70 #ifndef CONFIG_SYS_BARGSIZE
71 #define CONFIG_SYS_BARGSIZE 512
72 #endif
73
74 static const table_entry_t uimage_arch[] = {
75         {       IH_ARCH_INVALID,        "invalid",      "Invalid ARCH", },
76         {       IH_ARCH_ALPHA,          "alpha",        "Alpha",        },
77         {       IH_ARCH_ARM,            "arm",          "ARM",          },
78         {       IH_ARCH_I386,           "x86",          "Intel x86",    },
79         {       IH_ARCH_IA64,           "ia64",         "IA64",         },
80         {       IH_ARCH_M68K,           "m68k",         "M68K",         },
81         {       IH_ARCH_MICROBLAZE,     "microblaze",   "MicroBlaze",   },
82         {       IH_ARCH_MIPS,           "mips",         "MIPS",         },
83         {       IH_ARCH_MIPS64,         "mips64",       "MIPS 64 Bit",  },
84         {       IH_ARCH_NIOS2,          "nios2",        "NIOS II",      },
85         {       IH_ARCH_PPC,            "powerpc",      "PowerPC",      },
86         {       IH_ARCH_PPC,            "ppc",          "PowerPC",      },
87         {       IH_ARCH_S390,           "s390",         "IBM S390",     },
88         {       IH_ARCH_SH,             "sh",           "SuperH",       },
89         {       IH_ARCH_SPARC,          "sparc",        "SPARC",        },
90         {       IH_ARCH_SPARC64,        "sparc64",      "SPARC 64 Bit", },
91         {       IH_ARCH_BLACKFIN,       "blackfin",     "Blackfin",     },
92         {       IH_ARCH_AVR32,          "avr32",        "AVR32",        },
93         {       IH_ARCH_NDS32,          "nds32",        "NDS32",        },
94         {       IH_ARCH_OPENRISC,       "or1k",         "OpenRISC 1000",},
95         {       IH_ARCH_SANDBOX,        "sandbox",      "Sandbox",      },
96         {       IH_ARCH_ARM64,          "arm64",        "AArch64",      },
97         {       IH_ARCH_ARC,            "arc",          "ARC",          },
98         {       IH_ARCH_X86_64,         "x86_64",       "AMD x86_64",   },
99         {       IH_ARCH_XTENSA,         "xtensa",       "Xtensa",       },
100         {       IH_ARCH_RISCV,          "riscv",        "RISC-V",       },
101         {       -1,                     "",             "",             },
102 };
103
104 static const table_entry_t uimage_os[] = {
105         {       IH_OS_INVALID,  "invalid",      "Invalid OS",           },
106         {       IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware"  },
107         {       IH_OS_LINUX,    "linux",        "Linux",                },
108 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
109         {       IH_OS_LYNXOS,   "lynxos",       "LynxOS",               },
110 #endif
111         {       IH_OS_NETBSD,   "netbsd",       "NetBSD",               },
112         {       IH_OS_OSE,      "ose",          "Enea OSE",             },
113         {       IH_OS_PLAN9,    "plan9",        "Plan 9",               },
114         {       IH_OS_RTEMS,    "rtems",        "RTEMS",                },
115         {       IH_OS_TEE,      "tee",          "Trusted Execution Environment" },
116         {       IH_OS_U_BOOT,   "u-boot",       "U-Boot",               },
117         {       IH_OS_VXWORKS,  "vxworks",      "VxWorks",              },
118 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
119         {       IH_OS_QNX,      "qnx",          "QNX",                  },
120 #endif
121 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
122         {       IH_OS_INTEGRITY,"integrity",    "INTEGRITY",            },
123 #endif
124 #ifdef USE_HOSTCC
125         {       IH_OS_4_4BSD,   "4_4bsd",       "4_4BSD",               },
126         {       IH_OS_DELL,     "dell",         "Dell",                 },
127         {       IH_OS_ESIX,     "esix",         "Esix",                 },
128         {       IH_OS_FREEBSD,  "freebsd",      "FreeBSD",              },
129         {       IH_OS_IRIX,     "irix",         "Irix",                 },
130         {       IH_OS_NCR,      "ncr",          "NCR",                  },
131         {       IH_OS_OPENBSD,  "openbsd",      "OpenBSD",              },
132         {       IH_OS_PSOS,     "psos",         "pSOS",                 },
133         {       IH_OS_SCO,      "sco",          "SCO",                  },
134         {       IH_OS_SOLARIS,  "solaris",      "Solaris",              },
135         {       IH_OS_SVR4,     "svr4",         "SVR4",                 },
136 #endif
137 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
138         {       IH_OS_OPENRTOS, "openrtos",     "OpenRTOS",             },
139 #endif
140         {       IH_OS_OPENSBI,  "opensbi",      "RISC-V OpenSBI",       },
141         {       IH_OS_EFI,      "efi",          "EFI Firmware" },
142
143         {       -1,             "",             "",                     },
144 };
145
146 static const table_entry_t uimage_type[] = {
147         {       IH_TYPE_AISIMAGE,   "aisimage",   "Davinci AIS image",},
148         {       IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image",   },
149         {       IH_TYPE_FIRMWARE,   "firmware",   "Firmware",           },
150         {       IH_TYPE_FLATDT,     "flat_dt",    "Flat Device Tree",   },
151         {       IH_TYPE_GPIMAGE,    "gpimage",    "TI Keystone SPL Image",},
152         {       IH_TYPE_KERNEL,     "kernel",     "Kernel Image",       },
153         {       IH_TYPE_KERNEL_NOLOAD, "kernel_noload",  "Kernel Image (no loading done)", },
154         {       IH_TYPE_KWBIMAGE,   "kwbimage",   "Kirkwood Boot Image",},
155         {       IH_TYPE_IMXIMAGE,   "imximage",   "Freescale i.MX Boot Image",},
156         {       IH_TYPE_IMX8IMAGE,  "imx8image",  "NXP i.MX8 Boot Image",},
157         {       IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
158         {       IH_TYPE_INVALID,    "invalid",    "Invalid Image",      },
159         {       IH_TYPE_MULTI,      "multi",      "Multi-File Image",   },
160         {       IH_TYPE_OMAPIMAGE,  "omapimage",  "TI OMAP SPL With GP CH",},
161         {       IH_TYPE_PBLIMAGE,   "pblimage",   "Freescale PBL Boot Image",},
162         {       IH_TYPE_RAMDISK,    "ramdisk",    "RAMDisk Image",      },
163         {       IH_TYPE_SCRIPT,     "script",     "Script",             },
164         {       IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
165         {       IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
166         {       IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
167         {       IH_TYPE_UBLIMAGE,   "ublimage",   "Davinci UBL image",},
168         {       IH_TYPE_MXSIMAGE,   "mxsimage",   "Freescale MXS Boot Image",},
169         {       IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
170         {       IH_TYPE_X86_SETUP,  "x86_setup",  "x86 setup.bin",    },
171         {       IH_TYPE_LPC32XXIMAGE, "lpc32xximage",  "LPC32XX Boot Image", },
172         {       IH_TYPE_RKIMAGE,    "rkimage",    "Rockchip Boot Image" },
173         {       IH_TYPE_RKSD,       "rksd",       "Rockchip SD Boot Image" },
174         {       IH_TYPE_RKSPI,      "rkspi",      "Rockchip SPI Boot Image" },
175         {       IH_TYPE_VYBRIDIMAGE, "vybridimage",  "Vybrid Boot Image", },
176         {       IH_TYPE_ZYNQIMAGE,  "zynqimage",  "Xilinx Zynq Boot Image" },
177         {       IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
178         {       IH_TYPE_ZYNQMPBIF,  "zynqmpbif",  "Xilinx ZynqMP Boot Image (bif)" },
179         {       IH_TYPE_FPGA,       "fpga",       "FPGA Image" },
180         {       IH_TYPE_TEE,        "tee",        "Trusted Execution Environment Image",},
181         {       IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
182         {       IH_TYPE_PMMC,        "pmmc",        "TI Power Management Micro-Controller Firmware",},
183         {       IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
184         {       IH_TYPE_MTKIMAGE,   "mtk_image",   "MediaTek BootROM loadable Image" },
185         {       IH_TYPE_COPRO, "copro", "Coprocessor Image"},
186         {       -1,                 "",           "",                   },
187 };
188
189 static const table_entry_t uimage_comp[] = {
190         {       IH_COMP_NONE,   "none",         "uncompressed",         },
191         {       IH_COMP_BZIP2,  "bzip2",        "bzip2 compressed",     },
192         {       IH_COMP_GZIP,   "gzip",         "gzip compressed",      },
193         {       IH_COMP_LZMA,   "lzma",         "lzma compressed",      },
194         {       IH_COMP_LZO,    "lzo",          "lzo compressed",       },
195         {       IH_COMP_LZ4,    "lz4",          "lz4 compressed",       },
196         {       -1,             "",             "",                     },
197 };
198
199 struct table_info {
200         const char *desc;
201         int count;
202         const table_entry_t *table;
203 };
204
205 static const struct table_info table_info[IH_COUNT] = {
206         { "architecture", IH_ARCH_COUNT, uimage_arch },
207         { "compression", IH_COMP_COUNT, uimage_comp },
208         { "operating system", IH_OS_COUNT, uimage_os },
209         { "image type", IH_TYPE_COUNT, uimage_type },
210 };
211
212 /*****************************************************************************/
213 /* Legacy format routines */
214 /*****************************************************************************/
215 int image_check_hcrc(const image_header_t *hdr)
216 {
217         ulong hcrc;
218         ulong len = image_get_header_size();
219         image_header_t header;
220
221         /* Copy header so we can blank CRC field for re-calculation */
222         memmove(&header, (char *)hdr, image_get_header_size());
223         image_set_hcrc(&header, 0);
224
225         hcrc = crc32(0, (unsigned char *)&header, len);
226
227         return (hcrc == image_get_hcrc(hdr));
228 }
229
230 int image_check_dcrc(const image_header_t *hdr)
231 {
232         ulong data = image_get_data(hdr);
233         ulong len = image_get_data_size(hdr);
234         ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
235
236         return (dcrc == image_get_dcrc(hdr));
237 }
238
239 /**
240  * image_multi_count - get component (sub-image) count
241  * @hdr: pointer to the header of the multi component image
242  *
243  * image_multi_count() returns number of components in a multi
244  * component image.
245  *
246  * Note: no checking of the image type is done, caller must pass
247  * a valid multi component image.
248  *
249  * returns:
250  *     number of components
251  */
252 ulong image_multi_count(const image_header_t *hdr)
253 {
254         ulong i, count = 0;
255         uint32_t *size;
256
257         /* get start of the image payload, which in case of multi
258          * component images that points to a table of component sizes */
259         size = (uint32_t *)image_get_data(hdr);
260
261         /* count non empty slots */
262         for (i = 0; size[i]; ++i)
263                 count++;
264
265         return count;
266 }
267
268 /**
269  * image_multi_getimg - get component data address and size
270  * @hdr: pointer to the header of the multi component image
271  * @idx: index of the requested component
272  * @data: pointer to a ulong variable, will hold component data address
273  * @len: pointer to a ulong variable, will hold component size
274  *
275  * image_multi_getimg() returns size and data address for the requested
276  * component in a multi component image.
277  *
278  * Note: no checking of the image type is done, caller must pass
279  * a valid multi component image.
280  *
281  * returns:
282  *     data address and size of the component, if idx is valid
283  *     0 in data and len, if idx is out of range
284  */
285 void image_multi_getimg(const image_header_t *hdr, ulong idx,
286                         ulong *data, ulong *len)
287 {
288         int i;
289         uint32_t *size;
290         ulong offset, count, img_data;
291
292         /* get number of component */
293         count = image_multi_count(hdr);
294
295         /* get start of the image payload, which in case of multi
296          * component images that points to a table of component sizes */
297         size = (uint32_t *)image_get_data(hdr);
298
299         /* get address of the proper component data start, which means
300          * skipping sizes table (add 1 for last, null entry) */
301         img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
302
303         if (idx < count) {
304                 *len = uimage_to_cpu(size[idx]);
305                 offset = 0;
306
307                 /* go over all indices preceding requested component idx */
308                 for (i = 0; i < idx; i++) {
309                         /* add up i-th component size, rounding up to 4 bytes */
310                         offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
311                 }
312
313                 /* calculate idx-th component data address */
314                 *data = img_data + offset;
315         } else {
316                 *len = 0;
317                 *data = 0;
318         }
319 }
320
321 static void image_print_type(const image_header_t *hdr)
322 {
323         const char __maybe_unused *os, *arch, *type, *comp;
324
325         os = genimg_get_os_name(image_get_os(hdr));
326         arch = genimg_get_arch_name(image_get_arch(hdr));
327         type = genimg_get_type_name(image_get_type(hdr));
328         comp = genimg_get_comp_name(image_get_comp(hdr));
329
330         printf("%s %s %s (%s)\n", arch, os, type, comp);
331 }
332
333 /**
334  * image_print_contents - prints out the contents of the legacy format image
335  * @ptr: pointer to the legacy format image header
336  * @p: pointer to prefix string
337  *
338  * image_print_contents() formats a multi line legacy image contents description.
339  * The routine prints out all header fields followed by the size/offset data
340  * for MULTI/SCRIPT images.
341  *
342  * returns:
343  *     no returned results
344  */
345 void image_print_contents(const void *ptr)
346 {
347         const image_header_t *hdr = (const image_header_t *)ptr;
348         const char __maybe_unused *p;
349
350         p = IMAGE_INDENT_STRING;
351         printf("%sImage Name:   %.*s\n", p, IH_NMLEN, image_get_name(hdr));
352         if (IMAGE_ENABLE_TIMESTAMP) {
353                 printf("%sCreated:      ", p);
354                 genimg_print_time((time_t)image_get_time(hdr));
355         }
356         printf("%sImage Type:   ", p);
357         image_print_type(hdr);
358         printf("%sData Size:    ", p);
359         genimg_print_size(image_get_data_size(hdr));
360         printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
361         printf("%sEntry Point:  %08x\n", p, image_get_ep(hdr));
362
363         if (image_check_type(hdr, IH_TYPE_MULTI) ||
364                         image_check_type(hdr, IH_TYPE_SCRIPT)) {
365                 int i;
366                 ulong data, len;
367                 ulong count = image_multi_count(hdr);
368
369                 printf("%sContents:\n", p);
370                 for (i = 0; i < count; i++) {
371                         image_multi_getimg(hdr, i, &data, &len);
372
373                         printf("%s   Image %d: ", p, i);
374                         genimg_print_size(len);
375
376                         if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
377                                 /*
378                                  * the user may need to know offsets
379                                  * if planning to do something with
380                                  * multiple files
381                                  */
382                                 printf("%s    Offset = 0x%08lx\n", p, data);
383                         }
384                 }
385         } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
386                 printf("HAB Blocks:   0x%08x   0x0000   0x%08x\n",
387                         image_get_load(hdr) - image_get_header_size(),
388                         (int)(image_get_size(hdr) + image_get_header_size()
389                         + sizeof(flash_header_v2_t) - 0x2060));
390         }
391 }
392
393 /**
394  * print_decomp_msg() - Print a suitable decompression/loading message
395  *
396  * @type:       OS type (IH_OS_...)
397  * @comp_type:  Compression type being used (IH_COMP_...)
398  * @is_xip:     true if the load address matches the image start
399  */
400 static void print_decomp_msg(int comp_type, int type, bool is_xip)
401 {
402         const char *name = genimg_get_type_name(type);
403
404         if (comp_type == IH_COMP_NONE)
405                 printf("   %s %s\n", is_xip ? "XIP" : "Loading", name);
406         else
407                 printf("   Uncompressing %s\n", name);
408 }
409
410 int image_decomp(int comp, ulong load, ulong image_start, int type,
411                  void *load_buf, void *image_buf, ulong image_len,
412                  uint unc_len, ulong *load_end)
413 {
414         int ret = 0;
415
416         *load_end = load;
417         print_decomp_msg(comp, type, load == image_start);
418
419         /*
420          * Load the image to the right place, decompressing if needed. After
421          * this, image_len will be set to the number of uncompressed bytes
422          * loaded, ret will be non-zero on error.
423          */
424         switch (comp) {
425         case IH_COMP_NONE:
426                 if (load == image_start)
427                         break;
428                 if (image_len <= unc_len)
429                         memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
430                 else
431                         ret = -ENOSPC;
432                 break;
433 #ifdef CONFIG_GZIP
434         case IH_COMP_GZIP: {
435                 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
436                 break;
437         }
438 #endif /* CONFIG_GZIP */
439 #ifdef CONFIG_BZIP2
440         case IH_COMP_BZIP2: {
441                 uint size = unc_len;
442
443                 /*
444                  * If we've got less than 4 MB of malloc() space,
445                  * use slower decompression algorithm which requires
446                  * at most 2300 KB of memory.
447                  */
448                 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
449                         image_buf, image_len,
450                         CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
451                 image_len = size;
452                 break;
453         }
454 #endif /* CONFIG_BZIP2 */
455 #ifdef CONFIG_LZMA
456         case IH_COMP_LZMA: {
457                 SizeT lzma_len = unc_len;
458
459                 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
460                                                image_buf, image_len);
461                 image_len = lzma_len;
462                 break;
463         }
464 #endif /* CONFIG_LZMA */
465 #ifdef CONFIG_LZO
466         case IH_COMP_LZO: {
467                 size_t size = unc_len;
468
469                 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
470                 image_len = size;
471                 break;
472         }
473 #endif /* CONFIG_LZO */
474 #ifdef CONFIG_LZ4
475         case IH_COMP_LZ4: {
476                 size_t size = unc_len;
477
478                 ret = ulz4fn(image_buf, image_len, load_buf, &size);
479                 image_len = size;
480                 break;
481         }
482 #endif /* CONFIG_LZ4 */
483         default:
484                 printf("Unimplemented compression type %d\n", comp);
485                 return -ENOSYS;
486         }
487
488         *load_end = load + image_len;
489
490         return ret;
491 }
492
493
494 #ifndef USE_HOSTCC
495 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
496 /**
497  * image_get_ramdisk - get and verify ramdisk image
498  * @rd_addr: ramdisk image start address
499  * @arch: expected ramdisk architecture
500  * @verify: checksum verification flag
501  *
502  * image_get_ramdisk() returns a pointer to the verified ramdisk image
503  * header. Routine receives image start address and expected architecture
504  * flag. Verification done covers data and header integrity and os/type/arch
505  * fields checking.
506  *
507  * returns:
508  *     pointer to a ramdisk image header, if image was found and valid
509  *     otherwise, return NULL
510  */
511 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
512                                                 int verify)
513 {
514         const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
515
516         if (!image_check_magic(rd_hdr)) {
517                 puts("Bad Magic Number\n");
518                 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
519                 return NULL;
520         }
521
522         if (!image_check_hcrc(rd_hdr)) {
523                 puts("Bad Header Checksum\n");
524                 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
525                 return NULL;
526         }
527
528         bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
529         image_print_contents(rd_hdr);
530
531         if (verify) {
532                 puts("   Verifying Checksum ... ");
533                 if (!image_check_dcrc(rd_hdr)) {
534                         puts("Bad Data CRC\n");
535                         bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
536                         return NULL;
537                 }
538                 puts("OK\n");
539         }
540
541         bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
542
543         if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
544             !image_check_arch(rd_hdr, arch) ||
545             !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
546                 printf("No Linux %s Ramdisk Image\n",
547                                 genimg_get_arch_name(arch));
548                 bootstage_error(BOOTSTAGE_ID_RAMDISK);
549                 return NULL;
550         }
551
552         return rd_hdr;
553 }
554 #endif
555 #endif /* !USE_HOSTCC */
556
557 /*****************************************************************************/
558 /* Shared dual-format routines */
559 /*****************************************************************************/
560 #ifndef USE_HOSTCC
561 ulong image_load_addr = CONFIG_SYS_LOAD_ADDR;   /* Default Load Address */
562 ulong image_save_addr;                  /* Default Save Address */
563 ulong image_save_size;                  /* Default Save Size (in bytes) */
564
565 static int on_loadaddr(const char *name, const char *value, enum env_op op,
566         int flags)
567 {
568         switch (op) {
569         case env_op_create:
570         case env_op_overwrite:
571                 image_load_addr = simple_strtoul(value, NULL, 16);
572                 break;
573         default:
574                 break;
575         }
576
577         return 0;
578 }
579 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
580
581 ulong env_get_bootm_low(void)
582 {
583         char *s = env_get("bootm_low");
584         if (s) {
585                 ulong tmp = simple_strtoul(s, NULL, 16);
586                 return tmp;
587         }
588
589 #if defined(CONFIG_SYS_SDRAM_BASE)
590         return CONFIG_SYS_SDRAM_BASE;
591 #elif defined(CONFIG_ARM) || defined(CONFIG_MICROBLAZE)
592         return gd->bd->bi_dram[0].start;
593 #else
594         return 0;
595 #endif
596 }
597
598 phys_size_t env_get_bootm_size(void)
599 {
600         phys_size_t tmp, size;
601         phys_addr_t start;
602         char *s = env_get("bootm_size");
603         if (s) {
604                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
605                 return tmp;
606         }
607
608 #if (defined(CONFIG_ARM) || defined(CONFIG_MICROBLAZE)) && \
609      defined(CONFIG_NR_DRAM_BANKS)
610         start = gd->bd->bi_dram[0].start;
611         size = gd->bd->bi_dram[0].size;
612 #else
613         start = gd->bd->bi_memstart;
614         size = gd->bd->bi_memsize;
615 #endif
616
617         s = env_get("bootm_low");
618         if (s)
619                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
620         else
621                 tmp = start;
622
623         return size - (tmp - start);
624 }
625
626 phys_size_t env_get_bootm_mapsize(void)
627 {
628         phys_size_t tmp;
629         char *s = env_get("bootm_mapsize");
630         if (s) {
631                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
632                 return tmp;
633         }
634
635 #if defined(CONFIG_SYS_BOOTMAPSZ)
636         return CONFIG_SYS_BOOTMAPSZ;
637 #else
638         return env_get_bootm_size();
639 #endif
640 }
641
642 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
643 {
644         if (to == from)
645                 return;
646
647 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
648         if (to > from) {
649                 from += len;
650                 to += len;
651         }
652         while (len > 0) {
653                 size_t tail = (len > chunksz) ? chunksz : len;
654                 WATCHDOG_RESET();
655                 if (to > from) {
656                         to -= tail;
657                         from -= tail;
658                 }
659                 memmove(to, from, tail);
660                 if (to < from) {
661                         to += tail;
662                         from += tail;
663                 }
664                 len -= tail;
665         }
666 #else   /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
667         memmove(to, from, len);
668 #endif  /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
669 }
670 #else   /* USE_HOSTCC */
671 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
672 {
673         memmove(to, from, len);
674 }
675 #endif /* !USE_HOSTCC */
676
677 void genimg_print_size(uint32_t size)
678 {
679 #ifndef USE_HOSTCC
680         printf("%d Bytes = ", size);
681         print_size(size, "\n");
682 #else
683         printf("%d Bytes = %.2f KiB = %.2f MiB\n",
684                         size, (double)size / 1.024e3,
685                         (double)size / 1.048576e6);
686 #endif
687 }
688
689 #if IMAGE_ENABLE_TIMESTAMP
690 void genimg_print_time(time_t timestamp)
691 {
692 #ifndef USE_HOSTCC
693         struct rtc_time tm;
694
695         rtc_to_tm(timestamp, &tm);
696         printf("%4d-%02d-%02d  %2d:%02d:%02d UTC\n",
697                         tm.tm_year, tm.tm_mon, tm.tm_mday,
698                         tm.tm_hour, tm.tm_min, tm.tm_sec);
699 #else
700         printf("%s", ctime(&timestamp));
701 #endif
702 }
703 #endif
704
705 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
706 {
707         for (; table->id >= 0; ++table) {
708                 if (table->id == id)
709                         return table;
710         }
711         return NULL;
712 }
713
714 static const char *unknown_msg(enum ih_category category)
715 {
716         static const char unknown_str[] = "Unknown ";
717         static char msg[30];
718
719         strcpy(msg, unknown_str);
720         strncat(msg, table_info[category].desc,
721                 sizeof(msg) - sizeof(unknown_str));
722
723         return msg;
724 }
725
726 /**
727  * get_cat_table_entry_name - translate entry id to long name
728  * @category: category to look up (enum ih_category)
729  * @id: entry id to be translated
730  *
731  * This will scan the translation table trying to find the entry that matches
732  * the given id.
733  *
734  * @retur long entry name if translation succeeds; error string on failure
735  */
736 const char *genimg_get_cat_name(enum ih_category category, uint id)
737 {
738         const table_entry_t *entry;
739
740         entry = get_table_entry(table_info[category].table, id);
741         if (!entry)
742                 return unknown_msg(category);
743 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
744         return entry->lname;
745 #else
746         return entry->lname + gd->reloc_off;
747 #endif
748 }
749
750 /**
751  * get_cat_table_entry_short_name - translate entry id to short name
752  * @category: category to look up (enum ih_category)
753  * @id: entry id to be translated
754  *
755  * This will scan the translation table trying to find the entry that matches
756  * the given id.
757  *
758  * @retur short entry name if translation succeeds; error string on failure
759  */
760 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
761 {
762         const table_entry_t *entry;
763
764         entry = get_table_entry(table_info[category].table, id);
765         if (!entry)
766                 return unknown_msg(category);
767 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
768         return entry->sname;
769 #else
770         return entry->sname + gd->reloc_off;
771 #endif
772 }
773
774 int genimg_get_cat_count(enum ih_category category)
775 {
776         return table_info[category].count;
777 }
778
779 const char *genimg_get_cat_desc(enum ih_category category)
780 {
781         return table_info[category].desc;
782 }
783
784 /**
785  * get_table_entry_name - translate entry id to long name
786  * @table: pointer to a translation table for entries of a specific type
787  * @msg: message to be returned when translation fails
788  * @id: entry id to be translated
789  *
790  * get_table_entry_name() will go over translation table trying to find
791  * entry that matches given id. If matching entry is found, its long
792  * name is returned to the caller.
793  *
794  * returns:
795  *     long entry name if translation succeeds
796  *     msg otherwise
797  */
798 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
799 {
800         table = get_table_entry(table, id);
801         if (!table)
802                 return msg;
803 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
804         return table->lname;
805 #else
806         return table->lname + gd->reloc_off;
807 #endif
808 }
809
810 const char *genimg_get_os_name(uint8_t os)
811 {
812         return (get_table_entry_name(uimage_os, "Unknown OS", os));
813 }
814
815 const char *genimg_get_arch_name(uint8_t arch)
816 {
817         return (get_table_entry_name(uimage_arch, "Unknown Architecture",
818                                         arch));
819 }
820
821 const char *genimg_get_type_name(uint8_t type)
822 {
823         return (get_table_entry_name(uimage_type, "Unknown Image", type));
824 }
825
826 static const char *genimg_get_short_name(const table_entry_t *table, int val)
827 {
828         table = get_table_entry(table, val);
829         if (!table)
830                 return "unknown";
831 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
832         return table->sname;
833 #else
834         return table->sname + gd->reloc_off;
835 #endif
836 }
837
838 const char *genimg_get_type_short_name(uint8_t type)
839 {
840         return genimg_get_short_name(uimage_type, type);
841 }
842
843 const char *genimg_get_comp_name(uint8_t comp)
844 {
845         return (get_table_entry_name(uimage_comp, "Unknown Compression",
846                                         comp));
847 }
848
849 const char *genimg_get_comp_short_name(uint8_t comp)
850 {
851         return genimg_get_short_name(uimage_comp, comp);
852 }
853
854 const char *genimg_get_os_short_name(uint8_t os)
855 {
856         return genimg_get_short_name(uimage_os, os);
857 }
858
859 const char *genimg_get_arch_short_name(uint8_t arch)
860 {
861         return genimg_get_short_name(uimage_arch, arch);
862 }
863
864 /**
865  * get_table_entry_id - translate short entry name to id
866  * @table: pointer to a translation table for entries of a specific type
867  * @table_name: to be used in case of error
868  * @name: entry short name to be translated
869  *
870  * get_table_entry_id() will go over translation table trying to find
871  * entry that matches given short name. If matching entry is found,
872  * its id returned to the caller.
873  *
874  * returns:
875  *     entry id if translation succeeds
876  *     -1 otherwise
877  */
878 int get_table_entry_id(const table_entry_t *table,
879                 const char *table_name, const char *name)
880 {
881         const table_entry_t *t;
882
883         for (t = table; t->id >= 0; ++t) {
884 #ifdef CONFIG_NEEDS_MANUAL_RELOC
885                 if (t->sname && strcasecmp(t->sname + gd->reloc_off, name) == 0)
886 #else
887                 if (t->sname && strcasecmp(t->sname, name) == 0)
888 #endif
889                         return (t->id);
890         }
891         debug("Invalid %s Type: %s\n", table_name, name);
892
893         return -1;
894 }
895
896 int genimg_get_os_id(const char *name)
897 {
898         return (get_table_entry_id(uimage_os, "OS", name));
899 }
900
901 int genimg_get_arch_id(const char *name)
902 {
903         return (get_table_entry_id(uimage_arch, "CPU", name));
904 }
905
906 int genimg_get_type_id(const char *name)
907 {
908         return (get_table_entry_id(uimage_type, "Image", name));
909 }
910
911 int genimg_get_comp_id(const char *name)
912 {
913         return (get_table_entry_id(uimage_comp, "Compression", name));
914 }
915
916 #ifndef USE_HOSTCC
917 /**
918  * genimg_get_kernel_addr_fit - get the real kernel address and return 2
919  *                              FIT strings
920  * @img_addr: a string might contain real image address
921  * @fit_uname_config: double pointer to a char, will hold pointer to a
922  *                    configuration unit name
923  * @fit_uname_kernel: double pointer to a char, will hold pointer to a subimage
924  *                    name
925  *
926  * genimg_get_kernel_addr_fit get the real kernel start address from a string
927  * which is normally the first argv of bootm/bootz
928  *
929  * returns:
930  *     kernel start address
931  */
932 ulong genimg_get_kernel_addr_fit(char * const img_addr,
933                              const char **fit_uname_config,
934                              const char **fit_uname_kernel)
935 {
936         ulong kernel_addr;
937
938         /* find out kernel image address */
939         if (!img_addr) {
940                 kernel_addr = image_load_addr;
941                 debug("*  kernel: default image load address = 0x%08lx\n",
942                       image_load_addr);
943 #if CONFIG_IS_ENABLED(FIT)
944         } else if (fit_parse_conf(img_addr, image_load_addr, &kernel_addr,
945                                   fit_uname_config)) {
946                 debug("*  kernel: config '%s' from image at 0x%08lx\n",
947                       *fit_uname_config, kernel_addr);
948         } else if (fit_parse_subimage(img_addr, image_load_addr, &kernel_addr,
949                                      fit_uname_kernel)) {
950                 debug("*  kernel: subimage '%s' from image at 0x%08lx\n",
951                       *fit_uname_kernel, kernel_addr);
952 #endif
953         } else {
954                 kernel_addr = simple_strtoul(img_addr, NULL, 16);
955                 debug("*  kernel: cmdline image address = 0x%08lx\n",
956                       kernel_addr);
957         }
958
959         return kernel_addr;
960 }
961
962 /**
963  * genimg_get_kernel_addr() is the simple version of
964  * genimg_get_kernel_addr_fit(). It ignores those return FIT strings
965  */
966 ulong genimg_get_kernel_addr(char * const img_addr)
967 {
968         const char *fit_uname_config = NULL;
969         const char *fit_uname_kernel = NULL;
970
971         return genimg_get_kernel_addr_fit(img_addr, &fit_uname_config,
972                                           &fit_uname_kernel);
973 }
974
975 /**
976  * genimg_get_format - get image format type
977  * @img_addr: image start address
978  *
979  * genimg_get_format() checks whether provided address points to a valid
980  * legacy or FIT image.
981  *
982  * New uImage format and FDT blob are based on a libfdt. FDT blob
983  * may be passed directly or embedded in a FIT image. In both situations
984  * genimg_get_format() must be able to dectect libfdt header.
985  *
986  * returns:
987  *     image format type or IMAGE_FORMAT_INVALID if no image is present
988  */
989 int genimg_get_format(const void *img_addr)
990 {
991 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
992         const image_header_t *hdr;
993
994         hdr = (const image_header_t *)img_addr;
995         if (image_check_magic(hdr))
996                 return IMAGE_FORMAT_LEGACY;
997 #endif
998 #if IMAGE_ENABLE_FIT || IMAGE_ENABLE_OF_LIBFDT
999         if (fdt_check_header(img_addr) == 0)
1000                 return IMAGE_FORMAT_FIT;
1001 #endif
1002 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1003         if (android_image_check_header(img_addr) == 0)
1004                 return IMAGE_FORMAT_ANDROID;
1005 #endif
1006
1007         return IMAGE_FORMAT_INVALID;
1008 }
1009
1010 /**
1011  * fit_has_config - check if there is a valid FIT configuration
1012  * @images: pointer to the bootm command headers structure
1013  *
1014  * fit_has_config() checks if there is a FIT configuration in use
1015  * (if FTI support is present).
1016  *
1017  * returns:
1018  *     0, no FIT support or no configuration found
1019  *     1, configuration found
1020  */
1021 int genimg_has_config(bootm_headers_t *images)
1022 {
1023 #if IMAGE_ENABLE_FIT
1024         if (images->fit_uname_cfg)
1025                 return 1;
1026 #endif
1027         return 0;
1028 }
1029
1030 /**
1031  * boot_get_ramdisk - main ramdisk handling routine
1032  * @argc: command argument count
1033  * @argv: command argument list
1034  * @images: pointer to the bootm images structure
1035  * @arch: expected ramdisk architecture
1036  * @rd_start: pointer to a ulong variable, will hold ramdisk start address
1037  * @rd_end: pointer to a ulong variable, will hold ramdisk end
1038  *
1039  * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
1040  * Curently supported are the following ramdisk sources:
1041  *      - multicomponent kernel/ramdisk image,
1042  *      - commandline provided address of decicated ramdisk image.
1043  *
1044  * returns:
1045  *     0, if ramdisk image was found and valid, or skiped
1046  *     rd_start and rd_end are set to ramdisk start/end addresses if
1047  *     ramdisk image is found and valid
1048  *
1049  *     1, if ramdisk image is found but corrupted, or invalid
1050  *     rd_start and rd_end are set to 0 if no ramdisk exists
1051  */
1052 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
1053                 uint8_t arch, ulong *rd_start, ulong *rd_end)
1054 {
1055         ulong rd_addr, rd_load;
1056         ulong rd_data, rd_len;
1057 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1058         const image_header_t *rd_hdr;
1059 #endif
1060         void *buf;
1061 #ifdef CONFIG_SUPPORT_RAW_INITRD
1062         char *end;
1063 #endif
1064 #if IMAGE_ENABLE_FIT
1065         const char      *fit_uname_config = images->fit_uname_cfg;
1066         const char      *fit_uname_ramdisk = NULL;
1067         ulong           default_addr;
1068         int             rd_noffset;
1069 #endif
1070         const char *select = NULL;
1071
1072         *rd_start = 0;
1073         *rd_end = 0;
1074
1075 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1076         /*
1077          * Look for an Android boot image.
1078          */
1079         buf = map_sysmem(images->os.start, 0);
1080         if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID)
1081                 select = (argc == 0) ? env_get("loadaddr") : argv[0];
1082 #endif
1083
1084         if (argc >= 2)
1085                 select = argv[1];
1086
1087         /*
1088          * Look for a '-' which indicates to ignore the
1089          * ramdisk argument
1090          */
1091         if (select && strcmp(select, "-") ==  0) {
1092                 debug("## Skipping init Ramdisk\n");
1093                 rd_len = rd_data = 0;
1094         } else if (select || genimg_has_config(images)) {
1095 #if IMAGE_ENABLE_FIT
1096                 if (select) {
1097                         /*
1098                          * If the init ramdisk comes from the FIT image and
1099                          * the FIT image address is omitted in the command
1100                          * line argument, try to use os FIT image address or
1101                          * default load address.
1102                          */
1103                         if (images->fit_uname_os)
1104                                 default_addr = (ulong)images->fit_hdr_os;
1105                         else
1106                                 default_addr = image_load_addr;
1107
1108                         if (fit_parse_conf(select, default_addr,
1109                                            &rd_addr, &fit_uname_config)) {
1110                                 debug("*  ramdisk: config '%s' from image at "
1111                                                 "0x%08lx\n",
1112                                                 fit_uname_config, rd_addr);
1113                         } else if (fit_parse_subimage(select, default_addr,
1114                                                 &rd_addr, &fit_uname_ramdisk)) {
1115                                 debug("*  ramdisk: subimage '%s' from image at "
1116                                                 "0x%08lx\n",
1117                                                 fit_uname_ramdisk, rd_addr);
1118                         } else
1119 #endif
1120                         {
1121                                 rd_addr = simple_strtoul(select, NULL, 16);
1122                                 debug("*  ramdisk: cmdline image address = "
1123                                                 "0x%08lx\n",
1124                                                 rd_addr);
1125                         }
1126 #if IMAGE_ENABLE_FIT
1127                 } else {
1128                         /* use FIT configuration provided in first bootm
1129                          * command argument. If the property is not defined,
1130                          * quit silently.
1131                          */
1132                         rd_addr = map_to_sysmem(images->fit_hdr_os);
1133                         rd_noffset = fit_get_node_from_config(images,
1134                                         FIT_RAMDISK_PROP, rd_addr);
1135                         if (rd_noffset == -ENOENT)
1136                                 return 0;
1137                         else if (rd_noffset < 0)
1138                                 return 1;
1139                 }
1140 #endif
1141
1142                 /*
1143                  * Check if there is an initrd image at the
1144                  * address provided in the second bootm argument
1145                  * check image type, for FIT images get FIT node.
1146                  */
1147                 buf = map_sysmem(rd_addr, 0);
1148                 switch (genimg_get_format(buf)) {
1149 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
1150                 case IMAGE_FORMAT_LEGACY:
1151                         printf("## Loading init Ramdisk from Legacy "
1152                                         "Image at %08lx ...\n", rd_addr);
1153
1154                         bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
1155                         rd_hdr = image_get_ramdisk(rd_addr, arch,
1156                                                         images->verify);
1157
1158                         if (rd_hdr == NULL)
1159                                 return 1;
1160
1161                         rd_data = image_get_data(rd_hdr);
1162                         rd_len = image_get_data_size(rd_hdr);
1163                         rd_load = image_get_load(rd_hdr);
1164                         break;
1165 #endif
1166 #if IMAGE_ENABLE_FIT
1167                 case IMAGE_FORMAT_FIT:
1168                         rd_noffset = fit_image_load(images,
1169                                         rd_addr, &fit_uname_ramdisk,
1170                                         &fit_uname_config, arch,
1171                                         IH_TYPE_RAMDISK,
1172                                         BOOTSTAGE_ID_FIT_RD_START,
1173                                         FIT_LOAD_OPTIONAL_NON_ZERO,
1174                                         &rd_data, &rd_len);
1175                         if (rd_noffset < 0)
1176                                 return 1;
1177
1178                         images->fit_hdr_rd = map_sysmem(rd_addr, 0);
1179                         images->fit_uname_rd = fit_uname_ramdisk;
1180                         images->fit_noffset_rd = rd_noffset;
1181                         break;
1182 #endif
1183 #ifdef CONFIG_ANDROID_BOOT_IMAGE
1184                 case IMAGE_FORMAT_ANDROID:
1185                         android_image_get_ramdisk((void *)images->os.start,
1186                                 &rd_data, &rd_len);
1187                         break;
1188 #endif
1189                 default:
1190 #ifdef CONFIG_SUPPORT_RAW_INITRD
1191                         end = NULL;
1192                         if (select)
1193                                 end = strchr(select, ':');
1194                         if (end) {
1195                                 rd_len = simple_strtoul(++end, NULL, 16);
1196                                 rd_data = rd_addr;
1197                         } else
1198 #endif
1199                         {
1200                                 puts("Wrong Ramdisk Image Format\n");
1201                                 rd_data = rd_len = rd_load = 0;
1202                                 return 1;
1203                         }
1204                 }
1205         } else if (images->legacy_hdr_valid &&
1206                         image_check_type(&images->legacy_hdr_os_copy,
1207                                                 IH_TYPE_MULTI)) {
1208
1209                 /*
1210                  * Now check if we have a legacy mult-component image,
1211                  * get second entry data start address and len.
1212                  */
1213                 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
1214                 printf("## Loading init Ramdisk from multi component "
1215                                 "Legacy Image at %08lx ...\n",
1216                                 (ulong)images->legacy_hdr_os);
1217
1218                 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
1219         } else {
1220                 /*
1221                  * no initrd image
1222                  */
1223                 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
1224                 rd_len = rd_data = 0;
1225         }
1226
1227         if (!rd_data) {
1228                 debug("## No init Ramdisk\n");
1229         } else {
1230                 *rd_start = rd_data;
1231                 *rd_end = rd_data + rd_len;
1232         }
1233         debug("   ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
1234                         *rd_start, *rd_end);
1235
1236         return 0;
1237 }
1238
1239 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1240 /**
1241  * boot_ramdisk_high - relocate init ramdisk
1242  * @lmb: pointer to lmb handle, will be used for memory mgmt
1243  * @rd_data: ramdisk data start address
1244  * @rd_len: ramdisk data length
1245  * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
1246  *      start address (after possible relocation)
1247  * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
1248  *      end address (after possible relocation)
1249  *
1250  * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
1251  * variable and if requested ramdisk data is moved to a specified location.
1252  *
1253  * Initrd_start and initrd_end are set to final (after relocation) ramdisk
1254  * start/end addresses if ramdisk image start and len were provided,
1255  * otherwise set initrd_start and initrd_end set to zeros.
1256  *
1257  * returns:
1258  *      0 - success
1259  *     -1 - failure
1260  */
1261 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
1262                   ulong *initrd_start, ulong *initrd_end)
1263 {
1264         char    *s;
1265         ulong   initrd_high;
1266         int     initrd_copy_to_ram = 1;
1267
1268         s = env_get("initrd_high");
1269         if (s) {
1270                 /* a value of "no" or a similar string will act like 0,
1271                  * turning the "load high" feature off. This is intentional.
1272                  */
1273                 initrd_high = simple_strtoul(s, NULL, 16);
1274                 if (initrd_high == ~0)
1275                         initrd_copy_to_ram = 0;
1276         } else {
1277                 initrd_high = env_get_bootm_mapsize() + env_get_bootm_low();
1278         }
1279
1280
1281         debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1282                         initrd_high, initrd_copy_to_ram);
1283
1284         if (rd_data) {
1285                 if (!initrd_copy_to_ram) {      /* zero-copy ramdisk support */
1286                         debug("   in-place initrd\n");
1287                         *initrd_start = rd_data;
1288                         *initrd_end = rd_data + rd_len;
1289                         lmb_reserve(lmb, rd_data, rd_len);
1290                 } else {
1291                         if (initrd_high)
1292                                 *initrd_start = (ulong)lmb_alloc_base(lmb,
1293                                                 rd_len, 0x1000, initrd_high);
1294                         else
1295                                 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1296                                                                  0x1000);
1297
1298                         if (*initrd_start == 0) {
1299                                 puts("ramdisk - allocation error\n");
1300                                 goto error;
1301                         }
1302                         bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1303
1304                         *initrd_end = *initrd_start + rd_len;
1305                         printf("   Loading Ramdisk to %08lx, end %08lx ... ",
1306                                         *initrd_start, *initrd_end);
1307
1308                         memmove_wd((void *)*initrd_start,
1309                                         (void *)rd_data, rd_len, CHUNKSZ);
1310
1311 #ifdef CONFIG_MP
1312                         /*
1313                          * Ensure the image is flushed to memory to handle
1314                          * AMP boot scenarios in which we might not be
1315                          * HW cache coherent
1316                          */
1317                         flush_cache((unsigned long)*initrd_start,
1318                                     ALIGN(rd_len, ARCH_DMA_MINALIGN));
1319 #endif
1320                         puts("OK\n");
1321                 }
1322         } else {
1323                 *initrd_start = 0;
1324                 *initrd_end = 0;
1325         }
1326         debug("   ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1327                         *initrd_start, *initrd_end);
1328
1329         return 0;
1330
1331 error:
1332         return -1;
1333 }
1334 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1335
1336 int boot_get_setup(bootm_headers_t *images, uint8_t arch,
1337                    ulong *setup_start, ulong *setup_len)
1338 {
1339 #if IMAGE_ENABLE_FIT
1340         return boot_get_setup_fit(images, arch, setup_start, setup_len);
1341 #else
1342         return -ENOENT;
1343 #endif
1344 }
1345
1346 #if IMAGE_ENABLE_FIT
1347 #if defined(CONFIG_FPGA)
1348 int boot_get_fpga(int argc, char * const argv[], bootm_headers_t *images,
1349                   uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1350 {
1351         ulong tmp_img_addr, img_data, img_len;
1352         void *buf;
1353         int conf_noffset;
1354         int fit_img_result;
1355         const char *uname, *name;
1356         int err;
1357         int devnum = 0; /* TODO support multi fpga platforms */
1358
1359         /* Check to see if the images struct has a FIT configuration */
1360         if (!genimg_has_config(images)) {
1361                 debug("## FIT configuration was not specified\n");
1362                 return 0;
1363         }
1364
1365         /*
1366          * Obtain the os FIT header from the images struct
1367          */
1368         tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1369         buf = map_sysmem(tmp_img_addr, 0);
1370         /*
1371          * Check image type. For FIT images get FIT node
1372          * and attempt to locate a generic binary.
1373          */
1374         switch (genimg_get_format(buf)) {
1375         case IMAGE_FORMAT_FIT:
1376                 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1377
1378                 uname = fdt_stringlist_get(buf, conf_noffset, FIT_FPGA_PROP, 0,
1379                                            NULL);
1380                 if (!uname) {
1381                         debug("## FPGA image is not specified\n");
1382                         return 0;
1383                 }
1384                 fit_img_result = fit_image_load(images,
1385                                                 tmp_img_addr,
1386                                                 (const char **)&uname,
1387                                                 &(images->fit_uname_cfg),
1388                                                 arch,
1389                                                 IH_TYPE_FPGA,
1390                                                 BOOTSTAGE_ID_FPGA_INIT,
1391                                                 FIT_LOAD_OPTIONAL_NON_ZERO,
1392                                                 &img_data, &img_len);
1393
1394                 debug("FPGA image (%s) loaded to 0x%lx/size 0x%lx\n",
1395                       uname, img_data, img_len);
1396
1397                 if (fit_img_result < 0) {
1398                         /* Something went wrong! */
1399                         return fit_img_result;
1400                 }
1401
1402                 if (!fpga_is_partial_data(devnum, img_len)) {
1403                         name = "full";
1404                         err = fpga_loadbitstream(devnum, (char *)img_data,
1405                                                  img_len, BIT_FULL);
1406                         if (err)
1407                                 err = fpga_load(devnum, (const void *)img_data,
1408                                                 img_len, BIT_FULL);
1409                 } else {
1410                         name = "partial";
1411                         err = fpga_loadbitstream(devnum, (char *)img_data,
1412                                                  img_len, BIT_PARTIAL);
1413                         if (err)
1414                                 err = fpga_load(devnum, (const void *)img_data,
1415                                                 img_len, BIT_PARTIAL);
1416                 }
1417
1418                 if (err)
1419                         return err;
1420
1421                 printf("   Programming %s bitstream... OK\n", name);
1422                 break;
1423         default:
1424                 printf("The given image format is not supported (corrupt?)\n");
1425                 return 1;
1426         }
1427
1428         return 0;
1429 }
1430 #endif
1431
1432 static void fit_loadable_process(uint8_t img_type,
1433                                  ulong img_data,
1434                                  ulong img_len)
1435 {
1436         int i;
1437         const unsigned int count =
1438                         ll_entry_count(struct fit_loadable_tbl, fit_loadable);
1439         struct fit_loadable_tbl *fit_loadable_handler =
1440                         ll_entry_start(struct fit_loadable_tbl, fit_loadable);
1441         /* For each loadable handler */
1442         for (i = 0; i < count; i++, fit_loadable_handler++)
1443                 /* matching this type */
1444                 if (fit_loadable_handler->type == img_type)
1445                         /* call that handler with this image data */
1446                         fit_loadable_handler->handler(img_data, img_len);
1447 }
1448
1449 int boot_get_loadable(int argc, char * const argv[], bootm_headers_t *images,
1450                 uint8_t arch, const ulong *ld_start, ulong * const ld_len)
1451 {
1452         /*
1453          * These variables are used to hold the current image location
1454          * in system memory.
1455          */
1456         ulong tmp_img_addr;
1457         /*
1458          * These two variables are requirements for fit_image_load, but
1459          * their values are not used
1460          */
1461         ulong img_data, img_len;
1462         void *buf;
1463         int loadables_index;
1464         int conf_noffset;
1465         int fit_img_result;
1466         const char *uname;
1467         uint8_t img_type;
1468
1469         /* Check to see if the images struct has a FIT configuration */
1470         if (!genimg_has_config(images)) {
1471                 debug("## FIT configuration was not specified\n");
1472                 return 0;
1473         }
1474
1475         /*
1476          * Obtain the os FIT header from the images struct
1477          */
1478         tmp_img_addr = map_to_sysmem(images->fit_hdr_os);
1479         buf = map_sysmem(tmp_img_addr, 0);
1480         /*
1481          * Check image type. For FIT images get FIT node
1482          * and attempt to locate a generic binary.
1483          */
1484         switch (genimg_get_format(buf)) {
1485         case IMAGE_FORMAT_FIT:
1486                 conf_noffset = fit_conf_get_node(buf, images->fit_uname_cfg);
1487
1488                 for (loadables_index = 0;
1489                      uname = fdt_stringlist_get(buf, conf_noffset,
1490                                         FIT_LOADABLE_PROP, loadables_index,
1491                                         NULL), uname;
1492                      loadables_index++)
1493                 {
1494                         fit_img_result = fit_image_load(images,
1495                                 tmp_img_addr,
1496                                 &uname,
1497                                 &(images->fit_uname_cfg), arch,
1498                                 IH_TYPE_LOADABLE,
1499                                 BOOTSTAGE_ID_FIT_LOADABLE_START,
1500                                 FIT_LOAD_OPTIONAL_NON_ZERO,
1501                                 &img_data, &img_len);
1502                         if (fit_img_result < 0) {
1503                                 /* Something went wrong! */
1504                                 return fit_img_result;
1505                         }
1506
1507                         fit_img_result = fit_image_get_node(buf, uname);
1508                         if (fit_img_result < 0) {
1509                                 /* Something went wrong! */
1510                                 return fit_img_result;
1511                         }
1512                         fit_img_result = fit_image_get_type(buf,
1513                                                             fit_img_result,
1514                                                             &img_type);
1515                         if (fit_img_result < 0) {
1516                                 /* Something went wrong! */
1517                                 return fit_img_result;
1518                         }
1519
1520                         fit_loadable_process(img_type, img_data, img_len);
1521                 }
1522                 break;
1523         default:
1524                 printf("The given image format is not supported (corrupt?)\n");
1525                 return 1;
1526         }
1527
1528         return 0;
1529 }
1530 #endif
1531
1532 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1533 /**
1534  * boot_get_cmdline - allocate and initialize kernel cmdline
1535  * @lmb: pointer to lmb handle, will be used for memory mgmt
1536  * @cmd_start: pointer to a ulong variable, will hold cmdline start
1537  * @cmd_end: pointer to a ulong variable, will hold cmdline end
1538  *
1539  * boot_get_cmdline() allocates space for kernel command line below
1540  * BOOTMAPSZ + env_get_bootm_low() address. If "bootargs" U-Boot environment
1541  * variable is present its contents is copied to allocated kernel
1542  * command line.
1543  *
1544  * returns:
1545  *      0 - success
1546  *     -1 - failure
1547  */
1548 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1549 {
1550         char *cmdline;
1551         char *s;
1552
1553         cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1554                                 env_get_bootm_mapsize() + env_get_bootm_low());
1555
1556         if (cmdline == NULL)
1557                 return -1;
1558
1559         s = env_get("bootargs");
1560         if (!s)
1561                 s = "";
1562
1563         strcpy(cmdline, s);
1564
1565         *cmd_start = (ulong) & cmdline[0];
1566         *cmd_end = *cmd_start + strlen(cmdline);
1567
1568         debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1569
1570         return 0;
1571 }
1572 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1573
1574 #ifdef CONFIG_SYS_BOOT_GET_KBD
1575 /**
1576  * boot_get_kbd - allocate and initialize kernel copy of board info
1577  * @lmb: pointer to lmb handle, will be used for memory mgmt
1578  * @kbd: double pointer to board info data
1579  *
1580  * boot_get_kbd() allocates space for kernel copy of board info data below
1581  * BOOTMAPSZ + env_get_bootm_low() address and kernel board info is initialized
1582  * with the current u-boot board info data.
1583  *
1584  * returns:
1585  *      0 - success
1586  *     -1 - failure
1587  */
1588 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1589 {
1590         *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1591                                 env_get_bootm_mapsize() + env_get_bootm_low());
1592         if (*kbd == NULL)
1593                 return -1;
1594
1595         **kbd = *(gd->bd);
1596
1597         debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1598
1599 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1600         do_bdinfo(NULL, 0, 0, NULL);
1601 #endif
1602
1603         return 0;
1604 }
1605 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1606
1607 #ifdef CONFIG_LMB
1608 int image_setup_linux(bootm_headers_t *images)
1609 {
1610         ulong of_size = images->ft_len;
1611         char **of_flat_tree = &images->ft_addr;
1612         struct lmb *lmb = &images->lmb;
1613         int ret;
1614
1615         if (IMAGE_ENABLE_OF_LIBFDT)
1616                 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1617
1618         if (IMAGE_BOOT_GET_CMDLINE) {
1619                 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1620                                 &images->cmdline_end);
1621                 if (ret) {
1622                         puts("ERROR with allocation of cmdline\n");
1623                         return ret;
1624                 }
1625         }
1626
1627         if (IMAGE_ENABLE_OF_LIBFDT) {
1628                 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1629                 if (ret)
1630                         return ret;
1631         }
1632
1633         if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1634                 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1635                 if (ret)
1636                         return ret;
1637         }
1638
1639         return 0;
1640 }
1641 #endif /* CONFIG_LMB */
1642 #endif /* !USE_HOSTCC */