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