README 228 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
wdenk's avatar
wdenk committed
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 38 39 40
In case of problems see the CHANGELOG file to find out who contributed
the specific port. In addition, there are various MAINTAINERS files
scattered throughout the U-Boot source identifying the people or
companies responsible for various boards and subsystems.
wdenk's avatar
wdenk committed
41

42 43 44
Note: As of August, 2010, there is no longer a CHANGELOG file in the
actual U-Boot source tree; however, it can be created dynamically
from the Git log using:
45 46 47

	make CHANGELOG

wdenk's avatar
wdenk committed
48 49 50 51

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

52
In case you have questions about, problems with or contributions for
53
U-Boot, you should send a message to the U-Boot mailing list at
54 55 56 57
<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
58 59


60 61 62
Where to get source code:
=========================

63
The U-Boot source code is maintained in the Git repository at
64 65 66 67
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
68
any version you might be interested in. Official releases are also
69 70 71
available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
directory.

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


wdenk's avatar
wdenk committed
76 77 78 79
Where we come from:
===================

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


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
115 116


wdenk's avatar
wdenk committed
117 118 119
Versioning:
===========

120 121 122 123 124 125 126 127
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:
Wolfgang Denk's avatar
Wolfgang Denk committed
128
	U-Boot v2009.11	    - Release November 2009
129 130
	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
wdenk's avatar
wdenk committed
131 132


wdenk's avatar
wdenk committed
133 134 135
Directory Hierarchy:
====================

136
/arch			Architecture specific files
137
  /arc			Files generic to ARC architecture
138 139 140 141 142 143
  /arm			Files generic to ARM architecture
  /avr32		Files generic to AVR32 architecture
  /blackfin		Files generic to Analog Devices Blackfin architecture
  /m68k			Files generic to m68k architecture
  /microblaze		Files generic to microblaze architecture
  /mips			Files generic to MIPS architecture
144
  /nds32		Files generic to NDS32 architecture
145
  /nios2		Files generic to Altera NIOS2 architecture
146
  /openrisc		Files generic to OpenRISC architecture
Stefan Roese's avatar
Stefan Roese committed
147
  /powerpc		Files generic to PowerPC architecture
148
  /sandbox		Files generic to HW-independent "sandbox"
149 150
  /sh			Files generic to SH architecture
  /sparc		Files generic to SPARC architecture
151
  /x86			Files generic to x86 architecture
152 153 154
/api			Machine/arch independent API for external apps
/board			Board dependent files
/common			Misc architecture independent functions
155
/configs		Board default configuration files
156 157 158
/disk			Code for disk drive partition handling
/doc			Documentation (don't expect too much)
/drivers		Commonly used device drivers
159
/dts			Contains Makefile for building internal U-Boot fdt.
160 161 162
/examples		Example code for standalone applications, etc.
/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
/include		Header Files
163 164
/lib			Library routines generic to all architectures
/Licenses		Various license files
165 166
/net			Networking code
/post			Power On Self Test
167 168
/scripts		Various build scripts and Makefiles
/test			Various unit test files
169
/tools			Tools to build S-Record or U-Boot images, etc.
wdenk's avatar
wdenk committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

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
186
  "CONFIG_SYS_".
wdenk's avatar
wdenk committed
187

188 189 190 191 192
Previously, all configuration was done by hand, which involved creating
symbolic links and editing configuration files manually. More recently,
U-Boot has added the Kbuild infrastructure used by the Linux kernel,
allowing you to use the "make menuconfig" command to configure your
build.
wdenk's avatar
wdenk committed
193 194 195 196 197 198


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

For all supported boards there are ready-to-use default
199
configurations available; just type "make <board_name>_defconfig".
wdenk's avatar
wdenk committed
200 201 202 203

Example: For a TQM823L module type:

	cd u-boot
204
	make TQM823L_defconfig
wdenk's avatar
wdenk committed
205

206 207 208
Note: If you're looking for the default configuration file for a board
you're sure used to be there but is now missing, check the file
doc/README.scrapyard for a list of no longer supported boards.
wdenk's avatar
wdenk committed
209

210 211 212 213 214 215 216 217
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.

218
See board/sandbox/README.sandbox for more details.
219 220


221 222 223 224
Board Initialisation Flow:
--------------------------

This is the intended start-up flow for boards. This should apply for both
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
SPL and U-Boot proper (i.e. they both follow the same rules).

Note: "SPL" stands for "Secondary Program Loader," which is explained in
more detail later in this file.

At present, SPL mostly uses a separate code path, but the function 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 typically starts with an architecture-specific (and possibly
CPU-specific) start.S file, such as:

	- arch/arm/cpu/armv7/start.S
	- arch/powerpc/cpu/mpc83xx/start.S
	- arch/mips/cpu/start.S
241

242 243
and so on. From there, three functions are called; the purpose and
limitations of each of these functions are described below.
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 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

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
302 303 304 305 306 307 308 309 310 311 312
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
313 314 315 316 317
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
318 319
The following options need to be configured:

320 321 322
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
323 324

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
325
		Define exactly one, e.g. CONFIG_ATSTK1002
wdenk's avatar
wdenk committed
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344

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

348 349 350 351 352
- Marvell Family Member
		CONFIG_SYS_MVFS		- define it if you want to enable
					  multiple fs option at one time
					  for marvell soc family

353
- 8xx CPU Options: (if using an MPC8xx CPU)
wdenk's avatar
wdenk committed
354 355
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
wdenk's avatar
wdenk committed
356 357
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
wdenk's avatar
wdenk committed
358 359
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
wdenk's avatar
wdenk committed
360

wdenk's avatar
wdenk committed
361
- 859/866/885 CPU options: (if using a MPC859 or MPC866 or MPC885 CPU):
362 363
		CONFIG_SYS_8xx_CPUCLK_MIN
		CONFIG_SYS_8xx_CPUCLK_MAX
wdenk's avatar
wdenk committed
364
		CONFIG_8xx_CPUCLK_DEFAULT
365 366
			See doc/README.MPC866

367
		CONFIG_SYS_MEASURE_CPUCLK
368

wdenk's avatar
wdenk committed
369 370 371 372 373
		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
374
		RTC clock or CONFIG_SYS_8XX_XIN)
375

376 377 378 379 380
		CONFIG_SYS_DELAYED_ICACHE

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

381
- 85xx CPU Options:
382 383 384 385 386 387
		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.

388 389 390 391 392 393
		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.

394 395 396 397 398
		CONFIG_SYS_FSL_PCIE_COMPAT

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

399 400 401 402 403 404 405 406 407
		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.

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
		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.

428 429
		CONFIG_A003399_NOR_WORKAROUND
		Enables a workaround for IFC erratum A003399. It is only
430
		required during NOR boot.
431

432 433
		CONFIG_A008044_WORKAROUND
		Enables a workaround for T1040/T1042 erratum A008044. It is only
434
		required during NAND boot and valid for Rev 1.0 SoC revision
435

436 437 438 439 440
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

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

441 442 443 444
		CONFIG_SYS_FSL_DSP_DDR_ADDR
		This value denotes start offset of DDR memory which is
		connected exclusively to the DSP cores.

445 446 447 448
		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
		This value denotes start offset of M2 memory
		which is directly connected to the DSP core.

449 450 451 452
		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
		This value denotes start offset of M3 memory which is directly
		connected to the DSP core.

453 454 455
		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
		This value denotes start offset of DSP CCSR space.

456 457 458 459 460
		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.

461 462
		CONFIG_SYS_CPC_REINIT_F
		This CONFIG is defined when the CPC is configured as SRAM at the
Bin Meng's avatar
Bin Meng committed
463
		time of U-Boot entry and is required to be re-initialized.
464

465
		CONFIG_DEEP_SLEEP
466
		Indicates this SoC supports deep sleep feature. If deep sleep is
467 468
		supported, core will start to execute uboot when wakes up.

469
- Generic CPU options:
470 471 472 473 474 475
		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().

476 477 478 479 480
		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN

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

481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
		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.

502 503 504
		CONFIG_SYS_FSL_DDRC_GEN4
		Freescale DDR4 controller.

505 506 507
		CONFIG_SYS_FSL_DDRC_ARM_GEN3
		Freescale DDR3 controller for ARM-based SoCs.

508 509 510 511 512 513 514 515 516 517 518 519
		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
520 521 522 523 524 525 526 527 528
		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.
529

530 531 532 533 534 535
		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

536 537 538 539 540 541 542 543 544
		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

545 546 547 548
		CONFIG_SPL_FSL_PBL
		It adds a target to create boot binary having SPL binary in PBI format
		concatenated with u-boot binary.

549 550 551 552 553 554
		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

555 556 557 558 559
		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.

560 561 562 563 564
		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.

565 566 567 568 569 570
		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.

571 572 573
		CONFIG_SYS_FSL_HAS_DP_DDR
		Defines the SoC has DP-DDR used for DPAA.

574 575 576 577 578 579
		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

580
- Intel Monahans options:
581
		CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
582 583 584 585 586

		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.

587
		CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
Wolfgang Denk's avatar
Wolfgang Denk committed
588

589 590
		Defines the Monahans turbo mode to oscillator
		ratio. Valid values are 1 (default if undefined) and
Wolfgang Denk's avatar
Wolfgang Denk committed
591
		2. The core frequency as calculated above is multiplied
592
		by this value.
Wolfgang Denk's avatar
Wolfgang Denk committed
593

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
- 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.

626 627 628 629 630 631
- 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
632 633 634 635 636 637 638 639
		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.

640
		CONFIG_ARM_ERRATA_716044
641 642 643
		CONFIG_ARM_ERRATA_742230
		CONFIG_ARM_ERRATA_743622
		CONFIG_ARM_ERRATA_751472
644
		CONFIG_ARM_ERRATA_761320
645 646 647
		CONFIG_ARM_ERRATA_773022
		CONFIG_ARM_ERRATA_774769
		CONFIG_ARM_ERRATA_794072
648 649 650 651 652 653 654

		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!

655 656 657 658 659 660 661 662
		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.

663 664 665
		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.
666
		CONFIG_ARM_ERRATA_430973
667
		CONFIG_ARM_ERRATA_454179
668
		CONFIG_ARM_ERRATA_621766
669
		CONFIG_ARM_ERRATA_798870
670
		CONFIG_ARM_ERRATA_801819
671

672 673 674 675 676 677 678
- 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.

wdenk's avatar
wdenk committed
679
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
680 681 682 683 684 685 686 687 688 689
		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
690
		"clocks_in_mhz=1" is automatically included in the
wdenk's avatar
wdenk committed
691 692
		default environment.

wdenk's avatar
wdenk committed
693 694
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

695
		When transferring memsize parameter to Linux, some versions
wdenk's avatar
wdenk committed
696 697 698
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

699
		CONFIG_OF_LIBFDT
700 701

		New kernel versions are expecting firmware settings to be
702 703 704 705 706 707
		passed using flattened device trees (based on open firmware
		concepts).

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

710 711 712 713
		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).
714
		OF_TBCLK - The timebase frequency.
Kumar Gala's avatar
Kumar Gala committed
715
		OF_STDOUT_PATH - The path to the console device
716

717 718
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
719

720 721 722 723
		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
724

725 726 727 728 729 730 731
		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.

732 733
		CONFIG_OF_BOOT_CPU

734
		This define fills in the correct boot CPU in the boot
735 736
		param header, the default value is zero if undefined.

737 738 739 740 741 742 743 744 745
		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.

746 747 748 749 750 751 752 753 754 755
		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.

756 757 758
- vxWorks boot parameters:

		bootvx constructs a valid bootline using the following
759 760
		environments variables: bootdev, bootfile, ipaddr, netmask,
		serverip, gatewayip, hostname, othbootargs.
761 762 763 764 765
		It loads the vxWorks image pointed bootfile.

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

766 767 768 769 770
- 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

Aneesh V's avatar
Aneesh V committed
771 772 773 774 775 776
- 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

wdenk's avatar
wdenk committed
777
- Serial Ports:
778
		CONFIG_PL010_SERIAL
wdenk's avatar
wdenk committed
779 780 781

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

782
		CONFIG_PL011_SERIAL
wdenk's avatar
wdenk committed
783 784 785 786 787 788 789 790 791 792 793 794 795 796

		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

797 798 799 800
		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
wdenk's avatar
wdenk committed
801

wdenk's avatar
wdenk committed
802
- Console Interface:
803 804 805 806
		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
807 808 809 810 811 812 813

		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
814
		defines (cf. smiLynxEM, i8042)
wdenk's avatar
wdenk committed
815 816 817 818 819 820 821 822 823
			VIDEO_FB_LITTLE_ENDIAN	graphic memory organisation
						(default big endian)
			VIDEO_HW_RECTFILL	graphic chip supports
						rectangle fill
						(cf. smiLynxEM)
			VIDEO_HW_BITBLT		graphic chip supports
						bit-blit (cf. smiLynxEM)
			VIDEO_VISIBLE_COLS	visible pixel columns
						(cols=pitch)
wdenk's avatar
wdenk committed
824 825
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
wdenk's avatar
wdenk committed
826 827
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
wdenk's avatar
wdenk committed
828
			VIDEO_FB_ADRS		framebuffer address
wdenk's avatar
wdenk committed
829
			VIDEO_KBD_INIT_FCT	keyboard int fct
830
						(i.e. rx51_kp_init())
wdenk's avatar
wdenk committed
831
			VIDEO_TSTC_FCT		test char fct
832
						(i.e. rx51_kp_tstc)
wdenk's avatar
wdenk committed
833
			VIDEO_GETC_FCT		get char fct
834
						(i.e. rx51_kp_getc)
wdenk's avatar
wdenk committed
835 836
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
837 838 839
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
wdenk's avatar
wdenk committed
840
			CONFIG_CONSOLE_EXTRA_INFO
841
						additional board info beside
wdenk's avatar
wdenk committed
842 843
						the logo

844 845 846 847
		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).

848 849 850
		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
851

wdenk's avatar
wdenk committed
852 853 854 855
		When CONFIG_SILENT_CONSOLE is defined, all console
		messages (by U-Boot and Linux!) can be silenced with
		the "silent" environment variable. See
		doc/README.silent for more information.
wdenk's avatar
wdenk committed
856

857 858 859 860 861
		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
862 863 864
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
865 866
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
wdenk's avatar
wdenk committed
867

868 869 870
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
871
		This option is actual only for 82xx and 8xx possible.
872 873 874 875
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

876
- Pre-Console Buffer:
877 878 879 880 881 882 883
		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
Wolfgang Denk's avatar
Wolfgang Denk committed
884
		bytes are output before the console is initialised, the
885 886
		earlier bytes are discarded.

887 888 889
		Note that when printing the buffer a copy is made on the
		stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.

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

wdenk's avatar
wdenk committed
893 894 895 896 897 898 899 900
- 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
901 902 903
		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
904 905

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
906 907 908
		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
909
		RAM and NFS.
wdenk's avatar
wdenk committed
910

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
- 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
927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
- 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.

952
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
wdenk's avatar
wdenk committed
953 954
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
955
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
956 957

- Monitor Functions:
958 959
		Monitor commands can be included or excluded
		from the build by using the #include files
960
		<config_cmd_all.h> and #undef'ing unwanted
961
		commands, or adding #define's for wanted commands.
962 963 964 965

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

966
		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
967 968 969 970 971 972
		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
973
		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
974
		CONFIG_CMD_CACHE	* icache, dcache
Michal Simek's avatar
Michal Simek committed
975
		CONFIG_CMD_CLK   	* clock command support
976
		CONFIG_CMD_CONSOLE	  coninfo
Mike Frysinger's avatar
Mike Frysinger committed
977
		CONFIG_CMD_CRC32	* crc32
978 979 980
		CONFIG_CMD_DATE		* support for RTC, date/time...
		CONFIG_CMD_DHCP		* DHCP support
		CONFIG_CMD_DIAG		* Diagnostics
981 982 983 984
		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
985 986
		CONFIG_CMD_DTT		* Digital Therm and Thermostat
		CONFIG_CMD_ECHO		  echo arguments
Peter Tyser's avatar
Peter Tyser committed
987
		CONFIG_CMD_EDITENV	  edit env variable
988
		CONFIG_CMD_EEPROM	* EEPROM read/write support
989
		CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
990
		CONFIG_CMD_ELF		* bootelf, bootvx
991
		CONFIG_CMD_ENV_CALLBACK	* display details about env callbacks
992
		CONFIG_CMD_ENV_FLAGS	* display details about env flags
993
		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
994
		CONFIG_CMD_EXPORTENV	* export the environment
995 996
		CONFIG_CMD_EXT2		* ext2 command support
		CONFIG_CMD_EXT4		* ext4 command support
997 998
		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
					  that work for multiple fs types
999
		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
1000
		CONFIG_CMD_SAVEENV	  saveenv
1001
		CONFIG_CMD_FDC		* Floppy Disk Support
1002
		CONFIG_CMD_FAT		* FAT command support
1003 1004
		CONFIG_CMD_FLASH	  flinfo, erase, protect
		CONFIG_CMD_FPGA		  FPGA device initialization support
1005
		CONFIG_CMD_FUSE		* Device fuse support
Anton Staaf's avatar
Anton Staaf committed
1006
		CONFIG_CMD_GETTIME	* Get time since boot
Mike Frysinger's avatar
Mike Frysinger committed
1007
		CONFIG_CMD_GO		* the 'go' command (exec code)
Kim Phillips's avatar
Kim Phillips committed
1008
		CONFIG_CMD_GREPENV	* search environment
1009
		CONFIG_CMD_HASH		* calculate hash / digest
1010 1011 1012
		CONFIG_CMD_I2C		* I2C serial bus support
		CONFIG_CMD_IDE		* IDE harddisk support
		CONFIG_CMD_IMI		  iminfo
1013
		CONFIG_CMD_IMLS		  List all images found in NOR flash
1014
		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
1015
		CONFIG_CMD_IMMAP	* IMMR dump support
Simon Glass's avatar
Simon Glass committed
1016
		CONFIG_CMD_IOTRACE	* I/O tracing for debugging
1017
		CONFIG_CMD_IMPORTENV	* import an environment
Joe Hershberger's avatar
Joe Hershberger committed
1018
		CONFIG_CMD_INI		* import data from an ini file into the env
1019 1020 1021 1022
		CONFIG_CMD_IRQ		* irqinfo
		CONFIG_CMD_ITEST	  Integer/string test of 2 values
		CONFIG_CMD_JFFS2	* JFFS2 Support
		CONFIG_CMD_KGDB		* kgdb
1023
		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
1024 1025
		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
					  (169.254.*.*)
1026 1027
		CONFIG_CMD_LOADB	  loadb
		CONFIG_CMD_LOADS	  loads
1028
		CONFIG_CMD_MD5SUM	* print md5 message digest
Robin Getz's avatar
Robin Getz committed
1029
					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
1030
		CONFIG_CMD_MEMINFO	* Display detailed memory information
1031
		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
1032
					  loop, loopw
1033
		CONFIG_CMD_MEMTEST	* mtest
1034 1035 1036
		CONFIG_CMD_MISC		  Misc functions like sleep etc
		CONFIG_CMD_MMC		* MMC memory mapped support
		CONFIG_CMD_MII		* MII utility commands
1037
		CONFIG_CMD_MTDPARTS	* MTD partition support
1038 1039
		CONFIG_CMD_NAND		* NAND support
		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
1040
		CONFIG_CMD_NFS		  NFS support
1041
		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
Wolfgang Denk's avatar
Wolfgang Denk committed
1042
		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
1043 1044 1045 1046 1047
		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
1048
		CONFIG_CMD_READ		* Read raw data from partition
1049 1050
		CONFIG_CMD_REGINFO	* Register dump
		CONFIG_CMD_RUN		  run command in env variable
1051
		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
1052
		CONFIG_CMD_SAVES	* save S record dump
1053
		CONFIG_SCSI		* SCSI Support
1054 1055 1056 1057
		CONFIG_CMD_SDRAM	* print SDRAM configuration information
					  (requires CONFIG_CMD_I2C)
		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
					  (4xx only)
1058
		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
1059
		CONFIG_CMD_SHA1SUM	* print sha1 memory digest
Robin Getz's avatar
Robin Getz committed
1060
					  (requires CONFIG_CMD_MEMORY)
1061
		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
1062
		CONFIG_CMD_SOURCE	  "source" command Support
1063
		CONFIG_CMD_SPI		* SPI serial bus support
Luca Ceresoli's avatar
Luca Ceresoli committed
1064
		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
1065
		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
1066 1067
		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
		CONFIG_CMD_TIMER	* access to the system tick timer
1068 1069
		CONFIG_CMD_USB		* USB support
		CONFIG_CMD_CDP		* Cisco Discover Protocol support
1070
		CONFIG_CMD_MFSL		* Microblaze FSL support
1071
		CONFIG_CMD_XIMG		  Load part of Multi Image
1072
		CONFIG_CMD_UUID		* Generate random UUID or GUID string
wdenk's avatar
wdenk committed
1073 1074 1075 1076

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

1077 1078
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
wdenk's avatar
wdenk committed
1079

1080 1081
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
wdenk's avatar
wdenk committed
1082 1083

	Note:	Don't enable the "icache" and "dcache" commands
1084
		(configuration option CONFIG_CMD_CACHE) unless you know
1085 1086 1087 1088 1089 1090
		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
1091 1092 1093 1094


		XXX - this list needs to get updated!

1095 1096 1097 1098 1099 1100 1101 1102
- Removal of commands
		If no commands are needed to boot, you can disable
		CONFIG_CMDLINE to remove them. In this case, the command line
		will not be available, and when U-Boot wants to execute the
		boot command (on start-up) it will call board_run_command()
		instead. This can reduce image size significantly for very
		simple boot procedures.

1103 1104
- Regular expression support:
		CONFIG_REGEX
1105 1106 1107 1108
		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".
1109

1110 1111 1112 1113 1114 1115 1116 1117
- 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.

1118 1119
		U-Boot needs to get its device tree from somewhere. This can
		be done using one of the two options below:
1120 1121 1122 1123 1124 1125 1126

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

1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139
		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
1140 1141 1142
- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
		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
1154

1155 1156 1157
		CONFIG_AT91_HW_WDT_TIMEOUT
		specify the timeout in seconds. default 2 seconds.

1158 1159 1160 1161 1162
- 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.
1163 1164
		Any change to this variable will be reverted at the
		next reset.
1165

wdenk's avatar
wdenk committed
1166 1167
- Real-Time Clock:

1168
		When CONFIG_CMD_DATE is selected, the type of the RTC
wdenk's avatar
wdenk committed
1169 1170 1171 1172 1173
		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
1174
		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
wdenk's avatar
wdenk committed
1175
		CONFIG_RTC_MC146818	- use MC146818 RTC
wdenk's avatar
wdenk committed
1176
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
1177
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
1178
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1179
		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
wdenk's avatar
wdenk committed
1180
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
1181
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
wdenk's avatar
wdenk committed
1182
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
1183
		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
1184 1185
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
wdenk's avatar
wdenk committed
1186

wdenk's avatar
wdenk committed
1187 1188 1189
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

1190 1191 1192
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO

1193 1194 1195 1196
		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.

1197 1198 1199
		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
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221
- 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
1222 1223
- Timestamp Support:

1224 1225 1226
		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
1227
		automatically enabled when you select CONFIG_CMD_DATE .
wdenk's avatar
wdenk committed
1228

1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
- 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
1239

1240
		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1241
		CONFIG_SCSI) you must configure support for at
1242
		least one non-MTD partition type as well.
wdenk's avatar
wdenk committed
1243 1244

- IDE Reset method:
wdenk's avatar
wdenk committed
1245 1246
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
1247

wdenk's avatar
wdenk committed
1248 1249 1250 1251
		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
1252 1253 1254 1255 1256 1257

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

1258 1259 1260 1261
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
1262
		Also look at CONFIG_SYS_64BIT_LBA.
1263 1264 1265
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

1266
		CONFIG_SYS_64BIT_LBA:
wdenk's avatar