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