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