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