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