1# 2# (C) Copyright 2000 - 2011 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. The MAINTAINERS file lists board 55maintainers. 56 57 58Where to get help: 59================== 60 61In case you have questions about, problems with or contributions for 62U-Boot you should send a message to the U-Boot mailing list at 63<u-boot@lists.denx.de>. There is also an archive of previous traffic 64on the mailing list - please search the archive before asking FAQ's. 65Please see http://lists.denx.de/pipermail/u-boot and 66http://dir.gmane.org/gmane.comp.boot-loaders.u-boot 67 68 69Where to get source code: 70========================= 71 72The U-Boot source code is maintained in the git repository at 73git://www.denx.de/git/u-boot.git ; you can browse it online at 74http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 75 76The "snapshot" links on this page allow you to download tarballs of 77any version you might be interested in. Official releases are also 78available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 79directory. 80 81Pre-built (and tested) images are available from 82ftp://ftp.denx.de/pub/u-boot/images/ 83 84 85Where we come from: 86=================== 87 88- start from 8xxrom sources 89- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 90- clean up code 91- make it easier to add custom boards 92- make it possible to add other [PowerPC] CPUs 93- extend functions, especially: 94 * Provide extended interface to Linux boot loader 95 * S-Record download 96 * network boot 97 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 98- create ARMBoot project (http://sourceforge.net/projects/armboot) 99- add other CPU families (starting with ARM) 100- create U-Boot project (http://sourceforge.net/projects/u-boot) 101- current project page: see http://www.denx.de/wiki/U-Boot 102 103 104Names and Spelling: 105=================== 106 107The "official" name of this project is "Das U-Boot". The spelling 108"U-Boot" shall be used in all written text (documentation, comments 109in source files etc.). Example: 110 111 This is the README file for the U-Boot project. 112 113File names etc. shall be based on the string "u-boot". Examples: 114 115 include/asm-ppc/u-boot.h 116 117 #include <asm/u-boot.h> 118 119Variable names, preprocessor constants etc. shall be either based on 120the string "u_boot" or on "U_BOOT". Example: 121 122 U_BOOT_VERSION u_boot_logo 123 IH_OS_U_BOOT u_boot_hush_start 124 125 126Versioning: 127=========== 128 129Starting with the release in October 2008, the names of the releases 130were changed from numerical release numbers without deeper meaning 131into a time stamp based numbering. Regular releases are identified by 132names consisting of the calendar year and month of the release date. 133Additional fields (if present) indicate release candidates or bug fix 134releases in "stable" maintenance trees. 135 136Examples: 137 U-Boot v2009.11 - Release November 2009 138 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 139 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 140 141 142Directory Hierarchy: 143==================== 144 145/arch Architecture specific files 146 /arm Files generic to ARM architecture 147 /cpu CPU specific files 148 /arm720t Files specific to ARM 720 CPUs 149 /arm920t Files specific to ARM 920 CPUs 150 /at91rm9200 Files specific to Atmel AT91RM9200 CPU 151 /imx Files specific to Freescale MC9328 i.MX CPUs 152 /s3c24x0 Files specific to Samsung S3C24X0 CPUs 153 /arm925t Files specific to ARM 925 CPUs 154 /arm926ejs Files specific to ARM 926 CPUs 155 /arm1136 Files specific to ARM 1136 CPUs 156 /ixp Files specific to Intel XScale IXP CPUs 157 /pxa Files specific to Intel XScale PXA CPUs 158 /s3c44b0 Files specific to Samsung S3C44B0 CPUs 159 /sa1100 Files specific to Intel StrongARM SA1100 CPUs 160 /lib Architecture specific library files 161 /avr32 Files generic to AVR32 architecture 162 /cpu CPU specific files 163 /lib Architecture specific library files 164 /blackfin Files generic to Analog Devices Blackfin architecture 165 /cpu CPU specific files 166 /lib Architecture specific library files 167 /x86 Files generic to x86 architecture 168 /cpu CPU specific files 169 /lib Architecture specific library files 170 /m68k Files generic to m68k architecture 171 /cpu CPU specific files 172 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 173 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 174 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 175 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 176 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 177 /lib Architecture specific library files 178 /microblaze Files generic to microblaze architecture 179 /cpu CPU specific files 180 /lib Architecture specific library files 181 /mips Files generic to MIPS architecture 182 /cpu CPU specific files 183 /lib Architecture specific library files 184 /nios2 Files generic to Altera NIOS2 architecture 185 /cpu CPU specific files 186 /lib Architecture specific library files 187 /powerpc Files generic to PowerPC architecture 188 /cpu CPU specific files 189 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 190 /mpc5xx Files specific to Freescale MPC5xx CPUs 191 /mpc5xxx Files specific to Freescale MPC5xxx CPUs 192 /mpc8xx Files specific to Freescale MPC8xx CPUs 193 /mpc8220 Files specific to Freescale MPC8220 CPUs 194 /mpc824x Files specific to Freescale MPC824x CPUs 195 /mpc8260 Files specific to Freescale MPC8260 CPUs 196 /mpc85xx Files specific to Freescale MPC85xx CPUs 197 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 198 /lib Architecture specific library files 199 /sh Files generic to SH architecture 200 /cpu CPU specific files 201 /sh2 Files specific to sh2 CPUs 202 /sh3 Files specific to sh3 CPUs 203 /sh4 Files specific to sh4 CPUs 204 /lib Architecture specific library files 205 /sparc Files generic to SPARC architecture 206 /cpu CPU specific files 207 /leon2 Files specific to Gaisler LEON2 SPARC CPU 208 /leon3 Files specific to Gaisler LEON3 SPARC CPU 209 /lib Architecture specific library files 210/api Machine/arch independent API for external apps 211/board Board dependent files 212/common Misc architecture independent functions 213/disk Code for disk drive partition handling 214/doc Documentation (don't expect too much) 215/drivers Commonly used device drivers 216/examples Example code for standalone applications, etc. 217/fs Filesystem code (cramfs, ext2, jffs2, etc.) 218/include Header Files 219/lib Files generic to all architectures 220 /libfdt Library files to support flattened device trees 221 /lzma Library files to support LZMA decompression 222 /lzo Library files to support LZO decompression 223/net Networking code 224/post Power On Self Test 225/rtc Real Time Clock drivers 226/tools Tools to build S-Record or U-Boot images, etc. 227 228Software Configuration: 229======================= 230 231Configuration is usually done using C preprocessor defines; the 232rationale behind that is to avoid dead code whenever possible. 233 234There are two classes of configuration variables: 235 236* Configuration _OPTIONS_: 237 These are selectable by the user and have names beginning with 238 "CONFIG_". 239 240* Configuration _SETTINGS_: 241 These depend on the hardware etc. and should not be meddled with if 242 you don't know what you're doing; they have names beginning with 243 "CONFIG_SYS_". 244 245Later we will add a configuration tool - probably similar to or even 246identical to what's used for the Linux kernel. Right now, we have to 247do the configuration by hand, which means creating some symbolic 248links and editing some configuration files. We use the TQM8xxL boards 249as an example here. 250 251 252Selection of Processor Architecture and Board Type: 253--------------------------------------------------- 254 255For all supported boards there are ready-to-use default 256configurations available; just type "make <board_name>_config". 257 258Example: For a TQM823L module type: 259 260 cd u-boot 261 make TQM823L_config 262 263For the Cogent platform, you need to specify the CPU type as well; 264e.g. "make cogent_mpc8xx_config". And also configure the cogent 265directory according to the instructions in cogent/README. 266 267 268Configuration Options: 269---------------------- 270 271Configuration depends on the combination of board and CPU type; all 272such information is kept in a configuration file 273"include/configs/<board_name>.h". 274 275Example: For a TQM823L module, all configuration settings are in 276"include/configs/TQM823L.h". 277 278 279Many of the options are named exactly as the corresponding Linux 280kernel configuration options. The intention is to make it easier to 281build a config tool - later. 282 283 284The following options need to be configured: 285 286- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 287 288- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 289 290- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 291 Define exactly one, e.g. CONFIG_ATSTK1002 292 293- CPU Module Type: (if CONFIG_COGENT is defined) 294 Define exactly one of 295 CONFIG_CMA286_60_OLD 296--- FIXME --- not tested yet: 297 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 298 CONFIG_CMA287_23, CONFIG_CMA287_50 299 300- Motherboard Type: (if CONFIG_COGENT is defined) 301 Define exactly one of 302 CONFIG_CMA101, CONFIG_CMA102 303 304- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 305 Define one or more of 306 CONFIG_CMA302 307 308- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 309 Define one or more of 310 CONFIG_LCD_HEARTBEAT - update a character position on 311 the LCD display every second with 312 a "rotator" |\-/|\-/ 313 314- Board flavour: (if CONFIG_MPC8260ADS is defined) 315 CONFIG_ADSTYPE 316 Possible values are: 317 CONFIG_SYS_8260ADS - original MPC8260ADS 318 CONFIG_SYS_8266ADS - MPC8266ADS 319 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 320 CONFIG_SYS_8272ADS - MPC8272ADS 321 322- Marvell Family Member 323 CONFIG_SYS_MVFS - define it if you want to enable 324 multiple fs option at one time 325 for marvell soc family 326 327- MPC824X Family Member (if CONFIG_MPC824X is defined) 328 Define exactly one of 329 CONFIG_MPC8240, CONFIG_MPC8245 330 331- 8xx CPU Options: (if using an MPC8xx CPU) 332 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 333 get_gclk_freq() cannot work 334 e.g. if there is no 32KHz 335 reference PIT/RTC clock 336 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 337 or XTAL/EXTAL) 338 339- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 340 CONFIG_SYS_8xx_CPUCLK_MIN 341 CONFIG_SYS_8xx_CPUCLK_MAX 342 CONFIG_8xx_CPUCLK_DEFAULT 343 See doc/README.MPC866 344 345 CONFIG_SYS_MEASURE_CPUCLK 346 347 Define this to measure the actual CPU clock instead 348 of relying on the correctness of the configured 349 values. Mostly useful for board bringup to make sure 350 the PLL is locked at the intended frequency. Note 351 that this requires a (stable) reference clock (32 kHz 352 RTC clock or CONFIG_SYS_8XX_XIN) 353 354 CONFIG_SYS_DELAYED_ICACHE 355 356 Define this option if you want to enable the 357 ICache only when Code runs from RAM. 358 359- 85xx CPU Options: 360 CONFIG_SYS_FSL_TBCLK_DIV 361 362 Defines the core time base clock divider ratio compared to the 363 system clock. On most PQ3 devices this is 8, on newer QorIQ 364 devices it can be 16 or 32. The ratio varies from SoC to Soc. 365 366 CONFIG_SYS_FSL_PCIE_COMPAT 367 368 Defines the string to utilize when trying to match PCIe device 369 tree nodes for the given platform. 370 371- Intel Monahans options: 372 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 373 374 Defines the Monahans run mode to oscillator 375 ratio. Valid values are 8, 16, 24, 31. The core 376 frequency is this value multiplied by 13 MHz. 377 378 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 379 380 Defines the Monahans turbo mode to oscillator 381 ratio. Valid values are 1 (default if undefined) and 382 2. The core frequency as calculated above is multiplied 383 by this value. 384 385- Linux Kernel Interface: 386 CONFIG_CLOCKS_IN_MHZ 387 388 U-Boot stores all clock information in Hz 389 internally. For binary compatibility with older Linux 390 kernels (which expect the clocks passed in the 391 bd_info data to be in MHz) the environment variable 392 "clocks_in_mhz" can be defined so that U-Boot 393 converts clock data to MHZ before passing it to the 394 Linux kernel. 395 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 396 "clocks_in_mhz=1" is automatically included in the 397 default environment. 398 399 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 400 401 When transferring memsize parameter to linux, some versions 402 expect it to be in bytes, others in MB. 403 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 404 405 CONFIG_OF_LIBFDT 406 407 New kernel versions are expecting firmware settings to be 408 passed using flattened device trees (based on open firmware 409 concepts). 410 411 CONFIG_OF_LIBFDT 412 * New libfdt-based support 413 * Adds the "fdt" command 414 * The bootm command automatically updates the fdt 415 416 OF_CPU - The proper name of the cpus node (only required for 417 MPC512X and MPC5xxx based boards). 418 OF_SOC - The proper name of the soc node (only required for 419 MPC512X and MPC5xxx based boards). 420 OF_TBCLK - The timebase frequency. 421 OF_STDOUT_PATH - The path to the console device 422 423 boards with QUICC Engines require OF_QE to set UCC MAC 424 addresses 425 426 CONFIG_OF_BOARD_SETUP 427 428 Board code has addition modification that it wants to make 429 to the flat device tree before handing it off to the kernel 430 431 CONFIG_OF_BOOT_CPU 432 433 This define fills in the correct boot CPU in the boot 434 param header, the default value is zero if undefined. 435 436 CONFIG_OF_IDE_FIXUP 437 438 U-Boot can detect if an IDE device is present or not. 439 If not, and this new config option is activated, U-Boot 440 removes the ATA node from the DTS before booting Linux, 441 so the Linux IDE driver does not probe the device and 442 crash. This is needed for buggy hardware (uc101) where 443 no pull down resistor is connected to the signal IDE5V_DD7. 444 445- vxWorks boot parameters: 446 447 bootvx constructs a valid bootline using the following 448 environments variables: bootfile, ipaddr, serverip, hostname. 449 It loads the vxWorks image pointed bootfile. 450 451 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 452 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 453 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 454 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 455 456 CONFIG_SYS_VXWORKS_ADD_PARAMS 457 458 Add it at the end of the bootline. E.g "u=username pw=secret" 459 460 Note: If a "bootargs" environment is defined, it will overwride 461 the defaults discussed just above. 462 463- Cache Configuration: 464 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 465 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 466 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 467 468- Cache Configuration for ARM: 469 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 470 controller 471 CONFIG_SYS_PL310_BASE - Physical base address of PL310 472 controller register space 473 474- Serial Ports: 475 CONFIG_PL010_SERIAL 476 477 Define this if you want support for Amba PrimeCell PL010 UARTs. 478 479 CONFIG_PL011_SERIAL 480 481 Define this if you want support for Amba PrimeCell PL011 UARTs. 482 483 CONFIG_PL011_CLOCK 484 485 If you have Amba PrimeCell PL011 UARTs, set this variable to 486 the clock speed of the UARTs. 487 488 CONFIG_PL01x_PORTS 489 490 If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 491 define this to a list of base addresses for each (supported) 492 port. See e.g. include/configs/versatile.h 493 494 CONFIG_PL011_SERIAL_RLCR 495 496 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 497 have separate receive and transmit line control registers. Set 498 this variable to initialize the extra register. 499 500 CONFIG_PL011_SERIAL_FLUSH_ON_INIT 501 502 On some platforms (e.g. U8500) U-Boot is loaded by a second stage 503 boot loader that has already initialized the UART. Define this 504 variable to flush the UART at init time. 505 506 507- Console Interface: 508 Depending on board, define exactly one serial port 509 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 510 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 511 console by defining CONFIG_8xx_CONS_NONE 512 513 Note: if CONFIG_8xx_CONS_NONE is defined, the serial 514 port routines must be defined elsewhere 515 (i.e. serial_init(), serial_getc(), ...) 516 517 CONFIG_CFB_CONSOLE 518 Enables console device for a color framebuffer. Needs following 519 defines (cf. smiLynxEM, i8042, board/eltec/bab7xx) 520 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 521 (default big endian) 522 VIDEO_HW_RECTFILL graphic chip supports 523 rectangle fill 524 (cf. smiLynxEM) 525 VIDEO_HW_BITBLT graphic chip supports 526 bit-blit (cf. smiLynxEM) 527 VIDEO_VISIBLE_COLS visible pixel columns 528 (cols=pitch) 529 VIDEO_VISIBLE_ROWS visible pixel rows 530 VIDEO_PIXEL_SIZE bytes per pixel 531 VIDEO_DATA_FORMAT graphic data format 532 (0-5, cf. cfb_console.c) 533 VIDEO_FB_ADRS framebuffer address 534 VIDEO_KBD_INIT_FCT keyboard int fct 535 (i.e. i8042_kbd_init()) 536 VIDEO_TSTC_FCT test char fct 537 (i.e. i8042_tstc) 538 VIDEO_GETC_FCT get char fct 539 (i.e. i8042_getc) 540 CONFIG_CONSOLE_CURSOR cursor drawing on/off 541 (requires blink timer 542 cf. i8042.c) 543 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 544 CONFIG_CONSOLE_TIME display time/date info in 545 upper right corner 546 (requires CONFIG_CMD_DATE) 547 CONFIG_VIDEO_LOGO display Linux logo in 548 upper left corner 549 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 550 linux_logo.h for logo. 551 Requires CONFIG_VIDEO_LOGO 552 CONFIG_CONSOLE_EXTRA_INFO 553 additional board info beside 554 the logo 555 556 When CONFIG_CFB_CONSOLE is defined, video console is 557 default i/o. Serial console can be forced with 558 environment 'console=serial'. 559 560 When CONFIG_SILENT_CONSOLE is defined, all console 561 messages (by U-Boot and Linux!) can be silenced with 562 the "silent" environment variable. See 563 doc/README.silent for more information. 564 565- Console Baudrate: 566 CONFIG_BAUDRATE - in bps 567 Select one of the baudrates listed in 568 CONFIG_SYS_BAUDRATE_TABLE, see below. 569 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 570 571- Console Rx buffer length 572 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 573 the maximum receive buffer length for the SMC. 574 This option is actual only for 82xx and 8xx possible. 575 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 576 must be defined, to setup the maximum idle timeout for 577 the SMC. 578 579- Boot Delay: CONFIG_BOOTDELAY - in seconds 580 Delay before automatically booting the default image; 581 set to -1 to disable autoboot. 582 583 See doc/README.autoboot for these options that 584 work with CONFIG_BOOTDELAY. None are required. 585 CONFIG_BOOT_RETRY_TIME 586 CONFIG_BOOT_RETRY_MIN 587 CONFIG_AUTOBOOT_KEYED 588 CONFIG_AUTOBOOT_PROMPT 589 CONFIG_AUTOBOOT_DELAY_STR 590 CONFIG_AUTOBOOT_STOP_STR 591 CONFIG_AUTOBOOT_DELAY_STR2 592 CONFIG_AUTOBOOT_STOP_STR2 593 CONFIG_ZERO_BOOTDELAY_CHECK 594 CONFIG_RESET_TO_RETRY 595 596- Autoboot Command: 597 CONFIG_BOOTCOMMAND 598 Only needed when CONFIG_BOOTDELAY is enabled; 599 define a command string that is automatically executed 600 when no character is read on the console interface 601 within "Boot Delay" after reset. 602 603 CONFIG_BOOTARGS 604 This can be used to pass arguments to the bootm 605 command. The value of CONFIG_BOOTARGS goes into the 606 environment value "bootargs". 607 608 CONFIG_RAMBOOT and CONFIG_NFSBOOT 609 The value of these goes into the environment as 610 "ramboot" and "nfsboot" respectively, and can be used 611 as a convenience, when switching between booting from 612 RAM and NFS. 613 614- Pre-Boot Commands: 615 CONFIG_PREBOOT 616 617 When this option is #defined, the existence of the 618 environment variable "preboot" will be checked 619 immediately before starting the CONFIG_BOOTDELAY 620 countdown and/or running the auto-boot command resp. 621 entering interactive mode. 622 623 This feature is especially useful when "preboot" is 624 automatically generated or modified. For an example 625 see the LWMON board specific code: here "preboot" is 626 modified when the user holds down a certain 627 combination of keys on the (special) keyboard when 628 booting the systems 629 630- Serial Download Echo Mode: 631 CONFIG_LOADS_ECHO 632 If defined to 1, all characters received during a 633 serial download (using the "loads" command) are 634 echoed back. This might be needed by some terminal 635 emulations (like "cu"), but may as well just take 636 time on others. This setting #define's the initial 637 value of the "loads_echo" environment variable. 638 639- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 640 CONFIG_KGDB_BAUDRATE 641 Select one of the baudrates listed in 642 CONFIG_SYS_BAUDRATE_TABLE, see below. 643 644- Monitor Functions: 645 Monitor commands can be included or excluded 646 from the build by using the #include files 647 "config_cmd_all.h" and #undef'ing unwanted 648 commands, or using "config_cmd_default.h" 649 and augmenting with additional #define's 650 for wanted commands. 651 652 The default command configuration includes all commands 653 except those marked below with a "*". 654 655 CONFIG_CMD_ASKENV * ask for env variable 656 CONFIG_CMD_BDI bdinfo 657 CONFIG_CMD_BEDBUG * Include BedBug Debugger 658 CONFIG_CMD_BMP * BMP support 659 CONFIG_CMD_BSP * Board specific commands 660 CONFIG_CMD_BOOTD bootd 661 CONFIG_CMD_CACHE * icache, dcache 662 CONFIG_CMD_CONSOLE coninfo 663 CONFIG_CMD_CRC32 * crc32 664 CONFIG_CMD_DATE * support for RTC, date/time... 665 CONFIG_CMD_DHCP * DHCP support 666 CONFIG_CMD_DIAG * Diagnostics 667 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 668 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 669 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 670 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 671 CONFIG_CMD_DTT * Digital Therm and Thermostat 672 CONFIG_CMD_ECHO echo arguments 673 CONFIG_CMD_EDITENV edit env variable 674 CONFIG_CMD_EEPROM * EEPROM read/write support 675 CONFIG_CMD_ELF * bootelf, bootvx 676 CONFIG_CMD_EXPORTENV * export the environment 677 CONFIG_CMD_SAVEENV saveenv 678 CONFIG_CMD_FDC * Floppy Disk Support 679 CONFIG_CMD_FAT * FAT partition support 680 CONFIG_CMD_FDOS * Dos diskette Support 681 CONFIG_CMD_FLASH flinfo, erase, protect 682 CONFIG_CMD_FPGA FPGA device initialization support 683 CONFIG_CMD_GO * the 'go' command (exec code) 684 CONFIG_CMD_GREPENV * search environment 685 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 686 CONFIG_CMD_I2C * I2C serial bus support 687 CONFIG_CMD_IDE * IDE harddisk support 688 CONFIG_CMD_IMI iminfo 689 CONFIG_CMD_IMLS List all found images 690 CONFIG_CMD_IMMAP * IMMR dump support 691 CONFIG_CMD_IMPORTENV * import an environment 692 CONFIG_CMD_IRQ * irqinfo 693 CONFIG_CMD_ITEST Integer/string test of 2 values 694 CONFIG_CMD_JFFS2 * JFFS2 Support 695 CONFIG_CMD_KGDB * kgdb 696 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 697 CONFIG_CMD_LOADB loadb 698 CONFIG_CMD_LOADS loads 699 CONFIG_CMD_MD5SUM print md5 message digest 700 (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 701 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 702 loop, loopw, mtest 703 CONFIG_CMD_MISC Misc functions like sleep etc 704 CONFIG_CMD_MMC * MMC memory mapped support 705 CONFIG_CMD_MII * MII utility commands 706 CONFIG_CMD_MTDPARTS * MTD partition support 707 CONFIG_CMD_NAND * NAND support 708 CONFIG_CMD_NET bootp, tftpboot, rarpboot 709 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 710 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 711 CONFIG_CMD_PCI * pciinfo 712 CONFIG_CMD_PCMCIA * PCMCIA support 713 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 714 host 715 CONFIG_CMD_PORTIO * Port I/O 716 CONFIG_CMD_REGINFO * Register dump 717 CONFIG_CMD_RUN run command in env variable 718 CONFIG_CMD_SAVES * save S record dump 719 CONFIG_CMD_SCSI * SCSI Support 720 CONFIG_CMD_SDRAM * print SDRAM configuration information 721 (requires CONFIG_CMD_I2C) 722 CONFIG_CMD_SETGETDCR Support for DCR Register access 723 (4xx only) 724 CONFIG_CMD_SHA1SUM print sha1 memory digest 725 (requires CONFIG_CMD_MEMORY) 726 CONFIG_CMD_SOURCE "source" command Support 727 CONFIG_CMD_SPI * SPI serial bus support 728 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 729 CONFIG_CMD_USB * USB support 730 CONFIG_CMD_CDP * Cisco Discover Protocol support 731 CONFIG_CMD_FSL * Microblaze FSL support 732 733 734 EXAMPLE: If you want all functions except of network 735 support you can write: 736 737 #include "config_cmd_all.h" 738 #undef CONFIG_CMD_NET 739 740 Other Commands: 741 fdt (flattened device tree) command: CONFIG_OF_LIBFDT 742 743 Note: Don't enable the "icache" and "dcache" commands 744 (configuration option CONFIG_CMD_CACHE) unless you know 745 what you (and your U-Boot users) are doing. Data 746 cache cannot be enabled on systems like the 8xx or 747 8260 (where accesses to the IMMR region must be 748 uncached), and it cannot be disabled on all other 749 systems where we (mis-) use the data cache to hold an 750 initial stack and some data. 751 752 753 XXX - this list needs to get updated! 754 755- Watchdog: 756 CONFIG_WATCHDOG 757 If this variable is defined, it enables watchdog 758 support for the SoC. There must be support in the SoC 759 specific code for a watchdog. For the 8xx and 8260 760 CPUs, the SIU Watchdog feature is enabled in the SYPCR 761 register. When supported for a specific SoC is 762 available, then no further board specific code should 763 be needed to use it. 764 765 CONFIG_HW_WATCHDOG 766 When using a watchdog circuitry external to the used 767 SoC, then define this variable and provide board 768 specific code for the "hw_watchdog_reset" function. 769 770- U-Boot Version: 771 CONFIG_VERSION_VARIABLE 772 If this variable is defined, an environment variable 773 named "ver" is created by U-Boot showing the U-Boot 774 version as printed by the "version" command. 775 This variable is readonly. 776 777- Real-Time Clock: 778 779 When CONFIG_CMD_DATE is selected, the type of the RTC 780 has to be selected, too. Define exactly one of the 781 following options: 782 783 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 784 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 785 CONFIG_RTC_MC13783 - use MC13783 RTC 786 CONFIG_RTC_MC146818 - use MC146818 RTC 787 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 788 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 789 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 790 CONFIG_RTC_DS164x - use Dallas DS164x RTC 791 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 792 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 793 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 794 CONFIG_SYS_RV3029_TCR - enable trickle charger on 795 RV3029 RTC. 796 797 Note that if the RTC uses I2C, then the I2C interface 798 must also be configured. See I2C Support, below. 799 800- GPIO Support: 801 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 802 CONFIG_PCA953X_INFO - enable pca953x info command 803 804 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 805 chip-ngpio pairs that tell the PCA953X driver the number of 806 pins supported by a particular chip. 807 808 Note that if the GPIO device uses I2C, then the I2C interface 809 must also be configured. See I2C Support, below. 810 811- Timestamp Support: 812 813 When CONFIG_TIMESTAMP is selected, the timestamp 814 (date and time) of an image is printed by image 815 commands like bootm or iminfo. This option is 816 automatically enabled when you select CONFIG_CMD_DATE . 817 818- Partition Support: 819 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 820 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 821 822 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 823 CONFIG_CMD_SCSI) you must configure support for at 824 least one partition type as well. 825 826- IDE Reset method: 827 CONFIG_IDE_RESET_ROUTINE - this is defined in several 828 board configurations files but used nowhere! 829 830 CONFIG_IDE_RESET - is this is defined, IDE Reset will 831 be performed by calling the function 832 ide_set_reset(int reset) 833 which has to be defined in a board specific file 834 835- ATAPI Support: 836 CONFIG_ATAPI 837 838 Set this to enable ATAPI support. 839 840- LBA48 Support 841 CONFIG_LBA48 842 843 Set this to enable support for disks larger than 137GB 844 Also look at CONFIG_SYS_64BIT_LBA. 845 Whithout these , LBA48 support uses 32bit variables and will 'only' 846 support disks up to 2.1TB. 847 848 CONFIG_SYS_64BIT_LBA: 849 When enabled, makes the IDE subsystem use 64bit sector addresses. 850 Default is 32bit. 851 852- SCSI Support: 853 At the moment only there is only support for the 854 SYM53C8XX SCSI controller; define 855 CONFIG_SCSI_SYM53C8XX to enable it. 856 857 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 858 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 859 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 860 maximum numbers of LUNs, SCSI ID's and target 861 devices. 862 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 863 864- NETWORK Support (PCI): 865 CONFIG_E1000 866 Support for Intel 8254x gigabit chips. 867 868 CONFIG_E1000_FALLBACK_MAC 869 default MAC for empty EEPROM after production. 870 871 CONFIG_EEPRO100 872 Support for Intel 82557/82559/82559ER chips. 873 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 874 write routine for first time initialisation. 875 876 CONFIG_TULIP 877 Support for Digital 2114x chips. 878 Optional CONFIG_TULIP_SELECT_MEDIA for board specific 879 modem chip initialisation (KS8761/QS6611). 880 881 CONFIG_NATSEMI 882 Support for National dp83815 chips. 883 884 CONFIG_NS8382X 885 Support for National dp8382[01] gigabit chips. 886 887- NETWORK Support (other): 888 889 CONFIG_DRIVER_AT91EMAC 890 Support for AT91RM9200 EMAC. 891 892 CONFIG_RMII 893 Define this to use reduced MII inteface 894 895 CONFIG_DRIVER_AT91EMAC_QUIET 896 If this defined, the driver is quiet. 897 The driver doen't show link status messages. 898 899 CONFIG_DRIVER_LAN91C96 900 Support for SMSC's LAN91C96 chips. 901 902 CONFIG_LAN91C96_BASE 903 Define this to hold the physical address 904 of the LAN91C96's I/O space 905 906 CONFIG_LAN91C96_USE_32_BIT 907 Define this to enable 32 bit addressing 908 909 CONFIG_DRIVER_SMC91111 910 Support for SMSC's LAN91C111 chip 911 912 CONFIG_SMC91111_BASE 913 Define this to hold the physical address 914 of the device (I/O space) 915 916 CONFIG_SMC_USE_32_BIT 917 Define this if data bus is 32 bits 918 919 CONFIG_SMC_USE_IOFUNCS 920 Define this to use i/o functions instead of macros 921 (some hardware wont work with macros) 922 923 CONFIG_FTGMAC100 924 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 925 926 CONFIG_FTGMAC100_EGIGA 927 Define this to use GE link update with gigabit PHY. 928 Define this if FTGMAC100 is connected to gigabit PHY. 929 If your system has 10/100 PHY only, it might not occur 930 wrong behavior. Because PHY usually return timeout or 931 useless data when polling gigabit status and gigabit 932 control registers. This behavior won't affect the 933 correctnessof 10/100 link speed update. 934 935 CONFIG_SMC911X 936 Support for SMSC's LAN911x and LAN921x chips 937 938 CONFIG_SMC911X_BASE 939 Define this to hold the physical address 940 of the device (I/O space) 941 942 CONFIG_SMC911X_32_BIT 943 Define this if data bus is 32 bits 944 945 CONFIG_SMC911X_16_BIT 946 Define this if data bus is 16 bits. If your processor 947 automatically converts one 32 bit word to two 16 bit 948 words you may also try CONFIG_SMC911X_32_BIT. 949 950 CONFIG_SH_ETHER 951 Support for Renesas on-chip Ethernet controller 952 953 CONFIG_SH_ETHER_USE_PORT 954 Define the number of ports to be used 955 956 CONFIG_SH_ETHER_PHY_ADDR 957 Define the ETH PHY's address 958 959 CONFIG_SH_ETHER_CACHE_WRITEBACK 960 If this option is set, the driver enables cache flush. 961 962- USB Support: 963 At the moment only the UHCI host controller is 964 supported (PIP405, MIP405, MPC5200); define 965 CONFIG_USB_UHCI to enable it. 966 define CONFIG_USB_KEYBOARD to enable the USB Keyboard 967 and define CONFIG_USB_STORAGE to enable the USB 968 storage devices. 969 Note: 970 Supported are USB Keyboards and USB Floppy drives 971 (TEAC FD-05PUB). 972 MPC5200 USB requires additional defines: 973 CONFIG_USB_CLOCK 974 for 528 MHz Clock: 0x0001bbbb 975 CONFIG_PSC3_USB 976 for USB on PSC3 977 CONFIG_USB_CONFIG 978 for differential drivers: 0x00001000 979 for single ended drivers: 0x00005000 980 for differential drivers on PSC3: 0x00000100 981 for single ended drivers on PSC3: 0x00004100 982 CONFIG_SYS_USB_EVENT_POLL 983 May be defined to allow interrupt polling 984 instead of using asynchronous interrupts 985 986- USB Device: 987 Define the below if you wish to use the USB console. 988 Once firmware is rebuilt from a serial console issue the 989 command "setenv stdin usbtty; setenv stdout usbtty" and 990 attach your USB cable. The Unix command "dmesg" should print 991 it has found a new device. The environment variable usbtty 992 can be set to gserial or cdc_acm to enable your device to 993 appear to a USB host as a Linux gserial device or a 994 Common Device Class Abstract Control Model serial device. 995 If you select usbtty = gserial you should be able to enumerate 996 a Linux host by 997 # modprobe usbserial vendor=0xVendorID product=0xProductID 998 else if using cdc_acm, simply setting the environment 999 variable usbtty to be cdc_acm should suffice. The following 1000 might be defined in YourBoardName.h 1001 1002 CONFIG_USB_DEVICE 1003 Define this to build a UDC device 1004 1005 CONFIG_USB_TTY 1006 Define this to have a tty type of device available to 1007 talk to the UDC device 1008 1009 CONFIG_SYS_CONSOLE_IS_IN_ENV 1010 Define this if you want stdin, stdout &/or stderr to 1011 be set to usbtty. 1012 1013 mpc8xx: 1014 CONFIG_SYS_USB_EXTC_CLK 0xBLAH 1015 Derive USB clock from external clock "blah" 1016 - CONFIG_SYS_USB_EXTC_CLK 0x02 1017 1018 CONFIG_SYS_USB_BRG_CLK 0xBLAH 1019 Derive USB clock from brgclk 1020 - CONFIG_SYS_USB_BRG_CLK 0x04 1021 1022 If you have a USB-IF assigned VendorID then you may wish to 1023 define your own vendor specific values either in BoardName.h 1024 or directly in usbd_vendor_info.h. If you don't define 1025 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 1026 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 1027 should pretend to be a Linux device to it's target host. 1028 1029 CONFIG_USBD_MANUFACTURER 1030 Define this string as the name of your company for 1031 - CONFIG_USBD_MANUFACTURER "my company" 1032 1033 CONFIG_USBD_PRODUCT_NAME 1034 Define this string as the name of your product 1035 - CONFIG_USBD_PRODUCT_NAME "acme usb device" 1036 1037 CONFIG_USBD_VENDORID 1038 Define this as your assigned Vendor ID from the USB 1039 Implementors Forum. This *must* be a genuine Vendor ID 1040 to avoid polluting the USB namespace. 1041 - CONFIG_USBD_VENDORID 0xFFFF 1042 1043 CONFIG_USBD_PRODUCTID 1044 Define this as the unique Product ID 1045 for your device 1046 - CONFIG_USBD_PRODUCTID 0xFFFF 1047 1048 1049- MMC Support: 1050 The MMC controller on the Intel PXA is supported. To 1051 enable this define CONFIG_MMC. The MMC can be 1052 accessed from the boot prompt by mapping the device 1053 to physical memory similar to flash. Command line is 1054 enabled with CONFIG_CMD_MMC. The MMC driver also works with 1055 the FAT fs. This is enabled with CONFIG_CMD_FAT. 1056 1057 CONFIG_SH_MMCIF 1058 Support for Renesas on-chip MMCIF controller 1059 1060 CONFIG_SH_MMCIF_ADDR 1061 Define the base address of MMCIF registers 1062 1063 CONFIG_SH_MMCIF_CLK 1064 Define the clock frequency for MMCIF 1065 1066- Journaling Flash filesystem support: 1067 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 1068 CONFIG_JFFS2_NAND_DEV 1069 Define these for a default partition on a NAND device 1070 1071 CONFIG_SYS_JFFS2_FIRST_SECTOR, 1072 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 1073 Define these for a default partition on a NOR device 1074 1075 CONFIG_SYS_JFFS_CUSTOM_PART 1076 Define this to create an own partition. You have to provide a 1077 function struct part_info* jffs2_part_info(int part_num) 1078 1079 If you define only one JFFS2 partition you may also want to 1080 #define CONFIG_SYS_JFFS_SINGLE_PART 1 1081 to disable the command chpart. This is the default when you 1082 have not defined a custom partition 1083 1084- Keyboard Support: 1085 CONFIG_ISA_KEYBOARD 1086 1087 Define this to enable standard (PC-Style) keyboard 1088 support 1089 1090 CONFIG_I8042_KBD 1091 Standard PC keyboard driver with US (is default) and 1092 GERMAN key layout (switch via environment 'keymap=de') support. 1093 Export function i8042_kbd_init, i8042_tstc and i8042_getc 1094 for cfb_console. Supports cursor blinking. 1095 1096- Video support: 1097 CONFIG_VIDEO 1098 1099 Define this to enable video support (for output to 1100 video). 1101 1102 CONFIG_VIDEO_CT69000 1103 1104 Enable Chips & Technologies 69000 Video chip 1105 1106 CONFIG_VIDEO_SMI_LYNXEM 1107 Enable Silicon Motion SMI 712/710/810 Video chip. The 1108 video output is selected via environment 'videoout' 1109 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1110 assumed. 1111 1112 For the CT69000 and SMI_LYNXEM drivers, videomode is 1113 selected via environment 'videomode'. Two different ways 1114 are possible: 1115 - "videomode=num" 'num' is a standard LiLo mode numbers. 1116 Following standard modes are supported (* is default): 1117 1118 Colors 640x480 800x600 1024x768 1152x864 1280x1024 1119 -------------+--------------------------------------------- 1120 8 bits | 0x301* 0x303 0x305 0x161 0x307 1121 15 bits | 0x310 0x313 0x316 0x162 0x319 1122 16 bits | 0x311 0x314 0x317 0x163 0x31A 1123 24 bits | 0x312 0x315 0x318 ? 0x31B 1124 -------------+--------------------------------------------- 1125 (i.e. setenv videomode 317; saveenv; reset;) 1126 1127 - "videomode=bootargs" all the video parameters are parsed 1128 from the bootargs. (See drivers/video/videomodes.c) 1129 1130 1131 CONFIG_VIDEO_SED13806 1132 Enable Epson SED13806 driver. This driver supports 8bpp 1133 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1134 or CONFIG_VIDEO_SED13806_16BPP 1135 1136 CONFIG_FSL_DIU_FB 1137 Enable the Freescale DIU video driver. Reference boards for 1138 SOCs that have a DIU should define this macro to enable DIU 1139 support, and should also define these other macros: 1140 1141 CONFIG_SYS_DIU_ADDR 1142 CONFIG_VIDEO 1143 CONFIG_CMD_BMP 1144 CONFIG_CFB_CONSOLE 1145 CONFIG_VIDEO_SW_CURSOR 1146 CONFIG_VGA_AS_SINGLE_DEVICE 1147 CONFIG_VIDEO_LOGO 1148 CONFIG_VIDEO_BMP_LOGO 1149 1150 The DIU driver will look for the 'video-mode' environment 1151 variable, and if defined, enable the DIU as a console during 1152 boot. See the documentation file README.video for a 1153 description of this variable. 1154 1155- Keyboard Support: 1156 CONFIG_KEYBOARD 1157 1158 Define this to enable a custom keyboard support. 1159 This simply calls drv_keyboard_init() which must be 1160 defined in your board-specific files. 1161 The only board using this so far is RBC823. 1162 1163- LCD Support: CONFIG_LCD 1164 1165 Define this to enable LCD support (for output to LCD 1166 display); also select one of the supported displays 1167 by defining one of these: 1168 1169 CONFIG_ATMEL_LCD: 1170 1171 HITACHI TX09D70VM1CCA, 3.5", 240x320. 1172 1173 CONFIG_NEC_NL6448AC33: 1174 1175 NEC NL6448AC33-18. Active, color, single scan. 1176 1177 CONFIG_NEC_NL6448BC20 1178 1179 NEC NL6448BC20-08. 6.5", 640x480. 1180 Active, color, single scan. 1181 1182 CONFIG_NEC_NL6448BC33_54 1183 1184 NEC NL6448BC33-54. 10.4", 640x480. 1185 Active, color, single scan. 1186 1187 CONFIG_SHARP_16x9 1188 1189 Sharp 320x240. Active, color, single scan. 1190 It isn't 16x9, and I am not sure what it is. 1191 1192 CONFIG_SHARP_LQ64D341 1193 1194 Sharp LQ64D341 display, 640x480. 1195 Active, color, single scan. 1196 1197 CONFIG_HLD1045 1198 1199 HLD1045 display, 640x480. 1200 Active, color, single scan. 1201 1202 CONFIG_OPTREX_BW 1203 1204 Optrex CBL50840-2 NF-FW 99 22 M5 1205 or 1206 Hitachi LMG6912RPFC-00T 1207 or 1208 Hitachi SP14Q002 1209 1210 320x240. Black & white. 1211 1212 Normally display is black on white background; define 1213 CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1214 1215- Splash Screen Support: CONFIG_SPLASH_SCREEN 1216 1217 If this option is set, the environment is checked for 1218 a variable "splashimage". If found, the usual display 1219 of logo, copyright and system information on the LCD 1220 is suppressed and the BMP image at the address 1221 specified in "splashimage" is loaded instead. The 1222 console is redirected to the "nulldev", too. This 1223 allows for a "silent" boot where a splash screen is 1224 loaded very quickly after power-on. 1225 1226 CONFIG_SPLASH_SCREEN_ALIGN 1227 1228 If this option is set the splash image can be freely positioned 1229 on the screen. Environment variable "splashpos" specifies the 1230 position as "x,y". If a positive number is given it is used as 1231 number of pixel from left/top. If a negative number is given it 1232 is used as number of pixel from right/bottom. You can also 1233 specify 'm' for centering the image. 1234 1235 Example: 1236 setenv splashpos m,m 1237 => image at center of screen 1238 1239 setenv splashpos 30,20 1240 => image at x = 30 and y = 20 1241 1242 setenv splashpos -10,m 1243 => vertically centered image 1244 at x = dspWidth - bmpWidth - 9 1245 1246- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 1247 1248 If this option is set, additionally to standard BMP 1249 images, gzipped BMP images can be displayed via the 1250 splashscreen support or the bmp command. 1251 1252- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1253 1254 If this option is set, 8-bit RLE compressed BMP images 1255 can be displayed via the splashscreen support or the 1256 bmp command. 1257 1258- Compression support: 1259 CONFIG_BZIP2 1260 1261 If this option is set, support for bzip2 compressed 1262 images is included. If not, only uncompressed and gzip 1263 compressed images are supported. 1264 1265 NOTE: the bzip2 algorithm requires a lot of RAM, so 1266 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1267 be at least 4MB. 1268 1269 CONFIG_LZMA 1270 1271 If this option is set, support for lzma compressed 1272 images is included. 1273 1274 Note: The LZMA algorithm adds between 2 and 4KB of code and it 1275 requires an amount of dynamic memory that is given by the 1276 formula: 1277 1278 (1846 + 768 << (lc + lp)) * sizeof(uint16) 1279 1280 Where lc and lp stand for, respectively, Literal context bits 1281 and Literal pos bits. 1282 1283 This value is upper-bounded by 14MB in the worst case. Anyway, 1284 for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1285 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1286 a very small buffer. 1287 1288 Use the lzmainfo tool to determinate the lc and lp values and 1289 then calculate the amount of needed dynamic memory (ensuring 1290 the appropriate CONFIG_SYS_MALLOC_LEN value). 1291 1292- MII/PHY support: 1293 CONFIG_PHY_ADDR 1294 1295 The address of PHY on MII bus. 1296 1297 CONFIG_PHY_CLOCK_FREQ (ppc4xx) 1298 1299 The clock frequency of the MII bus 1300 1301 CONFIG_PHY_GIGE 1302 1303 If this option is set, support for speed/duplex 1304 detection of gigabit PHY is included. 1305 1306 CONFIG_PHY_RESET_DELAY 1307 1308 Some PHY like Intel LXT971A need extra delay after 1309 reset before any MII register access is possible. 1310 For such PHY, set this option to the usec delay 1311 required. (minimum 300usec for LXT971A) 1312 1313 CONFIG_PHY_CMD_DELAY (ppc4xx) 1314 1315 Some PHY like Intel LXT971A need extra delay after 1316 command issued before MII status register can be read 1317 1318- Ethernet address: 1319 CONFIG_ETHADDR 1320 CONFIG_ETH1ADDR 1321 CONFIG_ETH2ADDR 1322 CONFIG_ETH3ADDR 1323 CONFIG_ETH4ADDR 1324 CONFIG_ETH5ADDR 1325 1326 Define a default value for Ethernet address to use 1327 for the respective Ethernet interface, in case this 1328 is not determined automatically. 1329 1330- IP address: 1331 CONFIG_IPADDR 1332 1333 Define a default value for the IP address to use for 1334 the default Ethernet interface, in case this is not 1335 determined through e.g. bootp. 1336 1337- Server IP address: 1338 CONFIG_SERVERIP 1339 1340 Defines a default value for the IP address of a TFTP 1341 server to contact when using the "tftboot" command. 1342 1343 CONFIG_KEEP_SERVERADDR 1344 1345 Keeps the server's MAC address, in the env 'serveraddr' 1346 for passing to bootargs (like Linux's netconsole option) 1347 1348- Multicast TFTP Mode: 1349 CONFIG_MCAST_TFTP 1350 1351 Defines whether you want to support multicast TFTP as per 1352 rfc-2090; for example to work with atftp. Lets lots of targets 1353 tftp down the same boot image concurrently. Note: the Ethernet 1354 driver in use must provide a function: mcast() to join/leave a 1355 multicast group. 1356 1357- BOOTP Recovery Mode: 1358 CONFIG_BOOTP_RANDOM_DELAY 1359 1360 If you have many targets in a network that try to 1361 boot using BOOTP, you may want to avoid that all 1362 systems send out BOOTP requests at precisely the same 1363 moment (which would happen for instance at recovery 1364 from a power failure, when all systems will try to 1365 boot, thus flooding the BOOTP server. Defining 1366 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1367 inserted before sending out BOOTP requests. The 1368 following delays are inserted then: 1369 1370 1st BOOTP request: delay 0 ... 1 sec 1371 2nd BOOTP request: delay 0 ... 2 sec 1372 3rd BOOTP request: delay 0 ... 4 sec 1373 4th and following 1374 BOOTP requests: delay 0 ... 8 sec 1375 1376- DHCP Advanced Options: 1377 You can fine tune the DHCP functionality by defining 1378 CONFIG_BOOTP_* symbols: 1379 1380 CONFIG_BOOTP_SUBNETMASK 1381 CONFIG_BOOTP_GATEWAY 1382 CONFIG_BOOTP_HOSTNAME 1383 CONFIG_BOOTP_NISDOMAIN 1384 CONFIG_BOOTP_BOOTPATH 1385 CONFIG_BOOTP_BOOTFILESIZE 1386 CONFIG_BOOTP_DNS 1387 CONFIG_BOOTP_DNS2 1388 CONFIG_BOOTP_SEND_HOSTNAME 1389 CONFIG_BOOTP_NTPSERVER 1390 CONFIG_BOOTP_TIMEOFFSET 1391 CONFIG_BOOTP_VENDOREX 1392 1393 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 1394 environment variable, not the BOOTP server. 1395 1396 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1397 serverip from a DHCP server, it is possible that more 1398 than one DNS serverip is offered to the client. 1399 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1400 serverip will be stored in the additional environment 1401 variable "dnsip2". The first DNS serverip is always 1402 stored in the variable "dnsip", when CONFIG_BOOTP_DNS 1403 is defined. 1404 1405 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1406 to do a dynamic update of a DNS server. To do this, they 1407 need the hostname of the DHCP requester. 1408 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 1409 of the "hostname" environment variable is passed as 1410 option 12 to the DHCP server. 1411 1412 CONFIG_BOOTP_DHCP_REQUEST_DELAY 1413 1414 A 32bit value in microseconds for a delay between 1415 receiving a "DHCP Offer" and sending the "DHCP Request". 1416 This fixes a problem with certain DHCP servers that don't 1417 respond 100% of the time to a "DHCP request". E.g. On an 1418 AT91RM9200 processor running at 180MHz, this delay needed 1419 to be *at least* 15,000 usec before a Windows Server 2003 1420 DHCP server would reply 100% of the time. I recommend at 1421 least 50,000 usec to be safe. The alternative is to hope 1422 that one of the retries will be successful but note that 1423 the DHCP timeout and retry process takes a longer than 1424 this delay. 1425 1426 - CDP Options: 1427 CONFIG_CDP_DEVICE_ID 1428 1429 The device id used in CDP trigger frames. 1430 1431 CONFIG_CDP_DEVICE_ID_PREFIX 1432 1433 A two character string which is prefixed to the MAC address 1434 of the device. 1435 1436 CONFIG_CDP_PORT_ID 1437 1438 A printf format string which contains the ascii name of 1439 the port. Normally is set to "eth%d" which sets 1440 eth0 for the first Ethernet, eth1 for the second etc. 1441 1442 CONFIG_CDP_CAPABILITIES 1443 1444 A 32bit integer which indicates the device capabilities; 1445 0x00000010 for a normal host which does not forwards. 1446 1447 CONFIG_CDP_VERSION 1448 1449 An ascii string containing the version of the software. 1450 1451 CONFIG_CDP_PLATFORM 1452 1453 An ascii string containing the name of the platform. 1454 1455 CONFIG_CDP_TRIGGER 1456 1457 A 32bit integer sent on the trigger. 1458 1459 CONFIG_CDP_POWER_CONSUMPTION 1460 1461 A 16bit integer containing the power consumption of the 1462 device in .1 of milliwatts. 1463 1464 CONFIG_CDP_APPLIANCE_VLAN_TYPE 1465 1466 A byte containing the id of the VLAN. 1467 1468- Status LED: CONFIG_STATUS_LED 1469 1470 Several configurations allow to display the current 1471 status using a LED. For instance, the LED will blink 1472 fast while running U-Boot code, stop blinking as 1473 soon as a reply to a BOOTP request was received, and 1474 start blinking slow once the Linux kernel is running 1475 (supported by a status LED driver in the Linux 1476 kernel). Defining CONFIG_STATUS_LED enables this 1477 feature in U-Boot. 1478 1479- CAN Support: CONFIG_CAN_DRIVER 1480 1481 Defining CONFIG_CAN_DRIVER enables CAN driver support 1482 on those systems that support this (optional) 1483 feature, like the TQM8xxL modules. 1484 1485- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1486 1487 These enable I2C serial bus commands. Defining either of 1488 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 1489 include the appropriate I2C driver for the selected CPU. 1490 1491 This will allow you to use i2c commands at the u-boot 1492 command line (as long as you set CONFIG_CMD_I2C in 1493 CONFIG_COMMANDS) and communicate with i2c based realtime 1494 clock chips. See common/cmd_i2c.c for a description of the 1495 command line interface. 1496 1497 CONFIG_HARD_I2C selects a hardware I2C controller. 1498 1499 CONFIG_SOFT_I2C configures u-boot to use a software (aka 1500 bit-banging) driver instead of CPM or similar hardware 1501 support for I2C. 1502 1503 There are several other quantities that must also be 1504 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1505 1506 In both cases you will need to define CONFIG_SYS_I2C_SPEED 1507 to be the frequency (in Hz) at which you wish your i2c bus 1508 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 1509 the CPU's i2c node address). 1510 1511 Now, the u-boot i2c code for the mpc8xx 1512 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 1513 and so its address should therefore be cleared to 0 (See, 1514 eg, MPC823e User's Manual p.16-473). So, set 1515 CONFIG_SYS_I2C_SLAVE to 0. 1516 1517 CONFIG_SYS_I2C_INIT_MPC5XXX 1518 1519 When a board is reset during an i2c bus transfer 1520 chips might think that the current transfer is still 1521 in progress. Reset the slave devices by sending start 1522 commands until the slave device responds. 1523 1524 That's all that's required for CONFIG_HARD_I2C. 1525 1526 If you use the software i2c interface (CONFIG_SOFT_I2C) 1527 then the following macros need to be defined (examples are 1528 from include/configs/lwmon.h): 1529 1530 I2C_INIT 1531 1532 (Optional). Any commands necessary to enable the I2C 1533 controller or configure ports. 1534 1535 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1536 1537 I2C_PORT 1538 1539 (Only for MPC8260 CPU). The I/O port to use (the code 1540 assumes both bits are on the same port). Valid values 1541 are 0..3 for ports A..D. 1542 1543 I2C_ACTIVE 1544 1545 The code necessary to make the I2C data line active 1546 (driven). If the data line is open collector, this 1547 define can be null. 1548 1549 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1550 1551 I2C_TRISTATE 1552 1553 The code necessary to make the I2C data line tri-stated 1554 (inactive). If the data line is open collector, this 1555 define can be null. 1556 1557 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1558 1559 I2C_READ 1560 1561 Code that returns TRUE if the I2C data line is high, 1562 FALSE if it is low. 1563 1564 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1565 1566 I2C_SDA(bit) 1567 1568 If <bit> is TRUE, sets the I2C data line high. If it 1569 is FALSE, it clears it (low). 1570 1571 eg: #define I2C_SDA(bit) \ 1572 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1573 else immr->im_cpm.cp_pbdat &= ~PB_SDA 1574 1575 I2C_SCL(bit) 1576 1577 If <bit> is TRUE, sets the I2C clock line high. If it 1578 is FALSE, it clears it (low). 1579 1580 eg: #define I2C_SCL(bit) \ 1581 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1582 else immr->im_cpm.cp_pbdat &= ~PB_SCL 1583 1584 I2C_DELAY 1585 1586 This delay is invoked four times per clock cycle so this 1587 controls the rate of data transfer. The data rate thus 1588 is 1 / (I2C_DELAY * 4). Often defined to be something 1589 like: 1590 1591 #define I2C_DELAY udelay(2) 1592 1593 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1594 1595 If your arch supports the generic GPIO framework (asm/gpio.h), 1596 then you may alternatively define the two GPIOs that are to be 1597 used as SCL / SDA. Any of the previous I2C_xxx macros will 1598 have GPIO-based defaults assigned to them as appropriate. 1599 1600 You should define these to the GPIO value as given directly to 1601 the generic GPIO functions. 1602 1603 CONFIG_SYS_I2C_INIT_BOARD 1604 1605 When a board is reset during an i2c bus transfer 1606 chips might think that the current transfer is still 1607 in progress. On some boards it is possible to access 1608 the i2c SCLK line directly, either by using the 1609 processor pin as a GPIO or by having a second pin 1610 connected to the bus. If this option is defined a 1611 custom i2c_init_board() routine in boards/xxx/board.c 1612 is run early in the boot sequence. 1613 1614 CONFIG_SYS_I2C_BOARD_LATE_INIT 1615 1616 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 1617 defined a custom i2c_board_late_init() routine in 1618 boards/xxx/board.c is run AFTER the operations in i2c_init() 1619 is completed. This callpoint can be used to unreset i2c bus 1620 using CPU i2c controller register accesses for CPUs whose i2c 1621 controller provide such a method. It is called at the end of 1622 i2c_init() to allow i2c_init operations to setup the i2c bus 1623 controller on the CPU (e.g. setting bus speed & slave address). 1624 1625 CONFIG_I2CFAST (PPC405GP|PPC405EP only) 1626 1627 This option enables configuration of bi_iic_fast[] flags 1628 in u-boot bd_info structure based on u-boot environment 1629 variable "i2cfast". (see also i2cfast) 1630 1631 CONFIG_I2C_MULTI_BUS 1632 1633 This option allows the use of multiple I2C buses, each of which 1634 must have a controller. At any point in time, only one bus is 1635 active. To switch to a different bus, use the 'i2c dev' command. 1636 Note that bus numbering is zero-based. 1637 1638 CONFIG_SYS_I2C_NOPROBES 1639 1640 This option specifies a list of I2C devices that will be skipped 1641 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 1642 is set, specify a list of bus-device pairs. Otherwise, specify 1643 a 1D array of device addresses 1644 1645 e.g. 1646 #undef CONFIG_I2C_MULTI_BUS 1647 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 1648 1649 will skip addresses 0x50 and 0x68 on a board with one I2C bus 1650 1651 #define CONFIG_I2C_MULTI_BUS 1652 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 1653 1654 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 1655 1656 CONFIG_SYS_SPD_BUS_NUM 1657 1658 If defined, then this indicates the I2C bus number for DDR SPD. 1659 If not defined, then U-Boot assumes that SPD is on I2C bus 0. 1660 1661 CONFIG_SYS_RTC_BUS_NUM 1662 1663 If defined, then this indicates the I2C bus number for the RTC. 1664 If not defined, then U-Boot assumes that RTC is on I2C bus 0. 1665 1666 CONFIG_SYS_DTT_BUS_NUM 1667 1668 If defined, then this indicates the I2C bus number for the DTT. 1669 If not defined, then U-Boot assumes that DTT is on I2C bus 0. 1670 1671 CONFIG_SYS_I2C_DTT_ADDR: 1672 1673 If defined, specifies the I2C address of the DTT device. 1674 If not defined, then U-Boot uses predefined value for 1675 specified DTT device. 1676 1677 CONFIG_FSL_I2C 1678 1679 Define this option if you want to use Freescale's I2C driver in 1680 drivers/i2c/fsl_i2c.c. 1681 1682 CONFIG_I2C_MUX 1683 1684 Define this option if you have I2C devices reached over 1 .. n 1685 I2C Muxes like the pca9544a. This option addes a new I2C 1686 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 1687 new I2C Bus to the existing I2C Busses. If you select the 1688 new Bus with "i2c dev", u-bbot sends first the commandos for 1689 the muxes to activate this new "bus". 1690 1691 CONFIG_I2C_MULTI_BUS must be also defined, to use this 1692 feature! 1693 1694 Example: 1695 Adding a new I2C Bus reached over 2 pca9544a muxes 1696 The First mux with address 70 and channel 6 1697 The Second mux with address 71 and channel 4 1698 1699 => i2c bus pca9544a:70:6:pca9544a:71:4 1700 1701 Use the "i2c bus" command without parameter, to get a list 1702 of I2C Busses with muxes: 1703 1704 => i2c bus 1705 Busses reached over muxes: 1706 Bus ID: 2 1707 reached over Mux(es): 1708 pca9544a@70 ch: 4 1709 Bus ID: 3 1710 reached over Mux(es): 1711 pca9544a@70 ch: 6 1712 pca9544a@71 ch: 4 1713 => 1714 1715 If you now switch to the new I2C Bus 3 with "i2c dev 3" 1716 u-boot sends First the Commando to the mux@70 to enable 1717 channel 6, and then the Commando to the mux@71 to enable 1718 the channel 4. 1719 1720 After that, you can use the "normal" i2c commands as 1721 usual, to communicate with your I2C devices behind 1722 the 2 muxes. 1723 1724 This option is actually implemented for the bitbanging 1725 algorithm in common/soft_i2c.c and for the Hardware I2C 1726 Bus on the MPC8260. But it should be not so difficult 1727 to add this option to other architectures. 1728 1729 CONFIG_SOFT_I2C_READ_REPEATED_START 1730 1731 defining this will force the i2c_read() function in 1732 the soft_i2c driver to perform an I2C repeated start 1733 between writing the address pointer and reading the 1734 data. If this define is omitted the default behaviour 1735 of doing a stop-start sequence will be used. Most I2C 1736 devices can use either method, but some require one or 1737 the other. 1738 1739- SPI Support: CONFIG_SPI 1740 1741 Enables SPI driver (so far only tested with 1742 SPI EEPROM, also an instance works with Crystal A/D and 1743 D/As on the SACSng board) 1744 1745 CONFIG_SH_SPI 1746 1747 Enables the driver for SPI controller on SuperH. Currently 1748 only SH7757 is supported. 1749 1750 CONFIG_SPI_X 1751 1752 Enables extended (16-bit) SPI EEPROM addressing. 1753 (symmetrical to CONFIG_I2C_X) 1754 1755 CONFIG_SOFT_SPI 1756 1757 Enables a software (bit-bang) SPI driver rather than 1758 using hardware support. This is a general purpose 1759 driver that only requires three general I/O port pins 1760 (two outputs, one input) to function. If this is 1761 defined, the board configuration must define several 1762 SPI configuration items (port pins to use, etc). For 1763 an example, see include/configs/sacsng.h. 1764 1765 CONFIG_HARD_SPI 1766 1767 Enables a hardware SPI driver for general-purpose reads 1768 and writes. As with CONFIG_SOFT_SPI, the board configuration 1769 must define a list of chip-select function pointers. 1770 Currently supported on some MPC8xxx processors. For an 1771 example, see include/configs/mpc8349emds.h. 1772 1773 CONFIG_MXC_SPI 1774 1775 Enables the driver for the SPI controllers on i.MX and MXC 1776 SoCs. Currently only i.MX31 is supported. 1777 1778- FPGA Support: CONFIG_FPGA 1779 1780 Enables FPGA subsystem. 1781 1782 CONFIG_FPGA_<vendor> 1783 1784 Enables support for specific chip vendors. 1785 (ALTERA, XILINX) 1786 1787 CONFIG_FPGA_<family> 1788 1789 Enables support for FPGA family. 1790 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 1791 1792 CONFIG_FPGA_COUNT 1793 1794 Specify the number of FPGA devices to support. 1795 1796 CONFIG_SYS_FPGA_PROG_FEEDBACK 1797 1798 Enable printing of hash marks during FPGA configuration. 1799 1800 CONFIG_SYS_FPGA_CHECK_BUSY 1801 1802 Enable checks on FPGA configuration interface busy 1803 status by the configuration function. This option 1804 will require a board or device specific function to 1805 be written. 1806 1807 CONFIG_FPGA_DELAY 1808 1809 If defined, a function that provides delays in the FPGA 1810 configuration driver. 1811 1812 CONFIG_SYS_FPGA_CHECK_CTRLC 1813 Allow Control-C to interrupt FPGA configuration 1814 1815 CONFIG_SYS_FPGA_CHECK_ERROR 1816 1817 Check for configuration errors during FPGA bitfile 1818 loading. For example, abort during Virtex II 1819 configuration if the INIT_B line goes low (which 1820 indicated a CRC error). 1821 1822 CONFIG_SYS_FPGA_WAIT_INIT 1823 1824 Maximum time to wait for the INIT_B line to deassert 1825 after PROB_B has been deasserted during a Virtex II 1826 FPGA configuration sequence. The default time is 500 1827 ms. 1828 1829 CONFIG_SYS_FPGA_WAIT_BUSY 1830 1831 Maximum time to wait for BUSY to deassert during 1832 Virtex II FPGA configuration. The default is 5 ms. 1833 1834 CONFIG_SYS_FPGA_WAIT_CONFIG 1835 1836 Time to wait after FPGA configuration. The default is 1837 200 ms. 1838 1839- Configuration Management: 1840 CONFIG_IDENT_STRING 1841 1842 If defined, this string will be added to the U-Boot 1843 version information (U_BOOT_VERSION) 1844 1845- Vendor Parameter Protection: 1846 1847 U-Boot considers the values of the environment 1848 variables "serial#" (Board Serial Number) and 1849 "ethaddr" (Ethernet Address) to be parameters that 1850 are set once by the board vendor / manufacturer, and 1851 protects these variables from casual modification by 1852 the user. Once set, these variables are read-only, 1853 and write or delete attempts are rejected. You can 1854 change this behaviour: 1855 1856 If CONFIG_ENV_OVERWRITE is #defined in your config 1857 file, the write protection for vendor parameters is 1858 completely disabled. Anybody can change or delete 1859 these parameters. 1860 1861 Alternatively, if you #define _both_ CONFIG_ETHADDR 1862 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 1863 Ethernet address is installed in the environment, 1864 which can be changed exactly ONCE by the user. [The 1865 serial# is unaffected by this, i. e. it remains 1866 read-only.] 1867 1868- Protected RAM: 1869 CONFIG_PRAM 1870 1871 Define this variable to enable the reservation of 1872 "protected RAM", i. e. RAM which is not overwritten 1873 by U-Boot. Define CONFIG_PRAM to hold the number of 1874 kB you want to reserve for pRAM. You can overwrite 1875 this default value by defining an environment 1876 variable "pram" to the number of kB you want to 1877 reserve. Note that the board info structure will 1878 still show the full amount of RAM. If pRAM is 1879 reserved, a new environment variable "mem" will 1880 automatically be defined to hold the amount of 1881 remaining RAM in a form that can be passed as boot 1882 argument to Linux, for instance like that: 1883 1884 setenv bootargs ... mem=\${mem} 1885 saveenv 1886 1887 This way you can tell Linux not to use this memory, 1888 either, which results in a memory region that will 1889 not be affected by reboots. 1890 1891 *WARNING* If your board configuration uses automatic 1892 detection of the RAM size, you must make sure that 1893 this memory test is non-destructive. So far, the 1894 following board configurations are known to be 1895 "pRAM-clean": 1896 1897 ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL, 1898 HERMES, IP860, RPXlite, LWMON, LANTEC, 1899 FLAGADM, TQM8260 1900 1901- Error Recovery: 1902 CONFIG_PANIC_HANG 1903 1904 Define this variable to stop the system in case of a 1905 fatal error, so that you have to reset it manually. 1906 This is probably NOT a good idea for an embedded 1907 system where you want the system to reboot 1908 automatically as fast as possible, but it may be 1909 useful during development since you can try to debug 1910 the conditions that lead to the situation. 1911 1912 CONFIG_NET_RETRY_COUNT 1913 1914 This variable defines the number of retries for 1915 network operations like ARP, RARP, TFTP, or BOOTP 1916 before giving up the operation. If not defined, a 1917 default value of 5 is used. 1918 1919 CONFIG_ARP_TIMEOUT 1920 1921 Timeout waiting for an ARP reply in milliseconds. 1922 1923- Command Interpreter: 1924 CONFIG_AUTO_COMPLETE 1925 1926 Enable auto completion of commands using TAB. 1927 1928 Note that this feature has NOT been implemented yet 1929 for the "hush" shell. 1930 1931 1932 CONFIG_SYS_HUSH_PARSER 1933 1934 Define this variable to enable the "hush" shell (from 1935 Busybox) as command line interpreter, thus enabling 1936 powerful command line syntax like 1937 if...then...else...fi conditionals or `&&' and '||' 1938 constructs ("shell scripts"). 1939 1940 If undefined, you get the old, much simpler behaviour 1941 with a somewhat smaller memory footprint. 1942 1943 1944 CONFIG_SYS_PROMPT_HUSH_PS2 1945 1946 This defines the secondary prompt string, which is 1947 printed when the command interpreter needs more input 1948 to complete a command. Usually "> ". 1949 1950 Note: 1951 1952 In the current implementation, the local variables 1953 space and global environment variables space are 1954 separated. Local variables are those you define by 1955 simply typing `name=value'. To access a local 1956 variable later on, you have write `$name' or 1957 `${name}'; to execute the contents of a variable 1958 directly type `$name' at the command prompt. 1959 1960 Global environment variables are those you use 1961 setenv/printenv to work with. To run a command stored 1962 in such a variable, you need to use the run command, 1963 and you must not use the '$' sign to access them. 1964 1965 To store commands and special characters in a 1966 variable, please use double quotation marks 1967 surrounding the whole text of the variable, instead 1968 of the backslashes before semicolons and special 1969 symbols. 1970 1971- Commandline Editing and History: 1972 CONFIG_CMDLINE_EDITING 1973 1974 Enable editing and History functions for interactive 1975 commandline input operations 1976 1977- Default Environment: 1978 CONFIG_EXTRA_ENV_SETTINGS 1979 1980 Define this to contain any number of null terminated 1981 strings (variable = value pairs) that will be part of 1982 the default environment compiled into the boot image. 1983 1984 For example, place something like this in your 1985 board's config file: 1986 1987 #define CONFIG_EXTRA_ENV_SETTINGS \ 1988 "myvar1=value1\0" \ 1989 "myvar2=value2\0" 1990 1991 Warning: This method is based on knowledge about the 1992 internal format how the environment is stored by the 1993 U-Boot code. This is NOT an official, exported 1994 interface! Although it is unlikely that this format 1995 will change soon, there is no guarantee either. 1996 You better know what you are doing here. 1997 1998 Note: overly (ab)use of the default environment is 1999 discouraged. Make sure to check other ways to preset 2000 the environment like the "source" command or the 2001 boot command first. 2002 2003- DataFlash Support: 2004 CONFIG_HAS_DATAFLASH 2005 2006 Defining this option enables DataFlash features and 2007 allows to read/write in Dataflash via the standard 2008 commands cp, md... 2009 2010- SystemACE Support: 2011 CONFIG_SYSTEMACE 2012 2013 Adding this option adds support for Xilinx SystemACE 2014 chips attached via some sort of local bus. The address 2015 of the chip must also be defined in the 2016 CONFIG_SYS_SYSTEMACE_BASE macro. For example: 2017 2018 #define CONFIG_SYSTEMACE 2019 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 2020 2021 When SystemACE support is added, the "ace" device type 2022 becomes available to the fat commands, i.e. fatls. 2023 2024- TFTP Fixed UDP Port: 2025 CONFIG_TFTP_PORT 2026 2027 If this is defined, the environment variable tftpsrcp 2028 is used to supply the TFTP UDP source port value. 2029 If tftpsrcp isn't defined, the normal pseudo-random port 2030 number generator is used. 2031 2032 Also, the environment variable tftpdstp is used to supply 2033 the TFTP UDP destination port value. If tftpdstp isn't 2034 defined, the normal port 69 is used. 2035 2036 The purpose for tftpsrcp is to allow a TFTP server to 2037 blindly start the TFTP transfer using the pre-configured 2038 target IP address and UDP port. This has the effect of 2039 "punching through" the (Windows XP) firewall, allowing 2040 the remainder of the TFTP transfer to proceed normally. 2041 A better solution is to properly configure the firewall, 2042 but sometimes that is not allowed. 2043 2044- Show boot progress: 2045 CONFIG_SHOW_BOOT_PROGRESS 2046 2047 Defining this option allows to add some board- 2048 specific code (calling a user-provided function 2049 "show_boot_progress(int)") that enables you to show 2050 the system's boot progress on some display (for 2051 example, some LED's) on your board. At the moment, 2052 the following checkpoints are implemented: 2053 2054- Standalone program support: 2055 CONFIG_STANDALONE_LOAD_ADDR 2056 2057 This option allows to define board specific values 2058 for the address where standalone program gets loaded, 2059 thus overwriting the architecutre dependent default 2060 settings. 2061 2062- Frame Buffer Address: 2063 CONFIG_FB_ADDR 2064 2065 Define CONFIG_FB_ADDR if you want to use specific address for 2066 frame buffer. 2067 Then system will reserve the frame buffer address to defined address 2068 instead of lcd_setmem (this function grab the memory for frame buffer 2069 by panel's size). 2070 2071 Please see board_init_f function. 2072 2073 If you want this config option then, 2074 please define it at your board config file 2075 2076Legacy uImage format: 2077 2078 Arg Where When 2079 1 common/cmd_bootm.c before attempting to boot an image 2080 -1 common/cmd_bootm.c Image header has bad magic number 2081 2 common/cmd_bootm.c Image header has correct magic number 2082 -2 common/cmd_bootm.c Image header has bad checksum 2083 3 common/cmd_bootm.c Image header has correct checksum 2084 -3 common/cmd_bootm.c Image data has bad checksum 2085 4 common/cmd_bootm.c Image data has correct checksum 2086 -4 common/cmd_bootm.c Image is for unsupported architecture 2087 5 common/cmd_bootm.c Architecture check OK 2088 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2089 6 common/cmd_bootm.c Image Type check OK 2090 -6 common/cmd_bootm.c gunzip uncompression error 2091 -7 common/cmd_bootm.c Unimplemented compression type 2092 7 common/cmd_bootm.c Uncompression OK 2093 8 common/cmd_bootm.c No uncompress/copy overwrite error 2094 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 2095 2096 9 common/image.c Start initial ramdisk verification 2097 -10 common/image.c Ramdisk header has bad magic number 2098 -11 common/image.c Ramdisk header has bad checksum 2099 10 common/image.c Ramdisk header is OK 2100 -12 common/image.c Ramdisk data has bad checksum 2101 11 common/image.c Ramdisk data has correct checksum 2102 12 common/image.c Ramdisk verification complete, start loading 2103 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 2104 13 common/image.c Start multifile image verification 2105 14 common/image.c No initial ramdisk, no multifile, continue. 2106 2107 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2108 2109 -30 arch/powerpc/lib/board.c Fatal error, hang the system 2110 -31 post/post.c POST test failed, detected by post_output_backlog() 2111 -32 post/post.c POST test failed, detected by post_run_single() 2112 2113 34 common/cmd_doc.c before loading a Image from a DOC device 2114 -35 common/cmd_doc.c Bad usage of "doc" command 2115 35 common/cmd_doc.c correct usage of "doc" command 2116 -36 common/cmd_doc.c No boot device 2117 36 common/cmd_doc.c correct boot device 2118 -37 common/cmd_doc.c Unknown Chip ID on boot device 2119 37 common/cmd_doc.c correct chip ID found, device available 2120 -38 common/cmd_doc.c Read Error on boot device 2121 38 common/cmd_doc.c reading Image header from DOC device OK 2122 -39 common/cmd_doc.c Image header has bad magic number 2123 39 common/cmd_doc.c Image header has correct magic number 2124 -40 common/cmd_doc.c Error reading Image from DOC device 2125 40 common/cmd_doc.c Image header has correct magic number 2126 41 common/cmd_ide.c before loading a Image from a IDE device 2127 -42 common/cmd_ide.c Bad usage of "ide" command 2128 42 common/cmd_ide.c correct usage of "ide" command 2129 -43 common/cmd_ide.c No boot device 2130 43 common/cmd_ide.c boot device found 2131 -44 common/cmd_ide.c Device not available 2132 44 common/cmd_ide.c Device available 2133 -45 common/cmd_ide.c wrong partition selected 2134 45 common/cmd_ide.c partition selected 2135 -46 common/cmd_ide.c Unknown partition table 2136 46 common/cmd_ide.c valid partition table found 2137 -47 common/cmd_ide.c Invalid partition type 2138 47 common/cmd_ide.c correct partition type 2139 -48 common/cmd_ide.c Error reading Image Header on boot device 2140 48 common/cmd_ide.c reading Image Header from IDE device OK 2141 -49 common/cmd_ide.c Image header has bad magic number 2142 49 common/cmd_ide.c Image header has correct magic number 2143 -50 common/cmd_ide.c Image header has bad checksum 2144 50 common/cmd_ide.c Image header has correct checksum 2145 -51 common/cmd_ide.c Error reading Image from IDE device 2146 51 common/cmd_ide.c reading Image from IDE device OK 2147 52 common/cmd_nand.c before loading a Image from a NAND device 2148 -53 common/cmd_nand.c Bad usage of "nand" command 2149 53 common/cmd_nand.c correct usage of "nand" command 2150 -54 common/cmd_nand.c No boot device 2151 54 common/cmd_nand.c boot device found 2152 -55 common/cmd_nand.c Unknown Chip ID on boot device 2153 55 common/cmd_nand.c correct chip ID found, device available 2154 -56 common/cmd_nand.c Error reading Image Header on boot device 2155 56 common/cmd_nand.c reading Image Header from NAND device OK 2156 -57 common/cmd_nand.c Image header has bad magic number 2157 57 common/cmd_nand.c Image header has correct magic number 2158 -58 common/cmd_nand.c Error reading Image from NAND device 2159 58 common/cmd_nand.c reading Image from NAND device OK 2160 2161 -60 common/env_common.c Environment has a bad CRC, using default 2162 2163 64 net/eth.c starting with Ethernet configuration. 2164 -64 net/eth.c no Ethernet found. 2165 65 net/eth.c Ethernet found. 2166 2167 -80 common/cmd_net.c usage wrong 2168 80 common/cmd_net.c before calling NetLoop() 2169 -81 common/cmd_net.c some error in NetLoop() occurred 2170 81 common/cmd_net.c NetLoop() back without error 2171 -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2172 82 common/cmd_net.c trying automatic boot 2173 83 common/cmd_net.c running "source" command 2174 -83 common/cmd_net.c some error in automatic boot or "source" command 2175 84 common/cmd_net.c end without errors 2176 2177FIT uImage format: 2178 2179 Arg Where When 2180 100 common/cmd_bootm.c Kernel FIT Image has correct format 2181 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 2182 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 2183 -101 common/cmd_bootm.c Can't get configuration for kernel subimage 2184 102 common/cmd_bootm.c Kernel unit name specified 2185 -103 common/cmd_bootm.c Can't get kernel subimage node offset 2186 103 common/cmd_bootm.c Found configuration node 2187 104 common/cmd_bootm.c Got kernel subimage node offset 2188 -104 common/cmd_bootm.c Kernel subimage hash verification failed 2189 105 common/cmd_bootm.c Kernel subimage hash verification OK 2190 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 2191 106 common/cmd_bootm.c Architecture check OK 2192 -106 common/cmd_bootm.c Kernel subimage has wrong type 2193 107 common/cmd_bootm.c Kernel subimage type OK 2194 -107 common/cmd_bootm.c Can't get kernel subimage data/size 2195 108 common/cmd_bootm.c Got kernel subimage data/size 2196 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 2197 -109 common/cmd_bootm.c Can't get kernel subimage type 2198 -110 common/cmd_bootm.c Can't get kernel subimage comp 2199 -111 common/cmd_bootm.c Can't get kernel subimage os 2200 -112 common/cmd_bootm.c Can't get kernel subimage load address 2201 -113 common/cmd_bootm.c Image uncompress/copy overwrite error 2202 2203 120 common/image.c Start initial ramdisk verification 2204 -120 common/image.c Ramdisk FIT image has incorrect format 2205 121 common/image.c Ramdisk FIT image has correct format 2206 122 common/image.c No ramdisk subimage unit name, using configuration 2207 -122 common/image.c Can't get configuration for ramdisk subimage 2208 123 common/image.c Ramdisk unit name specified 2209 -124 common/image.c Can't get ramdisk subimage node offset 2210 125 common/image.c Got ramdisk subimage node offset 2211 -125 common/image.c Ramdisk subimage hash verification failed 2212 126 common/image.c Ramdisk subimage hash verification OK 2213 -126 common/image.c Ramdisk subimage for unsupported architecture 2214 127 common/image.c Architecture check OK 2215 -127 common/image.c Can't get ramdisk subimage data/size 2216 128 common/image.c Got ramdisk subimage data/size 2217 129 common/image.c Can't get ramdisk load address 2218 -129 common/image.c Got ramdisk load address 2219 2220 -130 common/cmd_doc.c Incorrect FIT image format 2221 131 common/cmd_doc.c FIT image format OK 2222 2223 -140 common/cmd_ide.c Incorrect FIT image format 2224 141 common/cmd_ide.c FIT image format OK 2225 2226 -150 common/cmd_nand.c Incorrect FIT image format 2227 151 common/cmd_nand.c FIT image format OK 2228 2229- Automatic software updates via TFTP server 2230 CONFIG_UPDATE_TFTP 2231 CONFIG_UPDATE_TFTP_CNT_MAX 2232 CONFIG_UPDATE_TFTP_MSEC_MAX 2233 2234 These options enable and control the auto-update feature; 2235 for a more detailed description refer to doc/README.update. 2236 2237- MTD Support (mtdparts command, UBI support) 2238 CONFIG_MTD_DEVICE 2239 2240 Adds the MTD device infrastructure from the Linux kernel. 2241 Needed for mtdparts command support. 2242 2243 CONFIG_MTD_PARTITIONS 2244 2245 Adds the MTD partitioning infrastructure from the Linux 2246 kernel. Needed for UBI support. 2247 2248 2249Modem Support: 2250-------------- 2251 2252[so far only for SMDK2400 boards] 2253 2254- Modem support enable: 2255 CONFIG_MODEM_SUPPORT 2256 2257- RTS/CTS Flow control enable: 2258 CONFIG_HWFLOW 2259 2260- Modem debug support: 2261 CONFIG_MODEM_SUPPORT_DEBUG 2262 2263 Enables debugging stuff (char screen[1024], dbg()) 2264 for modem support. Useful only with BDI2000. 2265 2266- Interrupt support (PPC): 2267 2268 There are common interrupt_init() and timer_interrupt() 2269 for all PPC archs. interrupt_init() calls interrupt_init_cpu() 2270 for CPU specific initialization. interrupt_init_cpu() 2271 should set decrementer_count to appropriate value. If 2272 CPU resets decrementer automatically after interrupt 2273 (ppc4xx) it should set decrementer_count to zero. 2274 timer_interrupt() calls timer_interrupt_cpu() for CPU 2275 specific handling. If board has watchdog / status_led 2276 / other_activity_monitor it works automatically from 2277 general timer_interrupt(). 2278 2279- General: 2280 2281 In the target system modem support is enabled when a 2282 specific key (key combination) is pressed during 2283 power-on. Otherwise U-Boot will boot normally 2284 (autoboot). The key_pressed() function is called from 2285 board_init(). Currently key_pressed() is a dummy 2286 function, returning 1 and thus enabling modem 2287 initialization. 2288 2289 If there are no modem init strings in the 2290 environment, U-Boot proceed to autoboot; the 2291 previous output (banner, info printfs) will be 2292 suppressed, though. 2293 2294 See also: doc/README.Modem 2295 2296 2297Configuration Settings: 2298----------------------- 2299 2300- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2301 undefine this when you're short of memory. 2302 2303- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 2304 width of the commands listed in the 'help' command output. 2305 2306- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2307 prompt for user input. 2308 2309- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2310 2311- CONFIG_SYS_PBSIZE: Buffer size for Console output 2312 2313- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2314 2315- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2316 the application (usually a Linux kernel) when it is 2317 booted 2318 2319- CONFIG_SYS_BAUDRATE_TABLE: 2320 List of legal baudrate settings for this board. 2321 2322- CONFIG_SYS_CONSOLE_INFO_QUIET 2323 Suppress display of console information at boot. 2324 2325- CONFIG_SYS_CONSOLE_IS_IN_ENV 2326 If the board specific function 2327 extern int overwrite_console (void); 2328 returns 1, the stdin, stderr and stdout are switched to the 2329 serial port, else the settings in the environment are used. 2330 2331- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2332 Enable the call to overwrite_console(). 2333 2334- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2335 Enable overwrite of previous console environment settings. 2336 2337- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2338 Begin and End addresses of the area used by the 2339 simple memory test. 2340 2341- CONFIG_SYS_ALT_MEMTEST: 2342 Enable an alternate, more extensive memory test. 2343 2344- CONFIG_SYS_MEMTEST_SCRATCH: 2345 Scratch address used by the alternate memory test 2346 You only need to set this if address zero isn't writeable 2347 2348- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 2349 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 2350 this specified memory area will get subtracted from the top 2351 (end) of RAM and won't get "touched" at all by U-Boot. By 2352 fixing up gd->ram_size the Linux kernel should gets passed 2353 the now "corrected" memory size and won't touch it either. 2354 This should work for arch/ppc and arch/powerpc. Only Linux 2355 board ports in arch/powerpc with bootwrapper support that 2356 recalculate the memory size from the SDRAM controller setup 2357 will have to get fixed in Linux additionally. 2358 2359 This option can be used as a workaround for the 440EPx/GRx 2360 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 2361 be touched. 2362 2363 WARNING: Please make sure that this value is a multiple of 2364 the Linux page size (normally 4k). If this is not the case, 2365 then the end address of the Linux memory will be located at a 2366 non page size aligned address and this could cause major 2367 problems. 2368 2369- CONFIG_SYS_TFTP_LOADADDR: 2370 Default load address for network file downloads 2371 2372- CONFIG_SYS_LOADS_BAUD_CHANGE: 2373 Enable temporary baudrate change while serial download 2374 2375- CONFIG_SYS_SDRAM_BASE: 2376 Physical start address of SDRAM. _Must_ be 0 here. 2377 2378- CONFIG_SYS_MBIO_BASE: 2379 Physical start address of Motherboard I/O (if using a 2380 Cogent motherboard) 2381 2382- CONFIG_SYS_FLASH_BASE: 2383 Physical start address of Flash memory. 2384 2385- CONFIG_SYS_MONITOR_BASE: 2386 Physical start address of boot monitor code (set by 2387 make config files to be same as the text base address 2388 (CONFIG_SYS_TEXT_BASE) used when linking) - same as 2389 CONFIG_SYS_FLASH_BASE when booting from flash. 2390 2391- CONFIG_SYS_MONITOR_LEN: 2392 Size of memory reserved for monitor code, used to 2393 determine _at_compile_time_ (!) if the environment is 2394 embedded within the U-Boot image, or in a separate 2395 flash sector. 2396 2397- CONFIG_SYS_MALLOC_LEN: 2398 Size of DRAM reserved for malloc() use. 2399 2400- CONFIG_SYS_BOOTM_LEN: 2401 Normally compressed uImages are limited to an 2402 uncompressed size of 8 MBytes. If this is not enough, 2403 you can define CONFIG_SYS_BOOTM_LEN in your board config file 2404 to adjust this setting to your needs. 2405 2406- CONFIG_SYS_BOOTMAPSZ: 2407 Maximum size of memory mapped by the startup code of 2408 the Linux kernel; all data that must be processed by 2409 the Linux kernel (bd_info, boot arguments, FDT blob if 2410 used) must be put below this limit, unless "bootm_low" 2411 enviroment variable is defined and non-zero. In such case 2412 all data for the Linux kernel must be between "bootm_low" 2413 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 2414 variable "bootm_mapsize" will override the value of 2415 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 2416 then the value in "bootm_size" will be used instead. 2417 2418- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2419 Enable initrd_high functionality. If defined then the 2420 initrd_high feature is enabled and the bootm ramdisk subcommand 2421 is enabled. 2422 2423- CONFIG_SYS_BOOT_GET_CMDLINE: 2424 Enables allocating and saving kernel cmdline in space between 2425 "bootm_low" and "bootm_low" + BOOTMAPSZ. 2426 2427- CONFIG_SYS_BOOT_GET_KBD: 2428 Enables allocating and saving a kernel copy of the bd_info in 2429 space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2430 2431- CONFIG_SYS_MAX_FLASH_BANKS: 2432 Max number of Flash memory banks 2433 2434- CONFIG_SYS_MAX_FLASH_SECT: 2435 Max number of sectors on a Flash chip 2436 2437- CONFIG_SYS_FLASH_ERASE_TOUT: 2438 Timeout for Flash erase operations (in ms) 2439 2440- CONFIG_SYS_FLASH_WRITE_TOUT: 2441 Timeout for Flash write operations (in ms) 2442 2443- CONFIG_SYS_FLASH_LOCK_TOUT 2444 Timeout for Flash set sector lock bit operation (in ms) 2445 2446- CONFIG_SYS_FLASH_UNLOCK_TOUT 2447 Timeout for Flash clear lock bits operation (in ms) 2448 2449- CONFIG_SYS_FLASH_PROTECTION 2450 If defined, hardware flash sectors protection is used 2451 instead of U-Boot software protection. 2452 2453- CONFIG_SYS_DIRECT_FLASH_TFTP: 2454 2455 Enable TFTP transfers directly to flash memory; 2456 without this option such a download has to be 2457 performed in two steps: (1) download to RAM, and (2) 2458 copy from RAM to flash. 2459 2460 The two-step approach is usually more reliable, since 2461 you can check if the download worked before you erase 2462 the flash, but in some situations (when system RAM is 2463 too limited to allow for a temporary copy of the 2464 downloaded image) this option may be very useful. 2465 2466- CONFIG_SYS_FLASH_CFI: 2467 Define if the flash driver uses extra elements in the 2468 common flash structure for storing flash geometry. 2469 2470- CONFIG_FLASH_CFI_DRIVER 2471 This option also enables the building of the cfi_flash driver 2472 in the drivers directory 2473 2474- CONFIG_FLASH_CFI_MTD 2475 This option enables the building of the cfi_mtd driver 2476 in the drivers directory. The driver exports CFI flash 2477 to the MTD layer. 2478 2479- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 2480 Use buffered writes to flash. 2481 2482- CONFIG_FLASH_SPANSION_S29WS_N 2483 s29ws-n MirrorBit flash has non-standard addresses for buffered 2484 write commands. 2485 2486- CONFIG_SYS_FLASH_QUIET_TEST 2487 If this option is defined, the common CFI flash doesn't 2488 print it's warning upon not recognized FLASH banks. This 2489 is useful, if some of the configured banks are only 2490 optionally available. 2491 2492- CONFIG_FLASH_SHOW_PROGRESS 2493 If defined (must be an integer), print out countdown 2494 digits and dots. Recommended value: 45 (9..1) for 80 2495 column displays, 15 (3..1) for 40 column displays. 2496 2497- CONFIG_SYS_RX_ETH_BUFFER: 2498 Defines the number of Ethernet receive buffers. On some 2499 Ethernet controllers it is recommended to set this value 2500 to 8 or even higher (EEPRO100 or 405 EMAC), since all 2501 buffers can be full shortly after enabling the interface 2502 on high Ethernet traffic. 2503 Defaults to 4 if not defined. 2504 2505- CONFIG_ENV_MAX_ENTRIES 2506 2507 Maximum number of entries in the hash table that is used 2508 internally to store the environment settings. The default 2509 setting is supposed to be generous and should work in most 2510 cases. This setting can be used to tune behaviour; see 2511 lib/hashtable.c for details. 2512 2513The following definitions that deal with the placement and management 2514of environment data (variable area); in general, we support the 2515following configurations: 2516 2517- CONFIG_ENV_IS_IN_FLASH: 2518 2519 Define this if the environment is in flash memory. 2520 2521 a) The environment occupies one whole flash sector, which is 2522 "embedded" in the text segment with the U-Boot code. This 2523 happens usually with "bottom boot sector" or "top boot 2524 sector" type flash chips, which have several smaller 2525 sectors at the start or the end. For instance, such a 2526 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2527 such a case you would place the environment in one of the 2528 4 kB sectors - with U-Boot code before and after it. With 2529 "top boot sector" type flash chips, you would put the 2530 environment in one of the last sectors, leaving a gap 2531 between U-Boot and the environment. 2532 2533 - CONFIG_ENV_OFFSET: 2534 2535 Offset of environment data (variable area) to the 2536 beginning of flash memory; for instance, with bottom boot 2537 type flash chips the second sector can be used: the offset 2538 for this sector is given here. 2539 2540 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2541 2542 - CONFIG_ENV_ADDR: 2543 2544 This is just another way to specify the start address of 2545 the flash sector containing the environment (instead of 2546 CONFIG_ENV_OFFSET). 2547 2548 - CONFIG_ENV_SECT_SIZE: 2549 2550 Size of the sector containing the environment. 2551 2552 2553 b) Sometimes flash chips have few, equal sized, BIG sectors. 2554 In such a case you don't want to spend a whole sector for 2555 the environment. 2556 2557 - CONFIG_ENV_SIZE: 2558 2559 If you use this in combination with CONFIG_ENV_IS_IN_FLASH 2560 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2561 of this flash sector for the environment. This saves 2562 memory for the RAM copy of the environment. 2563 2564 It may also save flash memory if you decide to use this 2565 when your environment is "embedded" within U-Boot code, 2566 since then the remainder of the flash sector could be used 2567 for U-Boot code. It should be pointed out that this is 2568 STRONGLY DISCOURAGED from a robustness point of view: 2569 updating the environment in flash makes it always 2570 necessary to erase the WHOLE sector. If something goes 2571 wrong before the contents has been restored from a copy in 2572 RAM, your target system will be dead. 2573 2574 - CONFIG_ENV_ADDR_REDUND 2575 CONFIG_ENV_SIZE_REDUND 2576 2577 These settings describe a second storage area used to hold 2578 a redundant copy of the environment data, so that there is 2579 a valid backup copy in case there is a power failure during 2580 a "saveenv" operation. 2581 2582BE CAREFUL! Any changes to the flash layout, and some changes to the 2583source code will make it necessary to adapt <board>/u-boot.lds* 2584accordingly! 2585 2586 2587- CONFIG_ENV_IS_IN_NVRAM: 2588 2589 Define this if you have some non-volatile memory device 2590 (NVRAM, battery buffered SRAM) which you want to use for the 2591 environment. 2592 2593 - CONFIG_ENV_ADDR: 2594 - CONFIG_ENV_SIZE: 2595 2596 These two #defines are used to determine the memory area you 2597 want to use for environment. It is assumed that this memory 2598 can just be read and written to, without any special 2599 provision. 2600 2601BE CAREFUL! The first access to the environment happens quite early 2602in U-Boot initalization (when we try to get the setting of for the 2603console baudrate). You *MUST* have mapped your NVRAM area then, or 2604U-Boot will hang. 2605 2606Please note that even with NVRAM we still use a copy of the 2607environment in RAM: we could work on NVRAM directly, but we want to 2608keep settings there always unmodified except somebody uses "saveenv" 2609to save the current settings. 2610 2611 2612- CONFIG_ENV_IS_IN_EEPROM: 2613 2614 Use this if you have an EEPROM or similar serial access 2615 device and a driver for it. 2616 2617 - CONFIG_ENV_OFFSET: 2618 - CONFIG_ENV_SIZE: 2619 2620 These two #defines specify the offset and size of the 2621 environment area within the total memory of your EEPROM. 2622 2623 - CONFIG_SYS_I2C_EEPROM_ADDR: 2624 If defined, specified the chip address of the EEPROM device. 2625 The default address is zero. 2626 2627 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2628 If defined, the number of bits used to address bytes in a 2629 single page in the EEPROM device. A 64 byte page, for example 2630 would require six bits. 2631 2632 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2633 If defined, the number of milliseconds to delay between 2634 page writes. The default is zero milliseconds. 2635 2636 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2637 The length in bytes of the EEPROM memory array address. Note 2638 that this is NOT the chip address length! 2639 2640 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 2641 EEPROM chips that implement "address overflow" are ones 2642 like Catalyst 24WC04/08/16 which has 9/10/11 bits of 2643 address and the extra bits end up in the "chip address" bit 2644 slots. This makes a 24WC08 (1Kbyte) chip look like four 256 2645 byte chips. 2646 2647 Note that we consider the length of the address field to 2648 still be one byte because the extra address bits are hidden 2649 in the chip address. 2650 2651 - CONFIG_SYS_EEPROM_SIZE: 2652 The size in bytes of the EEPROM device. 2653 2654 - CONFIG_ENV_EEPROM_IS_ON_I2C 2655 define this, if you have I2C and SPI activated, and your 2656 EEPROM, which holds the environment, is on the I2C bus. 2657 2658 - CONFIG_I2C_ENV_EEPROM_BUS 2659 if you have an Environment on an EEPROM reached over 2660 I2C muxes, you can define here, how to reach this 2661 EEPROM. For example: 2662 2663 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2664 2665 EEPROM which holds the environment, is reached over 2666 a pca9547 i2c mux with address 0x70, channel 3. 2667 2668- CONFIG_ENV_IS_IN_DATAFLASH: 2669 2670 Define this if you have a DataFlash memory device which you 2671 want to use for the environment. 2672 2673 - CONFIG_ENV_OFFSET: 2674 - CONFIG_ENV_ADDR: 2675 - CONFIG_ENV_SIZE: 2676 2677 These three #defines specify the offset and size of the 2678 environment area within the total memory of your DataFlash placed 2679 at the specified address. 2680 2681- CONFIG_ENV_IS_IN_NAND: 2682 2683 Define this if you have a NAND device which you want to use 2684 for the environment. 2685 2686 - CONFIG_ENV_OFFSET: 2687 - CONFIG_ENV_SIZE: 2688 2689 These two #defines specify the offset and size of the environment 2690 area within the first NAND device. CONFIG_ENV_OFFSET must be 2691 aligned to an erase block boundary. 2692 2693 - CONFIG_ENV_OFFSET_REDUND (optional): 2694 2695 This setting describes a second storage area of CONFIG_ENV_SIZE 2696 size used to hold a redundant copy of the environment data, so 2697 that there is a valid backup copy in case there is a power failure 2698 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2699 aligned to an erase block boundary. 2700 2701 - CONFIG_ENV_RANGE (optional): 2702 2703 Specifies the length of the region in which the environment 2704 can be written. This should be a multiple of the NAND device's 2705 block size. Specifying a range with more erase blocks than 2706 are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2707 the range to be avoided. 2708 2709 - CONFIG_ENV_OFFSET_OOB (optional): 2710 2711 Enables support for dynamically retrieving the offset of the 2712 environment from block zero's out-of-band data. The 2713 "nand env.oob" command can be used to record this offset. 2714 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2715 using CONFIG_ENV_OFFSET_OOB. 2716 2717- CONFIG_NAND_ENV_DST 2718 2719 Defines address in RAM to which the nand_spl code should copy the 2720 environment. If redundant environment is used, it will be copied to 2721 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2722 2723- CONFIG_SYS_SPI_INIT_OFFSET 2724 2725 Defines offset to the initial SPI buffer area in DPRAM. The 2726 area is used at an early stage (ROM part) if the environment 2727 is configured to reside in the SPI EEPROM: We need a 520 byte 2728 scratch DPRAM area. It is used between the two initialization 2729 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2730 to be a good choice since it makes it far enough from the 2731 start of the data area as well as from the stack pointer. 2732 2733Please note that the environment is read-only until the monitor 2734has been relocated to RAM and a RAM copy of the environment has been 2735created; also, when using EEPROM you will have to use getenv_f() 2736until then to read environment variables. 2737 2738The environment is protected by a CRC32 checksum. Before the monitor 2739is relocated into RAM, as a result of a bad CRC you will be working 2740with the compiled-in default environment - *silently*!!! [This is 2741necessary, because the first environment variable we need is the 2742"baudrate" setting for the console - if we have a bad CRC, we don't 2743have any device yet where we could complain.] 2744 2745Note: once the monitor has been relocated, then it will complain if 2746the default environment is used; a new CRC is computed as soon as you 2747use the "saveenv" command to store a valid environment. 2748 2749- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2750 Echo the inverted Ethernet link state to the fault LED. 2751 2752 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2753 also needs to be defined. 2754 2755- CONFIG_SYS_FAULT_MII_ADDR: 2756 MII address of the PHY to check for the Ethernet link state. 2757 2758- CONFIG_NS16550_MIN_FUNCTIONS: 2759 Define this if you desire to only have use of the NS16550_init 2760 and NS16550_putc functions for the serial driver located at 2761 drivers/serial/ns16550.c. This option is useful for saving 2762 space for already greatly restricted images, including but not 2763 limited to NAND_SPL configurations. 2764 2765Low Level (hardware related) configuration options: 2766--------------------------------------------------- 2767 2768- CONFIG_SYS_CACHELINE_SIZE: 2769 Cache Line Size of the CPU. 2770 2771- CONFIG_SYS_DEFAULT_IMMR: 2772 Default address of the IMMR after system reset. 2773 2774 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 2775 and RPXsuper) to be able to adjust the position of 2776 the IMMR register after a reset. 2777 2778- Floppy Disk Support: 2779 CONFIG_SYS_FDC_DRIVE_NUMBER 2780 2781 the default drive number (default value 0) 2782 2783 CONFIG_SYS_ISA_IO_STRIDE 2784 2785 defines the spacing between FDC chipset registers 2786 (default value 1) 2787 2788 CONFIG_SYS_ISA_IO_OFFSET 2789 2790 defines the offset of register from address. It 2791 depends on which part of the data bus is connected to 2792 the FDC chipset. (default value 0) 2793 2794 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 2795 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 2796 default value. 2797 2798 if CONFIG_SYS_FDC_HW_INIT is defined, then the function 2799 fdc_hw_init() is called at the beginning of the FDC 2800 setup. fdc_hw_init() must be provided by the board 2801 source code. It is used to make hardware dependant 2802 initializations. 2803 2804- CONFIG_IDE_AHB: 2805 Most IDE controllers were designed to be connected with PCI 2806 interface. Only few of them were designed for AHB interface. 2807 When software is doing ATA command and data transfer to 2808 IDE devices through IDE-AHB controller, some additional 2809 registers accessing to these kind of IDE-AHB controller 2810 is requierd. 2811 2812- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 2813 DO NOT CHANGE unless you know exactly what you're 2814 doing! (11-4) [MPC8xx/82xx systems only] 2815 2816- CONFIG_SYS_INIT_RAM_ADDR: 2817 2818 Start address of memory area that can be used for 2819 initial data and stack; please note that this must be 2820 writable memory that is working WITHOUT special 2821 initialization, i. e. you CANNOT use normal RAM which 2822 will become available only after programming the 2823 memory controller and running certain initialization 2824 sequences. 2825 2826 U-Boot uses the following memory types: 2827 - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2828 - MPC824X: data cache 2829 - PPC4xx: data cache 2830 2831- CONFIG_SYS_GBL_DATA_OFFSET: 2832 2833 Offset of the initial data structure in the memory 2834 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 2835 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 2836 data is located at the end of the available space 2837 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 2838 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 2839 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 2840 CONFIG_SYS_GBL_DATA_OFFSET) downward. 2841 2842 Note: 2843 On the MPC824X (or other systems that use the data 2844 cache for initial memory) the address chosen for 2845 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 2846 point to an otherwise UNUSED address space between 2847 the top of RAM and the start of the PCI space. 2848 2849- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 2850 2851- CONFIG_SYS_SYPCR: System Protection Control (11-9) 2852 2853- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 2854 2855- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 2856 2857- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2858 2859- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 2860 2861- CONFIG_SYS_OR_TIMING_SDRAM: 2862 SDRAM timing 2863 2864- CONFIG_SYS_MAMR_PTA: 2865 periodic timer for refresh 2866 2867- CONFIG_SYS_DER: Debug Event Register (37-47) 2868 2869- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 2870 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 2871 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 2872 CONFIG_SYS_BR1_PRELIM: 2873 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2874 2875- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 2876 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 2877 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 2878 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2879 2880- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 2881 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 2882 Machine Mode Register and Memory Periodic Timer 2883 Prescaler definitions (SDRAM timing) 2884 2885- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 2886 enable I2C microcode relocation patch (MPC8xx); 2887 define relocation offset in DPRAM [DSP2] 2888 2889- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 2890 enable SMC microcode relocation patch (MPC8xx); 2891 define relocation offset in DPRAM [SMC1] 2892 2893- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 2894 enable SPI microcode relocation patch (MPC8xx); 2895 define relocation offset in DPRAM [SCC4] 2896 2897- CONFIG_SYS_USE_OSCCLK: 2898 Use OSCM clock mode on MBX8xx board. Be careful, 2899 wrong setting might damage your board. Read 2900 doc/README.MBX before setting this variable! 2901 2902- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2903 Offset of the bootmode word in DPRAM used by post 2904 (Power On Self Tests). This definition overrides 2905 #define'd default value in commproc.h resp. 2906 cpm_8260.h. 2907 2908- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 2909 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 2910 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 2911 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 2912 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 2913 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 2914 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 2915 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 2916 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 2917 2918- CONFIG_PCI_DISABLE_PCIE: 2919 Disable PCI-Express on systems where it is supported but not 2920 required. 2921 2922- CONFIG_SYS_SRIO: 2923 Chip has SRIO or not 2924 2925- CONFIG_SRIO1: 2926 Board has SRIO 1 port available 2927 2928- CONFIG_SRIO2: 2929 Board has SRIO 2 port available 2930 2931- CONFIG_SYS_SRIOn_MEM_VIRT: 2932 Virtual Address of SRIO port 'n' memory region 2933 2934- CONFIG_SYS_SRIOn_MEM_PHYS: 2935 Physical Address of SRIO port 'n' memory region 2936 2937- CONFIG_SYS_SRIOn_MEM_SIZE: 2938 Size of SRIO port 'n' memory region 2939 2940- CONFIG_SYS_NDFC_16 2941 Defined to tell the NDFC that the NAND chip is using a 2942 16 bit bus. 2943 2944- CONFIG_SYS_NDFC_EBC0_CFG 2945 Sets the EBC0_CFG register for the NDFC. If not defined 2946 a default value will be used. 2947 2948- CONFIG_SPD_EEPROM 2949 Get DDR timing information from an I2C EEPROM. Common 2950 with pluggable memory modules such as SODIMMs 2951 2952 SPD_EEPROM_ADDRESS 2953 I2C address of the SPD EEPROM 2954 2955- CONFIG_SYS_SPD_BUS_NUM 2956 If SPD EEPROM is on an I2C bus other than the first 2957 one, specify here. Note that the value must resolve 2958 to something your driver can deal with. 2959 2960- CONFIG_SYS_DDR_RAW_TIMING 2961 Get DDR timing information from other than SPD. Common with 2962 soldered DDR chips onboard without SPD. DDR raw timing 2963 parameters are extracted from datasheet and hard-coded into 2964 header files or board specific files. 2965 2966- CONFIG_SYS_83XX_DDR_USES_CS0 2967 Only for 83xx systems. If specified, then DDR should 2968 be configured using CS0 and CS1 instead of CS2 and CS3. 2969 2970- CONFIG_ETHER_ON_FEC[12] 2971 Define to enable FEC[12] on a 8xx series processor. 2972 2973- CONFIG_FEC[12]_PHY 2974 Define to the hardcoded PHY address which corresponds 2975 to the given FEC; i. e. 2976 #define CONFIG_FEC1_PHY 4 2977 means that the PHY with address 4 is connected to FEC1 2978 2979 When set to -1, means to probe for first available. 2980 2981- CONFIG_FEC[12]_PHY_NORXERR 2982 The PHY does not have a RXERR line (RMII only). 2983 (so program the FEC to ignore it). 2984 2985- CONFIG_RMII 2986 Enable RMII mode for all FECs. 2987 Note that this is a global option, we can't 2988 have one FEC in standard MII mode and another in RMII mode. 2989 2990- CONFIG_CRC32_VERIFY 2991 Add a verify option to the crc32 command. 2992 The syntax is: 2993 2994 => crc32 -v <address> <count> <crc32> 2995 2996 Where address/count indicate a memory area 2997 and crc32 is the correct crc32 which the 2998 area should have. 2999 3000- CONFIG_LOOPW 3001 Add the "loopw" memory command. This only takes effect if 3002 the memory commands are activated globally (CONFIG_CMD_MEM). 3003 3004- CONFIG_MX_CYCLIC 3005 Add the "mdc" and "mwc" memory commands. These are cyclic 3006 "md/mw" commands. 3007 Examples: 3008 3009 => mdc.b 10 4 500 3010 This command will print 4 bytes (10,11,12,13) each 500 ms. 3011 3012 => mwc.l 100 12345678 10 3013 This command will write 12345678 to address 100 all 10 ms. 3014 3015 This only takes effect if the memory commands are activated 3016 globally (CONFIG_CMD_MEM). 3017 3018- CONFIG_SKIP_LOWLEVEL_INIT 3019 [ARM only] If this variable is defined, then certain 3020 low level initializations (like setting up the memory 3021 controller) are omitted and/or U-Boot does not 3022 relocate itself into RAM. 3023 3024 Normally this variable MUST NOT be defined. The only 3025 exception is when U-Boot is loaded (to RAM) by some 3026 other boot loader or by a debugger which performs 3027 these initializations itself. 3028 3029- CONFIG_PRELOADER 3030 Modifies the behaviour of start.S when compiling a loader 3031 that is executed before the actual U-Boot. E.g. when 3032 compiling a NAND SPL. 3033 3034- CONFIG_USE_ARCH_MEMCPY 3035 CONFIG_USE_ARCH_MEMSET 3036 If these options are used a optimized version of memcpy/memset will 3037 be used if available. These functions may be faster under some 3038 conditions but may increase the binary size. 3039 3040Building the Software: 3041====================== 3042 3043Building U-Boot has been tested in several native build environments 3044and in many different cross environments. Of course we cannot support 3045all possibly existing versions of cross development tools in all 3046(potentially obsolete) versions. In case of tool chain problems we 3047recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3048which is extensively used to build and test U-Boot. 3049 3050If you are not using a native environment, it is assumed that you 3051have GNU cross compiling tools available in your path. In this case, 3052you must set the environment variable CROSS_COMPILE in your shell. 3053Note that no changes to the Makefile or any other source files are 3054necessary. For example using the ELDK on a 4xx CPU, please enter: 3055 3056 $ CROSS_COMPILE=ppc_4xx- 3057 $ export CROSS_COMPILE 3058 3059Note: If you wish to generate Windows versions of the utilities in 3060 the tools directory you can use the MinGW toolchain 3061 (http://www.mingw.org). Set your HOST tools to the MinGW 3062 toolchain and execute 'make tools'. For example: 3063 3064 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 3065 3066 Binaries such as tools/mkimage.exe will be created which can 3067 be executed on computers running Windows. 3068 3069U-Boot is intended to be simple to build. After installing the 3070sources you must configure U-Boot for one specific board type. This 3071is done by typing: 3072 3073 make NAME_config 3074 3075where "NAME_config" is the name of one of the existing configu- 3076rations; see the main Makefile for supported names. 3077 3078Note: for some board special configuration names may exist; check if 3079 additional information is available from the board vendor; for 3080 instance, the TQM823L systems are available without (standard) 3081 or with LCD support. You can select such additional "features" 3082 when choosing the configuration, i. e. 3083 3084 make TQM823L_config 3085 - will configure for a plain TQM823L, i. e. no LCD support 3086 3087 make TQM823L_LCD_config 3088 - will configure for a TQM823L with U-Boot console on LCD 3089 3090 etc. 3091 3092 3093Finally, type "make all", and you should get some working U-Boot 3094images ready for download to / installation on your system: 3095 3096- "u-boot.bin" is a raw binary image 3097- "u-boot" is an image in ELF binary format 3098- "u-boot.srec" is in Motorola S-Record format 3099 3100By default the build is performed locally and the objects are saved 3101in the source directory. One of the two methods can be used to change 3102this behavior and build U-Boot to some external directory: 3103 31041. Add O= to the make command line invocations: 3105 3106 make O=/tmp/build distclean 3107 make O=/tmp/build NAME_config 3108 make O=/tmp/build all 3109 31102. Set environment variable BUILD_DIR to point to the desired location: 3111 3112 export BUILD_DIR=/tmp/build 3113 make distclean 3114 make NAME_config 3115 make all 3116 3117Note that the command line "O=" setting overrides the BUILD_DIR environment 3118variable. 3119 3120 3121Please be aware that the Makefiles assume you are using GNU make, so 3122for instance on NetBSD you might need to use "gmake" instead of 3123native "make". 3124 3125 3126If the system board that you have is not listed, then you will need 3127to port U-Boot to your hardware platform. To do this, follow these 3128steps: 3129 31301. Add a new configuration option for your board to the toplevel 3131 "Makefile" and to the "MAKEALL" script, using the existing 3132 entries as examples. Note that here and at many other places 3133 boards and other names are listed in alphabetical sort order. Please 3134 keep this order. 31352. Create a new directory to hold your board specific code. Add any 3136 files you need. In your board directory, you will need at least 3137 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 31383. Create a new configuration file "include/configs/<board>.h" for 3139 your board 31403. If you're porting U-Boot to a new CPU, then also create a new 3141 directory to hold your CPU specific code. Add any files you need. 31424. Run "make <board>_config" with your new name. 31435. Type "make", and you should get a working "u-boot.srec" file 3144 to be installed on your target system. 31456. Debug and solve any problems that might arise. 3146 [Of course, this last step is much harder than it sounds.] 3147 3148 3149Testing of U-Boot Modifications, Ports to New Hardware, etc.: 3150============================================================== 3151 3152If you have modified U-Boot sources (for instance added a new board 3153or support for new devices, a new CPU, etc.) you are expected to 3154provide feedback to the other developers. The feedback normally takes 3155the form of a "patch", i. e. a context diff against a certain (latest 3156official or latest in the git repository) version of U-Boot sources. 3157 3158But before you submit such a patch, please verify that your modifi- 3159cation did not break existing code. At least make sure that *ALL* of 3160the supported boards compile WITHOUT ANY compiler warnings. To do so, 3161just run the "MAKEALL" script, which will configure and build U-Boot 3162for ALL supported system. Be warned, this will take a while. You can 3163select which (cross) compiler to use by passing a `CROSS_COMPILE' 3164environment variable to the script, i. e. to use the ELDK cross tools 3165you can type 3166 3167 CROSS_COMPILE=ppc_8xx- MAKEALL 3168 3169or to build on a native PowerPC system you can type 3170 3171 CROSS_COMPILE=' ' MAKEALL 3172 3173When using the MAKEALL script, the default behaviour is to build 3174U-Boot in the source directory. This location can be changed by 3175setting the BUILD_DIR environment variable. Also, for each target 3176built, the MAKEALL script saves two log files (<target>.ERR and 3177<target>.MAKEALL) in the <source dir>/LOG directory. This default 3178location can be changed by setting the MAKEALL_LOGDIR environment 3179variable. For example: 3180 3181 export BUILD_DIR=/tmp/build 3182 export MAKEALL_LOGDIR=/tmp/log 3183 CROSS_COMPILE=ppc_8xx- MAKEALL 3184 3185With the above settings build objects are saved in the /tmp/build, 3186log files are saved in the /tmp/log and the source tree remains clean 3187during the whole build process. 3188 3189 3190See also "U-Boot Porting Guide" below. 3191 3192 3193Monitor Commands - Overview: 3194============================ 3195 3196go - start application at address 'addr' 3197run - run commands in an environment variable 3198bootm - boot application image from memory 3199bootp - boot image via network using BootP/TFTP protocol 3200tftpboot- boot image via network using TFTP protocol 3201 and env variables "ipaddr" and "serverip" 3202 (and eventually "gatewayip") 3203rarpboot- boot image via network using RARP/TFTP protocol 3204diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3205loads - load S-Record file over serial line 3206loadb - load binary file over serial line (kermit mode) 3207md - memory display 3208mm - memory modify (auto-incrementing) 3209nm - memory modify (constant address) 3210mw - memory write (fill) 3211cp - memory copy 3212cmp - memory compare 3213crc32 - checksum calculation 3214i2c - I2C sub-system 3215sspi - SPI utility commands 3216base - print or set address offset 3217printenv- print environment variables 3218setenv - set environment variables 3219saveenv - save environment variables to persistent storage 3220protect - enable or disable FLASH write protection 3221erase - erase FLASH memory 3222flinfo - print FLASH memory information 3223bdinfo - print Board Info structure 3224iminfo - print header information for application image 3225coninfo - print console devices and informations 3226ide - IDE sub-system 3227loop - infinite loop on address range 3228loopw - infinite write loop on address range 3229mtest - simple RAM test 3230icache - enable or disable instruction cache 3231dcache - enable or disable data cache 3232reset - Perform RESET of the CPU 3233echo - echo args to console 3234version - print monitor version 3235help - print online help 3236? - alias for 'help' 3237 3238 3239Monitor Commands - Detailed Description: 3240======================================== 3241 3242TODO. 3243 3244For now: just type "help <command>". 3245 3246 3247Environment Variables: 3248====================== 3249 3250U-Boot supports user configuration using Environment Variables which 3251can be made persistent by saving to Flash memory. 3252 3253Environment Variables are set using "setenv", printed using 3254"printenv", and saved to Flash using "saveenv". Using "setenv" 3255without a value can be used to delete a variable from the 3256environment. As long as you don't save the environment you are 3257working with an in-memory copy. In case the Flash area containing the 3258environment is erased by accident, a default environment is provided. 3259 3260Some configuration options can be set using Environment Variables. 3261 3262List of environment variables (most likely not complete): 3263 3264 baudrate - see CONFIG_BAUDRATE 3265 3266 bootdelay - see CONFIG_BOOTDELAY 3267 3268 bootcmd - see CONFIG_BOOTCOMMAND 3269 3270 bootargs - Boot arguments when booting an RTOS image 3271 3272 bootfile - Name of the image to load with TFTP 3273 3274 bootm_low - Memory range available for image processing in the bootm 3275 command can be restricted. This variable is given as 3276 a hexadecimal number and defines lowest address allowed 3277 for use by the bootm command. See also "bootm_size" 3278 environment variable. Address defined by "bootm_low" is 3279 also the base of the initial memory mapping for the Linux 3280 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 3281 bootm_mapsize. 3282 3283 bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 3284 This variable is given as a hexadecimal number and it 3285 defines the size of the memory region starting at base 3286 address bootm_low that is accessible by the Linux kernel 3287 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 3288 as the default value if it is defined, and bootm_size is 3289 used otherwise. 3290 3291 bootm_size - Memory range available for image processing in the bootm 3292 command can be restricted. This variable is given as 3293 a hexadecimal number and defines the size of the region 3294 allowed for use by the bootm command. See also "bootm_low" 3295 environment variable. 3296 3297 updatefile - Location of the software update file on a TFTP server, used 3298 by the automatic software update feature. Please refer to 3299 documentation in doc/README.update for more details. 3300 3301 autoload - if set to "no" (any string beginning with 'n'), 3302 "bootp" will just load perform a lookup of the 3303 configuration from the BOOTP server, but not try to 3304 load any image using TFTP 3305 3306 autostart - if set to "yes", an image loaded using the "bootp", 3307 "rarpboot", "tftpboot" or "diskboot" commands will 3308 be automatically started (by internally calling 3309 "bootm") 3310 3311 If set to "no", a standalone image passed to the 3312 "bootm" command will be copied to the load address 3313 (and eventually uncompressed), but NOT be started. 3314 This can be used to load and uncompress arbitrary 3315 data. 3316 3317 i2cfast - (PPC405GP|PPC405EP only) 3318 if set to 'y' configures Linux I2C driver for fast 3319 mode (400kHZ). This environment variable is used in 3320 initialization code. So, for changes to be effective 3321 it must be saved and board must be reset. 3322 3323 initrd_high - restrict positioning of initrd images: 3324 If this variable is not set, initrd images will be 3325 copied to the highest possible address in RAM; this 3326 is usually what you want since it allows for 3327 maximum initrd size. If for some reason you want to 3328 make sure that the initrd image is loaded below the 3329 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3330 variable to a value of "no" or "off" or "0". 3331 Alternatively, you can set it to a maximum upper 3332 address to use (U-Boot will still check that it 3333 does not overwrite the U-Boot stack and data). 3334 3335 For instance, when you have a system with 16 MB 3336 RAM, and want to reserve 4 MB from use by Linux, 3337 you can do this by adding "mem=12M" to the value of 3338 the "bootargs" variable. However, now you must make 3339 sure that the initrd image is placed in the first 3340 12 MB as well - this can be done with 3341 3342 setenv initrd_high 00c00000 3343 3344 If you set initrd_high to 0xFFFFFFFF, this is an 3345 indication to U-Boot that all addresses are legal 3346 for the Linux kernel, including addresses in flash 3347 memory. In this case U-Boot will NOT COPY the 3348 ramdisk at all. This may be useful to reduce the 3349 boot time on your system, but requires that this 3350 feature is supported by your Linux kernel. 3351 3352 ipaddr - IP address; needed for tftpboot command 3353 3354 loadaddr - Default load address for commands like "bootp", 3355 "rarpboot", "tftpboot", "loadb" or "diskboot" 3356 3357 loads_echo - see CONFIG_LOADS_ECHO 3358 3359 serverip - TFTP server IP address; needed for tftpboot command 3360 3361 bootretry - see CONFIG_BOOT_RETRY_TIME 3362 3363 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3364 3365 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3366 3367 ethprime - When CONFIG_NET_MULTI is enabled controls which 3368 interface is used first. 3369 3370 ethact - When CONFIG_NET_MULTI is enabled controls which 3371 interface is currently active. For example you 3372 can do the following 3373 3374 => setenv ethact FEC 3375 => ping 192.168.0.1 # traffic sent on FEC 3376 => setenv ethact SCC 3377 => ping 10.0.0.1 # traffic sent on SCC 3378 3379 ethrotate - When set to "no" U-Boot does not go through all 3380 available network interfaces. 3381 It just stays at the currently selected interface. 3382 3383 netretry - When set to "no" each network operation will 3384 either succeed or fail without retrying. 3385 When set to "once" the network operation will 3386 fail when all the available network interfaces 3387 are tried once without success. 3388 Useful on scripts which control the retry operation 3389 themselves. 3390 3391 npe_ucode - set load address for the NPE microcode 3392 3393 tftpsrcport - If this is set, the value is used for TFTP's 3394 UDP source port. 3395 3396 tftpdstport - If this is set, the value is used for TFTP's UDP 3397 destination port instead of the Well Know Port 69. 3398 3399 tftpblocksize - Block size to use for TFTP transfers; if not set, 3400 we use the TFTP server's default block size 3401 3402 tftptimeout - Retransmission timeout for TFTP packets (in milli- 3403 seconds, minimum value is 1000 = 1 second). Defines 3404 when a packet is considered to be lost so it has to 3405 be retransmitted. The default is 5000 = 5 seconds. 3406 Lowering this value may make downloads succeed 3407 faster in networks with high packet loss rates or 3408 with unreliable TFTP servers. 3409 3410 vlan - When set to a value < 4095 the traffic over 3411 Ethernet is encapsulated/received over 802.1q 3412 VLAN tagged frames. 3413 3414The following environment variables may be used and automatically 3415updated by the network boot commands ("bootp" and "rarpboot"), 3416depending the information provided by your boot server: 3417 3418 bootfile - see above 3419 dnsip - IP address of your Domain Name Server 3420 dnsip2 - IP address of your secondary Domain Name Server 3421 gatewayip - IP address of the Gateway (Router) to use 3422 hostname - Target hostname 3423 ipaddr - see above 3424 netmask - Subnet Mask 3425 rootpath - Pathname of the root filesystem on the NFS server 3426 serverip - see above 3427 3428 3429There are two special Environment Variables: 3430 3431 serial# - contains hardware identification information such 3432 as type string and/or serial number 3433 ethaddr - Ethernet address 3434 3435These variables can be set only once (usually during manufacturing of 3436the board). U-Boot refuses to delete or overwrite these variables 3437once they have been set once. 3438 3439 3440Further special Environment Variables: 3441 3442 ver - Contains the U-Boot version string as printed 3443 with the "version" command. This variable is 3444 readonly (see CONFIG_VERSION_VARIABLE). 3445 3446 3447Please note that changes to some configuration parameters may take 3448only effect after the next boot (yes, that's just like Windoze :-). 3449 3450 3451Command Line Parsing: 3452===================== 3453 3454There are two different command line parsers available with U-Boot: 3455the old "simple" one, and the much more powerful "hush" shell: 3456 3457Old, simple command line parser: 3458-------------------------------- 3459 3460- supports environment variables (through setenv / saveenv commands) 3461- several commands on one line, separated by ';' 3462- variable substitution using "... ${name} ..." syntax 3463- special characters ('$', ';') can be escaped by prefixing with '\', 3464 for example: 3465 setenv bootcmd bootm \${address} 3466- You can also escape text by enclosing in single apostrophes, for example: 3467 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3468 3469Hush shell: 3470----------- 3471 3472- similar to Bourne shell, with control structures like 3473 if...then...else...fi, for...do...done; while...do...done, 3474 until...do...done, ... 3475- supports environment ("global") variables (through setenv / saveenv 3476 commands) and local shell variables (through standard shell syntax 3477 "name=value"); only environment variables can be used with "run" 3478 command 3479 3480General rules: 3481-------------- 3482 3483(1) If a command line (or an environment variable executed by a "run" 3484 command) contains several commands separated by semicolon, and 3485 one of these commands fails, then the remaining commands will be 3486 executed anyway. 3487 3488(2) If you execute several variables with one call to run (i. e. 3489 calling run with a list of variables as arguments), any failing 3490 command will cause "run" to terminate, i. e. the remaining 3491 variables are not executed. 3492 3493Note for Redundant Ethernet Interfaces: 3494======================================= 3495 3496Some boards come with redundant Ethernet interfaces; U-Boot supports 3497such configurations and is capable of automatic selection of a 3498"working" interface when needed. MAC assignment works as follows: 3499 3500Network interfaces are numbered eth0, eth1, eth2, ... Corresponding 3501MAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3502"eth1addr" (=>eth1), "eth2addr", ... 3503 3504If the network interface stores some valid MAC address (for instance 3505in SROM), this is used as default address if there is NO correspon- 3506ding setting in the environment; if the corresponding environment 3507variable is set, this overrides the settings in the card; that means: 3508 3509o If the SROM has a valid MAC address, and there is no address in the 3510 environment, the SROM's address is used. 3511 3512o If there is no valid address in the SROM, and a definition in the 3513 environment exists, then the value from the environment variable is 3514 used. 3515 3516o If both the SROM and the environment contain a MAC address, and 3517 both addresses are the same, this MAC address is used. 3518 3519o If both the SROM and the environment contain a MAC address, and the 3520 addresses differ, the value from the environment is used and a 3521 warning is printed. 3522 3523o If neither SROM nor the environment contain a MAC address, an error 3524 is raised. 3525 3526If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3527will be programmed into hardware as part of the initialization process. This 3528may be skipped by setting the appropriate 'ethmacskip' environment variable. 3529The naming convention is as follows: 3530"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3531 3532Image Formats: 3533============== 3534 3535U-Boot is capable of booting (and performing other auxiliary operations on) 3536images in two formats: 3537 3538New uImage format (FIT) 3539----------------------- 3540 3541Flexible and powerful format based on Flattened Image Tree -- FIT (similar 3542to Flattened Device Tree). It allows the use of images with multiple 3543components (several kernels, ramdisks, etc.), with contents protected by 3544SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 3545 3546 3547Old uImage format 3548----------------- 3549 3550Old image format is based on binary files which can be basically anything, 3551preceded by a special header; see the definitions in include/image.h for 3552details; basically, the header defines the following image properties: 3553 3554* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3555 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3556 LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3557 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3558 INTEGRITY). 3559* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 3560 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 3561 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC). 3562* Compression Type (uncompressed, gzip, bzip2) 3563* Load Address 3564* Entry Point 3565* Image Name 3566* Image Timestamp 3567 3568The header is marked by a special Magic Number, and both the header 3569and the data portions of the image are secured against corruption by 3570CRC32 checksums. 3571 3572 3573Linux Support: 3574============== 3575 3576Although U-Boot should support any OS or standalone application 3577easily, the main focus has always been on Linux during the design of 3578U-Boot. 3579 3580U-Boot includes many features that so far have been part of some 3581special "boot loader" code within the Linux kernel. Also, any 3582"initrd" images to be used are no longer part of one big Linux image; 3583instead, kernel and "initrd" are separate images. This implementation 3584serves several purposes: 3585 3586- the same features can be used for other OS or standalone 3587 applications (for instance: using compressed images to reduce the 3588 Flash memory footprint) 3589 3590- it becomes much easier to port new Linux kernel versions because 3591 lots of low-level, hardware dependent stuff are done by U-Boot 3592 3593- the same Linux kernel image can now be used with different "initrd" 3594 images; of course this also means that different kernel images can 3595 be run with the same "initrd". This makes testing easier (you don't 3596 have to build a new "zImage.initrd" Linux image when you just 3597 change a file in your "initrd"). Also, a field-upgrade of the 3598 software is easier now. 3599 3600 3601Linux HOWTO: 3602============ 3603 3604Porting Linux to U-Boot based systems: 3605--------------------------------------- 3606 3607U-Boot cannot save you from doing all the necessary modifications to 3608configure the Linux device drivers for use with your target hardware 3609(no, we don't intend to provide a full virtual machine interface to 3610Linux :-). 3611 3612But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 3613 3614Just make sure your machine specific header file (for instance 3615include/asm-ppc/tqm8xx.h) includes the same definition of the Board 3616Information structure as we define in include/asm-<arch>/u-boot.h, 3617and make sure that your definition of IMAP_ADDR uses the same value 3618as your U-Boot configuration in CONFIG_SYS_IMMR. 3619 3620 3621Configuring the Linux kernel: 3622----------------------------- 3623 3624No specific requirements for U-Boot. Make sure you have some root 3625device (initial ramdisk, NFS) for your target system. 3626 3627 3628Building a Linux Image: 3629----------------------- 3630 3631With U-Boot, "normal" build targets like "zImage" or "bzImage" are 3632not used. If you use recent kernel source, a new build target 3633"uImage" will exist which automatically builds an image usable by 3634U-Boot. Most older kernels also have support for a "pImage" target, 3635which was introduced for our predecessor project PPCBoot and uses a 3636100% compatible format. 3637 3638Example: 3639 3640 make TQM850L_config 3641 make oldconfig 3642 make dep 3643 make uImage 3644 3645The "uImage" build target uses a special tool (in 'tools/mkimage') to 3646encapsulate a compressed Linux kernel image with header information, 3647CRC32 checksum etc. for use with U-Boot. This is what we are doing: 3648 3649* build a standard "vmlinux" kernel image (in ELF binary format): 3650 3651* convert the kernel into a raw binary image: 3652 3653 ${CROSS_COMPILE}-objcopy -O binary \ 3654 -R .note -R .comment \ 3655 -S vmlinux linux.bin 3656 3657* compress the binary image: 3658 3659 gzip -9 linux.bin 3660 3661* package compressed binary image for U-Boot: 3662 3663 mkimage -A ppc -O linux -T kernel -C gzip \ 3664 -a 0 -e 0 -n "Linux Kernel Image" \ 3665 -d linux.bin.gz uImage 3666 3667 3668The "mkimage" tool can also be used to create ramdisk images for use 3669with U-Boot, either separated from the Linux kernel image, or 3670combined into one file. "mkimage" encapsulates the images with a 64 3671byte header containing information about target architecture, 3672operating system, image type, compression method, entry points, time 3673stamp, CRC32 checksums, etc. 3674 3675"mkimage" can be called in two ways: to verify existing images and 3676print the header information, or to build new images. 3677 3678In the first form (with "-l" option) mkimage lists the information 3679contained in the header of an existing U-Boot image; this includes 3680checksum verification: 3681 3682 tools/mkimage -l image 3683 -l ==> list image header information 3684 3685The second form (with "-d" option) is used to build a U-Boot image 3686from a "data file" which is used as image payload: 3687 3688 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3689 -n name -d data_file image 3690 -A ==> set architecture to 'arch' 3691 -O ==> set operating system to 'os' 3692 -T ==> set image type to 'type' 3693 -C ==> set compression type 'comp' 3694 -a ==> set load address to 'addr' (hex) 3695 -e ==> set entry point to 'ep' (hex) 3696 -n ==> set image name to 'name' 3697 -d ==> use image data from 'datafile' 3698 3699Right now, all Linux kernels for PowerPC systems use the same load 3700address (0x00000000), but the entry point address depends on the 3701kernel version: 3702 3703- 2.2.x kernels have the entry point at 0x0000000C, 3704- 2.3.x and later kernels have the entry point at 0x00000000. 3705 3706So a typical call to build a U-Boot image would read: 3707 3708 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 3709 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 3710 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 3711 > examples/uImage.TQM850L 3712 Image Name: 2.4.4 kernel for TQM850L 3713 Created: Wed Jul 19 02:34:59 2000 3714 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3715 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3716 Load Address: 0x00000000 3717 Entry Point: 0x00000000 3718 3719To verify the contents of the image (or check for corruption): 3720 3721 -> tools/mkimage -l examples/uImage.TQM850L 3722 Image Name: 2.4.4 kernel for TQM850L 3723 Created: Wed Jul 19 02:34:59 2000 3724 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3725 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3726 Load Address: 0x00000000 3727 Entry Point: 0x00000000 3728 3729NOTE: for embedded systems where boot time is critical you can trade 3730speed for memory and install an UNCOMPRESSED image instead: this 3731needs more space in Flash, but boots much faster since it does not 3732need to be uncompressed: 3733 3734 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 3735 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 3736 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 3737 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 3738 > examples/uImage.TQM850L-uncompressed 3739 Image Name: 2.4.4 kernel for TQM850L 3740 Created: Wed Jul 19 02:34:59 2000 3741 Image Type: PowerPC Linux Kernel Image (uncompressed) 3742 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3743 Load Address: 0x00000000 3744 Entry Point: 0x00000000 3745 3746 3747Similar you can build U-Boot images from a 'ramdisk.image.gz' file 3748when your kernel is intended to use an initial ramdisk: 3749 3750 -> tools/mkimage -n 'Simple Ramdisk Image' \ 3751 > -A ppc -O linux -T ramdisk -C gzip \ 3752 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3753 Image Name: Simple Ramdisk Image 3754 Created: Wed Jan 12 14:01:50 2000 3755 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3756 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3757 Load Address: 0x00000000 3758 Entry Point: 0x00000000 3759 3760 3761Installing a Linux Image: 3762------------------------- 3763 3764To downloading a U-Boot image over the serial (console) interface, 3765you must convert the image to S-Record format: 3766 3767 objcopy -I binary -O srec examples/image examples/image.srec 3768 3769The 'objcopy' does not understand the information in the U-Boot 3770image header, so the resulting S-Record file will be relative to 3771address 0x00000000. To load it to a given address, you need to 3772specify the target address as 'offset' parameter with the 'loads' 3773command. 3774 3775Example: install the image to address 0x40100000 (which on the 3776TQM8xxL is in the first Flash bank): 3777 3778 => erase 40100000 401FFFFF 3779 3780 .......... done 3781 Erased 8 sectors 3782 3783 => loads 40100000 3784 ## Ready for S-Record download ... 3785 ~>examples/image.srec 3786 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3787 ... 3788 15989 15990 15991 15992 3789 [file transfer complete] 3790 [connected] 3791 ## Start Addr = 0x00000000 3792 3793 3794You can check the success of the download using the 'iminfo' command; 3795this includes a checksum verification so you can be sure no data 3796corruption happened: 3797 3798 => imi 40100000 3799 3800 ## Checking Image at 40100000 ... 3801 Image Name: 2.2.13 for initrd on TQM850L 3802 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3803 Data Size: 335725 Bytes = 327 kB = 0 MB 3804 Load Address: 00000000 3805 Entry Point: 0000000c 3806 Verifying Checksum ... OK 3807 3808 3809Boot Linux: 3810----------- 3811 3812The "bootm" command is used to boot an application that is stored in 3813memory (RAM or Flash). In case of a Linux kernel image, the contents 3814of the "bootargs" environment variable is passed to the kernel as 3815parameters. You can check and modify this variable using the 3816"printenv" and "setenv" commands: 3817 3818 3819 => printenv bootargs 3820 bootargs=root=/dev/ram 3821 3822 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3823 3824 => printenv bootargs 3825 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3826 3827 => bootm 40020000 3828 ## Booting Linux kernel at 40020000 ... 3829 Image Name: 2.2.13 for NFS on TQM850L 3830 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3831 Data Size: 381681 Bytes = 372 kB = 0 MB 3832 Load Address: 00000000 3833 Entry Point: 0000000c 3834 Verifying Checksum ... OK 3835 Uncompressing Kernel Image ... OK 3836 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 3837 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3838 time_init: decrementer frequency = 187500000/60 3839 Calibrating delay loop... 49.77 BogoMIPS 3840 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3841 ... 3842 3843If you want to boot a Linux kernel with initial RAM disk, you pass 3844the memory addresses of both the kernel and the initrd image (PPBCOOT 3845format!) to the "bootm" command: 3846 3847 => imi 40100000 40200000 3848 3849 ## Checking Image at 40100000 ... 3850 Image Name: 2.2.13 for initrd on TQM850L 3851 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3852 Data Size: 335725 Bytes = 327 kB = 0 MB 3853 Load Address: 00000000 3854 Entry Point: 0000000c 3855 Verifying Checksum ... OK 3856 3857 ## Checking Image at 40200000 ... 3858 Image Name: Simple Ramdisk Image 3859 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3860 Data Size: 566530 Bytes = 553 kB = 0 MB 3861 Load Address: 00000000 3862 Entry Point: 00000000 3863 Verifying Checksum ... OK 3864 3865 => bootm 40100000 40200000 3866 ## Booting Linux kernel at 40100000 ... 3867 Image Name: 2.2.13 for initrd on TQM850L 3868 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3869 Data Size: 335725 Bytes = 327 kB = 0 MB 3870 Load Address: 00000000 3871 Entry Point: 0000000c 3872 Verifying Checksum ... OK 3873 Uncompressing Kernel Image ... OK 3874 ## Loading RAMDisk Image at 40200000 ... 3875 Image Name: Simple Ramdisk Image 3876 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3877 Data Size: 566530 Bytes = 553 kB = 0 MB 3878 Load Address: 00000000 3879 Entry Point: 00000000 3880 Verifying Checksum ... OK 3881 Loading Ramdisk ... OK 3882 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 3883 Boot arguments: root=/dev/ram 3884 time_init: decrementer frequency = 187500000/60 3885 Calibrating delay loop... 49.77 BogoMIPS 3886 ... 3887 RAMDISK: Compressed image found at block 0 3888 VFS: Mounted root (ext2 filesystem). 3889 3890 bash# 3891 3892Boot Linux and pass a flat device tree: 3893----------- 3894 3895First, U-Boot must be compiled with the appropriate defines. See the section 3896titled "Linux Kernel Interface" above for a more in depth explanation. The 3897following is an example of how to start a kernel and pass an updated 3898flat device tree: 3899 3900=> print oftaddr 3901oftaddr=0x300000 3902=> print oft 3903oft=oftrees/mpc8540ads.dtb 3904=> tftp $oftaddr $oft 3905Speed: 1000, full duplex 3906Using TSEC0 device 3907TFTP from server 192.168.1.1; our IP address is 192.168.1.101 3908Filename 'oftrees/mpc8540ads.dtb'. 3909Load address: 0x300000 3910Loading: # 3911done 3912Bytes transferred = 4106 (100a hex) 3913=> tftp $loadaddr $bootfile 3914Speed: 1000, full duplex 3915Using TSEC0 device 3916TFTP from server 192.168.1.1; our IP address is 192.168.1.2 3917Filename 'uImage'. 3918Load address: 0x200000 3919Loading:############ 3920done 3921Bytes transferred = 1029407 (fb51f hex) 3922=> print loadaddr 3923loadaddr=200000 3924=> print oftaddr 3925oftaddr=0x300000 3926=> bootm $loadaddr - $oftaddr 3927## Booting image at 00200000 ... 3928 Image Name: Linux-2.6.17-dirty 3929 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3930 Data Size: 1029343 Bytes = 1005.2 kB 3931 Load Address: 00000000 3932 Entry Point: 00000000 3933 Verifying Checksum ... OK 3934 Uncompressing Kernel Image ... OK 3935Booting using flat device tree at 0x300000 3936Using MPC85xx ADS machine description 3937Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 3938[snip] 3939 3940 3941More About U-Boot Image Types: 3942------------------------------ 3943 3944U-Boot supports the following image types: 3945 3946 "Standalone Programs" are directly runnable in the environment 3947 provided by U-Boot; it is expected that (if they behave 3948 well) you can continue to work in U-Boot after return from 3949 the Standalone Program. 3950 "OS Kernel Images" are usually images of some Embedded OS which 3951 will take over control completely. Usually these programs 3952 will install their own set of exception handlers, device 3953 drivers, set up the MMU, etc. - this means, that you cannot 3954 expect to re-enter U-Boot except by resetting the CPU. 3955 "RAMDisk Images" are more or less just data blocks, and their 3956 parameters (address, size) are passed to an OS kernel that is 3957 being started. 3958 "Multi-File Images" contain several images, typically an OS 3959 (Linux) kernel image and one or more data images like 3960 RAMDisks. This construct is useful for instance when you want 3961 to boot over the network using BOOTP etc., where the boot 3962 server provides just a single image file, but you want to get 3963 for instance an OS kernel and a RAMDisk image. 3964 3965 "Multi-File Images" start with a list of image sizes, each 3966 image size (in bytes) specified by an "uint32_t" in network 3967 byte order. This list is terminated by an "(uint32_t)0". 3968 Immediately after the terminating 0 follow the images, one by 3969 one, all aligned on "uint32_t" boundaries (size rounded up to 3970 a multiple of 4 bytes). 3971 3972 "Firmware Images" are binary images containing firmware (like 3973 U-Boot or FPGA images) which usually will be programmed to 3974 flash memory. 3975 3976 "Script files" are command sequences that will be executed by 3977 U-Boot's command interpreter; this feature is especially 3978 useful when you configure U-Boot to use a real shell (hush) 3979 as command interpreter. 3980 3981 3982Standalone HOWTO: 3983================= 3984 3985One of the features of U-Boot is that you can dynamically load and 3986run "standalone" applications, which can use some resources of 3987U-Boot like console I/O functions or interrupt services. 3988 3989Two simple examples are included with the sources: 3990 3991"Hello World" Demo: 3992------------------- 3993 3994'examples/hello_world.c' contains a small "Hello World" Demo 3995application; it is automatically compiled when you build U-Boot. 3996It's configured to run at address 0x00040004, so you can play with it 3997like that: 3998 3999 => loads 4000 ## Ready for S-Record download ... 4001 ~>examples/hello_world.srec 4002 1 2 3 4 5 6 7 8 9 10 11 ... 4003 [file transfer complete] 4004 [connected] 4005 ## Start Addr = 0x00040004 4006 4007 => go 40004 Hello World! This is a test. 4008 ## Starting application at 0x00040004 ... 4009 Hello World 4010 argc = 7 4011 argv[0] = "40004" 4012 argv[1] = "Hello" 4013 argv[2] = "World!" 4014 argv[3] = "This" 4015 argv[4] = "is" 4016 argv[5] = "a" 4017 argv[6] = "test." 4018 argv[7] = "<NULL>" 4019 Hit any key to exit ... 4020 4021 ## Application terminated, rc = 0x0 4022 4023Another example, which demonstrates how to register a CPM interrupt 4024handler with the U-Boot code, can be found in 'examples/timer.c'. 4025Here, a CPM timer is set up to generate an interrupt every second. 4026The interrupt service routine is trivial, just printing a '.' 4027character, but this is just a demo program. The application can be 4028controlled by the following keys: 4029 4030 ? - print current values og the CPM Timer registers 4031 b - enable interrupts and start timer 4032 e - stop timer and disable interrupts 4033 q - quit application 4034 4035 => loads 4036 ## Ready for S-Record download ... 4037 ~>examples/timer.srec 4038 1 2 3 4 5 6 7 8 9 10 11 ... 4039 [file transfer complete] 4040 [connected] 4041 ## Start Addr = 0x00040004 4042 4043 => go 40004 4044 ## Starting application at 0x00040004 ... 4045 TIMERS=0xfff00980 4046 Using timer 1 4047 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4048 4049Hit 'b': 4050 [q, b, e, ?] Set interval 1000000 us 4051 Enabling timer 4052Hit '?': 4053 [q, b, e, ?] ........ 4054 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4055Hit '?': 4056 [q, b, e, ?] . 4057 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4058Hit '?': 4059 [q, b, e, ?] . 4060 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 4061Hit '?': 4062 [q, b, e, ?] . 4063 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 4064Hit 'e': 4065 [q, b, e, ?] ...Stopping timer 4066Hit 'q': 4067 [q, b, e, ?] ## Application terminated, rc = 0x0 4068 4069 4070Minicom warning: 4071================ 4072 4073Over time, many people have reported problems when trying to use the 4074"minicom" terminal emulation program for serial download. I (wd) 4075consider minicom to be broken, and recommend not to use it. Under 4076Unix, I recommend to use C-Kermit for general purpose use (and 4077especially for kermit binary protocol download ("loadb" command), and 4078use "cu" for S-Record download ("loads" command). 4079 4080Nevertheless, if you absolutely want to use it try adding this 4081configuration to your "File transfer protocols" section: 4082 4083 Name Program Name U/D FullScr IO-Red. Multi 4084 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 4085 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 4086 4087 4088NetBSD Notes: 4089============= 4090 4091Starting at version 0.9.2, U-Boot supports NetBSD both as host 4092(build U-Boot) and target system (boots NetBSD/mpc8xx). 4093 4094Building requires a cross environment; it is known to work on 4095NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 4096need gmake since the Makefiles are not compatible with BSD make). 4097Note that the cross-powerpc package does not install include files; 4098attempting to build U-Boot will fail because <machine/ansi.h> is 4099missing. This file has to be installed and patched manually: 4100 4101 # cd /usr/pkg/cross/powerpc-netbsd/include 4102 # mkdir powerpc 4103 # ln -s powerpc machine 4104 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4105 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4106 4107Native builds *don't* work due to incompatibilities between native 4108and U-Boot include files. 4109 4110Booting assumes that (the first part of) the image booted is a 4111stage-2 loader which in turn loads and then invokes the kernel 4112proper. Loader sources will eventually appear in the NetBSD source 4113tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 4114meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4115 4116 4117Implementation Internals: 4118========================= 4119 4120The following is not intended to be a complete description of every 4121implementation detail. However, it should help to understand the 4122inner workings of U-Boot and make it easier to port it to custom 4123hardware. 4124 4125 4126Initial Stack, Global Data: 4127--------------------------- 4128 4129The implementation of U-Boot is complicated by the fact that U-Boot 4130starts running out of ROM (flash memory), usually without access to 4131system RAM (because the memory controller is not initialized yet). 4132This means that we don't have writable Data or BSS segments, and BSS 4133is not initialized as zero. To be able to get a C environment working 4134at all, we have to allocate at least a minimal stack. Implementation 4135options for this are defined and restricted by the CPU used: Some CPU 4136models provide on-chip memory (like the IMMR area on MPC8xx and 4137MPC826x processors), on others (parts of) the data cache can be 4138locked as (mis-) used as memory, etc. 4139 4140 Chris Hallinan posted a good summary of these issues to the 4141 U-Boot mailing list: 4142 4143 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 4144 From: "Chris Hallinan" <clh@net1plus.com> 4145 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 4146 ... 4147 4148 Correct me if I'm wrong, folks, but the way I understand it 4149 is this: Using DCACHE as initial RAM for Stack, etc, does not 4150 require any physical RAM backing up the cache. The cleverness 4151 is that the cache is being used as a temporary supply of 4152 necessary storage before the SDRAM controller is setup. It's 4153 beyond the scope of this list to explain the details, but you 4154 can see how this works by studying the cache architecture and 4155 operation in the architecture and processor-specific manuals. 4156 4157 OCM is On Chip Memory, which I believe the 405GP has 4K. It 4158 is another option for the system designer to use as an 4159 initial stack/RAM area prior to SDRAM being available. Either 4160 option should work for you. Using CS 4 should be fine if your 4161 board designers haven't used it for something that would 4162 cause you grief during the initial boot! It is frequently not 4163 used. 4164 4165 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 4166 with your processor/board/system design. The default value 4167 you will find in any recent u-boot distribution in 4168 walnut.h should work for you. I'd set it to a value larger 4169 than your SDRAM module. If you have a 64MB SDRAM module, set 4170 it above 400_0000. Just make sure your board has no resources 4171 that are supposed to respond to that address! That code in 4172 start.S has been around a while and should work as is when 4173 you get the config right. 4174 4175 -Chris Hallinan 4176 DS4.COM, Inc. 4177 4178It is essential to remember this, since it has some impact on the C 4179code for the initialization procedures: 4180 4181* Initialized global data (data segment) is read-only. Do not attempt 4182 to write it. 4183 4184* Do not use any uninitialized global data (or implicitely initialized 4185 as zero data - BSS segment) at all - this is undefined, initiali- 4186 zation is performed later (when relocating to RAM). 4187 4188* Stack space is very limited. Avoid big data buffers or things like 4189 that. 4190 4191Having only the stack as writable memory limits means we cannot use 4192normal global data to share information beween the code. But it 4193turned out that the implementation of U-Boot can be greatly 4194simplified by making a global data structure (gd_t) available to all 4195functions. We could pass a pointer to this data as argument to _all_ 4196functions, but this would bloat the code. Instead we use a feature of 4197the GCC compiler (Global Register Variables) to share the data: we 4198place a pointer (gd) to the global data into a register which we 4199reserve for this purpose. 4200 4201When choosing a register for such a purpose we are restricted by the 4202relevant (E)ABI specifications for the current architecture, and by 4203GCC's implementation. 4204 4205For PowerPC, the following registers have specific use: 4206 R1: stack pointer 4207 R2: reserved for system use 4208 R3-R4: parameter passing and return values 4209 R5-R10: parameter passing 4210 R13: small data area pointer 4211 R30: GOT pointer 4212 R31: frame pointer 4213 4214 (U-Boot also uses R12 as internal GOT pointer. r12 4215 is a volatile register so r12 needs to be reset when 4216 going back and forth between asm and C) 4217 4218 ==> U-Boot will use R2 to hold a pointer to the global data 4219 4220 Note: on PPC, we could use a static initializer (since the 4221 address of the global data structure is known at compile time), 4222 but it turned out that reserving a register results in somewhat 4223 smaller code - although the code savings are not that big (on 4224 average for all boards 752 bytes for the whole U-Boot image, 4225 624 text + 127 data). 4226 4227On Blackfin, the normal C ABI (except for P3) is followed as documented here: 4228 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 4229 4230 ==> U-Boot will use P3 to hold a pointer to the global data 4231 4232On ARM, the following registers are used: 4233 4234 R0: function argument word/integer result 4235 R1-R3: function argument word 4236 R9: GOT pointer 4237 R10: stack limit (used only if stack checking if enabled) 4238 R11: argument (frame) pointer 4239 R12: temporary workspace 4240 R13: stack pointer 4241 R14: link register 4242 R15: program counter 4243 4244 ==> U-Boot will use R8 to hold a pointer to the global data 4245 4246On Nios II, the ABI is documented here: 4247 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 4248 4249 ==> U-Boot will use gp to hold a pointer to the global data 4250 4251 Note: on Nios II, we give "-G0" option to gcc and don't use gp 4252 to access small data sections, so gp is free. 4253 4254NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4255or current versions of GCC may "optimize" the code too much. 4256 4257Memory Management: 4258------------------ 4259 4260U-Boot runs in system state and uses physical addresses, i.e. the 4261MMU is not used either for address mapping nor for memory protection. 4262 4263The available memory is mapped to fixed addresses using the memory 4264controller. In this process, a contiguous block is formed for each 4265memory type (Flash, SDRAM, SRAM), even when it consists of several 4266physical memory banks. 4267 4268U-Boot is installed in the first 128 kB of the first Flash bank (on 4269TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4270booting and sizing and initializing DRAM, the code relocates itself 4271to the upper end of DRAM. Immediately below the U-Boot code some 4272memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4273configuration setting]. Below that, a structure with global Board 4274Info data is placed, followed by the stack (growing downward). 4275 4276Additionally, some exception handler code is copied to the low 8 kB 4277of DRAM (0x00000000 ... 0x00001FFF). 4278 4279So a typical memory configuration with 16 MB of DRAM could look like 4280this: 4281 4282 0x0000 0000 Exception Vector code 4283 : 4284 0x0000 1FFF 4285 0x0000 2000 Free for Application Use 4286 : 4287 : 4288 4289 : 4290 : 4291 0x00FB FF20 Monitor Stack (Growing downward) 4292 0x00FB FFAC Board Info Data and permanent copy of global data 4293 0x00FC 0000 Malloc Arena 4294 : 4295 0x00FD FFFF 4296 0x00FE 0000 RAM Copy of Monitor Code 4297 ... eventually: LCD or video framebuffer 4298 ... eventually: pRAM (Protected RAM - unchanged by reset) 4299 0x00FF FFFF [End of RAM] 4300 4301 4302System Initialization: 4303---------------------- 4304 4305In the reset configuration, U-Boot starts at the reset entry point 4306(on most PowerPC systems at address 0x00000100). Because of the reset 4307configuration for CS0# this is a mirror of the onboard Flash memory. 4308To be able to re-map memory U-Boot then jumps to its link address. 4309To be able to implement the initialization code in C, a (small!) 4310initial stack is set up in the internal Dual Ported RAM (in case CPUs 4311which provide such a feature like MPC8xx or MPC8260), or in a locked 4312part of the data cache. After that, U-Boot initializes the CPU core, 4313the caches and the SIU. 4314 4315Next, all (potentially) available memory banks are mapped using a 4316preliminary mapping. For example, we put them on 512 MB boundaries 4317(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4318on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4319programmed for SDRAM access. Using the temporary configuration, a 4320simple memory test is run that determines the size of the SDRAM 4321banks. 4322 4323When there is more than one SDRAM bank, and the banks are of 4324different size, the largest is mapped first. For equal size, the first 4325bank (CS2#) is mapped first. The first mapping is always for address 43260x00000000, with any additional banks following immediately to create 4327contiguous memory starting from 0. 4328 4329Then, the monitor installs itself at the upper end of the SDRAM area 4330and allocates memory for use by malloc() and for the global Board 4331Info data; also, the exception vector code is copied to the low RAM 4332pages, and the final stack is set up. 4333 4334Only after this relocation will you have a "normal" C environment; 4335until that you are restricted in several ways, mostly because you are 4336running from ROM, and because the code will have to be relocated to a 4337new address in RAM. 4338 4339 4340U-Boot Porting Guide: 4341---------------------- 4342 4343[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 4344list, October 2002] 4345 4346 4347int main(int argc, char *argv[]) 4348{ 4349 sighandler_t no_more_time; 4350 4351 signal(SIGALRM, no_more_time); 4352 alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4353 4354 if (available_money > available_manpower) { 4355 Pay consultant to port U-Boot; 4356 return 0; 4357 } 4358 4359 Download latest U-Boot source; 4360 4361 Subscribe to u-boot mailing list; 4362 4363 if (clueless) 4364 email("Hi, I am new to U-Boot, how do I get started?"); 4365 4366 while (learning) { 4367 Read the README file in the top level directory; 4368 Read http://www.denx.de/twiki/bin/view/DULG/Manual; 4369 Read applicable doc/*.README; 4370 Read the source, Luke; 4371 /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4372 } 4373 4374 if (available_money > toLocalCurrency ($2500)) 4375 Buy a BDI3000; 4376 else 4377 Add a lot of aggravation and time; 4378 4379 if (a similar board exists) { /* hopefully... */ 4380 cp -a board/<similar> board/<myboard> 4381 cp include/configs/<similar>.h include/configs/<myboard>.h 4382 } else { 4383 Create your own board support subdirectory; 4384 Create your own board include/configs/<myboard>.h file; 4385 } 4386 Edit new board/<myboard> files 4387 Edit new include/configs/<myboard>.h 4388 4389 while (!accepted) { 4390 while (!running) { 4391 do { 4392 Add / modify source code; 4393 } until (compiles); 4394 Debug; 4395 if (clueless) 4396 email("Hi, I am having problems..."); 4397 } 4398 Send patch file to the U-Boot email list; 4399 if (reasonable critiques) 4400 Incorporate improvements from email list code review; 4401 else 4402 Defend code as written; 4403 } 4404 4405 return 0; 4406} 4407 4408void no_more_time (int sig) 4409{ 4410 hire_a_guru(); 4411} 4412 4413 4414Coding Standards: 4415----------------- 4416 4417All contributions to U-Boot should conform to the Linux kernel 4418coding style; see the file "Documentation/CodingStyle" and the script 4419"scripts/Lindent" in your Linux kernel source directory. In sources 4420originating from U-Boot a style corresponding to "Lindent -pcs" (adding 4421spaces before parameters to function calls) is actually used. 4422 4423Source files originating from a different project (for example the 4424MTD subsystem) are generally exempt from these guidelines and are not 4425reformated to ease subsequent migration to newer versions of those 4426sources. 4427 4428Please note that U-Boot is implemented in C (and to some small parts in 4429Assembler); no C++ is used, so please do not use C++ style comments (//) 4430in your code. 4431 4432Please also stick to the following formatting rules: 4433- remove any trailing white space 4434- use TAB characters for indentation, not spaces 4435- make sure NOT to use DOS '\r\n' line feeds 4436- do not add more than 2 empty lines to source files 4437- do not add trailing empty lines to source files 4438 4439Submissions which do not conform to the standards may be returned 4440with a request to reformat the changes. 4441 4442 4443Submitting Patches: 4444------------------- 4445 4446Since the number of patches for U-Boot is growing, we need to 4447establish some rules. Submissions which do not conform to these rules 4448may be rejected, even when they contain important and valuable stuff. 4449 4450Please see http://www.denx.de/wiki/U-Boot/Patches for details. 4451 4452Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 4453see http://lists.denx.de/mailman/listinfo/u-boot 4454 4455When you send a patch, please include the following information with 4456it: 4457 4458* For bug fixes: a description of the bug and how your patch fixes 4459 this bug. Please try to include a way of demonstrating that the 4460 patch actually fixes something. 4461 4462* For new features: a description of the feature and your 4463 implementation. 4464 4465* A CHANGELOG entry as plaintext (separate from the patch) 4466 4467* For major contributions, your entry to the CREDITS file 4468 4469* When you add support for a new board, don't forget to add this 4470 board to the MAKEALL script, too. 4471 4472* If your patch adds new configuration options, don't forget to 4473 document these in the README file. 4474 4475* The patch itself. If you are using git (which is *strongly* 4476 recommended) you can easily generate the patch using the 4477 "git-format-patch". If you then use "git-send-email" to send it to 4478 the U-Boot mailing list, you will avoid most of the common problems 4479 with some other mail clients. 4480 4481 If you cannot use git, use "diff -purN OLD NEW". If your version of 4482 diff does not support these options, then get the latest version of 4483 GNU diff. 4484 4485 The current directory when running this command shall be the parent 4486 directory of the U-Boot source tree (i. e. please make sure that 4487 your patch includes sufficient directory information for the 4488 affected files). 4489 4490 We prefer patches as plain text. MIME attachments are discouraged, 4491 and compressed attachments must not be used. 4492 4493* If one logical set of modifications affects or creates several 4494 files, all these changes shall be submitted in a SINGLE patch file. 4495 4496* Changesets that contain different, unrelated modifications shall be 4497 submitted as SEPARATE patches, one patch per changeset. 4498 4499 4500Notes: 4501 4502* Before sending the patch, run the MAKEALL script on your patched 4503 source tree and make sure that no errors or warnings are reported 4504 for any of the boards. 4505 4506* Keep your modifications to the necessary minimum: A patch 4507 containing several unrelated changes or arbitrary reformats will be 4508 returned with a request to re-formatting / split it. 4509 4510* If you modify existing code, make sure that your new code does not 4511 add to the memory footprint of the code ;-) Small is beautiful! 4512 When adding new features, these should compile conditionally only 4513 (using #ifdef), and the resulting code with the new feature 4514 disabled must not need more memory than the old code without your 4515 modification. 4516 4517* Remember that there is a size limit of 100 kB per message on the 4518 u-boot mailing list. Bigger patches will be moderated. If they are 4519 reasonable and not too big, they will be acknowledged. But patches 4520 bigger than the size limit should be avoided. 4521