* Patch by Yuli Barcohen, 09 Jun 2004:
[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 <version.h>
29 #include <net.h>
30 #include <environment.h>
31
32 #if ( ((CFG_ENV_ADDR+CFG_ENV_SIZE) < CFG_MONITOR_BASE) || \
33       (CFG_ENV_ADDR >= (CFG_MONITOR_BASE + CFG_MONITOR_LEN)) ) || \
34     defined(CFG_ENV_IS_IN_NVRAM)
35 #define TOTAL_MALLOC_LEN        (CFG_MALLOC_LEN + CFG_ENV_SIZE)
36 #else
37 #define TOTAL_MALLOC_LEN        CFG_MALLOC_LEN
38 #endif
39
40 #undef DEBUG
41
42 extern int timer_init(void);
43
44 extern int incaip_set_cpuclk(void);
45
46 extern ulong uboot_end_data;
47 extern ulong uboot_end;
48
49 ulong monitor_flash_len;
50
51 const char version_string[] =
52         U_BOOT_VERSION" (" __DATE__ " - " __TIME__ ")";
53
54 static char *failed = "*** failed ***\n";
55
56 /*
57  * Begin and End of memory area for malloc(), and current "brk"
58  */
59 static ulong mem_malloc_start;
60 static ulong mem_malloc_end;
61 static ulong mem_malloc_brk;
62
63
64 /*
65  * The Malloc area is immediately below the monitor copy in DRAM
66  */
67 static void mem_malloc_init (void)
68 {
69         DECLARE_GLOBAL_DATA_PTR;
70
71         ulong dest_addr = CFG_MONITOR_BASE + gd->reloc_off;
72
73         mem_malloc_end = dest_addr;
74         mem_malloc_start = dest_addr - TOTAL_MALLOC_LEN;
75         mem_malloc_brk = mem_malloc_start;
76
77         memset ((void *) mem_malloc_start,
78                 0,
79                 mem_malloc_end - mem_malloc_start);
80 }
81
82 void *sbrk (ptrdiff_t increment)
83 {
84         ulong old = mem_malloc_brk;
85         ulong new = old + increment;
86
87         if ((new < mem_malloc_start) || (new > mem_malloc_end)) {
88                 return (NULL);
89         }
90         mem_malloc_brk = new;
91         return ((void *) old);
92 }
93
94
95 static int init_func_ram (void)
96 {
97         DECLARE_GLOBAL_DATA_PTR;
98
99 #ifdef  CONFIG_BOARD_TYPES
100         int board_type = gd->board_type;
101 #else
102         int board_type = 0;     /* use dummy arg */
103 #endif
104         puts ("DRAM:  ");
105
106         if ((gd->ram_size = initdram (board_type)) > 0) {
107                 print_size (gd->ram_size, "\n");
108                 return (0);
109         }
110         puts (failed);
111         return (1);
112 }
113
114 static int display_banner(void)
115 {
116
117         printf ("\n\n%s\n\n", version_string);
118         return (0);
119 }
120
121 static void display_flash_config(ulong size)
122 {
123         puts ("Flash: ");
124         print_size (size, "\n");
125 }
126
127
128 static int init_baudrate (void)
129 {
130         DECLARE_GLOBAL_DATA_PTR;
131
132         uchar tmp[64];  /* long enough for environment variables */
133         int i = getenv_r ("baudrate", tmp, sizeof (tmp));
134
135         gd->baudrate = (i > 0)
136                         ? (int) simple_strtoul (tmp, NULL, 10)
137                         : CONFIG_BAUDRATE;
138
139         return (0);
140 }
141
142
143 /*
144  * Breath some life into the board...
145  *
146  * The first part of initialization is running from Flash memory;
147  * its main purpose is to initialize the RAM so that we
148  * can relocate the monitor code to RAM.
149  */
150
151 /*
152  * All attempts to come up with a "common" initialization sequence
153  * that works for all boards and architectures failed: some of the
154  * requirements are just _too_ different. To get rid of the resulting
155  * mess of board dependend #ifdef'ed code we now make the whole
156  * initialization sequence configurable to the user.
157  *
158  * The requirements for any new initalization function is simple: it
159  * receives a pointer to the "global data" structure as it's only
160  * argument, and returns an integer return code, where 0 means
161  * "continue" and != 0 means "fatal error, hang the system".
162  */
163 typedef int (init_fnc_t) (void);
164
165 init_fnc_t *init_sequence[] = {
166         timer_init,
167         env_init,               /* initialize environment */
168 #ifdef CONFIG_INCA_IP
169         incaip_set_cpuclk,      /* set cpu clock according to environment variable */
170 #endif
171         init_baudrate,          /* initialze baudrate settings */
172         serial_init,            /* serial communications setup */
173         console_init_f,
174         display_banner,         /* say that we are here */
175         checkboard,
176         init_func_ram,
177         NULL,
178 };
179
180
181 void board_init_f(ulong bootflag)
182 {
183         DECLARE_GLOBAL_DATA_PTR;
184
185         gd_t gd_data, *id;
186         bd_t *bd;
187         init_fnc_t **init_fnc_ptr;
188         ulong addr, addr_sp, len = (ulong)&uboot_end - CFG_MONITOR_BASE;
189 #ifdef CONFIG_PURPLE
190         void copy_code (ulong);
191 #endif
192
193         /* Pointer is writable since we allocated a register for it.
194          */
195         gd = &gd_data;
196         memset ((void *)gd, 0, sizeof (gd_t));
197
198         for (init_fnc_ptr = init_sequence; *init_fnc_ptr; ++init_fnc_ptr) {
199                 if ((*init_fnc_ptr)() != 0) {
200                         hang ();
201                 }
202         }
203
204         /*
205          * Now that we have DRAM mapped and working, we can
206          * relocate the code and continue running from DRAM.
207          */
208         addr = CFG_SDRAM_BASE + gd->ram_size;
209
210         /* We can reserve some RAM "on top" here.
211          */
212
213         /* round down to next 4 kB limit.
214          */
215         addr &= ~(4096 - 1);
216         debug ("Top of RAM usable for U-Boot at: %08lx\n", addr);
217
218         /* Reserve memory for U-Boot code, data & bss
219          * round down to next 16 kB limit
220          */
221         addr -= len;
222         addr &= ~(16 * 1024 - 1);
223
224         debug ("Reserving %ldk for U-Boot at: %08lx\n", len >> 10, addr);
225
226          /* Reserve memory for malloc() arena.
227          */
228         addr_sp = addr - TOTAL_MALLOC_LEN;
229         debug ("Reserving %dk for malloc() at: %08lx\n",
230                         TOTAL_MALLOC_LEN >> 10, addr_sp);
231
232         /*
233          * (permanently) allocate a Board Info struct
234          * and a permanent copy of the "global" data
235          */
236         addr_sp -= sizeof(bd_t);
237         bd = (bd_t *)addr_sp;
238         gd->bd = bd;
239         debug ("Reserving %d Bytes for Board Info at: %08lx\n",
240                         sizeof(bd_t), addr_sp);
241
242         addr_sp -= sizeof(gd_t);
243         id = (gd_t *)addr_sp;
244         debug ("Reserving %d Bytes for Global Data at: %08lx\n",
245                         sizeof (gd_t), addr_sp);
246
247         /* Reserve memory for boot params.
248          */
249         addr_sp -= CFG_BOOTPARAMS_LEN;
250         bd->bi_boot_params = addr_sp;
251         debug ("Reserving %dk for boot params() at: %08lx\n",
252                         CFG_BOOTPARAMS_LEN >> 10, addr_sp);
253
254         /*
255          * Finally, we set up a new (bigger) stack.
256          *
257          * Leave some safety gap for SP, force alignment on 16 byte boundary
258          * Clear initial stack frame
259          */
260         addr_sp -= 16;
261         addr_sp &= ~0xF;
262         *((ulong *) addr_sp)-- = 0;
263         *((ulong *) addr_sp)-- = 0;
264         debug ("Stack Pointer at: %08lx\n", addr_sp);
265
266         /*
267          * Save local variables to board info struct
268          */
269         bd->bi_memstart = CFG_SDRAM_BASE;       /* start of  DRAM memory */
270         bd->bi_memsize  = gd->ram_size;         /* size  of  DRAM memory in bytes */
271         bd->bi_baudrate = gd->baudrate;         /* Console Baudrate */
272
273         memcpy (id, (void *)gd, sizeof (gd_t));
274
275         /* On the purple board we copy the code in a special way
276          * in order to solve flash problems
277          */
278 #ifdef CONFIG_PURPLE
279         copy_code(addr);
280 #endif
281
282         relocate_code (addr_sp, id, addr);
283
284         /* NOTREACHED - relocate_code() does not return */
285 }
286 /************************************************************************
287  *
288  * This is the next part if the initialization sequence: we are now
289  * running from RAM and have a "normal" C environment, i. e. global
290  * data can be written, BSS has been cleared, the stack size in not
291  * that critical any more, etc.
292  *
293  ************************************************************************
294  */
295
296 void board_init_r (gd_t *id, ulong dest_addr)
297 {
298         DECLARE_GLOBAL_DATA_PTR;
299         cmd_tbl_t *cmdtp;
300         ulong size;
301         extern void malloc_bin_reloc (void);
302 #ifndef CFG_ENV_IS_NOWHERE
303         extern char * env_name_spec;
304 #endif
305         char *s, *e;
306         bd_t *bd;
307         int i;
308
309         gd = id;
310         gd->flags |= GD_FLG_RELOC;      /* tell others: relocation done */
311
312         debug ("Now running in RAM - U-Boot at: %08lx\n", dest_addr);
313
314         gd->reloc_off = dest_addr - CFG_MONITOR_BASE;
315
316         monitor_flash_len = (ulong)&uboot_end_data - dest_addr;
317
318         /*
319          * We have to relocate the command table manually
320          */
321         for (cmdtp = &__u_boot_cmd_start; cmdtp !=  &__u_boot_cmd_end; cmdtp++) {
322                 ulong addr;
323
324                 addr = (ulong) (cmdtp->cmd) + gd->reloc_off;
325 #if 0
326                 printf ("Command \"%s\": 0x%08lx => 0x%08lx\n",
327                                 cmdtp->name, (ulong) (cmdtp->cmd), addr);
328 #endif
329                 cmdtp->cmd =
330                         (int (*)(struct cmd_tbl_s *, int, int, char *[]))addr;
331
332                 addr = (ulong)(cmdtp->name) + gd->reloc_off;
333                 cmdtp->name = (char *)addr;
334
335                 if (cmdtp->usage) {
336                         addr = (ulong)(cmdtp->usage) + gd->reloc_off;
337                         cmdtp->usage = (char *)addr;
338                 }
339 #ifdef  CFG_LONGHELP
340                 if (cmdtp->help) {
341                         addr = (ulong)(cmdtp->help) + gd->reloc_off;
342                         cmdtp->help = (char *)addr;
343                 }
344 #endif
345         }
346         /* there are some other pointer constants we must deal with */
347 #ifndef CFG_ENV_IS_NOWHERE
348         env_name_spec += gd->reloc_off;
349 #endif
350
351         /* configure available FLASH banks */
352         size = flash_init();
353         display_flash_config (size);
354
355         bd = gd->bd;
356         bd->bi_flashstart = CFG_FLASH_BASE;
357         bd->bi_flashsize = size;
358 #if CFG_MONITOR_BASE == CFG_FLASH_BASE
359         bd->bi_flashoffset = monitor_flash_len; /* reserved area for U-Boot */
360 #else
361         bd->bi_flashoffset = 0;
362 #endif
363
364         /* initialize malloc() area */
365         mem_malloc_init();
366         malloc_bin_reloc();
367
368         /* relocate environment function pointers etc. */
369         env_relocate();
370
371         /* board MAC address */
372         s = getenv ("ethaddr");
373         for (i = 0; i < 6; ++i) {
374                 bd->bi_enetaddr[i] = s ? simple_strtoul (s, &e, 16) : 0;
375                 if (s)
376                         s = (*e) ? e + 1 : e;
377         }
378
379         /* IP Address */
380         bd->bi_ip_addr = getenv_IPaddr("ipaddr");
381
382 #if defined(CONFIG_PCI)
383         /*
384          * Do pci configuration
385          */
386         pci_init();
387 #endif
388
389 /** leave this here (after malloc(), environment and PCI are working) **/
390         /* Initialize devices */
391         devices_init ();
392
393         jumptable_init ();
394
395         /* Initialize the console (after the relocation and devices init) */
396         console_init_r ();
397 /** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** ** **/
398
399         /* Initialize from environment */
400         if ((s = getenv ("loadaddr")) != NULL) {
401                 load_addr = simple_strtoul (s, NULL, 16);
402         }
403 #if (CONFIG_COMMANDS & CFG_CMD_NET)
404         if ((s = getenv ("bootfile")) != NULL) {
405                 copy_filename (BootFile, s, sizeof (BootFile));
406         }
407 #endif  /* CFG_CMD_NET */
408
409 #if defined(CONFIG_MISC_INIT_R)
410         /* miscellaneous platform dependent initialisations */
411         misc_init_r ();
412 #endif
413
414 #if (CONFIG_COMMANDS & CFG_CMD_NET) && defined(CONFIG_NET_MULTI)
415         puts ("Net:   ");
416         eth_initialize(gd->bd);
417 #endif
418
419         /* main_loop() can return to retry autoboot, if so just run it again. */
420         for (;;) {
421                 main_loop ();
422         }
423
424         /* NOTREACHED - no way out of command loop except booting */
425 }
426
427 void hang (void)
428 {
429         puts ("### ERROR ### Please RESET the board ###\n");
430         for (;;);
431 }