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_HWFLOW * RTS/CTS hw flow control 650 CONFIG_CMD_I2C * I2C serial bus support 651 CONFIG_CMD_IDE * IDE harddisk support 652 CONFIG_CMD_IMI iminfo 653 CONFIG_CMD_IMLS List all found images 654 CONFIG_CMD_IMMAP * IMMR dump support 655 CONFIG_CMD_IMPORTENV * import an environment 656 CONFIG_CMD_IRQ * irqinfo 657 CONFIG_CMD_ITEST Integer/string test of 2 values 658 CONFIG_CMD_JFFS2 * JFFS2 Support 659 CONFIG_CMD_KGDB * kgdb 660 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 661 CONFIG_CMD_LOADB loadb 662 CONFIG_CMD_LOADS loads 663 CONFIG_CMD_MD5SUM print md5 message digest 664 (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 665 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 666 loop, loopw, mtest 667 CONFIG_CMD_MISC Misc functions like sleep etc 668 CONFIG_CMD_MMC * MMC memory mapped support 669 CONFIG_CMD_MII * MII utility commands 670 CONFIG_CMD_MTDPARTS * MTD partition support 671 CONFIG_CMD_NAND * NAND support 672 CONFIG_CMD_NET bootp, tftpboot, rarpboot 673 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 674 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 675 CONFIG_CMD_PCI * pciinfo 676 CONFIG_CMD_PCMCIA * PCMCIA support 677 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 678 host 679 CONFIG_CMD_PORTIO * Port I/O 680 CONFIG_CMD_REGINFO * Register dump 681 CONFIG_CMD_RUN run command in env variable 682 CONFIG_CMD_SAVES * save S record dump 683 CONFIG_CMD_SCSI * SCSI Support 684 CONFIG_CMD_SDRAM * print SDRAM configuration information 685 (requires CONFIG_CMD_I2C) 686 CONFIG_CMD_SETGETDCR Support for DCR Register access 687 (4xx only) 688 CONFIG_CMD_SHA1SUM print sha1 memory digest 689 (requires CONFIG_CMD_MEMORY) 690 CONFIG_CMD_SOURCE "source" command Support 691 CONFIG_CMD_SPI * SPI serial bus support 692 CONFIG_CMD_USB * USB support 693 CONFIG_CMD_VFD * VFD support (TRAB) 694 CONFIG_CMD_CDP * Cisco Discover Protocol support 695 CONFIG_CMD_FSL * Microblaze FSL support 696 697 698 EXAMPLE: If you want all functions except of network 699 support you can write: 700 701 #include "config_cmd_all.h" 702 #undef CONFIG_CMD_NET 703 704 Other Commands: 705 fdt (flattened device tree) command: CONFIG_OF_LIBFDT 706 707 Note: Don't enable the "icache" and "dcache" commands 708 (configuration option CONFIG_CMD_CACHE) unless you know 709 what you (and your U-Boot users) are doing. Data 710 cache cannot be enabled on systems like the 8xx or 711 8260 (where accesses to the IMMR region must be 712 uncached), and it cannot be disabled on all other 713 systems where we (mis-) use the data cache to hold an 714 initial stack and some data. 715 716 717 XXX - this list needs to get updated! 718 719- Watchdog: 720 CONFIG_WATCHDOG 721 If this variable is defined, it enables watchdog 722 support. There must be support in the platform specific 723 code for a watchdog. For the 8xx and 8260 CPUs, the 724 SIU Watchdog feature is enabled in the SYPCR 725 register. 726 727- U-Boot Version: 728 CONFIG_VERSION_VARIABLE 729 If this variable is defined, an environment variable 730 named "ver" is created by U-Boot showing the U-Boot 731 version as printed by the "version" command. 732 This variable is readonly. 733 734- Real-Time Clock: 735 736 When CONFIG_CMD_DATE is selected, the type of the RTC 737 has to be selected, too. Define exactly one of the 738 following options: 739 740 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 741 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 742 CONFIG_RTC_MC13783 - use MC13783 RTC 743 CONFIG_RTC_MC146818 - use MC146818 RTC 744 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 745 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 746 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 747 CONFIG_RTC_DS164x - use Dallas DS164x RTC 748 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 749 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 750 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 751 752 Note that if the RTC uses I2C, then the I2C interface 753 must also be configured. See I2C Support, below. 754 755- GPIO Support: 756 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 757 CONFIG_PCA953X_INFO - enable pca953x info command 758 759 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 760 chip-ngpio pairs that tell the PCA953X driver the number of 761 pins supported by a particular chip. 762 763 Note that if the GPIO device uses I2C, then the I2C interface 764 must also be configured. See I2C Support, below. 765 766- Timestamp Support: 767 768 When CONFIG_TIMESTAMP is selected, the timestamp 769 (date and time) of an image is printed by image 770 commands like bootm or iminfo. This option is 771 automatically enabled when you select CONFIG_CMD_DATE . 772 773- Partition Support: 774 CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION 775 and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION 776 777 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 778 CONFIG_CMD_SCSI) you must configure support for at 779 least one partition type as well. 780 781- IDE Reset method: 782 CONFIG_IDE_RESET_ROUTINE - this is defined in several 783 board configurations files but used nowhere! 784 785 CONFIG_IDE_RESET - is this is defined, IDE Reset will 786 be performed by calling the function 787 ide_set_reset(int reset) 788 which has to be defined in a board specific file 789 790- ATAPI Support: 791 CONFIG_ATAPI 792 793 Set this to enable ATAPI support. 794 795- LBA48 Support 796 CONFIG_LBA48 797 798 Set this to enable support for disks larger than 137GB 799 Also look at CONFIG_SYS_64BIT_LBA. 800 Whithout these , LBA48 support uses 32bit variables and will 'only' 801 support disks up to 2.1TB. 802 803 CONFIG_SYS_64BIT_LBA: 804 When enabled, makes the IDE subsystem use 64bit sector addresses. 805 Default is 32bit. 806 807- SCSI Support: 808 At the moment only there is only support for the 809 SYM53C8XX SCSI controller; define 810 CONFIG_SCSI_SYM53C8XX to enable it. 811 812 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 813 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 814 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 815 maximum numbers of LUNs, SCSI ID's and target 816 devices. 817 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 818 819- NETWORK Support (PCI): 820 CONFIG_E1000 821 Support for Intel 8254x gigabit chips. 822 823 CONFIG_E1000_FALLBACK_MAC 824 default MAC for empty EEPROM after production. 825 826 CONFIG_EEPRO100 827 Support for Intel 82557/82559/82559ER chips. 828 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 829 write routine for first time initialisation. 830 831 CONFIG_TULIP 832 Support for Digital 2114x chips. 833 Optional CONFIG_TULIP_SELECT_MEDIA for board specific 834 modem chip initialisation (KS8761/QS6611). 835 836 CONFIG_NATSEMI 837 Support for National dp83815 chips. 838 839 CONFIG_NS8382X 840 Support for National dp8382[01] gigabit chips. 841 842- NETWORK Support (other): 843 844 CONFIG_DRIVER_AT91EMAC 845 Support for AT91RM9200 EMAC. 846 847 CONFIG_RMII 848 Define this to use reduced MII inteface 849 850 CONFIG_DRIVER_AT91EMAC_QUIET 851 If this defined, the driver is quiet. 852 The driver doen't show link status messages. 853 854 CONFIG_DRIVER_LAN91C96 855 Support for SMSC's LAN91C96 chips. 856 857 CONFIG_LAN91C96_BASE 858 Define this to hold the physical address 859 of the LAN91C96's I/O space 860 861 CONFIG_LAN91C96_USE_32_BIT 862 Define this to enable 32 bit addressing 863 864 CONFIG_DRIVER_SMC91111 865 Support for SMSC's LAN91C111 chip 866 867 CONFIG_SMC91111_BASE 868 Define this to hold the physical address 869 of the device (I/O space) 870 871 CONFIG_SMC_USE_32_BIT 872 Define this if data bus is 32 bits 873 874 CONFIG_SMC_USE_IOFUNCS 875 Define this to use i/o functions instead of macros 876 (some hardware wont work with macros) 877 878 CONFIG_FTGMAC100 879 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 880 881 CONFIG_FTGMAC100_EGIGA 882 Define this to use GE link update with gigabit PHY. 883 Define this if FTGMAC100 is connected to gigabit PHY. 884 If your system has 10/100 PHY only, it might not occur 885 wrong behavior. Because PHY usually return timeout or 886 useless data when polling gigabit status and gigabit 887 control registers. This behavior won't affect the 888 correctnessof 10/100 link speed update. 889 890 CONFIG_SMC911X 891 Support for SMSC's LAN911x and LAN921x chips 892 893 CONFIG_SMC911X_BASE 894 Define this to hold the physical address 895 of the device (I/O space) 896 897 CONFIG_SMC911X_32_BIT 898 Define this if data bus is 32 bits 899 900 CONFIG_SMC911X_16_BIT 901 Define this if data bus is 16 bits. If your processor 902 automatically converts one 32 bit word to two 16 bit 903 words you may also try CONFIG_SMC911X_32_BIT. 904 905 CONFIG_SH_ETHER 906 Support for Renesas on-chip Ethernet controller 907 908 CONFIG_SH_ETHER_USE_PORT 909 Define the number of ports to be used 910 911 CONFIG_SH_ETHER_PHY_ADDR 912 Define the ETH PHY's address 913 914 CONFIG_SH_ETHER_CACHE_WRITEBACK 915 If this option is set, the driver enables cache flush. 916 917- USB Support: 918 At the moment only the UHCI host controller is 919 supported (PIP405, MIP405, MPC5200); define 920 CONFIG_USB_UHCI to enable it. 921 define CONFIG_USB_KEYBOARD to enable the USB Keyboard 922 and define CONFIG_USB_STORAGE to enable the USB 923 storage devices. 924 Note: 925 Supported are USB Keyboards and USB Floppy drives 926 (TEAC FD-05PUB). 927 MPC5200 USB requires additional defines: 928 CONFIG_USB_CLOCK 929 for 528 MHz Clock: 0x0001bbbb 930 CONFIG_PSC3_USB 931 for USB on PSC3 932 CONFIG_USB_CONFIG 933 for differential drivers: 0x00001000 934 for single ended drivers: 0x00005000 935 for differential drivers on PSC3: 0x00000100 936 for single ended drivers on PSC3: 0x00004100 937 CONFIG_SYS_USB_EVENT_POLL 938 May be defined to allow interrupt polling 939 instead of using asynchronous interrupts 940 941- USB Device: 942 Define the below if you wish to use the USB console. 943 Once firmware is rebuilt from a serial console issue the 944 command "setenv stdin usbtty; setenv stdout usbtty" and 945 attach your USB cable. The Unix command "dmesg" should print 946 it has found a new device. The environment variable usbtty 947 can be set to gserial or cdc_acm to enable your device to 948 appear to a USB host as a Linux gserial device or a 949 Common Device Class Abstract Control Model serial device. 950 If you select usbtty = gserial you should be able to enumerate 951 a Linux host by 952 # modprobe usbserial vendor=0xVendorID product=0xProductID 953 else if using cdc_acm, simply setting the environment 954 variable usbtty to be cdc_acm should suffice. The following 955 might be defined in YourBoardName.h 956 957 CONFIG_USB_DEVICE 958 Define this to build a UDC device 959 960 CONFIG_USB_TTY 961 Define this to have a tty type of device available to 962 talk to the UDC device 963 964 CONFIG_SYS_CONSOLE_IS_IN_ENV 965 Define this if you want stdin, stdout &/or stderr to 966 be set to usbtty. 967 968 mpc8xx: 969 CONFIG_SYS_USB_EXTC_CLK 0xBLAH 970 Derive USB clock from external clock "blah" 971 - CONFIG_SYS_USB_EXTC_CLK 0x02 972 973 CONFIG_SYS_USB_BRG_CLK 0xBLAH 974 Derive USB clock from brgclk 975 - CONFIG_SYS_USB_BRG_CLK 0x04 976 977 If you have a USB-IF assigned VendorID then you may wish to 978 define your own vendor specific values either in BoardName.h 979 or directly in usbd_vendor_info.h. If you don't define 980 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 981 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 982 should pretend to be a Linux device to it's target host. 983 984 CONFIG_USBD_MANUFACTURER 985 Define this string as the name of your company for 986 - CONFIG_USBD_MANUFACTURER "my company" 987 988 CONFIG_USBD_PRODUCT_NAME 989 Define this string as the name of your product 990 - CONFIG_USBD_PRODUCT_NAME "acme usb device" 991 992 CONFIG_USBD_VENDORID 993 Define this as your assigned Vendor ID from the USB 994 Implementors Forum. This *must* be a genuine Vendor ID 995 to avoid polluting the USB namespace. 996 - CONFIG_USBD_VENDORID 0xFFFF 997 998 CONFIG_USBD_PRODUCTID 999 Define this as the unique Product ID 1000 for your device 1001 - CONFIG_USBD_PRODUCTID 0xFFFF 1002 1003 1004- MMC Support: 1005 The MMC controller on the Intel PXA is supported. To 1006 enable this define CONFIG_MMC. The MMC can be 1007 accessed from the boot prompt by mapping the device 1008 to physical memory similar to flash. Command line is 1009 enabled with CONFIG_CMD_MMC. The MMC driver also works with 1010 the FAT fs. This is enabled with CONFIG_CMD_FAT. 1011 1012- Journaling Flash filesystem support: 1013 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 1014 CONFIG_JFFS2_NAND_DEV 1015 Define these for a default partition on a NAND device 1016 1017 CONFIG_SYS_JFFS2_FIRST_SECTOR, 1018 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 1019 Define these for a default partition on a NOR device 1020 1021 CONFIG_SYS_JFFS_CUSTOM_PART 1022 Define this to create an own partition. You have to provide a 1023 function struct part_info* jffs2_part_info(int part_num) 1024 1025 If you define only one JFFS2 partition you may also want to 1026 #define CONFIG_SYS_JFFS_SINGLE_PART 1 1027 to disable the command chpart. This is the default when you 1028 have not defined a custom partition 1029 1030- Keyboard Support: 1031 CONFIG_ISA_KEYBOARD 1032 1033 Define this to enable standard (PC-Style) keyboard 1034 support 1035 1036 CONFIG_I8042_KBD 1037 Standard PC keyboard driver with US (is default) and 1038 GERMAN key layout (switch via environment 'keymap=de') support. 1039 Export function i8042_kbd_init, i8042_tstc and i8042_getc 1040 for cfb_console. Supports cursor blinking. 1041 1042- Video support: 1043 CONFIG_VIDEO 1044 1045 Define this to enable video support (for output to 1046 video). 1047 1048 CONFIG_VIDEO_CT69000 1049 1050 Enable Chips & Technologies 69000 Video chip 1051 1052 CONFIG_VIDEO_SMI_LYNXEM 1053 Enable Silicon Motion SMI 712/710/810 Video chip. The 1054 video output is selected via environment 'videoout' 1055 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1056 assumed. 1057 1058 For the CT69000 and SMI_LYNXEM drivers, videomode is 1059 selected via environment 'videomode'. Two different ways 1060 are possible: 1061 - "videomode=num" 'num' is a standard LiLo mode numbers. 1062 Following standard modes are supported (* is default): 1063 1064 Colors 640x480 800x600 1024x768 1152x864 1280x1024 1065 -------------+--------------------------------------------- 1066 8 bits | 0x301* 0x303 0x305 0x161 0x307 1067 15 bits | 0x310 0x313 0x316 0x162 0x319 1068 16 bits | 0x311 0x314 0x317 0x163 0x31A 1069 24 bits | 0x312 0x315 0x318 ? 0x31B 1070 -------------+--------------------------------------------- 1071 (i.e. setenv videomode 317; saveenv; reset;) 1072 1073 - "videomode=bootargs" all the video parameters are parsed 1074 from the bootargs. (See drivers/video/videomodes.c) 1075 1076 1077 CONFIG_VIDEO_SED13806 1078 Enable Epson SED13806 driver. This driver supports 8bpp 1079 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1080 or CONFIG_VIDEO_SED13806_16BPP 1081 1082 CONFIG_FSL_DIU_FB 1083 Enable the Freescale DIU video driver. Reference boards for 1084 SOCs that have a DIU should define this macro to enable DIU 1085 support, and should also define these other macros: 1086 1087 CONFIG_SYS_DIU_ADDR 1088 CONFIG_VIDEO 1089 CONFIG_CMD_BMP 1090 CONFIG_CFB_CONSOLE 1091 CONFIG_VIDEO_SW_CURSOR 1092 CONFIG_VGA_AS_SINGLE_DEVICE 1093 CONFIG_VIDEO_LOGO 1094 CONFIG_VIDEO_BMP_LOGO 1095 1096 The DIU driver will look for the 'monitor' environment variable, 1097 and if defined, enable the DIU as a console during boot. This 1098 variable should be set to one of these values: 1099 1100 '0' Output video to the DVI connector 1101 '1' Output video to the LVDS connector 1102 '2' Output video to the Dual-Link LVDS connector 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 2012Legacy uImage format: 2013 2014 Arg Where When 2015 1 common/cmd_bootm.c before attempting to boot an image 2016 -1 common/cmd_bootm.c Image header has bad magic number 2017 2 common/cmd_bootm.c Image header has correct magic number 2018 -2 common/cmd_bootm.c Image header has bad checksum 2019 3 common/cmd_bootm.c Image header has correct checksum 2020 -3 common/cmd_bootm.c Image data has bad checksum 2021 4 common/cmd_bootm.c Image data has correct checksum 2022 -4 common/cmd_bootm.c Image is for unsupported architecture 2023 5 common/cmd_bootm.c Architecture check OK 2024 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2025 6 common/cmd_bootm.c Image Type check OK 2026 -6 common/cmd_bootm.c gunzip uncompression error 2027 -7 common/cmd_bootm.c Unimplemented compression type 2028 7 common/cmd_bootm.c Uncompression OK 2029 8 common/cmd_bootm.c No uncompress/copy overwrite error 2030 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 2031 2032 9 common/image.c Start initial ramdisk verification 2033 -10 common/image.c Ramdisk header has bad magic number 2034 -11 common/image.c Ramdisk header has bad checksum 2035 10 common/image.c Ramdisk header is OK 2036 -12 common/image.c Ramdisk data has bad checksum 2037 11 common/image.c Ramdisk data has correct checksum 2038 12 common/image.c Ramdisk verification complete, start loading 2039 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 2040 13 common/image.c Start multifile image verification 2041 14 common/image.c No initial ramdisk, no multifile, continue. 2042 2043 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2044 2045 -30 arch/powerpc/lib/board.c Fatal error, hang the system 2046 -31 post/post.c POST test failed, detected by post_output_backlog() 2047 -32 post/post.c POST test failed, detected by post_run_single() 2048 2049 34 common/cmd_doc.c before loading a Image from a DOC device 2050 -35 common/cmd_doc.c Bad usage of "doc" command 2051 35 common/cmd_doc.c correct usage of "doc" command 2052 -36 common/cmd_doc.c No boot device 2053 36 common/cmd_doc.c correct boot device 2054 -37 common/cmd_doc.c Unknown Chip ID on boot device 2055 37 common/cmd_doc.c correct chip ID found, device available 2056 -38 common/cmd_doc.c Read Error on boot device 2057 38 common/cmd_doc.c reading Image header from DOC device OK 2058 -39 common/cmd_doc.c Image header has bad magic number 2059 39 common/cmd_doc.c Image header has correct magic number 2060 -40 common/cmd_doc.c Error reading Image from DOC device 2061 40 common/cmd_doc.c Image header has correct magic number 2062 41 common/cmd_ide.c before loading a Image from a IDE device 2063 -42 common/cmd_ide.c Bad usage of "ide" command 2064 42 common/cmd_ide.c correct usage of "ide" command 2065 -43 common/cmd_ide.c No boot device 2066 43 common/cmd_ide.c boot device found 2067 -44 common/cmd_ide.c Device not available 2068 44 common/cmd_ide.c Device available 2069 -45 common/cmd_ide.c wrong partition selected 2070 45 common/cmd_ide.c partition selected 2071 -46 common/cmd_ide.c Unknown partition table 2072 46 common/cmd_ide.c valid partition table found 2073 -47 common/cmd_ide.c Invalid partition type 2074 47 common/cmd_ide.c correct partition type 2075 -48 common/cmd_ide.c Error reading Image Header on boot device 2076 48 common/cmd_ide.c reading Image Header from IDE device OK 2077 -49 common/cmd_ide.c Image header has bad magic number 2078 49 common/cmd_ide.c Image header has correct magic number 2079 -50 common/cmd_ide.c Image header has bad checksum 2080 50 common/cmd_ide.c Image header has correct checksum 2081 -51 common/cmd_ide.c Error reading Image from IDE device 2082 51 common/cmd_ide.c reading Image from IDE device OK 2083 52 common/cmd_nand.c before loading a Image from a NAND device 2084 -53 common/cmd_nand.c Bad usage of "nand" command 2085 53 common/cmd_nand.c correct usage of "nand" command 2086 -54 common/cmd_nand.c No boot device 2087 54 common/cmd_nand.c boot device found 2088 -55 common/cmd_nand.c Unknown Chip ID on boot device 2089 55 common/cmd_nand.c correct chip ID found, device available 2090 -56 common/cmd_nand.c Error reading Image Header on boot device 2091 56 common/cmd_nand.c reading Image Header from NAND device OK 2092 -57 common/cmd_nand.c Image header has bad magic number 2093 57 common/cmd_nand.c Image header has correct magic number 2094 -58 common/cmd_nand.c Error reading Image from NAND device 2095 58 common/cmd_nand.c reading Image from NAND device OK 2096 2097 -60 common/env_common.c Environment has a bad CRC, using default 2098 2099 64 net/eth.c starting with Ethernet configuration. 2100 -64 net/eth.c no Ethernet found. 2101 65 net/eth.c Ethernet found. 2102 2103 -80 common/cmd_net.c usage wrong 2104 80 common/cmd_net.c before calling NetLoop() 2105 -81 common/cmd_net.c some error in NetLoop() occurred 2106 81 common/cmd_net.c NetLoop() back without error 2107 -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2108 82 common/cmd_net.c trying automatic boot 2109 83 common/cmd_net.c running "source" command 2110 -83 common/cmd_net.c some error in automatic boot or "source" command 2111 84 common/cmd_net.c end without errors 2112 2113FIT uImage format: 2114 2115 Arg Where When 2116 100 common/cmd_bootm.c Kernel FIT Image has correct format 2117 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 2118 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 2119 -101 common/cmd_bootm.c Can't get configuration for kernel subimage 2120 102 common/cmd_bootm.c Kernel unit name specified 2121 -103 common/cmd_bootm.c Can't get kernel subimage node offset 2122 103 common/cmd_bootm.c Found configuration node 2123 104 common/cmd_bootm.c Got kernel subimage node offset 2124 -104 common/cmd_bootm.c Kernel subimage hash verification failed 2125 105 common/cmd_bootm.c Kernel subimage hash verification OK 2126 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 2127 106 common/cmd_bootm.c Architecture check OK 2128 -106 common/cmd_bootm.c Kernel subimage has wrong type 2129 107 common/cmd_bootm.c Kernel subimage type OK 2130 -107 common/cmd_bootm.c Can't get kernel subimage data/size 2131 108 common/cmd_bootm.c Got kernel subimage data/size 2132 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 2133 -109 common/cmd_bootm.c Can't get kernel subimage type 2134 -110 common/cmd_bootm.c Can't get kernel subimage comp 2135 -111 common/cmd_bootm.c Can't get kernel subimage os 2136 -112 common/cmd_bootm.c Can't get kernel subimage load address 2137 -113 common/cmd_bootm.c Image uncompress/copy overwrite error 2138 2139 120 common/image.c Start initial ramdisk verification 2140 -120 common/image.c Ramdisk FIT image has incorrect format 2141 121 common/image.c Ramdisk FIT image has correct format 2142 122 common/image.c No ramdisk subimage unit name, using configuration 2143 -122 common/image.c Can't get configuration for ramdisk subimage 2144 123 common/image.c Ramdisk unit name specified 2145 -124 common/image.c Can't get ramdisk subimage node offset 2146 125 common/image.c Got ramdisk subimage node offset 2147 -125 common/image.c Ramdisk subimage hash verification failed 2148 126 common/image.c Ramdisk subimage hash verification OK 2149 -126 common/image.c Ramdisk subimage for unsupported architecture 2150 127 common/image.c Architecture check OK 2151 -127 common/image.c Can't get ramdisk subimage data/size 2152 128 common/image.c Got ramdisk subimage data/size 2153 129 common/image.c Can't get ramdisk load address 2154 -129 common/image.c Got ramdisk load address 2155 2156 -130 common/cmd_doc.c Incorrect FIT image format 2157 131 common/cmd_doc.c FIT image format OK 2158 2159 -140 common/cmd_ide.c Incorrect FIT image format 2160 141 common/cmd_ide.c FIT image format OK 2161 2162 -150 common/cmd_nand.c Incorrect FIT image format 2163 151 common/cmd_nand.c FIT image format OK 2164 2165- Automatic software updates via TFTP server 2166 CONFIG_UPDATE_TFTP 2167 CONFIG_UPDATE_TFTP_CNT_MAX 2168 CONFIG_UPDATE_TFTP_MSEC_MAX 2169 2170 These options enable and control the auto-update feature; 2171 for a more detailed description refer to doc/README.update. 2172 2173- MTD Support (mtdparts command, UBI support) 2174 CONFIG_MTD_DEVICE 2175 2176 Adds the MTD device infrastructure from the Linux kernel. 2177 Needed for mtdparts command support. 2178 2179 CONFIG_MTD_PARTITIONS 2180 2181 Adds the MTD partitioning infrastructure from the Linux 2182 kernel. Needed for UBI support. 2183 2184 2185Modem Support: 2186-------------- 2187 2188[so far only for SMDK2400 and TRAB boards] 2189 2190- Modem support enable: 2191 CONFIG_MODEM_SUPPORT 2192 2193- RTS/CTS Flow control enable: 2194 CONFIG_HWFLOW 2195 2196- Modem debug support: 2197 CONFIG_MODEM_SUPPORT_DEBUG 2198 2199 Enables debugging stuff (char screen[1024], dbg()) 2200 for modem support. Useful only with BDI2000. 2201 2202- Interrupt support (PPC): 2203 2204 There are common interrupt_init() and timer_interrupt() 2205 for all PPC archs. interrupt_init() calls interrupt_init_cpu() 2206 for CPU specific initialization. interrupt_init_cpu() 2207 should set decrementer_count to appropriate value. If 2208 CPU resets decrementer automatically after interrupt 2209 (ppc4xx) it should set decrementer_count to zero. 2210 timer_interrupt() calls timer_interrupt_cpu() for CPU 2211 specific handling. If board has watchdog / status_led 2212 / other_activity_monitor it works automatically from 2213 general timer_interrupt(). 2214 2215- General: 2216 2217 In the target system modem support is enabled when a 2218 specific key (key combination) is pressed during 2219 power-on. Otherwise U-Boot will boot normally 2220 (autoboot). The key_pressed() function is called from 2221 board_init(). Currently key_pressed() is a dummy 2222 function, returning 1 and thus enabling modem 2223 initialization. 2224 2225 If there are no modem init strings in the 2226 environment, U-Boot proceed to autoboot; the 2227 previous output (banner, info printfs) will be 2228 suppressed, though. 2229 2230 See also: doc/README.Modem 2231 2232 2233Configuration Settings: 2234----------------------- 2235 2236- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2237 undefine this when you're short of memory. 2238 2239- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 2240 width of the commands listed in the 'help' command output. 2241 2242- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2243 prompt for user input. 2244 2245- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2246 2247- CONFIG_SYS_PBSIZE: Buffer size for Console output 2248 2249- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2250 2251- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2252 the application (usually a Linux kernel) when it is 2253 booted 2254 2255- CONFIG_SYS_BAUDRATE_TABLE: 2256 List of legal baudrate settings for this board. 2257 2258- CONFIG_SYS_CONSOLE_INFO_QUIET 2259 Suppress display of console information at boot. 2260 2261- CONFIG_SYS_CONSOLE_IS_IN_ENV 2262 If the board specific function 2263 extern int overwrite_console (void); 2264 returns 1, the stdin, stderr and stdout are switched to the 2265 serial port, else the settings in the environment are used. 2266 2267- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 2268 Enable the call to overwrite_console(). 2269 2270- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 2271 Enable overwrite of previous console environment settings. 2272 2273- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 2274 Begin and End addresses of the area used by the 2275 simple memory test. 2276 2277- CONFIG_SYS_ALT_MEMTEST: 2278 Enable an alternate, more extensive memory test. 2279 2280- CONFIG_SYS_MEMTEST_SCRATCH: 2281 Scratch address used by the alternate memory test 2282 You only need to set this if address zero isn't writeable 2283 2284- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 2285 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 2286 this specified memory area will get subtracted from the top 2287 (end) of RAM and won't get "touched" at all by U-Boot. By 2288 fixing up gd->ram_size the Linux kernel should gets passed 2289 the now "corrected" memory size and won't touch it either. 2290 This should work for arch/ppc and arch/powerpc. Only Linux 2291 board ports in arch/powerpc with bootwrapper support that 2292 recalculate the memory size from the SDRAM controller setup 2293 will have to get fixed in Linux additionally. 2294 2295 This option can be used as a workaround for the 440EPx/GRx 2296 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 2297 be touched. 2298 2299 WARNING: Please make sure that this value is a multiple of 2300 the Linux page size (normally 4k). If this is not the case, 2301 then the end address of the Linux memory will be located at a 2302 non page size aligned address and this could cause major 2303 problems. 2304 2305- CONFIG_SYS_TFTP_LOADADDR: 2306 Default load address for network file downloads 2307 2308- CONFIG_SYS_LOADS_BAUD_CHANGE: 2309 Enable temporary baudrate change while serial download 2310 2311- CONFIG_SYS_SDRAM_BASE: 2312 Physical start address of SDRAM. _Must_ be 0 here. 2313 2314- CONFIG_SYS_MBIO_BASE: 2315 Physical start address of Motherboard I/O (if using a 2316 Cogent motherboard) 2317 2318- CONFIG_SYS_FLASH_BASE: 2319 Physical start address of Flash memory. 2320 2321- CONFIG_SYS_MONITOR_BASE: 2322 Physical start address of boot monitor code (set by 2323 make config files to be same as the text base address 2324 (CONFIG_SYS_TEXT_BASE) used when linking) - same as 2325 CONFIG_SYS_FLASH_BASE when booting from flash. 2326 2327- CONFIG_SYS_MONITOR_LEN: 2328 Size of memory reserved for monitor code, used to 2329 determine _at_compile_time_ (!) if the environment is 2330 embedded within the U-Boot image, or in a separate 2331 flash sector. 2332 2333- CONFIG_SYS_MALLOC_LEN: 2334 Size of DRAM reserved for malloc() use. 2335 2336- CONFIG_SYS_BOOTM_LEN: 2337 Normally compressed uImages are limited to an 2338 uncompressed size of 8 MBytes. If this is not enough, 2339 you can define CONFIG_SYS_BOOTM_LEN in your board config file 2340 to adjust this setting to your needs. 2341 2342- CONFIG_SYS_BOOTMAPSZ: 2343 Maximum size of memory mapped by the startup code of 2344 the Linux kernel; all data that must be processed by 2345 the Linux kernel (bd_info, boot arguments, FDT blob if 2346 used) must be put below this limit, unless "bootm_low" 2347 enviroment variable is defined and non-zero. In such case 2348 all data for the Linux kernel must be between "bootm_low" 2349 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. 2350 2351- CONFIG_SYS_BOOT_RAMDISK_HIGH: 2352 Enable initrd_high functionality. If defined then the 2353 initrd_high feature is enabled and the bootm ramdisk subcommand 2354 is enabled. 2355 2356- CONFIG_SYS_BOOT_GET_CMDLINE: 2357 Enables allocating and saving kernel cmdline in space between 2358 "bootm_low" and "bootm_low" + BOOTMAPSZ. 2359 2360- CONFIG_SYS_BOOT_GET_KBD: 2361 Enables allocating and saving a kernel copy of the bd_info in 2362 space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 2363 2364- CONFIG_SYS_MAX_FLASH_BANKS: 2365 Max number of Flash memory banks 2366 2367- CONFIG_SYS_MAX_FLASH_SECT: 2368 Max number of sectors on a Flash chip 2369 2370- CONFIG_SYS_FLASH_ERASE_TOUT: 2371 Timeout for Flash erase operations (in ms) 2372 2373- CONFIG_SYS_FLASH_WRITE_TOUT: 2374 Timeout for Flash write operations (in ms) 2375 2376- CONFIG_SYS_FLASH_LOCK_TOUT 2377 Timeout for Flash set sector lock bit operation (in ms) 2378 2379- CONFIG_SYS_FLASH_UNLOCK_TOUT 2380 Timeout for Flash clear lock bits operation (in ms) 2381 2382- CONFIG_SYS_FLASH_PROTECTION 2383 If defined, hardware flash sectors protection is used 2384 instead of U-Boot software protection. 2385 2386- CONFIG_SYS_DIRECT_FLASH_TFTP: 2387 2388 Enable TFTP transfers directly to flash memory; 2389 without this option such a download has to be 2390 performed in two steps: (1) download to RAM, and (2) 2391 copy from RAM to flash. 2392 2393 The two-step approach is usually more reliable, since 2394 you can check if the download worked before you erase 2395 the flash, but in some situations (when system RAM is 2396 too limited to allow for a temporary copy of the 2397 downloaded image) this option may be very useful. 2398 2399- CONFIG_SYS_FLASH_CFI: 2400 Define if the flash driver uses extra elements in the 2401 common flash structure for storing flash geometry. 2402 2403- CONFIG_FLASH_CFI_DRIVER 2404 This option also enables the building of the cfi_flash driver 2405 in the drivers directory 2406 2407- CONFIG_FLASH_CFI_MTD 2408 This option enables the building of the cfi_mtd driver 2409 in the drivers directory. The driver exports CFI flash 2410 to the MTD layer. 2411 2412- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 2413 Use buffered writes to flash. 2414 2415- CONFIG_FLASH_SPANSION_S29WS_N 2416 s29ws-n MirrorBit flash has non-standard addresses for buffered 2417 write commands. 2418 2419- CONFIG_SYS_FLASH_QUIET_TEST 2420 If this option is defined, the common CFI flash doesn't 2421 print it's warning upon not recognized FLASH banks. This 2422 is useful, if some of the configured banks are only 2423 optionally available. 2424 2425- CONFIG_FLASH_SHOW_PROGRESS 2426 If defined (must be an integer), print out countdown 2427 digits and dots. Recommended value: 45 (9..1) for 80 2428 column displays, 15 (3..1) for 40 column displays. 2429 2430- CONFIG_SYS_RX_ETH_BUFFER: 2431 Defines the number of Ethernet receive buffers. On some 2432 Ethernet controllers it is recommended to set this value 2433 to 8 or even higher (EEPRO100 or 405 EMAC), since all 2434 buffers can be full shortly after enabling the interface 2435 on high Ethernet traffic. 2436 Defaults to 4 if not defined. 2437 2438- CONFIG_ENV_MAX_ENTRIES 2439 2440 Maximum number of entries in the hash table that is used 2441 internally to store the environment settings. The default 2442 setting is supposed to be generous and should work in most 2443 cases. This setting can be used to tune behaviour; see 2444 lib/hashtable.c for details. 2445 2446The following definitions that deal with the placement and management 2447of environment data (variable area); in general, we support the 2448following configurations: 2449 2450- CONFIG_ENV_IS_IN_FLASH: 2451 2452 Define this if the environment is in flash memory. 2453 2454 a) The environment occupies one whole flash sector, which is 2455 "embedded" in the text segment with the U-Boot code. This 2456 happens usually with "bottom boot sector" or "top boot 2457 sector" type flash chips, which have several smaller 2458 sectors at the start or the end. For instance, such a 2459 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 2460 such a case you would place the environment in one of the 2461 4 kB sectors - with U-Boot code before and after it. With 2462 "top boot sector" type flash chips, you would put the 2463 environment in one of the last sectors, leaving a gap 2464 between U-Boot and the environment. 2465 2466 - CONFIG_ENV_OFFSET: 2467 2468 Offset of environment data (variable area) to the 2469 beginning of flash memory; for instance, with bottom boot 2470 type flash chips the second sector can be used: the offset 2471 for this sector is given here. 2472 2473 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 2474 2475 - CONFIG_ENV_ADDR: 2476 2477 This is just another way to specify the start address of 2478 the flash sector containing the environment (instead of 2479 CONFIG_ENV_OFFSET). 2480 2481 - CONFIG_ENV_SECT_SIZE: 2482 2483 Size of the sector containing the environment. 2484 2485 2486 b) Sometimes flash chips have few, equal sized, BIG sectors. 2487 In such a case you don't want to spend a whole sector for 2488 the environment. 2489 2490 - CONFIG_ENV_SIZE: 2491 2492 If you use this in combination with CONFIG_ENV_IS_IN_FLASH 2493 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 2494 of this flash sector for the environment. This saves 2495 memory for the RAM copy of the environment. 2496 2497 It may also save flash memory if you decide to use this 2498 when your environment is "embedded" within U-Boot code, 2499 since then the remainder of the flash sector could be used 2500 for U-Boot code. It should be pointed out that this is 2501 STRONGLY DISCOURAGED from a robustness point of view: 2502 updating the environment in flash makes it always 2503 necessary to erase the WHOLE sector. If something goes 2504 wrong before the contents has been restored from a copy in 2505 RAM, your target system will be dead. 2506 2507 - CONFIG_ENV_ADDR_REDUND 2508 CONFIG_ENV_SIZE_REDUND 2509 2510 These settings describe a second storage area used to hold 2511 a redundant copy of the environment data, so that there is 2512 a valid backup copy in case there is a power failure during 2513 a "saveenv" operation. 2514 2515BE CAREFUL! Any changes to the flash layout, and some changes to the 2516source code will make it necessary to adapt <board>/u-boot.lds* 2517accordingly! 2518 2519 2520- CONFIG_ENV_IS_IN_NVRAM: 2521 2522 Define this if you have some non-volatile memory device 2523 (NVRAM, battery buffered SRAM) which you want to use for the 2524 environment. 2525 2526 - CONFIG_ENV_ADDR: 2527 - CONFIG_ENV_SIZE: 2528 2529 These two #defines are used to determine the memory area you 2530 want to use for environment. It is assumed that this memory 2531 can just be read and written to, without any special 2532 provision. 2533 2534BE CAREFUL! The first access to the environment happens quite early 2535in U-Boot initalization (when we try to get the setting of for the 2536console baudrate). You *MUST* have mapped your NVRAM area then, or 2537U-Boot will hang. 2538 2539Please note that even with NVRAM we still use a copy of the 2540environment in RAM: we could work on NVRAM directly, but we want to 2541keep settings there always unmodified except somebody uses "saveenv" 2542to save the current settings. 2543 2544 2545- CONFIG_ENV_IS_IN_EEPROM: 2546 2547 Use this if you have an EEPROM or similar serial access 2548 device and a driver for it. 2549 2550 - CONFIG_ENV_OFFSET: 2551 - CONFIG_ENV_SIZE: 2552 2553 These two #defines specify the offset and size of the 2554 environment area within the total memory of your EEPROM. 2555 2556 - CONFIG_SYS_I2C_EEPROM_ADDR: 2557 If defined, specified the chip address of the EEPROM device. 2558 The default address is zero. 2559 2560 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 2561 If defined, the number of bits used to address bytes in a 2562 single page in the EEPROM device. A 64 byte page, for example 2563 would require six bits. 2564 2565 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 2566 If defined, the number of milliseconds to delay between 2567 page writes. The default is zero milliseconds. 2568 2569 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 2570 The length in bytes of the EEPROM memory array address. Note 2571 that this is NOT the chip address length! 2572 2573 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 2574 EEPROM chips that implement "address overflow" are ones 2575 like Catalyst 24WC04/08/16 which has 9/10/11 bits of 2576 address and the extra bits end up in the "chip address" bit 2577 slots. This makes a 24WC08 (1Kbyte) chip look like four 256 2578 byte chips. 2579 2580 Note that we consider the length of the address field to 2581 still be one byte because the extra address bits are hidden 2582 in the chip address. 2583 2584 - CONFIG_SYS_EEPROM_SIZE: 2585 The size in bytes of the EEPROM device. 2586 2587 - CONFIG_ENV_EEPROM_IS_ON_I2C 2588 define this, if you have I2C and SPI activated, and your 2589 EEPROM, which holds the environment, is on the I2C bus. 2590 2591 - CONFIG_I2C_ENV_EEPROM_BUS 2592 if you have an Environment on an EEPROM reached over 2593 I2C muxes, you can define here, how to reach this 2594 EEPROM. For example: 2595 2596 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 2597 2598 EEPROM which holds the environment, is reached over 2599 a pca9547 i2c mux with address 0x70, channel 3. 2600 2601- CONFIG_ENV_IS_IN_DATAFLASH: 2602 2603 Define this if you have a DataFlash memory device which you 2604 want to use for the environment. 2605 2606 - CONFIG_ENV_OFFSET: 2607 - CONFIG_ENV_ADDR: 2608 - CONFIG_ENV_SIZE: 2609 2610 These three #defines specify the offset and size of the 2611 environment area within the total memory of your DataFlash placed 2612 at the specified address. 2613 2614- CONFIG_ENV_IS_IN_NAND: 2615 2616 Define this if you have a NAND device which you want to use 2617 for the environment. 2618 2619 - CONFIG_ENV_OFFSET: 2620 - CONFIG_ENV_SIZE: 2621 2622 These two #defines specify the offset and size of the environment 2623 area within the first NAND device. CONFIG_ENV_OFFSET must be 2624 aligned to an erase block boundary. 2625 2626 - CONFIG_ENV_OFFSET_REDUND (optional): 2627 2628 This setting describes a second storage area of CONFIG_ENV_SIZE 2629 size used to hold a redundant copy of the environment data, so 2630 that there is a valid backup copy in case there is a power failure 2631 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 2632 aligned to an erase block boundary. 2633 2634 - CONFIG_ENV_RANGE (optional): 2635 2636 Specifies the length of the region in which the environment 2637 can be written. This should be a multiple of the NAND device's 2638 block size. Specifying a range with more erase blocks than 2639 are needed to hold CONFIG_ENV_SIZE allows bad blocks within 2640 the range to be avoided. 2641 2642 - CONFIG_ENV_OFFSET_OOB (optional): 2643 2644 Enables support for dynamically retrieving the offset of the 2645 environment from block zero's out-of-band data. The 2646 "nand env.oob" command can be used to record this offset. 2647 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 2648 using CONFIG_ENV_OFFSET_OOB. 2649 2650- CONFIG_NAND_ENV_DST 2651 2652 Defines address in RAM to which the nand_spl code should copy the 2653 environment. If redundant environment is used, it will be copied to 2654 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 2655 2656- CONFIG_SYS_SPI_INIT_OFFSET 2657 2658 Defines offset to the initial SPI buffer area in DPRAM. The 2659 area is used at an early stage (ROM part) if the environment 2660 is configured to reside in the SPI EEPROM: We need a 520 byte 2661 scratch DPRAM area. It is used between the two initialization 2662 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 2663 to be a good choice since it makes it far enough from the 2664 start of the data area as well as from the stack pointer. 2665 2666Please note that the environment is read-only until the monitor 2667has been relocated to RAM and a RAM copy of the environment has been 2668created; also, when using EEPROM you will have to use getenv_f() 2669until then to read environment variables. 2670 2671The environment is protected by a CRC32 checksum. Before the monitor 2672is relocated into RAM, as a result of a bad CRC you will be working 2673with the compiled-in default environment - *silently*!!! [This is 2674necessary, because the first environment variable we need is the 2675"baudrate" setting for the console - if we have a bad CRC, we don't 2676have any device yet where we could complain.] 2677 2678Note: once the monitor has been relocated, then it will complain if 2679the default environment is used; a new CRC is computed as soon as you 2680use the "saveenv" command to store a valid environment. 2681 2682- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 2683 Echo the inverted Ethernet link state to the fault LED. 2684 2685 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 2686 also needs to be defined. 2687 2688- CONFIG_SYS_FAULT_MII_ADDR: 2689 MII address of the PHY to check for the Ethernet link state. 2690 2691- CONFIG_NS16550_MIN_FUNCTIONS: 2692 Define this if you desire to only have use of the NS16550_init 2693 and NS16550_putc functions for the serial driver located at 2694 drivers/serial/ns16550.c. This option is useful for saving 2695 space for already greatly restricted images, including but not 2696 limited to NAND_SPL configurations. 2697 2698Low Level (hardware related) configuration options: 2699--------------------------------------------------- 2700 2701- CONFIG_SYS_CACHELINE_SIZE: 2702 Cache Line Size of the CPU. 2703 2704- CONFIG_SYS_DEFAULT_IMMR: 2705 Default address of the IMMR after system reset. 2706 2707 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 2708 and RPXsuper) to be able to adjust the position of 2709 the IMMR register after a reset. 2710 2711- Floppy Disk Support: 2712 CONFIG_SYS_FDC_DRIVE_NUMBER 2713 2714 the default drive number (default value 0) 2715 2716 CONFIG_SYS_ISA_IO_STRIDE 2717 2718 defines the spacing between FDC chipset registers 2719 (default value 1) 2720 2721 CONFIG_SYS_ISA_IO_OFFSET 2722 2723 defines the offset of register from address. It 2724 depends on which part of the data bus is connected to 2725 the FDC chipset. (default value 0) 2726 2727 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 2728 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 2729 default value. 2730 2731 if CONFIG_SYS_FDC_HW_INIT is defined, then the function 2732 fdc_hw_init() is called at the beginning of the FDC 2733 setup. fdc_hw_init() must be provided by the board 2734 source code. It is used to make hardware dependant 2735 initializations. 2736 2737- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 2738 DO NOT CHANGE unless you know exactly what you're 2739 doing! (11-4) [MPC8xx/82xx systems only] 2740 2741- CONFIG_SYS_INIT_RAM_ADDR: 2742 2743 Start address of memory area that can be used for 2744 initial data and stack; please note that this must be 2745 writable memory that is working WITHOUT special 2746 initialization, i. e. you CANNOT use normal RAM which 2747 will become available only after programming the 2748 memory controller and running certain initialization 2749 sequences. 2750 2751 U-Boot uses the following memory types: 2752 - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 2753 - MPC824X: data cache 2754 - PPC4xx: data cache 2755 2756- CONFIG_SYS_GBL_DATA_OFFSET: 2757 2758 Offset of the initial data structure in the memory 2759 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 2760 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 2761 data is located at the end of the available space 2762 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 2763 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 2764 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 2765 CONFIG_SYS_GBL_DATA_OFFSET) downward. 2766 2767 Note: 2768 On the MPC824X (or other systems that use the data 2769 cache for initial memory) the address chosen for 2770 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 2771 point to an otherwise UNUSED address space between 2772 the top of RAM and the start of the PCI space. 2773 2774- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 2775 2776- CONFIG_SYS_SYPCR: System Protection Control (11-9) 2777 2778- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 2779 2780- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 2781 2782- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 2783 2784- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 2785 2786- CONFIG_SYS_OR_TIMING_SDRAM: 2787 SDRAM timing 2788 2789- CONFIG_SYS_MAMR_PTA: 2790 periodic timer for refresh 2791 2792- CONFIG_SYS_DER: Debug Event Register (37-47) 2793 2794- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 2795 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 2796 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 2797 CONFIG_SYS_BR1_PRELIM: 2798 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 2799 2800- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 2801 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 2802 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 2803 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 2804 2805- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 2806 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 2807 Machine Mode Register and Memory Periodic Timer 2808 Prescaler definitions (SDRAM timing) 2809 2810- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 2811 enable I2C microcode relocation patch (MPC8xx); 2812 define relocation offset in DPRAM [DSP2] 2813 2814- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 2815 enable SMC microcode relocation patch (MPC8xx); 2816 define relocation offset in DPRAM [SMC1] 2817 2818- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 2819 enable SPI microcode relocation patch (MPC8xx); 2820 define relocation offset in DPRAM [SCC4] 2821 2822- CONFIG_SYS_USE_OSCCLK: 2823 Use OSCM clock mode on MBX8xx board. Be careful, 2824 wrong setting might damage your board. Read 2825 doc/README.MBX before setting this variable! 2826 2827- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 2828 Offset of the bootmode word in DPRAM used by post 2829 (Power On Self Tests). This definition overrides 2830 #define'd default value in commproc.h resp. 2831 cpm_8260.h. 2832 2833- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 2834 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 2835 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 2836 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 2837 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 2838 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 2839 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 2840 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 2841 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 2842 2843- CONFIG_PCI_DISABLE_PCIE: 2844 Disable PCI-Express on systems where it is supported but not 2845 required. 2846 2847- CONFIG_SYS_SRIO: 2848 Chip has SRIO or not 2849 2850- CONFIG_SRIO1: 2851 Board has SRIO 1 port available 2852 2853- CONFIG_SRIO2: 2854 Board has SRIO 2 port available 2855 2856- CONFIG_SYS_SRIOn_MEM_VIRT: 2857 Virtual Address of SRIO port 'n' memory region 2858 2859- CONFIG_SYS_SRIOn_MEM_PHYS: 2860 Physical Address of SRIO port 'n' memory region 2861 2862- CONFIG_SYS_SRIOn_MEM_SIZE: 2863 Size of SRIO port 'n' memory region 2864 2865- CONFIG_SPD_EEPROM 2866 Get DDR timing information from an I2C EEPROM. Common 2867 with pluggable memory modules such as SODIMMs 2868 2869 SPD_EEPROM_ADDRESS 2870 I2C address of the SPD EEPROM 2871 2872- CONFIG_SYS_SPD_BUS_NUM 2873 If SPD EEPROM is on an I2C bus other than the first 2874 one, specify here. Note that the value must resolve 2875 to something your driver can deal with. 2876 2877- CONFIG_SYS_83XX_DDR_USES_CS0 2878 Only for 83xx systems. If specified, then DDR should 2879 be configured using CS0 and CS1 instead of CS2 and CS3. 2880 2881- CONFIG_ETHER_ON_FEC[12] 2882 Define to enable FEC[12] on a 8xx series processor. 2883 2884- CONFIG_FEC[12]_PHY 2885 Define to the hardcoded PHY address which corresponds 2886 to the given FEC; i. e. 2887 #define CONFIG_FEC1_PHY 4 2888 means that the PHY with address 4 is connected to FEC1 2889 2890 When set to -1, means to probe for first available. 2891 2892- CONFIG_FEC[12]_PHY_NORXERR 2893 The PHY does not have a RXERR line (RMII only). 2894 (so program the FEC to ignore it). 2895 2896- CONFIG_RMII 2897 Enable RMII mode for all FECs. 2898 Note that this is a global option, we can't 2899 have one FEC in standard MII mode and another in RMII mode. 2900 2901- CONFIG_CRC32_VERIFY 2902 Add a verify option to the crc32 command. 2903 The syntax is: 2904 2905 => crc32 -v <address> <count> <crc32> 2906 2907 Where address/count indicate a memory area 2908 and crc32 is the correct crc32 which the 2909 area should have. 2910 2911- CONFIG_LOOPW 2912 Add the "loopw" memory command. This only takes effect if 2913 the memory commands are activated globally (CONFIG_CMD_MEM). 2914 2915- CONFIG_MX_CYCLIC 2916 Add the "mdc" and "mwc" memory commands. These are cyclic 2917 "md/mw" commands. 2918 Examples: 2919 2920 => mdc.b 10 4 500 2921 This command will print 4 bytes (10,11,12,13) each 500 ms. 2922 2923 => mwc.l 100 12345678 10 2924 This command will write 12345678 to address 100 all 10 ms. 2925 2926 This only takes effect if the memory commands are activated 2927 globally (CONFIG_CMD_MEM). 2928 2929- CONFIG_SKIP_LOWLEVEL_INIT 2930 [ARM only] If this variable is defined, then certain 2931 low level initializations (like setting up the memory 2932 controller) are omitted and/or U-Boot does not 2933 relocate itself into RAM. 2934 2935 Normally this variable MUST NOT be defined. The only 2936 exception is when U-Boot is loaded (to RAM) by some 2937 other boot loader or by a debugger which performs 2938 these initializations itself. 2939 2940- CONFIG_PRELOADER 2941 Modifies the behaviour of start.S when compiling a loader 2942 that is executed before the actual U-Boot. E.g. when 2943 compiling a NAND SPL. 2944 2945Building the Software: 2946====================== 2947 2948Building U-Boot has been tested in several native build environments 2949and in many different cross environments. Of course we cannot support 2950all possibly existing versions of cross development tools in all 2951(potentially obsolete) versions. In case of tool chain problems we 2952recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 2953which is extensively used to build and test U-Boot. 2954 2955If you are not using a native environment, it is assumed that you 2956have GNU cross compiling tools available in your path. In this case, 2957you must set the environment variable CROSS_COMPILE in your shell. 2958Note that no changes to the Makefile or any other source files are 2959necessary. For example using the ELDK on a 4xx CPU, please enter: 2960 2961 $ CROSS_COMPILE=ppc_4xx- 2962 $ export CROSS_COMPILE 2963 2964Note: If you wish to generate Windows versions of the utilities in 2965 the tools directory you can use the MinGW toolchain 2966 (http://www.mingw.org). Set your HOST tools to the MinGW 2967 toolchain and execute 'make tools'. For example: 2968 2969 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 2970 2971 Binaries such as tools/mkimage.exe will be created which can 2972 be executed on computers running Windows. 2973 2974U-Boot is intended to be simple to build. After installing the 2975sources you must configure U-Boot for one specific board type. This 2976is done by typing: 2977 2978 make NAME_config 2979 2980where "NAME_config" is the name of one of the existing configu- 2981rations; see the main Makefile for supported names. 2982 2983Note: for some board special configuration names may exist; check if 2984 additional information is available from the board vendor; for 2985 instance, the TQM823L systems are available without (standard) 2986 or with LCD support. You can select such additional "features" 2987 when choosing the configuration, i. e. 2988 2989 make TQM823L_config 2990 - will configure for a plain TQM823L, i. e. no LCD support 2991 2992 make TQM823L_LCD_config 2993 - will configure for a TQM823L with U-Boot console on LCD 2994 2995 etc. 2996 2997 2998Finally, type "make all", and you should get some working U-Boot 2999images ready for download to / installation on your system: 3000 3001- "u-boot.bin" is a raw binary image 3002- "u-boot" is an image in ELF binary format 3003- "u-boot.srec" is in Motorola S-Record format 3004 3005By default the build is performed locally and the objects are saved 3006in the source directory. One of the two methods can be used to change 3007this behavior and build U-Boot to some external directory: 3008 30091. Add O= to the make command line invocations: 3010 3011 make O=/tmp/build distclean 3012 make O=/tmp/build NAME_config 3013 make O=/tmp/build all 3014 30152. Set environment variable BUILD_DIR to point to the desired location: 3016 3017 export BUILD_DIR=/tmp/build 3018 make distclean 3019 make NAME_config 3020 make all 3021 3022Note that the command line "O=" setting overrides the BUILD_DIR environment 3023variable. 3024 3025 3026Please be aware that the Makefiles assume you are using GNU make, so 3027for instance on NetBSD you might need to use "gmake" instead of 3028native "make". 3029 3030 3031If the system board that you have is not listed, then you will need 3032to port U-Boot to your hardware platform. To do this, follow these 3033steps: 3034 30351. Add a new configuration option for your board to the toplevel 3036 "Makefile" and to the "MAKEALL" script, using the existing 3037 entries as examples. Note that here and at many other places 3038 boards and other names are listed in alphabetical sort order. Please 3039 keep this order. 30402. Create a new directory to hold your board specific code. Add any 3041 files you need. In your board directory, you will need at least 3042 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 30433. Create a new configuration file "include/configs/<board>.h" for 3044 your board 30453. If you're porting U-Boot to a new CPU, then also create a new 3046 directory to hold your CPU specific code. Add any files you need. 30474. Run "make <board>_config" with your new name. 30485. Type "make", and you should get a working "u-boot.srec" file 3049 to be installed on your target system. 30506. Debug and solve any problems that might arise. 3051 [Of course, this last step is much harder than it sounds.] 3052 3053 3054Testing of U-Boot Modifications, Ports to New Hardware, etc.: 3055============================================================== 3056 3057If you have modified U-Boot sources (for instance added a new board 3058or support for new devices, a new CPU, etc.) you are expected to 3059provide feedback to the other developers. The feedback normally takes 3060the form of a "patch", i. e. a context diff against a certain (latest 3061official or latest in the git repository) version of U-Boot sources. 3062 3063But before you submit such a patch, please verify that your modifi- 3064cation did not break existing code. At least make sure that *ALL* of 3065the supported boards compile WITHOUT ANY compiler warnings. To do so, 3066just run the "MAKEALL" script, which will configure and build U-Boot 3067for ALL supported system. Be warned, this will take a while. You can 3068select which (cross) compiler to use by passing a `CROSS_COMPILE' 3069environment variable to the script, i. e. to use the ELDK cross tools 3070you can type 3071 3072 CROSS_COMPILE=ppc_8xx- MAKEALL 3073 3074or to build on a native PowerPC system you can type 3075 3076 CROSS_COMPILE=' ' MAKEALL 3077 3078When using the MAKEALL script, the default behaviour is to build 3079U-Boot in the source directory. This location can be changed by 3080setting the BUILD_DIR environment variable. Also, for each target 3081built, the MAKEALL script saves two log files (<target>.ERR and 3082<target>.MAKEALL) in the <source dir>/LOG directory. This default 3083location can be changed by setting the MAKEALL_LOGDIR environment 3084variable. For example: 3085 3086 export BUILD_DIR=/tmp/build 3087 export MAKEALL_LOGDIR=/tmp/log 3088 CROSS_COMPILE=ppc_8xx- MAKEALL 3089 3090With the above settings build objects are saved in the /tmp/build, 3091log files are saved in the /tmp/log and the source tree remains clean 3092during the whole build process. 3093 3094 3095See also "U-Boot Porting Guide" below. 3096 3097 3098Monitor Commands - Overview: 3099============================ 3100 3101go - start application at address 'addr' 3102run - run commands in an environment variable 3103bootm - boot application image from memory 3104bootp - boot image via network using BootP/TFTP protocol 3105tftpboot- boot image via network using TFTP protocol 3106 and env variables "ipaddr" and "serverip" 3107 (and eventually "gatewayip") 3108rarpboot- boot image via network using RARP/TFTP protocol 3109diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 3110loads - load S-Record file over serial line 3111loadb - load binary file over serial line (kermit mode) 3112md - memory display 3113mm - memory modify (auto-incrementing) 3114nm - memory modify (constant address) 3115mw - memory write (fill) 3116cp - memory copy 3117cmp - memory compare 3118crc32 - checksum calculation 3119i2c - I2C sub-system 3120sspi - SPI utility commands 3121base - print or set address offset 3122printenv- print environment variables 3123setenv - set environment variables 3124saveenv - save environment variables to persistent storage 3125protect - enable or disable FLASH write protection 3126erase - erase FLASH memory 3127flinfo - print FLASH memory information 3128bdinfo - print Board Info structure 3129iminfo - print header information for application image 3130coninfo - print console devices and informations 3131ide - IDE sub-system 3132loop - infinite loop on address range 3133loopw - infinite write loop on address range 3134mtest - simple RAM test 3135icache - enable or disable instruction cache 3136dcache - enable or disable data cache 3137reset - Perform RESET of the CPU 3138echo - echo args to console 3139version - print monitor version 3140help - print online help 3141? - alias for 'help' 3142 3143 3144Monitor Commands - Detailed Description: 3145======================================== 3146 3147TODO. 3148 3149For now: just type "help <command>". 3150 3151 3152Environment Variables: 3153====================== 3154 3155U-Boot supports user configuration using Environment Variables which 3156can be made persistent by saving to Flash memory. 3157 3158Environment Variables are set using "setenv", printed using 3159"printenv", and saved to Flash using "saveenv". Using "setenv" 3160without a value can be used to delete a variable from the 3161environment. As long as you don't save the environment you are 3162working with an in-memory copy. In case the Flash area containing the 3163environment is erased by accident, a default environment is provided. 3164 3165Some configuration options can be set using Environment Variables. 3166 3167List of environment variables (most likely not complete): 3168 3169 baudrate - see CONFIG_BAUDRATE 3170 3171 bootdelay - see CONFIG_BOOTDELAY 3172 3173 bootcmd - see CONFIG_BOOTCOMMAND 3174 3175 bootargs - Boot arguments when booting an RTOS image 3176 3177 bootfile - Name of the image to load with TFTP 3178 3179 bootm_low - Memory range available for image processing in the bootm 3180 command can be restricted. This variable is given as 3181 a hexadecimal number and defines lowest address allowed 3182 for use by the bootm command. See also "bootm_size" 3183 environment variable. Address defined by "bootm_low" is 3184 also the base of the initial memory mapping for the Linux 3185 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ. 3186 3187 bootm_size - Memory range available for image processing in the bootm 3188 command can be restricted. This variable is given as 3189 a hexadecimal number and defines the size of the region 3190 allowed for use by the bootm command. See also "bootm_low" 3191 environment variable. 3192 3193 updatefile - Location of the software update file on a TFTP server, used 3194 by the automatic software update feature. Please refer to 3195 documentation in doc/README.update for more details. 3196 3197 autoload - if set to "no" (any string beginning with 'n'), 3198 "bootp" will just load perform a lookup of the 3199 configuration from the BOOTP server, but not try to 3200 load any image using TFTP 3201 3202 autostart - if set to "yes", an image loaded using the "bootp", 3203 "rarpboot", "tftpboot" or "diskboot" commands will 3204 be automatically started (by internally calling 3205 "bootm") 3206 3207 If set to "no", a standalone image passed to the 3208 "bootm" command will be copied to the load address 3209 (and eventually uncompressed), but NOT be started. 3210 This can be used to load and uncompress arbitrary 3211 data. 3212 3213 i2cfast - (PPC405GP|PPC405EP only) 3214 if set to 'y' configures Linux I2C driver for fast 3215 mode (400kHZ). This environment variable is used in 3216 initialization code. So, for changes to be effective 3217 it must be saved and board must be reset. 3218 3219 initrd_high - restrict positioning of initrd images: 3220 If this variable is not set, initrd images will be 3221 copied to the highest possible address in RAM; this 3222 is usually what you want since it allows for 3223 maximum initrd size. If for some reason you want to 3224 make sure that the initrd image is loaded below the 3225 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 3226 variable to a value of "no" or "off" or "0". 3227 Alternatively, you can set it to a maximum upper 3228 address to use (U-Boot will still check that it 3229 does not overwrite the U-Boot stack and data). 3230 3231 For instance, when you have a system with 16 MB 3232 RAM, and want to reserve 4 MB from use by Linux, 3233 you can do this by adding "mem=12M" to the value of 3234 the "bootargs" variable. However, now you must make 3235 sure that the initrd image is placed in the first 3236 12 MB as well - this can be done with 3237 3238 setenv initrd_high 00c00000 3239 3240 If you set initrd_high to 0xFFFFFFFF, this is an 3241 indication to U-Boot that all addresses are legal 3242 for the Linux kernel, including addresses in flash 3243 memory. In this case U-Boot will NOT COPY the 3244 ramdisk at all. This may be useful to reduce the 3245 boot time on your system, but requires that this 3246 feature is supported by your Linux kernel. 3247 3248 ipaddr - IP address; needed for tftpboot command 3249 3250 loadaddr - Default load address for commands like "bootp", 3251 "rarpboot", "tftpboot", "loadb" or "diskboot" 3252 3253 loads_echo - see CONFIG_LOADS_ECHO 3254 3255 serverip - TFTP server IP address; needed for tftpboot command 3256 3257 bootretry - see CONFIG_BOOT_RETRY_TIME 3258 3259 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 3260 3261 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 3262 3263 ethprime - When CONFIG_NET_MULTI is enabled controls which 3264 interface is used first. 3265 3266 ethact - When CONFIG_NET_MULTI is enabled controls which 3267 interface is currently active. For example you 3268 can do the following 3269 3270 => setenv ethact FEC 3271 => ping 192.168.0.1 # traffic sent on FEC 3272 => setenv ethact SCC 3273 => ping 10.0.0.1 # traffic sent on SCC 3274 3275 ethrotate - When set to "no" U-Boot does not go through all 3276 available network interfaces. 3277 It just stays at the currently selected interface. 3278 3279 netretry - When set to "no" each network operation will 3280 either succeed or fail without retrying. 3281 When set to "once" the network operation will 3282 fail when all the available network interfaces 3283 are tried once without success. 3284 Useful on scripts which control the retry operation 3285 themselves. 3286 3287 npe_ucode - set load address for the NPE microcode 3288 3289 tftpsrcport - If this is set, the value is used for TFTP's 3290 UDP source port. 3291 3292 tftpdstport - If this is set, the value is used for TFTP's UDP 3293 destination port instead of the Well Know Port 69. 3294 3295 tftpblocksize - Block size to use for TFTP transfers; if not set, 3296 we use the TFTP server's default block size 3297 3298 tftptimeout - Retransmission timeout for TFTP packets (in milli- 3299 seconds, minimum value is 1000 = 1 second). Defines 3300 when a packet is considered to be lost so it has to 3301 be retransmitted. The default is 5000 = 5 seconds. 3302 Lowering this value may make downloads succeed 3303 faster in networks with high packet loss rates or 3304 with unreliable TFTP servers. 3305 3306 vlan - When set to a value < 4095 the traffic over 3307 Ethernet is encapsulated/received over 802.1q 3308 VLAN tagged frames. 3309 3310The following environment variables may be used and automatically 3311updated by the network boot commands ("bootp" and "rarpboot"), 3312depending the information provided by your boot server: 3313 3314 bootfile - see above 3315 dnsip - IP address of your Domain Name Server 3316 dnsip2 - IP address of your secondary Domain Name Server 3317 gatewayip - IP address of the Gateway (Router) to use 3318 hostname - Target hostname 3319 ipaddr - see above 3320 netmask - Subnet Mask 3321 rootpath - Pathname of the root filesystem on the NFS server 3322 serverip - see above 3323 3324 3325There are two special Environment Variables: 3326 3327 serial# - contains hardware identification information such 3328 as type string and/or serial number 3329 ethaddr - Ethernet address 3330 3331These variables can be set only once (usually during manufacturing of 3332the board). U-Boot refuses to delete or overwrite these variables 3333once they have been set once. 3334 3335 3336Further special Environment Variables: 3337 3338 ver - Contains the U-Boot version string as printed 3339 with the "version" command. This variable is 3340 readonly (see CONFIG_VERSION_VARIABLE). 3341 3342 3343Please note that changes to some configuration parameters may take 3344only effect after the next boot (yes, that's just like Windoze :-). 3345 3346 3347Command Line Parsing: 3348===================== 3349 3350There are two different command line parsers available with U-Boot: 3351the old "simple" one, and the much more powerful "hush" shell: 3352 3353Old, simple command line parser: 3354-------------------------------- 3355 3356- supports environment variables (through setenv / saveenv commands) 3357- several commands on one line, separated by ';' 3358- variable substitution using "... ${name} ..." syntax 3359- special characters ('$', ';') can be escaped by prefixing with '\', 3360 for example: 3361 setenv bootcmd bootm \${address} 3362- You can also escape text by enclosing in single apostrophes, for example: 3363 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 3364 3365Hush shell: 3366----------- 3367 3368- similar to Bourne shell, with control structures like 3369 if...then...else...fi, for...do...done; while...do...done, 3370 until...do...done, ... 3371- supports environment ("global") variables (through setenv / saveenv 3372 commands) and local shell variables (through standard shell syntax 3373 "name=value"); only environment variables can be used with "run" 3374 command 3375 3376General rules: 3377-------------- 3378 3379(1) If a command line (or an environment variable executed by a "run" 3380 command) contains several commands separated by semicolon, and 3381 one of these commands fails, then the remaining commands will be 3382 executed anyway. 3383 3384(2) If you execute several variables with one call to run (i. e. 3385 calling run with a list of variables as arguments), any failing 3386 command will cause "run" to terminate, i. e. the remaining 3387 variables are not executed. 3388 3389Note for Redundant Ethernet Interfaces: 3390======================================= 3391 3392Some boards come with redundant Ethernet interfaces; U-Boot supports 3393such configurations and is capable of automatic selection of a 3394"working" interface when needed. MAC assignment works as follows: 3395 3396Network interfaces are numbered eth0, eth1, eth2, ... Corresponding 3397MAC addresses can be stored in the environment as "ethaddr" (=>eth0), 3398"eth1addr" (=>eth1), "eth2addr", ... 3399 3400If the network interface stores some valid MAC address (for instance 3401in SROM), this is used as default address if there is NO correspon- 3402ding setting in the environment; if the corresponding environment 3403variable is set, this overrides the settings in the card; that means: 3404 3405o If the SROM has a valid MAC address, and there is no address in the 3406 environment, the SROM's address is used. 3407 3408o If there is no valid address in the SROM, and a definition in the 3409 environment exists, then the value from the environment variable is 3410 used. 3411 3412o If both the SROM and the environment contain a MAC address, and 3413 both addresses are the same, this MAC address is used. 3414 3415o If both the SROM and the environment contain a MAC address, and the 3416 addresses differ, the value from the environment is used and a 3417 warning is printed. 3418 3419o If neither SROM nor the environment contain a MAC address, an error 3420 is raised. 3421 3422If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 3423will be programmed into hardware as part of the initialization process. This 3424may be skipped by setting the appropriate 'ethmacskip' environment variable. 3425The naming convention is as follows: 3426"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 3427 3428Image Formats: 3429============== 3430 3431U-Boot is capable of booting (and performing other auxiliary operations on) 3432images in two formats: 3433 3434New uImage format (FIT) 3435----------------------- 3436 3437Flexible and powerful format based on Flattened Image Tree -- FIT (similar 3438to Flattened Device Tree). It allows the use of images with multiple 3439components (several kernels, ramdisks, etc.), with contents protected by 3440SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 3441 3442 3443Old uImage format 3444----------------- 3445 3446Old image format is based on binary files which can be basically anything, 3447preceded by a special header; see the definitions in include/image.h for 3448details; basically, the header defines the following image properties: 3449 3450* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 3451 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 3452 LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 3453 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 3454 INTEGRITY). 3455* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 3456 IA64, MIPS, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 3457 Currently supported: ARM, AVR32, Intel x86, MIPS, Nios II, PowerPC). 3458* Compression Type (uncompressed, gzip, bzip2) 3459* Load Address 3460* Entry Point 3461* Image Name 3462* Image Timestamp 3463 3464The header is marked by a special Magic Number, and both the header 3465and the data portions of the image are secured against corruption by 3466CRC32 checksums. 3467 3468 3469Linux Support: 3470============== 3471 3472Although U-Boot should support any OS or standalone application 3473easily, the main focus has always been on Linux during the design of 3474U-Boot. 3475 3476U-Boot includes many features that so far have been part of some 3477special "boot loader" code within the Linux kernel. Also, any 3478"initrd" images to be used are no longer part of one big Linux image; 3479instead, kernel and "initrd" are separate images. This implementation 3480serves several purposes: 3481 3482- the same features can be used for other OS or standalone 3483 applications (for instance: using compressed images to reduce the 3484 Flash memory footprint) 3485 3486- it becomes much easier to port new Linux kernel versions because 3487 lots of low-level, hardware dependent stuff are done by U-Boot 3488 3489- the same Linux kernel image can now be used with different "initrd" 3490 images; of course this also means that different kernel images can 3491 be run with the same "initrd". This makes testing easier (you don't 3492 have to build a new "zImage.initrd" Linux image when you just 3493 change a file in your "initrd"). Also, a field-upgrade of the 3494 software is easier now. 3495 3496 3497Linux HOWTO: 3498============ 3499 3500Porting Linux to U-Boot based systems: 3501--------------------------------------- 3502 3503U-Boot cannot save you from doing all the necessary modifications to 3504configure the Linux device drivers for use with your target hardware 3505(no, we don't intend to provide a full virtual machine interface to 3506Linux :-). 3507 3508But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 3509 3510Just make sure your machine specific header file (for instance 3511include/asm-ppc/tqm8xx.h) includes the same definition of the Board 3512Information structure as we define in include/asm-<arch>/u-boot.h, 3513and make sure that your definition of IMAP_ADDR uses the same value 3514as your U-Boot configuration in CONFIG_SYS_IMMR. 3515 3516 3517Configuring the Linux kernel: 3518----------------------------- 3519 3520No specific requirements for U-Boot. Make sure you have some root 3521device (initial ramdisk, NFS) for your target system. 3522 3523 3524Building a Linux Image: 3525----------------------- 3526 3527With U-Boot, "normal" build targets like "zImage" or "bzImage" are 3528not used. If you use recent kernel source, a new build target 3529"uImage" will exist which automatically builds an image usable by 3530U-Boot. Most older kernels also have support for a "pImage" target, 3531which was introduced for our predecessor project PPCBoot and uses a 3532100% compatible format. 3533 3534Example: 3535 3536 make TQM850L_config 3537 make oldconfig 3538 make dep 3539 make uImage 3540 3541The "uImage" build target uses a special tool (in 'tools/mkimage') to 3542encapsulate a compressed Linux kernel image with header information, 3543CRC32 checksum etc. for use with U-Boot. This is what we are doing: 3544 3545* build a standard "vmlinux" kernel image (in ELF binary format): 3546 3547* convert the kernel into a raw binary image: 3548 3549 ${CROSS_COMPILE}-objcopy -O binary \ 3550 -R .note -R .comment \ 3551 -S vmlinux linux.bin 3552 3553* compress the binary image: 3554 3555 gzip -9 linux.bin 3556 3557* package compressed binary image for U-Boot: 3558 3559 mkimage -A ppc -O linux -T kernel -C gzip \ 3560 -a 0 -e 0 -n "Linux Kernel Image" \ 3561 -d linux.bin.gz uImage 3562 3563 3564The "mkimage" tool can also be used to create ramdisk images for use 3565with U-Boot, either separated from the Linux kernel image, or 3566combined into one file. "mkimage" encapsulates the images with a 64 3567byte header containing information about target architecture, 3568operating system, image type, compression method, entry points, time 3569stamp, CRC32 checksums, etc. 3570 3571"mkimage" can be called in two ways: to verify existing images and 3572print the header information, or to build new images. 3573 3574In the first form (with "-l" option) mkimage lists the information 3575contained in the header of an existing U-Boot image; this includes 3576checksum verification: 3577 3578 tools/mkimage -l image 3579 -l ==> list image header information 3580 3581The second form (with "-d" option) is used to build a U-Boot image 3582from a "data file" which is used as image payload: 3583 3584 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 3585 -n name -d data_file image 3586 -A ==> set architecture to 'arch' 3587 -O ==> set operating system to 'os' 3588 -T ==> set image type to 'type' 3589 -C ==> set compression type 'comp' 3590 -a ==> set load address to 'addr' (hex) 3591 -e ==> set entry point to 'ep' (hex) 3592 -n ==> set image name to 'name' 3593 -d ==> use image data from 'datafile' 3594 3595Right now, all Linux kernels for PowerPC systems use the same load 3596address (0x00000000), but the entry point address depends on the 3597kernel version: 3598 3599- 2.2.x kernels have the entry point at 0x0000000C, 3600- 2.3.x and later kernels have the entry point at 0x00000000. 3601 3602So a typical call to build a U-Boot image would read: 3603 3604 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 3605 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 3606 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 3607 > examples/uImage.TQM850L 3608 Image Name: 2.4.4 kernel for TQM850L 3609 Created: Wed Jul 19 02:34:59 2000 3610 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3611 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3612 Load Address: 0x00000000 3613 Entry Point: 0x00000000 3614 3615To verify the contents of the image (or check for corruption): 3616 3617 -> tools/mkimage -l examples/uImage.TQM850L 3618 Image Name: 2.4.4 kernel for TQM850L 3619 Created: Wed Jul 19 02:34:59 2000 3620 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3621 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 3622 Load Address: 0x00000000 3623 Entry Point: 0x00000000 3624 3625NOTE: for embedded systems where boot time is critical you can trade 3626speed for memory and install an UNCOMPRESSED image instead: this 3627needs more space in Flash, but boots much faster since it does not 3628need to be uncompressed: 3629 3630 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 3631 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 3632 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 3633 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 3634 > examples/uImage.TQM850L-uncompressed 3635 Image Name: 2.4.4 kernel for TQM850L 3636 Created: Wed Jul 19 02:34:59 2000 3637 Image Type: PowerPC Linux Kernel Image (uncompressed) 3638 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 3639 Load Address: 0x00000000 3640 Entry Point: 0x00000000 3641 3642 3643Similar you can build U-Boot images from a 'ramdisk.image.gz' file 3644when your kernel is intended to use an initial ramdisk: 3645 3646 -> tools/mkimage -n 'Simple Ramdisk Image' \ 3647 > -A ppc -O linux -T ramdisk -C gzip \ 3648 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 3649 Image Name: Simple Ramdisk Image 3650 Created: Wed Jan 12 14:01:50 2000 3651 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3652 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 3653 Load Address: 0x00000000 3654 Entry Point: 0x00000000 3655 3656 3657Installing a Linux Image: 3658------------------------- 3659 3660To downloading a U-Boot image over the serial (console) interface, 3661you must convert the image to S-Record format: 3662 3663 objcopy -I binary -O srec examples/image examples/image.srec 3664 3665The 'objcopy' does not understand the information in the U-Boot 3666image header, so the resulting S-Record file will be relative to 3667address 0x00000000. To load it to a given address, you need to 3668specify the target address as 'offset' parameter with the 'loads' 3669command. 3670 3671Example: install the image to address 0x40100000 (which on the 3672TQM8xxL is in the first Flash bank): 3673 3674 => erase 40100000 401FFFFF 3675 3676 .......... done 3677 Erased 8 sectors 3678 3679 => loads 40100000 3680 ## Ready for S-Record download ... 3681 ~>examples/image.srec 3682 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 3683 ... 3684 15989 15990 15991 15992 3685 [file transfer complete] 3686 [connected] 3687 ## Start Addr = 0x00000000 3688 3689 3690You can check the success of the download using the 'iminfo' command; 3691this includes a checksum verification so you can be sure no data 3692corruption happened: 3693 3694 => imi 40100000 3695 3696 ## Checking Image at 40100000 ... 3697 Image Name: 2.2.13 for initrd on TQM850L 3698 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3699 Data Size: 335725 Bytes = 327 kB = 0 MB 3700 Load Address: 00000000 3701 Entry Point: 0000000c 3702 Verifying Checksum ... OK 3703 3704 3705Boot Linux: 3706----------- 3707 3708The "bootm" command is used to boot an application that is stored in 3709memory (RAM or Flash). In case of a Linux kernel image, the contents 3710of the "bootargs" environment variable is passed to the kernel as 3711parameters. You can check and modify this variable using the 3712"printenv" and "setenv" commands: 3713 3714 3715 => printenv bootargs 3716 bootargs=root=/dev/ram 3717 3718 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3719 3720 => printenv bootargs 3721 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3722 3723 => bootm 40020000 3724 ## Booting Linux kernel at 40020000 ... 3725 Image Name: 2.2.13 for NFS on TQM850L 3726 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3727 Data Size: 381681 Bytes = 372 kB = 0 MB 3728 Load Address: 00000000 3729 Entry Point: 0000000c 3730 Verifying Checksum ... OK 3731 Uncompressing Kernel Image ... OK 3732 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 3733 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 3734 time_init: decrementer frequency = 187500000/60 3735 Calibrating delay loop... 49.77 BogoMIPS 3736 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 3737 ... 3738 3739If you want to boot a Linux kernel with initial RAM disk, you pass 3740the memory addresses of both the kernel and the initrd image (PPBCOOT 3741format!) to the "bootm" command: 3742 3743 => imi 40100000 40200000 3744 3745 ## Checking Image at 40100000 ... 3746 Image Name: 2.2.13 for initrd on TQM850L 3747 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3748 Data Size: 335725 Bytes = 327 kB = 0 MB 3749 Load Address: 00000000 3750 Entry Point: 0000000c 3751 Verifying Checksum ... OK 3752 3753 ## Checking Image at 40200000 ... 3754 Image Name: Simple Ramdisk Image 3755 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3756 Data Size: 566530 Bytes = 553 kB = 0 MB 3757 Load Address: 00000000 3758 Entry Point: 00000000 3759 Verifying Checksum ... OK 3760 3761 => bootm 40100000 40200000 3762 ## Booting Linux kernel at 40100000 ... 3763 Image Name: 2.2.13 for initrd on TQM850L 3764 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3765 Data Size: 335725 Bytes = 327 kB = 0 MB 3766 Load Address: 00000000 3767 Entry Point: 0000000c 3768 Verifying Checksum ... OK 3769 Uncompressing Kernel Image ... OK 3770 ## Loading RAMDisk Image at 40200000 ... 3771 Image Name: Simple Ramdisk Image 3772 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 3773 Data Size: 566530 Bytes = 553 kB = 0 MB 3774 Load Address: 00000000 3775 Entry Point: 00000000 3776 Verifying Checksum ... OK 3777 Loading Ramdisk ... OK 3778 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 3779 Boot arguments: root=/dev/ram 3780 time_init: decrementer frequency = 187500000/60 3781 Calibrating delay loop... 49.77 BogoMIPS 3782 ... 3783 RAMDISK: Compressed image found at block 0 3784 VFS: Mounted root (ext2 filesystem). 3785 3786 bash# 3787 3788Boot Linux and pass a flat device tree: 3789----------- 3790 3791First, U-Boot must be compiled with the appropriate defines. See the section 3792titled "Linux Kernel Interface" above for a more in depth explanation. The 3793following is an example of how to start a kernel and pass an updated 3794flat device tree: 3795 3796=> print oftaddr 3797oftaddr=0x300000 3798=> print oft 3799oft=oftrees/mpc8540ads.dtb 3800=> tftp $oftaddr $oft 3801Speed: 1000, full duplex 3802Using TSEC0 device 3803TFTP from server 192.168.1.1; our IP address is 192.168.1.101 3804Filename 'oftrees/mpc8540ads.dtb'. 3805Load address: 0x300000 3806Loading: # 3807done 3808Bytes transferred = 4106 (100a hex) 3809=> tftp $loadaddr $bootfile 3810Speed: 1000, full duplex 3811Using TSEC0 device 3812TFTP from server 192.168.1.1; our IP address is 192.168.1.2 3813Filename 'uImage'. 3814Load address: 0x200000 3815Loading:############ 3816done 3817Bytes transferred = 1029407 (fb51f hex) 3818=> print loadaddr 3819loadaddr=200000 3820=> print oftaddr 3821oftaddr=0x300000 3822=> bootm $loadaddr - $oftaddr 3823## Booting image at 00200000 ... 3824 Image Name: Linux-2.6.17-dirty 3825 Image Type: PowerPC Linux Kernel Image (gzip compressed) 3826 Data Size: 1029343 Bytes = 1005.2 kB 3827 Load Address: 00000000 3828 Entry Point: 00000000 3829 Verifying Checksum ... OK 3830 Uncompressing Kernel Image ... OK 3831Booting using flat device tree at 0x300000 3832Using MPC85xx ADS machine description 3833Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 3834[snip] 3835 3836 3837More About U-Boot Image Types: 3838------------------------------ 3839 3840U-Boot supports the following image types: 3841 3842 "Standalone Programs" are directly runnable in the environment 3843 provided by U-Boot; it is expected that (if they behave 3844 well) you can continue to work in U-Boot after return from 3845 the Standalone Program. 3846 "OS Kernel Images" are usually images of some Embedded OS which 3847 will take over control completely. Usually these programs 3848 will install their own set of exception handlers, device 3849 drivers, set up the MMU, etc. - this means, that you cannot 3850 expect to re-enter U-Boot except by resetting the CPU. 3851 "RAMDisk Images" are more or less just data blocks, and their 3852 parameters (address, size) are passed to an OS kernel that is 3853 being started. 3854 "Multi-File Images" contain several images, typically an OS 3855 (Linux) kernel image and one or more data images like 3856 RAMDisks. This construct is useful for instance when you want 3857 to boot over the network using BOOTP etc., where the boot 3858 server provides just a single image file, but you want to get 3859 for instance an OS kernel and a RAMDisk image. 3860 3861 "Multi-File Images" start with a list of image sizes, each 3862 image size (in bytes) specified by an "uint32_t" in network 3863 byte order. This list is terminated by an "(uint32_t)0". 3864 Immediately after the terminating 0 follow the images, one by 3865 one, all aligned on "uint32_t" boundaries (size rounded up to 3866 a multiple of 4 bytes). 3867 3868 "Firmware Images" are binary images containing firmware (like 3869 U-Boot or FPGA images) which usually will be programmed to 3870 flash memory. 3871 3872 "Script files" are command sequences that will be executed by 3873 U-Boot's command interpreter; this feature is especially 3874 useful when you configure U-Boot to use a real shell (hush) 3875 as command interpreter. 3876 3877 3878Standalone HOWTO: 3879================= 3880 3881One of the features of U-Boot is that you can dynamically load and 3882run "standalone" applications, which can use some resources of 3883U-Boot like console I/O functions or interrupt services. 3884 3885Two simple examples are included with the sources: 3886 3887"Hello World" Demo: 3888------------------- 3889 3890'examples/hello_world.c' contains a small "Hello World" Demo 3891application; it is automatically compiled when you build U-Boot. 3892It's configured to run at address 0x00040004, so you can play with it 3893like that: 3894 3895 => loads 3896 ## Ready for S-Record download ... 3897 ~>examples/hello_world.srec 3898 1 2 3 4 5 6 7 8 9 10 11 ... 3899 [file transfer complete] 3900 [connected] 3901 ## Start Addr = 0x00040004 3902 3903 => go 40004 Hello World! This is a test. 3904 ## Starting application at 0x00040004 ... 3905 Hello World 3906 argc = 7 3907 argv[0] = "40004" 3908 argv[1] = "Hello" 3909 argv[2] = "World!" 3910 argv[3] = "This" 3911 argv[4] = "is" 3912 argv[5] = "a" 3913 argv[6] = "test." 3914 argv[7] = "<NULL>" 3915 Hit any key to exit ... 3916 3917 ## Application terminated, rc = 0x0 3918 3919Another example, which demonstrates how to register a CPM interrupt 3920handler with the U-Boot code, can be found in 'examples/timer.c'. 3921Here, a CPM timer is set up to generate an interrupt every second. 3922The interrupt service routine is trivial, just printing a '.' 3923character, but this is just a demo program. The application can be 3924controlled by the following keys: 3925 3926 ? - print current values og the CPM Timer registers 3927 b - enable interrupts and start timer 3928 e - stop timer and disable interrupts 3929 q - quit application 3930 3931 => loads 3932 ## Ready for S-Record download ... 3933 ~>examples/timer.srec 3934 1 2 3 4 5 6 7 8 9 10 11 ... 3935 [file transfer complete] 3936 [connected] 3937 ## Start Addr = 0x00040004 3938 3939 => go 40004 3940 ## Starting application at 0x00040004 ... 3941 TIMERS=0xfff00980 3942 Using timer 1 3943 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 3944 3945Hit 'b': 3946 [q, b, e, ?] Set interval 1000000 us 3947 Enabling timer 3948Hit '?': 3949 [q, b, e, ?] ........ 3950 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 3951Hit '?': 3952 [q, b, e, ?] . 3953 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 3954Hit '?': 3955 [q, b, e, ?] . 3956 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 3957Hit '?': 3958 [q, b, e, ?] . 3959 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 3960Hit 'e': 3961 [q, b, e, ?] ...Stopping timer 3962Hit 'q': 3963 [q, b, e, ?] ## Application terminated, rc = 0x0 3964 3965 3966Minicom warning: 3967================ 3968 3969Over time, many people have reported problems when trying to use the 3970"minicom" terminal emulation program for serial download. I (wd) 3971consider minicom to be broken, and recommend not to use it. Under 3972Unix, I recommend to use C-Kermit for general purpose use (and 3973especially for kermit binary protocol download ("loadb" command), and 3974use "cu" for S-Record download ("loads" command). 3975 3976Nevertheless, if you absolutely want to use it try adding this 3977configuration to your "File transfer protocols" section: 3978 3979 Name Program Name U/D FullScr IO-Red. Multi 3980 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 3981 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 3982 3983 3984NetBSD Notes: 3985============= 3986 3987Starting at version 0.9.2, U-Boot supports NetBSD both as host 3988(build U-Boot) and target system (boots NetBSD/mpc8xx). 3989 3990Building requires a cross environment; it is known to work on 3991NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 3992need gmake since the Makefiles are not compatible with BSD make). 3993Note that the cross-powerpc package does not install include files; 3994attempting to build U-Boot will fail because <machine/ansi.h> is 3995missing. This file has to be installed and patched manually: 3996 3997 # cd /usr/pkg/cross/powerpc-netbsd/include 3998 # mkdir powerpc 3999 # ln -s powerpc machine 4000 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 4001 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 4002 4003Native builds *don't* work due to incompatibilities between native 4004and U-Boot include files. 4005 4006Booting assumes that (the first part of) the image booted is a 4007stage-2 loader which in turn loads and then invokes the kernel 4008proper. Loader sources will eventually appear in the NetBSD source 4009tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 4010meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 4011 4012 4013Implementation Internals: 4014========================= 4015 4016The following is not intended to be a complete description of every 4017implementation detail. However, it should help to understand the 4018inner workings of U-Boot and make it easier to port it to custom 4019hardware. 4020 4021 4022Initial Stack, Global Data: 4023--------------------------- 4024 4025The implementation of U-Boot is complicated by the fact that U-Boot 4026starts running out of ROM (flash memory), usually without access to 4027system RAM (because the memory controller is not initialized yet). 4028This means that we don't have writable Data or BSS segments, and BSS 4029is not initialized as zero. To be able to get a C environment working 4030at all, we have to allocate at least a minimal stack. Implementation 4031options for this are defined and restricted by the CPU used: Some CPU 4032models provide on-chip memory (like the IMMR area on MPC8xx and 4033MPC826x processors), on others (parts of) the data cache can be 4034locked as (mis-) used as memory, etc. 4035 4036 Chris Hallinan posted a good summary of these issues to the 4037 U-Boot mailing list: 4038 4039 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 4040 From: "Chris Hallinan" <clh@net1plus.com> 4041 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 4042 ... 4043 4044 Correct me if I'm wrong, folks, but the way I understand it 4045 is this: Using DCACHE as initial RAM for Stack, etc, does not 4046 require any physical RAM backing up the cache. The cleverness 4047 is that the cache is being used as a temporary supply of 4048 necessary storage before the SDRAM controller is setup. It's 4049 beyond the scope of this list to explain the details, but you 4050 can see how this works by studying the cache architecture and 4051 operation in the architecture and processor-specific manuals. 4052 4053 OCM is On Chip Memory, which I believe the 405GP has 4K. It 4054 is another option for the system designer to use as an 4055 initial stack/RAM area prior to SDRAM being available. Either 4056 option should work for you. Using CS 4 should be fine if your 4057 board designers haven't used it for something that would 4058 cause you grief during the initial boot! It is frequently not 4059 used. 4060 4061 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 4062 with your processor/board/system design. The default value 4063 you will find in any recent u-boot distribution in 4064 walnut.h should work for you. I'd set it to a value larger 4065 than your SDRAM module. If you have a 64MB SDRAM module, set 4066 it above 400_0000. Just make sure your board has no resources 4067 that are supposed to respond to that address! That code in 4068 start.S has been around a while and should work as is when 4069 you get the config right. 4070 4071 -Chris Hallinan 4072 DS4.COM, Inc. 4073 4074It is essential to remember this, since it has some impact on the C 4075code for the initialization procedures: 4076 4077* Initialized global data (data segment) is read-only. Do not attempt 4078 to write it. 4079 4080* Do not use any uninitialized global data (or implicitely initialized 4081 as zero data - BSS segment) at all - this is undefined, initiali- 4082 zation is performed later (when relocating to RAM). 4083 4084* Stack space is very limited. Avoid big data buffers or things like 4085 that. 4086 4087Having only the stack as writable memory limits means we cannot use 4088normal global data to share information beween the code. But it 4089turned out that the implementation of U-Boot can be greatly 4090simplified by making a global data structure (gd_t) available to all 4091functions. We could pass a pointer to this data as argument to _all_ 4092functions, but this would bloat the code. Instead we use a feature of 4093the GCC compiler (Global Register Variables) to share the data: we 4094place a pointer (gd) to the global data into a register which we 4095reserve for this purpose. 4096 4097When choosing a register for such a purpose we are restricted by the 4098relevant (E)ABI specifications for the current architecture, and by 4099GCC's implementation. 4100 4101For PowerPC, the following registers have specific use: 4102 R1: stack pointer 4103 R2: reserved for system use 4104 R3-R4: parameter passing and return values 4105 R5-R10: parameter passing 4106 R13: small data area pointer 4107 R30: GOT pointer 4108 R31: frame pointer 4109 4110 (U-Boot also uses R12 as internal GOT pointer. r12 4111 is a volatile register so r12 needs to be reset when 4112 going back and forth between asm and C) 4113 4114 ==> U-Boot will use R2 to hold a pointer to the global data 4115 4116 Note: on PPC, we could use a static initializer (since the 4117 address of the global data structure is known at compile time), 4118 but it turned out that reserving a register results in somewhat 4119 smaller code - although the code savings are not that big (on 4120 average for all boards 752 bytes for the whole U-Boot image, 4121 624 text + 127 data). 4122 4123On Blackfin, the normal C ABI (except for P3) is followed as documented here: 4124 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 4125 4126 ==> U-Boot will use P3 to hold a pointer to the global data 4127 4128On ARM, the following registers are used: 4129 4130 R0: function argument word/integer result 4131 R1-R3: function argument word 4132 R9: GOT pointer 4133 R10: stack limit (used only if stack checking if enabled) 4134 R11: argument (frame) pointer 4135 R12: temporary workspace 4136 R13: stack pointer 4137 R14: link register 4138 R15: program counter 4139 4140 ==> U-Boot will use R8 to hold a pointer to the global data 4141 4142On Nios II, the ABI is documented here: 4143 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 4144 4145 ==> U-Boot will use gp to hold a pointer to the global data 4146 4147 Note: on Nios II, we give "-G0" option to gcc and don't use gp 4148 to access small data sections, so gp is free. 4149 4150NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 4151or current versions of GCC may "optimize" the code too much. 4152 4153Memory Management: 4154------------------ 4155 4156U-Boot runs in system state and uses physical addresses, i.e. the 4157MMU is not used either for address mapping nor for memory protection. 4158 4159The available memory is mapped to fixed addresses using the memory 4160controller. In this process, a contiguous block is formed for each 4161memory type (Flash, SDRAM, SRAM), even when it consists of several 4162physical memory banks. 4163 4164U-Boot is installed in the first 128 kB of the first Flash bank (on 4165TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 4166booting and sizing and initializing DRAM, the code relocates itself 4167to the upper end of DRAM. Immediately below the U-Boot code some 4168memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 4169configuration setting]. Below that, a structure with global Board 4170Info data is placed, followed by the stack (growing downward). 4171 4172Additionally, some exception handler code is copied to the low 8 kB 4173of DRAM (0x00000000 ... 0x00001FFF). 4174 4175So a typical memory configuration with 16 MB of DRAM could look like 4176this: 4177 4178 0x0000 0000 Exception Vector code 4179 : 4180 0x0000 1FFF 4181 0x0000 2000 Free for Application Use 4182 : 4183 : 4184 4185 : 4186 : 4187 0x00FB FF20 Monitor Stack (Growing downward) 4188 0x00FB FFAC Board Info Data and permanent copy of global data 4189 0x00FC 0000 Malloc Arena 4190 : 4191 0x00FD FFFF 4192 0x00FE 0000 RAM Copy of Monitor Code 4193 ... eventually: LCD or video framebuffer 4194 ... eventually: pRAM (Protected RAM - unchanged by reset) 4195 0x00FF FFFF [End of RAM] 4196 4197 4198System Initialization: 4199---------------------- 4200 4201In the reset configuration, U-Boot starts at the reset entry point 4202(on most PowerPC systems at address 0x00000100). Because of the reset 4203configuration for CS0# this is a mirror of the onboard Flash memory. 4204To be able to re-map memory U-Boot then jumps to its link address. 4205To be able to implement the initialization code in C, a (small!) 4206initial stack is set up in the internal Dual Ported RAM (in case CPUs 4207which provide such a feature like MPC8xx or MPC8260), or in a locked 4208part of the data cache. After that, U-Boot initializes the CPU core, 4209the caches and the SIU. 4210 4211Next, all (potentially) available memory banks are mapped using a 4212preliminary mapping. For example, we put them on 512 MB boundaries 4213(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 4214on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 4215programmed for SDRAM access. Using the temporary configuration, a 4216simple memory test is run that determines the size of the SDRAM 4217banks. 4218 4219When there is more than one SDRAM bank, and the banks are of 4220different size, the largest is mapped first. For equal size, the first 4221bank (CS2#) is mapped first. The first mapping is always for address 42220x00000000, with any additional banks following immediately to create 4223contiguous memory starting from 0. 4224 4225Then, the monitor installs itself at the upper end of the SDRAM area 4226and allocates memory for use by malloc() and for the global Board 4227Info data; also, the exception vector code is copied to the low RAM 4228pages, and the final stack is set up. 4229 4230Only after this relocation will you have a "normal" C environment; 4231until that you are restricted in several ways, mostly because you are 4232running from ROM, and because the code will have to be relocated to a 4233new address in RAM. 4234 4235 4236U-Boot Porting Guide: 4237---------------------- 4238 4239[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 4240list, October 2002] 4241 4242 4243int main(int argc, char *argv[]) 4244{ 4245 sighandler_t no_more_time; 4246 4247 signal(SIGALRM, no_more_time); 4248 alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 4249 4250 if (available_money > available_manpower) { 4251 Pay consultant to port U-Boot; 4252 return 0; 4253 } 4254 4255 Download latest U-Boot source; 4256 4257 Subscribe to u-boot mailing list; 4258 4259 if (clueless) 4260 email("Hi, I am new to U-Boot, how do I get started?"); 4261 4262 while (learning) { 4263 Read the README file in the top level directory; 4264 Read http://www.denx.de/twiki/bin/view/DULG/Manual; 4265 Read applicable doc/*.README; 4266 Read the source, Luke; 4267 /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 4268 } 4269 4270 if (available_money > toLocalCurrency ($2500)) 4271 Buy a BDI3000; 4272 else 4273 Add a lot of aggravation and time; 4274 4275 if (a similar board exists) { /* hopefully... */ 4276 cp -a board/<similar> board/<myboard> 4277 cp include/configs/<similar>.h include/configs/<myboard>.h 4278 } else { 4279 Create your own board support subdirectory; 4280 Create your own board include/configs/<myboard>.h file; 4281 } 4282 Edit new board/<myboard> files 4283 Edit new include/configs/<myboard>.h 4284 4285 while (!accepted) { 4286 while (!running) { 4287 do { 4288 Add / modify source code; 4289 } until (compiles); 4290 Debug; 4291 if (clueless) 4292 email("Hi, I am having problems..."); 4293 } 4294 Send patch file to the U-Boot email list; 4295 if (reasonable critiques) 4296 Incorporate improvements from email list code review; 4297 else 4298 Defend code as written; 4299 } 4300 4301 return 0; 4302} 4303 4304void no_more_time (int sig) 4305{ 4306 hire_a_guru(); 4307} 4308 4309 4310Coding Standards: 4311----------------- 4312 4313All contributions to U-Boot should conform to the Linux kernel 4314coding style; see the file "Documentation/CodingStyle" and the script 4315"scripts/Lindent" in your Linux kernel source directory. In sources 4316originating from U-Boot a style corresponding to "Lindent -pcs" (adding 4317spaces before parameters to function calls) is actually used. 4318 4319Source files originating from a different project (for example the 4320MTD subsystem) are generally exempt from these guidelines and are not 4321reformated to ease subsequent migration to newer versions of those 4322sources. 4323 4324Please note that U-Boot is implemented in C (and to some small parts in 4325Assembler); no C++ is used, so please do not use C++ style comments (//) 4326in your code. 4327 4328Please also stick to the following formatting rules: 4329- remove any trailing white space 4330- use TAB characters for indentation, not spaces 4331- make sure NOT to use DOS '\r\n' line feeds 4332- do not add more than 2 empty lines to source files 4333- do not add trailing empty lines to source files 4334 4335Submissions which do not conform to the standards may be returned 4336with a request to reformat the changes. 4337 4338 4339Submitting Patches: 4340------------------- 4341 4342Since the number of patches for U-Boot is growing, we need to 4343establish some rules. Submissions which do not conform to these rules 4344may be rejected, even when they contain important and valuable stuff. 4345 4346Please see http://www.denx.de/wiki/U-Boot/Patches for details. 4347 4348Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 4349see http://lists.denx.de/mailman/listinfo/u-boot 4350 4351When you send a patch, please include the following information with 4352it: 4353 4354* For bug fixes: a description of the bug and how your patch fixes 4355 this bug. Please try to include a way of demonstrating that the 4356 patch actually fixes something. 4357 4358* For new features: a description of the feature and your 4359 implementation. 4360 4361* A CHANGELOG entry as plaintext (separate from the patch) 4362 4363* For major contributions, your entry to the CREDITS file 4364 4365* When you add support for a new board, don't forget to add this 4366 board to the MAKEALL script, too. 4367 4368* If your patch adds new configuration options, don't forget to 4369 document these in the README file. 4370 4371* The patch itself. If you are using git (which is *strongly* 4372 recommended) you can easily generate the patch using the 4373 "git-format-patch". If you then use "git-send-email" to send it to 4374 the U-Boot mailing list, you will avoid most of the common problems 4375 with some other mail clients. 4376 4377 If you cannot use git, use "diff -purN OLD NEW". If your version of 4378 diff does not support these options, then get the latest version of 4379 GNU diff. 4380 4381 The current directory when running this command shall be the parent 4382 directory of the U-Boot source tree (i. e. please make sure that 4383 your patch includes sufficient directory information for the 4384 affected files). 4385 4386 We prefer patches as plain text. MIME attachments are discouraged, 4387 and compressed attachments must not be used. 4388 4389* If one logical set of modifications affects or creates several 4390 files, all these changes shall be submitted in a SINGLE patch file. 4391 4392* Changesets that contain different, unrelated modifications shall be 4393 submitted as SEPARATE patches, one patch per changeset. 4394 4395 4396Notes: 4397 4398* Before sending the patch, run the MAKEALL script on your patched 4399 source tree and make sure that no errors or warnings are reported 4400 for any of the boards. 4401 4402* Keep your modifications to the necessary minimum: A patch 4403 containing several unrelated changes or arbitrary reformats will be 4404 returned with a request to re-formatting / split it. 4405 4406* If you modify existing code, make sure that your new code does not 4407 add to the memory footprint of the code ;-) Small is beautiful! 4408 When adding new features, these should compile conditionally only 4409 (using #ifdef), and the resulting code with the new feature 4410 disabled must not need more memory than the old code without your 4411 modification. 4412 4413* Remember that there is a size limit of 100 kB per message on the 4414 u-boot mailing list. Bigger patches will be moderated. If they are 4415 reasonable and not too big, they will be acknowledged. But patches 4416 bigger than the size limit should be avoided. 4417