README 181.7 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
	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
130
	U-Boot v2010.09-rc1 - Release candidate 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
  /arm			Files generic to ARM architecture
  /m68k			Files generic to m68k architecture
  /microblaze		Files generic to microblaze architecture
  /mips			Files generic to MIPS architecture
142
  /nds32		Files generic to NDS32 architecture
143
  /nios2		Files generic to Altera NIOS2 architecture
144
  /openrisc		Files generic to OpenRISC architecture
S
Stefan Roese 已提交
145
  /powerpc		Files generic to PowerPC architecture
146
  /sandbox		Files generic to HW-independent "sandbox"
147
  /sh			Files generic to SH architecture
148
  /x86			Files generic to x86 architecture
149 150
/api			Machine/arch independent API for external apps
/board			Board dependent files
151
/cmd			U-Boot commands functions
152
/common			Misc architecture independent functions
153
/configs		Board default configuration files
154 155 156
/disk			Code for disk drive partition handling
/doc			Documentation (don't expect too much)
/drivers		Commonly used device drivers
157
/dts			Contains Makefile for building internal U-Boot fdt.
158 159 160
/examples		Example code for standalone applications, etc.
/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
/include		Header Files
161 162
/lib			Library routines generic to all architectures
/Licenses		Various license files
163 164
/net			Networking code
/post			Power On Self Test
165 166
/scripts		Various build scripts and Makefiles
/test			Various unit test files
167
/tools			Tools to build S-Record or U-Boot images, etc.
W
wdenk 已提交
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183

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

186 187 188 189 190
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 已提交
191 192 193 194 195 196


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

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

Example: For a TQM823L module type:

	cd u-boot
202
	make TQM823L_defconfig
W
wdenk 已提交
203

204 205 206
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 已提交
207

208 209 210 211 212 213 214 215
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.

216
See board/sandbox/README.sandbox for more details.
217 218


219 220 221 222
Board Initialisation Flow:
--------------------------

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

240 241
and so on. From there, three functions are called; the purpose and
limitations of each of these functions are described below.
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293

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
294
		done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
295 296 297 298 299
		spl_board_init() function containing this call
	- loads U-Boot or (in falcon mode) Linux



W
wdenk 已提交
300 301 302 303 304 305 306 307 308 309 310
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 已提交
311 312 313 314 315
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 已提交
316 317
The following options need to be configured:

318 319 320
- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.

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

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

327
- 85xx CPU Options:
328 329 330 331 332 333
		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.

334 335 336 337 338 339
		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.

340 341 342 343 344
		CONFIG_SYS_FSL_PCIE_COMPAT

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

345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
		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.

365 366
		CONFIG_A003399_NOR_WORKAROUND
		Enables a workaround for IFC erratum A003399. It is only
367
		required during NOR boot.
368

369 370
		CONFIG_A008044_WORKAROUND
		Enables a workaround for T1040/T1042 erratum A008044. It is only
371
		required during NAND boot and valid for Rev 1.0 SoC revision
372

373 374 375 376 377
		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

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

378 379 380 381
		CONFIG_SYS_FSL_DSP_DDR_ADDR
		This value denotes start offset of DDR memory which is
		connected exclusively to the DSP cores.

382 383 384 385
		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
		This value denotes start offset of M2 memory
		which is directly connected to the DSP core.

386 387 388 389
		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
		This value denotes start offset of M3 memory which is directly
		connected to the DSP core.

390 391 392
		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
		This value denotes start offset of DSP CCSR space.

393 394 395 396 397
		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.

398 399
		CONFIG_SYS_CPC_REINIT_F
		This CONFIG is defined when the CPC is configured as SRAM at the
B
Bin Meng 已提交
400
		time of U-Boot entry and is required to be re-initialized.
401

402
		CONFIG_DEEP_SLEEP
403
		Indicates this SoC supports deep sleep feature. If deep sleep is
404 405
		supported, core will start to execute uboot when wakes up.

406 407 408 409 410 411
- Generic CPU options:
		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN

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

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
		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.

433 434 435
		CONFIG_SYS_FSL_DDRC_GEN4
		Freescale DDR4 controller.

436 437 438
		CONFIG_SYS_FSL_DDRC_ARM_GEN3
		Freescale DDR3 controller for ARM-based SoCs.

439 440 441 442 443 444
		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
445
		Board config to use DDR2. It can be enabled for SoCs with
446 447 448 449 450
		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
451 452 453 454 455 456 457 458 459
		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.
460

461 462 463 464 465 466
		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

467 468 469
		CONFIG_SYS_FSL_IFC_CLK_DIV
		Defines divider of platform clock(clock input to IFC controller).

470 471 472
		CONFIG_SYS_FSL_LBC_CLK_DIV
		Defines divider of platform clock(clock input to eLBC controller).

473 474 475 476 477 478 479 480 481
		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

482 483 484 485
		CONFIG_SPL_FSL_PBL
		It adds a target to create boot binary having SPL binary in PBI format
		concatenated with u-boot binary.

486 487 488 489 490 491
		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

492 493 494 495 496
		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.

497 498 499 500 501
		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.

502 503 504 505 506 507
		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.

508 509 510
		CONFIG_SYS_FSL_HAS_DP_DDR
		Defines the SoC has DP-DDR used for DPAA.

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

517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
- 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.

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

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

563 564 565 566 567 568 569
- 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 已提交
570
- Linux Kernel Interface:
W
wdenk 已提交
571 572 573 574 575 576 577 578 579 580
		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
581
		"clocks_in_mhz=1" is automatically included in the
W
wdenk 已提交
582 583
		default environment.

W
wdenk 已提交
584 585
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

586
		When transferring memsize parameter to Linux, some versions
W
wdenk 已提交
587 588 589
		expect it to be in bytes, others in MB.
		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.

590
		CONFIG_OF_LIBFDT
591 592

		New kernel versions are expecting firmware settings to be
593 594 595 596 597 598
		passed using flattened device trees (based on open firmware
		concepts).

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

601
		OF_TBCLK - The timebase frequency.
K
Kumar Gala 已提交
602
		OF_STDOUT_PATH - The path to the console device
603

M
Marcel Ziswiler 已提交
604 605
		boards with QUICC Engines require OF_QE to set UCC MAC
		addresses
606

607 608 609 610
		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
611

612 613 614 615 616 617 618
		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.

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

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

638 639 640
- vxWorks boot parameters:

		bootvx constructs a valid bootline using the following
641 642
		environments variables: bootdev, bootfile, ipaddr, netmask,
		serverip, gatewayip, hostname, othbootargs.
643 644 645 646 647
		It loads the vxWorks image pointed bootfile.

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

648 649 650 651 652
- 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 已提交
653 654 655 656 657 658
- 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 已提交
659
- Serial Ports:
660
		CONFIG_PL010_SERIAL
W
wdenk 已提交
661 662 663

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

664
		CONFIG_PL011_SERIAL
W
wdenk 已提交
665 666 667 668 669 670 671 672 673 674 675 676 677 678

		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

679 680 681 682
		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 已提交
683

W
wdenk 已提交
684 685 686
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
687
		CONFIG_SYS_BAUDRATE_TABLE, see below.
W
wdenk 已提交
688 689 690 691 692 693 694 695 696

- 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_RAMBOOT and CONFIG_NFSBOOT
W
wdenk 已提交
697 698 699
		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 已提交
700
		RAM and NFS.
W
wdenk 已提交
701

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717
- 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 已提交
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
- 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.

743
- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
W
wdenk 已提交
744 745
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
746
		CONFIG_SYS_BAUDRATE_TABLE, see below.
W
wdenk 已提交
747

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

756 757
- Regular expression support:
		CONFIG_REGEX
758 759 760 761
		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".
762

763 764 765 766 767 768 769 770
- 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.

771
		U-Boot needs to get its device tree from somewhere. This can
772
		be done using one of the three options below:
773 774 775 776 777 778 779

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

781 782 783 784 785 786 787 788 789 790 791 792
		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.

793 794 795 796 797 798
		CONFIG_OF_BOARD
		If this variable is defined, U-Boot will use the device tree
		provided by the board at runtime instead of embedding one with
		the image. Only boards defining board_fdt_blob_setup() support
		this option (see include/fdtdec.h file).

W
wdenk 已提交
799 800 801
- Watchdog:
		CONFIG_WATCHDOG
		If this variable is defined, it enables watchdog
802
		support for the SoC. There must be support in the SoC
803 804 805 806 807
		specific code for a watchdog. For the 8xx
		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.
808 809 810 811 812

		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 已提交
813

814 815 816
		CONFIG_AT91_HW_WDT_TIMEOUT
		specify the timeout in seconds. default 2 seconds.

817 818 819 820 821
- 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.
822 823
		Any change to this variable will be reverted at the
		next reset.
824

W
wdenk 已提交
825 826
- Real-Time Clock:

827
		When CONFIG_CMD_DATE is selected, the type of the RTC
W
wdenk 已提交
828 829 830 831
		has to be selected, too. Define exactly one of the
		following options:

		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
832
		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
W
wdenk 已提交
833
		CONFIG_RTC_MC146818	- use MC146818 RTC
W
wdenk 已提交
834
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
W
wdenk 已提交
835
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
W
wdenk 已提交
836
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
837
		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
W
wdenk 已提交
838
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
T
Tor Krill 已提交
839
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
W
wdenk 已提交
840
		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
841
		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
842 843
		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
					  RV3029 RTC.
W
wdenk 已提交
844

W
wdenk 已提交
845 846 847
		Note that if the RTC uses I2C, then the I2C interface
		must also be configured. See I2C Support, below.

848 849 850
- GPIO Support:
		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO

C
Chris Packham 已提交
851 852 853 854
		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.

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

S
Simon Glass 已提交
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879
- 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 已提交
880 881
- Timestamp Support:

W
wdenk 已提交
882 883 884
		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
885
		automatically enabled when you select CONFIG_CMD_DATE .
W
wdenk 已提交
886

887 888 889 890 891 892 893 894
- Partition Labels (disklabels) Supported:
		Zero or more of the following:
		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
		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 已提交
895

S
Simon Glass 已提交
896
		If IDE or SCSI support is enabled (CONFIG_IDE or
897
		CONFIG_SCSI) you must configure support for at
898
		least one non-MTD partition type as well.
W
wdenk 已提交
899 900

- IDE Reset method:
W
wdenk 已提交
901 902
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
W
wdenk 已提交
903

W
wdenk 已提交
904 905 906 907
		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 已提交
908 909 910 911 912 913

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

W
wdenk 已提交
914 915 916 917
- LBA48 Support
		CONFIG_LBA48

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

922
		CONFIG_SYS_64BIT_LBA:
W
wdenk 已提交
923 924 925
			When enabled, makes the IDE subsystem use 64bit sector addresses.
			Default is 32bit.

W
wdenk 已提交
926
- SCSI Support:
927 928 929
		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 已提交
930 931 932
		maximum numbers of LUNs, SCSI ID's and target
		devices.

933 934
		The environment variable 'scsidevs' is set to the number of
		SCSI devices found during the last scan.
935

W
wdenk 已提交
936
- NETWORK Support (PCI):
937
		CONFIG_E1000
938 939 940 941 942 943 944 945 946 947 948
		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.

W
wdenk 已提交
949 950
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
M
Marcel Ziswiler 已提交
951
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
W
wdenk 已提交
952 953 954 955 956 957 958 959 960 961 962 963 964
		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 已提交
965 966
- NETWORK Support (other):

967 968 969 970 971 972 973 974 975 976
		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 已提交
977 978 979
		CONFIG_CALXEDA_XGMAC
		Support for the Calxeda XGMAC device

980
		CONFIG_LAN91C96
W
wdenk 已提交
981 982 983 984 985
		Support for SMSC's LAN91C96 chips.

			CONFIG_LAN91C96_USE_32_BIT
			Define this to enable 32 bit addressing

986
		CONFIG_SMC91111
W
wdenk 已提交
987 988 989 990 991 992 993 994 995 996 997 998 999
		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)

1000 1001 1002 1003 1004 1005
		CONFIG_DRIVER_TI_EMAC
		Support for davinci emac

			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
			Define this if you have more then 3 PHYs.

1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
		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.

1018
		CONFIG_SMC911X
J
Jens Gehrlein 已提交
1019 1020
		Support for SMSC's LAN911x and LAN921x chips

1021
			CONFIG_SMC911X_BASE
J
Jens Gehrlein 已提交
1022 1023 1024
			Define this to hold the physical address
			of the device (I/O space)

1025
			CONFIG_SMC911X_32_BIT
J
Jens Gehrlein 已提交
1026 1027
			Define this if data bus is 32 bits

1028
			CONFIG_SMC911X_16_BIT
J
Jens Gehrlein 已提交
1029 1030
			Define this if data bus is 16 bits. If your processor
			automatically converts one 32 bit word to two 16 bit
1031
			words you may also try CONFIG_SMC911X_32_BIT.
J
Jens Gehrlein 已提交
1032

1033 1034 1035 1036 1037 1038 1039 1040 1041
		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

1042 1043 1044
			CONFIG_SH_ETHER_CACHE_WRITEBACK
			If this option is set, the driver enables cache flush.

1045 1046
- PWM Support:
		CONFIG_PWM_IMX
1047
		Support for PWM module on the imx6.
1048

1049
- TPM Support:
1050 1051 1052
		CONFIG_TPM
		Support TPM devices.

1053 1054
		CONFIG_TPM_TIS_INFINEON
		Support for Infineon i2c bus TPM devices. Only one device
1055 1056 1057 1058 1059
		per system is supported at this time.

			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
			Define the burst count bytes upper limit

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

1067 1068 1069 1070
			CONFIG_TPM_ST33ZP24_SPI
			Support for STMicroelectronics ST33ZP24 SPI devices.
			Requires TPM_ST33ZP24 and SPI.

D
Dirk Eibach 已提交
1071 1072 1073
		CONFIG_TPM_ATMEL_TWI
		Support for Atmel TWI TPM device. Requires I2C support.

1074
		CONFIG_TPM_TIS_LPC
1075 1076 1077 1078 1079 1080 1081 1082
		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.

1083 1084 1085 1086 1087 1088 1089 1090 1091
		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 已提交
1092 1093
- USB Support:
		At the moment only the UHCI host controller is
1094
		supported (PIP405, MIP405); define
W
wdenk 已提交
1095 1096
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
W
wdenk 已提交
1097
		and define CONFIG_USB_STORAGE to enable the USB
W
wdenk 已提交
1098 1099 1100 1101
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
W
wdenk 已提交
1102

1103 1104 1105
		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
		txfilltuning field in the EHCI controller on reset.

1106 1107 1108
		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
		HW module registers.

W
Wolfgang Denk 已提交
1109 1110 1111 1112
- 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 已提交
1113
		attach your USB cable. The Unix command "dmesg" should print
W
Wolfgang Denk 已提交
1114 1115
		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 已提交
1116
		appear to a USB host as a Linux gserial device or a
W
Wolfgang Denk 已提交
1117 1118 1119 1120 1121 1122 1123
		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 已提交
1124

W
Wolfgang Denk 已提交
1125 1126 1127 1128 1129 1130
			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 已提交
1131

1132 1133 1134 1135 1136 1137 1138 1139
			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.

1140
			CONFIG_SYS_CONSOLE_IS_IN_ENV
W
Wolfgang Denk 已提交
1141 1142 1143
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

W
Wolfgang Denk 已提交
1144
		If you have a USB-IF assigned VendorID then you may wish to
W
Wolfgang Denk 已提交
1145
		define your own vendor specific values either in BoardName.h
W
Wolfgang Denk 已提交
1146
		or directly in usbd_vendor_info.h. If you don't define
W
Wolfgang Denk 已提交
1147 1148 1149 1150 1151 1152 1153
		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 已提交
1154

W
Wolfgang Denk 已提交
1155 1156 1157 1158 1159 1160 1161 1162 1163
			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 已提交
1164

W
Wolfgang Denk 已提交
1165 1166 1167 1168
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
W
wdenk 已提交
1169

1170 1171 1172 1173 1174 1175 1176 1177
- 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 已提交
1178 1179 1180
		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 已提交
1181

1182
- MMC Support:
W
wdenk 已提交
1183 1184 1185
		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
1186
		to physical memory similar to flash. Command line is
1187 1188
		enabled with CONFIG_CMD_MMC. The MMC driver also works with
		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1189

1190 1191 1192 1193 1194 1195 1196 1197 1198
		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

1199 1200 1201 1202 1203 1204 1205
		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.

1206
- USB Device Firmware Update (DFU) class support:
1207
		CONFIG_USB_FUNCTION_DFU
1208 1209 1210 1211 1212
		This enables the USB portion of the DFU USB class

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

1213 1214 1215
		CONFIG_DFU_NAND
		This enables support for exposing NAND devices via DFU.

A
Afzal Mohammed 已提交
1216 1217 1218 1219 1220 1221
		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.

1222 1223 1224 1225 1226 1227
		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.

1228 1229 1230 1231 1232 1233 1234
		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.

1235 1236 1237 1238 1239 1240 1241 1242 1243 1244
		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.

W
wdenk 已提交
1245
- Journaling Flash filesystem support:
S
Simon Glass 已提交
1246
		CONFIG_JFFS2_NAND
W
wdenk 已提交
1247 1248
		Define these for a default partition on a NAND device

1249 1250
		CONFIG_SYS_JFFS2_FIRST_SECTOR,
		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
W
wdenk 已提交
1251 1252
		Define these for a default partition on a NOR device

W
wdenk 已提交
1253
- Keyboard Support:
1254 1255 1256 1257 1258 1259 1260 1261 1262
		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 已提交
1263 1264

- Video support:
1265
		CONFIG_FSL_DIU_FB
W
Wolfgang Denk 已提交
1266
		Enable the Freescale DIU video driver.	Reference boards for
1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277
		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_CFB_CONSOLE
			CONFIG_VIDEO_SW_CURSOR
			CONFIG_VGA_AS_SINGLE_DEVICE
			CONFIG_VIDEO_LOGO
			CONFIG_VIDEO_BMP_LOGO

1278 1279
		The DIU driver will look for the 'video-mode' environment
		variable, and if defined, enable the DIU as a console during
1280
		boot.  See the documentation file doc/README.video for a
1281
		description of this variable.
1282

W
wdenk 已提交
1283 1284 1285 1286 1287 1288
- 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 已提交
1289 1290 1291 1292
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

W
wdenk 已提交
1293
		CONFIG_NEC_NL6448AC33:
W
wdenk 已提交
1294

W
wdenk 已提交
1295
			NEC NL6448AC33-18. Active, color, single scan.
W
wdenk 已提交
1296

W
wdenk 已提交
1297
		CONFIG_NEC_NL6448BC20
W
wdenk 已提交
1298

W
wdenk 已提交
1299 1300 1301 1302 1303 1304
			NEC NL6448BC20-08. 6.5", 640x480.
			Active, color, single scan.

		CONFIG_NEC_NL6448BC33_54

			NEC NL6448BC33-54. 10.4", 640x480.
W
wdenk 已提交
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
			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.

1332 1333
		CONFIG_LCD_ALIGNMENT

1334
		Normally the LCD is page-aligned (typically 4KB). If this is
1335 1336 1337 1338 1339 1340
		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.


1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
		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.

1361 1362 1363 1364
		CONFIG_LCD_BMP_RLE8

		Support drawing of RLE8-compressed bitmaps on the LCD.

1365 1366 1367 1368 1369
		CONFIG_I2C_EDID

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

W
wdenk 已提交
1370
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1371

W
wdenk 已提交
1372 1373 1374
		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
1375
		is suppressed and the BMP image at the address
W
wdenk 已提交
1376 1377 1378 1379
		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.
1380

1381 1382 1383 1384
		CONFIG_SPLASHIMAGE_GUARD

		If this option is set, then U-Boot will prevent the environment
		variable "splashimage" from being set to a problematic address
1385
		(see doc/README.displaying-bmps).
1386 1387 1388 1389 1390 1391
		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.

1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411
		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 已提交
1412 1413 1414 1415 1416 1417
- 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.

1418 1419 1420 1421 1422 1423
- 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.

W
wdenk 已提交
1424
- Compression support:
1425 1426 1427 1428
		CONFIG_GZIP

		Enabled by default to support gzip compressed images.

W
wdenk 已提交
1429 1430 1431 1432 1433 1434
		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 已提交
1435
		NOTE: the bzip2 algorithm requires a lot of RAM, so
1436
		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
W
wdenk 已提交
1437
		be at least 4MB.
1438

W
wdenk 已提交
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459
- 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_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 已提交
1460 1461 1462 1463
- IP address:
		CONFIG_IPADDR

		Define a default value for the IP address to use for
M
Marcel Ziswiler 已提交
1464
		the default Ethernet interface, in case this is not
W
wdenk 已提交
1465
		determined through e.g. bootp.
1466
		(Environment variable "ipaddr")
W
wdenk 已提交
1467 1468 1469 1470

- Server IP address:
		CONFIG_SERVERIP

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

1475 1476 1477 1478 1479
		CONFIG_KEEP_SERVERADDR

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

1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496
- 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 已提交
1497 1498 1499 1500 1501
- 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 已提交
1502
		tftp down the same boot image concurrently.  Note: the Ethernet
D
David Updegraff 已提交
1503 1504 1505
		driver in use must provide a function: mcast() to join/leave a
		multicast group.

W
wdenk 已提交
1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516
- 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
1517
		following delays are inserted then:
W
wdenk 已提交
1518 1519 1520 1521 1522 1523 1524

		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

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

1543
- DHCP Advanced Options:
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558
		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
1559
		CONFIG_BOOTP_MAY_FAIL
1560

W
Wilson Callan 已提交
1561 1562
		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
		environment variable, not the BOOTP server.
1563

1564 1565 1566 1567 1568 1569
		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.

1570 1571 1572 1573 1574 1575 1576
		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
1577
		is defined.
1578 1579 1580 1581

		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 已提交
1582
		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
1583 1584
		of the "hostname" environment variable is passed as
		option 12 to the DHCP server.
1585

1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599
		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.

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

1608
 - CDP Options:
W
wdenk 已提交
1609
		CONFIG_CDP_DEVICE_ID
1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621

		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 已提交
1622
		eth0 for the first Ethernet, eth1 for the second etc.
1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649

		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.

1650
- Status LED:	CONFIG_LED_STATUS
W
wdenk 已提交
1651 1652 1653 1654 1655 1656 1657

		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
1658
		kernel). Defining CONFIG_LED_STATUS enables this
W
wdenk 已提交
1659 1660
		feature in U-Boot.

1661 1662
		Additional options:

1663
		CONFIG_LED_STATUS_GPIO
1664 1665
		The status LED can be connected to a GPIO pin.
		In such cases, the gpio_led driver can be used as a
1666
		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
1667 1668
		to include the gpio_led driver in the U-Boot binary.

1669 1670 1671 1672 1673 1674 1675
		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.

1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
- 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:
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698
		- 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
1699

1700 1701 1702 1703 1704 1705
		- 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.
1706
		  - If your board supports a second fsl i2c bus, define
1707 1708 1709 1710 1711
		    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.

1712
		- drivers/i2c/tegra_i2c.c:
N
Nobuhiro Iwamatsu 已提交
1713 1714 1715
		  - 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!
1716

1717 1718 1719 1720 1721
		- 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 已提交
1722 1723
		- drivers/i2c/i2c_mxc.c
		  - activate this driver with CONFIG_SYS_I2C_MXC
1724 1725 1726 1727
		  - 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 已提交
1728 1729 1730 1731 1732 1733
		  - 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
1734 1735
		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1736
		If those defines are not set, default value is 100000
T
trem 已提交
1737 1738
		for speed, and 0 for slave.

1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752
		- 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

1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
		- 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
1767
		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
1768

1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781
		- 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

1782 1783 1784 1785 1786
		- 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

1787 1788 1789 1790 1791 1792
		- 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 已提交
1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806
		- 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 已提交
1807 1808 1809 1810 1811 1812 1813 1814 1815
		  - 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 已提交
1816

1817 1818 1819
		additional defines:

		CONFIG_SYS_NUM_I2C_BUSES
1820
		Hold the number of i2c buses you want to use.
1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832

		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
1833
		hold a list of buses you want to use, only used if
1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850
		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
1851 1852 1853 1854 1855
			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
1856
			bus 6 on adapter 1 without a mux
1857 1858
			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
1859 1860 1861

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

S
Simon Glass 已提交
1862
- Legacy I2C Support:
1863
		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
W
wdenk 已提交
1864 1865
		then the following macros need to be defined (examples are
		from include/configs/lwmon.h):
W
wdenk 已提交
1866 1867 1868

		I2C_INIT

W
wdenk 已提交
1869
		(Optional). Any commands necessary to enable the I2C
W
wdenk 已提交
1870
		controller or configure ports.
W
wdenk 已提交
1871

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

W
wdenk 已提交
1874 1875 1876 1877 1878 1879
		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 已提交
1880 1881
		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)

W
wdenk 已提交
1882 1883 1884 1885 1886 1887
		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 已提交
1888 1889
		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)

W
wdenk 已提交
1890 1891
		I2C_READ

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

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

W
wdenk 已提交
1897 1898
		I2C_SDA(bit)

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

W
wdenk 已提交
1902
		eg: #define I2C_SDA(bit) \
W
wdenk 已提交
1903
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
W
wdenk 已提交
1904
			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
W
wdenk 已提交
1905

W
wdenk 已提交
1906 1907
		I2C_SCL(bit)

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

W
wdenk 已提交
1911
		eg: #define I2C_SCL(bit) \
W
wdenk 已提交
1912
			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
W
wdenk 已提交
1913
			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
W
wdenk 已提交
1914

W
wdenk 已提交
1915 1916 1917 1918
		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 已提交
1919
		is 1 / (I2C_DELAY * 4). Often defined to be something
1920 1921
		like:

W
wdenk 已提交
1922
		#define I2C_DELAY  udelay(2)
W
wdenk 已提交
1923

1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
		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.

1934
		CONFIG_SYS_I2C_INIT_BOARD
1935

W
wdenk 已提交
1936 1937 1938 1939 1940 1941 1942 1943
		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.
1944

B
Ben Warren 已提交
1945 1946 1947
		CONFIG_I2C_MULTI_BUS

		This option allows the use of multiple I2C buses, each of which
W
Wolfgang Denk 已提交
1948 1949
		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 已提交
1950 1951
		Note that bus numbering is zero-based.

1952
		CONFIG_SYS_I2C_NOPROBES
B
Ben Warren 已提交
1953 1954

		This option specifies a list of I2C devices that will be skipped
W
Wolfgang Denk 已提交
1955
		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
1956 1957
		is set, specify a list of bus-device pairs.  Otherwise, specify
		a 1D array of device addresses
B
Ben Warren 已提交
1958 1959 1960

		e.g.
			#undef	CONFIG_I2C_MULTI_BUS
W
Wolfgang Denk 已提交
1961
			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
B
Ben Warren 已提交
1962 1963 1964

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

W
Wolfgang Denk 已提交
1965
			#define CONFIG_I2C_MULTI_BUS
1966
			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
B
Ben Warren 已提交
1967 1968 1969

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

1970
		CONFIG_SYS_SPD_BUS_NUM
T
Timur Tabi 已提交
1971 1972 1973 1974

		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.

1975
		CONFIG_SYS_RTC_BUS_NUM
1976 1977 1978 1979

		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.

1980 1981 1982 1983 1984 1985 1986 1987 1988
		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 已提交
1989

W
wdenk 已提交
1990 1991 1992 1993 1994 1995
- 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)

1996 1997 1998 1999 2000
		CONFIG_SH_SPI

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

W
wdenk 已提交
2001 2002
		CONFIG_SOFT_SPI

W
wdenk 已提交
2003 2004 2005 2006 2007 2008 2009
		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 已提交
2010

2011 2012 2013 2014 2015
		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 已提交
2016
		Currently supported on some MPC8xxx processors.	 For an
2017 2018
		example, see include/configs/mpc8349emds.h.

G
Guennadi Liakhovetski 已提交
2019 2020 2021
		CONFIG_MXC_SPI

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

2024 2025 2026 2027
		CONFIG_SYS_SPI_MXC_WAIT
		Timeout for waiting until spi transfer completed.
		default: (CONFIG_SYS_HZ/100)     /* 10 ms */

2028
- FPGA Support: CONFIG_FPGA
W
wdenk 已提交
2029

2030 2031 2032 2033 2034 2035
		Enables FPGA subsystem.

		CONFIG_FPGA_<vendor>

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

2037
		CONFIG_FPGA_<family>
W
wdenk 已提交
2038

2039 2040 2041 2042 2043 2044
		Enables support for FPGA family.
		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)

		CONFIG_FPGA_COUNT

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

2046
		CONFIG_SYS_FPGA_PROG_FEEDBACK
W
wdenk 已提交
2047

W
wdenk 已提交
2048
		Enable printing of hash marks during FPGA configuration.
W
wdenk 已提交
2049

2050
		CONFIG_SYS_FPGA_CHECK_BUSY
W
wdenk 已提交
2051

W
wdenk 已提交
2052 2053 2054 2055
		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 已提交
2056 2057 2058 2059 2060 2061

		CONFIG_FPGA_DELAY

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

2062
		CONFIG_SYS_FPGA_CHECK_CTRLC
W
wdenk 已提交
2063 2064
		Allow Control-C to interrupt FPGA configuration

2065
		CONFIG_SYS_FPGA_CHECK_ERROR
W
wdenk 已提交
2066

W
wdenk 已提交
2067 2068 2069 2070
		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 已提交
2071

2072
		CONFIG_SYS_FPGA_WAIT_INIT
W
wdenk 已提交
2073

2074 2075
		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 已提交
2076
		FPGA configuration sequence. The default time is 500
M
Marcel Ziswiler 已提交
2077
		ms.
W
wdenk 已提交
2078

2079
		CONFIG_SYS_FPGA_WAIT_BUSY
W
wdenk 已提交
2080

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

2084
		CONFIG_SYS_FPGA_WAIT_CONFIG
W
wdenk 已提交
2085

W
wdenk 已提交
2086
		Time to wait after FPGA configuration. The default is
M
Marcel Ziswiler 已提交
2087
		200 ms.
W
wdenk 已提交
2088 2089

- Configuration Management:
2090 2091 2092 2093 2094 2095
		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
2096
		make / buildman.
2097

W
wdenk 已提交
2098 2099
		CONFIG_IDENT_STRING

W
wdenk 已提交
2100 2101
		If defined, this string will be added to the U-Boot
		version information (U_BOOT_VERSION)
W
wdenk 已提交
2102 2103 2104

- Vendor Parameter Protection:

W
wdenk 已提交
2105 2106
		U-Boot considers the values of the environment
		variables "serial#" (Board Serial Number) and
W
wdenk 已提交
2107
		"ethaddr" (Ethernet Address) to be parameters that
W
wdenk 已提交
2108 2109 2110 2111
		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 已提交
2112
		change this behaviour:
W
wdenk 已提交
2113 2114 2115

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

2119 2120
		Alternatively, if you define _both_ an ethaddr in the
		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
M
Marcel Ziswiler 已提交
2121
		Ethernet address is installed in the environment,
W
wdenk 已提交
2122 2123 2124 2125
		which can be changed exactly ONCE by the user. [The
		serial# is unaffected by this, i. e. it remains
		read-only.]

2126 2127 2128 2129 2130
		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 已提交
2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146
- 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:

2147
			setenv bootargs ... mem=\${mem}
W
wdenk 已提交
2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
			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":

2160
			IVMS8, IVML24, SPD8xx,
2161
			HERMES, IP860, RPXlite, LWMON,
2162
			FLAGADM
W
wdenk 已提交
2163

2164 2165 2166 2167 2168 2169 2170 2171
- 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 已提交
2172 2173 2174 2175 2176 2177
- 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 已提交
2178
		system where you want the system to reboot
W
wdenk 已提交
2179 2180 2181 2182 2183 2184
		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 已提交
2185 2186 2187 2188
		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 已提交
2189

2190 2191 2192 2193
		CONFIG_ARP_TIMEOUT

		Timeout waiting for an ARP reply in milliseconds.

2194 2195 2196 2197 2198 2199 2200
		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 已提交
2201
- Command Interpreter:
2202
		CONFIG_AUTO_COMPLETE
2203 2204 2205

		Enable auto completion of commands using TAB.

2206
		CONFIG_SYS_PROMPT_HUSH_PS2
W
wdenk 已提交
2207 2208 2209 2210 2211 2212 2213

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

	Note:

W
wdenk 已提交
2214 2215 2216 2217 2218 2219 2220
		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 已提交
2221

W
wdenk 已提交
2222 2223 2224 2225
		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 已提交
2226 2227 2228 2229 2230 2231 2232

		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.

2233
- Command Line Editing and History:
2234 2235
		CONFIG_CMDLINE_EDITING

M
Marcel Ziswiler 已提交
2236
		Enable editing and History functions for interactive
2237
		command line input operations
2238

2239 2240 2241 2242 2243 2244 2245 2246
- 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 已提交
2247
- Default Environment:
W
wdenk 已提交
2248 2249
		CONFIG_EXTRA_ENV_SETTINGS

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

W
wdenk 已提交
2254 2255
		For example, place something like this in your
		board's config file:
W
wdenk 已提交
2256 2257 2258 2259 2260

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

W
wdenk 已提交
2261 2262 2263 2264
		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 已提交
2265
		will change soon, there is no guarantee either.
W
wdenk 已提交
2266 2267
		You better know what you are doing here.

W
wdenk 已提交
2268 2269
		Note: overly (ab)use of the default environment is
		discouraged. Make sure to check other ways to preset
2270
		the environment like the "source" command or the
W
wdenk 已提交
2271
		boot command first.
W
wdenk 已提交
2272

2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286
		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

2287 2288 2289 2290 2291 2292
		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.

2293 2294 2295
		CONFIG_DELAY_ENVIRONMENT

		Normally the environment is loaded when the board is
2296
		initialised so that it is available to U-Boot. This inhibits
2297 2298 2299 2300 2301
		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.

W
wdenk 已提交
2302
- DataFlash Support:
2303 2304
		CONFIG_HAS_DATAFLASH

W
wdenk 已提交
2305 2306 2307
		Defining this option enables DataFlash features and
		allows to read/write in Dataflash via the standard
		commands cp, md...
2308

2309
- Serial Flash support
2310
		Usage requires an initial 'sf probe' to define the serial
2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322
		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

W
wdenk 已提交
2323 2324 2325 2326
		CONFIG_SYSTEMACE

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

		#define CONFIG_SYSTEMACE
2331
		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
W
wdenk 已提交
2332 2333 2334 2335

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

2336 2337 2338
- TFTP Fixed UDP Port:
		CONFIG_TFTP_PORT

2339
		If this is defined, the environment variable tftpsrcp
2340
		is used to supply the TFTP UDP source port value.
2341
		If tftpsrcp isn't defined, the normal pseudo-random port
2342 2343
		number generator is used.

2344 2345 2346 2347 2348
		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
2349 2350 2351 2352 2353 2354 2355
		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.

2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373
- 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_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
2374

W
wdenk 已提交
2375
- Show boot progress:
W
wdenk 已提交
2376 2377
		CONFIG_SHOW_BOOT_PROGRESS

W
wdenk 已提交
2378 2379 2380 2381 2382 2383
		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 已提交
2384

2385

2386 2387
Legacy uImage format:

W
wdenk 已提交
2388 2389
  Arg	Where			When
    1	common/cmd_bootm.c	before attempting to boot an image
W
wdenk 已提交
2390
   -1	common/cmd_bootm.c	Image header has bad	 magic number
W
wdenk 已提交
2391
    2	common/cmd_bootm.c	Image header has correct magic number
W
wdenk 已提交
2392
   -2	common/cmd_bootm.c	Image header has bad	 checksum
W
wdenk 已提交
2393
    3	common/cmd_bootm.c	Image header has correct checksum
W
wdenk 已提交
2394
   -3	common/cmd_bootm.c	Image data   has bad	 checksum
W
wdenk 已提交
2395 2396 2397
    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
2398
   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
W
wdenk 已提交
2399 2400 2401 2402
    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
2403
    8	common/cmd_bootm.c	No uncompress/copy overwrite error
W
wdenk 已提交
2404
   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
2405 2406 2407 2408 2409 2410 2411 2412

    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 已提交
2413
  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
2414 2415 2416
   13	common/image.c		Start multifile image verification
   14	common/image.c		No initial ramdisk, no multifile, continue.

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

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

2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472
   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 已提交
2473
   64	net/eth.c		starting with Ethernet configuration.
2474 2475 2476 2477
  -64	net/eth.c		no Ethernet found.
   65	net/eth.c		Ethernet found.

  -80	common/cmd_net.c	usage wrong
2478 2479 2480
   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
2481 2482
  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
   82	common/cmd_net.c	trying automatic boot
2483 2484
   83	common/cmd_net.c	running "source" command
  -83	common/cmd_net.c	some error in automatic boot or "source" command
2485
   84	common/cmd_net.c	end without errors
W
wdenk 已提交
2486

2487 2488 2489 2490 2491 2492 2493 2494 2495
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
2496
  103	common/cmd_bootm.c	Found configuration node
2497 2498 2499 2500 2501
  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 已提交
2502 2503
 -106	common/cmd_bootm.c	Kernel subimage has wrong type
  107	common/cmd_bootm.c	Kernel subimage type OK
2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515
 -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 已提交
2516
  122	common/image.c		No ramdisk subimage unit name, using configuration
2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529
 -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 已提交
2530
 -130	common/cmd_doc.c	Incorrect FIT image format
2531 2532
  131	common/cmd_doc.c	FIT image format OK

M
Marcel Ziswiler 已提交
2533
 -140	common/cmd_ide.c	Incorrect FIT image format
2534 2535
  141	common/cmd_ide.c	FIT image format OK

M
Marcel Ziswiler 已提交
2536
 -150	common/cmd_nand.c	Incorrect FIT image format
2537 2538
  151	common/cmd_nand.c	FIT image format OK

2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551
- 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.

2552 2553 2554
- Standalone program support:
		CONFIG_STANDALONE_LOAD_ADDR

W
Wolfgang Denk 已提交
2555 2556 2557
		This option defines a board specific value for the
		address where standalone program gets loaded, thus
		overwriting the architecture dependent default
2558 2559 2560 2561 2562 2563
		settings.

- Frame Buffer Address:
		CONFIG_FB_ADDR

		Define CONFIG_FB_ADDR if you want to use specific
2564 2565 2566 2567 2568 2569 2570
		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.
2571 2572 2573

		Please see board_init_f function.

2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592
- 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.

2593
- UBI support
2594 2595 2596 2597 2598
		CONFIG_UBI_SILENCE_MSG

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

2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613

		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
2614

2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656
		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 已提交
2657 2658 2659 2660
		CONFIG_MTD_UBI_FM_DEBUG
		Enable UBI fastmap debug
		default: 0

2661
- UBIFS support
2662 2663 2664 2665 2666
		CONFIG_UBIFS_SILENCE_MSG

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

2667
- SPL framework
W
Wolfgang Denk 已提交
2668 2669
		CONFIG_SPL
		Enable building of SPL globally.
2670

2671 2672 2673
		CONFIG_SPL_LDSCRIPT
		LDSCRIPT for linking the SPL binary.

2674 2675 2676 2677
		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.
2678
		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2679 2680
		must not be both defined at the same time.

2681
		CONFIG_SPL_MAX_SIZE
2682 2683 2684 2685
		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.
2686

W
Wolfgang Denk 已提交
2687 2688
		CONFIG_SPL_TEXT_BASE
		TEXT_BASE for linking the SPL binary.
2689

2690 2691 2692 2693
		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).

2694 2695 2696 2697
		CONFIG_SPL_BSS_START_ADDR
		Link address for the BSS within the SPL binary.

		CONFIG_SPL_BSS_MAX_SIZE
2698 2699 2700
		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.
2701
		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
2702
		must not be both defined at the same time.
2703 2704 2705 2706

		CONFIG_SPL_STACK
		Adress of the start of the stack SPL will use

2707 2708 2709 2710 2711 2712 2713 2714 2715 2716
		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.

2717 2718 2719 2720 2721
		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.

2722 2723
		CONFIG_SYS_SPL_MALLOC_START
		Starting address of the malloc pool used in SPL.
2724 2725 2726
		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.
2727 2728 2729

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

2731 2732 2733 2734 2735
		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.

2736 2737 2738 2739
		CONFIG_SPL_OS_BOOT
		Enable booting directly to an OS from SPL.
		See also: doc/README.falcon

2740 2741 2742 2743
		CONFIG_SPL_DISPLAY_PRINT
		For ARM, enable an optional function to print more information
		about the running system.

2744 2745 2746
		CONFIG_SPL_INIT_MINIMAL
		Arch init code should be built for a very small image

2747 2748 2749 2750
		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

2751 2752 2753 2754 2755 2756 2757 2758 2759 2760
		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)

2761 2762 2763 2764
		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
		Partition on the MMC to load U-Boot from when the MMC is being
		used in fs mode

2765 2766 2767 2768
		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
		Filename to read to load U-Boot when reading from filesystem

		CONFIG_SPL_FS_LOAD_KERNEL_NAME
2769
		Filename to read to load kernel uImage when reading
2770
		from filesystem (for Falcon mode)
2771

2772
		CONFIG_SPL_FS_LOAD_ARGS_NAME
2773
		Filename to read to load kernel argument parameters
2774
		when reading from filesystem (for Falcon mode)
2775

2776 2777 2778 2779 2780 2781
		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).

2782 2783 2784
		CONFIG_SPL_SKIP_RELOCATE
		Avoid SPL relocation

2785 2786 2787 2788 2789 2790 2791 2792 2793 2794
		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

2795
		CONFIG_SPL_NAND_SIMPLE
S
Scott Wood 已提交
2796 2797
		Support for NAND boot using simple NAND drivers that
		expose the cmd_ctrl() interface.
2798

2799 2800 2801 2802
		CONFIG_SPL_UBI
		Support for a lightweight UBI (fastmap) scanner and
		loader

2803 2804 2805 2806
		CONFIG_SPL_NAND_RAW_ONLY
		Support to boot only raw u-boot.bin images. Use this only
		if you need to save space.

2807 2808 2809 2810
		CONFIG_SPL_COMMON_INIT_DDR
		Set for common ddr init with serial presence detect in
		SPL binary.

2811 2812 2813 2814 2815 2816
		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 已提交
2817
		to read U-Boot
2818

2819 2820 2821
		CONFIG_SPL_NAND_BOOT
		Add support NAND boot

2822
		CONFIG_SYS_NAND_U_BOOT_OFFS
S
Scott Wood 已提交
2823 2824 2825 2826 2827 2828 2829
		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
2830 2831

		CONFIG_SYS_NAND_U_BOOT_START
S
Scott Wood 已提交
2832
		Entry point in loaded image to jump to
2833 2834 2835

		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
		Define this if you need to first read the OOB and then the
2836
		data. This is used, for example, on davinci platforms.
2837

2838 2839
		CONFIG_SPL_RAM_DEVICE
		Support for running image already present in ram, in SPL binary
2840

2841
		CONFIG_SPL_PAD_TO
2842 2843 2844 2845 2846
		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.
2847

S
Scott Wood 已提交
2848 2849 2850 2851 2852
		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.

2853 2854 2855 2856 2857 2858
		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.

2859 2860 2861 2862 2863 2864 2865
- 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
2866 2867 2868
		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.
2869

W
wdenk 已提交
2870 2871
- Interrupt support (PPC):

W
wdenk 已提交
2872 2873
		There are common interrupt_init() and timer_interrupt()
		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
M
Marcel Ziswiler 已提交
2874
		for CPU specific initialization. interrupt_init_cpu()
W
wdenk 已提交
2875
		should set decrementer_count to appropriate value. If
M
Marcel Ziswiler 已提交
2876
		CPU resets decrementer automatically after interrupt
W
wdenk 已提交
2877
		(ppc4xx) it should set decrementer_count to zero.
M
Marcel Ziswiler 已提交
2878
		timer_interrupt() calls timer_interrupt_cpu() for CPU
W
wdenk 已提交
2879 2880 2881
		specific handling. If board has watchdog / status_led
		/ other_activity_monitor it works automatically from
		general timer_interrupt().
W
wdenk 已提交
2882

W
wdenk 已提交
2883

2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897
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 已提交
2898 2899 2900 2901

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

2902 2903 2904
- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
		Optionally it can be defined to support 64-bit memory commands.

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

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

2911
- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
W
wdenk 已提交
2912 2913
		prompt for user input.

2914
- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
W
wdenk 已提交
2915

2916
- CONFIG_SYS_PBSIZE:	Buffer size for Console output
W
wdenk 已提交
2917

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

2920
- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
W
wdenk 已提交
2921 2922 2923
		the application (usually a Linux kernel) when it is
		booted

2924
- CONFIG_SYS_BAUDRATE_TABLE:
W
wdenk 已提交
2925 2926
		List of legal baudrate settings for this board.

2927
- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
W
wdenk 已提交
2928 2929 2930
		Begin and End addresses of the area used by the
		simple memory test.

2931
- CONFIG_SYS_ALT_MEMTEST:
W
wdenk 已提交
2932
		Enable an alternate, more extensive memory test.
W
wdenk 已提交
2933

2934
- CONFIG_SYS_MEMTEST_SCRATCH:
W
wdenk 已提交
2935 2936 2937
		Scratch address used by the alternate memory test
		You only need to set this if address zero isn't writeable

Y
York Sun 已提交
2938
- CONFIG_SYS_MEM_RESERVE_SECURE
2939
		Only implemented for ARMv8 for now.
Y
York Sun 已提交
2940 2941 2942
		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
2943
		gd->arch.secure_ram is used to track the location. In systems
Y
York Sun 已提交
2944 2945 2946
		the RAM base is not zero, or RAM is divided into banks,
		this variable needs to be recalcuated to get the address.

2947
- CONFIG_SYS_MEM_TOP_HIDE:
2948
		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
2949
		this specified memory area will get subtracted from the top
M
Marcel Ziswiler 已提交
2950
		(end) of RAM and won't get "touched" at all by U-Boot. By
2951 2952 2953
		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
2954
		board ports in arch/powerpc with bootwrapper support that
2955
		recalculate the memory size from the SDRAM controller setup
2956
		will have to get fixed in Linux additionally.
2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967

		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.

2968
- CONFIG_SYS_LOADS_BAUD_CHANGE:
W
wdenk 已提交
2969 2970
		Enable temporary baudrate change while serial download

2971
- CONFIG_SYS_SDRAM_BASE:
W
wdenk 已提交
2972 2973
		Physical start address of SDRAM. _Must_ be 0 here.

2974
- CONFIG_SYS_FLASH_BASE:
W
wdenk 已提交
2975 2976
		Physical start address of Flash memory.

2977
- CONFIG_SYS_MONITOR_BASE:
W
wdenk 已提交
2978 2979
		Physical start address of boot monitor code (set by
		make config files to be same as the text base address
2980
		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
2981
		CONFIG_SYS_FLASH_BASE when booting from flash.
W
wdenk 已提交
2982

2983
- CONFIG_SYS_MONITOR_LEN:
W
wdenk 已提交
2984 2985 2986 2987
		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 已提交
2988

2989
- CONFIG_SYS_MALLOC_LEN:
W
wdenk 已提交
2990 2991
		Size of DRAM reserved for malloc() use.

2992 2993 2994 2995 2996 2997 2998 2999 3000 3001
- 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.
3002
		The memory will be freed (or in fact just forgotten) when
3003 3004
		U-Boot relocates itself.

3005 3006 3007 3008 3009
- 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).

3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028
- 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.

3029
- CONFIG_SYS_BOOTM_LEN:
3030 3031
		Normally compressed uImages are limited to an
		uncompressed size of 8 MBytes. If this is not enough,
3032
		you can define CONFIG_SYS_BOOTM_LEN in your board config file
3033 3034
		to adjust this setting to your needs.

3035
- CONFIG_SYS_BOOTMAPSZ:
W
wdenk 已提交
3036 3037
		Maximum size of memory mapped by the startup code of
		the Linux kernel; all data that must be processed by
3038 3039
		the Linux kernel (bd_info, boot arguments, FDT blob if
		used) must be put below this limit, unless "bootm_low"
3040
		environment variable is defined and non-zero. In such case
3041
		all data for the Linux kernel must be between "bootm_low"
W
Wolfgang Denk 已提交
3042
		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3043 3044 3045
		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 已提交
3046

3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059
- 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.

3060
- CONFIG_SYS_MAX_FLASH_BANKS:
W
wdenk 已提交
3061 3062
		Max number of Flash memory banks

3063
- CONFIG_SYS_MAX_FLASH_SECT:
W
wdenk 已提交
3064 3065
		Max number of sectors on a Flash chip

3066
- CONFIG_SYS_FLASH_ERASE_TOUT:
W
wdenk 已提交
3067 3068
		Timeout for Flash erase operations (in ms)

3069
- CONFIG_SYS_FLASH_WRITE_TOUT:
W
wdenk 已提交
3070 3071
		Timeout for Flash write operations (in ms)

3072
- CONFIG_SYS_FLASH_LOCK_TOUT
W
wdenk 已提交
3073 3074
		Timeout for Flash set sector lock bit operation (in ms)

3075
- CONFIG_SYS_FLASH_UNLOCK_TOUT
W
wdenk 已提交
3076 3077
		Timeout for Flash clear lock bits operation (in ms)

3078
- CONFIG_SYS_FLASH_PROTECTION
W
wdenk 已提交
3079 3080 3081
		If defined, hardware flash sectors protection is used
		instead of U-Boot software protection.

3082
- CONFIG_SYS_DIRECT_FLASH_TFTP:
W
wdenk 已提交
3083 3084 3085 3086 3087 3088 3089 3090

		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 已提交
3091 3092
		the flash, but in some situations (when system RAM is
		too limited to allow for a temporary copy of the
W
wdenk 已提交
3093 3094
		downloaded image) this option may be very useful.

3095
- CONFIG_SYS_FLASH_CFI:
W
wdenk 已提交
3096
		Define if the flash driver uses extra elements in the
W
wdenk 已提交
3097 3098
		common flash structure for storing flash geometry.

3099
- CONFIG_FLASH_CFI_DRIVER
W
wdenk 已提交
3100 3101
		This option also enables the building of the cfi_flash driver
		in the drivers directory
W
wdenk 已提交
3102

P
Piotr Ziecik 已提交
3103 3104 3105 3106 3107
- 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.

3108
- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
3109 3110 3111 3112 3113 3114
		Use buffered writes to flash.

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

3115
- CONFIG_SYS_FLASH_QUIET_TEST
3116 3117 3118 3119 3120
		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.

3121 3122 3123 3124 3125
- 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.

3126 3127 3128 3129 3130 3131 3132 3133 3134
- 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.

3135
- CONFIG_SYS_RX_ETH_BUFFER:
M
Marcel Ziswiler 已提交
3136 3137
		Defines the number of Ethernet receive buffers. On some
		Ethernet controllers it is recommended to set this value
S
stroese 已提交
3138 3139
		to 8 or even higher (EEPRO100 or 405 EMAC), since all
		buffers can be full shortly after enabling the interface
M
Marcel Ziswiler 已提交
3140
		on high Ethernet traffic.
S
stroese 已提交
3141 3142
		Defaults to 4 if not defined.

3143 3144
- CONFIG_ENV_MAX_ENTRIES

W
Wolfgang Denk 已提交
3145 3146 3147 3148 3149
	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.
3150

3151 3152
- CONFIG_ENV_FLAGS_LIST_DEFAULT
- CONFIG_ENV_FLAGS_LIST_STATIC
3153
	Enable validation of the values given to environment variables when
3154 3155 3156 3157 3158 3159
	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]
3160 3161
		access_attribute = [a|r|o|c]
		attributes = type_attribute[access_attribute]
3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172
		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

3173 3174 3175 3176 3177 3178
	The access attributes are:
		a - Any (default)
		r - Read-only
		o - Write-once
		c - Change-default

3179 3180
	- CONFIG_ENV_FLAGS_LIST_DEFAULT
		Define this to a list (string) to define the ".flags"
3181
		environment variable in the default or embedded environment.
3182 3183 3184 3185 3186 3187 3188 3189

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

3190 3191 3192 3193
	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.

3194 3195 3196 3197
- CONFIG_ENV_ACCESS_IGNORE_FORCE
	If defined, don't allow the -f switch to env set override variable
	access flags.

3198 3199 3200 3201 3202
- 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 已提交
3203 3204 3205 3206
The following definitions that deal with the placement and management
of environment data (variable area); in general, we support the
following configurations:

3207 3208 3209 3210 3211
- 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.

W
wdenk 已提交
3212
BE CAREFUL! The first access to the environment happens quite early
3213
in U-Boot initialization (when we try to get the setting of for the
M
Marcel Ziswiler 已提交
3214
console baudrate). You *MUST* have mapped your NVRAM area then, or
W
wdenk 已提交
3215 3216 3217 3218 3219 3220 3221
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.

3222 3223
BE CAREFUL! For some special cases, the local device can not use
"saveenv" command. For example, the local device will get the
3224 3225
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.
3226

3227 3228 3229 3230 3231 3232
- 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.

B
Bruce Adler 已提交
3233
Please note that the environment is read-only until the monitor
W
wdenk 已提交
3234
has been relocated to RAM and a RAM copy of the environment has been
3235
created; also, when using EEPROM you will have to use env_get_f()
W
wdenk 已提交
3236 3237
until then to read environment variables.

W
wdenk 已提交
3238 3239 3240 3241 3242 3243
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 已提交
3244 3245 3246

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 已提交
3247
use the "saveenv" command to store a valid environment.
W
wdenk 已提交
3248

3249
- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
W
wdenk 已提交
3250
		Echo the inverted Ethernet link state to the fault LED.
W
wdenk 已提交
3251

3252
		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
W
wdenk 已提交
3253 3254
		      also needs to be defined.

3255
- CONFIG_SYS_FAULT_MII_ADDR:
W
wdenk 已提交
3256
		MII address of the PHY to check for the Ethernet link state.
W
wdenk 已提交
3257

3258 3259 3260 3261 3262 3263 3264
- 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.

3265 3266 3267 3268 3269
- 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.

3270 3271 3272 3273 3274
- 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.

3275 3276 3277 3278 3279
- 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 已提交
3280
Low Level (hardware related) configuration options:
W
wdenk 已提交
3281
---------------------------------------------------
W
wdenk 已提交
3282

3283
- CONFIG_SYS_CACHELINE_SIZE:
W
wdenk 已提交
3284 3285
		Cache Line Size of the CPU.

3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296
- 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_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 已提交
3297
		be set to that address.	 Otherwise, it should be set to the
3298 3299 3300 3301 3302 3303 3304 3305
		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:
3306 3307
		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
3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319
		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 已提交
3320
- Floppy Disk Support:
3321
		CONFIG_SYS_FDC_DRIVE_NUMBER
W
wdenk 已提交
3322 3323 3324

		the default drive number (default value 0)

3325
		CONFIG_SYS_ISA_IO_STRIDE
W
wdenk 已提交
3326

M
Marcel Ziswiler 已提交
3327
		defines the spacing between FDC chipset registers
W
wdenk 已提交
3328 3329
		(default value 1)

3330
		CONFIG_SYS_ISA_IO_OFFSET
W
wdenk 已提交
3331

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

3336 3337
		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
W
wdenk 已提交
3338
		default value.
W
wdenk 已提交
3339

3340
		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
W
wdenk 已提交
3341 3342
		fdc_hw_init() is called at the beginning of the FDC
		setup. fdc_hw_init() must be provided by the board
3343
		source code. It is used to make hardware-dependent
W
wdenk 已提交
3344
		initializations.
W
wdenk 已提交
3345

3346 3347 3348 3349 3350 3351
- 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
3352
		is required.
3353

3354
- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
W
wdenk 已提交
3355
		DO NOT CHANGE unless you know exactly what you're
3356
		doing! (11-4) [MPC8xx systems only]
W
wdenk 已提交
3357

3358
- CONFIG_SYS_INIT_RAM_ADDR:
W
wdenk 已提交
3359

W
wdenk 已提交
3360
		Start address of memory area that can be used for
W
wdenk 已提交
3361 3362 3363 3364 3365 3366 3367 3368
		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:
3369
		- MPC8xx: IMMR (internal memory of the CPU)
W
wdenk 已提交
3370

3371
- CONFIG_SYS_GBL_DATA_OFFSET:
W
wdenk 已提交
3372 3373

		Offset of the initial data structure in the memory
3374 3375
		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
W
wdenk 已提交
3376
		data is located at the end of the available space
3377
		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
3378
		GENERATED_GBL_DATA_SIZE), and the initial stack is just
3379 3380
		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
		CONFIG_SYS_GBL_DATA_OFFSET) downward.
W
wdenk 已提交
3381 3382 3383 3384

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

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

3391
- CONFIG_SYS_OR_TIMING_SDRAM:
W
wdenk 已提交
3392 3393
		SDRAM timing

3394
- CONFIG_SYS_MAMR_PTA:
W
wdenk 已提交
3395 3396
		periodic timer for refresh

3397 3398 3399 3400
- 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 已提交
3401 3402 3403
		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)

- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
3404 3405
  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
W
wdenk 已提交
3406 3407
		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)

3408
- CONFIG_PCI_ENUM_ONLY
3409
		Only scan through and get the devices on the buses.
3410 3411 3412 3413 3414
		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.

3415 3416 3417
- CONFIG_PCI_INDIRECT_BRIDGE:
		Enable support for indirect PCI bridges.

3418 3419 3420 3421 3422 3423 3424 3425 3426
- CONFIG_SYS_SRIO:
		Chip has SRIO or not

- CONFIG_SRIO1:
		Board has SRIO 1 port available

- CONFIG_SRIO2:
		Board has SRIO 2 port available

3427 3428 3429
- CONFIG_SRIO_PCIE_BOOT_MASTER
		Board can support master function for Boot from SRIO and PCIE

3430 3431 3432 3433 3434 3435 3436 3437 3438
- 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

3439 3440 3441 3442
- 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.
3443
		Example of drivers that use it:
3444
		- drivers/mtd/nand/ndfc.c
3445
		- drivers/mtd/nand/mxc_nand.c
3446 3447 3448 3449 3450

- 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 已提交
3451
- CONFIG_SPD_EEPROM
3452 3453 3454
		Get DDR timing information from an I2C EEPROM. Common
		with pluggable memory modules such as SODIMMs

B
Ben Warren 已提交
3455 3456 3457
  SPD_EEPROM_ADDRESS
		I2C address of the SPD EEPROM

3458
- CONFIG_SYS_SPD_BUS_NUM
3459 3460 3461
		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 已提交
3462

3463 3464 3465 3466 3467 3468
- 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.

3469 3470 3471
- CONFIG_FSL_DDR_INTERACTIVE
		Enable interactive DDR debugging. See doc/README.fsl-ddr.

Y
York Sun 已提交
3472 3473 3474
- CONFIG_FSL_DDR_SYNC_REFRESH
		Enable sync of refresh for multiple controllers.

3475 3476 3477
- CONFIG_FSL_DDR_BIST
		Enable built-in memory test for Freescale DDR controllers.

3478
- CONFIG_SYS_83XX_DDR_USES_CS0
3479 3480
		Only for 83xx systems. If specified, then DDR should
		be configured using CS0 and CS1 instead of CS2 and CS3.
3481

3482 3483 3484 3485 3486
- 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.

3487 3488 3489 3490 3491 3492 3493 3494 3495 3496
- 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 已提交
3497 3498
- CONFIG_LOOPW
		Add the "loopw" memory command. This only takes effect if
S
Simon Glass 已提交
3499
		the memory commands are activated globally (CONFIG_CMD_MEMORY).
W
wdenk 已提交
3500

S
stroese 已提交
3501 3502 3503 3504 3505
- CONFIG_MX_CYCLIC
		Add the "mdc" and "mwc" memory commands. These are cyclic
		"md/mw" commands.
		Examples:

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

W
wdenk 已提交
3509
		=> mwc.l 100 12345678 10
S
stroese 已提交
3510 3511
		This command will write 12345678 to address 100 all 10 ms.

W
wdenk 已提交
3512
		This only takes effect if the memory commands are activated
S
Simon Glass 已提交
3513
		globally (CONFIG_CMD_MEMORY).
S
stroese 已提交
3514

W
wdenk 已提交
3515
- CONFIG_SKIP_LOWLEVEL_INIT
3516
		[ARM, NDS32, MIPS only] If this variable is defined, then certain
W
Wolfgang Denk 已提交
3517 3518 3519 3520 3521 3522 3523 3524
		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 已提交
3525

3526 3527
- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
		[ARM926EJ-S only] This allows just the call to lowlevel_init()
3528
		to be skipped. The normal CP15 init (such as enabling the
3529 3530
		instruction cache) is still performed.

3531
- CONFIG_SPL_BUILD
3532 3533 3534
		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 已提交
3535

3536 3537 3538 3539 3540
- 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.

3541 3542 3543 3544 3545
- 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.

3546 3547 3548 3549 3550 3551 3552 3553 3554
- 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().

3555 3556 3557
- CONFIG_X86_RESET_VECTOR
		If defined, the x86 reset vector code is included. This is not
		needed when U-Boot is running from Coreboot.
3558

3559 3560 3561
- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
		Enables the RTC32K OSC on AM33xx based plattforms

3562 3563 3564 3565 3566
- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
		Option to disable subpage write in NAND driver
		driver that uses this:
		drivers/mtd/nand/davinci_nand.c

3567 3568 3569 3570 3571 3572 3573 3574 3575
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.

3576 3577 3578 3579 3580 3581 3582
- 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
3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604
	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.

3605 3606 3607
- 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
3608 3609 3610
	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.
3611

3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622
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.

3623 3624 3625 3626 3627 3628
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.

3629 3630
- CONFIG_SYS_MC_RSV_MEM_ALIGN
	Define alignment of reserved memory MC requires
3631

3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643
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 已提交
3644 3645 3646
Building the Software:
======================

3647 3648 3649 3650 3651 3652
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 已提交
3653

3654 3655 3656 3657 3658
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 已提交
3659

3660 3661
	$ CROSS_COMPILE=ppc_4xx-
	$ export CROSS_COMPILE
W
wdenk 已提交
3662

3663 3664 3665 3666 3667 3668 3669 3670 3671 3672
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.

3673 3674
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 已提交
3675 3676
is done by typing:

3677
	make NAME_defconfig
W
wdenk 已提交
3678

3679
where "NAME_defconfig" is the name of one of the existing configu-
3680
rations; see boards.cfg for supported names.
3681

W
wdenk 已提交
3682 3683 3684 3685
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 已提交
3686
      when choosing the configuration, i. e.
W
wdenk 已提交
3687

3688
      make TQM823L_defconfig
W
wdenk 已提交
3689 3690
	- will configure for a plain TQM823L, i. e. no LCD support

3691
      make TQM823L_LCD_defconfig
W
wdenk 已提交
3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703
	- 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

3704 3705 3706 3707 3708 3709 3710
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
3711
	make O=/tmp/build NAME_defconfig
3712 3713
	make O=/tmp/build all

3714
2. Set environment variable KBUILD_OUTPUT to point to the desired location:
3715

3716
	export KBUILD_OUTPUT=/tmp/build
3717
	make distclean
3718
	make NAME_defconfig
3719 3720
	make all

3721
Note that the command line "O=" setting overrides the KBUILD_OUTPUT environment
3722 3723
variable.

W
wdenk 已提交
3724 3725 3726 3727 3728 3729 3730 3731 3732 3733

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:

3734
1.  Create a new directory to hold your board specific code. Add any
W
wdenk 已提交
3735
    files you need. In your board directory, you will need at least
3736 3737 3738
    the "Makefile" and a "<board>.c".
2.  Create a new configuration file "include/configs/<board>.h" for
    your board.
W
wdenk 已提交
3739 3740
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.
3741
4.  Run "make <board>_defconfig" with your new name.
W
wdenk 已提交
3742 3743 3744 3745 3746 3747 3748 3749 3750
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.:
==============================================================

3751 3752
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 已提交
3753 3754
provide feedback to the other developers. The feedback normally takes
the form of a "patch", i. e. a context diff against a certain (latest
3755
official or latest in the git repository) version of U-Boot sources.
W
wdenk 已提交
3756

3757 3758
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 已提交
3759
the supported boards compile WITHOUT ANY compiler warnings. To do so,
3760 3761 3762 3763
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.
3764 3765


W
wdenk 已提交
3766 3767 3768 3769 3770 3771 3772 3773 3774 3775
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
3776
bootz   - boot zImage from memory
W
wdenk 已提交
3777 3778 3779
tftpboot- boot image via network using TFTP protocol
	       and env variables "ipaddr" and "serverip"
	       (and eventually "gatewayip")
S
Simon Glass 已提交
3780
tftpput - upload a file via network using TFTP protocol
W
wdenk 已提交
3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
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
3792
i2c	- I2C sub-system
W
wdenk 已提交
3793 3794 3795 3796 3797 3798 3799 3800
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
3801
nand	- NAND memory operations (see doc/README.nand)
W
wdenk 已提交
3802 3803 3804 3805 3806
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 已提交
3807
loopw	- infinite write loop on address range
W
wdenk 已提交
3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830
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 已提交
3831

W
wdenk 已提交
3832 3833 3834 3835 3836 3837
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 已提交
3838

3839 3840 3841
Some configuration options can be set using Environment Variables.

List of environment variables (most likely not complete):
W
wdenk 已提交
3842

W
wdenk 已提交
3843
  baudrate	- see CONFIG_BAUDRATE
W
wdenk 已提交
3844

W
wdenk 已提交
3845
  bootdelay	- see CONFIG_BOOTDELAY
W
wdenk 已提交
3846

W
wdenk 已提交
3847
  bootcmd	- see CONFIG_BOOTCOMMAND
W
wdenk 已提交
3848

W
wdenk 已提交
3849
  bootargs	- Boot arguments when booting an RTOS image
W
wdenk 已提交
3850

W
wdenk 已提交
3851
  bootfile	- Name of the image to load with TFTP
W
wdenk 已提交
3852

3853 3854 3855 3856 3857 3858
  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
3859 3860 3861
		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
		  bootm_mapsize.

W
Wolfgang Denk 已提交
3862
  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
3863 3864 3865 3866 3867 3868
		  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.
3869 3870 3871 3872 3873 3874 3875

  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.

3876 3877 3878 3879
  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 已提交
3880 3881 3882 3883
  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 已提交
3884

W
wdenk 已提交
3885 3886 3887 3888
  autostart	- if set to "yes", an image loaded using the "bootp",
		  "rarpboot", "tftpboot" or "diskboot" commands will
		  be automatically started (by internally calling
		  "bootm")
3889

W
wdenk 已提交
3890 3891 3892 3893 3894
		  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 已提交
3895

3896 3897
  fdt_high	- if set this restricts the maximum address that the
		  flattened device tree will be copied into upon boot.
3898 3899 3900 3901 3902 3903 3904 3905
		  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.

3906 3907 3908 3909 3910 3911 3912
		  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.

3913 3914 3915 3916
  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 已提交
3917 3918 3919 3920 3921 3922
  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 已提交
3923 3924 3925 3926 3927 3928
  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
3929
		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
W
wdenk 已提交
3930 3931 3932 3933
		  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 已提交
3934

W
wdenk 已提交
3935 3936 3937 3938 3939 3940
		  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 已提交
3941

W
wdenk 已提交
3942
		  setenv initrd_high 00c00000
W
wdenk 已提交
3943

W
wdenk 已提交
3944 3945 3946 3947 3948 3949 3950
		  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 已提交
3951

W
wdenk 已提交
3952
  ipaddr	- IP address; needed for tftpboot command
W
wdenk 已提交
3953

W
wdenk 已提交
3954 3955
  loadaddr	- Default load address for commands like "bootp",
		  "rarpboot", "tftpboot", "loadb" or "diskboot"
W
wdenk 已提交
3956

W
wdenk 已提交
3957
  loads_echo	- see CONFIG_LOADS_ECHO
3958

W
wdenk 已提交
3959
  serverip	- TFTP server IP address; needed for tftpboot command
3960

W
wdenk 已提交
3961
  bootretry	- see CONFIG_BOOT_RETRY_TIME
3962

W
wdenk 已提交
3963
  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
3964

W
wdenk 已提交
3965
  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
W
wdenk 已提交
3966

M
Mike Frysinger 已提交
3967
  ethprime	- controls which interface is used first.
W
wdenk 已提交
3968

M
Mike Frysinger 已提交
3969 3970
  ethact	- controls which interface is currently active.
		  For example you can do the following
W
wdenk 已提交
3971

3972 3973 3974 3975
		  => 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 已提交
3976

3977 3978 3979 3980
  ethrotate	- When set to "no" U-Boot does not go through all
		  available network interfaces.
		  It just stays at the currently selected interface.

3981
  netretry	- When set to "no" each network operation will
W
wdenk 已提交
3982 3983 3984 3985 3986 3987
		  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 已提交
3988

3989
  npe_ucode	- set load address for the NPE microcode
3990

3991
  silent_linux  - If set then Linux will be told to boot silently, by
3992 3993 3994 3995 3996
		  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.

3997
  tftpsrcp	- If this is set, the value is used for TFTP's
3998 3999
		  UDP source port.

4000
  tftpdstp	- If this is set, the value is used for TFTP's UDP
4001 4002
		  destination port instead of the Well Know Port 69.

4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013
  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.

4014 4015 4016 4017 4018 4019 4020 4021
  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.

4022
  vlan		- When set to a value < 4095 the traffic over
M
Marcel Ziswiler 已提交
4023
		  Ethernet is encapsulated/received over 802.1q
W
wdenk 已提交
4024
		  VLAN tagged frames.
W
wdenk 已提交
4025

4026 4027 4028 4029 4030 4031
  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.

4032 4033 4034 4035 4036 4037 4038 4039 4040
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 已提交
4041
boards currently use other variables for these purposes, and some
4042 4043
boards use these variables for other purposes.

W
Wolfgang Denk 已提交
4044 4045 4046 4047 4048 4049
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
4050

W
wdenk 已提交
4051 4052 4053
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 已提交
4054

W
wdenk 已提交
4055 4056 4057 4058 4059 4060 4061 4062 4063
  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
4064 4065


W
wdenk 已提交
4066
There are two special Environment Variables:
4067

W
wdenk 已提交
4068 4069 4070
  serial#	- contains hardware identification information such
		  as type string and/or serial number
  ethaddr	- Ethernet address
W
wdenk 已提交
4071

W
wdenk 已提交
4072 4073 4074
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 已提交
4075

4076

W
wdenk 已提交
4077
Further special Environment Variables:
4078

W
wdenk 已提交
4079 4080 4081
  ver		- Contains the U-Boot version string as printed
		  with the "version" command. This variable is
		  readonly (see CONFIG_VERSION_VARIABLE).
4082 4083


W
wdenk 已提交
4084 4085
Please note that changes to some configuration parameters may take
only effect after the next boot (yes, that's just like Windoze :-).
4086 4087


4088 4089 4090 4091
Callback functions for environment variables:
---------------------------------------------

For some environment variables, the behavior of u-boot needs to change
4092
when their values are changed.  This functionality allows functions to
4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114
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
4115
".callbacks" environment variable in the default or embedded environment.
4116

4117 4118 4119 4120
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.

4121

W
wdenk 已提交
4122 4123
Command Line Parsing:
=====================
4124

W
wdenk 已提交
4125 4126
There are two different command line parsers available with U-Boot:
the old "simple" one, and the much more powerful "hush" shell:
W
wdenk 已提交
4127

W
wdenk 已提交
4128 4129
Old, simple command line parser:
--------------------------------
W
wdenk 已提交
4130

W
wdenk 已提交
4131 4132
- supports environment variables (through setenv / saveenv commands)
- several commands on one line, separated by ';'
4133
- variable substitution using "... ${name} ..." syntax
W
wdenk 已提交
4134 4135
- special characters ('$', ';') can be escaped by prefixing with '\',
  for example:
4136
	setenv bootcmd bootm \${address}
W
wdenk 已提交
4137 4138
- 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 已提交
4139

W
wdenk 已提交
4140 4141
Hush shell:
-----------
W
wdenk 已提交
4142

W
wdenk 已提交
4143 4144 4145 4146 4147 4148 4149 4150 4151 4152
- 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 已提交
4153

W
wdenk 已提交
4154 4155 4156 4157
(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 已提交
4158

W
wdenk 已提交
4159
(2) If you execute several variables with one call to run (i. e.
M
Marcel Ziswiler 已提交
4160
    calling run with a list of variables as arguments), any failing
W
wdenk 已提交
4161 4162
    command will cause "run" to terminate, i. e. the remaining
    variables are not executed.
W
wdenk 已提交
4163

W
wdenk 已提交
4164 4165
Note for Redundant Ethernet Interfaces:
=======================================
W
wdenk 已提交
4166

M
Marcel Ziswiler 已提交
4167
Some boards come with redundant Ethernet interfaces; U-Boot supports
W
wdenk 已提交
4168 4169
such configurations and is capable of automatic selection of a
"working" interface when needed. MAC assignment works as follows:
W
wdenk 已提交
4170

W
wdenk 已提交
4171 4172 4173
Network interfaces are numbered eth0, eth1, eth2, ... Corresponding
MAC addresses can be stored in the environment as "ethaddr" (=>eth0),
"eth1addr" (=>eth1), "eth2addr", ...
W
wdenk 已提交
4174

W
wdenk 已提交
4175 4176 4177 4178
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 已提交
4179

W
wdenk 已提交
4180 4181
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 已提交
4182

W
wdenk 已提交
4183 4184 4185
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 已提交
4186

W
wdenk 已提交
4187 4188
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 已提交
4189

W
wdenk 已提交
4190 4191 4192
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 已提交
4193

W
wdenk 已提交
4194
o If neither SROM nor the environment contain a MAC address, an error
4195 4196
  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
  a random, locally-assigned MAC is used.
W
wdenk 已提交
4197

4198
If Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
W
Wolfgang Denk 已提交
4199
will be programmed into hardware as part of the initialization process.	 This
4200 4201 4202
may be skipped by setting the appropriate 'ethmacskip' environment variable.
The naming convention is as follows:
"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
W
wdenk 已提交
4203

W
wdenk 已提交
4204 4205
Image Formats:
==============
W
wdenk 已提交
4206

4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224
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 已提交
4225

W
wdenk 已提交
4226 4227
* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4228 4229 4230
  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
  INTEGRITY).
A
Andy Shevchenko 已提交
4231
* Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
4232
  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
A
Andy Shevchenko 已提交
4233
  Currently supported: ARM, Intel x86, MIPS, NDS32, Nios II, PowerPC).
W
wdenk 已提交
4234 4235 4236 4237 4238
* Compression Type (uncompressed, gzip, bzip2)
* Load Address
* Entry Point
* Image Name
* Image Timestamp
W
wdenk 已提交
4239

W
wdenk 已提交
4240 4241 4242
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 已提交
4243 4244


W
wdenk 已提交
4245 4246
Linux Support:
==============
W
wdenk 已提交
4247

W
wdenk 已提交
4248 4249 4250
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 已提交
4251

W
wdenk 已提交
4252 4253 4254 4255 4256
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 已提交
4257

W
wdenk 已提交
4258 4259 4260
- 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 已提交
4261

W
wdenk 已提交
4262 4263
- 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 已提交
4264

W
wdenk 已提交
4265 4266 4267 4268 4269 4270
- 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 已提交
4271 4272


W
wdenk 已提交
4273 4274
Linux HOWTO:
============
W
wdenk 已提交
4275

W
wdenk 已提交
4276 4277
Porting Linux to U-Boot based systems:
---------------------------------------
W
wdenk 已提交
4278

W
wdenk 已提交
4279 4280 4281 4282
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 已提交
4283

S
Stefan Roese 已提交
4284
But now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4285

W
wdenk 已提交
4286 4287
Just make sure your machine specific header file (for instance
include/asm-ppc/tqm8xx.h) includes the same definition of the Board
4288 4289
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
4290
as your U-Boot configuration in CONFIG_SYS_IMMR.
4291

4292 4293 4294 4295 4296
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 已提交
4297

W
wdenk 已提交
4298 4299
Configuring the Linux kernel:
-----------------------------
W
wdenk 已提交
4300

W
wdenk 已提交
4301 4302 4303 4304 4305 4306
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 已提交
4307

W
wdenk 已提交
4308 4309 4310 4311 4312 4313 4314 4315 4316
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:

4317
	make TQM850L_defconfig
W
wdenk 已提交
4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342
	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 已提交
4343 4344


W
wdenk 已提交
4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357
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 已提交
4358

W
wdenk 已提交
4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375
	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 已提交
4376 4377 4378
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 已提交
4379 4380 4381 4382 4383 4384 4385 4386

- 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 已提交
4387
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
W
wdenk 已提交
4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410
	> 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 已提交
4411
	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
W
wdenk 已提交
4412 4413
	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
S
Stefan Roese 已提交
4414
	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
W
wdenk 已提交
4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436
	> 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

4437 4438 4439 4440 4441
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:

4442 4443 4444 4445
	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'
4446

W
wdenk 已提交
4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481

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;
4482
this includes a checksum verification so you can be sure no data
W
wdenk 已提交
4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529
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 已提交
4530
If you want to boot a Linux kernel with initial RAM disk, you pass
W
wdenk 已提交
4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578
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#

4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614
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 ...
4615 4616 4617
   Image Name:	 Linux-2.6.17-dirty
   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
   Data Size:	 1029343 Bytes = 1005.2 kB
4618
   Load Address: 00000000
4619
   Entry Point:	 00000000
4620 4621 4622 4623 4624 4625 4626 4627
   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 已提交
4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667
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.

4668 4669 4670 4671 4672 4673 4674
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.

4675
Note, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
4676 4677 4678 4679
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 已提交
4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776

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 已提交
4777 4778 4779 4780
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 已提交
4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815

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 已提交
4816
meantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
W
wdenk 已提交
4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841


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.

4842
	Chris Hallinan posted a good summary of these issues to the
4843
	U-Boot mailing list:
W
wdenk 已提交
4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854

	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 已提交
4855
	beyond the scope of this list to explain the details, but you
W
wdenk 已提交
4856 4857 4858 4859 4860
	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 已提交
4861
	initial stack/RAM area prior to SDRAM being available. Either
W
wdenk 已提交
4862 4863 4864 4865 4866
	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.

4867
	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
W
wdenk 已提交
4868 4869
	with your processor/board/system design. The default value
	you will find in any recent u-boot distribution in
4870
	walnut.h should work for you. I'd set it to a value larger
W
wdenk 已提交
4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885
	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.

4886
* Do not use any uninitialized global data (or implicitly initialized
W
wdenk 已提交
4887 4888 4889 4890 4891 4892 4893
  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
4894
normal global data to share information between the code. But it
W
wdenk 已提交
4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908
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
4909
	R2:	reserved for system use
W
wdenk 已提交
4910 4911 4912 4913 4914 4915
	R3-R4:	parameter passing and return values
	R5-R10: parameter passing
	R13:	small data area pointer
	R30:	GOT pointer
	R31:	frame pointer

4916 4917 4918
	(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 已提交
4919

4920
    ==> U-Boot will use R2 to hold a pointer to the global data
W
wdenk 已提交
4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932

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

On ARM, the following registers are used:

	R0:	function argument word/integer result
	R1-R3:	function argument word
4933 4934
	R9:	platform specific
	R10:	stack limit (used only if stack checking is enabled)
W
wdenk 已提交
4935 4936 4937 4938 4939 4940
	R11:	argument (frame) pointer
	R12:	temporary workspace
	R13:	stack pointer
	R14:	link register
	R15:	program counter

4941 4942 4943
    ==> 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 已提交
4944

T
Thomas Chou 已提交
4945 4946 4947 4948 4949 4950 4951 4952
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.

4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966
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

4967 4968
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 已提交
4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984

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
4985
memory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
W
wdenk 已提交
4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016
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 已提交
5017

W
wdenk 已提交
5018
In the reset configuration, U-Boot starts at the reset entry point
M
Marcel Ziswiler 已提交
5019
(on most PowerPC systems at address 0x00000100). Because of the reset
5020
configuration for CS0# this is a mirror of the on board Flash memory.
W
wdenk 已提交
5021 5022 5023
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
5024 5025 5026
which provide such a feature like), or in a locked part of the data
cache. After that, U-Boot initializes the CPU core, the caches and
the SIU.
W
wdenk 已提交
5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054

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 已提交
5055

W
wdenk 已提交
5056 5057
[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
list, October 2002]
W
wdenk 已提交
5058 5059


5060
int main(int argc, char *argv[])
W
wdenk 已提交
5061 5062
{
	sighandler_t no_more_time;
W
wdenk 已提交
5063

5064 5065
	signal(SIGALRM, no_more_time);
	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
W
wdenk 已提交
5066

W
wdenk 已提交
5067
	if (available_money > available_manpower) {
5068
		Pay consultant to port U-Boot;
W
wdenk 已提交
5069 5070 5071
		return 0;
	}

W
wdenk 已提交
5072 5073
	Download latest U-Boot source;

5074
	Subscribe to u-boot mailing list;
W
wdenk 已提交
5075

5076 5077
	if (clueless)
		email("Hi, I am new to U-Boot, how do I get started?");
W
wdenk 已提交
5078 5079 5080

	while (learning) {
		Read the README file in the top level directory;
5081 5082
		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
		Read applicable doc/*.README;
W
wdenk 已提交
5083
		Read the source, Luke;
5084
		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
W
wdenk 已提交
5085 5086
	}

5087 5088 5089
	if (available_money > toLocalCurrency ($2500))
		Buy a BDI3000;
	else
W
wdenk 已提交
5090 5091
		Add a lot of aggravation and time;

5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115
	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 已提交
5116 5117 5118 5119 5120 5121 5122 5123 5124 5125
	}

	return 0;
}

void no_more_time (int sig)
{
      hire_a_guru();
}

W
wdenk 已提交
5126

W
wdenk 已提交
5127 5128
Coding Standards:
-----------------
W
wdenk 已提交
5129

W
wdenk 已提交
5130
All contributions to U-Boot should conform to the Linux kernel
5131
coding style; see the file "Documentation/CodingStyle" and the script
5132
"scripts/Lindent" in your Linux kernel source directory.
5133 5134 5135

Source files originating from a different project (for example the
MTD subsystem) are generally exempt from these guidelines and are not
5136
reformatted to ease subsequent migration to newer versions of those
5137 5138 5139 5140 5141
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 已提交
5142

W
wdenk 已提交
5143 5144
Please also stick to the following formatting rules:
- remove any trailing white space
5145
- use TAB characters for indentation and vertical alignment, not spaces
W
wdenk 已提交
5146
- make sure NOT to use DOS '\r\n' line feeds
5147
- do not add more than 2 consecutive empty lines to source files
W
wdenk 已提交
5148
- do not add trailing empty lines to source files
5149

W
wdenk 已提交
5150 5151
Submissions which do not conform to the standards may be returned
with a request to reformat the changes.
W
wdenk 已提交
5152 5153


W
wdenk 已提交
5154 5155
Submitting Patches:
-------------------
W
wdenk 已提交
5156

W
wdenk 已提交
5157 5158 5159
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 已提交
5160

M
Magnus Lilja 已提交
5161
Please see http://www.denx.de/wiki/U-Boot/Patches for details.
5162

5163 5164 5165
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 已提交
5166 5167
When you send a patch, please include the following information with
it:
W
wdenk 已提交
5168

W
wdenk 已提交
5169 5170 5171
* 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 已提交
5172

W
wdenk 已提交
5173 5174
* For new features: a description of the feature and your
  implementation.
W
wdenk 已提交
5175

W
wdenk 已提交
5176
* A CHANGELOG entry as plaintext (separate from the patch)
W
wdenk 已提交
5177

5178 5179
* For major contributions, add a MAINTAINERS file with your
  information and associated file and directory references.
W
wdenk 已提交
5180

5181 5182
* 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 已提交
5183

W
wdenk 已提交
5184 5185
* If your patch adds new configuration options, don't forget to
  document these in the README file.
W
wdenk 已提交
5186

5187 5188
* The patch itself. If you are using git (which is *strongly*
  recommended) you can easily generate the patch using the
5189
  "git format-patch". If you then use "git send-email" to send it to
5190 5191 5192 5193 5194 5195
  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 已提交
5196

5197 5198 5199 5200
  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 已提交
5201

5202 5203
  We prefer patches as plain text. MIME attachments are discouraged,
  and compressed attachments must not be used.
W
wdenk 已提交
5204

W
wdenk 已提交
5205 5206
* If one logical set of modifications affects or creates several
  files, all these changes shall be submitted in a SINGLE patch file.
W
wdenk 已提交
5207

W
wdenk 已提交
5208 5209
* Changesets that contain different, unrelated modifications shall be
  submitted as SEPARATE patches, one patch per changeset.
W
wdenk 已提交
5210

W
wdenk 已提交
5211

W
wdenk 已提交
5212
Notes:
W
wdenk 已提交
5213

5214
* Before sending the patch, run the buildman script on your patched
W
wdenk 已提交
5215 5216
  source tree and make sure that no errors or warnings are reported
  for any of the boards.
W
wdenk 已提交
5217

W
wdenk 已提交
5218 5219 5220
* 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 已提交
5221

W
wdenk 已提交
5222 5223 5224 5225 5226 5227
* 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.
5228

5229 5230 5231 5232
* 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.