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