Introduce virt_to_phys()
[oweals/u-boot.git] / lib_mips / board.c
1 /*
2  * (C) Copyright 2003
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * See file CREDITS for list of people who contributed to this
6  * project.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation; either version 2 of
11  * the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
21  * MA 02111-1307 USA
22  */
23
24 #include <common.h>
25 #include <command.h>
26 #include <malloc.h>
27 #include <devices.h>
28 #include <timestamp.h>
29 #include <version.h>
30 #include <net.h>
31 #include <environment.h>
32 #include <nand.h>
33 #include <onenand_uboot.h>
34 #include <spi.h>
35
36 DECLARE_GLOBAL_DATA_PTR;
37
38 #if ( ((CONFIG_ENV_ADDR+CONFIG_ENV_SIZE) < CONFIG_SYS_MONITOR_BASE) || \
39       (CONFIG_ENV_ADDR >= (CONFIG_SYS_MONITOR_BASE + CONFIG_SYS_MONITOR_LEN)) ) || \
40     defined(CONFIG_ENV_IS_IN_NVRAM)
41 #define TOTAL_MALLOC_LEN        (CONFIG_SYS_MALLOC_LEN + CONFIG_ENV_SIZE)
42 #else
43 #define TOTAL_MALLOC_LEN        CONFIG_SYS_MALLOC_LEN
44 #endif
45
46 #undef DEBUG
47
48 extern int timer_init(void);
49
50 extern int incaip_set_cpuclk(void);
51
52 extern ulong uboot_end_data;
53 extern ulong uboot_end;
54
55 ulong monitor_flash_len;
56
57 const char version_string[] =
58         U_BOOT_VERSION" (" U_BOOT_DATE " - " U_BOOT_TIME ")";
59
60 static char *failed = "*** failed ***\n";
61
62 /*
63  * Begin and End of memory area for malloc(), and current "brk"
64  */
65 static ulong mem_malloc_start;
66 static ulong mem_malloc_end;
67 static ulong mem_malloc_brk;
68
69 /*
70  * mips_io_port_base is the begin of the address space to which x86 style
71  * I/O ports are mapped.
72  */
73 unsigned long mips_io_port_base = -1;
74
75 int __board_early_init_f(void)
76 {
77         /*
78          * Nothing to do in this dummy implementation
79          */
80         return 0;
81 }
82 int board_early_init_f(void) __attribute__((weak, alias("__board_early_init_f")));
83
84 /*
85  * The Malloc area is immediately below the monitor copy in DRAM
86  */
87 static void mem_malloc_init (void)
88 {
89         ulong dest_addr = CONFIG_SYS_MONITOR_BASE + gd->reloc_off;
90
91         mem_malloc_end = dest_addr;
92         mem_malloc_start = dest_addr - TOTAL_MALLOC_LEN;
93         mem_malloc_brk = mem_malloc_start;
94
95         memset ((void *) mem_malloc_start,
96                 0,
97                 mem_malloc_end - mem_malloc_start);
98 }
99
100 void *sbrk (ptrdiff_t increment)
101 {
102         ulong old = mem_malloc_brk;
103         ulong new = old + increment;
104
105         if ((new < mem_malloc_start) || (new > mem_malloc_end)) {
106                 return (NULL);
107         }
108         mem_malloc_brk = new;
109         return ((void *) old);
110 }
111
112
113 static int init_func_ram (void)
114 {
115 #ifdef  CONFIG_BOARD_TYPES
116         int board_type = gd->board_type;
117 #else
118         int board_type = 0;     /* use dummy arg */
119 #endif
120         puts ("DRAM:  ");
121
122         if ((gd->ram_size = initdram (board_type)) > 0) {
123                 print_size (gd->ram_size, "\n");
124                 return (0);
125         }
126         puts (failed);
127         return (1);
128 }
129
130 static int display_banner(void)
131 {
132
133         printf ("\n\n%s\n\n", version_string);
134         return (0);
135 }
136
137 #ifndef CONFIG_SYS_NO_FLASH
138 static void display_flash_config(ulong size)
139 {
140         puts ("Flash: ");
141         print_size (size, "\n");
142 }
143 #endif
144
145 static int init_baudrate (void)
146 {
147         char tmp[64];   /* long enough for environment variables */
148         int i = getenv_r ("baudrate", tmp, sizeof (tmp));
149
150         gd->baudrate = (i > 0)
151                         ? (int) simple_strtoul (tmp, NULL, 10)
152                         : CONFIG_BAUDRATE;
153
154         return (0);
155 }
156
157
158 /*
159  * Breath some life into the board...
160  *
161  * The first part of initialization is running from Flash memory;
162  * its main purpose is to initialize the RAM so that we
163  * can relocate the monitor code to RAM.
164  */
165
166 /*
167  * All attempts to come up with a "common" initialization sequence
168  * that works for all boards and architectures failed: some of the
169  * requirements are just _too_ different. To get rid of the resulting
170  * mess of board dependend #ifdef'ed code we now make the whole
171  * initialization sequence configurable to the user.
172  *
173  * The requirements for any new initalization function is simple: it
174  * receives a pointer to the "global data" structure as it's only
175  * argument, and returns an integer return code, where 0 means
176  * "continue" and != 0 means "fatal error, hang the system".
177  */
178 typedef int (init_fnc_t) (void);
179
180 init_fnc_t *init_sequence[] = {
181         board_early_init_f,
182         timer_init,
183         env_init,               /* initialize environment */
184 #ifdef CONFIG_INCA_IP
185         incaip_set_cpuclk,      /* set cpu clock according to environment variable */
186 #endif
187         init_baudrate,          /* initialze baudrate settings */
188         serial_init,            /* serial communications setup */
189         console_init_f,
190         display_banner,         /* say that we are here */
191         checkboard,
192         init_func_ram,
193         NULL,
194 };
195
196
197 void board_init_f(ulong bootflag)
198 {
199         gd_t gd_data, *id;
200         bd_t *bd;
201         init_fnc_t **init_fnc_ptr;
202         ulong addr, addr_sp, len = (ulong)&uboot_end - CONFIG_SYS_MONITOR_BASE;
203         ulong *s;
204 #ifdef CONFIG_PURPLE
205         void copy_code (ulong);
206 #endif
207
208         /* Pointer is writable since we allocated a register for it.
209          */
210         gd = &gd_data;
211         /* compiler optimization barrier needed for GCC >= 3.4 */
212         __asm__ __volatile__("": : :"memory");
213
214         memset ((void *)gd, 0, sizeof (gd_t));
215
216         for (init_fnc_ptr = init_sequence; *init_fnc_ptr; ++init_fnc_ptr) {
217                 if ((*init_fnc_ptr)() != 0) {
218                         hang ();
219                 }
220         }
221
222         /*
223          * Now that we have DRAM mapped and working, we can
224          * relocate the code and continue running from DRAM.
225          */
226         addr = CONFIG_SYS_SDRAM_BASE + gd->ram_size;
227
228         /* We can reserve some RAM "on top" here.
229          */
230
231         /* round down to next 4 kB limit.
232          */
233         addr &= ~(4096 - 1);
234         debug ("Top of RAM usable for U-Boot at: %08lx\n", addr);
235
236         /* Reserve memory for U-Boot code, data & bss
237          * round down to next 16 kB limit
238          */
239         addr -= len;
240         addr &= ~(16 * 1024 - 1);
241
242         debug ("Reserving %ldk for U-Boot at: %08lx\n", len >> 10, addr);
243
244          /* Reserve memory for malloc() arena.
245          */
246         addr_sp = addr - TOTAL_MALLOC_LEN;
247         debug ("Reserving %dk for malloc() at: %08lx\n",
248                         TOTAL_MALLOC_LEN >> 10, addr_sp);
249
250         /*
251          * (permanently) allocate a Board Info struct
252          * and a permanent copy of the "global" data
253          */
254         addr_sp -= sizeof(bd_t);
255         bd = (bd_t *)addr_sp;
256         gd->bd = bd;
257         debug ("Reserving %zu Bytes for Board Info at: %08lx\n",
258                         sizeof(bd_t), addr_sp);
259
260         addr_sp -= sizeof(gd_t);
261         id = (gd_t *)addr_sp;
262         debug ("Reserving %zu Bytes for Global Data at: %08lx\n",
263                         sizeof (gd_t), addr_sp);
264
265         /* Reserve memory for boot params.
266          */
267         addr_sp -= CONFIG_SYS_BOOTPARAMS_LEN;
268         bd->bi_boot_params = addr_sp;
269         debug ("Reserving %dk for boot params() at: %08lx\n",
270                         CONFIG_SYS_BOOTPARAMS_LEN >> 10, addr_sp);
271
272         /*
273          * Finally, we set up a new (bigger) stack.
274          *
275          * Leave some safety gap for SP, force alignment on 16 byte boundary
276          * Clear initial stack frame
277          */
278         addr_sp -= 16;
279         addr_sp &= ~0xF;
280         s = (ulong *)addr_sp;
281         *s-- = 0;
282         *s-- = 0;
283         addr_sp = (ulong)s;
284         debug ("Stack Pointer at: %08lx\n", addr_sp);
285
286         /*
287          * Save local variables to board info struct
288          */
289         bd->bi_memstart = CONFIG_SYS_SDRAM_BASE;        /* start of  DRAM memory */
290         bd->bi_memsize  = gd->ram_size;         /* size  of  DRAM memory in bytes */
291         bd->bi_baudrate = gd->baudrate;         /* Console Baudrate */
292
293         memcpy (id, (void *)gd, sizeof (gd_t));
294
295         /* On the purple board we copy the code in a special way
296          * in order to solve flash problems
297          */
298 #ifdef CONFIG_PURPLE
299         copy_code(addr);
300 #endif
301
302         relocate_code (addr_sp, id, addr);
303
304         /* NOTREACHED - relocate_code() does not return */
305 }
306 /************************************************************************
307  *
308  * This is the next part if the initialization sequence: we are now
309  * running from RAM and have a "normal" C environment, i. e. global
310  * data can be written, BSS has been cleared, the stack size in not
311  * that critical any more, etc.
312  *
313  ************************************************************************
314  */
315
316 void board_init_r (gd_t *id, ulong dest_addr)
317 {
318         cmd_tbl_t *cmdtp;
319 #ifndef CONFIG_SYS_NO_FLASH
320         ulong size;
321 #endif
322         extern void malloc_bin_reloc (void);
323 #ifndef CONFIG_ENV_IS_NOWHERE
324         extern char * env_name_spec;
325 #endif
326         char *s, *e;
327         bd_t *bd;
328         int i;
329
330         gd = id;
331         gd->flags |= GD_FLG_RELOC;      /* tell others: relocation done */
332
333         debug ("Now running in RAM - U-Boot at: %08lx\n", dest_addr);
334
335         gd->reloc_off = dest_addr - CONFIG_SYS_MONITOR_BASE;
336
337         monitor_flash_len = (ulong)&uboot_end_data - dest_addr;
338
339         /*
340          * We have to relocate the command table manually
341          */
342         for (cmdtp = &__u_boot_cmd_start; cmdtp !=  &__u_boot_cmd_end; cmdtp++) {
343                 ulong addr;
344
345                 addr = (ulong) (cmdtp->cmd) + gd->reloc_off;
346 #if 0
347                 printf ("Command \"%s\": 0x%08lx => 0x%08lx\n",
348                                 cmdtp->name, (ulong) (cmdtp->cmd), addr);
349 #endif
350                 cmdtp->cmd =
351                         (int (*)(struct cmd_tbl_s *, int, int, char *[]))addr;
352
353                 addr = (ulong)(cmdtp->name) + gd->reloc_off;
354                 cmdtp->name = (char *)addr;
355
356                 if (cmdtp->usage) {
357                         addr = (ulong)(cmdtp->usage) + gd->reloc_off;
358                         cmdtp->usage = (char *)addr;
359                 }
360 #ifdef  CONFIG_SYS_LONGHELP
361                 if (cmdtp->help) {
362                         addr = (ulong)(cmdtp->help) + gd->reloc_off;
363                         cmdtp->help = (char *)addr;
364                 }
365 #endif
366         }
367         /* there are some other pointer constants we must deal with */
368 #ifndef CONFIG_ENV_IS_NOWHERE
369         env_name_spec += gd->reloc_off;
370 #endif
371
372         bd = gd->bd;
373
374 #ifndef CONFIG_SYS_NO_FLASH
375         /* configure available FLASH banks */
376         size = flash_init();
377         display_flash_config (size);
378         bd->bi_flashsize = size;
379 #endif
380
381         bd->bi_flashstart = CONFIG_SYS_FLASH_BASE;
382 #if CONFIG_SYS_MONITOR_BASE == CONFIG_SYS_FLASH_BASE
383         bd->bi_flashoffset = monitor_flash_len; /* reserved area for U-Boot */
384 #else
385         bd->bi_flashoffset = 0;
386 #endif
387
388         /* initialize malloc() area */
389         mem_malloc_init();
390         malloc_bin_reloc();
391
392 #ifdef CONFIG_CMD_NAND
393         puts ("NAND:  ");
394         nand_init ();           /* go init the NAND */
395 #endif
396
397 #if defined(CONFIG_CMD_ONENAND)
398         onenand_init();
399 #endif
400
401         /* relocate environment function pointers etc. */
402         env_relocate();
403
404         /* board MAC address */
405         s = getenv ("ethaddr");
406         for (i = 0; i < 6; ++i) {
407                 bd->bi_enetaddr[i] = s ? simple_strtoul (s, &e, 16) : 0;
408                 if (s)
409                         s = (*e) ? e + 1 : e;
410         }
411
412         /* IP Address */
413         bd->bi_ip_addr = getenv_IPaddr("ipaddr");
414
415 #if defined(CONFIG_PCI)
416         /*
417          * Do pci configuration
418          */
419         pci_init();
420 #endif
421
422 /** leave this here (after malloc(), environment and PCI are working) **/
423         /* Initialize devices */
424         devices_init ();
425
426         jumptable_init ();
427
428         /* Initialize the console (after the relocation and devices init) */
429         console_init_r ();
430 /** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** **/
431
432         /* Initialize from environment */
433         if ((s = getenv ("loadaddr")) != NULL) {
434                 load_addr = simple_strtoul (s, NULL, 16);
435         }
436 #if defined(CONFIG_CMD_NET)
437         if ((s = getenv ("bootfile")) != NULL) {
438                 copy_filename (BootFile, s, sizeof (BootFile));
439         }
440 #endif
441
442 #ifdef CONFIG_CMD_SPI
443         puts ("SPI:   ");
444         spi_init ();            /* go init the SPI */
445         puts ("ready\n");
446 #endif
447
448 #if defined(CONFIG_MISC_INIT_R)
449         /* miscellaneous platform dependent initialisations */
450         misc_init_r ();
451 #endif
452
453 #if defined(CONFIG_CMD_NET)
454 #if defined(CONFIG_NET_MULTI)
455         puts ("Net:   ");
456 #endif
457         eth_initialize(gd->bd);
458 #endif
459
460         /* main_loop() can return to retry autoboot, if so just run it again. */
461         for (;;) {
462                 main_loop ();
463         }
464
465         /* NOTREACHED - no way out of command loop except booting */
466 }
467
468 void hang (void)
469 {
470         puts ("### ERROR ### Please RESET the board ###\n");
471         for (;;);
472 }