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