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