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