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