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