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