]> git.karo-electronics.de Git - karo-tx-uboot.git/blob - arch/x86/lib/board.c
x86: Simplify Flash-to-RAM code execution transition
[karo-tx-uboot.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
46 #ifdef CONFIG_BITBANGMII
47 #include <miiphy.h>
48 #endif
49
50 /*
51  * Pointer to initial global data area
52  *
53  * Here we initialize it.
54  */
55 #undef  XTRN_DECLARE_GLOBAL_DATA_PTR
56 #define XTRN_DECLARE_GLOBAL_DATA_PTR    /* empty = allocate here */
57 DECLARE_GLOBAL_DATA_PTR = (gd_t *) (CONFIG_SYS_INIT_GD_ADDR);
58
59 /************************************************************************
60  * Init Utilities                                                       *
61  ************************************************************************
62  * Some of this code should be moved into the core functions,
63  * or dropped completely,
64  * but let's get it working (again) first...
65  */
66 static int init_baudrate(void)
67 {
68         gd->baudrate = getenv_ulong("baudrate", 10, CONFIG_BAUDRATE);
69         return 0;
70 }
71
72 static int display_banner(void)
73 {
74
75         printf("\n\n%s\n\n", version_string);
76
77         return 0;
78 }
79
80 static int display_dram_config(void)
81 {
82         int i;
83
84         puts("DRAM Configuration:\n");
85
86         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
87                 printf("Bank #%d: %08lx ", i, gd->bd->bi_dram[i].start);
88                 print_size(gd->bd->bi_dram[i].size, "\n");
89         }
90
91         return 0;
92 }
93
94 #ifndef CONFIG_SYS_NO_FLASH
95 static void display_flash_config(ulong size)
96 {
97         puts("Flash: ");
98         print_size(size, "\n");
99 }
100 #endif
101
102 /*
103  * Breath some life into the board...
104  *
105  * Initialize an SMC for serial comms, and carry out some hardware
106  * tests.
107  *
108  * The first part of initialization is running from Flash memory;
109  * its main purpose is to initialize the RAM so that we
110  * can relocate the monitor code to RAM.
111  */
112
113 /*
114  * All attempts to come up with a "common" initialization sequence
115  * that works for all boards and architectures failed: some of the
116  * requirements are just _too_ different. To get rid of the resulting
117  * mess of board dependend #ifdef'ed code we now make the whole
118  * initialization sequence configurable to the user.
119  *
120  * The requirements for any new initalization function is simple: it
121  * receives a pointer to the "global data" structure as it's only
122  * argument, and returns an integer return code, where 0 means
123  * "continue" and != 0 means "fatal error, hang the system".
124  */
125 typedef int (init_fnc_t) (void);
126
127 static int calculate_relocation_address(void);
128 static int copy_uboot_to_ram(void);
129 static int clear_bss(void);
130 static int do_elf_reloc_fixups(void);
131
132 init_fnc_t *init_sequence_f[] = {
133         cpu_init_f,
134         board_early_init_f,
135         env_init,
136         init_baudrate,
137         serial_init,
138         console_init_f,
139         dram_init_f,
140         calculate_relocation_address,
141         copy_uboot_to_ram,
142         clear_bss,
143         do_elf_reloc_fixups,
144
145         NULL,
146 };
147
148 init_fnc_t *init_sequence_r[] = {
149         cpu_init_r,             /* basic cpu dependent setup */
150         board_early_init_r,     /* basic board dependent setup */
151         dram_init,              /* configure available RAM banks */
152         interrupt_init,         /* set up exceptions */
153         timer_init,
154         display_banner,
155         display_dram_config,
156
157         NULL,
158 };
159
160 gd_t *gd;
161
162 static int calculate_relocation_address(void)
163 {
164         ulong text_start = (ulong)&__text_start;
165         ulong bss_end = (ulong)&__bss_end;
166         ulong dest_addr;
167         ulong rel_offset;
168
169         /* Calculate destination RAM Address and relocation offset */
170         dest_addr = gd->ram_size;
171         dest_addr -= CONFIG_SYS_STACK_SIZE;
172         dest_addr -= (bss_end - text_start);
173
174         /*
175          * Round destination address down to 16-byte boundary to keep
176          * IDT and GDT 16-byte aligned
177          */
178         dest_addr &= ~15;
179
180         rel_offset = dest_addr - text_start;
181
182         gd->start_addr_sp = gd->ram_size;
183         gd->relocaddr = dest_addr;
184         gd->reloc_off = rel_offset;
185
186         return 0;
187 }
188
189 static int copy_uboot_to_ram(void)
190 {
191         size_t len = (size_t)&__data_end - (size_t)&__text_start;
192
193         memcpy((void *)gd->relocaddr, (void *)&__text_start, len);
194
195         return 0;
196 }
197
198 static int clear_bss(void)
199 {
200         ulong dst_addr = (ulong)&__bss_start + gd->reloc_off;
201         size_t len = (size_t)&__bss_end - (size_t)&__bss_start;
202
203         memset((void *)dst_addr, 0x00, len);
204
205         return 0;
206 }
207
208 static int do_elf_reloc_fixups(void)
209 {
210         Elf32_Rel *re_src = (Elf32_Rel *)(&__rel_dyn_start);
211         Elf32_Rel *re_end = (Elf32_Rel *)(&__rel_dyn_end);
212
213         Elf32_Addr *offset_ptr_rom;
214         Elf32_Addr *offset_ptr_ram;
215
216         /* The size of the region of u-boot that runs out of RAM. */
217         uintptr_t size = (uintptr_t)&__bss_end - (uintptr_t)&__text_start;
218
219         do {
220                 /* Get the location from the relocation entry */
221                 offset_ptr_rom = (Elf32_Addr *)re_src->r_offset;
222
223                 /* Check that the location of the relocation is in .text */
224                 if (offset_ptr_rom >= (Elf32_Addr *)CONFIG_SYS_TEXT_BASE) {
225
226                         /* Switch to the in-RAM version */
227                         offset_ptr_ram = (Elf32_Addr *)((ulong)offset_ptr_rom +
228                                                         gd->reloc_off);
229
230                         /* Check that the target points into .text */
231                         if (*offset_ptr_ram >= CONFIG_SYS_TEXT_BASE &&
232                                         *offset_ptr_ram <
233                                         (CONFIG_SYS_TEXT_BASE + size)) {
234                                 *offset_ptr_ram += gd->reloc_off;
235                         }
236                 }
237         } while (re_src++ < re_end);
238
239         return 0;
240 }
241
242 /* Load U-Boot into RAM, initialize BSS, perform relocation adjustments */
243 void board_init_f(ulong boot_flags)
244 {
245         init_fnc_t **init_fnc_ptr;
246
247         gd->flags = boot_flags;
248
249         for (init_fnc_ptr = init_sequence_f; *init_fnc_ptr; ++init_fnc_ptr) {
250                 if ((*init_fnc_ptr)() != 0)
251                         hang();
252         }
253
254         gd->flags |= GD_FLG_RELOC;
255
256         /*
257          * SDRAM is now initialised, U-Boot has been copied into SDRAM,
258          * the BSS has been cleared etc. The final stack can now be setup
259          * in SDRAM. Code execution will continue (momentarily) in Flash,
260          * but with the stack in SDRAM and Global Data in temporary memory
261          * (CPU cache)
262          */
263         board_init_f_r_trampoline(gd->start_addr_sp);
264
265         /* NOTREACHED - board_init_f_r_trampoline() does not return */
266         while (1)
267                 ;
268 }
269
270 void board_init_f_r(void)
271 {
272         /*
273          * Transfer execution from Flash to RAM by calculating the address
274          * of the in-RAM copy of board_init_r() and calling it
275          */
276         (board_init_r + gd->reloc_off)(gd, gd->relocaddr);
277
278         /* NOTREACHED - board_init_r() does not return */
279         while (1)
280                 ;
281 }
282
283 void board_init_r(gd_t *id, ulong dest_addr)
284 {
285 #if defined(CONFIG_CMD_NET)
286         char *s;
287 #endif
288 #ifndef CONFIG_SYS_NO_FLASH
289         ulong size;
290 #endif
291         static bd_t bd_data;
292         static gd_t gd_data;
293         init_fnc_t **init_fnc_ptr;
294
295         show_boot_progress(0x21);
296
297         /* Global data pointer is now writable */
298         gd = &gd_data;
299         memcpy(gd, id, sizeof(gd_t));
300
301         /* compiler optimization barrier needed for GCC >= 3.4 */
302         __asm__ __volatile__("" : : : "memory");
303
304         gd->bd = &bd_data;
305         memset(gd->bd, 0, sizeof(bd_t));
306         show_boot_progress(0x22);
307
308         gd->baudrate =  CONFIG_BAUDRATE;
309
310         mem_malloc_init((((ulong)dest_addr - CONFIG_SYS_MALLOC_LEN)+3)&~3,
311                         CONFIG_SYS_MALLOC_LEN);
312
313         for (init_fnc_ptr = init_sequence_r; *init_fnc_ptr; ++init_fnc_ptr) {
314                 if ((*init_fnc_ptr)() != 0)
315                         hang();
316         }
317         show_boot_progress(0x23);
318
319 #ifdef CONFIG_SERIAL_MULTI
320         serial_initialize();
321 #endif
322
323 #ifndef CONFIG_SYS_NO_FLASH
324         /* configure available FLASH banks */
325         size = flash_init();
326         display_flash_config(size);
327         show_boot_progress(0x24);
328 #endif
329
330         show_boot_progress(0x25);
331
332         /* initialize environment */
333         env_relocate();
334         show_boot_progress(0x26);
335
336
337 #ifdef CONFIG_CMD_NET
338         /* IP Address */
339         bd_data.bi_ip_addr = getenv_IPaddr("ipaddr");
340 #endif
341
342 #if defined(CONFIG_PCI)
343         /*
344          * Do pci configuration
345          */
346         pci_init();
347 #endif
348
349         show_boot_progress(0x27);
350
351
352         stdio_init();
353
354         jumptable_init();
355
356         /* Initialize the console (after the relocation and devices init) */
357         console_init_r();
358
359 #ifdef CONFIG_MISC_INIT_R
360         /* miscellaneous platform dependent initialisations */
361         misc_init_r();
362 #endif
363
364 #if defined(CONFIG_CMD_PCMCIA) && !defined(CONFIG_CMD_IDE)
365         WATCHDOG_RESET();
366         puts("PCMCIA:");
367         pcmcia_init();
368 #endif
369
370 #if defined(CONFIG_CMD_KGDB)
371         WATCHDOG_RESET();
372         puts("KGDB:  ");
373         kgdb_init();
374 #endif
375
376         /* enable exceptions */
377         enable_interrupts();
378         show_boot_progress(0x28);
379
380 #ifdef CONFIG_STATUS_LED
381         status_led_set(STATUS_LED_BOOT, STATUS_LED_BLINKING);
382 #endif
383
384         udelay(20);
385
386         /* Initialize from environment */
387         load_addr = getenv_ulong("loadaddr", 16, load_addr);
388 #if defined(CONFIG_CMD_NET)
389         s = getenv("bootfile");
390
391         if (s != NULL)
392                 copy_filename(BootFile, s, sizeof(BootFile));
393 #endif
394
395         WATCHDOG_RESET();
396
397 #if defined(CONFIG_CMD_IDE)
398         WATCHDOG_RESET();
399         puts("IDE:   ");
400         ide_init();
401 #endif
402
403 #if defined(CONFIG_CMD_SCSI)
404         WATCHDOG_RESET();
405         puts("SCSI:  ");
406         scsi_init();
407 #endif
408
409 #if defined(CONFIG_CMD_DOC)
410         WATCHDOG_RESET();
411         puts("DOC:   ");
412         doc_init();
413 #endif
414
415 #ifdef CONFIG_BITBANGMII
416         bb_miiphy_init();
417 #endif
418 #if defined(CONFIG_CMD_NET)
419         WATCHDOG_RESET();
420         puts("Net:   ");
421         eth_initialize(gd->bd);
422 #endif
423
424 #if (defined(CONFIG_CMD_NET)) && (0)
425         WATCHDOG_RESET();
426 # ifdef DEBUG
427         puts("Reset Ethernet PHY\n");
428 # endif
429         reset_phy();
430 #endif
431
432 #ifdef CONFIG_LAST_STAGE_INIT
433         WATCHDOG_RESET();
434         /*
435          * Some parts can be only initialized if all others (like
436          * Interrupts) are up and running (i.e. the PC-style ISA
437          * keyboard).
438          */
439         last_stage_init();
440 #endif
441
442
443 #ifdef CONFIG_POST
444         post_run(NULL, POST_RAM | post_bootmode_get(0));
445 #endif
446
447         show_boot_progress(0x29);
448
449         /* main_loop() can return to retry autoboot, if so just run it again. */
450         for (;;)
451                 main_loop();
452
453         /* NOTREACHED - no way out of command loop except booting */
454 }
455
456 void hang(void)
457 {
458         puts("### ERROR ### Please RESET the board ###\n");
459         for (;;)
460                 ;
461 }
462
463 unsigned long do_go_exec(ulong (*entry)(int, char * const []),
464                          int argc, char * const argv[])
465 {
466         unsigned long ret = 0;
467         char **argv_tmp;
468
469         /*
470          * x86 does not use a dedicated register to pass the pointer to
471          * the global_data, so it is instead passed as argv[-1]. By using
472          * argv[-1], the called 'Application' can use the contents of
473          * argv natively. However, to safely use argv[-1] a new copy of
474          * argv is needed with the extra element
475          */
476         argv_tmp = malloc(sizeof(char *) * (argc + 1));
477
478         if (argv_tmp) {
479                 argv_tmp[0] = (char *)gd;
480
481                 memcpy(&argv_tmp[1], argv, (size_t)(sizeof(char *) * argc));
482
483                 ret = (entry) (argc, &argv_tmp[1]);
484                 free(argv_tmp);
485         }
486
487         return ret;
488 }
489
490 void setup_pcat_compatibility(void)
491         __attribute__((weak, alias("__setup_pcat_compatibility")));
492
493 void __setup_pcat_compatibility(void)
494 {
495 }