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