1# 2# (C) Copyright 2000 - 2013 3# Wolfgang Denk, DENX Software Engineering, wd@denx.de. 4# 5# SPDX-License-Identifier: GPL-2.0+ 6# 7 8Summary: 9======== 10 11This directory contains the source code for U-Boot, a boot loader for 12Embedded boards based on PowerPC, ARM, MIPS and several other 13processors, which can be installed in a boot ROM and used to 14initialize and test the hardware or to download and run application 15code. 16 17The development of U-Boot is closely related to Linux: some parts of 18the source code originate in the Linux source tree, we have some 19header files in common, and special provision has been made to 20support booting of Linux images. 21 22Some attention has been paid to make this software easily 23configurable and extendable. For instance, all monitor commands are 24implemented with the same call interface, so that it's very easy to 25add new commands. Also, instead of permanently adding rarely used 26code (for instance hardware test utilities) to the monitor, you can 27load and run it dynamically. 28 29 30Status: 31======= 32 33In general, all boards for which a configuration option exists in the 34Makefile have been tested to some extent and can be considered 35"working". In fact, many of them are used in production systems. 36 37In case of problems see the CHANGELOG and CREDITS files to find out 38who contributed the specific port. The boards.cfg file lists board 39maintainers. 40 41Note: There is no CHANGELOG file in the actual U-Boot source tree; 42it can be created dynamically from the Git log using: 43 44 make CHANGELOG 45 46 47Where to get help: 48================== 49 50In case you have questions about, problems with or contributions for 51U-Boot you should send a message to the U-Boot mailing list at 52<u-boot@lists.denx.de>. There is also an archive of previous traffic 53on the mailing list - please search the archive before asking FAQ's. 54Please see http://lists.denx.de/pipermail/u-boot and 55http://dir.gmane.org/gmane.comp.boot-loaders.u-boot 56 57 58Where to get source code: 59========================= 60 61The U-Boot source code is maintained in the git repository at 62git://www.denx.de/git/u-boot.git ; you can browse it online at 63http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary 64 65The "snapshot" links on this page allow you to download tarballs of 66any version you might be interested in. Official releases are also 67available for FTP download from the ftp://ftp.denx.de/pub/u-boot/ 68directory. 69 70Pre-built (and tested) images are available from 71ftp://ftp.denx.de/pub/u-boot/images/ 72 73 74Where we come from: 75=================== 76 77- start from 8xxrom sources 78- create PPCBoot project (http://sourceforge.net/projects/ppcboot) 79- clean up code 80- make it easier to add custom boards 81- make it possible to add other [PowerPC] CPUs 82- extend functions, especially: 83 * Provide extended interface to Linux boot loader 84 * S-Record download 85 * network boot 86 * PCMCIA / CompactFlash / ATA disk / SCSI ... boot 87- create ARMBoot project (http://sourceforge.net/projects/armboot) 88- add other CPU families (starting with ARM) 89- create U-Boot project (http://sourceforge.net/projects/u-boot) 90- current project page: see http://www.denx.de/wiki/U-Boot 91 92 93Names and Spelling: 94=================== 95 96The "official" name of this project is "Das U-Boot". The spelling 97"U-Boot" shall be used in all written text (documentation, comments 98in source files etc.). Example: 99 100 This is the README file for the U-Boot project. 101 102File names etc. shall be based on the string "u-boot". Examples: 103 104 include/asm-ppc/u-boot.h 105 106 #include <asm/u-boot.h> 107 108Variable names, preprocessor constants etc. shall be either based on 109the string "u_boot" or on "U_BOOT". Example: 110 111 U_BOOT_VERSION u_boot_logo 112 IH_OS_U_BOOT u_boot_hush_start 113 114 115Versioning: 116=========== 117 118Starting with the release in October 2008, the names of the releases 119were changed from numerical release numbers without deeper meaning 120into a time stamp based numbering. Regular releases are identified by 121names consisting of the calendar year and month of the release date. 122Additional fields (if present) indicate release candidates or bug fix 123releases in "stable" maintenance trees. 124 125Examples: 126 U-Boot v2009.11 - Release November 2009 127 U-Boot v2009.11.1 - Release 1 in version November 2009 stable tree 128 U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release 129 130 131Directory Hierarchy: 132==================== 133 134/arch Architecture specific files 135 /arc Files generic to ARC architecture 136 /cpu CPU specific files 137 /arc700 Files specific to ARC 700 CPUs 138 /lib Architecture specific library files 139 /arm Files generic to ARM architecture 140 /cpu CPU specific files 141 /arm720t Files specific to ARM 720 CPUs 142 /arm920t Files specific to ARM 920 CPUs 143 /at91 Files specific to Atmel AT91RM9200 CPU 144 /imx Files specific to Freescale MC9328 i.MX CPUs 145 /s3c24x0 Files specific to Samsung S3C24X0 CPUs 146 /arm926ejs Files specific to ARM 926 CPUs 147 /arm1136 Files specific to ARM 1136 CPUs 148 /pxa Files specific to Intel XScale PXA CPUs 149 /sa1100 Files specific to Intel StrongARM SA1100 CPUs 150 /lib Architecture specific library files 151 /avr32 Files generic to AVR32 architecture 152 /cpu CPU specific files 153 /lib Architecture specific library files 154 /blackfin Files generic to Analog Devices Blackfin architecture 155 /cpu CPU specific files 156 /lib Architecture specific library files 157 /m68k Files generic to m68k architecture 158 /cpu CPU specific files 159 /mcf52x2 Files specific to Freescale ColdFire MCF52x2 CPUs 160 /mcf5227x Files specific to Freescale ColdFire MCF5227x CPUs 161 /mcf532x Files specific to Freescale ColdFire MCF5329 CPUs 162 /mcf5445x Files specific to Freescale ColdFire MCF5445x CPUs 163 /mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs 164 /lib Architecture specific library files 165 /microblaze Files generic to microblaze architecture 166 /cpu CPU specific files 167 /lib Architecture specific library files 168 /mips Files generic to MIPS architecture 169 /cpu CPU specific files 170 /mips32 Files specific to MIPS32 CPUs 171 /mips64 Files specific to MIPS64 CPUs 172 /lib Architecture specific library files 173 /nds32 Files generic to NDS32 architecture 174 /cpu CPU specific files 175 /n1213 Files specific to Andes Technology N1213 CPUs 176 /lib Architecture specific library files 177 /nios2 Files generic to Altera NIOS2 architecture 178 /cpu CPU specific files 179 /lib Architecture specific library files 180 /openrisc Files generic to OpenRISC architecture 181 /cpu CPU specific files 182 /lib Architecture specific library files 183 /powerpc Files generic to PowerPC architecture 184 /cpu CPU specific files 185 /74xx_7xx Files specific to Freescale MPC74xx and 7xx CPUs 186 /mpc5xx Files specific to Freescale MPC5xx CPUs 187 /mpc5xxx Files specific to Freescale MPC5xxx CPUs 188 /mpc8xx Files specific to Freescale MPC8xx CPUs 189 /mpc824x Files specific to Freescale MPC824x CPUs 190 /mpc8260 Files specific to Freescale MPC8260 CPUs 191 /mpc85xx Files specific to Freescale MPC85xx CPUs 192 /ppc4xx Files specific to AMCC PowerPC 4xx CPUs 193 /lib Architecture specific library files 194 /sh Files generic to SH architecture 195 /cpu CPU specific files 196 /sh2 Files specific to sh2 CPUs 197 /sh3 Files specific to sh3 CPUs 198 /sh4 Files specific to sh4 CPUs 199 /lib Architecture specific library files 200 /sparc Files generic to SPARC architecture 201 /cpu CPU specific files 202 /leon2 Files specific to Gaisler LEON2 SPARC CPU 203 /leon3 Files specific to Gaisler LEON3 SPARC CPU 204 /lib Architecture specific library files 205 /x86 Files generic to x86 architecture 206 /cpu CPU specific files 207 /lib Architecture specific library files 208/api Machine/arch independent API for external apps 209/board Board dependent files 210/common Misc architecture independent functions 211/disk Code for disk drive partition handling 212/doc Documentation (don't expect too much) 213/drivers Commonly used device drivers 214/dts Contains Makefile for building internal U-Boot fdt. 215/examples Example code for standalone applications, etc. 216/fs Filesystem code (cramfs, ext2, jffs2, etc.) 217/include Header Files 218/lib Files generic to all architectures 219 /libfdt Library files to support flattened device trees 220 /lzma Library files to support LZMA decompression 221 /lzo Library files to support LZO decompression 222/net Networking code 223/post Power On Self Test 224/spl Secondary Program Loader framework 225/tools Tools to build S-Record or U-Boot images, etc. 226 227Software Configuration: 228======================= 229 230Configuration is usually done using C preprocessor defines; the 231rationale behind that is to avoid dead code whenever possible. 232 233There are two classes of configuration variables: 234 235* Configuration _OPTIONS_: 236 These are selectable by the user and have names beginning with 237 "CONFIG_". 238 239* Configuration _SETTINGS_: 240 These depend on the hardware etc. and should not be meddled with if 241 you don't know what you're doing; they have names beginning with 242 "CONFIG_SYS_". 243 244Later we will add a configuration tool - probably similar to or even 245identical to what's used for the Linux kernel. Right now, we have to 246do the configuration by hand, which means creating some symbolic 247links and editing some configuration files. We use the TQM8xxL boards 248as an example here. 249 250 251Selection of Processor Architecture and Board Type: 252--------------------------------------------------- 253 254For all supported boards there are ready-to-use default 255configurations available; just type "make <board_name>_config". 256 257Example: For a TQM823L module type: 258 259 cd u-boot 260 make TQM823L_config 261 262For the Cogent platform, you need to specify the CPU type as well; 263e.g. "make cogent_mpc8xx_config". And also configure the cogent 264directory according to the instructions in cogent/README. 265 266 267Sandbox Environment: 268-------------------- 269 270U-Boot can be built natively to run on a Linux host using the 'sandbox' 271board. This allows feature development which is not board- or architecture- 272specific to be undertaken on a native platform. The sandbox is also used to 273run some of U-Boot's tests. 274 275See board/sandbox/sandbox/README.sandbox for more details. 276 277 278Configuration Options: 279---------------------- 280 281Configuration depends on the combination of board and CPU type; all 282such information is kept in a configuration file 283"include/configs/<board_name>.h". 284 285Example: For a TQM823L module, all configuration settings are in 286"include/configs/TQM823L.h". 287 288 289Many of the options are named exactly as the corresponding Linux 290kernel configuration options. The intention is to make it easier to 291build a config tool - later. 292 293 294The following options need to be configured: 295 296- CPU Type: Define exactly one, e.g. CONFIG_MPC85XX. 297 298- Board Type: Define exactly one, e.g. CONFIG_MPC8540ADS. 299 300- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined) 301 Define exactly one, e.g. CONFIG_ATSTK1002 302 303- CPU Module Type: (if CONFIG_COGENT is defined) 304 Define exactly one of 305 CONFIG_CMA286_60_OLD 306--- FIXME --- not tested yet: 307 CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P, 308 CONFIG_CMA287_23, CONFIG_CMA287_50 309 310- Motherboard Type: (if CONFIG_COGENT is defined) 311 Define exactly one of 312 CONFIG_CMA101, CONFIG_CMA102 313 314- Motherboard I/O Modules: (if CONFIG_COGENT is defined) 315 Define one or more of 316 CONFIG_CMA302 317 318- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined) 319 Define one or more of 320 CONFIG_LCD_HEARTBEAT - update a character position on 321 the LCD display every second with 322 a "rotator" |\-/|\-/ 323 324- 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 additional defines: 2292 2293 CONFIG_SYS_NUM_I2C_BUSES 2294 Hold the number of i2c busses you want to use. If you 2295 don't use/have i2c muxes on your i2c bus, this 2296 is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can 2297 omit this define. 2298 2299 CONFIG_SYS_I2C_DIRECT_BUS 2300 define this, if you don't use i2c muxes on your hardware. 2301 if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can 2302 omit this define. 2303 2304 CONFIG_SYS_I2C_MAX_HOPS 2305 define how many muxes are maximal consecutively connected 2306 on one i2c bus. If you not use i2c muxes, omit this 2307 define. 2308 2309 CONFIG_SYS_I2C_BUSES 2310 hold a list of busses you want to use, only used if 2311 CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example 2312 a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and 2313 CONFIG_SYS_NUM_I2C_BUSES = 9: 2314 2315 CONFIG_SYS_I2C_BUSES {{0, {I2C_NULL_HOP}}, \ 2316 {0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \ 2317 {0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \ 2318 {0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \ 2319 {0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \ 2320 {0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \ 2321 {1, {I2C_NULL_HOP}}, \ 2322 {1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \ 2323 {1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \ 2324 } 2325 2326 which defines 2327 bus 0 on adapter 0 without a mux 2328 bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1 2329 bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2 2330 bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3 2331 bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4 2332 bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5 2333 bus 6 on adapter 1 without a mux 2334 bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1 2335 bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2 2336 2337 If you do not have i2c muxes on your board, omit this define. 2338 2339- Legacy I2C Support: CONFIG_HARD_I2C 2340 2341 NOTE: It is intended to move drivers to CONFIG_SYS_I2C which 2342 provides the following compelling advantages: 2343 2344 - more than one i2c adapter is usable 2345 - approved multibus support 2346 - better i2c mux support 2347 2348 ** Please consider updating your I2C driver now. ** 2349 2350 These enable legacy I2C serial bus commands. Defining 2351 CONFIG_HARD_I2C will include the appropriate I2C driver 2352 for the selected CPU. 2353 2354 This will allow you to use i2c commands at the u-boot 2355 command line (as long as you set CONFIG_CMD_I2C in 2356 CONFIG_COMMANDS) and communicate with i2c based realtime 2357 clock chips. See common/cmd_i2c.c for a description of the 2358 command line interface. 2359 2360 CONFIG_HARD_I2C selects a hardware I2C controller. 2361 2362 There are several other quantities that must also be 2363 defined when you define CONFIG_HARD_I2C. 2364 2365 In both cases you will need to define CONFIG_SYS_I2C_SPEED 2366 to be the frequency (in Hz) at which you wish your i2c bus 2367 to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie 2368 the CPU's i2c node address). 2369 2370 Now, the u-boot i2c code for the mpc8xx 2371 (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node 2372 and so its address should therefore be cleared to 0 (See, 2373 eg, MPC823e User's Manual p.16-473). So, set 2374 CONFIG_SYS_I2C_SLAVE to 0. 2375 2376 CONFIG_SYS_I2C_INIT_MPC5XXX 2377 2378 When a board is reset during an i2c bus transfer 2379 chips might think that the current transfer is still 2380 in progress. Reset the slave devices by sending start 2381 commands until the slave device responds. 2382 2383 That's all that's required for CONFIG_HARD_I2C. 2384 2385 If you use the software i2c interface (CONFIG_SYS_I2C_SOFT) 2386 then the following macros need to be defined (examples are 2387 from include/configs/lwmon.h): 2388 2389 I2C_INIT 2390 2391 (Optional). Any commands necessary to enable the I2C 2392 controller or configure ports. 2393 2394 eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |= PB_SCL) 2395 2396 I2C_PORT 2397 2398 (Only for MPC8260 CPU). The I/O port to use (the code 2399 assumes both bits are on the same port). Valid values 2400 are 0..3 for ports A..D. 2401 2402 I2C_ACTIVE 2403 2404 The code necessary to make the I2C data line active 2405 (driven). If the data line is open collector, this 2406 define can be null. 2407 2408 eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |= PB_SDA) 2409 2410 I2C_TRISTATE 2411 2412 The code necessary to make the I2C data line tri-stated 2413 (inactive). If the data line is open collector, this 2414 define can be null. 2415 2416 eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA) 2417 2418 I2C_READ 2419 2420 Code that returns true if the I2C data line is high, 2421 false if it is low. 2422 2423 eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0) 2424 2425 I2C_SDA(bit) 2426 2427 If <bit> is true, sets the I2C data line high. If it 2428 is false, it clears it (low). 2429 2430 eg: #define I2C_SDA(bit) \ 2431 if(bit) immr->im_cpm.cp_pbdat |= PB_SDA; \ 2432 else immr->im_cpm.cp_pbdat &= ~PB_SDA 2433 2434 I2C_SCL(bit) 2435 2436 If <bit> is true, sets the I2C clock line high. If it 2437 is false, it clears it (low). 2438 2439 eg: #define I2C_SCL(bit) \ 2440 if(bit) immr->im_cpm.cp_pbdat |= PB_SCL; \ 2441 else immr->im_cpm.cp_pbdat &= ~PB_SCL 2442 2443 I2C_DELAY 2444 2445 This delay is invoked four times per clock cycle so this 2446 controls the rate of data transfer. The data rate thus 2447 is 1 / (I2C_DELAY * 4). Often defined to be something 2448 like: 2449 2450 #define I2C_DELAY udelay(2) 2451 2452 CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA 2453 2454 If your arch supports the generic GPIO framework (asm/gpio.h), 2455 then you may alternatively define the two GPIOs that are to be 2456 used as SCL / SDA. Any of the previous I2C_xxx macros will 2457 have GPIO-based defaults assigned to them as appropriate. 2458 2459 You should define these to the GPIO value as given directly to 2460 the generic GPIO functions. 2461 2462 CONFIG_SYS_I2C_INIT_BOARD 2463 2464 When a board is reset during an i2c bus transfer 2465 chips might think that the current transfer is still 2466 in progress. On some boards it is possible to access 2467 the i2c SCLK line directly, either by using the 2468 processor pin as a GPIO or by having a second pin 2469 connected to the bus. If this option is defined a 2470 custom i2c_init_board() routine in boards/xxx/board.c 2471 is run early in the boot sequence. 2472 2473 CONFIG_SYS_I2C_BOARD_LATE_INIT 2474 2475 An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is 2476 defined a custom i2c_board_late_init() routine in 2477 boards/xxx/board.c is run AFTER the operations in i2c_init() 2478 is completed. This callpoint can be used to unreset i2c bus 2479 using CPU i2c controller register accesses for CPUs whose i2c 2480 controller provide such a method. It is called at the end of 2481 i2c_init() to allow i2c_init operations to setup the i2c bus 2482 controller on the CPU (e.g. setting bus speed & slave address). 2483 2484 CONFIG_I2CFAST (PPC405GP|PPC405EP only) 2485 2486 This option enables configuration of bi_iic_fast[] flags 2487 in u-boot bd_info structure based on u-boot environment 2488 variable "i2cfast". (see also i2cfast) 2489 2490 CONFIG_I2C_MULTI_BUS 2491 2492 This option allows the use of multiple I2C buses, each of which 2493 must have a controller. At any point in time, only one bus is 2494 active. To switch to a different bus, use the 'i2c dev' command. 2495 Note that bus numbering is zero-based. 2496 2497 CONFIG_SYS_I2C_NOPROBES 2498 2499 This option specifies a list of I2C devices that will be skipped 2500 when the 'i2c probe' command is issued. If CONFIG_I2C_MULTI_BUS 2501 is set, specify a list of bus-device pairs. Otherwise, specify 2502 a 1D array of device addresses 2503 2504 e.g. 2505 #undef CONFIG_I2C_MULTI_BUS 2506 #define CONFIG_SYS_I2C_NOPROBES {0x50,0x68} 2507 2508 will skip addresses 0x50 and 0x68 on a board with one I2C bus 2509 2510 #define CONFIG_I2C_MULTI_BUS 2511 #define CONFIG_SYS_I2C_MULTI_NOPROBES {{0,0x50},{0,0x68},{1,0x54}} 2512 2513 will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1 2514 2515 CONFIG_SYS_SPD_BUS_NUM 2516 2517 If defined, then this indicates the I2C bus number for DDR SPD. 2518 If not defined, then U-Boot assumes that SPD is on I2C bus 0. 2519 2520 CONFIG_SYS_RTC_BUS_NUM 2521 2522 If defined, then this indicates the I2C bus number for the RTC. 2523 If not defined, then U-Boot assumes that RTC is on I2C bus 0. 2524 2525 CONFIG_SYS_DTT_BUS_NUM 2526 2527 If defined, then this indicates the I2C bus number for the DTT. 2528 If not defined, then U-Boot assumes that DTT is on I2C bus 0. 2529 2530 CONFIG_SYS_I2C_DTT_ADDR: 2531 2532 If defined, specifies the I2C address of the DTT device. 2533 If not defined, then U-Boot uses predefined value for 2534 specified DTT device. 2535 2536 CONFIG_SOFT_I2C_READ_REPEATED_START 2537 2538 defining this will force the i2c_read() function in 2539 the soft_i2c driver to perform an I2C repeated start 2540 between writing the address pointer and reading the 2541 data. If this define is omitted the default behaviour 2542 of doing a stop-start sequence will be used. Most I2C 2543 devices can use either method, but some require one or 2544 the other. 2545 2546- SPI Support: CONFIG_SPI 2547 2548 Enables SPI driver (so far only tested with 2549 SPI EEPROM, also an instance works with Crystal A/D and 2550 D/As on the SACSng board) 2551 2552 CONFIG_SH_SPI 2553 2554 Enables the driver for SPI controller on SuperH. Currently 2555 only SH7757 is supported. 2556 2557 CONFIG_SPI_X 2558 2559 Enables extended (16-bit) SPI EEPROM addressing. 2560 (symmetrical to CONFIG_I2C_X) 2561 2562 CONFIG_SOFT_SPI 2563 2564 Enables a software (bit-bang) SPI driver rather than 2565 using hardware support. This is a general purpose 2566 driver that only requires three general I/O port pins 2567 (two outputs, one input) to function. If this is 2568 defined, the board configuration must define several 2569 SPI configuration items (port pins to use, etc). For 2570 an example, see include/configs/sacsng.h. 2571 2572 CONFIG_HARD_SPI 2573 2574 Enables a hardware SPI driver for general-purpose reads 2575 and writes. As with CONFIG_SOFT_SPI, the board configuration 2576 must define a list of chip-select function pointers. 2577 Currently supported on some MPC8xxx processors. For an 2578 example, see include/configs/mpc8349emds.h. 2579 2580 CONFIG_MXC_SPI 2581 2582 Enables the driver for the SPI controllers on i.MX and MXC 2583 SoCs. Currently i.MX31/35/51 are supported. 2584 2585- FPGA Support: CONFIG_FPGA 2586 2587 Enables FPGA subsystem. 2588 2589 CONFIG_FPGA_<vendor> 2590 2591 Enables support for specific chip vendors. 2592 (ALTERA, XILINX) 2593 2594 CONFIG_FPGA_<family> 2595 2596 Enables support for FPGA family. 2597 (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX) 2598 2599 CONFIG_FPGA_COUNT 2600 2601 Specify the number of FPGA devices to support. 2602 2603 CONFIG_CMD_FPGA_LOADMK 2604 2605 Enable support for fpga loadmk command 2606 2607 CONFIG_CMD_FPGA_LOADP 2608 2609 Enable support for fpga loadp command - load partial bitstream 2610 2611 CONFIG_CMD_FPGA_LOADBP 2612 2613 Enable support for fpga loadbp command - load partial bitstream 2614 (Xilinx only) 2615 2616 CONFIG_SYS_FPGA_PROG_FEEDBACK 2617 2618 Enable printing of hash marks during FPGA configuration. 2619 2620 CONFIG_SYS_FPGA_CHECK_BUSY 2621 2622 Enable checks on FPGA configuration interface busy 2623 status by the configuration function. This option 2624 will require a board or device specific function to 2625 be written. 2626 2627 CONFIG_FPGA_DELAY 2628 2629 If defined, a function that provides delays in the FPGA 2630 configuration driver. 2631 2632 CONFIG_SYS_FPGA_CHECK_CTRLC 2633 Allow Control-C to interrupt FPGA configuration 2634 2635 CONFIG_SYS_FPGA_CHECK_ERROR 2636 2637 Check for configuration errors during FPGA bitfile 2638 loading. For example, abort during Virtex II 2639 configuration if the INIT_B line goes low (which 2640 indicated a CRC error). 2641 2642 CONFIG_SYS_FPGA_WAIT_INIT 2643 2644 Maximum time to wait for the INIT_B line to deassert 2645 after PROB_B has been deasserted during a Virtex II 2646 FPGA configuration sequence. The default time is 500 2647 ms. 2648 2649 CONFIG_SYS_FPGA_WAIT_BUSY 2650 2651 Maximum time to wait for BUSY to deassert during 2652 Virtex II FPGA configuration. The default is 5 ms. 2653 2654 CONFIG_SYS_FPGA_WAIT_CONFIG 2655 2656 Time to wait after FPGA configuration. The default is 2657 200 ms. 2658 2659- Configuration Management: 2660 CONFIG_IDENT_STRING 2661 2662 If defined, this string will be added to the U-Boot 2663 version information (U_BOOT_VERSION) 2664 2665- Vendor Parameter Protection: 2666 2667 U-Boot considers the values of the environment 2668 variables "serial#" (Board Serial Number) and 2669 "ethaddr" (Ethernet Address) to be parameters that 2670 are set once by the board vendor / manufacturer, and 2671 protects these variables from casual modification by 2672 the user. Once set, these variables are read-only, 2673 and write or delete attempts are rejected. You can 2674 change this behaviour: 2675 2676 If CONFIG_ENV_OVERWRITE is #defined in your config 2677 file, the write protection for vendor parameters is 2678 completely disabled. Anybody can change or delete 2679 these parameters. 2680 2681 Alternatively, if you #define _both_ CONFIG_ETHADDR 2682 _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default 2683 Ethernet address is installed in the environment, 2684 which can be changed exactly ONCE by the user. [The 2685 serial# is unaffected by this, i. e. it remains 2686 read-only.] 2687 2688 The same can be accomplished in a more flexible way 2689 for any variable by configuring the type of access 2690 to allow for those variables in the ".flags" variable 2691 or define CONFIG_ENV_FLAGS_LIST_STATIC. 2692 2693- Protected RAM: 2694 CONFIG_PRAM 2695 2696 Define this variable to enable the reservation of 2697 "protected RAM", i. e. RAM which is not overwritten 2698 by U-Boot. Define CONFIG_PRAM to hold the number of 2699 kB you want to reserve for pRAM. You can overwrite 2700 this default value by defining an environment 2701 variable "pram" to the number of kB you want to 2702 reserve. Note that the board info structure will 2703 still show the full amount of RAM. If pRAM is 2704 reserved, a new environment variable "mem" will 2705 automatically be defined to hold the amount of 2706 remaining RAM in a form that can be passed as boot 2707 argument to Linux, for instance like that: 2708 2709 setenv bootargs ... mem=\${mem} 2710 saveenv 2711 2712 This way you can tell Linux not to use this memory, 2713 either, which results in a memory region that will 2714 not be affected by reboots. 2715 2716 *WARNING* If your board configuration uses automatic 2717 detection of the RAM size, you must make sure that 2718 this memory test is non-destructive. So far, the 2719 following board configurations are known to be 2720 "pRAM-clean": 2721 2722 IVMS8, IVML24, SPD8xx, TQM8xxL, 2723 HERMES, IP860, RPXlite, LWMON, 2724 FLAGADM, TQM8260 2725 2726- Access to physical memory region (> 4GB) 2727 Some basic support is provided for operations on memory not 2728 normally accessible to U-Boot - e.g. some architectures 2729 support access to more than 4GB of memory on 32-bit 2730 machines using physical address extension or similar. 2731 Define CONFIG_PHYSMEM to access this basic support, which 2732 currently only supports clearing the memory. 2733 2734- Error Recovery: 2735 CONFIG_PANIC_HANG 2736 2737 Define this variable to stop the system in case of a 2738 fatal error, so that you have to reset it manually. 2739 This is probably NOT a good idea for an embedded 2740 system where you want the system to reboot 2741 automatically as fast as possible, but it may be 2742 useful during development since you can try to debug 2743 the conditions that lead to the situation. 2744 2745 CONFIG_NET_RETRY_COUNT 2746 2747 This variable defines the number of retries for 2748 network operations like ARP, RARP, TFTP, or BOOTP 2749 before giving up the operation. If not defined, a 2750 default value of 5 is used. 2751 2752 CONFIG_ARP_TIMEOUT 2753 2754 Timeout waiting for an ARP reply in milliseconds. 2755 2756 CONFIG_NFS_TIMEOUT 2757 2758 Timeout in milliseconds used in NFS protocol. 2759 If you encounter "ERROR: Cannot umount" in nfs command, 2760 try longer timeout such as 2761 #define CONFIG_NFS_TIMEOUT 10000UL 2762 2763- Command Interpreter: 2764 CONFIG_AUTO_COMPLETE 2765 2766 Enable auto completion of commands using TAB. 2767 2768 Note that this feature has NOT been implemented yet 2769 for the "hush" shell. 2770 2771 2772 CONFIG_SYS_HUSH_PARSER 2773 2774 Define this variable to enable the "hush" shell (from 2775 Busybox) as command line interpreter, thus enabling 2776 powerful command line syntax like 2777 if...then...else...fi conditionals or `&&' and '||' 2778 constructs ("shell scripts"). 2779 2780 If undefined, you get the old, much simpler behaviour 2781 with a somewhat smaller memory footprint. 2782 2783 2784 CONFIG_SYS_PROMPT_HUSH_PS2 2785 2786 This defines the secondary prompt string, which is 2787 printed when the command interpreter needs more input 2788 to complete a command. Usually "> ". 2789 2790 Note: 2791 2792 In the current implementation, the local variables 2793 space and global environment variables space are 2794 separated. Local variables are those you define by 2795 simply typing `name=value'. To access a local 2796 variable later on, you have write `$name' or 2797 `${name}'; to execute the contents of a variable 2798 directly type `$name' at the command prompt. 2799 2800 Global environment variables are those you use 2801 setenv/printenv to work with. To run a command stored 2802 in such a variable, you need to use the run command, 2803 and you must not use the '$' sign to access them. 2804 2805 To store commands and special characters in a 2806 variable, please use double quotation marks 2807 surrounding the whole text of the variable, instead 2808 of the backslashes before semicolons and special 2809 symbols. 2810 2811- Commandline Editing and History: 2812 CONFIG_CMDLINE_EDITING 2813 2814 Enable editing and History functions for interactive 2815 commandline input operations 2816 2817- Default Environment: 2818 CONFIG_EXTRA_ENV_SETTINGS 2819 2820 Define this to contain any number of null terminated 2821 strings (variable = value pairs) that will be part of 2822 the default environment compiled into the boot image. 2823 2824 For example, place something like this in your 2825 board's config file: 2826 2827 #define CONFIG_EXTRA_ENV_SETTINGS \ 2828 "myvar1=value1\0" \ 2829 "myvar2=value2\0" 2830 2831 Warning: This method is based on knowledge about the 2832 internal format how the environment is stored by the 2833 U-Boot code. This is NOT an official, exported 2834 interface! Although it is unlikely that this format 2835 will change soon, there is no guarantee either. 2836 You better know what you are doing here. 2837 2838 Note: overly (ab)use of the default environment is 2839 discouraged. Make sure to check other ways to preset 2840 the environment like the "source" command or the 2841 boot command first. 2842 2843 CONFIG_ENV_VARS_UBOOT_CONFIG 2844 2845 Define this in order to add variables describing the 2846 U-Boot build configuration to the default environment. 2847 These will be named arch, cpu, board, vendor, and soc. 2848 2849 Enabling this option will cause the following to be defined: 2850 2851 - CONFIG_SYS_ARCH 2852 - CONFIG_SYS_CPU 2853 - CONFIG_SYS_BOARD 2854 - CONFIG_SYS_VENDOR 2855 - CONFIG_SYS_SOC 2856 2857 CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG 2858 2859 Define this in order to add variables describing certain 2860 run-time determined information about the hardware to the 2861 environment. These will be named board_name, board_rev. 2862 2863 CONFIG_DELAY_ENVIRONMENT 2864 2865 Normally the environment is loaded when the board is 2866 intialised so that it is available to U-Boot. This inhibits 2867 that so that the environment is not available until 2868 explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL 2869 this is instead controlled by the value of 2870 /config/load-environment. 2871 2872- DataFlash Support: 2873 CONFIG_HAS_DATAFLASH 2874 2875 Defining this option enables DataFlash features and 2876 allows to read/write in Dataflash via the standard 2877 commands cp, md... 2878 2879- Serial Flash support 2880 CONFIG_CMD_SF 2881 2882 Defining this option enables SPI flash commands 2883 'sf probe/read/write/erase/update'. 2884 2885 Usage requires an initial 'probe' to define the serial 2886 flash parameters, followed by read/write/erase/update 2887 commands. 2888 2889 The following defaults may be provided by the platform 2890 to handle the common case when only a single serial 2891 flash is present on the system. 2892 2893 CONFIG_SF_DEFAULT_BUS Bus identifier 2894 CONFIG_SF_DEFAULT_CS Chip-select 2895 CONFIG_SF_DEFAULT_MODE (see include/spi.h) 2896 CONFIG_SF_DEFAULT_SPEED in Hz 2897 2898 CONFIG_CMD_SF_TEST 2899 2900 Define this option to include a destructive SPI flash 2901 test ('sf test'). 2902 2903 CONFIG_SPI_FLASH_BAR Ban/Extended Addr Reg 2904 2905 Define this option to use the Bank addr/Extended addr 2906 support on SPI flashes which has size > 16Mbytes. 2907 2908 CONFIG_SF_DUAL_FLASH Dual flash memories 2909 2910 Define this option to use dual flash support where two flash 2911 memories can be connected with a given cs line. 2912 currently Xilinx Zynq qspi support these type of connections. 2913 2914- SystemACE Support: 2915 CONFIG_SYSTEMACE 2916 2917 Adding this option adds support for Xilinx SystemACE 2918 chips attached via some sort of local bus. The address 2919 of the chip must also be defined in the 2920 CONFIG_SYS_SYSTEMACE_BASE macro. For example: 2921 2922 #define CONFIG_SYSTEMACE 2923 #define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000 2924 2925 When SystemACE support is added, the "ace" device type 2926 becomes available to the fat commands, i.e. fatls. 2927 2928- TFTP Fixed UDP Port: 2929 CONFIG_TFTP_PORT 2930 2931 If this is defined, the environment variable tftpsrcp 2932 is used to supply the TFTP UDP source port value. 2933 If tftpsrcp isn't defined, the normal pseudo-random port 2934 number generator is used. 2935 2936 Also, the environment variable tftpdstp is used to supply 2937 the TFTP UDP destination port value. If tftpdstp isn't 2938 defined, the normal port 69 is used. 2939 2940 The purpose for tftpsrcp is to allow a TFTP server to 2941 blindly start the TFTP transfer using the pre-configured 2942 target IP address and UDP port. This has the effect of 2943 "punching through" the (Windows XP) firewall, allowing 2944 the remainder of the TFTP transfer to proceed normally. 2945 A better solution is to properly configure the firewall, 2946 but sometimes that is not allowed. 2947 2948- Hashing support: 2949 CONFIG_CMD_HASH 2950 2951 This enables a generic 'hash' command which can produce 2952 hashes / digests from a few algorithms (e.g. SHA1, SHA256). 2953 2954 CONFIG_HASH_VERIFY 2955 2956 Enable the hash verify command (hash -v). This adds to code 2957 size a little. 2958 2959 CONFIG_SHA1 - support SHA1 hashing 2960 CONFIG_SHA256 - support SHA256 hashing 2961 2962 Note: There is also a sha1sum command, which should perhaps 2963 be deprecated in favour of 'hash sha1'. 2964 2965- Freescale i.MX specific commands: 2966 CONFIG_CMD_HDMIDETECT 2967 This enables 'hdmidet' command which returns true if an 2968 HDMI monitor is detected. This command is i.MX 6 specific. 2969 2970 CONFIG_CMD_BMODE 2971 This enables the 'bmode' (bootmode) command for forcing 2972 a boot from specific media. 2973 2974 This is useful for forcing the ROM's usb downloader to 2975 activate upon a watchdog reset which is nice when iterating 2976 on U-Boot. Using the reset button or running bmode normal 2977 will set it back to normal. This command currently 2978 supports i.MX53 and i.MX6. 2979 2980- Signing support: 2981 CONFIG_RSA 2982 2983 This enables the RSA algorithm used for FIT image verification 2984 in U-Boot. See doc/uImage.FIT/signature.txt for more information. 2985 2986 The signing part is build into mkimage regardless of this 2987 option. 2988 2989- bootcount support: 2990 CONFIG_BOOTCOUNT_LIMIT 2991 2992 This enables the bootcounter support, see: 2993 http://www.denx.de/wiki/DULG/UBootBootCountLimit 2994 2995 CONFIG_AT91SAM9XE 2996 enable special bootcounter support on at91sam9xe based boards. 2997 CONFIG_BLACKFIN 2998 enable special bootcounter support on blackfin based boards. 2999 CONFIG_SOC_DA8XX 3000 enable special bootcounter support on da850 based boards. 3001 CONFIG_BOOTCOUNT_RAM 3002 enable support for the bootcounter in RAM 3003 CONFIG_BOOTCOUNT_I2C 3004 enable support for the bootcounter on an i2c (like RTC) device. 3005 CONFIG_SYS_I2C_RTC_ADDR = i2c chip address 3006 CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for 3007 the bootcounter. 3008 CONFIG_BOOTCOUNT_ALEN = address len 3009 3010- Show boot progress: 3011 CONFIG_SHOW_BOOT_PROGRESS 3012 3013 Defining this option allows to add some board- 3014 specific code (calling a user-provided function 3015 "show_boot_progress(int)") that enables you to show 3016 the system's boot progress on some display (for 3017 example, some LED's) on your board. At the moment, 3018 the following checkpoints are implemented: 3019 3020- Detailed boot stage timing 3021 CONFIG_BOOTSTAGE 3022 Define this option to get detailed timing of each stage 3023 of the boot process. 3024 3025 CONFIG_BOOTSTAGE_USER_COUNT 3026 This is the number of available user bootstage records. 3027 Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...) 3028 a new ID will be allocated from this stash. If you exceed 3029 the limit, recording will stop. 3030 3031 CONFIG_BOOTSTAGE_REPORT 3032 Define this to print a report before boot, similar to this: 3033 3034 Timer summary in microseconds: 3035 Mark Elapsed Stage 3036 0 0 reset 3037 3,575,678 3,575,678 board_init_f start 3038 3,575,695 17 arch_cpu_init A9 3039 3,575,777 82 arch_cpu_init done 3040 3,659,598 83,821 board_init_r start 3041 3,910,375 250,777 main_loop 3042 29,916,167 26,005,792 bootm_start 3043 30,361,327 445,160 start_kernel 3044 3045 CONFIG_CMD_BOOTSTAGE 3046 Add a 'bootstage' command which supports printing a report 3047 and un/stashing of bootstage data. 3048 3049 CONFIG_BOOTSTAGE_FDT 3050 Stash the bootstage information in the FDT. A root 'bootstage' 3051 node is created with each bootstage id as a child. Each child 3052 has a 'name' property and either 'mark' containing the 3053 mark time in microsecond, or 'accum' containing the 3054 accumulated time for that bootstage id in microseconds. 3055 For example: 3056 3057 bootstage { 3058 154 { 3059 name = "board_init_f"; 3060 mark = <3575678>; 3061 }; 3062 170 { 3063 name = "lcd"; 3064 accum = <33482>; 3065 }; 3066 }; 3067 3068 Code in the Linux kernel can find this in /proc/devicetree. 3069 3070Legacy uImage format: 3071 3072 Arg Where When 3073 1 common/cmd_bootm.c before attempting to boot an image 3074 -1 common/cmd_bootm.c Image header has bad magic number 3075 2 common/cmd_bootm.c Image header has correct magic number 3076 -2 common/cmd_bootm.c Image header has bad checksum 3077 3 common/cmd_bootm.c Image header has correct checksum 3078 -3 common/cmd_bootm.c Image data has bad checksum 3079 4 common/cmd_bootm.c Image data has correct checksum 3080 -4 common/cmd_bootm.c Image is for unsupported architecture 3081 5 common/cmd_bootm.c Architecture check OK 3082 -5 common/cmd_bootm.c Wrong Image Type (not kernel, multi) 3083 6 common/cmd_bootm.c Image Type check OK 3084 -6 common/cmd_bootm.c gunzip uncompression error 3085 -7 common/cmd_bootm.c Unimplemented compression type 3086 7 common/cmd_bootm.c Uncompression OK 3087 8 common/cmd_bootm.c No uncompress/copy overwrite error 3088 -9 common/cmd_bootm.c Unsupported OS (not Linux, BSD, VxWorks, QNX) 3089 3090 9 common/image.c Start initial ramdisk verification 3091 -10 common/image.c Ramdisk header has bad magic number 3092 -11 common/image.c Ramdisk header has bad checksum 3093 10 common/image.c Ramdisk header is OK 3094 -12 common/image.c Ramdisk data has bad checksum 3095 11 common/image.c Ramdisk data has correct checksum 3096 12 common/image.c Ramdisk verification complete, start loading 3097 -13 common/image.c Wrong Image Type (not PPC Linux ramdisk) 3098 13 common/image.c Start multifile image verification 3099 14 common/image.c No initial ramdisk, no multifile, continue. 3100 3101 15 arch/<arch>/lib/bootm.c All preparation done, transferring control to OS 3102 3103 -30 arch/powerpc/lib/board.c Fatal error, hang the system 3104 -31 post/post.c POST test failed, detected by post_output_backlog() 3105 -32 post/post.c POST test failed, detected by post_run_single() 3106 3107 34 common/cmd_doc.c before loading a Image from a DOC device 3108 -35 common/cmd_doc.c Bad usage of "doc" command 3109 35 common/cmd_doc.c correct usage of "doc" command 3110 -36 common/cmd_doc.c No boot device 3111 36 common/cmd_doc.c correct boot device 3112 -37 common/cmd_doc.c Unknown Chip ID on boot device 3113 37 common/cmd_doc.c correct chip ID found, device available 3114 -38 common/cmd_doc.c Read Error on boot device 3115 38 common/cmd_doc.c reading Image header from DOC device OK 3116 -39 common/cmd_doc.c Image header has bad magic number 3117 39 common/cmd_doc.c Image header has correct magic number 3118 -40 common/cmd_doc.c Error reading Image from DOC device 3119 40 common/cmd_doc.c Image header has correct magic number 3120 41 common/cmd_ide.c before loading a Image from a IDE device 3121 -42 common/cmd_ide.c Bad usage of "ide" command 3122 42 common/cmd_ide.c correct usage of "ide" command 3123 -43 common/cmd_ide.c No boot device 3124 43 common/cmd_ide.c boot device found 3125 -44 common/cmd_ide.c Device not available 3126 44 common/cmd_ide.c Device available 3127 -45 common/cmd_ide.c wrong partition selected 3128 45 common/cmd_ide.c partition selected 3129 -46 common/cmd_ide.c Unknown partition table 3130 46 common/cmd_ide.c valid partition table found 3131 -47 common/cmd_ide.c Invalid partition type 3132 47 common/cmd_ide.c correct partition type 3133 -48 common/cmd_ide.c Error reading Image Header on boot device 3134 48 common/cmd_ide.c reading Image Header from IDE device OK 3135 -49 common/cmd_ide.c Image header has bad magic number 3136 49 common/cmd_ide.c Image header has correct magic number 3137 -50 common/cmd_ide.c Image header has bad checksum 3138 50 common/cmd_ide.c Image header has correct checksum 3139 -51 common/cmd_ide.c Error reading Image from IDE device 3140 51 common/cmd_ide.c reading Image from IDE device OK 3141 52 common/cmd_nand.c before loading a Image from a NAND device 3142 -53 common/cmd_nand.c Bad usage of "nand" command 3143 53 common/cmd_nand.c correct usage of "nand" command 3144 -54 common/cmd_nand.c No boot device 3145 54 common/cmd_nand.c boot device found 3146 -55 common/cmd_nand.c Unknown Chip ID on boot device 3147 55 common/cmd_nand.c correct chip ID found, device available 3148 -56 common/cmd_nand.c Error reading Image Header on boot device 3149 56 common/cmd_nand.c reading Image Header from NAND device OK 3150 -57 common/cmd_nand.c Image header has bad magic number 3151 57 common/cmd_nand.c Image header has correct magic number 3152 -58 common/cmd_nand.c Error reading Image from NAND device 3153 58 common/cmd_nand.c reading Image from NAND device OK 3154 3155 -60 common/env_common.c Environment has a bad CRC, using default 3156 3157 64 net/eth.c starting with Ethernet configuration. 3158 -64 net/eth.c no Ethernet found. 3159 65 net/eth.c Ethernet found. 3160 3161 -80 common/cmd_net.c usage wrong 3162 80 common/cmd_net.c before calling NetLoop() 3163 -81 common/cmd_net.c some error in NetLoop() occurred 3164 81 common/cmd_net.c NetLoop() back without error 3165 -82 common/cmd_net.c size == 0 (File with size 0 loaded) 3166 82 common/cmd_net.c trying automatic boot 3167 83 common/cmd_net.c running "source" command 3168 -83 common/cmd_net.c some error in automatic boot or "source" command 3169 84 common/cmd_net.c end without errors 3170 3171FIT uImage format: 3172 3173 Arg Where When 3174 100 common/cmd_bootm.c Kernel FIT Image has correct format 3175 -100 common/cmd_bootm.c Kernel FIT Image has incorrect format 3176 101 common/cmd_bootm.c No Kernel subimage unit name, using configuration 3177 -101 common/cmd_bootm.c Can't get configuration for kernel subimage 3178 102 common/cmd_bootm.c Kernel unit name specified 3179 -103 common/cmd_bootm.c Can't get kernel subimage node offset 3180 103 common/cmd_bootm.c Found configuration node 3181 104 common/cmd_bootm.c Got kernel subimage node offset 3182 -104 common/cmd_bootm.c Kernel subimage hash verification failed 3183 105 common/cmd_bootm.c Kernel subimage hash verification OK 3184 -105 common/cmd_bootm.c Kernel subimage is for unsupported architecture 3185 106 common/cmd_bootm.c Architecture check OK 3186 -106 common/cmd_bootm.c Kernel subimage has wrong type 3187 107 common/cmd_bootm.c Kernel subimage type OK 3188 -107 common/cmd_bootm.c Can't get kernel subimage data/size 3189 108 common/cmd_bootm.c Got kernel subimage data/size 3190 -108 common/cmd_bootm.c Wrong image type (not legacy, FIT) 3191 -109 common/cmd_bootm.c Can't get kernel subimage type 3192 -110 common/cmd_bootm.c Can't get kernel subimage comp 3193 -111 common/cmd_bootm.c Can't get kernel subimage os 3194 -112 common/cmd_bootm.c Can't get kernel subimage load address 3195 -113 common/cmd_bootm.c Image uncompress/copy overwrite error 3196 3197 120 common/image.c Start initial ramdisk verification 3198 -120 common/image.c Ramdisk FIT image has incorrect format 3199 121 common/image.c Ramdisk FIT image has correct format 3200 122 common/image.c No ramdisk subimage unit name, using configuration 3201 -122 common/image.c Can't get configuration for ramdisk subimage 3202 123 common/image.c Ramdisk unit name specified 3203 -124 common/image.c Can't get ramdisk subimage node offset 3204 125 common/image.c Got ramdisk subimage node offset 3205 -125 common/image.c Ramdisk subimage hash verification failed 3206 126 common/image.c Ramdisk subimage hash verification OK 3207 -126 common/image.c Ramdisk subimage for unsupported architecture 3208 127 common/image.c Architecture check OK 3209 -127 common/image.c Can't get ramdisk subimage data/size 3210 128 common/image.c Got ramdisk subimage data/size 3211 129 common/image.c Can't get ramdisk load address 3212 -129 common/image.c Got ramdisk load address 3213 3214 -130 common/cmd_doc.c Incorrect FIT image format 3215 131 common/cmd_doc.c FIT image format OK 3216 3217 -140 common/cmd_ide.c Incorrect FIT image format 3218 141 common/cmd_ide.c FIT image format OK 3219 3220 -150 common/cmd_nand.c Incorrect FIT image format 3221 151 common/cmd_nand.c FIT image format OK 3222 3223- legacy image format: 3224 CONFIG_IMAGE_FORMAT_LEGACY 3225 enables the legacy image format support in U-Boot. 3226 3227 Default: 3228 enabled if CONFIG_FIT_SIGNATURE is not defined. 3229 3230 CONFIG_DISABLE_IMAGE_LEGACY 3231 disable the legacy image format 3232 3233 This define is introduced, as the legacy image format is 3234 enabled per default for backward compatibility. 3235 3236- FIT image support: 3237 CONFIG_FIT 3238 Enable support for the FIT uImage format. 3239 3240 CONFIG_FIT_BEST_MATCH 3241 When no configuration is explicitly selected, default to the 3242 one whose fdt's compatibility field best matches that of 3243 U-Boot itself. A match is considered "best" if it matches the 3244 most specific compatibility entry of U-Boot's fdt's root node. 3245 The order of entries in the configuration's fdt is ignored. 3246 3247 CONFIG_FIT_SIGNATURE 3248 This option enables signature verification of FIT uImages, 3249 using a hash signed and verified using RSA. See 3250 doc/uImage.FIT/signature.txt for more details. 3251 3252 WARNING: When relying on signed FIT images with required 3253 signature check the legacy image format is default 3254 disabled. If a board need legacy image format support 3255 enable this through CONFIG_IMAGE_FORMAT_LEGACY 3256 3257- Standalone program support: 3258 CONFIG_STANDALONE_LOAD_ADDR 3259 3260 This option defines a board specific value for the 3261 address where standalone program gets loaded, thus 3262 overwriting the architecture dependent default 3263 settings. 3264 3265- Frame Buffer Address: 3266 CONFIG_FB_ADDR 3267 3268 Define CONFIG_FB_ADDR if you want to use specific 3269 address for frame buffer. This is typically the case 3270 when using a graphics controller has separate video 3271 memory. U-Boot will then place the frame buffer at 3272 the given address instead of dynamically reserving it 3273 in system RAM by calling lcd_setmem(), which grabs 3274 the memory for the frame buffer depending on the 3275 configured panel size. 3276 3277 Please see board_init_f function. 3278 3279- Automatic software updates via TFTP server 3280 CONFIG_UPDATE_TFTP 3281 CONFIG_UPDATE_TFTP_CNT_MAX 3282 CONFIG_UPDATE_TFTP_MSEC_MAX 3283 3284 These options enable and control the auto-update feature; 3285 for a more detailed description refer to doc/README.update. 3286 3287- MTD Support (mtdparts command, UBI support) 3288 CONFIG_MTD_DEVICE 3289 3290 Adds the MTD device infrastructure from the Linux kernel. 3291 Needed for mtdparts command support. 3292 3293 CONFIG_MTD_PARTITIONS 3294 3295 Adds the MTD partitioning infrastructure from the Linux 3296 kernel. Needed for UBI support. 3297 3298- UBI support 3299 CONFIG_CMD_UBI 3300 3301 Adds commands for interacting with MTD partitions formatted 3302 with the UBI flash translation layer 3303 3304 Requires also defining CONFIG_RBTREE 3305 3306 CONFIG_UBI_SILENCE_MSG 3307 3308 Make the verbose messages from UBI stop printing. This leaves 3309 warnings and errors enabled. 3310 3311- UBIFS support 3312 CONFIG_CMD_UBIFS 3313 3314 Adds commands for interacting with UBI volumes formatted as 3315 UBIFS. UBIFS is read-only in u-boot. 3316 3317 Requires UBI support as well as CONFIG_LZO 3318 3319 CONFIG_UBIFS_SILENCE_MSG 3320 3321 Make the verbose messages from UBIFS stop printing. This leaves 3322 warnings and errors enabled. 3323 3324- SPL framework 3325 CONFIG_SPL 3326 Enable building of SPL globally. 3327 3328 CONFIG_SPL_LDSCRIPT 3329 LDSCRIPT for linking the SPL binary. 3330 3331 CONFIG_SPL_MAX_FOOTPRINT 3332 Maximum size in memory allocated to the SPL, BSS included. 3333 When defined, the linker checks that the actual memory 3334 used by SPL from _start to __bss_end does not exceed it. 3335 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 3336 must not be both defined at the same time. 3337 3338 CONFIG_SPL_MAX_SIZE 3339 Maximum size of the SPL image (text, data, rodata, and 3340 linker lists sections), BSS excluded. 3341 When defined, the linker checks that the actual size does 3342 not exceed it. 3343 3344 CONFIG_SPL_TEXT_BASE 3345 TEXT_BASE for linking the SPL binary. 3346 3347 CONFIG_SPL_RELOC_TEXT_BASE 3348 Address to relocate to. If unspecified, this is equal to 3349 CONFIG_SPL_TEXT_BASE (i.e. no relocation is done). 3350 3351 CONFIG_SPL_BSS_START_ADDR 3352 Link address for the BSS within the SPL binary. 3353 3354 CONFIG_SPL_BSS_MAX_SIZE 3355 Maximum size in memory allocated to the SPL BSS. 3356 When defined, the linker checks that the actual memory used 3357 by SPL from __bss_start to __bss_end does not exceed it. 3358 CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE 3359 must not be both defined at the same time. 3360 3361 CONFIG_SPL_STACK 3362 Adress of the start of the stack SPL will use 3363 3364 CONFIG_SPL_RELOC_STACK 3365 Adress of the start of the stack SPL will use after 3366 relocation. If unspecified, this is equal to 3367 CONFIG_SPL_STACK. 3368 3369 CONFIG_SYS_SPL_MALLOC_START 3370 Starting address of the malloc pool used in SPL. 3371 3372 CONFIG_SYS_SPL_MALLOC_SIZE 3373 The size of the malloc pool used in SPL. 3374 3375 CONFIG_SPL_FRAMEWORK 3376 Enable the SPL framework under common/. This framework 3377 supports MMC, NAND and YMODEM loading of U-Boot and NAND 3378 NAND loading of the Linux Kernel. 3379 3380 CONFIG_SPL_OS_BOOT 3381 Enable booting directly to an OS from SPL. 3382 See also: doc/README.falcon 3383 3384 CONFIG_SPL_DISPLAY_PRINT 3385 For ARM, enable an optional function to print more information 3386 about the running system. 3387 3388 CONFIG_SPL_INIT_MINIMAL 3389 Arch init code should be built for a very small image 3390 3391 CONFIG_SPL_LIBCOMMON_SUPPORT 3392 Support for common/libcommon.o in SPL binary 3393 3394 CONFIG_SPL_LIBDISK_SUPPORT 3395 Support for disk/libdisk.o in SPL binary 3396 3397 CONFIG_SPL_I2C_SUPPORT 3398 Support for drivers/i2c/libi2c.o in SPL binary 3399 3400 CONFIG_SPL_GPIO_SUPPORT 3401 Support for drivers/gpio/libgpio.o in SPL binary 3402 3403 CONFIG_SPL_MMC_SUPPORT 3404 Support for drivers/mmc/libmmc.o in SPL binary 3405 3406 CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR, 3407 CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS, 3408 CONFIG_SYS_MMC_SD_FAT_BOOT_PARTITION 3409 Address, size and partition on the MMC to load U-Boot from 3410 when the MMC is being used in raw mode. 3411 3412 CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR 3413 Sector to load kernel uImage from when MMC is being 3414 used in raw mode (for Falcon mode) 3415 3416 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR, 3417 CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS 3418 Sector and number of sectors to load kernel argument 3419 parameters from when MMC is being used in raw mode 3420 (for falcon mode) 3421 3422 CONFIG_SPL_FAT_SUPPORT 3423 Support for fs/fat/libfat.o in SPL binary 3424 3425 CONFIG_SPL_FAT_LOAD_PAYLOAD_NAME 3426 Filename to read to load U-Boot when reading from FAT 3427 3428 CONFIG_SPL_FAT_LOAD_KERNEL_NAME 3429 Filename to read to load kernel uImage when reading 3430 from FAT (for Falcon mode) 3431 3432 CONFIG_SPL_FAT_LOAD_ARGS_NAME 3433 Filename to read to load kernel argument parameters 3434 when reading from FAT (for Falcon mode) 3435 3436 CONFIG_SPL_MPC83XX_WAIT_FOR_NAND 3437 Set this for NAND SPL on PPC mpc83xx targets, so that 3438 start.S waits for the rest of the SPL to load before 3439 continuing (the hardware starts execution after just 3440 loading the first page rather than the full 4K). 3441 3442 CONFIG_SPL_SKIP_RELOCATE 3443 Avoid SPL relocation 3444 3445 CONFIG_SPL_NAND_BASE 3446 Include nand_base.c in the SPL. Requires 3447 CONFIG_SPL_NAND_DRIVERS. 3448 3449 CONFIG_SPL_NAND_DRIVERS 3450 SPL uses normal NAND drivers, not minimal drivers. 3451 3452 CONFIG_SPL_NAND_ECC 3453 Include standard software ECC in the SPL 3454 3455 CONFIG_SPL_NAND_SIMPLE 3456 Support for NAND boot using simple NAND drivers that 3457 expose the cmd_ctrl() interface. 3458 3459 CONFIG_SPL_MTD_SUPPORT 3460 Support for the MTD subsystem within SPL. Useful for 3461 environment on NAND support within SPL. 3462 3463 CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT 3464 Set for the SPL on PPC mpc8xxx targets, support for 3465 drivers/ddr/fsl/libddr.o in SPL binary. 3466 3467 CONFIG_SPL_COMMON_INIT_DDR 3468 Set for common ddr init with serial presence detect in 3469 SPL binary. 3470 3471 CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT, 3472 CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE, 3473 CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS, 3474 CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE, 3475 CONFIG_SYS_NAND_ECCBYTES 3476 Defines the size and behavior of the NAND that SPL uses 3477 to read U-Boot 3478 3479 CONFIG_SPL_NAND_BOOT 3480 Add support NAND boot 3481 3482 CONFIG_SYS_NAND_U_BOOT_OFFS 3483 Location in NAND to read U-Boot from 3484 3485 CONFIG_SYS_NAND_U_BOOT_DST 3486 Location in memory to load U-Boot to 3487 3488 CONFIG_SYS_NAND_U_BOOT_SIZE 3489 Size of image to load 3490 3491 CONFIG_SYS_NAND_U_BOOT_START 3492 Entry point in loaded image to jump to 3493 3494 CONFIG_SYS_NAND_HW_ECC_OOBFIRST 3495 Define this if you need to first read the OOB and then the 3496 data. This is used for example on davinci plattforms. 3497 3498 CONFIG_SPL_OMAP3_ID_NAND 3499 Support for an OMAP3-specific set of functions to return the 3500 ID and MFR of the first attached NAND chip, if present. 3501 3502 CONFIG_SPL_SERIAL_SUPPORT 3503 Support for drivers/serial/libserial.o in SPL binary 3504 3505 CONFIG_SPL_SPI_FLASH_SUPPORT 3506 Support for drivers/mtd/spi/libspi_flash.o in SPL binary 3507 3508 CONFIG_SPL_SPI_SUPPORT 3509 Support for drivers/spi/libspi.o in SPL binary 3510 3511 CONFIG_SPL_RAM_DEVICE 3512 Support for running image already present in ram, in SPL binary 3513 3514 CONFIG_SPL_LIBGENERIC_SUPPORT 3515 Support for lib/libgeneric.o in SPL binary 3516 3517 CONFIG_SPL_ENV_SUPPORT 3518 Support for the environment operating in SPL binary 3519 3520 CONFIG_SPL_NET_SUPPORT 3521 Support for the net/libnet.o in SPL binary. 3522 It conflicts with SPL env from storage medium specified by 3523 CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE 3524 3525 CONFIG_SPL_PAD_TO 3526 Image offset to which the SPL should be padded before appending 3527 the SPL payload. By default, this is defined as 3528 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 3529 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 3530 payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 3531 3532 CONFIG_SPL_TARGET 3533 Final target image containing SPL and payload. Some SPLs 3534 use an arch-specific makefile fragment instead, for 3535 example if more than one image needs to be produced. 3536 3537 CONFIG_FIT_SPL_PRINT 3538 Printing information about a FIT image adds quite a bit of 3539 code to SPL. So this is normally disabled in SPL. Use this 3540 option to re-enable it. This will affect the output of the 3541 bootm command when booting a FIT image. 3542 3543- TPL framework 3544 CONFIG_TPL 3545 Enable building of TPL globally. 3546 3547 CONFIG_TPL_PAD_TO 3548 Image offset to which the TPL should be padded before appending 3549 the TPL payload. By default, this is defined as 3550 CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined. 3551 CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL 3552 payload without any padding, or >= CONFIG_SPL_MAX_SIZE. 3553 3554Modem Support: 3555-------------- 3556 3557[so far only for SMDK2400 boards] 3558 3559- Modem support enable: 3560 CONFIG_MODEM_SUPPORT 3561 3562- RTS/CTS Flow control enable: 3563 CONFIG_HWFLOW 3564 3565- Modem debug support: 3566 CONFIG_MODEM_SUPPORT_DEBUG 3567 3568 Enables debugging stuff (char screen[1024], dbg()) 3569 for modem support. Useful only with BDI2000. 3570 3571- Interrupt support (PPC): 3572 3573 There are common interrupt_init() and timer_interrupt() 3574 for all PPC archs. interrupt_init() calls interrupt_init_cpu() 3575 for CPU specific initialization. interrupt_init_cpu() 3576 should set decrementer_count to appropriate value. If 3577 CPU resets decrementer automatically after interrupt 3578 (ppc4xx) it should set decrementer_count to zero. 3579 timer_interrupt() calls timer_interrupt_cpu() for CPU 3580 specific handling. If board has watchdog / status_led 3581 / other_activity_monitor it works automatically from 3582 general timer_interrupt(). 3583 3584- General: 3585 3586 In the target system modem support is enabled when a 3587 specific key (key combination) is pressed during 3588 power-on. Otherwise U-Boot will boot normally 3589 (autoboot). The key_pressed() function is called from 3590 board_init(). Currently key_pressed() is a dummy 3591 function, returning 1 and thus enabling modem 3592 initialization. 3593 3594 If there are no modem init strings in the 3595 environment, U-Boot proceed to autoboot; the 3596 previous output (banner, info printfs) will be 3597 suppressed, though. 3598 3599 See also: doc/README.Modem 3600 3601Board initialization settings: 3602------------------------------ 3603 3604During Initialization u-boot calls a number of board specific functions 3605to allow the preparation of board specific prerequisites, e.g. pin setup 3606before drivers are initialized. To enable these callbacks the 3607following configuration macros have to be defined. Currently this is 3608architecture specific, so please check arch/your_architecture/lib/board.c 3609typically in board_init_f() and board_init_r(). 3610 3611- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f() 3612- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r() 3613- CONFIG_BOARD_LATE_INIT: Call board_late_init() 3614- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init() 3615 3616Configuration Settings: 3617----------------------- 3618 3619- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit. 3620 Optionally it can be defined to support 64-bit memory commands. 3621 3622- CONFIG_SYS_LONGHELP: Defined when you want long help messages included; 3623 undefine this when you're short of memory. 3624 3625- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default 3626 width of the commands listed in the 'help' command output. 3627 3628- CONFIG_SYS_PROMPT: This is what U-Boot prints on the console to 3629 prompt for user input. 3630 3631- CONFIG_SYS_CBSIZE: Buffer size for input from the Console 3632 3633- CONFIG_SYS_PBSIZE: Buffer size for Console output 3634 3635- CONFIG_SYS_MAXARGS: max. Number of arguments accepted for monitor commands 3636 3637- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to 3638 the application (usually a Linux kernel) when it is 3639 booted 3640 3641- CONFIG_SYS_BAUDRATE_TABLE: 3642 List of legal baudrate settings for this board. 3643 3644- CONFIG_SYS_CONSOLE_INFO_QUIET 3645 Suppress display of console information at boot. 3646 3647- CONFIG_SYS_CONSOLE_IS_IN_ENV 3648 If the board specific function 3649 extern int overwrite_console (void); 3650 returns 1, the stdin, stderr and stdout are switched to the 3651 serial port, else the settings in the environment are used. 3652 3653- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE 3654 Enable the call to overwrite_console(). 3655 3656- CONFIG_SYS_CONSOLE_ENV_OVERWRITE 3657 Enable overwrite of previous console environment settings. 3658 3659- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END: 3660 Begin and End addresses of the area used by the 3661 simple memory test. 3662 3663- CONFIG_SYS_ALT_MEMTEST: 3664 Enable an alternate, more extensive memory test. 3665 3666- CONFIG_SYS_MEMTEST_SCRATCH: 3667 Scratch address used by the alternate memory test 3668 You only need to set this if address zero isn't writeable 3669 3670- CONFIG_SYS_MEM_TOP_HIDE (PPC only): 3671 If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header, 3672 this specified memory area will get subtracted from the top 3673 (end) of RAM and won't get "touched" at all by U-Boot. By 3674 fixing up gd->ram_size the Linux kernel should gets passed 3675 the now "corrected" memory size and won't touch it either. 3676 This should work for arch/ppc and arch/powerpc. Only Linux 3677 board ports in arch/powerpc with bootwrapper support that 3678 recalculate the memory size from the SDRAM controller setup 3679 will have to get fixed in Linux additionally. 3680 3681 This option can be used as a workaround for the 440EPx/GRx 3682 CHIP 11 errata where the last 256 bytes in SDRAM shouldn't 3683 be touched. 3684 3685 WARNING: Please make sure that this value is a multiple of 3686 the Linux page size (normally 4k). If this is not the case, 3687 then the end address of the Linux memory will be located at a 3688 non page size aligned address and this could cause major 3689 problems. 3690 3691- CONFIG_SYS_LOADS_BAUD_CHANGE: 3692 Enable temporary baudrate change while serial download 3693 3694- CONFIG_SYS_SDRAM_BASE: 3695 Physical start address of SDRAM. _Must_ be 0 here. 3696 3697- CONFIG_SYS_MBIO_BASE: 3698 Physical start address of Motherboard I/O (if using a 3699 Cogent motherboard) 3700 3701- CONFIG_SYS_FLASH_BASE: 3702 Physical start address of Flash memory. 3703 3704- CONFIG_SYS_MONITOR_BASE: 3705 Physical start address of boot monitor code (set by 3706 make config files to be same as the text base address 3707 (CONFIG_SYS_TEXT_BASE) used when linking) - same as 3708 CONFIG_SYS_FLASH_BASE when booting from flash. 3709 3710- CONFIG_SYS_MONITOR_LEN: 3711 Size of memory reserved for monitor code, used to 3712 determine _at_compile_time_ (!) if the environment is 3713 embedded within the U-Boot image, or in a separate 3714 flash sector. 3715 3716- CONFIG_SYS_MALLOC_LEN: 3717 Size of DRAM reserved for malloc() use. 3718 3719- CONFIG_SYS_BOOTM_LEN: 3720 Normally compressed uImages are limited to an 3721 uncompressed size of 8 MBytes. If this is not enough, 3722 you can define CONFIG_SYS_BOOTM_LEN in your board config file 3723 to adjust this setting to your needs. 3724 3725- CONFIG_SYS_BOOTMAPSZ: 3726 Maximum size of memory mapped by the startup code of 3727 the Linux kernel; all data that must be processed by 3728 the Linux kernel (bd_info, boot arguments, FDT blob if 3729 used) must be put below this limit, unless "bootm_low" 3730 environment variable is defined and non-zero. In such case 3731 all data for the Linux kernel must be between "bootm_low" 3732 and "bootm_low" + CONFIG_SYS_BOOTMAPSZ. The environment 3733 variable "bootm_mapsize" will override the value of 3734 CONFIG_SYS_BOOTMAPSZ. If CONFIG_SYS_BOOTMAPSZ is undefined, 3735 then the value in "bootm_size" will be used instead. 3736 3737- CONFIG_SYS_BOOT_RAMDISK_HIGH: 3738 Enable initrd_high functionality. If defined then the 3739 initrd_high feature is enabled and the bootm ramdisk subcommand 3740 is enabled. 3741 3742- CONFIG_SYS_BOOT_GET_CMDLINE: 3743 Enables allocating and saving kernel cmdline in space between 3744 "bootm_low" and "bootm_low" + BOOTMAPSZ. 3745 3746- CONFIG_SYS_BOOT_GET_KBD: 3747 Enables allocating and saving a kernel copy of the bd_info in 3748 space between "bootm_low" and "bootm_low" + BOOTMAPSZ. 3749 3750- CONFIG_SYS_MAX_FLASH_BANKS: 3751 Max number of Flash memory banks 3752 3753- CONFIG_SYS_MAX_FLASH_SECT: 3754 Max number of sectors on a Flash chip 3755 3756- CONFIG_SYS_FLASH_ERASE_TOUT: 3757 Timeout for Flash erase operations (in ms) 3758 3759- CONFIG_SYS_FLASH_WRITE_TOUT: 3760 Timeout for Flash write operations (in ms) 3761 3762- CONFIG_SYS_FLASH_LOCK_TOUT 3763 Timeout for Flash set sector lock bit operation (in ms) 3764 3765- CONFIG_SYS_FLASH_UNLOCK_TOUT 3766 Timeout for Flash clear lock bits operation (in ms) 3767 3768- CONFIG_SYS_FLASH_PROTECTION 3769 If defined, hardware flash sectors protection is used 3770 instead of U-Boot software protection. 3771 3772- CONFIG_SYS_DIRECT_FLASH_TFTP: 3773 3774 Enable TFTP transfers directly to flash memory; 3775 without this option such a download has to be 3776 performed in two steps: (1) download to RAM, and (2) 3777 copy from RAM to flash. 3778 3779 The two-step approach is usually more reliable, since 3780 you can check if the download worked before you erase 3781 the flash, but in some situations (when system RAM is 3782 too limited to allow for a temporary copy of the 3783 downloaded image) this option may be very useful. 3784 3785- CONFIG_SYS_FLASH_CFI: 3786 Define if the flash driver uses extra elements in the 3787 common flash structure for storing flash geometry. 3788 3789- CONFIG_FLASH_CFI_DRIVER 3790 This option also enables the building of the cfi_flash driver 3791 in the drivers directory 3792 3793- CONFIG_FLASH_CFI_MTD 3794 This option enables the building of the cfi_mtd driver 3795 in the drivers directory. The driver exports CFI flash 3796 to the MTD layer. 3797 3798- CONFIG_SYS_FLASH_USE_BUFFER_WRITE 3799 Use buffered writes to flash. 3800 3801- CONFIG_FLASH_SPANSION_S29WS_N 3802 s29ws-n MirrorBit flash has non-standard addresses for buffered 3803 write commands. 3804 3805- CONFIG_SYS_FLASH_QUIET_TEST 3806 If this option is defined, the common CFI flash doesn't 3807 print it's warning upon not recognized FLASH banks. This 3808 is useful, if some of the configured banks are only 3809 optionally available. 3810 3811- CONFIG_FLASH_SHOW_PROGRESS 3812 If defined (must be an integer), print out countdown 3813 digits and dots. Recommended value: 45 (9..1) for 80 3814 column displays, 15 (3..1) for 40 column displays. 3815 3816- CONFIG_FLASH_VERIFY 3817 If defined, the content of the flash (destination) is compared 3818 against the source after the write operation. An error message 3819 will be printed when the contents are not identical. 3820 Please note that this option is useless in nearly all cases, 3821 since such flash programming errors usually are detected earlier 3822 while unprotecting/erasing/programming. Please only enable 3823 this option if you really know what you are doing. 3824 3825- CONFIG_SYS_RX_ETH_BUFFER: 3826 Defines the number of Ethernet receive buffers. On some 3827 Ethernet controllers it is recommended to set this value 3828 to 8 or even higher (EEPRO100 or 405 EMAC), since all 3829 buffers can be full shortly after enabling the interface 3830 on high Ethernet traffic. 3831 Defaults to 4 if not defined. 3832 3833- CONFIG_ENV_MAX_ENTRIES 3834 3835 Maximum number of entries in the hash table that is used 3836 internally to store the environment settings. The default 3837 setting is supposed to be generous and should work in most 3838 cases. This setting can be used to tune behaviour; see 3839 lib/hashtable.c for details. 3840 3841- CONFIG_ENV_FLAGS_LIST_DEFAULT 3842- CONFIG_ENV_FLAGS_LIST_STATIC 3843 Enable validation of the values given to environment variables when 3844 calling env set. Variables can be restricted to only decimal, 3845 hexadecimal, or boolean. If CONFIG_CMD_NET is also defined, 3846 the variables can also be restricted to IP address or MAC address. 3847 3848 The format of the list is: 3849 type_attribute = [s|d|x|b|i|m] 3850 access_atribute = [a|r|o|c] 3851 attributes = type_attribute[access_atribute] 3852 entry = variable_name[:attributes] 3853 list = entry[,list] 3854 3855 The type attributes are: 3856 s - String (default) 3857 d - Decimal 3858 x - Hexadecimal 3859 b - Boolean ([1yYtT|0nNfF]) 3860 i - IP address 3861 m - MAC address 3862 3863 The access attributes are: 3864 a - Any (default) 3865 r - Read-only 3866 o - Write-once 3867 c - Change-default 3868 3869 - CONFIG_ENV_FLAGS_LIST_DEFAULT 3870 Define this to a list (string) to define the ".flags" 3871 envirnoment variable in the default or embedded environment. 3872 3873 - CONFIG_ENV_FLAGS_LIST_STATIC 3874 Define this to a list (string) to define validation that 3875 should be done if an entry is not found in the ".flags" 3876 environment variable. To override a setting in the static 3877 list, simply add an entry for the same variable name to the 3878 ".flags" variable. 3879 3880- CONFIG_ENV_ACCESS_IGNORE_FORCE 3881 If defined, don't allow the -f switch to env set override variable 3882 access flags. 3883 3884- CONFIG_SYS_GENERIC_BOARD 3885 This selects the architecture-generic board system instead of the 3886 architecture-specific board files. It is intended to move boards 3887 to this new framework over time. Defining this will disable the 3888 arch/foo/lib/board.c file and use common/board_f.c and 3889 common/board_r.c instead. To use this option your architecture 3890 must support it (i.e. must define __HAVE_ARCH_GENERIC_BOARD in 3891 its config.mk file). If you find problems enabling this option on 3892 your board please report the problem and send patches! 3893 3894- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only) 3895 This is set by OMAP boards for the max time that reset should 3896 be asserted. See doc/README.omap-reset-time for details on how 3897 the value can be calulated on a given board. 3898 3899The following definitions that deal with the placement and management 3900of environment data (variable area); in general, we support the 3901following configurations: 3902 3903- CONFIG_BUILD_ENVCRC: 3904 3905 Builds up envcrc with the target environment so that external utils 3906 may easily extract it and embed it in final U-Boot images. 3907 3908- CONFIG_ENV_IS_IN_FLASH: 3909 3910 Define this if the environment is in flash memory. 3911 3912 a) The environment occupies one whole flash sector, which is 3913 "embedded" in the text segment with the U-Boot code. This 3914 happens usually with "bottom boot sector" or "top boot 3915 sector" type flash chips, which have several smaller 3916 sectors at the start or the end. For instance, such a 3917 layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In 3918 such a case you would place the environment in one of the 3919 4 kB sectors - with U-Boot code before and after it. With 3920 "top boot sector" type flash chips, you would put the 3921 environment in one of the last sectors, leaving a gap 3922 between U-Boot and the environment. 3923 3924 - CONFIG_ENV_OFFSET: 3925 3926 Offset of environment data (variable area) to the 3927 beginning of flash memory; for instance, with bottom boot 3928 type flash chips the second sector can be used: the offset 3929 for this sector is given here. 3930 3931 CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE. 3932 3933 - CONFIG_ENV_ADDR: 3934 3935 This is just another way to specify the start address of 3936 the flash sector containing the environment (instead of 3937 CONFIG_ENV_OFFSET). 3938 3939 - CONFIG_ENV_SECT_SIZE: 3940 3941 Size of the sector containing the environment. 3942 3943 3944 b) Sometimes flash chips have few, equal sized, BIG sectors. 3945 In such a case you don't want to spend a whole sector for 3946 the environment. 3947 3948 - CONFIG_ENV_SIZE: 3949 3950 If you use this in combination with CONFIG_ENV_IS_IN_FLASH 3951 and CONFIG_ENV_SECT_SIZE, you can specify to use only a part 3952 of this flash sector for the environment. This saves 3953 memory for the RAM copy of the environment. 3954 3955 It may also save flash memory if you decide to use this 3956 when your environment is "embedded" within U-Boot code, 3957 since then the remainder of the flash sector could be used 3958 for U-Boot code. It should be pointed out that this is 3959 STRONGLY DISCOURAGED from a robustness point of view: 3960 updating the environment in flash makes it always 3961 necessary to erase the WHOLE sector. If something goes 3962 wrong before the contents has been restored from a copy in 3963 RAM, your target system will be dead. 3964 3965 - CONFIG_ENV_ADDR_REDUND 3966 CONFIG_ENV_SIZE_REDUND 3967 3968 These settings describe a second storage area used to hold 3969 a redundant copy of the environment data, so that there is 3970 a valid backup copy in case there is a power failure during 3971 a "saveenv" operation. 3972 3973BE CAREFUL! Any changes to the flash layout, and some changes to the 3974source code will make it necessary to adapt <board>/u-boot.lds* 3975accordingly! 3976 3977 3978- CONFIG_ENV_IS_IN_NVRAM: 3979 3980 Define this if you have some non-volatile memory device 3981 (NVRAM, battery buffered SRAM) which you want to use for the 3982 environment. 3983 3984 - CONFIG_ENV_ADDR: 3985 - CONFIG_ENV_SIZE: 3986 3987 These two #defines are used to determine the memory area you 3988 want to use for environment. It is assumed that this memory 3989 can just be read and written to, without any special 3990 provision. 3991 3992BE CAREFUL! The first access to the environment happens quite early 3993in U-Boot initalization (when we try to get the setting of for the 3994console baudrate). You *MUST* have mapped your NVRAM area then, or 3995U-Boot will hang. 3996 3997Please note that even with NVRAM we still use a copy of the 3998environment in RAM: we could work on NVRAM directly, but we want to 3999keep settings there always unmodified except somebody uses "saveenv" 4000to save the current settings. 4001 4002 4003- CONFIG_ENV_IS_IN_EEPROM: 4004 4005 Use this if you have an EEPROM or similar serial access 4006 device and a driver for it. 4007 4008 - CONFIG_ENV_OFFSET: 4009 - CONFIG_ENV_SIZE: 4010 4011 These two #defines specify the offset and size of the 4012 environment area within the total memory of your EEPROM. 4013 4014 - CONFIG_SYS_I2C_EEPROM_ADDR: 4015 If defined, specified the chip address of the EEPROM device. 4016 The default address is zero. 4017 4018 - CONFIG_SYS_EEPROM_PAGE_WRITE_BITS: 4019 If defined, the number of bits used to address bytes in a 4020 single page in the EEPROM device. A 64 byte page, for example 4021 would require six bits. 4022 4023 - CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS: 4024 If defined, the number of milliseconds to delay between 4025 page writes. The default is zero milliseconds. 4026 4027 - CONFIG_SYS_I2C_EEPROM_ADDR_LEN: 4028 The length in bytes of the EEPROM memory array address. Note 4029 that this is NOT the chip address length! 4030 4031 - CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW: 4032 EEPROM chips that implement "address overflow" are ones 4033 like Catalyst 24WC04/08/16 which has 9/10/11 bits of 4034 address and the extra bits end up in the "chip address" bit 4035 slots. This makes a 24WC08 (1Kbyte) chip look like four 256 4036 byte chips. 4037 4038 Note that we consider the length of the address field to 4039 still be one byte because the extra address bits are hidden 4040 in the chip address. 4041 4042 - CONFIG_SYS_EEPROM_SIZE: 4043 The size in bytes of the EEPROM device. 4044 4045 - CONFIG_ENV_EEPROM_IS_ON_I2C 4046 define this, if you have I2C and SPI activated, and your 4047 EEPROM, which holds the environment, is on the I2C bus. 4048 4049 - CONFIG_I2C_ENV_EEPROM_BUS 4050 if you have an Environment on an EEPROM reached over 4051 I2C muxes, you can define here, how to reach this 4052 EEPROM. For example: 4053 4054 #define CONFIG_I2C_ENV_EEPROM_BUS 1 4055 4056 EEPROM which holds the environment, is reached over 4057 a pca9547 i2c mux with address 0x70, channel 3. 4058 4059- CONFIG_ENV_IS_IN_DATAFLASH: 4060 4061 Define this if you have a DataFlash memory device which you 4062 want to use for the environment. 4063 4064 - CONFIG_ENV_OFFSET: 4065 - CONFIG_ENV_ADDR: 4066 - CONFIG_ENV_SIZE: 4067 4068 These three #defines specify the offset and size of the 4069 environment area within the total memory of your DataFlash placed 4070 at the specified address. 4071 4072- CONFIG_ENV_IS_IN_SPI_FLASH: 4073 4074 Define this if you have a SPI Flash memory device which you 4075 want to use for the environment. 4076 4077 - CONFIG_ENV_OFFSET: 4078 - CONFIG_ENV_SIZE: 4079 4080 These two #defines specify the offset and size of the 4081 environment area within the SPI Flash. CONFIG_ENV_OFFSET must be 4082 aligned to an erase sector boundary. 4083 4084 - CONFIG_ENV_SECT_SIZE: 4085 4086 Define the SPI flash's sector size. 4087 4088 - CONFIG_ENV_OFFSET_REDUND (optional): 4089 4090 This setting describes a second storage area of CONFIG_ENV_SIZE 4091 size used to hold a redundant copy of the environment data, so 4092 that there is a valid backup copy in case there is a power failure 4093 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4094 aligned to an erase sector boundary. 4095 4096 - CONFIG_ENV_SPI_BUS (optional): 4097 - CONFIG_ENV_SPI_CS (optional): 4098 4099 Define the SPI bus and chip select. If not defined they will be 0. 4100 4101 - CONFIG_ENV_SPI_MAX_HZ (optional): 4102 4103 Define the SPI max work clock. If not defined then use 1MHz. 4104 4105 - CONFIG_ENV_SPI_MODE (optional): 4106 4107 Define the SPI work mode. If not defined then use SPI_MODE_3. 4108 4109- CONFIG_ENV_IS_IN_REMOTE: 4110 4111 Define this if you have a remote memory space which you 4112 want to use for the local device's environment. 4113 4114 - CONFIG_ENV_ADDR: 4115 - CONFIG_ENV_SIZE: 4116 4117 These two #defines specify the address and size of the 4118 environment area within the remote memory space. The 4119 local device can get the environment from remote memory 4120 space by SRIO or PCIE links. 4121 4122BE CAREFUL! For some special cases, the local device can not use 4123"saveenv" command. For example, the local device will get the 4124environment stored in a remote NOR flash by SRIO or PCIE link, 4125but it can not erase, write this NOR flash by SRIO or PCIE interface. 4126 4127- CONFIG_ENV_IS_IN_NAND: 4128 4129 Define this if you have a NAND device which you want to use 4130 for the environment. 4131 4132 - CONFIG_ENV_OFFSET: 4133 - CONFIG_ENV_SIZE: 4134 4135 These two #defines specify the offset and size of the environment 4136 area within the first NAND device. CONFIG_ENV_OFFSET must be 4137 aligned to an erase block boundary. 4138 4139 - CONFIG_ENV_OFFSET_REDUND (optional): 4140 4141 This setting describes a second storage area of CONFIG_ENV_SIZE 4142 size used to hold a redundant copy of the environment data, so 4143 that there is a valid backup copy in case there is a power failure 4144 during a "saveenv" operation. CONFIG_ENV_OFFSET_RENDUND must be 4145 aligned to an erase block boundary. 4146 4147 - CONFIG_ENV_RANGE (optional): 4148 4149 Specifies the length of the region in which the environment 4150 can be written. This should be a multiple of the NAND device's 4151 block size. Specifying a range with more erase blocks than 4152 are needed to hold CONFIG_ENV_SIZE allows bad blocks within 4153 the range to be avoided. 4154 4155 - CONFIG_ENV_OFFSET_OOB (optional): 4156 4157 Enables support for dynamically retrieving the offset of the 4158 environment from block zero's out-of-band data. The 4159 "nand env.oob" command can be used to record this offset. 4160 Currently, CONFIG_ENV_OFFSET_REDUND is not supported when 4161 using CONFIG_ENV_OFFSET_OOB. 4162 4163- CONFIG_NAND_ENV_DST 4164 4165 Defines address in RAM to which the nand_spl code should copy the 4166 environment. If redundant environment is used, it will be copied to 4167 CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE. 4168 4169- CONFIG_ENV_IS_IN_UBI: 4170 4171 Define this if you have an UBI volume that you want to use for the 4172 environment. This has the benefit of wear-leveling the environment 4173 accesses, which is important on NAND. 4174 4175 - CONFIG_ENV_UBI_PART: 4176 4177 Define this to a string that is the mtd partition containing the UBI. 4178 4179 - CONFIG_ENV_UBI_VOLUME: 4180 4181 Define this to the name of the volume that you want to store the 4182 environment in. 4183 4184 - CONFIG_ENV_UBI_VOLUME_REDUND: 4185 4186 Define this to the name of another volume to store a second copy of 4187 the environment in. This will enable redundant environments in UBI. 4188 It is assumed that both volumes are in the same MTD partition. 4189 4190 - CONFIG_UBI_SILENCE_MSG 4191 - CONFIG_UBIFS_SILENCE_MSG 4192 4193 You will probably want to define these to avoid a really noisy system 4194 when storing the env in UBI. 4195 4196- CONFIG_ENV_IS_IN_FAT: 4197 Define this if you want to use the FAT file system for the environment. 4198 4199 - FAT_ENV_INTERFACE: 4200 4201 Define this to a string that is the name of the block device. 4202 4203 - FAT_ENV_DEV_AND_PART: 4204 4205 Define this to a string to specify the partition of the device. It can 4206 be as following: 4207 4208 "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1) 4209 - "D:P": device D partition P. Error occurs if device D has no 4210 partition table. 4211 - "D:0": device D. 4212 - "D" or "D:": device D partition 1 if device D has partition 4213 table, or the whole device D if has no partition 4214 table. 4215 - "D:auto": first partition in device D with bootable flag set. 4216 If none, first valid paratition in device D. If no 4217 partition table then means device D. 4218 4219 - FAT_ENV_FILE: 4220 4221 It's a string of the FAT file name. This file use to store the 4222 envrionment. 4223 4224 - CONFIG_FAT_WRITE: 4225 This should be defined. Otherwise it cannot save the envrionment file. 4226 4227- CONFIG_ENV_IS_IN_MMC: 4228 4229 Define this if you have an MMC device which you want to use for the 4230 environment. 4231 4232 - CONFIG_SYS_MMC_ENV_DEV: 4233 4234 Specifies which MMC device the environment is stored in. 4235 4236 - CONFIG_SYS_MMC_ENV_PART (optional): 4237 4238 Specifies which MMC partition the environment is stored in. If not 4239 set, defaults to partition 0, the user area. Common values might be 4240 1 (first MMC boot partition), 2 (second MMC boot partition). 4241 4242 - CONFIG_ENV_OFFSET: 4243 - CONFIG_ENV_SIZE: 4244 4245 These two #defines specify the offset and size of the environment 4246 area within the specified MMC device. 4247 4248 If offset is positive (the usual case), it is treated as relative to 4249 the start of the MMC partition. If offset is negative, it is treated 4250 as relative to the end of the MMC partition. This can be useful if 4251 your board may be fitted with different MMC devices, which have 4252 different sizes for the MMC partitions, and you always want the 4253 environment placed at the very end of the partition, to leave the 4254 maximum possible space before it, to store other data. 4255 4256 These two values are in units of bytes, but must be aligned to an 4257 MMC sector boundary. 4258 4259 - CONFIG_ENV_OFFSET_REDUND (optional): 4260 4261 Specifies a second storage area, of CONFIG_ENV_SIZE size, used to 4262 hold a redundant copy of the environment data. This provides a 4263 valid backup copy in case the other copy is corrupted, e.g. due 4264 to a power failure during a "saveenv" operation. 4265 4266 This value may also be positive or negative; this is handled in the 4267 same way as CONFIG_ENV_OFFSET. 4268 4269 This value is also in units of bytes, but must also be aligned to 4270 an MMC sector boundary. 4271 4272 - CONFIG_ENV_SIZE_REDUND (optional): 4273 4274 This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is 4275 set. If this value is set, it must be set to the same value as 4276 CONFIG_ENV_SIZE. 4277 4278- CONFIG_SYS_SPI_INIT_OFFSET 4279 4280 Defines offset to the initial SPI buffer area in DPRAM. The 4281 area is used at an early stage (ROM part) if the environment 4282 is configured to reside in the SPI EEPROM: We need a 520 byte 4283 scratch DPRAM area. It is used between the two initialization 4284 calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems 4285 to be a good choice since it makes it far enough from the 4286 start of the data area as well as from the stack pointer. 4287 4288Please note that the environment is read-only until the monitor 4289has been relocated to RAM and a RAM copy of the environment has been 4290created; also, when using EEPROM you will have to use getenv_f() 4291until then to read environment variables. 4292 4293The environment is protected by a CRC32 checksum. Before the monitor 4294is relocated into RAM, as a result of a bad CRC you will be working 4295with the compiled-in default environment - *silently*!!! [This is 4296necessary, because the first environment variable we need is the 4297"baudrate" setting for the console - if we have a bad CRC, we don't 4298have any device yet where we could complain.] 4299 4300Note: once the monitor has been relocated, then it will complain if 4301the default environment is used; a new CRC is computed as soon as you 4302use the "saveenv" command to store a valid environment. 4303 4304- CONFIG_SYS_FAULT_ECHO_LINK_DOWN: 4305 Echo the inverted Ethernet link state to the fault LED. 4306 4307 Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR 4308 also needs to be defined. 4309 4310- CONFIG_SYS_FAULT_MII_ADDR: 4311 MII address of the PHY to check for the Ethernet link state. 4312 4313- CONFIG_NS16550_MIN_FUNCTIONS: 4314 Define this if you desire to only have use of the NS16550_init 4315 and NS16550_putc functions for the serial driver located at 4316 drivers/serial/ns16550.c. This option is useful for saving 4317 space for already greatly restricted images, including but not 4318 limited to NAND_SPL configurations. 4319 4320- CONFIG_DISPLAY_BOARDINFO 4321 Display information about the board that U-Boot is running on 4322 when U-Boot starts up. The board function checkboard() is called 4323 to do this. 4324 4325- CONFIG_DISPLAY_BOARDINFO_LATE 4326 Similar to the previous option, but display this information 4327 later, once stdio is running and output goes to the LCD, if 4328 present. 4329 4330Low Level (hardware related) configuration options: 4331--------------------------------------------------- 4332 4333- CONFIG_SYS_CACHELINE_SIZE: 4334 Cache Line Size of the CPU. 4335 4336- CONFIG_SYS_DEFAULT_IMMR: 4337 Default address of the IMMR after system reset. 4338 4339 Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU, 4340 and RPXsuper) to be able to adjust the position of 4341 the IMMR register after a reset. 4342 4343- CONFIG_SYS_CCSRBAR_DEFAULT: 4344 Default (power-on reset) physical address of CCSR on Freescale 4345 PowerPC SOCs. 4346 4347- CONFIG_SYS_CCSRBAR: 4348 Virtual address of CCSR. On a 32-bit build, this is typically 4349 the same value as CONFIG_SYS_CCSRBAR_DEFAULT. 4350 4351 CONFIG_SYS_DEFAULT_IMMR must also be set to this value, 4352 for cross-platform code that uses that macro instead. 4353 4354- CONFIG_SYS_CCSRBAR_PHYS: 4355 Physical address of CCSR. CCSR can be relocated to a new 4356 physical address, if desired. In this case, this macro should 4357 be set to that address. Otherwise, it should be set to the 4358 same value as CONFIG_SYS_CCSRBAR_DEFAULT. For example, CCSR 4359 is typically relocated on 36-bit builds. It is recommended 4360 that this macro be defined via the _HIGH and _LOW macros: 4361 4362 #define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH 4363 * 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW) 4364 4365- CONFIG_SYS_CCSRBAR_PHYS_HIGH: 4366 Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS. This value is typically 4367 either 0 (32-bit build) or 0xF (36-bit build). This macro is 4368 used in assembly code, so it must not contain typecasts or 4369 integer size suffixes (e.g. "ULL"). 4370 4371- CONFIG_SYS_CCSRBAR_PHYS_LOW: 4372 Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS. This macro is 4373 used in assembly code, so it must not contain typecasts or 4374 integer size suffixes (e.g. "ULL"). 4375 4376- CONFIG_SYS_CCSR_DO_NOT_RELOCATE: 4377 If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be 4378 forced to a value that ensures that CCSR is not relocated. 4379 4380- Floppy Disk Support: 4381 CONFIG_SYS_FDC_DRIVE_NUMBER 4382 4383 the default drive number (default value 0) 4384 4385 CONFIG_SYS_ISA_IO_STRIDE 4386 4387 defines the spacing between FDC chipset registers 4388 (default value 1) 4389 4390 CONFIG_SYS_ISA_IO_OFFSET 4391 4392 defines the offset of register from address. It 4393 depends on which part of the data bus is connected to 4394 the FDC chipset. (default value 0) 4395 4396 If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and 4397 CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their 4398 default value. 4399 4400 if CONFIG_SYS_FDC_HW_INIT is defined, then the function 4401 fdc_hw_init() is called at the beginning of the FDC 4402 setup. fdc_hw_init() must be provided by the board 4403 source code. It is used to make hardware dependant 4404 initializations. 4405 4406- CONFIG_IDE_AHB: 4407 Most IDE controllers were designed to be connected with PCI 4408 interface. Only few of them were designed for AHB interface. 4409 When software is doing ATA command and data transfer to 4410 IDE devices through IDE-AHB controller, some additional 4411 registers accessing to these kind of IDE-AHB controller 4412 is requierd. 4413 4414- CONFIG_SYS_IMMR: Physical address of the Internal Memory. 4415 DO NOT CHANGE unless you know exactly what you're 4416 doing! (11-4) [MPC8xx/82xx systems only] 4417 4418- CONFIG_SYS_INIT_RAM_ADDR: 4419 4420 Start address of memory area that can be used for 4421 initial data and stack; please note that this must be 4422 writable memory that is working WITHOUT special 4423 initialization, i. e. you CANNOT use normal RAM which 4424 will become available only after programming the 4425 memory controller and running certain initialization 4426 sequences. 4427 4428 U-Boot uses the following memory types: 4429 - MPC8xx and MPC8260: IMMR (internal memory of the CPU) 4430 - MPC824X: data cache 4431 - PPC4xx: data cache 4432 4433- CONFIG_SYS_GBL_DATA_OFFSET: 4434 4435 Offset of the initial data structure in the memory 4436 area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually 4437 CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial 4438 data is located at the end of the available space 4439 (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE - 4440 CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just 4441 below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR + 4442 CONFIG_SYS_GBL_DATA_OFFSET) downward. 4443 4444 Note: 4445 On the MPC824X (or other systems that use the data 4446 cache for initial memory) the address chosen for 4447 CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must 4448 point to an otherwise UNUSED address space between 4449 the top of RAM and the start of the PCI space. 4450 4451- CONFIG_SYS_SIUMCR: SIU Module Configuration (11-6) 4452 4453- CONFIG_SYS_SYPCR: System Protection Control (11-9) 4454 4455- CONFIG_SYS_TBSCR: Time Base Status and Control (11-26) 4456 4457- CONFIG_SYS_PISCR: Periodic Interrupt Status and Control (11-31) 4458 4459- CONFIG_SYS_PLPRCR: PLL, Low-Power, and Reset Control Register (15-30) 4460 4461- CONFIG_SYS_SCCR: System Clock and reset Control Register (15-27) 4462 4463- CONFIG_SYS_OR_TIMING_SDRAM: 4464 SDRAM timing 4465 4466- CONFIG_SYS_MAMR_PTA: 4467 periodic timer for refresh 4468 4469- CONFIG_SYS_DER: Debug Event Register (37-47) 4470 4471- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM, 4472 CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP, 4473 CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM, 4474 CONFIG_SYS_BR1_PRELIM: 4475 Memory Controller Definitions: BR0/1 and OR0/1 (FLASH) 4476 4477- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE, 4478 CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM, 4479 CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM: 4480 Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM) 4481 4482- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K, 4483 CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL: 4484 Machine Mode Register and Memory Periodic Timer 4485 Prescaler definitions (SDRAM timing) 4486 4487- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]: 4488 enable I2C microcode relocation patch (MPC8xx); 4489 define relocation offset in DPRAM [DSP2] 4490 4491- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]: 4492 enable SMC microcode relocation patch (MPC8xx); 4493 define relocation offset in DPRAM [SMC1] 4494 4495- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]: 4496 enable SPI microcode relocation patch (MPC8xx); 4497 define relocation offset in DPRAM [SCC4] 4498 4499- CONFIG_SYS_USE_OSCCLK: 4500 Use OSCM clock mode on MBX8xx board. Be careful, 4501 wrong setting might damage your board. Read 4502 doc/README.MBX before setting this variable! 4503 4504- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only) 4505 Offset of the bootmode word in DPRAM used by post 4506 (Power On Self Tests). This definition overrides 4507 #define'd default value in commproc.h resp. 4508 cpm_8260.h. 4509 4510- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB, 4511 CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL, 4512 CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS, 4513 CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB, 4514 CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START, 4515 CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL, 4516 CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE, 4517 CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only) 4518 Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set. 4519 4520- CONFIG_PCI_DISABLE_PCIE: 4521 Disable PCI-Express on systems where it is supported but not 4522 required. 4523 4524- CONFIG_PCI_ENUM_ONLY 4525 Only scan through and get the devices on the busses. 4526 Don't do any setup work, presumably because someone or 4527 something has already done it, and we don't need to do it 4528 a second time. Useful for platforms that are pre-booted 4529 by coreboot or similar. 4530 4531- CONFIG_PCI_INDIRECT_BRIDGE: 4532 Enable support for indirect PCI bridges. 4533 4534- CONFIG_SYS_SRIO: 4535 Chip has SRIO or not 4536 4537- CONFIG_SRIO1: 4538 Board has SRIO 1 port available 4539 4540- CONFIG_SRIO2: 4541 Board has SRIO 2 port available 4542 4543- CONFIG_SRIO_PCIE_BOOT_MASTER 4544 Board can support master function for Boot from SRIO and PCIE 4545 4546- CONFIG_SYS_SRIOn_MEM_VIRT: 4547 Virtual Address of SRIO port 'n' memory region 4548 4549- CONFIG_SYS_SRIOn_MEM_PHYS: 4550 Physical Address of SRIO port 'n' memory region 4551 4552- CONFIG_SYS_SRIOn_MEM_SIZE: 4553 Size of SRIO port 'n' memory region 4554 4555- CONFIG_SYS_NAND_BUSWIDTH_16BIT 4556 Defined to tell the NAND controller that the NAND chip is using 4557 a 16 bit bus. 4558 Not all NAND drivers use this symbol. 4559 Example of drivers that use it: 4560 - drivers/mtd/nand/ndfc.c 4561 - drivers/mtd/nand/mxc_nand.c 4562 4563- CONFIG_SYS_NDFC_EBC0_CFG 4564 Sets the EBC0_CFG register for the NDFC. If not defined 4565 a default value will be used. 4566 4567- CONFIG_SPD_EEPROM 4568 Get DDR timing information from an I2C EEPROM. Common 4569 with pluggable memory modules such as SODIMMs 4570 4571 SPD_EEPROM_ADDRESS 4572 I2C address of the SPD EEPROM 4573 4574- CONFIG_SYS_SPD_BUS_NUM 4575 If SPD EEPROM is on an I2C bus other than the first 4576 one, specify here. Note that the value must resolve 4577 to something your driver can deal with. 4578 4579- CONFIG_SYS_DDR_RAW_TIMING 4580 Get DDR timing information from other than SPD. Common with 4581 soldered DDR chips onboard without SPD. DDR raw timing 4582 parameters are extracted from datasheet and hard-coded into 4583 header files or board specific files. 4584 4585- CONFIG_FSL_DDR_INTERACTIVE 4586 Enable interactive DDR debugging. See doc/README.fsl-ddr. 4587 4588- CONFIG_SYS_83XX_DDR_USES_CS0 4589 Only for 83xx systems. If specified, then DDR should 4590 be configured using CS0 and CS1 instead of CS2 and CS3. 4591 4592- CONFIG_ETHER_ON_FEC[12] 4593 Define to enable FEC[12] on a 8xx series processor. 4594 4595- CONFIG_FEC[12]_PHY 4596 Define to the hardcoded PHY address which corresponds 4597 to the given FEC; i. e. 4598 #define CONFIG_FEC1_PHY 4 4599 means that the PHY with address 4 is connected to FEC1 4600 4601 When set to -1, means to probe for first available. 4602 4603- CONFIG_FEC[12]_PHY_NORXERR 4604 The PHY does not have a RXERR line (RMII only). 4605 (so program the FEC to ignore it). 4606 4607- CONFIG_RMII 4608 Enable RMII mode for all FECs. 4609 Note that this is a global option, we can't 4610 have one FEC in standard MII mode and another in RMII mode. 4611 4612- CONFIG_CRC32_VERIFY 4613 Add a verify option to the crc32 command. 4614 The syntax is: 4615 4616 => crc32 -v <address> <count> <crc32> 4617 4618 Where address/count indicate a memory area 4619 and crc32 is the correct crc32 which the 4620 area should have. 4621 4622- CONFIG_LOOPW 4623 Add the "loopw" memory command. This only takes effect if 4624 the memory commands are activated globally (CONFIG_CMD_MEM). 4625 4626- CONFIG_MX_CYCLIC 4627 Add the "mdc" and "mwc" memory commands. These are cyclic 4628 "md/mw" commands. 4629 Examples: 4630 4631 => mdc.b 10 4 500 4632 This command will print 4 bytes (10,11,12,13) each 500 ms. 4633 4634 => mwc.l 100 12345678 10 4635 This command will write 12345678 to address 100 all 10 ms. 4636 4637 This only takes effect if the memory commands are activated 4638 globally (CONFIG_CMD_MEM). 4639 4640- CONFIG_SKIP_LOWLEVEL_INIT 4641 [ARM, NDS32, MIPS only] If this variable is defined, then certain 4642 low level initializations (like setting up the memory 4643 controller) are omitted and/or U-Boot does not 4644 relocate itself into RAM. 4645 4646 Normally this variable MUST NOT be defined. The only 4647 exception is when U-Boot is loaded (to RAM) by some 4648 other boot loader or by a debugger which performs 4649 these initializations itself. 4650 4651- CONFIG_SPL_BUILD 4652 Modifies the behaviour of start.S when compiling a loader 4653 that is executed before the actual U-Boot. E.g. when 4654 compiling a NAND SPL. 4655 4656- CONFIG_TPL_BUILD 4657 Modifies the behaviour of start.S when compiling a loader 4658 that is executed after the SPL and before the actual U-Boot. 4659 It is loaded by the SPL. 4660 4661- CONFIG_SYS_MPC85XX_NO_RESETVEC 4662 Only for 85xx systems. If this variable is specified, the section 4663 .resetvec is not kept and the section .bootpg is placed in the 4664 previous 4k of the .text section. 4665 4666- CONFIG_ARCH_MAP_SYSMEM 4667 Generally U-Boot (and in particular the md command) uses 4668 effective address. It is therefore not necessary to regard 4669 U-Boot address as virtual addresses that need to be translated 4670 to physical addresses. However, sandbox requires this, since 4671 it maintains its own little RAM buffer which contains all 4672 addressable memory. This option causes some memory accesses 4673 to be mapped through map_sysmem() / unmap_sysmem(). 4674 4675- CONFIG_USE_ARCH_MEMCPY 4676 CONFIG_USE_ARCH_MEMSET 4677 If these options are used a optimized version of memcpy/memset will 4678 be used if available. These functions may be faster under some 4679 conditions but may increase the binary size. 4680 4681- CONFIG_X86_RESET_VECTOR 4682 If defined, the x86 reset vector code is included. This is not 4683 needed when U-Boot is running from Coreboot. 4684 4685- CONFIG_SYS_MPUCLK 4686 Defines the MPU clock speed (in MHz). 4687 4688 NOTE : currently only supported on AM335x platforms. 4689 4690- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC: 4691 Enables the RTC32K OSC on AM33xx based plattforms 4692 4693- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE 4694 Option to disable subpage write in NAND driver 4695 driver that uses this: 4696 drivers/mtd/nand/davinci_nand.c 4697 4698Freescale QE/FMAN Firmware Support: 4699----------------------------------- 4700 4701The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the 4702loading of "firmware", which is encoded in the QE firmware binary format. 4703This firmware often needs to be loaded during U-Boot booting, so macros 4704are used to identify the storage device (NOR flash, SPI, etc) and the address 4705within that device. 4706 4707- CONFIG_SYS_FMAN_FW_ADDR 4708 The address in the storage device where the FMAN microcode is located. The 4709 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4710 is also specified. 4711 4712- CONFIG_SYS_QE_FW_ADDR 4713 The address in the storage device where the QE microcode is located. The 4714 meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro 4715 is also specified. 4716 4717- CONFIG_SYS_QE_FMAN_FW_LENGTH 4718 The maximum possible size of the firmware. The firmware binary format 4719 has a field that specifies the actual size of the firmware, but it 4720 might not be possible to read any part of the firmware unless some 4721 local storage is allocated to hold the entire firmware first. 4722 4723- CONFIG_SYS_QE_FMAN_FW_IN_NOR 4724 Specifies that QE/FMAN firmware is located in NOR flash, mapped as 4725 normal addressable memory via the LBC. CONFIG_SYS_FMAN_FW_ADDR is the 4726 virtual address in NOR flash. 4727 4728- CONFIG_SYS_QE_FMAN_FW_IN_NAND 4729 Specifies that QE/FMAN firmware is located in NAND flash. 4730 CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash. 4731 4732- CONFIG_SYS_QE_FMAN_FW_IN_MMC 4733 Specifies that QE/FMAN firmware is located on the primary SD/MMC 4734 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4735 4736- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH 4737 Specifies that QE/FMAN firmware is located on the primary SPI 4738 device. CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device. 4739 4740- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE 4741 Specifies that QE/FMAN firmware is located in the remote (master) 4742 memory space. CONFIG_SYS_FMAN_FW_ADDR is a virtual address which 4743 can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound 4744 window->master inbound window->master LAW->the ucode address in 4745 master's memory space. 4746 4747Freescale Layerscape Management Complex Firmware Support: 4748--------------------------------------------------------- 4749The Freescale Layerscape Management Complex (MC) supports the loading of 4750"firmware". 4751This firmware often needs to be loaded during U-Boot booting, so macros 4752are used to identify the storage device (NOR flash, SPI, etc) and the address 4753within that device. 4754 4755- CONFIG_FSL_MC_ENET 4756 Enable the MC driver for Layerscape SoCs. 4757 4758- CONFIG_SYS_LS_MC_FW_ADDR 4759 The address in the storage device where the firmware is located. The 4760 meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro 4761 is also specified. 4762 4763- CONFIG_SYS_LS_MC_FW_LENGTH 4764 The maximum possible size of the firmware. The firmware binary format 4765 has a field that specifies the actual size of the firmware, but it 4766 might not be possible to read any part of the firmware unless some 4767 local storage is allocated to hold the entire firmware first. 4768 4769- CONFIG_SYS_LS_MC_FW_IN_NOR 4770 Specifies that MC firmware is located in NOR flash, mapped as 4771 normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the 4772 virtual address in NOR flash. 4773 4774Building the Software: 4775====================== 4776 4777Building U-Boot has been tested in several native build environments 4778and in many different cross environments. Of course we cannot support 4779all possibly existing versions of cross development tools in all 4780(potentially obsolete) versions. In case of tool chain problems we 4781recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK) 4782which is extensively used to build and test U-Boot. 4783 4784If you are not using a native environment, it is assumed that you 4785have GNU cross compiling tools available in your path. In this case, 4786you must set the environment variable CROSS_COMPILE in your shell. 4787Note that no changes to the Makefile or any other source files are 4788necessary. For example using the ELDK on a 4xx CPU, please enter: 4789 4790 $ CROSS_COMPILE=ppc_4xx- 4791 $ export CROSS_COMPILE 4792 4793Note: If you wish to generate Windows versions of the utilities in 4794 the tools directory you can use the MinGW toolchain 4795 (http://www.mingw.org). Set your HOST tools to the MinGW 4796 toolchain and execute 'make tools'. For example: 4797 4798 $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools 4799 4800 Binaries such as tools/mkimage.exe will be created which can 4801 be executed on computers running Windows. 4802 4803U-Boot is intended to be simple to build. After installing the 4804sources you must configure U-Boot for one specific board type. This 4805is done by typing: 4806 4807 make NAME_config 4808 4809where "NAME_config" is the name of one of the existing configu- 4810rations; see boards.cfg for supported names. 4811 4812Note: for some board special configuration names may exist; check if 4813 additional information is available from the board vendor; for 4814 instance, the TQM823L systems are available without (standard) 4815 or with LCD support. You can select such additional "features" 4816 when choosing the configuration, i. e. 4817 4818 make TQM823L_config 4819 - will configure for a plain TQM823L, i. e. no LCD support 4820 4821 make TQM823L_LCD_config 4822 - will configure for a TQM823L with U-Boot console on LCD 4823 4824 etc. 4825 4826 4827Finally, type "make all", and you should get some working U-Boot 4828images ready for download to / installation on your system: 4829 4830- "u-boot.bin" is a raw binary image 4831- "u-boot" is an image in ELF binary format 4832- "u-boot.srec" is in Motorola S-Record format 4833 4834By default the build is performed locally and the objects are saved 4835in the source directory. One of the two methods can be used to change 4836this behavior and build U-Boot to some external directory: 4837 48381. Add O= to the make command line invocations: 4839 4840 make O=/tmp/build distclean 4841 make O=/tmp/build NAME_config 4842 make O=/tmp/build all 4843 48442. Set environment variable BUILD_DIR to point to the desired location: 4845 4846 export BUILD_DIR=/tmp/build 4847 make distclean 4848 make NAME_config 4849 make all 4850 4851Note that the command line "O=" setting overrides the BUILD_DIR environment 4852variable. 4853 4854 4855Please be aware that the Makefiles assume you are using GNU make, so 4856for instance on NetBSD you might need to use "gmake" instead of 4857native "make". 4858 4859 4860If the system board that you have is not listed, then you will need 4861to port U-Boot to your hardware platform. To do this, follow these 4862steps: 4863 48641. Add a new configuration option for your board to the toplevel 4865 "boards.cfg" file, using the existing entries as examples. 4866 Follow the instructions there to keep the boards in order. 48672. Create a new directory to hold your board specific code. Add any 4868 files you need. In your board directory, you will need at least 4869 the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds". 48703. Create a new configuration file "include/configs/<board>.h" for 4871 your board 48723. If you're porting U-Boot to a new CPU, then also create a new 4873 directory to hold your CPU specific code. Add any files you need. 48744. Run "make <board>_config" with your new name. 48755. Type "make", and you should get a working "u-boot.srec" file 4876 to be installed on your target system. 48776. Debug and solve any problems that might arise. 4878 [Of course, this last step is much harder than it sounds.] 4879 4880 4881Testing of U-Boot Modifications, Ports to New Hardware, etc.: 4882============================================================== 4883 4884If you have modified U-Boot sources (for instance added a new board 4885or support for new devices, a new CPU, etc.) you are expected to 4886provide feedback to the other developers. The feedback normally takes 4887the form of a "patch", i. e. a context diff against a certain (latest 4888official or latest in the git repository) version of U-Boot sources. 4889 4890But before you submit such a patch, please verify that your modifi- 4891cation did not break existing code. At least make sure that *ALL* of 4892the supported boards compile WITHOUT ANY compiler warnings. To do so, 4893just run the "MAKEALL" script, which will configure and build U-Boot 4894for ALL supported system. Be warned, this will take a while. You can 4895select which (cross) compiler to use by passing a `CROSS_COMPILE' 4896environment variable to the script, i. e. to use the ELDK cross tools 4897you can type 4898 4899 CROSS_COMPILE=ppc_8xx- MAKEALL 4900 4901or to build on a native PowerPC system you can type 4902 4903 CROSS_COMPILE=' ' MAKEALL 4904 4905When using the MAKEALL script, the default behaviour is to build 4906U-Boot in the source directory. This location can be changed by 4907setting the BUILD_DIR environment variable. Also, for each target 4908built, the MAKEALL script saves two log files (<target>.ERR and 4909<target>.MAKEALL) in the <source dir>/LOG directory. This default 4910location can be changed by setting the MAKEALL_LOGDIR environment 4911variable. For example: 4912 4913 export BUILD_DIR=/tmp/build 4914 export MAKEALL_LOGDIR=/tmp/log 4915 CROSS_COMPILE=ppc_8xx- MAKEALL 4916 4917With the above settings build objects are saved in the /tmp/build, 4918log files are saved in the /tmp/log and the source tree remains clean 4919during the whole build process. 4920 4921 4922See also "U-Boot Porting Guide" below. 4923 4924 4925Monitor Commands - Overview: 4926============================ 4927 4928go - start application at address 'addr' 4929run - run commands in an environment variable 4930bootm - boot application image from memory 4931bootp - boot image via network using BootP/TFTP protocol 4932bootz - boot zImage from memory 4933tftpboot- boot image via network using TFTP protocol 4934 and env variables "ipaddr" and "serverip" 4935 (and eventually "gatewayip") 4936tftpput - upload a file via network using TFTP protocol 4937rarpboot- boot image via network using RARP/TFTP protocol 4938diskboot- boot from IDE devicebootd - boot default, i.e., run 'bootcmd' 4939loads - load S-Record file over serial line 4940loadb - load binary file over serial line (kermit mode) 4941md - memory display 4942mm - memory modify (auto-incrementing) 4943nm - memory modify (constant address) 4944mw - memory write (fill) 4945cp - memory copy 4946cmp - memory compare 4947crc32 - checksum calculation 4948i2c - I2C sub-system 4949sspi - SPI utility commands 4950base - print or set address offset 4951printenv- print environment variables 4952setenv - set environment variables 4953saveenv - save environment variables to persistent storage 4954protect - enable or disable FLASH write protection 4955erase - erase FLASH memory 4956flinfo - print FLASH memory information 4957nand - NAND memory operations (see doc/README.nand) 4958bdinfo - print Board Info structure 4959iminfo - print header information for application image 4960coninfo - print console devices and informations 4961ide - IDE sub-system 4962loop - infinite loop on address range 4963loopw - infinite write loop on address range 4964mtest - simple RAM test 4965icache - enable or disable instruction cache 4966dcache - enable or disable data cache 4967reset - Perform RESET of the CPU 4968echo - echo args to console 4969version - print monitor version 4970help - print online help 4971? - alias for 'help' 4972 4973 4974Monitor Commands - Detailed Description: 4975======================================== 4976 4977TODO. 4978 4979For now: just type "help <command>". 4980 4981 4982Environment Variables: 4983====================== 4984 4985U-Boot supports user configuration using Environment Variables which 4986can be made persistent by saving to Flash memory. 4987 4988Environment Variables are set using "setenv", printed using 4989"printenv", and saved to Flash using "saveenv". Using "setenv" 4990without a value can be used to delete a variable from the 4991environment. As long as you don't save the environment you are 4992working with an in-memory copy. In case the Flash area containing the 4993environment is erased by accident, a default environment is provided. 4994 4995Some configuration options can be set using Environment Variables. 4996 4997List of environment variables (most likely not complete): 4998 4999 baudrate - see CONFIG_BAUDRATE 5000 5001 bootdelay - see CONFIG_BOOTDELAY 5002 5003 bootcmd - see CONFIG_BOOTCOMMAND 5004 5005 bootargs - Boot arguments when booting an RTOS image 5006 5007 bootfile - Name of the image to load with TFTP 5008 5009 bootm_low - Memory range available for image processing in the bootm 5010 command can be restricted. This variable is given as 5011 a hexadecimal number and defines lowest address allowed 5012 for use by the bootm command. See also "bootm_size" 5013 environment variable. Address defined by "bootm_low" is 5014 also the base of the initial memory mapping for the Linux 5015 kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and 5016 bootm_mapsize. 5017 5018 bootm_mapsize - Size of the initial memory mapping for the Linux kernel. 5019 This variable is given as a hexadecimal number and it 5020 defines the size of the memory region starting at base 5021 address bootm_low that is accessible by the Linux kernel 5022 during early boot. If unset, CONFIG_SYS_BOOTMAPSZ is used 5023 as the default value if it is defined, and bootm_size is 5024 used otherwise. 5025 5026 bootm_size - Memory range available for image processing in the bootm 5027 command can be restricted. This variable is given as 5028 a hexadecimal number and defines the size of the region 5029 allowed for use by the bootm command. See also "bootm_low" 5030 environment variable. 5031 5032 updatefile - Location of the software update file on a TFTP server, used 5033 by the automatic software update feature. Please refer to 5034 documentation in doc/README.update for more details. 5035 5036 autoload - if set to "no" (any string beginning with 'n'), 5037 "bootp" will just load perform a lookup of the 5038 configuration from the BOOTP server, but not try to 5039 load any image using TFTP 5040 5041 autostart - if set to "yes", an image loaded using the "bootp", 5042 "rarpboot", "tftpboot" or "diskboot" commands will 5043 be automatically started (by internally calling 5044 "bootm") 5045 5046 If set to "no", a standalone image passed to the 5047 "bootm" command will be copied to the load address 5048 (and eventually uncompressed), but NOT be started. 5049 This can be used to load and uncompress arbitrary 5050 data. 5051 5052 fdt_high - if set this restricts the maximum address that the 5053 flattened device tree will be copied into upon boot. 5054 For example, if you have a system with 1 GB memory 5055 at physical address 0x10000000, while Linux kernel 5056 only recognizes the first 704 MB as low memory, you 5057 may need to set fdt_high as 0x3C000000 to have the 5058 device tree blob be copied to the maximum address 5059 of the 704 MB low memory, so that Linux kernel can 5060 access it during the boot procedure. 5061 5062 If this is set to the special value 0xFFFFFFFF then 5063 the fdt will not be copied at all on boot. For this 5064 to work it must reside in writable memory, have 5065 sufficient padding on the end of it for u-boot to 5066 add the information it needs into it, and the memory 5067 must be accessible by the kernel. 5068 5069 fdtcontroladdr- if set this is the address of the control flattened 5070 device tree used by U-Boot when CONFIG_OF_CONTROL is 5071 defined. 5072 5073 i2cfast - (PPC405GP|PPC405EP only) 5074 if set to 'y' configures Linux I2C driver for fast 5075 mode (400kHZ). This environment variable is used in 5076 initialization code. So, for changes to be effective 5077 it must be saved and board must be reset. 5078 5079 initrd_high - restrict positioning of initrd images: 5080 If this variable is not set, initrd images will be 5081 copied to the highest possible address in RAM; this 5082 is usually what you want since it allows for 5083 maximum initrd size. If for some reason you want to 5084 make sure that the initrd image is loaded below the 5085 CONFIG_SYS_BOOTMAPSZ limit, you can set this environment 5086 variable to a value of "no" or "off" or "0". 5087 Alternatively, you can set it to a maximum upper 5088 address to use (U-Boot will still check that it 5089 does not overwrite the U-Boot stack and data). 5090 5091 For instance, when you have a system with 16 MB 5092 RAM, and want to reserve 4 MB from use by Linux, 5093 you can do this by adding "mem=12M" to the value of 5094 the "bootargs" variable. However, now you must make 5095 sure that the initrd image is placed in the first 5096 12 MB as well - this can be done with 5097 5098 setenv initrd_high 00c00000 5099 5100 If you set initrd_high to 0xFFFFFFFF, this is an 5101 indication to U-Boot that all addresses are legal 5102 for the Linux kernel, including addresses in flash 5103 memory. In this case U-Boot will NOT COPY the 5104 ramdisk at all. This may be useful to reduce the 5105 boot time on your system, but requires that this 5106 feature is supported by your Linux kernel. 5107 5108 ipaddr - IP address; needed for tftpboot command 5109 5110 loadaddr - Default load address for commands like "bootp", 5111 "rarpboot", "tftpboot", "loadb" or "diskboot" 5112 5113 loads_echo - see CONFIG_LOADS_ECHO 5114 5115 serverip - TFTP server IP address; needed for tftpboot command 5116 5117 bootretry - see CONFIG_BOOT_RETRY_TIME 5118 5119 bootdelaykey - see CONFIG_AUTOBOOT_DELAY_STR 5120 5121 bootstopkey - see CONFIG_AUTOBOOT_STOP_STR 5122 5123 ethprime - controls which interface is used first. 5124 5125 ethact - controls which interface is currently active. 5126 For example you can do the following 5127 5128 => setenv ethact FEC 5129 => ping 192.168.0.1 # traffic sent on FEC 5130 => setenv ethact SCC 5131 => ping 10.0.0.1 # traffic sent on SCC 5132 5133 ethrotate - When set to "no" U-Boot does not go through all 5134 available network interfaces. 5135 It just stays at the currently selected interface. 5136 5137 netretry - When set to "no" each network operation will 5138 either succeed or fail without retrying. 5139 When set to "once" the network operation will 5140 fail when all the available network interfaces 5141 are tried once without success. 5142 Useful on scripts which control the retry operation 5143 themselves. 5144 5145 npe_ucode - set load address for the NPE microcode 5146 5147 silent_linux - If set then linux will be told to boot silently, by 5148 changing the console to be empty. If "yes" it will be 5149 made silent. If "no" it will not be made silent. If 5150 unset, then it will be made silent if the U-Boot console 5151 is silent. 5152 5153 tftpsrcport - If this is set, the value is used for TFTP's 5154 UDP source port. 5155 5156 tftpdstport - If this is set, the value is used for TFTP's UDP 5157 destination port instead of the Well Know Port 69. 5158 5159 tftpblocksize - Block size to use for TFTP transfers; if not set, 5160 we use the TFTP server's default block size 5161 5162 tftptimeout - Retransmission timeout for TFTP packets (in milli- 5163 seconds, minimum value is 1000 = 1 second). Defines 5164 when a packet is considered to be lost so it has to 5165 be retransmitted. The default is 5000 = 5 seconds. 5166 Lowering this value may make downloads succeed 5167 faster in networks with high packet loss rates or 5168 with unreliable TFTP servers. 5169 5170 vlan - When set to a value < 4095 the traffic over 5171 Ethernet is encapsulated/received over 802.1q 5172 VLAN tagged frames. 5173 5174The following image location variables contain the location of images 5175used in booting. The "Image" column gives the role of the image and is 5176not an environment variable name. The other columns are environment 5177variable names. "File Name" gives the name of the file on a TFTP 5178server, "RAM Address" gives the location in RAM the image will be 5179loaded to, and "Flash Location" gives the image's address in NOR 5180flash or offset in NAND flash. 5181 5182*Note* - these variables don't have to be defined for all boards, some 5183boards currenlty use other variables for these purposes, and some 5184boards use these variables for other purposes. 5185 5186Image File Name RAM Address Flash Location 5187----- --------- ----------- -------------- 5188u-boot u-boot u-boot_addr_r u-boot_addr 5189Linux kernel bootfile kernel_addr_r kernel_addr 5190device tree blob fdtfile fdt_addr_r fdt_addr 5191ramdisk ramdiskfile ramdisk_addr_r ramdisk_addr 5192 5193The following environment variables may be used and automatically 5194updated by the network boot commands ("bootp" and "rarpboot"), 5195depending the information provided by your boot server: 5196 5197 bootfile - see above 5198 dnsip - IP address of your Domain Name Server 5199 dnsip2 - IP address of your secondary Domain Name Server 5200 gatewayip - IP address of the Gateway (Router) to use 5201 hostname - Target hostname 5202 ipaddr - see above 5203 netmask - Subnet Mask 5204 rootpath - Pathname of the root filesystem on the NFS server 5205 serverip - see above 5206 5207 5208There are two special Environment Variables: 5209 5210 serial# - contains hardware identification information such 5211 as type string and/or serial number 5212 ethaddr - Ethernet address 5213 5214These variables can be set only once (usually during manufacturing of 5215the board). U-Boot refuses to delete or overwrite these variables 5216once they have been set once. 5217 5218 5219Further special Environment Variables: 5220 5221 ver - Contains the U-Boot version string as printed 5222 with the "version" command. This variable is 5223 readonly (see CONFIG_VERSION_VARIABLE). 5224 5225 5226Please note that changes to some configuration parameters may take 5227only effect after the next boot (yes, that's just like Windoze :-). 5228 5229 5230Callback functions for environment variables: 5231--------------------------------------------- 5232 5233For some environment variables, the behavior of u-boot needs to change 5234when their values are changed. This functionailty allows functions to 5235be associated with arbitrary variables. On creation, overwrite, or 5236deletion, the callback will provide the opportunity for some side 5237effect to happen or for the change to be rejected. 5238 5239The callbacks are named and associated with a function using the 5240U_BOOT_ENV_CALLBACK macro in your board or driver code. 5241 5242These callbacks are associated with variables in one of two ways. The 5243static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC 5244in the board configuration to a string that defines a list of 5245associations. The list must be in the following format: 5246 5247 entry = variable_name[:callback_name] 5248 list = entry[,list] 5249 5250If the callback name is not specified, then the callback is deleted. 5251Spaces are also allowed anywhere in the list. 5252 5253Callbacks can also be associated by defining the ".callbacks" variable 5254with the same list format above. Any association in ".callbacks" will 5255override any association in the static list. You can define 5256CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the 5257".callbacks" envirnoment variable in the default or embedded environment. 5258 5259 5260Command Line Parsing: 5261===================== 5262 5263There are two different command line parsers available with U-Boot: 5264the old "simple" one, and the much more powerful "hush" shell: 5265 5266Old, simple command line parser: 5267-------------------------------- 5268 5269- supports environment variables (through setenv / saveenv commands) 5270- several commands on one line, separated by ';' 5271- variable substitution using "... ${name} ..." syntax 5272- special characters ('$', ';') can be escaped by prefixing with '\', 5273 for example: 5274 setenv bootcmd bootm \${address} 5275- You can also escape text by enclosing in single apostrophes, for example: 5276 setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off' 5277 5278Hush shell: 5279----------- 5280 5281- similar to Bourne shell, with control structures like 5282 if...then...else...fi, for...do...done; while...do...done, 5283 until...do...done, ... 5284- supports environment ("global") variables (through setenv / saveenv 5285 commands) and local shell variables (through standard shell syntax 5286 "name=value"); only environment variables can be used with "run" 5287 command 5288 5289General rules: 5290-------------- 5291 5292(1) If a command line (or an environment variable executed by a "run" 5293 command) contains several commands separated by semicolon, and 5294 one of these commands fails, then the remaining commands will be 5295 executed anyway. 5296 5297(2) If you execute several variables with one call to run (i. e. 5298 calling run with a list of variables as arguments), any failing 5299 command will cause "run" to terminate, i. e. the remaining 5300 variables are not executed. 5301 5302Note for Redundant Ethernet Interfaces: 5303======================================= 5304 5305Some boards come with redundant Ethernet interfaces; U-Boot supports 5306such configurations and is capable of automatic selection of a 5307"working" interface when needed. MAC assignment works as follows: 5308 5309Network interfaces are numbered eth0, eth1, eth2, ... Corresponding 5310MAC addresses can be stored in the environment as "ethaddr" (=>eth0), 5311"eth1addr" (=>eth1), "eth2addr", ... 5312 5313If the network interface stores some valid MAC address (for instance 5314in SROM), this is used as default address if there is NO correspon- 5315ding setting in the environment; if the corresponding environment 5316variable is set, this overrides the settings in the card; that means: 5317 5318o If the SROM has a valid MAC address, and there is no address in the 5319 environment, the SROM's address is used. 5320 5321o If there is no valid address in the SROM, and a definition in the 5322 environment exists, then the value from the environment variable is 5323 used. 5324 5325o If both the SROM and the environment contain a MAC address, and 5326 both addresses are the same, this MAC address is used. 5327 5328o If both the SROM and the environment contain a MAC address, and the 5329 addresses differ, the value from the environment is used and a 5330 warning is printed. 5331 5332o If neither SROM nor the environment contain a MAC address, an error 5333 is raised. 5334 5335If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses 5336will be programmed into hardware as part of the initialization process. This 5337may be skipped by setting the appropriate 'ethmacskip' environment variable. 5338The naming convention is as follows: 5339"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc. 5340 5341Image Formats: 5342============== 5343 5344U-Boot is capable of booting (and performing other auxiliary operations on) 5345images in two formats: 5346 5347New uImage format (FIT) 5348----------------------- 5349 5350Flexible and powerful format based on Flattened Image Tree -- FIT (similar 5351to Flattened Device Tree). It allows the use of images with multiple 5352components (several kernels, ramdisks, etc.), with contents protected by 5353SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory. 5354 5355 5356Old uImage format 5357----------------- 5358 5359Old image format is based on binary files which can be basically anything, 5360preceded by a special header; see the definitions in include/image.h for 5361details; basically, the header defines the following image properties: 5362 5363* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD, 5364 4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks, 5365 LynxOS, pSOS, QNX, RTEMS, INTEGRITY; 5366 Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS, 5367 INTEGRITY). 5368* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86, 5369 IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit; 5370 Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC). 5371* Compression Type (uncompressed, gzip, bzip2) 5372* Load Address 5373* Entry Point 5374* Image Name 5375* Image Timestamp 5376 5377The header is marked by a special Magic Number, and both the header 5378and the data portions of the image are secured against corruption by 5379CRC32 checksums. 5380 5381 5382Linux Support: 5383============== 5384 5385Although U-Boot should support any OS or standalone application 5386easily, the main focus has always been on Linux during the design of 5387U-Boot. 5388 5389U-Boot includes many features that so far have been part of some 5390special "boot loader" code within the Linux kernel. Also, any 5391"initrd" images to be used are no longer part of one big Linux image; 5392instead, kernel and "initrd" are separate images. This implementation 5393serves several purposes: 5394 5395- the same features can be used for other OS or standalone 5396 applications (for instance: using compressed images to reduce the 5397 Flash memory footprint) 5398 5399- it becomes much easier to port new Linux kernel versions because 5400 lots of low-level, hardware dependent stuff are done by U-Boot 5401 5402- the same Linux kernel image can now be used with different "initrd" 5403 images; of course this also means that different kernel images can 5404 be run with the same "initrd". This makes testing easier (you don't 5405 have to build a new "zImage.initrd" Linux image when you just 5406 change a file in your "initrd"). Also, a field-upgrade of the 5407 software is easier now. 5408 5409 5410Linux HOWTO: 5411============ 5412 5413Porting Linux to U-Boot based systems: 5414--------------------------------------- 5415 5416U-Boot cannot save you from doing all the necessary modifications to 5417configure the Linux device drivers for use with your target hardware 5418(no, we don't intend to provide a full virtual machine interface to 5419Linux :-). 5420 5421But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot). 5422 5423Just make sure your machine specific header file (for instance 5424include/asm-ppc/tqm8xx.h) includes the same definition of the Board 5425Information structure as we define in include/asm-<arch>/u-boot.h, 5426and make sure that your definition of IMAP_ADDR uses the same value 5427as your U-Boot configuration in CONFIG_SYS_IMMR. 5428 5429Note that U-Boot now has a driver model, a unified model for drivers. 5430If you are adding a new driver, plumb it into driver model. If there 5431is no uclass available, you are encouraged to create one. See 5432doc/driver-model. 5433 5434 5435Configuring the Linux kernel: 5436----------------------------- 5437 5438No specific requirements for U-Boot. Make sure you have some root 5439device (initial ramdisk, NFS) for your target system. 5440 5441 5442Building a Linux Image: 5443----------------------- 5444 5445With U-Boot, "normal" build targets like "zImage" or "bzImage" are 5446not used. If you use recent kernel source, a new build target 5447"uImage" will exist which automatically builds an image usable by 5448U-Boot. Most older kernels also have support for a "pImage" target, 5449which was introduced for our predecessor project PPCBoot and uses a 5450100% compatible format. 5451 5452Example: 5453 5454 make TQM850L_config 5455 make oldconfig 5456 make dep 5457 make uImage 5458 5459The "uImage" build target uses a special tool (in 'tools/mkimage') to 5460encapsulate a compressed Linux kernel image with header information, 5461CRC32 checksum etc. for use with U-Boot. This is what we are doing: 5462 5463* build a standard "vmlinux" kernel image (in ELF binary format): 5464 5465* convert the kernel into a raw binary image: 5466 5467 ${CROSS_COMPILE}-objcopy -O binary \ 5468 -R .note -R .comment \ 5469 -S vmlinux linux.bin 5470 5471* compress the binary image: 5472 5473 gzip -9 linux.bin 5474 5475* package compressed binary image for U-Boot: 5476 5477 mkimage -A ppc -O linux -T kernel -C gzip \ 5478 -a 0 -e 0 -n "Linux Kernel Image" \ 5479 -d linux.bin.gz uImage 5480 5481 5482The "mkimage" tool can also be used to create ramdisk images for use 5483with U-Boot, either separated from the Linux kernel image, or 5484combined into one file. "mkimage" encapsulates the images with a 64 5485byte header containing information about target architecture, 5486operating system, image type, compression method, entry points, time 5487stamp, CRC32 checksums, etc. 5488 5489"mkimage" can be called in two ways: to verify existing images and 5490print the header information, or to build new images. 5491 5492In the first form (with "-l" option) mkimage lists the information 5493contained in the header of an existing U-Boot image; this includes 5494checksum verification: 5495 5496 tools/mkimage -l image 5497 -l ==> list image header information 5498 5499The second form (with "-d" option) is used to build a U-Boot image 5500from a "data file" which is used as image payload: 5501 5502 tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \ 5503 -n name -d data_file image 5504 -A ==> set architecture to 'arch' 5505 -O ==> set operating system to 'os' 5506 -T ==> set image type to 'type' 5507 -C ==> set compression type 'comp' 5508 -a ==> set load address to 'addr' (hex) 5509 -e ==> set entry point to 'ep' (hex) 5510 -n ==> set image name to 'name' 5511 -d ==> use image data from 'datafile' 5512 5513Right now, all Linux kernels for PowerPC systems use the same load 5514address (0x00000000), but the entry point address depends on the 5515kernel version: 5516 5517- 2.2.x kernels have the entry point at 0x0000000C, 5518- 2.3.x and later kernels have the entry point at 0x00000000. 5519 5520So a typical call to build a U-Boot image would read: 5521 5522 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 5523 > -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \ 5524 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \ 5525 > examples/uImage.TQM850L 5526 Image Name: 2.4.4 kernel for TQM850L 5527 Created: Wed Jul 19 02:34:59 2000 5528 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5529 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5530 Load Address: 0x00000000 5531 Entry Point: 0x00000000 5532 5533To verify the contents of the image (or check for corruption): 5534 5535 -> tools/mkimage -l examples/uImage.TQM850L 5536 Image Name: 2.4.4 kernel for TQM850L 5537 Created: Wed Jul 19 02:34:59 2000 5538 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5539 Data Size: 335725 Bytes = 327.86 kB = 0.32 MB 5540 Load Address: 0x00000000 5541 Entry Point: 0x00000000 5542 5543NOTE: for embedded systems where boot time is critical you can trade 5544speed for memory and install an UNCOMPRESSED image instead: this 5545needs more space in Flash, but boots much faster since it does not 5546need to be uncompressed: 5547 5548 -> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz 5549 -> tools/mkimage -n '2.4.4 kernel for TQM850L' \ 5550 > -A ppc -O linux -T kernel -C none -a 0 -e 0 \ 5551 > -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \ 5552 > examples/uImage.TQM850L-uncompressed 5553 Image Name: 2.4.4 kernel for TQM850L 5554 Created: Wed Jul 19 02:34:59 2000 5555 Image Type: PowerPC Linux Kernel Image (uncompressed) 5556 Data Size: 792160 Bytes = 773.59 kB = 0.76 MB 5557 Load Address: 0x00000000 5558 Entry Point: 0x00000000 5559 5560 5561Similar you can build U-Boot images from a 'ramdisk.image.gz' file 5562when your kernel is intended to use an initial ramdisk: 5563 5564 -> tools/mkimage -n 'Simple Ramdisk Image' \ 5565 > -A ppc -O linux -T ramdisk -C gzip \ 5566 > -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd 5567 Image Name: Simple Ramdisk Image 5568 Created: Wed Jan 12 14:01:50 2000 5569 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5570 Data Size: 566530 Bytes = 553.25 kB = 0.54 MB 5571 Load Address: 0x00000000 5572 Entry Point: 0x00000000 5573 5574The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i" 5575option performs the converse operation of the mkimage's second form (the "-d" 5576option). Given an image built by mkimage, the dumpimage extracts a "data file" 5577from the image: 5578 5579 tools/dumpimage -i image -p position data_file 5580 -i ==> extract from the 'image' a specific 'data_file', \ 5581 indexed by 'position' 5582 5583 5584Installing a Linux Image: 5585------------------------- 5586 5587To downloading a U-Boot image over the serial (console) interface, 5588you must convert the image to S-Record format: 5589 5590 objcopy -I binary -O srec examples/image examples/image.srec 5591 5592The 'objcopy' does not understand the information in the U-Boot 5593image header, so the resulting S-Record file will be relative to 5594address 0x00000000. To load it to a given address, you need to 5595specify the target address as 'offset' parameter with the 'loads' 5596command. 5597 5598Example: install the image to address 0x40100000 (which on the 5599TQM8xxL is in the first Flash bank): 5600 5601 => erase 40100000 401FFFFF 5602 5603 .......... done 5604 Erased 8 sectors 5605 5606 => loads 40100000 5607 ## Ready for S-Record download ... 5608 ~>examples/image.srec 5609 1 2 3 4 5 6 7 8 9 10 11 12 13 ... 5610 ... 5611 15989 15990 15991 15992 5612 [file transfer complete] 5613 [connected] 5614 ## Start Addr = 0x00000000 5615 5616 5617You can check the success of the download using the 'iminfo' command; 5618this includes a checksum verification so you can be sure no data 5619corruption happened: 5620 5621 => imi 40100000 5622 5623 ## Checking Image at 40100000 ... 5624 Image Name: 2.2.13 for initrd on TQM850L 5625 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5626 Data Size: 335725 Bytes = 327 kB = 0 MB 5627 Load Address: 00000000 5628 Entry Point: 0000000c 5629 Verifying Checksum ... OK 5630 5631 5632Boot Linux: 5633----------- 5634 5635The "bootm" command is used to boot an application that is stored in 5636memory (RAM or Flash). In case of a Linux kernel image, the contents 5637of the "bootargs" environment variable is passed to the kernel as 5638parameters. You can check and modify this variable using the 5639"printenv" and "setenv" commands: 5640 5641 5642 => printenv bootargs 5643 bootargs=root=/dev/ram 5644 5645 => setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5646 5647 => printenv bootargs 5648 bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5649 5650 => bootm 40020000 5651 ## Booting Linux kernel at 40020000 ... 5652 Image Name: 2.2.13 for NFS on TQM850L 5653 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5654 Data Size: 381681 Bytes = 372 kB = 0 MB 5655 Load Address: 00000000 5656 Entry Point: 0000000c 5657 Verifying Checksum ... OK 5658 Uncompressing Kernel Image ... OK 5659 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 5660 Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2 5661 time_init: decrementer frequency = 187500000/60 5662 Calibrating delay loop... 49.77 BogoMIPS 5663 Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000] 5664 ... 5665 5666If you want to boot a Linux kernel with initial RAM disk, you pass 5667the memory addresses of both the kernel and the initrd image (PPBCOOT 5668format!) to the "bootm" command: 5669 5670 => imi 40100000 40200000 5671 5672 ## Checking Image at 40100000 ... 5673 Image Name: 2.2.13 for initrd on TQM850L 5674 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5675 Data Size: 335725 Bytes = 327 kB = 0 MB 5676 Load Address: 00000000 5677 Entry Point: 0000000c 5678 Verifying Checksum ... OK 5679 5680 ## Checking Image at 40200000 ... 5681 Image Name: Simple Ramdisk Image 5682 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5683 Data Size: 566530 Bytes = 553 kB = 0 MB 5684 Load Address: 00000000 5685 Entry Point: 00000000 5686 Verifying Checksum ... OK 5687 5688 => bootm 40100000 40200000 5689 ## Booting Linux kernel at 40100000 ... 5690 Image Name: 2.2.13 for initrd on TQM850L 5691 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5692 Data Size: 335725 Bytes = 327 kB = 0 MB 5693 Load Address: 00000000 5694 Entry Point: 0000000c 5695 Verifying Checksum ... OK 5696 Uncompressing Kernel Image ... OK 5697 ## Loading RAMDisk Image at 40200000 ... 5698 Image Name: Simple Ramdisk Image 5699 Image Type: PowerPC Linux RAMDisk Image (gzip compressed) 5700 Data Size: 566530 Bytes = 553 kB = 0 MB 5701 Load Address: 00000000 5702 Entry Point: 00000000 5703 Verifying Checksum ... OK 5704 Loading Ramdisk ... OK 5705 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 5706 Boot arguments: root=/dev/ram 5707 time_init: decrementer frequency = 187500000/60 5708 Calibrating delay loop... 49.77 BogoMIPS 5709 ... 5710 RAMDISK: Compressed image found at block 0 5711 VFS: Mounted root (ext2 filesystem). 5712 5713 bash# 5714 5715Boot Linux and pass a flat device tree: 5716----------- 5717 5718First, U-Boot must be compiled with the appropriate defines. See the section 5719titled "Linux Kernel Interface" above for a more in depth explanation. The 5720following is an example of how to start a kernel and pass an updated 5721flat device tree: 5722 5723=> print oftaddr 5724oftaddr=0x300000 5725=> print oft 5726oft=oftrees/mpc8540ads.dtb 5727=> tftp $oftaddr $oft 5728Speed: 1000, full duplex 5729Using TSEC0 device 5730TFTP from server 192.168.1.1; our IP address is 192.168.1.101 5731Filename 'oftrees/mpc8540ads.dtb'. 5732Load address: 0x300000 5733Loading: # 5734done 5735Bytes transferred = 4106 (100a hex) 5736=> tftp $loadaddr $bootfile 5737Speed: 1000, full duplex 5738Using TSEC0 device 5739TFTP from server 192.168.1.1; our IP address is 192.168.1.2 5740Filename 'uImage'. 5741Load address: 0x200000 5742Loading:############ 5743done 5744Bytes transferred = 1029407 (fb51f hex) 5745=> print loadaddr 5746loadaddr=200000 5747=> print oftaddr 5748oftaddr=0x300000 5749=> bootm $loadaddr - $oftaddr 5750## Booting image at 00200000 ... 5751 Image Name: Linux-2.6.17-dirty 5752 Image Type: PowerPC Linux Kernel Image (gzip compressed) 5753 Data Size: 1029343 Bytes = 1005.2 kB 5754 Load Address: 00000000 5755 Entry Point: 00000000 5756 Verifying Checksum ... OK 5757 Uncompressing Kernel Image ... OK 5758Booting using flat device tree at 0x300000 5759Using MPC85xx ADS machine description 5760Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb 5761[snip] 5762 5763 5764More About U-Boot Image Types: 5765------------------------------ 5766 5767U-Boot supports the following image types: 5768 5769 "Standalone Programs" are directly runnable in the environment 5770 provided by U-Boot; it is expected that (if they behave 5771 well) you can continue to work in U-Boot after return from 5772 the Standalone Program. 5773 "OS Kernel Images" are usually images of some Embedded OS which 5774 will take over control completely. Usually these programs 5775 will install their own set of exception handlers, device 5776 drivers, set up the MMU, etc. - this means, that you cannot 5777 expect to re-enter U-Boot except by resetting the CPU. 5778 "RAMDisk Images" are more or less just data blocks, and their 5779 parameters (address, size) are passed to an OS kernel that is 5780 being started. 5781 "Multi-File Images" contain several images, typically an OS 5782 (Linux) kernel image and one or more data images like 5783 RAMDisks. This construct is useful for instance when you want 5784 to boot over the network using BOOTP etc., where the boot 5785 server provides just a single image file, but you want to get 5786 for instance an OS kernel and a RAMDisk image. 5787 5788 "Multi-File Images" start with a list of image sizes, each 5789 image size (in bytes) specified by an "uint32_t" in network 5790 byte order. This list is terminated by an "(uint32_t)0". 5791 Immediately after the terminating 0 follow the images, one by 5792 one, all aligned on "uint32_t" boundaries (size rounded up to 5793 a multiple of 4 bytes). 5794 5795 "Firmware Images" are binary images containing firmware (like 5796 U-Boot or FPGA images) which usually will be programmed to 5797 flash memory. 5798 5799 "Script files" are command sequences that will be executed by 5800 U-Boot's command interpreter; this feature is especially 5801 useful when you configure U-Boot to use a real shell (hush) 5802 as command interpreter. 5803 5804Booting the Linux zImage: 5805------------------------- 5806 5807On some platforms, it's possible to boot Linux zImage. This is done 5808using the "bootz" command. The syntax of "bootz" command is the same 5809as the syntax of "bootm" command. 5810 5811Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply 5812kernel with raw initrd images. The syntax is slightly different, the 5813address of the initrd must be augmented by it's size, in the following 5814format: "<initrd addres>:<initrd size>". 5815 5816 5817Standalone HOWTO: 5818================= 5819 5820One of the features of U-Boot is that you can dynamically load and 5821run "standalone" applications, which can use some resources of 5822U-Boot like console I/O functions or interrupt services. 5823 5824Two simple examples are included with the sources: 5825 5826"Hello World" Demo: 5827------------------- 5828 5829'examples/hello_world.c' contains a small "Hello World" Demo 5830application; it is automatically compiled when you build U-Boot. 5831It's configured to run at address 0x00040004, so you can play with it 5832like that: 5833 5834 => loads 5835 ## Ready for S-Record download ... 5836 ~>examples/hello_world.srec 5837 1 2 3 4 5 6 7 8 9 10 11 ... 5838 [file transfer complete] 5839 [connected] 5840 ## Start Addr = 0x00040004 5841 5842 => go 40004 Hello World! This is a test. 5843 ## Starting application at 0x00040004 ... 5844 Hello World 5845 argc = 7 5846 argv[0] = "40004" 5847 argv[1] = "Hello" 5848 argv[2] = "World!" 5849 argv[3] = "This" 5850 argv[4] = "is" 5851 argv[5] = "a" 5852 argv[6] = "test." 5853 argv[7] = "<NULL>" 5854 Hit any key to exit ... 5855 5856 ## Application terminated, rc = 0x0 5857 5858Another example, which demonstrates how to register a CPM interrupt 5859handler with the U-Boot code, can be found in 'examples/timer.c'. 5860Here, a CPM timer is set up to generate an interrupt every second. 5861The interrupt service routine is trivial, just printing a '.' 5862character, but this is just a demo program. The application can be 5863controlled by the following keys: 5864 5865 ? - print current values og the CPM Timer registers 5866 b - enable interrupts and start timer 5867 e - stop timer and disable interrupts 5868 q - quit application 5869 5870 => loads 5871 ## Ready for S-Record download ... 5872 ~>examples/timer.srec 5873 1 2 3 4 5 6 7 8 9 10 11 ... 5874 [file transfer complete] 5875 [connected] 5876 ## Start Addr = 0x00040004 5877 5878 => go 40004 5879 ## Starting application at 0x00040004 ... 5880 TIMERS=0xfff00980 5881 Using timer 1 5882 tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0 5883 5884Hit 'b': 5885 [q, b, e, ?] Set interval 1000000 us 5886 Enabling timer 5887Hit '?': 5888 [q, b, e, ?] ........ 5889 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0 5890Hit '?': 5891 [q, b, e, ?] . 5892 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0 5893Hit '?': 5894 [q, b, e, ?] . 5895 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0 5896Hit '?': 5897 [q, b, e, ?] . 5898 tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0 5899Hit 'e': 5900 [q, b, e, ?] ...Stopping timer 5901Hit 'q': 5902 [q, b, e, ?] ## Application terminated, rc = 0x0 5903 5904 5905Minicom warning: 5906================ 5907 5908Over time, many people have reported problems when trying to use the 5909"minicom" terminal emulation program for serial download. I (wd) 5910consider minicom to be broken, and recommend not to use it. Under 5911Unix, I recommend to use C-Kermit for general purpose use (and 5912especially for kermit binary protocol download ("loadb" command), and 5913use "cu" for S-Record download ("loads" command). See 5914http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3. 5915for help with kermit. 5916 5917 5918Nevertheless, if you absolutely want to use it try adding this 5919configuration to your "File transfer protocols" section: 5920 5921 Name Program Name U/D FullScr IO-Red. Multi 5922 X kermit /usr/bin/kermit -i -l %l -s Y U Y N N 5923 Y kermit /usr/bin/kermit -i -l %l -r N D Y N N 5924 5925 5926NetBSD Notes: 5927============= 5928 5929Starting at version 0.9.2, U-Boot supports NetBSD both as host 5930(build U-Boot) and target system (boots NetBSD/mpc8xx). 5931 5932Building requires a cross environment; it is known to work on 5933NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also 5934need gmake since the Makefiles are not compatible with BSD make). 5935Note that the cross-powerpc package does not install include files; 5936attempting to build U-Boot will fail because <machine/ansi.h> is 5937missing. This file has to be installed and patched manually: 5938 5939 # cd /usr/pkg/cross/powerpc-netbsd/include 5940 # mkdir powerpc 5941 # ln -s powerpc machine 5942 # cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h 5943 # ${EDIT} powerpc/ansi.h ## must remove __va_list, _BSD_VA_LIST 5944 5945Native builds *don't* work due to incompatibilities between native 5946and U-Boot include files. 5947 5948Booting assumes that (the first part of) the image booted is a 5949stage-2 loader which in turn loads and then invokes the kernel 5950proper. Loader sources will eventually appear in the NetBSD source 5951tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the 5952meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz 5953 5954 5955Implementation Internals: 5956========================= 5957 5958The following is not intended to be a complete description of every 5959implementation detail. However, it should help to understand the 5960inner workings of U-Boot and make it easier to port it to custom 5961hardware. 5962 5963 5964Initial Stack, Global Data: 5965--------------------------- 5966 5967The implementation of U-Boot is complicated by the fact that U-Boot 5968starts running out of ROM (flash memory), usually without access to 5969system RAM (because the memory controller is not initialized yet). 5970This means that we don't have writable Data or BSS segments, and BSS 5971is not initialized as zero. To be able to get a C environment working 5972at all, we have to allocate at least a minimal stack. Implementation 5973options for this are defined and restricted by the CPU used: Some CPU 5974models provide on-chip memory (like the IMMR area on MPC8xx and 5975MPC826x processors), on others (parts of) the data cache can be 5976locked as (mis-) used as memory, etc. 5977 5978 Chris Hallinan posted a good summary of these issues to the 5979 U-Boot mailing list: 5980 5981 Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)? 5982 From: "Chris Hallinan" <clh@net1plus.com> 5983 Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET) 5984 ... 5985 5986 Correct me if I'm wrong, folks, but the way I understand it 5987 is this: Using DCACHE as initial RAM for Stack, etc, does not 5988 require any physical RAM backing up the cache. The cleverness 5989 is that the cache is being used as a temporary supply of 5990 necessary storage before the SDRAM controller is setup. It's 5991 beyond the scope of this list to explain the details, but you 5992 can see how this works by studying the cache architecture and 5993 operation in the architecture and processor-specific manuals. 5994 5995 OCM is On Chip Memory, which I believe the 405GP has 4K. It 5996 is another option for the system designer to use as an 5997 initial stack/RAM area prior to SDRAM being available. Either 5998 option should work for you. Using CS 4 should be fine if your 5999 board designers haven't used it for something that would 6000 cause you grief during the initial boot! It is frequently not 6001 used. 6002 6003 CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere 6004 with your processor/board/system design. The default value 6005 you will find in any recent u-boot distribution in 6006 walnut.h should work for you. I'd set it to a value larger 6007 than your SDRAM module. If you have a 64MB SDRAM module, set 6008 it above 400_0000. Just make sure your board has no resources 6009 that are supposed to respond to that address! That code in 6010 start.S has been around a while and should work as is when 6011 you get the config right. 6012 6013 -Chris Hallinan 6014 DS4.COM, Inc. 6015 6016It is essential to remember this, since it has some impact on the C 6017code for the initialization procedures: 6018 6019* Initialized global data (data segment) is read-only. Do not attempt 6020 to write it. 6021 6022* Do not use any uninitialized global data (or implicitely initialized 6023 as zero data - BSS segment) at all - this is undefined, initiali- 6024 zation is performed later (when relocating to RAM). 6025 6026* Stack space is very limited. Avoid big data buffers or things like 6027 that. 6028 6029Having only the stack as writable memory limits means we cannot use 6030normal global data to share information beween the code. But it 6031turned out that the implementation of U-Boot can be greatly 6032simplified by making a global data structure (gd_t) available to all 6033functions. We could pass a pointer to this data as argument to _all_ 6034functions, but this would bloat the code. Instead we use a feature of 6035the GCC compiler (Global Register Variables) to share the data: we 6036place a pointer (gd) to the global data into a register which we 6037reserve for this purpose. 6038 6039When choosing a register for such a purpose we are restricted by the 6040relevant (E)ABI specifications for the current architecture, and by 6041GCC's implementation. 6042 6043For PowerPC, the following registers have specific use: 6044 R1: stack pointer 6045 R2: reserved for system use 6046 R3-R4: parameter passing and return values 6047 R5-R10: parameter passing 6048 R13: small data area pointer 6049 R30: GOT pointer 6050 R31: frame pointer 6051 6052 (U-Boot also uses R12 as internal GOT pointer. r12 6053 is a volatile register so r12 needs to be reset when 6054 going back and forth between asm and C) 6055 6056 ==> U-Boot will use R2 to hold a pointer to the global data 6057 6058 Note: on PPC, we could use a static initializer (since the 6059 address of the global data structure is known at compile time), 6060 but it turned out that reserving a register results in somewhat 6061 smaller code - although the code savings are not that big (on 6062 average for all boards 752 bytes for the whole U-Boot image, 6063 624 text + 127 data). 6064 6065On Blackfin, the normal C ABI (except for P3) is followed as documented here: 6066 http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface 6067 6068 ==> U-Boot will use P3 to hold a pointer to the global data 6069 6070On ARM, the following registers are used: 6071 6072 R0: function argument word/integer result 6073 R1-R3: function argument word 6074 R9: platform specific 6075 R10: stack limit (used only if stack checking is enabled) 6076 R11: argument (frame) pointer 6077 R12: temporary workspace 6078 R13: stack pointer 6079 R14: link register 6080 R15: program counter 6081 6082 ==> U-Boot will use R9 to hold a pointer to the global data 6083 6084 Note: on ARM, only R_ARM_RELATIVE relocations are supported. 6085 6086On Nios II, the ABI is documented here: 6087 http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf 6088 6089 ==> U-Boot will use gp to hold a pointer to the global data 6090 6091 Note: on Nios II, we give "-G0" option to gcc and don't use gp 6092 to access small data sections, so gp is free. 6093 6094On NDS32, the following registers are used: 6095 6096 R0-R1: argument/return 6097 R2-R5: argument 6098 R15: temporary register for assembler 6099 R16: trampoline register 6100 R28: frame pointer (FP) 6101 R29: global pointer (GP) 6102 R30: link register (LP) 6103 R31: stack pointer (SP) 6104 PC: program counter (PC) 6105 6106 ==> U-Boot will use R10 to hold a pointer to the global data 6107 6108NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope, 6109or current versions of GCC may "optimize" the code too much. 6110 6111Memory Management: 6112------------------ 6113 6114U-Boot runs in system state and uses physical addresses, i.e. the 6115MMU is not used either for address mapping nor for memory protection. 6116 6117The available memory is mapped to fixed addresses using the memory 6118controller. In this process, a contiguous block is formed for each 6119memory type (Flash, SDRAM, SRAM), even when it consists of several 6120physical memory banks. 6121 6122U-Boot is installed in the first 128 kB of the first Flash bank (on 6123TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After 6124booting and sizing and initializing DRAM, the code relocates itself 6125to the upper end of DRAM. Immediately below the U-Boot code some 6126memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN 6127configuration setting]. Below that, a structure with global Board 6128Info data is placed, followed by the stack (growing downward). 6129 6130Additionally, some exception handler code is copied to the low 8 kB 6131of DRAM (0x00000000 ... 0x00001FFF). 6132 6133So a typical memory configuration with 16 MB of DRAM could look like 6134this: 6135 6136 0x0000 0000 Exception Vector code 6137 : 6138 0x0000 1FFF 6139 0x0000 2000 Free for Application Use 6140 : 6141 : 6142 6143 : 6144 : 6145 0x00FB FF20 Monitor Stack (Growing downward) 6146 0x00FB FFAC Board Info Data and permanent copy of global data 6147 0x00FC 0000 Malloc Arena 6148 : 6149 0x00FD FFFF 6150 0x00FE 0000 RAM Copy of Monitor Code 6151 ... eventually: LCD or video framebuffer 6152 ... eventually: pRAM (Protected RAM - unchanged by reset) 6153 0x00FF FFFF [End of RAM] 6154 6155 6156System Initialization: 6157---------------------- 6158 6159In the reset configuration, U-Boot starts at the reset entry point 6160(on most PowerPC systems at address 0x00000100). Because of the reset 6161configuration for CS0# this is a mirror of the onboard Flash memory. 6162To be able to re-map memory U-Boot then jumps to its link address. 6163To be able to implement the initialization code in C, a (small!) 6164initial stack is set up in the internal Dual Ported RAM (in case CPUs 6165which provide such a feature like MPC8xx or MPC8260), or in a locked 6166part of the data cache. After that, U-Boot initializes the CPU core, 6167the caches and the SIU. 6168 6169Next, all (potentially) available memory banks are mapped using a 6170preliminary mapping. For example, we put them on 512 MB boundaries 6171(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash 6172on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is 6173programmed for SDRAM access. Using the temporary configuration, a 6174simple memory test is run that determines the size of the SDRAM 6175banks. 6176 6177When there is more than one SDRAM bank, and the banks are of 6178different size, the largest is mapped first. For equal size, the first 6179bank (CS2#) is mapped first. The first mapping is always for address 61800x00000000, with any additional banks following immediately to create 6181contiguous memory starting from 0. 6182 6183Then, the monitor installs itself at the upper end of the SDRAM area 6184and allocates memory for use by malloc() and for the global Board 6185Info data; also, the exception vector code is copied to the low RAM 6186pages, and the final stack is set up. 6187 6188Only after this relocation will you have a "normal" C environment; 6189until that you are restricted in several ways, mostly because you are 6190running from ROM, and because the code will have to be relocated to a 6191new address in RAM. 6192 6193 6194U-Boot Porting Guide: 6195---------------------- 6196 6197[Based on messages by Jerry Van Baren in the U-Boot-Users mailing 6198list, October 2002] 6199 6200 6201int main(int argc, char *argv[]) 6202{ 6203 sighandler_t no_more_time; 6204 6205 signal(SIGALRM, no_more_time); 6206 alarm(PROJECT_DEADLINE - toSec (3 * WEEK)); 6207 6208 if (available_money > available_manpower) { 6209 Pay consultant to port U-Boot; 6210 return 0; 6211 } 6212 6213 Download latest U-Boot source; 6214 6215 Subscribe to u-boot mailing list; 6216 6217 if (clueless) 6218 email("Hi, I am new to U-Boot, how do I get started?"); 6219 6220 while (learning) { 6221 Read the README file in the top level directory; 6222 Read http://www.denx.de/twiki/bin/view/DULG/Manual; 6223 Read applicable doc/*.README; 6224 Read the source, Luke; 6225 /* find . -name "*.[chS]" | xargs grep -i <keyword> */ 6226 } 6227 6228 if (available_money > toLocalCurrency ($2500)) 6229 Buy a BDI3000; 6230 else 6231 Add a lot of aggravation and time; 6232 6233 if (a similar board exists) { /* hopefully... */ 6234 cp -a board/<similar> board/<myboard> 6235 cp include/configs/<similar>.h include/configs/<myboard>.h 6236 } else { 6237 Create your own board support subdirectory; 6238 Create your own board include/configs/<myboard>.h file; 6239 } 6240 Edit new board/<myboard> files 6241 Edit new include/configs/<myboard>.h 6242 6243 while (!accepted) { 6244 while (!running) { 6245 do { 6246 Add / modify source code; 6247 } until (compiles); 6248 Debug; 6249 if (clueless) 6250 email("Hi, I am having problems..."); 6251 } 6252 Send patch file to the U-Boot email list; 6253 if (reasonable critiques) 6254 Incorporate improvements from email list code review; 6255 else 6256 Defend code as written; 6257 } 6258 6259 return 0; 6260} 6261 6262void no_more_time (int sig) 6263{ 6264 hire_a_guru(); 6265} 6266 6267 6268Coding Standards: 6269----------------- 6270 6271All contributions to U-Boot should conform to the Linux kernel 6272coding style; see the file "Documentation/CodingStyle" and the script 6273"scripts/Lindent" in your Linux kernel source directory. 6274 6275Source files originating from a different project (for example the 6276MTD subsystem) are generally exempt from these guidelines and are not 6277reformated to ease subsequent migration to newer versions of those 6278sources. 6279 6280Please note that U-Boot is implemented in C (and to some small parts in 6281Assembler); no C++ is used, so please do not use C++ style comments (//) 6282in your code. 6283 6284Please also stick to the following formatting rules: 6285- remove any trailing white space 6286- use TAB characters for indentation and vertical alignment, not spaces 6287- make sure NOT to use DOS '\r\n' line feeds 6288- do not add more than 2 consecutive empty lines to source files 6289- do not add trailing empty lines to source files 6290 6291Submissions which do not conform to the standards may be returned 6292with a request to reformat the changes. 6293 6294 6295Submitting Patches: 6296------------------- 6297 6298Since the number of patches for U-Boot is growing, we need to 6299establish some rules. Submissions which do not conform to these rules 6300may be rejected, even when they contain important and valuable stuff. 6301 6302Please see http://www.denx.de/wiki/U-Boot/Patches for details. 6303 6304Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>; 6305see http://lists.denx.de/mailman/listinfo/u-boot 6306 6307When you send a patch, please include the following information with 6308it: 6309 6310* For bug fixes: a description of the bug and how your patch fixes 6311 this bug. Please try to include a way of demonstrating that the 6312 patch actually fixes something. 6313 6314* For new features: a description of the feature and your 6315 implementation. 6316 6317* A CHANGELOG entry as plaintext (separate from the patch) 6318 6319* For major contributions, your entry to the CREDITS file 6320 6321* When you add support for a new board, don't forget to add a 6322 maintainer e-mail address to the boards.cfg file, too. 6323 6324* If your patch adds new configuration options, don't forget to 6325 document these in the README file. 6326 6327* The patch itself. If you are using git (which is *strongly* 6328 recommended) you can easily generate the patch using the 6329 "git format-patch". If you then use "git send-email" to send it to 6330 the U-Boot mailing list, you will avoid most of the common problems 6331 with some other mail clients. 6332 6333 If you cannot use git, use "diff -purN OLD NEW". If your version of 6334 diff does not support these options, then get the latest version of 6335 GNU diff. 6336 6337 The current directory when running this command shall be the parent 6338 directory of the U-Boot source tree (i. e. please make sure that 6339 your patch includes sufficient directory information for the 6340 affected files). 6341 6342 We prefer patches as plain text. MIME attachments are discouraged, 6343 and compressed attachments must not be used. 6344 6345* If one logical set of modifications affects or creates several 6346 files, all these changes shall be submitted in a SINGLE patch file. 6347 6348* Changesets that contain different, unrelated modifications shall be 6349 submitted as SEPARATE patches, one patch per changeset. 6350 6351 6352Notes: 6353 6354* Before sending the patch, run the MAKEALL script on your patched 6355 source tree and make sure that no errors or warnings are reported 6356 for any of the boards. 6357 6358* Keep your modifications to the necessary minimum: A patch 6359 containing several unrelated changes or arbitrary reformats will be 6360 returned with a request to re-formatting / split it. 6361 6362* If you modify existing code, make sure that your new code does not 6363 add to the memory footprint of the code ;-) Small is beautiful! 6364 When adding new features, these should compile conditionally only 6365 (using #ifdef), and the resulting code with the new feature 6366 disabled must not need more memory than the old code without your 6367 modification. 6368 6369* Remember that there is a size limit of 100 kB per message on the 6370 u-boot mailing list. Bigger patches will be moderated. If they are 6371 reasonable and not too big, they will be acknowledged. But patches 6372 bigger than the size limit should be avoided. 6373