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