README 140 KB
Newer Older
wdenk's avatar
wdenk committed
1
#
2
# (C) Copyright 2000 - 2008
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
This directory contains the source code for U-Boot, a boot loader for
wdenk's avatar
wdenk committed
28 29 30 31
Embedded boards based on PowerPC, ARM, MIPS and several other
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
32 33

The development of U-Boot is closely related to Linux: some parts of
34 35
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
36 37 38 39 40 41 42 43 44 45 46 47 48 49
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
50
Makefile have been tested to some extent and can be considered
wdenk's avatar
wdenk committed
51 52
"working". In fact, many of them are used in production systems.

53
In case of problems see the CHANGELOG and CREDITS files to find out
54 55
who contributed the specific port. The MAINTAINERS file lists board
maintainers.
wdenk's avatar
wdenk committed
56 57 58 59 60


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

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
63 64 65 66
<u-boot@lists.denx.de>. There is also an archive of previous traffic
on the mailing list - please search the archive before asking FAQ's.
Please see http://lists.denx.de/pipermail/u-boot and
http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenk's avatar
wdenk committed
67 68


69 70 71 72 73 74 75 76
Where to get source code:
=========================

The U-Boot source code is maintained in the git repository at
git://www.denx.de/git/u-boot.git ; you can browse it online at
http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary

The "snapshot" links on this page allow you to download tarballs of
77
any version you might be interested in. Official releases are also
78 79 80
available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
directory.

81
Pre-built (and tested) images are available from
82 83 84
ftp://ftp.denx.de/pub/u-boot/images/


wdenk's avatar
wdenk committed
85 86 87 88
Where we come from:
===================

- start from 8xxrom sources
89
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenk's avatar
wdenk committed
90 91 92 93 94 95 96
- 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
97
  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
98
- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenk's avatar
wdenk committed
99
- add other CPU families (starting with ARM)
100
- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja's avatar
Magnus Lilja committed
101
- current project page: see http://www.denx.de/wiki/U-Boot
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123


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
124 125


wdenk's avatar
wdenk committed
126 127 128 129 130 131 132 133 134 135 136 137
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
138 139 140
Directory Hierarchy:
====================

wdenk's avatar
wdenk committed
141 142
- board		Board dependent files
- common	Misc architecture independent functions
wdenk's avatar
wdenk committed
143
- cpu		CPU specific files
wdenk's avatar
wdenk committed
144
  - 74xx_7xx	Files specific to Freescale MPC74xx and 7xx CPUs
wdenk's avatar
wdenk committed
145 146
  - arm720t	Files specific to ARM 720 CPUs
  - arm920t	Files specific to ARM 920 CPUs
wdenk's avatar
wdenk committed
147
    - at91rm9200 Files specific to Atmel AT91RM9200 CPU
wdenk's avatar
wdenk committed
148
    - imx	Files specific to Freescale MC9328 i.MX CPUs
wdenk's avatar
wdenk committed
149
    - s3c24x0	Files specific to Samsung S3C24X0 CPUs
wdenk's avatar
wdenk committed
150 151
  - arm925t	Files specific to ARM 925 CPUs
  - arm926ejs	Files specific to ARM 926 CPUs
152
  - arm1136	Files specific to ARM 1136 CPUs
153
  - at32ap	Files specific to Atmel AVR32 AP CPUs
154
  - blackfin	Files specific to Analog Devices Blackfin CPUs
wdenk's avatar
wdenk committed
155 156
  - i386	Files specific to i386 CPUs
  - ixp		Files specific to Intel XScale IXP CPUs
157
  - leon2	Files specific to Gaisler LEON2 SPARC CPU
158
  - leon3	Files specific to Gaisler LEON3 SPARC CPU
wdenk's avatar
wdenk committed
159
  - mcf52x2	Files specific to Freescale ColdFire MCF52x2 CPUs
160
  - mcf5227x	Files specific to Freescale ColdFire MCF5227x CPUs
161
  - mcf532x	Files specific to Freescale ColdFire MCF5329 CPUs
162
  - mcf5445x	Files specific to Freescale ColdFire MCF5445x CPUs
163
  - mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
wdenk's avatar
wdenk committed
164
  - mips	Files specific to MIPS CPUs
wdenk's avatar
wdenk committed
165 166 167 168 169 170 171
  - mpc5xx	Files specific to Freescale MPC5xx  CPUs
  - mpc5xxx	Files specific to Freescale MPC5xxx CPUs
  - mpc8xx	Files specific to Freescale MPC8xx  CPUs
  - mpc8220	Files specific to Freescale MPC8220 CPUs
  - mpc824x	Files specific to Freescale MPC824x CPUs
  - mpc8260	Files specific to Freescale MPC8260 CPUs
  - mpc85xx	Files specific to Freescale MPC85xx CPUs
wdenk's avatar
wdenk committed
172
  - nios	Files specific to Altera NIOS CPUs
wdenk's avatar
wdenk committed
173
  - nios2	Files specific to Altera Nios-II CPUs
Wolfgang Denk's avatar
Wolfgang Denk committed
174
  - ppc4xx	Files specific to AMCC PowerPC 4xx CPUs
wdenk's avatar
wdenk committed
175 176 177
  - 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
178 179
- disk		Code for disk drive partition handling
- doc		Documentation (don't expect too much)
wdenk's avatar
wdenk committed
180
- drivers	Commonly used device drivers
wdenk's avatar
wdenk committed
181 182 183
- dtt		Digital Thermometer and Thermostat drivers
- examples	Example code for standalone applications, etc.
- include	Header Files
wdenk's avatar
wdenk committed
184
- lib_arm	Files generic to ARM	 architecture
Wolfgang Denk's avatar
Wolfgang Denk committed
185
- lib_avr32	Files generic to AVR32	 architecture
186
- lib_blackfin	Files generic to Blackfin architecture
wdenk's avatar
wdenk committed
187 188 189 190 191 192
- 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
193
- lib_sparc	Files generic to SPARC	 architecture
194
- libfdt	Library files to support flattened device trees
wdenk's avatar
wdenk committed
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
215
  "CONFIG_SYS_".
wdenk's avatar
wdenk committed
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

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

235
For the Cogent platform, you need to specify the CPU type as well;
wdenk's avatar
wdenk committed
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
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
251 252 253 254 255
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
256 257
The following options need to be configured:

258 259 260
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
261 262

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
263
		Define exactly one, e.g. CONFIG_ATSTK1002
wdenk's avatar
wdenk committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

- 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
283
					  the LCD display every second with
wdenk's avatar
wdenk committed
284 285
					  a "rotator" |\-/|\-/

wdenk's avatar
wdenk committed
286 287 288
- Board flavour: (if CONFIG_MPC8260ADS is defined)
		CONFIG_ADSTYPE
		Possible values are:
289 290 291 292
			CONFIG_SYS_8260ADS	- original MPC8260ADS
			CONFIG_SYS_8266ADS	- MPC8266ADS
			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
			CONFIG_SYS_8272ADS	- MPC8272ADS
wdenk's avatar
wdenk committed
293

wdenk's avatar
wdenk committed
294
- MPC824X Family Member (if CONFIG_MPC824X is defined)
wdenk's avatar
wdenk committed
295 296
		Define exactly one of
		CONFIG_MPC8240, CONFIG_MPC8245
wdenk's avatar
wdenk committed
297

298
- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk's avatar
wdenk committed
299 300
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
wdenk's avatar
wdenk committed
301 302
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
wdenk's avatar
wdenk committed
303 304
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
wdenk's avatar
wdenk committed
305

wdenk's avatar
wdenk committed
306
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
307 308
		CONFIG_SYS_8xx_CPUCLK_MIN
		CONFIG_SYS_8xx_CPUCLK_MAX
wdenk's avatar
wdenk committed
309
		CONFIG_8xx_CPUCLK_DEFAULT
310 311
			See doc/README.MPC866

312
		CONFIG_SYS_MEASURE_CPUCLK
313

wdenk's avatar
wdenk committed
314 315 316 317 318
		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
319
		RTC clock or CONFIG_SYS_8XX_XIN)
320

321
- Intel Monahans options:
322
		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
323 324 325 326 327

		Defines the Monahans run mode to oscillator
		ratio. Valid values are 8, 16, 24, 31. The core
		frequency is this value multiplied by 13 MHz.

328
		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denk's avatar
Wolfgang Denk committed
329

330 331
		Defines the Monahans turbo mode to oscillator
		ratio. Valid values are 1 (default if undefined) and
Wolfgang Denk's avatar
Wolfgang Denk committed
332
		2. The core frequency as calculated above is multiplied
333
		by this value.
Wolfgang Denk's avatar
Wolfgang Denk committed
334

wdenk's avatar
wdenk committed
335
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
336 337 338 339 340 341 342 343 344 345
		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
346
		"clocks_in_mhz=1" is automatically included in the
wdenk's avatar
wdenk committed
347 348
		default environment.

wdenk's avatar
wdenk committed
349 350
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

351
		When transferring memsize parameter to linux, some versions
wdenk's avatar
wdenk committed
352 353 354
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

355
		CONFIG_OF_LIBFDT
356 357

		New kernel versions are expecting firmware settings to be
358 359 360 361 362 363
		passed using flattened device trees (based on open firmware
		concepts).

		CONFIG_OF_LIBFDT
		 * New libfdt-based support
		 * Adds the "fdt" command
364
		 * The bootm command automatically updates the fdt
365

366
		OF_CPU - The proper name of the cpus node.
Kumar Gala's avatar
Kumar Gala committed
367
		OF_SOC - The proper name of the soc node.
368
		OF_TBCLK - The timebase frequency.
Kumar Gala's avatar
Kumar Gala committed
369
		OF_STDOUT_PATH - The path to the console device
370

371 372
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
373

374 375 376 377
		CONFIG_OF_BOARD_SETUP

		Board code has addition modification that it wants to make
		to the flat device tree before handing it off to the kernel
378

379 380
		CONFIG_OF_BOOT_CPU

381
		This define fills in the correct boot CPU in the boot
382 383
		param header, the default value is zero if undefined.

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
- vxWorks boot parameters:

		bootvx constructs a valid bootline using the following
		environments variables: bootfile, ipaddr, serverip, hostname.
		It loads the vxWorks image pointed bootfile.

		CONFIG_SYS_VXWORKS_BOOT_DEVICE - The vxworks device name
		CONFIG_SYS_VXWORKS_MAC_PTR - Ethernet 6 byte MA -address
		CONFIG_SYS_VXWORKS_SERVERNAME - Name of the server
		CONFIG_SYS_VXWORKS_BOOT_ADDR - Address of boot parameters

		CONFIG_SYS_VXWORKS_ADD_PARAMS

		Add it at the end of the bootline. E.g "u=username pw=secret"

		Note: If a "bootargs" environment is defined, it will overwride
		the defaults discussed just above.

wdenk's avatar
wdenk committed
402
- Serial Ports:
403
		CONFIG_PL010_SERIAL
wdenk's avatar
wdenk committed
404 405 406

		Define this if you want support for Amba PrimeCell PL010 UARTs.

407
		CONFIG_PL011_SERIAL
wdenk's avatar
wdenk committed
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422

		Define this if you want support for Amba PrimeCell PL011 UARTs.

		CONFIG_PL011_CLOCK

		If you have Amba PrimeCell PL011 UARTs, set this variable to
		the clock speed of the UARTs.

		CONFIG_PL01x_PORTS

		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
		define this to a list of base addresses for each (supported)
		port. See e.g. include/configs/versatile.h


wdenk's avatar
wdenk committed
423
- Console Interface:
424 425 426 427
		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
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444

		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
445 446
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
wdenk's avatar
wdenk committed
447 448
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
wdenk's avatar
wdenk committed
449
			VIDEO_FB_ADRS		framebuffer address
wdenk's avatar
wdenk committed
450 451 452 453 454 455 456 457 458
			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)
459
			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenk's avatar
wdenk committed
460 461
			CONFIG_CONSOLE_TIME	display time/date info in
						upper right corner
462
						(requires CONFIG_CMD_DATE)
wdenk's avatar
wdenk committed
463 464
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
465 466 467
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
wdenk's avatar
wdenk committed
468
			CONFIG_CONSOLE_EXTRA_INFO
469
						additional board info beside
wdenk's avatar
wdenk committed
470 471
						the logo

472 473 474
		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
475

wdenk's avatar
wdenk committed
476 477 478 479
		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.
wdenk's avatar
wdenk committed
480

wdenk's avatar
wdenk committed
481 482 483
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
484 485
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
486

487 488 489
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
490
		This option is actual only for 82xx and 8xx possible.
491 492 493 494
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

wdenk's avatar
wdenk committed
495 496 497 498 499 500 501 502 503
- 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.

504 505
		Leave undefined to disable this feature, including
		disable the buffer and hardware handshake.
wdenk's avatar
wdenk committed
506

stroese's avatar
stroese committed
507 508 509
- Console UART Number:
		CONFIG_UART1_CONSOLE

Wolfgang Denk's avatar
Wolfgang Denk committed
510
		AMCC PPC4xx only.
stroese's avatar
stroese committed
511 512 513
		If defined internal UART1 (and not UART0) is used
		as default U-Boot console.

wdenk's avatar
wdenk committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
- 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
539 540 541
		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
542 543

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
544 545 546
		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
547
		RAM and NFS.
wdenk's avatar
wdenk committed
548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573

- 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.

574
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenk's avatar
wdenk committed
575 576
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
577
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
578 579

- Monitor Functions:
580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
		Monitor commands can be included or excluded
		from the build by using the #include files
		"config_cmd_all.h" and #undef'ing unwanted
		commands, or using "config_cmd_default.h"
		and augmenting with additional #define's
		for wanted commands.

		The default command configuration includes all commands
		except those marked below with a "*".

		CONFIG_CMD_ASKENV	* ask for env variable
		CONFIG_CMD_AUTOSCRIPT	  Autoscript Support
		CONFIG_CMD_BDI		  bdinfo
		CONFIG_CMD_BEDBUG	* Include BedBug Debugger
		CONFIG_CMD_BMP		* BMP support
		CONFIG_CMD_BSP		* Board specific commands
		CONFIG_CMD_BOOTD	  bootd
		CONFIG_CMD_CACHE	* icache, dcache
		CONFIG_CMD_CONSOLE	  coninfo
		CONFIG_CMD_DATE		* support for RTC, date/time...
		CONFIG_CMD_DHCP		* DHCP support
		CONFIG_CMD_DIAG		* Diagnostics
		CONFIG_CMD_DOC		* Disk-On-Chip Support
603 604 605 606
		CONFIG_CMD_DS4510	* ds4510 I2C gpio commands
		CONFIG_CMD_DS4510_INFO	* ds4510 I2C info command
		CONFIG_CMD_DS4510_MEM	* ds4510 I2C eeprom/sram commansd
		CONFIG_CMD_DS4510_RST	* ds4510 I2C rst command
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635
		CONFIG_CMD_DTT		* Digital Therm and Thermostat
		CONFIG_CMD_ECHO		  echo arguments
		CONFIG_CMD_EEPROM	* EEPROM read/write support
		CONFIG_CMD_ELF		* bootelf, bootvx
		CONFIG_CMD_ENV		  saveenv
		CONFIG_CMD_FDC		* Floppy Disk Support
		CONFIG_CMD_FAT		* FAT partition support
		CONFIG_CMD_FDOS		* Dos diskette Support
		CONFIG_CMD_FLASH	  flinfo, erase, protect
		CONFIG_CMD_FPGA		  FPGA device initialization support
		CONFIG_CMD_HWFLOW	* RTS/CTS hw flow control
		CONFIG_CMD_I2C		* I2C serial bus support
		CONFIG_CMD_IDE		* IDE harddisk support
		CONFIG_CMD_IMI		  iminfo
		CONFIG_CMD_IMLS		  List all found images
		CONFIG_CMD_IMMAP	* IMMR dump support
		CONFIG_CMD_IRQ		* irqinfo
		CONFIG_CMD_ITEST	  Integer/string test of 2 values
		CONFIG_CMD_JFFS2	* JFFS2 Support
		CONFIG_CMD_KGDB		* kgdb
		CONFIG_CMD_LOADB	  loadb
		CONFIG_CMD_LOADS	  loads
		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
					  loop, loopw, mtest
		CONFIG_CMD_MISC		  Misc functions like sleep etc
		CONFIG_CMD_MMC		* MMC memory mapped support
		CONFIG_CMD_MII		* MII utility commands
		CONFIG_CMD_NAND		* NAND support
		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
636 637
		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
		CONFIG_CMD_PCI		* pciinfo
		CONFIG_CMD_PCMCIA		* PCMCIA support
		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
					  host
		CONFIG_CMD_PORTIO	* Port I/O
		CONFIG_CMD_REGINFO	* Register dump
		CONFIG_CMD_RUN		  run command in env variable
		CONFIG_CMD_SAVES	* save S record dump
		CONFIG_CMD_SCSI		* SCSI Support
		CONFIG_CMD_SDRAM	* print SDRAM configuration information
					  (requires CONFIG_CMD_I2C)
		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
					  (4xx only)
		CONFIG_CMD_SPI		* SPI serial bus support
		CONFIG_CMD_USB		* USB support
		CONFIG_CMD_VFD		* VFD support (TRAB)
		CONFIG_CMD_CDP		* Cisco Discover Protocol support
		CONFIG_CMD_FSL		* Microblaze FSL support

wdenk's avatar
wdenk committed
657 658 659 660

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

661 662
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
wdenk's avatar
wdenk committed
663

664 665
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenk's avatar
wdenk committed
666 667

	Note:	Don't enable the "icache" and "dcache" commands
668
		(configuration option CONFIG_CMD_CACHE) unless you know
669 670 671 672 673 674
		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
675 676 677 678 679 680 681


		XXX - this list needs to get updated!

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

687 688 689 690 691 692 693
- 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
694 695
- Real-Time Clock:

696
		When CONFIG_CMD_DATE is selected, the type of the RTC
wdenk's avatar
wdenk committed
697 698 699 700 701
		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
Guennadi Liakhovetski's avatar
Guennadi Liakhovetski committed
702
		CONFIG_RTC_MC13783	- use MC13783 RTC
wdenk's avatar
wdenk committed
703
		CONFIG_RTC_MC146818	- use MC146818 RTC
wdenk's avatar
wdenk committed
704
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
705
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
706
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
wdenk's avatar
wdenk committed
707
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
708
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
wdenk's avatar
wdenk committed
709
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
710
		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
wdenk's avatar
wdenk committed
711

wdenk's avatar
wdenk committed
712 713 714
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

715 716 717 718 719 720 721
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
		CONFIG_PCA953X_INFO	- enable pca953x info command

		Note that if the GPIO device uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

wdenk's avatar
wdenk committed
722 723
- Timestamp Support:

724 725 726
		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
727
		automatically enabled when you select CONFIG_CMD_DATE .
wdenk's avatar
wdenk committed
728 729 730

- Partition Support:
		CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
731
		and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION
wdenk's avatar
wdenk committed
732

733 734 735
		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
		CONFIG_CMD_SCSI) you must configure support for at
		least one partition type as well.
wdenk's avatar
wdenk committed
736 737

- IDE Reset method:
wdenk's avatar
wdenk committed
738 739
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
740

wdenk's avatar
wdenk committed
741 742 743 744
		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
745 746 747 748 749 750

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

751 752 753 754
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
755
		Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
756 757 758
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

759
		CONFIG_SYS_64BIT_LBA:
760 761 762
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

wdenk's avatar
wdenk committed
763 764 765 766 767
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

768 769 770
		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
wdenk's avatar
wdenk committed
771 772
		maximum numbers of LUNs, SCSI ID's and target
		devices.
773
		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenk's avatar
wdenk committed
774 775

- NETWORK Support (PCI):
776 777
		CONFIG_E1000
		Support for Intel 8254x gigabit chips.
stroese's avatar
stroese committed
778

Andre Schwarz's avatar
Andre Schwarz committed
779
		CONFIG_E1000_FALLBACK_MAC
780
		default MAC for empty EEPROM after production.
Andre Schwarz's avatar
Andre Schwarz committed
781

wdenk's avatar
wdenk committed
782 783
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
784
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenk's avatar
wdenk committed
785 786 787 788 789 790 791 792 793 794 795 796 797
		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.

wdenk's avatar
wdenk committed
798 799 800 801 802 803 804 805 806 807 808 809
- 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
810 811 812 813 814 815 816 817 818 819 820 821 822 823
		CONFIG_DRIVER_SMC91111
		Support for SMSC's LAN91C111 chip

			CONFIG_SMC91111_BASE
			Define this to hold the physical address
			of the device (I/O space)

			CONFIG_SMC_USE_32_BIT
			Define this if data bus is 32 bits

			CONFIG_SMC_USE_IOFUNCS
			Define this to use i/o functions instead of macros
			(some hardware wont work with macros)

Jens Gehrlein's avatar
Jens Gehrlein committed
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
		CONFIG_DRIVER_SMC911X
		Support for SMSC's LAN911x and LAN921x chips

			CONFIG_DRIVER_SMC911X_BASE
			Define this to hold the physical address
			of the device (I/O space)

			CONFIG_DRIVER_SMC911X_32_BIT
			Define this if data bus is 32 bits

			CONFIG_DRIVER_SMC911X_16_BIT
			Define this if data bus is 16 bits. If your processor
			automatically converts one 32 bit word to two 16 bit
			words you may also try CONFIG_DRIVER_SMC911X_32_BIT.

wdenk's avatar
wdenk committed
839 840
- USB Support:
		At the moment only the UHCI host controller is
wdenk's avatar
wdenk committed
841
		supported (PIP405, MIP405, MPC5200); define
wdenk's avatar
wdenk committed
842 843
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk's avatar
wdenk committed
844
		and define CONFIG_USB_STORAGE to enable the USB
wdenk's avatar
wdenk committed
845 846 847 848
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
wdenk's avatar
wdenk committed
849 850 851 852 853 854
		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
855
			CONFIG_SYS_USB_EVENT_POLL
Zhang Wei's avatar
Zhang Wei committed
856 857
				May be defined to allow interrupt polling
				instead of using asynchronous interrupts
wdenk's avatar
wdenk committed
858

Wolfgang Denk's avatar
Wolfgang Denk committed
859 860 861 862
- USB Device:
		Define the below if you wish to use the USB console.
		Once firmware is rebuilt from a serial console issue the
		command "setenv stdin usbtty; setenv stdout usbtty" and
863
		attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk's avatar
Wolfgang Denk committed
864 865
		it has found a new device. The environment variable usbtty
		can be set to gserial or cdc_acm to enable your device to
Wolfgang Denk's avatar
Wolfgang Denk committed
866
		appear to a USB host as a Linux gserial device or a
Wolfgang Denk's avatar
Wolfgang Denk committed
867 868 869 870 871 872 873
		Common Device Class Abstract Control Model serial device.
		If you select usbtty = gserial you should be able to enumerate
		a Linux host by
		# modprobe usbserial vendor=0xVendorID product=0xProductID
		else if using cdc_acm, simply setting the environment
		variable usbtty to be cdc_acm should suffice. The following
		might be defined in YourBoardName.h
Wolfgang Denk's avatar
Wolfgang Denk committed
874

Wolfgang Denk's avatar
Wolfgang Denk committed
875 876 877 878 879 880
			CONFIG_USB_DEVICE
			Define this to build a UDC device

			CONFIG_USB_TTY
			Define this to have a tty type of device available to
			talk to the UDC device
Wolfgang Denk's avatar
Wolfgang Denk committed
881

882
			CONFIG_SYS_CONSOLE_IS_IN_ENV
Wolfgang Denk's avatar
Wolfgang Denk committed
883 884 885 886
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

			mpc8xx:
887
				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
Wolfgang Denk's avatar
Wolfgang Denk committed
888
				Derive USB clock from external clock "blah"
889
				- CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk's avatar
Wolfgang Denk committed
890

891
				CONFIG_SYS_USB_BRG_CLK 0xBLAH
Wolfgang Denk's avatar
Wolfgang Denk committed
892
				Derive USB clock from brgclk
893
				- CONFIG_SYS_USB_BRG_CLK 0x04
Wolfgang Denk's avatar
Wolfgang Denk committed
894

Wolfgang Denk's avatar
Wolfgang Denk committed
895
		If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk's avatar
Wolfgang Denk committed
896
		define your own vendor specific values either in BoardName.h
Wolfgang Denk's avatar
Wolfgang Denk committed
897
		or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk's avatar
Wolfgang Denk committed
898 899 900 901 902 903 904
		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
		should pretend to be a Linux device to it's target host.

			CONFIG_USBD_MANUFACTURER
			Define this string as the name of your company for
			- CONFIG_USBD_MANUFACTURER "my company"
Wolfgang Denk's avatar
Wolfgang Denk committed
905

Wolfgang Denk's avatar
Wolfgang Denk committed
906 907 908 909 910 911 912 913 914
			CONFIG_USBD_PRODUCT_NAME
			Define this string as the name of your product
			- CONFIG_USBD_PRODUCT_NAME "acme usb device"

			CONFIG_USBD_VENDORID
			Define this as your assigned Vendor ID from the USB
			Implementors Forum. This *must* be a genuine Vendor ID
			to avoid polluting the USB namespace.
			- CONFIG_USBD_VENDORID 0xFFFF
Wolfgang Denk's avatar
Wolfgang Denk committed
915

Wolfgang Denk's avatar
Wolfgang Denk committed
916 917 918 919
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
wdenk's avatar
wdenk committed
920

wdenk's avatar
wdenk committed
921

922
- MMC Support:
wdenk's avatar
wdenk committed
923 924 925
		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
926
		to physical memory similar to flash. Command line is
927 928
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
929

wdenk's avatar
wdenk committed
930 931 932 933 934
- Journaling Flash filesystem support:
		CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
		CONFIG_JFFS2_NAND_DEV
		Define these for a default partition on a NAND device

935 936
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
wdenk's avatar
wdenk committed
937 938
		Define these for a default partition on a NOR device

939
		CONFIG_SYS_JFFS_CUSTOM_PART
wdenk's avatar
wdenk committed
940 941 942 943
		Define this to create an own partition. You have to provide a
		function struct part_info* jffs2_part_info(int part_num)

		If you define only one JFFS2 partition you may also want to
944
		#define CONFIG_SYS_JFFS_SINGLE_PART	1
wdenk's avatar
wdenk committed
945 946 947
		to disable the command chpart. This is the default when you
		have not defined a custom partition

wdenk's avatar
wdenk committed
948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
- 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
971
		Enable Silicon Motion SMI 712/710/810 Video chip. The
wdenk's avatar
wdenk committed
972 973 974 975
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

wdenk's avatar
wdenk committed
976
		For the CT69000 and SMI_LYNXEM drivers, videomode is
977
		selected via environment 'videomode'. Two different ways
wdenk's avatar
wdenk committed
978 979
		are possible:
		- "videomode=num"   'num' is a standard LiLo mode numbers.
wdenk's avatar
wdenk committed
980
		Following standard modes are supported	(* is default):
wdenk's avatar
wdenk committed
981 982 983 984 985 986 987 988

		      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
989 990
		(i.e. setenv videomode 317; saveenv; reset;)

wdenk's avatar
wdenk committed
991
		- "videomode=bootargs" all the video parameters are parsed
992
		from the bootargs. (See drivers/video/videomodes.c)
wdenk's avatar
wdenk committed
993 994


995
		CONFIG_VIDEO_SED13806
996
		Enable Epson SED13806 driver. This driver supports 8bpp
997 998 999
		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
		or CONFIG_VIDEO_SED13806_16BPP

1000
- Keyboard Support:
wdenk's avatar
wdenk committed
1001
		CONFIG_KEYBOARD
1002

wdenk's avatar
wdenk committed
1003 1004 1005 1006
		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.
1007

wdenk's avatar
wdenk committed
1008 1009 1010 1011 1012 1013
- 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:

Stelian Pop's avatar
Stelian Pop committed
1014 1015 1016 1017
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

wdenk's avatar
wdenk committed
1018
		CONFIG_NEC_NL6448AC33:
wdenk's avatar
wdenk committed
1019

wdenk's avatar
wdenk committed
1020
			NEC NL6448AC33-18. Active, color, single scan.
wdenk's avatar
wdenk committed
1021

wdenk's avatar
wdenk committed
1022
		CONFIG_NEC_NL6448BC20
wdenk's avatar
wdenk committed
1023

wdenk's avatar
wdenk committed
1024 1025 1026 1027 1028 1029
			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
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
			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
1058
		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenk's avatar
wdenk committed
1059

wdenk's avatar
wdenk committed
1060
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1061

wdenk's avatar
wdenk committed
1062 1063 1064
		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
1065
		is suppressed and the BMP image at the address
wdenk's avatar
wdenk committed
1066 1067 1068 1069
		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.
1070

1071 1072 1073 1074 1075 1076
- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP

		If this option is set, additionally to standard BMP
		images, gzipped BMP images can be displayed via the
		splashscreen support or the bmp command.

wdenk's avatar
wdenk committed
1077 1078 1079 1080 1081 1082 1083
- 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.

1084
		NOTE: the bzip2 algorithm requires a lot of RAM, so
1085
		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1086
		be at least 4MB.
1087

1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
		CONFIG_LZMA

		If this option is set, support for lzma compressed
		images is included.

		Note: The LZMA algorithm adds between 2 and 4KB of code and it
		requires an amount of dynamic memory that is given by the
		formula:

			(1846 + 768 << (lc + lp)) * sizeof(uint16)

		Where lc and lp stand for, respectively, Literal context bits
		and Literal pos bits.

		This value is upper-bounded by 14MB in the worst case. Anyway,
		for a ~4MB large kernel image, we have lc=3 and lp=0 for a
		total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
		a very small buffer.

		Use the lzmainfo tool to determinate the lc and lp values and
		then calculate the amount of needed dynamic memory (ensuring
1109
		the appropriate CONFIG_SYS_MALLOC_LEN value).
1110

wdenk's avatar
wdenk committed
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
- MII/PHY support:
		CONFIG_PHY_ADDR

		The address of PHY on MII bus.

		CONFIG_PHY_CLOCK_FREQ (ppc4xx)

		The clock frequency of the MII bus

		CONFIG_PHY_GIGE

		If this option is set, support for speed/duplex
1123
		detection of gigabit PHY is included.
wdenk's avatar
wdenk committed
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136

		CONFIG_PHY_RESET_DELAY

		Some PHY like Intel LXT971A need extra delay after
		reset before any MII register access is possible.
		For such PHY, set this option to the usec delay
		required. (minimum 300usec for LXT971A)

		CONFIG_PHY_CMD_DELAY (ppc4xx)

		Some PHY like Intel LXT971A need extra delay after
		command issued before MII status register can be read

wdenk's avatar
wdenk committed
1137 1138
- Ethernet address:
		CONFIG_ETHADDR
1139
		CONFIG_ETH1ADDR
wdenk's avatar
wdenk committed
1140 1141
		CONFIG_ETH2ADDR
		CONFIG_ETH3ADDR
1142 1143
		CONFIG_ETH4ADDR
		CONFIG_ETH5ADDR
wdenk's avatar
wdenk committed
1144

1145 1146
		Define a default value for Ethernet address to use
		for the respective Ethernet interface, in case this
wdenk's avatar
wdenk committed
1147 1148 1149 1150 1151 1152
		is not determined automatically.

- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
1153
		the default Ethernet interface, in case this is not
wdenk's avatar
wdenk committed
1154 1155 1156 1157 1158
		determined through e.g. bootp.

- Server IP address:
		CONFIG_SERVERIP

1159
		Defines a default value for the IP address of a TFTP
wdenk's avatar
wdenk committed
1160 1161
		server to contact when using the "tftboot" command.

David Updegraff's avatar
David Updegraff committed
1162 1163 1164 1165 1166
- Multicast TFTP Mode:
		CONFIG_MCAST_TFTP

		Defines whether you want to support multicast TFTP as per
		rfc-2090; for example to work with atftp.  Lets lots of targets
1167
		tftp down the same boot image concurrently.  Note: the Ethernet
David Updegraff's avatar
David Updegraff committed
1168 1169 1170 1171
		driver in use must provide a function: mcast() to join/leave a
		multicast group.

		CONFIG_BOOTP_RANDOM_DELAY
wdenk's avatar
wdenk committed
1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182
- 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
1183
		following delays are inserted then:
wdenk's avatar
wdenk committed
1184 1185 1186 1187 1188 1189 1190

		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

1191
- DHCP Advanced Options:
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
		You can fine tune the DHCP functionality by defining
		CONFIG_BOOTP_* symbols:

		CONFIG_BOOTP_SUBNETMASK
		CONFIG_BOOTP_GATEWAY
		CONFIG_BOOTP_HOSTNAME
		CONFIG_BOOTP_NISDOMAIN
		CONFIG_BOOTP_BOOTPATH
		CONFIG_BOOTP_BOOTFILESIZE
		CONFIG_BOOTP_DNS
		CONFIG_BOOTP_DNS2
		CONFIG_BOOTP_SEND_HOSTNAME
		CONFIG_BOOTP_NTPSERVER
		CONFIG_BOOTP_TIMEOFFSET
		CONFIG_BOOTP_VENDOREX
1207

1208 1209
		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
		environment variable, not the BOOTP server.
1210 1211 1212 1213 1214 1215 1216 1217

		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
1218
		is defined.
1219 1220 1221 1222

		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.
1223
		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1224 1225
		of the "hostname" environment variable is passed as
		option 12 to the DHCP server.
1226

1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240
		CONFIG_BOOTP_DHCP_REQUEST_DELAY

		A 32bit value in microseconds for a delay between
		receiving a "DHCP Offer" and sending the "DHCP Request".
		This fixes a problem with certain DHCP servers that don't
		respond 100% of the time to a "DHCP request". E.g. On an
		AT91RM9200 processor running at 180MHz, this delay needed
		to be *at least* 15,000 usec before a Windows Server 2003
		DHCP server would reply 100% of the time. I recommend at
		least 50,000 usec to be safe. The alternative is to hope
		that one of the retries will be successful but note that
		the DHCP timeout and retry process takes a longer than
		this delay.

1241
 - CDP Options:
wdenk's avatar
wdenk committed
1242
		CONFIG_CDP_DEVICE_ID
1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254

		The device id used in CDP trigger frames.

		CONFIG_CDP_DEVICE_ID_PREFIX

		A two character string which is prefixed to the MAC address
		of the device.

		CONFIG_CDP_PORT_ID

		A printf format string which contains the ascii name of
		the port. Normally is set to "eth%d" which sets
1255
		eth0 for the first Ethernet, eth1 for the second etc.
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282

		CONFIG_CDP_CAPABILITIES

		A 32bit integer which indicates the device capabilities;
		0x00000010 for a normal host which does not forwards.

		CONFIG_CDP_VERSION

		An ascii string containing the version of the software.

		CONFIG_CDP_PLATFORM

		An ascii string containing the name of the platform.

		CONFIG_CDP_TRIGGER

		A 32bit integer sent on the trigger.

		CONFIG_CDP_POWER_CONSUMPTION

		A 16bit integer containing the power consumption of the
		device in .1 of milliwatts.

		CONFIG_CDP_APPLIANCE_VLAN_TYPE

		A byte containing the id of the VLAN.

wdenk's avatar
wdenk committed
1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
- 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
1302
		These enable I2C serial bus commands. Defining either of
1303
		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1304
		include the appropriate I2C driver for the selected CPU.
wdenk's avatar
wdenk committed
1305

1306
		This will allow you to use i2c commands at the u-boot
1307
		command line (as long as you set CONFIG_CMD_I2C in
wdenk's avatar
wdenk committed
1308 1309
		CONFIG_COMMANDS) and communicate with i2c based realtime
		clock chips. See common/cmd_i2c.c for a description of the
1310
		command line interface.
wdenk's avatar
wdenk committed
1311

1312 1313 1314 1315 1316 1317
		CONFIG_I2C_CMD_TREE is a recommended option that places
		all I2C commands under a single 'i2c' root command.  The
		older 'imm', 'imd', 'iprobe' etc. commands are considered
		deprecated and may disappear in the future.

		CONFIG_HARD_I2C selects a hardware I2C controller.
wdenk's avatar
wdenk committed
1318

1319
		CONFIG_SOFT_I2C configures u-boot to use a software (aka
wdenk's avatar
wdenk committed
1320 1321
		bit-banging) driver instead of CPM or similar hardware
		support for I2C.
wdenk's avatar
wdenk committed
1322

1323
		There are several other quantities that must also be
wdenk's avatar
wdenk committed
1324
		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenk's avatar
wdenk committed
1325

1326
		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1327
		to be the frequency (in Hz) at which you wish your i2c bus
1328
		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie