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