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

Summary:
========

11
This directory contains the source code for U-Boot, a boot loader for
wdenk's avatar
wdenk committed
12 13 14 15
Embedded boards based on PowerPC, ARM, MIPS and several other
processors, which can be installed in a boot ROM and used to
initialize and test the hardware or to download and run application
code.
wdenk's avatar
wdenk committed
16 17

The development of U-Boot is closely related to Linux: some parts of
18 19
the source code originate in the Linux source tree, we have some
header files in common, and special provision has been made to
wdenk's avatar
wdenk committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33
support booting of Linux images.

Some attention has been paid to make this software easily
configurable and extendable. For instance, all monitor commands are
implemented with the same call interface, so that it's very easy to
add new commands. Also, instead of permanently adding rarely used
code (for instance hardware test utilities) to the monitor, you can
load and run it dynamically.


Status:
=======

In general, all boards for which a configuration option exists in the
34
Makefile have been tested to some extent and can be considered
wdenk's avatar
wdenk committed
35 36
"working". In fact, many of them are used in production systems.

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

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

	make CHANGELOG

wdenk's avatar
wdenk committed
48 49 50 51

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

52
In case you have questions about, problems with or contributions for
53
U-Boot, you should send a message to the U-Boot mailing list at
54 55 56 57
<u-boot@lists.denx.de>. There is also an archive of previous traffic
on the mailing list - please search the archive before asking FAQ's.
Please see http://lists.denx.de/pipermail/u-boot and
http://dir.gmane.org/gmane.comp.boot-loaders.u-boot
wdenk's avatar
wdenk committed
58 59


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

63
The U-Boot source code is maintained in the Git repository at
64 65 66 67
git://www.denx.de/git/u-boot.git ; you can browse it online at
http://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary

The "snapshot" links on this page allow you to download tarballs of
68
any version you might be interested in. Official releases are also
69 70 71
available for FTP download from the ftp://ftp.denx.de/pub/u-boot/
directory.

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


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

- start from 8xxrom sources
80
- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
wdenk's avatar
wdenk committed
81 82 83 84 85 86 87
- clean up code
- make it easier to add custom boards
- make it possible to add other [PowerPC] CPUs
- extend functions, especially:
  * Provide extended interface to Linux boot loader
  * S-Record download
  * network boot
88
  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
89
- create ARMBoot project (http://sourceforge.net/projects/armboot)
wdenk's avatar
wdenk committed
90
- add other CPU families (starting with ARM)
91
- create U-Boot project (http://sourceforge.net/projects/u-boot)
Magnus Lilja's avatar
Magnus Lilja committed
92
- current project page: see http://www.denx.de/wiki/U-Boot
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114


Names and Spelling:
===================

The "official" name of this project is "Das U-Boot". The spelling
"U-Boot" shall be used in all written text (documentation, comments
in source files etc.). Example:

	This is the README file for the U-Boot project.

File names etc. shall be based on the string "u-boot". Examples:

	include/asm-ppc/u-boot.h

	#include <asm/u-boot.h>

Variable names, preprocessor constants etc. shall be either based on
the string "u_boot" or on "U_BOOT". Example:

	U_BOOT_VERSION		u_boot_logo
	IH_OS_U_BOOT		u_boot_hush_start
wdenk's avatar
wdenk committed
115 116


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

120 121 122 123 124 125 126 127
Starting with the release in October 2008, the names of the releases
were changed from numerical release numbers without deeper meaning
into a time stamp based numbering. Regular releases are identified by
names consisting of the calendar year and month of the release date.
Additional fields (if present) indicate release candidates or bug fix
releases in "stable" maintenance trees.

Examples:
Wolfgang Denk's avatar
Wolfgang Denk committed
128
	U-Boot v2009.11	    - Release November 2009
129
	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
wdenk's avatar
wdenk committed
131 132


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

136
/arch			Architecture specific files
137
  /arc			Files generic to ARC architecture
138 139 140 141
  /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
Stefan Roese's avatar
Stefan Roese committed
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.
wdenk's avatar
wdenk committed
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_".
wdenk's avatar
wdenk committed
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.
wdenk's avatar
wdenk committed
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".
wdenk's avatar
wdenk committed
198 199 200 201

Example: For a TQM823L module type:

	cd u-boot
202
	make TQM823L_defconfig
wdenk's avatar
wdenk committed
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.
wdenk's avatar
wdenk committed
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



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


wdenk's avatar
wdenk committed
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.


wdenk's avatar
wdenk committed
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
Bin Meng's avatar
Bin Meng committed
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.

wdenk's avatar
wdenk committed
570
- Linux Kernel Interface:
wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
582 583
		default environment.

wdenk's avatar
wdenk committed
584 585
		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]

586
		When transferring memsize parameter to Linux, some versions
wdenk's avatar
wdenk committed
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.
Kumar Gala's avatar
Kumar Gala committed
602
		OF_STDOUT_PATH - The path to the console device
603

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

Aneesh V's avatar
Aneesh V committed
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

wdenk's avatar
wdenk committed
659
- Serial Ports:
660
		CONFIG_PL010_SERIAL
wdenk's avatar
wdenk committed
661 662 663

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

664
		CONFIG_PL011_SERIAL
wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
683

wdenk's avatar
wdenk committed
684 685 686
- Console Baudrate:
		CONFIG_BAUDRATE - in bps
		Select one of the baudrates listed in
687
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
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
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
700
		RAM and NFS.
wdenk's avatar
wdenk committed
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.

wdenk's avatar
wdenk committed
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)
wdenk's avatar
wdenk committed
744 745
		CONFIG_KGDB_BAUDRATE
		Select one of the baudrates listed in
746
		CONFIG_SYS_BAUDRATE_TABLE, see below.
wdenk's avatar
wdenk committed
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).

wdenk's avatar
wdenk committed
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.
wdenk's avatar
wdenk committed
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

wdenk's avatar
wdenk committed
825 826
- Real-Time Clock:

827
		When CONFIG_CMD_DATE is selected, the type of the RTC
wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
833
		CONFIG_RTC_MC146818	- use MC146818 RTC
wdenk's avatar
wdenk committed
834
		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
wdenk's avatar
wdenk committed
835
		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
836
		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
837
		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
wdenk's avatar
wdenk committed
838
		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
839
		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
wdenk's avatar
wdenk committed
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.
wdenk's avatar
wdenk committed
844

wdenk's avatar
wdenk committed
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

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.

Simon Glass's avatar
Simon Glass committed
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)

wdenk's avatar
wdenk committed
880 881
- Timestamp Support:

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 .
wdenk's avatar
wdenk committed
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.
wdenk's avatar
wdenk committed
895

Simon Glass's avatar
Simon Glass committed
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.
wdenk's avatar
wdenk committed
899 900

- IDE Reset method:
wdenk's avatar
wdenk committed
901 902
		CONFIG_IDE_RESET_ROUTINE - this is defined in several
		board configurations files but used nowhere!
wdenk's avatar
wdenk committed
903

wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
908 909 910 911 912 913

- ATAPI Support:
		CONFIG_ATAPI

		Set this to enable ATAPI support.

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.
919 920 921
		Whithout these , LBA48 support uses 32bit variables and will 'only'
		support disks up to 2.1TB.

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

wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
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

wdenk's avatar
wdenk committed
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.

wdenk's avatar
wdenk committed
949 950
		CONFIG_EEPRO100
		Support for Intel 82557/82559/82559ER chips.
951
		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
wdenk's avatar
wdenk committed
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.

wdenk's avatar
wdenk committed
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.

Rob Herring's avatar
Rob Herring committed
977 978 979
		CONFIG_CALXEDA_XGMAC
		Support for the Calxeda XGMAC device

980
		CONFIG_LAN91C96
wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
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
Jens Gehrlein's avatar
Jens Gehrlein committed
1019 1020
		Support for SMSC's LAN911x and LAN921x chips

1021
			CONFIG_SMC911X_BASE
Jens Gehrlein's avatar
Jens Gehrlein committed
1022 1023 1024
			Define this to hold the physical address
			of the device (I/O space)

1025
			CONFIG_SMC911X_32_BIT
Jens Gehrlein's avatar
Jens Gehrlein committed
1026 1027
			Define this if data bus is 32 bits

1028
			CONFIG_SMC911X_16_BIT
Jens Gehrlein's avatar
Jens Gehrlein committed
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.
Jens Gehrlein's avatar
Jens Gehrlein committed
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.

Dirk Eibach's avatar
Dirk Eibach committed
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.

wdenk's avatar
wdenk committed
1092 1093
- USB Support:
		At the moment only the UHCI host controller is
1094
		supported (PIP405, MIP405); define
wdenk's avatar
wdenk committed
1095 1096
		CONFIG_USB_UHCI to enable it.
		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
wdenk's avatar
wdenk committed
1097
		and define CONFIG_USB_STORAGE to enable the USB
wdenk's avatar
wdenk committed
1098 1099 1100 1101
		storage devices.
		Note:
		Supported are USB Keyboards and USB Floppy drives
		(TEAC FD-05PUB).
wdenk's avatar
wdenk committed
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.

Wolfgang Denk's avatar
Wolfgang Denk committed
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
1113
		attach your USB cable. The Unix command "dmesg" should print
Wolfgang Denk's avatar
Wolfgang Denk committed
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
Wolfgang Denk's avatar
Wolfgang Denk committed
1116
		appear to a USB host as a Linux gserial device or a
Wolfgang Denk's avatar
Wolfgang Denk committed
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
Wolfgang Denk's avatar
Wolfgang Denk committed
1124

Wolfgang Denk's avatar
Wolfgang Denk committed
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
Wolfgang Denk's avatar
Wolfgang Denk committed
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
Wolfgang Denk's avatar
Wolfgang Denk committed
1141 1142 1143
			Define this if you want stdin, stdout &/or stderr to
			be set to usbtty.

Wolfgang Denk's avatar
Wolfgang Denk committed
1144
		If you have a USB-IF assigned VendorID then you may wish to
Wolfgang Denk's avatar
Wolfgang Denk committed
1145
		define your own vendor specific values either in BoardName.h
Wolfgang Denk's avatar
Wolfgang Denk committed
1146
		or directly in usbd_vendor_info.h. If you don't define
Wolfgang Denk's avatar
Wolfgang Denk committed
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"
Wolfgang Denk's avatar
Wolfgang Denk committed
1154

Wolfgang Denk's avatar
Wolfgang Denk committed
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
Wolfgang Denk's avatar
Wolfgang Denk committed
1164

Wolfgang Denk's avatar
Wolfgang Denk committed
1165 1166 1167 1168
			CONFIG_USBD_PRODUCTID
			Define this as the unique Product ID
			for your device
			- CONFIG_USBD_PRODUCTID 0xFFFF
wdenk's avatar
wdenk committed
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.
Lucas Stach's avatar
Lucas Stach committed
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.
wdenk's avatar
wdenk committed
1181

1182
- MMC Support:
wdenk's avatar
wdenk committed
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.

Afzal Mohammed's avatar
Afzal Mohammed committed
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.

wdenk's avatar
wdenk committed
1245
- Journaling Flash filesystem support:
1246
		CONFIG_JFFS2_NAND
wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
1251 1252
		Define these for a default partition on a NOR device

wdenk's avatar
wdenk committed
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.
wdenk's avatar
wdenk committed
1263 1264

- Video support:
1265
		CONFIG_FSL_DIU_FB
Wolfgang Denk's avatar
Wolfgang Denk committed
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

wdenk's avatar
wdenk committed
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:

Stelian Pop's avatar
Stelian Pop committed
1289 1290 1291 1292
		CONFIG_ATMEL_LCD:

			HITACHI TX09D70VM1CCA, 3.5", 240x320.

wdenk's avatar
wdenk committed
1293
		CONFIG_NEC_NL6448AC33:
wdenk's avatar
wdenk committed
1294

wdenk's avatar
wdenk committed
1295
			NEC NL6448AC33-18. Active, color, single scan.
wdenk's avatar
wdenk committed
1296

wdenk's avatar
wdenk committed
1297
		CONFIG_NEC_NL6448BC20
wdenk's avatar
wdenk committed
1298

wdenk's avatar
wdenk committed
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.
wdenk's avatar
wdenk committed
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.

wdenk's avatar
wdenk committed
1370
- Splash Screen Support: CONFIG_SPLASH_SCREEN
1371

wdenk's avatar
wdenk committed
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
wdenk's avatar
wdenk committed
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.