README 106 KB
Newer Older
wdenk's avatar
wdenk committed
1
#
2
# (C) Copyright 2000 - 2004
wdenk's avatar
wdenk committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
#
# See file CREDITS for list of people who contributed to this
# project.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; either version 2 of
# the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston,
# MA 02111-1307 USA
#

Summary:
========

27 28 29 30
This directory contains the source code for U-Boot, a boot loader for
Embedded boards based on PowerPC and ARM processors, which can be
installed in a boot ROM and used to initialize and test the hardware
or to download and run application code.
wdenk's avatar
wdenk committed
31 32

The development of U-Boot is closely related to Linux: some parts of
33 34
the source code originate in the Linux source tree, we have some
header files in common, and special provision has been made to
wdenk's avatar
wdenk committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48
support booting of Linux images.

Some attention has been paid to make this software easily
configurable and extendable. For instance, all monitor commands are
implemented with the same call interface, so that it's very easy to
add new commands. Also, instead of permanently adding rarely used
code (for instance hardware test utilities) to the monitor, you can
load and run it dynamically.


Status:
=======

In general, all boards for which a configuration option exists in the
49
Makefile have been tested to some extent and can be considered
wdenk's avatar
wdenk committed
50 51
"working". In fact, many of them are used in production systems.

52
In case of problems see the CHANGELOG and CREDITS files to find out
wdenk's avatar
wdenk committed
53 54 55 56 57 58
who contributed the specific port.


Where to get help:
==================

59 60 61 62
In case you have questions about, problems with or contributions for
U-Boot you should send a message to the U-Boot mailing list at
<u-boot-users@lists.sourceforge.net>. There is also an archive of
previous traffic on the mailing list - please search the archive
wdenk's avatar
wdenk committed
63 64 65 66 67 68 69 70
before asking FAQ's. Please see
http://lists.sourceforge.net/lists/listinfo/u-boot-users/


Where we come from:
===================

- start from 8xxrom sources
71
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenk's avatar
wdenk committed
72 73 74 75 76 77 78 79
- clean up code
- make it easier to add custom boards
- make it possible to add other [PowerPC] CPUs
- extend functions, especially:
  * Provide extended interface to Linux boot loader
  * S-Record download
  * network boot
  * PCMCIA / CompactFLash / ATA disk / SCSI ... boot
80
- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenk's avatar
wdenk committed
81
- add other CPU families (starting with ARM)
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
- create U-Boot project (http://sourceforge.net/projects/u-boot)


Names and Spelling:
===================

The "official" name of this project is "Das U-Boot". The spelling
"U-Boot" shall be used in all written text (documentation, comments
in source files etc.). Example:

	This is the README file for the U-Boot project.

File names etc. shall be based on the string "u-boot". Examples:

	include/asm-ppc/u-boot.h

	#include <asm/u-boot.h>

Variable names, preprocessor constants etc. shall be either based on
the string "u_boot" or on "U_BOOT". Example:

	U_BOOT_VERSION		u_boot_logo
	IH_OS_U_BOOT		u_boot_hush_start
wdenk's avatar
wdenk committed
105 106


wdenk's avatar
wdenk committed
107 108 109 110 111 112 113 114 115 116 117 118
Versioning:
===========

U-Boot uses a 3 level version number containing a version, a
sub-version, and a patchlevel: "U-Boot-2.34.5" means version "2",
sub-version "34", and patchlevel "4".

The patchlevel is used to indicate certain stages of development
between released versions, i. e. officially released versions of
U-Boot will always have a patchlevel of "0".


wdenk's avatar
wdenk committed
119 120 121
Directory Hierarchy:
====================

wdenk's avatar
wdenk committed
122 123
- board		Board dependent files
- common	Misc architecture independent functions
wdenk's avatar
wdenk committed
124
- cpu		CPU specific files
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
  - 74xx_7xx	Files specific to Motorola MPC74xx and 7xx CPUs
  - arm720t	Files specific to ARM 720 CPUs
  - arm920t	Files specific to ARM 920 CPUs
  - arm925t	Files specific to ARM 925 CPUs
  - arm926ejs	Files specific to ARM 926 CPUs
  - at91rm9200	Files specific to Atmel AT91RM9200 CPUs
  - i386	Files specific to i386 CPUs
  - ixp		Files specific to Intel XScale IXP CPUs
  - mcf52x2	Files specific to Motorola ColdFire MCF52x2 CPUs
  - mips	Files specific to MIPS CPUs
  - mpc5xx	Files specific to Motorola MPC5xx  CPUs
  - mpc5xxx	Files specific to Motorola MPC5xxx CPUs
  - mpc8xx	Files specific to Motorola MPC8xx  CPUs
  - mpc824x	Files specific to Motorola MPC824x CPUs
  - mpc8260	Files specific to Motorola MPC8260 CPUs
  - mpc85xx	Files specific to Motorola MPC85xx CPUs
  - nios	Files specific to Altera NIOS CPUs
  - ppc4xx	Files specific to IBM PowerPC 4xx CPUs
  - pxa		Files specific to Intel XScale PXA CPUs
  - s3c44b0	Files specific to Samsung S3C44B0 CPUs
  - sa1100	Files specific to Intel StrongARM SA1100 CPUs
wdenk's avatar
wdenk committed
146 147
- disk		Code for disk drive partition handling
- doc		Documentation (don't expect too much)
wdenk's avatar
wdenk committed
148
- drivers	Commonly used device drivers
wdenk's avatar
wdenk committed
149 150 151
- dtt		Digital Thermometer and Thermostat drivers
- examples	Example code for standalone applications, etc.
- include	Header Files
152 153 154 155 156 157 158
- lib_arm	Files generic to ARM	 architecture
- lib_generic	Files generic to all	 architectures
- lib_i386	Files generic to i386	 architecture
- lib_m68k	Files generic to m68k	 architecture
- lib_mips	Files generic to MIPS	 architecture
- lib_nios	Files generic to NIOS	 architecture
- lib_ppc	Files generic to PowerPC architecture
wdenk's avatar
wdenk committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
- net		Networking code
- post		Power On Self Test
- rtc		Real Time Clock drivers
- tools		Tools to build S-Record or U-Boot images, etc.

Software Configuration:
=======================

Configuration is usually done using C preprocessor defines; the
rationale behind that is to avoid dead code whenever possible.

There are two classes of configuration variables:

* Configuration _OPTIONS_:
  These are selectable by the user and have names beginning with
  "CONFIG_".

* Configuration _SETTINGS_:
  These depend on the hardware etc. and should not be meddled with if
  you don't know what you're doing; they have names beginning with
  "CFG_".

Later we will add a configuration tool - probably similar to or even
identical to what's used for the Linux kernel. Right now, we have to
do the configuration by hand, which means creating some symbolic
links and editing some configuration files. We use the TQM8xxL boards
as an example here.


Selection of Processor Architecture and Board Type:
---------------------------------------------------

For all supported boards there are ready-to-use default
configurations available; just type "make <board_name>_config".

Example: For a TQM823L module type:

	cd u-boot
	make TQM823L_config

For the Cogent platform, you need to specify the cpu type as well;
e.g. "make cogent_mpc8xx_config". And also configure the cogent
directory according to the instructions in cogent/README.


Configuration Options:
----------------------

Configuration depends on the combination of board and CPU type; all
such information is kept in a configuration file
"include/configs/<board_name>.h".

Example: For a TQM823L module, all configuration settings are in
"include/configs/TQM823L.h".


wdenk's avatar
wdenk committed
215 216 217 218 219
Many of the options are named exactly as the corresponding Linux
kernel configuration options. The intention is to make it easier to
build a config tool - later.


wdenk's avatar
wdenk committed
220 221 222 223 224 225 226
The following options need to be configured:

- CPU Type:	Define exactly one of

		PowerPC based CPUs:
		-------------------
		CONFIG_MPC823,	CONFIG_MPC850,	CONFIG_MPC855,	CONFIG_MPC860
227
	or	CONFIG_MPC5xx
wdenk's avatar
wdenk committed
228
	or	CONFIG_MPC824X, CONFIG_MPC8260
229
	or	CONFIG_MPC85xx
wdenk's avatar
wdenk committed
230 231
	or	CONFIG_IOP480
	or	CONFIG_405GP
232
	or	CONFIG_405EP
wdenk's avatar
wdenk committed
233 234
	or	CONFIG_440
	or	CONFIG_MPC74xx
wdenk's avatar
wdenk committed
235
	or	CONFIG_750FX
wdenk's avatar
wdenk committed
236 237 238 239 240 241 242 243 244 245 246 247 248

		ARM based CPUs:
		---------------
		CONFIG_SA1110
		CONFIG_ARM7
		CONFIG_PXA250


- Board Type:	Define exactly one of

		PowerPC based boards:
		---------------------

wdenk's avatar
wdenk committed
249 250 251 252 253 254 255 256
		CONFIG_ADCIOP,	   CONFIG_ICU862      CONFIG_RPXsuper,
		CONFIG_ADS860,	   CONFIG_IP860,      CONFIG_SM850,
		CONFIG_AMX860,	   CONFIG_IPHASE4539, CONFIG_SPD823TS,
		CONFIG_AR405,	   CONFIG_IVML24,     CONFIG_SXNI855T,
		CONFIG_BAB7xx,	   CONFIG_IVML24_128, CONFIG_Sandpoint8240,
		CONFIG_CANBT,	   CONFIG_IVML24_256, CONFIG_Sandpoint8245,
		CONFIG_CCM,	   CONFIG_IVMS8,      CONFIG_TQM823L,
		CONFIG_CPCI405,	   CONFIG_IVMS8_128,  CONFIG_TQM850L,
wdenk's avatar
wdenk committed
257 258
		CONFIG_CPCI4052,   CONFIG_IVMS8_256,  CONFIG_TQM855L,
		CONFIG_CPCIISER4,  CONFIG_LANTEC,     CONFIG_TQM860L,
wdenk's avatar
wdenk committed
259 260 261
		CONFIG_CPU86,	   CONFIG_MBX,	      CONFIG_TQM8260,
		CONFIG_CRAYL1,	   CONFIG_MBX860T,    CONFIG_TTTech,
		CONFIG_CU824,	   CONFIG_MHPC,	      CONFIG_UTX8245,
wdenk's avatar
wdenk committed
262
		CONFIG_DASA_SIM,   CONFIG_MIP405,     CONFIG_W7OLMC,
wdenk's avatar
wdenk committed
263 264 265 266 267
		CONFIG_DU405,	   CONFIG_MOUSSE,     CONFIG_W7OLMG,
		CONFIG_ELPPC,	   CONFIG_MPC8260ADS, CONFIG_WALNUT405,
		CONFIG_ERIC,	   CONFIG_MUSENKI,    CONFIG_ZUMA,
		CONFIG_ESTEEM192E, CONFIG_MVS1,	      CONFIG_c2mon,
		CONFIG_ETX094,	   CONFIG_NX823,      CONFIG_cogent_mpc8260,
wdenk's avatar
wdenk committed
268
		CONFIG_EVB64260,   CONFIG_OCRTC,      CONFIG_cogent_mpc8xx,
wdenk's avatar
wdenk committed
269 270
		CONFIG_FADS823,	   CONFIG_ORSG,	      CONFIG_ep8260,
		CONFIG_FADS850SAR, CONFIG_OXC,	      CONFIG_gw8260,
wdenk's avatar
wdenk committed
271
		CONFIG_FADS860T,   CONFIG_PCI405,     CONFIG_hermes,
wdenk's avatar
wdenk committed
272 273 274 275 276 277 278 279 280
		CONFIG_FLAGADM,	   CONFIG_PCIPPC2,    CONFIG_hymod,
		CONFIG_FPS850L,	   CONFIG_PCIPPC6,    CONFIG_lwmon,
		CONFIG_GEN860T,	   CONFIG_PIP405,     CONFIG_pcu_e,
		CONFIG_GENIETV,	   CONFIG_PM826,      CONFIG_ppmc8260,
		CONFIG_GTH,	   CONFIG_RPXClassic, CONFIG_rsdproto,
		CONFIG_IAD210,	   CONFIG_RPXlite,    CONFIG_sbc8260,
		CONFIG_EBONY,	   CONFIG_sacsng,     CONFIG_FPS860L,
		CONFIG_V37,	   CONFIG_ELPT860,    CONFIG_CMI,
		CONFIG_NETVIA,	   CONFIG_RBC823,     CONFIG_ZPC1900,
281
		CONFIG_MPC8540ADS, CONFIG_MPC8560ADS, CONFIG_QS850,
wdenk's avatar
wdenk committed
282
		CONFIG_QS823,	   CONFIG_QS860T,     CONFIG_DB64360,
283 284
		CONFIG_DB64460,	   CONFIG_DUET_ADS    CONFIG_NETTA
		CONFIG_NETPHONE
wdenk's avatar
wdenk committed
285 286 287 288

		ARM based boards:
		-----------------

289 290 291 292 293 294
		CONFIG_HHP_CRADLE,  CONFIG_DNP1110,	CONFIG_EP7312,
		CONFIG_IMPA7,	    CONFIG_LART,	CONFIG_LUBBOCK,
		CONFIG_INNOVATOROMAP1510,      CONFIG_INNOVATOROMAP1610,
		CONFIG_H2_OMAP1610, CONFIG_SHANNON,	CONFIG_SMDK2400,
		CONFIG_SMDK2410,    CONFIG_TRAB,	CONFIG_VCMA9,
		CONFIG_AT91RM9200DK
wdenk's avatar
wdenk committed
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317


- CPU Module Type: (if CONFIG_COGENT is defined)
		Define exactly one of
		CONFIG_CMA286_60_OLD
--- FIXME --- not tested yet:
		CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
		CONFIG_CMA287_23, CONFIG_CMA287_50

- Motherboard Type: (if CONFIG_COGENT is defined)
		Define exactly one of
		CONFIG_CMA101, CONFIG_CMA102

- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
		Define one or more of
		CONFIG_CMA302

- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
		Define one or more of
		CONFIG_LCD_HEARTBEAT	- update a character position on
					  the lcd display every second with
					  a "rotator" |\-/|\-/

318 319 320 321
- Board flavour: (if CONFIG_MPC8260ADS is defined)
		CONFIG_ADSTYPE
		Possible values are:
			CFG_8260ADS	- original MPC8260ADS
322
			CFG_8266ADS	- MPC8266ADS
323
			CFG_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
324
			CFG_8272ADS	- MPC8272ADS
325

wdenk's avatar
wdenk committed
326
- MPC824X Family Member (if CONFIG_MPC824X is defined)
327 328
		Define exactly one of
		CONFIG_MPC8240, CONFIG_MPC8245
wdenk's avatar
wdenk committed
329

330
- 8xx CPU Options: (if using an MPC8xx cpu)
wdenk's avatar
wdenk committed
331
		Define one or more of
332 333 334
		CONFIG_8xx_GCLK_FREQ	- if get_gclk_freq() cannot work
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
wdenk's avatar
wdenk committed
335

336 337 338 339 340 341 342 343 344
- 859/866 CPU options: (if using a MPC859 or MPC866 CPU):
		CFG_866_OSCCLK
		CFG_866_CPUCLK_MIN
		CFG_866_CPUCLK_MAX
		CFG_866_CPUCLK_DEFAULT
			See doc/README.MPC866

		CFG_MEASURE_CPUCLK

wdenk's avatar
wdenk committed
345 346 347 348 349 350
		Define this to measure the actual CPU clock instead
		of relying on the correctness of the configured
		values. Mostly useful for board bringup to make sure
		the PLL is locked at the intended frequency. Note
		that this requires a (stable) reference clock (32 kHz
		RTC clock),
351

352
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
353 354 355 356 357 358 359 360 361 362 363 364 365
		CONFIG_CLOCKS_IN_MHZ

		U-Boot stores all clock information in Hz
		internally. For binary compatibility with older Linux
		kernels (which expect the clocks passed in the
		bd_info data to be in MHz) the environment variable
		"clocks_in_mhz" can be defined so that U-Boot
		converts clock data to MHZ before passing it to the
		Linux kernel.
		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
		"clocks_in_mhz=1" is  automatically  included  in  the
		default environment.

366 367 368 369 370 371
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

		When transfering memsize parameter to linux, some versions
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

wdenk's avatar
wdenk committed
372
- Console Interface:
373 374 375 376
		Depending on board, define exactly one serial port
		(like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
		CONFIG_8xx_CONS_SCC1, ...), or switch off the serial
		console by defining CONFIG_8xx_CONS_NONE
wdenk's avatar
wdenk committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393

		Note: if CONFIG_8xx_CONS_NONE is defined, the serial
		port routines must be defined elsewhere
		(i.e. serial_init(), serial_getc(), ...)

		CONFIG_CFB_CONSOLE
		Enables console device for a color framebuffer. Needs following
		defines (cf. smiLynxEM, i8042, board/eltec/bab7xx)
			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
						(default big endian)
			VIDEO_HW_RECTFILL	graphic chip supports
						rectangle fill
						(cf. smiLynxEM)
			VIDEO_HW_BITBLT		graphic chip supports
						bit-blit (cf. smiLynxEM)
			VIDEO_VISIBLE_COLS	visible pixel columns
						(cols=pitch)
wdenk's avatar
wdenk committed
394 395
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
wdenk's avatar
wdenk committed
396 397
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
wdenk's avatar
wdenk committed
398
			VIDEO_FB_ADRS		framebuffer address
wdenk's avatar
wdenk committed
399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
			VIDEO_KBD_INIT_FCT	keyboard int fct
						(i.e. i8042_kbd_init())
			VIDEO_TSTC_FCT		test char fct
						(i.e. i8042_tstc)
			VIDEO_GETC_FCT		get char fct
						(i.e. i8042_getc)
			CONFIG_CONSOLE_CURSOR	cursor drawing on/off
						(requires blink timer
						cf. i8042.c)
			CFG_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
			CONFIG_CONSOLE_TIME	display time/date info in
						upper right corner
						(requires CFG_CMD_DATE)
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
414 415 416
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
wdenk's avatar
wdenk committed
417 418 419 420
			CONFIG_CONSOLE_EXTRA_INFO
						addional board info beside
						the logo

421 422 423
		When CONFIG_CFB_CONSOLE is defined, video console is
		default i/o. Serial console can be forced with
		environment 'console=serial'.
wdenk's avatar
wdenk committed
424

wdenk's avatar
wdenk committed
425 426 427 428
		When CONFIG_SILENT_CONSOLE is defined, all console
		messages (by U-Boot and Linux!) can be silenced with
		the "silent" environment variable. See
		doc/README.silent for more information.
429

wdenk's avatar
wdenk committed
430 431 432 433
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
		CFG_BAUDRATE_TABLE, see below.
434
		CFG_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
435 436 437 438 439 440 441 442 443 444

- Interrupt driven serial port input:
		CONFIG_SERIAL_SOFTWARE_FIFO

		PPC405GP only.
		Use an interrupt handler for receiving data on the
		serial port. It also enables using hardware handshake
		(RTS/CTS) and UART's built-in FIFO. Set the number of
		bytes the interrupt driven input buffer should have.

445 446
		Leave undefined to disable this feature, including
		disable the buffer and hardware handshake.
wdenk's avatar
wdenk committed
447

stroese's avatar
stroese committed
448 449 450 451 452 453 454
- Console UART Number:
		CONFIG_UART1_CONSOLE

		IBM PPC4xx only.
		If defined internal UART1 (and not UART0) is used
		as default U-Boot console.

wdenk's avatar
wdenk committed
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
- Boot Delay:	CONFIG_BOOTDELAY - in seconds
		Delay before automatically booting the default image;
		set to -1 to disable autoboot.

		See doc/README.autoboot for these options that
		work with CONFIG_BOOTDELAY. None are required.
		CONFIG_BOOT_RETRY_TIME
		CONFIG_BOOT_RETRY_MIN
		CONFIG_AUTOBOOT_KEYED
		CONFIG_AUTOBOOT_PROMPT
		CONFIG_AUTOBOOT_DELAY_STR
		CONFIG_AUTOBOOT_STOP_STR
		CONFIG_AUTOBOOT_DELAY_STR2
		CONFIG_AUTOBOOT_STOP_STR2
		CONFIG_ZERO_BOOTDELAY_CHECK
		CONFIG_RESET_TO_RETRY

- Autoboot Command:
		CONFIG_BOOTCOMMAND
		Only needed when CONFIG_BOOTDELAY is enabled;
		define a command string that is automatically executed
		when no character is read on the console interface
		within "Boot Delay" after reset.

		CONFIG_BOOTARGS
480 481 482
		This can be used to pass arguments to the bootm
		command. The value of CONFIG_BOOTARGS goes into the
		environment value "bootargs".
wdenk's avatar
wdenk committed
483 484

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
485 486 487 488
		The value of these goes into the environment as
		"ramboot" and "nfsboot" respectively, and can be used
		as a convenience, when switching between booting from
		ram and nfs.
wdenk's avatar
wdenk committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

- Pre-Boot Commands:
		CONFIG_PREBOOT

		When this option is #defined, the existence of the
		environment variable "preboot" will be checked
		immediately before starting the CONFIG_BOOTDELAY
		countdown and/or running the auto-boot command resp.
		entering interactive mode.

		This feature is especially useful when "preboot" is
		automatically generated or modified. For an example
		see the LWMON board specific code: here "preboot" is
		modified when the user holds down a certain
		combination of keys on the (special) keyboard when
		booting the systems

- Serial Download Echo Mode:
		CONFIG_LOADS_ECHO
		If defined to 1, all characters received during a
		serial download (using the "loads" command) are
		echoed back. This might be needed by some terminal
		emulations (like "cu"), but may as well just take
		time on others. This setting #define's the initial
		value of the "loads_echo" environment variable.

- Kgdb Serial Baudrate: (if CFG_CMD_KGDB is defined)
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
		CFG_BAUDRATE_TABLE, see below.

- Monitor Functions:
		CONFIG_COMMANDS
		Most monitor functions can be selected (or
		de-selected) by adjusting the definition of
		CONFIG_COMMANDS; to select individual functions,
		#define CONFIG_COMMANDS by "OR"ing any of the
		following values:

		#define enables commands:
		-------------------------
		CFG_CMD_ASKENV	* ask for env variable
531
		CFG_CMD_AUTOSCRIPT Autoscript Support
wdenk's avatar
wdenk committed
532 533
		CFG_CMD_BDI	  bdinfo
		CFG_CMD_BEDBUG	  Include BedBug Debugger
wdenk's avatar
wdenk committed
534
		CFG_CMD_BMP	* BMP support
wdenk's avatar
wdenk committed
535 536 537 538 539
		CFG_CMD_BOOTD	  bootd
		CFG_CMD_CACHE	  icache, dcache
		CFG_CMD_CONSOLE	  coninfo
		CFG_CMD_DATE	* support for RTC, date/time...
		CFG_CMD_DHCP	  DHCP support
wdenk's avatar
wdenk committed
540 541 542
		CFG_CMD_DIAG	* Diagnostics
		CFG_CMD_DOC	* Disk-On-Chip Support
		CFG_CMD_DTT	  Digital Therm and Thermostat
wdenk's avatar
wdenk committed
543 544 545 546 547
		CFG_CMD_ECHO	* echo arguments
		CFG_CMD_EEPROM	* EEPROM read/write support
		CFG_CMD_ELF	  bootelf, bootvx
		CFG_CMD_ENV	  saveenv
		CFG_CMD_FDC	* Floppy Disk Support
548
		CFG_CMD_FAT	  FAT partition support
549
		CFG_CMD_FDOS	* Dos diskette Support
wdenk's avatar
wdenk committed
550 551
		CFG_CMD_FLASH	  flinfo, erase, protect
		CFG_CMD_FPGA	  FPGA device initialization support
wdenk's avatar
wdenk committed
552
		CFG_CMD_HWFLOW	* RTS/CTS hw flow control
wdenk's avatar
wdenk committed
553 554 555
		CFG_CMD_I2C	* I2C serial bus support
		CFG_CMD_IDE	* IDE harddisk support
		CFG_CMD_IMI	  iminfo
wdenk's avatar
wdenk committed
556
		CFG_CMD_IMLS	  List all found images
wdenk's avatar
wdenk committed
557 558
		CFG_CMD_IMMAP	* IMMR dump support
		CFG_CMD_IRQ	* irqinfo
559
		CFG_CMD_ITEST	* Integer/string test of 2 values
wdenk's avatar
wdenk committed
560
		CFG_CMD_JFFS2	* JFFS2 Support
wdenk's avatar
wdenk committed
561 562 563 564 565
		CFG_CMD_KGDB	* kgdb
		CFG_CMD_LOADB	  loadb
		CFG_CMD_LOADS	  loads
		CFG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
				  loop, mtest
wdenk's avatar
wdenk committed
566
		CFG_CMD_MISC	  Misc functions like sleep etc
567
		CFG_CMD_MMC	  MMC memory mapped support
wdenk's avatar
wdenk committed
568
		CFG_CMD_MII	  MII utility commands
wdenk's avatar
wdenk committed
569
		CFG_CMD_NAND	* NAND support
wdenk's avatar
wdenk committed
570 571 572
		CFG_CMD_NET	  bootp, tftpboot, rarpboot
		CFG_CMD_PCI	* pciinfo
		CFG_CMD_PCMCIA	* PCMCIA support
wdenk's avatar
wdenk committed
573 574
		CFG_CMD_PING	* send ICMP ECHO_REQUEST to network host
		CFG_CMD_PORTIO	* Port I/O
wdenk's avatar
wdenk committed
575 576
		CFG_CMD_REGINFO * Register dump
		CFG_CMD_RUN	  run command in env variable
wdenk's avatar
wdenk committed
577
		CFG_CMD_SAVES	  save S record dump
wdenk's avatar
wdenk committed
578
		CFG_CMD_SCSI	* SCSI Support
wdenk's avatar
wdenk committed
579
		CFG_CMD_SDRAM	* print SDRAM configuration information
wdenk's avatar
wdenk committed
580 581 582
		CFG_CMD_SETGETDCR Support for DCR Register access (4xx only)
		CFG_CMD_SPI	* SPI serial bus support
		CFG_CMD_USB	* USB support
wdenk's avatar
wdenk committed
583
		CFG_CMD_VFD	* VFD support (TRAB)
wdenk's avatar
wdenk committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
		CFG_CMD_BSP	* Board SPecific functions
		-----------------------------------------------
		CFG_CMD_ALL	all

		CFG_CMD_DFL	Default configuration; at the moment
				this is includes all commands, except
				the ones marked with "*" in the list
				above.

		If you don't define CONFIG_COMMANDS it defaults to
		CFG_CMD_DFL in include/cmd_confdefs.h. A board can
		override the default settings in the respective
		include file.

		EXAMPLE: If you want all functions except of network
		support you can write:

		#define CONFIG_COMMANDS (CFG_CMD_ALL & ~CFG_CMD_NET)


	Note:	Don't enable the "icache" and "dcache" commands
605 606 607 608 609 610 611
		(configuration option CFG_CMD_CACHE) unless you know
		what you (and your U-Boot users) are doing. Data
		cache cannot be enabled on systems like the 8xx or
		8260 (where accesses to the IMMR region must be
		uncached), and it cannot be disabled on all other
		systems where we (mis-) use the data cache to hold an
		initial stack and some data.
wdenk's avatar
wdenk committed
612 613 614 615 616 617 618


		XXX - this list needs to get updated!

- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
wdenk's avatar
wdenk committed
619
		support. There must be support in the platform specific
wdenk's avatar
wdenk committed
620 621 622 623
		code for a watchdog. For the 8xx and 8260 CPUs, the
		SIU Watchdog feature is enabled in the SYPCR
		register.

624 625 626 627 628 629 630
- U-Boot Version:
		CONFIG_VERSION_VARIABLE
		If this variable is defined, an environment variable
		named "ver" is created by U-Boot showing the U-Boot
		version as printed by the "version" command.
		This variable is readonly.

wdenk's avatar
wdenk committed
631 632 633 634 635 636 637 638 639
- Real-Time Clock:

		When CFG_CMD_DATE is selected, the type of the RTC
		has to be selected, too. Define exactly one of the
		following options:

		CONFIG_RTC_MPC8xx	- use internal RTC of MPC8xx
		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
		CONFIG_RTC_MC146818	- use MC146818 RTC
640
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
641
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
642
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
643
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
wdenk's avatar
wdenk committed
644

wdenk's avatar
wdenk committed
645 646 647
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

wdenk's avatar
wdenk committed
648 649
- Timestamp Support:

650 651 652 653
		When CONFIG_TIMESTAMP is selected, the timestamp
		(date and time) of an image is printed by image
		commands like bootm or iminfo. This option is
		automatically enabled when you select CFG_CMD_DATE .
wdenk's avatar
wdenk committed
654 655 656 657 658 659 660 661 662 663

- Partition Support:
		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
		and/or CONFIG_ISO_PARTITION

		If IDE or SCSI support	is  enabled  (CFG_CMD_IDE  or
		CFG_CMD_SCSI) you must configure support for at least
		one partition type as well.

- IDE Reset method:
664 665
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
666

667 668 669 670
		CONFIG_IDE_RESET - is this is defined, IDE Reset will
		be performed by calling the function
			ide_set_reset(int reset)
		which has to be defined in a board specific file
wdenk's avatar
wdenk committed
671 672 673 674 675 676

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

677 678 679 680 681 682 683 684 685 686 687 688
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
		Also look at CFG_64BIT_LBA ,CFG_64BIT_VSPRINTF and CFG_64BIT_STRTOUL
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

		CFG_64BIT_LBA:
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

wdenk's avatar
wdenk committed
689 690 691 692 693 694 695 696 697 698 699 700 701
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

		CFG_SCSI_MAX_LUN [8], CFG_SCSI_MAX_SCSI_ID [7] and
		CFG_SCSI_MAX_DEVICE [CFG_SCSI_MAX_SCSI_ID *
		CFG_SCSI_MAX_LUN] can be adjusted to define the
		maximum numbers of LUNs, SCSI ID's and target
		devices.
		CFG_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)

- NETWORK Support (PCI):
702 703
		CONFIG_E1000
		Support for Intel 8254x gigabit chips.
stroese's avatar
stroese committed
704

wdenk's avatar
wdenk committed
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
		Optional CONFIG_EEPRO100_SROM_WRITE enables eeprom
		write routine for first time initialisation.

		CONFIG_TULIP
		Support for Digital 2114x chips.
		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
		modem chip initialisation (KS8761/QS6611).

		CONFIG_NATSEMI
		Support for National dp83815 chips.

		CONFIG_NS8382X
		Support for National dp8382[01] gigabit chips.

721 722 723 724 725 726 727 728 729 730 731 732
- NETWORK Support (other):

		CONFIG_DRIVER_LAN91C96
		Support for SMSC's LAN91C96 chips.

			CONFIG_LAN91C96_BASE
			Define this to hold the physical address
			of the LAN91C96's I/O space

			CONFIG_LAN91C96_USE_32_BIT
			Define this to enable 32 bit addressing

wdenk's avatar
wdenk committed
733 734
- USB Support:
		At the moment only the UHCI host controller is
735
		supported (PIP405, MIP405, MPC5200); define
wdenk's avatar
wdenk committed
736 737 738 739 740 741 742
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
		end define CONFIG_USB_STORAGE to enable the USB
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
743 744 745 746 747 748 749
		MPC5200 USB requires additional defines:
			CONFIG_USB_CLOCK
				for 528 MHz Clock: 0x0001bbbb
			CONFIG_USB_CONFIG
				for differential drivers: 0x00001000
				for single ended drivers: 0x00005000

wdenk's avatar
wdenk committed
750

751
- MMC Support:
wdenk's avatar
wdenk committed
752 753 754
		The MMC controller on the Intel PXA is supported. To
		enable this define CONFIG_MMC. The MMC can be
		accessed from the boot prompt by mapping the device
755 756
		to physical memory similar to flash. Command line is
		enabled with CFG_CMD_MMC. The MMC driver also works with
wdenk's avatar
wdenk committed
757
		the FAT fs. This is enabled with CFG_CMD_FAT.
758

wdenk's avatar
wdenk committed
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
- Keyboard Support:
		CONFIG_ISA_KEYBOARD

		Define this to enable standard (PC-Style) keyboard
		support

		CONFIG_I8042_KBD
		Standard PC keyboard driver with US (is default) and
		GERMAN key layout (switch via environment 'keymap=de') support.
		Export function i8042_kbd_init, i8042_tstc and i8042_getc
		for cfb_console. Supports cursor blinking.

- Video support:
		CONFIG_VIDEO

		Define this to enable video support (for output to
		video).

		CONFIG_VIDEO_CT69000

		Enable Chips & Technologies 69000 Video chip

		CONFIG_VIDEO_SMI_LYNXEM
wdenk's avatar
wdenk committed
782
		Enable Silicon Motion SMI 712/710/810 Video chip. The
783 784 785 786
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

wdenk's avatar
wdenk committed
787 788
		For the CT69000 and SMI_LYNXEM drivers, videomode is
		selected via environment 'videomode'. Two diferent ways
789 790 791 792 793 794 795 796 797 798 799
		are possible:
		- "videomode=num"   'num' is a standard LiLo mode numbers.
		Following standard modes are supported  (* is default):

		      Colors	640x480 800x600 1024x768 1152x864 1280x1024
		-------------+---------------------------------------------
		      8 bits |	0x301*	0x303	 0x305	  0x161	    0x307
		     15 bits |	0x310	0x313	 0x316	  0x162	    0x319
		     16 bits |	0x311	0x314	 0x317	  0x163	    0x31A
		     24 bits |	0x312	0x315	 0x318	    ?	    0x31B
		-------------+---------------------------------------------
wdenk's avatar
wdenk committed
800 801
		(i.e. setenv videomode 317; saveenv; reset;)

wdenk's avatar
wdenk committed
802
		- "videomode=bootargs" all the video parameters are parsed
803 804 805
		from the bootargs. (See drivers/videomodes.c)


806
		CONFIG_VIDEO_SED13806
807
		Enable Epson SED13806 driver. This driver supports 8bpp
808 809 810
		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
		or CONFIG_VIDEO_SED13806_16BPP

811
- Keyboard Support:
wdenk's avatar
wdenk committed
812
		CONFIG_KEYBOARD
813

wdenk's avatar
wdenk committed
814 815 816 817
		Define this to enable a custom keyboard support.
		This simply calls drv_keyboard_init() which must be
		defined in your board-specific files.
		The only board using this so far is RBC823.
818

wdenk's avatar
wdenk committed
819 820 821 822 823 824
- LCD Support:	CONFIG_LCD

		Define this to enable LCD support (for output to LCD
		display); also select one of the supported displays
		by defining one of these:

wdenk's avatar
wdenk committed
825
		CONFIG_NEC_NL6448AC33:
wdenk's avatar
wdenk committed
826

wdenk's avatar
wdenk committed
827
			NEC NL6448AC33-18. Active, color, single scan.
wdenk's avatar
wdenk committed
828

wdenk's avatar
wdenk committed
829
		CONFIG_NEC_NL6448BC20
wdenk's avatar
wdenk committed
830

wdenk's avatar
wdenk committed
831 832 833 834 835 836
			NEC NL6448BC20-08. 6.5", 640x480.
			Active, color, single scan.

		CONFIG_NEC_NL6448BC33_54

			NEC NL6448BC33-54. 10.4", 640x480.
wdenk's avatar
wdenk committed
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
			Active, color, single scan.

		CONFIG_SHARP_16x9

			Sharp 320x240. Active, color, single scan.
			It isn't 16x9, and I am not sure what it is.

		CONFIG_SHARP_LQ64D341

			Sharp LQ64D341 display, 640x480.
			Active, color, single scan.

		CONFIG_HLD1045

			HLD1045 display, 640x480.
			Active, color, single scan.

		CONFIG_OPTREX_BW

			Optrex	 CBL50840-2 NF-FW 99 22 M5
			or
			Hitachi	 LMG6912RPFC-00T
			or
			Hitachi	 SP14Q002

			320x240. Black & white.

		Normally display is black on white background; define
		CFG_WHITE_ON_BLACK to get it inverted.

wdenk's avatar
wdenk committed
867
- Splash Screen Support: CONFIG_SPLASH_SCREEN
868

wdenk's avatar
wdenk committed
869 870 871 872 873 874 875 876
		If this option is set, the environment is checked for
		a variable "splashimage". If found, the usual display
		of logo, copyright and system information on the LCD
		is supressed and the BMP image at the address
		specified in "splashimage" is loaded instead. The
		console is redirected to the "nulldev", too. This
		allows for a "silent" boot where a splash screen is
		loaded very quickly after power-on.
877

wdenk's avatar
wdenk committed
878 879 880 881 882 883 884
- Compression support:
		CONFIG_BZIP2

		If this option is set, support for bzip2 compressed
		images is included. If not, only uncompressed and gzip
		compressed images are supported.

885 886 887
		NOTE: the bzip2 algorithm requires a lot of RAM, so
		the malloc area (as defined by CFG_MALLOC_LEN) should
		be at least 4MB.
888

wdenk's avatar
wdenk committed
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
- Ethernet address:
		CONFIG_ETHADDR
		CONFIG_ETH2ADDR
		CONFIG_ETH3ADDR

		Define a default value for ethernet address to use
		for the respective ethernet interface, in case this
		is not determined automatically.

- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
		the default ethernet interface, in case this is not
		determined through e.g. bootp.

- Server IP address:
		CONFIG_SERVERIP

		Defines a default value for theIP address of a TFTP
		server to contact when using the "tftboot" command.

- BOOTP Recovery Mode:
		CONFIG_BOOTP_RANDOM_DELAY

		If you have many targets in a network that try to
		boot using BOOTP, you may want to avoid that all
		systems send out BOOTP requests at precisely the same
		moment (which would happen for instance at recovery
		from a power failure, when all systems will try to
		boot, thus flooding the BOOTP server. Defining
		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
		inserted before sending out BOOTP requests. The
		following delays are insterted then:

		1st BOOTP request:	delay 0 ... 1 sec
		2nd BOOTP request:	delay 0 ... 2 sec
		3rd BOOTP request:	delay 0 ... 4 sec
		4th and following
		BOOTP requests:		delay 0 ... 8 sec

930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952
- DHCP Advanced Options:
		CONFIG_BOOTP_MASK

		You can fine tune the DHCP functionality by adding
		these flags to the CONFIG_BOOTP_MASK define:

		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
		serverip from a DHCP server, it is possible that more
		than one DNS serverip is offered to the client.
		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
		serverip will be stored in the additional environment
		variable "dnsip2". The first DNS serverip is always
		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
		is added to the CONFIG_BOOTP_MASK.

		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
		to do a dynamic update of a DNS server. To do this, they
		need the hostname of the DHCP requester.
		If CONFIG_BOOP_SEND_HOSTNAME is added to the
		CONFIG_BOOTP_MASK, the content of the "hostname"
		environment variable is passed as option 12 to
		the DHCP server.

wdenk's avatar
wdenk committed
953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
- Status LED:	CONFIG_STATUS_LED

		Several configurations allow to display the current
		status using a LED. For instance, the LED will blink
		fast while running U-Boot code, stop blinking as
		soon as a reply to a BOOTP request was received, and
		start blinking slow once the Linux kernel is running
		(supported by a status LED driver in the Linux
		kernel). Defining CONFIG_STATUS_LED enables this
		feature in U-Boot.

- CAN Support:	CONFIG_CAN_DRIVER

		Defining CONFIG_CAN_DRIVER enables CAN driver support
		on those systems that support this (optional)
		feature, like the TQM8xxL modules.

- I2C Support:	CONFIG_HARD_I2C | CONFIG_SOFT_I2C

wdenk's avatar
wdenk committed
972
		These enable I2C serial bus commands. Defining either of
973 974
		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
		include the appropriate I2C driver for the selected cpu.
wdenk's avatar
wdenk committed
975

976 977
		This will allow you to use i2c commands at the u-boot
		command line (as long as you set CFG_CMD_I2C in
wdenk's avatar
wdenk committed
978 979
		CONFIG_COMMANDS) and communicate with i2c based realtime
		clock chips. See common/cmd_i2c.c for a description of the
980
		command line interface.
wdenk's avatar
wdenk committed
981

wdenk's avatar
wdenk committed
982
		CONFIG_HARD_I2C selects the CPM hardware driver for I2C.
wdenk's avatar
wdenk committed
983

984
		CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenk's avatar
wdenk committed
985 986
		bit-banging) driver instead of CPM or similar hardware
		support for I2C.
wdenk's avatar
wdenk committed
987

988
		There are several other quantities that must also be
wdenk's avatar
wdenk committed
989
		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenk's avatar
wdenk committed
990

wdenk's avatar
wdenk committed
991
		In both cases you will need to define CFG_I2C_SPEED
992 993 994 995
		to be the frequency (in Hz) at which you wish your i2c bus
		to run and CFG_I2C_SLAVE to be the address of this node (ie
		the cpu's i2c node address).

wdenk's avatar
wdenk committed
996 997 998
		Now, the u-boot i2c code for the mpc8xx (cpu/mpc8xx/i2c.c)
		sets the cpu up as a master node and so its address should
		therefore be cleared to 0 (See, eg, MPC823e User's Manual
999
		p.16-473). So, set CFG_I2C_SLAVE to 0.
wdenk's avatar
wdenk committed
1000

1001
		That's all that's required for CONFIG_HARD_I2C.
wdenk's avatar
wdenk committed
1002

wdenk's avatar
wdenk committed
1003 1004 1005
		If you use the software i2c interface (CONFIG_SOFT_I2C)
		then the following macros need to be defined (examples are
		from include/configs/lwmon.h):
wdenk's avatar
wdenk committed
1006 1007 1008

		I2C_INIT

wdenk's avatar
wdenk committed
1009
		(Optional). Any commands necessary to enable the I2C
1010
		controller or configure ports.
wdenk's avatar
wdenk committed
1011

wdenk's avatar
wdenk committed
1012
		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
wdenk's avatar
wdenk committed
1013

wdenk's avatar
wdenk committed
1014 1015
		I2C_PORT

1016 1017 1018
		(Only for MPC8260 CPU). The I/O port to use (the code
		assumes both bits are on the same port). Valid values
		are 0..3 for ports A..D.
wdenk's avatar
wdenk committed
1019 1020 1021 1022 1023 1024 1025

		I2C_ACTIVE

		The code necessary to make the I2C data line active
		(driven).  If the data line is open collector, this
		define can be null.

wdenk's avatar
wdenk committed
1026 1027
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

wdenk's avatar
wdenk committed
1028 1029 1030 1031 1032 1033
		I2C_TRISTATE

		The code necessary to make the I2C data line tri-stated
		(inactive).  If the data line is open collector, this
		define can be null.

wdenk's avatar
wdenk committed
1034 1035
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

wdenk's avatar
wdenk committed
1036 1037 1038 1039 1040
		I2C_READ

		Code that returns TRUE if the I2C data line is high,
		FALSE if it is low.

wdenk's avatar
wdenk committed
1041 1042
		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)

wdenk's avatar
wdenk committed
1043 1044 1045 1046 1047
		I2C_SDA(bit)

		If <bit> is TRUE, sets the I2C data line high. If it
		is FALSE, it clears it (low).

wdenk's avatar
wdenk committed
1048
		eg: #define I2C_SDA(bit) \
1049
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
wdenk's avatar
wdenk committed
1050
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
wdenk's avatar
wdenk committed
1051

wdenk's avatar
wdenk committed
1052 1053 1054 1055 1056
		I2C_SCL(bit)

		If <bit> is TRUE, sets the I2C clock line high. If it
		is FALSE, it clears it (low).

wdenk's avatar
wdenk committed
1057
		eg: #define I2C_SCL(bit) \
1058
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
wdenk's avatar
wdenk committed
1059
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
wdenk's avatar
wdenk committed
1060

wdenk's avatar
wdenk committed
1061 1062 1063 1064
		I2C_DELAY

		This delay is invoked four times per clock cycle so this
		controls the rate of data transfer.  The data rate thus
wdenk's avatar
wdenk committed
1065
		is 1 / (I2C_DELAY * 4). Often defined to be something
1066 1067
		like:

wdenk's avatar
wdenk committed
1068
		#define I2C_DELAY  udelay(2)
wdenk's avatar
wdenk committed
1069

1070 1071
		CFG_I2C_INIT_BOARD

wdenk's avatar
wdenk committed
1072 1073 1074 1075 1076 1077 1078 1079
		When a board is reset during an i2c bus transfer
		chips might think that the current transfer is still
		in progress. On some boards it is possible to access
		the i2c SCLK line directly, either by using the
		processor pin as a GPIO or by having a second pin
		connected to the bus. If this option is defined a
		custom i2c_init_board() routine in boards/xxx/board.c
		is run early in the boot sequence.
1080

wdenk's avatar
wdenk committed
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
- SPI Support:	CONFIG_SPI

		Enables SPI driver (so far only tested with
		SPI EEPROM, also an instance works with Crystal A/D and
		D/As on the SACSng board)

		CONFIG_SPI_X

		Enables extended (16-bit) SPI EEPROM addressing.
		(symmetrical to CONFIG_I2C_X)

		CONFIG_SOFT_SPI

1094 1095 1096 1097 1098 1099 1100
		Enables a software (bit-bang) SPI driver rather than
		using hardware support. This is a general purpose
		driver that only requires three general I/O port pins
		(two outputs, one input) to function. If this is
		defined, the board configuration must define several
		SPI configuration items (port pins to use, etc). For
		an example, see include/configs/sacsng.h.
wdenk's avatar
wdenk committed
1101

wdenk's avatar
wdenk committed
1102
- FPGA Support: CONFIG_FPGA_COUNT
wdenk's avatar
wdenk committed
1103

wdenk's avatar
wdenk committed
1104
		Specify the number of FPGA devices to support.
wdenk's avatar
wdenk committed
1105

wdenk's avatar
wdenk committed
1106
		CONFIG_FPGA
wdenk's avatar
wdenk committed
1107

wdenk's avatar
wdenk committed
1108 1109
		Used to specify the types of FPGA devices.  For example,
		#define CONFIG_FPGA  CFG_XILINX_VIRTEX2
wdenk's avatar
wdenk committed
1110

wdenk's avatar
wdenk committed
1111
		CFG_FPGA_PROG_FEEDBACK
wdenk's avatar
wdenk committed
1112

wdenk's avatar
wdenk committed
1113
		Enable printing of hash marks during FPGA configuration.
wdenk's avatar
wdenk committed
1114 1115 1116

		CFG_FPGA_CHECK_BUSY

1117 1118 1119 1120
		Enable checks on FPGA configuration interface busy
		status by the configuration function. This option
		will require a board or device specific function to
		be written.
wdenk's avatar
wdenk committed
1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131

		CONFIG_FPGA_DELAY

		If defined, a function that provides delays in the FPGA
		configuration driver.

		CFG_FPGA_CHECK_CTRLC
		Allow Control-C to interrupt FPGA configuration

		CFG_FPGA_CHECK_ERROR

1132 1133 1134 1135
		Check for configuration errors during FPGA bitfile
		loading. For example, abort during Virtex II
		configuration if the INIT_B line goes low (which
		indicated a CRC error).
wdenk's avatar
wdenk committed
1136 1137 1138

		CFG_FPGA_WAIT_INIT

1139 1140 1141 1142
		Maximum time to wait for the INIT_B line to deassert
		after PROB_B has been deasserted during a Virtex II
		FPGA configuration sequence. The default time is 500
		mS.
wdenk's avatar
wdenk committed
1143 1144 1145

		CFG_FPGA_WAIT_BUSY

1146 1147
		Maximum time to wait for BUSY to deassert during
		Virtex II FPGA configuration. The default is 5 mS.
wdenk's avatar
wdenk committed
1148 1149 1150

		CFG_FPGA_WAIT_CONFIG

1151 1152
		Time to wait after FPGA configuration. The default is
		200 mS.
wdenk's avatar
wdenk committed
1153 1154 1155 1156

- Configuration Management:
		CONFIG_IDENT_STRING

1157 1158
		If defined, this string will be added to the U-Boot
		version information (U_BOOT_VERSION)
wdenk's avatar
wdenk committed
1159 1160 1161

- Vendor Parameter Protection:

1162 1163
		U-Boot considers the values of the environment
		variables "serial#" (Board Serial Number) and
wdenk's avatar
wdenk committed
1164
		"ethaddr" (Ethernet Address) to be parameters that
1165 1166 1167 1168 1169
		are set once by the board vendor / manufacturer, and
		protects these variables from casual modification by
		the user. Once set, these variables are read-only,
		and write or delete attempts are rejected. You can
		change this behviour:
wdenk's avatar
wdenk committed
1170 1171 1172

		If CONFIG_ENV_OVERWRITE is #defined in your config
		file, the write protection for vendor parameters is
1173
		completely disabled. Anybody can change or delete
wdenk's avatar
wdenk committed
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
		these parameters.

		Alternatively, if you #define _both_ CONFIG_ETHADDR
		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
		ethernet address is installed in the environment,
		which can be changed exactly ONCE by the user. [The
		serial# is unaffected by this, i. e. it remains
		read-only.]

- Protected RAM:
		CONFIG_PRAM

		Define this variable to enable the reservation of
		"protected RAM", i. e. RAM which is not overwritten
		by U-Boot. Define CONFIG_PRAM to hold the number of
		kB you want to reserve for pRAM. You can overwrite
		this default value by defining an environment
		variable "pram" to the number of kB you want to
		reserve. Note that the board info structure will
		still show the full amount of RAM. If pRAM is
		reserved, a new environment variable "mem" will
		automatically be defined to hold the amount of
		remaining RAM in a form that can be passed as boot
		argument to Linux, for instance like that:

			setenv bootargs ... mem=\$(mem)
			saveenv

		This way you can tell Linux not to use this memory,
		either, which results in a memory region that will
		not be affected by reboots.

		*WARNING* If your board configuration uses automatic
		detection of the RAM size, you must make sure that
		this memory test is non-destructive. So far, the
		following board configurations are known to be
		"pRAM-clean":

			ETX094, IVMS8, IVML24, SPD8xx, TQM8xxL,
			HERMES, IP860, RPXlite, LWMON, LANTEC,
			PCU_E, FLAGADM, TQM8260

- Error Recovery:
		CONFIG_PANIC_HANG

		Define this variable to stop the system in case of a
		fatal error, so that you have to reset it manually.
		This is probably NOT a good idea for an embedded
		system where you want to system to reboot
		automatically as fast as possible, but it may be
		useful during development since you can try to debug
		the conditions that lead to the situation.

		CONFIG_NET_RETRY_COUNT

1229 1230 1231 1232
		This variable defines the number of retries for
		network operations like ARP, RARP, TFTP, or BOOTP
		before giving up the operation. If not defined, a
		default value of 5 is used.
wdenk's avatar
wdenk committed
1233 1234

- Command Interpreter:
1235 1236 1237 1238
		CFG_AUTO_COMPLETE

		Enable auto completion of commands using TAB.

wdenk's avatar
wdenk committed
1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258
		CFG_HUSH_PARSER

		Define this variable to enable the "hush" shell (from
		Busybox) as command line interpreter, thus enabling
		powerful command line syntax like
		if...then...else...fi conditionals or `&&' and '||'
		constructs ("shell scripts").

		If undefined, you get the old, much simpler behaviour
		with a somewhat smaller memory footprint.


		CFG_PROMPT_HUSH_PS2

		This defines the secondary prompt string, which is
		printed when the command interpreter needs more input
		to complete a command. Usually "> ".

	Note:

wdenk's avatar
wdenk committed
1259 1260 1261 1262 1263 1264 1265
		In the current implementation, the local variables
		space and global environment variables space are
		separated. Local variables are those you define by
		simply typing `name=value'. To access a local
		variable later on, you have write `$name' or
		`${name}'; to execute the contents of a variable
		directly type `$name' at the command prompt.
wdenk's avatar
wdenk committed
1266

1267 1268 1269 1270
		Global environment variables are those you use
		setenv/printenv to work with. To run a command stored
		in such a variable, you need to use the run command,
		and you must not use the '$' sign to access them.
wdenk's avatar
wdenk committed
1271 1272 1273 1274 1275 1276 1277

		To store commands and special characters in a
		variable, please use double quotation marks
		surrounding the whole text of the variable, instead
		of the backslashes before semicolons and special
		symbols.

1278
- Default Environment:
wdenk's avatar
wdenk committed
1279 1280
		CONFIG_EXTRA_ENV_SETTINGS

1281 1282
		Define this to contain any number of null terminated
		strings (variable = value pairs) that will be part of
wdenk's avatar
wdenk committed
1283
		the default environment compiled into the boot image.
1284

1285 1286
		For example, place something like this in your
		board's config file:
wdenk's avatar
wdenk committed
1287 1288 1289 1290 1291

		#define CONFIG_EXTRA_ENV_SETTINGS \
			"myvar1=value1\0" \
			"myvar2=value2\0"

1292 1293 1294 1295
		Warning: This method is based on knowledge about the
		internal format how the environment is stored by the
		U-Boot code. This is NOT an official, exported
		interface! Although it is unlikely that this format
wdenk's avatar
wdenk committed
1296
		will change soon, there is no guarantee either.
wdenk's avatar
wdenk committed
1297 1298
		You better know what you are doing here.

1299 1300 1301 1302
		Note: overly (ab)use of the default environment is
		discouraged. Make sure to check other ways to preset
		the environment like the autoscript function or the
		boot command first.
wdenk's avatar
wdenk committed
1303

1304
- DataFlash Support:
1305 1306
		CONFIG_HAS_DATAFLASH

wdenk's avatar
wdenk committed
1307 1308 1309
		Defining this option enables DataFlash features and
		allows to read/write in Dataflash via the standard
		commands cp, md...
1310

wdenk's avatar
wdenk committed
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
- SystemACE Support:
		CONFIG_SYSTEMACE

		Adding this option adds support for Xilinx SystemACE
		chips attached via some sort of local bus. The address
		of the chip must alsh be defined in the
		CFG_SYSTEMACE_BASE macro. For example:

		#define CONFIG_SYSTEMACE
		#define CFG_SYSTEMACE_BASE 0xf0000000

		When SystemACE support is added, the "ace" device type
		becomes available to the fat commands, i.e. fatls.

1325
- Show boot progress:
wdenk's avatar
wdenk committed
1326 1327
		CONFIG_SHOW_BOOT_PROGRESS

1328 1329 1330 1331 1332 1333
		Defining this option allows to add some board-
		specific code (calling a user-provided function
		"show_boot_progress(int)") that enables you to show
		the system's boot progress on some display (for
		example, some LED's) on your board. At the moment,
		the following checkpoints are implemented:
wdenk's avatar
wdenk committed
1334 1335 1336

  Arg	Where			When
    1	common/cmd_bootm.c	before attempting to boot an image
wdenk's avatar
wdenk committed
1337
   -1	common/cmd_bootm.c	Image header has bad	 magic number
wdenk's avatar
wdenk committed
1338
    2	common/cmd_bootm.c	Image header has correct magic number
wdenk's avatar
wdenk committed
1339
   -2	common/cmd_bootm.c	Image header has bad	 checksum
wdenk's avatar
wdenk committed
1340
    3	common/cmd_bootm.c	Image header has correct checksum
wdenk's avatar
wdenk committed
1341
   -3	common/cmd_bootm.c	Image data   has bad	 checksum
wdenk's avatar
wdenk committed
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
    4	common/cmd_bootm.c	Image data   has correct checksum
   -4	common/cmd_bootm.c	Image is for unsupported architecture
    5	common/cmd_bootm.c	Architecture check OK
   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
    6	common/cmd_bootm.c	Image Type check OK
   -6	common/cmd_bootm.c	gunzip uncompression error
   -7	common/cmd_bootm.c	Unimplemented compression type
    7	common/cmd_bootm.c	Uncompression OK
   -8	common/cmd_bootm.c	Wrong Image Type (not kernel, multi, standalone)
    8	common/cmd_bootm.c	Image Type check OK
   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
    9	common/cmd_bootm.c	Start initial ramdisk verification
wdenk's avatar
wdenk committed
1354 1355
  -10	common/cmd_bootm.c	Ramdisk header has bad	   magic number
  -11	common/cmd_bootm.c	Ramdisk header has bad	   checksum
wdenk's avatar
wdenk committed
1356
   10	common/cmd_bootm.c	Ramdisk header is OK
wdenk's avatar
wdenk committed
1357
  -12	common/cmd_bootm.c	Ramdisk data   has bad	   checksum
wdenk's avatar
wdenk committed
1358 1359 1360 1361 1362 1363 1364
   11	common/cmd_bootm.c	Ramdisk data   has correct checksum
   12	common/cmd_bootm.c	Ramdisk verification complete, start loading
  -13	common/cmd_bootm.c	Wrong Image Type (not PPC Linux Ramdisk)
   13	common/cmd_bootm.c	Start multifile image verification
   14	common/cmd_bootm.c	No initial ramdisk, no multifile, continue.
   15	common/cmd_bootm.c	All preparation done, transferring control to OS

1365 1366 1367
  -30	lib_ppc/board.c		Fatal error, hang the system
  -31	post/post.c		POST test failed, detected by post_output_backlog()
  -32	post/post.c		POST test failed, detected by post_run_single()
1368

wdenk's avatar
wdenk committed
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382
   -1	common/cmd_doc.c	Bad usage of "doc" command
   -1	common/cmd_doc.c	No boot device
   -1	common/cmd_doc.c	Unknown Chip ID on boot device
   -1	common/cmd_doc.c	Read Error on boot device
   -1	common/cmd_doc.c	Image header has bad magic number

   -1	common/cmd_ide.c	Bad usage of "ide" command
   -1	common/cmd_ide.c	No boot device
   -1	common/cmd_ide.c	Unknown boot device
   -1	common/cmd_ide.c	Unknown partition table
   -1	common/cmd_ide.c	Invalid partition type
   -1	common/cmd_ide.c	Read Error on boot device
   -1	common/cmd_ide.c	Image header has bad magic number

1383 1384 1385 1386 1387 1388
   -1	common/cmd_nand.c	Bad usage of "nand" command
   -1	common/cmd_nand.c	No boot device
   -1	common/cmd_nand.c	Unknown Chip ID on boot device
   -1	common/cmd_nand.c	Read Error on boot device
   -1	common/cmd_nand.c	Image header has bad magic number

wdenk's avatar
wdenk committed
1389
   -1	common/env_common.c	Environment has a bad CRC, using default
wdenk's avatar
wdenk committed
1390 1391 1392 1393 1394


Modem Support:
--------------

1395
[so far only for SMDK2400 and TRAB boards]
wdenk's avatar
wdenk committed
1396 1397 1398 1399 1400 1401 1402 1403 1404 1405

- Modem support endable:
		CONFIG_MODEM_SUPPORT

- RTS/CTS Flow control enable:
		CONFIG_HWFLOW

- Modem debug support:
		CONFIG_MODEM_SUPPORT_DEBUG

1406 1407
		Enables debugging stuff (char screen[1024], dbg())
		for modem support. Useful only with BDI2000.
wdenk's avatar
wdenk committed
1408

1409 1410
- Interrupt support (PPC):

wdenk's avatar
wdenk committed
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420
		There are common interrupt_init() and timer_interrupt()
		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
		for cpu specific initialization. interrupt_init_cpu()
		should set decrementer_count to appropriate value. If
		cpu resets decrementer automatically after interrupt
		(ppc4xx) it should set decrementer_count to zero.
		timer_interrupt() calls timer_interrupt_cpu() for cpu
		specific handling. If board has watchdog / status_led
		/ other_activity_monitor it works automatically from
		general timer_interrupt().
1421

wdenk's avatar
wdenk committed
1422 1423
- General:

1424 1425 1426 1427 1428 1429 1430
		In the target system modem support is enabled when a
		specific key (key combination) is pressed during
		power-on. Otherwise U-Boot will boot normally
		(autoboot). The key_pressed() fuction is called from
		board_init(). Currently key_pressed() is a dummy
		function, returning 1 and thus enabling modem
		initialization.
wdenk's avatar
wdenk committed
1431

1432 1433 1434 1435
		If there are no modem init strings in the
		environment, U-Boot proceed to autoboot; the
		previous output (banner, info printfs) will be
		supressed, though.
wdenk's avatar
wdenk committed
1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462

		See also: doc/README.Modem


Configuration Settings:
-----------------------

- CFG_LONGHELP: Defined when you want long help messages included;
		undefine this when you're short of memory.

- CFG_PROMPT:	This is what U-Boot prints on the console to
		prompt for user input.

- CFG_CBSIZE:	Buffer size for input from the Console

- CFG_PBSIZE:	Buffer size for Console output

- CFG_MAXARGS:	max. Number of arguments accepted for monitor commands

- CFG_BARGSIZE: Buffer size for Boot Arguments which are passed to
		the application (usually a Linux kernel) when it is
		booted

- CFG_BAUDRATE_TABLE:
		List of legal baudrate settings for this board.

- CFG_CONSOLE_INFO_QUIET
wdenk's avatar
wdenk committed
1463
		Suppress display of console information at boot.
wdenk's avatar
wdenk committed
1464 1465

- CFG_CONSOLE_IS_IN_ENV
wdenk's avatar
wdenk committed
1466 1467 1468
		If the board specific function
			extern int overwrite_console (void);
		returns 1, the stdin, stderr and stdout are switched to the
wdenk's avatar
wdenk committed
1469 1470 1471
		serial port, else the settings in the environment are used.

- CFG_CONSOLE_OVERWRITE_ROUTINE
wdenk's avatar
wdenk committed
1472
		Enable the call to overwrite_console().
wdenk's avatar
wdenk committed
1473 1474 1475 1476 1477 1478 1479 1480 1481

- CFG_CONSOLE_ENV_OVERWRITE
		Enable overwrite of previous console environment settings.

- CFG_MEMTEST_START, CFG_MEMTEST_END:
		Begin and End addresses of the area used by the
		simple memory test.

- CFG_ALT_MEMTEST:
wdenk's avatar
wdenk committed
1482
		Enable an alternate, more extensive memory test.
wdenk's avatar
wdenk committed
1483

1484 1485 1486 1487
- CFG_MEMTEST_SCRATCH:
		Scratch address used by the alternate memory test
		You only need to set this if address zero isn't writeable

wdenk's avatar
wdenk committed
1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510
- CFG_TFTP_LOADADDR:
		Default load address for network file downloads

- CFG_LOADS_BAUD_CHANGE:
		Enable temporary baudrate change while serial download

- CFG_SDRAM_BASE:
		Physical start address of SDRAM. _Must_ be 0 here.

- CFG_MBIO_BASE:
		Physical start address of Motherboard I/O (if using a
		Cogent motherboard)

- CFG_FLASH_BASE:
		Physical start address of Flash memory.

- CFG_MONITOR_BASE:
		Physical start address of boot monitor code (set by
		make config files to be same as the text base address
		(TEXT_BASE) used when linking) - same as
		CFG_FLASH_BASE when booting from flash.

- CFG_MONITOR_LEN:
wdenk's avatar
wdenk committed
1511 1512 1513 1514
		Size of memory reserved for monitor code, used to
		determine _at_compile_time_ (!) if the environment is
		embedded within the U-Boot image, or in a separate
		flash sector.
wdenk's avatar
wdenk committed
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536

- CFG_MALLOC_LEN:
		Size of DRAM reserved for malloc() use.

- CFG_BOOTMAPSZ:
		Maximum size of memory mapped by the startup code of
		the Linux kernel; all data that must be processed by
		the Linux kernel (bd_info, boot arguments, eventually
		initrd image) must be put below this limit.

- CFG_MAX_FLASH_BANKS:
		Max number of Flash memory banks

- CFG_MAX_FLASH_SECT:
		Max number of sectors on a Flash chip

- CFG_FLASH_ERASE_TOUT:
		Timeout for Flash erase operations (in ms)

- CFG_FLASH_WRITE_TOUT:
		Timeout for Flash write operations (in ms)

1537 1538 1539 1540 1541 1542 1543 1544 1545 1546
- CFG_FLASH_LOCK_TOUT
		Timeout for Flash set sector lock bit operation (in ms)

- CFG_FLASH_UNLOCK_TOUT
		Timeout for Flash clear lock bits operation (in ms)

- CFG_FLASH_PROTECTION
		If defined, hardware flash sectors protection is used
		instead of U-Boot software protection.

wdenk's avatar
wdenk committed
1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560
- CFG_DIRECT_FLASH_TFTP:

		Enable TFTP transfers directly to flash memory;
		without this option such a download has to be
		performed in two steps: (1) download to RAM, and (2)
		copy from RAM to flash.

		The two-step approach is usually more reliable, since
		you can check if the download worked before you erase
		the flash, but in some situations (when sytem RAM is
		too limited to allow for a tempory copy of the
		downloaded image) this option may be very useful.

- CFG_FLASH_CFI:
1561
		Define if the flash driver uses extra elements in the
1562 1563 1564 1565 1566
		common flash structure for storing flash geometry.

- CFG_FLASH_CFI_DRIVER
		This option also enables the building of the cfi_flash driver
		in the drivers directory
wdenk's avatar
wdenk committed
1567

stroese's avatar
stroese committed
1568 1569 1570 1571 1572 1573 1574 1575
- CFG_RX_ETH_BUFFER:
		Defines the number of ethernet receive buffers. On some
		ethernet controllers it is recommended to set this value
		to 8 or even higher (EEPRO100 or 405 EMAC), since all
		buffers can be full shortly after enabling the interface
		on high ethernet traffic.
		Defaults to 4 if not defined.

wdenk's avatar
wdenk committed
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
The following definitions that deal with the placement and management
of environment data (variable area); in general, we support the
following configurations:

- CFG_ENV_IS_IN_FLASH:

	Define this if the environment is in flash memory.

	a) The environment occupies one whole flash sector, which is
	   "embedded" in the text segment with the U-Boot code. This
	   happens usually with "bottom boot sector" or "top boot
	   sector" type flash chips, which have several smaller
	   sectors at the start or the end. For instance, such a
	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
	   such a case you would place the environment in one of the
	   4 kB sectors - with U-Boot code before and after it. With
	   "top boot sector" type flash chips, you would put the
	   environment in one of the last sectors, leaving a gap
	   between U-Boot and the environment.

	- CFG_ENV_OFFSET:

	   Offset of environment data (variable area) to the
	   beginning of flash memory; for instance, with bottom boot
	   type flash chips the second sector can be used: the offset
	   for this sector is given here.

	   CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.

	- CFG_ENV_ADDR:

	   This is just another way to specify the start address of
	   the flash sector containing the environment (instead of
	   CFG_ENV_OFFSET).

	- CFG_ENV_SECT_SIZE:

	   Size of the sector containing the environment.


	b) Sometimes flash chips have few, equal sized, BIG sectors.
	   In such a case you don't want to spend a whole sector for
	   the environment.

	- CFG_ENV_SIZE:

	   If you use this in combination with CFG_ENV_IS_IN_FLASH
	   and CFG_ENV_SECT_SIZE, you can specify to use only a part
	   of this flash sector for the environment. This saves
	   memory for the RAM copy of the environment.

	   It may also save flash memory if you decide to use this
	   when your environment is "embedded" within U-Boot code,
	   since then the remainder of the flash sector could be used
	   for U-Boot code. It should be pointed out that this is
	   STRONGLY DISCOURAGED from a robustness point of view:
	   updating the environment in flash makes it always
	   necessary to erase the WHOLE sector. If something goes
	   wrong before the contents has been restored from a copy in
	   RAM, your target system will be dead.

	- CFG_ENV_ADDR_REDUND
	  CFG_ENV_SIZE_REDUND

1640 1641
	   These settings describe a second storage area used to hold
	   a redundand copy of the environment data, so that there is
1642
	   a valid backup copy in case there is a power failure during
1643
	   a "saveenv" operation.
wdenk's avatar
wdenk committed
1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696

BE CAREFUL! Any changes to the flash layout, and some changes to the
source code will make it necessary to adapt <board>/u-boot.lds*
accordingly!


- CFG_ENV_IS_IN_NVRAM:

	Define this if you have some non-volatile memory device
	(NVRAM, battery buffered SRAM) which you want to use for the
	environment.

	- CFG_ENV_ADDR:
	- CFG_ENV_SIZE:

	  These two #defines are used to determin the memory area you
	  want to use for environment. It is assumed that this memory
	  can just be read and written to, without any special
	  provision.

BE CAREFUL! The first access to the environment happens quite early
in U-Boot initalization (when we try to get the setting of for the
console baudrate). You *MUST* have mappend your NVRAM area then, or
U-Boot will hang.

Please note that even with NVRAM we still use a copy of the
environment in RAM: we could work on NVRAM directly, but we want to
keep settings there always unmodified except somebody uses "saveenv"
to save the current settings.


- CFG_ENV_IS_IN_EEPROM:

	Use this if you have an EEPROM or similar serial access
	device and a driver for it.

	- CFG_ENV_OFFSET:
	- CFG_ENV_SIZE:

	  These two #defines specify the offset and size of the
	  environment area within the total memory of your EEPROM.

	- CFG_I2C_EEPROM_ADDR:
	  If defined, specified the chip address of the EEPROM device.
	  The default address is zero.

	- CFG_EEPROM_PAGE_WRITE_BITS:
	  If defined, the number of bits used to address bytes in a
	  single page in the EEPROM device.  A 64 byte page, for example
	  would require six bits.

	- CFG_EEPROM_PAGE_WRITE_DELAY_MS:
	  If defined, the number of milliseconds to delay between
wdenk's avatar
wdenk committed
1697
	  page writes.	The default is zero milliseconds.
wdenk's avatar
wdenk committed
1698 1699 1700 1701 1702 1703 1704 1705 1706

	- CFG_I2C_EEPROM_ADDR_LEN:
	  The length in bytes of the EEPROM memory array address.  Note
	  that this is NOT the chip address length!

	- CFG_EEPROM_SIZE:
	  The size in bytes of the EEPROM device.


1707 1708
- CFG_ENV_IS_IN_DATAFLASH:

wdenk's avatar
wdenk committed
1709
	Define this if you have a DataFlash memory device which you
1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720
	want to use for the environment.

	- CFG_ENV_OFFSET:
	- CFG_ENV_ADDR:
	- CFG_ENV_SIZE:

	  These three #defines specify the offset and size of the
	  environment area within the total memory of your DataFlash placed
	  at the specified address.


wdenk's avatar
wdenk committed
1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735
- CFG_SPI_INIT_OFFSET

	Defines offset to the initial SPI buffer area in DPRAM. The
	area is used at an early stage (ROM part) if the environment
	is configured to reside in the SPI EEPROM: We need a 520 byte
	scratch DPRAM area. It is used between the two initialization
	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
	to be a good choice since it makes it far enough from the
	start of the data area as well as from the stack pointer.

Please note that the environment is read-only as long as the monitor
has been relocated to RAM and a RAM copy of the environment has been
created; also, when using EEPROM you will have to use getenv_r()
until then to read environment variables.

1736 1737 1738 1739 1740 1741
The environment is protected by a CRC32 checksum. Before the monitor
is relocated into RAM, as a result of a bad CRC you will be working
with the compiled-in default environment - *silently*!!! [This is
necessary, because the first environment variable we need is the
"baudrate" setting for the console - if we have a bad CRC, we don't
have any device yet where we could complain.]
wdenk's avatar
wdenk committed
1742 1743 1744

Note: once the monitor has been relocated, then it will complain if
the default environment is used; a new CRC is computed as soon as you
1745
use the "saveenv" command to store a valid environment.
wdenk's avatar
wdenk committed
1746

1747
- CFG_FAULT_ECHO_LINK_DOWN:
1748
		Echo the inverted Ethernet link state to the fault LED.
1749 1750 1751 1752 1753

		Note: If this option is active, then CFG_FAULT_MII_ADDR
		      also needs to be defined.

- CFG_FAULT_MII_ADDR:
1754
		MII address of the PHY to check for the Ethernet link state.
wdenk's avatar
wdenk committed
1755

1756 1757 1758 1759 1760 1761 1762
- CFG_64BIT_VSPRINTF:
		Makes vsprintf (and all *printf functions) support printing
		of 64bit values by using the L quantifier

- CFG_64BIT_STRTOUL:
		Adds simple_strtoull that returns a 64bit value

wdenk's avatar
wdenk committed
1763
Low Level (hardware related) configuration options:
1764
---------------------------------------------------
wdenk's avatar
wdenk committed
1765 1766 1767 1768 1769 1770

- CFG_CACHELINE_SIZE:
		Cache Line Size of the CPU.

- CFG_DEFAULT_IMMR:
		Default address of the IMMR after system reset.
1771

1772 1773 1774
		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
		and RPXsuper) to be able to adjust the position of
		the IMMR register after a reset.
wdenk's avatar
wdenk committed
1775

wdenk's avatar
wdenk committed
1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787
- Floppy Disk Support:
		CFG_FDC_DRIVE_NUMBER

		the default drive number (default value 0)

		CFG_ISA_IO_STRIDE

		defines the spacing between fdc chipset registers
		(default value 1)

		CFG_ISA_IO_OFFSET

1788 1789 1790
		defines the offset of register from address. It
		depends on which part of the data bus is connected to
		the fdc chipset. (default value 0)
wdenk's avatar
wdenk committed
1791

1792 1793 1794
		If CFG_ISA_IO_STRIDE CFG_ISA_IO_OFFSET and
		CFG_FDC_DRIVE_NUMBER are undefined, they take their
		default value.
wdenk's avatar
wdenk committed
1795

1796 1797 1798 1799 1800
		if CFG_FDC_HW_INIT is defined, then the function
		fdc_hw_init() is called at the beginning of the FDC
		setup. fdc_hw_init() must be provided by the board
		source code. It is used to make hardware dependant
		initializations.
wdenk's avatar
wdenk committed
1801

wdenk's avatar
wdenk committed
1802 1803 1804 1805 1806 1807
- CFG_IMMR:	Physical address of the Internal Memory Mapped
		Register; DO NOT CHANGE! (11-4)
		[MPC8xx systems only]

- CFG_INIT_RAM_ADDR:

wdenk's avatar
wdenk committed
1808
		Start address of memory area that can be used for
wdenk's avatar
wdenk committed
1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820
		initial data and stack; please note that this must be
		writable memory that is working WITHOUT special
		initialization, i. e. you CANNOT use normal RAM which
		will become available only after programming the
		memory controller and running certain initialization
		sequences.

		U-Boot uses the following memory types:
		- MPC8xx and MPC8260: IMMR (internal memory of the CPU)
		- MPC824X: data cache
		- PPC4xx:  data cache

1821
- CFG_GBL_DATA_OFFSET:
wdenk's avatar
wdenk committed
1822 1823 1824

		Offset of the initial data structure in the memory
		area defined by CFG_INIT_RAM_ADDR. Usually
1825
		CFG_GBL_DATA_OFFSET is chosen such that the initial
wdenk's avatar
wdenk committed
1826 1827 1828 1829
		data is located at the end of the available space
		(sometimes written as (CFG_INIT_RAM_END -
		CFG_INIT_DATA_SIZE), and the initial stack is just
		below that area (growing from (CFG_INIT_RAM_ADDR +
1830
		CFG_GBL_DATA_OFFSET) downward.
wdenk's avatar
wdenk committed
1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887

	Note:
		On the MPC824X (or other systems that use the data
		cache for initial memory) the address chosen for
		CFG_INIT_RAM_ADDR is basically arbitrary - it must
		point to an otherwise UNUSED address space between
		the top of RAM and the start of the PCI space.

- CFG_SIUMCR:	SIU Module Configuration (11-6)

- CFG_SYPCR:	System Protection Control (11-9)

- CFG_TBSCR:	Time Base Status and Control (11-26)

- CFG_PISCR:	Periodic Interrupt Status and Control (11-31)

- CFG_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)

- CFG_SCCR:	System Clock and reset Control Register (15-27)

- CFG_OR_TIMING_SDRAM:
		SDRAM timing

- CFG_MAMR_PTA:
		periodic timer for refresh

- CFG_DER:	Debug Event Register (37-47)

- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CFG_REMAP_OR_AM,
  CFG_PRELIM_OR_AM, CFG_OR_TIMING_FLASH, CFG_OR0_REMAP,
  CFG_OR0_PRELIM, CFG_BR0_PRELIM, CFG_OR1_REMAP, CFG_OR1_PRELIM,
  CFG_BR1_PRELIM:
		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)

- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
  CFG_OR_TIMING_SDRAM, CFG_OR2_PRELIM, CFG_BR2_PRELIM,
  CFG_OR3_PRELIM, CFG_BR3_PRELIM:
		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)

- CFG_MAMR_PTA, CFG_MPTPR_2BK_4K, CFG_MPTPR_1BK_4K, CFG_MPTPR_2BK_8K,
  CFG_MPTPR_1BK_8K, CFG_MAMR_8COL, CFG_MAMR_9COL:
		Machine Mode Register and Memory Periodic Timer
		Prescaler definitions (SDRAM timing)

- CFG_I2C_UCODE_PATCH, CFG_I2C_DPMEM_OFFSET [0x1FC0]:
		enable I2C microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [DSP2]

- CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
		enable SPI microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [SCC4]

- CFG_USE_OSCCLK:
		Use OSCM clock mode on MBX8xx board. Be careful,
		wrong setting might damage your board. Read
		doc/README.MBX before setting this variable!

1888
- CFG_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
1889 1890 1891 1892
		Offset of the bootmode word in DPRAM used by post
		(Power On Self Tests). This definition overrides
		#define'd default value in commproc.h resp.
		cpm_8260.h.
1893

stroese's avatar
stroese committed
1894 1895 1896 1897 1898 1899 1900
- CFG_PCI_SLV_MEM_LOCAL, CFG_PCI_SLV_MEM_BUS, CFG_PICMR0_MASK_ATTRIB,
  CFG_PCI_MSTR0_LOCAL, CFG_PCIMSK0_MASK, CFG_PCI_MSTR1_LOCAL,
  CFG_PCIMSK1_MASK, CFG_PCI_MSTR_MEM_LOCAL, CFG_PCI_MSTR_MEM_BUS,
  CFG_CPU_PCI_MEM_START, CFG_PCI_MSTR_MEM_SIZE, CFG_POCMR0_MASK_ATTRIB,
  CFG_PCI_MSTR_MEMIO_LOCAL, CFG_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
  CFG_PCI_MSTR_MEMIO_SIZE, CFG_POCMR1_MASK_ATTRIB, CFG_PCI_MSTR_IO_LOCAL,
  CFG_PCI_MSTR_IO_BUS, CFG_CPU_PCI_IO_START, CFG_PCI_MSTR_IO_SIZE,
wdenk's avatar
wdenk committed
1901 1902 1903
  CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
		Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.

wdenk's avatar
wdenk committed
1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921
Building the Software:
======================

Building U-Boot has been tested in native PPC environments (on a
PowerBook G3 running LinuxPPC 2000) and in cross environments
(running RedHat 6.x and 7.x Linux on x86, Solaris 2.6 on a SPARC, and
NetBSD 1.5 on x86).

If you are not using a native PPC environment, it is assumed that you
have the GNU cross compiling tools available in your path and named
with a prefix of "powerpc-linux-". If this is not the case, (e.g. if
you are using Monta Vista's Hard Hat Linux CDK 1.2) you must change
the definition of CROSS_COMPILE in Makefile. For HHL on a 4xx CPU,
change it to:

	CROSS_COMPILE = ppc_4xx-