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