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