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