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