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