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