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