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