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