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