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