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

Summary:
========

11
This directory contains the source code for U-Boot, a boot loader for
W
wdenk 已提交
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.
W
wdenk 已提交
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
W
wdenk 已提交
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
W
wdenk 已提交
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.
W
wdenk 已提交
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

W
wdenk 已提交
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
W
wdenk 已提交
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
M
Marcel Ziswiler 已提交
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/


W
wdenk 已提交
76 77 78 79
Where we come from:
===================

- start from 8xxrom sources
80
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
W
wdenk 已提交
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
M
Marcel Ziswiler 已提交
88
  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
89
- create ARMBoot project (http://sourceforge.net/projects/armboot)
W
wdenk 已提交
90
- add other CPU families (starting with ARM)
91
- create U-Boot project (http://sourceforge.net/projects/u-boot)
M
Magnus Lilja 已提交
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
W
wdenk 已提交
115 116


W
wdenk 已提交
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:
W
Wolfgang Denk 已提交
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
W
wdenk 已提交
131 132


W
wdenk 已提交
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
S
Stefan Roese 已提交
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
/api			Machine/arch independent API for external apps
/board			Board dependent files
154
/cmd			U-Boot commands functions
155
/common			Misc architecture independent functions
156
/configs		Board default configuration files
157 158 159
/disk			Code for disk drive partition handling
/doc			Documentation (don't expect too much)
/drivers		Commonly used device drivers
160
/dts			Contains Makefile for building internal U-Boot fdt.
161 162 163
/examples		Example code for standalone applications, etc.
/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
/include		Header Files
164 165
/lib			Library routines generic to all architectures
/Licenses		Various license files
166 167
/net			Networking code
/post			Power On Self Test
168 169
/scripts		Various build scripts and Makefiles
/test			Various unit test files
170
/tools			Tools to build S-Record or U-Boot images, etc.
W
wdenk 已提交
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186

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
187
  "CONFIG_SYS_".
W
wdenk 已提交
188

189 190 191 192 193
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.
W
wdenk 已提交
194 195 196 197 198 199


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

For all supported boards there are ready-to-use default
200
configurations available; just type "make <board_name>_defconfig".
W
wdenk 已提交
201 202 203 204

Example: For a TQM823L module type:

	cd u-boot
205
	make TQM823L_defconfig
W
wdenk 已提交
206

207 208 209
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.
W
wdenk 已提交
210

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

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


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

This is the intended start-up flow for boards. This should apply for both
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
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
242

243 244
and so on. From there, three functions are called; the purpose and
limitations of each of these functions are described below.
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 302

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



W
wdenk 已提交
303 304 305 306 307 308 309 310 311 312 313
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".


W
wdenk 已提交
314 315 316 317 318
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.


W
wdenk 已提交
319 320
The following options need to be configured:

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

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

- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
326
		Define exactly one, e.g. CONFIG_ATSTK1002
W
wdenk 已提交
327

328 329 330 331 332
- Marvell Family Member
		CONFIG_SYS_MVFS		- define it if you want to enable
					  multiple fs option at one time
					  for marvell soc family

M
Marcel Ziswiler 已提交
333
- 8xx CPU Options: (if using an MPC8xx CPU)
W
wdenk 已提交
334 335
		CONFIG_8xx_GCLK_FREQ	- deprecated: CPU clock if
					  get_gclk_freq() cannot work
W
wdenk 已提交
336 337
					  e.g. if there is no 32KHz
					  reference PIT/RTC clock
W
wdenk 已提交
338 339
		CONFIG_8xx_OSCLK	- PLL input clock (either EXTCLK
					  or XTAL/EXTAL)
W
wdenk 已提交
340

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

347
		CONFIG_SYS_MEASURE_CPUCLK
348

W
wdenk 已提交
349 350 351 352 353
		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
354
		RTC clock or CONFIG_SYS_8XX_XIN)
355

356 357 358 359 360
		CONFIG_SYS_DELAYED_ICACHE

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

361
- 85xx CPU Options:
362 363 364 365 366 367
		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.

368 369 370 371 372 373
		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.

374 375 376 377 378
		CONFIG_SYS_FSL_PCIE_COMPAT

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

379 380 381 382 383 384 385 386 387
		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.

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
		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.

408 409
		CONFIG_A003399_NOR_WORKAROUND
		Enables a workaround for IFC erratum A003399. It is only
410
		required during NOR boot.
411

412 413
		CONFIG_A008044_WORKAROUND
		Enables a workaround for T1040/T1042 erratum A008044. It is only
414
		required during NAND boot and valid for Rev 1.0 SoC revision
415

416 417 418 419 420
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

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

421 422 423 424
		CONFIG_SYS_FSL_DSP_DDR_ADDR
		This value denotes start offset of DDR memory which is
		connected exclusively to the DSP cores.

425 426 427 428
		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
		This value denotes start offset of M2 memory
		which is directly connected to the DSP core.

429 430 431 432
		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
		This value denotes start offset of M3 memory which is directly
		connected to the DSP core.

433 434 435
		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
		This value denotes start offset of DSP CCSR space.

436 437 438 439 440
		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.

441 442
		CONFIG_SYS_CPC_REINIT_F
		This CONFIG is defined when the CPC is configured as SRAM at the
B
Bin Meng 已提交
443
		time of U-Boot entry and is required to be re-initialized.
444

445
		CONFIG_DEEP_SLEEP
446
		Indicates this SoC supports deep sleep feature. If deep sleep is
447 448
		supported, core will start to execute uboot when wakes up.

449
- Generic CPU options:
450 451 452 453 454 455
		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().

456 457 458 459 460
		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN

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

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
		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.

482 483 484
		CONFIG_SYS_FSL_DDRC_GEN4
		Freescale DDR4 controller.

485 486 487
		CONFIG_SYS_FSL_DDRC_ARM_GEN3
		Freescale DDR3 controller for ARM-based SoCs.

488 489 490 491 492 493
		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
494
		Board config to use DDR2. It can be enabled for SoCs with
495 496 497 498 499
		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
500 501 502 503 504 505 506 507 508
		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.
509

510 511 512 513 514 515
		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

516 517 518 519 520 521 522 523 524
		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

525 526 527 528
		CONFIG_SPL_FSL_PBL
		It adds a target to create boot binary having SPL binary in PBI format
		concatenated with u-boot binary.

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

535 536 537 538 539
		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.

540 541 542 543 544
		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.

545 546 547 548 549 550
		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.

551 552 553
		CONFIG_SYS_FSL_HAS_DP_DDR
		Defines the SoC has DP-DDR used for DPAA.

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

560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
- 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.

592 593 594 595 596 597
- 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.

A
Aneesh V 已提交
598 599 600 601 602 603 604 605
		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.

606
		CONFIG_ARM_ERRATA_716044
607 608 609
		CONFIG_ARM_ERRATA_742230
		CONFIG_ARM_ERRATA_743622
		CONFIG_ARM_ERRATA_751472
610
		CONFIG_ARM_ERRATA_761320
611 612 613
		CONFIG_ARM_ERRATA_773022
		CONFIG_ARM_ERRATA_774769
		CONFIG_ARM_ERRATA_794072
614 615 616 617 618 619 620

		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!

621 622 623 624 625 626 627 628
		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.

629 630 631
		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.
632
		CONFIG_ARM_ERRATA_430973
633
		CONFIG_ARM_ERRATA_454179
634
		CONFIG_ARM_ERRATA_621766
635
		CONFIG_ARM_ERRATA_798870
636
		CONFIG_ARM_ERRATA_801819
637

638 639 640 641 642 643 644
- 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.

W
wdenk 已提交
645
- Linux Kernel Interface:
W
wdenk 已提交
646 647 648 649 650 651 652 653 654 655
		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
656
		"clocks_in_mhz=1" is automatically included in the
W
wdenk 已提交
657 658
		default environment.

W
wdenk 已提交
659 660
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

661
		When transferring memsize parameter to Linux, some versions
W
wdenk 已提交
662 663 664
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

665
		CONFIG_OF_LIBFDT
666 667

		New kernel versions are expecting firmware settings to be
668 669 670 671 672 673
		passed using flattened device trees (based on open firmware
		concepts).

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

676 677 678 679
		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).
680
		OF_TBCLK - The timebase frequency.
K
Kumar Gala 已提交
681
		OF_STDOUT_PATH - The path to the console device
682

M
Marcel Ziswiler 已提交
683 684
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
685

686 687 688 689
		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
690

691 692 693 694 695 696 697
		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.

698 699
		CONFIG_OF_BOOT_CPU

M
Marcel Ziswiler 已提交
700
		This define fills in the correct boot CPU in the boot
701 702
		param header, the default value is zero if undefined.

703 704 705 706 707 708 709 710 711
		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.

712 713 714 715 716 717 718 719 720 721
		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.

722 723 724
- vxWorks boot parameters:

		bootvx constructs a valid bootline using the following
725 726
		environments variables: bootdev, bootfile, ipaddr, netmask,
		serverip, gatewayip, hostname, othbootargs.
727 728 729 730 731
		It loads the vxWorks image pointed bootfile.

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

732 733 734 735 736
- 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

A
Aneesh V 已提交
737 738 739 740 741 742
- 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

W
wdenk 已提交
743
- Serial Ports:
744
		CONFIG_PL010_SERIAL
W
wdenk 已提交
745 746 747

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

748
		CONFIG_PL011_SERIAL
W
wdenk 已提交
749 750 751 752 753 754 755 756 757 758 759 760 761 762

		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

763 764 765 766
		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
W
wdenk 已提交
767

W
wdenk 已提交
768
- Console Interface:
W
wdenk 已提交
769 770 771 772
		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
W
wdenk 已提交
773 774 775 776 777 778 779

		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
780
		defines (cf. smiLynxEM, i8042)
W
wdenk 已提交
781 782 783 784 785 786 787 788 789
			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)
W
wdenk 已提交
790 791
			VIDEO_VISIBLE_ROWS	visible pixel rows
			VIDEO_PIXEL_SIZE	bytes per pixel
W
wdenk 已提交
792 793
			VIDEO_DATA_FORMAT	graphic data format
						(0-5, cf. cfb_console.c)
W
wdenk 已提交
794
			VIDEO_FB_ADRS		framebuffer address
W
wdenk 已提交
795
			VIDEO_KBD_INIT_FCT	keyboard int fct
796
						(i.e. rx51_kp_init())
W
wdenk 已提交
797
			VIDEO_TSTC_FCT		test char fct
798
						(i.e. rx51_kp_tstc)
W
wdenk 已提交
799
			VIDEO_GETC_FCT		get char fct
800
						(i.e. rx51_kp_getc)
W
wdenk 已提交
801 802
			CONFIG_VIDEO_LOGO	display Linux logo in
						upper left corner
803 804 805
			CONFIG_VIDEO_BMP_LOGO	use bmp_logo.h instead of
						linux_logo.h for logo.
						Requires CONFIG_VIDEO_LOGO
W
wdenk 已提交
806
			CONFIG_CONSOLE_EXTRA_INFO
M
Marcel Ziswiler 已提交
807
						additional board info beside
W
wdenk 已提交
808
						the logo
809 810 811
			CONFIG_HIDE_LOGO_VERSION
						do not display bootloader
						version string
W
wdenk 已提交
812

813 814 815 816
		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).

W
wdenk 已提交
817 818 819
		When CONFIG_CFB_CONSOLE is defined, video console is
		default i/o. Serial console can be forced with
		environment 'console=serial'.
W
wdenk 已提交
820

W
wdenk 已提交
821 822 823 824
		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.
W
wdenk 已提交
825

826 827 828 829 830
		CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
			is 0x00.
		CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
			is 0xa0.

W
wdenk 已提交
831 832 833
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
834 835
		CONFIG_SYS_BAUDRATE_TABLE, see below.
		CONFIG_SYS_BRGCLK_PRESCALE, baudrate prescale
W
wdenk 已提交
836

837 838 839
- Console Rx buffer length
		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
		the maximum receive buffer length for the SMC.
840
		This option is actual only for 82xx and 8xx possible.
841 842 843 844
		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
		must be defined, to setup the maximum idle timeout for
		the SMC.

845
- Pre-Console Buffer:
846 847 848 849 850 851 852
		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
W
Wolfgang Denk 已提交
853
		bytes are output before the console is initialised, the
854 855
		earlier bytes are discarded.

856 857 858
		Note that when printing the buffer a copy is made on the
		stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.

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

W
wdenk 已提交
862 863 864 865 866 867 868 869
- 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
W
wdenk 已提交
870 871 872
		This can be used to pass arguments to the bootm
		command. The value of CONFIG_BOOTARGS goes into the
		environment value "bootargs".
W
wdenk 已提交
873 874

		CONFIG_RAMBOOT and CONFIG_NFSBOOT
W
wdenk 已提交
875 876 877
		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
M
Marcel Ziswiler 已提交
878
		RAM and NFS.
W
wdenk 已提交
879

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
- 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.

W
wdenk 已提交
896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
- 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.

921
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
W
wdenk 已提交
922 923
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
924
		CONFIG_SYS_BAUDRATE_TABLE, see below.
W
wdenk 已提交
925 926

- Monitor Functions:
927 928
		Monitor commands can be included or excluded
		from the build by using the #include files
929
		<config_cmd_all.h> and #undef'ing unwanted
930
		commands, or adding #define's for wanted commands.
931 932 933 934

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

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

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

1046 1047
		#include "config_cmd_all.h"
		#undef CONFIG_CMD_NET
W
wdenk 已提交
1048

1049 1050
	Other Commands:
		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
W
wdenk 已提交
1051 1052

	Note:	Don't enable the "icache" and "dcache" commands
1053
		(configuration option CONFIG_CMD_CACHE) unless you know
W
wdenk 已提交
1054 1055 1056 1057 1058 1059
		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.
W
wdenk 已提交
1060 1061 1062 1063


		XXX - this list needs to get updated!

1064 1065 1066 1067 1068 1069 1070 1071
- 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.

1072 1073
- Regular expression support:
		CONFIG_REGEX
1074 1075 1076 1077
		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".
1078

1079 1080 1081 1082 1083 1084 1085 1086
- 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.

1087 1088
		U-Boot needs to get its device tree from somewhere. This can
		be done using one of the two options below:
1089 1090 1091 1092 1093 1094 1095

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

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
		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.

W
wdenk 已提交
1109 1110 1111
- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
		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.
W
wdenk 已提交
1123

1124 1125 1126
		CONFIG_AT91_HW_WDT_TIMEOUT
		specify the timeout in seconds. default 2 seconds.

1127 1128 1129 1130 1131
- 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.
1132 1133
		Any change to this variable will be reverted at the
		next reset.
1134

W
wdenk 已提交
1135 1136
- Real-Time Clock:

1137
		When CONFIG_CMD_DATE is selected, the type of the RTC
W
wdenk 已提交
1138 1139 1140 1141 1142
		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
1143
		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
W
wdenk 已提交
1144
		CONFIG_RTC_MC146818	- use MC146818 RTC
W
wdenk 已提交
1145
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
W
wdenk 已提交
1146
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
W
wdenk 已提交
1147
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
1148
		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
W
wdenk 已提交
1149
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
T
Tor Krill 已提交
1150
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
W
wdenk 已提交
1151
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
1152
		CONFIG_SYS_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
1153 1154
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
W
wdenk 已提交
1155

W
wdenk 已提交
1156 1157 1158
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

1159 1160 1161
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO

C
Chris Packham 已提交
1162 1163 1164 1165
		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.

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

S
Simon Glass 已提交
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
- 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)

W
wdenk 已提交
1191 1192
- Timestamp Support:

W
wdenk 已提交
1193 1194 1195
		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
1196
		automatically enabled when you select CONFIG_CMD_DATE .
W
wdenk 已提交
1197

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
- 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.
W
wdenk 已提交
1208

1209
		If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
1210
		CONFIG_SCSI) you must configure support for at
1211
		least one non-MTD partition type as well.
W
wdenk 已提交
1212 1213

- IDE Reset method:
W
wdenk 已提交
1214 1215
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
W
wdenk 已提交
1216

W
wdenk 已提交
1217 1218 1219 1220
		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
W
wdenk 已提交
1221 1222 1223 1224 1225 1226

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

W
wdenk 已提交
1227 1228 1229 1230
- LBA48 Support
		CONFIG_LBA48

		Set this to enable support for disks larger than 137GB
1231
		Also look at CONFIG_SYS_64BIT_LBA.
W
wdenk 已提交
1232 1233 1234
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

1235
		CONFIG_SYS_64BIT_LBA:
W
wdenk 已提交
1236 1237 1238
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

W
wdenk 已提交
1239 1240 1241 1242 1243
- SCSI Support:
		At the moment only there is only support for the
		SYM53C8XX SCSI controller; define
		CONFIG_SCSI_SYM53C8XX to enable it.

1244 1245 1246
		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
W
wdenk 已提交
1247 1248
		maximum numbers of LUNs, SCSI ID's and target
		devices.
1249
		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
W
wdenk 已提交
1250

1251 1252
		The environment variable 'scsidevs' is set to the number of
		SCSI devices found during the last scan.
1253

W
wdenk 已提交
1254
- NETWORK Support (PCI):
1255
		CONFIG_E1000
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
		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.
S
stroese 已提交
1270

W
wdenk 已提交
1271 1272
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
M
Marcel Ziswiler 已提交
1273
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
W
wdenk 已提交
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286
		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.

W
wdenk 已提交
1287 1288
- NETWORK Support (other):

1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
		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.

R
Rob Herring 已提交
1299 1300 1301
		CONFIG_CALXEDA_XGMAC
		Support for the Calxeda XGMAC device

1302
		CONFIG_LAN91C96
W
wdenk 已提交
1303 1304 1305 1306 1307 1308 1309 1310 1311
		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

1312
		CONFIG_SMC91111
W
wdenk 已提交
1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325
		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)

1326 1327 1328 1329 1330 1331
		CONFIG_DRIVER_TI_EMAC
		Support for davinci emac

			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
			Define this if you have more then 3 PHYs.

1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
		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.

1344
		CONFIG_SMC911X
J
Jens Gehrlein 已提交
1345 1346
		Support for SMSC's LAN911x and LAN921x chips

1347
			CONFIG_SMC911X_BASE
J
Jens Gehrlein 已提交
1348 1349 1350
			Define this to hold the physical address
			of the device (I/O space)

1351
			CONFIG_SMC911X_32_BIT
J
Jens Gehrlein 已提交
1352 1353
			Define this if data bus is 32 bits

1354
			CONFIG_SMC911X_16_BIT
J
Jens Gehrlein 已提交
1355 1356
			Define this if data bus is 16 bits. If your processor
			automatically converts one 32 bit word to two 16 bit
1357
			words you may also try CONFIG_SMC911X_32_BIT.
J
Jens Gehrlein 已提交
1358

1359 1360 1361 1362 1363 1364 1365 1366 1367
		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

1368 1369 1370
			CONFIG_SH_ETHER_CACHE_WRITEBACK
			If this option is set, the driver enables cache flush.

1371 1372 1373 1374
- PWM Support:
		CONFIG_PWM_IMX
		Support for PWM modul on the imx6.

1375
- TPM Support:
1376 1377 1378
		CONFIG_TPM
		Support TPM devices.

1379 1380
		CONFIG_TPM_TIS_INFINEON
		Support for Infineon i2c bus TPM devices. Only one device
1381 1382 1383 1384 1385
		per system is supported at this time.

			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
			Define the burst count bytes upper limit

1386 1387 1388 1389 1390 1391 1392
		CONFIG_TPM_ST33ZP24
		Support for STMicroelectronics TPM devices. Requires DM_TPM support.

			CONFIG_TPM_ST33ZP24_I2C
			Support for STMicroelectronics ST33ZP24 I2C devices.
			Requires TPM_ST33ZP24 and I2C.

1393 1394 1395 1396
			CONFIG_TPM_ST33ZP24_SPI
			Support for STMicroelectronics ST33ZP24 SPI devices.
			Requires TPM_ST33ZP24 and SPI.

D
Dirk Eibach 已提交
1397 1398 1399
		CONFIG_TPM_ATMEL_TWI
		Support for Atmel TWI TPM device. Requires I2C support.

1400
		CONFIG_TPM_TIS_LPC
1401 1402 1403 1404 1405 1406 1407 1408
		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.

1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422
		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.

W
wdenk 已提交
1423 1424
- USB Support:
		At the moment only the UHCI host controller is
W
wdenk 已提交
1425
		supported (PIP405, MIP405, MPC5200); define
W
wdenk 已提交
1426 1427
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
W
wdenk 已提交
1428
		and define CONFIG_USB_STORAGE to enable the USB
W
wdenk 已提交
1429 1430 1431 1432
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
W
wdenk 已提交
1433 1434 1435
		MPC5200 USB requires additional defines:
			CONFIG_USB_CLOCK
				for 528 MHz Clock: 0x0001bbbb
1436 1437
			CONFIG_PSC3_USB
				for USB on PSC3
W
wdenk 已提交
1438 1439 1440
			CONFIG_USB_CONFIG
				for differential drivers: 0x00001000
				for single ended drivers: 0x00005000
1441 1442
				for differential drivers on PSC3: 0x00000100
				for single ended drivers on PSC3: 0x00004100
1443
			CONFIG_SYS_USB_EVENT_POLL
Z
Zhang Wei 已提交
1444 1445
				May be defined to allow interrupt polling
				instead of using asynchronous interrupts
W
wdenk 已提交
1446

1447 1448 1449
		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
		txfilltuning field in the EHCI controller on reset.

1450 1451 1452
		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
		HW module registers.

W
Wolfgang Denk 已提交
1453 1454 1455 1456
- 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
M
Marcel Ziswiler 已提交
1457
		attach your USB cable. The Unix command "dmesg" should print
W
Wolfgang Denk 已提交
1458 1459
		it has found a new device. The environment variable usbtty
		can be set to gserial or cdc_acm to enable your device to
W
Wolfgang Denk 已提交
1460
		appear to a USB host as a Linux gserial device or a
W
Wolfgang Denk 已提交
1461 1462 1463 1464 1465 1466 1467
		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
W
Wolfgang Denk 已提交
1468

W
Wolfgang Denk 已提交
1469 1470 1471 1472 1473 1474
			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
W
Wolfgang Denk 已提交
1475

1476 1477 1478 1479 1480 1481 1482 1483
			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.

1484
			CONFIG_SYS_CONSOLE_IS_IN_ENV
W
Wolfgang Denk 已提交
1485 1486 1487 1488
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

			mpc8xx:
1489
				CONFIG_SYS_USB_EXTC_CLK 0xBLAH
W
Wolfgang Denk 已提交
1490
				Derive USB clock from external clock "blah"
1491
				- CONFIG_SYS_USB_EXTC_CLK 0x02
W
Wolfgang Denk 已提交
1492

1493
				CONFIG_SYS_USB_BRG_CLK 0xBLAH
W
Wolfgang Denk 已提交
1494
				Derive USB clock from brgclk
1495
				- CONFIG_SYS_USB_BRG_CLK 0x04
W
Wolfgang Denk 已提交
1496

W
Wolfgang Denk 已提交
1497
		If you have a USB-IF assigned VendorID then you may wish to
W
Wolfgang Denk 已提交
1498
		define your own vendor specific values either in BoardName.h
W
Wolfgang Denk 已提交
1499
		or directly in usbd_vendor_info.h. If you don't define
W
Wolfgang Denk 已提交
1500 1501 1502 1503 1504 1505 1506
		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"
W
Wolfgang Denk 已提交
1507

W
Wolfgang Denk 已提交
1508 1509 1510 1511 1512 1513 1514 1515 1516
			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
W
Wolfgang Denk 已提交
1517

W
Wolfgang Denk 已提交
1518 1519 1520 1521
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
W
wdenk 已提交
1522

1523 1524 1525 1526 1527 1528 1529 1530
- 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.
L
Lucas Stach 已提交
1531 1532 1533
		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.
W
wdenk 已提交
1534

1535
- MMC Support:
W
wdenk 已提交
1536 1537 1538
		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
1539
		to physical memory similar to flash. Command line is
1540 1541
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1542

1543 1544 1545 1546 1547 1548 1549 1550 1551
		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

1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
		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.

1562
- USB Device Firmware Update (DFU) class support:
1563
		CONFIG_USB_FUNCTION_DFU
1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574
		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.

1575 1576 1577
		CONFIG_DFU_NAND
		This enables support for exposing NAND devices via DFU.

A
Afzal Mohammed 已提交
1578 1579 1580 1581 1582 1583
		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.

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

1590 1591 1592 1593 1594 1595 1596
		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.

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

1607
- USB Device Android Fastboot support:
1608 1609 1610
		CONFIG_USB_FUNCTION_FASTBOOT
		This enables the USB part of the fastboot gadget

1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621
		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.

1622
		CONFIG_FASTBOOT_BUF_ADDR
1623 1624 1625 1626
		The fastboot protocol requires a large memory buffer for
		downloads. Define this to the starting RAM address to use for
		downloaded images.

1627
		CONFIG_FASTBOOT_BUF_SIZE
1628 1629 1630
		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.
1631 1632 1633 1634 1635 1636 1637 1638 1639 1640

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

1642 1643 1644 1645 1646 1647 1648
		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.
1649
		The default is "gpt" if undefined.
1650

1651 1652 1653 1654 1655 1656 1657
		CONFIG_FASTBOOT_MBR_NAME
		The fastboot "flash" command supports writing the downloaded
		image to DOS MBR.
		This occurs when the "partition name" specified on the
		"fastboot flash" command line matches this value.
		If not defined the default value "mbr" is used.

W
wdenk 已提交
1658 1659 1660 1661 1662
- 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

1663 1664
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
W
wdenk 已提交
1665 1666
		Define these for a default partition on a NOR device

1667
		CONFIG_SYS_JFFS_CUSTOM_PART
W
wdenk 已提交
1668 1669 1670 1671
		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
1672
		#define CONFIG_SYS_JFFS_SINGLE_PART	1
W
wdenk 已提交
1673 1674 1675
		to disable the command chpart. This is the default when you
		have not defined a custom partition

D
Donggeun Kim 已提交
1676 1677
- FAT(File Allocation Table) filesystem write function support:
		CONFIG_FAT_WRITE
D
Donggeun Kim 已提交
1678 1679 1680 1681 1682 1683

		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.
D
Donggeun Kim 已提交
1684

1685 1686 1687 1688 1689 1690 1691
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.

1692 1693 1694 1695 1696 1697
- 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.

W
wdenk 已提交
1698
- Keyboard Support:
1699 1700 1701 1702 1703 1704 1705 1706 1707
		See Kconfig help for available keyboard drivers.

		CONFIG_KEYBOARD

		Define this to enable a custom keyboard support.
		This simply calls drv_keyboard_init() which must be
		defined in your board-specific files. This option is deprecated
		and is only used by novena. For new boards, use driver model
		instead.
W
wdenk 已提交
1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719

- 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
W
wdenk 已提交
1720
		Enable Silicon Motion SMI 712/710/810 Video chip. The
W
wdenk 已提交
1721 1722 1723 1724
		video output is selected via environment 'videoout'
		(1 = LCD and 2 = CRT). If videoout is undefined, CRT is
		assumed.

W
wdenk 已提交
1725
		For the CT69000 and SMI_LYNXEM drivers, videomode is
M
Marcel Ziswiler 已提交
1726
		selected via environment 'videomode'. Two different ways
W
wdenk 已提交
1727 1728
		are possible:
		- "videomode=num"   'num' is a standard LiLo mode numbers.
W
wdenk 已提交
1729
		Following standard modes are supported	(* is default):
W
wdenk 已提交
1730 1731 1732 1733 1734 1735 1736 1737

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

W
wdenk 已提交
1740
		- "videomode=bootargs" all the video parameters are parsed
1741
		from the bootargs. (See drivers/video/videomodes.c)
W
wdenk 已提交
1742 1743


1744
		CONFIG_VIDEO_SED13806
W
wdenk 已提交
1745
		Enable Epson SED13806 driver. This driver supports 8bpp
1746 1747 1748
		and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
		or CONFIG_VIDEO_SED13806_16BPP

1749
		CONFIG_FSL_DIU_FB
W
Wolfgang Denk 已提交
1750
		Enable the Freescale DIU video driver.	Reference boards for
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
		SOCs that have a DIU should define this macro to enable DIU
		support, and should also define these other macros:

			CONFIG_SYS_DIU_ADDR
			CONFIG_VIDEO
			CONFIG_CMD_BMP
			CONFIG_CFB_CONSOLE
			CONFIG_VIDEO_SW_CURSOR
			CONFIG_VGA_AS_SINGLE_DEVICE
			CONFIG_VIDEO_LOGO
			CONFIG_VIDEO_BMP_LOGO

1763 1764
		The DIU driver will look for the 'video-mode' environment
		variable, and if defined, enable the DIU as a console during
1765
		boot.  See the documentation file doc/README.video for a
1766
		description of this variable.
1767

W
wdenk 已提交
1768 1769 1770 1771 1772 1773
- LCD Support:	CONFIG_LCD

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

S
Stelian Pop 已提交
1774 1775 1776 1777
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

W
wdenk 已提交
1778
		CONFIG_NEC_NL6448AC33:
W
wdenk 已提交
1779

W
wdenk 已提交
1780
			NEC NL6448AC33-18. Active, color, single scan.
W
wdenk 已提交
1781

W
wdenk 已提交
1782
		CONFIG_NEC_NL6448BC20
W
wdenk 已提交
1783

W
wdenk 已提交
1784 1785 1786 1787 1788 1789
			NEC NL6448BC20-08. 6.5", 640x480.
			Active, color, single scan.

		CONFIG_NEC_NL6448BC33_54

			NEC NL6448BC33-54. 10.4", 640x480.
W
wdenk 已提交
1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817
			Active, color, single scan.

		CONFIG_SHARP_16x9

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

		CONFIG_SHARP_LQ64D341

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

		CONFIG_HLD1045

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

		CONFIG_OPTREX_BW

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

			320x240. Black & white.

		Normally display is black on white background; define
1818
		CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
W
wdenk 已提交
1819

1820 1821
		CONFIG_LCD_ALIGNMENT

1822
		Normally the LCD is page-aligned (typically 4KB). If this is
1823 1824 1825 1826 1827
		defined then the LCD will be aligned to this value instead.
		For ARM it is sometimes useful to use MMU_SECTION_SIZE
		here, since it is cheaper to change data cache settings on
		a per-section basis.

1828 1829 1830 1831 1832 1833
		CONFIG_CONSOLE_SCROLL_LINES

		When the console need to be scrolled, this is the number of
		lines to scroll by. It defaults to 1. Increasing this makes
		the console jump but can help speed up operation when scrolling
		is slow.
1834

1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854
		CONFIG_LCD_ROTATION

		Sometimes, for example if the display is mounted in portrait
		mode or even if it's mounted landscape but rotated by 180degree,
		we need to rotate our content of the display relative to the
		framebuffer, so that user can read the messages which are
		printed out.
		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
		initialized with a given rotation from "vl_rot" out of
		"vidinfo_t" which is provided by the board specific code.
		The value for vl_rot is coded as following (matching to
		fbcon=rotate:<n> linux-kernel commandline):
		0 = no rotation respectively 0 degree
		1 = 90 degree rotation
		2 = 180 degree rotation
		3 = 270 degree rotation

		If CONFIG_LCD_ROTATION is not defined, the console will be
		initialized with 0degree rotation.

1855 1856 1857 1858
		CONFIG_LCD_BMP_RLE8

		Support drawing of RLE8-compressed bitmaps on the LCD.

1859 1860 1861 1862 1863
		CONFIG_I2C_EDID

		Enables an 'i2c edid' command which can read EDID
		information over I2C from an attached LCD display.

W
wdenk 已提交
1864
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1865

W
wdenk 已提交
1866 1867 1868
		If this option is set, the environment is checked for
		a variable "splashimage". If found, the usual display
		of logo, copyright and system information on the LCD
1869
		is suppressed and the BMP image at the address
W
wdenk 已提交
1870 1871 1872 1873
		specified in "splashimage" is loaded instead. The
		console is redirected to the "nulldev", too. This
		allows for a "silent" boot where a splash screen is
		loaded very quickly after power-on.
1874

1875 1876 1877 1878
		CONFIG_SPLASHIMAGE_GUARD

		If this option is set, then U-Boot will prevent the environment
		variable "splashimage" from being set to a problematic address
1879
		(see doc/README.displaying-bmps).
1880 1881 1882 1883 1884 1885
		This option is useful for targets where, due to alignment
		restrictions, an improperly aligned BMP image will cause a data
		abort. If you think you will not have problems with unaligned
		accesses (for example because your toolchain prevents them)
		there is no need to set this option.

1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905
		CONFIG_SPLASH_SCREEN_ALIGN

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

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

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

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

S
Stefan Roese 已提交
1906 1907 1908 1909 1910 1911
- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP

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

1912 1913 1914 1915 1916 1917
- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8

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

1918
- Do compressing for memory range:
L
Lei Wen 已提交
1919 1920 1921 1922 1923
		CONFIG_CMD_ZIP

		If this option is set, it would use zlib deflate method
		to compress the specified memory at its best effort.

W
wdenk 已提交
1924
- Compression support:
1925 1926 1927 1928
		CONFIG_GZIP

		Enabled by default to support gzip compressed images.

W
wdenk 已提交
1929 1930 1931 1932 1933 1934
		CONFIG_BZIP2

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

W
wdenk 已提交
1935
		NOTE: the bzip2 algorithm requires a lot of RAM, so
1936
		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
W
wdenk 已提交
1937
		be at least 4MB.
1938

1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959
		CONFIG_LZMA

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

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

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

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

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

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

1962 1963 1964 1965 1966
		CONFIG_LZO

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

W
wdenk 已提交
1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
- MII/PHY support:
		CONFIG_PHY_ADDR

		The address of PHY on MII bus.

		CONFIG_PHY_CLOCK_FREQ (ppc4xx)

		The clock frequency of the MII bus

		CONFIG_PHY_GIGE

		If this option is set, support for speed/duplex
M
Marcel Ziswiler 已提交
1979
		detection of gigabit PHY is included.
W
wdenk 已提交
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992

		CONFIG_PHY_RESET_DELAY

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

		CONFIG_PHY_CMD_DELAY (ppc4xx)

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

W
wdenk 已提交
1993 1994 1995 1996
- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
M
Marcel Ziswiler 已提交
1997
		the default Ethernet interface, in case this is not
W
wdenk 已提交
1998
		determined through e.g. bootp.
1999
		(Environment variable "ipaddr")
W
wdenk 已提交
2000 2001 2002 2003

- Server IP address:
		CONFIG_SERVERIP

M
Marcel Ziswiler 已提交
2004
		Defines a default value for the IP address of a TFTP
W
wdenk 已提交
2005
		server to contact when using the "tftboot" command.
2006
		(Environment variable "serverip")
W
wdenk 已提交
2007

2008 2009 2010 2011 2012
		CONFIG_KEEP_SERVERADDR

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

2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029
- Gateway IP address:
		CONFIG_GATEWAYIP

		Defines a default value for the IP address of the
		default router where packets to other networks are
		sent to.
		(Environment variable "gatewayip")

- Subnet mask:
		CONFIG_NETMASK

		Defines a default value for the subnet mask (or
		routing prefix) which is used to determine if an IP
		address belongs to the local subnet or needs to be
		forwarded through a router.
		(Environment variable "netmask")

D
David Updegraff 已提交
2030 2031 2032 2033 2034
- Multicast TFTP Mode:
		CONFIG_MCAST_TFTP

		Defines whether you want to support multicast TFTP as per
		rfc-2090; for example to work with atftp.  Lets lots of targets
M
Marcel Ziswiler 已提交
2035
		tftp down the same boot image concurrently.  Note: the Ethernet
D
David Updegraff 已提交
2036 2037 2038
		driver in use must provide a function: mcast() to join/leave a
		multicast group.

W
wdenk 已提交
2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049
- BOOTP Recovery Mode:
		CONFIG_BOOTP_RANDOM_DELAY

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

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

2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075
		CONFIG_BOOTP_ID_CACHE_SIZE

		BOOTP packets are uniquely identified using a 32-bit ID. The
		server will copy the ID from client requests to responses and
		U-Boot will use this to determine if it is the destination of
		an incoming response. Some servers will check that addresses
		aren't in use before handing them out (usually using an ARP
		ping) and therefore take up to a few hundred milliseconds to
		respond. Network congestion may also influence the time it
		takes for a response to make it back to the client. If that
		time is too long, U-Boot will retransmit requests. In order
		to allow earlier responses to still be accepted after these
		retransmissions, U-Boot's BOOTP client keeps a small cache of
		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
		cache. The default is to keep IDs for up to four outstanding
		requests. Increasing this will allow U-Boot to accept offers
		from a BOOTP client in networks with unusually high latency.

2076
- DHCP Advanced Options:
2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091
		You can fine tune the DHCP functionality by defining
		CONFIG_BOOTP_* symbols:

		CONFIG_BOOTP_SUBNETMASK
		CONFIG_BOOTP_GATEWAY
		CONFIG_BOOTP_HOSTNAME
		CONFIG_BOOTP_NISDOMAIN
		CONFIG_BOOTP_BOOTPATH
		CONFIG_BOOTP_BOOTFILESIZE
		CONFIG_BOOTP_DNS
		CONFIG_BOOTP_DNS2
		CONFIG_BOOTP_SEND_HOSTNAME
		CONFIG_BOOTP_NTPSERVER
		CONFIG_BOOTP_TIMEOFFSET
		CONFIG_BOOTP_VENDOREX
2092
		CONFIG_BOOTP_MAY_FAIL
2093

W
Wilson Callan 已提交
2094 2095
		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
		environment variable, not the BOOTP server.
2096

2097 2098 2099 2100 2101 2102
		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
		after the configured retry count, the call will fail
		instead of starting over.  This can be used to fail over
		to Link-local IP address configuration if the DHCP server
		is not available.

2103 2104 2105 2106 2107 2108 2109
		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
		serverip from a DHCP server, it is possible that more
		than one DNS serverip is offered to the client.
		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
		serverip will be stored in the additional environment
		variable "dnsip2". The first DNS serverip is always
		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
2110
		is defined.
2111 2112 2113 2114

		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
		to do a dynamic update of a DNS server. To do this, they
		need the hostname of the DHCP requester.
W
Wilson Callan 已提交
2115
		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
2116 2117
		of the "hostname" environment variable is passed as
		option 12 to the DHCP server.
2118

2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132
		CONFIG_BOOTP_DHCP_REQUEST_DELAY

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

2133 2134 2135 2136 2137 2138 2139 2140
 - Link-local IP address negotiation:
		Negotiate with other link-local clients on the local network
		for an address that doesn't require explicit configuration.
		This is especially useful if a DHCP server cannot be guaranteed
		to exist in all environments that the device must operate.

		See doc/README.link-local for more information.

2141
 - CDP Options:
W
wdenk 已提交
2142
		CONFIG_CDP_DEVICE_ID
2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154

		The device id used in CDP trigger frames.

		CONFIG_CDP_DEVICE_ID_PREFIX

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

		CONFIG_CDP_PORT_ID

		A printf format string which contains the ascii name of
		the port. Normally is set to "eth%d" which sets
M
Marcel Ziswiler 已提交
2155
		eth0 for the first Ethernet, eth1 for the second etc.
2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182

		CONFIG_CDP_CAPABILITIES

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

		CONFIG_CDP_VERSION

		An ascii string containing the version of the software.

		CONFIG_CDP_PLATFORM

		An ascii string containing the name of the platform.

		CONFIG_CDP_TRIGGER

		A 32bit integer sent on the trigger.

		CONFIG_CDP_POWER_CONSUMPTION

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

		CONFIG_CDP_APPLIANCE_VLAN_TYPE

		A byte containing the id of the VLAN.

W
wdenk 已提交
2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193
- Status LED:	CONFIG_STATUS_LED

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

2194 2195 2196 2197 2198 2199 2200 2201
		Additional options:

		CONFIG_GPIO_LED
		The status LED can be connected to a GPIO pin.
		In such cases, the gpio_led driver can be used as a
		status LED backend implementation. Define CONFIG_GPIO_LED
		to include the gpio_led driver in the U-Boot binary.

2202 2203 2204 2205 2206 2207 2208
		CONFIG_GPIO_LED_INVERTED_TABLE
		Some GPIO connected LEDs may have inverted polarity in which
		case the GPIO high value corresponds to LED off state and
		GPIO low value corresponds to LED on state.
		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
		with a list of GPIO LEDs that have inverted polarity.

W
wdenk 已提交
2209 2210 2211 2212 2213 2214
- CAN Support:	CONFIG_CAN_DRIVER

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

2215 2216 2217 2218 2219 2220 2221 2222 2223 2224
- I2C Support:	CONFIG_SYS_I2C

		This enable the NEW i2c subsystem, and will allow you to use
		i2c commands at the u-boot command line (as long as you set
		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
		based realtime clock chips or other i2c devices. See
		common/cmd_i2c.c for a description of the command line
		interface.

		ported i2c driver to the new framework:
2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237
		- drivers/i2c/soft_i2c.c:
		  - activate first bus with CONFIG_SYS_I2C_SOFT define
		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
		    for defining speed and slave address
		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
		    for defining speed and slave address
		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
		    for defining speed and slave address
		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
		    for defining speed and slave address
2238

2239 2240 2241 2242 2243 2244
		- drivers/i2c/fsl_i2c.c:
		  - activate i2c driver with CONFIG_SYS_I2C_FSL
		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
		    bus.
2245
		  - If your board supports a second fsl i2c bus, define
2246 2247 2248 2249 2250
		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
		    second bus.

2251
		- drivers/i2c/tegra_i2c.c:
N
Nobuhiro Iwamatsu 已提交
2252 2253 2254
		  - activate this driver with CONFIG_SYS_I2C_TEGRA
		  - This driver adds 4 i2c buses with a fix speed from
		    100000 and the slave addr 0!
2255

2256 2257 2258 2259 2260
		- drivers/i2c/ppc4xx_i2c.c
		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1

T
trem 已提交
2261 2262
		- drivers/i2c/i2c_mxc.c
		  - activate this driver with CONFIG_SYS_I2C_MXC
2263 2264 2265 2266
		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
T
trem 已提交
2267 2268 2269 2270 2271 2272
		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
2273 2274
		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
2275
		If those defines are not set, default value is 100000
T
trem 已提交
2276 2277
		for speed, and 0 for slave.

2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291
		- drivers/i2c/rcar_i2c.c:
		  - activate this driver with CONFIG_SYS_I2C_RCAR
		  - This driver adds 4 i2c buses

		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses

2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
		- drivers/i2c/sh_i2c.c:
		  - activate this driver with CONFIG_SYS_I2C_SH
		  - This driver adds from 2 to 5 i2c buses

		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
		  - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
		  - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
2308
		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
2309

2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
		- drivers/i2c/omap24xx_i2c.c
		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4

2323 2324 2325 2326 2327
		- drivers/i2c/zynq_i2c.c
		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr

2328 2329 2330 2331 2332 2333
		- drivers/i2c/s3c24x0_i2c.c:
		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
		    with a fix speed from 100000 and the slave addr 0!

D
Dirk Eibach 已提交
2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347
		- drivers/i2c/ihs_i2c.c
		  - activate this driver with CONFIG_SYS_I2C_IHS
		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
D
Dirk Eibach 已提交
2348 2349 2350 2351 2352 2353 2354 2355 2356
		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
D
Dirk Eibach 已提交
2357

2358 2359 2360
		additional defines:

		CONFIG_SYS_NUM_I2C_BUSES
2361
		Hold the number of i2c buses you want to use. If you
2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376
		don't use/have i2c muxes on your i2c bus, this
		is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
		omit this define.

		CONFIG_SYS_I2C_DIRECT_BUS
		define this, if you don't use i2c muxes on your hardware.
		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
		omit this define.

		CONFIG_SYS_I2C_MAX_HOPS
		define how many muxes are maximal consecutively connected
		on one i2c bus. If you not use i2c muxes, omit this
		define.

		CONFIG_SYS_I2C_BUSES
2377
		hold a list of buses you want to use, only used if
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394
		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
		CONFIG_SYS_NUM_I2C_BUSES = 9:

		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
					{1, {I2C_NULL_HOP}}, \
					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
					}

		which defines
			bus 0 on adapter 0 without a mux
2395 2396 2397 2398 2399
			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
2400
			bus 6 on adapter 1 without a mux
2401 2402
			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
2403 2404 2405

		If you do not have i2c muxes on your board, omit this define.

2406
- Legacy I2C Support:	CONFIG_HARD_I2C
2407 2408 2409 2410 2411 2412 2413 2414 2415 2416

		NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
		provides the following compelling advantages:

		- more than one i2c adapter is usable
		- approved multibus support
		- better i2c mux support

		** Please consider updating your I2C driver now. **

2417 2418 2419
		These enable legacy I2C serial bus commands. Defining
		CONFIG_HARD_I2C will include the appropriate I2C driver
		for the selected CPU.
W
wdenk 已提交
2420

2421
		This will allow you to use i2c commands at the u-boot
2422
		command line (as long as you set CONFIG_CMD_I2C in
W
wdenk 已提交
2423 2424
		CONFIG_COMMANDS) and communicate with i2c based realtime
		clock chips. See common/cmd_i2c.c for a description of the
W
wdenk 已提交
2425
		command line interface.
W
wdenk 已提交
2426

B
Ben Warren 已提交
2427
		CONFIG_HARD_I2C selects a hardware I2C controller.
W
wdenk 已提交
2428

2429
		There are several other quantities that must also be
2430
		defined when you define CONFIG_HARD_I2C.
W
wdenk 已提交
2431

2432
		In both cases you will need to define CONFIG_SYS_I2C_SPEED
2433
		to be the frequency (in Hz) at which you wish your i2c bus
2434
		to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
M
Marcel Ziswiler 已提交
2435
		the CPU's i2c node address).
2436

2437
		Now, the u-boot i2c code for the mpc8xx
S
Stefan Roese 已提交
2438
		(arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
2439 2440 2441
		and so its address should therefore be cleared to 0 (See,
		eg, MPC823e User's Manual p.16-473). So, set
		CONFIG_SYS_I2C_SLAVE to 0.
W
wdenk 已提交
2442

2443 2444 2445 2446 2447 2448 2449
		CONFIG_SYS_I2C_INIT_MPC5XXX

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

2450
		That's all that's required for CONFIG_HARD_I2C.
W
wdenk 已提交
2451

2452
		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
W
wdenk 已提交
2453 2454
		then the following macros need to be defined (examples are
		from include/configs/lwmon.h):
W
wdenk 已提交
2455 2456 2457

		I2C_INIT

W
wdenk 已提交
2458
		(Optional). Any commands necessary to enable the I2C
W
wdenk 已提交
2459
		controller or configure ports.
W
wdenk 已提交
2460

W
wdenk 已提交
2461
		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
W
wdenk 已提交
2462

W
wdenk 已提交
2463 2464
		I2C_PORT

W
wdenk 已提交
2465 2466 2467
		(Only for MPC8260 CPU). The I/O port to use (the code
		assumes both bits are on the same port). Valid values
		are 0..3 for ports A..D.
W
wdenk 已提交
2468 2469 2470 2471 2472 2473 2474

		I2C_ACTIVE

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

W
wdenk 已提交
2475 2476
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

W
wdenk 已提交
2477 2478 2479 2480 2481 2482
		I2C_TRISTATE

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

W
wdenk 已提交
2483 2484
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

W
wdenk 已提交
2485 2486
		I2C_READ

Y
York Sun 已提交
2487 2488
		Code that returns true if the I2C data line is high,
		false if it is low.
W
wdenk 已提交
2489

W
wdenk 已提交
2490 2491
		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)

W
wdenk 已提交
2492 2493
		I2C_SDA(bit)

Y
York Sun 已提交
2494 2495
		If <bit> is true, sets the I2C data line high. If it
		is false, it clears it (low).
W
wdenk 已提交
2496

W
wdenk 已提交
2497
		eg: #define I2C_SDA(bit) \
W
wdenk 已提交
2498
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
W
wdenk 已提交
2499
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
W
wdenk 已提交
2500

W
wdenk 已提交
2501 2502
		I2C_SCL(bit)

Y
York Sun 已提交
2503 2504
		If <bit> is true, sets the I2C clock line high. If it
		is false, it clears it (low).
W
wdenk 已提交
2505

W
wdenk 已提交
2506
		eg: #define I2C_SCL(bit) \
W
wdenk 已提交
2507
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
W
wdenk 已提交
2508
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
W
wdenk 已提交
2509

W
wdenk 已提交
2510 2511 2512 2513
		I2C_DELAY

		This delay is invoked four times per clock cycle so this
		controls the rate of data transfer.  The data rate thus
W
wdenk 已提交
2514
		is 1 / (I2C_DELAY * 4). Often defined to be something
2515 2516
		like:

W
wdenk 已提交
2517
		#define I2C_DELAY  udelay(2)
W
wdenk 已提交
2518

2519 2520 2521 2522 2523 2524 2525 2526 2527 2528
		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA

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

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

2529
		CONFIG_SYS_I2C_INIT_BOARD
2530

W
wdenk 已提交
2531 2532 2533 2534 2535 2536 2537 2538
		When a board is reset during an i2c bus transfer
		chips might think that the current transfer is still
		in progress. On some boards it is possible to access
		the i2c SCLK line directly, either by using the
		processor pin as a GPIO or by having a second pin
		connected to the bus. If this option is defined a
		custom i2c_init_board() routine in boards/xxx/board.c
		is run early in the boot sequence.
2539

2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550
		CONFIG_SYS_I2C_BOARD_LATE_INIT

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

W
wdenk 已提交
2551 2552 2553 2554 2555 2556
		CONFIG_I2CFAST (PPC405GP|PPC405EP only)

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

B
Ben Warren 已提交
2557 2558 2559
		CONFIG_I2C_MULTI_BUS

		This option allows the use of multiple I2C buses, each of which
W
Wolfgang Denk 已提交
2560 2561
		must have a controller.	 At any point in time, only one bus is
		active.	 To switch to a different bus, use the 'i2c dev' command.
B
Ben Warren 已提交
2562 2563
		Note that bus numbering is zero-based.

2564
		CONFIG_SYS_I2C_NOPROBES
B
Ben Warren 已提交
2565 2566

		This option specifies a list of I2C devices that will be skipped
W
Wolfgang Denk 已提交
2567
		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
2568 2569
		is set, specify a list of bus-device pairs.  Otherwise, specify
		a 1D array of device addresses
B
Ben Warren 已提交
2570 2571 2572

		e.g.
			#undef	CONFIG_I2C_MULTI_BUS
W
Wolfgang Denk 已提交
2573
			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
B
Ben Warren 已提交
2574 2575 2576

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

W
Wolfgang Denk 已提交
2577
			#define CONFIG_I2C_MULTI_BUS
2578
			#define CONFIG_SYS_I2C_MULTI_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
B
Ben Warren 已提交
2579 2580 2581

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

2582
		CONFIG_SYS_SPD_BUS_NUM
T
Timur Tabi 已提交
2583 2584 2585 2586

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

2587
		CONFIG_SYS_RTC_BUS_NUM
2588 2589 2590 2591

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

2592
		CONFIG_SYS_DTT_BUS_NUM
2593 2594 2595 2596

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

2597
		CONFIG_SYS_I2C_DTT_ADDR:
2598 2599 2600 2601 2602

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

2603 2604 2605 2606 2607 2608 2609 2610 2611
		CONFIG_SOFT_I2C_READ_REPEATED_START

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

W
wdenk 已提交
2613 2614 2615 2616 2617 2618
- SPI Support:	CONFIG_SPI

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

2619 2620 2621 2622 2623
		CONFIG_SH_SPI

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

W
wdenk 已提交
2624 2625
		CONFIG_SOFT_SPI

W
wdenk 已提交
2626 2627 2628 2629 2630 2631 2632
		Enables a software (bit-bang) SPI driver rather than
		using hardware support. This is a general purpose
		driver that only requires three general I/O port pins
		(two outputs, one input) to function. If this is
		defined, the board configuration must define several
		SPI configuration items (port pins to use, etc). For
		an example, see include/configs/sacsng.h.
W
wdenk 已提交
2633

2634 2635 2636 2637 2638
		CONFIG_HARD_SPI

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

G
Guennadi Liakhovetski 已提交
2642 2643 2644
		CONFIG_MXC_SPI

		Enables the driver for the SPI controllers on i.MX and MXC
2645
		SoCs. Currently i.MX31/35/51 are supported.
G
Guennadi Liakhovetski 已提交
2646

2647 2648 2649 2650
		CONFIG_SYS_SPI_MXC_WAIT
		Timeout for waiting until spi transfer completed.
		default: (CONFIG_SYS_HZ/100)     /* 10 ms */

2651
- FPGA Support: CONFIG_FPGA
W
wdenk 已提交
2652

2653 2654 2655 2656 2657 2658
		Enables FPGA subsystem.

		CONFIG_FPGA_<vendor>

		Enables support for specific chip vendors.
		(ALTERA, XILINX)
W
wdenk 已提交
2659

2660
		CONFIG_FPGA_<family>
W
wdenk 已提交
2661

2662 2663 2664 2665 2666 2667
		Enables support for FPGA family.
		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)

		CONFIG_FPGA_COUNT

		Specify the number of FPGA devices to support.
W
wdenk 已提交
2668

2669 2670 2671 2672
		CONFIG_CMD_FPGA_LOADMK

		Enable support for fpga loadmk command

2673 2674 2675 2676 2677 2678 2679 2680 2681
		CONFIG_CMD_FPGA_LOADP

		Enable support for fpga loadp command - load partial bitstream

		CONFIG_CMD_FPGA_LOADBP

		Enable support for fpga loadbp command - load partial bitstream
		(Xilinx only)

2682
		CONFIG_SYS_FPGA_PROG_FEEDBACK
W
wdenk 已提交
2683

W
wdenk 已提交
2684
		Enable printing of hash marks during FPGA configuration.
W
wdenk 已提交
2685

2686
		CONFIG_SYS_FPGA_CHECK_BUSY
W
wdenk 已提交
2687

W
wdenk 已提交
2688 2689 2690 2691
		Enable checks on FPGA configuration interface busy
		status by the configuration function. This option
		will require a board or device specific function to
		be written.
W
wdenk 已提交
2692 2693 2694 2695 2696 2697

		CONFIG_FPGA_DELAY

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

2698
		CONFIG_SYS_FPGA_CHECK_CTRLC
W
wdenk 已提交
2699 2700
		Allow Control-C to interrupt FPGA configuration

2701
		CONFIG_SYS_FPGA_CHECK_ERROR
W
wdenk 已提交
2702

W
wdenk 已提交
2703 2704 2705 2706
		Check for configuration errors during FPGA bitfile
		loading. For example, abort during Virtex II
		configuration if the INIT_B line goes low (which
		indicated a CRC error).
W
wdenk 已提交
2707

2708
		CONFIG_SYS_FPGA_WAIT_INIT
W
wdenk 已提交
2709

2710 2711
		Maximum time to wait for the INIT_B line to de-assert
		after PROB_B has been de-asserted during a Virtex II
W
wdenk 已提交
2712
		FPGA configuration sequence. The default time is 500
M
Marcel Ziswiler 已提交
2713
		ms.
W
wdenk 已提交
2714

2715
		CONFIG_SYS_FPGA_WAIT_BUSY
W
wdenk 已提交
2716

2717
		Maximum time to wait for BUSY to de-assert during
M
Marcel Ziswiler 已提交
2718
		Virtex II FPGA configuration. The default is 5 ms.
W
wdenk 已提交
2719

2720
		CONFIG_SYS_FPGA_WAIT_CONFIG
W
wdenk 已提交
2721

W
wdenk 已提交
2722
		Time to wait after FPGA configuration. The default is
M
Marcel Ziswiler 已提交
2723
		200 ms.
W
wdenk 已提交
2724 2725

- Configuration Management:
2726 2727 2728 2729 2730 2731
		CONFIG_BUILD_TARGET

		Some SoCs need special image types (e.g. U-Boot binary
		with a special header) as build targets. By defining
		CONFIG_BUILD_TARGET in the SoC / board header, this
		special image will be automatically built upon calling
2732
		make / buildman.
2733

W
wdenk 已提交
2734 2735
		CONFIG_IDENT_STRING

W
wdenk 已提交
2736 2737
		If defined, this string will be added to the U-Boot
		version information (U_BOOT_VERSION)
W
wdenk 已提交
2738 2739 2740

- Vendor Parameter Protection:

W
wdenk 已提交
2741 2742
		U-Boot considers the values of the environment
		variables "serial#" (Board Serial Number) and
W
wdenk 已提交
2743
		"ethaddr" (Ethernet Address) to be parameters that
W
wdenk 已提交
2744 2745 2746 2747
		are set once by the board vendor / manufacturer, and
		protects these variables from casual modification by
		the user. Once set, these variables are read-only,
		and write or delete attempts are rejected. You can
M
Marcel Ziswiler 已提交
2748
		change this behaviour:
W
wdenk 已提交
2749 2750 2751

		If CONFIG_ENV_OVERWRITE is #defined in your config
		file, the write protection for vendor parameters is
2752
		completely disabled. Anybody can change or delete
W
wdenk 已提交
2753 2754
		these parameters.

2755 2756
		Alternatively, if you define _both_ an ethaddr in the
		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
M
Marcel Ziswiler 已提交
2757
		Ethernet address is installed in the environment,
W
wdenk 已提交
2758 2759 2760 2761
		which can be changed exactly ONCE by the user. [The
		serial# is unaffected by this, i. e. it remains
		read-only.]

2762 2763 2764 2765 2766
		The same can be accomplished in a more flexible way
		for any variable by configuring the type of access
		to allow for those variables in the ".flags" variable
		or define CONFIG_ENV_FLAGS_LIST_STATIC.

W
wdenk 已提交
2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782
- Protected RAM:
		CONFIG_PRAM

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

2783
			setenv bootargs ... mem=\${mem}
W
wdenk 已提交
2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795
			saveenv

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

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

2796 2797
			IVMS8, IVML24, SPD8xx, TQM8xxL,
			HERMES, IP860, RPXlite, LWMON,
2798
			FLAGADM, TQM8260
W
wdenk 已提交
2799

2800 2801 2802 2803 2804 2805 2806 2807
- Access to physical memory region (> 4GB)
		Some basic support is provided for operations on memory not
		normally accessible to U-Boot - e.g. some architectures
		support access to more than 4GB of memory on 32-bit
		machines using physical address extension or similar.
		Define CONFIG_PHYSMEM to access this basic support, which
		currently only supports clearing the memory.

W
wdenk 已提交
2808 2809 2810 2811 2812 2813
- Error Recovery:
		CONFIG_PANIC_HANG

		Define this variable to stop the system in case of a
		fatal error, so that you have to reset it manually.
		This is probably NOT a good idea for an embedded
M
Marcel Ziswiler 已提交
2814
		system where you want the system to reboot
W
wdenk 已提交
2815 2816 2817 2818 2819 2820
		automatically as fast as possible, but it may be
		useful during development since you can try to debug
		the conditions that lead to the situation.

		CONFIG_NET_RETRY_COUNT

W
wdenk 已提交
2821 2822 2823 2824
		This variable defines the number of retries for
		network operations like ARP, RARP, TFTP, or BOOTP
		before giving up the operation. If not defined, a
		default value of 5 is used.
W
wdenk 已提交
2825

2826 2827 2828 2829
		CONFIG_ARP_TIMEOUT

		Timeout waiting for an ARP reply in milliseconds.

2830 2831 2832 2833 2834 2835 2836
		CONFIG_NFS_TIMEOUT

		Timeout in milliseconds used in NFS protocol.
		If you encounter "ERROR: Cannot umount" in nfs command,
		try longer timeout such as
		#define CONFIG_NFS_TIMEOUT 10000UL

W
wdenk 已提交
2837
- Command Interpreter:
2838
		CONFIG_AUTO_COMPLETE
2839 2840 2841

		Enable auto completion of commands using TAB.

2842
		CONFIG_SYS_PROMPT_HUSH_PS2
W
wdenk 已提交
2843 2844 2845 2846 2847 2848 2849

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

	Note:

W
wdenk 已提交
2850 2851 2852 2853 2854 2855 2856
		In the current implementation, the local variables
		space and global environment variables space are
		separated. Local variables are those you define by
		simply typing `name=value'. To access a local
		variable later on, you have write `$name' or
		`${name}'; to execute the contents of a variable
		directly type `$name' at the command prompt.
W
wdenk 已提交
2857

W
wdenk 已提交
2858 2859 2860 2861
		Global environment variables are those you use
		setenv/printenv to work with. To run a command stored
		in such a variable, you need to use the run command,
		and you must not use the '$' sign to access them.
W
wdenk 已提交
2862 2863 2864 2865 2866 2867 2868

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

2869
- Command Line Editing and History:
2870 2871
		CONFIG_CMDLINE_EDITING

M
Marcel Ziswiler 已提交
2872
		Enable editing and History functions for interactive
2873
		command line input operations
2874

2875 2876 2877 2878 2879 2880 2881 2882
- Command Line PS1/PS2 support:
		CONFIG_CMDLINE_PS_SUPPORT

		Enable support for changing the command prompt string
		at run-time. Only static string is supported so far.
		The string is obtained from environment variables PS1
		and PS2.

W
wdenk 已提交
2883
- Default Environment:
W
wdenk 已提交
2884 2885
		CONFIG_EXTRA_ENV_SETTINGS

W
wdenk 已提交
2886 2887
		Define this to contain any number of null terminated
		strings (variable = value pairs) that will be part of
W
wdenk 已提交
2888
		the default environment compiled into the boot image.
W
wdenk 已提交
2889

W
wdenk 已提交
2890 2891
		For example, place something like this in your
		board's config file:
W
wdenk 已提交
2892 2893 2894 2895 2896

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

W
wdenk 已提交
2897 2898 2899 2900
		Warning: This method is based on knowledge about the
		internal format how the environment is stored by the
		U-Boot code. This is NOT an official, exported
		interface! Although it is unlikely that this format
W
wdenk 已提交
2901
		will change soon, there is no guarantee either.
W
wdenk 已提交
2902 2903
		You better know what you are doing here.

W
wdenk 已提交
2904 2905
		Note: overly (ab)use of the default environment is
		discouraged. Make sure to check other ways to preset
2906
		the environment like the "source" command or the
W
wdenk 已提交
2907
		boot command first.
W
wdenk 已提交
2908

2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922
		CONFIG_ENV_VARS_UBOOT_CONFIG

		Define this in order to add variables describing the
		U-Boot build configuration to the default environment.
		These will be named arch, cpu, board, vendor, and soc.

		Enabling this option will cause the following to be defined:

		- CONFIG_SYS_ARCH
		- CONFIG_SYS_CPU
		- CONFIG_SYS_BOARD
		- CONFIG_SYS_VENDOR
		- CONFIG_SYS_SOC

2923 2924 2925 2926 2927 2928
		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG

		Define this in order to add variables describing certain
		run-time determined information about the hardware to the
		environment.  These will be named board_name, board_rev.

2929 2930 2931
		CONFIG_DELAY_ENVIRONMENT

		Normally the environment is loaded when the board is
2932
		initialised so that it is available to U-Boot. This inhibits
2933 2934 2935 2936 2937
		that so that the environment is not available until
		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
		this is instead controlled by the value of
		/config/load-environment.

2938 2939 2940
- Parallel Flash support:
		CONFIG_SYS_NO_FLASH

B
Bin Meng 已提交
2941
		Traditionally U-Boot was run on systems with parallel NOR
2942 2943 2944 2945 2946 2947 2948 2949 2950
		flash. This option is used to disable support for parallel NOR
		flash. This option should be defined if the board does not have
		parallel flash.

		If this option is not defined one of the generic flash drivers
		(e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
		selected or the board must provide an implementation of the
		flash API (see include/flash.h).

W
wdenk 已提交
2951
- DataFlash Support:
2952 2953
		CONFIG_HAS_DATAFLASH

W
wdenk 已提交
2954 2955 2956
		Defining this option enables DataFlash features and
		allows to read/write in Dataflash via the standard
		commands cp, md...
2957

2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976
- Serial Flash support
		CONFIG_CMD_SF

		Defining this option enables SPI flash commands
		'sf probe/read/write/erase/update'.

		Usage requires an initial 'probe' to define the serial
		flash parameters, followed by read/write/erase/update
		commands.

		The following defaults may be provided by the platform
		to handle the common case when only a single serial
		flash is present on the system.

		CONFIG_SF_DEFAULT_BUS		Bus identifier
		CONFIG_SF_DEFAULT_CS		Chip-select
		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
		CONFIG_SF_DEFAULT_SPEED		in Hz

S
Simon Glass 已提交
2977 2978 2979 2980 2981
		CONFIG_CMD_SF_TEST

		Define this option to include a destructive SPI flash
		test ('sf test').

2982 2983 2984 2985
		CONFIG_SF_DUAL_FLASH		Dual flash memories

		Define this option to use dual flash support where two flash
		memories can be connected with a given cs line.
2986
		Currently Xilinx Zynq qspi supports these type of connections.
2987

W
wdenk 已提交
2988 2989 2990 2991 2992
- SystemACE Support:
		CONFIG_SYSTEMACE

		Adding this option adds support for Xilinx SystemACE
		chips attached via some sort of local bus. The address
M
Marcel Ziswiler 已提交
2993
		of the chip must also be defined in the
2994
		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
W
wdenk 已提交
2995 2996

		#define CONFIG_SYSTEMACE
2997
		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
W
wdenk 已提交
2998 2999 3000 3001

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

3002 3003 3004
- TFTP Fixed UDP Port:
		CONFIG_TFTP_PORT

3005
		If this is defined, the environment variable tftpsrcp
3006
		is used to supply the TFTP UDP source port value.
3007
		If tftpsrcp isn't defined, the normal pseudo-random port
3008 3009
		number generator is used.

3010 3011 3012 3013 3014
		Also, the environment variable tftpdstp is used to supply
		the TFTP UDP destination port value.  If tftpdstp isn't
		defined, the normal port 69 is used.

		The purpose for tftpsrcp is to allow a TFTP server to
3015 3016 3017 3018 3019 3020 3021
		blindly start the TFTP transfer using the pre-configured
		target IP address and UDP port. This has the effect of
		"punching through" the (Windows XP) firewall, allowing
		the remainder of the TFTP transfer to proceed normally.
		A better solution is to properly configure the firewall,
		but sometimes that is not allowed.

3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032
- Hashing support:
		CONFIG_CMD_HASH

		This enables a generic 'hash' command which can produce
		hashes / digests from a few algorithms (e.g. SHA1, SHA256).

		CONFIG_HASH_VERIFY

		Enable the hash verify command (hash -v). This adds to code
		size a little.

3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044
		CONFIG_SHA1 - This option enables support of hashing using SHA1
		algorithm. The hash is calculated in software.
		CONFIG_SHA256 - This option enables support of hashing using
		SHA256 algorithm. The hash is calculated in software.
		CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
		for SHA1/SHA256 hashing.
		This affects the 'hash' command and also the
		hash_lookup_algo() function.
		CONFIG_SHA_PROG_HW_ACCEL - This option enables
		hardware-acceleration for SHA1/SHA256 progressive hashing.
		Data can be streamed in a block at a time and the hashing
		is performed in hardware.
3045 3046 3047 3048

		Note: There is also a sha1sum command, which should perhaps
		be deprecated in favour of 'hash sha1'.

3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063
- Freescale i.MX specific commands:
		CONFIG_CMD_HDMIDETECT
		This enables 'hdmidet' command which returns true if an
		HDMI monitor is detected.  This command is i.MX 6 specific.

		CONFIG_CMD_BMODE
		This enables the 'bmode' (bootmode) command for forcing
		a boot from specific media.

		This is useful for forcing the ROM's usb downloader to
		activate upon a watchdog reset which is nice when iterating
		on U-Boot.  Using the reset button or running bmode normal
		will set it back to normal.  This command currently
		supports i.MX53 and i.MX6.

3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083
- bootcount support:
		CONFIG_BOOTCOUNT_LIMIT

		This enables the bootcounter support, see:
		http://www.denx.de/wiki/DULG/UBootBootCountLimit

		CONFIG_AT91SAM9XE
		enable special bootcounter support on at91sam9xe based boards.
		CONFIG_BLACKFIN
		enable special bootcounter support on blackfin based boards.
		CONFIG_SOC_DA8XX
		enable special bootcounter support on da850 based boards.
		CONFIG_BOOTCOUNT_RAM
		enable support for the bootcounter in RAM
		CONFIG_BOOTCOUNT_I2C
		enable support for the bootcounter on an i2c (like RTC) device.
			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
						    the bootcounter.
			CONFIG_BOOTCOUNT_ALEN = address len
3084

W
wdenk 已提交
3085
- Show boot progress:
W
wdenk 已提交
3086 3087
		CONFIG_SHOW_BOOT_PROGRESS

W
wdenk 已提交
3088 3089 3090 3091 3092 3093
		Defining this option allows to add some board-
		specific code (calling a user-provided function
		"show_boot_progress(int)") that enables you to show
		the system's boot progress on some display (for
		example, some LED's) on your board. At the moment,
		the following checkpoints are implemented:
W
wdenk 已提交
3094

3095

3096 3097
Legacy uImage format:

W
wdenk 已提交
3098 3099
  Arg	Where			When
    1	common/cmd_bootm.c	before attempting to boot an image
W
wdenk 已提交
3100
   -1	common/cmd_bootm.c	Image header has bad	 magic number
W
wdenk 已提交
3101
    2	common/cmd_bootm.c	Image header has correct magic number
W
wdenk 已提交
3102
   -2	common/cmd_bootm.c	Image header has bad	 checksum
W
wdenk 已提交
3103
    3	common/cmd_bootm.c	Image header has correct checksum
W
wdenk 已提交
3104
   -3	common/cmd_bootm.c	Image data   has bad	 checksum
W
wdenk 已提交
3105 3106 3107
    4	common/cmd_bootm.c	Image data   has correct checksum
   -4	common/cmd_bootm.c	Image is for unsupported architecture
    5	common/cmd_bootm.c	Architecture check OK
3108
   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
W
wdenk 已提交
3109 3110 3111 3112
    6	common/cmd_bootm.c	Image Type check OK
   -6	common/cmd_bootm.c	gunzip uncompression error
   -7	common/cmd_bootm.c	Unimplemented compression type
    7	common/cmd_bootm.c	Uncompression OK
3113
    8	common/cmd_bootm.c	No uncompress/copy overwrite error
W
wdenk 已提交
3114
   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
3115 3116 3117 3118 3119 3120 3121 3122

    9	common/image.c		Start initial ramdisk verification
  -10	common/image.c		Ramdisk header has bad	   magic number
  -11	common/image.c		Ramdisk header has bad	   checksum
   10	common/image.c		Ramdisk header is OK
  -12	common/image.c		Ramdisk data   has bad	   checksum
   11	common/image.c		Ramdisk data   has correct checksum
   12	common/image.c		Ramdisk verification complete, start loading
M
Marcel Ziswiler 已提交
3123
  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
3124 3125 3126
   13	common/image.c		Start multifile image verification
   14	common/image.c		No initial ramdisk, no multifile, continue.

W
Wolfgang Denk 已提交
3127
   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
W
wdenk 已提交
3128

S
Stefan Roese 已提交
3129
  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
W
wdenk 已提交
3130 3131
  -31	post/post.c		POST test failed, detected by post_output_backlog()
  -32	post/post.c		POST test failed, detected by post_run_single()
3132

3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182
   34	common/cmd_doc.c	before loading a Image from a DOC device
  -35	common/cmd_doc.c	Bad usage of "doc" command
   35	common/cmd_doc.c	correct usage of "doc" command
  -36	common/cmd_doc.c	No boot device
   36	common/cmd_doc.c	correct boot device
  -37	common/cmd_doc.c	Unknown Chip ID on boot device
   37	common/cmd_doc.c	correct chip ID found, device available
  -38	common/cmd_doc.c	Read Error on boot device
   38	common/cmd_doc.c	reading Image header from DOC device OK
  -39	common/cmd_doc.c	Image header has bad magic number
   39	common/cmd_doc.c	Image header has correct magic number
  -40	common/cmd_doc.c	Error reading Image from DOC device
   40	common/cmd_doc.c	Image header has correct magic number
   41	common/cmd_ide.c	before loading a Image from a IDE device
  -42	common/cmd_ide.c	Bad usage of "ide" command
   42	common/cmd_ide.c	correct usage of "ide" command
  -43	common/cmd_ide.c	No boot device
   43	common/cmd_ide.c	boot device found
  -44	common/cmd_ide.c	Device not available
   44	common/cmd_ide.c	Device available
  -45	common/cmd_ide.c	wrong partition selected
   45	common/cmd_ide.c	partition selected
  -46	common/cmd_ide.c	Unknown partition table
   46	common/cmd_ide.c	valid partition table found
  -47	common/cmd_ide.c	Invalid partition type
   47	common/cmd_ide.c	correct partition type
  -48	common/cmd_ide.c	Error reading Image Header on boot device
   48	common/cmd_ide.c	reading Image Header from IDE device OK
  -49	common/cmd_ide.c	Image header has bad magic number
   49	common/cmd_ide.c	Image header has correct magic number
  -50	common/cmd_ide.c	Image header has bad	 checksum
   50	common/cmd_ide.c	Image header has correct checksum
  -51	common/cmd_ide.c	Error reading Image from IDE device
   51	common/cmd_ide.c	reading Image from IDE device OK
   52	common/cmd_nand.c	before loading a Image from a NAND device
  -53	common/cmd_nand.c	Bad usage of "nand" command
   53	common/cmd_nand.c	correct usage of "nand" command
  -54	common/cmd_nand.c	No boot device
   54	common/cmd_nand.c	boot device found
  -55	common/cmd_nand.c	Unknown Chip ID on boot device
   55	common/cmd_nand.c	correct chip ID found, device available
  -56	common/cmd_nand.c	Error reading Image Header on boot device
   56	common/cmd_nand.c	reading Image Header from NAND device OK
  -57	common/cmd_nand.c	Image header has bad magic number
   57	common/cmd_nand.c	Image header has correct magic number
  -58	common/cmd_nand.c	Error reading Image from NAND device
   58	common/cmd_nand.c	reading Image from NAND device OK

  -60	common/env_common.c	Environment has a bad CRC, using default

M
Marcel Ziswiler 已提交
3183
   64	net/eth.c		starting with Ethernet configuration.
3184 3185 3186 3187
  -64	net/eth.c		no Ethernet found.
   65	net/eth.c		Ethernet found.

  -80	common/cmd_net.c	usage wrong
3188 3189 3190
   80	common/cmd_net.c	before calling net_loop()
  -81	common/cmd_net.c	some error in net_loop() occurred
   81	common/cmd_net.c	net_loop() back without error
3191 3192
  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
   82	common/cmd_net.c	trying automatic boot
3193 3194
   83	common/cmd_net.c	running "source" command
  -83	common/cmd_net.c	some error in automatic boot or "source" command
3195
   84	common/cmd_net.c	end without errors
W
wdenk 已提交
3196

3197 3198 3199 3200 3201 3202 3203 3204 3205
FIT uImage format:

  Arg	Where			When
  100	common/cmd_bootm.c	Kernel FIT Image has correct format
 -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
 -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
  102	common/cmd_bootm.c	Kernel unit name specified
 -103	common/cmd_bootm.c	Can't get kernel subimage node offset
3206
  103	common/cmd_bootm.c	Found configuration node
3207 3208 3209 3210 3211
  104	common/cmd_bootm.c	Got kernel subimage node offset
 -104	common/cmd_bootm.c	Kernel subimage hash verification failed
  105	common/cmd_bootm.c	Kernel subimage hash verification OK
 -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
  106	common/cmd_bootm.c	Architecture check OK
M
Marcel Ziswiler 已提交
3212 3213
 -106	common/cmd_bootm.c	Kernel subimage has wrong type
  107	common/cmd_bootm.c	Kernel subimage type OK
3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225
 -107	common/cmd_bootm.c	Can't get kernel subimage data/size
  108	common/cmd_bootm.c	Got kernel subimage data/size
 -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
 -109	common/cmd_bootm.c	Can't get kernel subimage type
 -110	common/cmd_bootm.c	Can't get kernel subimage comp
 -111	common/cmd_bootm.c	Can't get kernel subimage os
 -112	common/cmd_bootm.c	Can't get kernel subimage load address
 -113	common/cmd_bootm.c	Image uncompress/copy overwrite error

  120	common/image.c		Start initial ramdisk verification
 -120	common/image.c		Ramdisk FIT image has incorrect format
  121	common/image.c		Ramdisk FIT image has correct format
M
Marcel Ziswiler 已提交
3226
  122	common/image.c		No ramdisk subimage unit name, using configuration
3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239
 -122	common/image.c		Can't get configuration for ramdisk subimage
  123	common/image.c		Ramdisk unit name specified
 -124	common/image.c		Can't get ramdisk subimage node offset
  125	common/image.c		Got ramdisk subimage node offset
 -125	common/image.c		Ramdisk subimage hash verification failed
  126	common/image.c		Ramdisk subimage hash verification OK
 -126	common/image.c		Ramdisk subimage for unsupported architecture
  127	common/image.c		Architecture check OK
 -127	common/image.c		Can't get ramdisk subimage data/size
  128	common/image.c		Got ramdisk subimage data/size
  129	common/image.c		Can't get ramdisk load address
 -129	common/image.c		Got ramdisk load address

M
Marcel Ziswiler 已提交
3240
 -130	common/cmd_doc.c	Incorrect FIT image format
3241 3242
  131	common/cmd_doc.c	FIT image format OK

M
Marcel Ziswiler 已提交
3243
 -140	common/cmd_ide.c	Incorrect FIT image format
3244 3245
  141	common/cmd_ide.c	FIT image format OK

M
Marcel Ziswiler 已提交
3246
 -150	common/cmd_nand.c	Incorrect FIT image format
3247 3248
  151	common/cmd_nand.c	FIT image format OK

3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261
- legacy image format:
		CONFIG_IMAGE_FORMAT_LEGACY
		enables the legacy image format support in U-Boot.

		Default:
		enabled if CONFIG_FIT_SIGNATURE is not defined.

		CONFIG_DISABLE_IMAGE_LEGACY
		disable the legacy image format

		This define is introduced, as the legacy image format is
		enabled per default for backward compatibility.

3262
- FIT image support:
D
Dirk Eibach 已提交
3263 3264 3265 3266 3267
		CONFIG_FIT_DISABLE_SHA256
		Supporting SHA256 hashes has quite an impact on binary size.
		For constrained systems sha256 hash support can be disabled
		with this option.

3268 3269 3270
		TODO(sjg@chromium.org): Adjust this option to be positive,
		and move it to Kconfig

3271 3272 3273
- Standalone program support:
		CONFIG_STANDALONE_LOAD_ADDR

W
Wolfgang Denk 已提交
3274 3275 3276
		This option defines a board specific value for the
		address where standalone program gets loaded, thus
		overwriting the architecture dependent default
3277 3278 3279 3280 3281 3282
		settings.

- Frame Buffer Address:
		CONFIG_FB_ADDR

		Define CONFIG_FB_ADDR if you want to use specific
3283 3284 3285 3286 3287 3288 3289
		address for frame buffer.  This is typically the case
		when using a graphics controller has separate video
		memory.  U-Boot will then place the frame buffer at
		the given address instead of dynamically reserving it
		in system RAM by calling lcd_setmem(), which grabs
		the memory for the frame buffer depending on the
		configured panel size.
3290 3291 3292

		Please see board_init_f function.

3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311
- Automatic software updates via TFTP server
		CONFIG_UPDATE_TFTP
		CONFIG_UPDATE_TFTP_CNT_MAX
		CONFIG_UPDATE_TFTP_MSEC_MAX

		These options enable and control the auto-update feature;
		for a more detailed description refer to doc/README.update.

- MTD Support (mtdparts command, UBI support)
		CONFIG_MTD_DEVICE

		Adds the MTD device infrastructure from the Linux kernel.
		Needed for mtdparts command support.

		CONFIG_MTD_PARTITIONS

		Adds the MTD partitioning infrastructure from the Linux
		kernel. Needed for UBI support.

3312 3313 3314 3315 3316 3317 3318 3319
- UBI support
		CONFIG_CMD_UBI

		Adds commands for interacting with MTD partitions formatted
		with the UBI flash translation layer

		Requires also defining CONFIG_RBTREE

3320 3321 3322 3323 3324
		CONFIG_UBI_SILENCE_MSG

		Make the verbose messages from UBI stop printing.  This leaves
		warnings and errors enabled.

3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339

		CONFIG_MTD_UBI_WL_THRESHOLD
		This parameter defines the maximum difference between the highest
		erase counter value and the lowest erase counter value of eraseblocks
		of UBI devices. When this threshold is exceeded, UBI starts performing
		wear leveling by means of moving data from eraseblock with low erase
		counter to eraseblocks with high erase counter.

		The default value should be OK for SLC NAND flashes, NOR flashes and
		other flashes which have eraseblock life-cycle 100000 or more.
		However, in case of MLC NAND flashes which typically have eraseblock
		life-cycle less than 10000, the threshold should be lessened (e.g.,
		to 128 or 256, although it does not have to be power of 2).

		default: 4096
3340

3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382
		CONFIG_MTD_UBI_BEB_LIMIT
		This option specifies the maximum bad physical eraseblocks UBI
		expects on the MTD device (per 1024 eraseblocks). If the
		underlying flash does not admit of bad eraseblocks (e.g. NOR
		flash), this value is ignored.

		NAND datasheets often specify the minimum and maximum NVM
		(Number of Valid Blocks) for the flashes' endurance lifetime.
		The maximum expected bad eraseblocks per 1024 eraseblocks
		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
		which gives 20 for most NANDs (MaxNVB is basically the total
		count of eraseblocks on the chip).

		To put it differently, if this value is 20, UBI will try to
		reserve about 1.9% of physical eraseblocks for bad blocks
		handling. And that will be 1.9% of eraseblocks on the entire
		NAND chip, not just the MTD partition UBI attaches. This means
		that if you have, say, a NAND flash chip admits maximum 40 bad
		eraseblocks, and it is split on two MTD partitions of the same
		size, UBI will reserve 40 eraseblocks when attaching a
		partition.

		default: 20

		CONFIG_MTD_UBI_FASTMAP
		Fastmap is a mechanism which allows attaching an UBI device
		in nearly constant time. Instead of scanning the whole MTD device it
		only has to locate a checkpoint (called fastmap) on the device.
		The on-flash fastmap contains all information needed to attach
		the device. Using fastmap makes only sense on large devices where
		attaching by scanning takes long. UBI will not automatically install
		a fastmap on old images, but you can set the UBI parameter
		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
		that fastmap-enabled images are still usable with UBI implementations
		without	fastmap support. On typical flash devices the whole fastmap
		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.

		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
		Set this parameter to enable fastmap automatically on images
		without a fastmap.
		default: 0

H
Heiko Schocher 已提交
3383 3384 3385 3386
		CONFIG_MTD_UBI_FM_DEBUG
		Enable UBI fastmap debug
		default: 0

3387 3388 3389 3390 3391 3392 3393 3394
- UBIFS support
		CONFIG_CMD_UBIFS

		Adds commands for interacting with UBI volumes formatted as
		UBIFS.  UBIFS is read-only in u-boot.

		Requires UBI support as well as CONFIG_LZO

3395 3396 3397 3398 3399
		CONFIG_UBIFS_SILENCE_MSG

		Make the verbose messages from UBIFS stop printing.  This leaves
		warnings and errors enabled.

3400
- SPL framework
W
Wolfgang Denk 已提交
3401 3402
		CONFIG_SPL
		Enable building of SPL globally.
3403

3404 3405 3406
		CONFIG_SPL_LDSCRIPT
		LDSCRIPT for linking the SPL binary.

3407 3408 3409 3410
		CONFIG_SPL_MAX_FOOTPRINT
		Maximum size in memory allocated to the SPL, BSS included.
		When defined, the linker checks that the actual memory
		used by SPL from _start to __bss_end does not exceed it.
3411
		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3412 3413
		must not be both defined at the same time.

3414
		CONFIG_SPL_MAX_SIZE
3415 3416 3417 3418
		Maximum size of the SPL image (text, data, rodata, and
		linker lists sections), BSS excluded.
		When defined, the linker checks that the actual size does
		not exceed it.
3419

W
Wolfgang Denk 已提交
3420 3421
		CONFIG_SPL_TEXT_BASE
		TEXT_BASE for linking the SPL binary.
3422

3423 3424 3425 3426
		CONFIG_SPL_RELOC_TEXT_BASE
		Address to relocate to.  If unspecified, this is equal to
		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).

3427 3428 3429 3430
		CONFIG_SPL_BSS_START_ADDR
		Link address for the BSS within the SPL binary.

		CONFIG_SPL_BSS_MAX_SIZE
3431 3432 3433
		Maximum size in memory allocated to the SPL BSS.
		When defined, the linker checks that the actual memory used
		by SPL from __bss_start to __bss_end does not exceed it.
3434
		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
3435
		must not be both defined at the same time.
3436 3437 3438 3439

		CONFIG_SPL_STACK
		Adress of the start of the stack SPL will use

3440 3441 3442 3443 3444 3445 3446 3447 3448 3449
		CONFIG_SPL_PANIC_ON_RAW_IMAGE
		When defined, SPL will panic() if the image it has
		loaded does not have a signature.
		Defining this is useful when code which loads images
		in SPL cannot guarantee that absolutely all read errors
		will be caught.
		An example is the LPC32XX MLC NAND driver, which will
		consider that a completely unreadable NAND block is bad,
		and thus should be skipped silently.

3450 3451 3452 3453
		CONFIG_SPL_ABORT_ON_RAW_IMAGE
		When defined, SPL will proceed to another boot method
		if the image it has loaded does not have a signature.

3454 3455 3456 3457 3458
		CONFIG_SPL_RELOC_STACK
		Adress of the start of the stack SPL will use after
		relocation.  If unspecified, this is equal to
		CONFIG_SPL_STACK.

3459 3460
		CONFIG_SYS_SPL_MALLOC_START
		Starting address of the malloc pool used in SPL.
3461 3462 3463
		When this option is set the full malloc is used in SPL and
		it is set up by spl_init() and before that, the simple malloc()
		can be used if CONFIG_SYS_MALLOC_F is defined.
3464 3465 3466

		CONFIG_SYS_SPL_MALLOC_SIZE
		The size of the malloc pool used in SPL.
3467

3468 3469 3470 3471 3472
		CONFIG_SPL_FRAMEWORK
		Enable the SPL framework under common/.  This framework
		supports MMC, NAND and YMODEM loading of U-Boot and NAND
		NAND loading of the Linux Kernel.

3473 3474 3475 3476
		CONFIG_SPL_OS_BOOT
		Enable booting directly to an OS from SPL.
		See also: doc/README.falcon

3477 3478 3479 3480
		CONFIG_SPL_DISPLAY_PRINT
		For ARM, enable an optional function to print more information
		about the running system.

3481 3482 3483
		CONFIG_SPL_INIT_MINIMAL
		Arch init code should be built for a very small image

3484 3485
		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
		CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
3486
		Address and partition on the MMC to load U-Boot from
3487 3488
		when the MMC is being used in raw mode.

3489 3490 3491 3492
		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
		Partition on the MMC to load U-Boot from when the MMC is being
		used in raw mode

3493 3494 3495 3496 3497 3498 3499 3500 3501 3502
		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
		Sector to load kernel uImage from when MMC is being
		used in raw mode (for Falcon mode)

		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
		Sector and number of sectors to load kernel argument
		parameters from when MMC is being used in raw mode
		(for falcon mode)

3503 3504 3505 3506
		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
		Partition on the MMC to load U-Boot from when the MMC is being
		used in fs mode

3507 3508 3509 3510
		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
		Filename to read to load U-Boot when reading from filesystem

		CONFIG_SPL_FS_LOAD_KERNEL_NAME
3511
		Filename to read to load kernel uImage when reading
3512
		from filesystem (for Falcon mode)
3513

3514
		CONFIG_SPL_FS_LOAD_ARGS_NAME
3515
		Filename to read to load kernel argument parameters
3516
		when reading from filesystem (for Falcon mode)
3517

3518 3519 3520 3521 3522 3523
		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
		Set this for NAND SPL on PPC mpc83xx targets, so that
		start.S waits for the rest of the SPL to load before
		continuing (the hardware starts execution after just
		loading the first page rather than the full 4K).

3524 3525 3526
		CONFIG_SPL_SKIP_RELOCATE
		Avoid SPL relocation

3527 3528 3529 3530 3531 3532 3533 3534 3535 3536
		CONFIG_SPL_NAND_BASE
		Include nand_base.c in the SPL.  Requires
		CONFIG_SPL_NAND_DRIVERS.

		CONFIG_SPL_NAND_DRIVERS
		SPL uses normal NAND drivers, not minimal drivers.

		CONFIG_SPL_NAND_ECC
		Include standard software ECC in the SPL

3537
		CONFIG_SPL_NAND_SIMPLE
S
Scott Wood 已提交
3538 3539
		Support for NAND boot using simple NAND drivers that
		expose the cmd_ctrl() interface.
3540

3541 3542 3543 3544
		CONFIG_SPL_UBI
		Support for a lightweight UBI (fastmap) scanner and
		loader

3545 3546 3547 3548
		CONFIG_SPL_NAND_RAW_ONLY
		Support to boot only raw u-boot.bin images. Use this only
		if you need to save space.

3549 3550 3551 3552
		CONFIG_SPL_COMMON_INIT_DDR
		Set for common ddr init with serial presence detect in
		SPL binary.

3553 3554 3555 3556 3557 3558
		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
		CONFIG_SYS_NAND_ECCBYTES
		Defines the size and behavior of the NAND that SPL uses
S
Scott Wood 已提交
3559
		to read U-Boot
3560

3561 3562 3563
		CONFIG_SPL_NAND_BOOT
		Add support NAND boot

3564
		CONFIG_SYS_NAND_U_BOOT_OFFS
S
Scott Wood 已提交
3565 3566 3567 3568 3569 3570 3571
		Location in NAND to read U-Boot from

		CONFIG_SYS_NAND_U_BOOT_DST
		Location in memory to load U-Boot to

		CONFIG_SYS_NAND_U_BOOT_SIZE
		Size of image to load
3572 3573

		CONFIG_SYS_NAND_U_BOOT_START
S
Scott Wood 已提交
3574
		Entry point in loaded image to jump to
3575 3576 3577

		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
		Define this if you need to first read the OOB and then the
3578
		data. This is used, for example, on davinci platforms.
3579 3580 3581 3582 3583

		CONFIG_SPL_OMAP3_ID_NAND
		Support for an OMAP3-specific set of functions to return the
		ID and MFR of the first attached NAND chip, if present.

3584 3585
		CONFIG_SPL_RAM_DEVICE
		Support for running image already present in ram, in SPL binary
3586

3587
		CONFIG_SPL_PAD_TO
3588 3589 3590 3591 3592
		Image offset to which the SPL should be padded before appending
		the SPL payload. By default, this is defined as
		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3593

S
Scott Wood 已提交
3594 3595 3596 3597 3598
		CONFIG_SPL_TARGET
		Final target image containing SPL and payload.  Some SPLs
		use an arch-specific makefile fragment instead, for
		example if more than one image needs to be produced.

3599 3600 3601 3602 3603 3604
		CONFIG_FIT_SPL_PRINT
		Printing information about a FIT image adds quite a bit of
		code to SPL. So this is normally disabled in SPL. Use this
		option to re-enable it. This will affect the output of the
		bootm command when booting a FIT image.

3605 3606 3607 3608 3609 3610 3611
- TPL framework
		CONFIG_TPL
		Enable building of TPL globally.

		CONFIG_TPL_PAD_TO
		Image offset to which the TPL should be padded before appending
		the TPL payload. By default, this is defined as
3612 3613 3614
		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
3615

W
wdenk 已提交
3616 3617
- Interrupt support (PPC):

W
wdenk 已提交
3618 3619
		There are common interrupt_init() and timer_interrupt()
		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
M
Marcel Ziswiler 已提交
3620
		for CPU specific initialization. interrupt_init_cpu()
W
wdenk 已提交
3621
		should set decrementer_count to appropriate value. If
M
Marcel Ziswiler 已提交
3622
		CPU resets decrementer automatically after interrupt
W
wdenk 已提交
3623
		(ppc4xx) it should set decrementer_count to zero.
M
Marcel Ziswiler 已提交
3624
		timer_interrupt() calls timer_interrupt_cpu() for CPU
W
wdenk 已提交
3625 3626 3627
		specific handling. If board has watchdog / status_led
		/ other_activity_monitor it works automatically from
		general timer_interrupt().
W
wdenk 已提交
3628

W
wdenk 已提交
3629

3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643
Board initialization settings:
------------------------------

During Initialization u-boot calls a number of board specific functions
to allow the preparation of board specific prerequisites, e.g. pin setup
before drivers are initialized. To enable these callbacks the
following configuration macros have to be defined. Currently this is
architecture specific, so please check arch/your_architecture/lib/board.c
typically in board_init_f() and board_init_r().

- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
- CONFIG_BOARD_LATE_INIT: Call board_late_init()
- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
W
wdenk 已提交
3644 3645 3646 3647

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

3648 3649 3650
- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
		Optionally it can be defined to support 64-bit memory commands.

3651
- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
W
wdenk 已提交
3652 3653
		undefine this when you're short of memory.

P
Peter Tyser 已提交
3654 3655 3656
- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
		width of the commands listed in the 'help' command output.

3657
- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
W
wdenk 已提交
3658 3659
		prompt for user input.

3660
- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
W
wdenk 已提交
3661

3662
- CONFIG_SYS_PBSIZE:	Buffer size for Console output
W
wdenk 已提交
3663

3664
- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
W
wdenk 已提交
3665

3666
- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
W
wdenk 已提交
3667 3668 3669
		the application (usually a Linux kernel) when it is
		booted

3670
- CONFIG_SYS_BAUDRATE_TABLE:
W
wdenk 已提交
3671 3672
		List of legal baudrate settings for this board.

3673
- CONFIG_SYS_CONSOLE_INFO_QUIET
W
wdenk 已提交
3674
		Suppress display of console information at boot.
W
wdenk 已提交
3675

3676
- CONFIG_SYS_CONSOLE_IS_IN_ENV
W
wdenk 已提交
3677 3678 3679
		If the board specific function
			extern int overwrite_console (void);
		returns 1, the stdin, stderr and stdout are switched to the
W
wdenk 已提交
3680 3681
		serial port, else the settings in the environment are used.

3682
- CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
W
wdenk 已提交
3683
		Enable the call to overwrite_console().
W
wdenk 已提交
3684

3685
- CONFIG_SYS_CONSOLE_ENV_OVERWRITE
W
wdenk 已提交
3686 3687
		Enable overwrite of previous console environment settings.

3688
- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
W
wdenk 已提交
3689 3690 3691
		Begin and End addresses of the area used by the
		simple memory test.

3692
- CONFIG_SYS_ALT_MEMTEST:
W
wdenk 已提交
3693
		Enable an alternate, more extensive memory test.
W
wdenk 已提交
3694

3695
- CONFIG_SYS_MEMTEST_SCRATCH:
W
wdenk 已提交
3696 3697 3698
		Scratch address used by the alternate memory test
		You only need to set this if address zero isn't writeable

Y
York Sun 已提交
3699
- CONFIG_SYS_MEM_RESERVE_SECURE
3700
		Only implemented for ARMv8 for now.
Y
York Sun 已提交
3701 3702 3703
		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
		is substracted from total RAM and won't be reported to OS.
		This memory can be used as secure memory. A variable
3704
		gd->arch.secure_ram is used to track the location. In systems
Y
York Sun 已提交
3705 3706 3707
		the RAM base is not zero, or RAM is divided into banks,
		this variable needs to be recalcuated to get the address.

3708
- CONFIG_SYS_MEM_TOP_HIDE:
3709
		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
3710
		this specified memory area will get subtracted from the top
M
Marcel Ziswiler 已提交
3711
		(end) of RAM and won't get "touched" at all by U-Boot. By
3712 3713 3714
		fixing up gd->ram_size the Linux kernel should gets passed
		the now "corrected" memory size and won't touch it either.
		This should work for arch/ppc and arch/powerpc. Only Linux
3715
		board ports in arch/powerpc with bootwrapper support that
3716
		recalculate the memory size from the SDRAM controller setup
3717
		will have to get fixed in Linux additionally.
3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728

		This option can be used as a workaround for the 440EPx/GRx
		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
		be touched.

		WARNING: Please make sure that this value is a multiple of
		the Linux page size (normally 4k). If this is not the case,
		then the end address of the Linux memory will be located at a
		non page size aligned address and this could cause major
		problems.

3729
- CONFIG_SYS_LOADS_BAUD_CHANGE:
W
wdenk 已提交
3730 3731
		Enable temporary baudrate change while serial download

3732
- CONFIG_SYS_SDRAM_BASE:
W
wdenk 已提交
3733 3734
		Physical start address of SDRAM. _Must_ be 0 here.

3735
- CONFIG_SYS_FLASH_BASE:
W
wdenk 已提交
3736 3737
		Physical start address of Flash memory.

3738
- CONFIG_SYS_MONITOR_BASE:
W
wdenk 已提交
3739 3740
		Physical start address of boot monitor code (set by
		make config files to be same as the text base address
3741
		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
3742
		CONFIG_SYS_FLASH_BASE when booting from flash.
W
wdenk 已提交
3743

3744
- CONFIG_SYS_MONITOR_LEN:
W
wdenk 已提交
3745 3746 3747 3748
		Size of memory reserved for monitor code, used to
		determine _at_compile_time_ (!) if the environment is
		embedded within the U-Boot image, or in a separate
		flash sector.
W
wdenk 已提交
3749

3750
- CONFIG_SYS_MALLOC_LEN:
W
wdenk 已提交
3751 3752
		Size of DRAM reserved for malloc() use.

3753 3754 3755 3756 3757 3758 3759 3760 3761 3762
- CONFIG_SYS_MALLOC_F_LEN
		Size of the malloc() pool for use before relocation. If
		this is defined, then a very simple malloc() implementation
		will become available before relocation. The address is just
		below the global data, and the stack is moved down to make
		space.

		This feature allocates regions with increasing addresses
		within the region. calloc() is supported, but realloc()
		is not available. free() is supported but does nothing.
3763
		The memory will be freed (or in fact just forgotten) when
3764 3765
		U-Boot relocates itself.

3766 3767 3768 3769 3770
- CONFIG_SYS_MALLOC_SIMPLE
		Provides a simple and small malloc() and calloc() for those
		boards which do not use the full malloc in SPL (which is
		enabled with CONFIG_SYS_SPL_MALLOC_START).

3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789
- CONFIG_SYS_NONCACHED_MEMORY:
		Size of non-cached memory area. This area of memory will be
		typically located right below the malloc() area and mapped
		uncached in the MMU. This is useful for drivers that would
		otherwise require a lot of explicit cache maintenance. For
		some drivers it's also impossible to properly maintain the
		cache. For example if the regions that need to be flushed
		are not a multiple of the cache-line size, *and* padding
		cannot be allocated between the regions to align them (i.e.
		if the HW requires a contiguous array of regions, and the
		size of each region is not cache-aligned), then a flush of
		one region may result in overwriting data that hardware has
		written to another region in the same cache-line. This can
		happen for example in network drivers where descriptors for
		buffers are typically smaller than the CPU cache-line (e.g.
		16 bytes vs. 32 or 64 bytes).

		Non-cached memory is only supported on 32-bit ARM at present.

3790
- CONFIG_SYS_BOOTM_LEN:
3791 3792
		Normally compressed uImages are limited to an
		uncompressed size of 8 MBytes. If this is not enough,
3793
		you can define CONFIG_SYS_BOOTM_LEN in your board config file
3794 3795
		to adjust this setting to your needs.

3796
- CONFIG_SYS_BOOTMAPSZ:
W
wdenk 已提交
3797 3798
		Maximum size of memory mapped by the startup code of
		the Linux kernel; all data that must be processed by
3799 3800
		the Linux kernel (bd_info, boot arguments, FDT blob if
		used) must be put below this limit, unless "bootm_low"
3801
		environment variable is defined and non-zero. In such case
3802
		all data for the Linux kernel must be between "bootm_low"
W
Wolfgang Denk 已提交
3803
		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3804 3805 3806
		variable "bootm_mapsize" will override the value of
		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
		then the value in "bootm_size" will be used instead.
W
wdenk 已提交
3807

3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820
- CONFIG_SYS_BOOT_RAMDISK_HIGH:
		Enable initrd_high functionality.  If defined then the
		initrd_high feature is enabled and the bootm ramdisk subcommand
		is enabled.

- CONFIG_SYS_BOOT_GET_CMDLINE:
		Enables allocating and saving kernel cmdline in space between
		"bootm_low" and "bootm_low" + BOOTMAPSZ.

- CONFIG_SYS_BOOT_GET_KBD:
		Enables allocating and saving a kernel copy of the bd_info in
		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.

3821
- CONFIG_SYS_MAX_FLASH_BANKS:
W
wdenk 已提交
3822 3823
		Max number of Flash memory banks

3824
- CONFIG_SYS_MAX_FLASH_SECT:
W
wdenk 已提交
3825 3826
		Max number of sectors on a Flash chip

3827
- CONFIG_SYS_FLASH_ERASE_TOUT:
W
wdenk 已提交
3828 3829
		Timeout for Flash erase operations (in ms)

3830
- CONFIG_SYS_FLASH_WRITE_TOUT:
W
wdenk 已提交
3831 3832
		Timeout for Flash write operations (in ms)

3833
- CONFIG_SYS_FLASH_LOCK_TOUT
W
wdenk 已提交
3834 3835
		Timeout for Flash set sector lock bit operation (in ms)

3836
- CONFIG_SYS_FLASH_UNLOCK_TOUT
W
wdenk 已提交
3837 3838
		Timeout for Flash clear lock bits operation (in ms)

3839
- CONFIG_SYS_FLASH_PROTECTION
W
wdenk 已提交
3840 3841 3842
		If defined, hardware flash sectors protection is used
		instead of U-Boot software protection.

3843
- CONFIG_SYS_DIRECT_FLASH_TFTP:
W
wdenk 已提交
3844 3845 3846 3847 3848 3849 3850 3851

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

		The two-step approach is usually more reliable, since
		you can check if the download worked before you erase
M
Marcel Ziswiler 已提交
3852 3853
		the flash, but in some situations (when system RAM is
		too limited to allow for a temporary copy of the
W
wdenk 已提交
3854 3855
		downloaded image) this option may be very useful.

3856
- CONFIG_SYS_FLASH_CFI:
W
wdenk 已提交
3857
		Define if the flash driver uses extra elements in the
W
wdenk 已提交
3858 3859
		common flash structure for storing flash geometry.

3860
- CONFIG_FLASH_CFI_DRIVER
W
wdenk 已提交
3861 3862
		This option also enables the building of the cfi_flash driver
		in the drivers directory
W
wdenk 已提交
3863

P
Piotr Ziecik 已提交
3864 3865 3866 3867 3868
- CONFIG_FLASH_CFI_MTD
		This option enables the building of the cfi_mtd driver
		in the drivers directory. The driver exports CFI flash
		to the MTD layer.

3869
- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3870 3871 3872 3873 3874 3875
		Use buffered writes to flash.

- CONFIG_FLASH_SPANSION_S29WS_N
		s29ws-n MirrorBit flash has non-standard addresses for buffered
		write commands.

3876
- CONFIG_SYS_FLASH_QUIET_TEST
3877 3878 3879 3880 3881
		If this option is defined, the common CFI flash doesn't
		print it's warning upon not recognized FLASH banks. This
		is useful, if some of the configured banks are only
		optionally available.

3882 3883 3884 3885 3886
- CONFIG_FLASH_SHOW_PROGRESS
		If defined (must be an integer), print out countdown
		digits and dots.  Recommended value: 45 (9..1) for 80
		column displays, 15 (3..1) for 40 column displays.

3887 3888 3889 3890 3891 3892 3893 3894 3895
- CONFIG_FLASH_VERIFY
		If defined, the content of the flash (destination) is compared
		against the source after the write operation. An error message
		will be printed when the contents are not identical.
		Please note that this option is useless in nearly all cases,
		since such flash programming errors usually are detected earlier
		while unprotecting/erasing/programming. Please only enable
		this option if you really know what you are doing.

3896
- CONFIG_SYS_RX_ETH_BUFFER:
M
Marcel Ziswiler 已提交
3897 3898
		Defines the number of Ethernet receive buffers. On some
		Ethernet controllers it is recommended to set this value
S
stroese 已提交
3899 3900
		to 8 or even higher (EEPRO100 or 405 EMAC), since all
		buffers can be full shortly after enabling the interface
M
Marcel Ziswiler 已提交
3901
		on high Ethernet traffic.
S
stroese 已提交
3902 3903
		Defaults to 4 if not defined.

3904 3905
- CONFIG_ENV_MAX_ENTRIES

W
Wolfgang Denk 已提交
3906 3907 3908 3909 3910
	Maximum number of entries in the hash table that is used
	internally to store the environment settings. The default
	setting is supposed to be generous and should work in most
	cases. This setting can be used to tune behaviour; see
	lib/hashtable.c for details.
3911

3912 3913
- CONFIG_ENV_FLAGS_LIST_DEFAULT
- CONFIG_ENV_FLAGS_LIST_STATIC
3914
	Enable validation of the values given to environment variables when
3915 3916 3917 3918 3919 3920
	calling env set.  Variables can be restricted to only decimal,
	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
	the variables can also be restricted to IP address or MAC address.

	The format of the list is:
		type_attribute = [s|d|x|b|i|m]
3921 3922
		access_attribute = [a|r|o|c]
		attributes = type_attribute[access_attribute]
3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933
		entry = variable_name[:attributes]
		list = entry[,list]

	The type attributes are:
		s - String (default)
		d - Decimal
		x - Hexadecimal
		b - Boolean ([1yYtT|0nNfF])
		i - IP address
		m - MAC address

3934 3935 3936 3937 3938 3939
	The access attributes are:
		a - Any (default)
		r - Read-only
		o - Write-once
		c - Change-default

3940 3941
	- CONFIG_ENV_FLAGS_LIST_DEFAULT
		Define this to a list (string) to define the ".flags"
3942
		environment variable in the default or embedded environment.
3943 3944 3945 3946 3947 3948 3949 3950

	- CONFIG_ENV_FLAGS_LIST_STATIC
		Define this to a list (string) to define validation that
		should be done if an entry is not found in the ".flags"
		environment variable.  To override a setting in the static
		list, simply add an entry for the same variable name to the
		".flags" variable.

3951 3952 3953 3954
	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
	regular expression. This allows multiple variables to define the same
	flags without explicitly listing them for each variable.

3955 3956 3957 3958
- CONFIG_ENV_ACCESS_IGNORE_FORCE
	If defined, don't allow the -f switch to env set override variable
	access flags.

3959 3960 3961
- CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
	This is set by OMAP boards for the max time that reset should
	be asserted. See doc/README.omap-reset-time for details on how
3962
	the value can be calculated on a given board.
3963

3964 3965 3966 3967 3968
- CONFIG_USE_STDINT
	If stdint.h is available with your toolchain you can define this
	option to enable it. You can provide option 'USE_STDINT=1' when
	building U-Boot to enable this.

W
wdenk 已提交
3969 3970 3971 3972
The following definitions that deal with the placement and management
of environment data (variable area); in general, we support the
following configurations:

3973 3974 3975 3976 3977
- CONFIG_BUILD_ENVCRC:

	Builds up envcrc with the target environment so that external utils
	may easily extract it and embed it in final U-Boot images.

3978
- CONFIG_ENV_IS_IN_FLASH:
W
wdenk 已提交
3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993

	Define this if the environment is in flash memory.

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

3994
	- CONFIG_ENV_OFFSET:
W
wdenk 已提交
3995 3996 3997 3998 3999 4000

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

4001
	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
W
wdenk 已提交
4002

4003
	- CONFIG_ENV_ADDR:
W
wdenk 已提交
4004 4005 4006

	   This is just another way to specify the start address of
	   the flash sector containing the environment (instead of
4007
	   CONFIG_ENV_OFFSET).
W
wdenk 已提交
4008

4009
	- CONFIG_ENV_SECT_SIZE:
W
wdenk 已提交
4010 4011 4012 4013 4014 4015 4016 4017

	   Size of the sector containing the environment.


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

4018
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
4019

4020
	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
4021
	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
W
wdenk 已提交
4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034
	   of this flash sector for the environment. This saves
	   memory for the RAM copy of the environment.

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

4035 4036
	- CONFIG_ENV_ADDR_REDUND
	  CONFIG_ENV_SIZE_REDUND
W
wdenk 已提交
4037

W
wdenk 已提交
4038
	   These settings describe a second storage area used to hold
M
Marcel Ziswiler 已提交
4039
	   a redundant copy of the environment data, so that there is
W
wdenk 已提交
4040
	   a valid backup copy in case there is a power failure during
W
wdenk 已提交
4041
	   a "saveenv" operation.
W
wdenk 已提交
4042 4043 4044 4045 4046 4047

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


4048
- CONFIG_ENV_IS_IN_NVRAM:
W
wdenk 已提交
4049 4050 4051 4052 4053

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

4054 4055
	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
4056

M
Marcel Ziswiler 已提交
4057
	  These two #defines are used to determine the memory area you
W
wdenk 已提交
4058 4059 4060 4061 4062
	  want to use for environment. It is assumed that this memory
	  can just be read and written to, without any special
	  provision.

BE CAREFUL! The first access to the environment happens quite early
4063
in U-Boot initialization (when we try to get the setting of for the
M
Marcel Ziswiler 已提交
4064
console baudrate). You *MUST* have mapped your NVRAM area then, or
W
wdenk 已提交
4065 4066 4067 4068 4069 4070 4071 4072
U-Boot will hang.

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


4073
- CONFIG_ENV_IS_IN_EEPROM:
W
wdenk 已提交
4074 4075 4076 4077

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

4078 4079
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
4080 4081 4082 4083

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

4084
	- CONFIG_SYS_I2C_EEPROM_ADDR:
W
wdenk 已提交
4085 4086 4087
	  If defined, specified the chip address of the EEPROM device.
	  The default address is zero.

4088 4089 4090
	- CONFIG_SYS_I2C_EEPROM_BUS:
	  If defined, specified the i2c bus of the EEPROM device.

4091
	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
W
wdenk 已提交
4092 4093 4094 4095
	  If defined, the number of bits used to address bytes in a
	  single page in the EEPROM device.  A 64 byte page, for example
	  would require six bits.

4096
	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
W
wdenk 已提交
4097
	  If defined, the number of milliseconds to delay between
W
wdenk 已提交
4098
	  page writes.	The default is zero milliseconds.
W
wdenk 已提交
4099

4100
	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
W
wdenk 已提交
4101 4102 4103
	  The length in bytes of the EEPROM memory array address.  Note
	  that this is NOT the chip address length!

4104
	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
4105 4106 4107 4108 4109 4110 4111 4112 4113 4114
	  EEPROM chips that implement "address overflow" are ones
	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
	  address and the extra bits end up in the "chip address" bit
	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
	  byte chips.

	  Note that we consider the length of the address field to
	  still be one byte because the extra address bits are hidden
	  in the chip address.

4115
	- CONFIG_SYS_EEPROM_SIZE:
W
wdenk 已提交
4116 4117
	  The size in bytes of the EEPROM device.

H
Heiko Schocher 已提交
4118 4119 4120 4121 4122 4123 4124 4125 4126
	- CONFIG_ENV_EEPROM_IS_ON_I2C
	  define this, if you have I2C and SPI activated, and your
	  EEPROM, which holds the environment, is on the I2C bus.

	- CONFIG_I2C_ENV_EEPROM_BUS
	  if you have an Environment on an EEPROM reached over
	  I2C muxes, you can define here, how to reach this
	  EEPROM. For example:

4127
	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
H
Heiko Schocher 已提交
4128 4129 4130

	  EEPROM which holds the environment, is reached over
	  a pca9547 i2c mux with address 0x70, channel 3.
W
wdenk 已提交
4131

4132
- CONFIG_ENV_IS_IN_DATAFLASH:
4133

W
wdenk 已提交
4134
	Define this if you have a DataFlash memory device which you
4135 4136
	want to use for the environment.

4137 4138 4139
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:
4140 4141 4142 4143 4144

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

4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165
- CONFIG_ENV_IS_IN_SPI_FLASH:

	Define this if you have a SPI Flash memory device which you
	want to use for the environment.

	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:

	  These two #defines specify the offset and size of the
	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
	  aligned to an erase sector boundary.

	- CONFIG_ENV_SECT_SIZE:

	  Define the SPI flash's sector size.

	- CONFIG_ENV_OFFSET_REDUND (optional):

	  This setting describes a second storage area of CONFIG_ENV_SIZE
	  size used to hold a redundant copy of the environment data, so
	  that there is a valid backup copy in case there is a power failure
4166
	  during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181
	  aligned to an erase sector boundary.

	- CONFIG_ENV_SPI_BUS (optional):
	- CONFIG_ENV_SPI_CS (optional):

	  Define the SPI bus and chip select. If not defined they will be 0.

	- CONFIG_ENV_SPI_MAX_HZ (optional):

	  Define the SPI max work clock. If not defined then use 1MHz.

	- CONFIG_ENV_SPI_MODE (optional):

	  Define the SPI work mode. If not defined then use SPI_MODE_3.

4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192
- CONFIG_ENV_IS_IN_REMOTE:

	Define this if you have a remote memory space which you
	want to use for the local device's environment.

	- CONFIG_ENV_ADDR:
	- CONFIG_ENV_SIZE:

	  These two #defines specify the address and size of the
	  environment area within the remote memory space. The
	  local device can get the environment from remote memory
4193
	  space by SRIO or PCIE links.
4194 4195 4196

BE CAREFUL! For some special cases, the local device can not use
"saveenv" command. For example, the local device will get the
4197 4198
environment stored in a remote NOR flash by SRIO or PCIE link,
but it can not erase, write this NOR flash by SRIO or PCIE interface.
4199

4200
- CONFIG_ENV_IS_IN_NAND:
W
wdenk 已提交
4201 4202 4203 4204

	Define this if you have a NAND device which you want to use
	for the environment.

4205 4206
	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:
W
wdenk 已提交
4207 4208

	  These two #defines specify the offset and size of the environment
S
Scott Wood 已提交
4209 4210
	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
	  aligned to an erase block boundary.
4211

S
Scott Wood 已提交
4212
	- CONFIG_ENV_OFFSET_REDUND (optional):
4213

4214
	  This setting describes a second storage area of CONFIG_ENV_SIZE
S
Scott Wood 已提交
4215 4216
	  size used to hold a redundant copy of the environment data, so
	  that there is a valid backup copy in case there is a power failure
4217
	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_REDUND must be
S
Scott Wood 已提交
4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234
	  aligned to an erase block boundary.

	- CONFIG_ENV_RANGE (optional):

	  Specifies the length of the region in which the environment
	  can be written.  This should be a multiple of the NAND device's
	  block size.  Specifying a range with more erase blocks than
	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
	  the range to be avoided.

	- CONFIG_ENV_OFFSET_OOB (optional):

	  Enables support for dynamically retrieving the offset of the
	  environment from block zero's out-of-band data.  The
	  "nand env.oob" command can be used to record this offset.
	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
	  using CONFIG_ENV_OFFSET_OOB.
4235

4236 4237 4238 4239 4240 4241
- CONFIG_NAND_ENV_DST

	Defines address in RAM to which the nand_spl code should copy the
	environment. If redundant environment is used, it will be copied to
	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.

4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256
- CONFIG_ENV_IS_IN_UBI:

	Define this if you have an UBI volume that you want to use for the
	environment.  This has the benefit of wear-leveling the environment
	accesses, which is important on NAND.

	- CONFIG_ENV_UBI_PART:

	  Define this to a string that is the mtd partition containing the UBI.

	- CONFIG_ENV_UBI_VOLUME:

	  Define this to the name of the volume that you want to store the
	  environment in.

4257 4258 4259 4260 4261 4262
	- CONFIG_ENV_UBI_VOLUME_REDUND:

	  Define this to the name of another volume to store a second copy of
	  the environment in.  This will enable redundant environments in UBI.
	  It is assumed that both volumes are in the same MTD partition.

4263 4264 4265 4266 4267 4268
	- CONFIG_UBI_SILENCE_MSG
	- CONFIG_UBIFS_SILENCE_MSG

	  You will probably want to define these to avoid a really noisy system
	  when storing the env in UBI.

4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288
- CONFIG_ENV_IS_IN_FAT:
       Define this if you want to use the FAT file system for the environment.

       - FAT_ENV_INTERFACE:

         Define this to a string that is the name of the block device.

       - FAT_ENV_DEV_AND_PART:

         Define this to a string to specify the partition of the device. It can
         be as following:

           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
               - "D:P": device D partition P. Error occurs if device D has no
                        partition table.
               - "D:0": device D.
               - "D" or "D:": device D partition 1 if device D has partition
                              table, or the whole device D if has no partition
                              table.
               - "D:auto": first partition in device D with bootable flag set.
4289
                           If none, first valid partition in device D. If no
4290 4291 4292 4293 4294
                           partition table then means device D.

       - FAT_ENV_FILE:

         It's a string of the FAT file name. This file use to store the
4295
         environment.
4296 4297

       - CONFIG_FAT_WRITE:
4298
         This should be defined. Otherwise it cannot save the environment file.
4299

4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320
- CONFIG_ENV_IS_IN_MMC:

	Define this if you have an MMC device which you want to use for the
	environment.

	- CONFIG_SYS_MMC_ENV_DEV:

	  Specifies which MMC device the environment is stored in.

	- CONFIG_SYS_MMC_ENV_PART (optional):

	  Specifies which MMC partition the environment is stored in. If not
	  set, defaults to partition 0, the user area. Common values might be
	  1 (first MMC boot partition), 2 (second MMC boot partition).

	- CONFIG_ENV_OFFSET:
	- CONFIG_ENV_SIZE:

	  These two #defines specify the offset and size of the environment
	  area within the specified MMC device.

4321 4322 4323 4324 4325 4326 4327 4328
	  If offset is positive (the usual case), it is treated as relative to
	  the start of the MMC partition. If offset is negative, it is treated
	  as relative to the end of the MMC partition. This can be useful if
	  your board may be fitted with different MMC devices, which have
	  different sizes for the MMC partitions, and you always want the
	  environment placed at the very end of the partition, to leave the
	  maximum possible space before it, to store other data.

4329 4330 4331 4332 4333 4334 4335 4336 4337 4338
	  These two values are in units of bytes, but must be aligned to an
	  MMC sector boundary.

	- CONFIG_ENV_OFFSET_REDUND (optional):

	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
	  hold a redundant copy of the environment data. This provides a
	  valid backup copy in case the other copy is corrupted, e.g. due
	  to a power failure during a "saveenv" operation.

4339 4340 4341
	  This value may also be positive or negative; this is handled in the
	  same way as CONFIG_ENV_OFFSET.

4342 4343 4344 4345 4346 4347 4348 4349 4350
	  This value is also in units of bytes, but must also be aligned to
	  an MMC sector boundary.

	- CONFIG_ENV_SIZE_REDUND (optional):

	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
	  set. If this value is set, it must be set to the same value as
	  CONFIG_ENV_SIZE.

4351
- CONFIG_SYS_SPI_INIT_OFFSET
W
wdenk 已提交
4352 4353 4354 4355 4356 4357 4358 4359 4360

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

B
Bruce Adler 已提交
4361
Please note that the environment is read-only until the monitor
W
wdenk 已提交
4362
has been relocated to RAM and a RAM copy of the environment has been
4363
created; also, when using EEPROM you will have to use getenv_f()
W
wdenk 已提交
4364 4365
until then to read environment variables.

W
wdenk 已提交
4366 4367 4368 4369 4370 4371
The environment is protected by a CRC32 checksum. Before the monitor
is relocated into RAM, as a result of a bad CRC you will be working
with the compiled-in default environment - *silently*!!! [This is
necessary, because the first environment variable we need is the
"baudrate" setting for the console - if we have a bad CRC, we don't
have any device yet where we could complain.]
W
wdenk 已提交
4372 4373 4374

Note: once the monitor has been relocated, then it will complain if
the default environment is used; a new CRC is computed as soon as you
W
wdenk 已提交
4375
use the "saveenv" command to store a valid environment.
W
wdenk 已提交
4376

4377
- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
W
wdenk 已提交
4378
		Echo the inverted Ethernet link state to the fault LED.
W
wdenk 已提交
4379

4380
		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
W
wdenk 已提交
4381 4382
		      also needs to be defined.

4383
- CONFIG_SYS_FAULT_MII_ADDR:
W
wdenk 已提交
4384
		MII address of the PHY to check for the Ethernet link state.
W
wdenk 已提交
4385

4386 4387 4388 4389 4390 4391 4392
- CONFIG_NS16550_MIN_FUNCTIONS:
		Define this if you desire to only have use of the NS16550_init
		and NS16550_putc functions for the serial driver located at
		drivers/serial/ns16550.c.  This option is useful for saving
		space for already greatly restricted images, including but not
		limited to NAND_SPL configurations.

4393 4394 4395 4396 4397
- CONFIG_DISPLAY_BOARDINFO
		Display information about the board that U-Boot is running on
		when U-Boot starts up. The board function checkboard() is called
		to do this.

4398 4399 4400 4401 4402
- CONFIG_DISPLAY_BOARDINFO_LATE
		Similar to the previous option, but display this information
		later, once stdio is running and output goes to the LCD, if
		present.

4403 4404 4405 4406 4407
- CONFIG_BOARD_SIZE_LIMIT:
		Maximum size of the U-Boot image. When defined, the
		build system checks that the actual size does not
		exceed it.

W
wdenk 已提交
4408
Low Level (hardware related) configuration options:
W
wdenk 已提交
4409
---------------------------------------------------
W
wdenk 已提交
4410

4411
- CONFIG_SYS_CACHELINE_SIZE:
W
wdenk 已提交
4412 4413
		Cache Line Size of the CPU.

4414
- CONFIG_SYS_DEFAULT_IMMR:
W
wdenk 已提交
4415
		Default address of the IMMR after system reset.
W
wdenk 已提交
4416

W
wdenk 已提交
4417 4418 4419
		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
		and RPXsuper) to be able to adjust the position of
		the IMMR register after a reset.
W
wdenk 已提交
4420

4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434
- CONFIG_SYS_CCSRBAR_DEFAULT:
		Default (power-on reset) physical address of CCSR on Freescale
		PowerPC SOCs.

- CONFIG_SYS_CCSRBAR:
		Virtual address of CCSR.  On a 32-bit build, this is typically
		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.

		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
		for cross-platform code that uses that macro instead.

- CONFIG_SYS_CCSRBAR_PHYS:
		Physical address of CCSR.  CCSR can be relocated to a new
		physical address, if desired.  In this case, this macro should
W
Wolfgang Denk 已提交
4435
		be set to that address.	 Otherwise, it should be set to the
4436 4437 4438 4439 4440 4441 4442 4443
		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
		is typically relocated on 36-bit builds.  It is recommended
		that this macro be defined via the _HIGH and _LOW macros:

		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)

- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
4444 4445
		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457
		used in assembly code, so it must not contain typecasts or
		integer size suffixes (e.g. "ULL").

- CONFIG_SYS_CCSRBAR_PHYS_LOW:
		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
		used in assembly code, so it must not contain typecasts or
		integer size suffixes (e.g. "ULL").

- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
		forced to a value that ensures that CCSR is not relocated.

W
wdenk 已提交
4458
- Floppy Disk Support:
4459
		CONFIG_SYS_FDC_DRIVE_NUMBER
W
wdenk 已提交
4460 4461 4462

		the default drive number (default value 0)

4463
		CONFIG_SYS_ISA_IO_STRIDE
W
wdenk 已提交
4464

M
Marcel Ziswiler 已提交
4465
		defines the spacing between FDC chipset registers
W
wdenk 已提交
4466 4467
		(default value 1)

4468
		CONFIG_SYS_ISA_IO_OFFSET
W
wdenk 已提交
4469

W
wdenk 已提交
4470 4471
		defines the offset of register from address. It
		depends on which part of the data bus is connected to
M
Marcel Ziswiler 已提交
4472
		the FDC chipset. (default value 0)
W
wdenk 已提交
4473

4474 4475
		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
W
wdenk 已提交
4476
		default value.
W
wdenk 已提交
4477

4478
		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
W
wdenk 已提交
4479 4480
		fdc_hw_init() is called at the beginning of the FDC
		setup. fdc_hw_init() must be provided by the board
4481
		source code. It is used to make hardware-dependent
W
wdenk 已提交
4482
		initializations.
W
wdenk 已提交
4483

4484 4485 4486 4487 4488 4489
- CONFIG_IDE_AHB:
		Most IDE controllers were designed to be connected with PCI
		interface. Only few of them were designed for AHB interface.
		When software is doing ATA command and data transfer to
		IDE devices through IDE-AHB controller, some additional
		registers accessing to these kind of IDE-AHB controller
4490
		is required.
4491

4492
- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
W
wdenk 已提交
4493
		DO NOT CHANGE unless you know exactly what you're
W
wdenk 已提交
4494
		doing! (11-4) [MPC8xx/82xx systems only]
W
wdenk 已提交
4495

4496
- CONFIG_SYS_INIT_RAM_ADDR:
W
wdenk 已提交
4497

W
wdenk 已提交
4498
		Start address of memory area that can be used for
W
wdenk 已提交
4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510
		initial data and stack; please note that this must be
		writable memory that is working WITHOUT special
		initialization, i. e. you CANNOT use normal RAM which
		will become available only after programming the
		memory controller and running certain initialization
		sequences.

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

4511
- CONFIG_SYS_GBL_DATA_OFFSET:
W
wdenk 已提交
4512 4513

		Offset of the initial data structure in the memory
4514 4515
		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
W
wdenk 已提交
4516
		data is located at the end of the available space
4517
		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4518 4519 4520
		CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
		CONFIG_SYS_GBL_DATA_OFFSET) downward.
W
wdenk 已提交
4521 4522 4523 4524

	Note:
		On the MPC824X (or other systems that use the data
		cache for initial memory) the address chosen for
4525
		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
W
wdenk 已提交
4526 4527 4528
		point to an otherwise UNUSED address space between
		the top of RAM and the start of the PCI space.

4529
- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
W
wdenk 已提交
4530

4531
- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
W
wdenk 已提交
4532

4533
- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
W
wdenk 已提交
4534

4535
- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
W
wdenk 已提交
4536

4537
- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
W
wdenk 已提交
4538

4539
- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
W
wdenk 已提交
4540

4541
- CONFIG_SYS_OR_TIMING_SDRAM:
W
wdenk 已提交
4542 4543
		SDRAM timing

4544
- CONFIG_SYS_MAMR_PTA:
W
wdenk 已提交
4545 4546
		periodic timer for refresh

4547
- CONFIG_SYS_DER:	Debug Event Register (37-47)
W
wdenk 已提交
4548

4549 4550 4551 4552
- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
  CONFIG_SYS_BR1_PRELIM:
W
wdenk 已提交
4553 4554 4555
		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)

- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
4556 4557
  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
W
wdenk 已提交
4558 4559
		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)

4560 4561
- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
W
wdenk 已提交
4562 4563 4564
		Machine Mode Register and Memory Periodic Timer
		Prescaler definitions (SDRAM timing)

4565
- CONFIG_SYS_I2C_UCODE_PATCH, CONFIG_SYS_I2C_DPMEM_OFFSET [0x1FC0]:
W
wdenk 已提交
4566 4567 4568
		enable I2C microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [DSP2]

4569
- CONFIG_SYS_SMC_UCODE_PATCH, CONFIG_SYS_SMC_DPMEM_OFFSET [0x1FC0]:
4570 4571 4572
		enable SMC microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [SMC1]

4573
- CONFIG_SYS_SPI_UCODE_PATCH, CONFIG_SYS_SPI_DPMEM_OFFSET [0x1FC0]:
W
wdenk 已提交
4574 4575 4576
		enable SPI microcode relocation patch (MPC8xx);
		define relocation offset in DPRAM [SCC4]

4577
- CONFIG_SYS_USE_OSCCLK:
W
wdenk 已提交
4578 4579 4580 4581
		Use OSCM clock mode on MBX8xx board. Be careful,
		wrong setting might damage your board. Read
		doc/README.MBX before setting this variable!

4582
- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
W
wdenk 已提交
4583 4584 4585 4586
		Offset of the bootmode word in DPRAM used by post
		(Power On Self Tests). This definition overrides
		#define'd default value in commproc.h resp.
		cpm_8260.h.
4587

4588 4589 4590 4591 4592 4593 4594 4595
- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
S
Stefan Roese 已提交
4596
		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
W
wdenk 已提交
4597

4598 4599 4600 4601
- CONFIG_PCI_DISABLE_PCIE:
		Disable PCI-Express on systems where it is supported but not
		required.

4602
- CONFIG_PCI_ENUM_ONLY
4603
		Only scan through and get the devices on the buses.
4604 4605 4606 4607 4608
		Don't do any setup work, presumably because someone or
		something has already done it, and we don't need to do it
		a second time.	Useful for platforms that are pre-booted
		by coreboot or similar.

4609 4610 4611
- CONFIG_PCI_INDIRECT_BRIDGE:
		Enable support for indirect PCI bridges.

4612 4613 4614 4615 4616 4617 4618 4619 4620
- CONFIG_SYS_SRIO:
		Chip has SRIO or not

- CONFIG_SRIO1:
		Board has SRIO 1 port available

- CONFIG_SRIO2:
		Board has SRIO 2 port available

4621 4622 4623
- CONFIG_SRIO_PCIE_BOOT_MASTER
		Board can support master function for Boot from SRIO and PCIE

4624 4625 4626 4627 4628 4629 4630 4631 4632
- CONFIG_SYS_SRIOn_MEM_VIRT:
		Virtual Address of SRIO port 'n' memory region

- CONFIG_SYS_SRIOn_MEM_PHYS:
		Physical Address of SRIO port 'n' memory region

- CONFIG_SYS_SRIOn_MEM_SIZE:
		Size of SRIO port 'n' memory region

4633 4634 4635 4636
- CONFIG_SYS_NAND_BUSWIDTH_16BIT
		Defined to tell the NAND controller that the NAND chip is using
		a 16 bit bus.
		Not all NAND drivers use this symbol.
4637
		Example of drivers that use it:
4638
		- drivers/mtd/nand/ndfc.c
4639
		- drivers/mtd/nand/mxc_nand.c
4640 4641 4642 4643 4644

- CONFIG_SYS_NDFC_EBC0_CFG
		Sets the EBC0_CFG register for the NDFC. If not defined
		a default value will be used.

B
Ben Warren 已提交
4645
- CONFIG_SPD_EEPROM
4646 4647 4648
		Get DDR timing information from an I2C EEPROM. Common
		with pluggable memory modules such as SODIMMs

B
Ben Warren 已提交
4649 4650 4651
  SPD_EEPROM_ADDRESS
		I2C address of the SPD EEPROM

4652
- CONFIG_SYS_SPD_BUS_NUM
4653 4654 4655
		If SPD EEPROM is on an I2C bus other than the first
		one, specify here. Note that the value must resolve
		to something your driver can deal with.
B
Ben Warren 已提交
4656

4657 4658 4659 4660 4661 4662
- CONFIG_SYS_DDR_RAW_TIMING
		Get DDR timing information from other than SPD. Common with
		soldered DDR chips onboard without SPD. DDR raw timing
		parameters are extracted from datasheet and hard-coded into
		header files or board specific files.

4663 4664 4665
- CONFIG_FSL_DDR_INTERACTIVE
		Enable interactive DDR debugging. See doc/README.fsl-ddr.

Y
York Sun 已提交
4666 4667 4668
- CONFIG_FSL_DDR_SYNC_REFRESH
		Enable sync of refresh for multiple controllers.

4669 4670 4671
- CONFIG_FSL_DDR_BIST
		Enable built-in memory test for Freescale DDR controllers.

4672
- CONFIG_SYS_83XX_DDR_USES_CS0
4673 4674
		Only for 83xx systems. If specified, then DDR should
		be configured using CS0 and CS1 instead of CS2 and CS3.
4675

4676 4677 4678 4679 4680
- CONFIG_ETHER_ON_FEC[12]
		Define to enable FEC[12] on a 8xx series processor.

- CONFIG_FEC[12]_PHY
		Define to the hardcoded PHY address which corresponds
W
wdenk 已提交
4681 4682
		to the given FEC; i. e.
			#define CONFIG_FEC1_PHY 4
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695
		means that the PHY with address 4 is connected to FEC1

		When set to -1, means to probe for first available.

- CONFIG_FEC[12]_PHY_NORXERR
		The PHY does not have a RXERR line (RMII only).
		(so program the FEC to ignore it).

- CONFIG_RMII
		Enable RMII mode for all FECs.
		Note that this is a global option, we can't
		have one FEC in standard MII mode and another in RMII mode.

4696 4697 4698 4699 4700 4701 4702 4703 4704 4705
- CONFIG_CRC32_VERIFY
		Add a verify option to the crc32 command.
		The syntax is:

		=> crc32 -v <address> <count> <crc32>

		Where address/count indicate a memory area
		and crc32 is the correct crc32 which the
		area should have.

W
wdenk 已提交
4706 4707
- CONFIG_LOOPW
		Add the "loopw" memory command. This only takes effect if
4708
		the memory commands are activated globally (CONFIG_CMD_MEM).
W
wdenk 已提交
4709

S
stroese 已提交
4710 4711 4712 4713 4714
- CONFIG_MX_CYCLIC
		Add the "mdc" and "mwc" memory commands. These are cyclic
		"md/mw" commands.
		Examples:

W
wdenk 已提交
4715
		=> mdc.b 10 4 500
S
stroese 已提交
4716 4717
		This command will print 4 bytes (10,11,12,13) each 500 ms.

W
wdenk 已提交
4718
		=> mwc.l 100 12345678 10
S
stroese 已提交
4719 4720
		This command will write 12345678 to address 100 all 10 ms.

W
wdenk 已提交
4721
		This only takes effect if the memory commands are activated
4722
		globally (CONFIG_CMD_MEM).
S
stroese 已提交
4723

W
wdenk 已提交
4724
- CONFIG_SKIP_LOWLEVEL_INIT
4725
		[ARM, NDS32, MIPS only] If this variable is defined, then certain
W
Wolfgang Denk 已提交
4726 4727 4728 4729 4730 4731 4732 4733
		low level initializations (like setting up the memory
		controller) are omitted and/or U-Boot does not
		relocate itself into RAM.

		Normally this variable MUST NOT be defined. The only
		exception is when U-Boot is loaded (to RAM) by some
		other boot loader or by a debugger which performs
		these initializations itself.
W
wdenk 已提交
4734

4735 4736
- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
		[ARM926EJ-S only] This allows just the call to lowlevel_init()
4737
		to be skipped. The normal CP15 init (such as enabling the
4738 4739
		instruction cache) is still performed.

4740
- CONFIG_SPL_BUILD
4741 4742 4743
		Modifies the behaviour of start.S when compiling a loader
		that is executed before the actual U-Boot. E.g. when
		compiling a NAND SPL.
W
wdenk 已提交
4744

4745 4746 4747 4748 4749
- CONFIG_TPL_BUILD
		Modifies the behaviour of start.S  when compiling a loader
		that is executed after the SPL and before the actual U-Boot.
		It is loaded by the SPL.

4750 4751 4752 4753 4754
- CONFIG_SYS_MPC85XX_NO_RESETVEC
		Only for 85xx systems. If this variable is specified, the section
		.resetvec is not kept and the section .bootpg is placed in the
		previous 4k of the .text section.

4755 4756 4757 4758 4759 4760 4761 4762 4763
- CONFIG_ARCH_MAP_SYSMEM
		Generally U-Boot (and in particular the md command) uses
		effective address. It is therefore not necessary to regard
		U-Boot address as virtual addresses that need to be translated
		to physical addresses. However, sandbox requires this, since
		it maintains its own little RAM buffer which contains all
		addressable memory. This option causes some memory accesses
		to be mapped through map_sysmem() / unmap_sysmem().

4764 4765 4766 4767 4768 4769
- CONFIG_USE_ARCH_MEMCPY
  CONFIG_USE_ARCH_MEMSET
		If these options are used a optimized version of memcpy/memset will
		be used if available. These functions may be faster under some
		conditions but may increase the binary size.

4770 4771 4772
- CONFIG_X86_RESET_VECTOR
		If defined, the x86 reset vector code is included. This is not
		needed when U-Boot is running from Coreboot.
4773

4774 4775 4776 4777
- CONFIG_SYS_MPUCLK
		Defines the MPU clock speed (in MHz).

		NOTE : currently only supported on AM335x platforms.
4778

4779 4780 4781
- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
		Enables the RTC32K OSC on AM33xx based plattforms

4782 4783 4784 4785 4786
- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
		Option to disable subpage write in NAND driver
		driver that uses this:
		drivers/mtd/nand/davinci_nand.c

4787 4788 4789 4790 4791 4792 4793 4794 4795
Freescale QE/FMAN Firmware Support:
-----------------------------------

The Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
loading of "firmware", which is encoded in the QE firmware binary format.
This firmware often needs to be loaded during U-Boot booting, so macros
are used to identify the storage device (NOR flash, SPI, etc) and the address
within that device.

4796 4797 4798 4799 4800 4801 4802
- CONFIG_SYS_FMAN_FW_ADDR
	The address in the storage device where the FMAN microcode is located.  The
	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
	is also specified.

- CONFIG_SYS_QE_FW_ADDR
	The address in the storage device where the QE microcode is located.  The
4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828
	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
	is also specified.

- CONFIG_SYS_QE_FMAN_FW_LENGTH
	The maximum possible size of the firmware.  The firmware binary format
	has a field that specifies the actual size of the firmware, but it
	might not be possible to read any part of the firmware unless some
	local storage is allocated to hold the entire firmware first.

- CONFIG_SYS_QE_FMAN_FW_IN_NOR
	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
	virtual address in NOR flash.

- CONFIG_SYS_QE_FMAN_FW_IN_NAND
	Specifies that QE/FMAN firmware is located in NAND flash.
	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.

- CONFIG_SYS_QE_FMAN_FW_IN_MMC
	Specifies that QE/FMAN firmware is located on the primary SD/MMC
	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.

- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
	Specifies that QE/FMAN firmware is located on the primary SPI
	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.

4829 4830 4831
- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
	Specifies that QE/FMAN firmware is located in the remote (master)
	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4832 4833 4834
	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
	window->master inbound window->master LAW->the ucode address in
	master's memory space.
4835

4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862
Freescale Layerscape Management Complex Firmware Support:
---------------------------------------------------------
The Freescale Layerscape Management Complex (MC) supports the loading of
"firmware".
This firmware often needs to be loaded during U-Boot booting, so macros
are used to identify the storage device (NOR flash, SPI, etc) and the address
within that device.

- CONFIG_FSL_MC_ENET
	Enable the MC driver for Layerscape SoCs.

- CONFIG_SYS_LS_MC_FW_ADDR
	The address in the storage device where the firmware is located.  The
	meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
	is also specified.

- CONFIG_SYS_LS_MC_FW_LENGTH
	The maximum possible size of the firmware.  The firmware binary format
	has a field that specifies the actual size of the firmware, but it
	might not be possible to read any part of the firmware unless some
	local storage is allocated to hold the entire firmware first.

- CONFIG_SYS_LS_MC_FW_IN_NOR
	Specifies that MC firmware is located in NOR flash, mapped as
	normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
	virtual address in NOR flash.

4863 4864 4865 4866 4867 4868
Freescale Layerscape Debug Server Support:
-------------------------------------------
The Freescale Layerscape Debug Server Support supports the loading of
"Debug Server firmware" and triggering SP boot-rom.
This firmware often needs to be loaded during U-Boot booting.

4869 4870
- CONFIG_SYS_MC_RSV_MEM_ALIGN
	Define alignment of reserved memory MC requires
4871

4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883
Reproducible builds
-------------------

In order to achieve reproducible builds, timestamps used in the U-Boot build
process have to be set to a fixed value.

This is done using the SOURCE_DATE_EPOCH environment variable.
SOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
option for U-Boot or an environment variable in U-Boot.

SOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.

W
wdenk 已提交
4884 4885 4886
Building the Software:
======================

4887 4888 4889 4890 4891 4892
Building U-Boot has been tested in several native build environments
and in many different cross environments. Of course we cannot support
all possibly existing versions of cross development tools in all
(potentially obsolete) versions. In case of tool chain problems we
recommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
which is extensively used to build and test U-Boot.
W
wdenk 已提交
4893

4894 4895 4896 4897 4898
If you are not using a native environment, it is assumed that you
have GNU cross compiling tools available in your path. In this case,
you must set the environment variable CROSS_COMPILE in your shell.
Note that no changes to the Makefile or any other source files are
necessary. For example using the ELDK on a 4xx CPU, please enter:
W
wdenk 已提交
4899

4900 4901
	$ CROSS_COMPILE=ppc_4xx-
	$ export CROSS_COMPILE
W
wdenk 已提交
4902

4903 4904 4905 4906 4907 4908 4909 4910 4911 4912
Note: If you wish to generate Windows versions of the utilities in
      the tools directory you can use the MinGW toolchain
      (http://www.mingw.org).  Set your HOST tools to the MinGW
      toolchain and execute 'make tools'.  For example:

       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools

      Binaries such as tools/mkimage.exe will be created which can
      be executed on computers running Windows.

4913 4914
U-Boot is intended to be simple to build. After installing the
sources you must configure U-Boot for one specific board type. This
W
wdenk 已提交
4915 4916
is done by typing:

4917
	make NAME_defconfig
W
wdenk 已提交
4918

4919
where "NAME_defconfig" is the name of one of the existing configu-
4920
rations; see boards.cfg for supported names.
4921

W
wdenk 已提交
4922 4923 4924 4925
Note: for some board special configuration names may exist; check if
      additional information is available from the board vendor; for
      instance, the TQM823L systems are available without (standard)
      or with LCD support. You can select such additional "features"
M
Marcel Ziswiler 已提交
4926
      when choosing the configuration, i. e.
W
wdenk 已提交
4927

4928
      make TQM823L_defconfig
W
wdenk 已提交
4929 4930
	- will configure for a plain TQM823L, i. e. no LCD support

4931
      make TQM823L_LCD_defconfig
W
wdenk 已提交
4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943
	- will configure for a TQM823L with U-Boot console on LCD

      etc.


Finally, type "make all", and you should get some working U-Boot
images ready for download to / installation on your system:

- "u-boot.bin" is a raw binary image
- "u-boot" is an image in ELF binary format
- "u-boot.srec" is in Motorola S-Record format

4944 4945 4946 4947 4948 4949 4950
By default the build is performed locally and the objects are saved
in the source directory. One of the two methods can be used to change
this behavior and build U-Boot to some external directory:

1. Add O= to the make command line invocations:

	make O=/tmp/build distclean
4951
	make O=/tmp/build NAME_defconfig
4952 4953
	make O=/tmp/build all

4954
2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4955

4956
	export KBUILD_OUTPUT=/tmp/build
4957
	make distclean
4958
	make NAME_defconfig
4959 4960
	make all

4961
Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
4962 4963
variable.

W
wdenk 已提交
4964 4965 4966 4967 4968 4969 4970 4971 4972 4973

Please be aware that the Makefiles assume you are using GNU make, so
for instance on NetBSD you might need to use "gmake" instead of
native "make".


If the system board that you have is not listed, then you will need
to port U-Boot to your hardware platform. To do this, follow these
steps:

4974
1.  Create a new directory to hold your board specific code. Add any
W
wdenk 已提交
4975
    files you need. In your board directory, you will need at least
4976 4977 4978
    the "Makefile" and a "<board>.c".
2.  Create a new configuration file "include/configs/<board>.h" for
    your board.
W
wdenk 已提交
4979 4980
3.  If you're porting U-Boot to a new CPU, then also create a new
    directory to hold your CPU specific code. Add any files you need.
4981
4.  Run "make <board>_defconfig" with your new name.
W
wdenk 已提交
4982 4983 4984 4985 4986 4987 4988 4989 4990
5.  Type "make", and you should get a working "u-boot.srec" file
    to be installed on your target system.
6.  Debug and solve any problems that might arise.
    [Of course, this last step is much harder than it sounds.]


Testing of U-Boot Modifications, Ports to New Hardware, etc.:
==============================================================

4991 4992
If you have modified U-Boot sources (for instance added a new board
or support for new devices, a new CPU, etc.) you are expected to
W
wdenk 已提交
4993 4994
provide feedback to the other developers. The feedback normally takes
the form of a "patch", i. e. a context diff against a certain (latest
4995
official or latest in the git repository) version of U-Boot sources.
W
wdenk 已提交
4996

4997 4998
But before you submit such a patch, please verify that your modifi-
cation did not break existing code. At least make sure that *ALL* of
W
wdenk 已提交
4999
the supported boards compile WITHOUT ANY compiler warnings. To do so,
5000 5001 5002 5003
just run the buildman script (tools/buildman/buildman), which will
configure and build U-Boot for ALL supported system. Be warned, this
will take a while. Please see the buildman README, or run 'buildman -H'
for documentation.
5004 5005


W
wdenk 已提交
5006 5007 5008 5009 5010 5011 5012 5013 5014 5015
See also "U-Boot Porting Guide" below.


Monitor Commands - Overview:
============================

go	- start application at address 'addr'
run	- run commands in an environment variable
bootm	- boot application image from memory
bootp	- boot image via network using BootP/TFTP protocol
5016
bootz   - boot zImage from memory
W
wdenk 已提交
5017 5018 5019
tftpboot- boot image via network using TFTP protocol
	       and env variables "ipaddr" and "serverip"
	       (and eventually "gatewayip")
S
Simon Glass 已提交
5020
tftpput - upload a file via network using TFTP protocol
W
wdenk 已提交
5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031
rarpboot- boot image via network using RARP/TFTP protocol
diskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
loads	- load S-Record file over serial line
loadb	- load binary file over serial line (kermit mode)
md	- memory display
mm	- memory modify (auto-incrementing)
nm	- memory modify (constant address)
mw	- memory write (fill)
cp	- memory copy
cmp	- memory compare
crc32	- checksum calculation
5032
i2c	- I2C sub-system
W
wdenk 已提交
5033 5034 5035 5036 5037 5038 5039 5040
sspi	- SPI utility commands
base	- print or set address offset
printenv- print environment variables
setenv	- set environment variables
saveenv - save environment variables to persistent storage
protect - enable or disable FLASH write protection
erase	- erase FLASH memory
flinfo	- print FLASH memory information
5041
nand	- NAND memory operations (see doc/README.nand)
W
wdenk 已提交
5042 5043 5044 5045 5046
bdinfo	- print Board Info structure
iminfo	- print header information for application image
coninfo - print console devices and informations
ide	- IDE sub-system
loop	- infinite loop on address range
W
wdenk 已提交
5047
loopw	- infinite write loop on address range
W
wdenk 已提交
5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070
mtest	- simple RAM test
icache	- enable or disable instruction cache
dcache	- enable or disable data cache
reset	- Perform RESET of the CPU
echo	- echo args to console
version - print monitor version
help	- print online help
?	- alias for 'help'


Monitor Commands - Detailed Description:
========================================

TODO.

For now: just type "help <command>".


Environment Variables:
======================

U-Boot supports user configuration using Environment Variables which
can be made persistent by saving to Flash memory.
W
wdenk 已提交
5071

W
wdenk 已提交
5072 5073 5074 5075 5076 5077
Environment Variables are set using "setenv", printed using
"printenv", and saved to Flash using "saveenv". Using "setenv"
without a value can be used to delete a variable from the
environment. As long as you don't save the environment you are
working with an in-memory copy. In case the Flash area containing the
environment is erased by accident, a default environment is provided.
W
wdenk 已提交
5078

5079 5080 5081
Some configuration options can be set using Environment Variables.

List of environment variables (most likely not complete):
W
wdenk 已提交
5082

W
wdenk 已提交
5083
  baudrate	- see CONFIG_BAUDRATE
W
wdenk 已提交
5084

W
wdenk 已提交
5085
  bootdelay	- see CONFIG_BOOTDELAY
W
wdenk 已提交
5086

W
wdenk 已提交
5087
  bootcmd	- see CONFIG_BOOTCOMMAND
W
wdenk 已提交
5088

W
wdenk 已提交
5089
  bootargs	- Boot arguments when booting an RTOS image
W
wdenk 已提交
5090

W
wdenk 已提交
5091
  bootfile	- Name of the image to load with TFTP
W
wdenk 已提交
5092

5093 5094 5095 5096 5097 5098
  bootm_low	- Memory range available for image processing in the bootm
		  command can be restricted. This variable is given as
		  a hexadecimal number and defines lowest address allowed
		  for use by the bootm command. See also "bootm_size"
		  environment variable. Address defined by "bootm_low" is
		  also the base of the initial memory mapping for the Linux
5099 5100 5101
		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
		  bootm_mapsize.

W
Wolfgang Denk 已提交
5102
  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
5103 5104 5105 5106 5107 5108
		  This variable is given as a hexadecimal number and it
		  defines the size of the memory region starting at base
		  address bootm_low that is accessible by the Linux kernel
		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
		  as the default value if it is defined, and bootm_size is
		  used otherwise.
5109 5110 5111 5112 5113 5114 5115

  bootm_size	- Memory range available for image processing in the bootm
		  command can be restricted. This variable is given as
		  a hexadecimal number and defines the size of the region
		  allowed for use by the bootm command. See also "bootm_low"
		  environment variable.

5116 5117 5118 5119
  updatefile	- Location of the software update file on a TFTP server, used
		  by the automatic software update feature. Please refer to
		  documentation in doc/README.update for more details.

W
wdenk 已提交
5120 5121 5122 5123
  autoload	- if set to "no" (any string beginning with 'n'),
		  "bootp" will just load perform a lookup of the
		  configuration from the BOOTP server, but not try to
		  load any image using TFTP
W
wdenk 已提交
5124

W
wdenk 已提交
5125 5126 5127 5128
  autostart	- if set to "yes", an image loaded using the "bootp",
		  "rarpboot", "tftpboot" or "diskboot" commands will
		  be automatically started (by internally calling
		  "bootm")
5129

W
wdenk 已提交
5130 5131 5132 5133 5134
		  If set to "no", a standalone image passed to the
		  "bootm" command will be copied to the load address
		  (and eventually uncompressed), but NOT be started.
		  This can be used to load and uncompress arbitrary
		  data.
W
wdenk 已提交
5135

5136 5137
  fdt_high	- if set this restricts the maximum address that the
		  flattened device tree will be copied into upon boot.
5138 5139 5140 5141 5142 5143 5144 5145
		  For example, if you have a system with 1 GB memory
		  at physical address 0x10000000, while Linux kernel
		  only recognizes the first 704 MB as low memory, you
		  may need to set fdt_high as 0x3C000000 to have the
		  device tree blob be copied to the maximum address
		  of the 704 MB low memory, so that Linux kernel can
		  access it during the boot procedure.

5146 5147 5148 5149 5150 5151 5152
		  If this is set to the special value 0xFFFFFFFF then
		  the fdt will not be copied at all on boot.  For this
		  to work it must reside in writable memory, have
		  sufficient padding on the end of it for u-boot to
		  add the information it needs into it, and the memory
		  must be accessible by the kernel.

5153 5154 5155 5156
  fdtcontroladdr- if set this is the address of the control flattened
		  device tree used by U-Boot when CONFIG_OF_CONTROL is
		  defined.

W
wdenk 已提交
5157 5158 5159 5160 5161 5162
  i2cfast	- (PPC405GP|PPC405EP only)
		  if set to 'y' configures Linux I2C driver for fast
		  mode (400kHZ). This environment variable is used in
		  initialization code. So, for changes to be effective
		  it must be saved and board must be reset.

W
wdenk 已提交
5163 5164 5165 5166 5167 5168
  initrd_high	- restrict positioning of initrd images:
		  If this variable is not set, initrd images will be
		  copied to the highest possible address in RAM; this
		  is usually what you want since it allows for
		  maximum initrd size. If for some reason you want to
		  make sure that the initrd image is loaded below the
5169
		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
W
wdenk 已提交
5170 5171 5172 5173
		  variable to a value of "no" or "off" or "0".
		  Alternatively, you can set it to a maximum upper
		  address to use (U-Boot will still check that it
		  does not overwrite the U-Boot stack and data).
W
wdenk 已提交
5174

W
wdenk 已提交
5175 5176 5177 5178 5179 5180
		  For instance, when you have a system with 16 MB
		  RAM, and want to reserve 4 MB from use by Linux,
		  you can do this by adding "mem=12M" to the value of
		  the "bootargs" variable. However, now you must make
		  sure that the initrd image is placed in the first
		  12 MB as well - this can be done with
W
wdenk 已提交
5181

W
wdenk 已提交
5182
		  setenv initrd_high 00c00000
W
wdenk 已提交
5183

W
wdenk 已提交
5184 5185 5186 5187 5188 5189 5190
		  If you set initrd_high to 0xFFFFFFFF, this is an
		  indication to U-Boot that all addresses are legal
		  for the Linux kernel, including addresses in flash
		  memory. In this case U-Boot will NOT COPY the
		  ramdisk at all. This may be useful to reduce the
		  boot time on your system, but requires that this
		  feature is supported by your Linux kernel.
W
wdenk 已提交
5191

W
wdenk 已提交
5192
  ipaddr	- IP address; needed for tftpboot command
W
wdenk 已提交
5193

W
wdenk 已提交
5194 5195
  loadaddr	- Default load address for commands like "bootp",
		  "rarpboot", "tftpboot", "loadb" or "diskboot"
W
wdenk 已提交
5196

W
wdenk 已提交
5197
  loads_echo	- see CONFIG_LOADS_ECHO
5198

W
wdenk 已提交
5199
  serverip	- TFTP server IP address; needed for tftpboot command
5200

W
wdenk 已提交
5201
  bootretry	- see CONFIG_BOOT_RETRY_TIME
5202

W
wdenk 已提交
5203
  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
5204

W
wdenk 已提交
5205
  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
W
wdenk 已提交
5206

M
Mike Frysinger 已提交
5207
  ethprime	- controls which interface is used first.
W
wdenk 已提交
5208

M
Mike Frysinger 已提交
5209 5210
  ethact	- controls which interface is currently active.
		  For example you can do the following
W
wdenk 已提交
5211

5212 5213 5214 5215
		  => setenv ethact FEC
		  => ping 192.168.0.1 # traffic sent on FEC
		  => setenv ethact SCC
		  => ping 10.0.0.1 # traffic sent on SCC
W
wdenk 已提交
5216

5217 5218 5219 5220
  ethrotate	- When set to "no" U-Boot does not go through all
		  available network interfaces.
		  It just stays at the currently selected interface.

5221
  netretry	- When set to "no" each network operation will
W
wdenk 已提交
5222 5223 5224 5225 5226 5227
		  either succeed or fail without retrying.
		  When set to "once" the network operation will
		  fail when all the available network interfaces
		  are tried once without success.
		  Useful on scripts which control the retry operation
		  themselves.
W
wdenk 已提交
5228

5229
  npe_ucode	- set load address for the NPE microcode
5230

5231
  silent_linux  - If set then Linux will be told to boot silently, by
5232 5233 5234 5235 5236
		  changing the console to be empty. If "yes" it will be
		  made silent. If "no" it will not be made silent. If
		  unset, then it will be made silent if the U-Boot console
		  is silent.

5237
  tftpsrcp	- If this is set, the value is used for TFTP's
5238 5239
		  UDP source port.

5240
  tftpdstp	- If this is set, the value is used for TFTP's UDP
5241 5242
		  destination port instead of the Well Know Port 69.

5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253
  tftpblocksize - Block size to use for TFTP transfers; if not set,
		  we use the TFTP server's default block size

  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
		  seconds, minimum value is 1000 = 1 second). Defines
		  when a packet is considered to be lost so it has to
		  be retransmitted. The default is 5000 = 5 seconds.
		  Lowering this value may make downloads succeed
		  faster in networks with high packet loss rates or
		  with unreliable TFTP servers.

5254 5255 5256 5257 5258 5259 5260 5261
  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
		  unit, minimum value = 0). Defines how many timeouts
		  can happen during a single file transfer before that
		  transfer is aborted. The default is 10, and 0 means
		  'no timeouts allowed'. Increasing this value may help
		  downloads succeed with high packet loss rates, or with
		  unreliable TFTP servers or client hardware.

5262
  vlan		- When set to a value < 4095 the traffic over
M
Marcel Ziswiler 已提交
5263
		  Ethernet is encapsulated/received over 802.1q
W
wdenk 已提交
5264
		  VLAN tagged frames.
W
wdenk 已提交
5265

5266 5267 5268 5269 5270 5271
  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
		  Unsigned value, in milliseconds. If not set, the period will
		  be either the default (28000), or a value based on
		  CONFIG_NET_RETRY_COUNT, if defined. This value has
		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.

5272 5273 5274 5275 5276 5277 5278 5279 5280
The following image location variables contain the location of images
used in booting. The "Image" column gives the role of the image and is
not an environment variable name. The other columns are environment
variable names. "File Name" gives the name of the file on a TFTP
server, "RAM Address" gives the location in RAM the image will be
loaded to, and "Flash Location" gives the image's address in NOR
flash or offset in NAND flash.

*Note* - these variables don't have to be defined for all boards, some
F
Fabio Estevam 已提交
5281
boards currently use other variables for these purposes, and some
5282 5283
boards use these variables for other purposes.

W
Wolfgang Denk 已提交
5284 5285 5286 5287 5288 5289
Image		    File Name	     RAM Address       Flash Location
-----		    ---------	     -----------       --------------
u-boot		    u-boot	     u-boot_addr_r     u-boot_addr
Linux kernel	    bootfile	     kernel_addr_r     kernel_addr
device tree blob    fdtfile	     fdt_addr_r	       fdt_addr
ramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
5290

W
wdenk 已提交
5291 5292 5293
The following environment variables may be used and automatically
updated by the network boot commands ("bootp" and "rarpboot"),
depending the information provided by your boot server:
W
wdenk 已提交
5294

W
wdenk 已提交
5295 5296 5297 5298 5299 5300 5301 5302 5303
  bootfile	- see above
  dnsip		- IP address of your Domain Name Server
  dnsip2	- IP address of your secondary Domain Name Server
  gatewayip	- IP address of the Gateway (Router) to use
  hostname	- Target hostname
  ipaddr	- see above
  netmask	- Subnet Mask
  rootpath	- Pathname of the root filesystem on the NFS server
  serverip	- see above
5304 5305


W
wdenk 已提交
5306
There are two special Environment Variables:
5307

W
wdenk 已提交
5308 5309 5310
  serial#	- contains hardware identification information such
		  as type string and/or serial number
  ethaddr	- Ethernet address
W
wdenk 已提交
5311

W
wdenk 已提交
5312 5313 5314
These variables can be set only once (usually during manufacturing of
the board). U-Boot refuses to delete or overwrite these variables
once they have been set once.
W
wdenk 已提交
5315

5316

W
wdenk 已提交
5317
Further special Environment Variables:
5318

W
wdenk 已提交
5319 5320 5321
  ver		- Contains the U-Boot version string as printed
		  with the "version" command. This variable is
		  readonly (see CONFIG_VERSION_VARIABLE).
5322 5323


W
wdenk 已提交
5324 5325
Please note that changes to some configuration parameters may take
only effect after the next boot (yes, that's just like Windoze :-).
5326 5327


5328 5329 5330 5331
Callback functions for environment variables:
---------------------------------------------

For some environment variables, the behavior of u-boot needs to change
5332
when their values are changed.  This functionality allows functions to
5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354
be associated with arbitrary variables.  On creation, overwrite, or
deletion, the callback will provide the opportunity for some side
effect to happen or for the change to be rejected.

The callbacks are named and associated with a function using the
U_BOOT_ENV_CALLBACK macro in your board or driver code.

These callbacks are associated with variables in one of two ways.  The
static list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
in the board configuration to a string that defines a list of
associations.  The list must be in the following format:

	entry = variable_name[:callback_name]
	list = entry[,list]

If the callback name is not specified, then the callback is deleted.
Spaces are also allowed anywhere in the list.

Callbacks can also be associated by defining the ".callbacks" variable
with the same list format above.  Any association in ".callbacks" will
override any association in the static list. You can define
CONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
5355
".callbacks" environment variable in the default or embedded environment.
5356

5357 5358 5359 5360
If CONFIG_REGEX is defined, the variable_name above is evaluated as a
regular expression. This allows multiple variables to be connected to
the same callback without explicitly listing them all out.

5361

W
wdenk 已提交
5362 5363
Command Line Parsing:
=====================
5364

W
wdenk 已提交
5365 5366
There are two different command line parsers available with U-Boot:
the old "simple" one, and the much more powerful "hush" shell:
W
wdenk 已提交
5367

W
wdenk 已提交
5368 5369
Old, simple command line parser:
--------------------------------
W
wdenk 已提交
5370

W
wdenk 已提交
5371 5372
- supports environment variables (through setenv / saveenv commands)
- several commands on one line, separated by ';'
5373
- variable substitution using "... ${name} ..." syntax
W
wdenk 已提交
5374 5375
- special characters ('$', ';') can be escaped by prefixing with '\',
  for example:
5376
	setenv bootcmd bootm \${address}
W
wdenk 已提交
5377 5378
- You can also escape text by enclosing in single apostrophes, for example:
	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
W
wdenk 已提交
5379

W
wdenk 已提交
5380 5381
Hush shell:
-----------
W
wdenk 已提交
5382

W
wdenk 已提交
5383 5384 5385 5386 5387 5388 5389 5390 5391 5392
- similar to Bourne shell, with control structures like
  if...then...else...fi, for...do...done; while...do...done,
  until...do...done, ...
- supports environment ("global") variables (through setenv / saveenv
  commands) and local shell variables (through standard shell syntax
  "name=value"); only environment variables can be used with "run"
  command

General rules:
--------------
W
wdenk 已提交
5393

W
wdenk 已提交
5394 5395 5396 5397
(1) If a command line (or an environment variable executed by a "run"
    command) contains several commands separated by semicolon, and
    one of these commands fails, then the remaining commands will be
    executed anyway.
W
wdenk 已提交
5398

W
wdenk 已提交
5399
(2) If you execute several variables with one call to run (i. e.
M
Marcel Ziswiler 已提交
5400
    calling run with a list of variables as arguments), any failing
W
wdenk 已提交
5401 5402
    command will cause "run" to terminate, i. e. the remaining
    variables are not executed.
W
wdenk 已提交
5403

W
wdenk 已提交
5404 5405
Note for Redundant Ethernet Interfaces:
=======================================
W
wdenk 已提交
5406

M
Marcel Ziswiler 已提交
5407
Some boards come with redundant Ethernet interfaces; U-Boot supports
W
wdenk 已提交
5408 5409
such configurations and is capable of automatic selection of a
"working" interface when needed. MAC assignment works as follows:
W
wdenk 已提交
5410

W
wdenk 已提交
5411 5412 5413
Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
"eth1addr" (=>eth1), "eth2addr", ...
W
wdenk 已提交
5414

W
wdenk 已提交
5415 5416 5417 5418
If the network interface stores some valid MAC address (for instance
in SROM), this is used as default address if there is NO correspon-
ding setting in the environment; if the corresponding environment
variable is set, this overrides the settings in the card; that means:
W
wdenk 已提交
5419

W
wdenk 已提交
5420 5421
o If the SROM has a valid MAC address, and there is no address in the
  environment, the SROM's address is used.
W
wdenk 已提交
5422

W
wdenk 已提交
5423 5424 5425
o If there is no valid address in the SROM, and a definition in the
  environment exists, then the value from the environment variable is
  used.
W
wdenk 已提交
5426

W
wdenk 已提交
5427 5428
o If both the SROM and the environment contain a MAC address, and
  both addresses are the same, this MAC address is used.
W
wdenk 已提交
5429

W
wdenk 已提交
5430 5431 5432
o If both the SROM and the environment contain a MAC address, and the
  addresses differ, the value from the environment is used and a
  warning is printed.
W
wdenk 已提交
5433

W
wdenk 已提交
5434
o If neither SROM nor the environment contain a MAC address, an error
5435 5436
  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
  a random, locally-assigned MAC is used.
W
wdenk 已提交
5437

5438
If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
W
Wolfgang Denk 已提交
5439
will be programmed into hardware as part of the initialization process.	 This
5440 5441 5442
may be skipped by setting the appropriate 'ethmacskip' environment variable.
The naming convention is as follows:
"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
W
wdenk 已提交
5443

W
wdenk 已提交
5444 5445
Image Formats:
==============
W
wdenk 已提交
5446

5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464
U-Boot is capable of booting (and performing other auxiliary operations on)
images in two formats:

New uImage format (FIT)
-----------------------

Flexible and powerful format based on Flattened Image Tree -- FIT (similar
to Flattened Device Tree). It allows the use of images with multiple
components (several kernels, ramdisks, etc.), with contents protected by
SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.


Old uImage format
-----------------

Old image format is based on binary files which can be basically anything,
preceded by a special header; see the definitions in include/image.h for
details; basically, the header defines the following image properties:
W
wdenk 已提交
5465

W
wdenk 已提交
5466 5467
* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
5468 5469 5470
  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
  INTEGRITY).
W
Wolfgang Denk 已提交
5471
* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
5472 5473
  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
W
wdenk 已提交
5474 5475 5476 5477 5478
* Compression Type (uncompressed, gzip, bzip2)
* Load Address
* Entry Point
* Image Name
* Image Timestamp
W
wdenk 已提交
5479

W
wdenk 已提交
5480 5481 5482
The header is marked by a special Magic Number, and both the header
and the data portions of the image are secured against corruption by
CRC32 checksums.
W
wdenk 已提交
5483 5484


W
wdenk 已提交
5485 5486
Linux Support:
==============
W
wdenk 已提交
5487

W
wdenk 已提交
5488 5489 5490
Although U-Boot should support any OS or standalone application
easily, the main focus has always been on Linux during the design of
U-Boot.
W
wdenk 已提交
5491

W
wdenk 已提交
5492 5493 5494 5495 5496
U-Boot includes many features that so far have been part of some
special "boot loader" code within the Linux kernel. Also, any
"initrd" images to be used are no longer part of one big Linux image;
instead, kernel and "initrd" are separate images. This implementation
serves several purposes:
W
wdenk 已提交
5497

W
wdenk 已提交
5498 5499 5500
- the same features can be used for other OS or standalone
  applications (for instance: using compressed images to reduce the
  Flash memory footprint)
W
wdenk 已提交
5501

W
wdenk 已提交
5502 5503
- it becomes much easier to port new Linux kernel versions because
  lots of low-level, hardware dependent stuff are done by U-Boot
W
wdenk 已提交
5504

W
wdenk 已提交
5505 5506 5507 5508 5509 5510
- the same Linux kernel image can now be used with different "initrd"
  images; of course this also means that different kernel images can
  be run with the same "initrd". This makes testing easier (you don't
  have to build a new "zImage.initrd" Linux image when you just
  change a file in your "initrd"). Also, a field-upgrade of the
  software is easier now.
W
wdenk 已提交
5511 5512


W
wdenk 已提交
5513 5514
Linux HOWTO:
============
W
wdenk 已提交
5515

W
wdenk 已提交
5516 5517
Porting Linux to U-Boot based systems:
---------------------------------------
W
wdenk 已提交
5518

W
wdenk 已提交
5519 5520 5521 5522
U-Boot cannot save you from doing all the necessary modifications to
configure the Linux device drivers for use with your target hardware
(no, we don't intend to provide a full virtual machine interface to
Linux :-).
W
wdenk 已提交
5523

S
Stefan Roese 已提交
5524
But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
5525

W
wdenk 已提交
5526 5527
Just make sure your machine specific header file (for instance
include/asm-ppc/tqm8xx.h) includes the same definition of the Board
5528 5529
Information structure as we define in include/asm-<arch>/u-boot.h,
and make sure that your definition of IMAP_ADDR uses the same value
5530
as your U-Boot configuration in CONFIG_SYS_IMMR.
5531

5532 5533 5534 5535 5536
Note that U-Boot now has a driver model, a unified model for drivers.
If you are adding a new driver, plumb it into driver model. If there
is no uclass available, you are encouraged to create one. See
doc/driver-model.

W
wdenk 已提交
5537

W
wdenk 已提交
5538 5539
Configuring the Linux kernel:
-----------------------------
W
wdenk 已提交
5540

W
wdenk 已提交
5541 5542 5543 5544 5545 5546
No specific requirements for U-Boot. Make sure you have some root
device (initial ramdisk, NFS) for your target system.


Building a Linux Image:
-----------------------
W
wdenk 已提交
5547

W
wdenk 已提交
5548 5549 5550 5551 5552 5553 5554 5555 5556
With U-Boot, "normal" build targets like "zImage" or "bzImage" are
not used. If you use recent kernel source, a new build target
"uImage" will exist which automatically builds an image usable by
U-Boot. Most older kernels also have support for a "pImage" target,
which was introduced for our predecessor project PPCBoot and uses a
100% compatible format.

Example:

5557
	make TQM850L_defconfig
W
wdenk 已提交
5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582
	make oldconfig
	make dep
	make uImage

The "uImage" build target uses a special tool (in 'tools/mkimage') to
encapsulate a compressed Linux kernel image with header	 information,
CRC32 checksum etc. for use with U-Boot. This is what we are doing:

* build a standard "vmlinux" kernel image (in ELF binary format):

* convert the kernel into a raw binary image:

	${CROSS_COMPILE}-objcopy -O binary \
				 -R .note -R .comment \
				 -S vmlinux linux.bin

* compress the binary image:

	gzip -9 linux.bin

* package compressed binary image for U-Boot:

	mkimage -A ppc -O linux -T kernel -C gzip \
		-a 0 -e 0 -n "Linux Kernel Image" \
		-d linux.bin.gz uImage
W
wdenk 已提交
5583 5584


W
wdenk 已提交
5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597
The "mkimage" tool can also be used to create ramdisk images for use
with U-Boot, either separated from the Linux kernel image, or
combined into one file. "mkimage" encapsulates the images with a 64
byte header containing information about target architecture,
operating system, image type, compression method, entry points, time
stamp, CRC32 checksums, etc.

"mkimage" can be called in two ways: to verify existing images and
print the header information, or to build new images.

In the first form (with "-l" option) mkimage lists the information
contained in the header of an existing U-Boot image; this includes
checksum verification:
W
wdenk 已提交
5598

W
wdenk 已提交
5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615
	tools/mkimage -l image
	  -l ==> list image header information

The second form (with "-d" option) is used to build a U-Boot image
from a "data file" which is used as image payload:

	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
		      -n name -d data_file image
	  -A ==> set architecture to 'arch'
	  -O ==> set operating system to 'os'
	  -T ==> set image type to 'type'
	  -C ==> set compression type 'comp'
	  -a ==> set load address to 'addr' (hex)
	  -e ==> set entry point to 'ep' (hex)
	  -n ==> set image name to 'name'
	  -d ==> use image data from 'datafile'

W
wdenk 已提交
5616 5617 5618
Right now, all Linux kernels for PowerPC systems use the same load
address (0x00000000), but the entry point address depends on the
kernel version:
W
wdenk 已提交
5619 5620 5621 5622 5623 5624 5625 5626

- 2.2.x kernels have the entry point at 0x0000000C,
- 2.3.x and later kernels have the entry point at 0x00000000.

So a typical call to build a U-Boot image would read:

	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
S
Stefan Roese 已提交
5627
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
W
wdenk 已提交
5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650
	> examples/uImage.TQM850L
	Image Name:   2.4.4 kernel for TQM850L
	Created:      Wed Jul 19 02:34:59 2000
	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000

To verify the contents of the image (or check for corruption):

	-> tools/mkimage -l examples/uImage.TQM850L
	Image Name:   2.4.4 kernel for TQM850L
	Created:      Wed Jul 19 02:34:59 2000
	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000

NOTE: for embedded systems where boot time is critical you can trade
speed for memory and install an UNCOMPRESSED image instead: this
needs more space in Flash, but boots much faster since it does not
need to be uncompressed:

S
Stefan Roese 已提交
5651
	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
W
wdenk 已提交
5652 5653
	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
S
Stefan Roese 已提交
5654
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
W
wdenk 已提交
5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676
	> examples/uImage.TQM850L-uncompressed
	Image Name:   2.4.4 kernel for TQM850L
	Created:      Wed Jul 19 02:34:59 2000
	Image Type:   PowerPC Linux Kernel Image (uncompressed)
	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000


Similar you can build U-Boot images from a 'ramdisk.image.gz' file
when your kernel is intended to use an initial ramdisk:

	-> tools/mkimage -n 'Simple Ramdisk Image' \
	> -A ppc -O linux -T ramdisk -C gzip \
	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
	Image Name:   Simple Ramdisk Image
	Created:      Wed Jan 12 14:01:50 2000
	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
	Load Address: 0x00000000
	Entry Point:  0x00000000

5677 5678 5679 5680 5681
The "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
option performs the converse operation of the mkimage's second form (the "-d"
option). Given an image built by mkimage, the dumpimage extracts a "data file"
from the image:

5682 5683 5684 5685
	tools/dumpimage -i image -T type -p position data_file
	  -i ==> extract from the 'image' a specific 'data_file'
	  -T ==> set image type to 'type'
	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5686

W
wdenk 已提交
5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721

Installing a Linux Image:
-------------------------

To downloading a U-Boot image over the serial (console) interface,
you must convert the image to S-Record format:

	objcopy -I binary -O srec examples/image examples/image.srec

The 'objcopy' does not understand the information in the U-Boot
image header, so the resulting S-Record file will be relative to
address 0x00000000. To load it to a given address, you need to
specify the target address as 'offset' parameter with the 'loads'
command.

Example: install the image to address 0x40100000 (which on the
TQM8xxL is in the first Flash bank):

	=> erase 40100000 401FFFFF

	.......... done
	Erased 8 sectors

	=> loads 40100000
	## Ready for S-Record download ...
	~>examples/image.srec
	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
	...
	15989 15990 15991 15992
	[file transfer complete]
	[connected]
	## Start Addr = 0x00000000


You can check the success of the download using the 'iminfo' command;
5722
this includes a checksum verification so you can be sure no data
W
wdenk 已提交
5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769
corruption happened:

	=> imi 40100000

	## Checking Image at 40100000 ...
	   Image Name:	 2.2.13 for initrd on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 335725 Bytes = 327 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK


Boot Linux:
-----------

The "bootm" command is used to boot an application that is stored in
memory (RAM or Flash). In case of a Linux kernel image, the contents
of the "bootargs" environment variable is passed to the kernel as
parameters. You can check and modify this variable using the
"printenv" and "setenv" commands:


	=> printenv bootargs
	bootargs=root=/dev/ram

	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2

	=> printenv bootargs
	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2

	=> bootm 40020000
	## Booting Linux kernel at 40020000 ...
	   Image Name:	 2.2.13 for NFS on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 381681 Bytes = 372 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK
	   Uncompressing Kernel Image ... OK
	Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:35:17 MEST 2000
	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
	time_init: decrementer frequency = 187500000/60
	Calibrating delay loop... 49.77 BogoMIPS
	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
	...

M
Marcel Ziswiler 已提交
5770
If you want to boot a Linux kernel with initial RAM disk, you pass
W
wdenk 已提交
5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818
the memory addresses of both the kernel and the initrd image (PPBCOOT
format!) to the "bootm" command:

	=> imi 40100000 40200000

	## Checking Image at 40100000 ...
	   Image Name:	 2.2.13 for initrd on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 335725 Bytes = 327 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK

	## Checking Image at 40200000 ...
	   Image Name:	 Simple Ramdisk Image
	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
	   Data Size:	 566530 Bytes = 553 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 00000000
	   Verifying Checksum ... OK

	=> bootm 40100000 40200000
	## Booting Linux kernel at 40100000 ...
	   Image Name:	 2.2.13 for initrd on TQM850L
	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
	   Data Size:	 335725 Bytes = 327 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 0000000c
	   Verifying Checksum ... OK
	   Uncompressing Kernel Image ... OK
	## Loading RAMDisk Image at 40200000 ...
	   Image Name:	 Simple Ramdisk Image
	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
	   Data Size:	 566530 Bytes = 553 kB = 0 MB
	   Load Address: 00000000
	   Entry Point:	 00000000
	   Verifying Checksum ... OK
	   Loading Ramdisk ... OK
	Linux version 2.2.13 (wd@denx.local.net) (gcc version 2.95.2 19991024 (release)) #1 Wed Jul 19 02:32:08 MEST 2000
	Boot arguments: root=/dev/ram
	time_init: decrementer frequency = 187500000/60
	Calibrating delay loop... 49.77 BogoMIPS
	...
	RAMDISK: Compressed image found at block 0
	VFS: Mounted root (ext2 filesystem).

	bash#

5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854
Boot Linux and pass a flat device tree:
-----------

First, U-Boot must be compiled with the appropriate defines. See the section
titled "Linux Kernel Interface" above for a more in depth explanation. The
following is an example of how to start a kernel and pass an updated
flat device tree:

=> print oftaddr
oftaddr=0x300000
=> print oft
oft=oftrees/mpc8540ads.dtb
=> tftp $oftaddr $oft
Speed: 1000, full duplex
Using TSEC0 device
TFTP from server 192.168.1.1; our IP address is 192.168.1.101
Filename 'oftrees/mpc8540ads.dtb'.
Load address: 0x300000
Loading: #
done
Bytes transferred = 4106 (100a hex)
=> tftp $loadaddr $bootfile
Speed: 1000, full duplex
Using TSEC0 device
TFTP from server 192.168.1.1; our IP address is 192.168.1.2
Filename 'uImage'.
Load address: 0x200000
Loading:############
done
Bytes transferred = 1029407 (fb51f hex)
=> print loadaddr
loadaddr=200000
=> print oftaddr
oftaddr=0x300000
=> bootm $loadaddr - $oftaddr
## Booting image at 00200000 ...
5855 5856 5857
   Image Name:	 Linux-2.6.17-dirty
   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
   Data Size:	 1029343 Bytes = 1005.2 kB
5858
   Load Address: 00000000
5859
   Entry Point:	 00000000
5860 5861 5862 5863 5864 5865 5866 5867
   Verifying Checksum ... OK
   Uncompressing Kernel Image ... OK
Booting using flat device tree at 0x300000
Using MPC85xx ADS machine description
Memory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
[snip]


W
wdenk 已提交
5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907
More About U-Boot Image Types:
------------------------------

U-Boot supports the following image types:

   "Standalone Programs" are directly runnable in the environment
	provided by U-Boot; it is expected that (if they behave
	well) you can continue to work in U-Boot after return from
	the Standalone Program.
   "OS Kernel Images" are usually images of some Embedded OS which
	will take over control completely. Usually these programs
	will install their own set of exception handlers, device
	drivers, set up the MMU, etc. - this means, that you cannot
	expect to re-enter U-Boot except by resetting the CPU.
   "RAMDisk Images" are more or less just data blocks, and their
	parameters (address, size) are passed to an OS kernel that is
	being started.
   "Multi-File Images" contain several images, typically an OS
	(Linux) kernel image and one or more data images like
	RAMDisks. This construct is useful for instance when you want
	to boot over the network using BOOTP etc., where the boot
	server provides just a single image file, but you want to get
	for instance an OS kernel and a RAMDisk image.

	"Multi-File Images" start with a list of image sizes, each
	image size (in bytes) specified by an "uint32_t" in network
	byte order. This list is terminated by an "(uint32_t)0".
	Immediately after the terminating 0 follow the images, one by
	one, all aligned on "uint32_t" boundaries (size rounded up to
	a multiple of 4 bytes).

   "Firmware Images" are binary images containing firmware (like
	U-Boot or FPGA images) which usually will be programmed to
	flash memory.

   "Script files" are command sequences that will be executed by
	U-Boot's command interpreter; this feature is especially
	useful when you configure U-Boot to use a real shell (hush)
	as command interpreter.

5908 5909 5910 5911 5912 5913 5914
Booting the Linux zImage:
-------------------------

On some platforms, it's possible to boot Linux zImage. This is done
using the "bootz" command. The syntax of "bootz" command is the same
as the syntax of "bootm" command.

5915
Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5916 5917 5918 5919
kernel with raw initrd images. The syntax is slightly different, the
address of the initrd must be augmented by it's size, in the following
format: "<initrd addres>:<initrd size>".

W
wdenk 已提交
5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016

Standalone HOWTO:
=================

One of the features of U-Boot is that you can dynamically load and
run "standalone" applications, which can use some resources of
U-Boot like console I/O functions or interrupt services.

Two simple examples are included with the sources:

"Hello World" Demo:
-------------------

'examples/hello_world.c' contains a small "Hello World" Demo
application; it is automatically compiled when you build U-Boot.
It's configured to run at address 0x00040004, so you can play with it
like that:

	=> loads
	## Ready for S-Record download ...
	~>examples/hello_world.srec
	1 2 3 4 5 6 7 8 9 10 11 ...
	[file transfer complete]
	[connected]
	## Start Addr = 0x00040004

	=> go 40004 Hello World! This is a test.
	## Starting application at 0x00040004 ...
	Hello World
	argc = 7
	argv[0] = "40004"
	argv[1] = "Hello"
	argv[2] = "World!"
	argv[3] = "This"
	argv[4] = "is"
	argv[5] = "a"
	argv[6] = "test."
	argv[7] = "<NULL>"
	Hit any key to exit ...

	## Application terminated, rc = 0x0

Another example, which demonstrates how to register a CPM interrupt
handler with the U-Boot code, can be found in 'examples/timer.c'.
Here, a CPM timer is set up to generate an interrupt every second.
The interrupt service routine is trivial, just printing a '.'
character, but this is just a demo program. The application can be
controlled by the following keys:

	? - print current values og the CPM Timer registers
	b - enable interrupts and start timer
	e - stop timer and disable interrupts
	q - quit application

	=> loads
	## Ready for S-Record download ...
	~>examples/timer.srec
	1 2 3 4 5 6 7 8 9 10 11 ...
	[file transfer complete]
	[connected]
	## Start Addr = 0x00040004

	=> go 40004
	## Starting application at 0x00040004 ...
	TIMERS=0xfff00980
	Using timer 1
	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0

Hit 'b':
	[q, b, e, ?] Set interval 1000000 us
	Enabling timer
Hit '?':
	[q, b, e, ?] ........
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
Hit '?':
	[q, b, e, ?] .
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
Hit '?':
	[q, b, e, ?] .
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
Hit '?':
	[q, b, e, ?] .
	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
Hit 'e':
	[q, b, e, ?] ...Stopping timer
Hit 'q':
	[q, b, e, ?] ## Application terminated, rc = 0x0


Minicom warning:
================

Over time, many people have reported problems when trying to use the
"minicom" terminal emulation program for serial download. I (wd)
consider minicom to be broken, and recommend not to use it. Under
Unix, I recommend to use C-Kermit for general purpose use (and
especially for kermit binary protocol download ("loadb" command), and
K
Karl O. Pinc 已提交
6017 6018 6019 6020
use "cu" for S-Record download ("loads" command).  See
http://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
for help with kermit.

W
wdenk 已提交
6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055

Nevertheless, if you absolutely want to use it try adding this
configuration to your "File transfer protocols" section:

	   Name	   Program			Name U/D FullScr IO-Red. Multi
	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N


NetBSD Notes:
=============

Starting at version 0.9.2, U-Boot supports NetBSD both as host
(build U-Boot) and target system (boots NetBSD/mpc8xx).

Building requires a cross environment; it is known to work on
NetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
need gmake since the Makefiles are not compatible with BSD make).
Note that the cross-powerpc package does not install include files;
attempting to build U-Boot will fail because <machine/ansi.h> is
missing.  This file has to be installed and patched manually:

	# cd /usr/pkg/cross/powerpc-netbsd/include
	# mkdir powerpc
	# ln -s powerpc machine
	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST

Native builds *don't* work due to incompatibilities between native
and U-Boot include files.

Booting assumes that (the first part of) the image booted is a
stage-2 loader which in turn loads and then invokes the kernel
proper. Loader sources will eventually appear in the NetBSD source
tree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
W
wdenk 已提交
6056
meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
W
wdenk 已提交
6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081


Implementation Internals:
=========================

The following is not intended to be a complete description of every
implementation detail. However, it should help to understand the
inner workings of U-Boot and make it easier to port it to custom
hardware.


Initial Stack, Global Data:
---------------------------

The implementation of U-Boot is complicated by the fact that U-Boot
starts running out of ROM (flash memory), usually without access to
system RAM (because the memory controller is not initialized yet).
This means that we don't have writable Data or BSS segments, and BSS
is not initialized as zero. To be able to get a C environment working
at all, we have to allocate at least a minimal stack. Implementation
options for this are defined and restricted by the CPU used: Some CPU
models provide on-chip memory (like the IMMR area on MPC8xx and
MPC826x processors), on others (parts of) the data cache can be
locked as (mis-) used as memory, etc.

6082
	Chris Hallinan posted a good summary of these issues to the
6083
	U-Boot mailing list:
W
wdenk 已提交
6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094

	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
	From: "Chris Hallinan" <clh@net1plus.com>
	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
	...

	Correct me if I'm wrong, folks, but the way I understand it
	is this: Using DCACHE as initial RAM for Stack, etc, does not
	require any physical RAM backing up the cache. The cleverness
	is that the cache is being used as a temporary supply of
	necessary storage before the SDRAM controller is setup. It's
M
Marcel Ziswiler 已提交
6095
	beyond the scope of this list to explain the details, but you
W
wdenk 已提交
6096 6097 6098 6099 6100
	can see how this works by studying the cache architecture and
	operation in the architecture and processor-specific manuals.

	OCM is On Chip Memory, which I believe the 405GP has 4K. It
	is another option for the system designer to use as an
M
Marcel Ziswiler 已提交
6101
	initial stack/RAM area prior to SDRAM being available. Either
W
wdenk 已提交
6102 6103 6104 6105 6106
	option should work for you. Using CS 4 should be fine if your
	board designers haven't used it for something that would
	cause you grief during the initial boot! It is frequently not
	used.

6107
	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
W
wdenk 已提交
6108 6109
	with your processor/board/system design. The default value
	you will find in any recent u-boot distribution in
6110
	walnut.h should work for you. I'd set it to a value larger
W
wdenk 已提交
6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125
	than your SDRAM module. If you have a 64MB SDRAM module, set
	it above 400_0000. Just make sure your board has no resources
	that are supposed to respond to that address! That code in
	start.S has been around a while and should work as is when
	you get the config right.

	-Chris Hallinan
	DS4.COM, Inc.

It is essential to remember this, since it has some impact on the C
code for the initialization procedures:

* Initialized global data (data segment) is read-only. Do not attempt
  to write it.

6126
* Do not use any uninitialized global data (or implicitly initialized
W
wdenk 已提交
6127 6128 6129 6130 6131 6132 6133
  as zero data - BSS segment) at all - this is undefined, initiali-
  zation is performed later (when relocating to RAM).

* Stack space is very limited. Avoid big data buffers or things like
  that.

Having only the stack as writable memory limits means we cannot use
6134
normal global data to share information between the code. But it
W
wdenk 已提交
6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148
turned out that the implementation of U-Boot can be greatly
simplified by making a global data structure (gd_t) available to all
functions. We could pass a pointer to this data as argument to _all_
functions, but this would bloat the code. Instead we use a feature of
the GCC compiler (Global Register Variables) to share the data: we
place a pointer (gd) to the global data into a register which we
reserve for this purpose.

When choosing a register for such a purpose we are restricted by the
relevant  (E)ABI  specifications for the current architecture, and by
GCC's implementation.

For PowerPC, the following registers have specific use:
	R1:	stack pointer
6149
	R2:	reserved for system use
W
wdenk 已提交
6150 6151 6152 6153 6154 6155
	R3-R4:	parameter passing and return values
	R5-R10: parameter passing
	R13:	small data area pointer
	R30:	GOT pointer
	R31:	frame pointer

6156 6157 6158
	(U-Boot also uses R12 as internal GOT pointer. r12
	is a volatile register so r12 needs to be reset when
	going back and forth between asm and C)
W
wdenk 已提交
6159

6160
    ==> U-Boot will use R2 to hold a pointer to the global data
W
wdenk 已提交
6161 6162 6163 6164 6165 6166 6167 6168

    Note: on PPC, we could use a static initializer (since the
    address of the global data structure is known at compile time),
    but it turned out that reserving a register results in somewhat
    smaller code - although the code savings are not that big (on
    average for all boards 752 bytes for the whole U-Boot image,
    624 text + 127 data).

6169
On Blackfin, the normal C ABI (except for P3) is followed as documented here:
M
Mike Frysinger 已提交
6170 6171
	http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface

6172
    ==> U-Boot will use P3 to hold a pointer to the global data
M
Mike Frysinger 已提交
6173

W
wdenk 已提交
6174 6175 6176 6177
On ARM, the following registers are used:

	R0:	function argument word/integer result
	R1-R3:	function argument word
6178 6179
	R9:	platform specific
	R10:	stack limit (used only if stack checking is enabled)
W
wdenk 已提交
6180 6181 6182 6183 6184 6185
	R11:	argument (frame) pointer
	R12:	temporary workspace
	R13:	stack pointer
	R14:	link register
	R15:	program counter

6186 6187 6188
    ==> U-Boot will use R9 to hold a pointer to the global data

    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
W
wdenk 已提交
6189

T
Thomas Chou 已提交
6190 6191 6192 6193 6194 6195 6196 6197
On Nios II, the ABI is documented here:
	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf

    ==> U-Boot will use gp to hold a pointer to the global data

    Note: on Nios II, we give "-G0" option to gcc and don't use gp
    to access small data sections, so gp is free.

6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211
On NDS32, the following registers are used:

	R0-R1:	argument/return
	R2-R5:	argument
	R15:	temporary register for assembler
	R16:	trampoline register
	R28:	frame pointer (FP)
	R29:	global pointer (GP)
	R30:	link register (LP)
	R31:	stack pointer (SP)
	PC:	program counter (PC)

    ==> U-Boot will use R10 to hold a pointer to the global data

6212 6213
NOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
or current versions of GCC may "optimize" the code too much.
W
wdenk 已提交
6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229

Memory Management:
------------------

U-Boot runs in system state and uses physical addresses, i.e. the
MMU is not used either for address mapping nor for memory protection.

The available memory is mapped to fixed addresses using the memory
controller. In this process, a contiguous block is formed for each
memory type (Flash, SDRAM, SRAM), even when it consists of several
physical memory banks.

U-Boot is installed in the first 128 kB of the first Flash bank (on
TQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
booting and sizing and initializing DRAM, the code relocates itself
to the upper end of DRAM. Immediately below the U-Boot code some
6230
memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
W
wdenk 已提交
6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261
configuration setting]. Below that, a structure with global Board
Info data is placed, followed by the stack (growing downward).

Additionally, some exception handler code is copied to the low 8 kB
of DRAM (0x00000000 ... 0x00001FFF).

So a typical memory configuration with 16 MB of DRAM could look like
this:

	0x0000 0000	Exception Vector code
	      :
	0x0000 1FFF
	0x0000 2000	Free for Application Use
	      :
	      :

	      :
	      :
	0x00FB FF20	Monitor Stack (Growing downward)
	0x00FB FFAC	Board Info Data and permanent copy of global data
	0x00FC 0000	Malloc Arena
	      :
	0x00FD FFFF
	0x00FE 0000	RAM Copy of Monitor Code
	...		eventually: LCD or video framebuffer
	...		eventually: pRAM (Protected RAM - unchanged by reset)
	0x00FF FFFF	[End of RAM]


System Initialization:
----------------------
W
wdenk 已提交
6262

W
wdenk 已提交
6263
In the reset configuration, U-Boot starts at the reset entry point
M
Marcel Ziswiler 已提交
6264
(on most PowerPC systems at address 0x00000100). Because of the reset
6265
configuration for CS0# this is a mirror of the on board Flash memory.
W
wdenk 已提交
6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299
To be able to re-map memory U-Boot then jumps to its link address.
To be able to implement the initialization code in C, a (small!)
initial stack is set up in the internal Dual Ported RAM (in case CPUs
which provide such a feature like MPC8xx or MPC8260), or in a locked
part of the data cache. After that, U-Boot initializes the CPU core,
the caches and the SIU.

Next, all (potentially) available memory banks are mapped using a
preliminary mapping. For example, we put them on 512 MB boundaries
(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
on 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
programmed for SDRAM access. Using the temporary configuration, a
simple memory test is run that determines the size of the SDRAM
banks.

When there is more than one SDRAM bank, and the banks are of
different size, the largest is mapped first. For equal size, the first
bank (CS2#) is mapped first. The first mapping is always for address
0x00000000, with any additional banks following immediately to create
contiguous memory starting from 0.

Then, the monitor installs itself at the upper end of the SDRAM area
and allocates memory for use by malloc() and for the global Board
Info data; also, the exception vector code is copied to the low RAM
pages, and the final stack is set up.

Only after this relocation will you have a "normal" C environment;
until that you are restricted in several ways, mostly because you are
running from ROM, and because the code will have to be relocated to a
new address in RAM.


U-Boot Porting Guide:
----------------------
W
wdenk 已提交
6300

W
wdenk 已提交
6301 6302
[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
list, October 2002]
W
wdenk 已提交
6303 6304


6305
int main(int argc, char *argv[])
W
wdenk 已提交
6306 6307
{
	sighandler_t no_more_time;
W
wdenk 已提交
6308

6309 6310
	signal(SIGALRM, no_more_time);
	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
W
wdenk 已提交
6311

W
wdenk 已提交
6312
	if (available_money > available_manpower) {
6313
		Pay consultant to port U-Boot;
W
wdenk 已提交
6314 6315 6316
		return 0;
	}

W
wdenk 已提交
6317 6318
	Download latest U-Boot source;

6319
	Subscribe to u-boot mailing list;
W
wdenk 已提交
6320

6321 6322
	if (clueless)
		email("Hi, I am new to U-Boot, how do I get started?");
W
wdenk 已提交
6323 6324 6325

	while (learning) {
		Read the README file in the top level directory;
6326 6327
		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
		Read applicable doc/*.README;
W
wdenk 已提交
6328
		Read the source, Luke;
6329
		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
W
wdenk 已提交
6330 6331
	}

6332 6333 6334
	if (available_money > toLocalCurrency ($2500))
		Buy a BDI3000;
	else
W
wdenk 已提交
6335 6336
		Add a lot of aggravation and time;

6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360
	if (a similar board exists) {	/* hopefully... */
		cp -a board/<similar> board/<myboard>
		cp include/configs/<similar>.h include/configs/<myboard>.h
	} else {
		Create your own board support subdirectory;
		Create your own board include/configs/<myboard>.h file;
	}
	Edit new board/<myboard> files
	Edit new include/configs/<myboard>.h

	while (!accepted) {
		while (!running) {
			do {
				Add / modify source code;
			} until (compiles);
			Debug;
			if (clueless)
				email("Hi, I am having problems...");
		}
		Send patch file to the U-Boot email list;
		if (reasonable critiques)
			Incorporate improvements from email list code review;
		else
			Defend code as written;
W
wdenk 已提交
6361 6362 6363 6364 6365 6366 6367 6368 6369 6370
	}

	return 0;
}

void no_more_time (int sig)
{
      hire_a_guru();
}

W
wdenk 已提交
6371

W
wdenk 已提交
6372 6373
Coding Standards:
-----------------
W
wdenk 已提交
6374

W
wdenk 已提交
6375
All contributions to U-Boot should conform to the Linux kernel
6376
coding style; see the file "Documentation/CodingStyle" and the script
6377
"scripts/Lindent" in your Linux kernel source directory.
6378 6379 6380

Source files originating from a different project (for example the
MTD subsystem) are generally exempt from these guidelines and are not
6381
reformatted to ease subsequent migration to newer versions of those
6382 6383 6384 6385 6386
sources.

Please note that U-Boot is implemented in C (and to some small parts in
Assembler); no C++ is used, so please do not use C++ style comments (//)
in your code.
W
wdenk 已提交
6387

W
wdenk 已提交
6388 6389
Please also stick to the following formatting rules:
- remove any trailing white space
6390
- use TAB characters for indentation and vertical alignment, not spaces
W
wdenk 已提交
6391
- make sure NOT to use DOS '\r\n' line feeds
6392
- do not add more than 2 consecutive empty lines to source files
W
wdenk 已提交
6393
- do not add trailing empty lines to source files
6394

W
wdenk 已提交
6395 6396
Submissions which do not conform to the standards may be returned
with a request to reformat the changes.
W
wdenk 已提交
6397 6398


W
wdenk 已提交
6399 6400
Submitting Patches:
-------------------
W
wdenk 已提交
6401

W
wdenk 已提交
6402 6403 6404
Since the number of patches for U-Boot is growing, we need to
establish some rules. Submissions which do not conform to these rules
may be rejected, even when they contain important and valuable stuff.
W
wdenk 已提交
6405

M
Magnus Lilja 已提交
6406
Please see http://www.denx.de/wiki/U-Boot/Patches for details.
6407

6408 6409 6410
Patches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
see http://lists.denx.de/mailman/listinfo/u-boot

W
wdenk 已提交
6411 6412
When you send a patch, please include the following information with
it:
W
wdenk 已提交
6413

W
wdenk 已提交
6414 6415 6416
* For bug fixes: a description of the bug and how your patch fixes
  this bug. Please try to include a way of demonstrating that the
  patch actually fixes something.
W
wdenk 已提交
6417

W
wdenk 已提交
6418 6419
* For new features: a description of the feature and your
  implementation.
W
wdenk 已提交
6420

W
wdenk 已提交
6421
* A CHANGELOG entry as plaintext (separate from the patch)
W
wdenk 已提交
6422

6423 6424
* For major contributions, add a MAINTAINERS file with your
  information and associated file and directory references.
W
wdenk 已提交
6425

6426 6427
* When you add support for a new board, don't forget to add a
  maintainer e-mail address to the boards.cfg file, too.
W
wdenk 已提交
6428

W
wdenk 已提交
6429 6430
* If your patch adds new configuration options, don't forget to
  document these in the README file.
W
wdenk 已提交
6431

6432 6433
* The patch itself. If you are using git (which is *strongly*
  recommended) you can easily generate the patch using the
6434
  "git format-patch". If you then use "git send-email" to send it to
6435 6436 6437 6438 6439 6440
  the U-Boot mailing list, you will avoid most of the common problems
  with some other mail clients.

  If you cannot use git, use "diff -purN OLD NEW". If your version of
  diff does not support these options, then get the latest version of
  GNU diff.
W
wdenk 已提交
6441

6442 6443 6444 6445
  The current directory when running this command shall be the parent
  directory of the U-Boot source tree (i. e. please make sure that
  your patch includes sufficient directory information for the
  affected files).
W
wdenk 已提交
6446

6447 6448
  We prefer patches as plain text. MIME attachments are discouraged,
  and compressed attachments must not be used.
W
wdenk 已提交
6449

W
wdenk 已提交
6450 6451
* If one logical set of modifications affects or creates several
  files, all these changes shall be submitted in a SINGLE patch file.
W
wdenk 已提交
6452

W
wdenk 已提交
6453 6454
* Changesets that contain different, unrelated modifications shall be
  submitted as SEPARATE patches, one patch per changeset.
W
wdenk 已提交
6455

W
wdenk 已提交
6456

W
wdenk 已提交
6457
Notes:
W
wdenk 已提交
6458

6459
* Before sending the patch, run the buildman script on your patched
W
wdenk 已提交
6460 6461
  source tree and make sure that no errors or warnings are reported
  for any of the boards.
W
wdenk 已提交
6462

W
wdenk 已提交
6463 6464 6465
* Keep your modifications to the necessary minimum: A patch
  containing several unrelated changes or arbitrary reformats will be
  returned with a request to re-formatting / split it.
W
wdenk 已提交
6466

W
wdenk 已提交
6467 6468 6469 6470 6471 6472
* If you modify existing code, make sure that your new code does not
  add to the memory footprint of the code ;-) Small is beautiful!
  When adding new features, these should compile conditionally only
  (using #ifdef), and the resulting code with the new feature
  disabled must not need more memory than the old code without your
  modification.
6473

6474 6475 6476 6477
* Remember that there is a size limit of 100 kB per message on the
  u-boot mailing list. Bigger patches will be moderated. If they are
  reasonable and not too big, they will be acknowledged. But patches
  bigger than the size limit should be avoided.