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