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