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