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