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