common/image.c

   1 /*
   2  * (C) Copyright 2008 Semihalf
   3  *
   4  * (C) Copyright 2000-2006
   5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   6  *
   7  * SPDX-License-Identifier:     GPL-2.0+
   8  */
   9
  10 #ifndef USE_HOSTCC
  11 #include <common.h>
  12 #include <watchdog.h>
  13
  14 #ifdef CONFIG_SHOW_BOOT_PROGRESS
  15 #include <status_led.h>
  16 #endif
  17
  18 #ifdef CONFIG_HAS_DATAFLASH
  19 #include <dataflash.h>
  20 #endif
  21
  22 #ifdef CONFIG_LOGBUFFER
  23 #include <logbuff.h>
  24 #endif
  25
  26 #include <rtc.h>
  27
  28 #include <environment.h>
  29 #include <image.h>
  30
  31 #if defined(CONFIG_FIT) || defined(CONFIG_OF_LIBFDT)
  32 #include <libfdt.h>
  33 #include <fdt_support.h>
  34 #endif
  35
  36 #include <u-boot/md5.h>
  37 #include <sha1.h>
  38 #include <asm/errno.h>
  39 #include <asm/io.h>
  40
  41 #ifdef CONFIG_CMD_BDI
  42 extern int do_bdinfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  43 #endif
  44
  45 DECLARE_GLOBAL_DATA_PTR;
  46
  47 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
  48                                                 int verify);
  49 #else
  50 #include "mkimage.h"
  51 #include <u-boot/md5.h>
  52 #include <time.h>
  53 #include <image.h>
  54 #endif /* !USE_HOSTCC*/
  55
  56 #include <u-boot/crc.h>
  57
  58 #ifndef CONFIG_SYS_BARGSIZE
  59 #define CONFIG_SYS_BARGSIZE 512
  60 #endif
  61
  62 static const table_entry_t uimage_arch[] = {
  63         {       IH_ARCH_INVALID,        NULL,           "Invalid ARCH", },
  64         {       IH_ARCH_ALPHA,          "alpha",        "Alpha",        },
  65         {       IH_ARCH_ARM,            "arm",          "ARM",          },
  66         {       IH_ARCH_I386,           "x86",          "Intel x86",    },
  67         {       IH_ARCH_IA64,           "ia64",         "IA64",         },
  68         {       IH_ARCH_M68K,           "m68k",         "M68K",         },
  69         {       IH_ARCH_MICROBLAZE,     "microblaze",   "MicroBlaze",   },
  70         {       IH_ARCH_MIPS,           "mips",         "MIPS",         },
  71         {       IH_ARCH_MIPS64,         "mips64",       "MIPS 64 Bit",  },
  72         {       IH_ARCH_NIOS2,          "nios2",        "NIOS II",      },
  73         {       IH_ARCH_PPC,            "powerpc",      "PowerPC",      },
  74         {       IH_ARCH_PPC,            "ppc",          "PowerPC",      },
  75         {       IH_ARCH_S390,           "s390",         "IBM S390",     },
  76         {       IH_ARCH_SH,             "sh",           "SuperH",       },
  77         {       IH_ARCH_SPARC,          "sparc",        "SPARC",        },
  78         {       IH_ARCH_SPARC64,        "sparc64",      "SPARC 64 Bit", },
  79         {       IH_ARCH_BLACKFIN,       "blackfin",     "Blackfin",     },
  80         {       IH_ARCH_AVR32,          "avr32",        "AVR32",        },
  81         {       IH_ARCH_NDS32,          "nds32",        "NDS32",        },
  82         {       IH_ARCH_OPENRISC,       "or1k",         "OpenRISC 1000",},
  83         {       IH_ARCH_SANDBOX,        "sandbox",      "Sandbox",      },
  84         {       IH_ARCH_ARM64,          "arm64",        "AArch64",      },
  85         {       IH_ARCH_ARC,            "arc",          "ARC",          },
  86         {       -1,                     "",             "",             },
  87 };
  88
  89 static const table_entry_t uimage_os[] = {
  90         {       IH_OS_INVALID,  NULL,           "Invalid OS",           },
  91         {       IH_OS_LINUX,    "linux",        "Linux",                },
  92 #if defined(CONFIG_LYNXKDI) || defined(USE_HOSTCC)
  93         {       IH_OS_LYNXOS,   "lynxos",       "LynxOS",               },
  94 #endif
  95         {       IH_OS_NETBSD,   "netbsd",       "NetBSD",               },
  96         {       IH_OS_OSE,      "ose",          "Enea OSE",             },
  97         {       IH_OS_PLAN9,    "plan9",        "Plan 9",               },
  98         {       IH_OS_RTEMS,    "rtems",        "RTEMS",                },
  99         {       IH_OS_U_BOOT,   "u-boot",       "U-Boot",               },
 100         {       IH_OS_VXWORKS,  "vxworks",      "VxWorks",              },
 101 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
 102         {       IH_OS_QNX,      "qnx",          "QNX",                  },
 103 #endif
 104 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
 105         {       IH_OS_INTEGRITY,"integrity",    "INTEGRITY",            },
 106 #endif
 107 #ifdef USE_HOSTCC
 108         {       IH_OS_4_4BSD,   "4_4bsd",       "4_4BSD",               },
 109         {       IH_OS_DELL,     "dell",         "Dell",                 },
 110         {       IH_OS_ESIX,     "esix",         "Esix",                 },
 111         {       IH_OS_FREEBSD,  "freebsd",      "FreeBSD",              },
 112         {       IH_OS_IRIX,     "irix",         "Irix",                 },
 113         {       IH_OS_NCR,      "ncr",          "NCR",                  },
 114         {       IH_OS_OPENBSD,  "openbsd",      "OpenBSD",              },
 115         {       IH_OS_PSOS,     "psos",         "pSOS",                 },
 116         {       IH_OS_SCO,      "sco",          "SCO",                  },
 117         {       IH_OS_SOLARIS,  "solaris",      "Solaris",              },
 118         {       IH_OS_SVR4,     "svr4",         "SVR4",                 },
 119 #endif
 120         {       -1,             "",             "",                     },
 121 };
 122
 123 static const table_entry_t uimage_type[] = {
 124         {       IH_TYPE_AISIMAGE,   "aisimage",   "Davinci AIS image",},
 125         {       IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image",   },
 126         {       IH_TYPE_FIRMWARE,   "firmware",   "Firmware",           },
 127         {       IH_TYPE_FLATDT,     "flat_dt",    "Flat Device Tree",   },
 128         {       IH_TYPE_GPIMAGE,    "gpimage",    "TI Keystone SPL Image",},
 129         {       IH_TYPE_KERNEL,     "kernel",     "Kernel Image",       },
 130         {       IH_TYPE_KERNEL_NOLOAD, "kernel_noload",  "Kernel Image (no loading done)", },
 131         {       IH_TYPE_KWBIMAGE,   "kwbimage",   "Kirkwood Boot Image",},
 132         {       IH_TYPE_IMXIMAGE,   "imximage",   "Freescale i.MX Boot Image",},
 133         {       IH_TYPE_INVALID,    NULL,         "Invalid Image",      },
 134         {       IH_TYPE_MULTI,      "multi",      "Multi-File Image",   },
 135         {       IH_TYPE_OMAPIMAGE,  "omapimage",  "TI OMAP SPL With GP CH",},
 136         {       IH_TYPE_PBLIMAGE,   "pblimage",   "Freescale PBL Boot Image",},
 137         {       IH_TYPE_RAMDISK,    "ramdisk",    "RAMDisk Image",      },
 138         {       IH_TYPE_SCRIPT,     "script",     "Script",             },
 139         {       IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
 140         {       IH_TYPE_UBLIMAGE,   "ublimage",   "Davinci UBL image",},
 141         {       IH_TYPE_MXSIMAGE,   "mxsimage",   "Freescale MXS Boot Image",},
 142         {       IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
 143         {       -1,                 "",           "",                   },
 144 };
 145
 146 static const table_entry_t uimage_comp[] = {
 147         {       IH_COMP_NONE,   "none",         "uncompressed",         },
 148         {       IH_COMP_BZIP2,  "bzip2",        "bzip2 compressed",     },
 149         {       IH_COMP_GZIP,   "gzip",         "gzip compressed",      },
 150         {       IH_COMP_LZMA,   "lzma",         "lzma compressed",      },
 151         {       IH_COMP_LZO,    "lzo",          "lzo compressed",       },
 152         {       -1,             "",             "",                     },
 153 };
 154
 155 /*****************************************************************************/
 156 /* Legacy format routines */
 157 /*****************************************************************************/
 158 int image_check_hcrc(const image_header_t *hdr)
 159 {
 160         ulong hcrc;
 161         ulong len = image_get_header_size();
 162         image_header_t header;
 163
 164         /* Copy header so we can blank CRC field for re-calculation */
 165         memmove(&header, (char *)hdr, image_get_header_size());
 166         image_set_hcrc(&header, 0);
 167
 168         hcrc = crc32(0, (unsigned char *)&header, len);
 169
 170         return (hcrc == image_get_hcrc(hdr));
 171 }
 172
 173 int image_check_dcrc(const image_header_t *hdr)
 174 {
 175         ulong data = image_get_data(hdr);
 176         ulong len = image_get_data_size(hdr);
 177         ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
 178
 179         return (dcrc == image_get_dcrc(hdr));
 180 }
 181
 182 /**
 183  * image_multi_count - get component (sub-image) count
 184  * @hdr: pointer to the header of the multi component image
 185  *
 186  * image_multi_count() returns number of components in a multi
 187  * component image.
 188  *
 189  * Note: no checking of the image type is done, caller must pass
 190  * a valid multi component image.
 191  *
 192  * returns:
 193  *     number of components
 194  */
 195 ulong image_multi_count(const image_header_t *hdr)
 196 {
 197         ulong i, count = 0;
 198         uint32_t *size;
 199
 200         /* get start of the image payload, which in case of multi
 201          * component images that points to a table of component sizes */
 202         size = (uint32_t *)image_get_data(hdr);
 203
 204         /* count non empty slots */
 205         for (i = 0; size[i]; ++i)
 206                 count++;
 207
 208         return count;
 209 }
 210
 211 /**
 212  * image_multi_getimg - get component data address and size
 213  * @hdr: pointer to the header of the multi component image
 214  * @idx: index of the requested component
 215  * @data: pointer to a ulong variable, will hold component data address
 216  * @len: pointer to a ulong variable, will hold component size
 217  *
 218  * image_multi_getimg() returns size and data address for the requested
 219  * component in a multi component image.
 220  *
 221  * Note: no checking of the image type is done, caller must pass
 222  * a valid multi component image.
 223  *
 224  * returns:
 225  *     data address and size of the component, if idx is valid
 226  *     0 in data and len, if idx is out of range
 227  */
 228 void image_multi_getimg(const image_header_t *hdr, ulong idx,
 229                         ulong *data, ulong *len)
 230 {
 231         int i;
 232         uint32_t *size;
 233         ulong offset, count, img_data;
 234
 235         /* get number of component */
 236         count = image_multi_count(hdr);
 237
 238         /* get start of the image payload, which in case of multi
 239          * component images that points to a table of component sizes */
 240         size = (uint32_t *)image_get_data(hdr);
 241
 242         /* get address of the proper component data start, which means
 243          * skipping sizes table (add 1 for last, null entry) */
 244         img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
 245
 246         if (idx < count) {
 247                 *len = uimage_to_cpu(size[idx]);
 248                 offset = 0;
 249
 250                 /* go over all indices preceding requested component idx */
 251                 for (i = 0; i < idx; i++) {
 252                         /* add up i-th component size, rounding up to 4 bytes */
 253                         offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
 254                 }
 255
 256                 /* calculate idx-th component data address */
 257                 *data = img_data + offset;
 258         } else {
 259                 *len = 0;
 260                 *data = 0;
 261         }
 262 }
 263
 264 static void image_print_type(const image_header_t *hdr)
 265 {
 266         const char *os, *arch, *type, *comp;
 267
 268         os = genimg_get_os_name(image_get_os(hdr));
 269         arch = genimg_get_arch_name(image_get_arch(hdr));
 270         type = genimg_get_type_name(image_get_type(hdr));
 271         comp = genimg_get_comp_name(image_get_comp(hdr));
 272
 273         printf("%s %s %s (%s)\n", arch, os, type, comp);
 274 }
 275
 276 /**
 277  * image_print_contents - prints out the contents of the legacy format image
 278  * @ptr: pointer to the legacy format image header
 279  * @p: pointer to prefix string
 280  *
 281  * image_print_contents() formats a multi line legacy image contents description.
 282  * The routine prints out all header fields followed by the size/offset data
 283  * for MULTI/SCRIPT images.
 284  *
 285  * returns:
 286  *     no returned results
 287  */
 288 void image_print_contents(const void *ptr)
 289 {
 290         const image_header_t *hdr = (const image_header_t *)ptr;
 291         const char *p;
 292
 293         p = IMAGE_INDENT_STRING;
 294         printf("%sImage Name:   %.*s\n", p, IH_NMLEN, image_get_name(hdr));
 295         if (IMAGE_ENABLE_TIMESTAMP) {
 296                 printf("%sCreated:      ", p);
 297                 genimg_print_time((time_t)image_get_time(hdr));
 298         }
 299         printf("%sImage Type:   ", p);
 300         image_print_type(hdr);
 301         printf("%sData Size:    ", p);
 302         genimg_print_size(image_get_data_size(hdr));
 303         printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
 304         printf("%sEntry Point:  %08x\n", p, image_get_ep(hdr));
 305
 306         if (image_check_type(hdr, IH_TYPE_MULTI) ||
 307                         image_check_type(hdr, IH_TYPE_SCRIPT)) {
 308                 int i;
 309                 ulong data, len;
 310                 ulong count = image_multi_count(hdr);
 311
 312                 printf("%sContents:\n", p);
 313                 for (i = 0; i < count; i++) {
 314                         image_multi_getimg(hdr, i, &data, &len);
 315
 316                         printf("%s   Image %d: ", p, i);
 317                         genimg_print_size(len);
 318
 319                         if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
 320                                 /*
 321                                  * the user may need to know offsets
 322                                  * if planning to do something with
 323                                  * multiple files
 324                                  */
 325                                 printf("%s    Offset = 0x%08lx\n", p, data);
 326                         }
 327                 }
 328         }
 329 }
 330
 331
 332 #ifndef USE_HOSTCC
 333 /**
 334  * image_get_ramdisk - get and verify ramdisk image
 335  * @rd_addr: ramdisk image start address
 336  * @arch: expected ramdisk architecture
 337  * @verify: checksum verification flag
 338  *
 339  * image_get_ramdisk() returns a pointer to the verified ramdisk image
 340  * header. Routine receives image start address and expected architecture
 341  * flag. Verification done covers data and header integrity and os/type/arch
 342  * fields checking.
 343  *
 344  * If dataflash support is enabled routine checks for dataflash addresses
 345  * and handles required dataflash reads.
 346  *
 347  * returns:
 348  *     pointer to a ramdisk image header, if image was found and valid
 349  *     otherwise, return NULL
 350  */
 351 static const image_header_t *image_get_ramdisk(ulong rd_addr, uint8_t arch,
 352                                                 int verify)
 353 {
 354         const image_header_t *rd_hdr = (const image_header_t *)rd_addr;
 355
 356         if (!image_check_magic(rd_hdr)) {
 357                 puts("Bad Magic Number\n");
 358                 bootstage_error(BOOTSTAGE_ID_RD_MAGIC);
 359                 return NULL;
 360         }
 361
 362         if (!image_check_hcrc(rd_hdr)) {
 363                 puts("Bad Header Checksum\n");
 364                 bootstage_error(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
 365                 return NULL;
 366         }
 367
 368         bootstage_mark(BOOTSTAGE_ID_RD_MAGIC);
 369         image_print_contents(rd_hdr);
 370
 371         if (verify) {
 372                 puts("   Verifying Checksum ... ");
 373                 if (!image_check_dcrc(rd_hdr)) {
 374                         puts("Bad Data CRC\n");
 375                         bootstage_error(BOOTSTAGE_ID_RD_CHECKSUM);
 376                         return NULL;
 377                 }
 378                 puts("OK\n");
 379         }
 380
 381         bootstage_mark(BOOTSTAGE_ID_RD_HDR_CHECKSUM);
 382
 383         if (!image_check_os(rd_hdr, IH_OS_LINUX) ||
 384             !image_check_arch(rd_hdr, arch) ||
 385             !image_check_type(rd_hdr, IH_TYPE_RAMDISK)) {
 386                 printf("No Linux %s Ramdisk Image\n",
 387                                 genimg_get_arch_name(arch));
 388                 bootstage_error(BOOTSTAGE_ID_RAMDISK);
 389                 return NULL;
 390         }
 391
 392         return rd_hdr;
 393 }
 394 #endif /* !USE_HOSTCC */
 395
 396 /*****************************************************************************/
 397 /* Shared dual-format routines */
 398 /*****************************************************************************/
 399 #ifndef USE_HOSTCC
 400 ulong load_addr = CONFIG_SYS_LOAD_ADDR; /* Default Load Address */
 401 ulong save_addr;                        /* Default Save Address */
 402 ulong save_size;                        /* Default Save Size (in bytes) */
 403
 404 static int on_loadaddr(const char *name, const char *value, enum env_op op,
 405         int flags)
 406 {
 407         switch (op) {
 408         case env_op_create:
 409         case env_op_overwrite:
 410                 load_addr = simple_strtoul(value, NULL, 16);
 411                 break;
 412         default:
 413                 break;
 414         }
 415
 416         return 0;
 417 }
 418 U_BOOT_ENV_CALLBACK(loadaddr, on_loadaddr);
 419
 420 ulong getenv_bootm_low(void)
 421 {
 422         char *s = getenv("bootm_low");
 423         if (s) {
 424                 ulong tmp = simple_strtoul(s, NULL, 16);
 425                 return tmp;
 426         }
 427
 428 #if defined(CONFIG_SYS_SDRAM_BASE)
 429         return CONFIG_SYS_SDRAM_BASE;
 430 #elif defined(CONFIG_ARM)
 431         return gd->bd->bi_dram[0].start;
 432 #else
 433         return 0;
 434 #endif
 435 }
 436
 437 phys_size_t getenv_bootm_size(void)
 438 {
 439         phys_size_t tmp;
 440         char *s = getenv("bootm_size");
 441         if (s) {
 442                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
 443                 return tmp;
 444         }
 445         s = getenv("bootm_low");
 446         if (s)
 447                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
 448         else
 449                 tmp = 0;
 450
 451
 452 #if defined(CONFIG_ARM)
 453         return gd->bd->bi_dram[0].size - tmp;
 454 #else
 455         return gd->bd->bi_memsize - tmp;
 456 #endif
 457 }
 458
 459 phys_size_t getenv_bootm_mapsize(void)
 460 {
 461         phys_size_t tmp;
 462         char *s = getenv("bootm_mapsize");
 463         if (s) {
 464                 tmp = (phys_size_t)simple_strtoull(s, NULL, 16);
 465                 return tmp;
 466         }
 467
 468 #if defined(CONFIG_SYS_BOOTMAPSZ)
 469         return CONFIG_SYS_BOOTMAPSZ;
 470 #else
 471         return getenv_bootm_size();
 472 #endif
 473 }
 474
 475 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
 476 {
 477         if (to == from)
 478                 return;
 479
 480 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
 481         while (len > 0) {
 482                 size_t tail = (len > chunksz) ? chunksz : len;
 483                 WATCHDOG_RESET();
 484                 memmove(to, from, tail);
 485                 to += tail;
 486                 from += tail;
 487                 len -= tail;
 488         }
 489 #else   /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
 490         memmove(to, from, len);
 491 #endif  /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
 492 }
 493 #endif /* !USE_HOSTCC */
 494
 495 void genimg_print_size(uint32_t size)
 496 {
 497 #ifndef USE_HOSTCC
 498         printf("%d Bytes = ", size);
 499         print_size(size, "\n");
 500 #else
 501         printf("%d Bytes = %.2f kB = %.2f MB\n",
 502                         size, (double)size / 1.024e3,
 503                         (double)size / 1.048576e6);
 504 #endif
 505 }
 506
 507 #if IMAGE_ENABLE_TIMESTAMP
 508 void genimg_print_time(time_t timestamp)
 509 {
 510 #ifndef USE_HOSTCC
 511         struct rtc_time tm;
 512
 513         to_tm(timestamp, &tm);
 514         printf("%4d-%02d-%02d  %2d:%02d:%02d UTC\n",
 515                         tm.tm_year, tm.tm_mon, tm.tm_mday,
 516                         tm.tm_hour, tm.tm_min, tm.tm_sec);
 517 #else
 518         printf("%s", ctime(&timestamp));
 519 #endif
 520 }
 521 #endif
 522
 523 /**
 524  * get_table_entry_name - translate entry id to long name
 525  * @table: pointer to a translation table for entries of a specific type
 526  * @msg: message to be returned when translation fails
 527  * @id: entry id to be translated
 528  *
 529  * get_table_entry_name() will go over translation table trying to find
 530  * entry that matches given id. If matching entry is found, its long
 531  * name is returned to the caller.
 532  *
 533  * returns:
 534  *     long entry name if translation succeeds
 535  *     msg otherwise
 536  */
 537 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
 538 {
 539         for (; table->id >= 0; ++table) {
 540                 if (table->id == id)
 541 #if defined(USE_HOSTCC) || !defined(CONFIG_NEEDS_MANUAL_RELOC)
 542                         return table->lname;
 543 #else
 544                         return table->lname + gd->reloc_off;
 545 #endif
 546         }
 547         return (msg);
 548 }
 549
 550 const char *genimg_get_os_name(uint8_t os)
 551 {
 552         return (get_table_entry_name(uimage_os, "Unknown OS", os));
 553 }
 554
 555 const char *genimg_get_arch_name(uint8_t arch)
 556 {
 557         return (get_table_entry_name(uimage_arch, "Unknown Architecture",
 558                                         arch));
 559 }
 560
 561 const char *genimg_get_type_name(uint8_t type)
 562 {
 563         return (get_table_entry_name(uimage_type, "Unknown Image", type));
 564 }
 565
 566 const char *genimg_get_comp_name(uint8_t comp)
 567 {
 568         return (get_table_entry_name(uimage_comp, "Unknown Compression",
 569                                         comp));
 570 }
 571
 572 /**
 573  * get_table_entry_id - translate short entry name to id
 574  * @table: pointer to a translation table for entries of a specific type
 575  * @table_name: to be used in case of error
 576  * @name: entry short name to be translated
 577  *
 578  * get_table_entry_id() will go over translation table trying to find
 579  * entry that matches given short name. If matching entry is found,
 580  * its id returned to the caller.
 581  *
 582  * returns:
 583  *     entry id if translation succeeds
 584  *     -1 otherwise
 585  */
 586 int get_table_entry_id(const table_entry_t *table,
 587                 const char *table_name, const char *name)
 588 {
 589         const table_entry_t *t;
 590 #ifdef USE_HOSTCC
 591         int first = 1;
 592
 593         for (t = table; t->id >= 0; ++t) {
 594                 if (t->sname && strcasecmp(t->sname, name) == 0)
 595                         return(t->id);
 596         }
 597
 598         fprintf(stderr, "\nInvalid %s Type - valid names are", table_name);
 599         for (t = table; t->id >= 0; ++t) {
 600                 if (t->sname == NULL)
 601                         continue;
 602                 fprintf(stderr, "%c %s", (first) ? ':' : ',', t->sname);
 603                 first = 0;
 604         }
 605         fprintf(stderr, "\n");
 606 #else
 607         for (t = table; t->id >= 0; ++t) {
 608 #ifdef CONFIG_NEEDS_MANUAL_RELOC
 609                 if (t->sname && strcmp(t->sname + gd->reloc_off, name) == 0)
 610 #else
 611                 if (t->sname && strcmp(t->sname, name) == 0)
 612 #endif
 613                         return (t->id);
 614         }
 615         debug("Invalid %s Type: %s\n", table_name, name);
 616 #endif /* USE_HOSTCC */
 617         return (-1);
 618 }
 619
 620 int genimg_get_os_id(const char *name)
 621 {
 622         return (get_table_entry_id(uimage_os, "OS", name));
 623 }
 624
 625 int genimg_get_arch_id(const char *name)
 626 {
 627         return (get_table_entry_id(uimage_arch, "CPU", name));
 628 }
 629
 630 int genimg_get_type_id(const char *name)
 631 {
 632         return (get_table_entry_id(uimage_type, "Image", name));
 633 }
 634
 635 int genimg_get_comp_id(const char *name)
 636 {
 637         return (get_table_entry_id(uimage_comp, "Compression", name));
 638 }
 639
 640 #ifndef USE_HOSTCC
 641 /**
 642  * genimg_get_format - get image format type
 643  * @img_addr: image start address
 644  *
 645  * genimg_get_format() checks whether provided address points to a valid
 646  * legacy or FIT image.
 647  *
 648  * New uImage format and FDT blob are based on a libfdt. FDT blob
 649  * may be passed directly or embedded in a FIT image. In both situations
 650  * genimg_get_format() must be able to dectect libfdt header.
 651  *
 652  * returns:
 653  *     image format type or IMAGE_FORMAT_INVALID if no image is present
 654  */
 655 int genimg_get_format(const void *img_addr)
 656 {
 657         ulong format = IMAGE_FORMAT_INVALID;
 658         const image_header_t *hdr;
 659
 660         hdr = (const image_header_t *)img_addr;
 661         if (image_check_magic(hdr))
 662                 format = IMAGE_FORMAT_LEGACY;
 663 #if defined(CONFIG_FIT) || defined(CONFIG_OF_LIBFDT)
 664         else if (fdt_check_header(img_addr) == 0)
 665                 format = IMAGE_FORMAT_FIT;
 666 #endif
 667 #ifdef CONFIG_ANDROID_BOOT_IMAGE
 668         else if (android_image_check_header(img_addr) == 0)
 669                 format = IMAGE_FORMAT_ANDROID;
 670 #endif
 671
 672         return format;
 673 }
 674
 675 /**
 676  * genimg_get_image - get image from special storage (if necessary)
 677  * @img_addr: image start address
 678  *
 679  * genimg_get_image() checks if provided image start adddress is located
 680  * in a dataflash storage. If so, image is moved to a system RAM memory.
 681  *
 682  * returns:
 683  *     image start address after possible relocation from special storage
 684  */
 685 ulong genimg_get_image(ulong img_addr)
 686 {
 687         ulong ram_addr = img_addr;
 688
 689 #ifdef CONFIG_HAS_DATAFLASH
 690         ulong h_size, d_size;
 691
 692         if (addr_dataflash(img_addr)) {
 693                 void *buf;
 694
 695                 /* ger RAM address */
 696                 ram_addr = CONFIG_SYS_LOAD_ADDR;
 697
 698                 /* get header size */
 699                 h_size = image_get_header_size();
 700 #if defined(CONFIG_FIT)
 701                 if (sizeof(struct fdt_header) > h_size)
 702                         h_size = sizeof(struct fdt_header);
 703 #endif
 704
 705                 /* read in header */
 706                 debug("   Reading image header from dataflash address "
 707                         "%08lx to RAM address %08lx\n", img_addr, ram_addr);
 708
 709                 buf = map_sysmem(ram_addr, 0);
 710                 read_dataflash(img_addr, h_size, buf);
 711
 712                 /* get data size */
 713                 switch (genimg_get_format(buf)) {
 714                 case IMAGE_FORMAT_LEGACY:
 715                         d_size = image_get_data_size(buf);
 716                         debug("   Legacy format image found at 0x%08lx, "
 717                                         "size 0x%08lx\n",
 718                                         ram_addr, d_size);
 719                         break;
 720 #if defined(CONFIG_FIT)
 721                 case IMAGE_FORMAT_FIT:
 722                         d_size = fit_get_size(buf) - h_size;
 723                         debug("   FIT/FDT format image found at 0x%08lx, "
 724                                         "size 0x%08lx\n",
 725                                         ram_addr, d_size);
 726                         break;
 727 #endif
 728                 default:
 729                         printf("   No valid image found at 0x%08lx\n",
 730                                 img_addr);
 731                         return ram_addr;
 732                 }
 733
 734                 /* read in image data */
 735                 debug("   Reading image remaining data from dataflash address "
 736                         "%08lx to RAM address %08lx\n", img_addr + h_size,
 737                         ram_addr + h_size);
 738
 739                 read_dataflash(img_addr + h_size, d_size,
 740                                 (char *)(buf + h_size));
 741
 742         }
 743 #endif /* CONFIG_HAS_DATAFLASH */
 744
 745         return ram_addr;
 746 }
 747
 748 /**
 749  * fit_has_config - check if there is a valid FIT configuration
 750  * @images: pointer to the bootm command headers structure
 751  *
 752  * fit_has_config() checks if there is a FIT configuration in use
 753  * (if FTI support is present).
 754  *
 755  * returns:
 756  *     0, no FIT support or no configuration found
 757  *     1, configuration found
 758  */
 759 int genimg_has_config(bootm_headers_t *images)
 760 {
 761 #if defined(CONFIG_FIT)
 762         if (images->fit_uname_cfg)
 763                 return 1;
 764 #endif
 765         return 0;
 766 }
 767
 768 /**
 769  * boot_get_ramdisk - main ramdisk handling routine
 770  * @argc: command argument count
 771  * @argv: command argument list
 772  * @images: pointer to the bootm images structure
 773  * @arch: expected ramdisk architecture
 774  * @rd_start: pointer to a ulong variable, will hold ramdisk start address
 775  * @rd_end: pointer to a ulong variable, will hold ramdisk end
 776  *
 777  * boot_get_ramdisk() is responsible for finding a valid ramdisk image.
 778  * Curently supported are the following ramdisk sources:
 779  *      - multicomponent kernel/ramdisk image,
 780  *      - commandline provided address of decicated ramdisk image.
 781  *
 782  * returns:
 783  *     0, if ramdisk image was found and valid, or skiped
 784  *     rd_start and rd_end are set to ramdisk start/end addresses if
 785  *     ramdisk image is found and valid
 786  *
 787  *     1, if ramdisk image is found but corrupted, or invalid
 788  *     rd_start and rd_end are set to 0 if no ramdisk exists
 789  */
 790 int boot_get_ramdisk(int argc, char * const argv[], bootm_headers_t *images,
 791                 uint8_t arch, ulong *rd_start, ulong *rd_end)
 792 {
 793         ulong rd_addr, rd_load;
 794         ulong rd_data, rd_len;
 795         const image_header_t *rd_hdr;
 796         void *buf;
 797 #ifdef CONFIG_SUPPORT_RAW_INITRD
 798         char *end;
 799 #endif
 800 #if defined(CONFIG_FIT)
 801         const char      *fit_uname_config = images->fit_uname_cfg;
 802         const char      *fit_uname_ramdisk = NULL;
 803         ulong           default_addr;
 804         int             rd_noffset;
 805 #endif
 806         const char *select = NULL;
 807
 808         *rd_start = 0;
 809         *rd_end = 0;
 810
 811         if (argc >= 2)
 812                 select = argv[1];
 813         /*
 814          * Look for a '-' which indicates to ignore the
 815          * ramdisk argument
 816          */
 817         if (select && strcmp(select, "-") ==  0) {
 818                 debug("## Skipping init Ramdisk\n");
 819                 rd_len = rd_data = 0;
 820         } else if (select || genimg_has_config(images)) {
 821 #if defined(CONFIG_FIT)
 822                 if (select) {
 823                         /*
 824                          * If the init ramdisk comes from the FIT image and
 825                          * the FIT image address is omitted in the command
 826                          * line argument, try to use os FIT image address or
 827                          * default load address.
 828                          */
 829                         if (images->fit_uname_os)
 830                                 default_addr = (ulong)images->fit_hdr_os;
 831                         else
 832                                 default_addr = load_addr;
 833
 834                         if (fit_parse_conf(select, default_addr,
 835                                            &rd_addr, &fit_uname_config)) {
 836                                 debug("*  ramdisk: config '%s' from image at "
 837                                                 "0x%08lx\n",
 838                                                 fit_uname_config, rd_addr);
 839                         } else if (fit_parse_subimage(select, default_addr,
 840                                                 &rd_addr, &fit_uname_ramdisk)) {
 841                                 debug("*  ramdisk: subimage '%s' from image at "
 842                                                 "0x%08lx\n",
 843                                                 fit_uname_ramdisk, rd_addr);
 844                         } else
 845 #endif
 846                         {
 847                                 rd_addr = simple_strtoul(select, NULL, 16);
 848                                 debug("*  ramdisk: cmdline image address = "
 849                                                 "0x%08lx\n",
 850                                                 rd_addr);
 851                         }
 852 #if defined(CONFIG_FIT)
 853                 } else {
 854                         /* use FIT configuration provided in first bootm
 855                          * command argument. If the property is not defined,
 856                          * quit silently.
 857                          */
 858                         rd_addr = map_to_sysmem(images->fit_hdr_os);
 859                         rd_noffset = fit_get_node_from_config(images,
 860                                         FIT_RAMDISK_PROP, rd_addr);
 861                         if (rd_noffset == -ENOLINK)
 862                                 return 0;
 863                         else if (rd_noffset < 0)
 864                                 return 1;
 865                 }
 866 #endif
 867
 868                 /* copy from dataflash if needed */
 869                 rd_addr = genimg_get_image(rd_addr);
 870
 871                 /*
 872                  * Check if there is an initrd image at the
 873                  * address provided in the second bootm argument
 874                  * check image type, for FIT images get FIT node.
 875                  */
 876                 buf = map_sysmem(rd_addr, 0);
 877                 switch (genimg_get_format(buf)) {
 878                 case IMAGE_FORMAT_LEGACY:
 879                         printf("## Loading init Ramdisk from Legacy "
 880                                         "Image at %08lx ...\n", rd_addr);
 881
 882                         bootstage_mark(BOOTSTAGE_ID_CHECK_RAMDISK);
 883                         rd_hdr = image_get_ramdisk(rd_addr, arch,
 884                                                         images->verify);
 885
 886                         if (rd_hdr == NULL)
 887                                 return 1;
 888
 889                         rd_data = image_get_data(rd_hdr);
 890                         rd_len = image_get_data_size(rd_hdr);
 891                         rd_load = image_get_load(rd_hdr);
 892                         break;
 893 #if defined(CONFIG_FIT)
 894                 case IMAGE_FORMAT_FIT:
 895                         rd_noffset = fit_image_load(images, FIT_RAMDISK_PROP,
 896                                         rd_addr, &fit_uname_ramdisk,
 897                                         &fit_uname_config, arch,
 898                                         IH_TYPE_RAMDISK,
 899                                         BOOTSTAGE_ID_FIT_RD_START,
 900                                         FIT_LOAD_IGNORED, &rd_data, &rd_len);
 901                         if (rd_noffset < 0)
 902                                 return 1;
 903
 904                         images->fit_hdr_rd = map_sysmem(rd_addr, 0);
 905                         images->fit_uname_rd = fit_uname_ramdisk;
 906                         images->fit_noffset_rd = rd_noffset;
 907                         break;
 908 #endif
 909                 default:
 910 #ifdef CONFIG_SUPPORT_RAW_INITRD
 911                         end = NULL;
 912                         if (select)
 913                                 end = strchr(select, ':');
 914                         if (end) {
 915                                 rd_len = simple_strtoul(++end, NULL, 16);
 916                                 rd_data = rd_addr;
 917                         } else
 918 #endif
 919                         {
 920                                 puts("Wrong Ramdisk Image Format\n");
 921                                 rd_data = rd_len = rd_load = 0;
 922                                 return 1;
 923                         }
 924                 }
 925         } else if (images->legacy_hdr_valid &&
 926                         image_check_type(&images->legacy_hdr_os_copy,
 927                                                 IH_TYPE_MULTI)) {
 928
 929                 /*
 930                  * Now check if we have a legacy mult-component image,
 931                  * get second entry data start address and len.
 932                  */
 933                 bootstage_mark(BOOTSTAGE_ID_RAMDISK);
 934                 printf("## Loading init Ramdisk from multi component "
 935                                 "Legacy Image at %08lx ...\n",
 936                                 (ulong)images->legacy_hdr_os);
 937
 938                 image_multi_getimg(images->legacy_hdr_os, 1, &rd_data, &rd_len);
 939         }
 940 #ifdef CONFIG_ANDROID_BOOT_IMAGE
 941         else if ((genimg_get_format(images) == IMAGE_FORMAT_ANDROID) &&
 942                  (!android_image_get_ramdisk((void *)images->os.start,
 943                  &rd_data, &rd_len))) {
 944                 /* empty */
 945         }
 946 #endif
 947         else {
 948                 /*
 949                  * no initrd image
 950                  */
 951                 bootstage_mark(BOOTSTAGE_ID_NO_RAMDISK);
 952                 rd_len = rd_data = 0;
 953         }
 954
 955         if (!rd_data) {
 956                 debug("## No init Ramdisk\n");
 957         } else {
 958                 *rd_start = rd_data;
 959                 *rd_end = rd_data + rd_len;
 960         }
 961         debug("   ramdisk start = 0x%08lx, ramdisk end = 0x%08lx\n",
 962                         *rd_start, *rd_end);
 963
 964         return 0;
 965 }
 966
 967 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
 968 /**
 969  * boot_ramdisk_high - relocate init ramdisk
 970  * @lmb: pointer to lmb handle, will be used for memory mgmt
 971  * @rd_data: ramdisk data start address
 972  * @rd_len: ramdisk data length
 973  * @initrd_start: pointer to a ulong variable, will hold final init ramdisk
 974  *      start address (after possible relocation)
 975  * @initrd_end: pointer to a ulong variable, will hold final init ramdisk
 976  *      end address (after possible relocation)
 977  *
 978  * boot_ramdisk_high() takes a relocation hint from "initrd_high" environment
 979  * variable and if requested ramdisk data is moved to a specified location.
 980  *
 981  * Initrd_start and initrd_end are set to final (after relocation) ramdisk
 982  * start/end addresses if ramdisk image start and len were provided,
 983  * otherwise set initrd_start and initrd_end set to zeros.
 984  *
 985  * returns:
 986  *      0 - success
 987  *     -1 - failure
 988  */
 989 int boot_ramdisk_high(struct lmb *lmb, ulong rd_data, ulong rd_len,
 990                   ulong *initrd_start, ulong *initrd_end)
 991 {
 992         char    *s;
 993         ulong   initrd_high;
 994         int     initrd_copy_to_ram = 1;
 995
 996         if ((s = getenv("initrd_high")) != NULL) {
 997                 /* a value of "no" or a similar string will act like 0,
 998                  * turning the "load high" feature off. This is intentional.
 999                  */
1000                 initrd_high = simple_strtoul(s, NULL, 16);
1001                 if (initrd_high == ~0)
1002                         initrd_copy_to_ram = 0;
1003         } else {
1004                 /* not set, no restrictions to load high */
1005                 initrd_high = ~0;
1006         }
1007
1008
1009 #ifdef CONFIG_LOGBUFFER
1010         /* Prevent initrd from overwriting logbuffer */
1011         lmb_reserve(lmb, logbuffer_base() - LOGBUFF_OVERHEAD, LOGBUFF_RESERVE);
1012 #endif
1013
1014         debug("## initrd_high = 0x%08lx, copy_to_ram = %d\n",
1015                         initrd_high, initrd_copy_to_ram);
1016
1017         if (rd_data) {
1018                 if (!initrd_copy_to_ram) {      /* zero-copy ramdisk support */
1019                         debug("   in-place initrd\n");
1020                         *initrd_start = rd_data;
1021                         *initrd_end = rd_data + rd_len;
1022                         lmb_reserve(lmb, rd_data, rd_len);
1023                 } else {
1024                         if (initrd_high)
1025                                 *initrd_start = (ulong)lmb_alloc_base(lmb,
1026                                                 rd_len, 0x1000, initrd_high);
1027                         else
1028                                 *initrd_start = (ulong)lmb_alloc(lmb, rd_len,
1029                                                                  0x1000);
1030
1031                         if (*initrd_start == 0) {
1032                                 puts("ramdisk - allocation error\n");
1033                                 goto error;
1034                         }
1035                         bootstage_mark(BOOTSTAGE_ID_COPY_RAMDISK);
1036
1037                         *initrd_end = *initrd_start + rd_len;
1038                         printf("   Loading Ramdisk to %08lx, end %08lx ... ",
1039                                         *initrd_start, *initrd_end);
1040
1041                         memmove_wd((void *)*initrd_start,
1042                                         (void *)rd_data, rd_len, CHUNKSZ);
1043
1044 #ifdef CONFIG_MP
1045                         /*
1046                          * Ensure the image is flushed to memory to handle
1047                          * AMP boot scenarios in which we might not be
1048                          * HW cache coherent
1049                          */
1050                         flush_cache((unsigned long)*initrd_start, rd_len);
1051 #endif
1052                         puts("OK\n");
1053                 }
1054         } else {
1055                 *initrd_start = 0;
1056                 *initrd_end = 0;
1057         }
1058         debug("   ramdisk load start = 0x%08lx, ramdisk load end = 0x%08lx\n",
1059                         *initrd_start, *initrd_end);
1060
1061         return 0;
1062
1063 error:
1064         return -1;
1065 }
1066 #endif /* CONFIG_SYS_BOOT_RAMDISK_HIGH */
1067
1068 #ifdef CONFIG_SYS_BOOT_GET_CMDLINE
1069 /**
1070  * boot_get_cmdline - allocate and initialize kernel cmdline
1071  * @lmb: pointer to lmb handle, will be used for memory mgmt
1072  * @cmd_start: pointer to a ulong variable, will hold cmdline start
1073  * @cmd_end: pointer to a ulong variable, will hold cmdline end
1074  *
1075  * boot_get_cmdline() allocates space for kernel command line below
1076  * BOOTMAPSZ + getenv_bootm_low() address. If "bootargs" U-boot environemnt
1077  * variable is present its contents is copied to allocated kernel
1078  * command line.
1079  *
1080  * returns:
1081  *      0 - success
1082  *     -1 - failure
1083  */
1084 int boot_get_cmdline(struct lmb *lmb, ulong *cmd_start, ulong *cmd_end)
1085 {
1086         char *cmdline;
1087         char *s;
1088
1089         cmdline = (char *)(ulong)lmb_alloc_base(lmb, CONFIG_SYS_BARGSIZE, 0xf,
1090                                 getenv_bootm_mapsize() + getenv_bootm_low());
1091
1092         if (cmdline == NULL)
1093                 return -1;
1094
1095         if ((s = getenv("bootargs")) == NULL)
1096                 s = "";
1097
1098         strcpy(cmdline, s);
1099
1100         *cmd_start = (ulong) & cmdline[0];
1101         *cmd_end = *cmd_start + strlen(cmdline);
1102
1103         debug("## cmdline at 0x%08lx ... 0x%08lx\n", *cmd_start, *cmd_end);
1104
1105         return 0;
1106 }
1107 #endif /* CONFIG_SYS_BOOT_GET_CMDLINE */
1108
1109 #ifdef CONFIG_SYS_BOOT_GET_KBD
1110 /**
1111  * boot_get_kbd - allocate and initialize kernel copy of board info
1112  * @lmb: pointer to lmb handle, will be used for memory mgmt
1113  * @kbd: double pointer to board info data
1114  *
1115  * boot_get_kbd() allocates space for kernel copy of board info data below
1116  * BOOTMAPSZ + getenv_bootm_low() address and kernel board info is initialized
1117  * with the current u-boot board info data.
1118  *
1119  * returns:
1120  *      0 - success
1121  *     -1 - failure
1122  */
1123 int boot_get_kbd(struct lmb *lmb, bd_t **kbd)
1124 {
1125         *kbd = (bd_t *)(ulong)lmb_alloc_base(lmb, sizeof(bd_t), 0xf,
1126                                 getenv_bootm_mapsize() + getenv_bootm_low());
1127         if (*kbd == NULL)
1128                 return -1;
1129
1130         **kbd = *(gd->bd);
1131
1132         debug("## kernel board info at 0x%08lx\n", (ulong)*kbd);
1133
1134 #if defined(DEBUG) && defined(CONFIG_CMD_BDI)
1135         do_bdinfo(NULL, 0, 0, NULL);
1136 #endif
1137
1138         return 0;
1139 }
1140 #endif /* CONFIG_SYS_BOOT_GET_KBD */
1141
1142 #ifdef CONFIG_LMB
1143 int image_setup_linux(bootm_headers_t *images)
1144 {
1145         ulong of_size = images->ft_len;
1146         char **of_flat_tree = &images->ft_addr;
1147         ulong *initrd_start = &images->initrd_start;
1148         ulong *initrd_end = &images->initrd_end;
1149         struct lmb *lmb = &images->lmb;
1150         ulong rd_len;
1151         int ret;
1152
1153         if (IMAGE_ENABLE_OF_LIBFDT)
1154                 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
1155
1156         if (IMAGE_BOOT_GET_CMDLINE) {
1157                 ret = boot_get_cmdline(lmb, &images->cmdline_start,
1158                                 &images->cmdline_end);
1159                 if (ret) {
1160                         puts("ERROR with allocation of cmdline\n");
1161                         return ret;
1162                 }
1163         }
1164         if (IMAGE_ENABLE_RAMDISK_HIGH) {
1165                 rd_len = images->rd_end - images->rd_start;
1166                 ret = boot_ramdisk_high(lmb, images->rd_start, rd_len,
1167                                 initrd_start, initrd_end);
1168                 if (ret)
1169                         return ret;
1170         }
1171
1172         if (IMAGE_ENABLE_OF_LIBFDT) {
1173                 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
1174                 if (ret)
1175                         return ret;
1176         }
1177
1178         if (IMAGE_ENABLE_OF_LIBFDT && of_size) {
1179                 ret = image_setup_libfdt(images, *of_flat_tree, of_size, lmb);
1180                 if (ret)
1181                         return ret;
1182         }
1183
1184         return 0;
1185 }
1186 #endif /* CONFIG_LMB */
1187 #endif /* !USE_HOSTCC */