bloblist: Place on a 4KB boundary
[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         gd->bd->bi_dram[0].start = gd->ram_base;
241         gd->bd->bi_dram[0].size = get_effective_memsize();
242
243         return 0;
244 }
245
246 #if defined(CONFIG_SYS_I2C)
247 static int init_func_i2c(void)
248 {
249         puts("I2C:   ");
250         i2c_init_all();
251         puts("ready\n");
252         return 0;
253 }
254 #endif
255
256 #if defined(CONFIG_VID)
257 __weak int init_func_vid(void)
258 {
259         return 0;
260 }
261 #endif
262
263 static int setup_mon_len(void)
264 {
265 #if defined(__ARM__) || defined(__MICROBLAZE__)
266         gd->mon_len = (ulong)&__bss_end - (ulong)_start;
267 #elif defined(CONFIG_SANDBOX) || defined(CONFIG_EFI_APP)
268         gd->mon_len = (ulong)&_end - (ulong)_init;
269 #elif defined(CONFIG_NIOS2) || defined(CONFIG_XTENSA)
270         gd->mon_len = CONFIG_SYS_MONITOR_LEN;
271 #elif defined(CONFIG_NDS32) || defined(CONFIG_SH) || defined(CONFIG_RISCV)
272         gd->mon_len = (ulong)(&__bss_end) - (ulong)(&_start);
273 #elif defined(CONFIG_SYS_MONITOR_BASE)
274         /* TODO: use (ulong)&__bss_end - (ulong)&__text_start; ? */
275         gd->mon_len = (ulong)&__bss_end - CONFIG_SYS_MONITOR_BASE;
276 #endif
277         return 0;
278 }
279
280 static int setup_spl_handoff(void)
281 {
282 #if CONFIG_IS_ENABLED(HANDOFF)
283         gd->spl_handoff = bloblist_find(BLOBLISTT_SPL_HANDOFF,
284                                         sizeof(struct spl_handoff));
285         debug("Found SPL hand-off info %p\n", gd->spl_handoff);
286 #endif
287
288         return 0;
289 }
290
291 __weak int arch_cpu_init(void)
292 {
293         return 0;
294 }
295
296 __weak int mach_cpu_init(void)
297 {
298         return 0;
299 }
300
301 /* Get the top of usable RAM */
302 __weak ulong board_get_usable_ram_top(ulong total_size)
303 {
304 #if defined(CONFIG_SYS_SDRAM_BASE) && CONFIG_SYS_SDRAM_BASE > 0
305         /*
306          * Detect whether we have so much RAM that it goes past the end of our
307          * 32-bit address space. If so, clip the usable RAM so it doesn't.
308          */
309         if (gd->ram_top < CONFIG_SYS_SDRAM_BASE)
310                 /*
311                  * Will wrap back to top of 32-bit space when reservations
312                  * are made.
313                  */
314                 return 0;
315 #endif
316         return gd->ram_top;
317 }
318
319 static int setup_dest_addr(void)
320 {
321         debug("Monitor len: %08lX\n", gd->mon_len);
322         /*
323          * Ram is setup, size stored in gd !!
324          */
325         debug("Ram size: %08lX\n", (ulong)gd->ram_size);
326 #if defined(CONFIG_SYS_MEM_TOP_HIDE)
327         /*
328          * Subtract specified amount of memory to hide so that it won't
329          * get "touched" at all by U-Boot. By fixing up gd->ram_size
330          * the Linux kernel should now get passed the now "corrected"
331          * memory size and won't touch it either. This should work
332          * for arch/ppc and arch/powerpc. Only Linux board ports in
333          * arch/powerpc with bootwrapper support, that recalculate the
334          * memory size from the SDRAM controller setup will have to
335          * get fixed.
336          */
337         gd->ram_size -= CONFIG_SYS_MEM_TOP_HIDE;
338 #endif
339 #ifdef CONFIG_SYS_SDRAM_BASE
340         gd->ram_base = CONFIG_SYS_SDRAM_BASE;
341 #endif
342         gd->ram_top = gd->ram_base + get_effective_memsize();
343         gd->ram_top = board_get_usable_ram_top(gd->mon_len);
344         gd->relocaddr = gd->ram_top;
345         debug("Ram top: %08lX\n", (ulong)gd->ram_top);
346 #if defined(CONFIG_MP) && (defined(CONFIG_MPC86xx) || defined(CONFIG_E500))
347         /*
348          * We need to make sure the location we intend to put secondary core
349          * boot code is reserved and not used by any part of u-boot
350          */
351         if (gd->relocaddr > determine_mp_bootpg(NULL)) {
352                 gd->relocaddr = determine_mp_bootpg(NULL);
353                 debug("Reserving MP boot page to %08lx\n", gd->relocaddr);
354         }
355 #endif
356         return 0;
357 }
358
359 #ifdef CONFIG_PRAM
360 /* reserve protected RAM */
361 static int reserve_pram(void)
362 {
363         ulong reg;
364
365         reg = env_get_ulong("pram", 10, CONFIG_PRAM);
366         gd->relocaddr -= (reg << 10);           /* size is in kB */
367         debug("Reserving %ldk for protected RAM at %08lx\n", reg,
368               gd->relocaddr);
369         return 0;
370 }
371 #endif /* CONFIG_PRAM */
372
373 /* Round memory pointer down to next 4 kB limit */
374 static int reserve_round_4k(void)
375 {
376         gd->relocaddr &= ~(4096 - 1);
377         return 0;
378 }
379
380 __weak int arch_reserve_mmu(void)
381 {
382         return 0;
383 }
384
385 static int reserve_video(void)
386 {
387 #ifdef CONFIG_DM_VIDEO
388         ulong addr;
389         int ret;
390
391         addr = gd->relocaddr;
392         ret = video_reserve(&addr);
393         if (ret)
394                 return ret;
395         gd->relocaddr = addr;
396 #elif defined(CONFIG_LCD)
397 #  ifdef CONFIG_FB_ADDR
398         gd->fb_base = CONFIG_FB_ADDR;
399 #  else
400         /* reserve memory for LCD display (always full pages) */
401         gd->relocaddr = lcd_setmem(gd->relocaddr);
402         gd->fb_base = gd->relocaddr;
403 #  endif /* CONFIG_FB_ADDR */
404 #endif
405
406         return 0;
407 }
408
409 static int reserve_trace(void)
410 {
411 #ifdef CONFIG_TRACE
412         gd->relocaddr -= CONFIG_TRACE_BUFFER_SIZE;
413         gd->trace_buff = map_sysmem(gd->relocaddr, CONFIG_TRACE_BUFFER_SIZE);
414         debug("Reserving %luk for trace data at: %08lx\n",
415               (unsigned long)CONFIG_TRACE_BUFFER_SIZE >> 10, gd->relocaddr);
416 #endif
417
418         return 0;
419 }
420
421 static int reserve_uboot(void)
422 {
423         if (!(gd->flags & GD_FLG_SKIP_RELOC)) {
424                 /*
425                  * reserve memory for U-Boot code, data & bss
426                  * round down to next 4 kB limit
427                  */
428                 gd->relocaddr -= gd->mon_len;
429                 gd->relocaddr &= ~(4096 - 1);
430         #if defined(CONFIG_E500) || defined(CONFIG_MIPS)
431                 /* round down to next 64 kB limit so that IVPR stays aligned */
432                 gd->relocaddr &= ~(65536 - 1);
433         #endif
434
435                 debug("Reserving %ldk for U-Boot at: %08lx\n",
436                       gd->mon_len >> 10, gd->relocaddr);
437         }
438
439         gd->start_addr_sp = gd->relocaddr;
440
441         return 0;
442 }
443
444 /*
445  * reserve after start_addr_sp the requested size and make the stack pointer
446  * 16-byte aligned, this alignment is needed for cast on the reserved memory
447  * ref = x86_64 ABI: https://reviews.llvm.org/D30049: 16 bytes
448  *     = ARMv8 Instruction Set Overview: quad word, 16 bytes
449  */
450 static unsigned long reserve_stack_aligned(size_t size)
451 {
452         return ALIGN_DOWN(gd->start_addr_sp - size, 16);
453 }
454
455 #ifdef CONFIG_SYS_NONCACHED_MEMORY
456 static int reserve_noncached(void)
457 {
458         /*
459          * The value of gd->start_addr_sp must match the value of malloc_start
460          * calculated in boatrd_f.c:initr_malloc(), which is passed to
461          * board_r.c:mem_malloc_init() and then used by
462          * cache.c:noncached_init()
463          *
464          * These calculations must match the code in cache.c:noncached_init()
465          */
466         gd->start_addr_sp = ALIGN(gd->start_addr_sp, MMU_SECTION_SIZE) -
467                 MMU_SECTION_SIZE;
468         gd->start_addr_sp -= ALIGN(CONFIG_SYS_NONCACHED_MEMORY,
469                                    MMU_SECTION_SIZE);
470         debug("Reserving %dM for noncached_alloc() at: %08lx\n",
471               CONFIG_SYS_NONCACHED_MEMORY >> 20, gd->start_addr_sp);
472
473         return 0;
474 }
475 #endif
476
477 /* reserve memory for malloc() area */
478 static int reserve_malloc(void)
479 {
480         gd->start_addr_sp = reserve_stack_aligned(TOTAL_MALLOC_LEN);
481         debug("Reserving %dk for malloc() at: %08lx\n",
482               TOTAL_MALLOC_LEN >> 10, gd->start_addr_sp);
483 #ifdef CONFIG_SYS_NONCACHED_MEMORY
484         reserve_noncached();
485 #endif
486
487         return 0;
488 }
489
490 /* (permanently) allocate a Board Info struct */
491 static int reserve_board(void)
492 {
493         if (!gd->bd) {
494                 gd->start_addr_sp = reserve_stack_aligned(sizeof(struct bd_info));
495                 gd->bd = (struct bd_info *)map_sysmem(gd->start_addr_sp,
496                                                       sizeof(struct bd_info));
497                 memset(gd->bd, '\0', sizeof(struct bd_info));
498                 debug("Reserving %zu Bytes for Board Info at: %08lx\n",
499                       sizeof(struct bd_info), gd->start_addr_sp);
500         }
501         return 0;
502 }
503
504 static int setup_machine(void)
505 {
506 #ifdef CONFIG_MACH_TYPE
507         gd->bd->bi_arch_number = CONFIG_MACH_TYPE; /* board id for Linux */
508 #endif
509         return 0;
510 }
511
512 static int reserve_global_data(void)
513 {
514         gd->start_addr_sp = reserve_stack_aligned(sizeof(gd_t));
515         gd->new_gd = (gd_t *)map_sysmem(gd->start_addr_sp, sizeof(gd_t));
516         debug("Reserving %zu Bytes for Global Data at: %08lx\n",
517               sizeof(gd_t), gd->start_addr_sp);
518         return 0;
519 }
520
521 static int reserve_fdt(void)
522 {
523 #ifndef CONFIG_OF_EMBED
524         /*
525          * If the device tree is sitting immediately above our image then we
526          * must relocate it. If it is embedded in the data section, then it
527          * will be relocated with other data.
528          */
529         if (gd->fdt_blob) {
530                 gd->fdt_size = ALIGN(fdt_totalsize(gd->fdt_blob), 32);
531
532                 gd->start_addr_sp = reserve_stack_aligned(gd->fdt_size);
533                 gd->new_fdt = map_sysmem(gd->start_addr_sp, gd->fdt_size);
534                 debug("Reserving %lu Bytes for FDT at: %08lx\n",
535                       gd->fdt_size, gd->start_addr_sp);
536         }
537 #endif
538
539         return 0;
540 }
541
542 static int reserve_bootstage(void)
543 {
544 #ifdef CONFIG_BOOTSTAGE
545         int size = bootstage_get_size();
546
547         gd->start_addr_sp = reserve_stack_aligned(size);
548         gd->new_bootstage = map_sysmem(gd->start_addr_sp, size);
549         debug("Reserving %#x Bytes for bootstage at: %08lx\n", size,
550               gd->start_addr_sp);
551 #endif
552
553         return 0;
554 }
555
556 __weak int arch_reserve_stacks(void)
557 {
558         return 0;
559 }
560
561 static int reserve_stacks(void)
562 {
563         /* make stack pointer 16-byte aligned */
564         gd->start_addr_sp = reserve_stack_aligned(16);
565
566         /*
567          * let the architecture-specific code tailor gd->start_addr_sp and
568          * gd->irq_sp
569          */
570         return arch_reserve_stacks();
571 }
572
573 static int reserve_bloblist(void)
574 {
575 #ifdef CONFIG_BLOBLIST
576         /* Align to a 4KB boundary for easier reading of addresses */
577         gd->start_addr_sp = ALIGN_DOWN(gd->start_addr_sp - CONFIG_BLOBLIST_SIZE,
578                                        0x1000);
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         if (IS_ENABLED(CONFIG_SYS_HAS_SRAM)) {
602                 bd->bi_sramstart = CONFIG_SYS_SRAM_BASE; /* start of SRAM */
603                 bd->bi_sramsize = CONFIG_SYS_SRAM_SIZE;  /* size  of SRAM */
604         }
605
606         return arch_setup_bdinfo();
607 }
608
609 #ifdef CONFIG_POST
610 static int init_post(void)
611 {
612         post_bootmode_init();
613         post_run(NULL, POST_ROM | post_bootmode_get(0));
614
615         return 0;
616 }
617 #endif
618
619 static int reloc_fdt(void)
620 {
621 #ifndef CONFIG_OF_EMBED
622         if (gd->flags & GD_FLG_SKIP_RELOC)
623                 return 0;
624         if (gd->new_fdt) {
625                 memcpy(gd->new_fdt, gd->fdt_blob, fdt_totalsize(gd->fdt_blob));
626                 gd->fdt_blob = gd->new_fdt;
627         }
628 #endif
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         if (gd->flags & GD_FLG_SKIP_RELOC)
656                 return 0;
657         if (gd->new_bloblist) {
658                 int size = CONFIG_BLOBLIST_SIZE;
659
660                 debug("Copying bloblist from %p to %p, size %x\n",
661                       gd->bloblist, gd->new_bloblist, size);
662                 memcpy(gd->new_bloblist, gd->bloblist, size);
663                 gd->bloblist = gd->new_bloblist;
664         }
665 #endif
666
667         return 0;
668 }
669
670 static int setup_reloc(void)
671 {
672         if (gd->flags & GD_FLG_SKIP_RELOC) {
673                 debug("Skipping relocation due to flag\n");
674                 return 0;
675         }
676
677 #ifdef CONFIG_SYS_TEXT_BASE
678 #ifdef ARM
679         gd->reloc_off = gd->relocaddr - (unsigned long)__image_copy_start;
680 #elif defined(CONFIG_M68K)
681         /*
682          * On all ColdFire arch cpu, monitor code starts always
683          * just after the default vector table location, so at 0x400
684          */
685         gd->reloc_off = gd->relocaddr - (CONFIG_SYS_TEXT_BASE + 0x400);
686 #elif !defined(CONFIG_SANDBOX)
687         gd->reloc_off = gd->relocaddr - CONFIG_SYS_TEXT_BASE;
688 #endif
689 #endif
690         memcpy(gd->new_gd, (char *)gd, sizeof(gd_t));
691
692         debug("Relocation Offset is: %08lx\n", gd->reloc_off);
693         debug("Relocating to %08lx, new gd at %08lx, sp at %08lx\n",
694               gd->relocaddr, (ulong)map_to_sysmem(gd->new_gd),
695               gd->start_addr_sp);
696
697         return 0;
698 }
699
700 #ifdef CONFIG_OF_BOARD_FIXUP
701 static int fix_fdt(void)
702 {
703         return board_fix_fdt((void *)gd->fdt_blob);
704 }
705 #endif
706
707 /* ARM calls relocate_code from its crt0.S */
708 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
709                 !CONFIG_IS_ENABLED(X86_64)
710
711 static int jump_to_copy(void)
712 {
713         if (gd->flags & GD_FLG_SKIP_RELOC)
714                 return 0;
715         /*
716          * x86 is special, but in a nice way. It uses a trampoline which
717          * enables the dcache if possible.
718          *
719          * For now, other archs use relocate_code(), which is implemented
720          * similarly for all archs. When we do generic relocation, hopefully
721          * we can make all archs enable the dcache prior to relocation.
722          */
723 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
724         /*
725          * SDRAM and console are now initialised. The final stack can now
726          * be setup in SDRAM. Code execution will continue in Flash, but
727          * with the stack in SDRAM and Global Data in temporary memory
728          * (CPU cache)
729          */
730         arch_setup_gd(gd->new_gd);
731         board_init_f_r_trampoline(gd->start_addr_sp);
732 #else
733         relocate_code(gd->start_addr_sp, gd->new_gd, gd->relocaddr);
734 #endif
735
736         return 0;
737 }
738 #endif
739
740 /* Record the board_init_f() bootstage (after arch_cpu_init()) */
741 static int initf_bootstage(void)
742 {
743         bool from_spl = IS_ENABLED(CONFIG_SPL_BOOTSTAGE) &&
744                         IS_ENABLED(CONFIG_BOOTSTAGE_STASH);
745         int ret;
746
747         ret = bootstage_init(!from_spl);
748         if (ret)
749                 return ret;
750         if (from_spl) {
751                 const void *stash = map_sysmem(CONFIG_BOOTSTAGE_STASH_ADDR,
752                                                CONFIG_BOOTSTAGE_STASH_SIZE);
753
754                 ret = bootstage_unstash(stash, CONFIG_BOOTSTAGE_STASH_SIZE);
755                 if (ret && ret != -ENOENT) {
756                         debug("Failed to unstash bootstage: err=%d\n", ret);
757                         return ret;
758                 }
759         }
760
761         bootstage_mark_name(BOOTSTAGE_ID_START_UBOOT_F, "board_init_f");
762
763         return 0;
764 }
765
766 static int initf_console_record(void)
767 {
768 #if defined(CONFIG_CONSOLE_RECORD) && CONFIG_VAL(SYS_MALLOC_F_LEN)
769         return console_record_init();
770 #else
771         return 0;
772 #endif
773 }
774
775 static int initf_dm(void)
776 {
777 #if defined(CONFIG_DM) && CONFIG_VAL(SYS_MALLOC_F_LEN)
778         int ret;
779
780         bootstage_start(BOOTSTAGE_ID_ACCUM_DM_F, "dm_f");
781         ret = dm_init_and_scan(true);
782         bootstage_accum(BOOTSTAGE_ID_ACCUM_DM_F);
783         if (ret)
784                 return ret;
785 #endif
786 #ifdef CONFIG_TIMER_EARLY
787         ret = dm_timer_init();
788         if (ret)
789                 return ret;
790 #endif
791
792         return 0;
793 }
794
795 /* Architecture-specific memory reservation */
796 __weak int reserve_arch(void)
797 {
798         return 0;
799 }
800
801 __weak int arch_cpu_init_dm(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 const init_fnc_t init_sequence_f[] = {
817         setup_mon_len,
818 #ifdef CONFIG_OF_CONTROL
819         fdtdec_setup,
820 #endif
821 #ifdef CONFIG_TRACE_EARLY
822         trace_early_init,
823 #endif
824         initf_malloc,
825         log_init,
826         initf_bootstage,        /* uses its own timer, so does not need DM */
827 #ifdef CONFIG_BLOBLIST
828         bloblist_init,
829 #endif
830         setup_spl_handoff,
831         initf_console_record,
832 #if defined(CONFIG_HAVE_FSP)
833         arch_fsp_init,
834 #endif
835         arch_cpu_init,          /* basic arch cpu dependent setup */
836         mach_cpu_init,          /* SoC/machine dependent CPU setup */
837         initf_dm,
838         arch_cpu_init_dm,
839 #if defined(CONFIG_BOARD_EARLY_INIT_F)
840         board_early_init_f,
841 #endif
842 #if defined(CONFIG_PPC) || defined(CONFIG_SYS_FSL_CLK) || defined(CONFIG_M68K)
843         /* get CPU and bus clocks according to the environment variable */
844         get_clocks,             /* get CPU and bus clocks (etc.) */
845 #endif
846 #if !defined(CONFIG_M68K)
847         timer_init,             /* initialize timer */
848 #endif
849 #if defined(CONFIG_BOARD_POSTCLK_INIT)
850         board_postclk_init,
851 #endif
852         env_init,               /* initialize environment */
853         init_baud_rate,         /* initialze baudrate settings */
854         serial_init,            /* serial communications setup */
855         console_init_f,         /* stage 1 init of console */
856         display_options,        /* say that we are here */
857         display_text_info,      /* show debugging info if required */
858         checkcpu,
859 #if defined(CONFIG_SYSRESET)
860         print_resetinfo,
861 #endif
862 #if defined(CONFIG_DISPLAY_CPUINFO)
863         print_cpuinfo,          /* display cpu info (and speed) */
864 #endif
865 #if defined(CONFIG_DTB_RESELECT)
866         embedded_dtb_select,
867 #endif
868 #if defined(CONFIG_DISPLAY_BOARDINFO)
869         show_board_info,
870 #endif
871         INIT_FUNC_WATCHDOG_INIT
872 #if defined(CONFIG_MISC_INIT_F)
873         misc_init_f,
874 #endif
875         INIT_FUNC_WATCHDOG_RESET
876 #if defined(CONFIG_SYS_I2C)
877         init_func_i2c,
878 #endif
879 #if defined(CONFIG_VID) && !defined(CONFIG_SPL)
880         init_func_vid,
881 #endif
882         announce_dram_init,
883         dram_init,              /* configure available RAM banks */
884 #ifdef CONFIG_POST
885         post_init_f,
886 #endif
887         INIT_FUNC_WATCHDOG_RESET
888 #if defined(CONFIG_SYS_DRAM_TEST)
889         testdram,
890 #endif /* CONFIG_SYS_DRAM_TEST */
891         INIT_FUNC_WATCHDOG_RESET
892
893 #ifdef CONFIG_POST
894         init_post,
895 #endif
896         INIT_FUNC_WATCHDOG_RESET
897         /*
898          * Now that we have DRAM mapped and working, we can
899          * relocate the code and continue running from DRAM.
900          *
901          * Reserve memory at end of RAM for (top down in that order):
902          *  - area that won't get touched by U-Boot and Linux (optional)
903          *  - kernel log buffer
904          *  - protected RAM
905          *  - LCD framebuffer
906          *  - monitor code
907          *  - board info struct
908          */
909         setup_dest_addr,
910 #ifdef CONFIG_OF_BOARD_FIXUP
911         fix_fdt,
912 #endif
913 #ifdef CONFIG_PRAM
914         reserve_pram,
915 #endif
916         reserve_round_4k,
917         arch_reserve_mmu,
918         reserve_video,
919         reserve_trace,
920         reserve_uboot,
921         reserve_malloc,
922         reserve_board,
923         setup_machine,
924         reserve_global_data,
925         reserve_fdt,
926         reserve_bootstage,
927         reserve_bloblist,
928         reserve_arch,
929         reserve_stacks,
930         dram_init_banksize,
931         show_dram_config,
932         INIT_FUNC_WATCHDOG_RESET
933         setup_bdinfo,
934         display_new_sp,
935         INIT_FUNC_WATCHDOG_RESET
936         reloc_fdt,
937         reloc_bootstage,
938         reloc_bloblist,
939         setup_reloc,
940 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
941         copy_uboot_to_ram,
942         do_elf_reloc_fixups,
943 #endif
944         clear_bss,
945 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
946                 !CONFIG_IS_ENABLED(X86_64)
947         jump_to_copy,
948 #endif
949         NULL,
950 };
951
952 void board_init_f(ulong boot_flags)
953 {
954         gd->flags = boot_flags;
955         gd->have_console = 0;
956
957         if (initcall_run_list(init_sequence_f))
958                 hang();
959
960 #if !defined(CONFIG_ARM) && !defined(CONFIG_SANDBOX) && \
961                 !defined(CONFIG_EFI_APP) && !CONFIG_IS_ENABLED(X86_64) && \
962                 !defined(CONFIG_ARC)
963         /* NOTREACHED - jump_to_copy() does not return */
964         hang();
965 #endif
966 }
967
968 #if defined(CONFIG_X86) || defined(CONFIG_ARC)
969 /*
970  * For now this code is only used on x86.
971  *
972  * init_sequence_f_r is the list of init functions which are run when
973  * U-Boot is executing from Flash with a semi-limited 'C' environment.
974  * The following limitations must be considered when implementing an
975  * '_f_r' function:
976  *  - 'static' variables are read-only
977  *  - Global Data (gd->xxx) is read/write
978  *
979  * The '_f_r' sequence must, as a minimum, copy U-Boot to RAM (if
980  * supported).  It _should_, if possible, copy global data to RAM and
981  * initialise the CPU caches (to speed up the relocation process)
982  *
983  * NOTE: At present only x86 uses this route, but it is intended that
984  * all archs will move to this when generic relocation is implemented.
985  */
986 static const init_fnc_t init_sequence_f_r[] = {
987 #if !CONFIG_IS_ENABLED(X86_64)
988         init_cache_f_r,
989 #endif
990
991         NULL,
992 };
993
994 void board_init_f_r(void)
995 {
996         if (initcall_run_list(init_sequence_f_r))
997                 hang();
998
999         /*
1000          * The pre-relocation drivers may be using memory that has now gone
1001          * away. Mark serial as unavailable - this will fall back to the debug
1002          * UART if available.
1003          *
1004          * Do the same with log drivers since the memory may not be available.
1005          */
1006         gd->flags &= ~(GD_FLG_SERIAL_READY | GD_FLG_LOG_READY);
1007 #ifdef CONFIG_TIMER
1008         gd->timer = NULL;
1009 #endif
1010
1011         /*
1012          * U-Boot has been copied into SDRAM, the BSS has been cleared etc.
1013          * Transfer execution from Flash to RAM by calculating the address
1014          * of the in-RAM copy of board_init_r() and calling it
1015          */
1016         (board_init_r + gd->reloc_off)((gd_t *)gd, gd->relocaddr);
1017
1018         /* NOTREACHED - board_init_r() does not return */
1019         hang();
1020 }
1021 #endif /* CONFIG_X86 */