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