common: move TOTAL_MALLOC_LEN to include/common.h
[kernel/u-boot.git] / arch / m68k / lib / board.c
1 /*
2  * (C) Copyright 2003
3  * Josef Baumgartner <josef.baumgartner@telex.de>
4  *
5  * (C) Copyright 2000-2002
6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7  *
8  * See file CREDITS for list of people who contributed to this
9  * project.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License as
13  * published by the Free Software Foundation; either version 2 of
14  * the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
24  * MA 02111-1307 USA
25  */
26
27 #include <common.h>
28 #include <watchdog.h>
29 #include <command.h>
30 #include <malloc.h>
31 #include <stdio_dev.h>
32
33 #include <asm/immap.h>
34
35 #if defined(CONFIG_CMD_IDE)
36 #include <ide.h>
37 #endif
38 #if defined(CONFIG_CMD_SCSI)
39 #include <scsi.h>
40 #endif
41 #if defined(CONFIG_CMD_KGDB)
42 #include <kgdb.h>
43 #endif
44 #ifdef CONFIG_STATUS_LED
45 #include <status_led.h>
46 #endif
47 #include <net.h>
48 #include <serial.h>
49 #if defined(CONFIG_CMD_BEDBUG)
50 #include <cmd_bedbug.h>
51 #endif
52 #ifdef CONFIG_SYS_ALLOC_DPRAM
53 #include <commproc.h>
54 #endif
55 #include <version.h>
56
57 #if defined(CONFIG_HARD_I2C) || \
58     defined(CONFIG_SOFT_I2C)
59 #include <i2c.h>
60 #endif
61
62 #ifdef CONFIG_CMD_SPI
63 #include <spi.h>
64 #endif
65
66 #ifdef CONFIG_BITBANGMII
67 #include <miiphy.h>
68 #endif
69
70 #include <nand.h>
71
72 DECLARE_GLOBAL_DATA_PTR;
73
74 static char *failed = "*** failed ***\n";
75
76 #ifdef  CONFIG_PCU_E
77 extern flash_info_t flash_info[];
78 #endif
79
80 #include <environment.h>
81
82 extern ulong __init_end;
83 extern ulong _end;
84
85 extern  void timer_init(void);
86
87 #if defined(CONFIG_WATCHDOG)
88 # define INIT_FUNC_WATCHDOG_INIT        watchdog_init,
89 # define WATCHDOG_DISABLE               watchdog_disable
90
91 extern int watchdog_init(void);
92 extern int watchdog_disable(void);
93 #else
94 # define INIT_FUNC_WATCHDOG_INIT        /* undef */
95 # define WATCHDOG_DISABLE               /* undef */
96 #endif /* CONFIG_WATCHDOG */
97
98 ulong monitor_flash_len;
99
100 /************************************************************************
101  * Utilities                                                            *
102  ************************************************************************
103  */
104
105 /*
106  * All attempts to come up with a "common" initialization sequence
107  * that works for all boards and architectures failed: some of the
108  * requirements are just _too_ different. To get rid of the resulting
109  * mess of board dependend #ifdef'ed code we now make the whole
110  * initialization sequence configurable to the user.
111  *
112  * The requirements for any new initalization function is simple: it
113  * receives a pointer to the "global data" structure as it's only
114  * argument, and returns an integer return code, where 0 means
115  * "continue" and != 0 means "fatal error, hang the system".
116  */
117 typedef int (init_fnc_t) (void);
118
119 /************************************************************************
120  * Init Utilities
121  ************************************************************************
122  * Some of this code should be moved into the core functions,
123  * but let's get it working (again) first...
124  */
125
126 static int init_baudrate (void)
127 {
128         char tmp[64];   /* long enough for environment variables */
129         int i = getenv_f("baudrate", tmp, sizeof (tmp));
130
131         gd->baudrate = (i > 0)
132                         ? (int) simple_strtoul (tmp, NULL, 10)
133                         : CONFIG_BAUDRATE;
134         return (0);
135 }
136
137 /***********************************************************************/
138
139 static int init_func_ram (void)
140 {
141         int board_type = 0;     /* use dummy arg */
142         puts ("DRAM:  ");
143
144         if ((gd->ram_size = initdram (board_type)) > 0) {
145                 print_size (gd->ram_size, "\n");
146                 return (0);
147         }
148         puts (failed);
149         return (1);
150 }
151
152 /***********************************************************************/
153
154 #if defined(CONFIG_HARD_I2C) || defined(CONFIG_SOFT_I2C)
155 static int init_func_i2c (void)
156 {
157         puts ("I2C:   ");
158         i2c_init (CONFIG_SYS_I2C_SPEED, CONFIG_SYS_I2C_SLAVE);
159         puts ("ready\n");
160         return (0);
161 }
162 #endif
163
164 #if defined(CONFIG_HARD_SPI)
165 static int init_func_spi (void)
166 {
167         puts ("SPI:   ");
168         spi_init ();
169         puts ("ready\n");
170         return (0);
171 }
172 #endif
173
174 /***********************************************************************/
175
176 /************************************************************************
177  * Initialization sequence                                              *
178  ************************************************************************
179  */
180
181 init_fnc_t *init_sequence[] = {
182         get_clocks,
183         env_init,
184         init_baudrate,
185         serial_init,
186         console_init_f,
187         display_options,
188         checkcpu,
189         checkboard,
190 #if defined(CONFIG_HARD_I2C) || defined(CONFIG_SOFT_I2C)
191         init_func_i2c,
192 #endif
193 #if defined(CONFIG_HARD_SPI)
194         init_func_spi,
195 #endif
196         init_func_ram,
197 #if defined(CONFIG_SYS_DRAM_TEST)
198         testdram,
199 #endif /* CONFIG_SYS_DRAM_TEST */
200         INIT_FUNC_WATCHDOG_INIT
201         NULL,                   /* Terminate this list */
202 };
203
204
205 /************************************************************************
206  *
207  * This is the first part of the initialization sequence that is
208  * implemented in C, but still running from ROM.
209  *
210  * The main purpose is to provide a (serial) console interface as
211  * soon as possible (so we can see any error messages), and to
212  * initialize the RAM so that we can relocate the monitor code to
213  * RAM.
214  *
215  * Be aware of the restrictions: global data is read-only, BSS is not
216  * initialized, and stack space is limited to a few kB.
217  *
218  ************************************************************************
219  */
220
221 void
222 board_init_f (ulong bootflag)
223 {
224         bd_t *bd;
225         ulong len, addr, addr_sp;
226         ulong *paddr;
227         gd_t *id;
228         init_fnc_t **init_fnc_ptr;
229 #ifdef CONFIG_PRAM
230         int i;
231         ulong reg;
232         char tmp[64];           /* long enough for environment variables */
233 #endif
234
235         /* Pointer is writable since we allocated a register for it */
236         gd = (gd_t *) (CONFIG_SYS_INIT_RAM_ADDR + CONFIG_SYS_GBL_DATA_OFFSET);
237         /* compiler optimization barrier needed for GCC >= 3.4 */
238         __asm__ __volatile__("": : :"memory");
239
240         /* Clear initial global data */
241         memset ((void *) gd, 0, sizeof (gd_t));
242
243         for (init_fnc_ptr = init_sequence; *init_fnc_ptr; ++init_fnc_ptr) {
244                 if ((*init_fnc_ptr)() != 0) {
245                         hang ();
246                 }
247         }
248
249         /*
250          * Now that we have DRAM mapped and working, we can
251          * relocate the code and continue running from DRAM.
252          *
253          * Reserve memory at end of RAM for (top down in that order):
254          *      - protected RAM
255          *      - LCD framebuffer
256          *      - monitor code
257          *      - board info struct
258          */
259         len = (ulong)&_end - CONFIG_SYS_MONITOR_BASE;
260
261         addr = CONFIG_SYS_SDRAM_BASE + gd->ram_size;
262
263 #ifdef CONFIG_LOGBUFFER
264         /* reserve kernel log buffer */
265         addr -= (LOGBUFF_RESERVE);
266         debug ("Reserving %dk for kernel logbuffer at %08lx\n", LOGBUFF_LEN, addr);
267 #endif
268
269 #ifdef CONFIG_PRAM
270         /*
271          * reserve protected RAM
272          */
273         i = getenv_f("pram", tmp, sizeof (tmp));
274         reg = (i > 0) ? simple_strtoul (tmp, NULL, 10) : CONFIG_PRAM;
275         addr -= (reg << 10);            /* size is in kB */
276         debug ("Reserving %ldk for protected RAM at %08lx\n", reg, addr);
277 #endif /* CONFIG_PRAM */
278
279         /* round down to next 4 kB limit */
280         addr &= ~(4096 - 1);
281         debug ("Top of RAM usable for U-Boot at: %08lx\n", addr);
282
283 #ifdef CONFIG_LCD
284         /* reserve memory for LCD display (always full pages) */
285         addr = lcd_setmem (addr);
286         gd->fb_base = addr;
287 #endif /* CONFIG_LCD */
288
289         /*
290          * reserve memory for U-Boot code, data & bss
291          * round down to next 4 kB limit
292          */
293         addr -= len;
294         addr &= ~(4096 - 1);
295
296         debug ("Reserving %ldk for U-Boot at: %08lx\n", len >> 10, addr);
297
298         /*
299          * reserve memory for malloc() arena
300          */
301         addr_sp = addr - TOTAL_MALLOC_LEN;
302         debug ("Reserving %dk for malloc() at: %08lx\n",
303                         TOTAL_MALLOC_LEN >> 10, addr_sp);
304
305         /*
306          * (permanently) allocate a Board Info struct
307          * and a permanent copy of the "global" data
308          */
309         addr_sp -= sizeof (bd_t);
310         bd = (bd_t *) addr_sp;
311         gd->bd = bd;
312         debug ("Reserving %zu Bytes for Board Info at: %08lx\n",
313                         sizeof (bd_t), addr_sp);
314         addr_sp -= sizeof (gd_t);
315         id = (gd_t *) addr_sp;
316         debug ("Reserving %zu Bytes for Global Data at: %08lx\n",
317                         sizeof (gd_t), addr_sp);
318
319         /* Reserve memory for boot params. */
320         addr_sp -= CONFIG_SYS_BOOTPARAMS_LEN;
321         bd->bi_boot_params = addr_sp;
322         debug ("Reserving %dk for boot parameters at: %08lx\n",
323                         CONFIG_SYS_BOOTPARAMS_LEN >> 10, addr_sp);
324
325         /*
326          * Finally, we set up a new (bigger) stack.
327          *
328          * Leave some safety gap for SP, force alignment on 16 byte boundary
329          * Clear initial stack frame
330          */
331         addr_sp -= 16;
332         addr_sp &= ~0xF;
333
334         paddr = (ulong *)addr_sp;
335         *paddr-- = 0;
336         *paddr-- = 0;
337         addr_sp = (ulong)paddr;
338
339         debug ("Stack Pointer at: %08lx\n", addr_sp);
340
341         /*
342          * Save local variables to board info struct
343          */
344         bd->bi_memstart  = CONFIG_SYS_SDRAM_BASE;       /* start of  DRAM memory      */
345         bd->bi_memsize   = gd->ram_size;        /* size  of  DRAM memory in bytes */
346 #ifdef CONFIG_SYS_INIT_RAM_ADDR
347         bd->bi_sramstart = CONFIG_SYS_INIT_RAM_ADDR;    /* start of  SRAM memory        */
348         bd->bi_sramsize  = CONFIG_SYS_INIT_RAM_END;     /* size  of  SRAM memory        */
349 #endif
350         bd->bi_mbar_base = CONFIG_SYS_MBAR;             /* base of internal registers */
351
352         bd->bi_bootflags = bootflag;            /* boot / reboot flag (for LynxOS)    */
353
354         WATCHDOG_RESET ();
355         bd->bi_intfreq = gd->cpu_clk;   /* Internal Freq, in Hz */
356         bd->bi_busfreq = gd->bus_clk;   /* Bus Freq,      in Hz */
357 #ifdef CONFIG_PCI
358         bd->bi_pcifreq = gd->pci_clk;           /* PCI Freq in Hz */
359 #endif
360 #ifdef CONFIG_EXTRA_CLOCK
361         bd->bi_inpfreq = gd->inp_clk;           /* input Freq in Hz */
362         bd->bi_vcofreq = gd->vco_clk;           /* vco Freq in Hz */
363         bd->bi_flbfreq = gd->flb_clk;           /* flexbus Freq in Hz */
364 #endif
365         bd->bi_baudrate = gd->baudrate; /* Console Baudrate     */
366
367 #ifdef CONFIG_SYS_EXTBDINFO
368         strncpy (bd->bi_s_version, "1.2", sizeof (bd->bi_s_version));
369         strncpy (bd->bi_r_version, U_BOOT_VERSION, sizeof (bd->bi_r_version));
370 #endif
371
372         WATCHDOG_RESET ();
373
374 #ifdef CONFIG_POST
375         post_bootmode_init();
376         post_run (NULL, POST_ROM | post_bootmode_get(0));
377 #endif
378
379         WATCHDOG_RESET();
380
381         memcpy (id, (void *)gd, sizeof (gd_t));
382
383         debug ("Start relocate of code from %08x to %08lx\n", CONFIG_SYS_MONITOR_BASE, addr);
384         relocate_code (addr_sp, id, addr);
385
386         /* NOTREACHED - jump_to_ram() does not return */
387 }
388
389 /************************************************************************
390  *
391  * This is the next part if the initialization sequence: we are now
392  * running from RAM and have a "normal" C environment, i. e. global
393  * data can be written, BSS has been cleared, the stack size in not
394  * that critical any more, etc.
395  *
396  ************************************************************************
397  */
398 void board_init_r (gd_t *id, ulong dest_addr)
399 {
400         cmd_tbl_t *cmdtp;
401         char *s;
402         bd_t *bd;
403         extern void malloc_bin_reloc (void);
404
405 #ifndef CONFIG_ENV_IS_NOWHERE
406         extern char * env_name_spec;
407 #endif
408 #ifndef CONFIG_SYS_NO_FLASH
409         ulong flash_size;
410 #endif
411         gd = id;                /* initialize RAM version of global data */
412         bd = gd->bd;
413
414         gd->flags |= GD_FLG_RELOC;      /* tell others: relocation done */
415
416 #ifdef CONFIG_SERIAL_MULTI
417         serial_initialize();
418 #endif
419
420         debug ("Now running in RAM - U-Boot at: %08lx\n", dest_addr);
421
422         WATCHDOG_RESET ();
423
424         gd->reloc_off =  dest_addr - CONFIG_SYS_MONITOR_BASE;
425
426         monitor_flash_len = (ulong)&__init_end - dest_addr;
427
428 #if !defined(CONFIG_RELOC_FIXUP_WORKS)
429         /*
430          * We have to relocate the command table manually
431          */
432         fixup_cmdtable(&__u_boot_cmd_start,
433                 (ulong)(&__u_boot_cmd_end - &__u_boot_cmd_start));
434 #endif /* !defined(CONFIG_RELOC_FIXUP_WORKS) */
435
436         /* there are some other pointer constants we must deal with */
437 #ifndef CONFIG_ENV_IS_NOWHERE
438         env_name_spec += gd->reloc_off;
439 #endif
440
441         WATCHDOG_RESET ();
442
443 #ifdef CONFIG_LOGBUFFER
444         logbuff_init_ptrs ();
445 #endif
446 #ifdef CONFIG_POST
447         post_output_backlog ();
448         post_reloc ();
449 #endif
450         WATCHDOG_RESET();
451
452 #if 0
453         /* instruction cache enabled in cpu_init_f() for faster relocation */
454         icache_enable ();       /* it's time to enable the instruction cache */
455 #endif
456
457         /*
458          * Setup trap handlers
459          */
460         trap_init (CONFIG_SYS_SDRAM_BASE);
461
462         /* The Malloc area is immediately below the monitor copy in DRAM */
463         mem_malloc_init (CONFIG_SYS_MONITOR_BASE + gd->reloc_off -
464                         TOTAL_MALLOC_LEN, TOTAL_MALLOC_LEN);
465         malloc_bin_reloc ();
466
467 #if !defined(CONFIG_SYS_NO_FLASH)
468         puts ("FLASH: ");
469
470         if ((flash_size = flash_init ()) > 0) {
471 # ifdef CONFIG_SYS_FLASH_CHECKSUM
472                 print_size (flash_size, "");
473                 /*
474                  * Compute and print flash CRC if flashchecksum is set to 'y'
475                  *
476                  * NOTE: Maybe we should add some WATCHDOG_RESET()? XXX
477                  */
478                 s = getenv ("flashchecksum");
479                 if (s && (*s == 'y')) {
480                         printf ("  CRC: %08X",
481                                         crc32 (0,
482                                                    (const unsigned char *) CONFIG_SYS_FLASH_BASE,
483                                                    flash_size)
484                                         );
485                 }
486                 putc ('\n');
487 # else  /* !CONFIG_SYS_FLASH_CHECKSUM */
488                 print_size (flash_size, "\n");
489 # endif /* CONFIG_SYS_FLASH_CHECKSUM */
490         } else {
491                 puts (failed);
492                 hang ();
493         }
494
495         bd->bi_flashstart = CONFIG_SYS_FLASH_BASE;      /* update start of FLASH memory    */
496         bd->bi_flashsize = flash_size;  /* size of FLASH memory (final value) */
497         bd->bi_flashoffset = 0;
498 #else   /* CONFIG_SYS_NO_FLASH */
499         bd->bi_flashsize = 0;
500         bd->bi_flashstart = 0;
501         bd->bi_flashoffset = 0;
502 #endif /* !CONFIG_SYS_NO_FLASH */
503
504         WATCHDOG_RESET ();
505
506         /* initialize higher level parts of CPU like time base and timers */
507         cpu_init_r ();
508
509         WATCHDOG_RESET ();
510
511 #ifdef CONFIG_SPI
512 # if !defined(CONFIG_ENV_IS_IN_EEPROM)
513         spi_init_f ();
514 # endif
515         spi_init_r ();
516 #endif
517
518         /* relocate environment function pointers etc. */
519         env_relocate ();
520
521         /*
522          * Fill in missing fields of bd_info.
523          * We do this here, where we have "normal" access to the
524          * environment; we used to do this still running from ROM,
525          * where had to use getenv_f(), which can be pretty slow when
526          * the environment is in EEPROM.
527          */
528         bd->bi_ip_addr = getenv_IPaddr ("ipaddr");
529
530         WATCHDOG_RESET ();
531
532 #if defined(CONFIG_PCI)
533         /*
534          * Do pci configuration
535          */
536         pci_init ();
537 #endif
538
539         /** leave this here (after malloc(), environment and PCI are working) **/
540         /* Initialize stdio devices */
541         stdio_init ();
542
543         /* Initialize the jump table for applications */
544         jumptable_init ();
545
546         /* Initialize the console (after the relocation and devices init) */
547         console_init_r ();
548
549 #if defined(CONFIG_MISC_INIT_R)
550         /* miscellaneous platform dependent initialisations */
551         misc_init_r ();
552 #endif
553
554 #if defined(CONFIG_CMD_KGDB)
555         WATCHDOG_RESET ();
556         puts ("KGDB:  ");
557         kgdb_init ();
558 #endif
559
560         debug ("U-Boot relocated to %08lx\n", dest_addr);
561
562         /*
563          * Enable Interrupts
564          */
565         interrupt_init ();
566
567         /* Must happen after interrupts are initialized since
568          * an irq handler gets installed
569          */
570         timer_init();
571
572 #ifdef CONFIG_SERIAL_SOFTWARE_FIFO
573         serial_buffered_init();
574 #endif
575
576 #ifdef CONFIG_STATUS_LED
577         status_led_set (STATUS_LED_BOOT, STATUS_LED_BLINKING);
578 #endif
579
580         udelay (20);
581
582         set_timer (0);
583
584         /* Insert function pointers now that we have relocated the code */
585
586         /* Initialize from environment */
587         if ((s = getenv ("loadaddr")) != NULL) {
588                 load_addr = simple_strtoul (s, NULL, 16);
589         }
590 #if defined(CONFIG_CMD_NET)
591         if ((s = getenv ("bootfile")) != NULL) {
592                 copy_filename (BootFile, s, sizeof (BootFile));
593         }
594 #endif
595
596         WATCHDOG_RESET ();
597
598 #if defined(CONFIG_CMD_DOC)
599         WATCHDOG_RESET ();
600         puts ("DOC:   ");
601         doc_init ();
602 #endif
603
604 #if defined(CONFIG_CMD_NAND)
605         WATCHDOG_RESET ();
606         puts ("NAND:  ");
607         nand_init();            /* go init the NAND */
608 #endif
609
610 #ifdef CONFIG_BITBANGMII
611         bb_miiphy_init();
612 #endif
613 #if defined(CONFIG_CMD_NET)
614         WATCHDOG_RESET();
615 #if defined(FEC_ENET)
616         eth_init(bd);
617 #endif
618 #if defined(CONFIG_NET_MULTI)
619         puts ("Net:   ");
620         eth_initialize (bd);
621 #endif
622 #endif
623
624 #ifdef CONFIG_POST
625         post_run (NULL, POST_RAM | post_bootmode_get(0));
626 #endif
627
628 #if defined(CONFIG_CMD_PCMCIA) \
629     && !defined(CONFIG_CMD_IDE)
630         WATCHDOG_RESET ();
631         puts ("PCMCIA:");
632         pcmcia_init ();
633 #endif
634
635 #if defined(CONFIG_CMD_IDE)
636         WATCHDOG_RESET ();
637         puts ("IDE:   ");
638         ide_init ();
639 #endif
640
641 #ifdef CONFIG_LAST_STAGE_INIT
642         WATCHDOG_RESET ();
643         /*
644          * Some parts can be only initialized if all others (like
645          * Interrupts) are up and running (i.e. the PC-style ISA
646          * keyboard).
647          */
648         last_stage_init ();
649 #endif
650
651 #if defined(CONFIG_CMD_BEDBUG)
652         WATCHDOG_RESET ();
653         bedbug_init ();
654 #endif
655
656 #if defined(CONFIG_PRAM) || defined(CONFIG_LOGBUFFER)
657         /*
658          * Export available size of memory for Linux,
659          * taking into account the protected RAM at top of memory
660          */
661         {
662                 ulong pram;
663                 char memsz[32];
664 #ifdef CONFIG_PRAM
665                 char *s;
666
667                 if ((s = getenv ("pram")) != NULL) {
668                         pram = simple_strtoul (s, NULL, 10);
669                 } else {
670                         pram = CONFIG_PRAM;
671                 }
672 #else
673                 pram=0;
674 #endif
675 #ifdef CONFIG_LOGBUFFER
676                 /* Also take the logbuffer into account (pram is in kB) */
677                 pram += (LOGBUFF_LEN+LOGBUFF_OVERHEAD)/1024;
678 #endif
679                 sprintf (memsz, "%ldk", (bd->bi_memsize / 1024) - pram);
680                 setenv ("mem", memsz);
681         }
682 #endif
683
684 #ifdef CONFIG_MODEM_SUPPORT
685  {
686          extern int do_mdm_init;
687          do_mdm_init = gd->do_mdm_init;
688  }
689 #endif
690
691 #ifdef CONFIG_WATCHDOG
692         /* disable watchdog if environment is set */
693         if ((s = getenv ("watchdog")) != NULL) {
694                 if (strncmp (s, "off", 3) == 0) {
695                         WATCHDOG_DISABLE ();
696                 }
697         }
698 #endif /* CONFIG_WATCHDOG*/
699
700
701         /* Initialization complete - start the monitor */
702
703         /* main_loop() can return to retry autoboot, if so just run it again. */
704         for (;;) {
705                 WATCHDOG_RESET ();
706                 main_loop ();
707         }
708
709         /* NOTREACHED - no way out of command loop except booting */
710 }
711
712
713 void hang(void)
714 {
715         puts ("### ERROR ### Please RESET the board ###\n");
716         for (;;);
717 }