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