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