README 158 KB
Newer Older
wdenk's avatar
wdenk committed
1
#
2
# (C) Copyright 2000 - 2011
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
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)
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


126 127 128
Versioning:
===========

129 130 131 132 133 134 135 136 137 138 139
Starting with the release in October 2008, the names of the releases
were changed from numerical release numbers without deeper meaning
into a time stamp based numbering. Regular releases are identified by
names consisting of the calendar year and month of the release date.
Additional fields (if present) indicate release candidates or bug fix
releases in "stable" maintenance trees.

Examples:
	U-Boot v2009.11     - Release November 2009
	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
	U-Boot v2010.09-rc1 - Release candiate 1 for September 2010 release
140 141


wdenk's avatar
wdenk committed
142 143 144
Directory Hierarchy:
====================

145 146 147 148 149
/arch			Architecture specific files
  /arm			Files generic to ARM architecture
    /cpu		CPU specific files
      /arm720t		Files specific to ARM 720 CPUs
      /arm920t		Files specific to ARM 920 CPUs
150
	/at91		Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk's avatar
Wolfgang Denk committed
151 152
	/imx		Files specific to Freescale MC9328 i.MX CPUs
	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
153 154 155 156 157 158 159 160 161 162 163 164 165 166
      /arm925t		Files specific to ARM 925 CPUs
      /arm926ejs	Files specific to ARM 926 CPUs
      /arm1136		Files specific to ARM 1136 CPUs
      /ixp		Files specific to Intel XScale IXP CPUs
      /pxa		Files specific to Intel XScale PXA CPUs
      /s3c44b0		Files specific to Samsung S3C44B0 CPUs
      /sa1100		Files specific to Intel StrongARM SA1100 CPUs
    /lib		Architecture specific library files
  /avr32		Files generic to AVR32 architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
  /blackfin		Files generic to Analog Devices Blackfin architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
Graeme Russ's avatar
Graeme Russ committed
167
  /x86			Files generic to x86 architecture
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
    /cpu		CPU specific files
    /lib		Architecture specific library files
  /m68k			Files generic to m68k architecture
    /cpu		CPU specific files
      /mcf52x2		Files specific to Freescale ColdFire MCF52x2 CPUs
      /mcf5227x		Files specific to Freescale ColdFire MCF5227x CPUs
      /mcf532x		Files specific to Freescale ColdFire MCF5329 CPUs
      /mcf5445x		Files specific to Freescale ColdFire MCF5445x CPUs
      /mcf547x_8x	Files specific to Freescale ColdFire MCF547x_8x CPUs
    /lib		Architecture specific library files
  /microblaze		Files generic to microblaze architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
  /mips			Files generic to MIPS architecture
    /cpu		CPU specific files
183
      /mips32		Files specific to MIPS32 CPUs
184 185 186 187
    /lib		Architecture specific library files
  /nios2		Files generic to Altera NIOS2 architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
188
  /powerpc		Files generic to PowerPC architecture
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 215 216 217 218 219 220 221 222 223 224 225 226 227
    /cpu		CPU specific files
      /74xx_7xx		Files specific to Freescale MPC74xx and 7xx CPUs
      /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
      /ppc4xx		Files specific to AMCC PowerPC 4xx CPUs
    /lib		Architecture specific library files
  /sh			Files generic to SH architecture
    /cpu		CPU specific files
      /sh2		Files specific to sh2 CPUs
      /sh3		Files specific to sh3 CPUs
      /sh4		Files specific to sh4 CPUs
    /lib		Architecture specific library files
  /sparc		Files generic to SPARC architecture
    /cpu		CPU specific files
      /leon2		Files specific to Gaisler LEON2 SPARC CPU
      /leon3		Files specific to Gaisler LEON3 SPARC CPU
    /lib		Architecture specific library files
/api			Machine/arch independent API for external apps
/board			Board dependent files
/common			Misc architecture independent functions
/disk			Code for disk drive partition handling
/doc			Documentation (don't expect too much)
/drivers		Commonly used device drivers
/examples		Example code for standalone applications, etc.
/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
/include		Header Files
/lib			Files generic to all architectures
  /libfdt		Library files to support flattened device trees
  /lzma			Library files to support LZMA decompression
  /lzo			Library files to support LZO decompression
/net			Networking code
/post			Power On Self Test
/rtc			Real Time Clock drivers
/tools			Tools to build S-Record or U-Boot images, etc.
wdenk's avatar
wdenk committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

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
244
  "CONFIG_SYS_".
wdenk's avatar
wdenk committed
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263

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

264
For the Cogent platform, you need to specify the CPU type as well;
wdenk's avatar
wdenk committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
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
280 281 282 283 284
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
285 286
The following options need to be configured:

287 288 289
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
290 291

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
292
		Define exactly one, e.g. CONFIG_ATSTK1002
wdenk's avatar
wdenk committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

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

315 316 317
- Board flavour: (if CONFIG_MPC8260ADS is defined)
		CONFIG_ADSTYPE
		Possible values are:
318 319 320 321
			CONFIG_SYS_8260ADS	- original MPC8260ADS
			CONFIG_SYS_8266ADS	- MPC8266ADS
			CONFIG_SYS_PQ2FADS	- PQ2FADS-ZU or PQ2FADS-VR
			CONFIG_SYS_8272ADS	- MPC8272ADS
322

323 324 325 326 327
- Marvell Family Member
		CONFIG_SYS_MVFS		- define it if you want to enable
					  multiple fs option at one time
					  for marvell soc family

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

332
- 8xx CPU Options: (if using an MPC8xx CPU)
333 334
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
335 336
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
337 338
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
wdenk's avatar
wdenk committed
339

340
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
341 342
		CONFIG_SYS_8xx_CPUCLK_MIN
		CONFIG_SYS_8xx_CPUCLK_MAX
343
		CONFIG_8xx_CPUCLK_DEFAULT
344 345
			See doc/README.MPC866

346
		CONFIG_SYS_MEASURE_CPUCLK
347

348 349 350 351 352
		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
353
		RTC clock or CONFIG_SYS_8XX_XIN)
354

355 356 357 358 359
		CONFIG_SYS_DELAYED_ICACHE

		Define this option if you want to enable the
		ICache only when Code runs from RAM.

360 361 362 363 364 365 366
- 85xx CPU Options:
		CONFIG_SYS_FSL_TBCLK_DIV

		Defines the core time base clock divider ratio compared to the
		system clock.  On most PQ3 devices this is 8, on newer QorIQ
		devices it can be 16 or 32.  The ratio varies from SoC to Soc.

367 368 369 370 371
		CONFIG_SYS_FSL_PCIE_COMPAT

		Defines the string to utilize when trying to match PCIe device
		tree nodes for the given platform.

372
- Intel Monahans options:
373
		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
374 375 376 377 378

		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.

379
		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denk's avatar
Wolfgang Denk committed
380

381 382
		Defines the Monahans turbo mode to oscillator
		ratio. Valid values are 1 (default if undefined) and
Wolfgang Denk's avatar
Wolfgang Denk committed
383
		2. The core frequency as calculated above is multiplied
384
		by this value.
Wolfgang Denk's avatar
Wolfgang Denk committed
385

386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
- MIPS CPU options:
		CONFIG_SYS_INIT_SP_OFFSET

		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
		pointer. This is needed for the temporary stack before
		relocation.

		CONFIG_SYS_MIPS_CACHE_MODE

		Cache operation mode for the MIPS CPU.
		See also arch/mips/include/asm/mipsregs.h.
		Possible values are:
			CONF_CM_CACHABLE_NO_WA
			CONF_CM_CACHABLE_WA
			CONF_CM_UNCACHED
			CONF_CM_CACHABLE_NONCOHERENT
			CONF_CM_CACHABLE_CE
			CONF_CM_CACHABLE_COW
			CONF_CM_CACHABLE_CUW
			CONF_CM_CACHABLE_ACCELERATED

		CONFIG_SYS_XWAY_EBU_BOOTCFG

		Special option for Lantiq XWAY SoCs for booting from NOR flash.
		See also arch/mips/cpu/mips32/start.S.

		CONFIG_XWAY_SWAP_BYTES

		Enable compilation of tools/xway-swap-bytes needed for Lantiq
		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
		be swapped if a flash programmer is used.

418
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
419 420 421 422 423 424 425 426 427 428
		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
429
		"clocks_in_mhz=1" is automatically included in the
wdenk's avatar
wdenk committed
430 431
		default environment.

432 433
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

434
		When transferring memsize parameter to linux, some versions
435 436 437
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

438
		CONFIG_OF_LIBFDT
439 440

		New kernel versions are expecting firmware settings to be
441 442 443 444 445 446
		passed using flattened device trees (based on open firmware
		concepts).

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

449 450 451 452
		OF_CPU - The proper name of the cpus node (only required for
			MPC512X and MPC5xxx based boards).
		OF_SOC - The proper name of the soc node (only required for
			MPC512X and MPC5xxx based boards).
453
		OF_TBCLK - The timebase frequency.
454
		OF_STDOUT_PATH - The path to the console device
455

456 457
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
458

459 460 461 462
		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
463

464 465
		CONFIG_OF_BOOT_CPU

466
		This define fills in the correct boot CPU in the boot
467 468
		param header, the default value is zero if undefined.

469 470 471 472 473 474 475 476 477
		CONFIG_OF_IDE_FIXUP

		U-Boot can detect if an IDE device is present or not.
		If not, and this new config option is activated, U-Boot
		removes the ATA node from the DTS before booting Linux,
		so the Linux IDE driver does not probe the device and
		crash. This is needed for buggy hardware (uc101) where
		no pull down resistor is connected to the signal IDE5V_DD7.

478 479 480 481 482 483 484 485 486 487
		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]

		This setting is mandatory for all boards that have only one
		machine type and must be used to specify the machine type
		number as it appears in the ARM machine registry
		(see http://www.arm.linux.org.uk/developer/machines/).
		Only boards that have multiple machine types supported
		in a single configuration file and the machine type is
		runtime discoverable, do not have to use this setting.

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
- 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.

506 507 508 509 510
- Cache Configuration:
		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot

511 512 513 514 515 516
- Cache Configuration for ARM:
		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
				      controller
		CONFIG_SYS_PL310_BASE - Physical base address of PL310
					controller register space

517
- Serial Ports:
518
		CONFIG_PL010_SERIAL
519 520 521

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

522
		CONFIG_PL011_SERIAL
523 524 525 526 527 528 529 530 531 532 533 534 535 536

		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

537 538 539 540 541 542 543 544 545 546 547 548
		CONFIG_PL011_SERIAL_RLCR

		Some vendor versions of PL011 serial ports (e.g. ST-Ericsson U8500)
		have separate receive and transmit line control registers.  Set
		this variable to initialize the extra register.

		CONFIG_PL011_SERIAL_FLUSH_ON_INIT

		On some platforms (e.g. U8500) U-Boot is loaded by a second stage
		boot loader that has already initialized the UART.  Define this
		variable to flush the UART at init time.

549

wdenk's avatar
wdenk committed
550
- Console Interface:
551 552 553 554
		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
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571

		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)
572 573
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
wdenk's avatar
wdenk committed
574 575
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
576
			VIDEO_FB_ADRS		framebuffer address
wdenk's avatar
wdenk committed
577 578 579 580 581 582 583 584 585
			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)
586
			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenk's avatar
wdenk committed
587 588
			CONFIG_CONSOLE_TIME	display time/date info in
						upper right corner
589
						(requires CONFIG_CMD_DATE)
wdenk's avatar
wdenk committed
590 591
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
592 593 594
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
wdenk's avatar
wdenk committed
595
			CONFIG_CONSOLE_EXTRA_INFO
596
						additional board info beside
wdenk's avatar
wdenk committed
597 598
						the logo

599 600 601
		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
602

603 604 605 606
		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.
607

wdenk's avatar
wdenk committed
608 609 610
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
611 612
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
613

614 615 616
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
617
		This option is actual only for 82xx and 8xx possible.
618 619 620 621
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

622 623 624 625 626 627 628 629 630 631 632 633 634 635
- Pre-Console Buffer:
                Prior to the console being initialised (i.e. serial UART
                initialised etc) all console output is silently discarded.
                Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
                buffer any console messages prior to the console being
                initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
                bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
                a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
                bytes are output before the console is  initialised, the
                earlier bytes are discarded.

                'Sane' compilers will generate smaller code if
                CONFIG_PRE_CON_BUF_SZ is a power of 2

wdenk's avatar
wdenk committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
- 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
661 662 663
		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
664 665

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
666 667 668
		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
669
		RAM and NFS.
wdenk's avatar
wdenk committed
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695

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

696
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenk's avatar
wdenk committed
697 698
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
699
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
700 701

- Monitor Functions:
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
		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_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
720
		CONFIG_CMD_CRC32	* crc32
721 722 723
		CONFIG_CMD_DATE		* support for RTC, date/time...
		CONFIG_CMD_DHCP		* DHCP support
		CONFIG_CMD_DIAG		* Diagnostics
724 725 726 727
		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
728 729
		CONFIG_CMD_DTT		* Digital Therm and Thermostat
		CONFIG_CMD_ECHO		  echo arguments
Peter Tyser's avatar
Peter Tyser committed
730
		CONFIG_CMD_EDITENV	  edit env variable
731 732
		CONFIG_CMD_EEPROM	* EEPROM read/write support
		CONFIG_CMD_ELF		* bootelf, bootvx
733
		CONFIG_CMD_EXPORTENV	* export the environment
734
		CONFIG_CMD_SAVEENV	  saveenv
735 736 737 738 739
		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
Mike Frysinger's avatar
Mike Frysinger committed
740
		CONFIG_CMD_GO		* the 'go' command (exec code)
741
		CONFIG_CMD_GREPENV	* search environment
742 743 744 745 746 747
		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
748
		CONFIG_CMD_IMPORTENV	* import an environment
749 750 751 752
		CONFIG_CMD_IRQ		* irqinfo
		CONFIG_CMD_ITEST	  Integer/string test of 2 values
		CONFIG_CMD_JFFS2	* JFFS2 Support
		CONFIG_CMD_KGDB		* kgdb
753
		CONFIG_CMD_LDRINFO	  ldrinfo (display Blackfin loader)
754 755
		CONFIG_CMD_LOADB	  loadb
		CONFIG_CMD_LOADS	  loads
756 757
		CONFIG_CMD_MD5SUM	  print md5 message digest
					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
758 759 760 761 762
		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
763
		CONFIG_CMD_MTDPARTS	* MTD partition support
764 765
		CONFIG_CMD_NAND		* NAND support
		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
766 767
		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
		CONFIG_CMD_PCA953X_INFO	* PCA953x I2C gpio info command
768 769 770 771 772 773 774 775 776 777 778 779 780
		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)
781
		CONFIG_CMD_SHA1SUM	  print sha1 memory digest
782
					  (requires CONFIG_CMD_MEMORY)
783
		CONFIG_CMD_SOURCE	  "source" command Support
784
		CONFIG_CMD_SPI		* SPI serial bus support
785
		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
786 787 788 789
		CONFIG_CMD_USB		* USB support
		CONFIG_CMD_CDP		* Cisco Discover Protocol support
		CONFIG_CMD_FSL		* Microblaze FSL support

wdenk's avatar
wdenk committed
790 791 792 793

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

794 795
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
wdenk's avatar
wdenk committed
796

797 798
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenk's avatar
wdenk committed
799 800

	Note:	Don't enable the "icache" and "dcache" commands
801
		(configuration option CONFIG_CMD_CACHE) unless you know
802 803 804 805 806 807
		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
808 809 810 811 812 813 814


		XXX - this list needs to get updated!

- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
815 816 817 818 819 820 821 822 823 824 825
		support for the SoC. There must be support in the SoC
		specific code for a watchdog. For the 8xx and 8260
		CPUs, the SIU Watchdog feature is enabled in the SYPCR
		register.  When supported for a specific SoC is
		available, then no further board specific code should
		be needed to use it.

		CONFIG_HW_WATCHDOG
		When using a watchdog circuitry external to the used
		SoC, then define this variable and provide board
		specific code for the "hw_watchdog_reset" function.
wdenk's avatar
wdenk committed
826

827 828 829 830 831 832 833
- 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
834 835
- Real-Time Clock:

836
		When CONFIG_CMD_DATE is selected, the type of the RTC
wdenk's avatar
wdenk committed
837 838 839 840 841
		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
842
		CONFIG_RTC_MC13783	- use MC13783 RTC
wdenk's avatar
wdenk committed
843
		CONFIG_RTC_MC146818	- use MC146818 RTC
844
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
845
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
846
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
847
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
848
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
849
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
850
		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
851 852
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
wdenk's avatar
wdenk committed
853

854 855 856
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

857 858 859 860
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
		CONFIG_PCA953X_INFO	- enable pca953x info command

861 862 863 864
		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
		chip-ngpio pairs that tell the PCA953X driver the number of
		pins supported by a particular chip.

865 866 867
		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
868 869
- Timestamp Support:

870 871 872
		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
873
		automatically enabled when you select CONFIG_CMD_DATE .
wdenk's avatar
wdenk committed
874 875 876

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

879 880 881
		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
882 883

- IDE Reset method:
884 885
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
886

887 888 889 890
		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
891 892 893 894 895 896

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

897 898 899 900
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
901
		Also look at CONFIG_SYS_64BIT_LBA.
902 903 904
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

905
		CONFIG_SYS_64BIT_LBA:
906 907 908
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

wdenk's avatar
wdenk committed
909 910 911 912 913
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

914 915 916
		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
917 918
		maximum numbers of LUNs, SCSI ID's and target
		devices.
919
		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenk's avatar
wdenk committed
920 921

- NETWORK Support (PCI):
922 923
		CONFIG_E1000
		Support for Intel 8254x gigabit chips.
stroese's avatar
stroese committed
924

925
		CONFIG_E1000_FALLBACK_MAC
926
		default MAC for empty EEPROM after production.
927

wdenk's avatar
wdenk committed
928 929
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
930
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenk's avatar
wdenk committed
931 932 933 934 935 936 937 938 939 940 941 942 943
		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.

944 945
- NETWORK Support (other):

946 947 948 949 950 951 952 953 954 955
		CONFIG_DRIVER_AT91EMAC
		Support for AT91RM9200 EMAC.

			CONFIG_RMII
			Define this to use reduced MII inteface

			CONFIG_DRIVER_AT91EMAC_QUIET
			If this defined, the driver is quiet.
			The driver doen't show link status messages.

956 957 958 959 960 961 962 963 964 965
		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

966 967 968 969 970 971 972 973 974 975 976 977 978 979
		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)

980 981 982 983 984 985 986 987 988 989 990 991
		CONFIG_FTGMAC100
		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet

			CONFIG_FTGMAC100_EGIGA
			Define this to use GE link update with gigabit PHY.
			Define this if FTGMAC100 is connected to gigabit PHY.
			If your system has 10/100 PHY only, it might not occur
			wrong behavior. Because PHY usually return timeout or
			useless data when polling gigabit status and gigabit
			control registers. This behavior won't affect the
			correctnessof 10/100 link speed update.

992
		CONFIG_SMC911X
993 994
		Support for SMSC's LAN911x and LAN921x chips

995
			CONFIG_SMC911X_BASE
996 997 998
			Define this to hold the physical address
			of the device (I/O space)

999
			CONFIG_SMC911X_32_BIT
1000 1001
			Define this if data bus is 32 bits

1002
			CONFIG_SMC911X_16_BIT
1003 1004
			Define this if data bus is 16 bits. If your processor
			automatically converts one 32 bit word to two 16 bit
1005
			words you may also try CONFIG_SMC911X_32_BIT.
1006

1007 1008 1009 1010 1011 1012 1013 1014 1015
		CONFIG_SH_ETHER
		Support for Renesas on-chip Ethernet controller

			CONFIG_SH_ETHER_USE_PORT
			Define the number of ports to be used

			CONFIG_SH_ETHER_PHY_ADDR
			Define the ETH PHY's address

1016 1017 1018
			CONFIG_SH_ETHER_CACHE_WRITEBACK
			If this option is set, the driver enables cache flush.

wdenk's avatar
wdenk committed
1019 1020
- USB Support:
		At the moment only the UHCI host controller is
1021
		supported (PIP405, MIP405, MPC5200); define
wdenk's avatar
wdenk committed
1022 1023
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1024
		and define CONFIG_USB_STORAGE to enable the USB
wdenk's avatar
wdenk committed
1025 1026 1027 1028
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
1029 1030 1031
		MPC5200 USB requires additional defines:
			CONFIG_USB_CLOCK
				for 528 MHz Clock: 0x0001bbbb
1032 1033
			CONFIG_PSC3_USB
				for USB on PSC3
1034 1035 1036
			CONFIG_USB_CONFIG
				for differential drivers: 0x00001000
				for single ended drivers: 0x00005000
1037 1038
				for differential drivers on PSC3: 0x00000100
				for single ended drivers on PSC3: 0x00004100
1039
			CONFIG_SYS_USB_EVENT_POLL
Zhang Wei's avatar
Zhang Wei committed
1040 1041
				May be defined to allow interrupt polling
				instead of using asynchronous interrupts
1042

1043 1044 1045 1046
- 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
1047
		attach your USB cable. The Unix command "dmesg" should print
1048 1049
		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
1050
		appear to a USB host as a Linux gserial device or a
1051 1052 1053 1054 1055 1056 1057
		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
1058

1059 1060 1061 1062 1063 1064
			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
1065

1066
			CONFIG_SYS_CONSOLE_IS_IN_ENV
1067 1068 1069 1070
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

			mpc8xx:
1071
				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1072
				Derive USB clock from external clock "blah"
1073
				- CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk's avatar
Wolfgang Denk committed
1074

1075
				CONFIG_SYS_USB_BRG_CLK 0xBLAH
1076
				Derive USB clock from brgclk
1077
				- CONFIG_SYS_USB_BRG_CLK 0x04
1078

Wolfgang Denk's avatar
Wolfgang Denk committed
1079
		If you have a USB-IF assigned VendorID then you may wish to
1080
		define your own vendor specific values either in BoardName.h
Wolfgang Denk's avatar
Wolfgang Denk committed
1081
		or directly in usbd_vendor_info.h. If you don't define
1082 1083 1084 1085 1086 1087 1088
		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
1089

1090 1091 1092 1093 1094 1095 1096 1097 1098
			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
1099

1100 1101 1102 1103
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
1104

wdenk's avatar
wdenk committed
1105

1106
- MMC Support:
wdenk's avatar
wdenk committed
1107 1108 1109
		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
1110
		to physical memory similar to flash. Command line is
1111 1112
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1113

1114 1115 1116 1117 1118 1119 1120 1121 1122
		CONFIG_SH_MMCIF
		Support for Renesas on-chip MMCIF controller

			CONFIG_SH_MMCIF_ADDR
			Define the base address of MMCIF registers

			CONFIG_SH_MMCIF_CLK
			Define the clock frequency for MMCIF

1123 1124 1125 1126 1127
- 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

1128 1129
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1130 1131
		Define these for a default partition on a NOR device

1132
		CONFIG_SYS_JFFS_CUSTOM_PART
1133 1134 1135 1136
		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
1137
		#define CONFIG_SYS_JFFS_SINGLE_PART	1
1138 1139 1140
		to disable the command chpart. This is the default when you
		have not defined a custom partition

wdenk's avatar
wdenk committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
- 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
1164
		Enable Silicon Motion SMI 712/710/810 Video chip. The
1165 1166 1167 1168
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

wdenk's avatar
wdenk committed
1169
		For the CT69000 and SMI_LYNXEM drivers, videomode is
1170
		selected via environment 'videomode'. Two different ways
1171 1172
		are possible:
		- "videomode=num"   'num' is a standard LiLo mode numbers.
wdenk's avatar
wdenk committed
1173
		Following standard modes are supported	(* is default):
1174 1175 1176 1177 1178 1179 1180 1181

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

wdenk's avatar
wdenk committed
1184
		- "videomode=bootargs" all the video parameters are parsed
1185
		from the bootargs. (See drivers/video/videomodes.c)
1186 1187


1188
		CONFIG_VIDEO_SED13806
1189
		Enable Epson SED13806 driver. This driver supports 8bpp
1190 1191 1192
		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
		or CONFIG_VIDEO_SED13806_16BPP

1193
		CONFIG_FSL_DIU_FB
1194
		Enable the Freescale DIU video driver.	Reference boards for
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
		SOCs that have a DIU should define this macro to enable DIU
		support, and should also define these other macros:

			CONFIG_SYS_DIU_ADDR
			CONFIG_VIDEO
			CONFIG_CMD_BMP
			CONFIG_CFB_CONSOLE
			CONFIG_VIDEO_SW_CURSOR
			CONFIG_VGA_AS_SINGLE_DEVICE
			CONFIG_VIDEO_LOGO
			CONFIG_VIDEO_BMP_LOGO

1207 1208 1209 1210
		The DIU driver will look for the 'video-mode' environment
		variable, and if defined, enable the DIU as a console during
		boot.  See the documentation file README.video for a
		description of this variable.
1211

1212
- Keyboard Support:
wdenk's avatar
wdenk committed
1213
		CONFIG_KEYBOARD
1214

wdenk's avatar
wdenk committed
1215 1216 1217 1218
		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.
1219

wdenk's avatar
wdenk committed
1220 1221 1222 1223 1224 1225
- 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
1226 1227 1228 1229
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

wdenk's avatar
wdenk committed
1230
		CONFIG_NEC_NL6448AC33:
wdenk's avatar
wdenk committed
1231

wdenk's avatar
wdenk committed
1232
			NEC NL6448AC33-18. Active, color, single scan.
wdenk's avatar
wdenk committed
1233

wdenk's avatar
wdenk committed
1234
		CONFIG_NEC_NL6448BC20
wdenk's avatar
wdenk committed
1235

wdenk's avatar
wdenk committed
1236 1237 1238 1239 1240 1241
			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
1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
			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
1270
		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
wdenk's avatar
wdenk committed
1271

wdenk's avatar
wdenk committed
1272
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1273

wdenk's avatar
wdenk committed
1274 1275 1276
		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
1277
		is suppressed and the BMP image at the address
wdenk's avatar
wdenk committed
1278 1279 1280 1281
		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.
1282

1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302
		CONFIG_SPLASH_SCREEN_ALIGN

		If this option is set the splash image can be freely positioned
		on the screen. Environment variable "splashpos" specifies the
		position as "x,y". If a positive number is given it is used as
		number of pixel from left/top. If a negative number is given it
		is used as number of pixel from right/bottom. You can also
		specify 'm' for centering the image.

		Example:
		setenv splashpos m,m
			=> image at center of screen

		setenv splashpos 30,20
			=> image at x = 30 and y = 20

		setenv splashpos -10,m
			=> vertically centered image
			   at x = dspWidth - bmpWidth - 9

1303 1304 1305 1306 1307 1308
- 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.

1309 1310 1311 1312 1313 1314
- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8

		If this option is set, 8-bit RLE compressed BMP images
		can be displayed via the splashscreen support or the
		bmp command.

1315 1316 1317 1318 1319 1320 1321
- 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.

1322
		NOTE: the bzip2 algorithm requires a lot of RAM, so
1323
		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1324
		be at least 4MB.
1325

1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
		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
1347
		the appropriate CONFIG_SYS_MALLOC_LEN value).
1348

1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
- 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
1361
		detection of gigabit PHY is included.
1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374

		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
1375 1376
- Ethernet address:
		CONFIG_ETHADDR
1377
		CONFIG_ETH1ADDR
wdenk's avatar
wdenk committed
1378 1379
		CONFIG_ETH2ADDR
		CONFIG_ETH3ADDR
1380 1381
		CONFIG_ETH4ADDR
		CONFIG_ETH5ADDR
wdenk's avatar
wdenk committed
1382

1383 1384
		Define a default value for Ethernet address to use
		for the respective Ethernet interface, in case this
wdenk's avatar
wdenk committed
1385 1386 1387 1388 1389 1390
		is not determined automatically.

- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
1391
		the default Ethernet interface, in case this is not
wdenk's avatar
wdenk committed
1392 1393 1394 1395 1396
		determined through e.g. bootp.

- Server IP address:
		CONFIG_SERVERIP

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

1400 1401 1402 1403 1404
		CONFIG_KEEP_SERVERADDR

		Keeps the server's MAC address, in the env 'serveraddr'
		for passing to bootargs (like Linux's netconsole option)

1405 1406 1407 1408 1409
- 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
1410
		tftp down the same boot image concurrently.  Note: the Ethernet
1411 1412 1413
		driver in use must provide a function: mcast() to join/leave a
		multicast group.

wdenk's avatar
wdenk committed
1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
- 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
1425
		following delays are inserted then:
wdenk's avatar
wdenk committed
1426 1427 1428 1429 1430 1431 1432

		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

1433
- DHCP Advanced Options:
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448
		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
1449

1450 1451
		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
		environment variable, not the BOOTP server.
1452 1453 1454 1455 1456 1457 1458 1459

		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
1460
		is defined.
1461 1462 1463 1464

		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.
1465
		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1466 1467
		of the "hostname" environment variable is passed as
		option 12 to the DHCP server.
1468

1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
		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.

1483
 - CDP Options:
wdenk's avatar
wdenk committed
1484
		CONFIG_CDP_DEVICE_ID
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496

		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
1497
		eth0 for the first Ethernet, eth1 for the second etc.
1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524

		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
1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
- 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

1544
		These enable I2C serial bus commands. Defining either of
1545
		(but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
1546
		include the appropriate I2C driver for the selected CPU.
wdenk's avatar
wdenk committed
1547

1548
		This will allow you to use i2c commands at the u-boot
1549
		command line (as long as you set CONFIG_CMD_I2C in
1550 1551
		CONFIG_COMMANDS) and communicate with i2c based realtime
		clock chips. See common/cmd_i2c.c for a description of the
1552
		command line interface.
wdenk's avatar
wdenk committed
1553

1554
		CONFIG_HARD_I2C selects a hardware I2C controller.
1555

1556
		CONFIG_SOFT_I2C configures u-boot to use a software (aka
1557 1558
		bit-banging) driver instead of CPM or similar hardware
		support for I2C.
wdenk's avatar
wdenk committed
1559

1560
		There are several other quantities that must also be
1561
		defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
wdenk's avatar
wdenk committed
1562

1563
		In both cases you will need to define CONFIG_SYS_I2C_SPEED
1564
		to be the frequency (in Hz) at which you wish your i2c bus
1565
		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
1566
		the CPU's i2c node address).
1567

1568
		Now, the u-boot i2c code for the mpc8xx
1569
		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
1570 1571 1572
		and so its address should therefore be cleared to 0 (See,
		eg, MPC823e User's Manual p.16-473). So, set
		CONFIG_SYS_I2C_SLAVE to 0.
wdenk's avatar
wdenk committed
1573

1574 1575 1576 1577 1578 1579 1580
		CONFIG_SYS_I2C_INIT_MPC5XXX

		When a board is reset during an i2c bus transfer
		chips might think that the current transfer is still
		in progress.  Reset the slave devices by sending start
		commands until the slave device responds.

1581
		That's all that's required for CONFIG_HARD_I2C.
wdenk's avatar
wdenk committed
1582

1583 1584 1585
		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
1586 1587 1588

		I2C_INIT

1589
		(Optional). Any commands necessary to enable the I2C
1590
		controller or configure ports.
wdenk's avatar
wdenk committed
1591

1592
		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
1593

wdenk's avatar
wdenk committed
1594 1595
		I2C_PORT

1596 1597 1598
		(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
1599 1600 1601 1602 1603 1604 1605

		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.

1606 1607
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

wdenk's avatar
wdenk committed
1608 1609 1610 1611 1612 1613
		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.

1614 1615
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

wdenk's avatar
wdenk committed
1616 1617 1618 1619 1620
		I2C_READ

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

1621 1622
		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)

wdenk's avatar
wdenk committed
1623 1624 1625 1626 1627
		I2C_SDA(bit)

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

1628
		eg: #define I2C_SDA(bit) \
1629
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
1630
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
1631

wdenk's avatar
wdenk committed
1632 1633 1634 1635 1636
		I2C_SCL(bit)

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

1637
		eg: #define I2C_SCL(bit) \
1638
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
1639
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
1640

wdenk's avatar
wdenk committed
1641 1642 1643 1644
		I2C_DELAY

		This delay is invoked four times per clock cycle so this
		controls the rate of data transfer.  The data rate thus
1645
		is 1 / (I2C_DELAY * 4). Often defined to be something
1646 1647
		like:

1648
		#define I2C_DELAY  udelay(2)
wdenk's avatar
wdenk committed
1649

1650 1651 1652 1653 1654 1655 1656 1657 1658 1659
		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA

		If your arch supports the generic GPIO framework (asm/gpio.h),
		then you may alternatively define the two GPIOs that are to be
		used as SCL / SDA.  Any of the previous I2C_xxx macros will
		have GPIO-based defaults assigned to them as appropriate.

		You should define these to the GPIO value as given directly to
		the generic GPIO functions.

1660
		CONFIG_SYS_I2C_INIT_BOARD
1661

wdenk's avatar
wdenk committed
1662 1663 1664 1665 1666 1667 1668 1669
		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.
1670

1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681
		CONFIG_SYS_I2C_BOARD_LATE_INIT

		An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
		defined a custom i2c_board_late_init() routine in
		boards/xxx/board.c is run AFTER the operations in i2c_init()
		is completed. This callpoint can be used to unreset i2c bus
		using CPU i2c controller register accesses for CPUs whose i2c
		controller provide such a method. It is called at the end of
		i2c_init() to allow i2c_init operations to setup the i2c bus
		controller on the CPU (e.g. setting bus speed & slave address).

1682 1683 1684 1685 1686 1687
		CONFIG_I2CFAST (PPC405GP|PPC405EP only)

		This option enables configuration of bi_iic_fast[] flags
		in u-boot bd_info structure based on u-boot environment
		variable "i2cfast". (see also i2cfast)

1688 1689 1690 1691 1692 1693 1694
		CONFIG_I2C_MULTI_BUS

		This option allows the use of multiple I2C buses, each of which
		must have a controller.  At any point in time, only one bus is
		active.  To switch to a different bus, use the 'i2c dev' command.
		Note that bus numbering is zero-based.

1695
		CONFIG_SYS_I2C_NOPROBES
1696 1697

		This option specifies a list of I2C devices that will be skipped
1698 1699 1700
		when the 'i2c probe' command is issued.  If CONFIG_I2C_MULTI_BUS
		is set, specify a list of bus-device pairs.  Otherwise, specify
		a 1D array of device addresses
1701 1702 1703

		e.g.
			#undef	CONFIG_I2C_MULTI_BUS
1704
			#define CONFIG_SYS_I2C_NOPROBES	{0x50,0x68}
1705 1706 1707 1708

		will skip addresses 0x50 and 0x68 on a board with one I2C bus

			#define	CONFIG_I2C_MULTI_BUS
1709
			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
1710 1711 1712

		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1

1713
		CONFIG_SYS_SPD_BUS_NUM
1714 1715 1716 1717

		If defined, then this indicates the I2C bus number for DDR SPD.
		If not defined, then U-Boot assumes that SPD is on I2C bus 0.

1718
		CONFIG_SYS_RTC_BUS_NUM
1719 1720 1721 1722

		If defined, then this indicates the I2C bus number for the RTC.
		If not defined, then U-Boot assumes that RTC is on I2C bus 0.

1723
		CONFIG_SYS_DTT_BUS_NUM
1724 1725 1726 1727

		If defined, then this indicates the I2C bus number for the DTT.
		If not defined, then U-Boot assumes that DTT is on I2C bus 0.

1728
		CONFIG_SYS_I2C_DTT_ADDR:
1729 1730 1731 1732 1733

		If defined, specifies the I2C address of the DTT device.
		If not defined, then U-Boot uses predefined value for
		specified DTT device.

1734 1735 1736
		CONFIG_FSL_I2C

		Define this option if you want to use Freescale's I2C driver in
1737
		drivers/i2c/fsl_i2c.c.
1738

1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772
		CONFIG_I2C_MUX

		Define this option if you have I2C devices reached over 1 .. n
		I2C Muxes like the pca9544a. This option addes a new I2C
		Command "i2c bus [muxtype:muxaddr:muxchannel]" which adds a
		new I2C Bus to the existing I2C Busses. If you select the
		new Bus with "i2c dev", u-bbot sends first the commandos for
		the muxes to activate this new "bus".

		CONFIG_I2C_MULTI_BUS must be also defined, to use this
		feature!

		Example:
		Adding a new I2C Bus reached over 2 pca9544a muxes
			The First mux with address 70 and channel 6
			The Second mux with address 71 and channel 4

		=> i2c bus pca9544a:70:6:pca9544a:71:4

		Use the "i2c bus" command without parameter, to get a list
		of I2C Busses with muxes:

		=> i2c bus
		Busses reached over muxes:
		Bus ID: 2
		  reached over Mux(es):
		    pca9544a@70 ch: 4
		Bus ID: 3
		  reached over Mux(es):
		    pca9544a@70 ch: 6
		    pca9544a@71 ch: 4
		=>

		If you now switch to the new I2C Bus 3 with "i2c dev 3"
1773 1774
		u-boot first sends the command to the mux@70 to enable
		channel 6, and then the command to the mux@71 to enable
1775 1776 1777
		the channel 4.

		After that, you can use the "normal" i2c commands as
1778
		usual to communicate with your I2C devices behind
1779 1780 1781 1782 1783 1784 1785
		the 2 muxes.

		This option is actually implemented for the bitbanging
		algorithm in common/soft_i2c.c and for the Hardware I2C
		Bus on the MPC8260. But it should be not so difficult
		to add this option to other architectures.

1786 1787 1788 1789 1790 1791 1792 1793 1794
		CONFIG_SOFT_I2C_READ_REPEATED_START

		defining this will force the i2c_read() function in
		the soft_i2c driver to perform an I2C repeated start
		between writing the address pointer and reading the
		data.  If this define is omitted the default behaviour
		of doing a stop-start sequence will be used.  Most I2C
		devices can use either method, but some require one or
		the other.
1795

wdenk's avatar
wdenk committed
1796 1797 1798 1799 1800 1801
- 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)

1802 1803 1804 1805 1806
		CONFIG_SH_SPI

		Enables the driver for SPI controller on SuperH. Currently
		only SH7757 is supported.

wdenk's avatar
wdenk committed
1807 1808 1809 1810 1811 1812 1813
		CONFIG_SPI_X

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

		CONFIG_SOFT_SPI

1814 1815 1816 1817 1818 1819 1820
		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
1821

1822 1823 1824 1825 1826 1827 1828 1829
		CONFIG_HARD_SPI

		Enables a hardware SPI driver for general-purpose reads
		and writes.  As with CONFIG_SOFT_SPI, the board configuration
		must define a list of chip-select function pointers.
		Currently supported on some MPC8xxx processors.  For an
		example, see include/configs/mpc8349emds.h.

1830 1831 1832 1833 1834
		CONFIG_MXC_SPI

		Enables the driver for the SPI controllers on i.MX and MXC
		SoCs. Currently only i.MX31 is supported.

1835
- FPGA Support: CONFIG_FPGA
wdenk's avatar
wdenk committed
1836

1837 1838 1839 1840 1841 1842
		Enables FPGA subsystem.

		CONFIG_FPGA_<vendor>

		Enables support for specific chip vendors.
		(ALTERA, XILINX)
wdenk's avatar
wdenk committed
1843

1844
		CONFIG_FPGA_<family>
wdenk's avatar
wdenk committed
1845

1846 1847 1848 1849 1850 1851
		Enables support for FPGA family.
		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)

		CONFIG_FPGA_COUNT

		Specify the number of FPGA devices to support.