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 CONFIG_USB_HUB_MIN_POWER_ON_DELAY defines the minimum 1436 interval for usb hub power-on delay.(minimum 100msec) 1437 1438- USB Device: 1439 Define the below if you wish to use the USB console. 1440 Once firmware is rebuilt from a serial console issue the 1441 command "setenv stdin usbtty; setenv stdout usbtty" and 1442 attach your USB cable. The Unix command "dmesg" should print 1443 it has found a new device. The environment variable usbtty 1444 can be set to gserial or cdc_acm to enable your device to 1445 appear to a USB host as a Linux gserial device or a 1446 Common Device Class Abstract Control Model serial device. 1447 If you select usbtty = gserial you should be able to enumerate 1448 a Linux host by 1449 # modprobe usbserial vendor=0xVendorID product=0xProductID 1450 else if using cdc_acm, simply setting the environment 1451 variable usbtty to be cdc_acm should suffice. The following 1452 might be defined in YourBoardName.h 1453 1454 CONFIG_USB_DEVICE 1455 Define this to build a UDC device 1456 1457 CONFIG_USB_TTY 1458 Define this to have a tty type of device available to 1459 talk to the UDC device 1460 1461 CONFIG_USBD_HS 1462 Define this to enable the high speed support for usb 1463 device and usbtty. If this feature is enabled, a routine 1464 int is_usbd_high_speed(void) 1465 also needs to be defined by the driver to dynamically poll 1466 whether the enumeration has succeded at high speed or full 1467 speed. 1468 1469 CONFIG_SYS_CONSOLE_IS_IN_ENV 1470 Define this if you want stdin, stdout &/or stderr to 1471 be set to usbtty. 1472 1473 mpc8xx: 1474 CONFIG_SYS_USB_EXTC_CLK 0xBLAH 1475 Derive USB clock from external clock "blah" 1476 - CONFIG_SYS_USB_EXTC_CLK 0x02 1477 1478 CONFIG_SYS_USB_BRG_CLK 0xBLAH 1479 Derive USB clock from brgclk 1480 - CONFIG_SYS_USB_BRG_CLK 0x04 1481 1482 If you have a USB-IF assigned VendorID then you may wish to 1483 define your own vendor specific values either in BoardName.h 1484 or directly in usbd_vendor_info.h. If you don't define 1485 CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME, 1486 CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot 1487 should pretend to be a Linux device to it's target host. 1488 1489 CONFIG_USBD_MANUFACTURER 1490 Define this string as the name of your company for 1491 - CONFIG_USBD_MANUFACTURER "my company" 1492 1493 CONFIG_USBD_PRODUCT_NAME 1494 Define this string as the name of your product 1495 - CONFIG_USBD_PRODUCT_NAME "acme usb device" 1496 1497 CONFIG_USBD_VENDORID 1498 Define this as your assigned Vendor ID from the USB 1499 Implementors Forum. This *must* be a genuine Vendor ID 1500 to avoid polluting the USB namespace. 1501 - CONFIG_USBD_VENDORID 0xFFFF 1502 1503 CONFIG_USBD_PRODUCTID 1504 Define this as the unique Product ID 1505 for your device 1506 - CONFIG_USBD_PRODUCTID 0xFFFF 1507 1508- ULPI Layer Support: 1509 The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via 1510 the generic ULPI layer. The generic layer accesses the ULPI PHY 1511 via the platform viewport, so you need both the genric layer and 1512 the viewport enabled. Currently only Chipidea/ARC based 1513 viewport is supported. 1514 To enable the ULPI layer support, define CONFIG_USB_ULPI and 1515 CONFIG_USB_ULPI_VIEWPORT in your board configuration file. 1516 If your ULPI phy needs a different reference clock than the 1517 standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to 1518 the appropriate value in Hz. 1519 1520- MMC Support: 1521 The MMC controller on the Intel PXA is supported. To 1522 enable this define CONFIG_MMC. The MMC can be 1523 accessed from the boot prompt by mapping the device 1524 to physical memory similar to flash. Command line is 1525 enabled with CONFIG_CMD_MMC. The MMC driver also works with 1526 the FAT fs. This is enabled with CONFIG_CMD_FAT. 1527 1528 CONFIG_SH_MMCIF 1529 Support for Renesas on-chip MMCIF controller 1530 1531 CONFIG_SH_MMCIF_ADDR 1532 Define the base address of MMCIF registers 1533 1534 CONFIG_SH_MMCIF_CLK 1535 Define the clock frequency for MMCIF 1536 1537- USB Device Firmware Update (DFU) class support: 1538 CONFIG_DFU_FUNCTION 1539 This enables the USB portion of the DFU USB class 1540 1541 CONFIG_CMD_DFU 1542 This enables the command "dfu" which is used to have 1543 U-Boot create a DFU class device via USB. This command 1544 requires that the "dfu_alt_info" environment variable be 1545 set and define the alt settings to expose to the host. 1546 1547 CONFIG_DFU_MMC 1548 This enables support for exposing (e)MMC devices via DFU. 1549 1550 CONFIG_DFU_NAND 1551 This enables support for exposing NAND devices via DFU. 1552 1553 CONFIG_DFU_RAM 1554 This enables support for exposing RAM via DFU. 1555 Note: DFU spec refer to non-volatile memory usage, but 1556 allow usages beyond the scope of spec - here RAM usage, 1557 one that would help mostly the developer. 1558 1559 CONFIG_SYS_DFU_DATA_BUF_SIZE 1560 Dfu transfer uses a buffer before writing data to the 1561 raw storage device. Make the size (in bytes) of this buffer 1562 configurable. The size of this buffer is also configurable 1563 through the "dfu_bufsiz" environment variable. 1564 1565 CONFIG_SYS_DFU_MAX_FILE_SIZE 1566 When updating files rather than the raw storage device, 1567 we use a static buffer to copy the file into and then write 1568 the buffer once we've been given the whole file. Define 1569 this to the maximum filesize (in bytes) for the buffer. 1570 Default is 4 MiB if undefined. 1571 1572 DFU_DEFAULT_POLL_TIMEOUT 1573 Poll timeout [ms], is the timeout a device can send to the 1574 host. The host must wait for this timeout before sending 1575 a subsequent DFU_GET_STATUS request to the device. 1576 1577 DFU_MANIFEST_POLL_TIMEOUT 1578 Poll timeout [ms], which the device sends to the host when 1579 entering dfuMANIFEST state. Host waits this timeout, before 1580 sending again an USB request to the device. 1581 1582- Journaling Flash filesystem support: 1583 CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE, 1584 CONFIG_JFFS2_NAND_DEV 1585 Define these for a default partition on a NAND device 1586 1587 CONFIG_SYS_JFFS2_FIRST_SECTOR, 1588 CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS 1589 Define these for a default partition on a NOR device 1590 1591 CONFIG_SYS_JFFS_CUSTOM_PART 1592 Define this to create an own partition. You have to provide a 1593 function struct part_info* jffs2_part_info(int part_num) 1594 1595 If you define only one JFFS2 partition you may also want to 1596 #define CONFIG_SYS_JFFS_SINGLE_PART 1 1597 to disable the command chpart. This is the default when you 1598 have not defined a custom partition 1599 1600- FAT(File Allocation Table) filesystem write function support: 1601 CONFIG_FAT_WRITE 1602 1603 Define this to enable support for saving memory data as a 1604 file in FAT formatted partition. 1605 1606 This will also enable the command "fatwrite" enabling the 1607 user to write files to FAT. 1608 1609CBFS (Coreboot Filesystem) support 1610 CONFIG_CMD_CBFS 1611 1612 Define this to enable support for reading from a Coreboot 1613 filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls 1614 and cbfsload. 1615 1616- Keyboard Support: 1617 CONFIG_ISA_KEYBOARD 1618 1619 Define this to enable standard (PC-Style) keyboard 1620 support 1621 1622 CONFIG_I8042_KBD 1623 Standard PC keyboard driver with US (is default) and 1624 GERMAN key layout (switch via environment 'keymap=de') support. 1625 Export function i8042_kbd_init, i8042_tstc and i8042_getc 1626 for cfb_console. Supports cursor blinking. 1627 1628 CONFIG_CROS_EC_KEYB 1629 Enables a Chrome OS keyboard using the CROS_EC interface. 1630 This uses CROS_EC to communicate with a second microcontroller 1631 which provides key scans on request. 1632 1633- Video support: 1634 CONFIG_VIDEO 1635 1636 Define this to enable video support (for output to 1637 video). 1638 1639 CONFIG_VIDEO_CT69000 1640 1641 Enable Chips & Technologies 69000 Video chip 1642 1643 CONFIG_VIDEO_SMI_LYNXEM 1644 Enable Silicon Motion SMI 712/710/810 Video chip. The 1645 video output is selected via environment 'videoout' 1646 (1 = LCD and 2 = CRT). If videoout is undefined, CRT is 1647 assumed. 1648 1649 For the CT69000 and SMI_LYNXEM drivers, videomode is 1650 selected via environment 'videomode'. Two different ways 1651 are possible: 1652 - "videomode=num" 'num' is a standard LiLo mode numbers. 1653 Following standard modes are supported (* is default): 1654 1655 Colors 640x480 800x600 1024x768 1152x864 1280x1024 1656 -------------+--------------------------------------------- 1657 8 bits | 0x301* 0x303 0x305 0x161 0x307 1658 15 bits | 0x310 0x313 0x316 0x162 0x319 1659 16 bits | 0x311 0x314 0x317 0x163 0x31A 1660 24 bits | 0x312 0x315 0x318 ? 0x31B 1661 -------------+--------------------------------------------- 1662 (i.e. setenv videomode 317; saveenv; reset;) 1663 1664 - "videomode=bootargs" all the video parameters are parsed 1665 from the bootargs. (See drivers/video/videomodes.c) 1666 1667 1668 CONFIG_VIDEO_SED13806 1669 Enable Epson SED13806 driver. This driver supports 8bpp 1670 and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP 1671 or CONFIG_VIDEO_SED13806_16BPP 1672 1673 CONFIG_FSL_DIU_FB 1674 Enable the Freescale DIU video driver. Reference boards for 1675 SOCs that have a DIU should define this macro to enable DIU 1676 support, and should also define these other macros: 1677 1678 CONFIG_SYS_DIU_ADDR 1679 CONFIG_VIDEO 1680 CONFIG_CMD_BMP 1681 CONFIG_CFB_CONSOLE 1682 CONFIG_VIDEO_SW_CURSOR 1683 CONFIG_VGA_AS_SINGLE_DEVICE 1684 CONFIG_VIDEO_LOGO 1685 CONFIG_VIDEO_BMP_LOGO 1686 1687 The DIU driver will look for the 'video-mode' environment 1688 variable, and if defined, enable the DIU as a console during 1689 boot. See the documentation file README.video for a 1690 description of this variable. 1691 1692 CONFIG_VIDEO_VGA 1693 1694 Enable the VGA video / BIOS for x86. The alternative if you 1695 are using coreboot is to use the coreboot frame buffer 1696 driver. 1697 1698 1699- Keyboard Support: 1700 CONFIG_KEYBOARD 1701 1702 Define this to enable a custom keyboard support. 1703 This simply calls drv_keyboard_init() which must be 1704 defined in your board-specific files. 1705 The only board using this so far is RBC823. 1706 1707- LCD Support: CONFIG_LCD 1708 1709 Define this to enable LCD support (for output to LCD 1710 display); also select one of the supported displays 1711 by defining one of these: 1712 1713 CONFIG_ATMEL_LCD: 1714 1715 HITACHI TX09D70VM1CCA, 3.5", 240x320. 1716 1717 CONFIG_NEC_NL6448AC33: 1718 1719 NEC NL6448AC33-18. Active, color, single scan. 1720 1721 CONFIG_NEC_NL6448BC20 1722 1723 NEC NL6448BC20-08. 6.5", 640x480. 1724 Active, color, single scan. 1725 1726 CONFIG_NEC_NL6448BC33_54 1727 1728 NEC NL6448BC33-54. 10.4", 640x480. 1729 Active, color, single scan. 1730 1731 CONFIG_SHARP_16x9 1732 1733 Sharp 320x240. Active, color, single scan. 1734 It isn't 16x9, and I am not sure what it is. 1735 1736 CONFIG_SHARP_LQ64D341 1737 1738 Sharp LQ64D341 display, 640x480. 1739 Active, color, single scan. 1740 1741 CONFIG_HLD1045 1742 1743 HLD1045 display, 640x480. 1744 Active, color, single scan. 1745 1746 CONFIG_OPTREX_BW 1747 1748 Optrex CBL50840-2 NF-FW 99 22 M5 1749 or 1750 Hitachi LMG6912RPFC-00T 1751 or 1752 Hitachi SP14Q002 1753 1754 320x240. Black & white. 1755 1756 Normally display is black on white background; define 1757 CONFIG_SYS_WHITE_ON_BLACK to get it inverted. 1758 1759 CONFIG_LCD_ALIGNMENT 1760 1761 Normally the LCD is page-aligned (tyically 4KB). If this is 1762 defined then the LCD will be aligned to this value instead. 1763 For ARM it is sometimes useful to use MMU_SECTION_SIZE 1764 here, since it is cheaper to change data cache settings on 1765 a per-section basis. 1766 1767 CONFIG_CONSOLE_SCROLL_LINES 1768 1769 When the console need to be scrolled, this is the number of 1770 lines to scroll by. It defaults to 1. Increasing this makes 1771 the console jump but can help speed up operation when scrolling 1772 is slow. 1773 1774 CONFIG_LCD_BMP_RLE8 1775 1776 Support drawing of RLE8-compressed bitmaps on the LCD. 1777 1778 CONFIG_I2C_EDID 1779 1780 Enables an 'i2c edid' command which can read EDID 1781 information over I2C from an attached LCD display. 1782 1783- Splash Screen Support: CONFIG_SPLASH_SCREEN 1784 1785 If this option is set, the environment is checked for 1786 a variable "splashimage". If found, the usual display 1787 of logo, copyright and system information on the LCD 1788 is suppressed and the BMP image at the address 1789 specified in "splashimage" is loaded instead. The 1790 console is redirected to the "nulldev", too. This 1791 allows for a "silent" boot where a splash screen is 1792 loaded very quickly after power-on. 1793 1794 CONFIG_SPLASHIMAGE_GUARD 1795 1796 If this option is set, then U-Boot will prevent the environment 1797 variable "splashimage" from being set to a problematic address 1798 (see README.displaying-bmps). 1799 This option is useful for targets where, due to alignment 1800 restrictions, an improperly aligned BMP image will cause a data 1801 abort. If you think you will not have problems with unaligned 1802 accesses (for example because your toolchain prevents them) 1803 there is no need to set this option. 1804 1805 CONFIG_SPLASH_SCREEN_ALIGN 1806 1807 If this option is set the splash image can be freely positioned 1808 on the screen. Environment variable "splashpos" specifies the 1809 position as "x,y". If a positive number is given it is used as 1810 number of pixel from left/top. If a negative number is given it 1811 is used as number of pixel from right/bottom. You can also 1812 specify 'm' for centering the image. 1813 1814 Example: 1815 setenv splashpos m,m 1816 => image at center of screen 1817 1818 setenv splashpos 30,20 1819 => image at x = 30 and y = 20 1820 1821 setenv splashpos -10,m 1822 => vertically centered image 1823 at x = dspWidth - bmpWidth - 9 1824 1825- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP 1826 1827 If this option is set, additionally to standard BMP 1828 images, gzipped BMP images can be displayed via the 1829 splashscreen support or the bmp command. 1830 1831- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8 1832 1833 If this option is set, 8-bit RLE compressed BMP images 1834 can be displayed via the splashscreen support or the 1835 bmp command. 1836 1837- Do compresssing for memory range: 1838 CONFIG_CMD_ZIP 1839 1840 If this option is set, it would use zlib deflate method 1841 to compress the specified memory at its best effort. 1842 1843- Compression support: 1844 CONFIG_GZIP 1845 1846 Enabled by default to support gzip compressed images. 1847 1848 CONFIG_BZIP2 1849 1850 If this option is set, support for bzip2 compressed 1851 images is included. If not, only uncompressed and gzip 1852 compressed images are supported. 1853 1854 NOTE: the bzip2 algorithm requires a lot of RAM, so 1855 the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should 1856 be at least 4MB. 1857 1858 CONFIG_LZMA 1859 1860 If this option is set, support for lzma compressed 1861 images is included. 1862 1863 Note: The LZMA algorithm adds between 2 and 4KB of code and it 1864 requires an amount of dynamic memory that is given by the 1865 formula: 1866 1867 (1846 + 768 << (lc + lp)) * sizeof(uint16) 1868 1869 Where lc and lp stand for, respectively, Literal context bits 1870 and Literal pos bits. 1871 1872 This value is upper-bounded by 14MB in the worst case. Anyway, 1873 for a ~4MB large kernel image, we have lc=3 and lp=0 for a 1874 total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is 1875 a very small buffer. 1876 1877 Use the lzmainfo tool to determinate the lc and lp values and 1878 then calculate the amount of needed dynamic memory (ensuring 1879 the appropriate CONFIG_SYS_MALLOC_LEN value). 1880 1881 CONFIG_LZO 1882 1883 If this option is set, support for LZO compressed images 1884 is included. 1885 1886- MII/PHY support: 1887 CONFIG_PHY_ADDR 1888 1889 The address of PHY on MII bus. 1890 1891 CONFIG_PHY_CLOCK_FREQ (ppc4xx) 1892 1893 The clock frequency of the MII bus 1894 1895 CONFIG_PHY_GIGE 1896 1897 If this option is set, support for speed/duplex 1898 detection of gigabit PHY is included. 1899 1900 CONFIG_PHY_RESET_DELAY 1901 1902 Some PHY like Intel LXT971A need extra delay after 1903 reset before any MII register access is possible. 1904 For such PHY, set this option to the usec delay 1905 required. (minimum 300usec for LXT971A) 1906 1907 CONFIG_PHY_CMD_DELAY (ppc4xx) 1908 1909 Some PHY like Intel LXT971A need extra delay after 1910 command issued before MII status register can be read 1911 1912- Ethernet address: 1913 CONFIG_ETHADDR 1914 CONFIG_ETH1ADDR 1915 CONFIG_ETH2ADDR 1916 CONFIG_ETH3ADDR 1917 CONFIG_ETH4ADDR 1918 CONFIG_ETH5ADDR 1919 1920 Define a default value for Ethernet address to use 1921 for the respective Ethernet interface, in case this 1922 is not determined automatically. 1923 1924- IP address: 1925 CONFIG_IPADDR 1926 1927 Define a default value for the IP address to use for 1928 the default Ethernet interface, in case this is not 1929 determined through e.g. bootp. 1930 (Environment variable "ipaddr") 1931 1932- Server IP address: 1933 CONFIG_SERVERIP 1934 1935 Defines a default value for the IP address of a TFTP 1936 server to contact when using the "tftboot" command. 1937 (Environment variable "serverip") 1938 1939 CONFIG_KEEP_SERVERADDR 1940 1941 Keeps the server's MAC address, in the env 'serveraddr' 1942 for passing to bootargs (like Linux's netconsole option) 1943 1944- Gateway IP address: 1945 CONFIG_GATEWAYIP 1946 1947 Defines a default value for the IP address of the 1948 default router where packets to other networks are 1949 sent to. 1950 (Environment variable "gatewayip") 1951 1952- Subnet mask: 1953 CONFIG_NETMASK 1954 1955 Defines a default value for the subnet mask (or 1956 routing prefix) which is used to determine if an IP 1957 address belongs to the local subnet or needs to be 1958 forwarded through a router. 1959 (Environment variable "netmask") 1960 1961- Multicast TFTP Mode: 1962 CONFIG_MCAST_TFTP 1963 1964 Defines whether you want to support multicast TFTP as per 1965 rfc-2090; for example to work with atftp. Lets lots of targets 1966 tftp down the same boot image concurrently. Note: the Ethernet 1967 driver in use must provide a function: mcast() to join/leave a 1968 multicast group. 1969 1970- BOOTP Recovery Mode: 1971 CONFIG_BOOTP_RANDOM_DELAY 1972 1973 If you have many targets in a network that try to 1974 boot using BOOTP, you may want to avoid that all 1975 systems send out BOOTP requests at precisely the same 1976 moment (which would happen for instance at recovery 1977 from a power failure, when all systems will try to 1978 boot, thus flooding the BOOTP server. Defining 1979 CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be 1980 inserted before sending out BOOTP requests. The 1981 following delays are inserted then: 1982 1983 1st BOOTP request: delay 0 ... 1 sec 1984 2nd BOOTP request: delay 0 ... 2 sec 1985 3rd BOOTP request: delay 0 ... 4 sec 1986 4th and following 1987 BOOTP requests: delay 0 ... 8 sec 1988 1989- DHCP Advanced Options: 1990 You can fine tune the DHCP functionality by defining 1991 CONFIG_BOOTP_* symbols: 1992 1993 CONFIG_BOOTP_SUBNETMASK 1994 CONFIG_BOOTP_GATEWAY 1995 CONFIG_BOOTP_HOSTNAME 1996 CONFIG_BOOTP_NISDOMAIN 1997 CONFIG_BOOTP_BOOTPATH 1998 CONFIG_BOOTP_BOOTFILESIZE 1999 CONFIG_BOOTP_DNS 2000 CONFIG_BOOTP_DNS2 2001 CONFIG_BOOTP_SEND_HOSTNAME 2002 CONFIG_BOOTP_NTPSERVER 2003 CONFIG_BOOTP_TIMEOFFSET 2004 CONFIG_BOOTP_VENDOREX 2005 CONFIG_BOOTP_MAY_FAIL 2006 2007 CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip 2008 environment variable, not the BOOTP server. 2009 2010 CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found 2011 after the configured retry count, the call will fail 2012 instead of starting over. This can be used to fail over 2013 to Link-local IP address configuration if the DHCP server 2014 is not available. 2015 2016 CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS 2017 serverip from a DHCP server, it is possible that more 2018 than one DNS serverip is offered to the client. 2019 If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS 2020 serverip will be stored in the additional environment 2021 variable "dnsip2". The first DNS serverip is always 2022 stored in the variable "dnsip", when CONFIG_BOOTP_DNS 2023 is defined. 2024 2025 CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable 2026 to do a dynamic update of a DNS server. To do this, they 2027 need the hostname of the DHCP requester. 2028 If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content 2029 of the "hostname" environment variable is passed as 2030 option 12 to the DHCP server. 2031 2032 CONFIG_BOOTP_DHCP_REQUEST_DELAY 2033 2034 A 32bit value in microseconds for a delay between 2035 receiving a "DHCP Offer" and sending the "DHCP Request". 2036 This fixes a problem with certain DHCP servers that don't 2037 respond 100% of the time to a "DHCP request". E.g. On an 2038 AT91RM9200 processor running at 180MHz, this delay needed 2039 to be *at least* 15,000 usec before a Windows Server 2003 2040 DHCP server would reply 100% of the time. I recommend at 2041 least 50,000 usec to be safe. The alternative is to hope 2042 that one of the retries will be successful but note that 2043 the DHCP timeout and retry process takes a longer than 2044 this delay. 2045 2046 - Link-local IP address negotiation: 2047 Negotiate with other link-local clients on the local network 2048 for an address that doesn't require explicit configuration. 2049 This is especially useful if a DHCP server cannot be guaranteed 2050 to exist in all environments that the device must operate. 2051 2052 See doc/README.link-local for more information. 2053 2054 - CDP Options: 2055 CONFIG_CDP_DEVICE_ID 2056 2057 The device id used in CDP trigger frames. 2058 2059 CONFIG_CDP_DEVICE_ID_PREFIX 2060 2061 A two character string which is prefixed to the MAC address 2062 of the device. 2063 2064 CONFIG_CDP_PORT_ID 2065 2066 A printf format string which contains the ascii name of 2067 the port. Normally is set to "eth%d" which sets 2068 eth0 for the first Ethernet, eth1 for the second etc. 2069 2070 CONFIG_CDP_CAPABILITIES 2071 2072 A 32bit integer which indicates the device capabilities; 2073 0x00000010 for a normal host which does not forwards. 2074 2075 CONFIG_CDP_VERSION 2076 2077 An ascii string containing the version of the software. 2078 2079 CONFIG_CDP_PLATFORM 2080 2081 An ascii string containing the name of the platform. 2082 2083 CONFIG_CDP_TRIGGER 2084 2085 A 32bit integer sent on the trigger. 2086 2087 CONFIG_CDP_POWER_CONSUMPTION 2088 2089 A 16bit integer containing the power consumption of the 2090 device in .1 of milliwatts. 2091 2092 CONFIG_CDP_APPLIANCE_VLAN_TYPE 2093 2094 A byte containing the id of the VLAN. 2095 2096- Status LED: CONFIG_STATUS_LED 2097 2098 Several configurations allow to display the current 2099 status using a LED. For instance, the LED will blink 2100 fast while running U-Boot code, stop blinking as 2101 soon as a reply to a BOOTP request was received, and 2102 start blinking slow once the Linux kernel is running 2103 (supported by a status LED driver in the Linux 2104 kernel). Defining CONFIG_STATUS_LED enables this 2105 feature in U-Boot. 2106 2107 Additional options: 2108 2109 CONFIG_GPIO_LED 2110 The status LED can be connected to a GPIO pin. 2111 In such cases, the gpio_led driver can be used as a 2112 status LED backend implementation. Define CONFIG_GPIO_LED 2113 to include the gpio_led driver in the U-Boot binary. 2114 2115 CONFIG_GPIO_LED_INVERTED_TABLE 2116 Some GPIO connected LEDs may have inverted polarity in which 2117 case the GPIO high value corresponds to LED off state and 2118 GPIO low value corresponds to LED on state. 2119 In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined 2120 with a list of GPIO LEDs that have inverted polarity. 2121 2122- CAN Support: CONFIG_CAN_DRIVER 2123 2124 Defining CONFIG_CAN_DRIVER enables CAN driver support 2125 on those systems that support this (optional) 2126 feature, like the TQM8xxL modules. 2127 2128- I2C Support: CONFIG_SYS_I2C 2129 2130 This enable the NEW i2c subsystem, and will allow you to use 2131 i2c commands at the u-boot command line (as long as you set 2132 CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c 2133 based realtime clock chips or other i2c devices. See 2134 common/cmd_i2c.c for a description of the command line 2135 interface. 2136 2137 ported i2c driver to the new framework: 2138 - drivers/i2c/soft_i2c.c: 2139 - activate first bus with CONFIG_SYS_I2C_SOFT define 2140 CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE 2141 for defining speed and slave address 2142 - activate second bus with I2C_SOFT_DECLARATIONS2 define 2143 CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2 2144 for defining speed and slave address 2145 - activate third bus with I2C_SOFT_DECLARATIONS3 define 2146 CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3 2147 for defining speed and slave address 2148 - activate fourth bus with I2C_SOFT_DECLARATIONS4 define 2149 CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4 2150 for defining speed and slave address 2151 2152 - drivers/i2c/fsl_i2c.c: 2153 - activate i2c driver with CONFIG_SYS_I2C_FSL 2154 define CONFIG_SYS_FSL_I2C_OFFSET for setting the register 2155 offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and 2156 CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first 2157 bus. 2158 - If your board supports a second fsl i2c bus, define 2159 CONFIG_SYS_FSL_I2C2_OFFSET for the register offset 2160 CONFIG_SYS_FSL_I2C2_SPEED for the speed and 2161 CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the 2162 second bus. 2163 2164 - drivers/i2c/tegra_i2c.c: 2165 - activate this driver with CONFIG_SYS_I2C_TEGRA 2166 - This driver adds 4 i2c buses with a fix speed from 2167 100000 and the slave addr 0! 2168 2169 - drivers/i2c/ppc4xx_i2c.c 2170 - activate this driver with CONFIG_SYS_I2C_PPC4XX 2171 - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0 2172 - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1 2173 2174 - drivers/i2c/i2c_mxc.c 2175 - activate this driver with CONFIG_SYS_I2C_MXC 2176 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED 2177 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE 2178 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED 2179 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE 2180 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED 2181 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE 2182 If thoses defines are not set, default value is 100000 2183 for speed, and 0 for slave. 2184 2185 - drivers/i2c/rcar_i2c.c: 2186 - activate this driver with CONFIG_SYS_I2C_RCAR 2187 - This driver adds 4 i2c buses 2188 2189 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0 2190 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0 2191 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1 2192 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1 2193 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2 2194 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2 2195 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3 2196 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3 2197 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses 2198 2199 - drivers/i2c/sh_i2c.c: 2200 - activate this driver with CONFIG_SYS_I2C_SH 2201 - This driver adds from 2 to 5 i2c buses 2202 2203 - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0 2204 - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0 2205 - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1 2206 - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1 2207 - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2 2208 - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2 2209 - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3 2210 - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3 2211 - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4 2212 - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4 2213 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5 2214 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5 2215 - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses 2216 2217 - drivers/i2c/omap24xx_i2c.c 2218 - activate this driver with CONFIG_SYS_I2C_OMAP24XX 2219 - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0 2220 - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0 2221 - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1 2222 - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1 2223 - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2 2224 - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2 2225 - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3 2226 - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3 2227 - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4 2228 - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4 2229 2230 - drivers/i2c/zynq_i2c.c 2231 - activate this driver with CONFIG_SYS_I2C_ZYNQ 2232 - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting 2233 - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr 2234 2235 - drivers/i2c/s3c24x0_i2c.c: 2236 - activate this driver with CONFIG_SYS_I2C_S3C24X0 2237 - This driver adds i2c buses (11 for Exynos5250, Exynos5420 2238 9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung) 2239 with a fix speed from 100000 and the slave addr 0! 2240 2241 additional defines: 2242 2243 CONFIG_SYS_NUM_I2C_BUSES 2244 Hold the number of i2c busses you want to use. If you 2245 don't use/have i2c muxes on your i2c bus, this 2246 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 2247 omit this define. 2248 2249 CONFIG_SYS_I2C_DIRECT_BUS 2250 define this, if you don't use i2c muxes on your hardware. 2251 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 2252 omit this define. 2253 2254 CONFIG_SYS_I2C_MAX_HOPS 2255 define how many muxes are maximal consecutively connected 2256 on one i2c bus. If you not use i2c muxes, omit this 2257 define. 2258 2259 CONFIG_SYS_I2C_BUSES 2260 hold a list of busses you want to use, only used if 2261 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 2262 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 2263 CONFIG_SYS_NUM_I2C_BUSES = 9: 2264 2265 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 2266 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 2267 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 2268 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 2269 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 2270 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 2271 {1, {I2C_NULL_HOP}}, \ 2272 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 2273 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 2274 } 2275 2276 which defines 2277 bus 0 on adapter 0 without a mux 2278 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2279 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2280 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2281 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2282 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 2283 bus 6 on adapter 1 without a mux 2284 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2285 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 2286 2287 If you do not have i2c muxes on your board, omit this define. 2288 2289- Legacy I2C Support: CONFIG_HARD_I2C 2290 2291 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 2292 provides the following compelling advantages: 2293 2294 - more than one i2c adapter is usable 2295 - approved multibus support 2296 - better i2c mux support 2297 2298 ** Please consider updating your I2C driver now. ** 2299 2300 These enable legacy I2C serial bus commands. Defining 2301 CONFIG_HARD_I2C will include the appropriate I2C driver 2302 for the selected CPU. 2303 2304 This will allow you to use i2c commands at the u-boot 2305 command line (as long as you set CONFIG_CMD_I2C in 2306 CONFIG_COMMANDS) and communicate with i2c based realtime 2307 clock chips. See common/cmd_i2c.c for a description of the 2308 command line interface. 2309 2310 CONFIG_HARD_I2C selects a hardware I2C controller. 2311 2312 There are several other quantities that must also be 2313 defined when you define CONFIG_HARD_I2C. 2314 2315 In both cases you will need to define CONFIG_SYS_I2C_SPEED 2316 to be the frequency (in Hz) at which you wish your i2c bus 2317 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 2318 the CPU's i2c node address). 2319 2320 Now, the u-boot i2c code for the mpc8xx 2321 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 2322 and so its address should therefore be cleared to 0 (See, 2323 eg, MPC823e User's Manual p.16-473). So, set 2324 CONFIG_SYS_I2C_SLAVE to 0. 2325 2326 CONFIG_SYS_I2C_INIT_MPC5XXX 2327 2328 When a board is reset during an i2c bus transfer 2329 chips might think that the current transfer is still 2330 in progress. Reset the slave devices by sending start 2331 commands until the slave device responds. 2332 2333 That's all that's required for CONFIG_HARD_I2C. 2334 2335 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2336 then the following macros need to be defined (examples are 2337 from include/configs/lwmon.h): 2338 2339 I2C_INIT 2340 2341 (Optional). Any commands necessary to enable the I2C 2342 controller or configure ports. 2343 2344 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2345 2346 I2C_PORT 2347 2348 (Only for MPC8260 CPU). The I/O port to use (the code 2349 assumes both bits are on the same port). Valid values 2350 are 0..3 for ports A..D. 2351 2352 I2C_ACTIVE 2353 2354 The code necessary to make the I2C data line active 2355 (driven). If the data line is open collector, this 2356 define can be null. 2357 2358 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2359 2360 I2C_TRISTATE 2361 2362 The code necessary to make the I2C data line tri-stated 2363 (inactive). If the data line is open collector, this 2364 define can be null. 2365 2366 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2367 2368 I2C_READ 2369 2370 Code that returns true if the I2C data line is high, 2371 false if it is low. 2372 2373 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2374 2375 I2C_SDA(bit) 2376 2377 If <bit> is true, sets the I2C data line high. If it 2378 is false, it clears it (low). 2379 2380 eg: #define I2C_SDA(bit) \ 2381 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2382 else immr->im_cpm.cp_pbdat &= ~PB_SDA 2383 2384 I2C_SCL(bit) 2385 2386 If <bit> is true, sets the I2C clock line high. If it 2387 is false, it clears it (low). 2388 2389 eg: #define I2C_SCL(bit) \ 2390 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2391 else immr->im_cpm.cp_pbdat &= ~PB_SCL 2392 2393 I2C_DELAY 2394 2395 This delay is invoked four times per clock cycle so this 2396 controls the rate of data transfer. The data rate thus 2397 is 1 / (I2C_DELAY * 4). Often defined to be something 2398 like: 2399 2400 #define I2C_DELAY udelay(2) 2401 2402 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2403 2404 If your arch supports the generic GPIO framework (asm/gpio.h), 2405 then you may alternatively define the two GPIOs that are to be 2406 used as SCL / SDA. Any of the previous I2C_xxx macros will 2407 have GPIO-based defaults assigned to them as appropriate. 2408 2409 You should define these to the GPIO value as given directly to 2410 the generic GPIO functions. 2411 2412 CONFIG_SYS_I2C_INIT_BOARD 2413 2414 When a board is reset during an i2c bus transfer 2415 chips might think that the current transfer is still 2416 in progress. On some boards it is possible to access 2417 the i2c SCLK line directly, either by using the 2418 processor pin as a GPIO or by having a second pin 2419 connected to the bus. If this option is defined a 2420 custom i2c_init_board() routine in boards/xxx/board.c 2421 is run early in the boot sequence. 2422 2423 CONFIG_SYS_I2C_BOARD_LATE_INIT 2424 2425 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 2426 defined a custom i2c_board_late_init() routine in 2427 boards/xxx/board.c is run AFTER the operations in i2c_init() 2428 is completed. This callpoint can be used to unreset i2c bus 2429 using CPU i2c controller register accesses for CPUs whose i2c 2430 controller provide such a method. It is called at the end of 2431 i2c_init() to allow i2c_init operations to setup the i2c bus 2432 controller on the CPU (e.g. setting bus speed & slave address). 2433 2434 CONFIG_I2CFAST (PPC405GP|PPC405EP only) 2435 2436 This option enables configuration of bi_iic_fast[] flags 2437 in u-boot bd_info structure based on u-boot environment 2438 variable "i2cfast". (see also i2cfast) 2439 2440 CONFIG_I2C_MULTI_BUS 2441 2442 This option allows the use of multiple I2C buses, each of which 2443 must have a controller. At any point in time, only one bus is 2444 active. To switch to a different bus, use the 'i2c dev' command. 2445 Note that bus numbering is zero-based. 2446 2447 CONFIG_SYS_I2C_NOPROBES 2448 2449 This option specifies a list of I2C devices that will be skipped 2450 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 2451 is set, specify a list of bus-device pairs. Otherwise, specify 2452 a 1D array of device addresses 2453 2454 e.g. 2455 #undef CONFIG_I2C_MULTI_BUS 2456 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2457 2458 will skip addresses 0x50 and 0x68 on a board with one I2C bus 2459 2460 #define CONFIG_I2C_MULTI_BUS 2461 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2462 2463 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2464 2465 CONFIG_SYS_SPD_BUS_NUM 2466 2467 If defined, then this indicates the I2C bus number for DDR SPD. 2468 If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2469 2470 CONFIG_SYS_RTC_BUS_NUM 2471 2472 If defined, then this indicates the I2C bus number for the RTC. 2473 If not defined, then U-Boot assumes that RTC is on I2C bus 0. 2474 2475 CONFIG_SYS_DTT_BUS_NUM 2476 2477 If defined, then this indicates the I2C bus number for the DTT. 2478 If not defined, then U-Boot assumes that DTT is on I2C bus 0. 2479 2480 CONFIG_SYS_I2C_DTT_ADDR: 2481 2482 If defined, specifies the I2C address of the DTT device. 2483 If not defined, then U-Boot uses predefined value for 2484 specified DTT device. 2485 2486 CONFIG_SOFT_I2C_READ_REPEATED_START 2487 2488 defining this will force the i2c_read() function in 2489 the soft_i2c driver to perform an I2C repeated start 2490 between writing the address pointer and reading the 2491 data. If this define is omitted the default behaviour 2492 of doing a stop-start sequence will be used. Most I2C 2493 devices can use either method, but some require one or 2494 the other. 2495 2496- SPI Support: CONFIG_SPI 2497 2498 Enables SPI driver (so far only tested with 2499 SPI EEPROM, also an instance works with Crystal A/D and 2500 D/As on the SACSng board) 2501 2502 CONFIG_SH_SPI 2503 2504 Enables the driver for SPI controller on SuperH. Currently 2505 only SH7757 is supported. 2506 2507 CONFIG_SPI_X 2508 2509 Enables extended (16-bit) SPI EEPROM addressing. 2510 (symmetrical to CONFIG_I2C_X) 2511 2512 CONFIG_SOFT_SPI 2513 2514 Enables a software (bit-bang) SPI driver rather than 2515 using hardware support. This is a general purpose 2516 driver that only requires three general I/O port pins 2517 (two outputs, one input) to function. If this is 2518 defined, the board configuration must define several 2519 SPI configuration items (port pins to use, etc). For 2520 an example, see include/configs/sacsng.h. 2521 2522 CONFIG_HARD_SPI 2523 2524 Enables a hardware SPI driver for general-purpose reads 2525 and writes. As with CONFIG_SOFT_SPI, the board configuration 2526 must define a list of chip-select function pointers. 2527 Currently supported on some MPC8xxx processors. For an 2528 example, see include/configs/mpc8349emds.h. 2529 2530 CONFIG_MXC_SPI 2531 2532 Enables the driver for the SPI controllers on i.MX and MXC 2533 SoCs. Currently i.MX31/35/51 are supported. 2534 2535- FPGA Support: CONFIG_FPGA 2536 2537 Enables FPGA subsystem. 2538 2539 CONFIG_FPGA_<vendor> 2540 2541 Enables support for specific chip vendors. 2542 (ALTERA, XILINX) 2543 2544 CONFIG_FPGA_<family> 2545 2546 Enables support for FPGA family. 2547 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 2548 2549 CONFIG_FPGA_COUNT 2550 2551 Specify the number of FPGA devices to support. 2552 2553 CONFIG_CMD_FPGA_LOADMK 2554 2555 Enable support for fpga loadmk command 2556 2557 CONFIG_SYS_FPGA_PROG_FEEDBACK 2558 2559 Enable printing of hash marks during FPGA configuration. 2560 2561 CONFIG_SYS_FPGA_CHECK_BUSY 2562 2563 Enable checks on FPGA configuration interface busy 2564 status by the configuration function. This option 2565 will require a board or device specific function to 2566 be written. 2567 2568 CONFIG_FPGA_DELAY 2569 2570 If defined, a function that provides delays in the FPGA 2571 configuration driver. 2572 2573 CONFIG_SYS_FPGA_CHECK_CTRLC 2574 Allow Control-C to interrupt FPGA configuration 2575 2576 CONFIG_SYS_FPGA_CHECK_ERROR 2577 2578 Check for configuration errors during FPGA bitfile 2579 loading. For example, abort during Virtex II 2580 configuration if the INIT_B line goes low (which 2581 indicated a CRC error). 2582 2583 CONFIG_SYS_FPGA_WAIT_INIT 2584 2585 Maximum time to wait for the INIT_B line to deassert 2586 after PROB_B has been deasserted during a Virtex II 2587 FPGA configuration sequence. The default time is 500 2588 ms. 2589 2590 CONFIG_SYS_FPGA_WAIT_BUSY 2591 2592 Maximum time to wait for BUSY to deassert during 2593 Virtex II FPGA configuration. The default is 5 ms. 2594 2595 CONFIG_SYS_FPGA_WAIT_CONFIG 2596 2597 Time to wait after FPGA configuration. The default is 2598 200 ms. 2599 2600- Configuration Management: 2601 CONFIG_IDENT_STRING 2602 2603 If defined, this string will be added to the U-Boot 2604 version information (U_BOOT_VERSION) 2605 2606- Vendor Parameter Protection: 2607 2608 U-Boot considers the values of the environment 2609 variables "serial#" (Board Serial Number) and 2610 "ethaddr" (Ethernet Address) to be parameters that 2611 are set once by the board vendor / manufacturer, and 2612 protects these variables from casual modification by 2613 the user. Once set, these variables are read-only, 2614 and write or delete attempts are rejected. You can 2615 change this behaviour: 2616 2617 If CONFIG_ENV_OVERWRITE is #defined in your config 2618 file, the write protection for vendor parameters is 2619 completely disabled. Anybody can change or delete 2620 these parameters. 2621 2622 Alternatively, if you #define _both_ CONFIG_ETHADDR 2623 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 2624 Ethernet address is installed in the environment, 2625 which can be changed exactly ONCE by the user. [The 2626 serial# is unaffected by this, i. e. it remains 2627 read-only.] 2628 2629 The same can be accomplished in a more flexible way 2630 for any variable by configuring the type of access 2631 to allow for those variables in the ".flags" variable 2632 or define CONFIG_ENV_FLAGS_LIST_STATIC. 2633 2634- Protected RAM: 2635 CONFIG_PRAM 2636 2637 Define this variable to enable the reservation of 2638 "protected RAM", i. e. RAM which is not overwritten 2639 by U-Boot. Define CONFIG_PRAM to hold the number of 2640 kB you want to reserve for pRAM. You can overwrite 2641 this default value by defining an environment 2642 variable "pram" to the number of kB you want to 2643 reserve. Note that the board info structure will 2644 still show the full amount of RAM. If pRAM is 2645 reserved, a new environment variable "mem" will 2646 automatically be defined to hold the amount of 2647 remaining RAM in a form that can be passed as boot 2648 argument to Linux, for instance like that: 2649 2650 setenv bootargs ... mem=\${mem} 2651 saveenv 2652 2653 This way you can tell Linux not to use this memory, 2654 either, which results in a memory region that will 2655 not be affected by reboots. 2656 2657 *WARNING* If your board configuration uses automatic 2658 detection of the RAM size, you must make sure that 2659 this memory test is non-destructive. So far, the 2660 following board configurations are known to be 2661 "pRAM-clean": 2662 2663 IVMS8, IVML24, SPD8xx, TQM8xxL, 2664 HERMES, IP860, RPXlite, LWMON, 2665 FLAGADM, TQM8260 2666 2667- Access to physical memory region (> 4GB) 2668 Some basic support is provided for operations on memory not 2669 normally accessible to U-Boot - e.g. some architectures 2670 support access to more than 4GB of memory on 32-bit 2671 machines using physical address extension or similar. 2672 Define CONFIG_PHYSMEM to access this basic support, which 2673 currently only supports clearing the memory. 2674 2675- Error Recovery: 2676 CONFIG_PANIC_HANG 2677 2678 Define this variable to stop the system in case of a 2679 fatal error, so that you have to reset it manually. 2680 This is probably NOT a good idea for an embedded 2681 system where you want the system to reboot 2682 automatically as fast as possible, but it may be 2683 useful during development since you can try to debug 2684 the conditions that lead to the situation. 2685 2686 CONFIG_NET_RETRY_COUNT 2687 2688 This variable defines the number of retries for 2689 network operations like ARP, RARP, TFTP, or BOOTP 2690 before giving up the operation. If not defined, a 2691 default value of 5 is used. 2692 2693 CONFIG_ARP_TIMEOUT 2694 2695 Timeout waiting for an ARP reply in milliseconds. 2696 2697 CONFIG_NFS_TIMEOUT 2698 2699 Timeout in milliseconds used in NFS protocol. 2700 If you encounter "ERROR: Cannot umount" in nfs command, 2701 try longer timeout such as 2702 #define CONFIG_NFS_TIMEOUT 10000UL 2703 2704- Command Interpreter: 2705 CONFIG_AUTO_COMPLETE 2706 2707 Enable auto completion of commands using TAB. 2708 2709 Note that this feature has NOT been implemented yet 2710 for the "hush" shell. 2711 2712 2713 CONFIG_SYS_HUSH_PARSER 2714 2715 Define this variable to enable the "hush" shell (from 2716 Busybox) as command line interpreter, thus enabling 2717 powerful command line syntax like 2718 if...then...else...fi conditionals or `&&' and '||' 2719 constructs ("shell scripts"). 2720 2721 If undefined, you get the old, much simpler behaviour 2722 with a somewhat smaller memory footprint. 2723 2724 2725 CONFIG_SYS_PROMPT_HUSH_PS2 2726 2727 This defines the secondary prompt string, which is 2728 printed when the command interpreter needs more input 2729 to complete a command. Usually "> ". 2730 2731 Note: 2732 2733 In the current implementation, the local variables 2734 space and global environment variables space are 2735 separated. Local variables are those you define by 2736 simply typing `name=value'. To access a local 2737 variable later on, you have write `$name' or 2738 `${name}'; to execute the contents of a variable 2739 directly type `$name' at the command prompt. 2740 2741 Global environment variables are those you use 2742 setenv/printenv to work with. To run a command stored 2743 in such a variable, you need to use the run command, 2744 and you must not use the '$' sign to access them. 2745 2746 To store commands and special characters in a 2747 variable, please use double quotation marks 2748 surrounding the whole text of the variable, instead 2749 of the backslashes before semicolons and special 2750 symbols. 2751 2752- Commandline Editing and History: 2753 CONFIG_CMDLINE_EDITING 2754 2755 Enable editing and History functions for interactive 2756 commandline input operations 2757 2758- Default Environment: 2759 CONFIG_EXTRA_ENV_SETTINGS 2760 2761 Define this to contain any number of null terminated 2762 strings (variable = value pairs) that will be part of 2763 the default environment compiled into the boot image. 2764 2765 For example, place something like this in your 2766 board's config file: 2767 2768 #define CONFIG_EXTRA_ENV_SETTINGS \ 2769 "myvar1=value1\0" \ 2770 "myvar2=value2\0" 2771 2772 Warning: This method is based on knowledge about the 2773 internal format how the environment is stored by the 2774 U-Boot code. This is NOT an official, exported 2775 interface! Although it is unlikely that this format 2776 will change soon, there is no guarantee either. 2777 You better know what you are doing here. 2778 2779 Note: overly (ab)use of the default environment is 2780 discouraged. Make sure to check other ways to preset 2781 the environment like the "source" command or the 2782 boot command first. 2783 2784 CONFIG_ENV_VARS_UBOOT_CONFIG 2785 2786 Define this in order to add variables describing the 2787 U-Boot build configuration to the default environment. 2788 These will be named arch, cpu, board, vendor, and soc. 2789 2790 Enabling this option will cause the following to be defined: 2791 2792 - CONFIG_SYS_ARCH 2793 - CONFIG_SYS_CPU 2794 - CONFIG_SYS_BOARD 2795 - CONFIG_SYS_VENDOR 2796 - CONFIG_SYS_SOC 2797 2798 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 2799 2800 Define this in order to add variables describing certain 2801 run-time determined information about the hardware to the 2802 environment. These will be named board_name, board_rev. 2803 2804 CONFIG_DELAY_ENVIRONMENT 2805 2806 Normally the environment is loaded when the board is 2807 intialised so that it is available to U-Boot. This inhibits 2808 that so that the environment is not available until 2809 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 2810 this is instead controlled by the value of 2811 /config/load-environment. 2812 2813- DataFlash Support: 2814 CONFIG_HAS_DATAFLASH 2815 2816 Defining this option enables DataFlash features and 2817 allows to read/write in Dataflash via the standard 2818 commands cp, md... 2819 2820- Serial Flash support 2821 CONFIG_CMD_SF 2822 2823 Defining this option enables SPI flash commands 2824 'sf probe/read/write/erase/update'. 2825 2826 Usage requires an initial 'probe' to define the serial 2827 flash parameters, followed by read/write/erase/update 2828 commands. 2829 2830 The following defaults may be provided by the platform 2831 to handle the common case when only a single serial 2832 flash is present on the system. 2833 2834 CONFIG_SF_DEFAULT_BUS Bus identifier 2835 CONFIG_SF_DEFAULT_CS Chip-select 2836 CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2837 CONFIG_SF_DEFAULT_SPEED in Hz 2838 2839 CONFIG_CMD_SF_TEST 2840 2841 Define this option to include a destructive SPI flash 2842 test ('sf test'). 2843 2844 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg 2845 2846 Define this option to use the Bank addr/Extended addr 2847 support on SPI flashes which has size > 16Mbytes. 2848 2849 CONFIG_SF_DUAL_FLASH Dual flash memories 2850 2851 Define this option to use dual flash support where two flash 2852 memories can be connected with a given cs line. 2853 currently Xilinx Zynq qspi support these type of connections. 2854 2855- SystemACE Support: 2856 CONFIG_SYSTEMACE 2857 2858 Adding this option adds support for Xilinx SystemACE 2859 chips attached via some sort of local bus. The address 2860 of the chip must also be defined in the 2861 CONFIG_SYS_SYSTEMACE_BASE macro. For example: 2862 2863 #define CONFIG_SYSTEMACE 2864 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 2865 2866 When SystemACE support is added, the "ace" device type 2867 becomes available to the fat commands, i.e. fatls. 2868 2869- TFTP Fixed UDP Port: 2870 CONFIG_TFTP_PORT 2871 2872 If this is defined, the environment variable tftpsrcp 2873 is used to supply the TFTP UDP source port value. 2874 If tftpsrcp isn't defined, the normal pseudo-random port 2875 number generator is used. 2876 2877 Also, the environment variable tftpdstp is used to supply 2878 the TFTP UDP destination port value. If tftpdstp isn't 2879 defined, the normal port 69 is used. 2880 2881 The purpose for tftpsrcp is to allow a TFTP server to 2882 blindly start the TFTP transfer using the pre-configured 2883 target IP address and UDP port. This has the effect of 2884 "punching through" the (Windows XP) firewall, allowing 2885 the remainder of the TFTP transfer to proceed normally. 2886 A better solution is to properly configure the firewall, 2887 but sometimes that is not allowed. 2888 2889- Hashing support: 2890 CONFIG_CMD_HASH 2891 2892 This enables a generic 'hash' command which can produce 2893 hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2894 2895 CONFIG_HASH_VERIFY 2896 2897 Enable the hash verify command (hash -v). This adds to code 2898 size a little. 2899 2900 CONFIG_SHA1 - support SHA1 hashing 2901 CONFIG_SHA256 - support SHA256 hashing 2902 2903 Note: There is also a sha1sum command, which should perhaps 2904 be deprecated in favour of 'hash sha1'. 2905 2906- Freescale i.MX specific commands: 2907 CONFIG_CMD_HDMIDETECT 2908 This enables 'hdmidet' command which returns true if an 2909 HDMI monitor is detected. This command is i.MX 6 specific. 2910 2911 CONFIG_CMD_BMODE 2912 This enables the 'bmode' (bootmode) command for forcing 2913 a boot from specific media. 2914 2915 This is useful for forcing the ROM's usb downloader to 2916 activate upon a watchdog reset which is nice when iterating 2917 on U-Boot. Using the reset button or running bmode normal 2918 will set it back to normal. This command currently 2919 supports i.MX53 and i.MX6. 2920 2921- Signing support: 2922 CONFIG_RSA 2923 2924 This enables the RSA algorithm used for FIT image verification 2925 in U-Boot. See doc/uImage.FIT/signature.txt for more information. 2926 2927 The signing part is build into mkimage regardless of this 2928 option. 2929 2930- bootcount support: 2931 CONFIG_BOOTCOUNT_LIMIT 2932 2933 This enables the bootcounter support, see: 2934 http://www.denx.de/wiki/DULG/UBootBootCountLimit 2935 2936 CONFIG_AT91SAM9XE 2937 enable special bootcounter support on at91sam9xe based boards. 2938 CONFIG_BLACKFIN 2939 enable special bootcounter support on blackfin based boards. 2940 CONFIG_SOC_DA8XX 2941 enable special bootcounter support on da850 based boards. 2942 CONFIG_BOOTCOUNT_RAM 2943 enable support for the bootcounter in RAM 2944 CONFIG_BOOTCOUNT_I2C 2945 enable support for the bootcounter on an i2c (like RTC) device. 2946 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 2947 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 2948 the bootcounter. 2949 CONFIG_BOOTCOUNT_ALEN = address len 2950 2951- Show boot progress: 2952 CONFIG_SHOW_BOOT_PROGRESS 2953 2954 Defining this option allows to add some board- 2955 specific code (calling a user-provided function 2956 "show_boot_progress(int)") that enables you to show 2957 the system's boot progress on some display (for 2958 example, some LED's) on your board. At the moment, 2959 the following checkpoints are implemented: 2960 2961- Detailed boot stage timing 2962 CONFIG_BOOTSTAGE 2963 Define this option to get detailed timing of each stage 2964 of the boot process. 2965 2966 CONFIG_BOOTSTAGE_USER_COUNT 2967 This is the number of available user bootstage records. 2968 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 2969 a new ID will be allocated from this stash. If you exceed 2970 the limit, recording will stop. 2971 2972 CONFIG_BOOTSTAGE_REPORT 2973 Define this to print a report before boot, similar to this: 2974 2975 Timer summary in microseconds: 2976 Mark Elapsed Stage 2977 0 0 reset 2978 3,575,678 3,575,678 board_init_f start 2979 3,575,695 17 arch_cpu_init A9 2980 3,575,777 82 arch_cpu_init done 2981 3,659,598 83,821 board_init_r start 2982 3,910,375 250,777 main_loop 2983 29,916,167 26,005,792 bootm_start 2984 30,361,327 445,160 start_kernel 2985 2986 CONFIG_CMD_BOOTSTAGE 2987 Add a 'bootstage' command which supports printing a report 2988 and un/stashing of bootstage data. 2989 2990 CONFIG_BOOTSTAGE_FDT 2991 Stash the bootstage information in the FDT. A root 'bootstage' 2992 node is created with each bootstage id as a child. Each child 2993 has a 'name' property and either 'mark' containing the 2994 mark time in microsecond, or 'accum' containing the 2995 accumulated time for that bootstage id in microseconds. 2996 For example: 2997 2998 bootstage { 2999 154 { 3000 name = "board_init_f"; 3001 mark = <3575678>; 3002 }; 3003 170 { 3004 name = "lcd"; 3005 accum = <33482>; 3006 }; 3007 }; 3008 3009 Code in the Linux kernel can find this in /proc/devicetree. 3010 3011Legacy uImage format: 3012 3013 Arg Where When 3014 1 common/cmd_bootm.c before attempting to boot an image 3015 -1 common/cmd_bootm.c Image header has bad magic number 3016 2 common/cmd_bootm.c Image header has correct magic number 3017 -2 common/cmd_bootm.c Image header has bad checksum 3018 3 common/cmd_bootm.c Image header has correct checksum 3019 -3 common/cmd_bootm.c Image data has bad checksum 3020 4 common/cmd_bootm.c Image data has correct checksum 3021 -4 common/cmd_bootm.c Image is for unsupported architecture 3022 5 common/cmd_bootm.c Architecture check OK 3023 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 3024 6 common/cmd_bootm.c Image Type check OK 3025 -6 common/cmd_bootm.c gunzip uncompression error 3026 -7 common/cmd_bootm.c Unimplemented compression type 3027 7 common/cmd_bootm.c Uncompression OK 3028 8 common/cmd_bootm.c No uncompress/copy overwrite error 3029 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 3030 3031 9 common/image.c Start initial ramdisk verification 3032 -10 common/image.c Ramdisk header has bad magic number 3033 -11 common/image.c Ramdisk header has bad checksum 3034 10 common/image.c Ramdisk header is OK 3035 -12 common/image.c Ramdisk data has bad checksum 3036 11 common/image.c Ramdisk data has correct checksum 3037 12 common/image.c Ramdisk verification complete, start loading 3038 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 3039 13 common/image.c Start multifile image verification 3040 14 common/image.c No initial ramdisk, no multifile, continue. 3041 3042 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 3043 3044 -30 arch/powerpc/lib/board.c Fatal error, hang the system 3045 -31 post/post.c POST test failed, detected by post_output_backlog() 3046 -32 post/post.c POST test failed, detected by post_run_single() 3047 3048 34 common/cmd_doc.c before loading a Image from a DOC device 3049 -35 common/cmd_doc.c Bad usage of "doc" command 3050 35 common/cmd_doc.c correct usage of "doc" command 3051 -36 common/cmd_doc.c No boot device 3052 36 common/cmd_doc.c correct boot device 3053 -37 common/cmd_doc.c Unknown Chip ID on boot device 3054 37 common/cmd_doc.c correct chip ID found, device available 3055 -38 common/cmd_doc.c Read Error on boot device 3056 38 common/cmd_doc.c reading Image header from DOC device OK 3057 -39 common/cmd_doc.c Image header has bad magic number 3058 39 common/cmd_doc.c Image header has correct magic number 3059 -40 common/cmd_doc.c Error reading Image from DOC device 3060 40 common/cmd_doc.c Image header has correct magic number 3061 41 common/cmd_ide.c before loading a Image from a IDE device 3062 -42 common/cmd_ide.c Bad usage of "ide" command 3063 42 common/cmd_ide.c correct usage of "ide" command 3064 -43 common/cmd_ide.c No boot device 3065 43 common/cmd_ide.c boot device found 3066 -44 common/cmd_ide.c Device not available 3067 44 common/cmd_ide.c Device available 3068 -45 common/cmd_ide.c wrong partition selected 3069 45 common/cmd_ide.c partition selected 3070 -46 common/cmd_ide.c Unknown partition table 3071 46 common/cmd_ide.c valid partition table found 3072 -47 common/cmd_ide.c Invalid partition type 3073 47 common/cmd_ide.c correct partition type 3074 -48 common/cmd_ide.c Error reading Image Header on boot device 3075 48 common/cmd_ide.c reading Image Header from IDE device OK 3076 -49 common/cmd_ide.c Image header has bad magic number 3077 49 common/cmd_ide.c Image header has correct magic number 3078 -50 common/cmd_ide.c Image header has bad checksum 3079 50 common/cmd_ide.c Image header has correct checksum 3080 -51 common/cmd_ide.c Error reading Image from IDE device 3081 51 common/cmd_ide.c reading Image from IDE device OK 3082 52 common/cmd_nand.c before loading a Image from a NAND device 3083 -53 common/cmd_nand.c Bad usage of "nand" command 3084 53 common/cmd_nand.c correct usage of "nand" command 3085 -54 common/cmd_nand.c No boot device 3086 54 common/cmd_nand.c boot device found 3087 -55 common/cmd_nand.c Unknown Chip ID on boot device 3088 55 common/cmd_nand.c correct chip ID found, device available 3089 -56 common/cmd_nand.c Error reading Image Header on boot device 3090 56 common/cmd_nand.c reading Image Header from NAND device OK 3091 -57 common/cmd_nand.c Image header has bad magic number 3092 57 common/cmd_nand.c Image header has correct magic number 3093 -58 common/cmd_nand.c Error reading Image from NAND device 3094 58 common/cmd_nand.c reading Image from NAND device OK 3095 3096 -60 common/env_common.c Environment has a bad CRC, using default 3097 3098 64 net/eth.c starting with Ethernet configuration. 3099 -64 net/eth.c no Ethernet found. 3100 65 net/eth.c Ethernet found. 3101 3102 -80 common/cmd_net.c usage wrong 3103 80 common/cmd_net.c before calling NetLoop() 3104 -81 common/cmd_net.c some error in NetLoop() occurred 3105 81 common/cmd_net.c NetLoop() back without error 3106 -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3107 82 common/cmd_net.c trying automatic boot 3108 83 common/cmd_net.c running "source" command 3109 -83 common/cmd_net.c some error in automatic boot or "source" command 3110 84 common/cmd_net.c end without errors 3111 3112FIT uImage format: 3113 3114 Arg Where When 3115 100 common/cmd_bootm.c Kernel FIT Image has correct format 3116 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 3117 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 3118 -101 common/cmd_bootm.c Can't get configuration for kernel subimage 3119 102 common/cmd_bootm.c Kernel unit name specified 3120 -103 common/cmd_bootm.c Can't get kernel subimage node offset 3121 103 common/cmd_bootm.c Found configuration node 3122 104 common/cmd_bootm.c Got kernel subimage node offset 3123 -104 common/cmd_bootm.c Kernel subimage hash verification failed 3124 105 common/cmd_bootm.c Kernel subimage hash verification OK 3125 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 3126 106 common/cmd_bootm.c Architecture check OK 3127 -106 common/cmd_bootm.c Kernel subimage has wrong type 3128 107 common/cmd_bootm.c Kernel subimage type OK 3129 -107 common/cmd_bootm.c Can't get kernel subimage data/size 3130 108 common/cmd_bootm.c Got kernel subimage data/size 3131 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 3132 -109 common/cmd_bootm.c Can't get kernel subimage type 3133 -110 common/cmd_bootm.c Can't get kernel subimage comp 3134 -111 common/cmd_bootm.c Can't get kernel subimage os 3135 -112 common/cmd_bootm.c Can't get kernel subimage load address 3136 -113 common/cmd_bootm.c Image uncompress/copy overwrite error 3137 3138 120 common/image.c Start initial ramdisk verification 3139 -120 common/image.c Ramdisk FIT image has incorrect format 3140 121 common/image.c Ramdisk FIT image has correct format 3141 122 common/image.c No ramdisk subimage unit name, using configuration 3142 -122 common/image.c Can't get configuration for ramdisk subimage 3143 123 common/image.c Ramdisk unit name specified 3144 -124 common/image.c Can't get ramdisk subimage node offset 3145 125 common/image.c Got ramdisk subimage node offset 3146 -125 common/image.c Ramdisk subimage hash verification failed 3147 126 common/image.c Ramdisk subimage hash verification OK 3148 -126 common/image.c Ramdisk subimage for unsupported architecture 3149 127 common/image.c Architecture check OK 3150 -127 common/image.c Can't get ramdisk subimage data/size 3151 128 common/image.c Got ramdisk subimage data/size 3152 129 common/image.c Can't get ramdisk load address 3153 -129 common/image.c Got ramdisk load address 3154 3155 -130 common/cmd_doc.c Incorrect FIT image format 3156 131 common/cmd_doc.c FIT image format OK 3157 3158 -140 common/cmd_ide.c Incorrect FIT image format 3159 141 common/cmd_ide.c FIT image format OK 3160 3161 -150 common/cmd_nand.c Incorrect FIT image format 3162 151 common/cmd_nand.c FIT image format OK 3163 3164- FIT image support: 3165 CONFIG_FIT 3166 Enable support for the FIT uImage format. 3167 3168 CONFIG_FIT_BEST_MATCH 3169 When no configuration is explicitly selected, default to the 3170 one whose fdt's compatibility field best matches that of 3171 U-Boot itself. A match is considered "best" if it matches the 3172 most specific compatibility entry of U-Boot's fdt's root node. 3173 The order of entries in the configuration's fdt is ignored. 3174 3175 CONFIG_FIT_SIGNATURE 3176 This option enables signature verification of FIT uImages, 3177 using a hash signed and verified using RSA. See 3178 doc/uImage.FIT/signature.txt for more details. 3179 3180- Standalone program support: 3181 CONFIG_STANDALONE_LOAD_ADDR 3182 3183 This option defines a board specific value for the 3184 address where standalone program gets loaded, thus 3185 overwriting the architecture dependent default 3186 settings. 3187 3188- Frame Buffer Address: 3189 CONFIG_FB_ADDR 3190 3191 Define CONFIG_FB_ADDR if you want to use specific 3192 address for frame buffer. This is typically the case 3193 when using a graphics controller has separate video 3194 memory. U-Boot will then place the frame buffer at 3195 the given address instead of dynamically reserving it 3196 in system RAM by calling lcd_setmem(), which grabs 3197 the memory for the frame buffer depending on the 3198 configured panel size. 3199 3200 Please see board_init_f function. 3201 3202- Automatic software updates via TFTP server 3203 CONFIG_UPDATE_TFTP 3204 CONFIG_UPDATE_TFTP_CNT_MAX 3205 CONFIG_UPDATE_TFTP_MSEC_MAX 3206 3207 These options enable and control the auto-update feature; 3208 for a more detailed description refer to doc/README.update. 3209 3210- MTD Support (mtdparts command, UBI support) 3211 CONFIG_MTD_DEVICE 3212 3213 Adds the MTD device infrastructure from the Linux kernel. 3214 Needed for mtdparts command support. 3215 3216 CONFIG_MTD_PARTITIONS 3217 3218 Adds the MTD partitioning infrastructure from the Linux 3219 kernel. Needed for UBI support. 3220 3221- UBI support 3222 CONFIG_CMD_UBI 3223 3224 Adds commands for interacting with MTD partitions formatted 3225 with the UBI flash translation layer 3226 3227 Requires also defining CONFIG_RBTREE 3228 3229 CONFIG_UBI_SILENCE_MSG 3230 3231 Make the verbose messages from UBI stop printing. This leaves 3232 warnings and errors enabled. 3233 3234- UBIFS support 3235 CONFIG_CMD_UBIFS 3236 3237 Adds commands for interacting with UBI volumes formatted as 3238 UBIFS. UBIFS is read-only in u-boot. 3239 3240 Requires UBI support as well as CONFIG_LZO 3241 3242 CONFIG_UBIFS_SILENCE_MSG 3243 3244 Make the verbose messages from UBIFS stop printing. This leaves 3245 warnings and errors enabled. 3246 3247- SPL framework 3248 CONFIG_SPL 3249 Enable building of SPL globally. 3250 3251 CONFIG_SPL_LDSCRIPT 3252 LDSCRIPT for linking the SPL binary. 3253 3254 CONFIG_SPL_MAX_FOOTPRINT 3255 Maximum size in memory allocated to the SPL, BSS included. 3256 When defined, the linker checks that the actual memory 3257 used by SPL from _start to __bss_end does not exceed it. 3258 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 3259 must not be both defined at the same time. 3260 3261 CONFIG_SPL_MAX_SIZE 3262 Maximum size of the SPL image (text, data, rodata, and 3263 linker lists sections), BSS excluded. 3264 When defined, the linker checks that the actual size does 3265 not exceed it. 3266 3267 CONFIG_SPL_TEXT_BASE 3268 TEXT_BASE for linking the SPL binary. 3269 3270 CONFIG_SPL_RELOC_TEXT_BASE 3271 Address to relocate to. If unspecified, this is equal to 3272 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 3273 3274 CONFIG_SPL_BSS_START_ADDR 3275 Link address for the BSS within the SPL binary. 3276 3277 CONFIG_SPL_BSS_MAX_SIZE 3278 Maximum size in memory allocated to the SPL BSS. 3279 When defined, the linker checks that the actual memory used 3280 by SPL from __bss_start to __bss_end does not exceed it. 3281 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 3282 must not be both defined at the same time. 3283 3284 CONFIG_SPL_STACK 3285 Adress of the start of the stack SPL will use 3286 3287 CONFIG_SPL_RELOC_STACK 3288 Adress of the start of the stack SPL will use after 3289 relocation. If unspecified, this is equal to 3290 CONFIG_SPL_STACK. 3291 3292 CONFIG_SYS_SPL_MALLOC_START 3293 Starting address of the malloc pool used in SPL. 3294 3295 CONFIG_SYS_SPL_MALLOC_SIZE 3296 The size of the malloc pool used in SPL. 3297 3298 CONFIG_SPL_FRAMEWORK 3299 Enable the SPL framework under common/. This framework 3300 supports MMC, NAND and YMODEM loading of U-Boot and NAND 3301 NAND loading of the Linux Kernel. 3302 3303 CONFIG_SPL_OS_BOOT 3304 Enable booting directly to an OS from SPL. 3305 See also: doc/README.falcon 3306 3307 CONFIG_SPL_DISPLAY_PRINT 3308 For ARM, enable an optional function to print more information 3309 about the running system. 3310 3311 CONFIG_SPL_INIT_MINIMAL 3312 Arch init code should be built for a very small image 3313 3314 CONFIG_SPL_LIBCOMMON_SUPPORT 3315 Support for common/libcommon.o in SPL binary 3316 3317 CONFIG_SPL_LIBDISK_SUPPORT 3318 Support for disk/libdisk.o in SPL binary 3319 3320 CONFIG_SPL_I2C_SUPPORT 3321 Support for drivers/i2c/libi2c.o in SPL binary 3322 3323 CONFIG_SPL_GPIO_SUPPORT 3324 Support for drivers/gpio/libgpio.o in SPL binary 3325 3326 CONFIG_SPL_MMC_SUPPORT 3327 Support for drivers/mmc/libmmc.o in SPL binary 3328 3329 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 3330 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 3331 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 3332 Address, size and partition on the MMC to load U-Boot from 3333 when the MMC is being used in raw mode. 3334 3335 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 3336 Sector to load kernel uImage from when MMC is being 3337 used in raw mode (for Falcon mode) 3338 3339 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 3340 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 3341 Sector and number of sectors to load kernel argument 3342 parameters from when MMC is being used in raw mode 3343 (for falcon mode) 3344 3345 CONFIG_SPL_FAT_SUPPORT 3346 Support for fs/fat/libfat.o in SPL binary 3347 3348 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 3349 Filename to read to load U-Boot when reading from FAT 3350 3351 CONFIG_SPL_FAT_LOAD_KERNEL_NAME 3352 Filename to read to load kernel uImage when reading 3353 from FAT (for Falcon mode) 3354 3355 CONFIG_SPL_FAT_LOAD_ARGS_NAME 3356 Filename to read to load kernel argument parameters 3357 when reading from FAT (for Falcon mode) 3358 3359 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 3360 Set this for NAND SPL on PPC mpc83xx targets, so that 3361 start.S waits for the rest of the SPL to load before 3362 continuing (the hardware starts execution after just 3363 loading the first page rather than the full 4K). 3364 3365 CONFIG_SPL_SKIP_RELOCATE 3366 Avoid SPL relocation 3367 3368 CONFIG_SPL_NAND_BASE 3369 Include nand_base.c in the SPL. Requires 3370 CONFIG_SPL_NAND_DRIVERS. 3371 3372 CONFIG_SPL_NAND_DRIVERS 3373 SPL uses normal NAND drivers, not minimal drivers. 3374 3375 CONFIG_SPL_NAND_ECC 3376 Include standard software ECC in the SPL 3377 3378 CONFIG_SPL_NAND_SIMPLE 3379 Support for NAND boot using simple NAND drivers that 3380 expose the cmd_ctrl() interface. 3381 3382 CONFIG_SPL_MTD_SUPPORT 3383 Support for the MTD subsystem within SPL. Useful for 3384 environment on NAND support within SPL. 3385 3386 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3387 Set for the SPL on PPC mpc8xxx targets, support for 3388 drivers/ddr/fsl/libddr.o in SPL binary. 3389 3390 CONFIG_SPL_COMMON_INIT_DDR 3391 Set for common ddr init with serial presence detect in 3392 SPL binary. 3393 3394 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 3395 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 3396 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 3397 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 3398 CONFIG_SYS_NAND_ECCBYTES 3399 Defines the size and behavior of the NAND that SPL uses 3400 to read U-Boot 3401 3402 CONFIG_SPL_NAND_BOOT 3403 Add support NAND boot 3404 3405 CONFIG_SYS_NAND_U_BOOT_OFFS 3406 Location in NAND to read U-Boot from 3407 3408 CONFIG_SYS_NAND_U_BOOT_DST 3409 Location in memory to load U-Boot to 3410 3411 CONFIG_SYS_NAND_U_BOOT_SIZE 3412 Size of image to load 3413 3414 CONFIG_SYS_NAND_U_BOOT_START 3415 Entry point in loaded image to jump to 3416 3417 CONFIG_SYS_NAND_HW_ECC_OOBFIRST 3418 Define this if you need to first read the OOB and then the 3419 data. This is used for example on davinci plattforms. 3420 3421 CONFIG_SPL_OMAP3_ID_NAND 3422 Support for an OMAP3-specific set of functions to return the 3423 ID and MFR of the first attached NAND chip, if present. 3424 3425 CONFIG_SPL_SERIAL_SUPPORT 3426 Support for drivers/serial/libserial.o in SPL binary 3427 3428 CONFIG_SPL_SPI_FLASH_SUPPORT 3429 Support for drivers/mtd/spi/libspi_flash.o in SPL binary 3430 3431 CONFIG_SPL_SPI_SUPPORT 3432 Support for drivers/spi/libspi.o in SPL binary 3433 3434 CONFIG_SPL_RAM_DEVICE 3435 Support for running image already present in ram, in SPL binary 3436 3437 CONFIG_SPL_LIBGENERIC_SUPPORT 3438 Support for lib/libgeneric.o in SPL binary 3439 3440 CONFIG_SPL_ENV_SUPPORT 3441 Support for the environment operating in SPL binary 3442 3443 CONFIG_SPL_NET_SUPPORT 3444 Support for the net/libnet.o in SPL binary. 3445 It conflicts with SPL env from storage medium specified by 3446 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3447 3448 CONFIG_SPL_PAD_TO 3449 Image offset to which the SPL should be padded before appending 3450 the SPL payload. By default, this is defined as 3451 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 3452 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 3453 payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 3454 3455 CONFIG_SPL_TARGET 3456 Final target image containing SPL and payload. Some SPLs 3457 use an arch-specific makefile fragment instead, for 3458 example if more than one image needs to be produced. 3459 3460 CONFIG_FIT_SPL_PRINT 3461 Printing information about a FIT image adds quite a bit of 3462 code to SPL. So this is normally disabled in SPL. Use this 3463 option to re-enable it. This will affect the output of the 3464 bootm command when booting a FIT image. 3465 3466- TPL framework 3467 CONFIG_TPL 3468 Enable building of TPL globally. 3469 3470 CONFIG_TPL_PAD_TO 3471 Image offset to which the TPL should be padded before appending 3472 the TPL payload. By default, this is defined as 3473 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 3474 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 3475 payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 3476 3477Modem Support: 3478-------------- 3479 3480[so far only for SMDK2400 boards] 3481 3482- Modem support enable: 3483 CONFIG_MODEM_SUPPORT 3484 3485- RTS/CTS Flow control enable: 3486 CONFIG_HWFLOW 3487 3488- Modem debug support: 3489 CONFIG_MODEM_SUPPORT_DEBUG 3490 3491 Enables debugging stuff (char screen[1024], dbg()) 3492 for modem support. Useful only with BDI2000. 3493 3494- Interrupt support (PPC): 3495 3496 There are common interrupt_init() and timer_interrupt() 3497 for all PPC archs. interrupt_init() calls interrupt_init_cpu() 3498 for CPU specific initialization. interrupt_init_cpu() 3499 should set decrementer_count to appropriate value. If 3500 CPU resets decrementer automatically after interrupt 3501 (ppc4xx) it should set decrementer_count to zero. 3502 timer_interrupt() calls timer_interrupt_cpu() for CPU 3503 specific handling. If board has watchdog / status_led 3504 / other_activity_monitor it works automatically from 3505 general timer_interrupt(). 3506 3507- General: 3508 3509 In the target system modem support is enabled when a 3510 specific key (key combination) is pressed during 3511 power-on. Otherwise U-Boot will boot normally 3512 (autoboot). The key_pressed() function is called from 3513 board_init(). Currently key_pressed() is a dummy 3514 function, returning 1 and thus enabling modem 3515 initialization. 3516 3517 If there are no modem init strings in the 3518 environment, U-Boot proceed to autoboot; the 3519 previous output (banner, info printfs) will be 3520 suppressed, though. 3521 3522 See also: doc/README.Modem 3523 3524Board initialization settings: 3525------------------------------ 3526 3527During Initialization u-boot calls a number of board specific functions 3528to allow the preparation of board specific prerequisites, e.g. pin setup 3529before drivers are initialized. To enable these callbacks the 3530following configuration macros have to be defined. Currently this is 3531architecture specific, so please check arch/your_architecture/lib/board.c 3532typically in board_init_f() and board_init_r(). 3533 3534- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 3535- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 3536- CONFIG_BOARD_LATE_INIT: Call board_late_init() 3537- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3538 3539Configuration Settings: 3540----------------------- 3541 3542- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 3543 Optionally it can be defined to support 64-bit memory commands. 3544 3545- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3546 undefine this when you're short of memory. 3547 3548- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 3549 width of the commands listed in the 'help' command output. 3550 3551- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3552 prompt for user input. 3553 3554- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3555 3556- CONFIG_SYS_PBSIZE: Buffer size for Console output 3557 3558- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3559 3560- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3561 the application (usually a Linux kernel) when it is 3562 booted 3563 3564- CONFIG_SYS_BAUDRATE_TABLE: 3565 List of legal baudrate settings for this board. 3566 3567- CONFIG_SYS_CONSOLE_INFO_QUIET 3568 Suppress display of console information at boot. 3569 3570- CONFIG_SYS_CONSOLE_IS_IN_ENV 3571 If the board specific function 3572 extern int overwrite_console (void); 3573 returns 1, the stdin, stderr and stdout are switched to the 3574 serial port, else the settings in the environment are used. 3575 3576- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3577 Enable the call to overwrite_console(). 3578 3579- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3580 Enable overwrite of previous console environment settings. 3581 3582- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3583 Begin and End addresses of the area used by the 3584 simple memory test. 3585 3586- CONFIG_SYS_ALT_MEMTEST: 3587 Enable an alternate, more extensive memory test. 3588 3589- CONFIG_SYS_MEMTEST_SCRATCH: 3590 Scratch address used by the alternate memory test 3591 You only need to set this if address zero isn't writeable 3592 3593- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 3594 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 3595 this specified memory area will get subtracted from the top 3596 (end) of RAM and won't get "touched" at all by U-Boot. By 3597 fixing up gd->ram_size the Linux kernel should gets passed 3598 the now "corrected" memory size and won't touch it either. 3599 This should work for arch/ppc and arch/powerpc. Only Linux 3600 board ports in arch/powerpc with bootwrapper support that 3601 recalculate the memory size from the SDRAM controller setup 3602 will have to get fixed in Linux additionally. 3603 3604 This option can be used as a workaround for the 440EPx/GRx 3605 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 3606 be touched. 3607 3608 WARNING: Please make sure that this value is a multiple of 3609 the Linux page size (normally 4k). If this is not the case, 3610 then the end address of the Linux memory will be located at a 3611 non page size aligned address and this could cause major 3612 problems. 3613 3614- CONFIG_SYS_LOADS_BAUD_CHANGE: 3615 Enable temporary baudrate change while serial download 3616 3617- CONFIG_SYS_SDRAM_BASE: 3618 Physical start address of SDRAM. _Must_ be 0 here. 3619 3620- CONFIG_SYS_MBIO_BASE: 3621 Physical start address of Motherboard I/O (if using a 3622 Cogent motherboard) 3623 3624- CONFIG_SYS_FLASH_BASE: 3625 Physical start address of Flash memory. 3626 3627- CONFIG_SYS_MONITOR_BASE: 3628 Physical start address of boot monitor code (set by 3629 make config files to be same as the text base address 3630 (CONFIG_SYS_TEXT_BASE) used when linking) - same as 3631 CONFIG_SYS_FLASH_BASE when booting from flash. 3632 3633- CONFIG_SYS_MONITOR_LEN: 3634 Size of memory reserved for monitor code, used to 3635 determine _at_compile_time_ (!) if the environment is 3636 embedded within the U-Boot image, or in a separate 3637 flash sector. 3638 3639- CONFIG_SYS_MALLOC_LEN: 3640 Size of DRAM reserved for malloc() use. 3641 3642- CONFIG_SYS_BOOTM_LEN: 3643 Normally compressed uImages are limited to an 3644 uncompressed size of 8 MBytes. If this is not enough, 3645 you can define CONFIG_SYS_BOOTM_LEN in your board config file 3646 to adjust this setting to your needs. 3647 3648- CONFIG_SYS_BOOTMAPSZ: 3649 Maximum size of memory mapped by the startup code of 3650 the Linux kernel; all data that must be processed by 3651 the Linux kernel (bd_info, boot arguments, FDT blob if 3652 used) must be put below this limit, unless "bootm_low" 3653 environment variable is defined and non-zero. In such case 3654 all data for the Linux kernel must be between "bootm_low" 3655 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3656 variable "bootm_mapsize" will override the value of 3657 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3658 then the value in "bootm_size" will be used instead. 3659 3660- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3661 Enable initrd_high functionality. If defined then the 3662 initrd_high feature is enabled and the bootm ramdisk subcommand 3663 is enabled. 3664 3665- CONFIG_SYS_BOOT_GET_CMDLINE: 3666 Enables allocating and saving kernel cmdline in space between 3667 "bootm_low" and "bootm_low" + BOOTMAPSZ. 3668 3669- CONFIG_SYS_BOOT_GET_KBD: 3670 Enables allocating and saving a kernel copy of the bd_info in 3671 space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3672 3673- CONFIG_SYS_MAX_FLASH_BANKS: 3674 Max number of Flash memory banks 3675 3676- CONFIG_SYS_MAX_FLASH_SECT: 3677 Max number of sectors on a Flash chip 3678 3679- CONFIG_SYS_FLASH_ERASE_TOUT: 3680 Timeout for Flash erase operations (in ms) 3681 3682- CONFIG_SYS_FLASH_WRITE_TOUT: 3683 Timeout for Flash write operations (in ms) 3684 3685- CONFIG_SYS_FLASH_LOCK_TOUT 3686 Timeout for Flash set sector lock bit operation (in ms) 3687 3688- CONFIG_SYS_FLASH_UNLOCK_TOUT 3689 Timeout for Flash clear lock bits operation (in ms) 3690 3691- CONFIG_SYS_FLASH_PROTECTION 3692 If defined, hardware flash sectors protection is used 3693 instead of U-Boot software protection. 3694 3695- CONFIG_SYS_DIRECT_FLASH_TFTP: 3696 3697 Enable TFTP transfers directly to flash memory; 3698 without this option such a download has to be 3699 performed in two steps: (1) download to RAM, and (2) 3700 copy from RAM to flash. 3701 3702 The two-step approach is usually more reliable, since 3703 you can check if the download worked before you erase 3704 the flash, but in some situations (when system RAM is 3705 too limited to allow for a temporary copy of the 3706 downloaded image) this option may be very useful. 3707 3708- CONFIG_SYS_FLASH_CFI: 3709 Define if the flash driver uses extra elements in the 3710 common flash structure for storing flash geometry. 3711 3712- CONFIG_FLASH_CFI_DRIVER 3713 This option also enables the building of the cfi_flash driver 3714 in the drivers directory 3715 3716- CONFIG_FLASH_CFI_MTD 3717 This option enables the building of the cfi_mtd driver 3718 in the drivers directory. The driver exports CFI flash 3719 to the MTD layer. 3720 3721- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 3722 Use buffered writes to flash. 3723 3724- CONFIG_FLASH_SPANSION_S29WS_N 3725 s29ws-n MirrorBit flash has non-standard addresses for buffered 3726 write commands. 3727 3728- CONFIG_SYS_FLASH_QUIET_TEST 3729 If this option is defined, the common CFI flash doesn't 3730 print it's warning upon not recognized FLASH banks. This 3731 is useful, if some of the configured banks are only 3732 optionally available. 3733 3734- CONFIG_FLASH_SHOW_PROGRESS 3735 If defined (must be an integer), print out countdown 3736 digits and dots. Recommended value: 45 (9..1) for 80 3737 column displays, 15 (3..1) for 40 column displays. 3738 3739- CONFIG_FLASH_VERIFY 3740 If defined, the content of the flash (destination) is compared 3741 against the source after the write operation. An error message 3742 will be printed when the contents are not identical. 3743 Please note that this option is useless in nearly all cases, 3744 since such flash programming errors usually are detected earlier 3745 while unprotecting/erasing/programming. Please only enable 3746 this option if you really know what you are doing. 3747 3748- CONFIG_SYS_RX_ETH_BUFFER: 3749 Defines the number of Ethernet receive buffers. On some 3750 Ethernet controllers it is recommended to set this value 3751 to 8 or even higher (EEPRO100 or 405 EMAC), since all 3752 buffers can be full shortly after enabling the interface 3753 on high Ethernet traffic. 3754 Defaults to 4 if not defined. 3755 3756- CONFIG_ENV_MAX_ENTRIES 3757 3758 Maximum number of entries in the hash table that is used 3759 internally to store the environment settings. The default 3760 setting is supposed to be generous and should work in most 3761 cases. This setting can be used to tune behaviour; see 3762 lib/hashtable.c for details. 3763 3764- CONFIG_ENV_FLAGS_LIST_DEFAULT 3765- CONFIG_ENV_FLAGS_LIST_STATIC 3766 Enable validation of the values given to environment variables when 3767 calling env set. Variables can be restricted to only decimal, 3768 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 3769 the variables can also be restricted to IP address or MAC address. 3770 3771 The format of the list is: 3772 type_attribute = [s|d|x|b|i|m] 3773 access_atribute = [a|r|o|c] 3774 attributes = type_attribute[access_atribute] 3775 entry = variable_name[:attributes] 3776 list = entry[,list] 3777 3778 The type attributes are: 3779 s - String (default) 3780 d - Decimal 3781 x - Hexadecimal 3782 b - Boolean ([1yYtT|0nNfF]) 3783 i - IP address 3784 m - MAC address 3785 3786 The access attributes are: 3787 a - Any (default) 3788 r - Read-only 3789 o - Write-once 3790 c - Change-default 3791 3792 - CONFIG_ENV_FLAGS_LIST_DEFAULT 3793 Define this to a list (string) to define the ".flags" 3794 envirnoment variable in the default or embedded environment. 3795 3796 - CONFIG_ENV_FLAGS_LIST_STATIC 3797 Define this to a list (string) to define validation that 3798 should be done if an entry is not found in the ".flags" 3799 environment variable. To override a setting in the static 3800 list, simply add an entry for the same variable name to the 3801 ".flags" variable. 3802 3803- CONFIG_ENV_ACCESS_IGNORE_FORCE 3804 If defined, don't allow the -f switch to env set override variable 3805 access flags. 3806 3807- CONFIG_SYS_GENERIC_BOARD 3808 This selects the architecture-generic board system instead of the 3809 architecture-specific board files. It is intended to move boards 3810 to this new framework over time. Defining this will disable the 3811 arch/foo/lib/board.c file and use common/board_f.c and 3812 common/board_r.c instead. To use this option your architecture 3813 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 3814 its config.mk file). If you find problems enabling this option on 3815 your board please report the problem and send patches! 3816 3817- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 3818 This is set by OMAP boards for the max time that reset should 3819 be asserted. See doc/README.omap-reset-time for details on how 3820 the value can be calulated on a given board. 3821 3822The following definitions that deal with the placement and management 3823of environment data (variable area); in general, we support the 3824following configurations: 3825 3826- CONFIG_BUILD_ENVCRC: 3827 3828 Builds up envcrc with the target environment so that external utils 3829 may easily extract it and embed it in final U-Boot images. 3830 3831- CONFIG_ENV_IS_IN_FLASH: 3832 3833 Define this if the environment is in flash memory. 3834 3835 a) The environment occupies one whole flash sector, which is 3836 "embedded" in the text segment with the U-Boot code. This 3837 happens usually with "bottom boot sector" or "top boot 3838 sector" type flash chips, which have several smaller 3839 sectors at the start or the end. For instance, such a 3840 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3841 such a case you would place the environment in one of the 3842 4 kB sectors - with U-Boot code before and after it. With 3843 "top boot sector" type flash chips, you would put the 3844 environment in one of the last sectors, leaving a gap 3845 between U-Boot and the environment. 3846 3847 - CONFIG_ENV_OFFSET: 3848 3849 Offset of environment data (variable area) to the 3850 beginning of flash memory; for instance, with bottom boot 3851 type flash chips the second sector can be used: the offset 3852 for this sector is given here. 3853 3854 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3855 3856 - CONFIG_ENV_ADDR: 3857 3858 This is just another way to specify the start address of 3859 the flash sector containing the environment (instead of 3860 CONFIG_ENV_OFFSET). 3861 3862 - CONFIG_ENV_SECT_SIZE: 3863 3864 Size of the sector containing the environment. 3865 3866 3867 b) Sometimes flash chips have few, equal sized, BIG sectors. 3868 In such a case you don't want to spend a whole sector for 3869 the environment. 3870 3871 - CONFIG_ENV_SIZE: 3872 3873 If you use this in combination with CONFIG_ENV_IS_IN_FLASH 3874 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3875 of this flash sector for the environment. This saves 3876 memory for the RAM copy of the environment. 3877 3878 It may also save flash memory if you decide to use this 3879 when your environment is "embedded" within U-Boot code, 3880 since then the remainder of the flash sector could be used 3881 for U-Boot code. It should be pointed out that this is 3882 STRONGLY DISCOURAGED from a robustness point of view: 3883 updating the environment in flash makes it always 3884 necessary to erase the WHOLE sector. If something goes 3885 wrong before the contents has been restored from a copy in 3886 RAM, your target system will be dead. 3887 3888 - CONFIG_ENV_ADDR_REDUND 3889 CONFIG_ENV_SIZE_REDUND 3890 3891 These settings describe a second storage area used to hold 3892 a redundant copy of the environment data, so that there is 3893 a valid backup copy in case there is a power failure during 3894 a "saveenv" operation. 3895 3896BE CAREFUL! Any changes to the flash layout, and some changes to the 3897source code will make it necessary to adapt <board>/u-boot.lds* 3898accordingly! 3899 3900 3901- CONFIG_ENV_IS_IN_NVRAM: 3902 3903 Define this if you have some non-volatile memory device 3904 (NVRAM, battery buffered SRAM) which you want to use for the 3905 environment. 3906 3907 - CONFIG_ENV_ADDR: 3908 - CONFIG_ENV_SIZE: 3909 3910 These two #defines are used to determine the memory area you 3911 want to use for environment. It is assumed that this memory 3912 can just be read and written to, without any special 3913 provision. 3914 3915BE CAREFUL! The first access to the environment happens quite early 3916in U-Boot initalization (when we try to get the setting of for the 3917console baudrate). You *MUST* have mapped your NVRAM area then, or 3918U-Boot will hang. 3919 3920Please note that even with NVRAM we still use a copy of the 3921environment in RAM: we could work on NVRAM directly, but we want to 3922keep settings there always unmodified except somebody uses "saveenv" 3923to save the current settings. 3924 3925 3926- CONFIG_ENV_IS_IN_EEPROM: 3927 3928 Use this if you have an EEPROM or similar serial access 3929 device and a driver for it. 3930 3931 - CONFIG_ENV_OFFSET: 3932 - CONFIG_ENV_SIZE: 3933 3934 These two #defines specify the offset and size of the 3935 environment area within the total memory of your EEPROM. 3936 3937 - CONFIG_SYS_I2C_EEPROM_ADDR: 3938 If defined, specified the chip address of the EEPROM device. 3939 The default address is zero. 3940 3941 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 3942 If defined, the number of bits used to address bytes in a 3943 single page in the EEPROM device. A 64 byte page, for example 3944 would require six bits. 3945 3946 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 3947 If defined, the number of milliseconds to delay between 3948 page writes. The default is zero milliseconds. 3949 3950 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 3951 The length in bytes of the EEPROM memory array address. Note 3952 that this is NOT the chip address length! 3953 3954 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 3955 EEPROM chips that implement "address overflow" are ones 3956 like Catalyst 24WC04/08/16 which has 9/10/11 bits of 3957 address and the extra bits end up in the "chip address" bit 3958 slots. This makes a 24WC08 (1Kbyte) chip look like four 256 3959 byte chips. 3960 3961 Note that we consider the length of the address field to 3962 still be one byte because the extra address bits are hidden 3963 in the chip address. 3964 3965 - CONFIG_SYS_EEPROM_SIZE: 3966 The size in bytes of the EEPROM device. 3967 3968 - CONFIG_ENV_EEPROM_IS_ON_I2C 3969 define this, if you have I2C and SPI activated, and your 3970 EEPROM, which holds the environment, is on the I2C bus. 3971 3972 - CONFIG_I2C_ENV_EEPROM_BUS 3973 if you have an Environment on an EEPROM reached over 3974 I2C muxes, you can define here, how to reach this 3975 EEPROM. For example: 3976 3977 #define CONFIG_I2C_ENV_EEPROM_BUS 1 3978 3979 EEPROM which holds the environment, is reached over 3980 a pca9547 i2c mux with address 0x70, channel 3. 3981 3982- CONFIG_ENV_IS_IN_DATAFLASH: 3983 3984 Define this if you have a DataFlash memory device which you 3985 want to use for the environment. 3986 3987 - CONFIG_ENV_OFFSET: 3988 - CONFIG_ENV_ADDR: 3989 - CONFIG_ENV_SIZE: 3990 3991 These three #defines specify the offset and size of the 3992 environment area within the total memory of your DataFlash placed 3993 at the specified address. 3994 3995- CONFIG_ENV_IS_IN_REMOTE: 3996 3997 Define this if you have a remote memory space which you 3998 want to use for the local device's environment. 3999 4000 - CONFIG_ENV_ADDR: 4001 - CONFIG_ENV_SIZE: 4002 4003 These two #defines specify the address and size of the 4004 environment area within the remote memory space. The 4005 local device can get the environment from remote memory 4006 space by SRIO or PCIE links. 4007 4008BE CAREFUL! For some special cases, the local device can not use 4009"saveenv" command. For example, the local device will get the 4010environment stored in a remote NOR flash by SRIO or PCIE link, 4011but it can not erase, write this NOR flash by SRIO or PCIE interface. 4012 4013- CONFIG_ENV_IS_IN_NAND: 4014 4015 Define this if you have a NAND device which you want to use 4016 for the environment. 4017 4018 - CONFIG_ENV_OFFSET: 4019 - CONFIG_ENV_SIZE: 4020 4021 These two #defines specify the offset and size of the environment 4022 area within the first NAND device. CONFIG_ENV_OFFSET must be 4023 aligned to an erase block boundary. 4024 4025 - CONFIG_ENV_OFFSET_REDUND (optional): 4026 4027 This setting describes a second storage area of CONFIG_ENV_SIZE 4028 size used to hold a redundant copy of the environment data, so 4029 that there is a valid backup copy in case there is a power failure 4030 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4031 aligned to an erase block boundary. 4032 4033 - CONFIG_ENV_RANGE (optional): 4034 4035 Specifies the length of the region in which the environment 4036 can be written. This should be a multiple of the NAND device's 4037 block size. Specifying a range with more erase blocks than 4038 are needed to hold CONFIG_ENV_SIZE allows bad blocks within 4039 the range to be avoided. 4040 4041 - CONFIG_ENV_OFFSET_OOB (optional): 4042 4043 Enables support for dynamically retrieving the offset of the 4044 environment from block zero's out-of-band data. The 4045 "nand env.oob" command can be used to record this offset. 4046 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 4047 using CONFIG_ENV_OFFSET_OOB. 4048 4049- CONFIG_NAND_ENV_DST 4050 4051 Defines address in RAM to which the nand_spl code should copy the 4052 environment. If redundant environment is used, it will be copied to 4053 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4054 4055- CONFIG_ENV_IS_IN_UBI: 4056 4057 Define this if you have an UBI volume that you want to use for the 4058 environment. This has the benefit of wear-leveling the environment 4059 accesses, which is important on NAND. 4060 4061 - CONFIG_ENV_UBI_PART: 4062 4063 Define this to a string that is the mtd partition containing the UBI. 4064 4065 - CONFIG_ENV_UBI_VOLUME: 4066 4067 Define this to the name of the volume that you want to store the 4068 environment in. 4069 4070 - CONFIG_ENV_UBI_VOLUME_REDUND: 4071 4072 Define this to the name of another volume to store a second copy of 4073 the environment in. This will enable redundant environments in UBI. 4074 It is assumed that both volumes are in the same MTD partition. 4075 4076 - CONFIG_UBI_SILENCE_MSG 4077 - CONFIG_UBIFS_SILENCE_MSG 4078 4079 You will probably want to define these to avoid a really noisy system 4080 when storing the env in UBI. 4081 4082- CONFIG_ENV_IS_IN_MMC: 4083 4084 Define this if you have an MMC device which you want to use for the 4085 environment. 4086 4087 - CONFIG_SYS_MMC_ENV_DEV: 4088 4089 Specifies which MMC device the environment is stored in. 4090 4091 - CONFIG_SYS_MMC_ENV_PART (optional): 4092 4093 Specifies which MMC partition the environment is stored in. If not 4094 set, defaults to partition 0, the user area. Common values might be 4095 1 (first MMC boot partition), 2 (second MMC boot partition). 4096 4097 - CONFIG_ENV_OFFSET: 4098 - CONFIG_ENV_SIZE: 4099 4100 These two #defines specify the offset and size of the environment 4101 area within the specified MMC device. 4102 4103 If offset is positive (the usual case), it is treated as relative to 4104 the start of the MMC partition. If offset is negative, it is treated 4105 as relative to the end of the MMC partition. This can be useful if 4106 your board may be fitted with different MMC devices, which have 4107 different sizes for the MMC partitions, and you always want the 4108 environment placed at the very end of the partition, to leave the 4109 maximum possible space before it, to store other data. 4110 4111 These two values are in units of bytes, but must be aligned to an 4112 MMC sector boundary. 4113 4114 - CONFIG_ENV_OFFSET_REDUND (optional): 4115 4116 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 4117 hold a redundant copy of the environment data. This provides a 4118 valid backup copy in case the other copy is corrupted, e.g. due 4119 to a power failure during a "saveenv" operation. 4120 4121 This value may also be positive or negative; this is handled in the 4122 same way as CONFIG_ENV_OFFSET. 4123 4124 This value is also in units of bytes, but must also be aligned to 4125 an MMC sector boundary. 4126 4127 - CONFIG_ENV_SIZE_REDUND (optional): 4128 4129 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 4130 set. If this value is set, it must be set to the same value as 4131 CONFIG_ENV_SIZE. 4132 4133- CONFIG_SYS_SPI_INIT_OFFSET 4134 4135 Defines offset to the initial SPI buffer area in DPRAM. The 4136 area is used at an early stage (ROM part) if the environment 4137 is configured to reside in the SPI EEPROM: We need a 520 byte 4138 scratch DPRAM area. It is used between the two initialization 4139 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4140 to be a good choice since it makes it far enough from the 4141 start of the data area as well as from the stack pointer. 4142 4143Please note that the environment is read-only until the monitor 4144has been relocated to RAM and a RAM copy of the environment has been 4145created; also, when using EEPROM you will have to use getenv_f() 4146until then to read environment variables. 4147 4148The environment is protected by a CRC32 checksum. Before the monitor 4149is relocated into RAM, as a result of a bad CRC you will be working 4150with the compiled-in default environment - *silently*!!! [This is 4151necessary, because the first environment variable we need is the 4152"baudrate" setting for the console - if we have a bad CRC, we don't 4153have any device yet where we could complain.] 4154 4155Note: once the monitor has been relocated, then it will complain if 4156the default environment is used; a new CRC is computed as soon as you 4157use the "saveenv" command to store a valid environment. 4158 4159- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4160 Echo the inverted Ethernet link state to the fault LED. 4161 4162 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4163 also needs to be defined. 4164 4165- CONFIG_SYS_FAULT_MII_ADDR: 4166 MII address of the PHY to check for the Ethernet link state. 4167 4168- CONFIG_NS16550_MIN_FUNCTIONS: 4169 Define this if you desire to only have use of the NS16550_init 4170 and NS16550_putc functions for the serial driver located at 4171 drivers/serial/ns16550.c. This option is useful for saving 4172 space for already greatly restricted images, including but not 4173 limited to NAND_SPL configurations. 4174 4175- CONFIG_DISPLAY_BOARDINFO 4176 Display information about the board that U-Boot is running on 4177 when U-Boot starts up. The board function checkboard() is called 4178 to do this. 4179 4180- CONFIG_DISPLAY_BOARDINFO_LATE 4181 Similar to the previous option, but display this information 4182 later, once stdio is running and output goes to the LCD, if 4183 present. 4184 4185Low Level (hardware related) configuration options: 4186--------------------------------------------------- 4187 4188- CONFIG_SYS_CACHELINE_SIZE: 4189 Cache Line Size of the CPU. 4190 4191- CONFIG_SYS_DEFAULT_IMMR: 4192 Default address of the IMMR after system reset. 4193 4194 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 4195 and RPXsuper) to be able to adjust the position of 4196 the IMMR register after a reset. 4197 4198- CONFIG_SYS_CCSRBAR_DEFAULT: 4199 Default (power-on reset) physical address of CCSR on Freescale 4200 PowerPC SOCs. 4201 4202- CONFIG_SYS_CCSRBAR: 4203 Virtual address of CCSR. On a 32-bit build, this is typically 4204 the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4205 4206 CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4207 for cross-platform code that uses that macro instead. 4208 4209- CONFIG_SYS_CCSRBAR_PHYS: 4210 Physical address of CCSR. CCSR can be relocated to a new 4211 physical address, if desired. In this case, this macro should 4212 be set to that address. Otherwise, it should be set to the 4213 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4214 is typically relocated on 36-bit builds. It is recommended 4215 that this macro be defined via the _HIGH and _LOW macros: 4216 4217 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4218 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4219 4220- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4221 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4222 either 0 (32-bit build) or 0xF (36-bit build). This macro is 4223 used in assembly code, so it must not contain typecasts or 4224 integer size suffixes (e.g. "ULL"). 4225 4226- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4227 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4228 used in assembly code, so it must not contain typecasts or 4229 integer size suffixes (e.g. "ULL"). 4230 4231- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4232 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4233 forced to a value that ensures that CCSR is not relocated. 4234 4235- Floppy Disk Support: 4236 CONFIG_SYS_FDC_DRIVE_NUMBER 4237 4238 the default drive number (default value 0) 4239 4240 CONFIG_SYS_ISA_IO_STRIDE 4241 4242 defines the spacing between FDC chipset registers 4243 (default value 1) 4244 4245 CONFIG_SYS_ISA_IO_OFFSET 4246 4247 defines the offset of register from address. It 4248 depends on which part of the data bus is connected to 4249 the FDC chipset. (default value 0) 4250 4251 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 4252 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 4253 default value. 4254 4255 if CONFIG_SYS_FDC_HW_INIT is defined, then the function 4256 fdc_hw_init() is called at the beginning of the FDC 4257 setup. fdc_hw_init() must be provided by the board 4258 source code. It is used to make hardware dependant 4259 initializations. 4260 4261- CONFIG_IDE_AHB: 4262 Most IDE controllers were designed to be connected with PCI 4263 interface. Only few of them were designed for AHB interface. 4264 When software is doing ATA command and data transfer to 4265 IDE devices through IDE-AHB controller, some additional 4266 registers accessing to these kind of IDE-AHB controller 4267 is requierd. 4268 4269- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 4270 DO NOT CHANGE unless you know exactly what you're 4271 doing! (11-4) [MPC8xx/82xx systems only] 4272 4273- CONFIG_SYS_INIT_RAM_ADDR: 4274 4275 Start address of memory area that can be used for 4276 initial data and stack; please note that this must be 4277 writable memory that is working WITHOUT special 4278 initialization, i. e. you CANNOT use normal RAM which 4279 will become available only after programming the 4280 memory controller and running certain initialization 4281 sequences. 4282 4283 U-Boot uses the following memory types: 4284 - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4285 - MPC824X: data cache 4286 - PPC4xx: data cache 4287 4288- CONFIG_SYS_GBL_DATA_OFFSET: 4289 4290 Offset of the initial data structure in the memory 4291 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 4292 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4293 data is located at the end of the available space 4294 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 4295 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 4296 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 4297 CONFIG_SYS_GBL_DATA_OFFSET) downward. 4298 4299 Note: 4300 On the MPC824X (or other systems that use the data 4301 cache for initial memory) the address chosen for 4302 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4303 point to an otherwise UNUSED address space between 4304 the top of RAM and the start of the PCI space. 4305 4306- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4307 4308- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4309 4310- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4311 4312- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4313 4314- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4315 4316- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4317 4318- CONFIG_SYS_OR_TIMING_SDRAM: 4319 SDRAM timing 4320 4321- CONFIG_SYS_MAMR_PTA: 4322 periodic timer for refresh 4323 4324- CONFIG_SYS_DER: Debug Event Register (37-47) 4325 4326- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 4327 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 4328 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 4329 CONFIG_SYS_BR1_PRELIM: 4330 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4331 4332- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 4333 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 4334 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4335 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4336 4337- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 4338 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4339 Machine Mode Register and Memory Periodic Timer 4340 Prescaler definitions (SDRAM timing) 4341 4342- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4343 enable I2C microcode relocation patch (MPC8xx); 4344 define relocation offset in DPRAM [DSP2] 4345 4346- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4347 enable SMC microcode relocation patch (MPC8xx); 4348 define relocation offset in DPRAM [SMC1] 4349 4350- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4351 enable SPI microcode relocation patch (MPC8xx); 4352 define relocation offset in DPRAM [SCC4] 4353 4354- CONFIG_SYS_USE_OSCCLK: 4355 Use OSCM clock mode on MBX8xx board. Be careful, 4356 wrong setting might damage your board. Read 4357 doc/README.MBX before setting this variable! 4358 4359- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4360 Offset of the bootmode word in DPRAM used by post 4361 (Power On Self Tests). This definition overrides 4362 #define'd default value in commproc.h resp. 4363 cpm_8260.h. 4364 4365- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 4366 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 4367 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 4368 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 4369 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 4370 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 4371 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 4372 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4373 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 4374 4375- CONFIG_PCI_DISABLE_PCIE: 4376 Disable PCI-Express on systems where it is supported but not 4377 required. 4378 4379- CONFIG_PCI_ENUM_ONLY 4380 Only scan through and get the devices on the busses. 4381 Don't do any setup work, presumably because someone or 4382 something has already done it, and we don't need to do it 4383 a second time. Useful for platforms that are pre-booted 4384 by coreboot or similar. 4385 4386- CONFIG_PCI_INDIRECT_BRIDGE: 4387 Enable support for indirect PCI bridges. 4388 4389- CONFIG_SYS_SRIO: 4390 Chip has SRIO or not 4391 4392- CONFIG_SRIO1: 4393 Board has SRIO 1 port available 4394 4395- CONFIG_SRIO2: 4396 Board has SRIO 2 port available 4397 4398- CONFIG_SRIO_PCIE_BOOT_MASTER 4399 Board can support master function for Boot from SRIO and PCIE 4400 4401- CONFIG_SYS_SRIOn_MEM_VIRT: 4402 Virtual Address of SRIO port 'n' memory region 4403 4404- CONFIG_SYS_SRIOn_MEM_PHYS: 4405 Physical Address of SRIO port 'n' memory region 4406 4407- CONFIG_SYS_SRIOn_MEM_SIZE: 4408 Size of SRIO port 'n' memory region 4409 4410- CONFIG_SYS_NAND_BUSWIDTH_16BIT 4411 Defined to tell the NAND controller that the NAND chip is using 4412 a 16 bit bus. 4413 Not all NAND drivers use this symbol. 4414 Example of drivers that use it: 4415 - drivers/mtd/nand/ndfc.c 4416 - drivers/mtd/nand/mxc_nand.c 4417 4418- CONFIG_SYS_NDFC_EBC0_CFG 4419 Sets the EBC0_CFG register for the NDFC. If not defined 4420 a default value will be used. 4421 4422- CONFIG_SPD_EEPROM 4423 Get DDR timing information from an I2C EEPROM. Common 4424 with pluggable memory modules such as SODIMMs 4425 4426 SPD_EEPROM_ADDRESS 4427 I2C address of the SPD EEPROM 4428 4429- CONFIG_SYS_SPD_BUS_NUM 4430 If SPD EEPROM is on an I2C bus other than the first 4431 one, specify here. Note that the value must resolve 4432 to something your driver can deal with. 4433 4434- CONFIG_SYS_DDR_RAW_TIMING 4435 Get DDR timing information from other than SPD. Common with 4436 soldered DDR chips onboard without SPD. DDR raw timing 4437 parameters are extracted from datasheet and hard-coded into 4438 header files or board specific files. 4439 4440- CONFIG_FSL_DDR_INTERACTIVE 4441 Enable interactive DDR debugging. See doc/README.fsl-ddr. 4442 4443- CONFIG_SYS_83XX_DDR_USES_CS0 4444 Only for 83xx systems. If specified, then DDR should 4445 be configured using CS0 and CS1 instead of CS2 and CS3. 4446 4447- CONFIG_ETHER_ON_FEC[12] 4448 Define to enable FEC[12] on a 8xx series processor. 4449 4450- CONFIG_FEC[12]_PHY 4451 Define to the hardcoded PHY address which corresponds 4452 to the given FEC; i. e. 4453 #define CONFIG_FEC1_PHY 4 4454 means that the PHY with address 4 is connected to FEC1 4455 4456 When set to -1, means to probe for first available. 4457 4458- CONFIG_FEC[12]_PHY_NORXERR 4459 The PHY does not have a RXERR line (RMII only). 4460 (so program the FEC to ignore it). 4461 4462- CONFIG_RMII 4463 Enable RMII mode for all FECs. 4464 Note that this is a global option, we can't 4465 have one FEC in standard MII mode and another in RMII mode. 4466 4467- CONFIG_CRC32_VERIFY 4468 Add a verify option to the crc32 command. 4469 The syntax is: 4470 4471 => crc32 -v <address> <count> <crc32> 4472 4473 Where address/count indicate a memory area 4474 and crc32 is the correct crc32 which the 4475 area should have. 4476 4477- CONFIG_LOOPW 4478 Add the "loopw" memory command. This only takes effect if 4479 the memory commands are activated globally (CONFIG_CMD_MEM). 4480 4481- CONFIG_MX_CYCLIC 4482 Add the "mdc" and "mwc" memory commands. These are cyclic 4483 "md/mw" commands. 4484 Examples: 4485 4486 => mdc.b 10 4 500 4487 This command will print 4 bytes (10,11,12,13) each 500 ms. 4488 4489 => mwc.l 100 12345678 10 4490 This command will write 12345678 to address 100 all 10 ms. 4491 4492 This only takes effect if the memory commands are activated 4493 globally (CONFIG_CMD_MEM). 4494 4495- CONFIG_SKIP_LOWLEVEL_INIT 4496 [ARM, NDS32, MIPS only] If this variable is defined, then certain 4497 low level initializations (like setting up the memory 4498 controller) are omitted and/or U-Boot does not 4499 relocate itself into RAM. 4500 4501 Normally this variable MUST NOT be defined. The only 4502 exception is when U-Boot is loaded (to RAM) by some 4503 other boot loader or by a debugger which performs 4504 these initializations itself. 4505 4506- CONFIG_SPL_BUILD 4507 Modifies the behaviour of start.S when compiling a loader 4508 that is executed before the actual U-Boot. E.g. when 4509 compiling a NAND SPL. 4510 4511- CONFIG_TPL_BUILD 4512 Modifies the behaviour of start.S when compiling a loader 4513 that is executed after the SPL and before the actual U-Boot. 4514 It is loaded by the SPL. 4515 4516- CONFIG_SYS_MPC85XX_NO_RESETVEC 4517 Only for 85xx systems. If this variable is specified, the section 4518 .resetvec is not kept and the section .bootpg is placed in the 4519 previous 4k of the .text section. 4520 4521- CONFIG_ARCH_MAP_SYSMEM 4522 Generally U-Boot (and in particular the md command) uses 4523 effective address. It is therefore not necessary to regard 4524 U-Boot address as virtual addresses that need to be translated 4525 to physical addresses. However, sandbox requires this, since 4526 it maintains its own little RAM buffer which contains all 4527 addressable memory. This option causes some memory accesses 4528 to be mapped through map_sysmem() / unmap_sysmem(). 4529 4530- CONFIG_USE_ARCH_MEMCPY 4531 CONFIG_USE_ARCH_MEMSET 4532 If these options are used a optimized version of memcpy/memset will 4533 be used if available. These functions may be faster under some 4534 conditions but may increase the binary size. 4535 4536- CONFIG_X86_RESET_VECTOR 4537 If defined, the x86 reset vector code is included. This is not 4538 needed when U-Boot is running from Coreboot. 4539 4540- CONFIG_SYS_MPUCLK 4541 Defines the MPU clock speed (in MHz). 4542 4543 NOTE : currently only supported on AM335x platforms. 4544 4545- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 4546 Enables the RTC32K OSC on AM33xx based plattforms 4547 4548- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4549 Option to disable subpage write in NAND driver 4550 driver that uses this: 4551 drivers/mtd/nand/davinci_nand.c 4552 4553Freescale QE/FMAN Firmware Support: 4554----------------------------------- 4555 4556The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4557loading of "firmware", which is encoded in the QE firmware binary format. 4558This firmware often needs to be loaded during U-Boot booting, so macros 4559are used to identify the storage device (NOR flash, SPI, etc) and the address 4560within that device. 4561 4562- CONFIG_SYS_FMAN_FW_ADDR 4563 The address in the storage device where the FMAN microcode is located. The 4564 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4565 is also specified. 4566 4567- CONFIG_SYS_QE_FW_ADDR 4568 The address in the storage device where the QE microcode is located. The 4569 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4570 is also specified. 4571 4572- CONFIG_SYS_QE_FMAN_FW_LENGTH 4573 The maximum possible size of the firmware. The firmware binary format 4574 has a field that specifies the actual size of the firmware, but it 4575 might not be possible to read any part of the firmware unless some 4576 local storage is allocated to hold the entire firmware first. 4577 4578- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4579 Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4580 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4581 virtual address in NOR flash. 4582 4583- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4584 Specifies that QE/FMAN firmware is located in NAND flash. 4585 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4586 4587- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4588 Specifies that QE/FMAN firmware is located on the primary SD/MMC 4589 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4590 4591- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4592 Specifies that QE/FMAN firmware is located on the primary SPI 4593 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4594 4595- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4596 Specifies that QE/FMAN firmware is located in the remote (master) 4597 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4598 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4599 window->master inbound window->master LAW->the ucode address in 4600 master's memory space. 4601 4602Building the Software: 4603====================== 4604 4605Building U-Boot has been tested in several native build environments 4606and in many different cross environments. Of course we cannot support 4607all possibly existing versions of cross development tools in all 4608(potentially obsolete) versions. In case of tool chain problems we 4609recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4610which is extensively used to build and test U-Boot. 4611 4612If you are not using a native environment, it is assumed that you 4613have GNU cross compiling tools available in your path. In this case, 4614you must set the environment variable CROSS_COMPILE in your shell. 4615Note that no changes to the Makefile or any other source files are 4616necessary. For example using the ELDK on a 4xx CPU, please enter: 4617 4618 $ CROSS_COMPILE=ppc_4xx- 4619 $ export CROSS_COMPILE 4620 4621Note: If you wish to generate Windows versions of the utilities in 4622 the tools directory you can use the MinGW toolchain 4623 (http://www.mingw.org). Set your HOST tools to the MinGW 4624 toolchain and execute 'make tools'. For example: 4625 4626 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 4627 4628 Binaries such as tools/mkimage.exe will be created which can 4629 be executed on computers running Windows. 4630 4631U-Boot is intended to be simple to build. After installing the 4632sources you must configure U-Boot for one specific board type. This 4633is done by typing: 4634 4635 make NAME_config 4636 4637where "NAME_config" is the name of one of the existing configu- 4638rations; see boards.cfg for supported names. 4639 4640Note: for some board special configuration names may exist; check if 4641 additional information is available from the board vendor; for 4642 instance, the TQM823L systems are available without (standard) 4643 or with LCD support. You can select such additional "features" 4644 when choosing the configuration, i. e. 4645 4646 make TQM823L_config 4647 - will configure for a plain TQM823L, i. e. no LCD support 4648 4649 make TQM823L_LCD_config 4650 - will configure for a TQM823L with U-Boot console on LCD 4651 4652 etc. 4653 4654 4655Finally, type "make all", and you should get some working U-Boot 4656images ready for download to / installation on your system: 4657 4658- "u-boot.bin" is a raw binary image 4659- "u-boot" is an image in ELF binary format 4660- "u-boot.srec" is in Motorola S-Record format 4661 4662By default the build is performed locally and the objects are saved 4663in the source directory. One of the two methods can be used to change 4664this behavior and build U-Boot to some external directory: 4665 46661. Add O= to the make command line invocations: 4667 4668 make O=/tmp/build distclean 4669 make O=/tmp/build NAME_config 4670 make O=/tmp/build all 4671 46722. Set environment variable BUILD_DIR to point to the desired location: 4673 4674 export BUILD_DIR=/tmp/build 4675 make distclean 4676 make NAME_config 4677 make all 4678 4679Note that the command line "O=" setting overrides the BUILD_DIR environment 4680variable. 4681 4682 4683Please be aware that the Makefiles assume you are using GNU make, so 4684for instance on NetBSD you might need to use "gmake" instead of 4685native "make". 4686 4687 4688If the system board that you have is not listed, then you will need 4689to port U-Boot to your hardware platform. To do this, follow these 4690steps: 4691 46921. Add a new configuration option for your board to the toplevel 4693 "boards.cfg" file, using the existing entries as examples. 4694 Follow the instructions there to keep the boards in order. 46952. Create a new directory to hold your board specific code. Add any 4696 files you need. In your board directory, you will need at least 4697 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 46983. Create a new configuration file "include/configs/<board>.h" for 4699 your board 47003. If you're porting U-Boot to a new CPU, then also create a new 4701 directory to hold your CPU specific code. Add any files you need. 47024. Run "make <board>_config" with your new name. 47035. Type "make", and you should get a working "u-boot.srec" file 4704 to be installed on your target system. 47056. Debug and solve any problems that might arise. 4706 [Of course, this last step is much harder than it sounds.] 4707 4708 4709Testing of U-Boot Modifications, Ports to New Hardware, etc.: 4710============================================================== 4711 4712If you have modified U-Boot sources (for instance added a new board 4713or support for new devices, a new CPU, etc.) you are expected to 4714provide feedback to the other developers. The feedback normally takes 4715the form of a "patch", i. e. a context diff against a certain (latest 4716official or latest in the git repository) version of U-Boot sources. 4717 4718But before you submit such a patch, please verify that your modifi- 4719cation did not break existing code. At least make sure that *ALL* of 4720the supported boards compile WITHOUT ANY compiler warnings. To do so, 4721just run the "MAKEALL" script, which will configure and build U-Boot 4722for ALL supported system. Be warned, this will take a while. You can 4723select which (cross) compiler to use by passing a `CROSS_COMPILE' 4724environment variable to the script, i. e. to use the ELDK cross tools 4725you can type 4726 4727 CROSS_COMPILE=ppc_8xx- MAKEALL 4728 4729or to build on a native PowerPC system you can type 4730 4731 CROSS_COMPILE=' ' MAKEALL 4732 4733When using the MAKEALL script, the default behaviour is to build 4734U-Boot in the source directory. This location can be changed by 4735setting the BUILD_DIR environment variable. Also, for each target 4736built, the MAKEALL script saves two log files (<target>.ERR and 4737<target>.MAKEALL) in the <source dir>/LOG directory. This default 4738location can be changed by setting the MAKEALL_LOGDIR environment 4739variable. For example: 4740 4741 export BUILD_DIR=/tmp/build 4742 export MAKEALL_LOGDIR=/tmp/log 4743 CROSS_COMPILE=ppc_8xx- MAKEALL 4744 4745With the above settings build objects are saved in the /tmp/build, 4746log files are saved in the /tmp/log and the source tree remains clean 4747during the whole build process. 4748 4749 4750See also "U-Boot Porting Guide" below. 4751 4752 4753Monitor Commands - Overview: 4754============================ 4755 4756go - start application at address 'addr' 4757run - run commands in an environment variable 4758bootm - boot application image from memory 4759bootp - boot image via network using BootP/TFTP protocol 4760bootz - boot zImage from memory 4761tftpboot- boot image via network using TFTP protocol 4762 and env variables "ipaddr" and "serverip" 4763 (and eventually "gatewayip") 4764tftpput - upload a file via network using TFTP protocol 4765rarpboot- boot image via network using RARP/TFTP protocol 4766diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4767loads - load S-Record file over serial line 4768loadb - load binary file over serial line (kermit mode) 4769md - memory display 4770mm - memory modify (auto-incrementing) 4771nm - memory modify (constant address) 4772mw - memory write (fill) 4773cp - memory copy 4774cmp - memory compare 4775crc32 - checksum calculation 4776i2c - I2C sub-system 4777sspi - SPI utility commands 4778base - print or set address offset 4779printenv- print environment variables 4780setenv - set environment variables 4781saveenv - save environment variables to persistent storage 4782protect - enable or disable FLASH write protection 4783erase - erase FLASH memory 4784flinfo - print FLASH memory information 4785nand - NAND memory operations (see doc/README.nand) 4786bdinfo - print Board Info structure 4787iminfo - print header information for application image 4788coninfo - print console devices and informations 4789ide - IDE sub-system 4790loop - infinite loop on address range 4791loopw - infinite write loop on address range 4792mtest - simple RAM test 4793icache - enable or disable instruction cache 4794dcache - enable or disable data cache 4795reset - Perform RESET of the CPU 4796echo - echo args to console 4797version - print monitor version 4798help - print online help 4799? - alias for 'help' 4800 4801 4802Monitor Commands - Detailed Description: 4803======================================== 4804 4805TODO. 4806 4807For now: just type "help <command>". 4808 4809 4810Environment Variables: 4811====================== 4812 4813U-Boot supports user configuration using Environment Variables which 4814can be made persistent by saving to Flash memory. 4815 4816Environment Variables are set using "setenv", printed using 4817"printenv", and saved to Flash using "saveenv". Using "setenv" 4818without a value can be used to delete a variable from the 4819environment. As long as you don't save the environment you are 4820working with an in-memory copy. In case the Flash area containing the 4821environment is erased by accident, a default environment is provided. 4822 4823Some configuration options can be set using Environment Variables. 4824 4825List of environment variables (most likely not complete): 4826 4827 baudrate - see CONFIG_BAUDRATE 4828 4829 bootdelay - see CONFIG_BOOTDELAY 4830 4831 bootcmd - see CONFIG_BOOTCOMMAND 4832 4833 bootargs - Boot arguments when booting an RTOS image 4834 4835 bootfile - Name of the image to load with TFTP 4836 4837 bootm_low - Memory range available for image processing in the bootm 4838 command can be restricted. This variable is given as 4839 a hexadecimal number and defines lowest address allowed 4840 for use by the bootm command. See also "bootm_size" 4841 environment variable. Address defined by "bootm_low" is 4842 also the base of the initial memory mapping for the Linux 4843 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 4844 bootm_mapsize. 4845 4846 bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 4847 This variable is given as a hexadecimal number and it 4848 defines the size of the memory region starting at base 4849 address bootm_low that is accessible by the Linux kernel 4850 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 4851 as the default value if it is defined, and bootm_size is 4852 used otherwise. 4853 4854 bootm_size - Memory range available for image processing in the bootm 4855 command can be restricted. This variable is given as 4856 a hexadecimal number and defines the size of the region 4857 allowed for use by the bootm command. See also "bootm_low" 4858 environment variable. 4859 4860 updatefile - Location of the software update file on a TFTP server, used 4861 by the automatic software update feature. Please refer to 4862 documentation in doc/README.update for more details. 4863 4864 autoload - if set to "no" (any string beginning with 'n'), 4865 "bootp" will just load perform a lookup of the 4866 configuration from the BOOTP server, but not try to 4867 load any image using TFTP 4868 4869 autostart - if set to "yes", an image loaded using the "bootp", 4870 "rarpboot", "tftpboot" or "diskboot" commands will 4871 be automatically started (by internally calling 4872 "bootm") 4873 4874 If set to "no", a standalone image passed to the 4875 "bootm" command will be copied to the load address 4876 (and eventually uncompressed), but NOT be started. 4877 This can be used to load and uncompress arbitrary 4878 data. 4879 4880 fdt_high - if set this restricts the maximum address that the 4881 flattened device tree will be copied into upon boot. 4882 For example, if you have a system with 1 GB memory 4883 at physical address 0x10000000, while Linux kernel 4884 only recognizes the first 704 MB as low memory, you 4885 may need to set fdt_high as 0x3C000000 to have the 4886 device tree blob be copied to the maximum address 4887 of the 704 MB low memory, so that Linux kernel can 4888 access it during the boot procedure. 4889 4890 If this is set to the special value 0xFFFFFFFF then 4891 the fdt will not be copied at all on boot. For this 4892 to work it must reside in writable memory, have 4893 sufficient padding on the end of it for u-boot to 4894 add the information it needs into it, and the memory 4895 must be accessible by the kernel. 4896 4897 fdtcontroladdr- if set this is the address of the control flattened 4898 device tree used by U-Boot when CONFIG_OF_CONTROL is 4899 defined. 4900 4901 i2cfast - (PPC405GP|PPC405EP only) 4902 if set to 'y' configures Linux I2C driver for fast 4903 mode (400kHZ). This environment variable is used in 4904 initialization code. So, for changes to be effective 4905 it must be saved and board must be reset. 4906 4907 initrd_high - restrict positioning of initrd images: 4908 If this variable is not set, initrd images will be 4909 copied to the highest possible address in RAM; this 4910 is usually what you want since it allows for 4911 maximum initrd size. If for some reason you want to 4912 make sure that the initrd image is loaded below the 4913 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 4914 variable to a value of "no" or "off" or "0". 4915 Alternatively, you can set it to a maximum upper 4916 address to use (U-Boot will still check that it 4917 does not overwrite the U-Boot stack and data). 4918 4919 For instance, when you have a system with 16 MB 4920 RAM, and want to reserve 4 MB from use by Linux, 4921 you can do this by adding "mem=12M" to the value of 4922 the "bootargs" variable. However, now you must make 4923 sure that the initrd image is placed in the first 4924 12 MB as well - this can be done with 4925 4926 setenv initrd_high 00c00000 4927 4928 If you set initrd_high to 0xFFFFFFFF, this is an 4929 indication to U-Boot that all addresses are legal 4930 for the Linux kernel, including addresses in flash 4931 memory. In this case U-Boot will NOT COPY the 4932 ramdisk at all. This may be useful to reduce the 4933 boot time on your system, but requires that this 4934 feature is supported by your Linux kernel. 4935 4936 ipaddr - IP address; needed for tftpboot command 4937 4938 loadaddr - Default load address for commands like "bootp", 4939 "rarpboot", "tftpboot", "loadb" or "diskboot" 4940 4941 loads_echo - see CONFIG_LOADS_ECHO 4942 4943 serverip - TFTP server IP address; needed for tftpboot command 4944 4945 bootretry - see CONFIG_BOOT_RETRY_TIME 4946 4947 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 4948 4949 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 4950 4951 ethprime - controls which interface is used first. 4952 4953 ethact - controls which interface is currently active. 4954 For example you can do the following 4955 4956 => setenv ethact FEC 4957 => ping 192.168.0.1 # traffic sent on FEC 4958 => setenv ethact SCC 4959 => ping 10.0.0.1 # traffic sent on SCC 4960 4961 ethrotate - When set to "no" U-Boot does not go through all 4962 available network interfaces. 4963 It just stays at the currently selected interface. 4964 4965 netretry - When set to "no" each network operation will 4966 either succeed or fail without retrying. 4967 When set to "once" the network operation will 4968 fail when all the available network interfaces 4969 are tried once without success. 4970 Useful on scripts which control the retry operation 4971 themselves. 4972 4973 npe_ucode - set load address for the NPE microcode 4974 4975 silent_linux - If set then linux will be told to boot silently, by 4976 changing the console to be empty. If "yes" it will be 4977 made silent. If "no" it will not be made silent. If 4978 unset, then it will be made silent if the U-Boot console 4979 is silent. 4980 4981 tftpsrcport - If this is set, the value is used for TFTP's 4982 UDP source port. 4983 4984 tftpdstport - If this is set, the value is used for TFTP's UDP 4985 destination port instead of the Well Know Port 69. 4986 4987 tftpblocksize - Block size to use for TFTP transfers; if not set, 4988 we use the TFTP server's default block size 4989 4990 tftptimeout - Retransmission timeout for TFTP packets (in milli- 4991 seconds, minimum value is 1000 = 1 second). Defines 4992 when a packet is considered to be lost so it has to 4993 be retransmitted. The default is 5000 = 5 seconds. 4994 Lowering this value may make downloads succeed 4995 faster in networks with high packet loss rates or 4996 with unreliable TFTP servers. 4997 4998 vlan - When set to a value < 4095 the traffic over 4999 Ethernet is encapsulated/received over 802.1q 5000 VLAN tagged frames. 5001 5002The following image location variables contain the location of images 5003used in booting. The "Image" column gives the role of the image and is 5004not an environment variable name. The other columns are environment 5005variable names. "File Name" gives the name of the file on a TFTP 5006server, "RAM Address" gives the location in RAM the image will be 5007loaded to, and "Flash Location" gives the image's address in NOR 5008flash or offset in NAND flash. 5009 5010*Note* - these variables don't have to be defined for all boards, some 5011boards currenlty use other variables for these purposes, and some 5012boards use these variables for other purposes. 5013 5014Image File Name RAM Address Flash Location 5015----- --------- ----------- -------------- 5016u-boot u-boot u-boot_addr_r u-boot_addr 5017Linux kernel bootfile kernel_addr_r kernel_addr 5018device tree blob fdtfile fdt_addr_r fdt_addr 5019ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 5020 5021The following environment variables may be used and automatically 5022updated by the network boot commands ("bootp" and "rarpboot"), 5023depending the information provided by your boot server: 5024 5025 bootfile - see above 5026 dnsip - IP address of your Domain Name Server 5027 dnsip2 - IP address of your secondary Domain Name Server 5028 gatewayip - IP address of the Gateway (Router) to use 5029 hostname - Target hostname 5030 ipaddr - see above 5031 netmask - Subnet Mask 5032 rootpath - Pathname of the root filesystem on the NFS server 5033 serverip - see above 5034 5035 5036There are two special Environment Variables: 5037 5038 serial# - contains hardware identification information such 5039 as type string and/or serial number 5040 ethaddr - Ethernet address 5041 5042These variables can be set only once (usually during manufacturing of 5043the board). U-Boot refuses to delete or overwrite these variables 5044once they have been set once. 5045 5046 5047Further special Environment Variables: 5048 5049 ver - Contains the U-Boot version string as printed 5050 with the "version" command. This variable is 5051 readonly (see CONFIG_VERSION_VARIABLE). 5052 5053 5054Please note that changes to some configuration parameters may take 5055only effect after the next boot (yes, that's just like Windoze :-). 5056 5057 5058Callback functions for environment variables: 5059--------------------------------------------- 5060 5061For some environment variables, the behavior of u-boot needs to change 5062when their values are changed. This functionailty allows functions to 5063be associated with arbitrary variables. On creation, overwrite, or 5064deletion, the callback will provide the opportunity for some side 5065effect to happen or for the change to be rejected. 5066 5067The callbacks are named and associated with a function using the 5068U_BOOT_ENV_CALLBACK macro in your board or driver code. 5069 5070These callbacks are associated with variables in one of two ways. The 5071static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5072in the board configuration to a string that defines a list of 5073associations. The list must be in the following format: 5074 5075 entry = variable_name[:callback_name] 5076 list = entry[,list] 5077 5078If the callback name is not specified, then the callback is deleted. 5079Spaces are also allowed anywhere in the list. 5080 5081Callbacks can also be associated by defining the ".callbacks" variable 5082with the same list format above. Any association in ".callbacks" will 5083override any association in the static list. You can define 5084CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5085".callbacks" envirnoment variable in the default or embedded environment. 5086 5087 5088Command Line Parsing: 5089===================== 5090 5091There are two different command line parsers available with U-Boot: 5092the old "simple" one, and the much more powerful "hush" shell: 5093 5094Old, simple command line parser: 5095-------------------------------- 5096 5097- supports environment variables (through setenv / saveenv commands) 5098- several commands on one line, separated by ';' 5099- variable substitution using "... ${name} ..." syntax 5100- special characters ('$', ';') can be escaped by prefixing with '\', 5101 for example: 5102 setenv bootcmd bootm \${address} 5103- You can also escape text by enclosing in single apostrophes, for example: 5104 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5105 5106Hush shell: 5107----------- 5108 5109- similar to Bourne shell, with control structures like 5110 if...then...else...fi, for...do...done; while...do...done, 5111 until...do...done, ... 5112- supports environment ("global") variables (through setenv / saveenv 5113 commands) and local shell variables (through standard shell syntax 5114 "name=value"); only environment variables can be used with "run" 5115 command 5116 5117General rules: 5118-------------- 5119 5120(1) If a command line (or an environment variable executed by a "run" 5121 command) contains several commands separated by semicolon, and 5122 one of these commands fails, then the remaining commands will be 5123 executed anyway. 5124 5125(2) If you execute several variables with one call to run (i. e. 5126 calling run with a list of variables as arguments), any failing 5127 command will cause "run" to terminate, i. e. the remaining 5128 variables are not executed. 5129 5130Note for Redundant Ethernet Interfaces: 5131======================================= 5132 5133Some boards come with redundant Ethernet interfaces; U-Boot supports 5134such configurations and is capable of automatic selection of a 5135"working" interface when needed. MAC assignment works as follows: 5136 5137Network interfaces are numbered eth0, eth1, eth2, ... Corresponding 5138MAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5139"eth1addr" (=>eth1), "eth2addr", ... 5140 5141If the network interface stores some valid MAC address (for instance 5142in SROM), this is used as default address if there is NO correspon- 5143ding setting in the environment; if the corresponding environment 5144variable is set, this overrides the settings in the card; that means: 5145 5146o If the SROM has a valid MAC address, and there is no address in the 5147 environment, the SROM's address is used. 5148 5149o If there is no valid address in the SROM, and a definition in the 5150 environment exists, then the value from the environment variable is 5151 used. 5152 5153o If both the SROM and the environment contain a MAC address, and 5154 both addresses are the same, this MAC address is used. 5155 5156o If both the SROM and the environment contain a MAC address, and the 5157 addresses differ, the value from the environment is used and a 5158 warning is printed. 5159 5160o If neither SROM nor the environment contain a MAC address, an error 5161 is raised. 5162 5163If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5164will be programmed into hardware as part of the initialization process. This 5165may be skipped by setting the appropriate 'ethmacskip' environment variable. 5166The naming convention is as follows: 5167"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5168 5169Image Formats: 5170============== 5171 5172U-Boot is capable of booting (and performing other auxiliary operations on) 5173images in two formats: 5174 5175New uImage format (FIT) 5176----------------------- 5177 5178Flexible and powerful format based on Flattened Image Tree -- FIT (similar 5179to Flattened Device Tree). It allows the use of images with multiple 5180components (several kernels, ramdisks, etc.), with contents protected by 5181SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 5182 5183 5184Old uImage format 5185----------------- 5186 5187Old image format is based on binary files which can be basically anything, 5188preceded by a special header; see the definitions in include/image.h for 5189details; basically, the header defines the following image properties: 5190 5191* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5192 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5193 LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5194 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5195 INTEGRITY). 5196* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5197 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5198 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5199* Compression Type (uncompressed, gzip, bzip2) 5200* Load Address 5201* Entry Point 5202* Image Name 5203* Image Timestamp 5204 5205The header is marked by a special Magic Number, and both the header 5206and the data portions of the image are secured against corruption by 5207CRC32 checksums. 5208 5209 5210Linux Support: 5211============== 5212 5213Although U-Boot should support any OS or standalone application 5214easily, the main focus has always been on Linux during the design of 5215U-Boot. 5216 5217U-Boot includes many features that so far have been part of some 5218special "boot loader" code within the Linux kernel. Also, any 5219"initrd" images to be used are no longer part of one big Linux image; 5220instead, kernel and "initrd" are separate images. This implementation 5221serves several purposes: 5222 5223- the same features can be used for other OS or standalone 5224 applications (for instance: using compressed images to reduce the 5225 Flash memory footprint) 5226 5227- it becomes much easier to port new Linux kernel versions because 5228 lots of low-level, hardware dependent stuff are done by U-Boot 5229 5230- the same Linux kernel image can now be used with different "initrd" 5231 images; of course this also means that different kernel images can 5232 be run with the same "initrd". This makes testing easier (you don't 5233 have to build a new "zImage.initrd" Linux image when you just 5234 change a file in your "initrd"). Also, a field-upgrade of the 5235 software is easier now. 5236 5237 5238Linux HOWTO: 5239============ 5240 5241Porting Linux to U-Boot based systems: 5242--------------------------------------- 5243 5244U-Boot cannot save you from doing all the necessary modifications to 5245configure the Linux device drivers for use with your target hardware 5246(no, we don't intend to provide a full virtual machine interface to 5247Linux :-). 5248 5249But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5250 5251Just make sure your machine specific header file (for instance 5252include/asm-ppc/tqm8xx.h) includes the same definition of the Board 5253Information structure as we define in include/asm-<arch>/u-boot.h, 5254and make sure that your definition of IMAP_ADDR uses the same value 5255as your U-Boot configuration in CONFIG_SYS_IMMR. 5256 5257 5258Configuring the Linux kernel: 5259----------------------------- 5260 5261No specific requirements for U-Boot. Make sure you have some root 5262device (initial ramdisk, NFS) for your target system. 5263 5264 5265Building a Linux Image: 5266----------------------- 5267 5268With U-Boot, "normal" build targets like "zImage" or "bzImage" are 5269not used. If you use recent kernel source, a new build target 5270"uImage" will exist which automatically builds an image usable by 5271U-Boot. Most older kernels also have support for a "pImage" target, 5272which was introduced for our predecessor project PPCBoot and uses a 5273100% compatible format. 5274 5275Example: 5276 5277 make TQM850L_config 5278 make oldconfig 5279 make dep 5280 make uImage 5281 5282The "uImage" build target uses a special tool (in 'tools/mkimage') to 5283encapsulate a compressed Linux kernel image with header information, 5284CRC32 checksum etc. for use with U-Boot. This is what we are doing: 5285 5286* build a standard "vmlinux" kernel image (in ELF binary format): 5287 5288* convert the kernel into a raw binary image: 5289 5290 ${CROSS_COMPILE}-objcopy -O binary \ 5291 -R .note -R .comment \ 5292 -S vmlinux linux.bin 5293 5294* compress the binary image: 5295 5296 gzip -9 linux.bin 5297 5298* package compressed binary image for U-Boot: 5299 5300 mkimage -A ppc -O linux -T kernel -C gzip \ 5301 -a 0 -e 0 -n "Linux Kernel Image" \ 5302 -d linux.bin.gz uImage 5303 5304 5305The "mkimage" tool can also be used to create ramdisk images for use 5306with U-Boot, either separated from the Linux kernel image, or 5307combined into one file. "mkimage" encapsulates the images with a 64 5308byte header containing information about target architecture, 5309operating system, image type, compression method, entry points, time 5310stamp, CRC32 checksums, etc. 5311 5312"mkimage" can be called in two ways: to verify existing images and 5313print the header information, or to build new images. 5314 5315In the first form (with "-l" option) mkimage lists the information 5316contained in the header of an existing U-Boot image; this includes 5317checksum verification: 5318 5319 tools/mkimage -l image 5320 -l ==> list image header information 5321 5322The second form (with "-d" option) is used to build a U-Boot image 5323from a "data file" which is used as image payload: 5324 5325 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5326 -n name -d data_file image 5327 -A ==> set architecture to 'arch' 5328 -O ==> set operating system to 'os' 5329 -T ==> set image type to 'type' 5330 -C ==> set compression type 'comp' 5331 -a ==> set load address to 'addr' (hex) 5332 -e ==> set entry point to 'ep' (hex) 5333 -n ==> set image name to 'name' 5334 -d ==> use image data from 'datafile' 5335 5336Right now, all Linux kernels for PowerPC systems use the same load 5337address (0x00000000), but the entry point address depends on the 5338kernel version: 5339 5340- 2.2.x kernels have the entry point at 0x0000000C, 5341- 2.3.x and later kernels have the entry point at 0x00000000. 5342 5343So a typical call to build a U-Boot image would read: 5344 5345 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 5346 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5347 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 5348 > examples/uImage.TQM850L 5349 Image Name: 2.4.4 kernel for TQM850L 5350 Created: Wed Jul 19 02:34:59 2000 5351 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5352 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5353 Load Address: 0x00000000 5354 Entry Point: 0x00000000 5355 5356To verify the contents of the image (or check for corruption): 5357 5358 -> tools/mkimage -l examples/uImage.TQM850L 5359 Image Name: 2.4.4 kernel for TQM850L 5360 Created: Wed Jul 19 02:34:59 2000 5361 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5362 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5363 Load Address: 0x00000000 5364 Entry Point: 0x00000000 5365 5366NOTE: for embedded systems where boot time is critical you can trade 5367speed for memory and install an UNCOMPRESSED image instead: this 5368needs more space in Flash, but boots much faster since it does not 5369need to be uncompressed: 5370 5371 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 5372 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 5373 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5374 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 5375 > examples/uImage.TQM850L-uncompressed 5376 Image Name: 2.4.4 kernel for TQM850L 5377 Created: Wed Jul 19 02:34:59 2000 5378 Image Type: PowerPC Linux Kernel Image (uncompressed) 5379 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5380 Load Address: 0x00000000 5381 Entry Point: 0x00000000 5382 5383 5384Similar you can build U-Boot images from a 'ramdisk.image.gz' file 5385when your kernel is intended to use an initial ramdisk: 5386 5387 -> tools/mkimage -n 'Simple Ramdisk Image' \ 5388 > -A ppc -O linux -T ramdisk -C gzip \ 5389 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5390 Image Name: Simple Ramdisk Image 5391 Created: Wed Jan 12 14:01:50 2000 5392 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5393 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5394 Load Address: 0x00000000 5395 Entry Point: 0x00000000 5396 5397The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5398option performs the converse operation of the mkimage's second form (the "-d" 5399option). Given an image built by mkimage, the dumpimage extracts a "data file" 5400from the image: 5401 5402 tools/dumpimage -i image -p position data_file 5403 -i ==> extract from the 'image' a specific 'data_file', \ 5404 indexed by 'position' 5405 5406 5407Installing a Linux Image: 5408------------------------- 5409 5410To downloading a U-Boot image over the serial (console) interface, 5411you must convert the image to S-Record format: 5412 5413 objcopy -I binary -O srec examples/image examples/image.srec 5414 5415The 'objcopy' does not understand the information in the U-Boot 5416image header, so the resulting S-Record file will be relative to 5417address 0x00000000. To load it to a given address, you need to 5418specify the target address as 'offset' parameter with the 'loads' 5419command. 5420 5421Example: install the image to address 0x40100000 (which on the 5422TQM8xxL is in the first Flash bank): 5423 5424 => erase 40100000 401FFFFF 5425 5426 .......... done 5427 Erased 8 sectors 5428 5429 => loads 40100000 5430 ## Ready for S-Record download ... 5431 ~>examples/image.srec 5432 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5433 ... 5434 15989 15990 15991 15992 5435 [file transfer complete] 5436 [connected] 5437 ## Start Addr = 0x00000000 5438 5439 5440You can check the success of the download using the 'iminfo' command; 5441this includes a checksum verification so you can be sure no data 5442corruption happened: 5443 5444 => imi 40100000 5445 5446 ## Checking Image at 40100000 ... 5447 Image Name: 2.2.13 for initrd on TQM850L 5448 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5449 Data Size: 335725 Bytes = 327 kB = 0 MB 5450 Load Address: 00000000 5451 Entry Point: 0000000c 5452 Verifying Checksum ... OK 5453 5454 5455Boot Linux: 5456----------- 5457 5458The "bootm" command is used to boot an application that is stored in 5459memory (RAM or Flash). In case of a Linux kernel image, the contents 5460of the "bootargs" environment variable is passed to the kernel as 5461parameters. You can check and modify this variable using the 5462"printenv" and "setenv" commands: 5463 5464 5465 => printenv bootargs 5466 bootargs=root=/dev/ram 5467 5468 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5469 5470 => printenv bootargs 5471 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5472 5473 => bootm 40020000 5474 ## Booting Linux kernel at 40020000 ... 5475 Image Name: 2.2.13 for NFS on TQM850L 5476 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5477 Data Size: 381681 Bytes = 372 kB = 0 MB 5478 Load Address: 00000000 5479 Entry Point: 0000000c 5480 Verifying Checksum ... OK 5481 Uncompressing Kernel Image ... OK 5482 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 5483 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5484 time_init: decrementer frequency = 187500000/60 5485 Calibrating delay loop... 49.77 BogoMIPS 5486 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5487 ... 5488 5489If you want to boot a Linux kernel with initial RAM disk, you pass 5490the memory addresses of both the kernel and the initrd image (PPBCOOT 5491format!) to the "bootm" command: 5492 5493 => imi 40100000 40200000 5494 5495 ## Checking Image at 40100000 ... 5496 Image Name: 2.2.13 for initrd on TQM850L 5497 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5498 Data Size: 335725 Bytes = 327 kB = 0 MB 5499 Load Address: 00000000 5500 Entry Point: 0000000c 5501 Verifying Checksum ... OK 5502 5503 ## Checking Image at 40200000 ... 5504 Image Name: Simple Ramdisk Image 5505 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5506 Data Size: 566530 Bytes = 553 kB = 0 MB 5507 Load Address: 00000000 5508 Entry Point: 00000000 5509 Verifying Checksum ... OK 5510 5511 => bootm 40100000 40200000 5512 ## Booting Linux kernel at 40100000 ... 5513 Image Name: 2.2.13 for initrd on TQM850L 5514 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5515 Data Size: 335725 Bytes = 327 kB = 0 MB 5516 Load Address: 00000000 5517 Entry Point: 0000000c 5518 Verifying Checksum ... OK 5519 Uncompressing Kernel Image ... OK 5520 ## Loading RAMDisk Image at 40200000 ... 5521 Image Name: Simple Ramdisk Image 5522 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5523 Data Size: 566530 Bytes = 553 kB = 0 MB 5524 Load Address: 00000000 5525 Entry Point: 00000000 5526 Verifying Checksum ... OK 5527 Loading Ramdisk ... OK 5528 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 5529 Boot arguments: root=/dev/ram 5530 time_init: decrementer frequency = 187500000/60 5531 Calibrating delay loop... 49.77 BogoMIPS 5532 ... 5533 RAMDISK: Compressed image found at block 0 5534 VFS: Mounted root (ext2 filesystem). 5535 5536 bash# 5537 5538Boot Linux and pass a flat device tree: 5539----------- 5540 5541First, U-Boot must be compiled with the appropriate defines. See the section 5542titled "Linux Kernel Interface" above for a more in depth explanation. The 5543following is an example of how to start a kernel and pass an updated 5544flat device tree: 5545 5546=> print oftaddr 5547oftaddr=0x300000 5548=> print oft 5549oft=oftrees/mpc8540ads.dtb 5550=> tftp $oftaddr $oft 5551Speed: 1000, full duplex 5552Using TSEC0 device 5553TFTP from server 192.168.1.1; our IP address is 192.168.1.101 5554Filename 'oftrees/mpc8540ads.dtb'. 5555Load address: 0x300000 5556Loading: # 5557done 5558Bytes transferred = 4106 (100a hex) 5559=> tftp $loadaddr $bootfile 5560Speed: 1000, full duplex 5561Using TSEC0 device 5562TFTP from server 192.168.1.1; our IP address is 192.168.1.2 5563Filename 'uImage'. 5564Load address: 0x200000 5565Loading:############ 5566done 5567Bytes transferred = 1029407 (fb51f hex) 5568=> print loadaddr 5569loadaddr=200000 5570=> print oftaddr 5571oftaddr=0x300000 5572=> bootm $loadaddr - $oftaddr 5573## Booting image at 00200000 ... 5574 Image Name: Linux-2.6.17-dirty 5575 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5576 Data Size: 1029343 Bytes = 1005.2 kB 5577 Load Address: 00000000 5578 Entry Point: 00000000 5579 Verifying Checksum ... OK 5580 Uncompressing Kernel Image ... OK 5581Booting using flat device tree at 0x300000 5582Using MPC85xx ADS machine description 5583Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 5584[snip] 5585 5586 5587More About U-Boot Image Types: 5588------------------------------ 5589 5590U-Boot supports the following image types: 5591 5592 "Standalone Programs" are directly runnable in the environment 5593 provided by U-Boot; it is expected that (if they behave 5594 well) you can continue to work in U-Boot after return from 5595 the Standalone Program. 5596 "OS Kernel Images" are usually images of some Embedded OS which 5597 will take over control completely. Usually these programs 5598 will install their own set of exception handlers, device 5599 drivers, set up the MMU, etc. - this means, that you cannot 5600 expect to re-enter U-Boot except by resetting the CPU. 5601 "RAMDisk Images" are more or less just data blocks, and their 5602 parameters (address, size) are passed to an OS kernel that is 5603 being started. 5604 "Multi-File Images" contain several images, typically an OS 5605 (Linux) kernel image and one or more data images like 5606 RAMDisks. This construct is useful for instance when you want 5607 to boot over the network using BOOTP etc., where the boot 5608 server provides just a single image file, but you want to get 5609 for instance an OS kernel and a RAMDisk image. 5610 5611 "Multi-File Images" start with a list of image sizes, each 5612 image size (in bytes) specified by an "uint32_t" in network 5613 byte order. This list is terminated by an "(uint32_t)0". 5614 Immediately after the terminating 0 follow the images, one by 5615 one, all aligned on "uint32_t" boundaries (size rounded up to 5616 a multiple of 4 bytes). 5617 5618 "Firmware Images" are binary images containing firmware (like 5619 U-Boot or FPGA images) which usually will be programmed to 5620 flash memory. 5621 5622 "Script files" are command sequences that will be executed by 5623 U-Boot's command interpreter; this feature is especially 5624 useful when you configure U-Boot to use a real shell (hush) 5625 as command interpreter. 5626 5627Booting the Linux zImage: 5628------------------------- 5629 5630On some platforms, it's possible to boot Linux zImage. This is done 5631using the "bootz" command. The syntax of "bootz" command is the same 5632as the syntax of "bootm" command. 5633 5634Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5635kernel with raw initrd images. The syntax is slightly different, the 5636address of the initrd must be augmented by it's size, in the following 5637format: "<initrd addres>:<initrd size>". 5638 5639 5640Standalone HOWTO: 5641================= 5642 5643One of the features of U-Boot is that you can dynamically load and 5644run "standalone" applications, which can use some resources of 5645U-Boot like console I/O functions or interrupt services. 5646 5647Two simple examples are included with the sources: 5648 5649"Hello World" Demo: 5650------------------- 5651 5652'examples/hello_world.c' contains a small "Hello World" Demo 5653application; it is automatically compiled when you build U-Boot. 5654It's configured to run at address 0x00040004, so you can play with it 5655like that: 5656 5657 => loads 5658 ## Ready for S-Record download ... 5659 ~>examples/hello_world.srec 5660 1 2 3 4 5 6 7 8 9 10 11 ... 5661 [file transfer complete] 5662 [connected] 5663 ## Start Addr = 0x00040004 5664 5665 => go 40004 Hello World! This is a test. 5666 ## Starting application at 0x00040004 ... 5667 Hello World 5668 argc = 7 5669 argv[0] = "40004" 5670 argv[1] = "Hello" 5671 argv[2] = "World!" 5672 argv[3] = "This" 5673 argv[4] = "is" 5674 argv[5] = "a" 5675 argv[6] = "test." 5676 argv[7] = "<NULL>" 5677 Hit any key to exit ... 5678 5679 ## Application terminated, rc = 0x0 5680 5681Another example, which demonstrates how to register a CPM interrupt 5682handler with the U-Boot code, can be found in 'examples/timer.c'. 5683Here, a CPM timer is set up to generate an interrupt every second. 5684The interrupt service routine is trivial, just printing a '.' 5685character, but this is just a demo program. The application can be 5686controlled by the following keys: 5687 5688 ? - print current values og the CPM Timer registers 5689 b - enable interrupts and start timer 5690 e - stop timer and disable interrupts 5691 q - quit application 5692 5693 => loads 5694 ## Ready for S-Record download ... 5695 ~>examples/timer.srec 5696 1 2 3 4 5 6 7 8 9 10 11 ... 5697 [file transfer complete] 5698 [connected] 5699 ## Start Addr = 0x00040004 5700 5701 => go 40004 5702 ## Starting application at 0x00040004 ... 5703 TIMERS=0xfff00980 5704 Using timer 1 5705 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5706 5707Hit 'b': 5708 [q, b, e, ?] Set interval 1000000 us 5709 Enabling timer 5710Hit '?': 5711 [q, b, e, ?] ........ 5712 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5713Hit '?': 5714 [q, b, e, ?] . 5715 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5716Hit '?': 5717 [q, b, e, ?] . 5718 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5719Hit '?': 5720 [q, b, e, ?] . 5721 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5722Hit 'e': 5723 [q, b, e, ?] ...Stopping timer 5724Hit 'q': 5725 [q, b, e, ?] ## Application terminated, rc = 0x0 5726 5727 5728Minicom warning: 5729================ 5730 5731Over time, many people have reported problems when trying to use the 5732"minicom" terminal emulation program for serial download. I (wd) 5733consider minicom to be broken, and recommend not to use it. Under 5734Unix, I recommend to use C-Kermit for general purpose use (and 5735especially for kermit binary protocol download ("loadb" command), and 5736use "cu" for S-Record download ("loads" command). See 5737http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5738for help with kermit. 5739 5740 5741Nevertheless, if you absolutely want to use it try adding this 5742configuration to your "File transfer protocols" section: 5743 5744 Name Program Name U/D FullScr IO-Red. Multi 5745 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 5746 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 5747 5748 5749NetBSD Notes: 5750============= 5751 5752Starting at version 0.9.2, U-Boot supports NetBSD both as host 5753(build U-Boot) and target system (boots NetBSD/mpc8xx). 5754 5755Building requires a cross environment; it is known to work on 5756NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5757need gmake since the Makefiles are not compatible with BSD make). 5758Note that the cross-powerpc package does not install include files; 5759attempting to build U-Boot will fail because <machine/ansi.h> is 5760missing. This file has to be installed and patched manually: 5761 5762 # cd /usr/pkg/cross/powerpc-netbsd/include 5763 # mkdir powerpc 5764 # ln -s powerpc machine 5765 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5766 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5767 5768Native builds *don't* work due to incompatibilities between native 5769and U-Boot include files. 5770 5771Booting assumes that (the first part of) the image booted is a 5772stage-2 loader which in turn loads and then invokes the kernel 5773proper. Loader sources will eventually appear in the NetBSD source 5774tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 5775meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5776 5777 5778Implementation Internals: 5779========================= 5780 5781The following is not intended to be a complete description of every 5782implementation detail. However, it should help to understand the 5783inner workings of U-Boot and make it easier to port it to custom 5784hardware. 5785 5786 5787Initial Stack, Global Data: 5788--------------------------- 5789 5790The implementation of U-Boot is complicated by the fact that U-Boot 5791starts running out of ROM (flash memory), usually without access to 5792system RAM (because the memory controller is not initialized yet). 5793This means that we don't have writable Data or BSS segments, and BSS 5794is not initialized as zero. To be able to get a C environment working 5795at all, we have to allocate at least a minimal stack. Implementation 5796options for this are defined and restricted by the CPU used: Some CPU 5797models provide on-chip memory (like the IMMR area on MPC8xx and 5798MPC826x processors), on others (parts of) the data cache can be 5799locked as (mis-) used as memory, etc. 5800 5801 Chris Hallinan posted a good summary of these issues to the 5802 U-Boot mailing list: 5803 5804 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 5805 From: "Chris Hallinan" <clh@net1plus.com> 5806 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 5807 ... 5808 5809 Correct me if I'm wrong, folks, but the way I understand it 5810 is this: Using DCACHE as initial RAM for Stack, etc, does not 5811 require any physical RAM backing up the cache. The cleverness 5812 is that the cache is being used as a temporary supply of 5813 necessary storage before the SDRAM controller is setup. It's 5814 beyond the scope of this list to explain the details, but you 5815 can see how this works by studying the cache architecture and 5816 operation in the architecture and processor-specific manuals. 5817 5818 OCM is On Chip Memory, which I believe the 405GP has 4K. It 5819 is another option for the system designer to use as an 5820 initial stack/RAM area prior to SDRAM being available. Either 5821 option should work for you. Using CS 4 should be fine if your 5822 board designers haven't used it for something that would 5823 cause you grief during the initial boot! It is frequently not 5824 used. 5825 5826 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 5827 with your processor/board/system design. The default value 5828 you will find in any recent u-boot distribution in 5829 walnut.h should work for you. I'd set it to a value larger 5830 than your SDRAM module. If you have a 64MB SDRAM module, set 5831 it above 400_0000. Just make sure your board has no resources 5832 that are supposed to respond to that address! That code in 5833 start.S has been around a while and should work as is when 5834 you get the config right. 5835 5836 -Chris Hallinan 5837 DS4.COM, Inc. 5838 5839It is essential to remember this, since it has some impact on the C 5840code for the initialization procedures: 5841 5842* Initialized global data (data segment) is read-only. Do not attempt 5843 to write it. 5844 5845* Do not use any uninitialized global data (or implicitely initialized 5846 as zero data - BSS segment) at all - this is undefined, initiali- 5847 zation is performed later (when relocating to RAM). 5848 5849* Stack space is very limited. Avoid big data buffers or things like 5850 that. 5851 5852Having only the stack as writable memory limits means we cannot use 5853normal global data to share information beween the code. But it 5854turned out that the implementation of U-Boot can be greatly 5855simplified by making a global data structure (gd_t) available to all 5856functions. We could pass a pointer to this data as argument to _all_ 5857functions, but this would bloat the code. Instead we use a feature of 5858the GCC compiler (Global Register Variables) to share the data: we 5859place a pointer (gd) to the global data into a register which we 5860reserve for this purpose. 5861 5862When choosing a register for such a purpose we are restricted by the 5863relevant (E)ABI specifications for the current architecture, and by 5864GCC's implementation. 5865 5866For PowerPC, the following registers have specific use: 5867 R1: stack pointer 5868 R2: reserved for system use 5869 R3-R4: parameter passing and return values 5870 R5-R10: parameter passing 5871 R13: small data area pointer 5872 R30: GOT pointer 5873 R31: frame pointer 5874 5875 (U-Boot also uses R12 as internal GOT pointer. r12 5876 is a volatile register so r12 needs to be reset when 5877 going back and forth between asm and C) 5878 5879 ==> U-Boot will use R2 to hold a pointer to the global data 5880 5881 Note: on PPC, we could use a static initializer (since the 5882 address of the global data structure is known at compile time), 5883 but it turned out that reserving a register results in somewhat 5884 smaller code - although the code savings are not that big (on 5885 average for all boards 752 bytes for the whole U-Boot image, 5886 624 text + 127 data). 5887 5888On Blackfin, the normal C ABI (except for P3) is followed as documented here: 5889 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 5890 5891 ==> U-Boot will use P3 to hold a pointer to the global data 5892 5893On ARM, the following registers are used: 5894 5895 R0: function argument word/integer result 5896 R1-R3: function argument word 5897 R9: platform specific 5898 R10: stack limit (used only if stack checking is enabled) 5899 R11: argument (frame) pointer 5900 R12: temporary workspace 5901 R13: stack pointer 5902 R14: link register 5903 R15: program counter 5904 5905 ==> U-Boot will use R9 to hold a pointer to the global data 5906 5907 Note: on ARM, only R_ARM_RELATIVE relocations are supported. 5908 5909On Nios II, the ABI is documented here: 5910 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 5911 5912 ==> U-Boot will use gp to hold a pointer to the global data 5913 5914 Note: on Nios II, we give "-G0" option to gcc and don't use gp 5915 to access small data sections, so gp is free. 5916 5917On NDS32, the following registers are used: 5918 5919 R0-R1: argument/return 5920 R2-R5: argument 5921 R15: temporary register for assembler 5922 R16: trampoline register 5923 R28: frame pointer (FP) 5924 R29: global pointer (GP) 5925 R30: link register (LP) 5926 R31: stack pointer (SP) 5927 PC: program counter (PC) 5928 5929 ==> U-Boot will use R10 to hold a pointer to the global data 5930 5931NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 5932or current versions of GCC may "optimize" the code too much. 5933 5934Memory Management: 5935------------------ 5936 5937U-Boot runs in system state and uses physical addresses, i.e. the 5938MMU is not used either for address mapping nor for memory protection. 5939 5940The available memory is mapped to fixed addresses using the memory 5941controller. In this process, a contiguous block is formed for each 5942memory type (Flash, SDRAM, SRAM), even when it consists of several 5943physical memory banks. 5944 5945U-Boot is installed in the first 128 kB of the first Flash bank (on 5946TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 5947booting and sizing and initializing DRAM, the code relocates itself 5948to the upper end of DRAM. Immediately below the U-Boot code some 5949memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 5950configuration setting]. Below that, a structure with global Board 5951Info data is placed, followed by the stack (growing downward). 5952 5953Additionally, some exception handler code is copied to the low 8 kB 5954of DRAM (0x00000000 ... 0x00001FFF). 5955 5956So a typical memory configuration with 16 MB of DRAM could look like 5957this: 5958 5959 0x0000 0000 Exception Vector code 5960 : 5961 0x0000 1FFF 5962 0x0000 2000 Free for Application Use 5963 : 5964 : 5965 5966 : 5967 : 5968 0x00FB FF20 Monitor Stack (Growing downward) 5969 0x00FB FFAC Board Info Data and permanent copy of global data 5970 0x00FC 0000 Malloc Arena 5971 : 5972 0x00FD FFFF 5973 0x00FE 0000 RAM Copy of Monitor Code 5974 ... eventually: LCD or video framebuffer 5975 ... eventually: pRAM (Protected RAM - unchanged by reset) 5976 0x00FF FFFF [End of RAM] 5977 5978 5979System Initialization: 5980---------------------- 5981 5982In the reset configuration, U-Boot starts at the reset entry point 5983(on most PowerPC systems at address 0x00000100). Because of the reset 5984configuration for CS0# this is a mirror of the onboard Flash memory. 5985To be able to re-map memory U-Boot then jumps to its link address. 5986To be able to implement the initialization code in C, a (small!) 5987initial stack is set up in the internal Dual Ported RAM (in case CPUs 5988which provide such a feature like MPC8xx or MPC8260), or in a locked 5989part of the data cache. After that, U-Boot initializes the CPU core, 5990the caches and the SIU. 5991 5992Next, all (potentially) available memory banks are mapped using a 5993preliminary mapping. For example, we put them on 512 MB boundaries 5994(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 5995on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 5996programmed for SDRAM access. Using the temporary configuration, a 5997simple memory test is run that determines the size of the SDRAM 5998banks. 5999 6000When there is more than one SDRAM bank, and the banks are of 6001different size, the largest is mapped first. For equal size, the first 6002bank (CS2#) is mapped first. The first mapping is always for address 60030x00000000, with any additional banks following immediately to create 6004contiguous memory starting from 0. 6005 6006Then, the monitor installs itself at the upper end of the SDRAM area 6007and allocates memory for use by malloc() and for the global Board 6008Info data; also, the exception vector code is copied to the low RAM 6009pages, and the final stack is set up. 6010 6011Only after this relocation will you have a "normal" C environment; 6012until that you are restricted in several ways, mostly because you are 6013running from ROM, and because the code will have to be relocated to a 6014new address in RAM. 6015 6016 6017U-Boot Porting Guide: 6018---------------------- 6019 6020[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 6021list, October 2002] 6022 6023 6024int main(int argc, char *argv[]) 6025{ 6026 sighandler_t no_more_time; 6027 6028 signal(SIGALRM, no_more_time); 6029 alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 6030 6031 if (available_money > available_manpower) { 6032 Pay consultant to port U-Boot; 6033 return 0; 6034 } 6035 6036 Download latest U-Boot source; 6037 6038 Subscribe to u-boot mailing list; 6039 6040 if (clueless) 6041 email("Hi, I am new to U-Boot, how do I get started?"); 6042 6043 while (learning) { 6044 Read the README file in the top level directory; 6045 Read http://www.denx.de/twiki/bin/view/DULG/Manual; 6046 Read applicable doc/*.README; 6047 Read the source, Luke; 6048 /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 6049 } 6050 6051 if (available_money > toLocalCurrency ($2500)) 6052 Buy a BDI3000; 6053 else 6054 Add a lot of aggravation and time; 6055 6056 if (a similar board exists) { /* hopefully... */ 6057 cp -a board/<similar> board/<myboard> 6058 cp include/configs/<similar>.h include/configs/<myboard>.h 6059 } else { 6060 Create your own board support subdirectory; 6061 Create your own board include/configs/<myboard>.h file; 6062 } 6063 Edit new board/<myboard> files 6064 Edit new include/configs/<myboard>.h 6065 6066 while (!accepted) { 6067 while (!running) { 6068 do { 6069 Add / modify source code; 6070 } until (compiles); 6071 Debug; 6072 if (clueless) 6073 email("Hi, I am having problems..."); 6074 } 6075 Send patch file to the U-Boot email list; 6076 if (reasonable critiques) 6077 Incorporate improvements from email list code review; 6078 else 6079 Defend code as written; 6080 } 6081 6082 return 0; 6083} 6084 6085void no_more_time (int sig) 6086{ 6087 hire_a_guru(); 6088} 6089 6090 6091Coding Standards: 6092----------------- 6093 6094All contributions to U-Boot should conform to the Linux kernel 6095coding style; see the file "Documentation/CodingStyle" and the script 6096"scripts/Lindent" in your Linux kernel source directory. 6097 6098Source files originating from a different project (for example the 6099MTD subsystem) are generally exempt from these guidelines and are not 6100reformated to ease subsequent migration to newer versions of those 6101sources. 6102 6103Please note that U-Boot is implemented in C (and to some small parts in 6104Assembler); no C++ is used, so please do not use C++ style comments (//) 6105in your code. 6106 6107Please also stick to the following formatting rules: 6108- remove any trailing white space 6109- use TAB characters for indentation and vertical alignment, not spaces 6110- make sure NOT to use DOS '\r\n' line feeds 6111- do not add more than 2 consecutive empty lines to source files 6112- do not add trailing empty lines to source files 6113 6114Submissions which do not conform to the standards may be returned 6115with a request to reformat the changes. 6116 6117 6118Submitting Patches: 6119------------------- 6120 6121Since the number of patches for U-Boot is growing, we need to 6122establish some rules. Submissions which do not conform to these rules 6123may be rejected, even when they contain important and valuable stuff. 6124 6125Please see http://www.denx.de/wiki/U-Boot/Patches for details. 6126 6127Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 6128see http://lists.denx.de/mailman/listinfo/u-boot 6129 6130When you send a patch, please include the following information with 6131it: 6132 6133* For bug fixes: a description of the bug and how your patch fixes 6134 this bug. Please try to include a way of demonstrating that the 6135 patch actually fixes something. 6136 6137* For new features: a description of the feature and your 6138 implementation. 6139 6140* A CHANGELOG entry as plaintext (separate from the patch) 6141 6142* For major contributions, your entry to the CREDITS file 6143 6144* When you add support for a new board, don't forget to add a 6145 maintainer e-mail address to the boards.cfg file, too. 6146 6147* If your patch adds new configuration options, don't forget to 6148 document these in the README file. 6149 6150* The patch itself. If you are using git (which is *strongly* 6151 recommended) you can easily generate the patch using the 6152 "git format-patch". If you then use "git send-email" to send it to 6153 the U-Boot mailing list, you will avoid most of the common problems 6154 with some other mail clients. 6155 6156 If you cannot use git, use "diff -purN OLD NEW". If your version of 6157 diff does not support these options, then get the latest version of 6158 GNU diff. 6159 6160 The current directory when running this command shall be the parent 6161 directory of the U-Boot source tree (i. e. please make sure that 6162 your patch includes sufficient directory information for the 6163 affected files). 6164 6165 We prefer patches as plain text. MIME attachments are discouraged, 6166 and compressed attachments must not be used. 6167 6168* If one logical set of modifications affects or creates several 6169 files, all these changes shall be submitted in a SINGLE patch file. 6170 6171* Changesets that contain different, unrelated modifications shall be 6172 submitted as SEPARATE patches, one patch per changeset. 6173 6174 6175Notes: 6176 6177* Before sending the patch, run the MAKEALL script on your patched 6178 source tree and make sure that no errors or warnings are reported 6179 for any of the boards. 6180 6181* Keep your modifications to the necessary minimum: A patch 6182 containing several unrelated changes or arbitrary reformats will be 6183 returned with a request to re-formatting / split it. 6184 6185* If you modify existing code, make sure that your new code does not 6186 add to the memory footprint of the code ;-) Small is beautiful! 6187 When adding new features, these should compile conditionally only 6188 (using #ifdef), and the resulting code with the new feature 6189 disabled must not need more memory than the old code without your 6190 modification. 6191 6192* Remember that there is a size limit of 100 kB per message on the 6193 u-boot mailing list. Bigger patches will be moderated. If they are 6194 reasonable and not too big, they will be acknowledged. But patches 6195 bigger than the size limit should be avoided. 6196