cmd/bootm.c

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