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