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