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