1# 2# (C) Copyright 2000 - 2004 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 24Summary: 25======== 26 27This directory contains the source code for U-Boot, a boot loader for 28Embedded boards based on PowerPC, ARM, MIPS and several other 29processors, which can be installed in a boot ROM and used to 30initialize and test the hardware or to download and run application 31code. 32 33The development of U-Boot is closely related to Linux: some parts of 34the source code originate in the Linux source tree, we have some 35header files in common, and special provision has been made to 36support booting of Linux images. 37 38Some attention has been paid to make this software easily 39configurable and extendable. For instance, all monitor commands are 40implemented with the same call interface, so that it's very easy to 41add new commands. Also, instead of permanently adding rarely used 42code (for instance hardware test utilities) to the monitor, you can 43load and run it dynamically. 44 45 46Status: 47======= 48 49In general, all boards for which a configuration option exists in the 50Makefile have been tested to some extent and can be considered 51"working". In fact, many of them are used in production systems. 52 53In case of problems see the CHANGELOG and CREDITS files to find out 54who contributed the specific port. 55 56 57Where to get help: 58================== 59 60In case you have questions about, problems with or contributions for 61U-Boot you should send a message to the U-Boot mailing list at 62<u-boot-users@lists.sourceforge.net>. There is also an archive of 63previous traffic on the mailing list - please search the archive 64before asking FAQ's. Please see 65http://lists.sourceforge.net/lists/listinfo/u-boot-users/ 66 67 68Where we come from: 69=================== 70 71- start from 8xxrom sources 72- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 73- clean up code 74- make it easier to add custom boards 75- make it possible to add other [PowerPC] CPUs 76- extend functions, especially: 77 * Provide extended interface to Linux boot loader 78 * S-Record download 79 * network boot 80 * PCMCIA / CompactFLash / ATA disk / SCSI ... boot 81- create ARMBoot project (http://sourceforge.net/projects/armboot) 82- add other CPU families (starting with ARM) 83- create U-Boot project (http://sourceforge.net/projects/u-boot) 84 85 86Names and Spelling: 87=================== 88 89The "official" name of this project is "Das U-Boot". The spelling 90"U-Boot" shall be used in all written text (documentation, comments 91in source files etc.). Example: 92 93 This is the README file for the U-Boot project. 94 95File names etc. shall be based on the string "u-boot". Examples: 96 97 include/asm-ppc/u-boot.h 98 99 #include <asm/u-boot.h> 100 101Variable names, preprocessor constants etc. shall be either based on 102the string "u_boot" or on "U_BOOT". Example: 103 104 U_BOOT_VERSION u_boot_logo 105 IH_OS_U_BOOT u_boot_hush_start 106 107 108Versioning: 109=========== 110 111U-Boot uses a 3 level version number containing a version, a 112sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2", 113sub-version "34", and patchlevel "4". 114 115The patchlevel is used to indicate certain stages of development 116between released versions, i. e. officially released versions of 117U-Boot will always have a patchlevel of "0". 118 119 120Directory Hierarchy: 121==================== 122 123- board Board dependent files 124- common Misc architecture independent functions 125- cpu CPU specific files 126 - 74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 127 - arm720t Files specific to ARM 720 CPUs 128 - arm920t Files specific to ARM 920 CPUs 129 - imx Files specific to Freescale MC9328 i.MX CPUs 130 - s3c24x0 Files specific to Samsung S3C24X0 CPUs 131 - arm925t Files specific to ARM 925 CPUs 132 - arm926ejs Files specific to ARM 926 CPUs 133 - at91rm9200 Files specific to Atmel AT91RM9200 CPUs 134 - i386 Files specific to i386 CPUs 135 - ixp Files specific to Intel XScale IXP CPUs 136 - mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 137 - mips Files specific to MIPS CPUs 138 - mpc5xx Files specific to Freescale MPC5xx CPUs 139 - mpc5xxx Files specific to Freescale MPC5xxx CPUs 140 - mpc8xx Files specific to Freescale MPC8xx CPUs 141 - mpc8220 Files specific to Freescale MPC8220 CPUs 142 - mpc824x Files specific to Freescale MPC824x CPUs 143 - mpc8260 Files specific to Freescale MPC8260 CPUs 144 - mpc85xx Files specific to Freescale MPC85xx CPUs 145 - nios Files specific to Altera NIOS CPUs 146 - nios2 Files specific to Altera Nios-II CPUs 147 - ppc4xx Files specific to IBM PowerPC 4xx CPUs 148 - pxa Files specific to Intel XScale PXA CPUs 149 - s3c44b0 Files specific to Samsung S3C44B0 CPUs 150 - sa1100 Files specific to Intel StrongARM SA1100 CPUs 151- disk Code for disk drive partition handling 152- doc Documentation (don't expect too much) 153- drivers Commonly used device drivers 154- dtt Digital Thermometer and Thermostat drivers 155- examples Example code for standalone applications, etc. 156- include Header Files 157- lib_arm Files generic to ARM architecture 158- lib_generic Files generic to all architectures 159- lib_i386 Files generic to i386 architecture 160- lib_m68k Files generic to m68k architecture 161- lib_mips Files generic to MIPS architecture 162- lib_nios Files generic to NIOS architecture 163- lib_ppc Files generic to PowerPC architecture 164- net Networking code 165- post Power On Self Test 166- rtc Real Time Clock drivers 167- tools Tools to build S-Record or U-Boot images, etc. 168 169Software Configuration: 170======================= 171 172Configuration is usually done using C preprocessor defines; the 173rationale behind that is to avoid dead code whenever possible. 174 175There are two classes of configuration variables: 176 177* Configuration _OPTIONS_: 178 These are selectable by the user and have names beginning with 179 "CONFIG_". 180 181* Configuration _SETTINGS_: 182 These depend on the hardware etc. and should not be meddled with if 183 you don't know what you're doing; they have names beginning with 184 "CFG_". 185 186Later we will add a configuration tool - probably similar to or even 187identical to what's used for the Linux kernel. Right now, we have to 188do the configuration by hand, which means creating some symbolic 189links and editing some configuration files. We use the TQM8xxL boards 190as an example here. 191 192 193Selection of Processor Architecture and Board Type: 194--------------------------------------------------- 195 196For all supported boards there are ready-to-use default 197configurations available; just type "make <board_name>_config". 198 199Example: For a TQM823L module type: 200 201 cd u-boot 202 make TQM823L_config 203 204For the Cogent platform, you need to specify the cpu type as well; 205e.g. "make cogent_mpc8xx_config". And also configure the cogent 206directory according to the instructions in cogent/README. 207 208 209Configuration Options: 210---------------------- 211 212Configuration depends on the combination of board and CPU type; all 213such information is kept in a configuration file 214"include/configs/<board_name>.h". 215 216Example: For a TQM823L module, all configuration settings are in 217"include/configs/TQM823L.h". 218 219 220Many of the options are named exactly as the corresponding Linux 221kernel configuration options. The intention is to make it easier to 222build a config tool - later. 223 224 225The following options need to be configured: 226 227- CPU Type: Define exactly one of 228 229 PowerPC based CPUs: 230 ------------------- 231 CONFIG_MPC823, CONFIG_MPC850, CONFIG_MPC855, CONFIG_MPC860 232 or CONFIG_MPC5xx 233 or CONFIG_MPC8220 234 or CONFIG_MPC824X, CONFIG_MPC8260 235 or CONFIG_MPC85xx 236 or CONFIG_IOP480 237 or CONFIG_405GP 238 or CONFIG_405EP 239 or CONFIG_440 240 or CONFIG_MPC74xx 241 or CONFIG_750FX 242 243 ARM based CPUs: 244 --------------- 245 CONFIG_SA1110 246 CONFIG_ARM7 247 CONFIG_PXA250 248 249 MicroBlaze based CPUs: 250 ---------------------- 251 CONFIG_MICROBLAZE 252 253 Nios-2 based CPUs: 254 ---------------------- 255 CONFIG_NIOS2 256 257 258- Board Type: Define exactly one of 259 260 PowerPC based boards: 261 --------------------- 262 263 CONFIG_ADCIOP CONFIG_GEN860T CONFIG_PCI405 264 CONFIG_ADS860 CONFIG_GENIETV CONFIG_PCIPPC2 265 CONFIG_AMX860 CONFIG_GTH CONFIG_PCIPPC6 266 CONFIG_AR405 CONFIG_gw8260 CONFIG_pcu_e 267 CONFIG_BAB7xx CONFIG_hermes CONFIG_PIP405 268 CONFIG_c2mon CONFIG_hymod CONFIG_PM826 269 CONFIG_CANBT CONFIG_IAD210 CONFIG_ppmc8260 270 CONFIG_CCM CONFIG_ICU862 CONFIG_QS823 271 CONFIG_CMI CONFIG_IP860 CONFIG_QS850 272 CONFIG_cogent_mpc8260 CONFIG_IPHASE4539 CONFIG_QS860T 273 CONFIG_cogent_mpc8xx CONFIG_IVML24 CONFIG_RBC823 274 CONFIG_CPCI405 CONFIG_IVML24_128 CONFIG_RPXClassic 275 CONFIG_CPCI4052 CONFIG_IVML24_256 CONFIG_RPXlite 276 CONFIG_CPCIISER4 CONFIG_IVMS8 CONFIG_RPXsuper 277 CONFIG_CPU86 CONFIG_IVMS8_128 CONFIG_rsdproto 278 CONFIG_CRAYL1 CONFIG_IVMS8_256 CONFIG_sacsng 279 CONFIG_CSB272 CONFIG_JSE CONFIG_Sandpoint8240 280 CONFIG_CU824 CONFIG_LANTEC CONFIG_Sandpoint8245 281 CONFIG_DASA_SIM CONFIG_lwmon CONFIG_sbc8260 282 CONFIG_DB64360 CONFIG_MBX CONFIG_sbc8560 283 CONFIG_DB64460 CONFIG_MBX860T CONFIG_SM850 284 CONFIG_DU405 CONFIG_MHPC CONFIG_SPD823TS 285 CONFIG_DUET_ADS CONFIG_MIP405 CONFIG_STXGP3 286 CONFIG_EBONY CONFIG_MOUSSE CONFIG_SXNI855T 287 CONFIG_ELPPC CONFIG_MPC8260ADS CONFIG_TQM823L 288 CONFIG_ELPT860 CONFIG_MPC8540ADS CONFIG_TQM8260 289 CONFIG_ep8260 CONFIG_MPC8560ADS CONFIG_TQM850L 290 CONFIG_ERIC CONFIG_MUSENKI CONFIG_TQM855L 291 CONFIG_ESTEEM192E CONFIG_MVS1 CONFIG_TQM860L 292 CONFIG_ETX094 CONFIG_NETPHONE CONFIG_TTTech 293 CONFIG_EVB64260 CONFIG_NETTA CONFIG_UTX8245 294 CONFIG_FADS823 CONFIG_NETVIA CONFIG_V37 295 CONFIG_FADS850SAR CONFIG_NX823 CONFIG_W7OLMC 296 CONFIG_FADS860T CONFIG_OCRTC CONFIG_W7OLMG 297 CONFIG_FLAGADM CONFIG_ORSG CONFIG_WALNUT405 298 CONFIG_FPS850L CONFIG_OXC CONFIG_ZPC1900 299 CONFIG_FPS860L CONFIG_ZUMA 300 301 ARM based boards: 302 ----------------- 303 304 CONFIG_AT91RM9200DK, CONFIG_CERF250, CONFIG_DNP1110, 305 CONFIG_EP7312, CONFIG_H2_OMAP1610, CONFIG_HHP_CRADLE, 306 CONFIG_IMPA7, CONFIG_INNOVATOROMAP1510, CONFIG_INNOVATOROMAP1610, 307 CONFIG_LART, CONFIG_LPD7A400 CONFIG_LUBBOCK, 308 CONFIG_OSK_OMAP5912, CONFIG_SHANNON, CONFIG_P2_OMAP730, 309 CONFIG_SMDK2400, CONFIG_SMDK2410, CONFIG_TRAB, 310 CONFIG_VCMA9 311 312 MicroBlaze based boards: 313 ------------------------ 314 315 CONFIG_SUZAKU 316 317 Nios-2 based boards: 318 ------------------------ 319 320 CONFIG_PCI5441 CONFIG_PK1C20 321 322 323- CPU Module Type: (if CONFIG_COGENT is defined) 324 Define exactly one of 325 CONFIG_CMA286_60_OLD 326--- FIXME --- not tested yet: 327 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 328 CONFIG_CMA287_23, CONFIG_CMA287_50 329 330- Motherboard Type: (if CONFIG_COGENT is defined) 331 Define exactly one of 332 CONFIG_CMA101, CONFIG_CMA102 333 334- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 335 Define one or more of 336 CONFIG_CMA302 337 338- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 339 Define one or more of 340 CONFIG_LCD_HEARTBEAT - update a character position on 341 the lcd display every second with 342 a "rotator" |\-/|\-/ 343 344- Board flavour: (if CONFIG_MPC8260ADS is defined) 345 CONFIG_ADSTYPE 346 Possible values are: 347 CFG_8260ADS - original MPC8260ADS 348 CFG_8266ADS - MPC8266ADS 349 CFG_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 350 CFG_8272ADS - MPC8272ADS 351 352- MPC824X Family Member (if CONFIG_MPC824X is defined) 353 Define exactly one of 354 CONFIG_MPC8240, CONFIG_MPC8245 355 356- 8xx CPU Options: (if using an MPC8xx cpu) 357 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 358 get_gclk_freq() cannot work 359 e.g. if there is no 32KHz 360 reference PIT/RTC clock 361 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 362 or XTAL/EXTAL) 363 364- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 365 CFG_8xx_CPUCLK_MIN 366 CFG_8xx_CPUCLK_MAX 367 CONFIG_8xx_CPUCLK_DEFAULT 368 See doc/README.MPC866 369 370 CFG_MEASURE_CPUCLK 371 372 Define this to measure the actual CPU clock instead 373 of relying on the correctness of the configured 374 values. Mostly useful for board bringup to make sure 375 the PLL is locked at the intended frequency. Note 376 that this requires a (stable) reference clock (32 kHz 377 RTC clock or CFG_8XX_XIN) 378 379- Linux Kernel Interface: 380 CONFIG_CLOCKS_IN_MHZ 381 382 U-Boot stores all clock information in Hz 383 internally. For binary compatibility with older Linux 384 kernels (which expect the clocks passed in the 385 bd_info data to be in MHz) the environment variable 386 "clocks_in_mhz" can be defined so that U-Boot 387 converts clock data to MHZ before passing it to the 388 Linux kernel. 389 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 390 "clocks_in_mhz=1" is automatically included in the 391 default environment. 392 393 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 394 395 When transfering memsize parameter to linux, some versions 396 expect it to be in bytes, others in MB. 397 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 398 399- Serial Ports: 400 CFG_PL010_SERIAL 401 402 Define this if you want support for Amba PrimeCell PL010 UARTs. 403 404 CFG_PL011_SERIAL 405 406 Define this if you want support for Amba PrimeCell PL011 UARTs. 407 408 CONFIG_PL011_CLOCK 409 410 If you have Amba PrimeCell PL011 UARTs, set this variable to 411 the clock speed of the UARTs. 412 413 CONFIG_PL01x_PORTS 414 415 If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 416 define this to a list of base addresses for each (supported) 417 port. See e.g. include/configs/versatile.h 418 419 420- Console Interface: 421 Depending on board, define exactly one serial port 422 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 423 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 424 console by defining CONFIG_8xx_CONS_NONE 425 426 Note: if CONFIG_8xx_CONS_NONE is defined, the serial 427 port routines must be defined elsewhere 428 (i.e. serial_init(), serial_getc(), ...) 429 430 CONFIG_CFB_CONSOLE 431 Enables console device for a color framebuffer. Needs following 432 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 433 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 434 (default big endian) 435 VIDEO_HW_RECTFILL graphic chip supports 436 rectangle fill 437 (cf. smiLynxEM) 438 VIDEO_HW_BITBLT graphic chip supports 439 bit-blit (cf. smiLynxEM) 440 VIDEO_VISIBLE_COLS visible pixel columns 441 (cols=pitch) 442 VIDEO_VISIBLE_ROWS visible pixel rows 443 VIDEO_PIXEL_SIZE bytes per pixel 444 VIDEO_DATA_FORMAT graphic data format 445 (0-5, cf. cfb_console.c) 446 VIDEO_FB_ADRS framebuffer address 447 VIDEO_KBD_INIT_FCT keyboard int fct 448 (i.e. i8042_kbd_init()) 449 VIDEO_TSTC_FCT test char fct 450 (i.e. i8042_tstc) 451 VIDEO_GETC_FCT get char fct 452 (i.e. i8042_getc) 453 CONFIG_CONSOLE_CURSOR cursor drawing on/off 454 (requires blink timer 455 cf. i8042.c) 456 CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 457 CONFIG_CONSOLE_TIME display time/date info in 458 upper right corner 459 (requires CFG_CMD_DATE) 460 CONFIG_VIDEO_LOGO display Linux logo in 461 upper left corner 462 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 463 linux_logo.h for logo. 464 Requires CONFIG_VIDEO_LOGO 465 CONFIG_CONSOLE_EXTRA_INFO 466 addional board info beside 467 the logo 468 469 When CONFIG_CFB_CONSOLE is defined, video console is 470 default i/o. Serial console can be forced with 471 environment 'console=serial'. 472 473 When CONFIG_SILENT_CONSOLE is defined, all console 474 messages (by U-Boot and Linux!) can be silenced with 475 the "silent" environment variable. See 476 doc/README.silent for more information. 477 478- Console Baudrate: 479 CONFIG_BAUDRATE - in bps 480 Select one of the baudrates listed in 481 CFG_BAUDRATE_TABLE, see below. 482 CFG_BRGCLK_PRESCALE, baudrate prescale 483 484- Interrupt driven serial port input: 485 CONFIG_SERIAL_SOFTWARE_FIFO 486 487 PPC405GP only. 488 Use an interrupt handler for receiving data on the 489 serial port. It also enables using hardware handshake 490 (RTS/CTS) and UART's built-in FIFO. Set the number of 491 bytes the interrupt driven input buffer should have. 492 493 Leave undefined to disable this feature, including 494 disable the buffer and hardware handshake. 495 496- Console UART Number: 497 CONFIG_UART1_CONSOLE 498 499 IBM PPC4xx only. 500 If defined internal UART1 (and not UART0) is used 501 as default U-Boot console. 502 503- Boot Delay: CONFIG_BOOTDELAY - in seconds 504 Delay before automatically booting the default image; 505 set to -1 to disable autoboot. 506 507 See doc/README.autoboot for these options that 508 work with CONFIG_BOOTDELAY. None are required. 509 CONFIG_BOOT_RETRY_TIME 510 CONFIG_BOOT_RETRY_MIN 511 CONFIG_AUTOBOOT_KEYED 512 CONFIG_AUTOBOOT_PROMPT 513 CONFIG_AUTOBOOT_DELAY_STR 514 CONFIG_AUTOBOOT_STOP_STR 515 CONFIG_AUTOBOOT_DELAY_STR2 516 CONFIG_AUTOBOOT_STOP_STR2 517 CONFIG_ZERO_BOOTDELAY_CHECK 518 CONFIG_RESET_TO_RETRY 519 520- Autoboot Command: 521 CONFIG_BOOTCOMMAND 522 Only needed when CONFIG_BOOTDELAY is enabled; 523 define a command string that is automatically executed 524 when no character is read on the console interface 525 within "Boot Delay" after reset. 526 527 CONFIG_BOOTARGS 528 This can be used to pass arguments to the bootm 529 command. The value of CONFIG_BOOTARGS goes into the 530 environment value "bootargs". 531 532 CONFIG_RAMBOOT and CONFIG_NFSBOOT 533 The value of these goes into the environment as 534 "ramboot" and "nfsboot" respectively, and can be used 535 as a convenience, when switching between booting from 536 ram and nfs. 537 538- Pre-Boot Commands: 539 CONFIG_PREBOOT 540 541 When this option is #defined, the existence of the 542 environment variable "preboot" will be checked 543 immediately before starting the CONFIG_BOOTDELAY 544 countdown and/or running the auto-boot command resp. 545 entering interactive mode. 546 547 This feature is especially useful when "preboot" is 548 automatically generated or modified. For an example 549 see the LWMON board specific code: here "preboot" is 550 modified when the user holds down a certain 551 combination of keys on the (special) keyboard when 552 booting the systems 553 554- Serial Download Echo Mode: 555 CONFIG_LOADS_ECHO 556 If defined to 1, all characters received during a 557 serial download (using the "loads" command) are 558 echoed back. This might be needed by some terminal 559 emulations (like "cu"), but may as well just take 560 time on others. This setting #define's the initial 561 value of the "loads_echo" environment variable. 562 563- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined) 564 CONFIG_KGDB_BAUDRATE 565 Select one of the baudrates listed in 566 CFG_BAUDRATE_TABLE, see below. 567 568- Monitor Functions: 569 CONFIG_COMMANDS 570 Most monitor functions can be selected (or 571 de-selected) by adjusting the definition of 572 CONFIG_COMMANDS; to select individual functions, 573 #define CONFIG_COMMANDS by "OR"ing any of the 574 following values: 575 576 #define enables commands: 577 ------------------------- 578 CFG_CMD_ASKENV * ask for env variable 579 CFG_CMD_AUTOSCRIPT Autoscript Support 580 CFG_CMD_BDI bdinfo 581 CFG_CMD_BEDBUG * Include BedBug Debugger 582 CFG_CMD_BMP * BMP support 583 CFG_CMD_BSP * Board specific commands 584 CFG_CMD_BOOTD bootd 585 CFG_CMD_CACHE * icache, dcache 586 CFG_CMD_CONSOLE coninfo 587 CFG_CMD_DATE * support for RTC, date/time... 588 CFG_CMD_DHCP * DHCP support 589 CFG_CMD_DIAG * Diagnostics 590 CFG_CMD_DOC * Disk-On-Chip Support 591 CFG_CMD_DTT * Digital Therm and Thermostat 592 CFG_CMD_ECHO * echo arguments 593 CFG_CMD_EEPROM * EEPROM read/write support 594 CFG_CMD_ELF * bootelf, bootvx 595 CFG_CMD_ENV saveenv 596 CFG_CMD_FDC * Floppy Disk Support 597 CFG_CMD_FAT * FAT partition support 598 CFG_CMD_FDOS * Dos diskette Support 599 CFG_CMD_FLASH flinfo, erase, protect 600 CFG_CMD_FPGA FPGA device initialization support 601 CFG_CMD_HWFLOW * RTS/CTS hw flow control 602 CFG_CMD_I2C * I2C serial bus support 603 CFG_CMD_IDE * IDE harddisk support 604 CFG_CMD_IMI iminfo 605 CFG_CMD_IMLS List all found images 606 CFG_CMD_IMMAP * IMMR dump support 607 CFG_CMD_IRQ * irqinfo 608 CFG_CMD_ITEST Integer/string test of 2 values 609 CFG_CMD_JFFS2 * JFFS2 Support 610 CFG_CMD_KGDB * kgdb 611 CFG_CMD_LOADB loadb 612 CFG_CMD_LOADS loads 613 CFG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 614 loop, loopw, mtest 615 CFG_CMD_MISC Misc functions like sleep etc 616 CFG_CMD_MMC * MMC memory mapped support 617 CFG_CMD_MII * MII utility commands 618 CFG_CMD_NAND * NAND support 619 CFG_CMD_NET bootp, tftpboot, rarpboot 620 CFG_CMD_PCI * pciinfo 621 CFG_CMD_PCMCIA * PCMCIA support 622 CFG_CMD_PING * send ICMP ECHO_REQUEST to network host 623 CFG_CMD_PORTIO * Port I/O 624 CFG_CMD_REGINFO * Register dump 625 CFG_CMD_RUN run command in env variable 626 CFG_CMD_SAVES * save S record dump 627 CFG_CMD_SCSI * SCSI Support 628 CFG_CMD_SDRAM * print SDRAM configuration information 629 CFG_CMD_SETGETDCR Support for DCR Register access (4xx only) 630 CFG_CMD_SPI * SPI serial bus support 631 CFG_CMD_USB * USB support 632 CFG_CMD_VFD * VFD support (TRAB) 633 CFG_CMD_BSP * Board SPecific functions 634 CFG_CMD_CDP * Cisco Discover Protocol support 635 ----------------------------------------------- 636 CFG_CMD_ALL all 637 638 CONFIG_CMD_DFL Default configuration; at the moment 639 this is includes all commands, except 640 the ones marked with "*" in the list 641 above. 642 643 If you don't define CONFIG_COMMANDS it defaults to 644 CONFIG_CMD_DFL in include/cmd_confdefs.h. A board can 645 override the default settings in the respective 646 include file. 647 648 EXAMPLE: If you want all functions except of network 649 support you can write: 650 651 #define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET) 652 653 654 Note: Don't enable the "icache" and "dcache" commands 655 (configuration option CFG_CMD_CACHE) unless you know 656 what you (and your U-Boot users) are doing. Data 657 cache cannot be enabled on systems like the 8xx or 658 8260 (where accesses to the IMMR region must be 659 uncached), and it cannot be disabled on all other 660 systems where we (mis-) use the data cache to hold an 661 initial stack and some data. 662 663 664 XXX - this list needs to get updated! 665 666- Watchdog: 667 CONFIG_WATCHDOG 668 If this variable is defined, it enables watchdog 669 support. There must be support in the platform specific 670 code for a watchdog. For the 8xx and 8260 CPUs, the 671 SIU Watchdog feature is enabled in the SYPCR 672 register. 673 674- U-Boot Version: 675 CONFIG_VERSION_VARIABLE 676 If this variable is defined, an environment variable 677 named "ver" is created by U-Boot showing the U-Boot 678 version as printed by the "version" command. 679 This variable is readonly. 680 681- Real-Time Clock: 682 683 When CFG_CMD_DATE is selected, the type of the RTC 684 has to be selected, too. Define exactly one of the 685 following options: 686 687 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 688 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 689 CONFIG_RTC_MC146818 - use MC146818 RTC 690 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 691 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 692 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 693 CONFIG_RTC_DS164x - use Dallas DS164x RTC 694 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 695 696 Note that if the RTC uses I2C, then the I2C interface 697 must also be configured. See I2C Support, below. 698 699- Timestamp Support: 700 701 When CONFIG_TIMESTAMP is selected, the timestamp 702 (date and time) of an image is printed by image 703 commands like bootm or iminfo. This option is 704 automatically enabled when you select CFG_CMD_DATE . 705 706- Partition Support: 707 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 708 and/or CONFIG_ISO_PARTITION 709 710 If IDE or SCSI support is enabled (CFG_CMD_IDE or 711 CFG_CMD_SCSI) you must configure support for at least 712 one partition type as well. 713 714- IDE Reset method: 715 CONFIG_IDE_RESET_ROUTINE - this is defined in several 716 board configurations files but used nowhere! 717 718 CONFIG_IDE_RESET - is this is defined, IDE Reset will 719 be performed by calling the function 720 ide_set_reset(int reset) 721 which has to be defined in a board specific file 722 723- ATAPI Support: 724 CONFIG_ATAPI 725 726 Set this to enable ATAPI support. 727 728- LBA48 Support 729 CONFIG_LBA48 730 731 Set this to enable support for disks larger than 137GB 732 Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL 733 Whithout these , LBA48 support uses 32bit variables and will 'only' 734 support disks up to 2.1TB. 735 736 CFG_64BIT_LBA: 737 When enabled, makes the IDE subsystem use 64bit sector addresses. 738 Default is 32bit. 739 740- SCSI Support: 741 At the moment only there is only support for the 742 SYM53C8XX SCSI controller; define 743 CONFIG_SCSI_SYM53C8XX to enable it. 744 745 CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and 746 CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID * 747 CFG_SCSI_MAX_LUN] can be adjusted to define the 748 maximum numbers of LUNs, SCSI ID's and target 749 devices. 750 CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 751 752- NETWORK Support (PCI): 753 CONFIG_E1000 754 Support for Intel 8254x gigabit chips. 755 756 CONFIG_EEPRO100 757 Support for Intel 82557/82559/82559ER chips. 758 Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom 759 write routine for first time initialisation. 760 761 CONFIG_TULIP 762 Support for Digital 2114x chips. 763 Optional CONFIG_TULIP_SELECT_MEDIA for board specific 764 modem chip initialisation (KS8761/QS6611). 765 766 CONFIG_NATSEMI 767 Support for National dp83815 chips. 768 769 CONFIG_NS8382X 770 Support for National dp8382[01] gigabit chips. 771 772- NETWORK Support (other): 773 774 CONFIG_DRIVER_LAN91C96 775 Support for SMSC's LAN91C96 chips. 776 777 CONFIG_LAN91C96_BASE 778 Define this to hold the physical address 779 of the LAN91C96's I/O space 780 781 CONFIG_LAN91C96_USE_32_BIT 782 Define this to enable 32 bit addressing 783 784 CONFIG_DRIVER_SMC91111 785 Support for SMSC's LAN91C111 chip 786 787 CONFIG_SMC91111_BASE 788 Define this to hold the physical address 789 of the device (I/O space) 790 791 CONFIG_SMC_USE_32_BIT 792 Define this if data bus is 32 bits 793 794 CONFIG_SMC_USE_IOFUNCS 795 Define this to use i/o functions instead of macros 796 (some hardware wont work with macros) 797 798- USB Support: 799 At the moment only the UHCI host controller is 800 supported (PIP405, MIP405, MPC5200); define 801 CONFIG_USB_UHCI to enable it. 802 define CONFIG_USB_KEYBOARD to enable the USB Keyboard 803 and define CONFIG_USB_STORAGE to enable the USB 804 storage devices. 805 Note: 806 Supported are USB Keyboards and USB Floppy drives 807 (TEAC FD-05PUB). 808 MPC5200 USB requires additional defines: 809 CONFIG_USB_CLOCK 810 for 528 MHz Clock: 0x0001bbbb 811 CONFIG_USB_CONFIG 812 for differential drivers: 0x00001000 813 for single ended drivers: 0x00005000 814 815 816- MMC Support: 817 The MMC controller on the Intel PXA is supported. To 818 enable this define CONFIG_MMC. The MMC can be 819 accessed from the boot prompt by mapping the device 820 to physical memory similar to flash. Command line is 821 enabled with CFG_CMD_MMC. The MMC driver also works with 822 the FAT fs. This is enabled with CFG_CMD_FAT. 823 824- Journaling Flash filesystem support: 825 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 826 CONFIG_JFFS2_NAND_DEV 827 Define these for a default partition on a NAND device 828 829 CFG_JFFS2_FIRST_SECTOR, 830 CFG_JFFS2_FIRST_BANK, CFG_JFFS2_NUM_BANKS 831 Define these for a default partition on a NOR device 832 833 CFG_JFFS_CUSTOM_PART 834 Define this to create an own partition. You have to provide a 835 function struct part_info* jffs2_part_info(int part_num) 836 837 If you define only one JFFS2 partition you may also want to 838 #define CFG_JFFS_SINGLE_PART 1 839 to disable the command chpart. This is the default when you 840 have not defined a custom partition 841 842- Keyboard Support: 843 CONFIG_ISA_KEYBOARD 844 845 Define this to enable standard (PC-Style) keyboard 846 support 847 848 CONFIG_I8042_KBD 849 Standard PC keyboard driver with US (is default) and 850 GERMAN key layout (switch via environment 'keymap=de') support. 851 Export function i8042_kbd_init, i8042_tstc and i8042_getc 852 for cfb_console. Supports cursor blinking. 853 854- Video support: 855 CONFIG_VIDEO 856 857 Define this to enable video support (for output to 858 video). 859 860 CONFIG_VIDEO_CT69000 861 862 Enable Chips & Technologies 69000 Video chip 863 864 CONFIG_VIDEO_SMI_LYNXEM 865 Enable Silicon Motion SMI 712/710/810 Video chip. The 866 video output is selected via environment 'videoout' 867 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 868 assumed. 869 870 For the CT69000 and SMI_LYNXEM drivers, videomode is 871 selected via environment 'videomode'. Two diferent ways 872 are possible: 873 - "videomode=num" 'num' is a standard LiLo mode numbers. 874 Following standard modes are supported (* is default): 875 876 Colors 640x480 800x600 1024x768 1152x864 1280x1024 877 -------------+--------------------------------------------- 878 8 bits | 0x301* 0x303 0x305 0x161 0x307 879 15 bits | 0x310 0x313 0x316 0x162 0x319 880 16 bits | 0x311 0x314 0x317 0x163 0x31A 881 24 bits | 0x312 0x315 0x318 ? 0x31B 882 -------------+--------------------------------------------- 883 (i.e. setenv videomode 317; saveenv; reset;) 884 885 - "videomode=bootargs" all the video parameters are parsed 886 from the bootargs. (See drivers/videomodes.c) 887 888 889 CONFIG_VIDEO_SED13806 890 Enable Epson SED13806 driver. This driver supports 8bpp 891 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 892 or CONFIG_VIDEO_SED13806_16BPP 893 894- Keyboard Support: 895 CONFIG_KEYBOARD 896 897 Define this to enable a custom keyboard support. 898 This simply calls drv_keyboard_init() which must be 899 defined in your board-specific files. 900 The only board using this so far is RBC823. 901 902- LCD Support: CONFIG_LCD 903 904 Define this to enable LCD support (for output to LCD 905 display); also select one of the supported displays 906 by defining one of these: 907 908 CONFIG_NEC_NL6448AC33: 909 910 NEC NL6448AC33-18. Active, color, single scan. 911 912 CONFIG_NEC_NL6448BC20 913 914 NEC NL6448BC20-08. 6.5", 640x480. 915 Active, color, single scan. 916 917 CONFIG_NEC_NL6448BC33_54 918 919 NEC NL6448BC33-54. 10.4", 640x480. 920 Active, color, single scan. 921 922 CONFIG_SHARP_16x9 923 924 Sharp 320x240. Active, color, single scan. 925 It isn't 16x9, and I am not sure what it is. 926 927 CONFIG_SHARP_LQ64D341 928 929 Sharp LQ64D341 display, 640x480. 930 Active, color, single scan. 931 932 CONFIG_HLD1045 933 934 HLD1045 display, 640x480. 935 Active, color, single scan. 936 937 CONFIG_OPTREX_BW 938 939 Optrex CBL50840-2 NF-FW 99 22 M5 940 or 941 Hitachi LMG6912RPFC-00T 942 or 943 Hitachi SP14Q002 944 945 320x240. Black & white. 946 947 Normally display is black on white background; define 948 CFG_WHITE_ON_BLACK to get it inverted. 949 950- Splash Screen Support: CONFIG_SPLASH_SCREEN 951 952 If this option is set, the environment is checked for 953 a variable "splashimage". If found, the usual display 954 of logo, copyright and system information on the LCD 955 is suppressed and the BMP image at the address 956 specified in "splashimage" is loaded instead. The 957 console is redirected to the "nulldev", too. This 958 allows for a "silent" boot where a splash screen is 959 loaded very quickly after power-on. 960 961- Compression support: 962 CONFIG_BZIP2 963 964 If this option is set, support for bzip2 compressed 965 images is included. If not, only uncompressed and gzip 966 compressed images are supported. 967 968 NOTE: the bzip2 algorithm requires a lot of RAM, so 969 the malloc area (as defined by CFG_MALLOC_LEN) should 970 be at least 4MB. 971 972- MII/PHY support: 973 CONFIG_PHY_ADDR 974 975 The address of PHY on MII bus. 976 977 CONFIG_PHY_CLOCK_FREQ (ppc4xx) 978 979 The clock frequency of the MII bus 980 981 CONFIG_PHY_GIGE 982 983 If this option is set, support for speed/duplex 984 detection of Gigabit PHY is included. 985 986 CONFIG_PHY_RESET_DELAY 987 988 Some PHY like Intel LXT971A need extra delay after 989 reset before any MII register access is possible. 990 For such PHY, set this option to the usec delay 991 required. (minimum 300usec for LXT971A) 992 993 CONFIG_PHY_CMD_DELAY (ppc4xx) 994 995 Some PHY like Intel LXT971A need extra delay after 996 command issued before MII status register can be read 997 998- Ethernet address: 999 CONFIG_ETHADDR 1000 CONFIG_ETH2ADDR 1001 CONFIG_ETH3ADDR 1002 1003 Define a default value for ethernet address to use 1004 for the respective ethernet interface, in case this 1005 is not determined automatically. 1006 1007- IP address: 1008 CONFIG_IPADDR 1009 1010 Define a default value for the IP address to use for 1011 the default ethernet interface, in case this is not 1012 determined through e.g. bootp. 1013 1014- Server IP address: 1015 CONFIG_SERVERIP 1016 1017 Defines a default value for theIP address of a TFTP 1018 server to contact when using the "tftboot" command. 1019 1020- BOOTP Recovery Mode: 1021 CONFIG_BOOTP_RANDOM_DELAY 1022 1023 If you have many targets in a network that try to 1024 boot using BOOTP, you may want to avoid that all 1025 systems send out BOOTP requests at precisely the same 1026 moment (which would happen for instance at recovery 1027 from a power failure, when all systems will try to 1028 boot, thus flooding the BOOTP server. Defining 1029 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1030 inserted before sending out BOOTP requests. The 1031 following delays are insterted then: 1032 1033 1st BOOTP request: delay 0 ... 1 sec 1034 2nd BOOTP request: delay 0 ... 2 sec 1035 3rd BOOTP request: delay 0 ... 4 sec 1036 4th and following 1037 BOOTP requests: delay 0 ... 8 sec 1038 1039- DHCP Advanced Options: 1040 CONFIG_BOOTP_MASK 1041 1042 You can fine tune the DHCP functionality by adding 1043 these flags to the CONFIG_BOOTP_MASK define: 1044 1045 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1046 serverip from a DHCP server, it is possible that more 1047 than one DNS serverip is offered to the client. 1048 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1049 serverip will be stored in the additional environment 1050 variable "dnsip2". The first DNS serverip is always 1051 stored in the variable "dnsip", when CONFIG_BOOTP_DNS 1052 is added to the CONFIG_BOOTP_MASK. 1053 1054 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1055 to do a dynamic update of a DNS server. To do this, they 1056 need the hostname of the DHCP requester. 1057 If CONFIG_BOOP_SEND_HOSTNAME is added to the 1058 CONFIG_BOOTP_MASK, the content of the "hostname" 1059 environment variable is passed as option 12 to 1060 the DHCP server. 1061 1062 - CDP Options: 1063 CONFIG_CDP_DEVICE_ID 1064 1065 The device id used in CDP trigger frames. 1066 1067 CONFIG_CDP_DEVICE_ID_PREFIX 1068 1069 A two character string which is prefixed to the MAC address 1070 of the device. 1071 1072 CONFIG_CDP_PORT_ID 1073 1074 A printf format string which contains the ascii name of 1075 the port. Normally is set to "eth%d" which sets 1076 eth0 for the first ethernet, eth1 for the second etc. 1077 1078 CONFIG_CDP_CAPABILITIES 1079 1080 A 32bit integer which indicates the device capabilities; 1081 0x00000010 for a normal host which does not forwards. 1082 1083 CONFIG_CDP_VERSION 1084 1085 An ascii string containing the version of the software. 1086 1087 CONFIG_CDP_PLATFORM 1088 1089 An ascii string containing the name of the platform. 1090 1091 CONFIG_CDP_TRIGGER 1092 1093 A 32bit integer sent on the trigger. 1094 1095 CONFIG_CDP_POWER_CONSUMPTION 1096 1097 A 16bit integer containing the power consumption of the 1098 device in .1 of milliwatts. 1099 1100 CONFIG_CDP_APPLIANCE_VLAN_TYPE 1101 1102 A byte containing the id of the VLAN. 1103 1104- Status LED: CONFIG_STATUS_LED 1105 1106 Several configurations allow to display the current 1107 status using a LED. For instance, the LED will blink 1108 fast while running U-Boot code, stop blinking as 1109 soon as a reply to a BOOTP request was received, and 1110 start blinking slow once the Linux kernel is running 1111 (supported by a status LED driver in the Linux 1112 kernel). Defining CONFIG_STATUS_LED enables this 1113 feature in U-Boot. 1114 1115- CAN Support: CONFIG_CAN_DRIVER 1116 1117 Defining CONFIG_CAN_DRIVER enables CAN driver support 1118 on those systems that support this (optional) 1119 feature, like the TQM8xxL modules. 1120 1121- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1122 1123 These enable I2C serial bus commands. Defining either of 1124 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 1125 include the appropriate I2C driver for the selected cpu. 1126 1127 This will allow you to use i2c commands at the u-boot 1128 command line (as long as you set CFG_CMD_I2C in 1129 CONFIG_COMMANDS) and communicate with i2c based realtime 1130 clock chips. See common/cmd_i2c.c for a description of the 1131 command line interface. 1132 1133 CONFIG_HARD_I2C selects the CPM hardware driver for I2C. 1134 1135 CONFIG_SOFT_I2C configures u-boot to use a software (aka 1136 bit-banging) driver instead of CPM or similar hardware 1137 support for I2C. 1138 1139 There are several other quantities that must also be 1140 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1141 1142 In both cases you will need to define CFG_I2C_SPEED 1143 to be the frequency (in Hz) at which you wish your i2c bus 1144 to run and CFG_I2C_SLAVE to be the address of this node (ie 1145 the cpu's i2c node address). 1146 1147 Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c) 1148 sets the cpu up as a master node and so its address should 1149 therefore be cleared to 0 (See, eg, MPC823e User's Manual 1150 p.16-473). So, set CFG_I2C_SLAVE to 0. 1151 1152 That's all that's required for CONFIG_HARD_I2C. 1153 1154 If you use the software i2c interface (CONFIG_SOFT_I2C) 1155 then the following macros need to be defined (examples are 1156 from include/configs/lwmon.h): 1157 1158 I2C_INIT 1159 1160 (Optional). Any commands necessary to enable the I2C 1161 controller or configure ports. 1162 1163 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1164 1165 I2C_PORT 1166 1167 (Only for MPC8260 CPU). The I/O port to use (the code 1168 assumes both bits are on the same port). Valid values 1169 are 0..3 for ports A..D. 1170 1171 I2C_ACTIVE 1172 1173 The code necessary to make the I2C data line active 1174 (driven). If the data line is open collector, this 1175 define can be null. 1176 1177 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1178 1179 I2C_TRISTATE 1180 1181 The code necessary to make the I2C data line tri-stated 1182 (inactive). If the data line is open collector, this 1183 define can be null. 1184 1185 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1186 1187 I2C_READ 1188 1189 Code that returns TRUE if the I2C data line is high, 1190 FALSE if it is low. 1191 1192 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1193 1194 I2C_SDA(bit) 1195 1196 If <bit> is TRUE, sets the I2C data line high. If it 1197 is FALSE, it clears it (low). 1198 1199 eg: #define I2C_SDA(bit) \ 1200 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1201 else immr->im_cpm.cp_pbdat &= ~PB_SDA 1202 1203 I2C_SCL(bit) 1204 1205 If <bit> is TRUE, sets the I2C clock line high. If it 1206 is FALSE, it clears it (low). 1207 1208 eg: #define I2C_SCL(bit) \ 1209 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1210 else immr->im_cpm.cp_pbdat &= ~PB_SCL 1211 1212 I2C_DELAY 1213 1214 This delay is invoked four times per clock cycle so this 1215 controls the rate of data transfer. The data rate thus 1216 is 1 / (I2C_DELAY * 4). Often defined to be something 1217 like: 1218 1219 #define I2C_DELAY udelay(2) 1220 1221 CFG_I2C_INIT_BOARD 1222 1223 When a board is reset during an i2c bus transfer 1224 chips might think that the current transfer is still 1225 in progress. On some boards it is possible to access 1226 the i2c SCLK line directly, either by using the 1227 processor pin as a GPIO or by having a second pin 1228 connected to the bus. If this option is defined a 1229 custom i2c_init_board() routine in boards/xxx/board.c 1230 is run early in the boot sequence. 1231 1232 CONFIG_I2CFAST (PPC405GP|PPC405EP only) 1233 1234 This option enables configuration of bi_iic_fast[] flags 1235 in u-boot bd_info structure based on u-boot environment 1236 variable "i2cfast". (see also i2cfast) 1237 1238- SPI Support: CONFIG_SPI 1239 1240 Enables SPI driver (so far only tested with 1241 SPI EEPROM, also an instance works with Crystal A/D and 1242 D/As on the SACSng board) 1243 1244 CONFIG_SPI_X 1245 1246 Enables extended (16-bit) SPI EEPROM addressing. 1247 (symmetrical to CONFIG_I2C_X) 1248 1249 CONFIG_SOFT_SPI 1250 1251 Enables a software (bit-bang) SPI driver rather than 1252 using hardware support. This is a general purpose 1253 driver that only requires three general I/O port pins 1254 (two outputs, one input) to function. If this is 1255 defined, the board configuration must define several 1256 SPI configuration items (port pins to use, etc). For 1257 an example, see include/configs/sacsng.h. 1258 1259- FPGA Support: CONFIG_FPGA_COUNT 1260 1261 Specify the number of FPGA devices to support. 1262 1263 CONFIG_FPGA 1264 1265 Used to specify the types of FPGA devices. For example, 1266 #define CONFIG_FPGA CFG_XILINX_VIRTEX2 1267 1268 CFG_FPGA_PROG_FEEDBACK 1269 1270 Enable printing of hash marks during FPGA configuration. 1271 1272 CFG_FPGA_CHECK_BUSY 1273 1274 Enable checks on FPGA configuration interface busy 1275 status by the configuration function. This option 1276 will require a board or device specific function to 1277 be written. 1278 1279 CONFIG_FPGA_DELAY 1280 1281 If defined, a function that provides delays in the FPGA 1282 configuration driver. 1283 1284 CFG_FPGA_CHECK_CTRLC 1285 Allow Control-C to interrupt FPGA configuration 1286 1287 CFG_FPGA_CHECK_ERROR 1288 1289 Check for configuration errors during FPGA bitfile 1290 loading. For example, abort during Virtex II 1291 configuration if the INIT_B line goes low (which 1292 indicated a CRC error). 1293 1294 CFG_FPGA_WAIT_INIT 1295 1296 Maximum time to wait for the INIT_B line to deassert 1297 after PROB_B has been deasserted during a Virtex II 1298 FPGA configuration sequence. The default time is 500 1299 mS. 1300 1301 CFG_FPGA_WAIT_BUSY 1302 1303 Maximum time to wait for BUSY to deassert during 1304 Virtex II FPGA configuration. The default is 5 mS. 1305 1306 CFG_FPGA_WAIT_CONFIG 1307 1308 Time to wait after FPGA configuration. The default is 1309 200 mS. 1310 1311- Configuration Management: 1312 CONFIG_IDENT_STRING 1313 1314 If defined, this string will be added to the U-Boot 1315 version information (U_BOOT_VERSION) 1316 1317- Vendor Parameter Protection: 1318 1319 U-Boot considers the values of the environment 1320 variables "serial#" (Board Serial Number) and 1321 "ethaddr" (Ethernet Address) to be parameters that 1322 are set once by the board vendor / manufacturer, and 1323 protects these variables from casual modification by 1324 the user. Once set, these variables are read-only, 1325 and write or delete attempts are rejected. You can 1326 change this behviour: 1327 1328 If CONFIG_ENV_OVERWRITE is #defined in your config 1329 file, the write protection for vendor parameters is 1330 completely disabled. Anybody can change or delete 1331 these parameters. 1332 1333 Alternatively, if you #define _both_ CONFIG_ETHADDR 1334 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 1335 ethernet address is installed in the environment, 1336 which can be changed exactly ONCE by the user. [The 1337 serial# is unaffected by this, i. e. it remains 1338 read-only.] 1339 1340- Protected RAM: 1341 CONFIG_PRAM 1342 1343 Define this variable to enable the reservation of 1344 "protected RAM", i. e. RAM which is not overwritten 1345 by U-Boot. Define CONFIG_PRAM to hold the number of 1346 kB you want to reserve for pRAM. You can overwrite 1347 this default value by defining an environment 1348 variable "pram" to the number of kB you want to 1349 reserve. Note that the board info structure will 1350 still show the full amount of RAM. If pRAM is 1351 reserved, a new environment variable "mem" will 1352 automatically be defined to hold the amount of 1353 remaining RAM in a form that can be passed as boot 1354 argument to Linux, for instance like that: 1355 1356 setenv bootargs ... mem=\$(mem) 1357 saveenv 1358 1359 This way you can tell Linux not to use this memory, 1360 either, which results in a memory region that will 1361 not be affected by reboots. 1362 1363 *WARNING* If your board configuration uses automatic 1364 detection of the RAM size, you must make sure that 1365 this memory test is non-destructive. So far, the 1366 following board configurations are known to be 1367 "pRAM-clean": 1368 1369 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1370 HERMES, IP860, RPXlite, LWMON, LANTEC, 1371 PCU_E, FLAGADM, TQM8260 1372 1373- Error Recovery: 1374 CONFIG_PANIC_HANG 1375 1376 Define this variable to stop the system in case of a 1377 fatal error, so that you have to reset it manually. 1378 This is probably NOT a good idea for an embedded 1379 system where you want to system to reboot 1380 automatically as fast as possible, but it may be 1381 useful during development since you can try to debug 1382 the conditions that lead to the situation. 1383 1384 CONFIG_NET_RETRY_COUNT 1385 1386 This variable defines the number of retries for 1387 network operations like ARP, RARP, TFTP, or BOOTP 1388 before giving up the operation. If not defined, a 1389 default value of 5 is used. 1390 1391- Command Interpreter: 1392 CFG_AUTO_COMPLETE 1393 1394 Enable auto completion of commands using TAB. 1395 1396 CFG_HUSH_PARSER 1397 1398 Define this variable to enable the "hush" shell (from 1399 Busybox) as command line interpreter, thus enabling 1400 powerful command line syntax like 1401 if...then...else...fi conditionals or `&&' and '||' 1402 constructs ("shell scripts"). 1403 1404 If undefined, you get the old, much simpler behaviour 1405 with a somewhat smaller memory footprint. 1406 1407 1408 CFG_PROMPT_HUSH_PS2 1409 1410 This defines the secondary prompt string, which is 1411 printed when the command interpreter needs more input 1412 to complete a command. Usually "> ". 1413 1414 Note: 1415 1416 In the current implementation, the local variables 1417 space and global environment variables space are 1418 separated. Local variables are those you define by 1419 simply typing `name=value'. To access a local 1420 variable later on, you have write `$name' or 1421 `${name}'; to execute the contents of a variable 1422 directly type `$name' at the command prompt. 1423 1424 Global environment variables are those you use 1425 setenv/printenv to work with. To run a command stored 1426 in such a variable, you need to use the run command, 1427 and you must not use the '$' sign to access them. 1428 1429 To store commands and special characters in a 1430 variable, please use double quotation marks 1431 surrounding the whole text of the variable, instead 1432 of the backslashes before semicolons and special 1433 symbols. 1434 1435- Default Environment: 1436 CONFIG_EXTRA_ENV_SETTINGS 1437 1438 Define this to contain any number of null terminated 1439 strings (variable = value pairs) that will be part of 1440 the default environment compiled into the boot image. 1441 1442 For example, place something like this in your 1443 board's config file: 1444 1445 #define CONFIG_EXTRA_ENV_SETTINGS \ 1446 "myvar1=value1\0" \ 1447 "myvar2=value2\0" 1448 1449 Warning: This method is based on knowledge about the 1450 internal format how the environment is stored by the 1451 U-Boot code. This is NOT an official, exported 1452 interface! Although it is unlikely that this format 1453 will change soon, there is no guarantee either. 1454 You better know what you are doing here. 1455 1456 Note: overly (ab)use of the default environment is 1457 discouraged. Make sure to check other ways to preset 1458 the environment like the autoscript function or the 1459 boot command first. 1460 1461- DataFlash Support: 1462 CONFIG_HAS_DATAFLASH 1463 1464 Defining this option enables DataFlash features and 1465 allows to read/write in Dataflash via the standard 1466 commands cp, md... 1467 1468- SystemACE Support: 1469 CONFIG_SYSTEMACE 1470 1471 Adding this option adds support for Xilinx SystemACE 1472 chips attached via some sort of local bus. The address 1473 of the chip must alsh be defined in the 1474 CFG_SYSTEMACE_BASE macro. For example: 1475 1476 #define CONFIG_SYSTEMACE 1477 #define CFG_SYSTEMACE_BASE 0xf0000000 1478 1479 When SystemACE support is added, the "ace" device type 1480 becomes available to the fat commands, i.e. fatls. 1481 1482- Show boot progress: 1483 CONFIG_SHOW_BOOT_PROGRESS 1484 1485 Defining this option allows to add some board- 1486 specific code (calling a user-provided function 1487 "show_boot_progress(int)") that enables you to show 1488 the system's boot progress on some display (for 1489 example, some LED's) on your board. At the moment, 1490 the following checkpoints are implemented: 1491 1492 Arg Where When 1493 1 common/cmd_bootm.c before attempting to boot an image 1494 -1 common/cmd_bootm.c Image header has bad magic number 1495 2 common/cmd_bootm.c Image header has correct magic number 1496 -2 common/cmd_bootm.c Image header has bad checksum 1497 3 common/cmd_bootm.c Image header has correct checksum 1498 -3 common/cmd_bootm.c Image data has bad checksum 1499 4 common/cmd_bootm.c Image data has correct checksum 1500 -4 common/cmd_bootm.c Image is for unsupported architecture 1501 5 common/cmd_bootm.c Architecture check OK 1502 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) 1503 6 common/cmd_bootm.c Image Type check OK 1504 -6 common/cmd_bootm.c gunzip uncompression error 1505 -7 common/cmd_bootm.c Unimplemented compression type 1506 7 common/cmd_bootm.c Uncompression OK 1507 -8 common/cmd_bootm.c Wrong Image Type (not kernel, multi, standalone) 1508 8 common/cmd_bootm.c Image Type check OK 1509 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 1510 9 common/cmd_bootm.c Start initial ramdisk verification 1511 -10 common/cmd_bootm.c Ramdisk header has bad magic number 1512 -11 common/cmd_bootm.c Ramdisk header has bad checksum 1513 10 common/cmd_bootm.c Ramdisk header is OK 1514 -12 common/cmd_bootm.c Ramdisk data has bad checksum 1515 11 common/cmd_bootm.c Ramdisk data has correct checksum 1516 12 common/cmd_bootm.c Ramdisk verification complete, start loading 1517 -13 common/cmd_bootm.c Wrong Image Type (not PPC Linux Ramdisk) 1518 13 common/cmd_bootm.c Start multifile image verification 1519 14 common/cmd_bootm.c No initial ramdisk, no multifile, continue. 1520 15 common/cmd_bootm.c All preparation done, transferring control to OS 1521 1522 -30 lib_ppc/board.c Fatal error, hang the system 1523 -31 post/post.c POST test failed, detected by post_output_backlog() 1524 -32 post/post.c POST test failed, detected by post_run_single() 1525 1526 -1 common/cmd_doc.c Bad usage of "doc" command 1527 -1 common/cmd_doc.c No boot device 1528 -1 common/cmd_doc.c Unknown Chip ID on boot device 1529 -1 common/cmd_doc.c Read Error on boot device 1530 -1 common/cmd_doc.c Image header has bad magic number 1531 1532 -1 common/cmd_ide.c Bad usage of "ide" command 1533 -1 common/cmd_ide.c No boot device 1534 -1 common/cmd_ide.c Unknown boot device 1535 -1 common/cmd_ide.c Unknown partition table 1536 -1 common/cmd_ide.c Invalid partition type 1537 -1 common/cmd_ide.c Read Error on boot device 1538 -1 common/cmd_ide.c Image header has bad magic number 1539 1540 -1 common/cmd_nand.c Bad usage of "nand" command 1541 -1 common/cmd_nand.c No boot device 1542 -1 common/cmd_nand.c Unknown Chip ID on boot device 1543 -1 common/cmd_nand.c Read Error on boot device 1544 -1 common/cmd_nand.c Image header has bad magic number 1545 1546 -1 common/env_common.c Environment has a bad CRC, using default 1547 1548 1549Modem Support: 1550-------------- 1551 1552[so far only for SMDK2400 and TRAB boards] 1553 1554- Modem support endable: 1555 CONFIG_MODEM_SUPPORT 1556 1557- RTS/CTS Flow control enable: 1558 CONFIG_HWFLOW 1559 1560- Modem debug support: 1561 CONFIG_MODEM_SUPPORT_DEBUG 1562 1563 Enables debugging stuff (char screen[1024], dbg()) 1564 for modem support. Useful only with BDI2000. 1565 1566- Interrupt support (PPC): 1567 1568 There are common interrupt_init() and timer_interrupt() 1569 for all PPC archs. interrupt_init() calls interrupt_init_cpu() 1570 for cpu specific initialization. interrupt_init_cpu() 1571 should set decrementer_count to appropriate value. If 1572 cpu resets decrementer automatically after interrupt 1573 (ppc4xx) it should set decrementer_count to zero. 1574 timer_interrupt() calls timer_interrupt_cpu() for cpu 1575 specific handling. If board has watchdog / status_led 1576 / other_activity_monitor it works automatically from 1577 general timer_interrupt(). 1578 1579- General: 1580 1581 In the target system modem support is enabled when a 1582 specific key (key combination) is pressed during 1583 power-on. Otherwise U-Boot will boot normally 1584 (autoboot). The key_pressed() fuction is called from 1585 board_init(). Currently key_pressed() is a dummy 1586 function, returning 1 and thus enabling modem 1587 initialization. 1588 1589 If there are no modem init strings in the 1590 environment, U-Boot proceed to autoboot; the 1591 previous output (banner, info printfs) will be 1592 supressed, though. 1593 1594 See also: doc/README.Modem 1595 1596 1597Configuration Settings: 1598----------------------- 1599 1600- CFG_LONGHELP: Defined when you want long help messages included; 1601 undefine this when you're short of memory. 1602 1603- CFG_PROMPT: This is what U-Boot prints on the console to 1604 prompt for user input. 1605 1606- CFG_CBSIZE: Buffer size for input from the Console 1607 1608- CFG_PBSIZE: Buffer size for Console output 1609 1610- CFG_MAXARGS: max. Number of arguments accepted for monitor commands 1611 1612- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to 1613 the application (usually a Linux kernel) when it is 1614 booted 1615 1616- CFG_BAUDRATE_TABLE: 1617 List of legal baudrate settings for this board. 1618 1619- CFG_CONSOLE_INFO_QUIET 1620 Suppress display of console information at boot. 1621 1622- CFG_CONSOLE_IS_IN_ENV 1623 If the board specific function 1624 extern int overwrite_console (void); 1625 returns 1, the stdin, stderr and stdout are switched to the 1626 serial port, else the settings in the environment are used. 1627 1628- CFG_CONSOLE_OVERWRITE_ROUTINE 1629 Enable the call to overwrite_console(). 1630 1631- CFG_CONSOLE_ENV_OVERWRITE 1632 Enable overwrite of previous console environment settings. 1633 1634- CFG_MEMTEST_START, CFG_MEMTEST_END: 1635 Begin and End addresses of the area used by the 1636 simple memory test. 1637 1638- CFG_ALT_MEMTEST: 1639 Enable an alternate, more extensive memory test. 1640 1641- CFG_MEMTEST_SCRATCH: 1642 Scratch address used by the alternate memory test 1643 You only need to set this if address zero isn't writeable 1644 1645- CFG_TFTP_LOADADDR: 1646 Default load address for network file downloads 1647 1648- CFG_LOADS_BAUD_CHANGE: 1649 Enable temporary baudrate change while serial download 1650 1651- CFG_SDRAM_BASE: 1652 Physical start address of SDRAM. _Must_ be 0 here. 1653 1654- CFG_MBIO_BASE: 1655 Physical start address of Motherboard I/O (if using a 1656 Cogent motherboard) 1657 1658- CFG_FLASH_BASE: 1659 Physical start address of Flash memory. 1660 1661- CFG_MONITOR_BASE: 1662 Physical start address of boot monitor code (set by 1663 make config files to be same as the text base address 1664 (TEXT_BASE) used when linking) - same as 1665 CFG_FLASH_BASE when booting from flash. 1666 1667- CFG_MONITOR_LEN: 1668 Size of memory reserved for monitor code, used to 1669 determine _at_compile_time_ (!) if the environment is 1670 embedded within the U-Boot image, or in a separate 1671 flash sector. 1672 1673- CFG_MALLOC_LEN: 1674 Size of DRAM reserved for malloc() use. 1675 1676- CFG_BOOTMAPSZ: 1677 Maximum size of memory mapped by the startup code of 1678 the Linux kernel; all data that must be processed by 1679 the Linux kernel (bd_info, boot arguments, eventually 1680 initrd image) must be put below this limit. 1681 1682- CFG_MAX_FLASH_BANKS: 1683 Max number of Flash memory banks 1684 1685- CFG_MAX_FLASH_SECT: 1686 Max number of sectors on a Flash chip 1687 1688- CFG_FLASH_ERASE_TOUT: 1689 Timeout for Flash erase operations (in ms) 1690 1691- CFG_FLASH_WRITE_TOUT: 1692 Timeout for Flash write operations (in ms) 1693 1694- CFG_FLASH_LOCK_TOUT 1695 Timeout for Flash set sector lock bit operation (in ms) 1696 1697- CFG_FLASH_UNLOCK_TOUT 1698 Timeout for Flash clear lock bits operation (in ms) 1699 1700- CFG_FLASH_PROTECTION 1701 If defined, hardware flash sectors protection is used 1702 instead of U-Boot software protection. 1703 1704- CFG_DIRECT_FLASH_TFTP: 1705 1706 Enable TFTP transfers directly to flash memory; 1707 without this option such a download has to be 1708 performed in two steps: (1) download to RAM, and (2) 1709 copy from RAM to flash. 1710 1711 The two-step approach is usually more reliable, since 1712 you can check if the download worked before you erase 1713 the flash, but in some situations (when sytem RAM is 1714 too limited to allow for a tempory copy of the 1715 downloaded image) this option may be very useful. 1716 1717- CFG_FLASH_CFI: 1718 Define if the flash driver uses extra elements in the 1719 common flash structure for storing flash geometry. 1720 1721- CFG_FLASH_CFI_DRIVER 1722 This option also enables the building of the cfi_flash driver 1723 in the drivers directory 1724 1725- CFG_RX_ETH_BUFFER: 1726 Defines the number of ethernet receive buffers. On some 1727 ethernet controllers it is recommended to set this value 1728 to 8 or even higher (EEPRO100 or 405 EMAC), since all 1729 buffers can be full shortly after enabling the interface 1730 on high ethernet traffic. 1731 Defaults to 4 if not defined. 1732 1733The following definitions that deal with the placement and management 1734of environment data (variable area); in general, we support the 1735following configurations: 1736 1737- CFG_ENV_IS_IN_FLASH: 1738 1739 Define this if the environment is in flash memory. 1740 1741 a) The environment occupies one whole flash sector, which is 1742 "embedded" in the text segment with the U-Boot code. This 1743 happens usually with "bottom boot sector" or "top boot 1744 sector" type flash chips, which have several smaller 1745 sectors at the start or the end. For instance, such a 1746 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 1747 such a case you would place the environment in one of the 1748 4 kB sectors - with U-Boot code before and after it. With 1749 "top boot sector" type flash chips, you would put the 1750 environment in one of the last sectors, leaving a gap 1751 between U-Boot and the environment. 1752 1753 - CFG_ENV_OFFSET: 1754 1755 Offset of environment data (variable area) to the 1756 beginning of flash memory; for instance, with bottom boot 1757 type flash chips the second sector can be used: the offset 1758 for this sector is given here. 1759 1760 CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE. 1761 1762 - CFG_ENV_ADDR: 1763 1764 This is just another way to specify the start address of 1765 the flash sector containing the environment (instead of 1766 CFG_ENV_OFFSET). 1767 1768 - CFG_ENV_SECT_SIZE: 1769 1770 Size of the sector containing the environment. 1771 1772 1773 b) Sometimes flash chips have few, equal sized, BIG sectors. 1774 In such a case you don't want to spend a whole sector for 1775 the environment. 1776 1777 - CFG_ENV_SIZE: 1778 1779 If you use this in combination with CFG_ENV_IS_IN_FLASH 1780 and CFG_ENV_SECT_SIZE, you can specify to use only a part 1781 of this flash sector for the environment. This saves 1782 memory for the RAM copy of the environment. 1783 1784 It may also save flash memory if you decide to use this 1785 when your environment is "embedded" within U-Boot code, 1786 since then the remainder of the flash sector could be used 1787 for U-Boot code. It should be pointed out that this is 1788 STRONGLY DISCOURAGED from a robustness point of view: 1789 updating the environment in flash makes it always 1790 necessary to erase the WHOLE sector. If something goes 1791 wrong before the contents has been restored from a copy in 1792 RAM, your target system will be dead. 1793 1794 - CFG_ENV_ADDR_REDUND 1795 CFG_ENV_SIZE_REDUND 1796 1797 These settings describe a second storage area used to hold 1798 a redundand copy of the environment data, so that there is 1799 a valid backup copy in case there is a power failure during 1800 a "saveenv" operation. 1801 1802BE CAREFUL! Any changes to the flash layout, and some changes to the 1803source code will make it necessary to adapt <board>/u-boot.lds* 1804accordingly! 1805 1806 1807- CFG_ENV_IS_IN_NVRAM: 1808 1809 Define this if you have some non-volatile memory device 1810 (NVRAM, battery buffered SRAM) which you want to use for the 1811 environment. 1812 1813 - CFG_ENV_ADDR: 1814 - CFG_ENV_SIZE: 1815 1816 These two #defines are used to determin the memory area you 1817 want to use for environment. It is assumed that this memory 1818 can just be read and written to, without any special 1819 provision. 1820 1821BE CAREFUL! The first access to the environment happens quite early 1822in U-Boot initalization (when we try to get the setting of for the 1823console baudrate). You *MUST* have mappend your NVRAM area then, or 1824U-Boot will hang. 1825 1826Please note that even with NVRAM we still use a copy of the 1827environment in RAM: we could work on NVRAM directly, but we want to 1828keep settings there always unmodified except somebody uses "saveenv" 1829to save the current settings. 1830 1831 1832- CFG_ENV_IS_IN_EEPROM: 1833 1834 Use this if you have an EEPROM or similar serial access 1835 device and a driver for it. 1836 1837 - CFG_ENV_OFFSET: 1838 - CFG_ENV_SIZE: 1839 1840 These two #defines specify the offset and size of the 1841 environment area within the total memory of your EEPROM. 1842 1843 - CFG_I2C_EEPROM_ADDR: 1844 If defined, specified the chip address of the EEPROM device. 1845 The default address is zero. 1846 1847 - CFG_EEPROM_PAGE_WRITE_BITS: 1848 If defined, the number of bits used to address bytes in a 1849 single page in the EEPROM device. A 64 byte page, for example 1850 would require six bits. 1851 1852 - CFG_EEPROM_PAGE_WRITE_DELAY_MS: 1853 If defined, the number of milliseconds to delay between 1854 page writes. The default is zero milliseconds. 1855 1856 - CFG_I2C_EEPROM_ADDR_LEN: 1857 The length in bytes of the EEPROM memory array address. Note 1858 that this is NOT the chip address length! 1859 1860 - CFG_I2C_EEPROM_ADDR_OVERFLOW: 1861 EEPROM chips that implement "address overflow" are ones 1862 like Catalyst 24WC04/08/16 which has 9/10/11 bits of 1863 address and the extra bits end up in the "chip address" bit 1864 slots. This makes a 24WC08 (1Kbyte) chip look like four 256 1865 byte chips. 1866 1867 Note that we consider the length of the address field to 1868 still be one byte because the extra address bits are hidden 1869 in the chip address. 1870 1871 - CFG_EEPROM_SIZE: 1872 The size in bytes of the EEPROM device. 1873 1874 1875- CFG_ENV_IS_IN_DATAFLASH: 1876 1877 Define this if you have a DataFlash memory device which you 1878 want to use for the environment. 1879 1880 - CFG_ENV_OFFSET: 1881 - CFG_ENV_ADDR: 1882 - CFG_ENV_SIZE: 1883 1884 These three #defines specify the offset and size of the 1885 environment area within the total memory of your DataFlash placed 1886 at the specified address. 1887 1888- CFG_ENV_IS_IN_NAND: 1889 1890 Define this if you have a NAND device which you want to use 1891 for the environment. 1892 1893 - CFG_ENV_OFFSET: 1894 - CFG_ENV_SIZE: 1895 1896 These two #defines specify the offset and size of the environment 1897 area within the first NAND device. 1898 1899- CFG_SPI_INIT_OFFSET 1900 1901 Defines offset to the initial SPI buffer area in DPRAM. The 1902 area is used at an early stage (ROM part) if the environment 1903 is configured to reside in the SPI EEPROM: We need a 520 byte 1904 scratch DPRAM area. It is used between the two initialization 1905 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 1906 to be a good choice since it makes it far enough from the 1907 start of the data area as well as from the stack pointer. 1908 1909Please note that the environment is read-only as long as the monitor 1910has been relocated to RAM and a RAM copy of the environment has been 1911created; also, when using EEPROM you will have to use getenv_r() 1912until then to read environment variables. 1913 1914The environment is protected by a CRC32 checksum. Before the monitor 1915is relocated into RAM, as a result of a bad CRC you will be working 1916with the compiled-in default environment - *silently*!!! [This is 1917necessary, because the first environment variable we need is the 1918"baudrate" setting for the console - if we have a bad CRC, we don't 1919have any device yet where we could complain.] 1920 1921Note: once the monitor has been relocated, then it will complain if 1922the default environment is used; a new CRC is computed as soon as you 1923use the "saveenv" command to store a valid environment. 1924 1925- CFG_FAULT_ECHO_LINK_DOWN: 1926 Echo the inverted Ethernet link state to the fault LED. 1927 1928 Note: If this option is active, then CFG_FAULT_MII_ADDR 1929 also needs to be defined. 1930 1931- CFG_FAULT_MII_ADDR: 1932 MII address of the PHY to check for the Ethernet link state. 1933 1934- CFG_64BIT_VSPRINTF: 1935 Makes vsprintf (and all *printf functions) support printing 1936 of 64bit values by using the L quantifier 1937 1938- CFG_64BIT_STRTOUL: 1939 Adds simple_strtoull that returns a 64bit value 1940 1941Low Level (hardware related) configuration options: 1942--------------------------------------------------- 1943 1944- CFG_CACHELINE_SIZE: 1945 Cache Line Size of the CPU. 1946 1947- CFG_DEFAULT_IMMR: 1948 Default address of the IMMR after system reset. 1949 1950 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 1951 and RPXsuper) to be able to adjust the position of 1952 the IMMR register after a reset. 1953 1954- Floppy Disk Support: 1955 CFG_FDC_DRIVE_NUMBER 1956 1957 the default drive number (default value 0) 1958 1959 CFG_ISA_IO_STRIDE 1960 1961 defines the spacing between fdc chipset registers 1962 (default value 1) 1963 1964 CFG_ISA_IO_OFFSET 1965 1966 defines the offset of register from address. It 1967 depends on which part of the data bus is connected to 1968 the fdc chipset. (default value 0) 1969 1970 If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and 1971 CFG_FDC_DRIVE_NUMBER are undefined, they take their 1972 default value. 1973 1974 if CFG_FDC_HW_INIT is defined, then the function 1975 fdc_hw_init() is called at the beginning of the FDC 1976 setup. fdc_hw_init() must be provided by the board 1977 source code. It is used to make hardware dependant 1978 initializations. 1979 1980- CFG_IMMR: Physical address of the Internal Memory Mapped 1981 Register; DO NOT CHANGE! (11-4) 1982 [MPC8xx systems only] 1983 1984- CFG_INIT_RAM_ADDR: 1985 1986 Start address of memory area that can be used for 1987 initial data and stack; please note that this must be 1988 writable memory that is working WITHOUT special 1989 initialization, i. e. you CANNOT use normal RAM which 1990 will become available only after programming the 1991 memory controller and running certain initialization 1992 sequences. 1993 1994 U-Boot uses the following memory types: 1995 - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 1996 - MPC824X: data cache 1997 - PPC4xx: data cache 1998 1999- CFG_GBL_DATA_OFFSET: 2000 2001 Offset of the initial data structure in the memory 2002 area defined by CFG_INIT_RAM_ADDR. Usually 2003 CFG_GBL_DATA_OFFSET is chosen such that the initial 2004 data is located at the end of the available space 2005 (sometimes written as (CFG_INIT_RAM_END - 2006 CFG_INIT_DATA_SIZE), and the initial stack is just 2007 below that area (growing from (CFG_INIT_RAM_ADDR + 2008 CFG_GBL_DATA_OFFSET) downward. 2009 2010 Note: 2011 On the MPC824X (or other systems that use the data 2012 cache for initial memory) the address chosen for 2013 CFG_INIT_RAM_ADDR is basically arbitrary - it must 2014 point to an otherwise UNUSED address space between 2015 the top of RAM and the start of the PCI space. 2016 2017- CFG_SIUMCR: SIU Module Configuration (11-6) 2018 2019- CFG_SYPCR: System Protection Control (11-9) 2020 2021- CFG_TBSCR: Time Base Status and Control (11-26) 2022 2023- CFG_PISCR: Periodic Interrupt Status and Control (11-31) 2024 2025- CFG_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2026 2027- CFG_SCCR: System Clock and reset Control Register (15-27) 2028 2029- CFG_OR_TIMING_SDRAM: 2030 SDRAM timing 2031 2032- CFG_MAMR_PTA: 2033 periodic timer for refresh 2034 2035- CFG_DER: Debug Event Register (37-47) 2036 2037- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM, 2038 CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP, 2039 CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM, 2040 CFG_BR1_PRELIM: 2041 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2042 2043- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 2044 CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM, 2045 CFG_OR3_PRELIM, CFG_BR3_PRELIM: 2046 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2047 2048- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K, 2049 CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL: 2050 Machine Mode Register and Memory Periodic Timer 2051 Prescaler definitions (SDRAM timing) 2052 2053- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]: 2054 enable I2C microcode relocation patch (MPC8xx); 2055 define relocation offset in DPRAM [DSP2] 2056 2057- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]: 2058 enable SPI microcode relocation patch (MPC8xx); 2059 define relocation offset in DPRAM [SCC4] 2060 2061- CFG_USE_OSCCLK: 2062 Use OSCM clock mode on MBX8xx board. Be careful, 2063 wrong setting might damage your board. Read 2064 doc/README.MBX before setting this variable! 2065 2066- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2067 Offset of the bootmode word in DPRAM used by post 2068 (Power On Self Tests). This definition overrides 2069 #define'd default value in commproc.h resp. 2070 cpm_8260.h. 2071 2072- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB, 2073 CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL, 2074 CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS, 2075 CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB, 2076 CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 2077 CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL, 2078 CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE, 2079 CFG_POCMR2_MASK_ATTRIB: (MPC826x only) 2080 Overrides the default PCI memory map in cpu/mpc8260/pci.c if set. 2081 2082- CONFIG_ETHER_ON_FEC[12] 2083 Define to enable FEC[12] on a 8xx series processor. 2084 2085- CONFIG_FEC[12]_PHY 2086 Define to the hardcoded PHY address which corresponds 2087 to the given FEC; i. e. 2088 #define CONFIG_FEC1_PHY 4 2089 means that the PHY with address 4 is connected to FEC1 2090 2091 When set to -1, means to probe for first available. 2092 2093- CONFIG_FEC[12]_PHY_NORXERR 2094 The PHY does not have a RXERR line (RMII only). 2095 (so program the FEC to ignore it). 2096 2097- CONFIG_RMII 2098 Enable RMII mode for all FECs. 2099 Note that this is a global option, we can't 2100 have one FEC in standard MII mode and another in RMII mode. 2101 2102- CONFIG_CRC32_VERIFY 2103 Add a verify option to the crc32 command. 2104 The syntax is: 2105 2106 => crc32 -v <address> <count> <crc32> 2107 2108 Where address/count indicate a memory area 2109 and crc32 is the correct crc32 which the 2110 area should have. 2111 2112- CONFIG_LOOPW 2113 Add the "loopw" memory command. This only takes effect if 2114 the memory commands are activated globally (CFG_CMD_MEM). 2115 2116Building the Software: 2117====================== 2118 2119Building U-Boot has been tested in native PPC environments (on a 2120PowerBook G3 running LinuxPPC 2000) and in cross environments 2121(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and 2122NetBSD 1.5 on x86). 2123 2124If you are not using a native PPC environment, it is assumed that you 2125have the GNU cross compiling tools available in your path and named 2126with a prefix of "powerpc-linux-". If this is not the case, (e.g. if 2127you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change 2128the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU, 2129change it to: 2130 2131 CROSS_COMPILE = ppc_4xx- 2132 2133 2134U-Boot is intended to be simple to build. After installing the 2135sources you must configure U-Boot for one specific board type. This 2136is done by typing: 2137 2138 make NAME_config 2139 2140where "NAME_config" is the name of one of the existing 2141configurations; the following names are supported: 2142 2143 ADCIOP_config FPS860L_config omap730p2_config 2144 ADS860_config GEN860T_config pcu_e_config 2145 Alaska8220_config 2146 AR405_config GENIETV_config PIP405_config 2147 at91rm9200dk_config GTH_config QS823_config 2148 CANBT_config hermes_config QS850_config 2149 cmi_mpc5xx_config hymod_config QS860T_config 2150 cogent_common_config IP860_config RPXlite_config 2151 cogent_mpc8260_config IVML24_config RPXlite_DW_config 2152 cogent_mpc8xx_config IVMS8_config RPXsuper_config 2153 CPCI405_config JSE_config rsdproto_config 2154 CPCIISER4_config LANTEC_config Sandpoint8240_config 2155 csb272_config lwmon_config sbc8260_config 2156 CU824_config MBX860T_config sbc8560_33_config 2157 DUET_ADS_config MBX_config sbc8560_66_config 2158 EBONY_config MPC8260ADS_config SM850_config 2159 ELPT860_config MPC8540ADS_config SPD823TS_config 2160 ESTEEM192E_config MPC8560ADS_config stxgp3_config 2161 ETX094_config NETVIA_config SXNI855T_config 2162 FADS823_config omap1510inn_config TQM823L_config 2163 FADS850SAR_config omap1610h2_config TQM850L_config 2164 FADS860T_config omap1610inn_config TQM855L_config 2165 FPS850L_config omap5912osk_config TQM860L_config 2166 WALNUT405_config 2167 Yukon8220_config 2168 ZPC1900_config 2169 2170Note: for some board special configuration names may exist; check if 2171 additional information is available from the board vendor; for 2172 instance, the TQM823L systems are available without (standard) 2173 or with LCD support. You can select such additional "features" 2174 when chosing the configuration, i. e. 2175 2176 make TQM823L_config 2177 - will configure for a plain TQM823L, i. e. no LCD support 2178 2179 make TQM823L_LCD_config 2180 - will configure for a TQM823L with U-Boot console on LCD 2181 2182 etc. 2183 2184 2185Finally, type "make all", and you should get some working U-Boot 2186images ready for download to / installation on your system: 2187 2188- "u-boot.bin" is a raw binary image 2189- "u-boot" is an image in ELF binary format 2190- "u-boot.srec" is in Motorola S-Record format 2191 2192 2193Please be aware that the Makefiles assume you are using GNU make, so 2194for instance on NetBSD you might need to use "gmake" instead of 2195native "make". 2196 2197 2198If the system board that you have is not listed, then you will need 2199to port U-Boot to your hardware platform. To do this, follow these 2200steps: 2201 22021. Add a new configuration option for your board to the toplevel 2203 "Makefile" and to the "MAKEALL" script, using the existing 2204 entries as examples. Note that here and at many other places 2205 boards and other names are listed in alphabetical sort order. Please 2206 keep this order. 22072. Create a new directory to hold your board specific code. Add any 2208 files you need. In your board directory, you will need at least 2209 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 22103. Create a new configuration file "include/configs/<board>.h" for 2211 your board 22123. If you're porting U-Boot to a new CPU, then also create a new 2213 directory to hold your CPU specific code. Add any files you need. 22144. Run "make <board>_config" with your new name. 22155. Type "make", and you should get a working "u-boot.srec" file 2216 to be installed on your target system. 22176. Debug and solve any problems that might arise. 2218 [Of course, this last step is much harder than it sounds.] 2219 2220 2221Testing of U-Boot Modifications, Ports to New Hardware, etc.: 2222============================================================== 2223 2224If you have modified U-Boot sources (for instance added a new board 2225or support for new devices, a new CPU, etc.) you are expected to 2226provide feedback to the other developers. The feedback normally takes 2227the form of a "patch", i. e. a context diff against a certain (latest 2228official or latest in CVS) version of U-Boot sources. 2229 2230But before you submit such a patch, please verify that your modifi- 2231cation did not break existing code. At least make sure that *ALL* of 2232the supported boards compile WITHOUT ANY compiler warnings. To do so, 2233just run the "MAKEALL" script, which will configure and build U-Boot 2234for ALL supported system. Be warned, this will take a while. You can 2235select which (cross) compiler to use by passing a `CROSS_COMPILE' 2236environment variable to the script, i. e. to use the cross tools from 2237MontaVista's Hard Hat Linux you can type 2238 2239 CROSS_COMPILE=ppc_8xx- MAKEALL 2240 2241or to build on a native PowerPC system you can type 2242 2243 CROSS_COMPILE=' ' MAKEALL 2244 2245See also "U-Boot Porting Guide" below. 2246 2247 2248Monitor Commands - Overview: 2249============================ 2250 2251go - start application at address 'addr' 2252run - run commands in an environment variable 2253bootm - boot application image from memory 2254bootp - boot image via network using BootP/TFTP protocol 2255tftpboot- boot image via network using TFTP protocol 2256 and env variables "ipaddr" and "serverip" 2257 (and eventually "gatewayip") 2258rarpboot- boot image via network using RARP/TFTP protocol 2259diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 2260loads - load S-Record file over serial line 2261loadb - load binary file over serial line (kermit mode) 2262md - memory display 2263mm - memory modify (auto-incrementing) 2264nm - memory modify (constant address) 2265mw - memory write (fill) 2266cp - memory copy 2267cmp - memory compare 2268crc32 - checksum calculation 2269imd - i2c memory display 2270imm - i2c memory modify (auto-incrementing) 2271inm - i2c memory modify (constant address) 2272imw - i2c memory write (fill) 2273icrc32 - i2c checksum calculation 2274iprobe - probe to discover valid I2C chip addresses 2275iloop - infinite loop on address range 2276isdram - print SDRAM configuration information 2277sspi - SPI utility commands 2278base - print or set address offset 2279printenv- print environment variables 2280setenv - set environment variables 2281saveenv - save environment variables to persistent storage 2282protect - enable or disable FLASH write protection 2283erase - erase FLASH memory 2284flinfo - print FLASH memory information 2285bdinfo - print Board Info structure 2286iminfo - print header information for application image 2287coninfo - print console devices and informations 2288ide - IDE sub-system 2289loop - infinite loop on address range 2290loopw - infinite write loop on address range 2291mtest - simple RAM test 2292icache - enable or disable instruction cache 2293dcache - enable or disable data cache 2294reset - Perform RESET of the CPU 2295echo - echo args to console 2296version - print monitor version 2297help - print online help 2298? - alias for 'help' 2299 2300 2301Monitor Commands - Detailed Description: 2302======================================== 2303 2304TODO. 2305 2306For now: just type "help <command>". 2307 2308 2309Environment Variables: 2310====================== 2311 2312U-Boot supports user configuration using Environment Variables which 2313can be made persistent by saving to Flash memory. 2314 2315Environment Variables are set using "setenv", printed using 2316"printenv", and saved to Flash using "saveenv". Using "setenv" 2317without a value can be used to delete a variable from the 2318environment. As long as you don't save the environment you are 2319working with an in-memory copy. In case the Flash area containing the 2320environment is erased by accident, a default environment is provided. 2321 2322Some configuration options can be set using Environment Variables: 2323 2324 baudrate - see CONFIG_BAUDRATE 2325 2326 bootdelay - see CONFIG_BOOTDELAY 2327 2328 bootcmd - see CONFIG_BOOTCOMMAND 2329 2330 bootargs - Boot arguments when booting an RTOS image 2331 2332 bootfile - Name of the image to load with TFTP 2333 2334 autoload - if set to "no" (any string beginning with 'n'), 2335 "bootp" will just load perform a lookup of the 2336 configuration from the BOOTP server, but not try to 2337 load any image using TFTP 2338 2339 autostart - if set to "yes", an image loaded using the "bootp", 2340 "rarpboot", "tftpboot" or "diskboot" commands will 2341 be automatically started (by internally calling 2342 "bootm") 2343 2344 If set to "no", a standalone image passed to the 2345 "bootm" command will be copied to the load address 2346 (and eventually uncompressed), but NOT be started. 2347 This can be used to load and uncompress arbitrary 2348 data. 2349 2350 i2cfast - (PPC405GP|PPC405EP only) 2351 if set to 'y' configures Linux I2C driver for fast 2352 mode (400kHZ). This environment variable is used in 2353 initialization code. So, for changes to be effective 2354 it must be saved and board must be reset. 2355 2356 initrd_high - restrict positioning of initrd images: 2357 If this variable is not set, initrd images will be 2358 copied to the highest possible address in RAM; this 2359 is usually what you want since it allows for 2360 maximum initrd size. If for some reason you want to 2361 make sure that the initrd image is loaded below the 2362 CFG_BOOTMAPSZ limit, you can set this environment 2363 variable to a value of "no" or "off" or "0". 2364 Alternatively, you can set it to a maximum upper 2365 address to use (U-Boot will still check that it 2366 does not overwrite the U-Boot stack and data). 2367 2368 For instance, when you have a system with 16 MB 2369 RAM, and want to reserve 4 MB from use by Linux, 2370 you can do this by adding "mem=12M" to the value of 2371 the "bootargs" variable. However, now you must make 2372 sure that the initrd image is placed in the first 2373 12 MB as well - this can be done with 2374 2375 setenv initrd_high 00c00000 2376 2377 If you set initrd_high to 0xFFFFFFFF, this is an 2378 indication to U-Boot that all addresses are legal 2379 for the Linux kernel, including addresses in flash 2380 memory. In this case U-Boot will NOT COPY the 2381 ramdisk at all. This may be useful to reduce the 2382 boot time on your system, but requires that this 2383 feature is supported by your Linux kernel. 2384 2385 ipaddr - IP address; needed for tftpboot command 2386 2387 loadaddr - Default load address for commands like "bootp", 2388 "rarpboot", "tftpboot", "loadb" or "diskboot" 2389 2390 loads_echo - see CONFIG_LOADS_ECHO 2391 2392 serverip - TFTP server IP address; needed for tftpboot command 2393 2394 bootretry - see CONFIG_BOOT_RETRY_TIME 2395 2396 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 2397 2398 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 2399 2400 ethprime - When CONFIG_NET_MULTI is enabled controls which 2401 interface is used first. 2402 2403 ethact - When CONFIG_NET_MULTI is enabled controls which 2404 interface is currently active. For example you 2405 can do the following 2406 2407 => setenv ethact FEC ETHERNET 2408 => ping 192.168.0.1 # traffic sent on FEC ETHERNET 2409 => setenv ethact SCC ETHERNET 2410 => ping 10.0.0.1 # traffic sent on SCC ETHERNET 2411 2412 netretry - When set to "no" each network operation will 2413 either succeed or fail without retrying. 2414 When set to "once" the network operation will 2415 fail when all the available network interfaces 2416 are tried once without success. 2417 Useful on scripts which control the retry operation 2418 themselves. 2419 2420 vlan - When set to a value < 4095 the traffic over 2421 ethernet is encapsulated/received over 802.1q 2422 VLAN tagged frames. 2423 2424The following environment variables may be used and automatically 2425updated by the network boot commands ("bootp" and "rarpboot"), 2426depending the information provided by your boot server: 2427 2428 bootfile - see above 2429 dnsip - IP address of your Domain Name Server 2430 dnsip2 - IP address of your secondary Domain Name Server 2431 gatewayip - IP address of the Gateway (Router) to use 2432 hostname - Target hostname 2433 ipaddr - see above 2434 netmask - Subnet Mask 2435 rootpath - Pathname of the root filesystem on the NFS server 2436 serverip - see above 2437 2438 2439There are two special Environment Variables: 2440 2441 serial# - contains hardware identification information such 2442 as type string and/or serial number 2443 ethaddr - Ethernet address 2444 2445These variables can be set only once (usually during manufacturing of 2446the board). U-Boot refuses to delete or overwrite these variables 2447once they have been set once. 2448 2449 2450Further special Environment Variables: 2451 2452 ver - Contains the U-Boot version string as printed 2453 with the "version" command. This variable is 2454 readonly (see CONFIG_VERSION_VARIABLE). 2455 2456 2457Please note that changes to some configuration parameters may take 2458only effect after the next boot (yes, that's just like Windoze :-). 2459 2460 2461Command Line Parsing: 2462===================== 2463 2464There are two different command line parsers available with U-Boot: 2465the old "simple" one, and the much more powerful "hush" shell: 2466 2467Old, simple command line parser: 2468-------------------------------- 2469 2470- supports environment variables (through setenv / saveenv commands) 2471- several commands on one line, separated by ';' 2472- variable substitution using "... $(name) ..." syntax 2473- special characters ('$', ';') can be escaped by prefixing with '\', 2474 for example: 2475 setenv bootcmd bootm \$(address) 2476- You can also escape text by enclosing in single apostrophes, for example: 2477 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 2478 2479Hush shell: 2480----------- 2481 2482- similar to Bourne shell, with control structures like 2483 if...then...else...fi, for...do...done; while...do...done, 2484 until...do...done, ... 2485- supports environment ("global") variables (through setenv / saveenv 2486 commands) and local shell variables (through standard shell syntax 2487 "name=value"); only environment variables can be used with "run" 2488 command 2489 2490General rules: 2491-------------- 2492 2493(1) If a command line (or an environment variable executed by a "run" 2494 command) contains several commands separated by semicolon, and 2495 one of these commands fails, then the remaining commands will be 2496 executed anyway. 2497 2498(2) If you execute several variables with one call to run (i. e. 2499 calling run with a list af variables as arguments), any failing 2500 command will cause "run" to terminate, i. e. the remaining 2501 variables are not executed. 2502 2503Note for Redundant Ethernet Interfaces: 2504======================================= 2505 2506Some boards come with redundant ethernet interfaces; U-Boot supports 2507such configurations and is capable of automatic selection of a 2508"working" interface when needed. MAC assignment works as follows: 2509 2510Network interfaces are numbered eth0, eth1, eth2, ... Corresponding 2511MAC addresses can be stored in the environment as "ethaddr" (=>eth0), 2512"eth1addr" (=>eth1), "eth2addr", ... 2513 2514If the network interface stores some valid MAC address (for instance 2515in SROM), this is used as default address if there is NO correspon- 2516ding setting in the environment; if the corresponding environment 2517variable is set, this overrides the settings in the card; that means: 2518 2519o If the SROM has a valid MAC address, and there is no address in the 2520 environment, the SROM's address is used. 2521 2522o If there is no valid address in the SROM, and a definition in the 2523 environment exists, then the value from the environment variable is 2524 used. 2525 2526o If both the SROM and the environment contain a MAC address, and 2527 both addresses are the same, this MAC address is used. 2528 2529o If both the SROM and the environment contain a MAC address, and the 2530 addresses differ, the value from the environment is used and a 2531 warning is printed. 2532 2533o If neither SROM nor the environment contain a MAC address, an error 2534 is raised. 2535 2536 2537Image Formats: 2538============== 2539 2540The "boot" commands of this monitor operate on "image" files which 2541can be basicly anything, preceeded by a special header; see the 2542definitions in include/image.h for details; basicly, the header 2543defines the following image properties: 2544 2545* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 2546 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 2547 LynxOS, pSOS, QNX, RTEMS, ARTOS; 2548 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS). 2549* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86, 2550 IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 2551 Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC). 2552* Compression Type (uncompressed, gzip, bzip2) 2553* Load Address 2554* Entry Point 2555* Image Name 2556* Image Timestamp 2557 2558The header is marked by a special Magic Number, and both the header 2559and the data portions of the image are secured against corruption by 2560CRC32 checksums. 2561 2562 2563Linux Support: 2564============== 2565 2566Although U-Boot should support any OS or standalone application 2567easily, the main focus has always been on Linux during the design of 2568U-Boot. 2569 2570U-Boot includes many features that so far have been part of some 2571special "boot loader" code within the Linux kernel. Also, any 2572"initrd" images to be used are no longer part of one big Linux image; 2573instead, kernel and "initrd" are separate images. This implementation 2574serves several purposes: 2575 2576- the same features can be used for other OS or standalone 2577 applications (for instance: using compressed images to reduce the 2578 Flash memory footprint) 2579 2580- it becomes much easier to port new Linux kernel versions because 2581 lots of low-level, hardware dependent stuff are done by U-Boot 2582 2583- the same Linux kernel image can now be used with different "initrd" 2584 images; of course this also means that different kernel images can 2585 be run with the same "initrd". This makes testing easier (you don't 2586 have to build a new "zImage.initrd" Linux image when you just 2587 change a file in your "initrd"). Also, a field-upgrade of the 2588 software is easier now. 2589 2590 2591Linux HOWTO: 2592============ 2593 2594Porting Linux to U-Boot based systems: 2595--------------------------------------- 2596 2597U-Boot cannot save you from doing all the necessary modifications to 2598configure the Linux device drivers for use with your target hardware 2599(no, we don't intend to provide a full virtual machine interface to 2600Linux :-). 2601 2602But now you can ignore ALL boot loader code (in arch/ppc/mbxboot). 2603 2604Just make sure your machine specific header file (for instance 2605include/asm-ppc/tqm8xx.h) includes the same definition of the Board 2606Information structure as we define in include/u-boot.h, and make 2607sure that your definition of IMAP_ADDR uses the same value as your 2608U-Boot configuration in CFG_IMMR. 2609 2610 2611Configuring the Linux kernel: 2612----------------------------- 2613 2614No specific requirements for U-Boot. Make sure you have some root 2615device (initial ramdisk, NFS) for your target system. 2616 2617 2618Building a Linux Image: 2619----------------------- 2620 2621With U-Boot, "normal" build targets like "zImage" or "bzImage" are 2622not used. If you use recent kernel source, a new build target 2623"uImage" will exist which automatically builds an image usable by 2624U-Boot. Most older kernels also have support for a "pImage" target, 2625which was introduced for our predecessor project PPCBoot and uses a 2626100% compatible format. 2627 2628Example: 2629 2630 make TQM850L_config 2631 make oldconfig 2632 make dep 2633 make uImage 2634 2635The "uImage" build target uses a special tool (in 'tools/mkimage') to 2636encapsulate a compressed Linux kernel image with header information, 2637CRC32 checksum etc. for use with U-Boot. This is what we are doing: 2638 2639* build a standard "vmlinux" kernel image (in ELF binary format): 2640 2641* convert the kernel into a raw binary image: 2642 2643 ${CROSS_COMPILE}-objcopy -O binary \ 2644 -R .note -R .comment \ 2645 -S vmlinux linux.bin 2646 2647* compress the binary image: 2648 2649 gzip -9 linux.bin 2650 2651* package compressed binary image for U-Boot: 2652 2653 mkimage -A ppc -O linux -T kernel -C gzip \ 2654 -a 0 -e 0 -n "Linux Kernel Image" \ 2655 -d linux.bin.gz uImage 2656 2657 2658The "mkimage" tool can also be used to create ramdisk images for use 2659with U-Boot, either separated from the Linux kernel image, or 2660combined into one file. "mkimage" encapsulates the images with a 64 2661byte header containing information about target architecture, 2662operating system, image type, compression method, entry points, time 2663stamp, CRC32 checksums, etc. 2664 2665"mkimage" can be called in two ways: to verify existing images and 2666print the header information, or to build new images. 2667 2668In the first form (with "-l" option) mkimage lists the information 2669contained in the header of an existing U-Boot image; this includes 2670checksum verification: 2671 2672 tools/mkimage -l image 2673 -l ==> list image header information 2674 2675The second form (with "-d" option) is used to build a U-Boot image 2676from a "data file" which is used as image payload: 2677 2678 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 2679 -n name -d data_file image 2680 -A ==> set architecture to 'arch' 2681 -O ==> set operating system to 'os' 2682 -T ==> set image type to 'type' 2683 -C ==> set compression type 'comp' 2684 -a ==> set load address to 'addr' (hex) 2685 -e ==> set entry point to 'ep' (hex) 2686 -n ==> set image name to 'name' 2687 -d ==> use image data from 'datafile' 2688 2689Right now, all Linux kernels for PowerPC systems use the same load 2690address (0x00000000), but the entry point address depends on the 2691kernel version: 2692 2693- 2.2.x kernels have the entry point at 0x0000000C, 2694- 2.3.x and later kernels have the entry point at 0x00000000. 2695 2696So a typical call to build a U-Boot image would read: 2697 2698 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 2699 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 2700 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz \ 2701 > examples/uImage.TQM850L 2702 Image Name: 2.4.4 kernel for TQM850L 2703 Created: Wed Jul 19 02:34:59 2000 2704 Image Type: PowerPC Linux Kernel Image (gzip compressed) 2705 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 2706 Load Address: 0x00000000 2707 Entry Point: 0x00000000 2708 2709To verify the contents of the image (or check for corruption): 2710 2711 -> tools/mkimage -l examples/uImage.TQM850L 2712 Image Name: 2.4.4 kernel for TQM850L 2713 Created: Wed Jul 19 02:34:59 2000 2714 Image Type: PowerPC Linux Kernel Image (gzip compressed) 2715 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 2716 Load Address: 0x00000000 2717 Entry Point: 0x00000000 2718 2719NOTE: for embedded systems where boot time is critical you can trade 2720speed for memory and install an UNCOMPRESSED image instead: this 2721needs more space in Flash, but boots much faster since it does not 2722need to be uncompressed: 2723 2724 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux.gz 2725 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 2726 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 2727 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/ppc/coffboot/vmlinux \ 2728 > examples/uImage.TQM850L-uncompressed 2729 Image Name: 2.4.4 kernel for TQM850L 2730 Created: Wed Jul 19 02:34:59 2000 2731 Image Type: PowerPC Linux Kernel Image (uncompressed) 2732 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 2733 Load Address: 0x00000000 2734 Entry Point: 0x00000000 2735 2736 2737Similar you can build U-Boot images from a 'ramdisk.image.gz' file 2738when your kernel is intended to use an initial ramdisk: 2739 2740 -> tools/mkimage -n 'Simple Ramdisk Image' \ 2741 > -A ppc -O linux -T ramdisk -C gzip \ 2742 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 2743 Image Name: Simple Ramdisk Image 2744 Created: Wed Jan 12 14:01:50 2000 2745 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2746 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 2747 Load Address: 0x00000000 2748 Entry Point: 0x00000000 2749 2750 2751Installing a Linux Image: 2752------------------------- 2753 2754To downloading a U-Boot image over the serial (console) interface, 2755you must convert the image to S-Record format: 2756 2757 objcopy -I binary -O srec examples/image examples/image.srec 2758 2759The 'objcopy' does not understand the information in the U-Boot 2760image header, so the resulting S-Record file will be relative to 2761address 0x00000000. To load it to a given address, you need to 2762specify the target address as 'offset' parameter with the 'loads' 2763command. 2764 2765Example: install the image to address 0x40100000 (which on the 2766TQM8xxL is in the first Flash bank): 2767 2768 => erase 40100000 401FFFFF 2769 2770 .......... done 2771 Erased 8 sectors 2772 2773 => loads 40100000 2774 ## Ready for S-Record download ... 2775 ~>examples/image.srec 2776 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 2777 ... 2778 15989 15990 15991 15992 2779 [file transfer complete] 2780 [connected] 2781 ## Start Addr = 0x00000000 2782 2783 2784You can check the success of the download using the 'iminfo' command; 2785this includes a checksum verification so you can be sure no data 2786corruption happened: 2787 2788 => imi 40100000 2789 2790 ## Checking Image at 40100000 ... 2791 Image Name: 2.2.13 for initrd on TQM850L 2792 Image Type: PowerPC Linux Kernel Image (gzip compressed) 2793 Data Size: 335725 Bytes = 327 kB = 0 MB 2794 Load Address: 00000000 2795 Entry Point: 0000000c 2796 Verifying Checksum ... OK 2797 2798 2799Boot Linux: 2800----------- 2801 2802The "bootm" command is used to boot an application that is stored in 2803memory (RAM or Flash). In case of a Linux kernel image, the contents 2804of the "bootargs" environment variable is passed to the kernel as 2805parameters. You can check and modify this variable using the 2806"printenv" and "setenv" commands: 2807 2808 2809 => printenv bootargs 2810 bootargs=root=/dev/ram 2811 2812 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2813 2814 => printenv bootargs 2815 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2816 2817 => bootm 40020000 2818 ## Booting Linux kernel at 40020000 ... 2819 Image Name: 2.2.13 for NFS on TQM850L 2820 Image Type: PowerPC Linux Kernel Image (gzip compressed) 2821 Data Size: 381681 Bytes = 372 kB = 0 MB 2822 Load Address: 00000000 2823 Entry Point: 0000000c 2824 Verifying Checksum ... OK 2825 Uncompressing Kernel Image ... OK 2826 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000 2827 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 2828 time_init: decrementer frequency = 187500000/60 2829 Calibrating delay loop... 49.77 BogoMIPS 2830 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 2831 ... 2832 2833If you want to boot a Linux kernel with initial ram disk, you pass 2834the memory addresses of both the kernel and the initrd image (PPBCOOT 2835format!) to the "bootm" command: 2836 2837 => imi 40100000 40200000 2838 2839 ## Checking Image at 40100000 ... 2840 Image Name: 2.2.13 for initrd on TQM850L 2841 Image Type: PowerPC Linux Kernel Image (gzip compressed) 2842 Data Size: 335725 Bytes = 327 kB = 0 MB 2843 Load Address: 00000000 2844 Entry Point: 0000000c 2845 Verifying Checksum ... OK 2846 2847 ## Checking Image at 40200000 ... 2848 Image Name: Simple Ramdisk Image 2849 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2850 Data Size: 566530 Bytes = 553 kB = 0 MB 2851 Load Address: 00000000 2852 Entry Point: 00000000 2853 Verifying Checksum ... OK 2854 2855 => bootm 40100000 40200000 2856 ## Booting Linux kernel at 40100000 ... 2857 Image Name: 2.2.13 for initrd on TQM850L 2858 Image Type: PowerPC Linux Kernel Image (gzip compressed) 2859 Data Size: 335725 Bytes = 327 kB = 0 MB 2860 Load Address: 00000000 2861 Entry Point: 0000000c 2862 Verifying Checksum ... OK 2863 Uncompressing Kernel Image ... OK 2864 ## Loading RAMDisk Image at 40200000 ... 2865 Image Name: Simple Ramdisk Image 2866 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 2867 Data Size: 566530 Bytes = 553 kB = 0 MB 2868 Load Address: 00000000 2869 Entry Point: 00000000 2870 Verifying Checksum ... OK 2871 Loading Ramdisk ... OK 2872 Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000 2873 Boot arguments: root=/dev/ram 2874 time_init: decrementer frequency = 187500000/60 2875 Calibrating delay loop... 49.77 BogoMIPS 2876 ... 2877 RAMDISK: Compressed image found at block 0 2878 VFS: Mounted root (ext2 filesystem). 2879 2880 bash# 2881 2882More About U-Boot Image Types: 2883------------------------------ 2884 2885U-Boot supports the following image types: 2886 2887 "Standalone Programs" are directly runnable in the environment 2888 provided by U-Boot; it is expected that (if they behave 2889 well) you can continue to work in U-Boot after return from 2890 the Standalone Program. 2891 "OS Kernel Images" are usually images of some Embedded OS which 2892 will take over control completely. Usually these programs 2893 will install their own set of exception handlers, device 2894 drivers, set up the MMU, etc. - this means, that you cannot 2895 expect to re-enter U-Boot except by resetting the CPU. 2896 "RAMDisk Images" are more or less just data blocks, and their 2897 parameters (address, size) are passed to an OS kernel that is 2898 being started. 2899 "Multi-File Images" contain several images, typically an OS 2900 (Linux) kernel image and one or more data images like 2901 RAMDisks. This construct is useful for instance when you want 2902 to boot over the network using BOOTP etc., where the boot 2903 server provides just a single image file, but you want to get 2904 for instance an OS kernel and a RAMDisk image. 2905 2906 "Multi-File Images" start with a list of image sizes, each 2907 image size (in bytes) specified by an "uint32_t" in network 2908 byte order. This list is terminated by an "(uint32_t)0". 2909 Immediately after the terminating 0 follow the images, one by 2910 one, all aligned on "uint32_t" boundaries (size rounded up to 2911 a multiple of 4 bytes). 2912 2913 "Firmware Images" are binary images containing firmware (like 2914 U-Boot or FPGA images) which usually will be programmed to 2915 flash memory. 2916 2917 "Script files" are command sequences that will be executed by 2918 U-Boot's command interpreter; this feature is especially 2919 useful when you configure U-Boot to use a real shell (hush) 2920 as command interpreter. 2921 2922 2923Standalone HOWTO: 2924================= 2925 2926One of the features of U-Boot is that you can dynamically load and 2927run "standalone" applications, which can use some resources of 2928U-Boot like console I/O functions or interrupt services. 2929 2930Two simple examples are included with the sources: 2931 2932"Hello World" Demo: 2933------------------- 2934 2935'examples/hello_world.c' contains a small "Hello World" Demo 2936application; it is automatically compiled when you build U-Boot. 2937It's configured to run at address 0x00040004, so you can play with it 2938like that: 2939 2940 => loads 2941 ## Ready for S-Record download ... 2942 ~>examples/hello_world.srec 2943 1 2 3 4 5 6 7 8 9 10 11 ... 2944 [file transfer complete] 2945 [connected] 2946 ## Start Addr = 0x00040004 2947 2948 => go 40004 Hello World! This is a test. 2949 ## Starting application at 0x00040004 ... 2950 Hello World 2951 argc = 7 2952 argv[0] = "40004" 2953 argv[1] = "Hello" 2954 argv[2] = "World!" 2955 argv[3] = "This" 2956 argv[4] = "is" 2957 argv[5] = "a" 2958 argv[6] = "test." 2959 argv[7] = "<NULL>" 2960 Hit any key to exit ... 2961 2962 ## Application terminated, rc = 0x0 2963 2964Another example, which demonstrates how to register a CPM interrupt 2965handler with the U-Boot code, can be found in 'examples/timer.c'. 2966Here, a CPM timer is set up to generate an interrupt every second. 2967The interrupt service routine is trivial, just printing a '.' 2968character, but this is just a demo program. The application can be 2969controlled by the following keys: 2970 2971 ? - print current values og the CPM Timer registers 2972 b - enable interrupts and start timer 2973 e - stop timer and disable interrupts 2974 q - quit application 2975 2976 => loads 2977 ## Ready for S-Record download ... 2978 ~>examples/timer.srec 2979 1 2 3 4 5 6 7 8 9 10 11 ... 2980 [file transfer complete] 2981 [connected] 2982 ## Start Addr = 0x00040004 2983 2984 => go 40004 2985 ## Starting application at 0x00040004 ... 2986 TIMERS=0xfff00980 2987 Using timer 1 2988 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 2989 2990Hit 'b': 2991 [q, b, e, ?] Set interval 1000000 us 2992 Enabling timer 2993Hit '?': 2994 [q, b, e, ?] ........ 2995 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 2996Hit '?': 2997 [q, b, e, ?] . 2998 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 2999Hit '?': 3000 [q, b, e, ?] . 3001 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 3002Hit '?': 3003 [q, b, e, ?] . 3004 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 3005Hit 'e': 3006 [q, b, e, ?] ...Stopping timer 3007Hit 'q': 3008 [q, b, e, ?] ## Application terminated, rc = 0x0 3009 3010 3011Minicom warning: 3012================ 3013 3014Over time, many people have reported problems when trying to use the 3015"minicom" terminal emulation program for serial download. I (wd) 3016consider minicom to be broken, and recommend not to use it. Under 3017Unix, I recommend to use C-Kermit for general purpose use (and 3018especially for kermit binary protocol download ("loadb" command), and 3019use "cu" for S-Record download ("loads" command). 3020 3021Nevertheless, if you absolutely want to use it try adding this 3022configuration to your "File transfer protocols" section: 3023 3024 Name Program Name U/D FullScr IO-Red. Multi 3025 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 3026 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 3027 3028 3029NetBSD Notes: 3030============= 3031 3032Starting at version 0.9.2, U-Boot supports NetBSD both as host 3033(build U-Boot) and target system (boots NetBSD/mpc8xx). 3034 3035Building requires a cross environment; it is known to work on 3036NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 3037need gmake since the Makefiles are not compatible with BSD make). 3038Note that the cross-powerpc package does not install include files; 3039attempting to build U-Boot will fail because <machine/ansi.h> is 3040missing. This file has to be installed and patched manually: 3041 3042 # cd /usr/pkg/cross/powerpc-netbsd/include 3043 # mkdir powerpc 3044 # ln -s powerpc machine 3045 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 3046 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 3047 3048Native builds *don't* work due to incompatibilities between native 3049and U-Boot include files. 3050 3051Booting assumes that (the first part of) the image booted is a 3052stage-2 loader which in turn loads and then invokes the kernel 3053proper. Loader sources will eventually appear in the NetBSD source 3054tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 3055meantime, send mail to bruno@exet-ag.de and/or wd@denx.de for 3056details. 3057 3058 3059Implementation Internals: 3060========================= 3061 3062The following is not intended to be a complete description of every 3063implementation detail. However, it should help to understand the 3064inner workings of U-Boot and make it easier to port it to custom 3065hardware. 3066 3067 3068Initial Stack, Global Data: 3069--------------------------- 3070 3071The implementation of U-Boot is complicated by the fact that U-Boot 3072starts running out of ROM (flash memory), usually without access to 3073system RAM (because the memory controller is not initialized yet). 3074This means that we don't have writable Data or BSS segments, and BSS 3075is not initialized as zero. To be able to get a C environment working 3076at all, we have to allocate at least a minimal stack. Implementation 3077options for this are defined and restricted by the CPU used: Some CPU 3078models provide on-chip memory (like the IMMR area on MPC8xx and 3079MPC826x processors), on others (parts of) the data cache can be 3080locked as (mis-) used as memory, etc. 3081 3082 Chris Hallinan posted a good summary of these issues to the 3083 u-boot-users mailing list: 3084 3085 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 3086 From: "Chris Hallinan" <clh@net1plus.com> 3087 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 3088 ... 3089 3090 Correct me if I'm wrong, folks, but the way I understand it 3091 is this: Using DCACHE as initial RAM for Stack, etc, does not 3092 require any physical RAM backing up the cache. The cleverness 3093 is that the cache is being used as a temporary supply of 3094 necessary storage before the SDRAM controller is setup. It's 3095 beyond the scope of this list to expain the details, but you 3096 can see how this works by studying the cache architecture and 3097 operation in the architecture and processor-specific manuals. 3098 3099 OCM is On Chip Memory, which I believe the 405GP has 4K. It 3100 is another option for the system designer to use as an 3101 initial stack/ram area prior to SDRAM being available. Either 3102 option should work for you. Using CS 4 should be fine if your 3103 board designers haven't used it for something that would 3104 cause you grief during the initial boot! It is frequently not 3105 used. 3106 3107 CFG_INIT_RAM_ADDR should be somewhere that won't interfere 3108 with your processor/board/system design. The default value 3109 you will find in any recent u-boot distribution in 3110 Walnut405.h should work for you. I'd set it to a value larger 3111 than your SDRAM module. If you have a 64MB SDRAM module, set 3112 it above 400_0000. Just make sure your board has no resources 3113 that are supposed to respond to that address! That code in 3114 start.S has been around a while and should work as is when 3115 you get the config right. 3116 3117 -Chris Hallinan 3118 DS4.COM, Inc. 3119 3120It is essential to remember this, since it has some impact on the C 3121code for the initialization procedures: 3122 3123* Initialized global data (data segment) is read-only. Do not attempt 3124 to write it. 3125 3126* Do not use any unitialized global data (or implicitely initialized 3127 as zero data - BSS segment) at all - this is undefined, initiali- 3128 zation is performed later (when relocating to RAM). 3129 3130* Stack space is very limited. Avoid big data buffers or things like 3131 that. 3132 3133Having only the stack as writable memory limits means we cannot use 3134normal global data to share information beween the code. But it 3135turned out that the implementation of U-Boot can be greatly 3136simplified by making a global data structure (gd_t) available to all 3137functions. We could pass a pointer to this data as argument to _all_ 3138functions, but this would bloat the code. Instead we use a feature of 3139the GCC compiler (Global Register Variables) to share the data: we 3140place a pointer (gd) to the global data into a register which we 3141reserve for this purpose. 3142 3143When choosing a register for such a purpose we are restricted by the 3144relevant (E)ABI specifications for the current architecture, and by 3145GCC's implementation. 3146 3147For PowerPC, the following registers have specific use: 3148 R1: stack pointer 3149 R2: TOC pointer 3150 R3-R4: parameter passing and return values 3151 R5-R10: parameter passing 3152 R13: small data area pointer 3153 R30: GOT pointer 3154 R31: frame pointer 3155 3156 (U-Boot also uses R14 as internal GOT pointer.) 3157 3158 ==> U-Boot will use R29 to hold a pointer to the global data 3159 3160 Note: on PPC, we could use a static initializer (since the 3161 address of the global data structure is known at compile time), 3162 but it turned out that reserving a register results in somewhat 3163 smaller code - although the code savings are not that big (on 3164 average for all boards 752 bytes for the whole U-Boot image, 3165 624 text + 127 data). 3166 3167On ARM, the following registers are used: 3168 3169 R0: function argument word/integer result 3170 R1-R3: function argument word 3171 R9: GOT pointer 3172 R10: stack limit (used only if stack checking if enabled) 3173 R11: argument (frame) pointer 3174 R12: temporary workspace 3175 R13: stack pointer 3176 R14: link register 3177 R15: program counter 3178 3179 ==> U-Boot will use R8 to hold a pointer to the global data 3180 3181 3182Memory Management: 3183------------------ 3184 3185U-Boot runs in system state and uses physical addresses, i.e. the 3186MMU is not used either for address mapping nor for memory protection. 3187 3188The available memory is mapped to fixed addresses using the memory 3189controller. In this process, a contiguous block is formed for each 3190memory type (Flash, SDRAM, SRAM), even when it consists of several 3191physical memory banks. 3192 3193U-Boot is installed in the first 128 kB of the first Flash bank (on 3194TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 3195booting and sizing and initializing DRAM, the code relocates itself 3196to the upper end of DRAM. Immediately below the U-Boot code some 3197memory is reserved for use by malloc() [see CFG_MALLOC_LEN 3198configuration setting]. Below that, a structure with global Board 3199Info data is placed, followed by the stack (growing downward). 3200 3201Additionally, some exception handler code is copied to the low 8 kB 3202of DRAM (0x00000000 ... 0x00001FFF). 3203 3204So a typical memory configuration with 16 MB of DRAM could look like 3205this: 3206 3207 0x0000 0000 Exception Vector code 3208 : 3209 0x0000 1FFF 3210 0x0000 2000 Free for Application Use 3211 : 3212 : 3213 3214 : 3215 : 3216 0x00FB FF20 Monitor Stack (Growing downward) 3217 0x00FB FFAC Board Info Data and permanent copy of global data 3218 0x00FC 0000 Malloc Arena 3219 : 3220 0x00FD FFFF 3221 0x00FE 0000 RAM Copy of Monitor Code 3222 ... eventually: LCD or video framebuffer 3223 ... eventually: pRAM (Protected RAM - unchanged by reset) 3224 0x00FF FFFF [End of RAM] 3225 3226 3227System Initialization: 3228---------------------- 3229 3230In the reset configuration, U-Boot starts at the reset entry point 3231(on most PowerPC systens at address 0x00000100). Because of the reset 3232configuration for CS0# this is a mirror of the onboard Flash memory. 3233To be able to re-map memory U-Boot then jumps to its link address. 3234To be able to implement the initialization code in C, a (small!) 3235initial stack is set up in the internal Dual Ported RAM (in case CPUs 3236which provide such a feature like MPC8xx or MPC8260), or in a locked 3237part of the data cache. After that, U-Boot initializes the CPU core, 3238the caches and the SIU. 3239 3240Next, all (potentially) available memory banks are mapped using a 3241preliminary mapping. For example, we put them on 512 MB boundaries 3242(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 3243on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 3244programmed for SDRAM access. Using the temporary configuration, a 3245simple memory test is run that determines the size of the SDRAM 3246banks. 3247 3248When there is more than one SDRAM bank, and the banks are of 3249different size, the largest is mapped first. For equal size, the first 3250bank (CS2#) is mapped first. The first mapping is always for address 32510x00000000, with any additional banks following immediately to create 3252contiguous memory starting from 0. 3253 3254Then, the monitor installs itself at the upper end of the SDRAM area 3255and allocates memory for use by malloc() and for the global Board 3256Info data; also, the exception vector code is copied to the low RAM 3257pages, and the final stack is set up. 3258 3259Only after this relocation will you have a "normal" C environment; 3260until that you are restricted in several ways, mostly because you are 3261running from ROM, and because the code will have to be relocated to a 3262new address in RAM. 3263 3264 3265U-Boot Porting Guide: 3266---------------------- 3267 3268[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 3269list, October 2002] 3270 3271 3272int main (int argc, char *argv[]) 3273{ 3274 sighandler_t no_more_time; 3275 3276 signal (SIGALRM, no_more_time); 3277 alarm (PROJECT_DEADLINE - toSec (3 * WEEK)); 3278 3279 if (available_money > available_manpower) { 3280 pay consultant to port U-Boot; 3281 return 0; 3282 } 3283 3284 Download latest U-Boot source; 3285 3286 Subscribe to u-boot-users mailing list; 3287 3288 if (clueless) { 3289 email ("Hi, I am new to U-Boot, how do I get started?"); 3290 } 3291 3292 while (learning) { 3293 Read the README file in the top level directory; 3294 Read http://www.denx.de/twiki/bin/view/DULG/Manual ; 3295 Read the source, Luke; 3296 } 3297 3298 if (available_money > toLocalCurrency ($2500)) { 3299 Buy a BDI2000; 3300 } else { 3301 Add a lot of aggravation and time; 3302 } 3303 3304 Create your own board support subdirectory; 3305 3306 Create your own board config file; 3307 3308 while (!running) { 3309 do { 3310 Add / modify source code; 3311 } until (compiles); 3312 Debug; 3313 if (clueless) 3314 email ("Hi, I am having problems..."); 3315 } 3316 Send patch file to Wolfgang; 3317 3318 return 0; 3319} 3320 3321void no_more_time (int sig) 3322{ 3323 hire_a_guru(); 3324} 3325 3326 3327Coding Standards: 3328----------------- 3329 3330All contributions to U-Boot should conform to the Linux kernel 3331coding style; see the file "Documentation/CodingStyle" in your Linux 3332kernel source directory. 3333 3334Please note that U-Boot is implemented in C (and to some small parts 3335in Assembler); no C++ is used, so please do not use C++ style 3336comments (//) in your code. 3337 3338Please also stick to the following formatting rules: 3339- remove any trailing white space 3340- use TAB characters for indentation, not spaces 3341- make sure NOT to use DOS '\r\n' line feeds 3342- do not add more than 2 empty lines to source files 3343- do not add trailing empty lines to source files 3344 3345Submissions which do not conform to the standards may be returned 3346with a request to reformat the changes. 3347 3348 3349Submitting Patches: 3350------------------- 3351 3352Since the number of patches for U-Boot is growing, we need to 3353establish some rules. Submissions which do not conform to these rules 3354may be rejected, even when they contain important and valuable stuff. 3355 3356 3357When you send a patch, please include the following information with 3358it: 3359 3360* For bug fixes: a description of the bug and how your patch fixes 3361 this bug. Please try to include a way of demonstrating that the 3362 patch actually fixes something. 3363 3364* For new features: a description of the feature and your 3365 implementation. 3366 3367* A CHANGELOG entry as plaintext (separate from the patch) 3368 3369* For major contributions, your entry to the CREDITS file 3370 3371* When you add support for a new board, don't forget to add this 3372 board to the MAKEALL script, too. 3373 3374* If your patch adds new configuration options, don't forget to 3375 document these in the README file. 3376 3377* The patch itself. If you are accessing the CVS repository use "cvs 3378 update; cvs diff -puRN"; else, use "diff -purN OLD NEW". If your 3379 version of diff does not support these options, then get the latest 3380 version of GNU diff. 3381 3382 The current directory when running this command shall be the top 3383 level directory of the U-Boot source tree, or it's parent directory 3384 (i. e. please make sure that your patch includes sufficient 3385 directory information for the affected files). 3386 3387 We accept patches as plain text, MIME attachments or as uuencoded 3388 gzipped text. 3389 3390* If one logical set of modifications affects or creates several 3391 files, all these changes shall be submitted in a SINGLE patch file. 3392 3393* Changesets that contain different, unrelated modifications shall be 3394 submitted as SEPARATE patches, one patch per changeset. 3395 3396 3397Notes: 3398 3399* Before sending the patch, run the MAKEALL script on your patched 3400 source tree and make sure that no errors or warnings are reported 3401 for any of the boards. 3402 3403* Keep your modifications to the necessary minimum: A patch 3404 containing several unrelated changes or arbitrary reformats will be 3405 returned with a request to re-formatting / split it. 3406 3407* If you modify existing code, make sure that your new code does not 3408 add to the memory footprint of the code ;-) Small is beautiful! 3409 When adding new features, these should compile conditionally only 3410 (using #ifdef), and the resulting code with the new feature 3411 disabled must not need more memory than the old code without your 3412 modification. 3413