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