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