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