x86: Set GD_FLG_RELOC after entering in-RAM copy of U-Boot
[oweals/u-boot.git] / arch / x86 / lib / board.c
1 /*
2  * (C) Copyright 2008-2011
3  * Graeme Russ, <graeme.russ@gmail.com>
4  *
5  * (C) Copyright 2002
6  * Daniel Engström, Omicron Ceti AB, <daniel@omicron.se>
7  *
8  * (C) Copyright 2002
9  * Wolfgang Denk, DENX Software Engineering, <wd@denx.de>
10  *
11  * (C) Copyright 2002
12  * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
13  * Marius Groeger <mgroeger@sysgo.de>
14  *
15  * See file CREDITS for list of people who contributed to this
16  * project.
17  *
18  * This program is free software; you can redistribute it and/or
19  * modify it under the terms of the GNU General Public License as
20  * published by the Free Software Foundation; either version 2 of
21  * the License, or (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program; if not, write to the Free Software
30  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
31  * MA 02111-1307 USA
32  */
33
34 #include <common.h>
35 #include <watchdog.h>
36 #include <command.h>
37 #include <stdio_dev.h>
38 #include <version.h>
39 #include <malloc.h>
40 #include <net.h>
41 #include <ide.h>
42 #include <serial.h>
43 #include <asm/u-boot-x86.h>
44 #include <elf.h>
45 #include <asm/processor.h>
46
47 #ifdef CONFIG_BITBANGMII
48 #include <miiphy.h>
49 #endif
50
51 /************************************************************************
52  * Init Utilities                                                       *
53  ************************************************************************
54  * Some of this code should be moved into the core functions,
55  * or dropped completely,
56  * but let's get it working (again) first...
57  */
58 static int init_baudrate(void)
59 {
60         gd->baudrate = getenv_ulong("baudrate", 10, CONFIG_BAUDRATE);
61         return 0;
62 }
63
64 static int display_banner(void)
65 {
66
67         printf("\n\n%s\n\n", version_string);
68
69         return 0;
70 }
71
72 static int display_dram_config(void)
73 {
74         int i;
75
76         puts("DRAM Configuration:\n");
77
78         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
79                 printf("Bank #%d: %08lx ", i, gd->bd->bi_dram[i].start);
80                 print_size(gd->bd->bi_dram[i].size, "\n");
81         }
82
83         return 0;
84 }
85
86 #ifndef CONFIG_SYS_NO_FLASH
87 static void display_flash_config(ulong size)
88 {
89         puts("Flash: ");
90         print_size(size, "\n");
91 }
92 #endif
93
94 /*
95  * Breath some life into the board...
96  *
97  * Initialize an SMC for serial comms, and carry out some hardware
98  * tests.
99  *
100  * The first part of initialization is running from Flash memory;
101  * its main purpose is to initialize the RAM so that we
102  * can relocate the monitor code to RAM.
103  */
104
105 /*
106  * All attempts to come up with a "common" initialization sequence
107  * that works for all boards and architectures failed: some of the
108  * requirements are just _too_ different. To get rid of the resulting
109  * mess of board dependend #ifdef'ed code we now make the whole
110  * initialization sequence configurable to the user.
111  *
112  * The requirements for any new initalization function is simple: it
113  * receives a pointer to the "global data" structure as it's only
114  * argument, and returns an integer return code, where 0 means
115  * "continue" and != 0 means "fatal error, hang the system".
116  */
117 typedef int (init_fnc_t) (void);
118
119 static int calculate_relocation_address(void);
120 static int copy_uboot_to_ram(void);
121 static int clear_bss(void);
122 static int do_elf_reloc_fixups(void);
123 static int copy_gd_to_ram(void);
124
125 init_fnc_t *init_sequence_f[] = {
126         cpu_init_f,
127         board_early_init_f,
128         env_init,
129         init_baudrate,
130         serial_init,
131         console_init_f,
132         dram_init_f,
133         calculate_relocation_address,
134         copy_uboot_to_ram,
135         clear_bss,
136         do_elf_reloc_fixups,
137
138         NULL,
139 };
140
141 init_fnc_t *init_sequence_r[] = {
142         copy_gd_to_ram,
143         cpu_init_r,             /* basic cpu dependent setup */
144         board_early_init_r,     /* basic board dependent setup */
145         dram_init,              /* configure available RAM banks */
146         interrupt_init,         /* set up exceptions */
147         timer_init,
148         display_banner,
149         display_dram_config,
150
151         NULL,
152 };
153
154 static int calculate_relocation_address(void)
155 {
156         ulong text_start = (ulong)&__text_start;
157         ulong bss_end = (ulong)&__bss_end;
158         ulong dest_addr;
159
160         /*
161          * NOTE: All destination address are rounded down to 16-byte
162          *       boundary to satisfy various worst-case alignment
163          *       requirements
164          */
165
166         /* Global Data is at top of available memory */
167         dest_addr = gd->ram_size;
168         dest_addr -= GENERATED_GBL_DATA_SIZE;
169         dest_addr &= ~15;
170         gd->new_gd_addr = dest_addr;
171
172         /* GDT is below Global Data */
173         dest_addr -= X86_GDT_SIZE;
174         dest_addr &= ~15;
175         gd->gdt_addr = dest_addr;
176
177         /* Stack is below GDT */
178         gd->start_addr_sp = dest_addr;
179
180         /* U-Boot is below the stack */
181         dest_addr -= CONFIG_SYS_STACK_SIZE;
182         dest_addr -= (bss_end - text_start);
183         dest_addr &= ~15;
184         gd->relocaddr = dest_addr;
185         gd->reloc_off = (dest_addr - text_start);
186
187         return 0;
188 }
189
190 static int copy_uboot_to_ram(void)
191 {
192         size_t len = (size_t)&__data_end - (size_t)&__text_start;
193
194         memcpy((void *)gd->relocaddr, (void *)&__text_start, len);
195
196         return 0;
197 }
198
199 static int clear_bss(void)
200 {
201         ulong dst_addr = (ulong)&__bss_start + gd->reloc_off;
202         size_t len = (size_t)&__bss_end - (size_t)&__bss_start;
203
204         memset((void *)dst_addr, 0x00, len);
205
206         return 0;
207 }
208
209 static int do_elf_reloc_fixups(void)
210 {
211         Elf32_Rel *re_src = (Elf32_Rel *)(&__rel_dyn_start);
212         Elf32_Rel *re_end = (Elf32_Rel *)(&__rel_dyn_end);
213
214         Elf32_Addr *offset_ptr_rom;
215         Elf32_Addr *offset_ptr_ram;
216
217         /* The size of the region of u-boot that runs out of RAM. */
218         uintptr_t size = (uintptr_t)&__bss_end - (uintptr_t)&__text_start;
219
220         do {
221                 /* Get the location from the relocation entry */
222                 offset_ptr_rom = (Elf32_Addr *)re_src->r_offset;
223
224                 /* Check that the location of the relocation is in .text */
225                 if (offset_ptr_rom >= (Elf32_Addr *)CONFIG_SYS_TEXT_BASE) {
226
227                         /* Switch to the in-RAM version */
228                         offset_ptr_ram = (Elf32_Addr *)((ulong)offset_ptr_rom +
229                                                         gd->reloc_off);
230
231                         /* Check that the target points into .text */
232                         if (*offset_ptr_ram >= CONFIG_SYS_TEXT_BASE &&
233                                         *offset_ptr_ram <
234                                         (CONFIG_SYS_TEXT_BASE + size)) {
235                                 *offset_ptr_ram += gd->reloc_off;
236                         }
237                 }
238         } while (re_src++ < re_end);
239
240         return 0;
241 }
242
243 /* Load U-Boot into RAM, initialize BSS, perform relocation adjustments */
244 void board_init_f(ulong boot_flags)
245 {
246         init_fnc_t **init_fnc_ptr;
247
248         gd->flags = boot_flags;
249
250         for (init_fnc_ptr = init_sequence_f; *init_fnc_ptr; ++init_fnc_ptr) {
251                 if ((*init_fnc_ptr)() != 0)
252                         hang();
253         }
254
255         /*
256          * SDRAM is now initialised, U-Boot has been copied into SDRAM,
257          * the BSS has been cleared etc. The final stack can now be setup
258          * in SDRAM. Code execution will continue (momentarily) in Flash,
259          * but with the stack in SDRAM and Global Data in temporary memory
260          * (CPU cache)
261          */
262         board_init_f_r_trampoline(gd->start_addr_sp);
263
264         /* NOTREACHED - board_init_f_r_trampoline() does not return */
265         while (1)
266                 ;
267 }
268
269 void board_init_f_r(void)
270 {
271         /*
272          * Transfer execution from Flash to RAM by calculating the address
273          * of the in-RAM copy of board_init_r() and calling it
274          */
275         (board_init_r + gd->reloc_off)(gd, gd->relocaddr);
276
277         /* NOTREACHED - board_init_r() does not return */
278         while (1)
279                 ;
280 }
281
282 static int copy_gd_to_ram(void)
283 {
284         gd_t *ram_gd;
285
286         /*
287          * Global data is still in temporary memory (the CPU cache).
288          * calculate_relocation_address() has set gd->new_gd_addr to
289          * where the global data lives in RAM but getting it there
290          * safely is a bit tricky due to the 'F-Segment Hack' that
291          * we need to use for x86
292          */
293         ram_gd = (gd_t *)gd->new_gd_addr;
294         memcpy((void *)ram_gd, gd, sizeof(gd_t));
295
296         /*
297          * Reload the Global Descriptor Table so FS points to the
298          * in-RAM copy of Global Data (calculate_relocation_address()
299          * has already calculated the in-RAM location of the GDT)
300          */
301         ram_gd->gd_addr = (ulong)ram_gd;
302         init_gd(ram_gd, (u64 *)gd->gdt_addr);
303
304         return 0;
305 }
306
307 void board_init_r(gd_t *id, ulong dest_addr)
308 {
309 #if defined(CONFIG_CMD_NET)
310         char *s;
311 #endif
312 #ifndef CONFIG_SYS_NO_FLASH
313         ulong size;
314 #endif
315         static bd_t bd_data;
316         init_fnc_t **init_fnc_ptr;
317
318         show_boot_progress(0x21);
319
320         /* compiler optimization barrier needed for GCC >= 3.4 */
321         __asm__ __volatile__("" : : : "memory");
322
323         gd->flags |= GD_FLG_RELOC;
324
325         gd->bd = &bd_data;
326         memset(gd->bd, 0, sizeof(bd_t));
327         show_boot_progress(0x22);
328
329         gd->baudrate =  CONFIG_BAUDRATE;
330
331         mem_malloc_init((((ulong)dest_addr - CONFIG_SYS_MALLOC_LEN)+3)&~3,
332                         CONFIG_SYS_MALLOC_LEN);
333
334         for (init_fnc_ptr = init_sequence_r; *init_fnc_ptr; ++init_fnc_ptr) {
335                 if ((*init_fnc_ptr)() != 0)
336                         hang();
337         }
338         show_boot_progress(0x23);
339
340 #ifdef CONFIG_SERIAL_MULTI
341         serial_initialize();
342 #endif
343
344 #ifndef CONFIG_SYS_NO_FLASH
345         /* configure available FLASH banks */
346         size = flash_init();
347         display_flash_config(size);
348         show_boot_progress(0x24);
349 #endif
350
351         show_boot_progress(0x25);
352
353         /* initialize environment */
354         env_relocate();
355         show_boot_progress(0x26);
356
357
358 #ifdef CONFIG_CMD_NET
359         /* IP Address */
360         bd_data.bi_ip_addr = getenv_IPaddr("ipaddr");
361 #endif
362
363 #if defined(CONFIG_PCI)
364         /*
365          * Do pci configuration
366          */
367         pci_init();
368 #endif
369
370         show_boot_progress(0x27);
371
372
373         stdio_init();
374
375         jumptable_init();
376
377         /* Initialize the console (after the relocation and devices init) */
378         console_init_r();
379
380 #ifdef CONFIG_MISC_INIT_R
381         /* miscellaneous platform dependent initialisations */
382         misc_init_r();
383 #endif
384
385 #if defined(CONFIG_CMD_PCMCIA) && !defined(CONFIG_CMD_IDE)
386         WATCHDOG_RESET();
387         puts("PCMCIA:");
388         pcmcia_init();
389 #endif
390
391 #if defined(CONFIG_CMD_KGDB)
392         WATCHDOG_RESET();
393         puts("KGDB:  ");
394         kgdb_init();
395 #endif
396
397         /* enable exceptions */
398         enable_interrupts();
399         show_boot_progress(0x28);
400
401 #ifdef CONFIG_STATUS_LED
402         status_led_set(STATUS_LED_BOOT, STATUS_LED_BLINKING);
403 #endif
404
405         udelay(20);
406
407         /* Initialize from environment */
408         load_addr = getenv_ulong("loadaddr", 16, load_addr);
409 #if defined(CONFIG_CMD_NET)
410         s = getenv("bootfile");
411
412         if (s != NULL)
413                 copy_filename(BootFile, s, sizeof(BootFile));
414 #endif
415
416         WATCHDOG_RESET();
417
418 #if defined(CONFIG_CMD_IDE)
419         WATCHDOG_RESET();
420         puts("IDE:   ");
421         ide_init();
422 #endif
423
424 #if defined(CONFIG_CMD_SCSI)
425         WATCHDOG_RESET();
426         puts("SCSI:  ");
427         scsi_init();
428 #endif
429
430 #if defined(CONFIG_CMD_DOC)
431         WATCHDOG_RESET();
432         puts("DOC:   ");
433         doc_init();
434 #endif
435
436 #ifdef CONFIG_BITBANGMII
437         bb_miiphy_init();
438 #endif
439 #if defined(CONFIG_CMD_NET)
440         WATCHDOG_RESET();
441         puts("Net:   ");
442         eth_initialize(gd->bd);
443 #endif
444
445 #if (defined(CONFIG_CMD_NET)) && (0)
446         WATCHDOG_RESET();
447 # ifdef DEBUG
448         puts("Reset Ethernet PHY\n");
449 # endif
450         reset_phy();
451 #endif
452
453 #ifdef CONFIG_LAST_STAGE_INIT
454         WATCHDOG_RESET();
455         /*
456          * Some parts can be only initialized if all others (like
457          * Interrupts) are up and running (i.e. the PC-style ISA
458          * keyboard).
459          */
460         last_stage_init();
461 #endif
462
463
464 #ifdef CONFIG_POST
465         post_run(NULL, POST_RAM | post_bootmode_get(0));
466 #endif
467
468         show_boot_progress(0x29);
469
470         /* main_loop() can return to retry autoboot, if so just run it again. */
471         for (;;)
472                 main_loop();
473
474         /* NOTREACHED - no way out of command loop except booting */
475 }
476
477 void hang(void)
478 {
479         puts("### ERROR ### Please RESET the board ###\n");
480         for (;;)
481                 ;
482 }
483
484 unsigned long do_go_exec(ulong (*entry)(int, char * const []),
485                          int argc, char * const argv[])
486 {
487         unsigned long ret = 0;
488         char **argv_tmp;
489
490         /*
491          * x86 does not use a dedicated register to pass the pointer to
492          * the global_data, so it is instead passed as argv[-1]. By using
493          * argv[-1], the called 'Application' can use the contents of
494          * argv natively. However, to safely use argv[-1] a new copy of
495          * argv is needed with the extra element
496          */
497         argv_tmp = malloc(sizeof(char *) * (argc + 1));
498
499         if (argv_tmp) {
500                 argv_tmp[0] = (char *)gd;
501
502                 memcpy(&argv_tmp[1], argv, (size_t)(sizeof(char *) * argc));
503
504                 ret = (entry) (argc, &argv_tmp[1]);
505                 free(argv_tmp);
506         }
507
508         return ret;
509 }
510
511 void setup_pcat_compatibility(void)
512         __attribute__((weak, alias("__setup_pcat_compatibility")));
513
514 void __setup_pcat_compatibility(void)
515 {
516 }