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