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