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