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