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