cmd/bootm.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000-2009
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  */
   6
   7 /*
   8  * Boot support
   9  */
  10 #include <common.h>
  11 #include <bootm.h>
  12 #include <command.h>
  13 #include <env.h>
  14 #include <errno.h>
  15 #include <image.h>
  16 #include <malloc.h>
  17 #include <nand.h>
  18 #include <asm/byteorder.h>
  19 #include <linux/ctype.h>
  20 #include <linux/err.h>
  21 #include <u-boot/zlib.h>
  22 #include <mapmem.h>
  23
  24 DECLARE_GLOBAL_DATA_PTR;
  25
  26 #if defined(CONFIG_CMD_IMI)
  27 static int image_info(unsigned long addr);
  28 #endif
  29
  30 #if defined(CONFIG_CMD_IMLS)
  31 #include <flash.h>
  32 #include <mtd/cfi_flash.h>
  33 extern flash_info_t flash_info[]; /* info for FLASH chips */
  34 #endif
  35
  36 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
  37 static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
  38 #endif
  39
  40 /* we overload the cmd field with our state machine info instead of a
  41  * function pointer */
  42 static cmd_tbl_t cmd_bootm_sub[] = {
  43         U_BOOT_CMD_MKENT(start, 0, 1, (void *)BOOTM_STATE_START, "", ""),
  44         U_BOOT_CMD_MKENT(loados, 0, 1, (void *)BOOTM_STATE_LOADOS, "", ""),
  45 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
  46         U_BOOT_CMD_MKENT(ramdisk, 0, 1, (void *)BOOTM_STATE_RAMDISK, "", ""),
  47 #endif
  48 #ifdef CONFIG_OF_LIBFDT
  49         U_BOOT_CMD_MKENT(fdt, 0, 1, (void *)BOOTM_STATE_FDT, "", ""),
  50 #endif
  51         U_BOOT_CMD_MKENT(cmdline, 0, 1, (void *)BOOTM_STATE_OS_CMDLINE, "", ""),
  52         U_BOOT_CMD_MKENT(bdt, 0, 1, (void *)BOOTM_STATE_OS_BD_T, "", ""),
  53         U_BOOT_CMD_MKENT(prep, 0, 1, (void *)BOOTM_STATE_OS_PREP, "", ""),
  54         U_BOOT_CMD_MKENT(fake, 0, 1, (void *)BOOTM_STATE_OS_FAKE_GO, "", ""),
  55         U_BOOT_CMD_MKENT(go, 0, 1, (void *)BOOTM_STATE_OS_GO, "", ""),
  56 };
  57
  58 static int do_bootm_subcommand(cmd_tbl_t *cmdtp, int flag, int argc,
  59                         char * const argv[])
  60 {
  61         int ret = 0;
  62         long state;
  63         cmd_tbl_t *c;
  64
  65         c = find_cmd_tbl(argv[0], &cmd_bootm_sub[0], ARRAY_SIZE(cmd_bootm_sub));
  66         argc--; argv++;
  67
  68         if (c) {
  69                 state = (long)c->cmd;
  70                 if (state == BOOTM_STATE_START)
  71                         state |= BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER;
  72         } else {
  73                 /* Unrecognized command */
  74                 return CMD_RET_USAGE;
  75         }
  76
  77         if (((state & BOOTM_STATE_START) != BOOTM_STATE_START) &&
  78             images.state >= state) {
  79                 printf("Trying to execute a command out of order\n");
  80                 return CMD_RET_USAGE;
  81         }
  82
  83         ret = do_bootm_states(cmdtp, flag, argc, argv, state, &images, 0);
  84
  85         return ret;
  86 }
  87
  88 /*******************************************************************/
  89 /* bootm - boot application image from image in memory */
  90 /*******************************************************************/
  91
  92 int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  93 {
  94 #ifdef CONFIG_NEEDS_MANUAL_RELOC
  95         static int relocated = 0;
  96
  97         if (!relocated) {
  98                 int i;
  99
 100                 /* relocate names of sub-command table */
 101                 for (i = 0; i < ARRAY_SIZE(cmd_bootm_sub); i++)
 102                         cmd_bootm_sub[i].name += gd->reloc_off;
 103
 104                 relocated = 1;
 105         }
 106 #endif
 107
 108         /* determine if we have a sub command */
 109         argc--; argv++;
 110         if (argc > 0) {
 111                 char *endp;
 112
 113                 simple_strtoul(argv[0], &endp, 16);
 114                 /* endp pointing to NULL means that argv[0] was just a
 115                  * valid number, pass it along to the normal bootm processing
 116                  *
 117                  * If endp is ':' or '#' assume a FIT identifier so pass
 118                  * along for normal processing.
 119                  *
 120                  * Right now we assume the first arg should never be '-'
 121                  */
 122                 if ((*endp != 0) && (*endp != ':') && (*endp != '#'))
 123                         return do_bootm_subcommand(cmdtp, flag, argc, argv);
 124         }
 125
 126         return do_bootm_states(cmdtp, flag, argc, argv, BOOTM_STATE_START |
 127                 BOOTM_STATE_FINDOS | BOOTM_STATE_FINDOTHER |
 128                 BOOTM_STATE_LOADOS |
 129 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
 130                 BOOTM_STATE_RAMDISK |
 131 #endif
 132 #if defined(CONFIG_PPC) || defined(CONFIG_MIPS)
 133                 BOOTM_STATE_OS_CMDLINE |
 134 #endif
 135                 BOOTM_STATE_OS_PREP | BOOTM_STATE_OS_FAKE_GO |
 136                 BOOTM_STATE_OS_GO, &images, 1);
 137 }
 138
 139 int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
 140 {
 141         const char *ep = env_get("autostart");
 142
 143         if (ep && !strcmp(ep, "yes")) {
 144                 char *local_args[2];
 145                 local_args[0] = (char *)cmd;
 146                 local_args[1] = NULL;
 147                 printf("Automatic boot of image at addr 0x%08lX ...\n", load_addr);
 148                 return do_bootm(cmdtp, 0, 1, local_args);
 149         }
 150
 151         return 0;
 152 }
 153
 154 #ifdef CONFIG_SYS_LONGHELP
 155 static char bootm_help_text[] =
 156         "[addr [arg ...]]\n    - boot application image stored in memory\n"
 157         "\tpassing arguments 'arg ...'; when booting a Linux kernel,\n"
 158         "\t'arg' can be the address of an initrd image\n"
 159 #if defined(CONFIG_OF_LIBFDT)
 160         "\tWhen booting a Linux kernel which requires a flat device-tree\n"
 161         "\ta third argument is required which is the address of the\n"
 162         "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
 163         "\tuse a '-' for the second argument. If you do not pass a third\n"
 164         "\ta bd_info struct will be passed instead\n"
 165 #endif
 166 #if defined(CONFIG_FIT)
 167         "\t\nFor the new multi component uImage format (FIT) addresses\n"
 168         "\tmust be extended to include component or configuration unit name:\n"
 169         "\taddr:<subimg_uname> - direct component image specification\n"
 170         "\taddr#<conf_uname>   - configuration specification\n"
 171         "\tUse iminfo command to get the list of existing component\n"
 172         "\timages and configurations.\n"
 173 #endif
 174         "\nSub-commands to do part of the bootm sequence.  The sub-commands "
 175         "must be\n"
 176         "issued in the order below (it's ok to not issue all sub-commands):\n"
 177         "\tstart [addr [arg ...]]\n"
 178         "\tloados  - load OS image\n"
 179 #if defined(CONFIG_SYS_BOOT_RAMDISK_HIGH)
 180         "\tramdisk - relocate initrd, set env initrd_start/initrd_end\n"
 181 #endif
 182 #if defined(CONFIG_OF_LIBFDT)
 183         "\tfdt     - relocate flat device tree\n"
 184 #endif
 185         "\tcmdline - OS specific command line processing/setup\n"
 186         "\tbdt     - OS specific bd_t processing\n"
 187         "\tprep    - OS specific prep before relocation or go\n"
 188 #if defined(CONFIG_TRACE)
 189         "\tfake    - OS specific fake start without go\n"
 190 #endif
 191         "\tgo      - start OS";
 192 #endif
 193
 194 U_BOOT_CMD(
 195         bootm,  CONFIG_SYS_MAXARGS,     1,      do_bootm,
 196         "boot application image from memory", bootm_help_text
 197 );
 198
 199 /*******************************************************************/
 200 /* bootd - boot default image */
 201 /*******************************************************************/
 202 #if defined(CONFIG_CMD_BOOTD)
 203 int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 204 {
 205         return run_command(env_get("bootcmd"), flag);
 206 }
 207
 208 U_BOOT_CMD(
 209         boot,   1,      1,      do_bootd,
 210         "boot default, i.e., run 'bootcmd'",
 211         ""
 212 );
 213
 214 /* keep old command name "bootd" for backward compatibility */
 215 U_BOOT_CMD(
 216         bootd, 1,       1,      do_bootd,
 217         "boot default, i.e., run 'bootcmd'",
 218         ""
 219 );
 220
 221 #endif
 222
 223
 224 /*******************************************************************/
 225 /* iminfo - print header info for a requested image */
 226 /*******************************************************************/
 227 #if defined(CONFIG_CMD_IMI)
 228 static int do_iminfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 229 {
 230         int     arg;
 231         ulong   addr;
 232         int     rcode = 0;
 233
 234         if (argc < 2) {
 235                 return image_info(load_addr);
 236         }
 237
 238         for (arg = 1; arg < argc; ++arg) {
 239                 addr = simple_strtoul(argv[arg], NULL, 16);
 240                 if (image_info(addr) != 0)
 241                         rcode = 1;
 242         }
 243         return rcode;
 244 }
 245
 246 static int image_info(ulong addr)
 247 {
 248         void *hdr = (void *)map_sysmem(addr, 0);
 249
 250         printf("\n## Checking Image at %08lx ...\n", addr);
 251
 252         switch (genimg_get_format(hdr)) {
 253 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 254         case IMAGE_FORMAT_LEGACY:
 255                 puts("   Legacy image found\n");
 256                 if (!image_check_magic(hdr)) {
 257                         puts("   Bad Magic Number\n");
 258                         unmap_sysmem(hdr);
 259                         return 1;
 260                 }
 261
 262                 if (!image_check_hcrc(hdr)) {
 263                         puts("   Bad Header Checksum\n");
 264                         unmap_sysmem(hdr);
 265                         return 1;
 266                 }
 267
 268                 image_print_contents(hdr);
 269
 270                 puts("   Verifying Checksum ... ");
 271                 if (!image_check_dcrc(hdr)) {
 272                         puts("   Bad Data CRC\n");
 273                         unmap_sysmem(hdr);
 274                         return 1;
 275                 }
 276                 puts("OK\n");
 277                 unmap_sysmem(hdr);
 278                 return 0;
 279 #endif
 280 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
 281         case IMAGE_FORMAT_ANDROID:
 282                 puts("   Android image found\n");
 283                 android_print_contents(hdr);
 284                 unmap_sysmem(hdr);
 285                 return 0;
 286 #endif
 287 #if defined(CONFIG_FIT)
 288         case IMAGE_FORMAT_FIT:
 289                 puts("   FIT image found\n");
 290
 291                 if (!fit_check_format(hdr)) {
 292                         puts("Bad FIT image format!\n");
 293                         unmap_sysmem(hdr);
 294                         return 1;
 295                 }
 296
 297                 fit_print_contents(hdr);
 298
 299                 if (!fit_all_image_verify(hdr)) {
 300                         puts("Bad hash in FIT image!\n");
 301                         unmap_sysmem(hdr);
 302                         return 1;
 303                 }
 304
 305                 unmap_sysmem(hdr);
 306                 return 0;
 307 #endif
 308         default:
 309                 puts("Unknown image format!\n");
 310                 break;
 311         }
 312
 313         unmap_sysmem(hdr);
 314         return 1;
 315 }
 316
 317 U_BOOT_CMD(
 318         iminfo, CONFIG_SYS_MAXARGS,     1,      do_iminfo,
 319         "print header information for application image",
 320         "addr [addr ...]\n"
 321         "    - print header information for application image starting at\n"
 322         "      address 'addr' in memory; this includes verification of the\n"
 323         "      image contents (magic number, header and payload checksums)"
 324 );
 325 #endif
 326
 327
 328 /*******************************************************************/
 329 /* imls - list all images found in flash */
 330 /*******************************************************************/
 331 #if defined(CONFIG_CMD_IMLS)
 332 static int do_imls_nor(void)
 333 {
 334         flash_info_t *info;
 335         int i, j;
 336         void *hdr;
 337
 338         for (i = 0, info = &flash_info[0];
 339                 i < CONFIG_SYS_MAX_FLASH_BANKS; ++i, ++info) {
 340
 341                 if (info->flash_id == FLASH_UNKNOWN)
 342                         goto next_bank;
 343                 for (j = 0; j < info->sector_count; ++j) {
 344
 345                         hdr = (void *)info->start[j];
 346                         if (!hdr)
 347                                 goto next_sector;
 348
 349                         switch (genimg_get_format(hdr)) {
 350 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 351                         case IMAGE_FORMAT_LEGACY:
 352                                 if (!image_check_hcrc(hdr))
 353                                         goto next_sector;
 354
 355                                 printf("Legacy Image at %08lX:\n", (ulong)hdr);
 356                                 image_print_contents(hdr);
 357
 358                                 puts("   Verifying Checksum ... ");
 359                                 if (!image_check_dcrc(hdr)) {
 360                                         puts("Bad Data CRC\n");
 361                                 } else {
 362                                         puts("OK\n");
 363                                 }
 364                                 break;
 365 #endif
 366 #if defined(CONFIG_FIT)
 367                         case IMAGE_FORMAT_FIT:
 368                                 if (!fit_check_format(hdr))
 369                                         goto next_sector;
 370
 371                                 printf("FIT Image at %08lX:\n", (ulong)hdr);
 372                                 fit_print_contents(hdr);
 373                                 break;
 374 #endif
 375                         default:
 376                                 goto next_sector;
 377                         }
 378
 379 next_sector:            ;
 380                 }
 381 next_bank:      ;
 382         }
 383         return 0;
 384 }
 385 #endif
 386
 387 #if defined(CONFIG_CMD_IMLS_NAND)
 388 static int nand_imls_legacyimage(struct mtd_info *mtd, int nand_dev,
 389                                  loff_t off, size_t len)
 390 {
 391         void *imgdata;
 392         int ret;
 393
 394         imgdata = malloc(len);
 395         if (!imgdata) {
 396                 printf("May be a Legacy Image at NAND device %d offset %08llX:\n",
 397                                 nand_dev, off);
 398                 printf("   Low memory(cannot allocate memory for image)\n");
 399                 return -ENOMEM;
 400         }
 401
 402         ret = nand_read_skip_bad(mtd, off, &len, NULL, mtd->size, imgdata);
 403         if (ret < 0 && ret != -EUCLEAN) {
 404                 free(imgdata);
 405                 return ret;
 406         }
 407
 408         if (!image_check_hcrc(imgdata)) {
 409                 free(imgdata);
 410                 return 0;
 411         }
 412
 413         printf("Legacy Image at NAND device %d offset %08llX:\n",
 414                         nand_dev, off);
 415         image_print_contents(imgdata);
 416
 417         puts("   Verifying Checksum ... ");
 418         if (!image_check_dcrc(imgdata))
 419                 puts("Bad Data CRC\n");
 420         else
 421                 puts("OK\n");
 422
 423         free(imgdata);
 424
 425         return 0;
 426 }
 427
 428 static int nand_imls_fitimage(struct mtd_info *mtd, int nand_dev, loff_t off,
 429                               size_t len)
 430 {
 431         void *imgdata;
 432         int ret;
 433
 434         imgdata = malloc(len);
 435         if (!imgdata) {
 436                 printf("May be a FIT Image at NAND device %d offset %08llX:\n",
 437                                 nand_dev, off);
 438                 printf("   Low memory(cannot allocate memory for image)\n");
 439                 return -ENOMEM;
 440         }
 441
 442         ret = nand_read_skip_bad(mtd, off, &len, NULL, mtd->size, imgdata);
 443         if (ret < 0 && ret != -EUCLEAN) {
 444                 free(imgdata);
 445                 return ret;
 446         }
 447
 448         if (!fit_check_format(imgdata)) {
 449                 free(imgdata);
 450                 return 0;
 451         }
 452
 453         printf("FIT Image at NAND device %d offset %08llX:\n", nand_dev, off);
 454
 455         fit_print_contents(imgdata);
 456         free(imgdata);
 457
 458         return 0;
 459 }
 460
 461 static int do_imls_nand(void)
 462 {
 463         struct mtd_info *mtd;
 464         int nand_dev = nand_curr_device;
 465         size_t len;
 466         loff_t off;
 467         u32 buffer[16];
 468
 469         if (nand_dev < 0 || nand_dev >= CONFIG_SYS_MAX_NAND_DEVICE) {
 470                 puts("\nNo NAND devices available\n");
 471                 return -ENODEV;
 472         }
 473
 474         printf("\n");
 475
 476         for (nand_dev = 0; nand_dev < CONFIG_SYS_MAX_NAND_DEVICE; nand_dev++) {
 477                 mtd = get_nand_dev_by_index(nand_dev);
 478                 if (!mtd->name || !mtd->size)
 479                         continue;
 480
 481                 for (off = 0; off < mtd->size; off += mtd->erasesize) {
 482                         const image_header_t *header;
 483                         int ret;
 484
 485                         if (nand_block_isbad(mtd, off))
 486                                 continue;
 487
 488                         len = sizeof(buffer);
 489
 490                         ret = nand_read(mtd, off, &len, (u8 *)buffer);
 491                         if (ret < 0 && ret != -EUCLEAN) {
 492                                 printf("NAND read error %d at offset %08llX\n",
 493                                                 ret, off);
 494                                 continue;
 495                         }
 496
 497                         switch (genimg_get_format(buffer)) {
 498 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 499                         case IMAGE_FORMAT_LEGACY:
 500                                 header = (const image_header_t *)buffer;
 501
 502                                 len = image_get_image_size(header);
 503                                 nand_imls_legacyimage(mtd, nand_dev, off, len);
 504                                 break;
 505 #endif
 506 #if defined(CONFIG_FIT)
 507                         case IMAGE_FORMAT_FIT:
 508                                 len = fit_get_size(buffer);
 509                                 nand_imls_fitimage(mtd, nand_dev, off, len);
 510                                 break;
 511 #endif
 512                         }
 513                 }
 514         }
 515
 516         return 0;
 517 }
 518 #endif
 519
 520 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
 521 static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 522 {
 523         int ret_nor = 0, ret_nand = 0;
 524
 525 #if defined(CONFIG_CMD_IMLS)
 526         ret_nor = do_imls_nor();
 527 #endif
 528
 529 #if defined(CONFIG_CMD_IMLS_NAND)
 530         ret_nand = do_imls_nand();
 531 #endif
 532
 533         if (ret_nor)
 534                 return ret_nor;
 535
 536         if (ret_nand)
 537                 return ret_nand;
 538
 539         return (0);
 540 }
 541
 542 U_BOOT_CMD(
 543         imls,   1,              1,      do_imls,
 544         "list all images found in flash",
 545         "\n"
 546         "    - Prints information about all images found at sector/block\n"
 547         "      boundaries in nor/nand flash."
 548 );
 549 #endif