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