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