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