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