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