1# 2# (C) Copyright 2000 - 2012 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 57Note: There is no CHANGELOG file in the actual U-Boot source tree; 58it can be created dynamically from the Git log using: 59 60 make CHANGELOG 61 62 63Where to get help: 64================== 65 66In case you have questions about, problems with or contributions for 67U-Boot you should send a message to the U-Boot mailing list at 68<u-boot@lists.denx.de>. There is also an archive of previous traffic 69on the mailing list - please search the archive before asking FAQ's. 70Please see http://lists.denx.de/pipermail/u-boot and 71http://dir.gmane.org/gmane.comp.boot-loaders.u-boot 72 73 74Where to get source code: 75========================= 76 77The U-Boot source code is maintained in the git repository at 78git://www.denx.de/git/u-boot.git ; you can browse it online at 79http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 80 81The "snapshot" links on this page allow you to download tarballs of 82any version you might be interested in. Official releases are also 83available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 84directory. 85 86Pre-built (and tested) images are available from 87ftp://ftp.denx.de/pub/u-boot/images/ 88 89 90Where we come from: 91=================== 92 93- start from 8xxrom sources 94- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 95- clean up code 96- make it easier to add custom boards 97- make it possible to add other [PowerPC] CPUs 98- extend functions, especially: 99 * Provide extended interface to Linux boot loader 100 * S-Record download 101 * network boot 102 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 103- create ARMBoot project (http://sourceforge.net/projects/armboot) 104- add other CPU families (starting with ARM) 105- create U-Boot project (http://sourceforge.net/projects/u-boot) 106- current project page: see http://www.denx.de/wiki/U-Boot 107 108 109Names and Spelling: 110=================== 111 112The "official" name of this project is "Das U-Boot". The spelling 113"U-Boot" shall be used in all written text (documentation, comments 114in source files etc.). Example: 115 116 This is the README file for the U-Boot project. 117 118File names etc. shall be based on the string "u-boot". Examples: 119 120 include/asm-ppc/u-boot.h 121 122 #include <asm/u-boot.h> 123 124Variable names, preprocessor constants etc. shall be either based on 125the string "u_boot" or on "U_BOOT". Example: 126 127 U_BOOT_VERSION u_boot_logo 128 IH_OS_U_BOOT u_boot_hush_start 129 130 131Versioning: 132=========== 133 134Starting with the release in October 2008, the names of the releases 135were changed from numerical release numbers without deeper meaning 136into a time stamp based numbering. Regular releases are identified by 137names consisting of the calendar year and month of the release date. 138Additional fields (if present) indicate release candidates or bug fix 139releases in "stable" maintenance trees. 140 141Examples: 142 U-Boot v2009.11 - Release November 2009 143 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 144 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 145 146 147Directory Hierarchy: 148==================== 149 150/arch Architecture specific files 151 /arm Files generic to ARM architecture 152 /cpu CPU specific files 153 /arm720t Files specific to ARM 720 CPUs 154 /arm920t Files specific to ARM 920 CPUs 155 /at91 Files specific to Atmel AT91RM9200 CPU 156 /imx Files specific to Freescale MC9328 i.MX CPUs 157 /s3c24x0 Files specific to Samsung S3C24X0 CPUs 158 /arm925t Files specific to ARM 925 CPUs 159 /arm926ejs Files specific to ARM 926 CPUs 160 /arm1136 Files specific to ARM 1136 CPUs 161 /ixp Files specific to Intel XScale IXP CPUs 162 /pxa Files specific to Intel XScale PXA CPUs 163 /s3c44b0 Files specific to Samsung S3C44B0 CPUs 164 /sa1100 Files specific to Intel StrongARM SA1100 CPUs 165 /lib Architecture specific library files 166 /avr32 Files generic to AVR32 architecture 167 /cpu CPU specific files 168 /lib Architecture specific library files 169 /blackfin Files generic to Analog Devices Blackfin architecture 170 /cpu CPU specific files 171 /lib Architecture specific library files 172 /x86 Files generic to x86 architecture 173 /cpu CPU specific files 174 /lib Architecture specific library files 175 /m68k Files generic to m68k architecture 176 /cpu CPU specific files 177 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 178 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 179 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 180 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 181 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 182 /lib Architecture specific library files 183 /microblaze Files generic to microblaze architecture 184 /cpu CPU specific files 185 /lib Architecture specific library files 186 /mips Files generic to MIPS architecture 187 /cpu CPU specific files 188 /mips32 Files specific to MIPS32 CPUs 189 /xburst Files specific to Ingenic XBurst CPUs 190 /lib Architecture specific library files 191 /nds32 Files generic to NDS32 architecture 192 /cpu CPU specific files 193 /n1213 Files specific to Andes Technology N1213 CPUs 194 /lib Architecture specific library files 195 /nios2 Files generic to Altera NIOS2 architecture 196 /cpu CPU specific files 197 /lib Architecture specific library files 198 /powerpc Files generic to PowerPC architecture 199 /cpu CPU specific files 200 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 201 /mpc5xx Files specific to Freescale MPC5xx CPUs 202 /mpc5xxx Files specific to Freescale MPC5xxx CPUs 203 /mpc8xx Files specific to Freescale MPC8xx CPUs 204 /mpc8220 Files specific to Freescale MPC8220 CPUs 205 /mpc824x Files specific to Freescale MPC824x CPUs 206 /mpc8260 Files specific to Freescale MPC8260 CPUs 207 /mpc85xx Files specific to Freescale MPC85xx CPUs 208 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 209 /lib Architecture specific library files 210 /sh Files generic to SH architecture 211 /cpu CPU specific files 212 /sh2 Files specific to sh2 CPUs 213 /sh3 Files specific to sh3 CPUs 214 /sh4 Files specific to sh4 CPUs 215 /lib Architecture specific library files 216 /sparc Files generic to SPARC architecture 217 /cpu CPU specific files 218 /leon2 Files specific to Gaisler LEON2 SPARC CPU 219 /leon3 Files specific to Gaisler LEON3 SPARC CPU 220 /lib Architecture specific library files 221/api Machine/arch independent API for external apps 222/board Board dependent files 223/common Misc architecture independent functions 224/disk Code for disk drive partition handling 225/doc Documentation (don't expect too much) 226/drivers Commonly used device drivers 227/examples Example code for standalone applications, etc. 228/fs Filesystem code (cramfs, ext2, jffs2, etc.) 229/include Header Files 230/lib Files generic to all architectures 231 /libfdt Library files to support flattened device trees 232 /lzma Library files to support LZMA decompression 233 /lzo Library files to support LZO decompression 234/net Networking code 235/post Power On Self Test 236/rtc Real Time Clock drivers 237/tools Tools to build S-Record or U-Boot images, etc. 238 239Software Configuration: 240======================= 241 242Configuration is usually done using C preprocessor defines; the 243rationale behind that is to avoid dead code whenever possible. 244 245There are two classes of configuration variables: 246 247* Configuration _OPTIONS_: 248 These are selectable by the user and have names beginning with 249 "CONFIG_". 250 251* Configuration _SETTINGS_: 252 These depend on the hardware etc. and should not be meddled with if 253 you don't know what you're doing; they have names beginning with 254 "CONFIG_SYS_". 255 256Later we will add a configuration tool - probably similar to or even 257identical to what's used for the Linux kernel. Right now, we have to 258do the configuration by hand, which means creating some symbolic 259links and editing some configuration files. We use the TQM8xxL boards 260as an example here. 261 262 263Selection of Processor Architecture and Board Type: 264--------------------------------------------------- 265 266For all supported boards there are ready-to-use default 267configurations available; just type "make <board_name>_config". 268 269Example: For a TQM823L module type: 270 271 cd u-boot 272 make TQM823L_config 273 274For the Cogent platform, you need to specify the CPU type as well; 275e.g. "make cogent_mpc8xx_config". And also configure the cogent 276directory according to the instructions in cogent/README. 277 278 279Configuration Options: 280---------------------- 281 282Configuration depends on the combination of board and CPU type; all 283such information is kept in a configuration file 284"include/configs/<board_name>.h". 285 286Example: For a TQM823L module, all configuration settings are in 287"include/configs/TQM823L.h". 288 289 290Many of the options are named exactly as the corresponding Linux 291kernel configuration options. The intention is to make it easier to 292build a config tool - later. 293 294 295The following options need to be configured: 296 297- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 298 299- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 300 301- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 302 Define exactly one, e.g. CONFIG_ATSTK1002 303 304- CPU Module Type: (if CONFIG_COGENT is defined) 305 Define exactly one of 306 CONFIG_CMA286_60_OLD 307--- FIXME --- not tested yet: 308 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 309 CONFIG_CMA287_23, CONFIG_CMA287_50 310 311- Motherboard Type: (if CONFIG_COGENT is defined) 312 Define exactly one of 313 CONFIG_CMA101, CONFIG_CMA102 314 315- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 316 Define one or more of 317 CONFIG_CMA302 318 319- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 320 Define one or more of 321 CONFIG_LCD_HEARTBEAT - update a character position on 322 the LCD display every second with 323 a "rotator" |\-/|\-/ 324 325- Board flavour: (if CONFIG_MPC8260ADS is defined) 326 CONFIG_ADSTYPE 327 Possible values are: 328 CONFIG_SYS_8260ADS - original MPC8260ADS 329 CONFIG_SYS_8266ADS - MPC8266ADS 330 CONFIG_SYS_PQ2FADS - PQ2FADS-ZU or PQ2FADS-VR 331 CONFIG_SYS_8272ADS - MPC8272ADS 332 333- Marvell Family Member 334 CONFIG_SYS_MVFS - define it if you want to enable 335 multiple fs option at one time 336 for marvell soc family 337 338- MPC824X Family Member (if CONFIG_MPC824X is defined) 339 Define exactly one of 340 CONFIG_MPC8240, CONFIG_MPC8245 341 342- 8xx CPU Options: (if using an MPC8xx CPU) 343 CONFIG_8xx_GCLK_FREQ - deprecated: CPU clock if 344 get_gclk_freq() cannot work 345 e.g. if there is no 32KHz 346 reference PIT/RTC clock 347 CONFIG_8xx_OSCLK - PLL input clock (either EXTCLK 348 or XTAL/EXTAL) 349 350- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU): 351 CONFIG_SYS_8xx_CPUCLK_MIN 352 CONFIG_SYS_8xx_CPUCLK_MAX 353 CONFIG_8xx_CPUCLK_DEFAULT 354 See doc/README.MPC866 355 356 CONFIG_SYS_MEASURE_CPUCLK 357 358 Define this to measure the actual CPU clock instead 359 of relying on the correctness of the configured 360 values. Mostly useful for board bringup to make sure 361 the PLL is locked at the intended frequency. Note 362 that this requires a (stable) reference clock (32 kHz 363 RTC clock or CONFIG_SYS_8XX_XIN) 364 365 CONFIG_SYS_DELAYED_ICACHE 366 367 Define this option if you want to enable the 368 ICache only when Code runs from RAM. 369 370- 85xx CPU Options: 371 CONFIG_SYS_PPC64 372 373 Specifies that the core is a 64-bit PowerPC implementation (implements 374 the "64" category of the Power ISA). This is necessary for ePAPR 375 compliance, among other possible reasons. 376 377 CONFIG_SYS_FSL_TBCLK_DIV 378 379 Defines the core time base clock divider ratio compared to the 380 system clock. On most PQ3 devices this is 8, on newer QorIQ 381 devices it can be 16 or 32. The ratio varies from SoC to Soc. 382 383 CONFIG_SYS_FSL_PCIE_COMPAT 384 385 Defines the string to utilize when trying to match PCIe device 386 tree nodes for the given platform. 387 388 CONFIG_SYS_PPC_E500_DEBUG_TLB 389 390 Enables a temporary TLB entry to be used during boot to work 391 around limitations in e500v1 and e500v2 external debugger 392 support. This reduces the portions of the boot code where 393 breakpoints and single stepping do not work. The value of this 394 symbol should be set to the TLB1 entry to be used for this 395 purpose. 396 397 CONFIG_SYS_FSL_ERRATUM_A004510 398 399 Enables a workaround for erratum A004510. If set, 400 then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and 401 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set. 402 403 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV 404 CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional) 405 406 Defines one or two SoC revisions (low 8 bits of SVR) 407 for which the A004510 workaround should be applied. 408 409 The rest of SVR is either not relevant to the decision 410 of whether the erratum is present (e.g. p2040 versus 411 p2041) or is implied by the build target, which controls 412 whether CONFIG_SYS_FSL_ERRATUM_A004510 is set. 413 414 See Freescale App Note 4493 for more information about 415 this erratum. 416 417 CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY 418 419 This is the value to write into CCSR offset 0x18600 420 according to the A004510 workaround. 421 422- Generic CPU options: 423 CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN 424 425 Defines the endianess of the CPU. Implementation of those 426 values is arch specific. 427 428- Intel Monahans options: 429 CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO 430 431 Defines the Monahans run mode to oscillator 432 ratio. Valid values are 8, 16, 24, 31. The core 433 frequency is this value multiplied by 13 MHz. 434 435 CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO 436 437 Defines the Monahans turbo mode to oscillator 438 ratio. Valid values are 1 (default if undefined) and 439 2. The core frequency as calculated above is multiplied 440 by this value. 441 442- MIPS CPU options: 443 CONFIG_SYS_INIT_SP_OFFSET 444 445 Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack 446 pointer. This is needed for the temporary stack before 447 relocation. 448 449 CONFIG_SYS_MIPS_CACHE_MODE 450 451 Cache operation mode for the MIPS CPU. 452 See also arch/mips/include/asm/mipsregs.h. 453 Possible values are: 454 CONF_CM_CACHABLE_NO_WA 455 CONF_CM_CACHABLE_WA 456 CONF_CM_UNCACHED 457 CONF_CM_CACHABLE_NONCOHERENT 458 CONF_CM_CACHABLE_CE 459 CONF_CM_CACHABLE_COW 460 CONF_CM_CACHABLE_CUW 461 CONF_CM_CACHABLE_ACCELERATED 462 463 CONFIG_SYS_XWAY_EBU_BOOTCFG 464 465 Special option for Lantiq XWAY SoCs for booting from NOR flash. 466 See also arch/mips/cpu/mips32/start.S. 467 468 CONFIG_XWAY_SWAP_BYTES 469 470 Enable compilation of tools/xway-swap-bytes needed for Lantiq 471 XWAY SoCs for booting from NOR flash. The U-Boot image needs to 472 be swapped if a flash programmer is used. 473 474- ARM options: 475 CONFIG_SYS_EXCEPTION_VECTORS_HIGH 476 477 Select high exception vectors of the ARM core, e.g., do not 478 clear the V bit of the c1 register of CP15. 479 480 CONFIG_SYS_THUMB_BUILD 481 482 Use this flag to build U-Boot using the Thumb instruction 483 set for ARM architectures. Thumb instruction set provides 484 better code density. For ARM architectures that support 485 Thumb2 this flag will result in Thumb2 code generated by 486 GCC. 487 488- Linux Kernel Interface: 489 CONFIG_CLOCKS_IN_MHZ 490 491 U-Boot stores all clock information in Hz 492 internally. For binary compatibility with older Linux 493 kernels (which expect the clocks passed in the 494 bd_info data to be in MHz) the environment variable 495 "clocks_in_mhz" can be defined so that U-Boot 496 converts clock data to MHZ before passing it to the 497 Linux kernel. 498 When CONFIG_CLOCKS_IN_MHZ is defined, a definition of 499 "clocks_in_mhz=1" is automatically included in the 500 default environment. 501 502 CONFIG_MEMSIZE_IN_BYTES [relevant for MIPS only] 503 504 When transferring memsize parameter to linux, some versions 505 expect it to be in bytes, others in MB. 506 Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes. 507 508 CONFIG_OF_LIBFDT 509 510 New kernel versions are expecting firmware settings to be 511 passed using flattened device trees (based on open firmware 512 concepts). 513 514 CONFIG_OF_LIBFDT 515 * New libfdt-based support 516 * Adds the "fdt" command 517 * The bootm command automatically updates the fdt 518 519 OF_CPU - The proper name of the cpus node (only required for 520 MPC512X and MPC5xxx based boards). 521 OF_SOC - The proper name of the soc node (only required for 522 MPC512X and MPC5xxx based boards). 523 OF_TBCLK - The timebase frequency. 524 OF_STDOUT_PATH - The path to the console device 525 526 boards with QUICC Engines require OF_QE to set UCC MAC 527 addresses 528 529 CONFIG_OF_BOARD_SETUP 530 531 Board code has addition modification that it wants to make 532 to the flat device tree before handing it off to the kernel 533 534 CONFIG_OF_BOOT_CPU 535 536 This define fills in the correct boot CPU in the boot 537 param header, the default value is zero if undefined. 538 539 CONFIG_OF_IDE_FIXUP 540 541 U-Boot can detect if an IDE device is present or not. 542 If not, and this new config option is activated, U-Boot 543 removes the ATA node from the DTS before booting Linux, 544 so the Linux IDE driver does not probe the device and 545 crash. This is needed for buggy hardware (uc101) where 546 no pull down resistor is connected to the signal IDE5V_DD7. 547 548 CONFIG_MACH_TYPE [relevant for ARM only][mandatory] 549 550 This setting is mandatory for all boards that have only one 551 machine type and must be used to specify the machine type 552 number as it appears in the ARM machine registry 553 (see http://www.arm.linux.org.uk/developer/machines/). 554 Only boards that have multiple machine types supported 555 in a single configuration file and the machine type is 556 runtime discoverable, do not have to use this setting. 557 558- vxWorks boot parameters: 559 560 bootvx constructs a valid bootline using the following 561 environments variables: bootfile, ipaddr, serverip, hostname. 562 It loads the vxWorks image pointed bootfile. 563 564 CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name 565 CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address 566 CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server 567 CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters 568 569 CONFIG_SYS_VXWORKS_ADD_PARAMS 570 571 Add it at the end of the bootline. E.g "u=username pw=secret" 572 573 Note: If a "bootargs" environment is defined, it will overwride 574 the defaults discussed just above. 575 576- Cache Configuration: 577 CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot 578 CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot 579 CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot 580 581- Cache Configuration for ARM: 582 CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache 583 controller 584 CONFIG_SYS_PL310_BASE - Physical base address of PL310 585 controller register space 586 587- Serial Ports: 588 CONFIG_PL010_SERIAL 589 590 Define this if you want support for Amba PrimeCell PL010 UARTs. 591 592 CONFIG_PL011_SERIAL 593 594 Define this if you want support for Amba PrimeCell PL011 UARTs. 595 596 CONFIG_PL011_CLOCK 597 598 If you have Amba PrimeCell PL011 UARTs, set this variable to 599 the clock speed of the UARTs. 600 601 CONFIG_PL01x_PORTS 602 603 If you have Amba PrimeCell PL010 or PL011 UARTs on your board, 604 define this to a list of base addresses for each (supported) 605 port. See e.g. include/configs/versatile.h 606 607 CONFIG_PL011_SERIAL_RLCR 608 609 Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500) 610 have separate receive and transmit line control registers. Set 611 this variable to initialize the extra register. 612 613 CONFIG_PL011_SERIAL_FLUSH_ON_INIT 614 615 On some platforms (e.g. U8500) U-Boot is loaded by a second stage 616 boot loader that has already initialized the UART. Define this 617 variable to flush the UART at init time. 618 619 CONFIG_SYS_NS16550_BROKEN_TEMT 620 621 16550 UART set the Transmitter Empty (TEMT) Bit when all output 622 has finished and the transmitter is totally empty. U-Boot waits 623 for this bit to be set to initialize the serial console. On some 624 broken platforms this bit is not set in SPL making U-Boot to 625 hang while waiting for TEMT. Define this option to avoid it. 626 627 628- Console Interface: 629 Depending on board, define exactly one serial port 630 (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2, 631 CONFIG_8xx_CONS_SCC1, ...), or switch off the serial 632 console by defining CONFIG_8xx_CONS_NONE 633 634 Note: if CONFIG_8xx_CONS_NONE is defined, the serial 635 port routines must be defined elsewhere 636 (i.e. serial_init(), serial_getc(), ...) 637 638 CONFIG_CFB_CONSOLE 639 Enables console device for a color framebuffer. Needs following 640 defines (cf. smiLynxEM, i8042) 641 VIDEO_FB_LITTLE_ENDIAN graphic memory organisation 642 (default big endian) 643 VIDEO_HW_RECTFILL graphic chip supports 644 rectangle fill 645 (cf. smiLynxEM) 646 VIDEO_HW_BITBLT graphic chip supports 647 bit-blit (cf. smiLynxEM) 648 VIDEO_VISIBLE_COLS visible pixel columns 649 (cols=pitch) 650 VIDEO_VISIBLE_ROWS visible pixel rows 651 VIDEO_PIXEL_SIZE bytes per pixel 652 VIDEO_DATA_FORMAT graphic data format 653 (0-5, cf. cfb_console.c) 654 VIDEO_FB_ADRS framebuffer address 655 VIDEO_KBD_INIT_FCT keyboard int fct 656 (i.e. i8042_kbd_init()) 657 VIDEO_TSTC_FCT test char fct 658 (i.e. i8042_tstc) 659 VIDEO_GETC_FCT get char fct 660 (i.e. i8042_getc) 661 CONFIG_CONSOLE_CURSOR cursor drawing on/off 662 (requires blink timer 663 cf. i8042.c) 664 CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c) 665 CONFIG_CONSOLE_TIME display time/date info in 666 upper right corner 667 (requires CONFIG_CMD_DATE) 668 CONFIG_VIDEO_LOGO display Linux logo in 669 upper left corner 670 CONFIG_VIDEO_BMP_LOGO use bmp_logo.h instead of 671 linux_logo.h for logo. 672 Requires CONFIG_VIDEO_LOGO 673 CONFIG_CONSOLE_EXTRA_INFO 674 additional board info beside 675 the logo 676 677 When CONFIG_CFB_CONSOLE_ANSI is defined, console will support 678 a limited number of ANSI escape sequences (cursor control, 679 erase functions and limited graphics rendition control). 680 681 When CONFIG_CFB_CONSOLE is defined, video console is 682 default i/o. Serial console can be forced with 683 environment 'console=serial'. 684 685 When CONFIG_SILENT_CONSOLE is defined, all console 686 messages (by U-Boot and Linux!) can be silenced with 687 the "silent" environment variable. See 688 doc/README.silent for more information. 689 690- Console Baudrate: 691 CONFIG_BAUDRATE - in bps 692 Select one of the baudrates listed in 693 CONFIG_SYS_BAUDRATE_TABLE, see below. 694 CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale 695 696- Console Rx buffer length 697 With CONFIG_SYS_SMC_RXBUFLEN it is possible to define 698 the maximum receive buffer length for the SMC. 699 This option is actual only for 82xx and 8xx possible. 700 If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE 701 must be defined, to setup the maximum idle timeout for 702 the SMC. 703 704- Pre-Console Buffer: 705 Prior to the console being initialised (i.e. serial UART 706 initialised etc) all console output is silently discarded. 707 Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to 708 buffer any console messages prior to the console being 709 initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ 710 bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is 711 a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ 712 bytes are output before the console is initialised, the 713 earlier bytes are discarded. 714 715 'Sane' compilers will generate smaller code if 716 CONFIG_PRE_CON_BUF_SZ is a power of 2 717 718- Safe printf() functions 719 Define CONFIG_SYS_VSNPRINTF to compile in safe versions of 720 the printf() functions. These are defined in 721 include/vsprintf.h and include snprintf(), vsnprintf() and 722 so on. Code size increase is approximately 300-500 bytes. 723 If this option is not given then these functions will 724 silently discard their buffer size argument - this means 725 you are not getting any overflow checking in this case. 726 727- Boot Delay: CONFIG_BOOTDELAY - in seconds 728 Delay before automatically booting the default image; 729 set to -1 to disable autoboot. 730 set to -2 to autoboot with no delay and not check for abort 731 (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined). 732 733 See doc/README.autoboot for these options that 734 work with CONFIG_BOOTDELAY. None are required. 735 CONFIG_BOOT_RETRY_TIME 736 CONFIG_BOOT_RETRY_MIN 737 CONFIG_AUTOBOOT_KEYED 738 CONFIG_AUTOBOOT_PROMPT 739 CONFIG_AUTOBOOT_DELAY_STR 740 CONFIG_AUTOBOOT_STOP_STR 741 CONFIG_AUTOBOOT_DELAY_STR2 742 CONFIG_AUTOBOOT_STOP_STR2 743 CONFIG_ZERO_BOOTDELAY_CHECK 744 CONFIG_RESET_TO_RETRY 745 746- Autoboot Command: 747 CONFIG_BOOTCOMMAND 748 Only needed when CONFIG_BOOTDELAY is enabled; 749 define a command string that is automatically executed 750 when no character is read on the console interface 751 within "Boot Delay" after reset. 752 753 CONFIG_BOOTARGS 754 This can be used to pass arguments to the bootm 755 command. The value of CONFIG_BOOTARGS goes into the 756 environment value "bootargs". 757 758 CONFIG_RAMBOOT and CONFIG_NFSBOOT 759 The value of these goes into the environment as 760 "ramboot" and "nfsboot" respectively, and can be used 761 as a convenience, when switching between booting from 762 RAM and NFS. 763 764- Pre-Boot Commands: 765 CONFIG_PREBOOT 766 767 When this option is #defined, the existence of the 768 environment variable "preboot" will be checked 769 immediately before starting the CONFIG_BOOTDELAY 770 countdown and/or running the auto-boot command resp. 771 entering interactive mode. 772 773 This feature is especially useful when "preboot" is 774 automatically generated or modified. For an example 775 see the LWMON board specific code: here "preboot" is 776 modified when the user holds down a certain 777 combination of keys on the (special) keyboard when 778 booting the systems 779 780- Serial Download Echo Mode: 781 CONFIG_LOADS_ECHO 782 If defined to 1, all characters received during a 783 serial download (using the "loads" command) are 784 echoed back. This might be needed by some terminal 785 emulations (like "cu"), but may as well just take 786 time on others. This setting #define's the initial 787 value of the "loads_echo" environment variable. 788 789- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined) 790 CONFIG_KGDB_BAUDRATE 791 Select one of the baudrates listed in 792 CONFIG_SYS_BAUDRATE_TABLE, see below. 793 794- Monitor Functions: 795 Monitor commands can be included or excluded 796 from the build by using the #include files 797 <config_cmd_all.h> and #undef'ing unwanted 798 commands, or using <config_cmd_default.h> 799 and augmenting with additional #define's 800 for wanted commands. 801 802 The default command configuration includes all commands 803 except those marked below with a "*". 804 805 CONFIG_CMD_ASKENV * ask for env variable 806 CONFIG_CMD_BDI bdinfo 807 CONFIG_CMD_BEDBUG * Include BedBug Debugger 808 CONFIG_CMD_BMP * BMP support 809 CONFIG_CMD_BSP * Board specific commands 810 CONFIG_CMD_BOOTD bootd 811 CONFIG_CMD_CACHE * icache, dcache 812 CONFIG_CMD_CONSOLE coninfo 813 CONFIG_CMD_CRC32 * crc32 814 CONFIG_CMD_DATE * support for RTC, date/time... 815 CONFIG_CMD_DHCP * DHCP support 816 CONFIG_CMD_DIAG * Diagnostics 817 CONFIG_CMD_DS4510 * ds4510 I2C gpio commands 818 CONFIG_CMD_DS4510_INFO * ds4510 I2C info command 819 CONFIG_CMD_DS4510_MEM * ds4510 I2C eeprom/sram commansd 820 CONFIG_CMD_DS4510_RST * ds4510 I2C rst command 821 CONFIG_CMD_DTT * Digital Therm and Thermostat 822 CONFIG_CMD_ECHO echo arguments 823 CONFIG_CMD_EDITENV edit env variable 824 CONFIG_CMD_EEPROM * EEPROM read/write support 825 CONFIG_CMD_ELF * bootelf, bootvx 826 CONFIG_CMD_ENV_CALLBACK * display details about env callbacks 827 CONFIG_CMD_ENV_FLAGS * display details about env flags 828 CONFIG_CMD_EXPORTENV * export the environment 829 CONFIG_CMD_EXT2 * ext2 command support 830 CONFIG_CMD_EXT4 * ext4 command support 831 CONFIG_CMD_SAVEENV saveenv 832 CONFIG_CMD_FDC * Floppy Disk Support 833 CONFIG_CMD_FAT * FAT command support 834 CONFIG_CMD_FDOS * Dos diskette Support 835 CONFIG_CMD_FLASH flinfo, erase, protect 836 CONFIG_CMD_FPGA FPGA device initialization support 837 CONFIG_CMD_GETTIME * Get time since boot 838 CONFIG_CMD_GO * the 'go' command (exec code) 839 CONFIG_CMD_GREPENV * search environment 840 CONFIG_CMD_HASH * calculate hash / digest 841 CONFIG_CMD_HWFLOW * RTS/CTS hw flow control 842 CONFIG_CMD_I2C * I2C serial bus support 843 CONFIG_CMD_IDE * IDE harddisk support 844 CONFIG_CMD_IMI iminfo 845 CONFIG_CMD_IMLS List all images found in NOR flash 846 CONFIG_CMD_IMLS_NAND List all images found in NAND flash 847 CONFIG_CMD_IMMAP * IMMR dump support 848 CONFIG_CMD_IMPORTENV * import an environment 849 CONFIG_CMD_INI * import data from an ini file into the env 850 CONFIG_CMD_IRQ * irqinfo 851 CONFIG_CMD_ITEST Integer/string test of 2 values 852 CONFIG_CMD_JFFS2 * JFFS2 Support 853 CONFIG_CMD_KGDB * kgdb 854 CONFIG_CMD_LDRINFO ldrinfo (display Blackfin loader) 855 CONFIG_CMD_LINK_LOCAL * link-local IP address auto-configuration 856 (169.254.*.*) 857 CONFIG_CMD_LOADB loadb 858 CONFIG_CMD_LOADS loads 859 CONFIG_CMD_MD5SUM print md5 message digest 860 (requires CONFIG_CMD_MEMORY and CONFIG_MD5) 861 CONFIG_CMD_MEMINFO * Display detailed memory information 862 CONFIG_CMD_MEMORY md, mm, nm, mw, cp, cmp, crc, base, 863 loop, loopw, mtest 864 CONFIG_CMD_MISC Misc functions like sleep etc 865 CONFIG_CMD_MMC * MMC memory mapped support 866 CONFIG_CMD_MII * MII utility commands 867 CONFIG_CMD_MTDPARTS * MTD partition support 868 CONFIG_CMD_NAND * NAND support 869 CONFIG_CMD_NET bootp, tftpboot, rarpboot 870 CONFIG_CMD_PCA953X * PCA953x I2C gpio commands 871 CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command 872 CONFIG_CMD_PCI * pciinfo 873 CONFIG_CMD_PCMCIA * PCMCIA support 874 CONFIG_CMD_PING * send ICMP ECHO_REQUEST to network 875 host 876 CONFIG_CMD_PORTIO * Port I/O 877 CONFIG_CMD_READ * Read raw data from partition 878 CONFIG_CMD_REGINFO * Register dump 879 CONFIG_CMD_RUN run command in env variable 880 CONFIG_CMD_SANDBOX * sb command to access sandbox features 881 CONFIG_CMD_SAVES * save S record dump 882 CONFIG_CMD_SCSI * SCSI Support 883 CONFIG_CMD_SDRAM * print SDRAM configuration information 884 (requires CONFIG_CMD_I2C) 885 CONFIG_CMD_SETGETDCR Support for DCR Register access 886 (4xx only) 887 CONFIG_CMD_SF * Read/write/erase SPI NOR flash 888 CONFIG_CMD_SHA1SUM print sha1 memory digest 889 (requires CONFIG_CMD_MEMORY) 890 CONFIG_CMD_SOURCE "source" command Support 891 CONFIG_CMD_SPI * SPI serial bus support 892 CONFIG_CMD_TFTPSRV * TFTP transfer in server mode 893 CONFIG_CMD_TFTPPUT * TFTP put command (upload) 894 CONFIG_CMD_TIME * run command and report execution time (ARM specific) 895 CONFIG_CMD_TIMER * access to the system tick timer 896 CONFIG_CMD_USB * USB support 897 CONFIG_CMD_CDP * Cisco Discover Protocol support 898 CONFIG_CMD_MFSL * Microblaze FSL support 899 900 901 EXAMPLE: If you want all functions except of network 902 support you can write: 903 904 #include "config_cmd_all.h" 905 #undef CONFIG_CMD_NET 906 907 Other Commands: 908 fdt (flattened device tree) command: CONFIG_OF_LIBFDT 909 910 Note: Don't enable the "icache" and "dcache" commands 911 (configuration option CONFIG_CMD_CACHE) unless you know 912 what you (and your U-Boot users) are doing. Data 913 cache cannot be enabled on systems like the 8xx or 914 8260 (where accesses to the IMMR region must be 915 uncached), and it cannot be disabled on all other 916 systems where we (mis-) use the data cache to hold an 917 initial stack and some data. 918 919 920 XXX - this list needs to get updated! 921 922- Device tree: 923 CONFIG_OF_CONTROL 924 If this variable is defined, U-Boot will use a device tree 925 to configure its devices, instead of relying on statically 926 compiled #defines in the board file. This option is 927 experimental and only available on a few boards. The device 928 tree is available in the global data as gd->fdt_blob. 929 930 U-Boot needs to get its device tree from somewhere. This can 931 be done using one of the two options below: 932 933 CONFIG_OF_EMBED 934 If this variable is defined, U-Boot will embed a device tree 935 binary in its image. This device tree file should be in the 936 board directory and called <soc>-<board>.dts. The binary file 937 is then picked up in board_init_f() and made available through 938 the global data structure as gd->blob. 939 940 CONFIG_OF_SEPARATE 941 If this variable is defined, U-Boot will build a device tree 942 binary. It will be called u-boot.dtb. Architecture-specific 943 code will locate it at run-time. Generally this works by: 944 945 cat u-boot.bin u-boot.dtb >image.bin 946 947 and in fact, U-Boot does this for you, creating a file called 948 u-boot-dtb.bin which is useful in the common case. You can 949 still use the individual files if you need something more 950 exotic. 951 952- Watchdog: 953 CONFIG_WATCHDOG 954 If this variable is defined, it enables watchdog 955 support for the SoC. There must be support in the SoC 956 specific code for a watchdog. For the 8xx and 8260 957 CPUs, the SIU Watchdog feature is enabled in the SYPCR 958 register. When supported for a specific SoC is 959 available, then no further board specific code should 960 be needed to use it. 961 962 CONFIG_HW_WATCHDOG 963 When using a watchdog circuitry external to the used 964 SoC, then define this variable and provide board 965 specific code for the "hw_watchdog_reset" function. 966 967- U-Boot Version: 968 CONFIG_VERSION_VARIABLE 969 If this variable is defined, an environment variable 970 named "ver" is created by U-Boot showing the U-Boot 971 version as printed by the "version" command. 972 Any change to this variable will be reverted at the 973 next reset. 974 975- Real-Time Clock: 976 977 When CONFIG_CMD_DATE is selected, the type of the RTC 978 has to be selected, too. Define exactly one of the 979 following options: 980 981 CONFIG_RTC_MPC8xx - use internal RTC of MPC8xx 982 CONFIG_RTC_PCF8563 - use Philips PCF8563 RTC 983 CONFIG_RTC_MC13XXX - use MC13783 or MC13892 RTC 984 CONFIG_RTC_MC146818 - use MC146818 RTC 985 CONFIG_RTC_DS1307 - use Maxim, Inc. DS1307 RTC 986 CONFIG_RTC_DS1337 - use Maxim, Inc. DS1337 RTC 987 CONFIG_RTC_DS1338 - use Maxim, Inc. DS1338 RTC 988 CONFIG_RTC_DS164x - use Dallas DS164x RTC 989 CONFIG_RTC_ISL1208 - use Intersil ISL1208 RTC 990 CONFIG_RTC_MAX6900 - use Maxim, Inc. MAX6900 RTC 991 CONFIG_SYS_RTC_DS1337_NOOSC - Turn off the OSC output for DS1337 992 CONFIG_SYS_RV3029_TCR - enable trickle charger on 993 RV3029 RTC. 994 995 Note that if the RTC uses I2C, then the I2C interface 996 must also be configured. See I2C Support, below. 997 998- GPIO Support: 999 CONFIG_PCA953X - use NXP's PCA953X series I2C GPIO 1000 CONFIG_PCA953X_INFO - enable pca953x info command 1001 1002 The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of 1003 chip-ngpio pairs that tell the PCA953X driver the number of 1004 pins supported by a particular chip. 1005 1006 Note that if the GPIO device uses I2C, then the I2C interface 1007 must also be configured. See I2C Support, below. 1008 1009- Timestamp Support: 1010 1011 When CONFIG_TIMESTAMP is selected, the timestamp 1012 (date and time) of an image is printed by image 1013 commands like bootm or iminfo. This option is 1014 automatically enabled when you select CONFIG_CMD_DATE . 1015 1016- Partition Labels (disklabels) Supported: 1017 Zero or more of the following: 1018 CONFIG_MAC_PARTITION Apple's MacOS partition table. 1019 CONFIG_DOS_PARTITION MS Dos partition table, traditional on the 1020 Intel architecture, USB sticks, etc. 1021 CONFIG_ISO_PARTITION ISO partition table, used on CDROM etc. 1022 CONFIG_EFI_PARTITION GPT partition table, common when EFI is the 1023 bootloader. Note 2TB partition limit; see 1024 disk/part_efi.c 1025 CONFIG_MTD_PARTITIONS Memory Technology Device partition table. 1026 1027 If IDE or SCSI support is enabled (CONFIG_CMD_IDE or 1028 CONFIG_CMD_SCSI) you must configure support for at 1029 least one non-MTD partition type as well. 1030 1031- IDE Reset method: 1032 CONFIG_IDE_RESET_ROUTINE - this is defined in several 1033 board configurations files but used nowhere! 1034 1035 CONFIG_IDE_RESET - is this is defined, IDE Reset will 1036 be performed by calling the function 1037 ide_set_reset(int reset) 1038 which has to be defined in a board specific file 1039 1040- ATAPI Support: 1041 CONFIG_ATAPI 1042 1043 Set this to enable ATAPI support. 1044 1045- LBA48 Support 1046 CONFIG_LBA48 1047 1048 Set this to enable support for disks larger than 137GB 1049 Also look at CONFIG_SYS_64BIT_LBA. 1050 Whithout these , LBA48 support uses 32bit variables and will 'only' 1051 support disks up to 2.1TB. 1052 1053 CONFIG_SYS_64BIT_LBA: 1054 When enabled, makes the IDE subsystem use 64bit sector addresses. 1055 Default is 32bit. 1056 1057- SCSI Support: 1058 At the moment only there is only support for the 1059 SYM53C8XX SCSI controller; define 1060 CONFIG_SCSI_SYM53C8XX to enable it. 1061 1062 CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and 1063 CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID * 1064 CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the 1065 maximum numbers of LUNs, SCSI ID's and target 1066 devices. 1067 CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz) 1068 1069 The environment variable 'scsidevs' is set to the number of 1070 SCSI devices found during the last scan. 1071 1072- NETWORK Support (PCI): 1073 CONFIG_E1000 1074 Support for Intel 8254x/8257x gigabit chips. 1075 1076 CONFIG_E1000_SPI 1077 Utility code for direct access to the SPI bus on Intel 8257x. 1078 This does not do anything useful unless you set at least one 1079 of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC. 1080 1081 CONFIG_E1000_SPI_GENERIC 1082 Allow generic access to the SPI bus on the Intel 8257x, for 1083 example with the "sspi" command. 1084 1085 CONFIG_CMD_E1000 1086 Management command for E1000 devices. When used on devices 1087 with SPI support you can reprogram the EEPROM from U-Boot. 1088 1089 CONFIG_E1000_FALLBACK_MAC 1090 default MAC for empty EEPROM after production. 1091 1092 CONFIG_EEPRO100 1093 Support for Intel 82557/82559/82559ER chips. 1094 Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM 1095 write routine for first time initialisation. 1096 1097 CONFIG_TULIP 1098 Support for Digital 2114x chips. 1099 Optional CONFIG_TULIP_SELECT_MEDIA for board specific 1100 modem chip initialisation (KS8761/QS6611). 1101 1102 CONFIG_NATSEMI 1103 Support for National dp83815 chips. 1104 1105 CONFIG_NS8382X 1106 Support for National dp8382[01] gigabit chips. 1107 1108- NETWORK Support (other): 1109 1110 CONFIG_DRIVER_AT91EMAC 1111 Support for AT91RM9200 EMAC. 1112 1113 CONFIG_RMII 1114 Define this to use reduced MII inteface 1115 1116 CONFIG_DRIVER_AT91EMAC_QUIET 1117 If this defined, the driver is quiet. 1118 The driver doen't show link status messages. 1119 1120 CONFIG_CALXEDA_XGMAC 1121 Support for the Calxeda XGMAC device 1122 1123 CONFIG_LAN91C96 1124 Support for SMSC's LAN91C96 chips. 1125 1126 CONFIG_LAN91C96_BASE 1127 Define this to hold the physical address 1128 of the LAN91C96's I/O space 1129 1130 CONFIG_LAN91C96_USE_32_BIT 1131 Define this to enable 32 bit addressing 1132 1133 CONFIG_SMC91111 1134 Support for SMSC's LAN91C111 chip 1135 1136 CONFIG_SMC91111_BASE 1137 Define this to hold the physical address 1138 of the device (I/O space) 1139 1140 CONFIG_SMC_USE_32_BIT 1141 Define this if data bus is 32 bits 1142 1143 CONFIG_SMC_USE_IOFUNCS 1144 Define this to use i/o functions instead of macros 1145 (some hardware wont work with macros) 1146 1147 CONFIG_DRIVER_TI_EMAC 1148 Support for davinci emac 1149 1150 CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT 1151 Define this if you have more then 3 PHYs. 1152 1153 CONFIG_FTGMAC100 1154 Support for Faraday's FTGMAC100 Gigabit SoC Ethernet 1155 1156 CONFIG_FTGMAC100_EGIGA 1157 Define this to use GE link update with gigabit PHY. 1158 Define this if FTGMAC100 is connected to gigabit PHY. 1159 If your system has 10/100 PHY only, it might not occur 1160 wrong behavior. Because PHY usually return timeout or 1161 useless data when polling gigabit status and gigabit 1162 control registers. This behavior won't affect the 1163 correctnessof 10/100 link speed update. 1164 1165 CONFIG_SMC911X 1166 Support for SMSC's LAN911x and LAN921x chips 1167 1168 CONFIG_SMC911X_BASE 1169 Define this to hold the physical address 1170 of the device (I/O space) 1171 1172 CONFIG_SMC911X_32_BIT 1173 Define this if data bus is 32 bits 1174 1175 CONFIG_SMC911X_16_BIT 1176 Define this if data bus is 16 bits. If your processor 1177 automatically converts one 32 bit word to two 16 bit 1178 words you may also try CONFIG_SMC911X_32_BIT. 1179 1180 CONFIG_SH_ETHER 1181 Support for Renesas on-chip Ethernet controller 1182 1183 CONFIG_SH_ETHER_USE_PORT 1184 Define the number of ports to be used 1185 1186 CONFIG_SH_ETHER_PHY_ADDR 1187 Define the ETH PHY's address 1188 1189 CONFIG_SH_ETHER_CACHE_WRITEBACK 1190 If this option is set, the driver enables cache flush. 1191 1192- TPM Support: 1193 CONFIG_GENERIC_LPC_TPM 1194 Support for generic parallel port TPM devices. Only one device 1195 per system is supported at this time. 1196 1197 CONFIG_TPM_TIS_BASE_ADDRESS 1198 Base address where the generic TPM device is mapped 1199 to. Contemporary x86 systems usually map it at 1200 0xfed40000. 1201 1202- USB Support: 1203 At the moment only the UHCI host controller is 1204 supported (PIP405, MIP405, MPC5200); define 1205 CONFIG_USB_UHCI to enable it. 1206 define CONFIG_USB_KEYBOARD to enable the USB Keyboard 1207 and define CONFIG_USB_STORAGE to enable the USB 1208 storage devices. 1209 Note: 1210 Supported are USB Keyboards and USB Floppy drives 1211 (TEAC FD-05PUB). 1212 MPC5200 USB requires additional defines: 1213 CONFIG_USB_CLOCK 1214 for 528 MHz Clock: 0x0001bbbb 1215 CONFIG_PSC3_USB 1216 for USB on PSC3 1217 CONFIG_USB_CONFIG 1218 for differential drivers: 0x00001000 1219 for single ended drivers: 0x00005000 1220 for differential drivers on PSC3: 0x00000100 1221 for single ended drivers on PSC3: 0x00004100 1222 CONFIG_SYS_USB_EVENT_POLL 1223 May be defined to allow interrupt polling 1224 instead of using asynchronous interrupts 1225 1226 CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the 1227 txfilltuning field in the EHCI controller on reset. 1228 1229- USB Device: 1230 Define the below if you wish to use the USB console. 1231 Once firmware is rebuilt from a serial console issue the 1232 command "setenv stdin usbtty; setenv stdout usbtty" and 1233 attach your USB cable. The Unix command "dmesg" should print 1234 it has found a new device. The environment variable usbtty 1235 can be set to gserial or cdc_acm to enable your device to 1236 appear to a USB host as a Linux gserial device or a 1237 Common Device Class Abstract Control Model serial device. 1238 If you select usbtty = gserial you should be able to enumerate 1239 a Linux host by 1240 # modprobe usbserial vendor=0xVendorID product=0xProductID 1241 else if using cdc_acm, simply setting the environment 1242 variable usbtty to be cdc_acm should suffice. The following 1243 might be defined in YourBoardName.h 1244 1245 CONFIG_USB_DEVICE 1246 Define this to build a UDC device 1247 1248 CONFIG_USB_TTY 1249 Define this to have a tty type of device available to 1250 talk to the UDC device 1251 1252 CONFIG_USBD_HS 1253 Define this to enable the high speed support for usb 1254 device and usbtty. If this feature is enabled, a routine 1255 int is_usbd_high_speed(void) 1256 also needs to be defined by the driver to dynamically poll 1257 whether the enumeration has succeded at high speed or full 1258 speed. 1259 1260 CONFIG_SYS_CONSOLE_IS_IN_ENV 1261 Define this if you want stdin, stdout &/or stderr to 1262 be set to usbtty. 1263 1264 mpc8xx: 1265 CONFIG_SYS_USB_EXTC_CLK 0xBLAH 1266 Derive USB clock from external clock "blah" 1267 - CONFIG_SYS_USB_EXTC_CLK 0x02 1268 1269 CONFIG_SYS_USB_BRG_CLK 0xBLAH 1270 Derive USB clock from brgclk 1271 - CONFIG_SYS_USB_BRG_CLK 0x04 1272 1273 If you have a USB-IF assigned VendorID then you may wish to 1274 define your own vendor specific values either in BoardName.h 1275 or directly in usbd_vendor_info.h. If you don't define 1276 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 1277 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 1278 should pretend to be a Linux device to it's target host. 1279 1280 CONFIG_USBD_MANUFACTURER 1281 Define this string as the name of your company for 1282 - CONFIG_USBD_MANUFACTURER "my company" 1283 1284 CONFIG_USBD_PRODUCT_NAME 1285 Define this string as the name of your product 1286 - CONFIG_USBD_PRODUCT_NAME "acme usb device" 1287 1288 CONFIG_USBD_VENDORID 1289 Define this as your assigned Vendor ID from the USB 1290 Implementors Forum. This *must* be a genuine Vendor ID 1291 to avoid polluting the USB namespace. 1292 - CONFIG_USBD_VENDORID 0xFFFF 1293 1294 CONFIG_USBD_PRODUCTID 1295 Define this as the unique Product ID 1296 for your device 1297 - CONFIG_USBD_PRODUCTID 0xFFFF 1298 1299- ULPI Layer Support: 1300 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1301 the generic ULPI layer. The generic layer accesses the ULPI PHY 1302 via the platform viewport, so you need both the genric layer and 1303 the viewport enabled. Currently only Chipidea/ARC based 1304 viewport is supported. 1305 To enable the ULPI layer support, define CONFIG_USB_ULPI and 1306 CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 1307 If your ULPI phy needs a different reference clock than the 1308 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 1309 the appropriate value in Hz. 1310 1311- MMC Support: 1312 The MMC controller on the Intel PXA is supported. To 1313 enable this define CONFIG_MMC. The MMC can be 1314 accessed from the boot prompt by mapping the device 1315 to physical memory similar to flash. Command line is 1316 enabled with CONFIG_CMD_MMC. The MMC driver also works with 1317 the FAT fs. This is enabled with CONFIG_CMD_FAT. 1318 1319 CONFIG_SH_MMCIF 1320 Support for Renesas on-chip MMCIF controller 1321 1322 CONFIG_SH_MMCIF_ADDR 1323 Define the base address of MMCIF registers 1324 1325 CONFIG_SH_MMCIF_CLK 1326 Define the clock frequency for MMCIF 1327 1328- Journaling Flash filesystem support: 1329 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 1330 CONFIG_JFFS2_NAND_DEV 1331 Define these for a default partition on a NAND device 1332 1333 CONFIG_SYS_JFFS2_FIRST_SECTOR, 1334 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 1335 Define these for a default partition on a NOR device 1336 1337 CONFIG_SYS_JFFS_CUSTOM_PART 1338 Define this to create an own partition. You have to provide a 1339 function struct part_info* jffs2_part_info(int part_num) 1340 1341 If you define only one JFFS2 partition you may also want to 1342 #define CONFIG_SYS_JFFS_SINGLE_PART 1 1343 to disable the command chpart. This is the default when you 1344 have not defined a custom partition 1345 1346- FAT(File Allocation Table) filesystem write function support: 1347 CONFIG_FAT_WRITE 1348 1349 Define this to enable support for saving memory data as a 1350 file in FAT formatted partition. 1351 1352 This will also enable the command "fatwrite" enabling the 1353 user to write files to FAT. 1354 1355CBFS (Coreboot Filesystem) support 1356 CONFIG_CMD_CBFS 1357 1358 Define this to enable support for reading from a Coreboot 1359 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 1360 and cbfsload. 1361 1362- Keyboard Support: 1363 CONFIG_ISA_KEYBOARD 1364 1365 Define this to enable standard (PC-Style) keyboard 1366 support 1367 1368 CONFIG_I8042_KBD 1369 Standard PC keyboard driver with US (is default) and 1370 GERMAN key layout (switch via environment 'keymap=de') support. 1371 Export function i8042_kbd_init, i8042_tstc and i8042_getc 1372 for cfb_console. Supports cursor blinking. 1373 1374- Video support: 1375 CONFIG_VIDEO 1376 1377 Define this to enable video support (for output to 1378 video). 1379 1380 CONFIG_VIDEO_CT69000 1381 1382 Enable Chips & Technologies 69000 Video chip 1383 1384 CONFIG_VIDEO_SMI_LYNXEM 1385 Enable Silicon Motion SMI 712/710/810 Video chip. The 1386 video output is selected via environment 'videoout' 1387 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1388 assumed. 1389 1390 For the CT69000 and SMI_LYNXEM drivers, videomode is 1391 selected via environment 'videomode'. Two different ways 1392 are possible: 1393 - "videomode=num" 'num' is a standard LiLo mode numbers. 1394 Following standard modes are supported (* is default): 1395 1396 Colors 640x480 800x600 1024x768 1152x864 1280x1024 1397 -------------+--------------------------------------------- 1398 8 bits | 0x301* 0x303 0x305 0x161 0x307 1399 15 bits | 0x310 0x313 0x316 0x162 0x319 1400 16 bits | 0x311 0x314 0x317 0x163 0x31A 1401 24 bits | 0x312 0x315 0x318 ? 0x31B 1402 -------------+--------------------------------------------- 1403 (i.e. setenv videomode 317; saveenv; reset;) 1404 1405 - "videomode=bootargs" all the video parameters are parsed 1406 from the bootargs. (See drivers/video/videomodes.c) 1407 1408 1409 CONFIG_VIDEO_SED13806 1410 Enable Epson SED13806 driver. This driver supports 8bpp 1411 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1412 or CONFIG_VIDEO_SED13806_16BPP 1413 1414 CONFIG_FSL_DIU_FB 1415 Enable the Freescale DIU video driver. Reference boards for 1416 SOCs that have a DIU should define this macro to enable DIU 1417 support, and should also define these other macros: 1418 1419 CONFIG_SYS_DIU_ADDR 1420 CONFIG_VIDEO 1421 CONFIG_CMD_BMP 1422 CONFIG_CFB_CONSOLE 1423 CONFIG_VIDEO_SW_CURSOR 1424 CONFIG_VGA_AS_SINGLE_DEVICE 1425 CONFIG_VIDEO_LOGO 1426 CONFIG_VIDEO_BMP_LOGO 1427 1428 The DIU driver will look for the 'video-mode' environment 1429 variable, and if defined, enable the DIU as a console during 1430 boot. See the documentation file README.video for a 1431 description of this variable. 1432 1433 CONFIG_VIDEO_VGA 1434 1435 Enable the VGA video / BIOS for x86. The alternative if you 1436 are using coreboot is to use the coreboot frame buffer 1437 driver. 1438 1439 1440- Keyboard Support: 1441 CONFIG_KEYBOARD 1442 1443 Define this to enable a custom keyboard support. 1444 This simply calls drv_keyboard_init() which must be 1445 defined in your board-specific files. 1446 The only board using this so far is RBC823. 1447 1448- LCD Support: CONFIG_LCD 1449 1450 Define this to enable LCD support (for output to LCD 1451 display); also select one of the supported displays 1452 by defining one of these: 1453 1454 CONFIG_ATMEL_LCD: 1455 1456 HITACHI TX09D70VM1CCA, 3.5", 240x320. 1457 1458 CONFIG_NEC_NL6448AC33: 1459 1460 NEC NL6448AC33-18. Active, color, single scan. 1461 1462 CONFIG_NEC_NL6448BC20 1463 1464 NEC NL6448BC20-08. 6.5", 640x480. 1465 Active, color, single scan. 1466 1467 CONFIG_NEC_NL6448BC33_54 1468 1469 NEC NL6448BC33-54. 10.4", 640x480. 1470 Active, color, single scan. 1471 1472 CONFIG_SHARP_16x9 1473 1474 Sharp 320x240. Active, color, single scan. 1475 It isn't 16x9, and I am not sure what it is. 1476 1477 CONFIG_SHARP_LQ64D341 1478 1479 Sharp LQ64D341 display, 640x480. 1480 Active, color, single scan. 1481 1482 CONFIG_HLD1045 1483 1484 HLD1045 display, 640x480. 1485 Active, color, single scan. 1486 1487 CONFIG_OPTREX_BW 1488 1489 Optrex CBL50840-2 NF-FW 99 22 M5 1490 or 1491 Hitachi LMG6912RPFC-00T 1492 or 1493 Hitachi SP14Q002 1494 1495 320x240. Black & white. 1496 1497 Normally display is black on white background; define 1498 CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1499 1500 CONFIG_LCD_ALIGNMENT 1501 1502 Normally the LCD is page-aligned (tyically 4KB). If this is 1503 defined then the LCD will be aligned to this value instead. 1504 For ARM it is sometimes useful to use MMU_SECTION_SIZE 1505 here, since it is cheaper to change data cache settings on 1506 a per-section basis. 1507 1508 CONFIG_CONSOLE_SCROLL_LINES 1509 1510 When the console need to be scrolled, this is the number of 1511 lines to scroll by. It defaults to 1. Increasing this makes 1512 the console jump but can help speed up operation when scrolling 1513 is slow. 1514 1515 CONFIG_LCD_BMP_RLE8 1516 1517 Support drawing of RLE8-compressed bitmaps on the LCD. 1518 1519 CONFIG_I2C_EDID 1520 1521 Enables an 'i2c edid' command which can read EDID 1522 information over I2C from an attached LCD display. 1523 1524- Splash Screen Support: CONFIG_SPLASH_SCREEN 1525 1526 If this option is set, the environment is checked for 1527 a variable "splashimage". If found, the usual display 1528 of logo, copyright and system information on the LCD 1529 is suppressed and the BMP image at the address 1530 specified in "splashimage" is loaded instead. The 1531 console is redirected to the "nulldev", too. This 1532 allows for a "silent" boot where a splash screen is 1533 loaded very quickly after power-on. 1534 1535 CONFIG_SPLASHIMAGE_GUARD 1536 1537 If this option is set, then U-Boot will prevent the environment 1538 variable "splashimage" from being set to a problematic address 1539 (see README.displaying-bmps and README.arm-unaligned-accesses). 1540 This option is useful for targets where, due to alignment 1541 restrictions, an improperly aligned BMP image will cause a data 1542 abort. If you think you will not have problems with unaligned 1543 accesses (for example because your toolchain prevents them) 1544 there is no need to set this option. 1545 1546 CONFIG_SPLASH_SCREEN_ALIGN 1547 1548 If this option is set the splash image can be freely positioned 1549 on the screen. Environment variable "splashpos" specifies the 1550 position as "x,y". If a positive number is given it is used as 1551 number of pixel from left/top. If a negative number is given it 1552 is used as number of pixel from right/bottom. You can also 1553 specify 'm' for centering the image. 1554 1555 Example: 1556 setenv splashpos m,m 1557 => image at center of screen 1558 1559 setenv splashpos 30,20 1560 => image at x = 30 and y = 20 1561 1562 setenv splashpos -10,m 1563 => vertically centered image 1564 at x = dspWidth - bmpWidth - 9 1565 1566 CONFIG_SPLASH_SCREEN_PREPARE 1567 1568 If this option is set then the board_splash_screen_prepare() 1569 function, which must be defined in your code, is called as part 1570 of the splash screen display sequence. It gives the board an 1571 opportunity to prepare the splash image data before it is 1572 processed and sent to the frame buffer by U-Boot. 1573 1574- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 1575 1576 If this option is set, additionally to standard BMP 1577 images, gzipped BMP images can be displayed via the 1578 splashscreen support or the bmp command. 1579 1580- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1581 1582 If this option is set, 8-bit RLE compressed BMP images 1583 can be displayed via the splashscreen support or the 1584 bmp command. 1585 1586- Do compresssing for memory range: 1587 CONFIG_CMD_ZIP 1588 1589 If this option is set, it would use zlib deflate method 1590 to compress the specified memory at its best effort. 1591 1592- Compression support: 1593 CONFIG_BZIP2 1594 1595 If this option is set, support for bzip2 compressed 1596 images is included. If not, only uncompressed and gzip 1597 compressed images are supported. 1598 1599 NOTE: the bzip2 algorithm requires a lot of RAM, so 1600 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1601 be at least 4MB. 1602 1603 CONFIG_LZMA 1604 1605 If this option is set, support for lzma compressed 1606 images is included. 1607 1608 Note: The LZMA algorithm adds between 2 and 4KB of code and it 1609 requires an amount of dynamic memory that is given by the 1610 formula: 1611 1612 (1846 + 768 << (lc + lp)) * sizeof(uint16) 1613 1614 Where lc and lp stand for, respectively, Literal context bits 1615 and Literal pos bits. 1616 1617 This value is upper-bounded by 14MB in the worst case. Anyway, 1618 for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1619 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1620 a very small buffer. 1621 1622 Use the lzmainfo tool to determinate the lc and lp values and 1623 then calculate the amount of needed dynamic memory (ensuring 1624 the appropriate CONFIG_SYS_MALLOC_LEN value). 1625 1626- MII/PHY support: 1627 CONFIG_PHY_ADDR 1628 1629 The address of PHY on MII bus. 1630 1631 CONFIG_PHY_CLOCK_FREQ (ppc4xx) 1632 1633 The clock frequency of the MII bus 1634 1635 CONFIG_PHY_GIGE 1636 1637 If this option is set, support for speed/duplex 1638 detection of gigabit PHY is included. 1639 1640 CONFIG_PHY_RESET_DELAY 1641 1642 Some PHY like Intel LXT971A need extra delay after 1643 reset before any MII register access is possible. 1644 For such PHY, set this option to the usec delay 1645 required. (minimum 300usec for LXT971A) 1646 1647 CONFIG_PHY_CMD_DELAY (ppc4xx) 1648 1649 Some PHY like Intel LXT971A need extra delay after 1650 command issued before MII status register can be read 1651 1652- Ethernet address: 1653 CONFIG_ETHADDR 1654 CONFIG_ETH1ADDR 1655 CONFIG_ETH2ADDR 1656 CONFIG_ETH3ADDR 1657 CONFIG_ETH4ADDR 1658 CONFIG_ETH5ADDR 1659 1660 Define a default value for Ethernet address to use 1661 for the respective Ethernet interface, in case this 1662 is not determined automatically. 1663 1664- IP address: 1665 CONFIG_IPADDR 1666 1667 Define a default value for the IP address to use for 1668 the default Ethernet interface, in case this is not 1669 determined through e.g. bootp. 1670 (Environment variable "ipaddr") 1671 1672- Server IP address: 1673 CONFIG_SERVERIP 1674 1675 Defines a default value for the IP address of a TFTP 1676 server to contact when using the "tftboot" command. 1677 (Environment variable "serverip") 1678 1679 CONFIG_KEEP_SERVERADDR 1680 1681 Keeps the server's MAC address, in the env 'serveraddr' 1682 for passing to bootargs (like Linux's netconsole option) 1683 1684- Gateway IP address: 1685 CONFIG_GATEWAYIP 1686 1687 Defines a default value for the IP address of the 1688 default router where packets to other networks are 1689 sent to. 1690 (Environment variable "gatewayip") 1691 1692- Subnet mask: 1693 CONFIG_NETMASK 1694 1695 Defines a default value for the subnet mask (or 1696 routing prefix) which is used to determine if an IP 1697 address belongs to the local subnet or needs to be 1698 forwarded through a router. 1699 (Environment variable "netmask") 1700 1701- Multicast TFTP Mode: 1702 CONFIG_MCAST_TFTP 1703 1704 Defines whether you want to support multicast TFTP as per 1705 rfc-2090; for example to work with atftp. Lets lots of targets 1706 tftp down the same boot image concurrently. Note: the Ethernet 1707 driver in use must provide a function: mcast() to join/leave a 1708 multicast group. 1709 1710- BOOTP Recovery Mode: 1711 CONFIG_BOOTP_RANDOM_DELAY 1712 1713 If you have many targets in a network that try to 1714 boot using BOOTP, you may want to avoid that all 1715 systems send out BOOTP requests at precisely the same 1716 moment (which would happen for instance at recovery 1717 from a power failure, when all systems will try to 1718 boot, thus flooding the BOOTP server. Defining 1719 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1720 inserted before sending out BOOTP requests. The 1721 following delays are inserted then: 1722 1723 1st BOOTP request: delay 0 ... 1 sec 1724 2nd BOOTP request: delay 0 ... 2 sec 1725 3rd BOOTP request: delay 0 ... 4 sec 1726 4th and following 1727 BOOTP requests: delay 0 ... 8 sec 1728 1729- DHCP Advanced Options: 1730 You can fine tune the DHCP functionality by defining 1731 CONFIG_BOOTP_* symbols: 1732 1733 CONFIG_BOOTP_SUBNETMASK 1734 CONFIG_BOOTP_GATEWAY 1735 CONFIG_BOOTP_HOSTNAME 1736 CONFIG_BOOTP_NISDOMAIN 1737 CONFIG_BOOTP_BOOTPATH 1738 CONFIG_BOOTP_BOOTFILESIZE 1739 CONFIG_BOOTP_DNS 1740 CONFIG_BOOTP_DNS2 1741 CONFIG_BOOTP_SEND_HOSTNAME 1742 CONFIG_BOOTP_NTPSERVER 1743 CONFIG_BOOTP_TIMEOFFSET 1744 CONFIG_BOOTP_VENDOREX 1745 CONFIG_BOOTP_MAY_FAIL 1746 1747 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 1748 environment variable, not the BOOTP server. 1749 1750 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 1751 after the configured retry count, the call will fail 1752 instead of starting over. This can be used to fail over 1753 to Link-local IP address configuration if the DHCP server 1754 is not available. 1755 1756 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 1757 serverip from a DHCP server, it is possible that more 1758 than one DNS serverip is offered to the client. 1759 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 1760 serverip will be stored in the additional environment 1761 variable "dnsip2". The first DNS serverip is always 1762 stored in the variable "dnsip", when CONFIG_BOOTP_DNS 1763 is defined. 1764 1765 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 1766 to do a dynamic update of a DNS server. To do this, they 1767 need the hostname of the DHCP requester. 1768 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 1769 of the "hostname" environment variable is passed as 1770 option 12 to the DHCP server. 1771 1772 CONFIG_BOOTP_DHCP_REQUEST_DELAY 1773 1774 A 32bit value in microseconds for a delay between 1775 receiving a "DHCP Offer" and sending the "DHCP Request". 1776 This fixes a problem with certain DHCP servers that don't 1777 respond 100% of the time to a "DHCP request". E.g. On an 1778 AT91RM9200 processor running at 180MHz, this delay needed 1779 to be *at least* 15,000 usec before a Windows Server 2003 1780 DHCP server would reply 100% of the time. I recommend at 1781 least 50,000 usec to be safe. The alternative is to hope 1782 that one of the retries will be successful but note that 1783 the DHCP timeout and retry process takes a longer than 1784 this delay. 1785 1786 - Link-local IP address negotiation: 1787 Negotiate with other link-local clients on the local network 1788 for an address that doesn't require explicit configuration. 1789 This is especially useful if a DHCP server cannot be guaranteed 1790 to exist in all environments that the device must operate. 1791 1792 See doc/README.link-local for more information. 1793 1794 - CDP Options: 1795 CONFIG_CDP_DEVICE_ID 1796 1797 The device id used in CDP trigger frames. 1798 1799 CONFIG_CDP_DEVICE_ID_PREFIX 1800 1801 A two character string which is prefixed to the MAC address 1802 of the device. 1803 1804 CONFIG_CDP_PORT_ID 1805 1806 A printf format string which contains the ascii name of 1807 the port. Normally is set to "eth%d" which sets 1808 eth0 for the first Ethernet, eth1 for the second etc. 1809 1810 CONFIG_CDP_CAPABILITIES 1811 1812 A 32bit integer which indicates the device capabilities; 1813 0x00000010 for a normal host which does not forwards. 1814 1815 CONFIG_CDP_VERSION 1816 1817 An ascii string containing the version of the software. 1818 1819 CONFIG_CDP_PLATFORM 1820 1821 An ascii string containing the name of the platform. 1822 1823 CONFIG_CDP_TRIGGER 1824 1825 A 32bit integer sent on the trigger. 1826 1827 CONFIG_CDP_POWER_CONSUMPTION 1828 1829 A 16bit integer containing the power consumption of the 1830 device in .1 of milliwatts. 1831 1832 CONFIG_CDP_APPLIANCE_VLAN_TYPE 1833 1834 A byte containing the id of the VLAN. 1835 1836- Status LED: CONFIG_STATUS_LED 1837 1838 Several configurations allow to display the current 1839 status using a LED. For instance, the LED will blink 1840 fast while running U-Boot code, stop blinking as 1841 soon as a reply to a BOOTP request was received, and 1842 start blinking slow once the Linux kernel is running 1843 (supported by a status LED driver in the Linux 1844 kernel). Defining CONFIG_STATUS_LED enables this 1845 feature in U-Boot. 1846 1847- CAN Support: CONFIG_CAN_DRIVER 1848 1849 Defining CONFIG_CAN_DRIVER enables CAN driver support 1850 on those systems that support this (optional) 1851 feature, like the TQM8xxL modules. 1852 1853- I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C 1854 1855 These enable I2C serial bus commands. Defining either of 1856 (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will 1857 include the appropriate I2C driver for the selected CPU. 1858 1859 This will allow you to use i2c commands at the u-boot 1860 command line (as long as you set CONFIG_CMD_I2C in 1861 CONFIG_COMMANDS) and communicate with i2c based realtime 1862 clock chips. See common/cmd_i2c.c for a description of the 1863 command line interface. 1864 1865 CONFIG_HARD_I2C selects a hardware I2C controller. 1866 1867 CONFIG_SOFT_I2C configures u-boot to use a software (aka 1868 bit-banging) driver instead of CPM or similar hardware 1869 support for I2C. 1870 1871 There are several other quantities that must also be 1872 defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C. 1873 1874 In both cases you will need to define CONFIG_SYS_I2C_SPEED 1875 to be the frequency (in Hz) at which you wish your i2c bus 1876 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 1877 the CPU's i2c node address). 1878 1879 Now, the u-boot i2c code for the mpc8xx 1880 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 1881 and so its address should therefore be cleared to 0 (See, 1882 eg, MPC823e User's Manual p.16-473). So, set 1883 CONFIG_SYS_I2C_SLAVE to 0. 1884 1885 CONFIG_SYS_I2C_INIT_MPC5XXX 1886 1887 When a board is reset during an i2c bus transfer 1888 chips might think that the current transfer is still 1889 in progress. Reset the slave devices by sending start 1890 commands until the slave device responds. 1891 1892 That's all that's required for CONFIG_HARD_I2C. 1893 1894 If you use the software i2c interface (CONFIG_SOFT_I2C) 1895 then the following macros need to be defined (examples are 1896 from include/configs/lwmon.h): 1897 1898 I2C_INIT 1899 1900 (Optional). Any commands necessary to enable the I2C 1901 controller or configure ports. 1902 1903 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 1904 1905 I2C_PORT 1906 1907 (Only for MPC8260 CPU). The I/O port to use (the code 1908 assumes both bits are on the same port). Valid values 1909 are 0..3 for ports A..D. 1910 1911 I2C_ACTIVE 1912 1913 The code necessary to make the I2C data line active 1914 (driven). If the data line is open collector, this 1915 define can be null. 1916 1917 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 1918 1919 I2C_TRISTATE 1920 1921 The code necessary to make the I2C data line tri-stated 1922 (inactive). If the data line is open collector, this 1923 define can be null. 1924 1925 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 1926 1927 I2C_READ 1928 1929 Code that returns TRUE if the I2C data line is high, 1930 FALSE if it is low. 1931 1932 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 1933 1934 I2C_SDA(bit) 1935 1936 If <bit> is TRUE, sets the I2C data line high. If it 1937 is FALSE, it clears it (low). 1938 1939 eg: #define I2C_SDA(bit) \ 1940 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 1941 else immr->im_cpm.cp_pbdat &= ~PB_SDA 1942 1943 I2C_SCL(bit) 1944 1945 If <bit> is TRUE, sets the I2C clock line high. If it 1946 is FALSE, it clears it (low). 1947 1948 eg: #define I2C_SCL(bit) \ 1949 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 1950 else immr->im_cpm.cp_pbdat &= ~PB_SCL 1951 1952 I2C_DELAY 1953 1954 This delay is invoked four times per clock cycle so this 1955 controls the rate of data transfer. The data rate thus 1956 is 1 / (I2C_DELAY * 4). Often defined to be something 1957 like: 1958 1959 #define I2C_DELAY udelay(2) 1960 1961 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 1962 1963 If your arch supports the generic GPIO framework (asm/gpio.h), 1964 then you may alternatively define the two GPIOs that are to be 1965 used as SCL / SDA. Any of the previous I2C_xxx macros will 1966 have GPIO-based defaults assigned to them as appropriate. 1967 1968 You should define these to the GPIO value as given directly to 1969 the generic GPIO functions. 1970 1971 CONFIG_SYS_I2C_INIT_BOARD 1972 1973 When a board is reset during an i2c bus transfer 1974 chips might think that the current transfer is still 1975 in progress. On some boards it is possible to access 1976 the i2c SCLK line directly, either by using the 1977 processor pin as a GPIO or by having a second pin 1978 connected to the bus. If this option is defined a 1979 custom i2c_init_board() routine in boards/xxx/board.c 1980 is run early in the boot sequence. 1981 1982 CONFIG_SYS_I2C_BOARD_LATE_INIT 1983 1984 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 1985 defined a custom i2c_board_late_init() routine in 1986 boards/xxx/board.c is run AFTER the operations in i2c_init() 1987 is completed. This callpoint can be used to unreset i2c bus 1988 using CPU i2c controller register accesses for CPUs whose i2c 1989 controller provide such a method. It is called at the end of 1990 i2c_init() to allow i2c_init operations to setup the i2c bus 1991 controller on the CPU (e.g. setting bus speed & slave address). 1992 1993 CONFIG_I2CFAST (PPC405GP|PPC405EP only) 1994 1995 This option enables configuration of bi_iic_fast[] flags 1996 in u-boot bd_info structure based on u-boot environment 1997 variable "i2cfast". (see also i2cfast) 1998 1999 CONFIG_I2C_MULTI_BUS 2000 2001 This option allows the use of multiple I2C buses, each of which 2002 must have a controller. At any point in time, only one bus is 2003 active. To switch to a different bus, use the 'i2c dev' command. 2004 Note that bus numbering is zero-based. 2005 2006 CONFIG_SYS_I2C_NOPROBES 2007 2008 This option specifies a list of I2C devices that will be skipped 2009 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 2010 is set, specify a list of bus-device pairs. Otherwise, specify 2011 a 1D array of device addresses 2012 2013 e.g. 2014 #undef CONFIG_I2C_MULTI_BUS 2015 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2016 2017 will skip addresses 0x50 and 0x68 on a board with one I2C bus 2018 2019 #define CONFIG_I2C_MULTI_BUS 2020 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2021 2022 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2023 2024 CONFIG_SYS_SPD_BUS_NUM 2025 2026 If defined, then this indicates the I2C bus number for DDR SPD. 2027 If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2028 2029 CONFIG_SYS_RTC_BUS_NUM 2030 2031 If defined, then this indicates the I2C bus number for the RTC. 2032 If not defined, then U-Boot assumes that RTC is on I2C bus 0. 2033 2034 CONFIG_SYS_DTT_BUS_NUM 2035 2036 If defined, then this indicates the I2C bus number for the DTT. 2037 If not defined, then U-Boot assumes that DTT is on I2C bus 0. 2038 2039 CONFIG_SYS_I2C_DTT_ADDR: 2040 2041 If defined, specifies the I2C address of the DTT device. 2042 If not defined, then U-Boot uses predefined value for 2043 specified DTT device. 2044 2045 CONFIG_FSL_I2C 2046 2047 Define this option if you want to use Freescale's I2C driver in 2048 drivers/i2c/fsl_i2c.c. 2049 2050 CONFIG_I2C_MUX 2051 2052 Define this option if you have I2C devices reached over 1 .. n 2053 I2C Muxes like the pca9544a. This option addes a new I2C 2054 Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a 2055 new I2C Bus to the existing I2C Busses. If you select the 2056 new Bus with "i2c dev", u-bbot sends first the commandos for 2057 the muxes to activate this new "bus". 2058 2059 CONFIG_I2C_MULTI_BUS must be also defined, to use this 2060 feature! 2061 2062 Example: 2063 Adding a new I2C Bus reached over 2 pca9544a muxes 2064 The First mux with address 70 and channel 6 2065 The Second mux with address 71 and channel 4 2066 2067 => i2c bus pca9544a:70:6:pca9544a:71:4 2068 2069 Use the "i2c bus" command without parameter, to get a list 2070 of I2C Busses with muxes: 2071 2072 => i2c bus 2073 Busses reached over muxes: 2074 Bus ID: 2 2075 reached over Mux(es): 2076 pca9544a@70 ch: 4 2077 Bus ID: 3 2078 reached over Mux(es): 2079 pca9544a@70 ch: 6 2080 pca9544a@71 ch: 4 2081 => 2082 2083 If you now switch to the new I2C Bus 3 with "i2c dev 3" 2084 u-boot first sends the command to the mux@70 to enable 2085 channel 6, and then the command to the mux@71 to enable 2086 the channel 4. 2087 2088 After that, you can use the "normal" i2c commands as 2089 usual to communicate with your I2C devices behind 2090 the 2 muxes. 2091 2092 This option is actually implemented for the bitbanging 2093 algorithm in common/soft_i2c.c and for the Hardware I2C 2094 Bus on the MPC8260. But it should be not so difficult 2095 to add this option to other architectures. 2096 2097 CONFIG_SOFT_I2C_READ_REPEATED_START 2098 2099 defining this will force the i2c_read() function in 2100 the soft_i2c driver to perform an I2C repeated start 2101 between writing the address pointer and reading the 2102 data. If this define is omitted the default behaviour 2103 of doing a stop-start sequence will be used. Most I2C 2104 devices can use either method, but some require one or 2105 the other. 2106 2107- SPI Support: CONFIG_SPI 2108 2109 Enables SPI driver (so far only tested with 2110 SPI EEPROM, also an instance works with Crystal A/D and 2111 D/As on the SACSng board) 2112 2113 CONFIG_SH_SPI 2114 2115 Enables the driver for SPI controller on SuperH. Currently 2116 only SH7757 is supported. 2117 2118 CONFIG_SPI_X 2119 2120 Enables extended (16-bit) SPI EEPROM addressing. 2121 (symmetrical to CONFIG_I2C_X) 2122 2123 CONFIG_SOFT_SPI 2124 2125 Enables a software (bit-bang) SPI driver rather than 2126 using hardware support. This is a general purpose 2127 driver that only requires three general I/O port pins 2128 (two outputs, one input) to function. If this is 2129 defined, the board configuration must define several 2130 SPI configuration items (port pins to use, etc). For 2131 an example, see include/configs/sacsng.h. 2132 2133 CONFIG_HARD_SPI 2134 2135 Enables a hardware SPI driver for general-purpose reads 2136 and writes. As with CONFIG_SOFT_SPI, the board configuration 2137 must define a list of chip-select function pointers. 2138 Currently supported on some MPC8xxx processors. For an 2139 example, see include/configs/mpc8349emds.h. 2140 2141 CONFIG_MXC_SPI 2142 2143 Enables the driver for the SPI controllers on i.MX and MXC 2144 SoCs. Currently i.MX31/35/51 are supported. 2145 2146- FPGA Support: CONFIG_FPGA 2147 2148 Enables FPGA subsystem. 2149 2150 CONFIG_FPGA_<vendor> 2151 2152 Enables support for specific chip vendors. 2153 (ALTERA, XILINX) 2154 2155 CONFIG_FPGA_<family> 2156 2157 Enables support for FPGA family. 2158 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 2159 2160 CONFIG_FPGA_COUNT 2161 2162 Specify the number of FPGA devices to support. 2163 2164 CONFIG_SYS_FPGA_PROG_FEEDBACK 2165 2166 Enable printing of hash marks during FPGA configuration. 2167 2168 CONFIG_SYS_FPGA_CHECK_BUSY 2169 2170 Enable checks on FPGA configuration interface busy 2171 status by the configuration function. This option 2172 will require a board or device specific function to 2173 be written. 2174 2175 CONFIG_FPGA_DELAY 2176 2177 If defined, a function that provides delays in the FPGA 2178 configuration driver. 2179 2180 CONFIG_SYS_FPGA_CHECK_CTRLC 2181 Allow Control-C to interrupt FPGA configuration 2182 2183 CONFIG_SYS_FPGA_CHECK_ERROR 2184 2185 Check for configuration errors during FPGA bitfile 2186 loading. For example, abort during Virtex II 2187 configuration if the INIT_B line goes low (which 2188 indicated a CRC error). 2189 2190 CONFIG_SYS_FPGA_WAIT_INIT 2191 2192 Maximum time to wait for the INIT_B line to deassert 2193 after PROB_B has been deasserted during a Virtex II 2194 FPGA configuration sequence. The default time is 500 2195 ms. 2196 2197 CONFIG_SYS_FPGA_WAIT_BUSY 2198 2199 Maximum time to wait for BUSY to deassert during 2200 Virtex II FPGA configuration. The default is 5 ms. 2201 2202 CONFIG_SYS_FPGA_WAIT_CONFIG 2203 2204 Time to wait after FPGA configuration. The default is 2205 200 ms. 2206 2207- Configuration Management: 2208 CONFIG_IDENT_STRING 2209 2210 If defined, this string will be added to the U-Boot 2211 version information (U_BOOT_VERSION) 2212 2213- Vendor Parameter Protection: 2214 2215 U-Boot considers the values of the environment 2216 variables "serial#" (Board Serial Number) and 2217 "ethaddr" (Ethernet Address) to be parameters that 2218 are set once by the board vendor / manufacturer, and 2219 protects these variables from casual modification by 2220 the user. Once set, these variables are read-only, 2221 and write or delete attempts are rejected. You can 2222 change this behaviour: 2223 2224 If CONFIG_ENV_OVERWRITE is #defined in your config 2225 file, the write protection for vendor parameters is 2226 completely disabled. Anybody can change or delete 2227 these parameters. 2228 2229 Alternatively, if you #define _both_ CONFIG_ETHADDR 2230 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 2231 Ethernet address is installed in the environment, 2232 which can be changed exactly ONCE by the user. [The 2233 serial# is unaffected by this, i. e. it remains 2234 read-only.] 2235 2236 The same can be accomplished in a more flexible way 2237 for any variable by configuring the type of access 2238 to allow for those variables in the ".flags" variable 2239 or define CONFIG_ENV_FLAGS_LIST_STATIC. 2240 2241- Protected RAM: 2242 CONFIG_PRAM 2243 2244 Define this variable to enable the reservation of 2245 "protected RAM", i. e. RAM which is not overwritten 2246 by U-Boot. Define CONFIG_PRAM to hold the number of 2247 kB you want to reserve for pRAM. You can overwrite 2248 this default value by defining an environment 2249 variable "pram" to the number of kB you want to 2250 reserve. Note that the board info structure will 2251 still show the full amount of RAM. If pRAM is 2252 reserved, a new environment variable "mem" will 2253 automatically be defined to hold the amount of 2254 remaining RAM in a form that can be passed as boot 2255 argument to Linux, for instance like that: 2256 2257 setenv bootargs ... mem=\${mem} 2258 saveenv 2259 2260 This way you can tell Linux not to use this memory, 2261 either, which results in a memory region that will 2262 not be affected by reboots. 2263 2264 *WARNING* If your board configuration uses automatic 2265 detection of the RAM size, you must make sure that 2266 this memory test is non-destructive. So far, the 2267 following board configurations are known to be 2268 "pRAM-clean": 2269 2270 IVMS8, IVML24, SPD8xx, TQM8xxL, 2271 HERMES, IP860, RPXlite, LWMON, 2272 FLAGADM, TQM8260 2273 2274- Access to physical memory region (> 4GB) 2275 Some basic support is provided for operations on memory not 2276 normally accessible to U-Boot - e.g. some architectures 2277 support access to more than 4GB of memory on 32-bit 2278 machines using physical address extension or similar. 2279 Define CONFIG_PHYSMEM to access this basic support, which 2280 currently only supports clearing the memory. 2281 2282- Error Recovery: 2283 CONFIG_PANIC_HANG 2284 2285 Define this variable to stop the system in case of a 2286 fatal error, so that you have to reset it manually. 2287 This is probably NOT a good idea for an embedded 2288 system where you want the system to reboot 2289 automatically as fast as possible, but it may be 2290 useful during development since you can try to debug 2291 the conditions that lead to the situation. 2292 2293 CONFIG_NET_RETRY_COUNT 2294 2295 This variable defines the number of retries for 2296 network operations like ARP, RARP, TFTP, or BOOTP 2297 before giving up the operation. If not defined, a 2298 default value of 5 is used. 2299 2300 CONFIG_ARP_TIMEOUT 2301 2302 Timeout waiting for an ARP reply in milliseconds. 2303 2304 CONFIG_NFS_TIMEOUT 2305 2306 Timeout in milliseconds used in NFS protocol. 2307 If you encounter "ERROR: Cannot umount" in nfs command, 2308 try longer timeout such as 2309 #define CONFIG_NFS_TIMEOUT 10000UL 2310 2311- Command Interpreter: 2312 CONFIG_AUTO_COMPLETE 2313 2314 Enable auto completion of commands using TAB. 2315 2316 Note that this feature has NOT been implemented yet 2317 for the "hush" shell. 2318 2319 2320 CONFIG_SYS_HUSH_PARSER 2321 2322 Define this variable to enable the "hush" shell (from 2323 Busybox) as command line interpreter, thus enabling 2324 powerful command line syntax like 2325 if...then...else...fi conditionals or `&&' and '||' 2326 constructs ("shell scripts"). 2327 2328 If undefined, you get the old, much simpler behaviour 2329 with a somewhat smaller memory footprint. 2330 2331 2332 CONFIG_SYS_PROMPT_HUSH_PS2 2333 2334 This defines the secondary prompt string, which is 2335 printed when the command interpreter needs more input 2336 to complete a command. Usually "> ". 2337 2338 Note: 2339 2340 In the current implementation, the local variables 2341 space and global environment variables space are 2342 separated. Local variables are those you define by 2343 simply typing `name=value'. To access a local 2344 variable later on, you have write `$name' or 2345 `${name}'; to execute the contents of a variable 2346 directly type `$name' at the command prompt. 2347 2348 Global environment variables are those you use 2349 setenv/printenv to work with. To run a command stored 2350 in such a variable, you need to use the run command, 2351 and you must not use the '$' sign to access them. 2352 2353 To store commands and special characters in a 2354 variable, please use double quotation marks 2355 surrounding the whole text of the variable, instead 2356 of the backslashes before semicolons and special 2357 symbols. 2358 2359- Commandline Editing and History: 2360 CONFIG_CMDLINE_EDITING 2361 2362 Enable editing and History functions for interactive 2363 commandline input operations 2364 2365- Default Environment: 2366 CONFIG_EXTRA_ENV_SETTINGS 2367 2368 Define this to contain any number of null terminated 2369 strings (variable = value pairs) that will be part of 2370 the default environment compiled into the boot image. 2371 2372 For example, place something like this in your 2373 board's config file: 2374 2375 #define CONFIG_EXTRA_ENV_SETTINGS \ 2376 "myvar1=value1\0" \ 2377 "myvar2=value2\0" 2378 2379 Warning: This method is based on knowledge about the 2380 internal format how the environment is stored by the 2381 U-Boot code. This is NOT an official, exported 2382 interface! Although it is unlikely that this format 2383 will change soon, there is no guarantee either. 2384 You better know what you are doing here. 2385 2386 Note: overly (ab)use of the default environment is 2387 discouraged. Make sure to check other ways to preset 2388 the environment like the "source" command or the 2389 boot command first. 2390 2391 CONFIG_ENV_VARS_UBOOT_CONFIG 2392 2393 Define this in order to add variables describing the 2394 U-Boot build configuration to the default environment. 2395 These will be named arch, cpu, board, vendor, and soc. 2396 2397 Enabling this option will cause the following to be defined: 2398 2399 - CONFIG_SYS_ARCH 2400 - CONFIG_SYS_CPU 2401 - CONFIG_SYS_BOARD 2402 - CONFIG_SYS_VENDOR 2403 - CONFIG_SYS_SOC 2404 2405 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 2406 2407 Define this in order to add variables describing certain 2408 run-time determined information about the hardware to the 2409 environment. These will be named board_name, board_rev. 2410 2411 CONFIG_DELAY_ENVIRONMENT 2412 2413 Normally the environment is loaded when the board is 2414 intialised so that it is available to U-Boot. This inhibits 2415 that so that the environment is not available until 2416 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 2417 this is instead controlled by the value of 2418 /config/load-environment. 2419 2420- DataFlash Support: 2421 CONFIG_HAS_DATAFLASH 2422 2423 Defining this option enables DataFlash features and 2424 allows to read/write in Dataflash via the standard 2425 commands cp, md... 2426 2427- Serial Flash support 2428 CONFIG_CMD_SF 2429 2430 Defining this option enables SPI flash commands 2431 'sf probe/read/write/erase/update'. 2432 2433 Usage requires an initial 'probe' to define the serial 2434 flash parameters, followed by read/write/erase/update 2435 commands. 2436 2437 The following defaults may be provided by the platform 2438 to handle the common case when only a single serial 2439 flash is present on the system. 2440 2441 CONFIG_SF_DEFAULT_BUS Bus identifier 2442 CONFIG_SF_DEFAULT_CS Chip-select 2443 CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2444 CONFIG_SF_DEFAULT_SPEED in Hz 2445 2446 CONFIG_CMD_SF_TEST 2447 2448 Define this option to include a destructive SPI flash 2449 test ('sf test'). 2450 2451- SystemACE Support: 2452 CONFIG_SYSTEMACE 2453 2454 Adding this option adds support for Xilinx SystemACE 2455 chips attached via some sort of local bus. The address 2456 of the chip must also be defined in the 2457 CONFIG_SYS_SYSTEMACE_BASE macro. For example: 2458 2459 #define CONFIG_SYSTEMACE 2460 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 2461 2462 When SystemACE support is added, the "ace" device type 2463 becomes available to the fat commands, i.e. fatls. 2464 2465- TFTP Fixed UDP Port: 2466 CONFIG_TFTP_PORT 2467 2468 If this is defined, the environment variable tftpsrcp 2469 is used to supply the TFTP UDP source port value. 2470 If tftpsrcp isn't defined, the normal pseudo-random port 2471 number generator is used. 2472 2473 Also, the environment variable tftpdstp is used to supply 2474 the TFTP UDP destination port value. If tftpdstp isn't 2475 defined, the normal port 69 is used. 2476 2477 The purpose for tftpsrcp is to allow a TFTP server to 2478 blindly start the TFTP transfer using the pre-configured 2479 target IP address and UDP port. This has the effect of 2480 "punching through" the (Windows XP) firewall, allowing 2481 the remainder of the TFTP transfer to proceed normally. 2482 A better solution is to properly configure the firewall, 2483 but sometimes that is not allowed. 2484 2485- Hashing support: 2486 CONFIG_CMD_HASH 2487 2488 This enables a generic 'hash' command which can produce 2489 hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2490 2491 CONFIG_HASH_VERIFY 2492 2493 Enable the hash verify command (hash -v). This adds to code 2494 size a little. 2495 2496 CONFIG_SHA1 - support SHA1 hashing 2497 CONFIG_SHA256 - support SHA256 hashing 2498 2499 Note: There is also a sha1sum command, which should perhaps 2500 be deprecated in favour of 'hash sha1'. 2501 2502- Show boot progress: 2503 CONFIG_SHOW_BOOT_PROGRESS 2504 2505 Defining this option allows to add some board- 2506 specific code (calling a user-provided function 2507 "show_boot_progress(int)") that enables you to show 2508 the system's boot progress on some display (for 2509 example, some LED's) on your board. At the moment, 2510 the following checkpoints are implemented: 2511 2512- Detailed boot stage timing 2513 CONFIG_BOOTSTAGE 2514 Define this option to get detailed timing of each stage 2515 of the boot process. 2516 2517 CONFIG_BOOTSTAGE_USER_COUNT 2518 This is the number of available user bootstage records. 2519 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 2520 a new ID will be allocated from this stash. If you exceed 2521 the limit, recording will stop. 2522 2523 CONFIG_BOOTSTAGE_REPORT 2524 Define this to print a report before boot, similar to this: 2525 2526 Timer summary in microseconds: 2527 Mark Elapsed Stage 2528 0 0 reset 2529 3,575,678 3,575,678 board_init_f start 2530 3,575,695 17 arch_cpu_init A9 2531 3,575,777 82 arch_cpu_init done 2532 3,659,598 83,821 board_init_r start 2533 3,910,375 250,777 main_loop 2534 29,916,167 26,005,792 bootm_start 2535 30,361,327 445,160 start_kernel 2536 2537 CONFIG_CMD_BOOTSTAGE 2538 Add a 'bootstage' command which supports printing a report 2539 and un/stashing of bootstage data. 2540 2541 CONFIG_BOOTSTAGE_FDT 2542 Stash the bootstage information in the FDT. A root 'bootstage' 2543 node is created with each bootstage id as a child. Each child 2544 has a 'name' property and either 'mark' containing the 2545 mark time in microsecond, or 'accum' containing the 2546 accumulated time for that bootstage id in microseconds. 2547 For example: 2548 2549 bootstage { 2550 154 { 2551 name = "board_init_f"; 2552 mark = <3575678>; 2553 }; 2554 170 { 2555 name = "lcd"; 2556 accum = <33482>; 2557 }; 2558 }; 2559 2560 Code in the Linux kernel can find this in /proc/devicetree. 2561 2562Legacy uImage format: 2563 2564 Arg Where When 2565 1 common/cmd_bootm.c before attempting to boot an image 2566 -1 common/cmd_bootm.c Image header has bad magic number 2567 2 common/cmd_bootm.c Image header has correct magic number 2568 -2 common/cmd_bootm.c Image header has bad checksum 2569 3 common/cmd_bootm.c Image header has correct checksum 2570 -3 common/cmd_bootm.c Image data has bad checksum 2571 4 common/cmd_bootm.c Image data has correct checksum 2572 -4 common/cmd_bootm.c Image is for unsupported architecture 2573 5 common/cmd_bootm.c Architecture check OK 2574 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 2575 6 common/cmd_bootm.c Image Type check OK 2576 -6 common/cmd_bootm.c gunzip uncompression error 2577 -7 common/cmd_bootm.c Unimplemented compression type 2578 7 common/cmd_bootm.c Uncompression OK 2579 8 common/cmd_bootm.c No uncompress/copy overwrite error 2580 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 2581 2582 9 common/image.c Start initial ramdisk verification 2583 -10 common/image.c Ramdisk header has bad magic number 2584 -11 common/image.c Ramdisk header has bad checksum 2585 10 common/image.c Ramdisk header is OK 2586 -12 common/image.c Ramdisk data has bad checksum 2587 11 common/image.c Ramdisk data has correct checksum 2588 12 common/image.c Ramdisk verification complete, start loading 2589 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 2590 13 common/image.c Start multifile image verification 2591 14 common/image.c No initial ramdisk, no multifile, continue. 2592 2593 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 2594 2595 -30 arch/powerpc/lib/board.c Fatal error, hang the system 2596 -31 post/post.c POST test failed, detected by post_output_backlog() 2597 -32 post/post.c POST test failed, detected by post_run_single() 2598 2599 34 common/cmd_doc.c before loading a Image from a DOC device 2600 -35 common/cmd_doc.c Bad usage of "doc" command 2601 35 common/cmd_doc.c correct usage of "doc" command 2602 -36 common/cmd_doc.c No boot device 2603 36 common/cmd_doc.c correct boot device 2604 -37 common/cmd_doc.c Unknown Chip ID on boot device 2605 37 common/cmd_doc.c correct chip ID found, device available 2606 -38 common/cmd_doc.c Read Error on boot device 2607 38 common/cmd_doc.c reading Image header from DOC device OK 2608 -39 common/cmd_doc.c Image header has bad magic number 2609 39 common/cmd_doc.c Image header has correct magic number 2610 -40 common/cmd_doc.c Error reading Image from DOC device 2611 40 common/cmd_doc.c Image header has correct magic number 2612 41 common/cmd_ide.c before loading a Image from a IDE device 2613 -42 common/cmd_ide.c Bad usage of "ide" command 2614 42 common/cmd_ide.c correct usage of "ide" command 2615 -43 common/cmd_ide.c No boot device 2616 43 common/cmd_ide.c boot device found 2617 -44 common/cmd_ide.c Device not available 2618 44 common/cmd_ide.c Device available 2619 -45 common/cmd_ide.c wrong partition selected 2620 45 common/cmd_ide.c partition selected 2621 -46 common/cmd_ide.c Unknown partition table 2622 46 common/cmd_ide.c valid partition table found 2623 -47 common/cmd_ide.c Invalid partition type 2624 47 common/cmd_ide.c correct partition type 2625 -48 common/cmd_ide.c Error reading Image Header on boot device 2626 48 common/cmd_ide.c reading Image Header from IDE device OK 2627 -49 common/cmd_ide.c Image header has bad magic number 2628 49 common/cmd_ide.c Image header has correct magic number 2629 -50 common/cmd_ide.c Image header has bad checksum 2630 50 common/cmd_ide.c Image header has correct checksum 2631 -51 common/cmd_ide.c Error reading Image from IDE device 2632 51 common/cmd_ide.c reading Image from IDE device OK 2633 52 common/cmd_nand.c before loading a Image from a NAND device 2634 -53 common/cmd_nand.c Bad usage of "nand" command 2635 53 common/cmd_nand.c correct usage of "nand" command 2636 -54 common/cmd_nand.c No boot device 2637 54 common/cmd_nand.c boot device found 2638 -55 common/cmd_nand.c Unknown Chip ID on boot device 2639 55 common/cmd_nand.c correct chip ID found, device available 2640 -56 common/cmd_nand.c Error reading Image Header on boot device 2641 56 common/cmd_nand.c reading Image Header from NAND device OK 2642 -57 common/cmd_nand.c Image header has bad magic number 2643 57 common/cmd_nand.c Image header has correct magic number 2644 -58 common/cmd_nand.c Error reading Image from NAND device 2645 58 common/cmd_nand.c reading Image from NAND device OK 2646 2647 -60 common/env_common.c Environment has a bad CRC, using default 2648 2649 64 net/eth.c starting with Ethernet configuration. 2650 -64 net/eth.c no Ethernet found. 2651 65 net/eth.c Ethernet found. 2652 2653 -80 common/cmd_net.c usage wrong 2654 80 common/cmd_net.c before calling NetLoop() 2655 -81 common/cmd_net.c some error in NetLoop() occurred 2656 81 common/cmd_net.c NetLoop() back without error 2657 -82 common/cmd_net.c size == 0 (File with size 0 loaded) 2658 82 common/cmd_net.c trying automatic boot 2659 83 common/cmd_net.c running "source" command 2660 -83 common/cmd_net.c some error in automatic boot or "source" command 2661 84 common/cmd_net.c end without errors 2662 2663FIT uImage format: 2664 2665 Arg Where When 2666 100 common/cmd_bootm.c Kernel FIT Image has correct format 2667 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 2668 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 2669 -101 common/cmd_bootm.c Can't get configuration for kernel subimage 2670 102 common/cmd_bootm.c Kernel unit name specified 2671 -103 common/cmd_bootm.c Can't get kernel subimage node offset 2672 103 common/cmd_bootm.c Found configuration node 2673 104 common/cmd_bootm.c Got kernel subimage node offset 2674 -104 common/cmd_bootm.c Kernel subimage hash verification failed 2675 105 common/cmd_bootm.c Kernel subimage hash verification OK 2676 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 2677 106 common/cmd_bootm.c Architecture check OK 2678 -106 common/cmd_bootm.c Kernel subimage has wrong type 2679 107 common/cmd_bootm.c Kernel subimage type OK 2680 -107 common/cmd_bootm.c Can't get kernel subimage data/size 2681 108 common/cmd_bootm.c Got kernel subimage data/size 2682 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 2683 -109 common/cmd_bootm.c Can't get kernel subimage type 2684 -110 common/cmd_bootm.c Can't get kernel subimage comp 2685 -111 common/cmd_bootm.c Can't get kernel subimage os 2686 -112 common/cmd_bootm.c Can't get kernel subimage load address 2687 -113 common/cmd_bootm.c Image uncompress/copy overwrite error 2688 2689 120 common/image.c Start initial ramdisk verification 2690 -120 common/image.c Ramdisk FIT image has incorrect format 2691 121 common/image.c Ramdisk FIT image has correct format 2692 122 common/image.c No ramdisk subimage unit name, using configuration 2693 -122 common/image.c Can't get configuration for ramdisk subimage 2694 123 common/image.c Ramdisk unit name specified 2695 -124 common/image.c Can't get ramdisk subimage node offset 2696 125 common/image.c Got ramdisk subimage node offset 2697 -125 common/image.c Ramdisk subimage hash verification failed 2698 126 common/image.c Ramdisk subimage hash verification OK 2699 -126 common/image.c Ramdisk subimage for unsupported architecture 2700 127 common/image.c Architecture check OK 2701 -127 common/image.c Can't get ramdisk subimage data/size 2702 128 common/image.c Got ramdisk subimage data/size 2703 129 common/image.c Can't get ramdisk load address 2704 -129 common/image.c Got ramdisk load address 2705 2706 -130 common/cmd_doc.c Incorrect FIT image format 2707 131 common/cmd_doc.c FIT image format OK 2708 2709 -140 common/cmd_ide.c Incorrect FIT image format 2710 141 common/cmd_ide.c FIT image format OK 2711 2712 -150 common/cmd_nand.c Incorrect FIT image format 2713 151 common/cmd_nand.c FIT image format OK 2714 2715- FIT image support: 2716 CONFIG_FIT 2717 Enable support for the FIT uImage format. 2718 2719 CONFIG_FIT_BEST_MATCH 2720 When no configuration is explicitly selected, default to the 2721 one whose fdt's compatibility field best matches that of 2722 U-Boot itself. A match is considered "best" if it matches the 2723 most specific compatibility entry of U-Boot's fdt's root node. 2724 The order of entries in the configuration's fdt is ignored. 2725 2726- Standalone program support: 2727 CONFIG_STANDALONE_LOAD_ADDR 2728 2729 This option defines a board specific value for the 2730 address where standalone program gets loaded, thus 2731 overwriting the architecture dependent default 2732 settings. 2733 2734- Frame Buffer Address: 2735 CONFIG_FB_ADDR 2736 2737 Define CONFIG_FB_ADDR if you want to use specific 2738 address for frame buffer. This is typically the case 2739 when using a graphics controller has separate video 2740 memory. U-Boot will then place the frame buffer at 2741 the given address instead of dynamically reserving it 2742 in system RAM by calling lcd_setmem(), which grabs 2743 the memory for the frame buffer depending on the 2744 configured panel size. 2745 2746 Please see board_init_f function. 2747 2748- Automatic software updates via TFTP server 2749 CONFIG_UPDATE_TFTP 2750 CONFIG_UPDATE_TFTP_CNT_MAX 2751 CONFIG_UPDATE_TFTP_MSEC_MAX 2752 2753 These options enable and control the auto-update feature; 2754 for a more detailed description refer to doc/README.update. 2755 2756- MTD Support (mtdparts command, UBI support) 2757 CONFIG_MTD_DEVICE 2758 2759 Adds the MTD device infrastructure from the Linux kernel. 2760 Needed for mtdparts command support. 2761 2762 CONFIG_MTD_PARTITIONS 2763 2764 Adds the MTD partitioning infrastructure from the Linux 2765 kernel. Needed for UBI support. 2766 2767- SPL framework 2768 CONFIG_SPL 2769 Enable building of SPL globally. 2770 2771 CONFIG_SPL_LDSCRIPT 2772 LDSCRIPT for linking the SPL binary. 2773 2774 CONFIG_SPL_MAX_SIZE 2775 Maximum binary size (text, data and rodata) of the SPL binary. 2776 2777 CONFIG_SPL_TEXT_BASE 2778 TEXT_BASE for linking the SPL binary. 2779 2780 CONFIG_SPL_RELOC_TEXT_BASE 2781 Address to relocate to. If unspecified, this is equal to 2782 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 2783 2784 CONFIG_SPL_BSS_START_ADDR 2785 Link address for the BSS within the SPL binary. 2786 2787 CONFIG_SPL_BSS_MAX_SIZE 2788 Maximum binary size of the BSS section of the SPL binary. 2789 2790 CONFIG_SPL_STACK 2791 Adress of the start of the stack SPL will use 2792 2793 CONFIG_SPL_RELOC_STACK 2794 Adress of the start of the stack SPL will use after 2795 relocation. If unspecified, this is equal to 2796 CONFIG_SPL_STACK. 2797 2798 CONFIG_SYS_SPL_MALLOC_START 2799 Starting address of the malloc pool used in SPL. 2800 2801 CONFIG_SYS_SPL_MALLOC_SIZE 2802 The size of the malloc pool used in SPL. 2803 2804 CONFIG_SPL_FRAMEWORK 2805 Enable the SPL framework under common/. This framework 2806 supports MMC, NAND and YMODEM loading of U-Boot and NAND 2807 NAND loading of the Linux Kernel. 2808 2809 CONFIG_SPL_DISPLAY_PRINT 2810 For ARM, enable an optional function to print more information 2811 about the running system. 2812 2813 CONFIG_SPL_INIT_MINIMAL 2814 Arch init code should be built for a very small image 2815 2816 CONFIG_SPL_LIBCOMMON_SUPPORT 2817 Support for common/libcommon.o in SPL binary 2818 2819 CONFIG_SPL_LIBDISK_SUPPORT 2820 Support for disk/libdisk.o in SPL binary 2821 2822 CONFIG_SPL_I2C_SUPPORT 2823 Support for drivers/i2c/libi2c.o in SPL binary 2824 2825 CONFIG_SPL_GPIO_SUPPORT 2826 Support for drivers/gpio/libgpio.o in SPL binary 2827 2828 CONFIG_SPL_MMC_SUPPORT 2829 Support for drivers/mmc/libmmc.o in SPL binary 2830 2831 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 2832 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 2833 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 2834 Address, size and partition on the MMC to load U-Boot from 2835 when the MMC is being used in raw mode. 2836 2837 CONFIG_SPL_FAT_SUPPORT 2838 Support for fs/fat/libfat.o in SPL binary 2839 2840 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 2841 Filename to read to load U-Boot when reading from FAT 2842 2843 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 2844 Set this for NAND SPL on PPC mpc83xx targets, so that 2845 start.S waits for the rest of the SPL to load before 2846 continuing (the hardware starts execution after just 2847 loading the first page rather than the full 4K). 2848 2849 CONFIG_SPL_NAND_BASE 2850 Include nand_base.c in the SPL. Requires 2851 CONFIG_SPL_NAND_DRIVERS. 2852 2853 CONFIG_SPL_NAND_DRIVERS 2854 SPL uses normal NAND drivers, not minimal drivers. 2855 2856 CONFIG_SPL_NAND_ECC 2857 Include standard software ECC in the SPL 2858 2859 CONFIG_SPL_NAND_SIMPLE 2860 Support for NAND boot using simple NAND drivers that 2861 expose the cmd_ctrl() interface. 2862 2863 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 2864 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 2865 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 2866 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 2867 CONFIG_SYS_NAND_ECCBYTES 2868 Defines the size and behavior of the NAND that SPL uses 2869 to read U-Boot 2870 2871 CONFIG_SYS_NAND_U_BOOT_OFFS 2872 Location in NAND to read U-Boot from 2873 2874 CONFIG_SYS_NAND_U_BOOT_DST 2875 Location in memory to load U-Boot to 2876 2877 CONFIG_SYS_NAND_U_BOOT_SIZE 2878 Size of image to load 2879 2880 CONFIG_SYS_NAND_U_BOOT_START 2881 Entry point in loaded image to jump to 2882 2883 CONFIG_SYS_NAND_HW_ECC_OOBFIRST 2884 Define this if you need to first read the OOB and then the 2885 data. This is used for example on davinci plattforms. 2886 2887 CONFIG_SPL_OMAP3_ID_NAND 2888 Support for an OMAP3-specific set of functions to return the 2889 ID and MFR of the first attached NAND chip, if present. 2890 2891 CONFIG_SPL_SERIAL_SUPPORT 2892 Support for drivers/serial/libserial.o in SPL binary 2893 2894 CONFIG_SPL_SPI_FLASH_SUPPORT 2895 Support for drivers/mtd/spi/libspi_flash.o in SPL binary 2896 2897 CONFIG_SPL_SPI_SUPPORT 2898 Support for drivers/spi/libspi.o in SPL binary 2899 2900 CONFIG_SPL_RAM_DEVICE 2901 Support for running image already present in ram, in SPL binary 2902 2903 CONFIG_SPL_LIBGENERIC_SUPPORT 2904 Support for lib/libgeneric.o in SPL binary 2905 2906 CONFIG_SPL_PAD_TO 2907 Linker address to which the SPL should be padded before 2908 appending the SPL payload. 2909 2910 CONFIG_SPL_TARGET 2911 Final target image containing SPL and payload. Some SPLs 2912 use an arch-specific makefile fragment instead, for 2913 example if more than one image needs to be produced. 2914 2915Modem Support: 2916-------------- 2917 2918[so far only for SMDK2400 boards] 2919 2920- Modem support enable: 2921 CONFIG_MODEM_SUPPORT 2922 2923- RTS/CTS Flow control enable: 2924 CONFIG_HWFLOW 2925 2926- Modem debug support: 2927 CONFIG_MODEM_SUPPORT_DEBUG 2928 2929 Enables debugging stuff (char screen[1024], dbg()) 2930 for modem support. Useful only with BDI2000. 2931 2932- Interrupt support (PPC): 2933 2934 There are common interrupt_init() and timer_interrupt() 2935 for all PPC archs. interrupt_init() calls interrupt_init_cpu() 2936 for CPU specific initialization. interrupt_init_cpu() 2937 should set decrementer_count to appropriate value. If 2938 CPU resets decrementer automatically after interrupt 2939 (ppc4xx) it should set decrementer_count to zero. 2940 timer_interrupt() calls timer_interrupt_cpu() for CPU 2941 specific handling. If board has watchdog / status_led 2942 / other_activity_monitor it works automatically from 2943 general timer_interrupt(). 2944 2945- General: 2946 2947 In the target system modem support is enabled when a 2948 specific key (key combination) is pressed during 2949 power-on. Otherwise U-Boot will boot normally 2950 (autoboot). The key_pressed() function is called from 2951 board_init(). Currently key_pressed() is a dummy 2952 function, returning 1 and thus enabling modem 2953 initialization. 2954 2955 If there are no modem init strings in the 2956 environment, U-Boot proceed to autoboot; the 2957 previous output (banner, info printfs) will be 2958 suppressed, though. 2959 2960 See also: doc/README.Modem 2961 2962Board initialization settings: 2963------------------------------ 2964 2965During Initialization u-boot calls a number of board specific functions 2966to allow the preparation of board specific prerequisites, e.g. pin setup 2967before drivers are initialized. To enable these callbacks the 2968following configuration macros have to be defined. Currently this is 2969architecture specific, so please check arch/your_architecture/lib/board.c 2970typically in board_init_f() and board_init_r(). 2971 2972- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 2973- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 2974- CONFIG_BOARD_LATE_INIT: Call board_late_init() 2975- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 2976 2977Configuration Settings: 2978----------------------- 2979 2980- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 2981 undefine this when you're short of memory. 2982 2983- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 2984 width of the commands listed in the 'help' command output. 2985 2986- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 2987 prompt for user input. 2988 2989- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 2990 2991- CONFIG_SYS_PBSIZE: Buffer size for Console output 2992 2993- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 2994 2995- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 2996 the application (usually a Linux kernel) when it is 2997 booted 2998 2999- CONFIG_SYS_BAUDRATE_TABLE: 3000 List of legal baudrate settings for this board. 3001 3002- CONFIG_SYS_CONSOLE_INFO_QUIET 3003 Suppress display of console information at boot. 3004 3005- CONFIG_SYS_CONSOLE_IS_IN_ENV 3006 If the board specific function 3007 extern int overwrite_console (void); 3008 returns 1, the stdin, stderr and stdout are switched to the 3009 serial port, else the settings in the environment are used. 3010 3011- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3012 Enable the call to overwrite_console(). 3013 3014- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3015 Enable overwrite of previous console environment settings. 3016 3017- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3018 Begin and End addresses of the area used by the 3019 simple memory test. 3020 3021- CONFIG_SYS_ALT_MEMTEST: 3022 Enable an alternate, more extensive memory test. 3023 3024- CONFIG_SYS_MEMTEST_SCRATCH: 3025 Scratch address used by the alternate memory test 3026 You only need to set this if address zero isn't writeable 3027 3028- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 3029 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 3030 this specified memory area will get subtracted from the top 3031 (end) of RAM and won't get "touched" at all by U-Boot. By 3032 fixing up gd->ram_size the Linux kernel should gets passed 3033 the now "corrected" memory size and won't touch it either. 3034 This should work for arch/ppc and arch/powerpc. Only Linux 3035 board ports in arch/powerpc with bootwrapper support that 3036 recalculate the memory size from the SDRAM controller setup 3037 will have to get fixed in Linux additionally. 3038 3039 This option can be used as a workaround for the 440EPx/GRx 3040 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 3041 be touched. 3042 3043 WARNING: Please make sure that this value is a multiple of 3044 the Linux page size (normally 4k). If this is not the case, 3045 then the end address of the Linux memory will be located at a 3046 non page size aligned address and this could cause major 3047 problems. 3048 3049- CONFIG_SYS_LOADS_BAUD_CHANGE: 3050 Enable temporary baudrate change while serial download 3051 3052- CONFIG_SYS_SDRAM_BASE: 3053 Physical start address of SDRAM. _Must_ be 0 here. 3054 3055- CONFIG_SYS_MBIO_BASE: 3056 Physical start address of Motherboard I/O (if using a 3057 Cogent motherboard) 3058 3059- CONFIG_SYS_FLASH_BASE: 3060 Physical start address of Flash memory. 3061 3062- CONFIG_SYS_MONITOR_BASE: 3063 Physical start address of boot monitor code (set by 3064 make config files to be same as the text base address 3065 (CONFIG_SYS_TEXT_BASE) used when linking) - same as 3066 CONFIG_SYS_FLASH_BASE when booting from flash. 3067 3068- CONFIG_SYS_MONITOR_LEN: 3069 Size of memory reserved for monitor code, used to 3070 determine _at_compile_time_ (!) if the environment is 3071 embedded within the U-Boot image, or in a separate 3072 flash sector. 3073 3074- CONFIG_SYS_MALLOC_LEN: 3075 Size of DRAM reserved for malloc() use. 3076 3077- CONFIG_SYS_BOOTM_LEN: 3078 Normally compressed uImages are limited to an 3079 uncompressed size of 8 MBytes. If this is not enough, 3080 you can define CONFIG_SYS_BOOTM_LEN in your board config file 3081 to adjust this setting to your needs. 3082 3083- CONFIG_SYS_BOOTMAPSZ: 3084 Maximum size of memory mapped by the startup code of 3085 the Linux kernel; all data that must be processed by 3086 the Linux kernel (bd_info, boot arguments, FDT blob if 3087 used) must be put below this limit, unless "bootm_low" 3088 enviroment variable is defined and non-zero. In such case 3089 all data for the Linux kernel must be between "bootm_low" 3090 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3091 variable "bootm_mapsize" will override the value of 3092 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3093 then the value in "bootm_size" will be used instead. 3094 3095- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3096 Enable initrd_high functionality. If defined then the 3097 initrd_high feature is enabled and the bootm ramdisk subcommand 3098 is enabled. 3099 3100- CONFIG_SYS_BOOT_GET_CMDLINE: 3101 Enables allocating and saving kernel cmdline in space between 3102 "bootm_low" and "bootm_low" + BOOTMAPSZ. 3103 3104- CONFIG_SYS_BOOT_GET_KBD: 3105 Enables allocating and saving a kernel copy of the bd_info in 3106 space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3107 3108- CONFIG_SYS_MAX_FLASH_BANKS: 3109 Max number of Flash memory banks 3110 3111- CONFIG_SYS_MAX_FLASH_SECT: 3112 Max number of sectors on a Flash chip 3113 3114- CONFIG_SYS_FLASH_ERASE_TOUT: 3115 Timeout for Flash erase operations (in ms) 3116 3117- CONFIG_SYS_FLASH_WRITE_TOUT: 3118 Timeout for Flash write operations (in ms) 3119 3120- CONFIG_SYS_FLASH_LOCK_TOUT 3121 Timeout for Flash set sector lock bit operation (in ms) 3122 3123- CONFIG_SYS_FLASH_UNLOCK_TOUT 3124 Timeout for Flash clear lock bits operation (in ms) 3125 3126- CONFIG_SYS_FLASH_PROTECTION 3127 If defined, hardware flash sectors protection is used 3128 instead of U-Boot software protection. 3129 3130- CONFIG_SYS_DIRECT_FLASH_TFTP: 3131 3132 Enable TFTP transfers directly to flash memory; 3133 without this option such a download has to be 3134 performed in two steps: (1) download to RAM, and (2) 3135 copy from RAM to flash. 3136 3137 The two-step approach is usually more reliable, since 3138 you can check if the download worked before you erase 3139 the flash, but in some situations (when system RAM is 3140 too limited to allow for a temporary copy of the 3141 downloaded image) this option may be very useful. 3142 3143- CONFIG_SYS_FLASH_CFI: 3144 Define if the flash driver uses extra elements in the 3145 common flash structure for storing flash geometry. 3146 3147- CONFIG_FLASH_CFI_DRIVER 3148 This option also enables the building of the cfi_flash driver 3149 in the drivers directory 3150 3151- CONFIG_FLASH_CFI_MTD 3152 This option enables the building of the cfi_mtd driver 3153 in the drivers directory. The driver exports CFI flash 3154 to the MTD layer. 3155 3156- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 3157 Use buffered writes to flash. 3158 3159- CONFIG_FLASH_SPANSION_S29WS_N 3160 s29ws-n MirrorBit flash has non-standard addresses for buffered 3161 write commands. 3162 3163- CONFIG_SYS_FLASH_QUIET_TEST 3164 If this option is defined, the common CFI flash doesn't 3165 print it's warning upon not recognized FLASH banks. This 3166 is useful, if some of the configured banks are only 3167 optionally available. 3168 3169- CONFIG_FLASH_SHOW_PROGRESS 3170 If defined (must be an integer), print out countdown 3171 digits and dots. Recommended value: 45 (9..1) for 80 3172 column displays, 15 (3..1) for 40 column displays. 3173 3174- CONFIG_SYS_RX_ETH_BUFFER: 3175 Defines the number of Ethernet receive buffers. On some 3176 Ethernet controllers it is recommended to set this value 3177 to 8 or even higher (EEPRO100 or 405 EMAC), since all 3178 buffers can be full shortly after enabling the interface 3179 on high Ethernet traffic. 3180 Defaults to 4 if not defined. 3181 3182- CONFIG_ENV_MAX_ENTRIES 3183 3184 Maximum number of entries in the hash table that is used 3185 internally to store the environment settings. The default 3186 setting is supposed to be generous and should work in most 3187 cases. This setting can be used to tune behaviour; see 3188 lib/hashtable.c for details. 3189 3190- CONFIG_ENV_FLAGS_LIST_DEFAULT 3191- CONFIG_ENV_FLAGS_LIST_STATIC 3192 Enable validation of the values given to enviroment variables when 3193 calling env set. Variables can be restricted to only decimal, 3194 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 3195 the variables can also be restricted to IP address or MAC address. 3196 3197 The format of the list is: 3198 type_attribute = [s|d|x|b|i|m] 3199 access_atribute = [a|r|o|c] 3200 attributes = type_attribute[access_atribute] 3201 entry = variable_name[:attributes] 3202 list = entry[,list] 3203 3204 The type attributes are: 3205 s - String (default) 3206 d - Decimal 3207 x - Hexadecimal 3208 b - Boolean ([1yYtT|0nNfF]) 3209 i - IP address 3210 m - MAC address 3211 3212 The access attributes are: 3213 a - Any (default) 3214 r - Read-only 3215 o - Write-once 3216 c - Change-default 3217 3218 - CONFIG_ENV_FLAGS_LIST_DEFAULT 3219 Define this to a list (string) to define the ".flags" 3220 envirnoment variable in the default or embedded environment. 3221 3222 - CONFIG_ENV_FLAGS_LIST_STATIC 3223 Define this to a list (string) to define validation that 3224 should be done if an entry is not found in the ".flags" 3225 environment variable. To override a setting in the static 3226 list, simply add an entry for the same variable name to the 3227 ".flags" variable. 3228 3229- CONFIG_ENV_ACCESS_IGNORE_FORCE 3230 If defined, don't allow the -f switch to env set override variable 3231 access flags. 3232 3233The following definitions that deal with the placement and management 3234of environment data (variable area); in general, we support the 3235following configurations: 3236 3237- CONFIG_BUILD_ENVCRC: 3238 3239 Builds up envcrc with the target environment so that external utils 3240 may easily extract it and embed it in final U-Boot images. 3241 3242- CONFIG_ENV_IS_IN_FLASH: 3243 3244 Define this if the environment is in flash memory. 3245 3246 a) The environment occupies one whole flash sector, which is 3247 "embedded" in the text segment with the U-Boot code. This 3248 happens usually with "bottom boot sector" or "top boot 3249 sector" type flash chips, which have several smaller 3250 sectors at the start or the end. For instance, such a 3251 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3252 such a case you would place the environment in one of the 3253 4 kB sectors - with U-Boot code before and after it. With 3254 "top boot sector" type flash chips, you would put the 3255 environment in one of the last sectors, leaving a gap 3256 between U-Boot and the environment. 3257 3258 - CONFIG_ENV_OFFSET: 3259 3260 Offset of environment data (variable area) to the 3261 beginning of flash memory; for instance, with bottom boot 3262 type flash chips the second sector can be used: the offset 3263 for this sector is given here. 3264 3265 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3266 3267 - CONFIG_ENV_ADDR: 3268 3269 This is just another way to specify the start address of 3270 the flash sector containing the environment (instead of 3271 CONFIG_ENV_OFFSET). 3272 3273 - CONFIG_ENV_SECT_SIZE: 3274 3275 Size of the sector containing the environment. 3276 3277 3278 b) Sometimes flash chips have few, equal sized, BIG sectors. 3279 In such a case you don't want to spend a whole sector for 3280 the environment. 3281 3282 - CONFIG_ENV_SIZE: 3283 3284 If you use this in combination with CONFIG_ENV_IS_IN_FLASH 3285 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3286 of this flash sector for the environment. This saves 3287 memory for the RAM copy of the environment. 3288 3289 It may also save flash memory if you decide to use this 3290 when your environment is "embedded" within U-Boot code, 3291 since then the remainder of the flash sector could be used 3292 for U-Boot code. It should be pointed out that this is 3293 STRONGLY DISCOURAGED from a robustness point of view: 3294 updating the environment in flash makes it always 3295 necessary to erase the WHOLE sector. If something goes 3296 wrong before the contents has been restored from a copy in 3297 RAM, your target system will be dead. 3298 3299 - CONFIG_ENV_ADDR_REDUND 3300 CONFIG_ENV_SIZE_REDUND 3301 3302 These settings describe a second storage area used to hold 3303 a redundant copy of the environment data, so that there is 3304 a valid backup copy in case there is a power failure during 3305 a "saveenv" operation. 3306 3307BE CAREFUL! Any changes to the flash layout, and some changes to the 3308source code will make it necessary to adapt <board>/u-boot.lds* 3309accordingly! 3310 3311 3312- CONFIG_ENV_IS_IN_NVRAM: 3313 3314 Define this if you have some non-volatile memory device 3315 (NVRAM, battery buffered SRAM) which you want to use for the 3316 environment. 3317 3318 - CONFIG_ENV_ADDR: 3319 - CONFIG_ENV_SIZE: 3320 3321 These two #defines are used to determine the memory area you 3322 want to use for environment. It is assumed that this memory 3323 can just be read and written to, without any special 3324 provision. 3325 3326BE CAREFUL! The first access to the environment happens quite early 3327in U-Boot initalization (when we try to get the setting of for the 3328console baudrate). You *MUST* have mapped your NVRAM area then, or 3329U-Boot will hang. 3330 3331Please note that even with NVRAM we still use a copy of the 3332environment in RAM: we could work on NVRAM directly, but we want to 3333keep settings there always unmodified except somebody uses "saveenv" 3334to save the current settings. 3335 3336 3337- CONFIG_ENV_IS_IN_EEPROM: 3338 3339 Use this if you have an EEPROM or similar serial access 3340 device and a driver for it. 3341 3342 - CONFIG_ENV_OFFSET: 3343 - CONFIG_ENV_SIZE: 3344 3345 These two #defines specify the offset and size of the 3346 environment area within the total memory of your EEPROM. 3347 3348 - CONFIG_SYS_I2C_EEPROM_ADDR: 3349 If defined, specified the chip address of the EEPROM device. 3350 The default address is zero. 3351 3352 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3353 If defined, the number of bits used to address bytes in a 3354 single page in the EEPROM device. A 64 byte page, for example 3355 would require six bits. 3356 3357 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3358 If defined, the number of milliseconds to delay between 3359 page writes. The default is zero milliseconds. 3360 3361 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3362 The length in bytes of the EEPROM memory array address. Note 3363 that this is NOT the chip address length! 3364 3365 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 3366 EEPROM chips that implement "address overflow" are ones 3367 like Catalyst 24WC04/08/16 which has 9/10/11 bits of 3368 address and the extra bits end up in the "chip address" bit 3369 slots. This makes a 24WC08 (1Kbyte) chip look like four 256 3370 byte chips. 3371 3372 Note that we consider the length of the address field to 3373 still be one byte because the extra address bits are hidden 3374 in the chip address. 3375 3376 - CONFIG_SYS_EEPROM_SIZE: 3377 The size in bytes of the EEPROM device. 3378 3379 - CONFIG_ENV_EEPROM_IS_ON_I2C 3380 define this, if you have I2C and SPI activated, and your 3381 EEPROM, which holds the environment, is on the I2C bus. 3382 3383 - CONFIG_I2C_ENV_EEPROM_BUS 3384 if you have an Environment on an EEPROM reached over 3385 I2C muxes, you can define here, how to reach this 3386 EEPROM. For example: 3387 3388 #define CONFIG_I2C_ENV_EEPROM_BUS "pca9547:70:d\0" 3389 3390 EEPROM which holds the environment, is reached over 3391 a pca9547 i2c mux with address 0x70, channel 3. 3392 3393- CONFIG_ENV_IS_IN_DATAFLASH: 3394 3395 Define this if you have a DataFlash memory device which you 3396 want to use for the environment. 3397 3398 - CONFIG_ENV_OFFSET: 3399 - CONFIG_ENV_ADDR: 3400 - CONFIG_ENV_SIZE: 3401 3402 These three #defines specify the offset and size of the 3403 environment area within the total memory of your DataFlash placed 3404 at the specified address. 3405 3406- CONFIG_ENV_IS_IN_REMOTE: 3407 3408 Define this if you have a remote memory space which you 3409 want to use for the local device's environment. 3410 3411 - CONFIG_ENV_ADDR: 3412 - CONFIG_ENV_SIZE: 3413 3414 These two #defines specify the address and size of the 3415 environment area within the remote memory space. The 3416 local device can get the environment from remote memory 3417 space by SRIO or PCIE links. 3418 3419BE CAREFUL! For some special cases, the local device can not use 3420"saveenv" command. For example, the local device will get the 3421environment stored in a remote NOR flash by SRIO or PCIE link, 3422but it can not erase, write this NOR flash by SRIO or PCIE interface. 3423 3424- CONFIG_ENV_IS_IN_NAND: 3425 3426 Define this if you have a NAND device which you want to use 3427 for the environment. 3428 3429 - CONFIG_ENV_OFFSET: 3430 - CONFIG_ENV_SIZE: 3431 3432 These two #defines specify the offset and size of the environment 3433 area within the first NAND device. CONFIG_ENV_OFFSET must be 3434 aligned to an erase block boundary. 3435 3436 - CONFIG_ENV_OFFSET_REDUND (optional): 3437 3438 This setting describes a second storage area of CONFIG_ENV_SIZE 3439 size used to hold a redundant copy of the environment data, so 3440 that there is a valid backup copy in case there is a power failure 3441 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 3442 aligned to an erase block boundary. 3443 3444 - CONFIG_ENV_RANGE (optional): 3445 3446 Specifies the length of the region in which the environment 3447 can be written. This should be a multiple of the NAND device's 3448 block size. Specifying a range with more erase blocks than 3449 are needed to hold CONFIG_ENV_SIZE allows bad blocks within 3450 the range to be avoided. 3451 3452 - CONFIG_ENV_OFFSET_OOB (optional): 3453 3454 Enables support for dynamically retrieving the offset of the 3455 environment from block zero's out-of-band data. The 3456 "nand env.oob" command can be used to record this offset. 3457 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 3458 using CONFIG_ENV_OFFSET_OOB. 3459 3460- CONFIG_NAND_ENV_DST 3461 3462 Defines address in RAM to which the nand_spl code should copy the 3463 environment. If redundant environment is used, it will be copied to 3464 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 3465 3466- CONFIG_SYS_SPI_INIT_OFFSET 3467 3468 Defines offset to the initial SPI buffer area in DPRAM. The 3469 area is used at an early stage (ROM part) if the environment 3470 is configured to reside in the SPI EEPROM: We need a 520 byte 3471 scratch DPRAM area. It is used between the two initialization 3472 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 3473 to be a good choice since it makes it far enough from the 3474 start of the data area as well as from the stack pointer. 3475 3476Please note that the environment is read-only until the monitor 3477has been relocated to RAM and a RAM copy of the environment has been 3478created; also, when using EEPROM you will have to use getenv_f() 3479until then to read environment variables. 3480 3481The environment is protected by a CRC32 checksum. Before the monitor 3482is relocated into RAM, as a result of a bad CRC you will be working 3483with the compiled-in default environment - *silently*!!! [This is 3484necessary, because the first environment variable we need is the 3485"baudrate" setting for the console - if we have a bad CRC, we don't 3486have any device yet where we could complain.] 3487 3488Note: once the monitor has been relocated, then it will complain if 3489the default environment is used; a new CRC is computed as soon as you 3490use the "saveenv" command to store a valid environment. 3491 3492- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 3493 Echo the inverted Ethernet link state to the fault LED. 3494 3495 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 3496 also needs to be defined. 3497 3498- CONFIG_SYS_FAULT_MII_ADDR: 3499 MII address of the PHY to check for the Ethernet link state. 3500 3501- CONFIG_NS16550_MIN_FUNCTIONS: 3502 Define this if you desire to only have use of the NS16550_init 3503 and NS16550_putc functions for the serial driver located at 3504 drivers/serial/ns16550.c. This option is useful for saving 3505 space for already greatly restricted images, including but not 3506 limited to NAND_SPL configurations. 3507 3508- CONFIG_DISPLAY_BOARDINFO 3509 Display information about the board that U-Boot is running on 3510 when U-Boot starts up. The board function checkboard() is called 3511 to do this. 3512 3513- CONFIG_DISPLAY_BOARDINFO_LATE 3514 Similar to the previous option, but display this information 3515 later, once stdio is running and output goes to the LCD, if 3516 present. 3517 3518Low Level (hardware related) configuration options: 3519--------------------------------------------------- 3520 3521- CONFIG_SYS_CACHELINE_SIZE: 3522 Cache Line Size of the CPU. 3523 3524- CONFIG_SYS_DEFAULT_IMMR: 3525 Default address of the IMMR after system reset. 3526 3527 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 3528 and RPXsuper) to be able to adjust the position of 3529 the IMMR register after a reset. 3530 3531- CONFIG_SYS_CCSRBAR_DEFAULT: 3532 Default (power-on reset) physical address of CCSR on Freescale 3533 PowerPC SOCs. 3534 3535- CONFIG_SYS_CCSRBAR: 3536 Virtual address of CCSR. On a 32-bit build, this is typically 3537 the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 3538 3539 CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 3540 for cross-platform code that uses that macro instead. 3541 3542- CONFIG_SYS_CCSRBAR_PHYS: 3543 Physical address of CCSR. CCSR can be relocated to a new 3544 physical address, if desired. In this case, this macro should 3545 be set to that address. Otherwise, it should be set to the 3546 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 3547 is typically relocated on 36-bit builds. It is recommended 3548 that this macro be defined via the _HIGH and _LOW macros: 3549 3550 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 3551 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 3552 3553- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 3554 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 3555 either 0 (32-bit build) or 0xF (36-bit build). This macro is 3556 used in assembly code, so it must not contain typecasts or 3557 integer size suffixes (e.g. "ULL"). 3558 3559- CONFIG_SYS_CCSRBAR_PHYS_LOW: 3560 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 3561 used in assembly code, so it must not contain typecasts or 3562 integer size suffixes (e.g. "ULL"). 3563 3564- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 3565 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 3566 forced to a value that ensures that CCSR is not relocated. 3567 3568- Floppy Disk Support: 3569 CONFIG_SYS_FDC_DRIVE_NUMBER 3570 3571 the default drive number (default value 0) 3572 3573 CONFIG_SYS_ISA_IO_STRIDE 3574 3575 defines the spacing between FDC chipset registers 3576 (default value 1) 3577 3578 CONFIG_SYS_ISA_IO_OFFSET 3579 3580 defines the offset of register from address. It 3581 depends on which part of the data bus is connected to 3582 the FDC chipset. (default value 0) 3583 3584 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 3585 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 3586 default value. 3587 3588 if CONFIG_SYS_FDC_HW_INIT is defined, then the function 3589 fdc_hw_init() is called at the beginning of the FDC 3590 setup. fdc_hw_init() must be provided by the board 3591 source code. It is used to make hardware dependant 3592 initializations. 3593 3594- CONFIG_IDE_AHB: 3595 Most IDE controllers were designed to be connected with PCI 3596 interface. Only few of them were designed for AHB interface. 3597 When software is doing ATA command and data transfer to 3598 IDE devices through IDE-AHB controller, some additional 3599 registers accessing to these kind of IDE-AHB controller 3600 is requierd. 3601 3602- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 3603 DO NOT CHANGE unless you know exactly what you're 3604 doing! (11-4) [MPC8xx/82xx systems only] 3605 3606- CONFIG_SYS_INIT_RAM_ADDR: 3607 3608 Start address of memory area that can be used for 3609 initial data and stack; please note that this must be 3610 writable memory that is working WITHOUT special 3611 initialization, i. e. you CANNOT use normal RAM which 3612 will become available only after programming the 3613 memory controller and running certain initialization 3614 sequences. 3615 3616 U-Boot uses the following memory types: 3617 - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 3618 - MPC824X: data cache 3619 - PPC4xx: data cache 3620 3621- CONFIG_SYS_GBL_DATA_OFFSET: 3622 3623 Offset of the initial data structure in the memory 3624 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 3625 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 3626 data is located at the end of the available space 3627 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 3628 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 3629 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 3630 CONFIG_SYS_GBL_DATA_OFFSET) downward. 3631 3632 Note: 3633 On the MPC824X (or other systems that use the data 3634 cache for initial memory) the address chosen for 3635 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 3636 point to an otherwise UNUSED address space between 3637 the top of RAM and the start of the PCI space. 3638 3639- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 3640 3641- CONFIG_SYS_SYPCR: System Protection Control (11-9) 3642 3643- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 3644 3645- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 3646 3647- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 3648 3649- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 3650 3651- CONFIG_SYS_OR_TIMING_SDRAM: 3652 SDRAM timing 3653 3654- CONFIG_SYS_MAMR_PTA: 3655 periodic timer for refresh 3656 3657- CONFIG_SYS_DER: Debug Event Register (37-47) 3658 3659- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 3660 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 3661 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 3662 CONFIG_SYS_BR1_PRELIM: 3663 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 3664 3665- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 3666 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 3667 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 3668 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 3669 3670- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 3671 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 3672 Machine Mode Register and Memory Periodic Timer 3673 Prescaler definitions (SDRAM timing) 3674 3675- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 3676 enable I2C microcode relocation patch (MPC8xx); 3677 define relocation offset in DPRAM [DSP2] 3678 3679- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 3680 enable SMC microcode relocation patch (MPC8xx); 3681 define relocation offset in DPRAM [SMC1] 3682 3683- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 3684 enable SPI microcode relocation patch (MPC8xx); 3685 define relocation offset in DPRAM [SCC4] 3686 3687- CONFIG_SYS_USE_OSCCLK: 3688 Use OSCM clock mode on MBX8xx board. Be careful, 3689 wrong setting might damage your board. Read 3690 doc/README.MBX before setting this variable! 3691 3692- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 3693 Offset of the bootmode word in DPRAM used by post 3694 (Power On Self Tests). This definition overrides 3695 #define'd default value in commproc.h resp. 3696 cpm_8260.h. 3697 3698- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 3699 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 3700 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 3701 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 3702 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 3703 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 3704 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 3705 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 3706 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 3707 3708- CONFIG_PCI_DISABLE_PCIE: 3709 Disable PCI-Express on systems where it is supported but not 3710 required. 3711 3712- CONFIG_PCI_ENUM_ONLY 3713 Only scan through and get the devices on the busses. 3714 Don't do any setup work, presumably because someone or 3715 something has already done it, and we don't need to do it 3716 a second time. Useful for platforms that are pre-booted 3717 by coreboot or similar. 3718 3719- CONFIG_SYS_SRIO: 3720 Chip has SRIO or not 3721 3722- CONFIG_SRIO1: 3723 Board has SRIO 1 port available 3724 3725- CONFIG_SRIO2: 3726 Board has SRIO 2 port available 3727 3728- CONFIG_SYS_SRIOn_MEM_VIRT: 3729 Virtual Address of SRIO port 'n' memory region 3730 3731- CONFIG_SYS_SRIOn_MEM_PHYS: 3732 Physical Address of SRIO port 'n' memory region 3733 3734- CONFIG_SYS_SRIOn_MEM_SIZE: 3735 Size of SRIO port 'n' memory region 3736 3737- CONFIG_SYS_NDFC_16 3738 Defined to tell the NDFC that the NAND chip is using a 3739 16 bit bus. 3740 3741- CONFIG_SYS_NDFC_EBC0_CFG 3742 Sets the EBC0_CFG register for the NDFC. If not defined 3743 a default value will be used. 3744 3745- CONFIG_SPD_EEPROM 3746 Get DDR timing information from an I2C EEPROM. Common 3747 with pluggable memory modules such as SODIMMs 3748 3749 SPD_EEPROM_ADDRESS 3750 I2C address of the SPD EEPROM 3751 3752- CONFIG_SYS_SPD_BUS_NUM 3753 If SPD EEPROM is on an I2C bus other than the first 3754 one, specify here. Note that the value must resolve 3755 to something your driver can deal with. 3756 3757- CONFIG_SYS_DDR_RAW_TIMING 3758 Get DDR timing information from other than SPD. Common with 3759 soldered DDR chips onboard without SPD. DDR raw timing 3760 parameters are extracted from datasheet and hard-coded into 3761 header files or board specific files. 3762 3763- CONFIG_FSL_DDR_INTERACTIVE 3764 Enable interactive DDR debugging. See doc/README.fsl-ddr. 3765 3766- CONFIG_SYS_83XX_DDR_USES_CS0 3767 Only for 83xx systems. If specified, then DDR should 3768 be configured using CS0 and CS1 instead of CS2 and CS3. 3769 3770- CONFIG_ETHER_ON_FEC[12] 3771 Define to enable FEC[12] on a 8xx series processor. 3772 3773- CONFIG_FEC[12]_PHY 3774 Define to the hardcoded PHY address which corresponds 3775 to the given FEC; i. e. 3776 #define CONFIG_FEC1_PHY 4 3777 means that the PHY with address 4 is connected to FEC1 3778 3779 When set to -1, means to probe for first available. 3780 3781- CONFIG_FEC[12]_PHY_NORXERR 3782 The PHY does not have a RXERR line (RMII only). 3783 (so program the FEC to ignore it). 3784 3785- CONFIG_RMII 3786 Enable RMII mode for all FECs. 3787 Note that this is a global option, we can't 3788 have one FEC in standard MII mode and another in RMII mode. 3789 3790- CONFIG_CRC32_VERIFY 3791 Add a verify option to the crc32 command. 3792 The syntax is: 3793 3794 => crc32 -v <address> <count> <crc32> 3795 3796 Where address/count indicate a memory area 3797 and crc32 is the correct crc32 which the 3798 area should have. 3799 3800- CONFIG_LOOPW 3801 Add the "loopw" memory command. This only takes effect if 3802 the memory commands are activated globally (CONFIG_CMD_MEM). 3803 3804- CONFIG_MX_CYCLIC 3805 Add the "mdc" and "mwc" memory commands. These are cyclic 3806 "md/mw" commands. 3807 Examples: 3808 3809 => mdc.b 10 4 500 3810 This command will print 4 bytes (10,11,12,13) each 500 ms. 3811 3812 => mwc.l 100 12345678 10 3813 This command will write 12345678 to address 100 all 10 ms. 3814 3815 This only takes effect if the memory commands are activated 3816 globally (CONFIG_CMD_MEM). 3817 3818- CONFIG_SKIP_LOWLEVEL_INIT 3819 [ARM, NDS32, MIPS only] If this variable is defined, then certain 3820 low level initializations (like setting up the memory 3821 controller) are omitted and/or U-Boot does not 3822 relocate itself into RAM. 3823 3824 Normally this variable MUST NOT be defined. The only 3825 exception is when U-Boot is loaded (to RAM) by some 3826 other boot loader or by a debugger which performs 3827 these initializations itself. 3828 3829- CONFIG_SPL_BUILD 3830 Modifies the behaviour of start.S when compiling a loader 3831 that is executed before the actual U-Boot. E.g. when 3832 compiling a NAND SPL. 3833 3834- CONFIG_ARCH_MAP_SYSMEM 3835 Generally U-Boot (and in particular the md command) uses 3836 effective address. It is therefore not necessary to regard 3837 U-Boot address as virtual addresses that need to be translated 3838 to physical addresses. However, sandbox requires this, since 3839 it maintains its own little RAM buffer which contains all 3840 addressable memory. This option causes some memory accesses 3841 to be mapped through map_sysmem() / unmap_sysmem(). 3842 3843- CONFIG_USE_ARCH_MEMCPY 3844 CONFIG_USE_ARCH_MEMSET 3845 If these options are used a optimized version of memcpy/memset will 3846 be used if available. These functions may be faster under some 3847 conditions but may increase the binary size. 3848 3849- CONFIG_X86_RESET_VECTOR 3850 If defined, the x86 reset vector code is included. This is not 3851 needed when U-Boot is running from Coreboot. 3852 3853 3854Freescale QE/FMAN Firmware Support: 3855----------------------------------- 3856 3857The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 3858loading of "firmware", which is encoded in the QE firmware binary format. 3859This firmware often needs to be loaded during U-Boot booting, so macros 3860are used to identify the storage device (NOR flash, SPI, etc) and the address 3861within that device. 3862 3863- CONFIG_SYS_QE_FMAN_FW_ADDR 3864 The address in the storage device where the firmware is located. The 3865 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 3866 is also specified. 3867 3868- CONFIG_SYS_QE_FMAN_FW_LENGTH 3869 The maximum possible size of the firmware. The firmware binary format 3870 has a field that specifies the actual size of the firmware, but it 3871 might not be possible to read any part of the firmware unless some 3872 local storage is allocated to hold the entire firmware first. 3873 3874- CONFIG_SYS_QE_FMAN_FW_IN_NOR 3875 Specifies that QE/FMAN firmware is located in NOR flash, mapped as 3876 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 3877 virtual address in NOR flash. 3878 3879- CONFIG_SYS_QE_FMAN_FW_IN_NAND 3880 Specifies that QE/FMAN firmware is located in NAND flash. 3881 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 3882 3883- CONFIG_SYS_QE_FMAN_FW_IN_MMC 3884 Specifies that QE/FMAN firmware is located on the primary SD/MMC 3885 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3886 3887- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 3888 Specifies that QE/FMAN firmware is located on the primary SPI 3889 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 3890 3891- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 3892 Specifies that QE/FMAN firmware is located in the remote (master) 3893 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 3894 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 3895 window->master inbound window->master LAW->the ucode address in 3896 master's memory space. 3897 3898Building the Software: 3899====================== 3900 3901Building U-Boot has been tested in several native build environments 3902and in many different cross environments. Of course we cannot support 3903all possibly existing versions of cross development tools in all 3904(potentially obsolete) versions. In case of tool chain problems we 3905recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 3906which is extensively used to build and test U-Boot. 3907 3908If you are not using a native environment, it is assumed that you 3909have GNU cross compiling tools available in your path. In this case, 3910you must set the environment variable CROSS_COMPILE in your shell. 3911Note that no changes to the Makefile or any other source files are 3912necessary. For example using the ELDK on a 4xx CPU, please enter: 3913 3914 $ CROSS_COMPILE=ppc_4xx- 3915 $ export CROSS_COMPILE 3916 3917Note: If you wish to generate Windows versions of the utilities in 3918 the tools directory you can use the MinGW toolchain 3919 (http://www.mingw.org). Set your HOST tools to the MinGW 3920 toolchain and execute 'make tools'. For example: 3921 3922 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 3923 3924 Binaries such as tools/mkimage.exe will be created which can 3925 be executed on computers running Windows. 3926 3927U-Boot is intended to be simple to build. After installing the 3928sources you must configure U-Boot for one specific board type. This 3929is done by typing: 3930 3931 make NAME_config 3932 3933where "NAME_config" is the name of one of the existing configu- 3934rations; see boards.cfg for supported names. 3935 3936Note: for some board special configuration names may exist; check if 3937 additional information is available from the board vendor; for 3938 instance, the TQM823L systems are available without (standard) 3939 or with LCD support. You can select such additional "features" 3940 when choosing the configuration, i. e. 3941 3942 make TQM823L_config 3943 - will configure for a plain TQM823L, i. e. no LCD support 3944 3945 make TQM823L_LCD_config 3946 - will configure for a TQM823L with U-Boot console on LCD 3947 3948 etc. 3949 3950 3951Finally, type "make all", and you should get some working U-Boot 3952images ready for download to / installation on your system: 3953 3954- "u-boot.bin" is a raw binary image 3955- "u-boot" is an image in ELF binary format 3956- "u-boot.srec" is in Motorola S-Record format 3957 3958By default the build is performed locally and the objects are saved 3959in the source directory. One of the two methods can be used to change 3960this behavior and build U-Boot to some external directory: 3961 39621. Add O= to the make command line invocations: 3963 3964 make O=/tmp/build distclean 3965 make O=/tmp/build NAME_config 3966 make O=/tmp/build all 3967 39682. Set environment variable BUILD_DIR to point to the desired location: 3969 3970 export BUILD_DIR=/tmp/build 3971 make distclean 3972 make NAME_config 3973 make all 3974 3975Note that the command line "O=" setting overrides the BUILD_DIR environment 3976variable. 3977 3978 3979Please be aware that the Makefiles assume you are using GNU make, so 3980for instance on NetBSD you might need to use "gmake" instead of 3981native "make". 3982 3983 3984If the system board that you have is not listed, then you will need 3985to port U-Boot to your hardware platform. To do this, follow these 3986steps: 3987 39881. Add a new configuration option for your board to the toplevel 3989 "boards.cfg" file, using the existing entries as examples. 3990 Follow the instructions there to keep the boards in order. 39912. Create a new directory to hold your board specific code. Add any 3992 files you need. In your board directory, you will need at least 3993 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 39943. Create a new configuration file "include/configs/<board>.h" for 3995 your board 39963. If you're porting U-Boot to a new CPU, then also create a new 3997 directory to hold your CPU specific code. Add any files you need. 39984. Run "make <board>_config" with your new name. 39995. Type "make", and you should get a working "u-boot.srec" file 4000 to be installed on your target system. 40016. Debug and solve any problems that might arise. 4002 [Of course, this last step is much harder than it sounds.] 4003 4004 4005Testing of U-Boot Modifications, Ports to New Hardware, etc.: 4006============================================================== 4007 4008If you have modified U-Boot sources (for instance added a new board 4009or support for new devices, a new CPU, etc.) you are expected to 4010provide feedback to the other developers. The feedback normally takes 4011the form of a "patch", i. e. a context diff against a certain (latest 4012official or latest in the git repository) version of U-Boot sources. 4013 4014But before you submit such a patch, please verify that your modifi- 4015cation did not break existing code. At least make sure that *ALL* of 4016the supported boards compile WITHOUT ANY compiler warnings. To do so, 4017just run the "MAKEALL" script, which will configure and build U-Boot 4018for ALL supported system. Be warned, this will take a while. You can 4019select which (cross) compiler to use by passing a `CROSS_COMPILE' 4020environment variable to the script, i. e. to use the ELDK cross tools 4021you can type 4022 4023 CROSS_COMPILE=ppc_8xx- MAKEALL 4024 4025or to build on a native PowerPC system you can type 4026 4027 CROSS_COMPILE=' ' MAKEALL 4028 4029When using the MAKEALL script, the default behaviour is to build 4030U-Boot in the source directory. This location can be changed by 4031setting the BUILD_DIR environment variable. Also, for each target 4032built, the MAKEALL script saves two log files (<target>.ERR and 4033<target>.MAKEALL) in the <source dir>/LOG directory. This default 4034location can be changed by setting the MAKEALL_LOGDIR environment 4035variable. For example: 4036 4037 export BUILD_DIR=/tmp/build 4038 export MAKEALL_LOGDIR=/tmp/log 4039 CROSS_COMPILE=ppc_8xx- MAKEALL 4040 4041With the above settings build objects are saved in the /tmp/build, 4042log files are saved in the /tmp/log and the source tree remains clean 4043during the whole build process. 4044 4045 4046See also "U-Boot Porting Guide" below. 4047 4048 4049Monitor Commands - Overview: 4050============================ 4051 4052go - start application at address 'addr' 4053run - run commands in an environment variable 4054bootm - boot application image from memory 4055bootp - boot image via network using BootP/TFTP protocol 4056bootz - boot zImage from memory 4057tftpboot- boot image via network using TFTP protocol 4058 and env variables "ipaddr" and "serverip" 4059 (and eventually "gatewayip") 4060tftpput - upload a file via network using TFTP protocol 4061rarpboot- boot image via network using RARP/TFTP protocol 4062diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4063loads - load S-Record file over serial line 4064loadb - load binary file over serial line (kermit mode) 4065md - memory display 4066mm - memory modify (auto-incrementing) 4067nm - memory modify (constant address) 4068mw - memory write (fill) 4069cp - memory copy 4070cmp - memory compare 4071crc32 - checksum calculation 4072i2c - I2C sub-system 4073sspi - SPI utility commands 4074base - print or set address offset 4075printenv- print environment variables 4076setenv - set environment variables 4077saveenv - save environment variables to persistent storage 4078protect - enable or disable FLASH write protection 4079erase - erase FLASH memory 4080flinfo - print FLASH memory information 4081nand - NAND memory operations (see doc/README.nand) 4082bdinfo - print Board Info structure 4083iminfo - print header information for application image 4084coninfo - print console devices and informations 4085ide - IDE sub-system 4086loop - infinite loop on address range 4087loopw - infinite write loop on address range 4088mtest - simple RAM test 4089icache - enable or disable instruction cache 4090dcache - enable or disable data cache 4091reset - Perform RESET of the CPU 4092echo - echo args to console 4093version - print monitor version 4094help - print online help 4095? - alias for 'help' 4096 4097 4098Monitor Commands - Detailed Description: 4099======================================== 4100 4101TODO. 4102 4103For now: just type "help <command>". 4104 4105 4106Environment Variables: 4107====================== 4108 4109U-Boot supports user configuration using Environment Variables which 4110can be made persistent by saving to Flash memory. 4111 4112Environment Variables are set using "setenv", printed using 4113"printenv", and saved to Flash using "saveenv". Using "setenv" 4114without a value can be used to delete a variable from the 4115environment. As long as you don't save the environment you are 4116working with an in-memory copy. In case the Flash area containing the 4117environment is erased by accident, a default environment is provided. 4118 4119Some configuration options can be set using Environment Variables. 4120 4121List of environment variables (most likely not complete): 4122 4123 baudrate - see CONFIG_BAUDRATE 4124 4125 bootdelay - see CONFIG_BOOTDELAY 4126 4127 bootcmd - see CONFIG_BOOTCOMMAND 4128 4129 bootargs - Boot arguments when booting an RTOS image 4130 4131 bootfile - Name of the image to load with TFTP 4132 4133 bootm_low - Memory range available for image processing in the bootm 4134 command can be restricted. This variable is given as 4135 a hexadecimal number and defines lowest address allowed 4136 for use by the bootm command. See also "bootm_size" 4137 environment variable. Address defined by "bootm_low" is 4138 also the base of the initial memory mapping for the Linux 4139 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4140 bootm_mapsize. 4141 4142 bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4143 This variable is given as a hexadecimal number and it 4144 defines the size of the memory region starting at base 4145 address bootm_low that is accessible by the Linux kernel 4146 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4147 as the default value if it is defined, and bootm_size is 4148 used otherwise. 4149 4150 bootm_size - Memory range available for image processing in the bootm 4151 command can be restricted. This variable is given as 4152 a hexadecimal number and defines the size of the region 4153 allowed for use by the bootm command. See also "bootm_low" 4154 environment variable. 4155 4156 updatefile - Location of the software update file on a TFTP server, used 4157 by the automatic software update feature. Please refer to 4158 documentation in doc/README.update for more details. 4159 4160 autoload - if set to "no" (any string beginning with 'n'), 4161 "bootp" will just load perform a lookup of the 4162 configuration from the BOOTP server, but not try to 4163 load any image using TFTP 4164 4165 autostart - if set to "yes", an image loaded using the "bootp", 4166 "rarpboot", "tftpboot" or "diskboot" commands will 4167 be automatically started (by internally calling 4168 "bootm") 4169 4170 If set to "no", a standalone image passed to the 4171 "bootm" command will be copied to the load address 4172 (and eventually uncompressed), but NOT be started. 4173 This can be used to load and uncompress arbitrary 4174 data. 4175 4176 fdt_high - if set this restricts the maximum address that the 4177 flattened device tree will be copied into upon boot. 4178 For example, if you have a system with 1 GB memory 4179 at physical address 0x10000000, while Linux kernel 4180 only recognizes the first 704 MB as low memory, you 4181 may need to set fdt_high as 0x3C000000 to have the 4182 device tree blob be copied to the maximum address 4183 of the 704 MB low memory, so that Linux kernel can 4184 access it during the boot procedure. 4185 4186 If this is set to the special value 0xFFFFFFFF then 4187 the fdt will not be copied at all on boot. For this 4188 to work it must reside in writable memory, have 4189 sufficient padding on the end of it for u-boot to 4190 add the information it needs into it, and the memory 4191 must be accessible by the kernel. 4192 4193 fdtcontroladdr- if set this is the address of the control flattened 4194 device tree used by U-Boot when CONFIG_OF_CONTROL is 4195 defined. 4196 4197 i2cfast - (PPC405GP|PPC405EP only) 4198 if set to 'y' configures Linux I2C driver for fast 4199 mode (400kHZ). This environment variable is used in 4200 initialization code. So, for changes to be effective 4201 it must be saved and board must be reset. 4202 4203 initrd_high - restrict positioning of initrd images: 4204 If this variable is not set, initrd images will be 4205 copied to the highest possible address in RAM; this 4206 is usually what you want since it allows for 4207 maximum initrd size. If for some reason you want to 4208 make sure that the initrd image is loaded below the 4209 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4210 variable to a value of "no" or "off" or "0". 4211 Alternatively, you can set it to a maximum upper 4212 address to use (U-Boot will still check that it 4213 does not overwrite the U-Boot stack and data). 4214 4215 For instance, when you have a system with 16 MB 4216 RAM, and want to reserve 4 MB from use by Linux, 4217 you can do this by adding "mem=12M" to the value of 4218 the "bootargs" variable. However, now you must make 4219 sure that the initrd image is placed in the first 4220 12 MB as well - this can be done with 4221 4222 setenv initrd_high 00c00000 4223 4224 If you set initrd_high to 0xFFFFFFFF, this is an 4225 indication to U-Boot that all addresses are legal 4226 for the Linux kernel, including addresses in flash 4227 memory. In this case U-Boot will NOT COPY the 4228 ramdisk at all. This may be useful to reduce the 4229 boot time on your system, but requires that this 4230 feature is supported by your Linux kernel. 4231 4232 ipaddr - IP address; needed for tftpboot command 4233 4234 loadaddr - Default load address for commands like "bootp", 4235 "rarpboot", "tftpboot", "loadb" or "diskboot" 4236 4237 loads_echo - see CONFIG_LOADS_ECHO 4238 4239 serverip - TFTP server IP address; needed for tftpboot command 4240 4241 bootretry - see CONFIG_BOOT_RETRY_TIME 4242 4243 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4244 4245 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4246 4247 ethprime - controls which interface is used first. 4248 4249 ethact - controls which interface is currently active. 4250 For example you can do the following 4251 4252 => setenv ethact FEC 4253 => ping 192.168.0.1 # traffic sent on FEC 4254 => setenv ethact SCC 4255 => ping 10.0.0.1 # traffic sent on SCC 4256 4257 ethrotate - When set to "no" U-Boot does not go through all 4258 available network interfaces. 4259 It just stays at the currently selected interface. 4260 4261 netretry - When set to "no" each network operation will 4262 either succeed or fail without retrying. 4263 When set to "once" the network operation will 4264 fail when all the available network interfaces 4265 are tried once without success. 4266 Useful on scripts which control the retry operation 4267 themselves. 4268 4269 npe_ucode - set load address for the NPE microcode 4270 4271 tftpsrcport - If this is set, the value is used for TFTP's 4272 UDP source port. 4273 4274 tftpdstport - If this is set, the value is used for TFTP's UDP 4275 destination port instead of the Well Know Port 69. 4276 4277 tftpblocksize - Block size to use for TFTP transfers; if not set, 4278 we use the TFTP server's default block size 4279 4280 tftptimeout - Retransmission timeout for TFTP packets (in milli- 4281 seconds, minimum value is 1000 = 1 second). Defines 4282 when a packet is considered to be lost so it has to 4283 be retransmitted. The default is 5000 = 5 seconds. 4284 Lowering this value may make downloads succeed 4285 faster in networks with high packet loss rates or 4286 with unreliable TFTP servers. 4287 4288 vlan - When set to a value < 4095 the traffic over 4289 Ethernet is encapsulated/received over 802.1q 4290 VLAN tagged frames. 4291 4292The following image location variables contain the location of images 4293used in booting. The "Image" column gives the role of the image and is 4294not an environment variable name. The other columns are environment 4295variable names. "File Name" gives the name of the file on a TFTP 4296server, "RAM Address" gives the location in RAM the image will be 4297loaded to, and "Flash Location" gives the image's address in NOR 4298flash or offset in NAND flash. 4299 4300*Note* - these variables don't have to be defined for all boards, some 4301boards currenlty use other variables for these purposes, and some 4302boards use these variables for other purposes. 4303 4304Image File Name RAM Address Flash Location 4305----- --------- ----------- -------------- 4306u-boot u-boot u-boot_addr_r u-boot_addr 4307Linux kernel bootfile kernel_addr_r kernel_addr 4308device tree blob fdtfile fdt_addr_r fdt_addr 4309ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 4310 4311The following environment variables may be used and automatically 4312updated by the network boot commands ("bootp" and "rarpboot"), 4313depending the information provided by your boot server: 4314 4315 bootfile - see above 4316 dnsip - IP address of your Domain Name Server 4317 dnsip2 - IP address of your secondary Domain Name Server 4318 gatewayip - IP address of the Gateway (Router) to use 4319 hostname - Target hostname 4320 ipaddr - see above 4321 netmask - Subnet Mask 4322 rootpath - Pathname of the root filesystem on the NFS server 4323 serverip - see above 4324 4325 4326There are two special Environment Variables: 4327 4328 serial# - contains hardware identification information such 4329 as type string and/or serial number 4330 ethaddr - Ethernet address 4331 4332These variables can be set only once (usually during manufacturing of 4333the board). U-Boot refuses to delete or overwrite these variables 4334once they have been set once. 4335 4336 4337Further special Environment Variables: 4338 4339 ver - Contains the U-Boot version string as printed 4340 with the "version" command. This variable is 4341 readonly (see CONFIG_VERSION_VARIABLE). 4342 4343 4344Please note that changes to some configuration parameters may take 4345only effect after the next boot (yes, that's just like Windoze :-). 4346 4347 4348Callback functions for environment variables: 4349--------------------------------------------- 4350 4351For some environment variables, the behavior of u-boot needs to change 4352when their values are changed. This functionailty allows functions to 4353be associated with arbitrary variables. On creation, overwrite, or 4354deletion, the callback will provide the opportunity for some side 4355effect to happen or for the change to be rejected. 4356 4357The callbacks are named and associated with a function using the 4358U_BOOT_ENV_CALLBACK macro in your board or driver code. 4359 4360These callbacks are associated with variables in one of two ways. The 4361static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 4362in the board configuration to a string that defines a list of 4363associations. The list must be in the following format: 4364 4365 entry = variable_name[:callback_name] 4366 list = entry[,list] 4367 4368If the callback name is not specified, then the callback is deleted. 4369Spaces are also allowed anywhere in the list. 4370 4371Callbacks can also be associated by defining the ".callbacks" variable 4372with the same list format above. Any association in ".callbacks" will 4373override any association in the static list. You can define 4374CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 4375".callbacks" envirnoment variable in the default or embedded environment. 4376 4377 4378Command Line Parsing: 4379===================== 4380 4381There are two different command line parsers available with U-Boot: 4382the old "simple" one, and the much more powerful "hush" shell: 4383 4384Old, simple command line parser: 4385-------------------------------- 4386 4387- supports environment variables (through setenv / saveenv commands) 4388- several commands on one line, separated by ';' 4389- variable substitution using "... ${name} ..." syntax 4390- special characters ('$', ';') can be escaped by prefixing with '\', 4391 for example: 4392 setenv bootcmd bootm \${address} 4393- You can also escape text by enclosing in single apostrophes, for example: 4394 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 4395 4396Hush shell: 4397----------- 4398 4399- similar to Bourne shell, with control structures like 4400 if...then...else...fi, for...do...done; while...do...done, 4401 until...do...done, ... 4402- supports environment ("global") variables (through setenv / saveenv 4403 commands) and local shell variables (through standard shell syntax 4404 "name=value"); only environment variables can be used with "run" 4405 command 4406 4407General rules: 4408-------------- 4409 4410(1) If a command line (or an environment variable executed by a "run" 4411 command) contains several commands separated by semicolon, and 4412 one of these commands fails, then the remaining commands will be 4413 executed anyway. 4414 4415(2) If you execute several variables with one call to run (i. e. 4416 calling run with a list of variables as arguments), any failing 4417 command will cause "run" to terminate, i. e. the remaining 4418 variables are not executed. 4419 4420Note for Redundant Ethernet Interfaces: 4421======================================= 4422 4423Some boards come with redundant Ethernet interfaces; U-Boot supports 4424such configurations and is capable of automatic selection of a 4425"working" interface when needed. MAC assignment works as follows: 4426 4427Network interfaces are numbered eth0, eth1, eth2, ... Corresponding 4428MAC addresses can be stored in the environment as "ethaddr" (=>eth0), 4429"eth1addr" (=>eth1), "eth2addr", ... 4430 4431If the network interface stores some valid MAC address (for instance 4432in SROM), this is used as default address if there is NO correspon- 4433ding setting in the environment; if the corresponding environment 4434variable is set, this overrides the settings in the card; that means: 4435 4436o If the SROM has a valid MAC address, and there is no address in the 4437 environment, the SROM's address is used. 4438 4439o If there is no valid address in the SROM, and a definition in the 4440 environment exists, then the value from the environment variable is 4441 used. 4442 4443o If both the SROM and the environment contain a MAC address, and 4444 both addresses are the same, this MAC address is used. 4445 4446o If both the SROM and the environment contain a MAC address, and the 4447 addresses differ, the value from the environment is used and a 4448 warning is printed. 4449 4450o If neither SROM nor the environment contain a MAC address, an error 4451 is raised. 4452 4453If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 4454will be programmed into hardware as part of the initialization process. This 4455may be skipped by setting the appropriate 'ethmacskip' environment variable. 4456The naming convention is as follows: 4457"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 4458 4459Image Formats: 4460============== 4461 4462U-Boot is capable of booting (and performing other auxiliary operations on) 4463images in two formats: 4464 4465New uImage format (FIT) 4466----------------------- 4467 4468Flexible and powerful format based on Flattened Image Tree -- FIT (similar 4469to Flattened Device Tree). It allows the use of images with multiple 4470components (several kernels, ramdisks, etc.), with contents protected by 4471SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 4472 4473 4474Old uImage format 4475----------------- 4476 4477Old image format is based on binary files which can be basically anything, 4478preceded by a special header; see the definitions in include/image.h for 4479details; basically, the header defines the following image properties: 4480 4481* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 4482 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 4483 LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 4484 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 4485 INTEGRITY). 4486* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 4487 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 4488 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 4489* Compression Type (uncompressed, gzip, bzip2) 4490* Load Address 4491* Entry Point 4492* Image Name 4493* Image Timestamp 4494 4495The header is marked by a special Magic Number, and both the header 4496and the data portions of the image are secured against corruption by 4497CRC32 checksums. 4498 4499 4500Linux Support: 4501============== 4502 4503Although U-Boot should support any OS or standalone application 4504easily, the main focus has always been on Linux during the design of 4505U-Boot. 4506 4507U-Boot includes many features that so far have been part of some 4508special "boot loader" code within the Linux kernel. Also, any 4509"initrd" images to be used are no longer part of one big Linux image; 4510instead, kernel and "initrd" are separate images. This implementation 4511serves several purposes: 4512 4513- the same features can be used for other OS or standalone 4514 applications (for instance: using compressed images to reduce the 4515 Flash memory footprint) 4516 4517- it becomes much easier to port new Linux kernel versions because 4518 lots of low-level, hardware dependent stuff are done by U-Boot 4519 4520- the same Linux kernel image can now be used with different "initrd" 4521 images; of course this also means that different kernel images can 4522 be run with the same "initrd". This makes testing easier (you don't 4523 have to build a new "zImage.initrd" Linux image when you just 4524 change a file in your "initrd"). Also, a field-upgrade of the 4525 software is easier now. 4526 4527 4528Linux HOWTO: 4529============ 4530 4531Porting Linux to U-Boot based systems: 4532--------------------------------------- 4533 4534U-Boot cannot save you from doing all the necessary modifications to 4535configure the Linux device drivers for use with your target hardware 4536(no, we don't intend to provide a full virtual machine interface to 4537Linux :-). 4538 4539But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 4540 4541Just make sure your machine specific header file (for instance 4542include/asm-ppc/tqm8xx.h) includes the same definition of the Board 4543Information structure as we define in include/asm-<arch>/u-boot.h, 4544and make sure that your definition of IMAP_ADDR uses the same value 4545as your U-Boot configuration in CONFIG_SYS_IMMR. 4546 4547 4548Configuring the Linux kernel: 4549----------------------------- 4550 4551No specific requirements for U-Boot. Make sure you have some root 4552device (initial ramdisk, NFS) for your target system. 4553 4554 4555Building a Linux Image: 4556----------------------- 4557 4558With U-Boot, "normal" build targets like "zImage" or "bzImage" are 4559not used. If you use recent kernel source, a new build target 4560"uImage" will exist which automatically builds an image usable by 4561U-Boot. Most older kernels also have support for a "pImage" target, 4562which was introduced for our predecessor project PPCBoot and uses a 4563100% compatible format. 4564 4565Example: 4566 4567 make TQM850L_config 4568 make oldconfig 4569 make dep 4570 make uImage 4571 4572The "uImage" build target uses a special tool (in 'tools/mkimage') to 4573encapsulate a compressed Linux kernel image with header information, 4574CRC32 checksum etc. for use with U-Boot. This is what we are doing: 4575 4576* build a standard "vmlinux" kernel image (in ELF binary format): 4577 4578* convert the kernel into a raw binary image: 4579 4580 ${CROSS_COMPILE}-objcopy -O binary \ 4581 -R .note -R .comment \ 4582 -S vmlinux linux.bin 4583 4584* compress the binary image: 4585 4586 gzip -9 linux.bin 4587 4588* package compressed binary image for U-Boot: 4589 4590 mkimage -A ppc -O linux -T kernel -C gzip \ 4591 -a 0 -e 0 -n "Linux Kernel Image" \ 4592 -d linux.bin.gz uImage 4593 4594 4595The "mkimage" tool can also be used to create ramdisk images for use 4596with U-Boot, either separated from the Linux kernel image, or 4597combined into one file. "mkimage" encapsulates the images with a 64 4598byte header containing information about target architecture, 4599operating system, image type, compression method, entry points, time 4600stamp, CRC32 checksums, etc. 4601 4602"mkimage" can be called in two ways: to verify existing images and 4603print the header information, or to build new images. 4604 4605In the first form (with "-l" option) mkimage lists the information 4606contained in the header of an existing U-Boot image; this includes 4607checksum verification: 4608 4609 tools/mkimage -l image 4610 -l ==> list image header information 4611 4612The second form (with "-d" option) is used to build a U-Boot image 4613from a "data file" which is used as image payload: 4614 4615 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 4616 -n name -d data_file image 4617 -A ==> set architecture to 'arch' 4618 -O ==> set operating system to 'os' 4619 -T ==> set image type to 'type' 4620 -C ==> set compression type 'comp' 4621 -a ==> set load address to 'addr' (hex) 4622 -e ==> set entry point to 'ep' (hex) 4623 -n ==> set image name to 'name' 4624 -d ==> use image data from 'datafile' 4625 4626Right now, all Linux kernels for PowerPC systems use the same load 4627address (0x00000000), but the entry point address depends on the 4628kernel version: 4629 4630- 2.2.x kernels have the entry point at 0x0000000C, 4631- 2.3.x and later kernels have the entry point at 0x00000000. 4632 4633So a typical call to build a U-Boot image would read: 4634 4635 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 4636 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 4637 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 4638 > examples/uImage.TQM850L 4639 Image Name: 2.4.4 kernel for TQM850L 4640 Created: Wed Jul 19 02:34:59 2000 4641 Image Type: PowerPC Linux Kernel Image (gzip compressed) 4642 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4643 Load Address: 0x00000000 4644 Entry Point: 0x00000000 4645 4646To verify the contents of the image (or check for corruption): 4647 4648 -> tools/mkimage -l examples/uImage.TQM850L 4649 Image Name: 2.4.4 kernel for TQM850L 4650 Created: Wed Jul 19 02:34:59 2000 4651 Image Type: PowerPC Linux Kernel Image (gzip compressed) 4652 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 4653 Load Address: 0x00000000 4654 Entry Point: 0x00000000 4655 4656NOTE: for embedded systems where boot time is critical you can trade 4657speed for memory and install an UNCOMPRESSED image instead: this 4658needs more space in Flash, but boots much faster since it does not 4659need to be uncompressed: 4660 4661 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 4662 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 4663 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 4664 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 4665 > examples/uImage.TQM850L-uncompressed 4666 Image Name: 2.4.4 kernel for TQM850L 4667 Created: Wed Jul 19 02:34:59 2000 4668 Image Type: PowerPC Linux Kernel Image (uncompressed) 4669 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 4670 Load Address: 0x00000000 4671 Entry Point: 0x00000000 4672 4673 4674Similar you can build U-Boot images from a 'ramdisk.image.gz' file 4675when your kernel is intended to use an initial ramdisk: 4676 4677 -> tools/mkimage -n 'Simple Ramdisk Image' \ 4678 > -A ppc -O linux -T ramdisk -C gzip \ 4679 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 4680 Image Name: Simple Ramdisk Image 4681 Created: Wed Jan 12 14:01:50 2000 4682 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4683 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 4684 Load Address: 0x00000000 4685 Entry Point: 0x00000000 4686 4687 4688Installing a Linux Image: 4689------------------------- 4690 4691To downloading a U-Boot image over the serial (console) interface, 4692you must convert the image to S-Record format: 4693 4694 objcopy -I binary -O srec examples/image examples/image.srec 4695 4696The 'objcopy' does not understand the information in the U-Boot 4697image header, so the resulting S-Record file will be relative to 4698address 0x00000000. To load it to a given address, you need to 4699specify the target address as 'offset' parameter with the 'loads' 4700command. 4701 4702Example: install the image to address 0x40100000 (which on the 4703TQM8xxL is in the first Flash bank): 4704 4705 => erase 40100000 401FFFFF 4706 4707 .......... done 4708 Erased 8 sectors 4709 4710 => loads 40100000 4711 ## Ready for S-Record download ... 4712 ~>examples/image.srec 4713 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 4714 ... 4715 15989 15990 15991 15992 4716 [file transfer complete] 4717 [connected] 4718 ## Start Addr = 0x00000000 4719 4720 4721You can check the success of the download using the 'iminfo' command; 4722this includes a checksum verification so you can be sure no data 4723corruption happened: 4724 4725 => imi 40100000 4726 4727 ## Checking Image at 40100000 ... 4728 Image Name: 2.2.13 for initrd on TQM850L 4729 Image Type: PowerPC Linux Kernel Image (gzip compressed) 4730 Data Size: 335725 Bytes = 327 kB = 0 MB 4731 Load Address: 00000000 4732 Entry Point: 0000000c 4733 Verifying Checksum ... OK 4734 4735 4736Boot Linux: 4737----------- 4738 4739The "bootm" command is used to boot an application that is stored in 4740memory (RAM or Flash). In case of a Linux kernel image, the contents 4741of the "bootargs" environment variable is passed to the kernel as 4742parameters. You can check and modify this variable using the 4743"printenv" and "setenv" commands: 4744 4745 4746 => printenv bootargs 4747 bootargs=root=/dev/ram 4748 4749 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4750 4751 => printenv bootargs 4752 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4753 4754 => bootm 40020000 4755 ## Booting Linux kernel at 40020000 ... 4756 Image Name: 2.2.13 for NFS on TQM850L 4757 Image Type: PowerPC Linux Kernel Image (gzip compressed) 4758 Data Size: 381681 Bytes = 372 kB = 0 MB 4759 Load Address: 00000000 4760 Entry Point: 0000000c 4761 Verifying Checksum ... OK 4762 Uncompressing Kernel Image ... OK 4763 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 4764 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 4765 time_init: decrementer frequency = 187500000/60 4766 Calibrating delay loop... 49.77 BogoMIPS 4767 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 4768 ... 4769 4770If you want to boot a Linux kernel with initial RAM disk, you pass 4771the memory addresses of both the kernel and the initrd image (PPBCOOT 4772format!) to the "bootm" command: 4773 4774 => imi 40100000 40200000 4775 4776 ## Checking Image at 40100000 ... 4777 Image Name: 2.2.13 for initrd on TQM850L 4778 Image Type: PowerPC Linux Kernel Image (gzip compressed) 4779 Data Size: 335725 Bytes = 327 kB = 0 MB 4780 Load Address: 00000000 4781 Entry Point: 0000000c 4782 Verifying Checksum ... OK 4783 4784 ## Checking Image at 40200000 ... 4785 Image Name: Simple Ramdisk Image 4786 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4787 Data Size: 566530 Bytes = 553 kB = 0 MB 4788 Load Address: 00000000 4789 Entry Point: 00000000 4790 Verifying Checksum ... OK 4791 4792 => bootm 40100000 40200000 4793 ## Booting Linux kernel at 40100000 ... 4794 Image Name: 2.2.13 for initrd on TQM850L 4795 Image Type: PowerPC Linux Kernel Image (gzip compressed) 4796 Data Size: 335725 Bytes = 327 kB = 0 MB 4797 Load Address: 00000000 4798 Entry Point: 0000000c 4799 Verifying Checksum ... OK 4800 Uncompressing Kernel Image ... OK 4801 ## Loading RAMDisk Image at 40200000 ... 4802 Image Name: Simple Ramdisk Image 4803 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 4804 Data Size: 566530 Bytes = 553 kB = 0 MB 4805 Load Address: 00000000 4806 Entry Point: 00000000 4807 Verifying Checksum ... OK 4808 Loading Ramdisk ... OK 4809 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 4810 Boot arguments: root=/dev/ram 4811 time_init: decrementer frequency = 187500000/60 4812 Calibrating delay loop... 49.77 BogoMIPS 4813 ... 4814 RAMDISK: Compressed image found at block 0 4815 VFS: Mounted root (ext2 filesystem). 4816 4817 bash# 4818 4819Boot Linux and pass a flat device tree: 4820----------- 4821 4822First, U-Boot must be compiled with the appropriate defines. See the section 4823titled "Linux Kernel Interface" above for a more in depth explanation. The 4824following is an example of how to start a kernel and pass an updated 4825flat device tree: 4826 4827=> print oftaddr 4828oftaddr=0x300000 4829=> print oft 4830oft=oftrees/mpc8540ads.dtb 4831=> tftp $oftaddr $oft 4832Speed: 1000, full duplex 4833Using TSEC0 device 4834TFTP from server 192.168.1.1; our IP address is 192.168.1.101 4835Filename 'oftrees/mpc8540ads.dtb'. 4836Load address: 0x300000 4837Loading: # 4838done 4839Bytes transferred = 4106 (100a hex) 4840=> tftp $loadaddr $bootfile 4841Speed: 1000, full duplex 4842Using TSEC0 device 4843TFTP from server 192.168.1.1; our IP address is 192.168.1.2 4844Filename 'uImage'. 4845Load address: 0x200000 4846Loading:############ 4847done 4848Bytes transferred = 1029407 (fb51f hex) 4849=> print loadaddr 4850loadaddr=200000 4851=> print oftaddr 4852oftaddr=0x300000 4853=> bootm $loadaddr - $oftaddr 4854## Booting image at 00200000 ... 4855 Image Name: Linux-2.6.17-dirty 4856 Image Type: PowerPC Linux Kernel Image (gzip compressed) 4857 Data Size: 1029343 Bytes = 1005.2 kB 4858 Load Address: 00000000 4859 Entry Point: 00000000 4860 Verifying Checksum ... OK 4861 Uncompressing Kernel Image ... OK 4862Booting using flat device tree at 0x300000 4863Using MPC85xx ADS machine description 4864Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 4865[snip] 4866 4867 4868More About U-Boot Image Types: 4869------------------------------ 4870 4871U-Boot supports the following image types: 4872 4873 "Standalone Programs" are directly runnable in the environment 4874 provided by U-Boot; it is expected that (if they behave 4875 well) you can continue to work in U-Boot after return from 4876 the Standalone Program. 4877 "OS Kernel Images" are usually images of some Embedded OS which 4878 will take over control completely. Usually these programs 4879 will install their own set of exception handlers, device 4880 drivers, set up the MMU, etc. - this means, that you cannot 4881 expect to re-enter U-Boot except by resetting the CPU. 4882 "RAMDisk Images" are more or less just data blocks, and their 4883 parameters (address, size) are passed to an OS kernel that is 4884 being started. 4885 "Multi-File Images" contain several images, typically an OS 4886 (Linux) kernel image and one or more data images like 4887 RAMDisks. This construct is useful for instance when you want 4888 to boot over the network using BOOTP etc., where the boot 4889 server provides just a single image file, but you want to get 4890 for instance an OS kernel and a RAMDisk image. 4891 4892 "Multi-File Images" start with a list of image sizes, each 4893 image size (in bytes) specified by an "uint32_t" in network 4894 byte order. This list is terminated by an "(uint32_t)0". 4895 Immediately after the terminating 0 follow the images, one by 4896 one, all aligned on "uint32_t" boundaries (size rounded up to 4897 a multiple of 4 bytes). 4898 4899 "Firmware Images" are binary images containing firmware (like 4900 U-Boot or FPGA images) which usually will be programmed to 4901 flash memory. 4902 4903 "Script files" are command sequences that will be executed by 4904 U-Boot's command interpreter; this feature is especially 4905 useful when you configure U-Boot to use a real shell (hush) 4906 as command interpreter. 4907 4908Booting the Linux zImage: 4909------------------------- 4910 4911On some platforms, it's possible to boot Linux zImage. This is done 4912using the "bootz" command. The syntax of "bootz" command is the same 4913as the syntax of "bootm" command. 4914 4915Note, defining the CONFIG_SUPPORT_INITRD_RAW allows user to supply 4916kernel with raw initrd images. The syntax is slightly different, the 4917address of the initrd must be augmented by it's size, in the following 4918format: "<initrd addres>:<initrd size>". 4919 4920 4921Standalone HOWTO: 4922================= 4923 4924One of the features of U-Boot is that you can dynamically load and 4925run "standalone" applications, which can use some resources of 4926U-Boot like console I/O functions or interrupt services. 4927 4928Two simple examples are included with the sources: 4929 4930"Hello World" Demo: 4931------------------- 4932 4933'examples/hello_world.c' contains a small "Hello World" Demo 4934application; it is automatically compiled when you build U-Boot. 4935It's configured to run at address 0x00040004, so you can play with it 4936like that: 4937 4938 => loads 4939 ## Ready for S-Record download ... 4940 ~>examples/hello_world.srec 4941 1 2 3 4 5 6 7 8 9 10 11 ... 4942 [file transfer complete] 4943 [connected] 4944 ## Start Addr = 0x00040004 4945 4946 => go 40004 Hello World! This is a test. 4947 ## Starting application at 0x00040004 ... 4948 Hello World 4949 argc = 7 4950 argv[0] = "40004" 4951 argv[1] = "Hello" 4952 argv[2] = "World!" 4953 argv[3] = "This" 4954 argv[4] = "is" 4955 argv[5] = "a" 4956 argv[6] = "test." 4957 argv[7] = "<NULL>" 4958 Hit any key to exit ... 4959 4960 ## Application terminated, rc = 0x0 4961 4962Another example, which demonstrates how to register a CPM interrupt 4963handler with the U-Boot code, can be found in 'examples/timer.c'. 4964Here, a CPM timer is set up to generate an interrupt every second. 4965The interrupt service routine is trivial, just printing a '.' 4966character, but this is just a demo program. The application can be 4967controlled by the following keys: 4968 4969 ? - print current values og the CPM Timer registers 4970 b - enable interrupts and start timer 4971 e - stop timer and disable interrupts 4972 q - quit application 4973 4974 => loads 4975 ## Ready for S-Record download ... 4976 ~>examples/timer.srec 4977 1 2 3 4 5 6 7 8 9 10 11 ... 4978 [file transfer complete] 4979 [connected] 4980 ## Start Addr = 0x00040004 4981 4982 => go 40004 4983 ## Starting application at 0x00040004 ... 4984 TIMERS=0xfff00980 4985 Using timer 1 4986 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 4987 4988Hit 'b': 4989 [q, b, e, ?] Set interval 1000000 us 4990 Enabling timer 4991Hit '?': 4992 [q, b, e, ?] ........ 4993 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 4994Hit '?': 4995 [q, b, e, ?] . 4996 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 4997Hit '?': 4998 [q, b, e, ?] . 4999 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5000Hit '?': 5001 [q, b, e, ?] . 5002 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5003Hit 'e': 5004 [q, b, e, ?] ...Stopping timer 5005Hit 'q': 5006 [q, b, e, ?] ## Application terminated, rc = 0x0 5007 5008 5009Minicom warning: 5010================ 5011 5012Over time, many people have reported problems when trying to use the 5013"minicom" terminal emulation program for serial download. I (wd) 5014consider minicom to be broken, and recommend not to use it. Under 5015Unix, I recommend to use C-Kermit for general purpose use (and 5016especially for kermit binary protocol download ("loadb" command), and 5017use "cu" for S-Record download ("loads" command). See 5018http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5019for help with kermit. 5020 5021 5022Nevertheless, if you absolutely want to use it try adding this 5023configuration to your "File transfer protocols" section: 5024 5025 Name Program Name U/D FullScr IO-Red. Multi 5026 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 5027 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 5028 5029 5030NetBSD Notes: 5031============= 5032 5033Starting at version 0.9.2, U-Boot supports NetBSD both as host 5034(build U-Boot) and target system (boots NetBSD/mpc8xx). 5035 5036Building requires a cross environment; it is known to work on 5037NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5038need gmake since the Makefiles are not compatible with BSD make). 5039Note that the cross-powerpc package does not install include files; 5040attempting to build U-Boot will fail because <machine/ansi.h> is 5041missing. This file has to be installed and patched manually: 5042 5043 # cd /usr/pkg/cross/powerpc-netbsd/include 5044 # mkdir powerpc 5045 # ln -s powerpc machine 5046 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5047 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5048 5049Native builds *don't* work due to incompatibilities between native 5050and U-Boot include files. 5051 5052Booting assumes that (the first part of) the image booted is a 5053stage-2 loader which in turn loads and then invokes the kernel 5054proper. Loader sources will eventually appear in the NetBSD source 5055tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 5056meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5057 5058 5059Implementation Internals: 5060========================= 5061 5062The following is not intended to be a complete description of every 5063implementation detail. However, it should help to understand the 5064inner workings of U-Boot and make it easier to port it to custom 5065hardware. 5066 5067 5068Initial Stack, Global Data: 5069--------------------------- 5070 5071The implementation of U-Boot is complicated by the fact that U-Boot 5072starts running out of ROM (flash memory), usually without access to 5073system RAM (because the memory controller is not initialized yet). 5074This means that we don't have writable Data or BSS segments, and BSS 5075is not initialized as zero. To be able to get a C environment working 5076at all, we have to allocate at least a minimal stack. Implementation 5077options for this are defined and restricted by the CPU used: Some CPU 5078models provide on-chip memory (like the IMMR area on MPC8xx and 5079MPC826x processors), on others (parts of) the data cache can be 5080locked as (mis-) used as memory, etc. 5081 5082 Chris Hallinan posted a good summary of these issues to the 5083 U-Boot mailing list: 5084 5085 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 5086 From: "Chris Hallinan" <clh@net1plus.com> 5087 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 5088 ... 5089 5090 Correct me if I'm wrong, folks, but the way I understand it 5091 is this: Using DCACHE as initial RAM for Stack, etc, does not 5092 require any physical RAM backing up the cache. The cleverness 5093 is that the cache is being used as a temporary supply of 5094 necessary storage before the SDRAM controller is setup. It's 5095 beyond the scope of this list to explain the details, but you 5096 can see how this works by studying the cache architecture and 5097 operation in the architecture and processor-specific manuals. 5098 5099 OCM is On Chip Memory, which I believe the 405GP has 4K. It 5100 is another option for the system designer to use as an 5101 initial stack/RAM area prior to SDRAM being available. Either 5102 option should work for you. Using CS 4 should be fine if your 5103 board designers haven't used it for something that would 5104 cause you grief during the initial boot! It is frequently not 5105 used. 5106 5107 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 5108 with your processor/board/system design. The default value 5109 you will find in any recent u-boot distribution in 5110 walnut.h should work for you. I'd set it to a value larger 5111 than your SDRAM module. If you have a 64MB SDRAM module, set 5112 it above 400_0000. Just make sure your board has no resources 5113 that are supposed to respond to that address! That code in 5114 start.S has been around a while and should work as is when 5115 you get the config right. 5116 5117 -Chris Hallinan 5118 DS4.COM, Inc. 5119 5120It is essential to remember this, since it has some impact on the C 5121code for the initialization procedures: 5122 5123* Initialized global data (data segment) is read-only. Do not attempt 5124 to write it. 5125 5126* Do not use any uninitialized global data (or implicitely initialized 5127 as zero data - BSS segment) at all - this is undefined, initiali- 5128 zation is performed later (when relocating to RAM). 5129 5130* Stack space is very limited. Avoid big data buffers or things like 5131 that. 5132 5133Having only the stack as writable memory limits means we cannot use 5134normal global data to share information beween the code. But it 5135turned out that the implementation of U-Boot can be greatly 5136simplified by making a global data structure (gd_t) available to all 5137functions. We could pass a pointer to this data as argument to _all_ 5138functions, but this would bloat the code. Instead we use a feature of 5139the GCC compiler (Global Register Variables) to share the data: we 5140place a pointer (gd) to the global data into a register which we 5141reserve for this purpose. 5142 5143When choosing a register for such a purpose we are restricted by the 5144relevant (E)ABI specifications for the current architecture, and by 5145GCC's implementation. 5146 5147For PowerPC, the following registers have specific use: 5148 R1: stack pointer 5149 R2: reserved for system use 5150 R3-R4: parameter passing and return values 5151 R5-R10: parameter passing 5152 R13: small data area pointer 5153 R30: GOT pointer 5154 R31: frame pointer 5155 5156 (U-Boot also uses R12 as internal GOT pointer. r12 5157 is a volatile register so r12 needs to be reset when 5158 going back and forth between asm and C) 5159 5160 ==> U-Boot will use R2 to hold a pointer to the global data 5161 5162 Note: on PPC, we could use a static initializer (since the 5163 address of the global data structure is known at compile time), 5164 but it turned out that reserving a register results in somewhat 5165 smaller code - although the code savings are not that big (on 5166 average for all boards 752 bytes for the whole U-Boot image, 5167 624 text + 127 data). 5168 5169On Blackfin, the normal C ABI (except for P3) is followed as documented here: 5170 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 5171 5172 ==> U-Boot will use P3 to hold a pointer to the global data 5173 5174On ARM, the following registers are used: 5175 5176 R0: function argument word/integer result 5177 R1-R3: function argument word 5178 R9: GOT pointer 5179 R10: stack limit (used only if stack checking if enabled) 5180 R11: argument (frame) pointer 5181 R12: temporary workspace 5182 R13: stack pointer 5183 R14: link register 5184 R15: program counter 5185 5186 ==> U-Boot will use R8 to hold a pointer to the global data 5187 5188On Nios II, the ABI is documented here: 5189 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 5190 5191 ==> U-Boot will use gp to hold a pointer to the global data 5192 5193 Note: on Nios II, we give "-G0" option to gcc and don't use gp 5194 to access small data sections, so gp is free. 5195 5196On NDS32, the following registers are used: 5197 5198 R0-R1: argument/return 5199 R2-R5: argument 5200 R15: temporary register for assembler 5201 R16: trampoline register 5202 R28: frame pointer (FP) 5203 R29: global pointer (GP) 5204 R30: link register (LP) 5205 R31: stack pointer (SP) 5206 PC: program counter (PC) 5207 5208 ==> U-Boot will use R10 to hold a pointer to the global data 5209 5210NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5211or current versions of GCC may "optimize" the code too much. 5212 5213Memory Management: 5214------------------ 5215 5216U-Boot runs in system state and uses physical addresses, i.e. the 5217MMU is not used either for address mapping nor for memory protection. 5218 5219The available memory is mapped to fixed addresses using the memory 5220controller. In this process, a contiguous block is formed for each 5221memory type (Flash, SDRAM, SRAM), even when it consists of several 5222physical memory banks. 5223 5224U-Boot is installed in the first 128 kB of the first Flash bank (on 5225TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5226booting and sizing and initializing DRAM, the code relocates itself 5227to the upper end of DRAM. Immediately below the U-Boot code some 5228memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5229configuration setting]. Below that, a structure with global Board 5230Info data is placed, followed by the stack (growing downward). 5231 5232Additionally, some exception handler code is copied to the low 8 kB 5233of DRAM (0x00000000 ... 0x00001FFF). 5234 5235So a typical memory configuration with 16 MB of DRAM could look like 5236this: 5237 5238 0x0000 0000 Exception Vector code 5239 : 5240 0x0000 1FFF 5241 0x0000 2000 Free for Application Use 5242 : 5243 : 5244 5245 : 5246 : 5247 0x00FB FF20 Monitor Stack (Growing downward) 5248 0x00FB FFAC Board Info Data and permanent copy of global data 5249 0x00FC 0000 Malloc Arena 5250 : 5251 0x00FD FFFF 5252 0x00FE 0000 RAM Copy of Monitor Code 5253 ... eventually: LCD or video framebuffer 5254 ... eventually: pRAM (Protected RAM - unchanged by reset) 5255 0x00FF FFFF [End of RAM] 5256 5257 5258System Initialization: 5259---------------------- 5260 5261In the reset configuration, U-Boot starts at the reset entry point 5262(on most PowerPC systems at address 0x00000100). Because of the reset 5263configuration for CS0# this is a mirror of the onboard Flash memory. 5264To be able to re-map memory U-Boot then jumps to its link address. 5265To be able to implement the initialization code in C, a (small!) 5266initial stack is set up in the internal Dual Ported RAM (in case CPUs 5267which provide such a feature like MPC8xx or MPC8260), or in a locked 5268part of the data cache. After that, U-Boot initializes the CPU core, 5269the caches and the SIU. 5270 5271Next, all (potentially) available memory banks are mapped using a 5272preliminary mapping. For example, we put them on 512 MB boundaries 5273(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5274on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5275programmed for SDRAM access. Using the temporary configuration, a 5276simple memory test is run that determines the size of the SDRAM 5277banks. 5278 5279When there is more than one SDRAM bank, and the banks are of 5280different size, the largest is mapped first. For equal size, the first 5281bank (CS2#) is mapped first. The first mapping is always for address 52820x00000000, with any additional banks following immediately to create 5283contiguous memory starting from 0. 5284 5285Then, the monitor installs itself at the upper end of the SDRAM area 5286and allocates memory for use by malloc() and for the global Board 5287Info data; also, the exception vector code is copied to the low RAM 5288pages, and the final stack is set up. 5289 5290Only after this relocation will you have a "normal" C environment; 5291until that you are restricted in several ways, mostly because you are 5292running from ROM, and because the code will have to be relocated to a 5293new address in RAM. 5294 5295 5296U-Boot Porting Guide: 5297---------------------- 5298 5299[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 5300list, October 2002] 5301 5302 5303int main(int argc, char *argv[]) 5304{ 5305 sighandler_t no_more_time; 5306 5307 signal(SIGALRM, no_more_time); 5308 alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 5309 5310 if (available_money > available_manpower) { 5311 Pay consultant to port U-Boot; 5312 return 0; 5313 } 5314 5315 Download latest U-Boot source; 5316 5317 Subscribe to u-boot mailing list; 5318 5319 if (clueless) 5320 email("Hi, I am new to U-Boot, how do I get started?"); 5321 5322 while (learning) { 5323 Read the README file in the top level directory; 5324 Read http://www.denx.de/twiki/bin/view/DULG/Manual; 5325 Read applicable doc/*.README; 5326 Read the source, Luke; 5327 /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 5328 } 5329 5330 if (available_money > toLocalCurrency ($2500)) 5331 Buy a BDI3000; 5332 else 5333 Add a lot of aggravation and time; 5334 5335 if (a similar board exists) { /* hopefully... */ 5336 cp -a board/<similar> board/<myboard> 5337 cp include/configs/<similar>.h include/configs/<myboard>.h 5338 } else { 5339 Create your own board support subdirectory; 5340 Create your own board include/configs/<myboard>.h file; 5341 } 5342 Edit new board/<myboard> files 5343 Edit new include/configs/<myboard>.h 5344 5345 while (!accepted) { 5346 while (!running) { 5347 do { 5348 Add / modify source code; 5349 } until (compiles); 5350 Debug; 5351 if (clueless) 5352 email("Hi, I am having problems..."); 5353 } 5354 Send patch file to the U-Boot email list; 5355 if (reasonable critiques) 5356 Incorporate improvements from email list code review; 5357 else 5358 Defend code as written; 5359 } 5360 5361 return 0; 5362} 5363 5364void no_more_time (int sig) 5365{ 5366 hire_a_guru(); 5367} 5368 5369 5370Coding Standards: 5371----------------- 5372 5373All contributions to U-Boot should conform to the Linux kernel 5374coding style; see the file "Documentation/CodingStyle" and the script 5375"scripts/Lindent" in your Linux kernel source directory. 5376 5377Source files originating from a different project (for example the 5378MTD subsystem) are generally exempt from these guidelines and are not 5379reformated to ease subsequent migration to newer versions of those 5380sources. 5381 5382Please note that U-Boot is implemented in C (and to some small parts in 5383Assembler); no C++ is used, so please do not use C++ style comments (//) 5384in your code. 5385 5386Please also stick to the following formatting rules: 5387- remove any trailing white space 5388- use TAB characters for indentation and vertical alignment, not spaces 5389- make sure NOT to use DOS '\r\n' line feeds 5390- do not add more than 2 consecutive empty lines to source files 5391- do not add trailing empty lines to source files 5392 5393Submissions which do not conform to the standards may be returned 5394with a request to reformat the changes. 5395 5396 5397Submitting Patches: 5398------------------- 5399 5400Since the number of patches for U-Boot is growing, we need to 5401establish some rules. Submissions which do not conform to these rules 5402may be rejected, even when they contain important and valuable stuff. 5403 5404Please see http://www.denx.de/wiki/U-Boot/Patches for details. 5405 5406Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 5407see http://lists.denx.de/mailman/listinfo/u-boot 5408 5409When you send a patch, please include the following information with 5410it: 5411 5412* For bug fixes: a description of the bug and how your patch fixes 5413 this bug. Please try to include a way of demonstrating that the 5414 patch actually fixes something. 5415 5416* For new features: a description of the feature and your 5417 implementation. 5418 5419* A CHANGELOG entry as plaintext (separate from the patch) 5420 5421* For major contributions, your entry to the CREDITS file 5422 5423* When you add support for a new board, don't forget to add this 5424 board to the MAINTAINERS file, too. 5425 5426* If your patch adds new configuration options, don't forget to 5427 document these in the README file. 5428 5429* The patch itself. If you are using git (which is *strongly* 5430 recommended) you can easily generate the patch using the 5431 "git format-patch". If you then use "git send-email" to send it to 5432 the U-Boot mailing list, you will avoid most of the common problems 5433 with some other mail clients. 5434 5435 If you cannot use git, use "diff -purN OLD NEW". If your version of 5436 diff does not support these options, then get the latest version of 5437 GNU diff. 5438 5439 The current directory when running this command shall be the parent 5440 directory of the U-Boot source tree (i. e. please make sure that 5441 your patch includes sufficient directory information for the 5442 affected files). 5443 5444 We prefer patches as plain text. MIME attachments are discouraged, 5445 and compressed attachments must not be used. 5446 5447* If one logical set of modifications affects or creates several 5448 files, all these changes shall be submitted in a SINGLE patch file. 5449 5450* Changesets that contain different, unrelated modifications shall be 5451 submitted as SEPARATE patches, one patch per changeset. 5452 5453 5454Notes: 5455 5456* Before sending the patch, run the MAKEALL script on your patched 5457 source tree and make sure that no errors or warnings are reported 5458 for any of the boards. 5459 5460* Keep your modifications to the necessary minimum: A patch 5461 containing several unrelated changes or arbitrary reformats will be 5462 returned with a request to re-formatting / split it. 5463 5464* If you modify existing code, make sure that your new code does not 5465 add to the memory footprint of the code ;-) Small is beautiful! 5466 When adding new features, these should compile conditionally only 5467 (using #ifdef), and the resulting code with the new feature 5468 disabled must not need more memory than the old code without your 5469 modification. 5470 5471* Remember that there is a size limit of 100 kB per message on the 5472 u-boot mailing list. Bigger patches will be moderated. If they are 5473 reasonable and not too big, they will be acknowledged. But patches 5474 bigger than the size limit should be avoided. 5475