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