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