CONFIG_NR_DRAM_BANKS: Remove unreferenced code as its always defined
[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 <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 #if defined(CONFIG_SYS_SDRAM_BASE)
241         gd->bd->bi_dram[0].start = CONFIG_SYS_SDRAM_BASE;
242         gd->bd->bi_dram[0].size = get_effective_memsize();
243 #endif
244
245         return 0;
246 }
247
248 #if defined(CONFIG_SYS_I2C)
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) || defined(CONFIG_EFI_APP)
270         gd->mon_len = (ulong)&_end - (ulong)_init;
271 #elif defined(CONFIG_NIOS2) || defined(CONFIG_XTENSA)
272         gd->mon_len = CONFIG_SYS_MONITOR_LEN;
273 #elif defined(CONFIG_NDS32) || defined(CONFIG_SH) || defined(CONFIG_RISCV)
274         gd->mon_len = (ulong)(&__bss_end) - (ulong)(&_start);
275 #elif defined(CONFIG_SYS_MONITOR_BASE)
276         /* TODO: use (ulong)&__bss_end - (ulong)&__text_start; ? */
277         gd->mon_len = (ulong)&__bss_end - CONFIG_SYS_MONITOR_BASE;
278 #endif
279         return 0;
280 }
281
282 static int setup_spl_handoff(void)
283 {
284 #if CONFIG_IS_ENABLED(HANDOFF)
285         gd->spl_handoff = bloblist_find(BLOBLISTT_SPL_HANDOFF,
286                                         sizeof(struct spl_handoff));
287         debug("Found SPL hand-off info %p\n", gd->spl_handoff);
288 #endif
289
290         return 0;
291 }
292
293 __weak int arch_cpu_init(void)
294 {
295         return 0;
296 }
297
298 __weak int mach_cpu_init(void)
299 {
300         return 0;
301 }
302
303 /* Get the top of usable RAM */
304 __weak ulong board_get_usable_ram_top(ulong total_size)
305 {
306 #if defined(CONFIG_SYS_SDRAM_BASE) && CONFIG_SYS_SDRAM_BASE > 0
307         /*
308          * Detect whether we have so much RAM that it goes past the end of our
309          * 32-bit address space. If so, clip the usable RAM so it doesn't.
310          */
311         if (gd->ram_top < CONFIG_SYS_SDRAM_BASE)
312                 /*
313                  * Will wrap back to top of 32-bit space when reservations
314                  * are made.
315                  */
316                 return 0;
317 #endif
318         return gd->ram_top;
319 }
320
321 static int setup_dest_addr(void)
322 {
323         debug("Monitor len: %08lX\n", gd->mon_len);
324         /*
325          * Ram is setup, size stored in gd !!
326          */
327         debug("Ram size: %08lX\n", (ulong)gd->ram_size);
328 #if defined(CONFIG_SYS_MEM_TOP_HIDE)
329         /*
330          * Subtract specified amount of memory to hide so that it won't
331          * get "touched" at all by U-Boot. By fixing up gd->ram_size
332          * the Linux kernel should now get passed the now "corrected"
333          * memory size and won't touch it either. This should work
334          * for arch/ppc and arch/powerpc. Only Linux board ports in
335          * arch/powerpc with bootwrapper support, that recalculate the
336          * memory size from the SDRAM controller setup will have to
337          * get fixed.
338          */
339         gd->ram_size -= CONFIG_SYS_MEM_TOP_HIDE;
340 #endif
341 #ifdef CONFIG_SYS_SDRAM_BASE
342         gd->ram_base = CONFIG_SYS_SDRAM_BASE;
343 #endif
344         gd->ram_top = gd->ram_base + get_effective_memsize();
345         gd->ram_top = board_get_usable_ram_top(gd->mon_len);
346         gd->relocaddr = gd->ram_top;
347         debug("Ram top: %08lX\n", (ulong)gd->ram_top);
348 #if defined(CONFIG_MP) && (defined(CONFIG_MPC86xx) || defined(CONFIG_E500))
349         /*
350          * We need to make sure the location we intend to put secondary core
351          * boot code is reserved and not used by any part of u-boot
352          */
353         if (gd->relocaddr > determine_mp_bootpg(NULL)) {
354                 gd->relocaddr = determine_mp_bootpg(NULL);
355                 debug("Reserving MP boot page to %08lx\n", gd->relocaddr);
356         }
357 #endif
358         return 0;
359 }
360
361 #ifdef CONFIG_PRAM
362 /* reserve protected RAM */
363 static int reserve_pram(void)
364 {
365         ulong reg;
366
367         reg = env_get_ulong("pram", 10, CONFIG_PRAM);
368         gd->relocaddr -= (reg << 10);           /* size is in kB */
369         debug("Reserving %ldk for protected RAM at %08lx\n", reg,
370               gd->relocaddr);
371         return 0;
372 }
373 #endif /* CONFIG_PRAM */
374
375 /* Round memory pointer down to next 4 kB limit */
376 static int reserve_round_4k(void)
377 {
378         gd->relocaddr &= ~(4096 - 1);
379         return 0;
380 }
381
382 __weak int arch_reserve_mmu(void)
383 {
384         return 0;
385 }
386
387 static int reserve_video(void)
388 {
389 #ifdef CONFIG_DM_VIDEO
390         ulong addr;
391         int ret;
392
393         addr = gd->relocaddr;
394         ret = video_reserve(&addr);
395         if (ret)
396                 return ret;
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 setup_machine(void)
507 {
508 #ifdef CONFIG_MACH_TYPE
509         gd->bd->bi_arch_number = CONFIG_MACH_TYPE; /* board id for Linux */
510 #endif
511         return 0;
512 }
513
514 static int reserve_global_data(void)
515 {
516         gd->start_addr_sp = reserve_stack_aligned(sizeof(gd_t));
517         gd->new_gd = (gd_t *)map_sysmem(gd->start_addr_sp, sizeof(gd_t));
518         debug("Reserving %zu Bytes for Global Data at: %08lx\n",
519               sizeof(gd_t), gd->start_addr_sp);
520         return 0;
521 }
522
523 static int reserve_fdt(void)
524 {
525 #ifndef CONFIG_OF_EMBED
526         /*
527          * If the device tree is sitting immediately above our image then we
528          * must relocate it. If it is embedded in the data section, then it
529          * will be relocated with other data.
530          */
531         if (gd->fdt_blob) {
532                 gd->fdt_size = ALIGN(fdt_totalsize(gd->fdt_blob), 32);
533
534                 gd->start_addr_sp = reserve_stack_aligned(gd->fdt_size);
535                 gd->new_fdt = map_sysmem(gd->start_addr_sp, gd->fdt_size);
536                 debug("Reserving %lu Bytes for FDT at: %08lx\n",
537                       gd->fdt_size, gd->start_addr_sp);
538         }
539 #endif
540
541         return 0;
542 }
543
544 static int reserve_bootstage(void)
545 {
546 #ifdef CONFIG_BOOTSTAGE
547         int size = bootstage_get_size();
548
549         gd->start_addr_sp = reserve_stack_aligned(size);
550         gd->new_bootstage = map_sysmem(gd->start_addr_sp, size);
551         debug("Reserving %#x Bytes for bootstage at: %08lx\n", size,
552               gd->start_addr_sp);
553 #endif
554
555         return 0;
556 }
557
558 __weak int arch_reserve_stacks(void)
559 {
560         return 0;
561 }
562
563 static int reserve_stacks(void)
564 {
565         /* make stack pointer 16-byte aligned */
566         gd->start_addr_sp = reserve_stack_aligned(16);
567
568         /*
569          * let the architecture-specific code tailor gd->start_addr_sp and
570          * gd->irq_sp
571          */
572         return arch_reserve_stacks();
573 }
574
575 static int reserve_bloblist(void)
576 {
577 #ifdef CONFIG_BLOBLIST
578         gd->start_addr_sp = reserve_stack_aligned(CONFIG_BLOBLIST_SIZE);
579         gd->new_bloblist = map_sysmem(gd->start_addr_sp, CONFIG_BLOBLIST_SIZE);
580 #endif
581
582         return 0;
583 }
584
585 static int display_new_sp(void)
586 {
587         debug("New Stack Pointer is: %08lx\n", gd->start_addr_sp);
588
589         return 0;
590 }
591
592 __weak int arch_setup_bdinfo(void)
593 {
594         return 0;
595 }
596
597 int setup_bdinfo(void)
598 {
599         struct bd_info *bd = gd->bd;
600
601         bd->bi_memstart = gd->ram_base;  /* start of memory */
602         bd->bi_memsize = gd->ram_size;   /* size in bytes */
603
604         if (IS_ENABLED(CONFIG_SYS_HAS_SRAM)) {
605                 bd->bi_sramstart = CONFIG_SYS_SRAM_BASE; /* start of SRAM */
606                 bd->bi_sramsize = CONFIG_SYS_SRAM_SIZE;  /* size  of SRAM */
607         }
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 #ifndef 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, fdt_totalsize(gd->fdt_blob));
629                 gd->fdt_blob = gd->new_fdt;
630         }
631 #endif
632
633         return 0;
634 }
635
636 static int reloc_bootstage(void)
637 {
638 #ifdef CONFIG_BOOTSTAGE
639         if (gd->flags & GD_FLG_SKIP_RELOC)
640                 return 0;
641         if (gd->new_bootstage) {
642                 int size = bootstage_get_size();
643
644                 debug("Copying bootstage from %p to %p, size %x\n",
645                       gd->bootstage, gd->new_bootstage, size);
646                 memcpy(gd->new_bootstage, gd->bootstage, size);
647                 gd->bootstage = gd->new_bootstage;
648                 bootstage_relocate();
649         }
650 #endif
651
652         return 0;
653 }
654
655 static int reloc_bloblist(void)
656 {
657 #ifdef CONFIG_BLOBLIST
658         if (gd->flags & GD_FLG_SKIP_RELOC)
659                 return 0;
660         if (gd->new_bloblist) {
661                 int size = CONFIG_BLOBLIST_SIZE;
662
663                 debug("Copying bloblist from %p to %p, size %x\n",
664                       gd->bloblist, gd->new_bloblist, size);
665                 memcpy(gd->new_bloblist, gd->bloblist, size);
666                 gd->bloblist = gd->new_bloblist;
667         }
668 #endif
669
670         return 0;
671 }
672
673 static int setup_reloc(void)
674 {
675         if (gd->flags & GD_FLG_SKIP_RELOC) {
676                 debug("Skipping relocation due to flag\n");
677                 return 0;
678         }
679
680 #ifdef CONFIG_SYS_TEXT_BASE
681 #ifdef ARM
682         gd->reloc_off = gd->relocaddr - (unsigned long)__image_copy_start;
683 #elif defined(CONFIG_M68K)
684         /*
685          * On all ColdFire arch cpu, monitor code starts always
686          * just after the default vector table location, so at 0x400
687          */
688         gd->reloc_off = gd->relocaddr - (CONFIG_SYS_TEXT_BASE + 0x400);
689 #elif !defined(CONFIG_SANDBOX)
690         gd->reloc_off = gd->relocaddr - CONFIG_SYS_TEXT_BASE;
691 #endif
692 #endif
693         memcpy(gd->new_gd, (char *)gd, sizeof(gd_t));
694
695         debug("Relocation Offset is: %08lx\n", gd->reloc_off);
696         debug("Relocating to %08lx, new gd at %08lx, sp at %08lx\n",
697               gd->relocaddr, (ulong)map_to_sysmem(gd->new_gd),
698               gd->start_addr_sp);
699
700         return 0;
701 }
702
703 #ifdef CONFIG_OF_BOARD_FIXUP
704 static int fix_fdt(void)
705 {
706         return board_fix_fdt((void *)gd->fdt_blob);
707 }
708 #endif
709
710 /* ARM calls relocate_code from its crt0.S */
711 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
712                 !CONFIG_IS_ENABLED(X86_64)
713
714 static int jump_to_copy(void)
715 {
716         if (gd->flags & GD_FLG_SKIP_RELOC)
717                 return 0;
718         /*
719          * x86 is special, but in a nice way. It uses a trampoline which
720          * enables the dcache if possible.
721          *
722          * For now, other archs use relocate_code(), which is implemented
723          * similarly for all archs. When we do generic relocation, hopefully
724          * we can make all archs enable the dcache prior to relocation.
725          */
726 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
727         /*
728          * SDRAM and console are now initialised. The final stack can now
729          * be setup in SDRAM. Code execution will continue in Flash, but
730          * with the stack in SDRAM and Global Data in temporary memory
731          * (CPU cache)
732          */
733         arch_setup_gd(gd->new_gd);
734         board_init_f_r_trampoline(gd->start_addr_sp);
735 #else
736         relocate_code(gd->start_addr_sp, gd->new_gd, gd->relocaddr);
737 #endif
738
739         return 0;
740 }
741 #endif
742
743 /* Record the board_init_f() bootstage (after arch_cpu_init()) */
744 static int initf_bootstage(void)
745 {
746         bool from_spl = IS_ENABLED(CONFIG_SPL_BOOTSTAGE) &&
747                         IS_ENABLED(CONFIG_BOOTSTAGE_STASH);
748         int ret;
749
750         ret = bootstage_init(!from_spl);
751         if (ret)
752                 return ret;
753         if (from_spl) {
754                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
755                                                CONFIG_BOOTSTAGE_STASH_SIZE);
756
757                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
758                 if (ret && ret != -ENOENT) {
759                         debug("Failed to unstash bootstage: err=%d\n", ret);
760                         return ret;
761                 }
762         }
763
764         bootstage_mark_name(BOOTSTAGE_ID_START_UBOOT_F, "board_init_f");
765
766         return 0;
767 }
768
769 static int initf_console_record(void)
770 {
771 #if defined(CONFIG_CONSOLE_RECORD) && CONFIG_VAL(SYS_MALLOC_F_LEN)
772         return console_record_init();
773 #else
774         return 0;
775 #endif
776 }
777
778 static int initf_dm(void)
779 {
780 #if defined(CONFIG_DM) && CONFIG_VAL(SYS_MALLOC_F_LEN)
781         int ret;
782
783         bootstage_start(BOOTSTAGE_ID_ACCUM_DM_F, "dm_f");
784         ret = dm_init_and_scan(true);
785         bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_F);
786         if (ret)
787                 return ret;
788 #endif
789 #ifdef CONFIG_TIMER_EARLY
790         ret = dm_timer_init();
791         if (ret)
792                 return ret;
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 arch_cpu_init_dm(void)
805 {
806         return 0;
807 }
808
809 __weak int checkcpu(void)
810 {
811         return 0;
812 }
813
814 __weak int clear_bss(void)
815 {
816         return 0;
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 #ifdef CONFIG_BLOBLIST
831         bloblist_init,
832 #endif
833         setup_spl_handoff,
834         initf_console_record,
835 #if defined(CONFIG_HAVE_FSP)
836         arch_fsp_init,
837 #endif
838         arch_cpu_init,          /* basic arch cpu dependent setup */
839         mach_cpu_init,          /* SoC/machine dependent CPU setup */
840         initf_dm,
841         arch_cpu_init_dm,
842 #if defined(CONFIG_BOARD_EARLY_INIT_F)
843         board_early_init_f,
844 #endif
845 #if defined(CONFIG_PPC) || defined(CONFIG_SYS_FSL_CLK) || defined(CONFIG_M68K)
846         /* get CPU and bus clocks according to the environment variable */
847         get_clocks,             /* get CPU and bus clocks (etc.) */
848 #endif
849 #if !defined(CONFIG_M68K)
850         timer_init,             /* initialize timer */
851 #endif
852 #if defined(CONFIG_BOARD_POSTCLK_INIT)
853         board_postclk_init,
854 #endif
855         env_init,               /* initialize environment */
856         init_baud_rate,         /* initialze baudrate settings */
857         serial_init,            /* serial communications setup */
858         console_init_f,         /* stage 1 init of console */
859         display_options,        /* say that we are here */
860         display_text_info,      /* show debugging info if required */
861         checkcpu,
862 #if defined(CONFIG_SYSRESET)
863         print_resetinfo,
864 #endif
865 #if defined(CONFIG_DISPLAY_CPUINFO)
866         print_cpuinfo,          /* display cpu info (and speed) */
867 #endif
868 #if defined(CONFIG_DTB_RESELECT)
869         embedded_dtb_select,
870 #endif
871 #if defined(CONFIG_DISPLAY_BOARDINFO)
872         show_board_info,
873 #endif
874         INIT_FUNC_WATCHDOG_INIT
875 #if defined(CONFIG_MISC_INIT_F)
876         misc_init_f,
877 #endif
878         INIT_FUNC_WATCHDOG_RESET
879 #if defined(CONFIG_SYS_I2C)
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         setup_machine,
927         reserve_global_data,
928         reserve_fdt,
929         reserve_bootstage,
930         reserve_bloblist,
931         reserve_arch,
932         reserve_stacks,
933         dram_init_banksize,
934         show_dram_config,
935         INIT_FUNC_WATCHDOG_RESET
936         setup_bdinfo,
937         display_new_sp,
938         INIT_FUNC_WATCHDOG_RESET
939         reloc_fdt,
940         reloc_bootstage,
941         reloc_bloblist,
942         setup_reloc,
943 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
944         copy_uboot_to_ram,
945         do_elf_reloc_fixups,
946 #endif
947         clear_bss,
948 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
949                 !CONFIG_IS_ENABLED(X86_64)
950         jump_to_copy,
951 #endif
952         NULL,
953 };
954
955 void board_init_f(ulong boot_flags)
956 {
957         gd->flags = boot_flags;
958         gd->have_console = 0;
959
960         if (initcall_run_list(init_sequence_f))
961                 hang();
962
963 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
964                 !defined(CONFIG_EFI_APP) && !CONFIG_IS_ENABLED(X86_64) && \
965                 !defined(CONFIG_ARC)
966         /* NOTREACHED - jump_to_copy() does not return */
967         hang();
968 #endif
969 }
970
971 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
972 /*
973  * For now this code is only used on x86.
974  *
975  * init_sequence_f_r is the list of init functions which are run when
976  * U-Boot is executing from Flash with a semi-limited 'C' environment.
977  * The following limitations must be considered when implementing an
978  * '_f_r' function:
979  *  - 'static' variables are read-only
980  *  - Global Data (gd->xxx) is read/write
981  *
982  * The '_f_r' sequence must, as a minimum, copy U-Boot to RAM (if
983  * supported).  It _should_, if possible, copy global data to RAM and
984  * initialise the CPU caches (to speed up the relocation process)
985  *
986  * NOTE: At present only x86 uses this route, but it is intended that
987  * all archs will move to this when generic relocation is implemented.
988  */
989 static const init_fnc_t init_sequence_f_r[] = {
990 #if !CONFIG_IS_ENABLED(X86_64)
991         init_cache_f_r,
992 #endif
993
994         NULL,
995 };
996
997 void board_init_f_r(void)
998 {
999         if (initcall_run_list(init_sequence_f_r))
1000                 hang();
1001
1002         /*
1003          * The pre-relocation drivers may be using memory that has now gone
1004          * away. Mark serial as unavailable - this will fall back to the debug
1005          * UART if available.
1006          *
1007          * Do the same with log drivers since the memory may not be available.
1008          */
1009         gd->flags &= ~(GD_FLG_SERIAL_READY | GD_FLG_LOG_READY);
1010 #ifdef CONFIG_TIMER
1011         gd->timer = NULL;
1012 #endif
1013
1014         /*
1015          * U-Boot has been copied into SDRAM, the BSS has been cleared etc.
1016          * Transfer execution from Flash to RAM by calculating the address
1017          * of the in-RAM copy of board_init_r() and calling it
1018          */
1019         (board_init_r + gd->reloc_off)((gd_t *)gd, gd->relocaddr);
1020
1021         /* NOTREACHED - board_init_r() does not return */
1022         hang();
1023 }
1024 #endif /* CONFIG_X86 */