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