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