Merge https://gitlab.denx.de/u-boot/custodians/u-boot-mpc85xx
[platform/kernel/u-boot.git] / 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 #  ifdef CONFIG_FB_ADDR
404         gd->fb_base = CONFIG_FB_ADDR;
405 #  else
406         /* reserve memory for LCD display (always full pages) */
407         gd->relocaddr = lcd_setmem(gd->relocaddr);
408         gd->fb_base = gd->relocaddr;
409 #  endif /* CONFIG_FB_ADDR */
410 #endif
411
412         return 0;
413 }
414
415 static int reserve_trace(void)
416 {
417 #ifdef CONFIG_TRACE
418         gd->relocaddr -= CONFIG_TRACE_BUFFER_SIZE;
419         gd->trace_buff = map_sysmem(gd->relocaddr, CONFIG_TRACE_BUFFER_SIZE);
420         debug("Reserving %luk for trace data at: %08lx\n",
421               (unsigned long)CONFIG_TRACE_BUFFER_SIZE >> 10, gd->relocaddr);
422 #endif
423
424         return 0;
425 }
426
427 static int reserve_uboot(void)
428 {
429         if (!(gd->flags & GD_FLG_SKIP_RELOC)) {
430                 /*
431                  * reserve memory for U-Boot code, data & bss
432                  * round down to next 4 kB limit
433                  */
434                 gd->relocaddr -= gd->mon_len;
435                 gd->relocaddr &= ~(4096 - 1);
436         #if defined(CONFIG_E500) || defined(CONFIG_MIPS)
437                 /* round down to next 64 kB limit so that IVPR stays aligned */
438                 gd->relocaddr &= ~(65536 - 1);
439         #endif
440
441                 debug("Reserving %ldk for U-Boot at: %08lx\n",
442                       gd->mon_len >> 10, gd->relocaddr);
443         }
444
445         gd->start_addr_sp = gd->relocaddr;
446
447         return 0;
448 }
449
450 /*
451  * reserve after start_addr_sp the requested size and make the stack pointer
452  * 16-byte aligned, this alignment is needed for cast on the reserved memory
453  * ref = x86_64 ABI: https://reviews.llvm.org/D30049: 16 bytes
454  *     = ARMv8 Instruction Set Overview: quad word, 16 bytes
455  */
456 static unsigned long reserve_stack_aligned(size_t size)
457 {
458         return ALIGN_DOWN(gd->start_addr_sp - size, 16);
459 }
460
461 #ifdef CONFIG_SYS_NONCACHED_MEMORY
462 static int reserve_noncached(void)
463 {
464         /*
465          * The value of gd->start_addr_sp must match the value of malloc_start
466          * calculated in boatrd_f.c:initr_malloc(), which is passed to
467          * board_r.c:mem_malloc_init() and then used by
468          * cache.c:noncached_init()
469          *
470          * These calculations must match the code in cache.c:noncached_init()
471          */
472         gd->start_addr_sp = ALIGN(gd->start_addr_sp, MMU_SECTION_SIZE) -
473                 MMU_SECTION_SIZE;
474         gd->start_addr_sp -= ALIGN(CONFIG_SYS_NONCACHED_MEMORY,
475                                    MMU_SECTION_SIZE);
476         debug("Reserving %dM for noncached_alloc() at: %08lx\n",
477               CONFIG_SYS_NONCACHED_MEMORY >> 20, gd->start_addr_sp);
478
479         return 0;
480 }
481 #endif
482
483 /* reserve memory for malloc() area */
484 static int reserve_malloc(void)
485 {
486         gd->start_addr_sp = reserve_stack_aligned(TOTAL_MALLOC_LEN);
487         debug("Reserving %dk for malloc() at: %08lx\n",
488               TOTAL_MALLOC_LEN >> 10, gd->start_addr_sp);
489 #ifdef CONFIG_SYS_NONCACHED_MEMORY
490         reserve_noncached();
491 #endif
492
493         return 0;
494 }
495
496 /* (permanently) allocate a Board Info struct */
497 static int reserve_board(void)
498 {
499         if (!gd->bd) {
500                 gd->start_addr_sp = reserve_stack_aligned(sizeof(struct bd_info));
501                 gd->bd = (struct bd_info *)map_sysmem(gd->start_addr_sp,
502                                                       sizeof(struct bd_info));
503                 memset(gd->bd, '\0', sizeof(struct bd_info));
504                 debug("Reserving %zu Bytes for Board Info at: %08lx\n",
505                       sizeof(struct bd_info), gd->start_addr_sp);
506         }
507         return 0;
508 }
509
510 static int reserve_global_data(void)
511 {
512         gd->start_addr_sp = reserve_stack_aligned(sizeof(gd_t));
513         gd->new_gd = (gd_t *)map_sysmem(gd->start_addr_sp, sizeof(gd_t));
514         debug("Reserving %zu Bytes for Global Data at: %08lx\n",
515               sizeof(gd_t), gd->start_addr_sp);
516         return 0;
517 }
518
519 static int reserve_fdt(void)
520 {
521         if (!IS_ENABLED(CONFIG_OF_EMBED)) {
522                 /*
523                  * If the device tree is sitting immediately above our image
524                  * then we must relocate it. If it is embedded in the data
525                  * section, then it will be relocated with other data.
526                  */
527                 if (gd->fdt_blob) {
528                         gd->fdt_size = ALIGN(fdt_totalsize(gd->fdt_blob), 32);
529
530                         gd->start_addr_sp = reserve_stack_aligned(gd->fdt_size);
531                         gd->new_fdt = map_sysmem(gd->start_addr_sp, gd->fdt_size);
532                         debug("Reserving %lu Bytes for FDT at: %08lx\n",
533                               gd->fdt_size, gd->start_addr_sp);
534                 }
535         }
536
537         return 0;
538 }
539
540 static int reserve_bootstage(void)
541 {
542 #ifdef CONFIG_BOOTSTAGE
543         int size = bootstage_get_size();
544
545         gd->start_addr_sp = reserve_stack_aligned(size);
546         gd->new_bootstage = map_sysmem(gd->start_addr_sp, size);
547         debug("Reserving %#x Bytes for bootstage at: %08lx\n", size,
548               gd->start_addr_sp);
549 #endif
550
551         return 0;
552 }
553
554 __weak int arch_reserve_stacks(void)
555 {
556         return 0;
557 }
558
559 static int reserve_stacks(void)
560 {
561         /* make stack pointer 16-byte aligned */
562         gd->start_addr_sp = reserve_stack_aligned(16);
563
564         /*
565          * let the architecture-specific code tailor gd->start_addr_sp and
566          * gd->irq_sp
567          */
568         return arch_reserve_stacks();
569 }
570
571 static int reserve_bloblist(void)
572 {
573 #ifdef CONFIG_BLOBLIST
574         /* Align to a 4KB boundary for easier reading of addresses */
575         gd->start_addr_sp = ALIGN_DOWN(gd->start_addr_sp -
576                                        CONFIG_BLOBLIST_SIZE_RELOC, 0x1000);
577         gd->new_bloblist = map_sysmem(gd->start_addr_sp,
578                                       CONFIG_BLOBLIST_SIZE_RELOC);
579 #endif
580
581         return 0;
582 }
583
584 static int display_new_sp(void)
585 {
586         debug("New Stack Pointer is: %08lx\n", gd->start_addr_sp);
587
588         return 0;
589 }
590
591 __weak int arch_setup_bdinfo(void)
592 {
593         return 0;
594 }
595
596 int setup_bdinfo(void)
597 {
598         struct bd_info *bd = gd->bd;
599
600         if (IS_ENABLED(CONFIG_SYS_HAS_SRAM)) {
601                 bd->bi_sramstart = CONFIG_SYS_SRAM_BASE; /* start of SRAM */
602                 bd->bi_sramsize = CONFIG_SYS_SRAM_SIZE;  /* size  of SRAM */
603         }
604
605 #ifdef CONFIG_MACH_TYPE
606         bd->bi_arch_number = CONFIG_MACH_TYPE; /* board id for Linux */
607 #endif
608
609         return arch_setup_bdinfo();
610 }
611
612 #ifdef CONFIG_POST
613 static int init_post(void)
614 {
615         post_bootmode_init();
616         post_run(NULL, POST_ROM | post_bootmode_get(0));
617
618         return 0;
619 }
620 #endif
621
622 static int reloc_fdt(void)
623 {
624         if (!IS_ENABLED(CONFIG_OF_EMBED)) {
625                 if (gd->flags & GD_FLG_SKIP_RELOC)
626                         return 0;
627                 if (gd->new_fdt) {
628                         memcpy(gd->new_fdt, gd->fdt_blob,
629                                fdt_totalsize(gd->fdt_blob));
630                         gd->fdt_blob = gd->new_fdt;
631                 }
632         }
633
634         return 0;
635 }
636
637 static int reloc_bootstage(void)
638 {
639 #ifdef CONFIG_BOOTSTAGE
640         if (gd->flags & GD_FLG_SKIP_RELOC)
641                 return 0;
642         if (gd->new_bootstage) {
643                 int size = bootstage_get_size();
644
645                 debug("Copying bootstage from %p to %p, size %x\n",
646                       gd->bootstage, gd->new_bootstage, size);
647                 memcpy(gd->new_bootstage, gd->bootstage, size);
648                 gd->bootstage = gd->new_bootstage;
649                 bootstage_relocate();
650         }
651 #endif
652
653         return 0;
654 }
655
656 static int reloc_bloblist(void)
657 {
658 #ifdef CONFIG_BLOBLIST
659         /*
660          * Relocate only if we are supposed to send it
661          */
662         if ((gd->flags & GD_FLG_SKIP_RELOC) &&
663             CONFIG_BLOBLIST_SIZE == CONFIG_BLOBLIST_SIZE_RELOC) {
664                 debug("Not relocating bloblist\n");
665                 return 0;
666         }
667         if (gd->new_bloblist) {
668                 int size = CONFIG_BLOBLIST_SIZE;
669
670                 debug("Copying bloblist from %p to %p, size %x\n",
671                       gd->bloblist, gd->new_bloblist, size);
672                 bloblist_reloc(gd->new_bloblist, CONFIG_BLOBLIST_SIZE_RELOC,
673                                gd->bloblist, size);
674                 gd->bloblist = gd->new_bloblist;
675         }
676 #endif
677
678         return 0;
679 }
680
681 static int setup_reloc(void)
682 {
683         if (!(gd->flags & GD_FLG_SKIP_RELOC)) {
684 #ifdef CONFIG_SYS_TEXT_BASE
685 #ifdef ARM
686                 gd->reloc_off = gd->relocaddr - (unsigned long)__image_copy_start;
687 #elif defined(CONFIG_M68K)
688                 /*
689                  * On all ColdFire arch cpu, monitor code starts always
690                  * just after the default vector table location, so at 0x400
691                  */
692                 gd->reloc_off = gd->relocaddr - (CONFIG_SYS_TEXT_BASE + 0x400);
693 #elif !defined(CONFIG_SANDBOX)
694                 gd->reloc_off = gd->relocaddr - CONFIG_SYS_TEXT_BASE;
695 #endif
696 #endif
697         }
698
699         memcpy(gd->new_gd, (char *)gd, sizeof(gd_t));
700
701         if (gd->flags & GD_FLG_SKIP_RELOC) {
702                 debug("Skipping relocation due to flag\n");
703         } else {
704                 debug("Relocation Offset is: %08lx\n", gd->reloc_off);
705                 debug("Relocating to %08lx, new gd at %08lx, sp at %08lx\n",
706                       gd->relocaddr, (ulong)map_to_sysmem(gd->new_gd),
707                       gd->start_addr_sp);
708         }
709
710         return 0;
711 }
712
713 #ifdef CONFIG_OF_BOARD_FIXUP
714 static int fix_fdt(void)
715 {
716         return board_fix_fdt((void *)gd->fdt_blob);
717 }
718 #endif
719
720 /* ARM calls relocate_code from its crt0.S */
721 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
722                 !CONFIG_IS_ENABLED(X86_64)
723
724 static int jump_to_copy(void)
725 {
726         if (gd->flags & GD_FLG_SKIP_RELOC)
727                 return 0;
728         /*
729          * x86 is special, but in a nice way. It uses a trampoline which
730          * enables the dcache if possible.
731          *
732          * For now, other archs use relocate_code(), which is implemented
733          * similarly for all archs. When we do generic relocation, hopefully
734          * we can make all archs enable the dcache prior to relocation.
735          */
736 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
737         /*
738          * SDRAM and console are now initialised. The final stack can now
739          * be setup in SDRAM. Code execution will continue in Flash, but
740          * with the stack in SDRAM and Global Data in temporary memory
741          * (CPU cache)
742          */
743         arch_setup_gd(gd->new_gd);
744         board_init_f_r_trampoline(gd->start_addr_sp);
745 #else
746         relocate_code(gd->start_addr_sp, gd->new_gd, gd->relocaddr);
747 #endif
748
749         return 0;
750 }
751 #endif
752
753 /* Record the board_init_f() bootstage (after arch_cpu_init()) */
754 static int initf_bootstage(void)
755 {
756         bool from_spl = IS_ENABLED(CONFIG_SPL_BOOTSTAGE) &&
757                         IS_ENABLED(CONFIG_BOOTSTAGE_STASH);
758         int ret;
759
760         ret = bootstage_init(!from_spl);
761         if (ret)
762                 return ret;
763         if (from_spl) {
764                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
765                                                CONFIG_BOOTSTAGE_STASH_SIZE);
766
767                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
768                 if (ret && ret != -ENOENT) {
769                         debug("Failed to unstash bootstage: err=%d\n", ret);
770                         return ret;
771                 }
772         }
773
774         bootstage_mark_name(BOOTSTAGE_ID_START_UBOOT_F, "board_init_f");
775
776         return 0;
777 }
778
779 static int initf_dm(void)
780 {
781 #if defined(CONFIG_DM) && CONFIG_VAL(SYS_MALLOC_F_LEN)
782         int ret;
783
784         bootstage_start(BOOTSTAGE_ID_ACCUM_DM_F, "dm_f");
785         ret = dm_init_and_scan(true);
786         bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_F);
787         if (ret)
788                 return ret;
789
790         if (IS_ENABLED(CONFIG_TIMER_EARLY)) {
791                 ret = dm_timer_init();
792                 if (ret)
793                         return ret;
794         }
795 #endif
796
797         return 0;
798 }
799
800 /* Architecture-specific memory reservation */
801 __weak int reserve_arch(void)
802 {
803         return 0;
804 }
805
806 __weak int checkcpu(void)
807 {
808         return 0;
809 }
810
811 __weak int clear_bss(void)
812 {
813         return 0;
814 }
815
816 static int misc_init_f(void)
817 {
818         return event_notify_null(EVT_MISC_INIT_F);
819 }
820
821 static const init_fnc_t init_sequence_f[] = {
822         setup_mon_len,
823 #ifdef CONFIG_OF_CONTROL
824         fdtdec_setup,
825 #endif
826 #ifdef CONFIG_TRACE_EARLY
827         trace_early_init,
828 #endif
829         initf_malloc,
830         log_init,
831         initf_bootstage,        /* uses its own timer, so does not need DM */
832         event_init,
833 #ifdef CONFIG_BLOBLIST
834         bloblist_init,
835 #endif
836         setup_spl_handoff,
837 #if defined(CONFIG_CONSOLE_RECORD_INIT_F)
838         console_record_init,
839 #endif
840 #if defined(CONFIG_HAVE_FSP)
841         arch_fsp_init,
842 #endif
843         arch_cpu_init,          /* basic arch cpu dependent setup */
844         mach_cpu_init,          /* SoC/machine dependent CPU setup */
845         initf_dm,
846 #if defined(CONFIG_BOARD_EARLY_INIT_F)
847         board_early_init_f,
848 #endif
849 #if defined(CONFIG_PPC) || defined(CONFIG_SYS_FSL_CLK) || defined(CONFIG_M68K)
850         /* get CPU and bus clocks according to the environment variable */
851         get_clocks,             /* get CPU and bus clocks (etc.) */
852 #endif
853 #if !defined(CONFIG_M68K)
854         timer_init,             /* initialize timer */
855 #endif
856 #if defined(CONFIG_BOARD_POSTCLK_INIT)
857         board_postclk_init,
858 #endif
859         env_init,               /* initialize environment */
860         init_baud_rate,         /* initialze baudrate settings */
861         serial_init,            /* serial communications setup */
862         console_init_f,         /* stage 1 init of console */
863         display_options,        /* say that we are here */
864         display_text_info,      /* show debugging info if required */
865         checkcpu,
866 #if defined(CONFIG_SYSRESET)
867         print_resetinfo,
868 #endif
869 #if defined(CONFIG_DISPLAY_CPUINFO)
870         print_cpuinfo,          /* display cpu info (and speed) */
871 #endif
872 #if defined(CONFIG_DTB_RESELECT)
873         embedded_dtb_select,
874 #endif
875 #if defined(CONFIG_DISPLAY_BOARDINFO)
876         show_board_info,
877 #endif
878         INIT_FUNC_WATCHDOG_INIT
879         misc_init_f,
880         INIT_FUNC_WATCHDOG_RESET
881 #if CONFIG_IS_ENABLED(SYS_I2C_LEGACY)
882         init_func_i2c,
883 #endif
884 #if defined(CONFIG_VID) && !defined(CONFIG_SPL)
885         init_func_vid,
886 #endif
887         announce_dram_init,
888         dram_init,              /* configure available RAM banks */
889 #ifdef CONFIG_POST
890         post_init_f,
891 #endif
892         INIT_FUNC_WATCHDOG_RESET
893 #if defined(CONFIG_SYS_DRAM_TEST)
894         testdram,
895 #endif /* CONFIG_SYS_DRAM_TEST */
896         INIT_FUNC_WATCHDOG_RESET
897
898 #ifdef CONFIG_POST
899         init_post,
900 #endif
901         INIT_FUNC_WATCHDOG_RESET
902         /*
903          * Now that we have DRAM mapped and working, we can
904          * relocate the code and continue running from DRAM.
905          *
906          * Reserve memory at end of RAM for (top down in that order):
907          *  - area that won't get touched by U-Boot and Linux (optional)
908          *  - kernel log buffer
909          *  - protected RAM
910          *  - LCD framebuffer
911          *  - monitor code
912          *  - board info struct
913          */
914         setup_dest_addr,
915 #ifdef CONFIG_OF_BOARD_FIXUP
916         fix_fdt,
917 #endif
918 #ifdef CONFIG_PRAM
919         reserve_pram,
920 #endif
921         reserve_round_4k,
922         arch_reserve_mmu,
923         reserve_video,
924         reserve_trace,
925         reserve_uboot,
926         reserve_malloc,
927         reserve_board,
928         reserve_global_data,
929         reserve_fdt,
930         reserve_bootstage,
931         reserve_bloblist,
932         reserve_arch,
933         reserve_stacks,
934         dram_init_banksize,
935         show_dram_config,
936         INIT_FUNC_WATCHDOG_RESET
937         setup_bdinfo,
938         display_new_sp,
939         INIT_FUNC_WATCHDOG_RESET
940         reloc_fdt,
941         reloc_bootstage,
942         reloc_bloblist,
943         setup_reloc,
944 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
945         copy_uboot_to_ram,
946         do_elf_reloc_fixups,
947 #endif
948         clear_bss,
949 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
950                 !CONFIG_IS_ENABLED(X86_64)
951         jump_to_copy,
952 #endif
953         NULL,
954 };
955
956 void board_init_f(ulong boot_flags)
957 {
958         gd->flags = boot_flags;
959         gd->have_console = 0;
960
961         if (initcall_run_list(init_sequence_f))
962                 hang();
963
964 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
965                 !defined(CONFIG_EFI_APP) && !CONFIG_IS_ENABLED(X86_64) && \
966                 !defined(CONFIG_ARC)
967         /* NOTREACHED - jump_to_copy() does not return */
968         hang();
969 #endif
970 }
971
972 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
973 /*
974  * For now this code is only used on x86.
975  *
976  * init_sequence_f_r is the list of init functions which are run when
977  * U-Boot is executing from Flash with a semi-limited 'C' environment.
978  * The following limitations must be considered when implementing an
979  * '_f_r' function:
980  *  - 'static' variables are read-only
981  *  - Global Data (gd->xxx) is read/write
982  *
983  * The '_f_r' sequence must, as a minimum, copy U-Boot to RAM (if
984  * supported).  It _should_, if possible, copy global data to RAM and
985  * initialise the CPU caches (to speed up the relocation process)
986  *
987  * NOTE: At present only x86 uses this route, but it is intended that
988  * all archs will move to this when generic relocation is implemented.
989  */
990 static const init_fnc_t init_sequence_f_r[] = {
991 #if !CONFIG_IS_ENABLED(X86_64)
992         init_cache_f_r,
993 #endif
994
995         NULL,
996 };
997
998 void board_init_f_r(void)
999 {
1000         if (initcall_run_list(init_sequence_f_r))
1001                 hang();
1002
1003         /*
1004          * The pre-relocation drivers may be using memory that has now gone
1005          * away. Mark serial as unavailable - this will fall back to the debug
1006          * UART if available.
1007          *
1008          * Do the same with log drivers since the memory may not be available.
1009          */
1010         gd->flags &= ~(GD_FLG_SERIAL_READY | GD_FLG_LOG_READY);
1011 #ifdef CONFIG_TIMER
1012         gd->timer = NULL;
1013 #endif
1014
1015         /*
1016          * U-Boot has been copied into SDRAM, the BSS has been cleared etc.
1017          * Transfer execution from Flash to RAM by calculating the address
1018          * of the in-RAM copy of board_init_r() and calling it
1019          */
1020         (board_init_r + gd->reloc_off)((gd_t *)gd, gd->relocaddr);
1021
1022         /* NOTREACHED - board_init_r() does not return */
1023         hang();
1024 }
1025 #endif /* CONFIG_X86 */