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