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",
 148                        image_load_addr);
 149                 return do_bootm(cmdtp, 0, 1, local_args);
 150         }
 151
 152         return 0;
 153 }
 154
 155 #ifdef CONFIG_SYS_LONGHELP
 156 static char bootm_help_text[] =
 157         "[addr [arg ...]]\n    - boot application image stored in memory\n"
 158         "\tpassing arguments 'arg ...'; when booting a Linux kernel,\n"
 159         "\t'arg' can be the address of an initrd image\n"
 160 #if defined(CONFIG_OF_LIBFDT)
 161         "\tWhen booting a Linux kernel which requires a flat device-tree\n"
 162         "\ta third argument is required which is the address of the\n"
 163         "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
 164         "\tuse a '-' for the second argument. If you do not pass a third\n"
 165         "\ta bd_info struct will be passed instead\n"
 166 #endif
 167 #if defined(CONFIG_FIT)
 168         "\t\nFor the new multi component uImage format (FIT) addresses\n"
 169         "\tmust be extended to include component or configuration unit name:\n"
 170         "\taddr:<subimg_uname> - direct component image specification\n"
 171         "\taddr#<conf_uname>   - configuration specification\n"
 172         "\tUse iminfo command to get the list of existing component\n"
 173         "\timages and configurations.\n"
 174 #endif
 175         "\nSub-commands to do part of the bootm sequence.  The sub-commands "
 176         "must be\n"
 177         "issued in the order below (it's ok to not issue all sub-commands):\n"
 178         "\tstart [addr [arg ...]]\n"
 179         "\tloados  - load OS image\n"
 180 #if defined(CONFIG_SYS_BOOT_RAMDISK_HIGH)
 181         "\tramdisk - relocate initrd, set env initrd_start/initrd_end\n"
 182 #endif
 183 #if defined(CONFIG_OF_LIBFDT)
 184         "\tfdt     - relocate flat device tree\n"
 185 #endif
 186         "\tcmdline - OS specific command line processing/setup\n"
 187         "\tbdt     - OS specific bd_t processing\n"
 188         "\tprep    - OS specific prep before relocation or go\n"
 189 #if defined(CONFIG_TRACE)
 190         "\tfake    - OS specific fake start without go\n"
 191 #endif
 192         "\tgo      - start OS";
 193 #endif
 194
 195 U_BOOT_CMD(
 196         bootm,  CONFIG_SYS_MAXARGS,     1,      do_bootm,
 197         "boot application image from memory", bootm_help_text
 198 );
 199
 200 /*******************************************************************/
 201 /* bootd - boot default image */
 202 /*******************************************************************/
 203 #if defined(CONFIG_CMD_BOOTD)
 204 int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 205 {
 206         return run_command(env_get("bootcmd"), flag);
 207 }
 208
 209 U_BOOT_CMD(
 210         boot,   1,      1,      do_bootd,
 211         "boot default, i.e., run 'bootcmd'",
 212         ""
 213 );
 214
 215 /* keep old command name "bootd" for backward compatibility */
 216 U_BOOT_CMD(
 217         bootd, 1,       1,      do_bootd,
 218         "boot default, i.e., run 'bootcmd'",
 219         ""
 220 );
 221
 222 #endif
 223
 224
 225 /*******************************************************************/
 226 /* iminfo - print header info for a requested image */
 227 /*******************************************************************/
 228 #if defined(CONFIG_CMD_IMI)
 229 static int do_iminfo(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 230 {
 231         int     arg;
 232         ulong   addr;
 233         int     rcode = 0;
 234
 235         if (argc < 2) {
 236                 return image_info(image_load_addr);
 237         }
 238
 239         for (arg = 1; arg < argc; ++arg) {
 240                 addr = simple_strtoul(argv[arg], NULL, 16);
 241                 if (image_info(addr) != 0)
 242                         rcode = 1;
 243         }
 244         return rcode;
 245 }
 246
 247 static int image_info(ulong addr)
 248 {
 249         void *hdr = (void *)map_sysmem(addr, 0);
 250
 251         printf("\n## Checking Image at %08lx ...\n", addr);
 252
 253         switch (genimg_get_format(hdr)) {
 254 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 255         case IMAGE_FORMAT_LEGACY:
 256                 puts("   Legacy image found\n");
 257                 if (!image_check_magic(hdr)) {
 258                         puts("   Bad Magic Number\n");
 259                         unmap_sysmem(hdr);
 260                         return 1;
 261                 }
 262
 263                 if (!image_check_hcrc(hdr)) {
 264                         puts("   Bad Header Checksum\n");
 265                         unmap_sysmem(hdr);
 266                         return 1;
 267                 }
 268
 269                 image_print_contents(hdr);
 270
 271                 puts("   Verifying Checksum ... ");
 272                 if (!image_check_dcrc(hdr)) {
 273                         puts("   Bad Data CRC\n");
 274                         unmap_sysmem(hdr);
 275                         return 1;
 276                 }
 277                 puts("OK\n");
 278                 unmap_sysmem(hdr);
 279                 return 0;
 280 #endif
 281 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
 282         case IMAGE_FORMAT_ANDROID:
 283                 puts("   Android image found\n");
 284                 android_print_contents(hdr);
 285                 unmap_sysmem(hdr);
 286                 return 0;
 287 #endif
 288 #if defined(CONFIG_FIT)
 289         case IMAGE_FORMAT_FIT:
 290                 puts("   FIT image found\n");
 291
 292                 if (!fit_check_format(hdr)) {
 293                         puts("Bad FIT image format!\n");
 294                         unmap_sysmem(hdr);
 295                         return 1;
 296                 }
 297
 298                 fit_print_contents(hdr);
 299
 300                 if (!fit_all_image_verify(hdr)) {
 301                         puts("Bad hash in FIT image!\n");
 302                         unmap_sysmem(hdr);
 303                         return 1;
 304                 }
 305
 306                 unmap_sysmem(hdr);
 307                 return 0;
 308 #endif
 309         default:
 310                 puts("Unknown image format!\n");
 311                 break;
 312         }
 313
 314         unmap_sysmem(hdr);
 315         return 1;
 316 }
 317
 318 U_BOOT_CMD(
 319         iminfo, CONFIG_SYS_MAXARGS,     1,      do_iminfo,
 320         "print header information for application image",
 321         "addr [addr ...]\n"
 322         "    - print header information for application image starting at\n"
 323         "      address 'addr' in memory; this includes verification of the\n"
 324         "      image contents (magic number, header and payload checksums)"
 325 );
 326 #endif
 327
 328
 329 /*******************************************************************/
 330 /* imls - list all images found in flash */
 331 /*******************************************************************/
 332 #if defined(CONFIG_CMD_IMLS)
 333 static int do_imls_nor(void)
 334 {
 335         flash_info_t *info;
 336         int i, j;
 337         void *hdr;
 338
 339         for (i = 0, info = &flash_info[0];
 340                 i < CONFIG_SYS_MAX_FLASH_BANKS; ++i, ++info) {
 341
 342                 if (info->flash_id == FLASH_UNKNOWN)
 343                         goto next_bank;
 344                 for (j = 0; j < info->sector_count; ++j) {
 345
 346                         hdr = (void *)info->start[j];
 347                         if (!hdr)
 348                                 goto next_sector;
 349
 350                         switch (genimg_get_format(hdr)) {
 351 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 352                         case IMAGE_FORMAT_LEGACY:
 353                                 if (!image_check_hcrc(hdr))
 354                                         goto next_sector;
 355
 356                                 printf("Legacy Image at %08lX:\n", (ulong)hdr);
 357                                 image_print_contents(hdr);
 358
 359                                 puts("   Verifying Checksum ... ");
 360                                 if (!image_check_dcrc(hdr)) {
 361                                         puts("Bad Data CRC\n");
 362                                 } else {
 363                                         puts("OK\n");
 364                                 }
 365                                 break;
 366 #endif
 367 #if defined(CONFIG_FIT)
 368                         case IMAGE_FORMAT_FIT:
 369                                 if (!fit_check_format(hdr))
 370                                         goto next_sector;
 371
 372                                 printf("FIT Image at %08lX:\n", (ulong)hdr);
 373                                 fit_print_contents(hdr);
 374                                 break;
 375 #endif
 376                         default:
 377                                 goto next_sector;
 378                         }
 379
 380 next_sector:            ;
 381                 }
 382 next_bank:      ;
 383         }
 384         return 0;
 385 }
 386 #endif
 387
 388 #if defined(CONFIG_CMD_IMLS_NAND)
 389 static int nand_imls_legacyimage(struct mtd_info *mtd, int nand_dev,
 390                                  loff_t off, size_t len)
 391 {
 392         void *imgdata;
 393         int ret;
 394
 395         imgdata = malloc(len);
 396         if (!imgdata) {
 397                 printf("May be a Legacy Image at NAND device %d offset %08llX:\n",
 398                                 nand_dev, off);
 399                 printf("   Low memory(cannot allocate memory for image)\n");
 400                 return -ENOMEM;
 401         }
 402
 403         ret = nand_read_skip_bad(mtd, off, &len, NULL, mtd->size, imgdata);
 404         if (ret < 0 && ret != -EUCLEAN) {
 405                 free(imgdata);
 406                 return ret;
 407         }
 408
 409         if (!image_check_hcrc(imgdata)) {
 410                 free(imgdata);
 411                 return 0;
 412         }
 413
 414         printf("Legacy Image at NAND device %d offset %08llX:\n",
 415                         nand_dev, off);
 416         image_print_contents(imgdata);
 417
 418         puts("   Verifying Checksum ... ");
 419         if (!image_check_dcrc(imgdata))
 420                 puts("Bad Data CRC\n");
 421         else
 422                 puts("OK\n");
 423
 424         free(imgdata);
 425
 426         return 0;
 427 }
 428
 429 static int nand_imls_fitimage(struct mtd_info *mtd, int nand_dev, loff_t off,
 430                               size_t len)
 431 {
 432         void *imgdata;
 433         int ret;
 434
 435         imgdata = malloc(len);
 436         if (!imgdata) {
 437                 printf("May be a FIT Image at NAND device %d offset %08llX:\n",
 438                                 nand_dev, off);
 439                 printf("   Low memory(cannot allocate memory for image)\n");
 440                 return -ENOMEM;
 441         }
 442
 443         ret = nand_read_skip_bad(mtd, off, &len, NULL, mtd->size, imgdata);
 444         if (ret < 0 && ret != -EUCLEAN) {
 445                 free(imgdata);
 446                 return ret;
 447         }
 448
 449         if (!fit_check_format(imgdata)) {
 450                 free(imgdata);
 451                 return 0;
 452         }
 453
 454         printf("FIT Image at NAND device %d offset %08llX:\n", nand_dev, off);
 455
 456         fit_print_contents(imgdata);
 457         free(imgdata);
 458
 459         return 0;
 460 }
 461
 462 static int do_imls_nand(void)
 463 {
 464         struct mtd_info *mtd;
 465         int nand_dev = nand_curr_device;
 466         size_t len;
 467         loff_t off;
 468         u32 buffer[16];
 469
 470         if (nand_dev < 0 || nand_dev >= CONFIG_SYS_MAX_NAND_DEVICE) {
 471                 puts("\nNo NAND devices available\n");
 472                 return -ENODEV;
 473         }
 474
 475         printf("\n");
 476
 477         for (nand_dev = 0; nand_dev < CONFIG_SYS_MAX_NAND_DEVICE; nand_dev++) {
 478                 mtd = get_nand_dev_by_index(nand_dev);
 479                 if (!mtd->name || !mtd->size)
 480                         continue;
 481
 482                 for (off = 0; off < mtd->size; off += mtd->erasesize) {
 483                         const image_header_t *header;
 484                         int ret;
 485
 486                         if (nand_block_isbad(mtd, off))
 487                                 continue;
 488
 489                         len = sizeof(buffer);
 490
 491                         ret = nand_read(mtd, off, &len, (u8 *)buffer);
 492                         if (ret < 0 && ret != -EUCLEAN) {
 493                                 printf("NAND read error %d at offset %08llX\n",
 494                                                 ret, off);
 495                                 continue;
 496                         }
 497
 498                         switch (genimg_get_format(buffer)) {
 499 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
 500                         case IMAGE_FORMAT_LEGACY:
 501                                 header = (const image_header_t *)buffer;
 502
 503                                 len = image_get_image_size(header);
 504                                 nand_imls_legacyimage(mtd, nand_dev, off, len);
 505                                 break;
 506 #endif
 507 #if defined(CONFIG_FIT)
 508                         case IMAGE_FORMAT_FIT:
 509                                 len = fit_get_size(buffer);
 510                                 nand_imls_fitimage(mtd, nand_dev, off, len);
 511                                 break;
 512 #endif
 513                         }
 514                 }
 515         }
 516
 517         return 0;
 518 }
 519 #endif
 520
 521 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
 522 static int do_imls(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 523 {
 524         int ret_nor = 0, ret_nand = 0;
 525
 526 #if defined(CONFIG_CMD_IMLS)
 527         ret_nor = do_imls_nor();
 528 #endif
 529
 530 #if defined(CONFIG_CMD_IMLS_NAND)
 531         ret_nand = do_imls_nand();
 532 #endif
 533
 534         if (ret_nor)
 535                 return ret_nor;
 536
 537         if (ret_nand)
 538                 return ret_nand;
 539
 540         return (0);
 541 }
 542
 543 U_BOOT_CMD(
 544         imls,   1,              1,      do_imls,
 545         "list all images found in flash",
 546         "\n"
 547         "    - Prints information about all images found at sector/block\n"
 548         "      boundaries in nor/nand flash."
 549 );
 550 #endif