README 232 KB
Newer Older
wdenk's avatar
wdenk committed
1
#
2
# (C) Copyright 2000 - 2013
wdenk's avatar
wdenk committed
3 4
# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
#
5
# SPDX-License-Identifier:	GPL-2.0+
wdenk's avatar
wdenk committed
6 7 8 9 10
#

Summary:
========

11
This directory contains the source code for U-Boot, a boot loader for
12 13 14 15
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
16 17

The development of U-Boot is closely related to Linux: some parts of
18 19
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
20 21 22 23 24 25 26 27 28 29 30 31 32 33
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
34
Makefile have been tested to some extent and can be considered
wdenk's avatar
wdenk committed
35 36
"working". In fact, many of them are used in production systems.

37
In case of problems see the CHANGELOG and CREDITS files to find out
38
who contributed the specific port. The boards.cfg file lists board
39
maintainers.
wdenk's avatar
wdenk committed
40

41 42 43 44 45
Note: There is no CHANGELOG file in the actual U-Boot source tree;
it can be created dynamically from the Git log using:

	make CHANGELOG

wdenk's avatar
wdenk committed
46 47 48 49

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

50 51
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
52 53 54 55
<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
56 57


58 59 60 61 62 63 64 65
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
66
any version you might be interested in. Official releases are also
67 68 69
available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
directory.

70
Pre-built (and tested) images are available from
71 72 73
ftp://ftp.denx.de/pub/u-boot/images/


wdenk's avatar
wdenk committed
74 75 76 77
Where we come from:
===================

- start from 8xxrom sources
78
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenk's avatar
wdenk committed
79 80 81 82 83 84 85
- 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
86
  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
87
- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenk's avatar
wdenk committed
88
- add other CPU families (starting with ARM)
89
- create U-Boot project (http://sourceforge.net/projects/u-boot)
90
- current project page: see http://www.denx.de/wiki/U-Boot
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112


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
113 114


115 116 117
Versioning:
===========

118 119 120 121 122 123 124 125
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:
126
	U-Boot v2009.11	    - Release November 2009
127 128
	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
129 130


wdenk's avatar
wdenk committed
131 132 133
Directory Hierarchy:
====================

134
/arch			Architecture specific files
135 136 137 138
  /arc			Files generic to ARC architecture
    /cpu		CPU specific files
      /arc700		Files specific to ARC 700 CPUs
    /lib		Architecture specific library files
139 140 141 142
  /arm			Files generic to ARM architecture
    /cpu		CPU specific files
      /arm720t		Files specific to ARM 720 CPUs
      /arm920t		Files specific to ARM 920 CPUs
143
	/at91		Files specific to Atmel AT91RM9200 CPU
Wolfgang Denk's avatar
Wolfgang Denk committed
144 145
	/imx		Files specific to Freescale MC9328 i.MX CPUs
	/s3c24x0	Files specific to Samsung S3C24X0 CPUs
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
      /arm926ejs	Files specific to ARM 926 CPUs
      /arm1136		Files specific to ARM 1136 CPUs
      /pxa		Files specific to Intel XScale PXA 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
  /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
170
      /mips32		Files specific to MIPS32 CPUs
171
      /mips64		Files specific to MIPS64 CPUs
172
    /lib		Architecture specific library files
173 174 175 176
  /nds32		Files generic to NDS32 architecture
    /cpu		CPU specific files
      /n1213		Files specific to Andes Technology N1213 CPUs
    /lib		Architecture specific library files
177 178 179
  /nios2		Files generic to Altera NIOS2 architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
180 181 182
  /openrisc		Files generic to OpenRISC architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
183
  /powerpc		Files generic to PowerPC architecture
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    /cpu		CPU specific files
      /mpc5xx		Files specific to Freescale MPC5xx CPUs
      /mpc5xxx		Files specific to Freescale MPC5xxx CPUs
      /mpc8xx		Files specific to Freescale MPC8xx 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
203 204 205
  /x86			Files generic to x86 architecture
    /cpu		CPU specific files
    /lib		Architecture specific library files
206 207 208 209 210 211
/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
212
/dts			Contains Makefile for building internal U-Boot fdt.
213 214 215 216 217 218 219 220 221
/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
222
/spl			Secondary Program Loader framework
223
/tools			Tools to build S-Record or U-Boot images, etc.
wdenk's avatar
wdenk committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239

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
240
  "CONFIG_SYS_".
wdenk's avatar
wdenk committed
241 242 243 244 245 246 247 248 249 250 251 252

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
253
configurations available; just type "make <board_name>_defconfig".
wdenk's avatar
wdenk committed
254 255 256 257

Example: For a TQM823L module type:

	cd u-boot
258
	make TQM823L_defconfig
wdenk's avatar
wdenk committed
259

260
For the Cogent platform, you need to specify the CPU type as well;
261
e.g. "make cogent_mpc8xx_defconfig". And also configure the cogent
wdenk's avatar
wdenk committed
262 263 264
directory according to the instructions in cogent/README.


265 266 267 268 269 270 271 272
Sandbox Environment:
--------------------

U-Boot can be built natively to run on a Linux host using the 'sandbox'
board. This allows feature development which is not board- or architecture-
specific to be undertaken on a native platform. The sandbox is also used to
run some of U-Boot's tests.

273
See board/sandbox/README.sandbox for more details.
274 275


276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
Board Initialisation Flow:
--------------------------

This is the intended start-up flow for boards. This should apply for both
SPL and U-Boot proper (i.e. they both follow the same rules). At present SPL
mostly uses a separate code path, but the funtion names and roles of each
function are the same. Some boards or architectures may not conform to this.
At least most ARM boards which use CONFIG_SPL_FRAMEWORK conform to this.

Execution starts with start.S with three functions called during init after
that. The purpose and limitations of each is described below.

lowlevel_init():
	- purpose: essential init to permit execution to reach board_init_f()
	- no global_data or BSS
	- there is no stack (ARMv7 may have one but it will soon be removed)
	- must not set up SDRAM or use console
	- must only do the bare minimum to allow execution to continue to
		board_init_f()
	- this is almost never needed
	- return normally from this function

board_init_f():
	- purpose: set up the machine ready for running board_init_r():
		i.e. SDRAM and serial UART
	- global_data is available
	- stack is in SRAM
	- BSS is not available, so you cannot use global/static variables,
		only stack variables and global_data

	Non-SPL-specific notes:
	- dram_init() is called to set up DRAM. If already done in SPL this
		can do nothing

	SPL-specific notes:
	- you can override the entire board_init_f() function with your own
		version as needed.
	- preloader_console_init() can be called here in extremis
	- should set up SDRAM, and anything needed to make the UART work
	- these is no need to clear BSS, it will be done by crt0.S
	- must return normally from this function (don't call board_init_r()
		directly)

Here the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
this point the stack and global_data are relocated to below
CONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
memory.

board_init_r():
	- purpose: main execution, common code
	- global_data is available
	- SDRAM is available
	- BSS is available, all static/global variables can be used
	- execution eventually continues to main_loop()

	Non-SPL-specific notes:
	- U-Boot is relocated to the top of memory and is now running from
		there.

	SPL-specific notes:
	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
		CONFIG_SPL_STACK_R_ADDR points into SDRAM
	- preloader_console_init() can be called here - typically this is
		done by defining CONFIG_SPL_BOARD_INIT and then supplying a
		spl_board_init() function containing this call
	- loads U-Boot or (in falcon mode) Linux



wdenk's avatar
wdenk committed
345 346 347 348 349 350 351 352 353 354 355
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
356 357 358 359 360
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
361 362
The following options need to be configured:

363 364 365
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
366 367

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
368
		Define exactly one, e.g. CONFIG_ATSTK1002
wdenk's avatar
wdenk committed
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387

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

391 392 393 394 395
- Marvell Family Member
		CONFIG_SYS_MVFS		- define it if you want to enable
					  multiple fs option at one time
					  for marvell soc family

396
- 8xx CPU Options: (if using an MPC8xx CPU)
397 398
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
399 400
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
401 402
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
wdenk's avatar
wdenk committed
403

404
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
405 406
		CONFIG_SYS_8xx_CPUCLK_MIN
		CONFIG_SYS_8xx_CPUCLK_MAX
407
		CONFIG_8xx_CPUCLK_DEFAULT
408 409
			See doc/README.MPC866

410
		CONFIG_SYS_MEASURE_CPUCLK
411

412 413 414 415 416
		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
417
		RTC clock or CONFIG_SYS_8XX_XIN)
418

419 420 421 422 423
		CONFIG_SYS_DELAYED_ICACHE

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

424
- 85xx CPU Options:
425 426 427 428 429 430
		CONFIG_SYS_PPC64

		Specifies that the core is a 64-bit PowerPC implementation (implements
		the "64" category of the Power ISA). This is necessary for ePAPR
		compliance, among other possible reasons.

431 432 433 434 435 436
		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.

437 438 439 440 441
		CONFIG_SYS_FSL_PCIE_COMPAT

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

442 443 444 445 446 447 448 449 450
		CONFIG_SYS_PPC_E500_DEBUG_TLB

		Enables a temporary TLB entry to be used during boot to work
		around limitations in e500v1 and e500v2 external debugger
		support. This reduces the portions of the boot code where
		breakpoints and single stepping do not work.  The value of this
		symbol should be set to the TLB1 entry to be used for this
		purpose.

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
		CONFIG_SYS_FSL_ERRATUM_A004510

		Enables a workaround for erratum A004510.  If set,
		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.

		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)

		Defines one or two SoC revisions (low 8 bits of SVR)
		for which the A004510 workaround should be applied.

		The rest of SVR is either not relevant to the decision
		of whether the erratum is present (e.g. p2040 versus
		p2041) or is implied by the build target, which controls
		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.

		See Freescale App Note 4493 for more information about
		this erratum.

471 472
		CONFIG_A003399_NOR_WORKAROUND
		Enables a workaround for IFC erratum A003399. It is only
473
		required during NOR boot.
474

475 476
		CONFIG_A008044_WORKAROUND
		Enables a workaround for T1040/T1042 erratum A008044. It is only
477
		required during NAND boot and valid for Rev 1.0 SoC revision
478

479 480 481 482 483
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

		This is the value to write into CCSR offset 0x18600
		according to the A004510 workaround.

484 485 486 487
		CONFIG_SYS_FSL_DSP_DDR_ADDR
		This value denotes start offset of DDR memory which is
		connected exclusively to the DSP cores.

488 489 490 491
		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
		This value denotes start offset of M2 memory
		which is directly connected to the DSP core.

492 493 494 495
		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
		This value denotes start offset of M3 memory which is directly
		connected to the DSP core.

496 497 498
		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
		This value denotes start offset of DSP CCSR space.

499 500 501 502 503
		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
		Single Source Clock is clocking mode present in some of FSL SoC's.
		In this mode, a single differential clock is used to supply
		clocks to the sysclock, ddrclock and usbclock.

504 505 506 507
		CONFIG_SYS_CPC_REINIT_F
		This CONFIG is defined when the CPC is configured as SRAM at the
		time of U-boot entry and is required to be re-initialized.

508
		CONFIG_DEEP_SLEEP
509
		Indicates this SoC supports deep sleep feature. If deep sleep is
510 511
		supported, core will start to execute uboot when wakes up.

512
- Generic CPU options:
513 514 515 516 517 518
		CONFIG_SYS_GENERIC_GLOBAL_DATA
		Defines global data is initialized in generic board board_init_f().
		If this macro is defined, global data is created and cleared in
		generic board board_init_f(). Without this macro, architecture/board
		should initialize global data before calling board_init_f().

519 520 521 522 523
		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN

		Defines the endianess of the CPU. Implementation of those
		values is arch specific.

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544
		CONFIG_SYS_FSL_DDR
		Freescale DDR driver in use. This type of DDR controller is
		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
		SoCs.

		CONFIG_SYS_FSL_DDR_ADDR
		Freescale DDR memory-mapped register base.

		CONFIG_SYS_FSL_DDR_EMU
		Specify emulator support for DDR. Some DDR features such as
		deskew training are not available.

		CONFIG_SYS_FSL_DDRC_GEN1
		Freescale DDR1 controller.

		CONFIG_SYS_FSL_DDRC_GEN2
		Freescale DDR2 controller.

		CONFIG_SYS_FSL_DDRC_GEN3
		Freescale DDR3 controller.

545 546 547
		CONFIG_SYS_FSL_DDRC_GEN4
		Freescale DDR4 controller.

548 549 550
		CONFIG_SYS_FSL_DDRC_ARM_GEN3
		Freescale DDR3 controller for ARM-based SoCs.

551 552 553 554 555 556 557 558 559 560 561 562
		CONFIG_SYS_FSL_DDR1
		Board config to use DDR1. It can be enabled for SoCs with
		Freescale DDR1 or DDR2 controllers, depending on the board
		implemetation.

		CONFIG_SYS_FSL_DDR2
		Board config to use DDR2. It can be eanbeld for SoCs with
		Freescale DDR2 or DDR3 controllers, depending on the board
		implementation.

		CONFIG_SYS_FSL_DDR3
		Board config to use DDR3. It can be enabled for SoCs with
563 564 565 566 567 568 569 570 571
		Freescale DDR3 or DDR3L controllers.

		CONFIG_SYS_FSL_DDR3L
		Board config to use DDR3L. It can be enabled for SoCs with
		DDR3L controllers.

		CONFIG_SYS_FSL_DDR4
		Board config to use DDR4. It can be enabled for SoCs with
		DDR4 controllers.
572

573 574 575 576 577 578
		CONFIG_SYS_FSL_IFC_BE
		Defines the IFC controller register space as Big Endian

		CONFIG_SYS_FSL_IFC_LE
		Defines the IFC controller register space as Little Endian

579 580 581 582 583 584 585 586 587
		CONFIG_SYS_FSL_PBL_PBI
		It enables addition of RCW (Power on reset configuration) in built image.
		Please refer doc/README.pblimage for more details

		CONFIG_SYS_FSL_PBL_RCW
		It adds PBI(pre-boot instructions) commands in u-boot build image.
		PBI commands can be used to configure SoC before it starts the execution.
		Please refer doc/README.pblimage for more details

588 589 590 591
		CONFIG_SPL_FSL_PBL
		It adds a target to create boot binary having SPL binary in PBI format
		concatenated with u-boot binary.

592 593 594 595 596 597
		CONFIG_SYS_FSL_DDR_BE
		Defines the DDR controller register space as Big Endian

		CONFIG_SYS_FSL_DDR_LE
		Defines the DDR controller register space as Little Endian

598 599 600 601 602
		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
		Physical address from the view of DDR controllers. It is the
		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
		it could be different for ARM SoCs.

603 604 605 606 607
		CONFIG_SYS_FSL_DDR_INTLV_256B
		DDR controller interleaving on 256-byte. This is a special
		interleaving mode, handled by Dickens for Freescale layerscape
		SoCs with ARM core.

608 609 610 611 612 613
		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
		Number of controllers used as main memory.

		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
		Number of controllers used for other than main memory.

614 615 616 617 618 619
		CONFIG_SYS_FSL_SEC_BE
		Defines the SEC controller register space as Big Endian

		CONFIG_SYS_FSL_SEC_LE
		Defines the SEC controller register space as Little Endian

620
- Intel Monahans options:
621
		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
622 623 624 625 626

		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.

627
		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denk's avatar
Wolfgang Denk committed
628

629 630
		Defines the Monahans turbo mode to oscillator
		ratio. Valid values are 1 (default if undefined) and
Wolfgang Denk's avatar
Wolfgang Denk committed
631
		2. The core frequency as calculated above is multiplied
632
		by this value.
Wolfgang Denk's avatar
Wolfgang Denk committed
633

634 635 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 661 662 663 664 665
- 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.

666 667 668 669 670 671
- ARM options:
		CONFIG_SYS_EXCEPTION_VECTORS_HIGH

		Select high exception vectors of the ARM core, e.g., do not
		clear the V bit of the c1 register of CP15.

Aneesh V's avatar
Aneesh V committed
672 673 674 675 676 677 678 679
		CONFIG_SYS_THUMB_BUILD

		Use this flag to build U-Boot using the Thumb instruction
		set for ARM architectures. Thumb instruction set provides
		better code density. For ARM architectures that support
		Thumb2 this flag will result in Thumb2 code generated by
		GCC.

680
		CONFIG_ARM_ERRATA_716044
681 682 683
		CONFIG_ARM_ERRATA_742230
		CONFIG_ARM_ERRATA_743622
		CONFIG_ARM_ERRATA_751472
684
		CONFIG_ARM_ERRATA_761320
685 686 687
		CONFIG_ARM_ERRATA_773022
		CONFIG_ARM_ERRATA_774769
		CONFIG_ARM_ERRATA_794072
688 689 690 691 692 693 694

		If set, the workarounds for these ARM errata are applied early
		during U-Boot startup. Note that these options force the
		workarounds to be applied; no CPU-type/version detection
		exists, unlike the similar options in the Linux kernel. Do not
		set these options unless they apply!

695 696 697 698 699 700 701 702
		COUNTER_FREQUENCY
		Generic timer clock source frequency.

		COUNTER_FREQUENCY_REAL
		Generic timer clock source frequency if the real clock is
		different from COUNTER_FREQUENCY, and can only be determined
		at run time.

703 704 705
		NOTE: The following can be machine specific errata. These
		do have ability to provide rudimentary version and machine
		specific checks, but expect no product checks.
706
		CONFIG_ARM_ERRATA_430973
707
		CONFIG_ARM_ERRATA_454179
708
		CONFIG_ARM_ERRATA_621766
709
		CONFIG_ARM_ERRATA_798870
710
		CONFIG_ARM_ERRATA_801819
711

712 713 714 715 716 717 718
- Tegra SoC options:
		CONFIG_TEGRA_SUPPORT_NON_SECURE

		Support executing U-Boot in non-secure (NS) mode. Certain
		impossible actions will be skipped if the CPU is in NS mode,
		such as ARM architectural timer initialization.

719
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
720 721 722 723 724 725 726 727 728 729
		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
730
		"clocks_in_mhz=1" is automatically included in the
wdenk's avatar
wdenk committed
731 732
		default environment.

733 734
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

735
		When transferring memsize parameter to Linux, some versions
736 737 738
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

739
		CONFIG_OF_LIBFDT
740 741

		New kernel versions are expecting firmware settings to be
742 743 744 745 746 747
		passed using flattened device trees (based on open firmware
		concepts).

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

750 751 752 753
		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).
754
		OF_TBCLK - The timebase frequency.
755
		OF_STDOUT_PATH - The path to the console device
756

757 758
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
759

760 761 762 763
		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
764

765 766 767 768 769 770 771
		CONFIG_OF_SYSTEM_SETUP

		Other code has addition modification that it wants to make
		to the flat device tree before handing it off to the kernel.
		This causes ft_system_setup() to be called before booting
		the kernel.

772 773
		CONFIG_OF_BOOT_CPU

774
		This define fills in the correct boot CPU in the boot
775 776
		param header, the default value is zero if undefined.

777 778 779 780 781 782 783 784 785
		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.

786 787 788 789 790 791 792 793 794 795
		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.

796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
- 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.

814 815 816 817 818
- 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

819 820 821 822 823 824
- 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

825
- Serial Ports:
826
		CONFIG_PL010_SERIAL
827 828 829

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

830
		CONFIG_PL011_SERIAL
831 832 833 834 835 836 837 838 839 840 841 842 843 844

		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

845 846 847 848
		CONFIG_SERIAL_HW_FLOW_CONTROL

		Define this variable to enable hw flow control in serial driver.
		Current user of this option is drivers/serial/nsl16550.c driver
849

wdenk's avatar
wdenk committed
850
- Console Interface:
851 852 853 854
		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
855 856 857 858 859 860 861

		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
862
		defines (cf. smiLynxEM, i8042)
wdenk's avatar
wdenk committed
863 864 865 866 867 868 869 870 871
			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)
872 873
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
wdenk's avatar
wdenk committed
874 875
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
876
			VIDEO_FB_ADRS		framebuffer address
wdenk's avatar
wdenk committed
877 878 879 880 881 882 883 884 885
			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)
886
			CONFIG_SYS_CONSOLE_BLINK_COUNT blink interval (cf. i8042.c)
wdenk's avatar
wdenk committed
887 888
			CONFIG_CONSOLE_TIME	display time/date info in
						upper right corner
889
						(requires CONFIG_CMD_DATE)
wdenk's avatar
wdenk committed
890 891
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
892 893 894
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
wdenk's avatar
wdenk committed
895
			CONFIG_CONSOLE_EXTRA_INFO
896
						additional board info beside
wdenk's avatar
wdenk committed
897 898
						the logo

899 900 901 902
		When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
		a limited number of ANSI escape sequences (cursor control,
		erase functions and limited graphics rendition control).

903 904 905
		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
906

907 908 909 910
		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.
911

912 913 914 915 916
		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
			is 0x00.
		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
			is 0xa0.

wdenk's avatar
wdenk committed
917 918 919
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
920 921
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
922

923 924 925
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
926
		This option is actual only for 82xx and 8xx possible.
927 928 929 930
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

931
- Pre-Console Buffer:
932 933 934 935 936 937 938
		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
939
		bytes are output before the console is initialised, the
940 941
		earlier bytes are discarded.

942 943 944
		Note that when printing the buffer a copy is made on the
		stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.

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

948 949 950 951 952 953 954 955 956
- Safe printf() functions
		Define CONFIG_SYS_VSNPRINTF to compile in safe versions of
		the printf() functions. These are defined in
		include/vsprintf.h and include snprintf(), vsnprintf() and
		so on. Code size increase is approximately 300-500 bytes.
		If this option is not given then these functions will
		silently discard their buffer size argument - this means
		you are not getting any overflow checking in this case.

wdenk's avatar
wdenk committed
957 958 959
- Boot Delay:	CONFIG_BOOTDELAY - in seconds
		Delay before automatically booting the default image;
		set to -1 to disable autoboot.
960 961
		set to -2 to autoboot with no delay and not check for abort
		(even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
wdenk's avatar
wdenk committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981

		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_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
982 983 984
		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
985 986

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
987 988 989
		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
990
		RAM and NFS.
wdenk's avatar
wdenk committed
991

992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
- Bootcount:
		CONFIG_BOOTCOUNT_LIMIT
		Implements a mechanism for detecting a repeating reboot
		cycle, see:
		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit

		CONFIG_BOOTCOUNT_ENV
		If no softreset save registers are found on the hardware
		"bootcount" is stored in the environment. To prevent a
		saveenv on all reboots, the environment variable
		"upgrade_available" is used. If "upgrade_available" is
		0, "bootcount" is always 0, if "upgrade_available" is
		1 "bootcount" is incremented in the environment.
		So the Userspace Applikation must set the "upgrade_available"
		and "bootcount" variable to 0, if a boot was successfully.

wdenk's avatar
wdenk committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
- 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.

1033
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenk's avatar
wdenk committed
1034 1035
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
1036
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
1037 1038

- Monitor Functions:
1039 1040
		Monitor commands can be included or excluded
		from the build by using the #include files
1041
		<config_cmd_all.h> and #undef'ing unwanted
1042
		commands, or adding #define's for wanted commands.
1043 1044 1045 1046

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

1047
		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
1048 1049 1050 1051 1052 1053
		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
1054
		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
1055
		CONFIG_CMD_CACHE	* icache, dcache
1056
		CONFIG_CMD_CLK   	* clock command support
1057
		CONFIG_CMD_CONSOLE	  coninfo
1058
		CONFIG_CMD_CRC32	* crc32
1059 1060 1061
		CONFIG_CMD_DATE		* support for RTC, date/time...
		CONFIG_CMD_DHCP		* DHCP support
		CONFIG_CMD_DIAG		* Diagnostics
1062 1063 1064 1065
		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
1066 1067
		CONFIG_CMD_DTT		* Digital Therm and Thermostat
		CONFIG_CMD_ECHO		  echo arguments
Peter Tyser's avatar
Peter Tyser committed
1068
		CONFIG_CMD_EDITENV	  edit env variable
1069 1070
		CONFIG_CMD_EEPROM	* EEPROM read/write support
		CONFIG_CMD_ELF		* bootelf, bootvx
1071
		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
1072
		CONFIG_CMD_ENV_FLAGS	* display details about env flags
1073
		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
1074
		CONFIG_CMD_EXPORTENV	* export the environment
1075 1076
		CONFIG_CMD_EXT2		* ext2 command support
		CONFIG_CMD_EXT4		* ext4 command support
1077 1078
		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
					  that work for multiple fs types
1079
		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1080
		CONFIG_CMD_SAVEENV	  saveenv
1081
		CONFIG_CMD_FDC		* Floppy Disk Support
1082
		CONFIG_CMD_FAT		* FAT command support
1083 1084
		CONFIG_CMD_FLASH	  flinfo, erase, protect
		CONFIG_CMD_FPGA		  FPGA device initialization support
1085
		CONFIG_CMD_FUSE		* Device fuse support
Anton Staaf's avatar
Anton Staaf committed
1086
		CONFIG_CMD_GETTIME	* Get time since boot
Mike Frysinger's avatar
Mike Frysinger committed
1087
		CONFIG_CMD_GO		* the 'go' command (exec code)
1088
		CONFIG_CMD_GREPENV	* search environment
1089
		CONFIG_CMD_HASH		* calculate hash / digest
1090 1091 1092 1093
		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
1094
		CONFIG_CMD_IMLS		  List all images found in NOR flash
1095
		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1096
		CONFIG_CMD_IMMAP	* IMMR dump support
Simon Glass's avatar
Simon Glass committed
1097
		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
1098
		CONFIG_CMD_IMPORTENV	* import an environment
1099
		CONFIG_CMD_INI		* import data from an ini file into the env
1100 1101 1102 1103
		CONFIG_CMD_IRQ		* irqinfo
		CONFIG_CMD_ITEST	  Integer/string test of 2 values
		CONFIG_CMD_JFFS2	* JFFS2 Support
		CONFIG_CMD_KGDB		* kgdb
1104
		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1105 1106
		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
					  (169.254.*.*)
1107 1108
		CONFIG_CMD_LOADB	  loadb
		CONFIG_CMD_LOADS	  loads
1109
		CONFIG_CMD_MD5SUM	* print md5 message digest
1110
					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
1111
		CONFIG_CMD_MEMINFO	* Display detailed memory information
1112
		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1113
					  loop, loopw
1114
		CONFIG_CMD_MEMTEST	* mtest
1115 1116 1117
		CONFIG_CMD_MISC		  Misc functions like sleep etc
		CONFIG_CMD_MMC		* MMC memory mapped support
		CONFIG_CMD_MII		* MII utility commands
1118
		CONFIG_CMD_MTDPARTS	* MTD partition support
1119 1120
		CONFIG_CMD_NAND		* NAND support
		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
1121
		CONFIG_CMD_NFS		  NFS support
1122
		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
1123
		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1124 1125 1126 1127 1128
		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
1129
		CONFIG_CMD_READ		* Read raw data from partition
1130 1131
		CONFIG_CMD_REGINFO	* Register dump
		CONFIG_CMD_RUN		  run command in env variable
1132
		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1133 1134 1135 1136 1137 1138
		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)
1139
		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
1140
		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
1141
					  (requires CONFIG_CMD_MEMORY)
1142
		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
1143
		CONFIG_CMD_SOURCE	  "source" command Support
1144
		CONFIG_CMD_SPI		* SPI serial bus support
1145
		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
1146
		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1147 1148
		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
		CONFIG_CMD_TIMER	* access to the system tick timer
1149 1150
		CONFIG_CMD_USB		* USB support
		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1151
		CONFIG_CMD_MFSL		* Microblaze FSL support
1152
		CONFIG_CMD_XIMG		  Load part of Multi Image
1153
		CONFIG_CMD_UUID		* Generate random UUID or GUID string
wdenk's avatar
wdenk committed
1154 1155 1156 1157

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

1158 1159
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
wdenk's avatar
wdenk committed
1160

1161 1162
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenk's avatar
wdenk committed
1163 1164

	Note:	Don't enable the "icache" and "dcache" commands
1165
		(configuration option CONFIG_CMD_CACHE) unless you know
1166 1167 1168 1169 1170 1171
		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
1172 1173 1174 1175


		XXX - this list needs to get updated!

1176 1177
- Regular expression support:
		CONFIG_REGEX
1178 1179 1180 1181
		If this variable is defined, U-Boot is linked against
		the SLRE (Super Light Regular Expression) library,
		which adds regex support to some commands, as for
		example "env grep" and "setexpr".
1182

1183 1184 1185 1186 1187 1188 1189 1190
- Device tree:
		CONFIG_OF_CONTROL
		If this variable is defined, U-Boot will use a device tree
		to configure its devices, instead of relying on statically
		compiled #defines in the board file. This option is
		experimental and only available on a few boards. The device
		tree is available in the global data as gd->fdt_blob.

1191 1192
		U-Boot needs to get its device tree from somewhere. This can
		be done using one of the two options below:
1193 1194 1195 1196 1197 1198 1199

		CONFIG_OF_EMBED
		If this variable is defined, U-Boot will embed a device tree
		binary in its image. This device tree file should be in the
		board directory and called <soc>-<board>.dts. The binary file
		is then picked up in board_init_f() and made available through
		the global data structure as gd->blob.
1200

1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212
		CONFIG_OF_SEPARATE
		If this variable is defined, U-Boot will build a device tree
		binary. It will be called u-boot.dtb. Architecture-specific
		code will locate it at run-time. Generally this works by:

			cat u-boot.bin u-boot.dtb >image.bin

		and in fact, U-Boot does this for you, creating a file called
		u-boot-dtb.bin which is useful in the common case. You can
		still use the individual files if you need something more
		exotic.

wdenk's avatar
wdenk committed
1213 1214 1215
- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
		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
1227

1228 1229 1230
		CONFIG_AT91_HW_WDT_TIMEOUT
		specify the timeout in seconds. default 2 seconds.

1231 1232 1233 1234 1235
- 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.
1236 1237
		Any change to this variable will be reverted at the
		next reset.
1238

wdenk's avatar
wdenk committed
1239 1240
- Real-Time Clock:

1241
		When CONFIG_CMD_DATE is selected, the type of the RTC
wdenk's avatar
wdenk committed
1242 1243 1244 1245 1246
		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
1247
		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
wdenk's avatar
wdenk committed
1248
		CONFIG_RTC_MC146818	- use MC146818 RTC
1249
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
1250
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
1251
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1252
		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
1253
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
1254
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
1255
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
1256
		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
1257 1258
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
wdenk's avatar
wdenk committed
1259

1260 1261 1262
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

1263 1264 1265
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO

1266 1267 1268 1269
		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.

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

Simon Glass's avatar
Simon Glass committed
1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294
- I/O tracing:
		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
		accesses and can checksum them or write a list of them out
		to memory. See the 'iotrace' command for details. This is
		useful for testing device drivers since it can confirm that
		the driver behaves the same way before and after a code
		change. Currently this is supported on sandbox and arm. To
		add support for your architecture, add '#include <iotrace.h>'
		to the bottom of arch/<arch>/include/asm/io.h and test.

		Example output from the 'iotrace stats' command is below.
		Note that if the trace buffer is exhausted, the checksum will
		still continue to operate.

			iotrace is enabled
			Start:  10000000	(buffer start address)
			Size:   00010000	(buffer size)
			Offset: 00000120	(current buffer offset)
			Output: 10000120	(start + offset)
			Count:  00000018	(number of trace records)
			CRC32:  9526fb66	(CRC32 of all trace records)

wdenk's avatar
wdenk committed
1295 1296
- Timestamp Support:

1297 1298 1299
		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
1300
		automatically enabled when you select CONFIG_CMD_DATE .
wdenk's avatar
wdenk committed
1301

1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
- Partition Labels (disklabels) Supported:
		Zero or more of the following:
		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
		CONFIG_DOS_PARTITION   MS Dos partition table, traditional on the
				       Intel architecture, USB sticks, etc.
		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
				       bootloader.  Note 2TB partition limit; see
				       disk/part_efi.c
		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
wdenk's avatar
wdenk committed
1312

1313 1314
		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
		CONFIG_CMD_SCSI) you must configure support for at
1315
		least one non-MTD partition type as well.
wdenk's avatar
wdenk committed
1316 1317

- IDE Reset method:
1318 1319
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
1320

1321 1322 1323 1324
		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
1325 1326 1327 1328 1329 1330

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

1331 1332 1333 1334
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
1335
		Also look at CONFIG_SYS_64BIT_LBA.
1336 1337 1338
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

1339
		CONFIG_SYS_64BIT_LBA:
1340 1341 1342
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

wdenk's avatar
wdenk committed
1343 1344 1345 1346 1347
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

1348 1349 1350
		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
1351 1352
		maximum numbers of LUNs, SCSI ID's and target
		devices.
1353
		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
wdenk's avatar
wdenk committed
1354

1355 1356
		The environment variable 'scsidevs' is set to the number of
		SCSI devices found during the last scan.
1357

wdenk's avatar
wdenk committed
1358
- NETWORK Support (PCI):
1359
		CONFIG_E1000
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373
		Support for Intel 8254x/8257x gigabit chips.

		CONFIG_E1000_SPI
		Utility code for direct access to the SPI bus on Intel 8257x.
		This does not do anything useful unless you set at least one
		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.

		CONFIG_E1000_SPI_GENERIC
		Allow generic access to the SPI bus on the Intel 8257x, for
		example with the "sspi" command.

		CONFIG_CMD_E1000
		Management command for E1000 devices.  When used on devices
		with SPI support you can reprogram the EEPROM from U-Boot.
stroese's avatar
stroese committed
1374

wdenk's avatar
wdenk committed
1375 1376
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
1377
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenk's avatar
wdenk committed
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
		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.

1391 1392
- NETWORK Support (other):

1393 1394 1395 1396 1397 1398 1399 1400 1401 1402
		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.

1403 1404 1405
		CONFIG_CALXEDA_XGMAC
		Support for the Calxeda XGMAC device

1406
		CONFIG_LAN91C96
1407 1408 1409 1410 1411 1412 1413 1414 1415
		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

1416
		CONFIG_SMC91111
1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429
		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)

1430 1431 1432 1433 1434 1435
		CONFIG_DRIVER_TI_EMAC
		Support for davinci emac

			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
			Define this if you have more then 3 PHYs.

1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447
		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.

1448
		CONFIG_SMC911X
1449 1450
		Support for SMSC's LAN911x and LAN921x chips

1451
			CONFIG_SMC911X_BASE
1452 1453 1454
			Define this to hold the physical address
			of the device (I/O space)

1455
			CONFIG_SMC911X_32_BIT
1456 1457
			Define this if data bus is 32 bits

1458
			CONFIG_SMC911X_16_BIT
1459 1460
			Define this if data bus is 16 bits. If your processor
			automatically converts one 32 bit word to two 16 bit
1461
			words you may also try CONFIG_SMC911X_32_BIT.
1462

1463 1464 1465 1466 1467 1468 1469 1470 1471
		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

1472 1473 1474
			CONFIG_SH_ETHER_CACHE_WRITEBACK
			If this option is set, the driver enables cache flush.

1475 1476 1477 1478
- PWM Support:
		CONFIG_PWM_IMX
		Support for PWM modul on the imx6.

1479
- TPM Support:
1480 1481 1482
		CONFIG_TPM
		Support TPM devices.

1483 1484 1485 1486 1487 1488 1489
		CONFIG_TPM_TIS_I2C
		Support for i2c bus TPM devices. Only one device
		per system is supported at this time.

			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
			Define the burst count bytes upper limit

Dirk Eibach's avatar
Dirk Eibach committed
1490 1491 1492
		CONFIG_TPM_ATMEL_TWI
		Support for Atmel TWI TPM device. Requires I2C support.

1493
		CONFIG_TPM_TIS_LPC
1494 1495 1496 1497 1498 1499 1500 1501
		Support for generic parallel port TPM devices. Only one device
		per system is supported at this time.

			CONFIG_TPM_TIS_BASE_ADDRESS
			Base address where the generic TPM device is mapped
			to. Contemporary x86 systems usually map it at
			0xfed40000.

1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
		CONFIG_CMD_TPM
		Add tpm monitor functions.
		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
		provides monitor access to authorized functions.

		CONFIG_TPM
		Define this to enable the TPM support library which provides
		functional interfaces to some TPM commands.
		Requires support for a TPM device.

		CONFIG_TPM_AUTH_SESSIONS
		Define this to enable authorized functions in the TPM library.
		Requires CONFIG_TPM and CONFIG_SHA1.

wdenk's avatar
wdenk committed
1516 1517
- USB Support:
		At the moment only the UHCI host controller is
1518
		supported (PIP405, MIP405, MPC5200); define
wdenk's avatar
wdenk committed
1519 1520
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
1521
		and define CONFIG_USB_STORAGE to enable the USB
wdenk's avatar
wdenk committed
1522 1523 1524 1525
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
1526 1527 1528
		MPC5200 USB requires additional defines:
			CONFIG_USB_CLOCK
				for 528 MHz Clock: 0x0001bbbb
1529 1530
			CONFIG_PSC3_USB
				for USB on PSC3
1531 1532 1533
			CONFIG_USB_CONFIG
				for differential drivers: 0x00001000
				for single ended drivers: 0x00005000
1534 1535
				for differential drivers on PSC3: 0x00000100
				for single ended drivers on PSC3: 0x00004100
1536
			CONFIG_SYS_USB_EVENT_POLL
Zhang Wei's avatar
Zhang Wei committed
1537 1538
				May be defined to allow interrupt polling
				instead of using asynchronous interrupts
1539

1540 1541 1542
		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
		txfilltuning field in the EHCI controller on reset.

1543 1544 1545
		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
		HW module registers.

1546 1547 1548 1549
- 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
1550
		attach your USB cable. The Unix command "dmesg" should print
1551 1552
		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
1553
		appear to a USB host as a Linux gserial device or a
1554 1555 1556 1557 1558 1559 1560
		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
1561

1562 1563 1564 1565 1566 1567
			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
1568

1569 1570 1571 1572 1573 1574 1575 1576
			CONFIG_USBD_HS
			Define this to enable the high speed support for usb
			device and usbtty. If this feature is enabled, a routine
			int is_usbd_high_speed(void)
			also needs to be defined by the driver to dynamically poll
			whether the enumeration has succeded at high speed or full
			speed.

1577
			CONFIG_SYS_CONSOLE_IS_IN_ENV
1578 1579 1580 1581
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

			mpc8xx:
1582
				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
1583
				Derive USB clock from external clock "blah"
1584
				- CONFIG_SYS_USB_EXTC_CLK 0x02
Wolfgang Denk's avatar
Wolfgang Denk committed
1585

1586
				CONFIG_SYS_USB_BRG_CLK 0xBLAH
1587
				Derive USB clock from brgclk
1588
				- CONFIG_SYS_USB_BRG_CLK 0x04
1589

Wolfgang Denk's avatar
Wolfgang Denk committed
1590
		If you have a USB-IF assigned VendorID then you may wish to
1591
		define your own vendor specific values either in BoardName.h
Wolfgang Denk's avatar
Wolfgang Denk committed
1592
		or directly in usbd_vendor_info.h. If you don't define
1593 1594 1595 1596 1597 1598 1599
		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
1600

1601 1602 1603 1604 1605 1606 1607 1608 1609
			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
1610

1611 1612 1613 1614
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
1615

1616 1617 1618 1619 1620 1621 1622 1623
- ULPI Layer Support:
		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
		the generic ULPI layer. The generic layer accesses the ULPI PHY
		via the platform viewport, so you need both the genric layer and
		the viewport enabled. Currently only Chipidea/ARC based
		viewport is supported.
		To enable the ULPI layer support, define CONFIG_USB_ULPI and
		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
1624 1625 1626
		If your ULPI phy needs a different reference clock than the
		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
		the appropriate value in Hz.
wdenk's avatar
wdenk committed
1627

1628
- MMC Support:
wdenk's avatar
wdenk committed
1629 1630 1631
		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
1632
		to physical memory similar to flash. Command line is
1633 1634
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1635

1636 1637 1638 1639 1640 1641 1642 1643 1644
		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

1645 1646 1647 1648 1649 1650 1651 1652 1653 1654
		CONFIG_GENERIC_MMC
		Enable the generic MMC driver

		CONFIG_SUPPORT_EMMC_BOOT
		Enable some additional features of the eMMC boot partitions.

		CONFIG_SUPPORT_EMMC_RPMB
		Enable the commands for reading, writing and programming the
		key for the Replay Protection Memory Block partition in eMMC.

1655
- USB Device Firmware Update (DFU) class support:
1656
		CONFIG_USB_FUNCTION_DFU
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667
		This enables the USB portion of the DFU USB class

		CONFIG_CMD_DFU
		This enables the command "dfu" which is used to have
		U-Boot create a DFU class device via USB.  This command
		requires that the "dfu_alt_info" environment variable be
		set and define the alt settings to expose to the host.

		CONFIG_DFU_MMC
		This enables support for exposing (e)MMC devices via DFU.

1668 1669 1670
		CONFIG_DFU_NAND
		This enables support for exposing NAND devices via DFU.

Afzal Mohammed's avatar
Afzal Mohammed committed
1671 1672 1673 1674 1675 1676
		CONFIG_DFU_RAM
		This enables support for exposing RAM via DFU.
		Note: DFU spec refer to non-volatile memory usage, but
		allow usages beyond the scope of spec - here RAM usage,
		one that would help mostly the developer.

1677 1678 1679 1680 1681 1682
		CONFIG_SYS_DFU_DATA_BUF_SIZE
		Dfu transfer uses a buffer before writing data to the
		raw storage device. Make the size (in bytes) of this buffer
		configurable. The size of this buffer is also configurable
		through the "dfu_bufsiz" environment variable.

1683 1684 1685 1686 1687 1688 1689
		CONFIG_SYS_DFU_MAX_FILE_SIZE
		When updating files rather than the raw storage device,
		we use a static buffer to copy the file into and then write
		the buffer once we've been given the whole file.  Define
		this to the maximum filesize (in bytes) for the buffer.
		Default is 4 MiB if undefined.

1690 1691 1692 1693 1694 1695 1696 1697 1698 1699
		DFU_DEFAULT_POLL_TIMEOUT
		Poll timeout [ms], is the timeout a device can send to the
		host. The host must wait for this timeout before sending
		a subsequent DFU_GET_STATUS request to the device.

		DFU_MANIFEST_POLL_TIMEOUT
		Poll timeout [ms], which the device sends to the host when
		entering dfuMANIFEST state. Host waits this timeout, before
		sending again an USB request to the device.

1700
- USB Device Android Fastboot support:
1701 1702 1703
		CONFIG_USB_FUNCTION_FASTBOOT
		This enables the USB part of the fastboot gadget

1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714
		CONFIG_CMD_FASTBOOT
		This enables the command "fastboot" which enables the Android
		fastboot mode for the platform's USB device. Fastboot is a USB
		protocol for downloading images, flashing and device control
		used on Android devices.
		See doc/README.android-fastboot for more information.

		CONFIG_ANDROID_BOOT_IMAGE
		This enables support for booting images which use the Android
		image format header.

1715
		CONFIG_FASTBOOT_BUF_ADDR
1716 1717 1718 1719
		The fastboot protocol requires a large memory buffer for
		downloads. Define this to the starting RAM address to use for
		downloaded images.

1720
		CONFIG_FASTBOOT_BUF_SIZE
1721 1722 1723
		The fastboot protocol requires a large memory buffer for
		downloads. This buffer should be as large as possible for a
		platform. Define this to the size available RAM for fastboot.
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733

		CONFIG_FASTBOOT_FLASH
		The fastboot protocol includes a "flash" command for writing
		the downloaded image to a non-volatile storage device. Define
		this to enable the "fastboot flash" command.

		CONFIG_FASTBOOT_FLASH_MMC_DEV
		The fastboot "flash" command requires additional information
		regarding the non-volatile storage device. Define this to
		the eMMC device that fastboot should use to store the image.
1734

1735 1736 1737 1738 1739 1740 1741 1742 1743
		CONFIG_FASTBOOT_GPT_NAME
		The fastboot "flash" command supports writing the downloaded
		image to the Protective MBR and the Primary GUID Partition
		Table. (Additionally, this downloaded image is post-processed
		to generate and write the Backup GUID Partition Table.)
		This occurs when the specified "partition name" on the
		"fastboot flash" command line matches this value.
		Default is GPT_ENTRY_NAME (currently "gpt") if undefined.

1744 1745 1746 1747 1748
- 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

1749 1750
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
1751 1752
		Define these for a default partition on a NOR device

1753
		CONFIG_SYS_JFFS_CUSTOM_PART
1754 1755 1756 1757
		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
1758
		#define CONFIG_SYS_JFFS_SINGLE_PART	1
1759 1760 1761
		to disable the command chpart. This is the default when you
		have not defined a custom partition

1762 1763
- FAT(File Allocation Table) filesystem write function support:
		CONFIG_FAT_WRITE
1764 1765 1766 1767 1768 1769

		Define this to enable support for saving memory data as a
		file in FAT formatted partition.

		This will also enable the command "fatwrite" enabling the
		user to write files to FAT.
1770

1771 1772 1773 1774 1775 1776 1777
CBFS (Coreboot Filesystem) support
		CONFIG_CMD_CBFS

		Define this to enable support for reading from a Coreboot
		filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
		and cbfsload.

1778 1779 1780 1781 1782 1783
- FAT(File Allocation Table) filesystem cluster size:
		CONFIG_FS_FAT_MAX_CLUSTSIZE

		Define the max cluster size for fat operations else
		a default value of 65536 will be defined.

wdenk's avatar
wdenk committed
1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795
- 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.

1796 1797 1798 1799 1800
		CONFIG_CROS_EC_KEYB
		Enables a Chrome OS keyboard using the CROS_EC interface.
		This uses CROS_EC to communicate with a second microcontroller
		which provides key scans on request.

wdenk's avatar
wdenk committed
1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811
- 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
1812
		Enable Silicon Motion SMI 712/710/810 Video chip. The
1813 1814 1815 1816
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

wdenk's avatar
wdenk committed