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