boot/bootm_os.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 #include <common.h>
   8 #include <bootm.h>
   9 #include <bootstage.h>
  10 #include <cpu_func.h>
  11 #include <efi_loader.h>
  12 #include <env.h>
  13 #include <fdt_support.h>
  14 #include <image.h>
  15 #include <lmb.h>
  16 #include <log.h>
  17 #include <asm/global_data.h>
  18 #include <linux/libfdt.h>
  19 #include <malloc.h>
  20 #include <mapmem.h>
  21 #include <vxworks.h>
  22 #include <tee/optee.h>
  23
  24 DECLARE_GLOBAL_DATA_PTR;
  25
  26 static int do_bootm_standalone(int flag, int argc, char *const argv[],
  27                                struct bootm_headers *images)
  28 {
  29         int (*appl)(int, char *const[]);
  30
  31         if (!env_get_autostart()) {
  32                 env_set_hex("filesize", images->os.image_len);
  33                 return 0;
  34         }
  35         appl = (int (*)(int, char * const []))images->ep;
  36         appl(argc, argv);
  37         return 0;
  38 }
  39
  40 /*******************************************************************/
  41 /* OS booting routines */
  42 /*******************************************************************/
  43
  44 #if defined(CONFIG_BOOTM_NETBSD) || defined(CONFIG_BOOTM_PLAN9)
  45 static void copy_args(char *dest, int argc, char *const argv[], char delim)
  46 {
  47         int i;
  48
  49         for (i = 0; i < argc; i++) {
  50                 if (i > 0)
  51                         *dest++ = delim;
  52                 strcpy(dest, argv[i]);
  53                 dest += strlen(argv[i]);
  54         }
  55 }
  56 #endif
  57
  58 static void __maybe_unused fit_unsupported_reset(const char *msg)
  59 {
  60         if (CONFIG_IS_ENABLED(FIT_VERBOSE)) {
  61                 printf("! FIT images not supported for '%s' - must reset board to recover!\n",
  62                        msg);
  63         }
  64 }
  65
  66 #ifdef CONFIG_BOOTM_NETBSD
  67 static int do_bootm_netbsd(int flag, int argc, char *const argv[],
  68                            struct bootm_headers *images)
  69 {
  70         void (*loader)(struct bd_info *bd, struct legacy_img_hdr *hdr,
  71                        char *console, char *cmdline);
  72         struct legacy_img_hdr *os_hdr, *hdr;
  73         ulong kernel_data, kernel_len;
  74         char *cmdline;
  75
  76         if (flag != BOOTM_STATE_OS_GO)
  77                 return 0;
  78
  79 #if defined(CONFIG_FIT)
  80         if (!images->legacy_hdr_valid) {
  81                 fit_unsupported_reset("NetBSD");
  82                 return 1;
  83         }
  84 #endif
  85         hdr = images->legacy_hdr_os;
  86
  87         /*
  88          * Booting a (NetBSD) kernel image
  89          *
  90          * This process is pretty similar to a standalone application:
  91          * The (first part of an multi-) image must be a stage-2 loader,
  92          * which in turn is responsible for loading & invoking the actual
  93          * kernel.  The only differences are the parameters being passed:
  94          * besides the board info strucure, the loader expects a command
  95          * line, the name of the console device, and (optionally) the
  96          * address of the original image header.
  97          */
  98         os_hdr = NULL;
  99         if (image_check_type(&images->legacy_hdr_os_copy, IH_TYPE_MULTI)) {
 100                 image_multi_getimg(hdr, 1, &kernel_data, &kernel_len);
 101                 if (kernel_len)
 102                         os_hdr = hdr;
 103         }
 104
 105         if (argc > 0) {
 106                 ulong len;
 107                 int   i;
 108
 109                 for (i = 0, len = 0; i < argc; i += 1)
 110                         len += strlen(argv[i]) + 1;
 111                 cmdline = malloc(len);
 112                 copy_args(cmdline, argc, argv, ' ');
 113         } else {
 114                 cmdline = env_get("bootargs");
 115                 if (cmdline == NULL)
 116                         cmdline = "";
 117         }
 118
 119         loader = (void (*)(struct bd_info *, struct legacy_img_hdr *, char *, char *))images->ep;
 120
 121         printf("## Transferring control to NetBSD stage-2 loader (at address %08lx) ...\n",
 122                (ulong)loader);
 123
 124         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 125
 126         /*
 127          * NetBSD Stage-2 Loader Parameters:
 128          *   arg[0]: pointer to board info data
 129          *   arg[1]: image load address
 130          *   arg[2]: char pointer to the console device to use
 131          *   arg[3]: char pointer to the boot arguments
 132          */
 133         (*loader)(gd->bd, os_hdr, "", cmdline);
 134
 135         return 1;
 136 }
 137 #endif /* CONFIG_BOOTM_NETBSD*/
 138
 139 #ifdef CONFIG_BOOTM_RTEMS
 140 static int do_bootm_rtems(int flag, int argc, char *const argv[],
 141                           struct bootm_headers *images)
 142 {
 143         void (*entry_point)(struct bd_info *);
 144
 145         if (flag != BOOTM_STATE_OS_GO)
 146                 return 0;
 147
 148 #if defined(CONFIG_FIT)
 149         if (!images->legacy_hdr_valid) {
 150                 fit_unsupported_reset("RTEMS");
 151                 return 1;
 152         }
 153 #endif
 154
 155         entry_point = (void (*)(struct bd_info *))images->ep;
 156
 157         printf("## Transferring control to RTEMS (at address %08lx) ...\n",
 158                (ulong)entry_point);
 159
 160         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 161
 162         /*
 163          * RTEMS Parameters:
 164          *   r3: ptr to board info data
 165          */
 166         (*entry_point)(gd->bd);
 167
 168         return 1;
 169 }
 170 #endif /* CONFIG_BOOTM_RTEMS */
 171
 172 #if defined(CONFIG_BOOTM_OSE)
 173 static int do_bootm_ose(int flag, int argc, char *const argv[],
 174                         struct bootm_headers *images)
 175 {
 176         void (*entry_point)(void);
 177
 178         if (flag != BOOTM_STATE_OS_GO)
 179                 return 0;
 180
 181 #if defined(CONFIG_FIT)
 182         if (!images->legacy_hdr_valid) {
 183                 fit_unsupported_reset("OSE");
 184                 return 1;
 185         }
 186 #endif
 187
 188         entry_point = (void (*)(void))images->ep;
 189
 190         printf("## Transferring control to OSE (at address %08lx) ...\n",
 191                (ulong)entry_point);
 192
 193         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 194
 195         /*
 196          * OSE Parameters:
 197          *   None
 198          */
 199         (*entry_point)();
 200
 201         return 1;
 202 }
 203 #endif /* CONFIG_BOOTM_OSE */
 204
 205 #if defined(CONFIG_BOOTM_PLAN9)
 206 static int do_bootm_plan9(int flag, int argc, char *const argv[],
 207                           struct bootm_headers *images)
 208 {
 209         void (*entry_point)(void);
 210         char *s;
 211
 212         if (flag != BOOTM_STATE_OS_GO)
 213                 return 0;
 214
 215 #if defined(CONFIG_FIT)
 216         if (!images->legacy_hdr_valid) {
 217                 fit_unsupported_reset("Plan 9");
 218                 return 1;
 219         }
 220 #endif
 221
 222         /* See README.plan9 */
 223         s = env_get("confaddr");
 224         if (s != NULL) {
 225                 char *confaddr = (char *)hextoul(s, NULL);
 226
 227                 if (argc > 0) {
 228                         copy_args(confaddr, argc, argv, '\n');
 229                 } else {
 230                         s = env_get("bootargs");
 231                         if (s != NULL)
 232                                 strcpy(confaddr, s);
 233                 }
 234         }
 235
 236         entry_point = (void (*)(void))images->ep;
 237
 238         printf("## Transferring control to Plan 9 (at address %08lx) ...\n",
 239                (ulong)entry_point);
 240
 241         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 242
 243         /*
 244          * Plan 9 Parameters:
 245          *   None
 246          */
 247         (*entry_point)();
 248
 249         return 1;
 250 }
 251 #endif /* CONFIG_BOOTM_PLAN9 */
 252
 253 #if defined(CONFIG_BOOTM_VXWORKS) && \
 254         (defined(CONFIG_PPC) || defined(CONFIG_ARM))
 255
 256 static void do_bootvx_fdt(struct bootm_headers *images)
 257 {
 258 #if defined(CONFIG_OF_LIBFDT)
 259         int ret;
 260         char *bootline;
 261         ulong of_size = images->ft_len;
 262         char **of_flat_tree = &images->ft_addr;
 263         struct lmb *lmb = &images->lmb;
 264
 265         if (*of_flat_tree) {
 266                 boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
 267
 268                 ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
 269                 if (ret)
 270                         return;
 271
 272                 /* Update ethernet nodes */
 273                 fdt_fixup_ethernet(*of_flat_tree);
 274
 275                 ret = fdt_add_subnode(*of_flat_tree, 0, "chosen");
 276                 if ((ret >= 0 || ret == -FDT_ERR_EXISTS)) {
 277                         bootline = env_get("bootargs");
 278                         if (bootline) {
 279                                 ret = fdt_find_and_setprop(*of_flat_tree,
 280                                                 "/chosen", "bootargs",
 281                                                 bootline,
 282                                                 strlen(bootline) + 1, 1);
 283                                 if (ret < 0) {
 284                                         printf("## ERROR: %s : %s\n", __func__,
 285                                                fdt_strerror(ret));
 286                                         return;
 287                                 }
 288                         }
 289                 } else {
 290                         printf("## ERROR: %s : %s\n", __func__,
 291                                fdt_strerror(ret));
 292                         return;
 293                 }
 294         }
 295 #endif
 296
 297         boot_prep_vxworks(images);
 298
 299         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 300
 301 #if defined(CONFIG_OF_LIBFDT)
 302         printf("## Starting vxWorks at 0x%08lx, device tree at 0x%08lx ...\n",
 303                (ulong)images->ep, (ulong)*of_flat_tree);
 304 #else
 305         printf("## Starting vxWorks at 0x%08lx\n", (ulong)images->ep);
 306 #endif
 307         flush();
 308
 309         boot_jump_vxworks(images);
 310
 311         puts("## vxWorks terminated\n");
 312 }
 313
 314 static int do_bootm_vxworks_legacy(int flag, int argc, char *const argv[],
 315                                    struct bootm_headers *images)
 316 {
 317         if (flag != BOOTM_STATE_OS_GO)
 318                 return 0;
 319
 320         do_bootvx_fdt(images);
 321
 322         return 1;
 323 }
 324
 325 int do_bootm_vxworks(int flag, int argc, char *const argv[],
 326                      struct bootm_headers *images)
 327 {
 328         char *bootargs;
 329         int pos;
 330         unsigned long vxflags;
 331         bool std_dtb = false;
 332
 333         /* get bootargs env */
 334         bootargs = env_get("bootargs");
 335
 336         if (bootargs != NULL) {
 337                 for (pos = 0; pos < strlen(bootargs); pos++) {
 338                         /* find f=0xnumber flag */
 339                         if ((bootargs[pos] == '=') && (pos >= 1) &&
 340                             (bootargs[pos - 1] == 'f')) {
 341                                 vxflags = hextoul(&bootargs[pos + 1], NULL);
 342                                 if (vxflags & VXWORKS_SYSFLG_STD_DTB)
 343                                         std_dtb = true;
 344                         }
 345                 }
 346         }
 347
 348         if (std_dtb) {
 349                 if (flag & BOOTM_STATE_OS_PREP)
 350                         printf("   Using standard DTB\n");
 351                 return do_bootm_linux(flag, argc, argv, images);
 352         } else {
 353                 if (flag & BOOTM_STATE_OS_PREP)
 354                         printf("   !!! WARNING !!! Using legacy DTB\n");
 355                 return do_bootm_vxworks_legacy(flag, argc, argv, images);
 356         }
 357 }
 358 #endif
 359
 360 #if defined(CONFIG_CMD_ELF)
 361 static int do_bootm_qnxelf(int flag, int argc, char *const argv[],
 362                            struct bootm_headers *images)
 363 {
 364         char *local_args[2];
 365         char str[16];
 366         int dcache;
 367
 368         if (flag != BOOTM_STATE_OS_GO)
 369                 return 0;
 370
 371 #if defined(CONFIG_FIT)
 372         if (!images->legacy_hdr_valid) {
 373                 fit_unsupported_reset("QNX");
 374                 return 1;
 375         }
 376 #endif
 377
 378         sprintf(str, "%lx", images->ep); /* write entry-point into string */
 379         local_args[0] = argv[0];
 380         local_args[1] = str;    /* and provide it via the arguments */
 381
 382         /*
 383          * QNX images require the data cache is disabled.
 384          */
 385         dcache = dcache_status();
 386         if (dcache)
 387                 dcache_disable();
 388
 389         do_bootelf(NULL, 0, 2, local_args);
 390
 391         if (dcache)
 392                 dcache_enable();
 393
 394         return 1;
 395 }
 396 #endif
 397
 398 #ifdef CONFIG_INTEGRITY
 399 static int do_bootm_integrity(int flag, int argc, char *const argv[],
 400                               struct bootm_headers *images)
 401 {
 402         void (*entry_point)(void);
 403
 404         if (flag != BOOTM_STATE_OS_GO)
 405                 return 0;
 406
 407 #if defined(CONFIG_FIT)
 408         if (!images->legacy_hdr_valid) {
 409                 fit_unsupported_reset("INTEGRITY");
 410                 return 1;
 411         }
 412 #endif
 413
 414         entry_point = (void (*)(void))images->ep;
 415
 416         printf("## Transferring control to INTEGRITY (at address %08lx) ...\n",
 417                (ulong)entry_point);
 418
 419         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 420
 421         /*
 422          * INTEGRITY Parameters:
 423          *   None
 424          */
 425         (*entry_point)();
 426
 427         return 1;
 428 }
 429 #endif
 430
 431 #ifdef CONFIG_BOOTM_OPENRTOS
 432 static int do_bootm_openrtos(int flag, int argc, char *const argv[],
 433                              struct bootm_headers *images)
 434 {
 435         void (*entry_point)(void);
 436
 437         if (flag != BOOTM_STATE_OS_GO)
 438                 return 0;
 439
 440         entry_point = (void (*)(void))images->ep;
 441
 442         printf("## Transferring control to OpenRTOS (at address %08lx) ...\n",
 443                 (ulong)entry_point);
 444
 445         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 446
 447         /*
 448          * OpenRTOS Parameters:
 449          *   None
 450          */
 451         (*entry_point)();
 452
 453         return 1;
 454 }
 455 #endif
 456
 457 #ifdef CONFIG_BOOTM_OPTEE
 458 static int do_bootm_tee(int flag, int argc, char *const argv[],
 459                         struct bootm_headers *images)
 460 {
 461         int ret;
 462
 463         /* Verify OS type */
 464         if (images->os.os != IH_OS_TEE) {
 465                 return 1;
 466         };
 467
 468         /* Validate OPTEE header */
 469         ret = optee_verify_bootm_image(images->os.image_start,
 470                                        images->os.load,
 471                                        images->os.image_len);
 472         if (ret)
 473                 return ret;
 474
 475         /* Locate FDT etc */
 476         ret = bootm_find_images(flag, argc, argv, 0, 0);
 477         if (ret)
 478                 return ret;
 479
 480         /* From here we can run the regular linux boot path */
 481         return do_bootm_linux(flag, argc, argv, images);
 482 }
 483 #endif
 484
 485 #ifdef CONFIG_BOOTM_EFI
 486 static int do_bootm_efi(int flag, int argc, char *const argv[],
 487                         struct bootm_headers *images)
 488 {
 489         int ret;
 490         efi_status_t efi_ret;
 491         void *image_buf;
 492
 493         if (flag != BOOTM_STATE_OS_GO)
 494                 return 0;
 495
 496         /* Locate FDT, if provided */
 497         ret = bootm_find_images(flag, argc, argv, 0, 0);
 498         if (ret)
 499                 return ret;
 500
 501         /* Initialize EFI drivers */
 502         efi_ret = efi_init_obj_list();
 503         if (efi_ret != EFI_SUCCESS) {
 504                 printf("## Failed to initialize UEFI sub-system: r = %lu\n",
 505                        efi_ret & ~EFI_ERROR_MASK);
 506                 return 1;
 507         }
 508
 509         /* Install device tree */
 510         efi_ret = efi_install_fdt(images->ft_len
 511                                   ? images->ft_addr : EFI_FDT_USE_INTERNAL);
 512         if (efi_ret != EFI_SUCCESS) {
 513                 printf("## Failed to install device tree: r = %lu\n",
 514                        efi_ret & ~EFI_ERROR_MASK);
 515                 return 1;
 516         }
 517
 518         /* Run EFI image */
 519         printf("## Transferring control to EFI (at address %08lx) ...\n",
 520                images->ep);
 521         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 522
 523         /* We expect to return */
 524         images->os.type = IH_TYPE_STANDALONE;
 525
 526         image_buf = map_sysmem(images->ep, images->os.image_len);
 527
 528         efi_ret = efi_run_image(image_buf, images->os.image_len);
 529         if (efi_ret != EFI_SUCCESS)
 530                 return 1;
 531         return 0;
 532 }
 533 #endif
 534
 535 static boot_os_fn *boot_os[] = {
 536         [IH_OS_U_BOOT] = do_bootm_standalone,
 537 #ifdef CONFIG_BOOTM_LINUX
 538         [IH_OS_LINUX] = do_bootm_linux,
 539 #endif
 540 #ifdef CONFIG_BOOTM_NETBSD
 541         [IH_OS_NETBSD] = do_bootm_netbsd,
 542 #endif
 543 #ifdef CONFIG_BOOTM_RTEMS
 544         [IH_OS_RTEMS] = do_bootm_rtems,
 545 #endif
 546 #if defined(CONFIG_BOOTM_OSE)
 547         [IH_OS_OSE] = do_bootm_ose,
 548 #endif
 549 #if defined(CONFIG_BOOTM_PLAN9)
 550         [IH_OS_PLAN9] = do_bootm_plan9,
 551 #endif
 552 #if defined(CONFIG_BOOTM_VXWORKS) && \
 553         (defined(CONFIG_PPC) || defined(CONFIG_ARM) || defined(CONFIG_RISCV))
 554         [IH_OS_VXWORKS] = do_bootm_vxworks,
 555 #endif
 556 #if defined(CONFIG_CMD_ELF)
 557         [IH_OS_QNX] = do_bootm_qnxelf,
 558 #endif
 559 #ifdef CONFIG_INTEGRITY
 560         [IH_OS_INTEGRITY] = do_bootm_integrity,
 561 #endif
 562 #ifdef CONFIG_BOOTM_OPENRTOS
 563         [IH_OS_OPENRTOS] = do_bootm_openrtos,
 564 #endif
 565 #ifdef CONFIG_BOOTM_OPTEE
 566         [IH_OS_TEE] = do_bootm_tee,
 567 #endif
 568 #ifdef CONFIG_BOOTM_EFI
 569         [IH_OS_EFI] = do_bootm_efi,
 570 #endif
 571 };
 572
 573 /* Allow for arch specific config before we boot */
 574 __weak void arch_preboot_os(void)
 575 {
 576         /* please define platform specific arch_preboot_os() */
 577 }
 578
 579 /* Allow for board specific config before we boot */
 580 __weak void board_preboot_os(void)
 581 {
 582         /* please define board specific board_preboot_os() */
 583 }
 584
 585 int boot_selected_os(int argc, char *const argv[], int state,
 586                      struct bootm_headers *images, boot_os_fn *boot_fn)
 587 {
 588         arch_preboot_os();
 589         board_preboot_os();
 590         boot_fn(state, argc, argv, images);
 591
 592         /* Stand-alone may return when 'autostart' is 'no' */
 593         if (images->os.type == IH_TYPE_STANDALONE ||
 594             IS_ENABLED(CONFIG_SANDBOX) ||
 595             state == BOOTM_STATE_OS_FAKE_GO) /* We expect to return */
 596                 return 0;
 597         bootstage_error(BOOTSTAGE_ID_BOOT_OS_RETURNED);
 598         debug("\n## Control returned to monitor - resetting...\n");
 599
 600         return BOOTM_ERR_RESET;
 601 }
 602
 603 boot_os_fn *bootm_os_get_boot_func(int os)
 604 {
 605         return boot_os[os];
 606 }