common/board_f.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (c) 2011 The Chromium OS Authors.
   4  * (C) Copyright 2002-2006
   5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   6  *
   7  * (C) Copyright 2002
   8  * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   9  * Marius Groeger <mgroeger@sysgo.de>
  10  */
  11
  12 #include <common.h>
  13 #include <bloblist.h>
  14 #include <bootstage.h>
  15 #include <clock_legacy.h>
  16 #include <console.h>
  17 #include <cpu.h>
  18 #include <cpu_func.h>
  19 #include <cyclic.h>
  20 #include <display_options.h>
  21 #include <dm.h>
  22 #include <env.h>
  23 #include <env_internal.h>
  24 #include <event.h>
  25 #include <fdtdec.h>
  26 #include <fs.h>
  27 #include <hang.h>
  28 #include <i2c.h>
  29 #include <init.h>
  30 #include <initcall.h>
  31 #include <log.h>
  32 #include <malloc.h>
  33 #include <mapmem.h>
  34 #include <os.h>
  35 #include <post.h>
  36 #include <relocate.h>
  37 #include <serial.h>
  38 #include <spl.h>
  39 #include <status_led.h>
  40 #include <sysreset.h>
  41 #include <timer.h>
  42 #include <trace.h>
  43 #include <video.h>
  44 #include <watchdog.h>
  45 #include <asm/cache.h>
  46 #include <asm/global_data.h>
  47 #include <asm/io.h>
  48 #include <asm/sections.h>
  49 #include <dm/root.h>
  50 #include <linux/errno.h>
  51 #include <linux/log2.h>
  52
  53 DECLARE_GLOBAL_DATA_PTR;
  54
  55 /*
  56  * TODO(sjg@chromium.org): IMO this code should be
  57  * refactored to a single function, something like:
  58  *
  59  * void led_set_state(enum led_colour_t colour, int on);
  60  */
  61 /************************************************************************
  62  * Coloured LED functionality
  63  ************************************************************************
  64  * May be supplied by boards if desired
  65  */
  66 __weak void coloured_LED_init(void) {}
  67 __weak void red_led_on(void) {}
  68 __weak void red_led_off(void) {}
  69 __weak void green_led_on(void) {}
  70 __weak void green_led_off(void) {}
  71 __weak void yellow_led_on(void) {}
  72 __weak void yellow_led_off(void) {}
  73 __weak void blue_led_on(void) {}
  74 __weak void blue_led_off(void) {}
  75
  76 /*
  77  * Why is gd allocated a register? Prior to reloc it might be better to
  78  * just pass it around to each function in this file?
  79  *
  80  * After reloc one could argue that it is hardly used and doesn't need
  81  * to be in a register. Or if it is it should perhaps hold pointers to all
  82  * global data for all modules, so that post-reloc we can avoid the massive
  83  * literal pool we get on ARM. Or perhaps just encourage each module to use
  84  * a structure...
  85  */
  86
  87 #if defined(CONFIG_WATCHDOG) || defined(CONFIG_HW_WATCHDOG)
  88 static int init_func_watchdog_init(void)
  89 {
  90 # if defined(CONFIG_HW_WATCHDOG) && \
  91         (defined(CONFIG_M68K) || defined(CONFIG_MICROBLAZE) || \
  92         defined(CONFIG_SH) || \
  93         defined(CONFIG_DESIGNWARE_WATCHDOG) || \
  94         defined(CONFIG_IMX_WATCHDOG))
  95         hw_watchdog_init();
  96         puts("       Watchdog enabled\n");
  97 # endif
  98         schedule();
  99
 100         return 0;
 101 }
 102
 103 int init_func_watchdog_reset(void)
 104 {
 105         schedule();
 106
 107         return 0;
 108 }
 109 #endif /* CONFIG_WATCHDOG */
 110
 111 __weak void board_add_ram_info(int use_default)
 112 {
 113         /* please define platform specific board_add_ram_info() */
 114 }
 115
 116 static int init_baud_rate(void)
 117 {
 118         gd->baudrate = env_get_ulong("baudrate", 10, CONFIG_BAUDRATE);
 119         return 0;
 120 }
 121
 122 static int display_text_info(void)
 123 {
 124 #if !defined(CONFIG_SANDBOX) && !defined(CONFIG_EFI_APP)
 125         ulong bss_start, bss_end, text_base;
 126
 127         bss_start = (ulong)&__bss_start;
 128         bss_end = (ulong)&__bss_end;
 129
 130 #ifdef CONFIG_TEXT_BASE
 131         text_base = CONFIG_TEXT_BASE;
 132 #else
 133         text_base = CONFIG_SYS_MONITOR_BASE;
 134 #endif
 135
 136         debug("U-Boot code: %08lX -> %08lX  BSS: -> %08lX\n",
 137               text_base, bss_start, bss_end);
 138 #endif
 139
 140         return 0;
 141 }
 142
 143 #ifdef CONFIG_SYSRESET
 144 static int print_resetinfo(void)
 145 {
 146         struct udevice *dev;
 147         char status[256];
 148         bool status_printed = false;
 149         int ret;
 150
 151         /* Not all boards have sysreset drivers available during early
 152          * boot, so don't fail if one can't be found.
 153          */
 154         for (ret = uclass_first_device_check(UCLASS_SYSRESET, &dev); dev;
 155                         ret = uclass_next_device_check(&dev)) {
 156                 if (ret) {
 157                         debug("%s: %s sysreset device (error: %d)\n",
 158                               __func__, dev->name, ret);
 159                         continue;
 160                 }
 161
 162                 if (!sysreset_get_status(dev, status, sizeof(status))) {
 163                         printf("%s%s", status_printed ? " " : "", status);
 164                         status_printed = true;
 165                 }
 166         }
 167         if (status_printed)
 168                 printf("\n");
 169
 170         return 0;
 171 }
 172 #endif
 173
 174 #if defined(CONFIG_DISPLAY_CPUINFO) && CONFIG_IS_ENABLED(CPU)
 175 static int print_cpuinfo(void)
 176 {
 177         struct udevice *dev;
 178         char desc[512];
 179         int ret;
 180
 181         dev = cpu_get_current_dev();
 182         if (!dev) {
 183                 debug("%s: Could not get CPU device\n",
 184                       __func__);
 185                 return -ENODEV;
 186         }
 187
 188         ret = cpu_get_desc(dev, desc, sizeof(desc));
 189         if (ret) {
 190                 debug("%s: Could not get CPU description (err = %d)\n",
 191                       dev->name, ret);
 192                 return ret;
 193         }
 194
 195         printf("CPU:   %s\n", desc);
 196
 197         return 0;
 198 }
 199 #endif
 200
 201 static int announce_dram_init(void)
 202 {
 203         puts("DRAM:  ");
 204         return 0;
 205 }
 206
 207 /*
 208  * From input size calculate its nearest rounded unit scale (multiply of 2^10)
 209  * and value in calculated unit scale multiplied by 10 (as fractional fixed
 210  * point number with one decimal digit), which is human natural format,
 211  * same what uses print_size() function for displaying. Mathematically it is:
 212  * round_nearest(val * 2^scale) = size * 10; where: 10 <= val < 10240.
 213  *
 214  * For example for size=87654321 we calculate scale=20 and val=836 which means
 215  * that input has natural human format 83.6 M (mega = 2^20).
 216  */
 217 #define compute_size_scale_val(size, scale, val) do { \
 218         scale = ilog2(size) / 10 * 10; \
 219         val = (10 * size + ((1ULL << scale) >> 1)) >> scale; \
 220         if (val == 10240) { val = 10; scale += 10; } \
 221 } while (0)
 222
 223 /*
 224  * Check if the sizes in their natural units written in decimal format with
 225  * one fraction number are same.
 226  */
 227 static int sizes_near(unsigned long long size1, unsigned long long size2)
 228 {
 229         unsigned int size1_scale, size1_val, size2_scale, size2_val;
 230
 231         compute_size_scale_val(size1, size1_scale, size1_val);
 232         compute_size_scale_val(size2, size2_scale, size2_val);
 233
 234         return size1_scale == size2_scale && size1_val == size2_val;
 235 }
 236
 237 static int show_dram_config(void)
 238 {
 239         unsigned long long size;
 240         int i;
 241
 242         debug("\nRAM Configuration:\n");
 243         for (i = size = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
 244                 size += gd->bd->bi_dram[i].size;
 245                 debug("Bank #%d: %llx ", i,
 246                       (unsigned long long)(gd->bd->bi_dram[i].start));
 247 #ifdef DEBUG
 248                 print_size(gd->bd->bi_dram[i].size, "\n");
 249 #endif
 250         }
 251         debug("\nDRAM:  ");
 252
 253         print_size(gd->ram_size, "");
 254         if (!sizes_near(gd->ram_size, size)) {
 255                 printf(" (effective ");
 256                 print_size(size, ")");
 257         }
 258         board_add_ram_info(0);
 259         putc('\n');
 260
 261         return 0;
 262 }
 263
 264 __weak int dram_init_banksize(void)
 265 {
 266         gd->bd->bi_dram[0].start = gd->ram_base;
 267         gd->bd->bi_dram[0].size = get_effective_memsize();
 268
 269         return 0;
 270 }
 271
 272 #if CONFIG_IS_ENABLED(SYS_I2C_LEGACY)
 273 static int init_func_i2c(void)
 274 {
 275         puts("I2C:   ");
 276         i2c_init_all();
 277         puts("ready\n");
 278         return 0;
 279 }
 280 #endif
 281
 282 #if defined(CONFIG_VID)
 283 __weak int init_func_vid(void)
 284 {
 285         return 0;
 286 }
 287 #endif
 288
 289 static int setup_mon_len(void)
 290 {
 291 #if defined(__ARM__) || defined(__MICROBLAZE__)
 292         gd->mon_len = (ulong)&__bss_end - (ulong)_start;
 293 #elif defined(CONFIG_SANDBOX) && !defined(__riscv)
 294         gd->mon_len = (ulong)&_end - (ulong)_init;
 295 #elif defined(CONFIG_SANDBOX)
 296         /* gcc does not provide _init in crti.o on RISC-V */
 297         gd->mon_len = 0;
 298 #elif defined(CONFIG_EFI_APP)
 299         gd->mon_len = (ulong)&_end - (ulong)_init;
 300 #elif defined(CONFIG_NIOS2) || defined(CONFIG_XTENSA)
 301         gd->mon_len = CONFIG_SYS_MONITOR_LEN;
 302 #elif defined(CONFIG_SH) || defined(CONFIG_RISCV)
 303         gd->mon_len = (ulong)(&__bss_end) - (ulong)(&_start);
 304 #elif defined(CONFIG_SYS_MONITOR_BASE)
 305         /* TODO: use (ulong)&__bss_end - (ulong)&__text_start; ? */
 306         gd->mon_len = (ulong)&__bss_end - CONFIG_SYS_MONITOR_BASE;
 307 #endif
 308         return 0;
 309 }
 310
 311 static int setup_spl_handoff(void)
 312 {
 313 #if CONFIG_IS_ENABLED(HANDOFF)
 314         gd->spl_handoff = bloblist_find(BLOBLISTT_U_BOOT_SPL_HANDOFF,
 315                                         sizeof(struct spl_handoff));
 316         debug("Found SPL hand-off info %p\n", gd->spl_handoff);
 317 #endif
 318
 319         return 0;
 320 }
 321
 322 __weak int arch_cpu_init(void)
 323 {
 324         return 0;
 325 }
 326
 327 __weak int mach_cpu_init(void)
 328 {
 329         return 0;
 330 }
 331
 332 /* Get the top of usable RAM */
 333 __weak phys_addr_t board_get_usable_ram_top(phys_size_t total_size)
 334 {
 335 #if defined(CFG_SYS_SDRAM_BASE) && CFG_SYS_SDRAM_BASE > 0
 336         /*
 337          * Detect whether we have so much RAM that it goes past the end of our
 338          * 32-bit address space. If so, clip the usable RAM so it doesn't.
 339          */
 340         if (gd->ram_top < CFG_SYS_SDRAM_BASE)
 341                 /*
 342                  * Will wrap back to top of 32-bit space when reservations
 343                  * are made.
 344                  */
 345                 return 0;
 346 #endif
 347         return gd->ram_top;
 348 }
 349
 350 __weak int arch_setup_dest_addr(void)
 351 {
 352         return 0;
 353 }
 354
 355 static int setup_dest_addr(void)
 356 {
 357         debug("Monitor len: %08lX\n", gd->mon_len);
 358         /*
 359          * Ram is setup, size stored in gd !!
 360          */
 361         debug("Ram size: %08llX\n", (unsigned long long)gd->ram_size);
 362 #if CONFIG_VAL(SYS_MEM_TOP_HIDE)
 363         /*
 364          * Subtract specified amount of memory to hide so that it won't
 365          * get "touched" at all by U-Boot. By fixing up gd->ram_size
 366          * the Linux kernel should now get passed the now "corrected"
 367          * memory size and won't touch it either. This should work
 368          * for arch/ppc and arch/powerpc. Only Linux board ports in
 369          * arch/powerpc with bootwrapper support, that recalculate the
 370          * memory size from the SDRAM controller setup will have to
 371          * get fixed.
 372          */
 373         gd->ram_size -= CONFIG_SYS_MEM_TOP_HIDE;
 374 #endif
 375 #ifdef CFG_SYS_SDRAM_BASE
 376         gd->ram_base = CFG_SYS_SDRAM_BASE;
 377 #endif
 378         gd->ram_top = gd->ram_base + get_effective_memsize();
 379         gd->ram_top = board_get_usable_ram_top(gd->mon_len);
 380         gd->relocaddr = gd->ram_top;
 381         debug("Ram top: %08llX\n", (unsigned long long)gd->ram_top);
 382
 383         return arch_setup_dest_addr();
 384 }
 385
 386 #ifdef CFG_PRAM
 387 /* reserve protected RAM */
 388 static int reserve_pram(void)
 389 {
 390         ulong reg;
 391
 392         reg = env_get_ulong("pram", 10, CFG_PRAM);
 393         gd->relocaddr -= (reg << 10);           /* size is in kB */
 394         debug("Reserving %ldk for protected RAM at %08lx\n", reg,
 395               gd->relocaddr);
 396         return 0;
 397 }
 398 #endif /* CFG_PRAM */
 399
 400 /* Round memory pointer down to next 4 kB limit */
 401 static int reserve_round_4k(void)
 402 {
 403         gd->relocaddr &= ~(4096 - 1);
 404         return 0;
 405 }
 406
 407 __weak int arch_reserve_mmu(void)
 408 {
 409         return 0;
 410 }
 411
 412 static int reserve_video(void)
 413 {
 414         if (IS_ENABLED(CONFIG_SPL_VIDEO_HANDOFF) && spl_phase() > PHASE_SPL) {
 415                 struct video_handoff *ho;
 416
 417                 ho = bloblist_find(BLOBLISTT_U_BOOT_VIDEO, sizeof(*ho));
 418                 if (!ho)
 419                         return log_msg_ret("blf", -ENOENT);
 420                 video_reserve_from_bloblist(ho);
 421                 gd->relocaddr = ho->fb;
 422         } else if (CONFIG_IS_ENABLED(VIDEO)) {
 423                 ulong addr;
 424                 int ret;
 425
 426                 addr = gd->relocaddr;
 427                 ret = video_reserve(&addr);
 428                 if (ret)
 429                         return ret;
 430                 debug("Reserving %luk for video at: %08lx\n",
 431                       ((unsigned long)gd->relocaddr - addr) >> 10, addr);
 432                 gd->relocaddr = addr;
 433         }
 434
 435         return 0;
 436 }
 437
 438 static int reserve_trace(void)
 439 {
 440 #ifdef CONFIG_TRACE
 441         gd->relocaddr -= CONFIG_TRACE_BUFFER_SIZE;
 442         gd->trace_buff = map_sysmem(gd->relocaddr, CONFIG_TRACE_BUFFER_SIZE);
 443         debug("Reserving %luk for trace data at: %08lx\n",
 444               (unsigned long)CONFIG_TRACE_BUFFER_SIZE >> 10, gd->relocaddr);
 445 #endif
 446
 447         return 0;
 448 }
 449
 450 static int reserve_uboot(void)
 451 {
 452         if (!(gd->flags & GD_FLG_SKIP_RELOC)) {
 453                 /*
 454                  * reserve memory for U-Boot code, data & bss
 455                  * round down to next 4 kB limit
 456                  */
 457                 gd->relocaddr -= gd->mon_len;
 458                 gd->relocaddr &= ~(4096 - 1);
 459         #if defined(CONFIG_E500) || defined(CONFIG_MIPS)
 460                 /* round down to next 64 kB limit so that IVPR stays aligned */
 461                 gd->relocaddr &= ~(65536 - 1);
 462         #endif
 463
 464                 debug("Reserving %ldk for U-Boot at: %08lx\n",
 465                       gd->mon_len >> 10, gd->relocaddr);
 466         }
 467
 468         gd->start_addr_sp = gd->relocaddr;
 469
 470         return 0;
 471 }
 472
 473 /*
 474  * reserve after start_addr_sp the requested size and make the stack pointer
 475  * 16-byte aligned, this alignment is needed for cast on the reserved memory
 476  * ref = x86_64 ABI: https://reviews.llvm.org/D30049: 16 bytes
 477  *     = ARMv8 Instruction Set Overview: quad word, 16 bytes
 478  */
 479 static unsigned long reserve_stack_aligned(size_t size)
 480 {
 481         return ALIGN_DOWN(gd->start_addr_sp - size, 16);
 482 }
 483
 484 #ifdef CONFIG_SYS_NONCACHED_MEMORY
 485 static int reserve_noncached(void)
 486 {
 487         /*
 488          * The value of gd->start_addr_sp must match the value of malloc_start
 489          * calculated in board_r.c:initr_malloc(), which is passed to
 490          * dlmalloc.c:mem_malloc_init() and then used by
 491          * cache.c:noncached_init()
 492          *
 493          * These calculations must match the code in cache.c:noncached_init()
 494          */
 495         gd->start_addr_sp = ALIGN(gd->start_addr_sp, MMU_SECTION_SIZE) -
 496                 MMU_SECTION_SIZE;
 497         gd->start_addr_sp -= ALIGN(CONFIG_SYS_NONCACHED_MEMORY,
 498                                    MMU_SECTION_SIZE);
 499         debug("Reserving %dM for noncached_alloc() at: %08lx\n",
 500               CONFIG_SYS_NONCACHED_MEMORY >> 20, gd->start_addr_sp);
 501
 502         return 0;
 503 }
 504 #endif
 505
 506 /* reserve memory for malloc() area */
 507 static int reserve_malloc(void)
 508 {
 509         gd->start_addr_sp = reserve_stack_aligned(TOTAL_MALLOC_LEN);
 510         debug("Reserving %dk for malloc() at: %08lx\n",
 511               TOTAL_MALLOC_LEN >> 10, gd->start_addr_sp);
 512 #ifdef CONFIG_SYS_NONCACHED_MEMORY
 513         reserve_noncached();
 514 #endif
 515
 516         return 0;
 517 }
 518
 519 /* (permanently) allocate a Board Info struct */
 520 static int reserve_board(void)
 521 {
 522         if (!gd->bd) {
 523                 gd->start_addr_sp = reserve_stack_aligned(sizeof(struct bd_info));
 524                 gd->bd = (struct bd_info *)map_sysmem(gd->start_addr_sp,
 525                                                       sizeof(struct bd_info));
 526                 memset(gd->bd, '\0', sizeof(struct bd_info));
 527                 debug("Reserving %zu Bytes for Board Info at: %08lx\n",
 528                       sizeof(struct bd_info), gd->start_addr_sp);
 529         }
 530         return 0;
 531 }
 532
 533 static int reserve_global_data(void)
 534 {
 535         gd->start_addr_sp = reserve_stack_aligned(sizeof(gd_t));
 536         gd->new_gd = (gd_t *)map_sysmem(gd->start_addr_sp, sizeof(gd_t));
 537         debug("Reserving %zu Bytes for Global Data at: %08lx\n",
 538               sizeof(gd_t), gd->start_addr_sp);
 539         return 0;
 540 }
 541
 542 static int reserve_fdt(void)
 543 {
 544         if (!IS_ENABLED(CONFIG_OF_EMBED)) {
 545                 /*
 546                  * If the device tree is sitting immediately above our image
 547                  * then we must relocate it. If it is embedded in the data
 548                  * section, then it will be relocated with other data.
 549                  */
 550                 if (gd->fdt_blob) {
 551                         gd->fdt_size = ALIGN(fdt_totalsize(gd->fdt_blob), 32);
 552
 553                         gd->start_addr_sp = reserve_stack_aligned(gd->fdt_size);
 554                         gd->new_fdt = map_sysmem(gd->start_addr_sp, gd->fdt_size);
 555                         debug("Reserving %lu Bytes for FDT at: %08lx\n",
 556                               gd->fdt_size, gd->start_addr_sp);
 557                 }
 558         }
 559
 560         return 0;
 561 }
 562
 563 static int reserve_bootstage(void)
 564 {
 565 #ifdef CONFIG_BOOTSTAGE
 566         int size = bootstage_get_size();
 567
 568         gd->start_addr_sp = reserve_stack_aligned(size);
 569         gd->new_bootstage = map_sysmem(gd->start_addr_sp, size);
 570         debug("Reserving %#x Bytes for bootstage at: %08lx\n", size,
 571               gd->start_addr_sp);
 572 #endif
 573
 574         return 0;
 575 }
 576
 577 __weak int arch_reserve_stacks(void)
 578 {
 579         return 0;
 580 }
 581
 582 static int reserve_stacks(void)
 583 {
 584         /* make stack pointer 16-byte aligned */
 585         gd->start_addr_sp = reserve_stack_aligned(16);
 586
 587         /*
 588          * let the architecture-specific code tailor gd->start_addr_sp and
 589          * gd->irq_sp
 590          */
 591         return arch_reserve_stacks();
 592 }
 593
 594 static int reserve_bloblist(void)
 595 {
 596 #ifdef CONFIG_BLOBLIST
 597         /* Align to a 4KB boundary for easier reading of addresses */
 598         gd->start_addr_sp = ALIGN_DOWN(gd->start_addr_sp -
 599                                        CONFIG_BLOBLIST_SIZE_RELOC, 0x1000);
 600         gd->new_bloblist = map_sysmem(gd->start_addr_sp,
 601                                       CONFIG_BLOBLIST_SIZE_RELOC);
 602 #endif
 603
 604         return 0;
 605 }
 606
 607 static int display_new_sp(void)
 608 {
 609         debug("New Stack Pointer is: %08lx\n", gd->start_addr_sp);
 610
 611         return 0;
 612 }
 613
 614 __weak int arch_setup_bdinfo(void)
 615 {
 616         return 0;
 617 }
 618
 619 int setup_bdinfo(void)
 620 {
 621         struct bd_info *bd = gd->bd;
 622
 623         if (IS_ENABLED(CONFIG_SYS_HAS_SRAM)) {
 624                 bd->bi_sramstart = CONFIG_SYS_SRAM_BASE; /* start of SRAM */
 625                 bd->bi_sramsize = CONFIG_SYS_SRAM_SIZE;  /* size  of SRAM */
 626         }
 627
 628         return arch_setup_bdinfo();
 629 }
 630
 631 #ifdef CONFIG_POST
 632 static int init_post(void)
 633 {
 634         post_bootmode_init();
 635         post_run(NULL, POST_ROM | post_bootmode_get(0));
 636
 637         return 0;
 638 }
 639 #endif
 640
 641 static int reloc_fdt(void)
 642 {
 643         if (!IS_ENABLED(CONFIG_OF_EMBED)) {
 644                 if (gd->new_fdt) {
 645                         memcpy(gd->new_fdt, gd->fdt_blob,
 646                                fdt_totalsize(gd->fdt_blob));
 647                         gd->fdt_blob = gd->new_fdt;
 648                 }
 649         }
 650
 651         return 0;
 652 }
 653
 654 static int reloc_bootstage(void)
 655 {
 656 #ifdef CONFIG_BOOTSTAGE
 657         if (gd->flags & GD_FLG_SKIP_RELOC)
 658                 return 0;
 659         if (gd->new_bootstage) {
 660                 int size = bootstage_get_size();
 661
 662                 debug("Copying bootstage from %p to %p, size %x\n",
 663                       gd->bootstage, gd->new_bootstage, size);
 664                 memcpy(gd->new_bootstage, gd->bootstage, size);
 665                 gd->bootstage = gd->new_bootstage;
 666                 bootstage_relocate();
 667         }
 668 #endif
 669
 670         return 0;
 671 }
 672
 673 static int reloc_bloblist(void)
 674 {
 675 #ifdef CONFIG_BLOBLIST
 676         /*
 677          * Relocate only if we are supposed to send it
 678          */
 679         if ((gd->flags & GD_FLG_SKIP_RELOC) &&
 680             CONFIG_BLOBLIST_SIZE == CONFIG_BLOBLIST_SIZE_RELOC) {
 681                 debug("Not relocating bloblist\n");
 682                 return 0;
 683         }
 684         if (gd->new_bloblist) {
 685                 int size = CONFIG_BLOBLIST_SIZE;
 686
 687                 debug("Copying bloblist from %p to %p, size %x\n",
 688                       gd->bloblist, gd->new_bloblist, size);
 689                 bloblist_reloc(gd->new_bloblist, CONFIG_BLOBLIST_SIZE_RELOC,
 690                                gd->bloblist, size);
 691                 gd->bloblist = gd->new_bloblist;
 692         }
 693 #endif
 694
 695         return 0;
 696 }
 697
 698 static int setup_reloc(void)
 699 {
 700         if (!(gd->flags & GD_FLG_SKIP_RELOC)) {
 701 #ifdef CONFIG_TEXT_BASE
 702 #ifdef ARM
 703                 gd->reloc_off = gd->relocaddr - (unsigned long)__image_copy_start;
 704 #elif defined(CONFIG_MICROBLAZE)
 705                 gd->reloc_off = gd->relocaddr - (u32)_start;
 706 #elif defined(CONFIG_M68K)
 707                 /*
 708                  * On all ColdFire arch cpu, monitor code starts always
 709                  * just after the default vector table location, so at 0x400
 710                  */
 711                 gd->reloc_off = gd->relocaddr - (CONFIG_TEXT_BASE + 0x400);
 712 #elif !defined(CONFIG_SANDBOX)
 713                 gd->reloc_off = gd->relocaddr - CONFIG_TEXT_BASE;
 714 #endif
 715 #endif
 716         }
 717
 718         memcpy(gd->new_gd, (char *)gd, sizeof(gd_t));
 719
 720         if (gd->flags & GD_FLG_SKIP_RELOC) {
 721                 debug("Skipping relocation due to flag\n");
 722         } else {
 723                 debug("Relocation Offset is: %08lx\n", gd->reloc_off);
 724                 debug("Relocating to %08lx, new gd at %08lx, sp at %08lx\n",
 725                       gd->relocaddr, (ulong)map_to_sysmem(gd->new_gd),
 726                       gd->start_addr_sp);
 727         }
 728
 729         return 0;
 730 }
 731
 732 #ifdef CONFIG_OF_BOARD_FIXUP
 733 static int fix_fdt(void)
 734 {
 735         return board_fix_fdt((void *)gd->fdt_blob);
 736 }
 737 #endif
 738
 739 /* ARM calls relocate_code from its crt0.S */
 740 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX)
 741
 742 static int jump_to_copy(void)
 743 {
 744         if (gd->flags & GD_FLG_SKIP_RELOC)
 745                 return 0;
 746         /*
 747          * x86 is special, but in a nice way. It uses a trampoline which
 748          * enables the dcache if possible.
 749          *
 750          * For now, other archs use relocate_code(), which is implemented
 751          * similarly for all archs. When we do generic relocation, hopefully
 752          * we can make all archs enable the dcache prior to relocation.
 753          */
 754 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
 755         /*
 756          * SDRAM and console are now initialised. The final stack can now
 757          * be setup in SDRAM. Code execution will continue in Flash, but
 758          * with the stack in SDRAM and Global Data in temporary memory
 759          * (CPU cache)
 760          */
 761         arch_setup_gd(gd->new_gd);
 762 # if CONFIG_IS_ENABLED(X86_64)
 763                 board_init_f_r_trampoline64(gd->new_gd, gd->start_addr_sp);
 764 # else
 765                 board_init_f_r_trampoline(gd->start_addr_sp);
 766 # endif
 767 #else
 768         relocate_code(gd->start_addr_sp, gd->new_gd, gd->relocaddr);
 769 #endif
 770
 771         return 0;
 772 }
 773 #endif
 774
 775 /* Record the board_init_f() bootstage (after arch_cpu_init()) */
 776 static int initf_bootstage(void)
 777 {
 778         bool from_spl = IS_ENABLED(CONFIG_SPL_BOOTSTAGE) &&
 779                         IS_ENABLED(CONFIG_BOOTSTAGE_STASH);
 780         int ret;
 781
 782         ret = bootstage_init(!from_spl);
 783         if (ret)
 784                 return ret;
 785         if (from_spl) {
 786                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
 787                                                CONFIG_BOOTSTAGE_STASH_SIZE);
 788
 789                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
 790                 if (ret && ret != -ENOENT) {
 791                         debug("Failed to unstash bootstage: err=%d\n", ret);
 792                         return ret;
 793                 }
 794         }
 795
 796         bootstage_mark_name(BOOTSTAGE_ID_START_UBOOT_F, "board_init_f");
 797
 798         return 0;
 799 }
 800
 801 static int initf_dm(void)
 802 {
 803 #if defined(CONFIG_DM) && CONFIG_VAL(SYS_MALLOC_F_LEN)
 804         int ret;
 805
 806         bootstage_start(BOOTSTAGE_ID_ACCUM_DM_F, "dm_f");
 807         ret = dm_init_and_scan(true);
 808         bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_F);
 809         if (ret)
 810                 return ret;
 811
 812         if (IS_ENABLED(CONFIG_TIMER_EARLY)) {
 813                 ret = dm_timer_init();
 814                 if (ret)
 815                         return ret;
 816         }
 817 #endif
 818
 819         return 0;
 820 }
 821
 822 /* Architecture-specific memory reservation */
 823 __weak int reserve_arch(void)
 824 {
 825         return 0;
 826 }
 827
 828 __weak int checkcpu(void)
 829 {
 830         return 0;
 831 }
 832
 833 __weak int clear_bss(void)
 834 {
 835         return 0;
 836 }
 837
 838 static int misc_init_f(void)
 839 {
 840         return event_notify_null(EVT_MISC_INIT_F);
 841 }
 842
 843 static const init_fnc_t init_sequence_f[] = {
 844         setup_mon_len,
 845 #ifdef CONFIG_OF_CONTROL
 846         fdtdec_setup,
 847 #endif
 848 #ifdef CONFIG_TRACE_EARLY
 849         trace_early_init,
 850 #endif
 851         initf_malloc,
 852         log_init,
 853         initf_bootstage,        /* uses its own timer, so does not need DM */
 854         event_init,
 855 #ifdef CONFIG_BLOBLIST
 856         bloblist_init,
 857 #endif
 858         setup_spl_handoff,
 859 #if defined(CONFIG_CONSOLE_RECORD_INIT_F)
 860         console_record_init,
 861 #endif
 862 #if defined(CONFIG_HAVE_FSP)
 863         arch_fsp_init,
 864 #endif
 865         arch_cpu_init,          /* basic arch cpu dependent setup */
 866         mach_cpu_init,          /* SoC/machine dependent CPU setup */
 867         initf_dm,
 868 #if defined(CONFIG_BOARD_EARLY_INIT_F)
 869         board_early_init_f,
 870 #endif
 871 #if defined(CONFIG_PPC) || defined(CONFIG_SYS_FSL_CLK) || defined(CONFIG_M68K)
 872         /* get CPU and bus clocks according to the environment variable */
 873         get_clocks,             /* get CPU and bus clocks (etc.) */
 874 #endif
 875 #if !defined(CONFIG_M68K) || (defined(CONFIG_M68K) && !defined(CONFIG_MCFTMR))
 876         timer_init,             /* initialize timer */
 877 #endif
 878 #if defined(CONFIG_BOARD_POSTCLK_INIT)
 879         board_postclk_init,
 880 #endif
 881         env_init,               /* initialize environment */
 882         init_baud_rate,         /* initialze baudrate settings */
 883         serial_init,            /* serial communications setup */
 884         console_init_f,         /* stage 1 init of console */
 885         display_options,        /* say that we are here */
 886         display_text_info,      /* show debugging info if required */
 887         checkcpu,
 888 #if defined(CONFIG_SYSRESET)
 889         print_resetinfo,
 890 #endif
 891 #if defined(CONFIG_DISPLAY_CPUINFO)
 892         print_cpuinfo,          /* display cpu info (and speed) */
 893 #endif
 894 #if defined(CONFIG_DTB_RESELECT)
 895         embedded_dtb_select,
 896 #endif
 897 #if defined(CONFIG_DISPLAY_BOARDINFO)
 898         show_board_info,
 899 #endif
 900         INIT_FUNC_WATCHDOG_INIT
 901         misc_init_f,
 902         INIT_FUNC_WATCHDOG_RESET
 903 #if CONFIG_IS_ENABLED(SYS_I2C_LEGACY)
 904         init_func_i2c,
 905 #endif
 906 #if defined(CONFIG_VID) && !defined(CONFIG_SPL)
 907         init_func_vid,
 908 #endif
 909         announce_dram_init,
 910         dram_init,              /* configure available RAM banks */
 911 #ifdef CONFIG_POST
 912         post_init_f,
 913 #endif
 914         INIT_FUNC_WATCHDOG_RESET
 915 #if defined(CFG_SYS_DRAM_TEST)
 916         testdram,
 917 #endif /* CFG_SYS_DRAM_TEST */
 918         INIT_FUNC_WATCHDOG_RESET
 919
 920 #ifdef CONFIG_POST
 921         init_post,
 922 #endif
 923         INIT_FUNC_WATCHDOG_RESET
 924         /*
 925          * Now that we have DRAM mapped and working, we can
 926          * relocate the code and continue running from DRAM.
 927          *
 928          * Reserve memory at end of RAM for (top down in that order):
 929          *  - area that won't get touched by U-Boot and Linux (optional)
 930          *  - kernel log buffer
 931          *  - protected RAM
 932          *  - LCD framebuffer
 933          *  - monitor code
 934          *  - board info struct
 935          */
 936         setup_dest_addr,
 937 #ifdef CONFIG_OF_BOARD_FIXUP
 938         fix_fdt,
 939 #endif
 940 #ifdef CFG_PRAM
 941         reserve_pram,
 942 #endif
 943         reserve_round_4k,
 944         arch_reserve_mmu,
 945         reserve_video,
 946         reserve_trace,
 947         reserve_uboot,
 948         reserve_malloc,
 949         reserve_board,
 950         reserve_global_data,
 951         reserve_fdt,
 952         reserve_bootstage,
 953         reserve_bloblist,
 954         reserve_arch,
 955         reserve_stacks,
 956         dram_init_banksize,
 957         show_dram_config,
 958         INIT_FUNC_WATCHDOG_RESET
 959         setup_bdinfo,
 960         display_new_sp,
 961         INIT_FUNC_WATCHDOG_RESET
 962         reloc_fdt,
 963         reloc_bootstage,
 964         reloc_bloblist,
 965         setup_reloc,
 966 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
 967         copy_uboot_to_ram,
 968         do_elf_reloc_fixups,
 969 #endif
 970         clear_bss,
 971         /*
 972          * Deregister all cyclic functions before relocation, so that
 973          * gd->cyclic_list does not contain any references to pre-relocation
 974          * devices. Drivers will register their cyclic functions anew when the
 975          * devices are probed again.
 976          *
 977          * This should happen as late as possible so that the window where a
 978          * watchdog device is not serviced is as small as possible.
 979          */
 980         cyclic_unregister_all,
 981 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX)
 982         jump_to_copy,
 983 #endif
 984         NULL,
 985 };
 986
 987 void board_init_f(ulong boot_flags)
 988 {
 989         gd->flags = boot_flags;
 990         gd->have_console = 0;
 991
 992         if (initcall_run_list(init_sequence_f))
 993                 hang();
 994
 995 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
 996                 !defined(CONFIG_EFI_APP) && !CONFIG_IS_ENABLED(X86_64) && \
 997                 !defined(CONFIG_ARC)
 998         /* NOTREACHED - jump_to_copy() does not return */
 999         hang();
1000 #endif
1001 }
1002
1003 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
1004 /*
1005  * For now this code is only used on x86.
1006  *
1007  * init_sequence_f_r is the list of init functions which are run when
1008  * U-Boot is executing from Flash with a semi-limited 'C' environment.
1009  * The following limitations must be considered when implementing an
1010  * '_f_r' function:
1011  *  - 'static' variables are read-only
1012  *  - Global Data (gd->xxx) is read/write
1013  *
1014  * The '_f_r' sequence must, as a minimum, copy U-Boot to RAM (if
1015  * supported).  It _should_, if possible, copy global data to RAM and
1016  * initialise the CPU caches (to speed up the relocation process)
1017  *
1018  * NOTE: At present only x86 uses this route, but it is intended that
1019  * all archs will move to this when generic relocation is implemented.
1020  */
1021 static const init_fnc_t init_sequence_f_r[] = {
1022 #if !CONFIG_IS_ENABLED(X86_64)
1023         init_cache_f_r,
1024 #endif
1025
1026         NULL,
1027 };
1028
1029 void board_init_f_r(void)
1030 {
1031         if (initcall_run_list(init_sequence_f_r))
1032                 hang();
1033
1034         /*
1035          * The pre-relocation drivers may be using memory that has now gone
1036          * away. Mark serial as unavailable - this will fall back to the debug
1037          * UART if available.
1038          *
1039          * Do the same with log drivers since the memory may not be available.
1040          */
1041         gd->flags &= ~(GD_FLG_SERIAL_READY | GD_FLG_LOG_READY);
1042 #ifdef CONFIG_TIMER
1043         gd->timer = NULL;
1044 #endif
1045
1046         /*
1047          * U-Boot has been copied into SDRAM, the BSS has been cleared etc.
1048          * Transfer execution from Flash to RAM by calculating the address
1049          * of the in-RAM copy of board_init_r() and calling it
1050          */
1051         (board_init_r + gd->reloc_off)((gd_t *)gd, gd->relocaddr);
1052
1053         /* NOTREACHED - board_init_r() does not return */
1054         hang();
1055 }
1056 #endif /* CONFIG_X86 */