arch/arm/lib/bootm.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /* Copyright (C) 2011
   3  * Corscience GmbH & Co. KG - Simon Schwarz <schwarz@corscience.de>
   4  *  - Added prep subcommand support
   5  *  - Reorganized source - modeled after powerpc version
   6  *
   7  * (C) Copyright 2002
   8  * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   9  * Marius Groeger <mgroeger@sysgo.de>
  10  *
  11  * Copyright (C) 2001  Erik Mouw (J.A.K.Mouw@its.tudelft.nl)
  12  */
  13
  14 #include <common.h>
  15 #include <command.h>
  16 #include <cpu_func.h>
  17 #include <dm.h>
  18 #include <dm/root.h>
  19 #include <env.h>
  20 #include <image.h>
  21 #include <u-boot/zlib.h>
  22 #include <asm/byteorder.h>
  23 #include <linux/libfdt.h>
  24 #include <mapmem.h>
  25 #include <fdt_support.h>
  26 #include <asm/bootm.h>
  27 #include <asm/secure.h>
  28 #include <linux/compiler.h>
  29 #include <bootm.h>
  30 #include <vxworks.h>
  31
  32 #ifdef CONFIG_ARMV7_NONSEC
  33 #include <asm/armv7.h>
  34 #endif
  35 #include <asm/setup.h>
  36
  37 DECLARE_GLOBAL_DATA_PTR;
  38
  39 static struct tag *params;
  40
  41 static ulong get_sp(void)
  42 {
  43         ulong ret;
  44
  45         asm("mov %0, sp" : "=r"(ret) : );
  46         return ret;
  47 }
  48
  49 void arch_lmb_reserve(struct lmb *lmb)
  50 {
  51         ulong sp, bank_end;
  52         int bank;
  53
  54         /*
  55          * Booting a (Linux) kernel image
  56          *
  57          * Allocate space for command line and board info - the
  58          * address should be as high as possible within the reach of
  59          * the kernel (see CONFIG_SYS_BOOTMAPSZ settings), but in unused
  60          * memory, which means far enough below the current stack
  61          * pointer.
  62          */
  63         sp = get_sp();
  64         debug("## Current stack ends at 0x%08lx ", sp);
  65
  66         /* adjust sp by 4K to be safe */
  67         sp -= 4096;
  68         for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
  69                 if (!gd->bd->bi_dram[bank].size ||
  70                     sp < gd->bd->bi_dram[bank].start)
  71                         continue;
  72                 /* Watch out for RAM at end of address space! */
  73                 bank_end = gd->bd->bi_dram[bank].start +
  74                         gd->bd->bi_dram[bank].size - 1;
  75                 if (sp > bank_end)
  76                         continue;
  77                 lmb_reserve(lmb, sp, bank_end - sp + 1);
  78                 break;
  79         }
  80 }
  81
  82 __weak void board_quiesce_devices(void)
  83 {
  84 }
  85
  86 /**
  87  * announce_and_cleanup() - Print message and prepare for kernel boot
  88  *
  89  * @fake: non-zero to do everything except actually boot
  90  */
  91 static void announce_and_cleanup(int fake)
  92 {
  93         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_HANDOFF, "start_kernel");
  94 #ifdef CONFIG_BOOTSTAGE_FDT
  95         bootstage_fdt_add_report();
  96 #endif
  97 #ifdef CONFIG_BOOTSTAGE_REPORT
  98         bootstage_report();
  99 #endif
 100
 101 #ifdef CONFIG_USB_DEVICE
 102         udc_disconnect();
 103 #endif
 104
 105         board_quiesce_devices();
 106
 107         printf("\nStarting kernel ...%s\n\n", fake ?
 108                 "(fake run for tracing)" : "");
 109         /*
 110          * Call remove function of all devices with a removal flag set.
 111          * This may be useful for last-stage operations, like cancelling
 112          * of DMA operation or releasing device internal buffers.
 113          */
 114         dm_remove_devices_flags(DM_REMOVE_ACTIVE_ALL);
 115
 116         cleanup_before_linux();
 117 }
 118
 119 static void setup_start_tag (bd_t *bd)
 120 {
 121         params = (struct tag *)bd->bi_boot_params;
 122
 123         params->hdr.tag = ATAG_CORE;
 124         params->hdr.size = tag_size (tag_core);
 125
 126         params->u.core.flags = 0;
 127         params->u.core.pagesize = 0;
 128         params->u.core.rootdev = 0;
 129
 130         params = tag_next (params);
 131 }
 132
 133 static void setup_memory_tags(bd_t *bd)
 134 {
 135         int i;
 136
 137         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 138                 params->hdr.tag = ATAG_MEM;
 139                 params->hdr.size = tag_size (tag_mem32);
 140
 141                 params->u.mem.start = bd->bi_dram[i].start;
 142                 params->u.mem.size = bd->bi_dram[i].size;
 143
 144                 params = tag_next (params);
 145         }
 146 }
 147
 148 static void setup_commandline_tag(bd_t *bd, char *commandline)
 149 {
 150         char *p;
 151
 152         if (!commandline)
 153                 return;
 154
 155         /* eat leading white space */
 156         for (p = commandline; *p == ' '; p++);
 157
 158         /* skip non-existent command lines so the kernel will still
 159          * use its default command line.
 160          */
 161         if (*p == '\0')
 162                 return;
 163
 164         params->hdr.tag = ATAG_CMDLINE;
 165         params->hdr.size =
 166                 (sizeof (struct tag_header) + strlen (p) + 1 + 4) >> 2;
 167
 168         strcpy (params->u.cmdline.cmdline, p);
 169
 170         params = tag_next (params);
 171 }
 172
 173 static void setup_initrd_tag(bd_t *bd, ulong initrd_start, ulong initrd_end)
 174 {
 175         /* an ATAG_INITRD node tells the kernel where the compressed
 176          * ramdisk can be found. ATAG_RDIMG is a better name, actually.
 177          */
 178         params->hdr.tag = ATAG_INITRD2;
 179         params->hdr.size = tag_size (tag_initrd);
 180
 181         params->u.initrd.start = initrd_start;
 182         params->u.initrd.size = initrd_end - initrd_start;
 183
 184         params = tag_next (params);
 185 }
 186
 187 static void setup_serial_tag(struct tag **tmp)
 188 {
 189         struct tag *params = *tmp;
 190         struct tag_serialnr serialnr;
 191
 192         get_board_serial(&serialnr);
 193         params->hdr.tag = ATAG_SERIAL;
 194         params->hdr.size = tag_size (tag_serialnr);
 195         params->u.serialnr.low = serialnr.low;
 196         params->u.serialnr.high= serialnr.high;
 197         params = tag_next (params);
 198         *tmp = params;
 199 }
 200
 201 static void setup_revision_tag(struct tag **in_params)
 202 {
 203         u32 rev = 0;
 204
 205         rev = get_board_rev();
 206         params->hdr.tag = ATAG_REVISION;
 207         params->hdr.size = tag_size (tag_revision);
 208         params->u.revision.rev = rev;
 209         params = tag_next (params);
 210 }
 211
 212 static void setup_end_tag(bd_t *bd)
 213 {
 214         params->hdr.tag = ATAG_NONE;
 215         params->hdr.size = 0;
 216 }
 217
 218 __weak void setup_board_tags(struct tag **in_params) {}
 219
 220 #ifdef CONFIG_ARM64
 221 static void do_nonsec_virt_switch(void)
 222 {
 223         smp_kick_all_cpus();
 224         dcache_disable();       /* flush cache before swtiching to EL2 */
 225 }
 226 #endif
 227
 228 __weak void board_prep_linux(bootm_headers_t *images) { }
 229
 230 /* Subcommand: PREP */
 231 static void boot_prep_linux(bootm_headers_t *images)
 232 {
 233         char *commandline = env_get("bootargs");
 234
 235         if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len) {
 236 #ifdef CONFIG_OF_LIBFDT
 237                 debug("using: FDT\n");
 238                 if (image_setup_linux(images)) {
 239                         printf("FDT creation failed! hanging...");
 240                         hang();
 241                 }
 242 #endif
 243         } else if (BOOTM_ENABLE_TAGS) {
 244                 debug("using: ATAGS\n");
 245                 setup_start_tag(gd->bd);
 246                 if (BOOTM_ENABLE_SERIAL_TAG)
 247                         setup_serial_tag(&params);
 248                 if (BOOTM_ENABLE_CMDLINE_TAG)
 249                         setup_commandline_tag(gd->bd, commandline);
 250                 if (BOOTM_ENABLE_REVISION_TAG)
 251                         setup_revision_tag(&params);
 252                 if (BOOTM_ENABLE_MEMORY_TAGS)
 253                         setup_memory_tags(gd->bd);
 254                 if (BOOTM_ENABLE_INITRD_TAG) {
 255                         /*
 256                          * In boot_ramdisk_high(), it may relocate ramdisk to
 257                          * a specified location. And set images->initrd_start &
 258                          * images->initrd_end to relocated ramdisk's start/end
 259                          * addresses. So use them instead of images->rd_start &
 260                          * images->rd_end when possible.
 261                          */
 262                         if (images->initrd_start && images->initrd_end) {
 263                                 setup_initrd_tag(gd->bd, images->initrd_start,
 264                                                  images->initrd_end);
 265                         } else if (images->rd_start && images->rd_end) {
 266                                 setup_initrd_tag(gd->bd, images->rd_start,
 267                                                  images->rd_end);
 268                         }
 269                 }
 270                 setup_board_tags(&params);
 271                 setup_end_tag(gd->bd);
 272         } else {
 273                 printf("FDT and ATAGS support not compiled in - hanging\n");
 274                 hang();
 275         }
 276
 277         board_prep_linux(images);
 278 }
 279
 280 __weak bool armv7_boot_nonsec_default(void)
 281 {
 282 #ifdef CONFIG_ARMV7_BOOT_SEC_DEFAULT
 283         return false;
 284 #else
 285         return true;
 286 #endif
 287 }
 288
 289 #ifdef CONFIG_ARMV7_NONSEC
 290 bool armv7_boot_nonsec(void)
 291 {
 292         char *s = env_get("bootm_boot_mode");
 293         bool nonsec = armv7_boot_nonsec_default();
 294
 295         if (s && !strcmp(s, "sec"))
 296                 nonsec = false;
 297
 298         if (s && !strcmp(s, "nonsec"))
 299                 nonsec = true;
 300
 301         return nonsec;
 302 }
 303 #endif
 304
 305 #ifdef CONFIG_ARM64
 306 __weak void update_os_arch_secondary_cores(uint8_t os_arch)
 307 {
 308 }
 309
 310 #ifdef CONFIG_ARMV8_SWITCH_TO_EL1
 311 static void switch_to_el1(void)
 312 {
 313         if ((IH_ARCH_DEFAULT == IH_ARCH_ARM64) &&
 314             (images.os.arch == IH_ARCH_ARM))
 315                 armv8_switch_to_el1(0, (u64)gd->bd->bi_arch_number,
 316                                     (u64)images.ft_addr, 0,
 317                                     (u64)images.ep,
 318                                     ES_TO_AARCH32);
 319         else
 320                 armv8_switch_to_el1((u64)images.ft_addr, 0, 0, 0,
 321                                     images.ep,
 322                                     ES_TO_AARCH64);
 323 }
 324 #endif
 325 #endif
 326
 327 /* Subcommand: GO */
 328 static void boot_jump_linux(bootm_headers_t *images, int flag)
 329 {
 330 #ifdef CONFIG_ARM64
 331         void (*kernel_entry)(void *fdt_addr, void *res0, void *res1,
 332                         void *res2);
 333         int fake = (flag & BOOTM_STATE_OS_FAKE_GO);
 334
 335         kernel_entry = (void (*)(void *fdt_addr, void *res0, void *res1,
 336                                 void *res2))images->ep;
 337
 338         debug("## Transferring control to Linux (at address %lx)...\n",
 339                 (ulong) kernel_entry);
 340         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 341
 342         announce_and_cleanup(fake);
 343
 344         if (!fake) {
 345 #ifdef CONFIG_ARMV8_PSCI
 346                 armv8_setup_psci();
 347 #endif
 348                 do_nonsec_virt_switch();
 349
 350                 update_os_arch_secondary_cores(images->os.arch);
 351
 352 #ifdef CONFIG_ARMV8_SWITCH_TO_EL1
 353                 armv8_switch_to_el2((u64)images->ft_addr, 0, 0, 0,
 354                                     (u64)switch_to_el1, ES_TO_AARCH64);
 355 #else
 356                 if ((IH_ARCH_DEFAULT == IH_ARCH_ARM64) &&
 357                     (images->os.arch == IH_ARCH_ARM))
 358                         armv8_switch_to_el2(0, (u64)gd->bd->bi_arch_number,
 359                                             (u64)images->ft_addr, 0,
 360                                             (u64)images->ep,
 361                                             ES_TO_AARCH32);
 362                 else
 363                         armv8_switch_to_el2((u64)images->ft_addr, 0, 0, 0,
 364                                             images->ep,
 365                                             ES_TO_AARCH64);
 366 #endif
 367         }
 368 #else
 369         unsigned long machid = gd->bd->bi_arch_number;
 370         char *s;
 371         void (*kernel_entry)(int zero, int arch, uint params);
 372         unsigned long r2;
 373         int fake = (flag & BOOTM_STATE_OS_FAKE_GO);
 374
 375         kernel_entry = (void (*)(int, int, uint))images->ep;
 376 #ifdef CONFIG_CPU_V7M
 377         ulong addr = (ulong)kernel_entry | 1;
 378         kernel_entry = (void *)addr;
 379 #endif
 380         s = env_get("machid");
 381         if (s) {
 382                 if (strict_strtoul(s, 16, &machid) < 0) {
 383                         debug("strict_strtoul failed!\n");
 384                         return;
 385                 }
 386                 printf("Using machid 0x%lx from environment\n", machid);
 387         }
 388
 389         debug("## Transferring control to Linux (at address %08lx)" \
 390                 "...\n", (ulong) kernel_entry);
 391         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
 392         announce_and_cleanup(fake);
 393
 394         if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len)
 395                 r2 = (unsigned long)images->ft_addr;
 396         else
 397                 r2 = gd->bd->bi_boot_params;
 398
 399         if (!fake) {
 400 #ifdef CONFIG_ARMV7_NONSEC
 401                 if (armv7_boot_nonsec()) {
 402                         armv7_init_nonsec();
 403                         secure_ram_addr(_do_nonsec_entry)(kernel_entry,
 404                                                           0, machid, r2);
 405                 } else
 406 #endif
 407                         kernel_entry(0, machid, r2);
 408         }
 409 #endif
 410 }
 411
 412 /* Main Entry point for arm bootm implementation
 413  *
 414  * Modeled after the powerpc implementation
 415  * DIFFERENCE: Instead of calling prep and go at the end
 416  * they are called if subcommand is equal 0.
 417  */
 418 int do_bootm_linux(int flag, int argc, char * const argv[],
 419                    bootm_headers_t *images)
 420 {
 421         /* No need for those on ARM */
 422         if (flag & BOOTM_STATE_OS_BD_T || flag & BOOTM_STATE_OS_CMDLINE)
 423                 return -1;
 424
 425         if (flag & BOOTM_STATE_OS_PREP) {
 426                 boot_prep_linux(images);
 427                 return 0;
 428         }
 429
 430         if (flag & (BOOTM_STATE_OS_GO | BOOTM_STATE_OS_FAKE_GO)) {
 431                 boot_jump_linux(images, flag);
 432                 return 0;
 433         }
 434
 435         boot_prep_linux(images);
 436         boot_jump_linux(images, flag);
 437         return 0;
 438 }
 439
 440 #if defined(CONFIG_BOOTM_VXWORKS)
 441 void boot_prep_vxworks(bootm_headers_t *images)
 442 {
 443 #if defined(CONFIG_OF_LIBFDT)
 444         int off;
 445
 446         if (images->ft_addr) {
 447                 off = fdt_path_offset(images->ft_addr, "/memory");
 448                 if (off > 0) {
 449                         if (arch_fixup_fdt(images->ft_addr))
 450                                 puts("## WARNING: fixup memory failed!\n");
 451                 }
 452         }
 453 #endif
 454         cleanup_before_linux();
 455 }
 456 void boot_jump_vxworks(bootm_headers_t *images)
 457 {
 458 #if defined(CONFIG_ARM64) && defined(CONFIG_ARMV8_PSCI)
 459         armv8_setup_psci();
 460         smp_kick_all_cpus();
 461 #endif
 462
 463         /* ARM VxWorks requires device tree physical address to be passed */
 464         ((void (*)(void *))images->ep)(images->ft_addr);
 465 }
 466 #endif