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