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