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