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