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