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