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