xref: /openbmc/u-boot/README (revision 064b55cf)
1c609719bSwdenk#
2eca3aeb3SWolfgang Denk# (C) Copyright 2000 - 2013
3c609719bSwdenk# Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4c609719bSwdenk#
5eca3aeb3SWolfgang Denk# SPDX-License-Identifier:	GPL-2.0+
6c609719bSwdenk#
7c609719bSwdenk
8c609719bSwdenkSummary:
9c609719bSwdenk========
10c609719bSwdenk
1124ee89b9SwdenkThis directory contains the source code for U-Boot, a boot loader for
12e86e5a07SwdenkEmbedded boards based on PowerPC, ARM, MIPS and several other
13e86e5a07Swdenkprocessors, which can be installed in a boot ROM and used to
14e86e5a07Swdenkinitialize and test the hardware or to download and run application
15e86e5a07Swdenkcode.
16c609719bSwdenk
17c609719bSwdenkThe development of U-Boot is closely related to Linux: some parts of
1824ee89b9Swdenkthe source code originate in the Linux source tree, we have some
1924ee89b9Swdenkheader files in common, and special provision has been made to
20c609719bSwdenksupport booting of Linux images.
21c609719bSwdenk
22c609719bSwdenkSome attention has been paid to make this software easily
23c609719bSwdenkconfigurable and extendable. For instance, all monitor commands are
24c609719bSwdenkimplemented with the same call interface, so that it's very easy to
25c609719bSwdenkadd new commands. Also, instead of permanently adding rarely used
26c609719bSwdenkcode (for instance hardware test utilities) to the monitor, you can
27c609719bSwdenkload and run it dynamically.
28c609719bSwdenk
29c609719bSwdenk
30c609719bSwdenkStatus:
31c609719bSwdenk=======
32c609719bSwdenk
33c609719bSwdenkIn general, all boards for which a configuration option exists in the
34c609719bSwdenkMakefile have been tested to some extent and can be considered
35c609719bSwdenk"working". In fact, many of them are used in production systems.
36c609719bSwdenk
377207b366SRobert P. J. DayIn case of problems see the CHANGELOG file to find out who contributed
387207b366SRobert P. J. Daythe specific port. In addition, there are various MAINTAINERS files
397207b366SRobert P. J. Dayscattered throughout the U-Boot source identifying the people or
407207b366SRobert P. J. Daycompanies responsible for various boards and subsystems.
41c609719bSwdenk
427207b366SRobert P. J. DayNote: As of August, 2010, there is no longer a CHANGELOG file in the
437207b366SRobert P. J. Dayactual U-Boot source tree; however, it can be created dynamically
447207b366SRobert P. J. Dayfrom the Git log using:
45adb9d851SRobert P. J. Day
46adb9d851SRobert P. J. Day	make CHANGELOG
47adb9d851SRobert P. J. Day
48c609719bSwdenk
49c609719bSwdenkWhere to get help:
50c609719bSwdenk==================
51c609719bSwdenk
52c609719bSwdenkIn case you have questions about, problems with or contributions for
537207b366SRobert P. J. DayU-Boot, you should send a message to the U-Boot mailing list at
540c32565fSPeter Tyser<u-boot@lists.denx.de>. There is also an archive of previous traffic
550c32565fSPeter Tyseron the mailing list - please search the archive before asking FAQ's.
560c32565fSPeter TyserPlease see http://lists.denx.de/pipermail/u-boot and
570c32565fSPeter Tyserhttp://dir.gmane.org/gmane.comp.boot-loaders.u-boot
58c609719bSwdenk
59c609719bSwdenk
60218ca724SWolfgang DenkWhere to get source code:
61218ca724SWolfgang Denk=========================
62218ca724SWolfgang Denk
637207b366SRobert P. J. DayThe U-Boot source code is maintained in the Git repository at
64218ca724SWolfgang Denkgit://www.denx.de/git/u-boot.git ; you can browse it online at
65218ca724SWolfgang Denkhttp://www.denx.de/cgi-bin/gitweb.cgi?p=u-boot.git;a=summary
66218ca724SWolfgang Denk
67218ca724SWolfgang DenkThe "snapshot" links on this page allow you to download tarballs of
6811ccc33fSMarcel Ziswilerany version you might be interested in. Official releases are also
69218ca724SWolfgang Denkavailable for FTP download from the ftp://ftp.denx.de/pub/u-boot/
70218ca724SWolfgang Denkdirectory.
71218ca724SWolfgang Denk
72d4ee711dSAnatolij GustschinPre-built (and tested) images are available from
73218ca724SWolfgang Denkftp://ftp.denx.de/pub/u-boot/images/
74218ca724SWolfgang Denk
75218ca724SWolfgang Denk
76c609719bSwdenkWhere we come from:
77c609719bSwdenk===================
78c609719bSwdenk
79c609719bSwdenk- start from 8xxrom sources
8024ee89b9Swdenk- create PPCBoot project (http://sourceforge.net/projects/ppcboot)
81c609719bSwdenk- clean up code
82c609719bSwdenk- make it easier to add custom boards
83c609719bSwdenk- make it possible to add other [PowerPC] CPUs
84c609719bSwdenk- extend functions, especially:
85c609719bSwdenk  * Provide extended interface to Linux boot loader
86c609719bSwdenk  * S-Record download
87c609719bSwdenk  * network boot
8811ccc33fSMarcel Ziswiler  * PCMCIA / CompactFlash / ATA disk / SCSI ... boot
8924ee89b9Swdenk- create ARMBoot project (http://sourceforge.net/projects/armboot)
90c609719bSwdenk- add other CPU families (starting with ARM)
9124ee89b9Swdenk- create U-Boot project (http://sourceforge.net/projects/u-boot)
920d28f34bSMagnus Lilja- current project page: see http://www.denx.de/wiki/U-Boot
9324ee89b9Swdenk
9424ee89b9Swdenk
9524ee89b9SwdenkNames and Spelling:
9624ee89b9Swdenk===================
9724ee89b9Swdenk
9824ee89b9SwdenkThe "official" name of this project is "Das U-Boot". The spelling
9924ee89b9Swdenk"U-Boot" shall be used in all written text (documentation, comments
10024ee89b9Swdenkin source files etc.). Example:
10124ee89b9Swdenk
10224ee89b9Swdenk	This is the README file for the U-Boot project.
10324ee89b9Swdenk
10424ee89b9SwdenkFile names etc. shall be based on the string "u-boot". Examples:
10524ee89b9Swdenk
10624ee89b9Swdenk	include/asm-ppc/u-boot.h
10724ee89b9Swdenk
10824ee89b9Swdenk	#include <asm/u-boot.h>
10924ee89b9Swdenk
11024ee89b9SwdenkVariable names, preprocessor constants etc. shall be either based on
11124ee89b9Swdenkthe string "u_boot" or on "U_BOOT". Example:
11224ee89b9Swdenk
11324ee89b9Swdenk	U_BOOT_VERSION		u_boot_logo
11424ee89b9Swdenk	IH_OS_U_BOOT		u_boot_hush_start
115c609719bSwdenk
116c609719bSwdenk
11793f19cc0SwdenkVersioning:
11893f19cc0Swdenk===========
11993f19cc0Swdenk
120360d883aSThomas WeberStarting with the release in October 2008, the names of the releases
121360d883aSThomas Weberwere changed from numerical release numbers without deeper meaning
122360d883aSThomas Weberinto a time stamp based numbering. Regular releases are identified by
123360d883aSThomas Webernames consisting of the calendar year and month of the release date.
124360d883aSThomas WeberAdditional fields (if present) indicate release candidates or bug fix
125360d883aSThomas Weberreleases in "stable" maintenance trees.
12693f19cc0Swdenk
127360d883aSThomas WeberExamples:
128360d883aSThomas Weber	U-Boot v2009.11	    - Release November 2009
129360d883aSThomas Weber	U-Boot v2009.11.1   - Release 1 in version November 2009 stable tree
1300de21ecbSJelle van der Waa	U-Boot v2010.09-rc1 - Release candidate 1 for September 2010 release
13193f19cc0Swdenk
13293f19cc0Swdenk
133c609719bSwdenkDirectory Hierarchy:
134c609719bSwdenk====================
135c609719bSwdenk
1368d321b81SPeter Tyser/arch			Architecture specific files
1376eae68e4SMasahiro Yamada  /arc			Files generic to ARC architecture
1388d321b81SPeter Tyser  /arm			Files generic to ARM architecture
1398d321b81SPeter Tyser  /avr32		Files generic to AVR32 architecture
1408d321b81SPeter Tyser  /m68k			Files generic to m68k architecture
1418d321b81SPeter Tyser  /microblaze		Files generic to microblaze architecture
1428d321b81SPeter Tyser  /mips			Files generic to MIPS architecture
143afc1ce82SMacpaul Lin  /nds32		Files generic to NDS32 architecture
1448d321b81SPeter Tyser  /nios2		Files generic to Altera NIOS2 architecture
14533c7731bSRobert P. J. Day  /openrisc		Files generic to OpenRISC architecture
146a47a12beSStefan Roese  /powerpc		Files generic to PowerPC architecture
1477207b366SRobert P. J. Day  /sandbox		Files generic to HW-independent "sandbox"
1488d321b81SPeter Tyser  /sh			Files generic to SH architecture
14933c7731bSRobert P. J. Day  /x86			Files generic to x86 architecture
1508d321b81SPeter Tyser/api			Machine/arch independent API for external apps
1518d321b81SPeter Tyser/board			Board dependent files
152740f7e5cSXu Ziyuan/cmd			U-Boot commands functions
1538d321b81SPeter Tyser/common			Misc architecture independent functions
1547207b366SRobert P. J. Day/configs		Board default configuration files
1558d321b81SPeter Tyser/disk			Code for disk drive partition handling
1568d321b81SPeter Tyser/doc			Documentation (don't expect too much)
1578d321b81SPeter Tyser/drivers		Commonly used device drivers
15833c7731bSRobert P. J. Day/dts			Contains Makefile for building internal U-Boot fdt.
1598d321b81SPeter Tyser/examples		Example code for standalone applications, etc.
1608d321b81SPeter Tyser/fs			Filesystem code (cramfs, ext2, jffs2, etc.)
1618d321b81SPeter Tyser/include		Header Files
1627207b366SRobert P. J. Day/lib			Library routines generic to all architectures
1637207b366SRobert P. J. Day/Licenses		Various license files
1648d321b81SPeter Tyser/net			Networking code
1658d321b81SPeter Tyser/post			Power On Self Test
1667207b366SRobert P. J. Day/scripts		Various build scripts and Makefiles
1677207b366SRobert P. J. Day/test			Various unit test files
1688d321b81SPeter Tyser/tools			Tools to build S-Record or U-Boot images, etc.
169c609719bSwdenk
170c609719bSwdenkSoftware Configuration:
171c609719bSwdenk=======================
172c609719bSwdenk
173c609719bSwdenkConfiguration is usually done using C preprocessor defines; the
174c609719bSwdenkrationale behind that is to avoid dead code whenever possible.
175c609719bSwdenk
176c609719bSwdenkThere are two classes of configuration variables:
177c609719bSwdenk
178c609719bSwdenk* Configuration _OPTIONS_:
179c609719bSwdenk  These are selectable by the user and have names beginning with
180c609719bSwdenk  "CONFIG_".
181c609719bSwdenk
182c609719bSwdenk* Configuration _SETTINGS_:
183c609719bSwdenk  These depend on the hardware etc. and should not be meddled with if
184c609719bSwdenk  you don't know what you're doing; they have names beginning with
1856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  "CONFIG_SYS_".
186c609719bSwdenk
1877207b366SRobert P. J. DayPreviously, all configuration was done by hand, which involved creating
1887207b366SRobert P. J. Daysymbolic links and editing configuration files manually. More recently,
1897207b366SRobert P. J. DayU-Boot has added the Kbuild infrastructure used by the Linux kernel,
1907207b366SRobert P. J. Dayallowing you to use the "make menuconfig" command to configure your
1917207b366SRobert P. J. Daybuild.
192c609719bSwdenk
193c609719bSwdenk
194c609719bSwdenkSelection of Processor Architecture and Board Type:
195c609719bSwdenk---------------------------------------------------
196c609719bSwdenk
197c609719bSwdenkFor all supported boards there are ready-to-use default
198ab584d67SHolger Freytherconfigurations available; just type "make <board_name>_defconfig".
199c609719bSwdenk
200c609719bSwdenkExample: For a TQM823L module type:
201c609719bSwdenk
202c609719bSwdenk	cd u-boot
203ab584d67SHolger Freyther	make TQM823L_defconfig
204c609719bSwdenk
2057207b366SRobert P. J. DayNote: If you're looking for the default configuration file for a board
2067207b366SRobert P. J. Dayyou're sure used to be there but is now missing, check the file
2077207b366SRobert P. J. Daydoc/README.scrapyard for a list of no longer supported boards.
208c609719bSwdenk
20975b3c3aaSSimon GlassSandbox Environment:
21075b3c3aaSSimon Glass--------------------
21175b3c3aaSSimon Glass
21275b3c3aaSSimon GlassU-Boot can be built natively to run on a Linux host using the 'sandbox'
21375b3c3aaSSimon Glassboard. This allows feature development which is not board- or architecture-
21475b3c3aaSSimon Glassspecific to be undertaken on a native platform. The sandbox is also used to
21575b3c3aaSSimon Glassrun some of U-Boot's tests.
21675b3c3aaSSimon Glass
2176b1978f8SJagannadha Sutradharudu TekiSee board/sandbox/README.sandbox for more details.
21875b3c3aaSSimon Glass
21975b3c3aaSSimon Glass
220db910353SSimon GlassBoard Initialisation Flow:
221db910353SSimon Glass--------------------------
222db910353SSimon Glass
223db910353SSimon GlassThis is the intended start-up flow for boards. This should apply for both
2247207b366SRobert P. J. DaySPL and U-Boot proper (i.e. they both follow the same rules).
225db910353SSimon Glass
2267207b366SRobert P. J. DayNote: "SPL" stands for "Secondary Program Loader," which is explained in
2277207b366SRobert P. J. Daymore detail later in this file.
2287207b366SRobert P. J. Day
2297207b366SRobert P. J. DayAt present, SPL mostly uses a separate code path, but the function names
2307207b366SRobert P. J. Dayand roles of each function are the same. Some boards or architectures
2317207b366SRobert P. J. Daymay not conform to this.  At least most ARM boards which use
2327207b366SRobert P. J. DayCONFIG_SPL_FRAMEWORK conform to this.
2337207b366SRobert P. J. Day
2347207b366SRobert P. J. DayExecution typically starts with an architecture-specific (and possibly
2357207b366SRobert P. J. DayCPU-specific) start.S file, such as:
2367207b366SRobert P. J. Day
2377207b366SRobert P. J. Day	- arch/arm/cpu/armv7/start.S
2387207b366SRobert P. J. Day	- arch/powerpc/cpu/mpc83xx/start.S
2397207b366SRobert P. J. Day	- arch/mips/cpu/start.S
2407207b366SRobert P. J. Day
2417207b366SRobert P. J. Dayand so on. From there, three functions are called; the purpose and
2427207b366SRobert P. J. Daylimitations of each of these functions are described below.
243db910353SSimon Glass
244db910353SSimon Glasslowlevel_init():
245db910353SSimon Glass	- purpose: essential init to permit execution to reach board_init_f()
246db910353SSimon Glass	- no global_data or BSS
247db910353SSimon Glass	- there is no stack (ARMv7 may have one but it will soon be removed)
248db910353SSimon Glass	- must not set up SDRAM or use console
249db910353SSimon Glass	- must only do the bare minimum to allow execution to continue to
250db910353SSimon Glass		board_init_f()
251db910353SSimon Glass	- this is almost never needed
252db910353SSimon Glass	- return normally from this function
253db910353SSimon Glass
254db910353SSimon Glassboard_init_f():
255db910353SSimon Glass	- purpose: set up the machine ready for running board_init_r():
256db910353SSimon Glass		i.e. SDRAM and serial UART
257db910353SSimon Glass	- global_data is available
258db910353SSimon Glass	- stack is in SRAM
259db910353SSimon Glass	- BSS is not available, so you cannot use global/static variables,
260db910353SSimon Glass		only stack variables and global_data
261db910353SSimon Glass
262db910353SSimon Glass	Non-SPL-specific notes:
263db910353SSimon Glass	- dram_init() is called to set up DRAM. If already done in SPL this
264db910353SSimon Glass		can do nothing
265db910353SSimon Glass
266db910353SSimon Glass	SPL-specific notes:
267db910353SSimon Glass	- you can override the entire board_init_f() function with your own
268db910353SSimon Glass		version as needed.
269db910353SSimon Glass	- preloader_console_init() can be called here in extremis
270db910353SSimon Glass	- should set up SDRAM, and anything needed to make the UART work
271db910353SSimon Glass	- these is no need to clear BSS, it will be done by crt0.S
272db910353SSimon Glass	- must return normally from this function (don't call board_init_r()
273db910353SSimon Glass		directly)
274db910353SSimon Glass
275db910353SSimon GlassHere the BSS is cleared. For SPL, if CONFIG_SPL_STACK_R is defined, then at
276db910353SSimon Glassthis point the stack and global_data are relocated to below
277db910353SSimon GlassCONFIG_SPL_STACK_R_ADDR. For non-SPL, U-Boot is relocated to run at the top of
278db910353SSimon Glassmemory.
279db910353SSimon Glass
280db910353SSimon Glassboard_init_r():
281db910353SSimon Glass	- purpose: main execution, common code
282db910353SSimon Glass	- global_data is available
283db910353SSimon Glass	- SDRAM is available
284db910353SSimon Glass	- BSS is available, all static/global variables can be used
285db910353SSimon Glass	- execution eventually continues to main_loop()
286db910353SSimon Glass
287db910353SSimon Glass	Non-SPL-specific notes:
288db910353SSimon Glass	- U-Boot is relocated to the top of memory and is now running from
289db910353SSimon Glass		there.
290db910353SSimon Glass
291db910353SSimon Glass	SPL-specific notes:
292db910353SSimon Glass	- stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
293db910353SSimon Glass		CONFIG_SPL_STACK_R_ADDR points into SDRAM
294db910353SSimon Glass	- preloader_console_init() can be called here - typically this is
2950680f1b1SLey Foon Tan		done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
296db910353SSimon Glass		spl_board_init() function containing this call
297db910353SSimon Glass	- loads U-Boot or (in falcon mode) Linux
298db910353SSimon Glass
299db910353SSimon Glass
300db910353SSimon Glass
301c609719bSwdenkConfiguration Options:
302c609719bSwdenk----------------------
303c609719bSwdenk
304c609719bSwdenkConfiguration depends on the combination of board and CPU type; all
305c609719bSwdenksuch information is kept in a configuration file
306c609719bSwdenk"include/configs/<board_name>.h".
307c609719bSwdenk
308c609719bSwdenkExample: For a TQM823L module, all configuration settings are in
309c609719bSwdenk"include/configs/TQM823L.h".
310c609719bSwdenk
311c609719bSwdenk
3127f6c2cbcSwdenkMany of the options are named exactly as the corresponding Linux
3137f6c2cbcSwdenkkernel configuration options. The intention is to make it easier to
3147f6c2cbcSwdenkbuild a config tool - later.
3157f6c2cbcSwdenk
3167f6c2cbcSwdenk
317c609719bSwdenkThe following options need to be configured:
318c609719bSwdenk
3192628114eSKim Phillips- CPU Type:	Define exactly one, e.g. CONFIG_MPC85XX.
320c609719bSwdenk
3212628114eSKim Phillips- Board Type:	Define exactly one, e.g. CONFIG_MPC8540ADS.
3226ccec449SWolfgang Denk
3236ccec449SWolfgang Denk- CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
32409ea0de0SHaavard Skinnemoen		Define exactly one, e.g. CONFIG_ATSTK1002
325c609719bSwdenk
326cf946c6dSLei Wen- Marvell Family Member
327cf946c6dSLei Wen		CONFIG_SYS_MVFS		- define it if you want to enable
328cf946c6dSLei Wen					  multiple fs option at one time
329cf946c6dSLei Wen					  for marvell soc family
330cf946c6dSLei Wen
33166412c63SKumar Gala- 85xx CPU Options:
332ffd06e02SYork Sun		CONFIG_SYS_PPC64
333ffd06e02SYork Sun
334ffd06e02SYork Sun		Specifies that the core is a 64-bit PowerPC implementation (implements
335ffd06e02SYork Sun		the "64" category of the Power ISA). This is necessary for ePAPR
336ffd06e02SYork Sun		compliance, among other possible reasons.
337ffd06e02SYork Sun
33866412c63SKumar Gala		CONFIG_SYS_FSL_TBCLK_DIV
33966412c63SKumar Gala
34066412c63SKumar Gala		Defines the core time base clock divider ratio compared to the
34166412c63SKumar Gala		system clock.  On most PQ3 devices this is 8, on newer QorIQ
34266412c63SKumar Gala		devices it can be 16 or 32.  The ratio varies from SoC to Soc.
34366412c63SKumar Gala
3448f29084aSKumar Gala		CONFIG_SYS_FSL_PCIE_COMPAT
3458f29084aSKumar Gala
3468f29084aSKumar Gala		Defines the string to utilize when trying to match PCIe device
3478f29084aSKumar Gala		tree nodes for the given platform.
3488f29084aSKumar Gala
34933eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510
35033eee330SScott Wood
35133eee330SScott Wood		Enables a workaround for erratum A004510.  If set,
35233eee330SScott Wood		then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
35333eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
35433eee330SScott Wood
35533eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
35633eee330SScott Wood		CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
35733eee330SScott Wood
35833eee330SScott Wood		Defines one or two SoC revisions (low 8 bits of SVR)
35933eee330SScott Wood		for which the A004510 workaround should be applied.
36033eee330SScott Wood
36133eee330SScott Wood		The rest of SVR is either not relevant to the decision
36233eee330SScott Wood		of whether the erratum is present (e.g. p2040 versus
36333eee330SScott Wood		p2041) or is implied by the build target, which controls
36433eee330SScott Wood		whether CONFIG_SYS_FSL_ERRATUM_A004510 is set.
36533eee330SScott Wood
36633eee330SScott Wood		See Freescale App Note 4493 for more information about
36733eee330SScott Wood		this erratum.
36833eee330SScott Wood
36974fa22edSPrabhakar Kushwaha		CONFIG_A003399_NOR_WORKAROUND
37074fa22edSPrabhakar Kushwaha		Enables a workaround for IFC erratum A003399. It is only
371b445bbb4SJeremiah Mahler		required during NOR boot.
37274fa22edSPrabhakar Kushwaha
3739f074e67SPrabhakar Kushwaha		CONFIG_A008044_WORKAROUND
3749f074e67SPrabhakar Kushwaha		Enables a workaround for T1040/T1042 erratum A008044. It is only
375b445bbb4SJeremiah Mahler		required during NAND boot and valid for Rev 1.0 SoC revision
3769f074e67SPrabhakar Kushwaha
37733eee330SScott Wood		CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
37833eee330SScott Wood
37933eee330SScott Wood		This is the value to write into CCSR offset 0x18600
38033eee330SScott Wood		according to the A004510 workaround.
38133eee330SScott Wood
38264501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_DDR_ADDR
38364501c66SPriyanka Jain		This value denotes start offset of DDR memory which is
38464501c66SPriyanka Jain		connected exclusively to the DSP cores.
38564501c66SPriyanka Jain
386765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
387765b0bdbSPriyanka Jain		This value denotes start offset of M2 memory
388765b0bdbSPriyanka Jain		which is directly connected to the DSP core.
389765b0bdbSPriyanka Jain
39064501c66SPriyanka Jain		CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
39164501c66SPriyanka Jain		This value denotes start offset of M3 memory which is directly
39264501c66SPriyanka Jain		connected to the DSP core.
39364501c66SPriyanka Jain
394765b0bdbSPriyanka Jain		CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
395765b0bdbSPriyanka Jain		This value denotes start offset of DSP CCSR space.
396765b0bdbSPriyanka Jain
397b135991aSPriyanka Jain		CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
398b135991aSPriyanka Jain		Single Source Clock is clocking mode present in some of FSL SoC's.
399b135991aSPriyanka Jain		In this mode, a single differential clock is used to supply
400b135991aSPriyanka Jain		clocks to the sysclock, ddrclock and usbclock.
401b135991aSPriyanka Jain
402fb4a2409SAneesh Bansal		CONFIG_SYS_CPC_REINIT_F
403fb4a2409SAneesh Bansal		This CONFIG is defined when the CPC is configured as SRAM at the
404a187559eSBin Meng		time of U-Boot entry and is required to be re-initialized.
405fb4a2409SAneesh Bansal
406aade2004STang Yuantian		CONFIG_DEEP_SLEEP
407b445bbb4SJeremiah Mahler		Indicates this SoC supports deep sleep feature. If deep sleep is
408aade2004STang Yuantian		supported, core will start to execute uboot when wakes up.
409aade2004STang Yuantian
4106cb461b4SDaniel Schwierzeck- Generic CPU options:
4112a1680e3SYork Sun		CONFIG_SYS_GENERIC_GLOBAL_DATA
4122a1680e3SYork Sun		Defines global data is initialized in generic board board_init_f().
4132a1680e3SYork Sun		If this macro is defined, global data is created and cleared in
4142a1680e3SYork Sun		generic board board_init_f(). Without this macro, architecture/board
4152a1680e3SYork Sun		should initialize global data before calling board_init_f().
4162a1680e3SYork Sun
4176cb461b4SDaniel Schwierzeck		CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
4186cb461b4SDaniel Schwierzeck
4196cb461b4SDaniel Schwierzeck		Defines the endianess of the CPU. Implementation of those
4206cb461b4SDaniel Schwierzeck		values is arch specific.
4216cb461b4SDaniel Schwierzeck
4225614e71bSYork Sun		CONFIG_SYS_FSL_DDR
4235614e71bSYork Sun		Freescale DDR driver in use. This type of DDR controller is
4245614e71bSYork Sun		found in mpc83xx, mpc85xx, mpc86xx as well as some ARM core
4255614e71bSYork Sun		SoCs.
4265614e71bSYork Sun
4275614e71bSYork Sun		CONFIG_SYS_FSL_DDR_ADDR
4285614e71bSYork Sun		Freescale DDR memory-mapped register base.
4295614e71bSYork Sun
4305614e71bSYork Sun		CONFIG_SYS_FSL_DDR_EMU
4315614e71bSYork Sun		Specify emulator support for DDR. Some DDR features such as
4325614e71bSYork Sun		deskew training are not available.
4335614e71bSYork Sun
4345614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN1
4355614e71bSYork Sun		Freescale DDR1 controller.
4365614e71bSYork Sun
4375614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN2
4385614e71bSYork Sun		Freescale DDR2 controller.
4395614e71bSYork Sun
4405614e71bSYork Sun		CONFIG_SYS_FSL_DDRC_GEN3
4415614e71bSYork Sun		Freescale DDR3 controller.
4425614e71bSYork Sun
44334e026f9SYork Sun		CONFIG_SYS_FSL_DDRC_GEN4
44434e026f9SYork Sun		Freescale DDR4 controller.
44534e026f9SYork Sun
4469ac4ffbdSYork Sun		CONFIG_SYS_FSL_DDRC_ARM_GEN3
4479ac4ffbdSYork Sun		Freescale DDR3 controller for ARM-based SoCs.
4489ac4ffbdSYork Sun
4495614e71bSYork Sun		CONFIG_SYS_FSL_DDR1
4505614e71bSYork Sun		Board config to use DDR1. It can be enabled for SoCs with
4515614e71bSYork Sun		Freescale DDR1 or DDR2 controllers, depending on the board
4525614e71bSYork Sun		implemetation.
4535614e71bSYork Sun
4545614e71bSYork Sun		CONFIG_SYS_FSL_DDR2
45562a3b7ddSRobert P. J. Day		Board config to use DDR2. It can be enabled for SoCs with
4565614e71bSYork Sun		Freescale DDR2 or DDR3 controllers, depending on the board
4575614e71bSYork Sun		implementation.
4585614e71bSYork Sun
4595614e71bSYork Sun		CONFIG_SYS_FSL_DDR3
4605614e71bSYork Sun		Board config to use DDR3. It can be enabled for SoCs with
46134e026f9SYork Sun		Freescale DDR3 or DDR3L controllers.
46234e026f9SYork Sun
46334e026f9SYork Sun		CONFIG_SYS_FSL_DDR3L
46434e026f9SYork Sun		Board config to use DDR3L. It can be enabled for SoCs with
46534e026f9SYork Sun		DDR3L controllers.
46634e026f9SYork Sun
46734e026f9SYork Sun		CONFIG_SYS_FSL_DDR4
46834e026f9SYork Sun		Board config to use DDR4. It can be enabled for SoCs with
46934e026f9SYork Sun		DDR4 controllers.
4705614e71bSYork Sun
4711b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_BE
4721b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Big Endian
4731b4175d6SPrabhakar Kushwaha
4741b4175d6SPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_LE
4751b4175d6SPrabhakar Kushwaha		Defines the IFC controller register space as Little Endian
4761b4175d6SPrabhakar Kushwaha
4771c40707eSPrabhakar Kushwaha		CONFIG_SYS_FSL_IFC_CLK_DIV
4781c40707eSPrabhakar Kushwaha		Defines divider of platform clock(clock input to IFC controller).
4791c40707eSPrabhakar Kushwaha
480add63f94SPrabhakar Kushwaha		CONFIG_SYS_FSL_LBC_CLK_DIV
481add63f94SPrabhakar Kushwaha		Defines divider of platform clock(clock input to eLBC controller).
482add63f94SPrabhakar Kushwaha
483690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_PBI
484690e4258SPrabhakar Kushwaha		It enables addition of RCW (Power on reset configuration) in built image.
485690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
486690e4258SPrabhakar Kushwaha
487690e4258SPrabhakar Kushwaha		CONFIG_SYS_FSL_PBL_RCW
488690e4258SPrabhakar Kushwaha		It adds PBI(pre-boot instructions) commands in u-boot build image.
489690e4258SPrabhakar Kushwaha		PBI commands can be used to configure SoC before it starts the execution.
490690e4258SPrabhakar Kushwaha		Please refer doc/README.pblimage for more details
491690e4258SPrabhakar Kushwaha
49289ad7be8SPrabhakar Kushwaha		CONFIG_SPL_FSL_PBL
49389ad7be8SPrabhakar Kushwaha		It adds a target to create boot binary having SPL binary in PBI format
49489ad7be8SPrabhakar Kushwaha		concatenated with u-boot binary.
49589ad7be8SPrabhakar Kushwaha
4964e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_BE
4974e5b1bd0SYork Sun		Defines the DDR controller register space as Big Endian
4984e5b1bd0SYork Sun
4994e5b1bd0SYork Sun		CONFIG_SYS_FSL_DDR_LE
5004e5b1bd0SYork Sun		Defines the DDR controller register space as Little Endian
5014e5b1bd0SYork Sun
5026b9e309aSYork Sun		CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
5036b9e309aSYork Sun		Physical address from the view of DDR controllers. It is the
5046b9e309aSYork Sun		same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
5056b9e309aSYork Sun		it could be different for ARM SoCs.
5066b9e309aSYork Sun
5076b1e1254SYork Sun		CONFIG_SYS_FSL_DDR_INTLV_256B
5086b1e1254SYork Sun		DDR controller interleaving on 256-byte. This is a special
5096b1e1254SYork Sun		interleaving mode, handled by Dickens for Freescale layerscape
5106b1e1254SYork Sun		SoCs with ARM core.
5116b1e1254SYork Sun
5121d71efbbSYork Sun		CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
5131d71efbbSYork Sun		Number of controllers used as main memory.
5141d71efbbSYork Sun
5151d71efbbSYork Sun		CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
5161d71efbbSYork Sun		Number of controllers used for other than main memory.
5171d71efbbSYork Sun
51844937214SPrabhakar Kushwaha		CONFIG_SYS_FSL_HAS_DP_DDR
51944937214SPrabhakar Kushwaha		Defines the SoC has DP-DDR used for DPAA.
52044937214SPrabhakar Kushwaha
521028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_BE
522028dbb8dSRuchika Gupta		Defines the SEC controller register space as Big Endian
523028dbb8dSRuchika Gupta
524028dbb8dSRuchika Gupta		CONFIG_SYS_FSL_SEC_LE
525028dbb8dSRuchika Gupta		Defines the SEC controller register space as Little Endian
526028dbb8dSRuchika Gupta
52792bbd64eSDaniel Schwierzeck- MIPS CPU options:
52892bbd64eSDaniel Schwierzeck		CONFIG_SYS_INIT_SP_OFFSET
52992bbd64eSDaniel Schwierzeck
53092bbd64eSDaniel Schwierzeck		Offset relative to CONFIG_SYS_SDRAM_BASE for initial stack
53192bbd64eSDaniel Schwierzeck		pointer. This is needed for the temporary stack before
53292bbd64eSDaniel Schwierzeck		relocation.
53392bbd64eSDaniel Schwierzeck
53492bbd64eSDaniel Schwierzeck		CONFIG_SYS_MIPS_CACHE_MODE
53592bbd64eSDaniel Schwierzeck
53692bbd64eSDaniel Schwierzeck		Cache operation mode for the MIPS CPU.
53792bbd64eSDaniel Schwierzeck		See also arch/mips/include/asm/mipsregs.h.
53892bbd64eSDaniel Schwierzeck		Possible values are:
53992bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NO_WA
54092bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_WA
54192bbd64eSDaniel Schwierzeck			CONF_CM_UNCACHED
54292bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_NONCOHERENT
54392bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CE
54492bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_COW
54592bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_CUW
54692bbd64eSDaniel Schwierzeck			CONF_CM_CACHABLE_ACCELERATED
54792bbd64eSDaniel Schwierzeck
54892bbd64eSDaniel Schwierzeck		CONFIG_SYS_XWAY_EBU_BOOTCFG
54992bbd64eSDaniel Schwierzeck
55092bbd64eSDaniel Schwierzeck		Special option for Lantiq XWAY SoCs for booting from NOR flash.
55192bbd64eSDaniel Schwierzeck		See also arch/mips/cpu/mips32/start.S.
55292bbd64eSDaniel Schwierzeck
55392bbd64eSDaniel Schwierzeck		CONFIG_XWAY_SWAP_BYTES
55492bbd64eSDaniel Schwierzeck
55592bbd64eSDaniel Schwierzeck		Enable compilation of tools/xway-swap-bytes needed for Lantiq
55692bbd64eSDaniel Schwierzeck		XWAY SoCs for booting from NOR flash. The U-Boot image needs to
55792bbd64eSDaniel Schwierzeck		be swapped if a flash programmer is used.
55892bbd64eSDaniel Schwierzeck
559b67d8816SChristian Riesch- ARM options:
560b67d8816SChristian Riesch		CONFIG_SYS_EXCEPTION_VECTORS_HIGH
561b67d8816SChristian Riesch
562b67d8816SChristian Riesch		Select high exception vectors of the ARM core, e.g., do not
563b67d8816SChristian Riesch		clear the V bit of the c1 register of CP15.
564b67d8816SChristian Riesch
565207774b2SYork Sun		COUNTER_FREQUENCY
566207774b2SYork Sun		Generic timer clock source frequency.
567207774b2SYork Sun
568207774b2SYork Sun		COUNTER_FREQUENCY_REAL
569207774b2SYork Sun		Generic timer clock source frequency if the real clock is
570207774b2SYork Sun		different from COUNTER_FREQUENCY, and can only be determined
571207774b2SYork Sun		at run time.
572207774b2SYork Sun
57373c38934SStephen Warren- Tegra SoC options:
57473c38934SStephen Warren		CONFIG_TEGRA_SUPPORT_NON_SECURE
57573c38934SStephen Warren
57673c38934SStephen Warren		Support executing U-Boot in non-secure (NS) mode. Certain
57773c38934SStephen Warren		impossible actions will be skipped if the CPU is in NS mode,
57873c38934SStephen Warren		such as ARM architectural timer initialization.
57973c38934SStephen Warren
5805da627a4Swdenk- Linux Kernel Interface:
581c609719bSwdenk		CONFIG_CLOCKS_IN_MHZ
582c609719bSwdenk
583c609719bSwdenk		U-Boot stores all clock information in Hz
584c609719bSwdenk		internally. For binary compatibility with older Linux
585c609719bSwdenk		kernels (which expect the clocks passed in the
586c609719bSwdenk		bd_info data to be in MHz) the environment variable
587c609719bSwdenk		"clocks_in_mhz" can be defined so that U-Boot
588c609719bSwdenk		converts clock data to MHZ before passing it to the
589c609719bSwdenk		Linux kernel.
590c609719bSwdenk		When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
591c609719bSwdenk		"clocks_in_mhz=1" is automatically included in the
592c609719bSwdenk		default environment.
593c609719bSwdenk
5945da627a4Swdenk		CONFIG_MEMSIZE_IN_BYTES		[relevant for MIPS only]
5955da627a4Swdenk
596b445bbb4SJeremiah Mahler		When transferring memsize parameter to Linux, some versions
5975da627a4Swdenk		expect it to be in bytes, others in MB.
5985da627a4Swdenk		Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
5995da627a4Swdenk
600fec6d9eeSGerald Van Baren		CONFIG_OF_LIBFDT
601f57f70aaSWolfgang Denk
602f57f70aaSWolfgang Denk		New kernel versions are expecting firmware settings to be
603213bf8c8SGerald Van Baren		passed using flattened device trees (based on open firmware
604213bf8c8SGerald Van Baren		concepts).
605213bf8c8SGerald Van Baren
606213bf8c8SGerald Van Baren		CONFIG_OF_LIBFDT
607213bf8c8SGerald Van Baren		 * New libfdt-based support
608213bf8c8SGerald Van Baren		 * Adds the "fdt" command
6093bb342fcSKim Phillips		 * The bootm command automatically updates the fdt
610213bf8c8SGerald Van Baren
611f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
612c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
613f57f70aaSWolfgang Denk
61411ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
61511ccc33fSMarcel Ziswiler		addresses
6163bb342fcSKim Phillips
6174e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6184e253137SKumar Gala
6194e253137SKumar Gala		Board code has addition modification that it wants to make
6204e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6216705d81eSwdenk
622c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
623c654b517SSimon Glass
624c654b517SSimon Glass		Other code has addition modification that it wants to make
625c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
626c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
627c654b517SSimon Glass		the kernel.
628c654b517SSimon Glass
6293887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6303887c3fbSHeiko Schocher
6313887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6323887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6333887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6343887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6353887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6363887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6373887c3fbSHeiko Schocher
6387eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6397eb29398SIgor Grinberg
6407eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6417eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6427eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6437eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6447eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6457eb29398SIgor Grinberg		in a single configuration file and the machine type is
6467eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6477eb29398SIgor Grinberg
6480b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6490b2f4ecaSNiklaus Giger
6500b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6519e98b7e3SBin Meng		environments variables: bootdev, bootfile, ipaddr, netmask,
6529e98b7e3SBin Meng		serverip, gatewayip, hostname, othbootargs.
6530b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6540b2f4ecaSNiklaus Giger
6550b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6560b2f4ecaSNiklaus Giger		the defaults discussed just above.
6570b2f4ecaSNiklaus Giger
6582c451f78SAneesh V- Cache Configuration:
6592c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6602c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6612c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6622c451f78SAneesh V
66393bc2193SAneesh V- Cache Configuration for ARM:
66493bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
66593bc2193SAneesh V				      controller
66693bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
66793bc2193SAneesh V					controller register space
66893bc2193SAneesh V
6696705d81eSwdenk- Serial Ports:
67048d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6716705d81eSwdenk
6726705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6736705d81eSwdenk
67448d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6756705d81eSwdenk
6766705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6776705d81eSwdenk
6786705d81eSwdenk		CONFIG_PL011_CLOCK
6796705d81eSwdenk
6806705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6816705d81eSwdenk		the clock speed of the UARTs.
6826705d81eSwdenk
6836705d81eSwdenk		CONFIG_PL01x_PORTS
6846705d81eSwdenk
6856705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6866705d81eSwdenk		define this to a list of base addresses for each (supported)
6876705d81eSwdenk		port. See e.g. include/configs/versatile.h
6886705d81eSwdenk
689d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
690d57dee57SKaricheri, Muralidharan
691d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
692d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
6936705d81eSwdenk
694c609719bSwdenk- Console Baudrate:
695c609719bSwdenk		CONFIG_BAUDRATE - in bps
696c609719bSwdenk		Select one of the baudrates listed in
6976d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
698c609719bSwdenk
699c609719bSwdenk- Autoboot Command:
700c609719bSwdenk		CONFIG_BOOTCOMMAND
701c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
702c609719bSwdenk		define a command string that is automatically executed
703c609719bSwdenk		when no character is read on the console interface
704c609719bSwdenk		within "Boot Delay" after reset.
705c609719bSwdenk
706c609719bSwdenk		CONFIG_BOOTARGS
707c609719bSwdenk		This can be used to pass arguments to the bootm
708c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
709c609719bSwdenk		environment value "bootargs".
710c609719bSwdenk
711c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
712c609719bSwdenk		The value of these goes into the environment as
713c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
714c609719bSwdenk		as a convenience, when switching between booting from
71511ccc33fSMarcel Ziswiler		RAM and NFS.
716c609719bSwdenk
717eda0ba38SHeiko Schocher- Bootcount:
718eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
719eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
720eda0ba38SHeiko Schocher		cycle, see:
721eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
722eda0ba38SHeiko Schocher
723eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
724eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
725eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
726eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
727eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
728eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
729eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
730eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
731eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
732eda0ba38SHeiko Schocher
733c609719bSwdenk- Pre-Boot Commands:
734c609719bSwdenk		CONFIG_PREBOOT
735c609719bSwdenk
736c609719bSwdenk		When this option is #defined, the existence of the
737c609719bSwdenk		environment variable "preboot" will be checked
738c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
739c609719bSwdenk		countdown and/or running the auto-boot command resp.
740c609719bSwdenk		entering interactive mode.
741c609719bSwdenk
742c609719bSwdenk		This feature is especially useful when "preboot" is
743c609719bSwdenk		automatically generated or modified. For an example
744c609719bSwdenk		see the LWMON board specific code: here "preboot" is
745c609719bSwdenk		modified when the user holds down a certain
746c609719bSwdenk		combination of keys on the (special) keyboard when
747c609719bSwdenk		booting the systems
748c609719bSwdenk
749c609719bSwdenk- Serial Download Echo Mode:
750c609719bSwdenk		CONFIG_LOADS_ECHO
751c609719bSwdenk		If defined to 1, all characters received during a
752c609719bSwdenk		serial download (using the "loads" command) are
753c609719bSwdenk		echoed back. This might be needed by some terminal
754c609719bSwdenk		emulations (like "cu"), but may as well just take
755c609719bSwdenk		time on others. This setting #define's the initial
756c609719bSwdenk		value of the "loads_echo" environment variable.
757c609719bSwdenk
758602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
759c609719bSwdenk		CONFIG_KGDB_BAUDRATE
760c609719bSwdenk		Select one of the baudrates listed in
7616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
762c609719bSwdenk
763c609719bSwdenk- Monitor Functions:
764602ad3b3SJon Loeliger		Monitor commands can be included or excluded
765602ad3b3SJon Loeliger		from the build by using the #include files
766c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
767ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
768c609719bSwdenk
769602ad3b3SJon Loeliger		The default command configuration includes all commands
770602ad3b3SJon Loeliger		except those marked below with a "*".
771602ad3b3SJon Loeliger
772b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
773602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
774602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
775602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
776d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
777602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
778602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
779602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
780602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
781602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
782246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
783602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
78488733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
7850c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
78603e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
78703e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
78816f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
78916f4d933SStephen Warren					  that work for multiple fs types
79059e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
791bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
792602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
793602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
794a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
795a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
796602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
797602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
7988fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
7994d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
8000c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
801c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
802602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
8034d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
804d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
805d22c338eSJoe Hershberger					  (169.254.*.*)
806602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
807602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
8084d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
80902c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
81015a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
811602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
812a2681707SWolfgang Denk					  loop, loopw
8134d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
814602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
815602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
816602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
81768d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
818602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
819602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
8204d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
821e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
822e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
823602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
824602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
825602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
826602ad3b3SJon Loeliger					  host
827602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
828ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
829602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
830602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
831d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
832602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
833c649e3c9SSimon Glass		CONFIG_SCSI		* SCSI Support
834602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
835602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
836602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
837602ad3b3SJon Loeliger					  (4xx only)
838f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
8397d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
84074de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
841602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8427a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8431fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
844da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
845da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
846602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
847602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
848c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
8494d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
85089c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
851c609719bSwdenk
852c609719bSwdenk		EXAMPLE: If you want all functions except of network
853c609719bSwdenk		support you can write:
854c609719bSwdenk
855602ad3b3SJon Loeliger		#include "config_cmd_all.h"
856602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
857c609719bSwdenk
858213bf8c8SGerald Van Baren	Other Commands:
859213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
860c609719bSwdenk
861c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
862602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
863c609719bSwdenk		what you (and your U-Boot users) are doing. Data
8645b8e76c3SHeiko Schocher		cache cannot be enabled on systems like the
865c609719bSwdenk		8260 (where accesses to the IMMR region must be
866c609719bSwdenk		uncached), and it cannot be disabled on all other
867c609719bSwdenk		systems where we (mis-) use the data cache to hold an
868c609719bSwdenk		initial stack and some data.
869c609719bSwdenk
870c609719bSwdenk
871c609719bSwdenk		XXX - this list needs to get updated!
872c609719bSwdenk
873302a6487SSimon Glass- Removal of commands
874302a6487SSimon Glass		If no commands are needed to boot, you can disable
875302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
876302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
877302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
878302a6487SSimon Glass		instead. This can reduce image size significantly for very
879302a6487SSimon Glass		simple boot procedures.
880302a6487SSimon Glass
881a5ecbe62SWolfgang Denk- Regular expression support:
882a5ecbe62SWolfgang Denk		CONFIG_REGEX
883a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
884a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
885a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
886a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
887a5ecbe62SWolfgang Denk
88845ba8077SSimon Glass- Device tree:
88945ba8077SSimon Glass		CONFIG_OF_CONTROL
89045ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
89145ba8077SSimon Glass		to configure its devices, instead of relying on statically
89245ba8077SSimon Glass		compiled #defines in the board file. This option is
89345ba8077SSimon Glass		experimental and only available on a few boards. The device
89445ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
89545ba8077SSimon Glass
8962c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
89782f766d1SAlex Deymo		be done using one of the three options below:
898bbb0b128SSimon Glass
899bbb0b128SSimon Glass		CONFIG_OF_EMBED
900bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
901bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
902bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
903bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
904bbb0b128SSimon Glass		the global data structure as gd->blob.
90545ba8077SSimon Glass
9062c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9072c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9082c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9092c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9102c0f79e4SSimon Glass
9112c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9122c0f79e4SSimon Glass
9132c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9142c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9152c0f79e4SSimon Glass		still use the individual files if you need something more
9162c0f79e4SSimon Glass		exotic.
9172c0f79e4SSimon Glass
91882f766d1SAlex Deymo		CONFIG_OF_BOARD
91982f766d1SAlex Deymo		If this variable is defined, U-Boot will use the device tree
92082f766d1SAlex Deymo		provided by the board at runtime instead of embedding one with
92182f766d1SAlex Deymo		the image. Only boards defining board_fdt_blob_setup() support
92282f766d1SAlex Deymo		this option (see include/fdtdec.h file).
92382f766d1SAlex Deymo
924c609719bSwdenk- Watchdog:
925c609719bSwdenk		CONFIG_WATCHDOG
926c609719bSwdenk		If this variable is defined, it enables watchdog
9276abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
9282eb48ff7SHeiko Schocher		specific code for a watchdog. When supported for a
9292eb48ff7SHeiko Schocher		specific SoC is available, then no further board specific
9302eb48ff7SHeiko Schocher		code should be needed to use it.
9316abe6fb6SDetlev Zundel
9326abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9336abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9346abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9356abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
936c609719bSwdenk
9377bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
9387bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
9397bae0d6fSHeiko Schocher
940c1551ea8Sstroese- U-Boot Version:
941c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
942c1551ea8Sstroese		If this variable is defined, an environment variable
943c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
944c1551ea8Sstroese		version as printed by the "version" command.
945a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
946a1ea8e51SBenoît Thébaudeau		next reset.
947c1551ea8Sstroese
948c609719bSwdenk- Real-Time Clock:
949c609719bSwdenk
950602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
951c609719bSwdenk		has to be selected, too. Define exactly one of the
952c609719bSwdenk		following options:
953c609719bSwdenk
954c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9554e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
956c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9571cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
958c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9597f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
960412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
9613bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9629536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9634c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9642bd3cab3SChris Packham		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
96571d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
96671d19f30SHeiko Schocher					  RV3029 RTC.
967c609719bSwdenk
968b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
969b37c7e5eSwdenk		must also be configured. See I2C Support, below.
970b37c7e5eSwdenk
971e92739d3SPeter Tyser- GPIO Support:
972e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
973e92739d3SPeter Tyser
9745dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9755dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9765dec49caSChris Packham		pins supported by a particular chip.
9775dec49caSChris Packham
978e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
979e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
980e92739d3SPeter Tyser
981aa53233aSSimon Glass- I/O tracing:
982aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
983aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
984aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
985aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
986aa53233aSSimon Glass		the driver behaves the same way before and after a code
987aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
988aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
989aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
990aa53233aSSimon Glass
991aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
992aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
993aa53233aSSimon Glass		still continue to operate.
994aa53233aSSimon Glass
995aa53233aSSimon Glass			iotrace is enabled
996aa53233aSSimon Glass			Start:  10000000	(buffer start address)
997aa53233aSSimon Glass			Size:   00010000	(buffer size)
998aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
999aa53233aSSimon Glass			Output: 10000120	(start + offset)
1000aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1001aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1002aa53233aSSimon Glass
1003c609719bSwdenk- Timestamp Support:
1004c609719bSwdenk
1005c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1006c609719bSwdenk		(date and time) of an image is printed by image
1007c609719bSwdenk		commands like bootm or iminfo. This option is
1008602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1009c609719bSwdenk
1010923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1011923c46f9SKarl O. Pinc		Zero or more of the following:
1012923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1013923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1014923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1015923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1016923c46f9SKarl O. Pinc				       disk/part_efi.c
1017923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1018c609719bSwdenk
1019fc843a02SSimon Glass		If IDE or SCSI support is enabled (CONFIG_IDE or
1020c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
1021923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1022c609719bSwdenk
1023c609719bSwdenk- IDE Reset method:
10244d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10254d13cbadSwdenk		board configurations files but used nowhere!
1026c609719bSwdenk
10274d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10284d13cbadSwdenk		be performed by calling the function
10294d13cbadSwdenk			ide_set_reset(int reset)
10304d13cbadSwdenk		which has to be defined in a board specific file
1031c609719bSwdenk
1032c609719bSwdenk- ATAPI Support:
1033c609719bSwdenk		CONFIG_ATAPI
1034c609719bSwdenk
1035c609719bSwdenk		Set this to enable ATAPI support.
1036c609719bSwdenk
1037c40b2956Swdenk- LBA48 Support
1038c40b2956Swdenk		CONFIG_LBA48
1039c40b2956Swdenk
1040c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10414b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1042c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1043c40b2956Swdenk		support disks up to 2.1TB.
1044c40b2956Swdenk
10456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1046c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1047c40b2956Swdenk			Default is 32bit.
1048c40b2956Swdenk
1049c609719bSwdenk- SCSI Support:
1050c609719bSwdenk		At the moment only there is only support for the
1051c609719bSwdenk		SYM53C8XX SCSI controller; define
1052c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1053c609719bSwdenk
10546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1057c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1058c609719bSwdenk		devices.
10596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1060c609719bSwdenk
1061447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1062447c031bSStefan Reinauer		SCSI devices found during the last scan.
1063447c031bSStefan Reinauer
1064c609719bSwdenk- NETWORK Support (PCI):
1065682011ffSwdenk		CONFIG_E1000
1066ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1067ce5207e1SKyle Moffett
1068ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1069ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1070ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1071ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1072ce5207e1SKyle Moffett
1073ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1074ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1075ce5207e1SKyle Moffett		example with the "sspi" command.
1076ce5207e1SKyle Moffett
1077ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1078ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1079ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1080682011ffSwdenk
1081c609719bSwdenk		CONFIG_EEPRO100
1082c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
108311ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1084c609719bSwdenk		write routine for first time initialisation.
1085c609719bSwdenk
1086c609719bSwdenk		CONFIG_TULIP
1087c609719bSwdenk		Support for Digital 2114x chips.
1088c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1089c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1090c609719bSwdenk
1091c609719bSwdenk		CONFIG_NATSEMI
1092c609719bSwdenk		Support for National dp83815 chips.
1093c609719bSwdenk
1094c609719bSwdenk		CONFIG_NS8382X
1095c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1096c609719bSwdenk
109745219c46Swdenk- NETWORK Support (other):
109845219c46Swdenk
1099c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1100c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1101c041e9d2SJens Scharsig
1102c041e9d2SJens Scharsig			CONFIG_RMII
1103c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1104c041e9d2SJens Scharsig
1105c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1106c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1107c041e9d2SJens Scharsig			The driver doen't show link status messages.
1108c041e9d2SJens Scharsig
1109efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1110efdd7319SRob Herring		Support for the Calxeda XGMAC device
1111efdd7319SRob Herring
11123bb46d23SAshok		CONFIG_LAN91C96
111345219c46Swdenk		Support for SMSC's LAN91C96 chips.
111445219c46Swdenk
111545219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
111645219c46Swdenk			Define this to enable 32 bit addressing
111745219c46Swdenk
11183bb46d23SAshok		CONFIG_SMC91111
1119f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1120f39748aeSwdenk
1121f39748aeSwdenk			CONFIG_SMC91111_BASE
1122f39748aeSwdenk			Define this to hold the physical address
1123f39748aeSwdenk			of the device (I/O space)
1124f39748aeSwdenk
1125f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1126f39748aeSwdenk			Define this if data bus is 32 bits
1127f39748aeSwdenk
1128f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1129f39748aeSwdenk			Define this to use i/o functions instead of macros
1130f39748aeSwdenk			(some hardware wont work with macros)
1131f39748aeSwdenk
1132dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1133dc02badaSHeiko Schocher		Support for davinci emac
1134dc02badaSHeiko Schocher
1135dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1136dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1137dc02badaSHeiko Schocher
1138b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1139b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1140b3dbf4a5SMacpaul Lin
1141b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1142b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1143b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1144b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1145b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1146b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1147b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1148b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1149b3dbf4a5SMacpaul Lin
1150c2fff331SMike Rapoport		CONFIG_SMC911X
1151557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1152557b377dSJens Gehrlein
1153c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1154557b377dSJens Gehrlein			Define this to hold the physical address
1155557b377dSJens Gehrlein			of the device (I/O space)
1156557b377dSJens Gehrlein
1157c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1158557b377dSJens Gehrlein			Define this if data bus is 32 bits
1159557b377dSJens Gehrlein
1160c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1161557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1162557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1163c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1164557b377dSJens Gehrlein
11653d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11663d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11673d0075faSYoshihiro Shimoda
11683d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11693d0075faSYoshihiro Shimoda			Define the number of ports to be used
11703d0075faSYoshihiro Shimoda
11713d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11723d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11733d0075faSYoshihiro Shimoda
117468260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
117568260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
117668260aabSYoshihiro Shimoda
1177b2f97cf2SHeiko Schocher- PWM Support:
1178b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
11795052e819SRobert P. J. Day		Support for PWM module on the imx6.
1180b2f97cf2SHeiko Schocher
11815e124724SVadim Bendebury- TPM Support:
118290899cc0SChe-liang Chiou		CONFIG_TPM
118390899cc0SChe-liang Chiou		Support TPM devices.
118490899cc0SChe-liang Chiou
11850766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
11860766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
11871b393db5STom Wai-Hong Tam		per system is supported at this time.
11881b393db5STom Wai-Hong Tam
11891b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
11901b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
11911b393db5STom Wai-Hong Tam
11923aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
11933aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
11943aa74088SChristophe Ricard
11953aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
11963aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
11973aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
11983aa74088SChristophe Ricard
1199b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1200b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1201b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1202b75fdc11SChristophe Ricard
1203c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1204c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1205c01939c7SDirk Eibach
120690899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12075e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12085e124724SVadim Bendebury		per system is supported at this time.
12095e124724SVadim Bendebury
12105e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12115e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12125e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12135e124724SVadim Bendebury			0xfed40000.
12145e124724SVadim Bendebury
1215be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1216be6c1529SReinhard Pfau		Add tpm monitor functions.
1217be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1218be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1219be6c1529SReinhard Pfau
1220be6c1529SReinhard Pfau		CONFIG_TPM
1221be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1222be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1223be6c1529SReinhard Pfau		Requires support for a TPM device.
1224be6c1529SReinhard Pfau
1225be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1226be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1227be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1228be6c1529SReinhard Pfau
1229c609719bSwdenk- USB Support:
1230c609719bSwdenk		At the moment only the UHCI host controller is
1231*064b55cfSHeiko Schocher		supported (PIP405, MIP405); define
1232c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1233c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
123430d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1235c609719bSwdenk		storage devices.
1236c609719bSwdenk		Note:
1237c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1238c609719bSwdenk		(TEAC FD-05PUB).
12394d13cbadSwdenk
12409ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12419ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12429ab4ce22SSimon Glass
12436e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
12446e9e0626SOleksandr Tymoshenko		HW module registers.
12456e9e0626SOleksandr Tymoshenko
124616c8d5e7SWolfgang Denk- USB Device:
124716c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
124816c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
124916c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
125011ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
125116c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
125216c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
125316c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
125416c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
125516c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
125616c8d5e7SWolfgang Denk		a Linux host by
125716c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
125816c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
125916c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
126016c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
126116c8d5e7SWolfgang Denk
126216c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
126316c8d5e7SWolfgang Denk			Define this to build a UDC device
126416c8d5e7SWolfgang Denk
126516c8d5e7SWolfgang Denk			CONFIG_USB_TTY
126616c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
126716c8d5e7SWolfgang Denk			talk to the UDC device
126816c8d5e7SWolfgang Denk
1269f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1270f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1271f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1272f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1273f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1274f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1275f9da0f89SVipin KUMAR			speed.
1276f9da0f89SVipin KUMAR
12776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
127816c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
127916c8d5e7SWolfgang Denk			be set to usbtty.
128016c8d5e7SWolfgang Denk
128116c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
128216c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
128316c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
128416c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
128516c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
128616c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
128716c8d5e7SWolfgang Denk
128816c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
128916c8d5e7SWolfgang Denk			Define this string as the name of your company for
129016c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
129116c8d5e7SWolfgang Denk
129216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
129316c8d5e7SWolfgang Denk			Define this string as the name of your product
129416c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
129516c8d5e7SWolfgang Denk
129616c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
129716c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
129816c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
129916c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
130016c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
130116c8d5e7SWolfgang Denk
130216c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
130316c8d5e7SWolfgang Denk			Define this as the unique Product ID
130416c8d5e7SWolfgang Denk			for your device
130516c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1306c609719bSwdenk
1307d70a560fSIgor Grinberg- ULPI Layer Support:
1308d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1309d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1310d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1311d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1312d70a560fSIgor Grinberg		viewport is supported.
1313d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1314d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13156d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13166d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13176d365ea0SLucas Stach		the appropriate value in Hz.
1318c609719bSwdenk
1319c609719bSwdenk- MMC Support:
1320c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1321c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1322c609719bSwdenk		accessed from the boot prompt by mapping the device
1323c609719bSwdenk		to physical memory similar to flash. Command line is
1324602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1325602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1326c609719bSwdenk
1327afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1328afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1329afb35666SYoshihiro Shimoda
1330afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1331afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1332afb35666SYoshihiro Shimoda
1333afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1334afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1335afb35666SYoshihiro Shimoda
13361fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
13371fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
13381fd93c6eSPierre Aubert
13391fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
13401fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
13411fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
13421fd93c6eSPierre Aubert
1343b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
134401acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1345b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1346b3ba6e94STom Rini
1347b3ba6e94STom Rini		CONFIG_CMD_DFU
1348b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1349b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1350b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1351b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1352b3ba6e94STom Rini
1353b3ba6e94STom Rini		CONFIG_DFU_MMC
1354b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1355b3ba6e94STom Rini
1356c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1357c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1358c6631764SPantelis Antoniou
1359a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1360a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1361a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1362a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1363a9479f04SAfzal Mohammed		one that would help mostly the developer.
1364a9479f04SAfzal Mohammed
1365e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1366e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1367e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1368e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1369e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1370e7e75c70SHeiko Schocher
1371ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1372ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1373ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1374ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1375ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1376ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1377ea2453d5SPantelis Antoniou
1378001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1379001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1380001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1381001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1382001a8319SHeiko Schocher
1383001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1384001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1385001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1386001a8319SHeiko Schocher		sending again an USB request to the device.
1387001a8319SHeiko Schocher
13883aab70afSSebastian Siewior- USB Device Android Fastboot support:
138917da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
139017da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
139117da3c0cSPaul Kocialkowski
13923aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
13933aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
13943aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
13953aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
13963aab70afSSebastian Siewior		used on Android devices.
13973aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
13983aab70afSSebastian Siewior
13993aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
14003aab70afSSebastian Siewior		This enables support for booting images which use the Android
14013aab70afSSebastian Siewior		image format header.
14023aab70afSSebastian Siewior
1403a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
14043aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
14053aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
14063aab70afSSebastian Siewior		downloaded images.
14073aab70afSSebastian Siewior
1408a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
14093aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
14103aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
14113aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
14123aab70afSSebastian Siewior
1413d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1414d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1415d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1416d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1417d1b5ed07SSteve Rae
1418d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1419d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1420d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1421d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1422d1b5ed07SSteve Rae
14230ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
14240ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
14250ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
14260ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
14270ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
14280ff7e585SSteve Rae		This occurs when the specified "partition name" on the
14290ff7e585SSteve Rae		"fastboot flash" command line matches this value.
14306f6c8630SPetr Kulhavy		The default is "gpt" if undefined.
14310ff7e585SSteve Rae
1432b6dd69a4SPetr Kulhavy		CONFIG_FASTBOOT_MBR_NAME
1433b6dd69a4SPetr Kulhavy		The fastboot "flash" command supports writing the downloaded
1434b6dd69a4SPetr Kulhavy		image to DOS MBR.
1435b6dd69a4SPetr Kulhavy		This occurs when the "partition name" specified on the
1436b6dd69a4SPetr Kulhavy		"fastboot flash" command line matches this value.
1437b6dd69a4SPetr Kulhavy		If not defined the default value "mbr" is used.
1438b6dd69a4SPetr Kulhavy
14396705d81eSwdenk- Journaling Flash filesystem support:
1440b2482dffSSimon Glass		CONFIG_JFFS2_NAND
14416705d81eSwdenk		Define these for a default partition on a NAND device
14426705d81eSwdenk
14436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14456705d81eSwdenk		Define these for a default partition on a NOR device
14466705d81eSwdenk
1447c609719bSwdenk- Keyboard Support:
144839f615edSSimon Glass		See Kconfig help for available keyboard drivers.
144939f615edSSimon Glass
145039f615edSSimon Glass		CONFIG_KEYBOARD
145139f615edSSimon Glass
145239f615edSSimon Glass		Define this to enable a custom keyboard support.
145339f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
145439f615edSSimon Glass		defined in your board-specific files. This option is deprecated
145539f615edSSimon Glass		and is only used by novena. For new boards, use driver model
145639f615edSSimon Glass		instead.
1457c609719bSwdenk
1458c609719bSwdenk- Video support:
14597d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
14607d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
14617d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
14627d3053fbSTimur Tabi		support, and should also define these other macros:
14637d3053fbSTimur Tabi
14647d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
14657d3053fbSTimur Tabi			CONFIG_VIDEO
14667d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14677d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14687d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14697d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14707d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14717d3053fbSTimur Tabi
1472ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1473ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
14748eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1475ba8e76bdSTimur Tabi		description of this variable.
14767d3053fbSTimur Tabi
1477c609719bSwdenk- LCD Support:	CONFIG_LCD
1478c609719bSwdenk
1479c609719bSwdenk		Define this to enable LCD support (for output to LCD
1480c609719bSwdenk		display); also select one of the supported displays
1481c609719bSwdenk		by defining one of these:
1482c609719bSwdenk
148339cf4804SStelian Pop		CONFIG_ATMEL_LCD:
148439cf4804SStelian Pop
148539cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
148639cf4804SStelian Pop
1487fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1488c609719bSwdenk
1489fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1490c609719bSwdenk
1491fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1492c609719bSwdenk
1493fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1494fd3103bbSwdenk			Active, color, single scan.
1495fd3103bbSwdenk
1496fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1497fd3103bbSwdenk
1498fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1499c609719bSwdenk			Active, color, single scan.
1500c609719bSwdenk
1501c609719bSwdenk		CONFIG_SHARP_16x9
1502c609719bSwdenk
1503c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1504c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1505c609719bSwdenk
1506c609719bSwdenk		CONFIG_SHARP_LQ64D341
1507c609719bSwdenk
1508c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1509c609719bSwdenk			Active, color, single scan.
1510c609719bSwdenk
1511c609719bSwdenk		CONFIG_HLD1045
1512c609719bSwdenk
1513c609719bSwdenk			HLD1045 display, 640x480.
1514c609719bSwdenk			Active, color, single scan.
1515c609719bSwdenk
1516c609719bSwdenk		CONFIG_OPTREX_BW
1517c609719bSwdenk
1518c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1519c609719bSwdenk			or
1520c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1521c609719bSwdenk			or
1522c609719bSwdenk			Hitachi	 SP14Q002
1523c609719bSwdenk
1524c609719bSwdenk			320x240. Black & white.
1525c609719bSwdenk
1526676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1527676d319eSSimon Glass
1528b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1529676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1530676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1531676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1532676d319eSSimon Glass		a per-section basis.
1533676d319eSSimon Glass
1534676d319eSSimon Glass
1535604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1536604c7d4aSHannes Petermaier
1537604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1538604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1539604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1540604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1541604c7d4aSHannes Petermaier		printed out.
1542604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1543604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1544604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1545604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1546604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1547604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1548604c7d4aSHannes Petermaier		1 = 90 degree rotation
1549604c7d4aSHannes Petermaier		2 = 180 degree rotation
1550604c7d4aSHannes Petermaier		3 = 270 degree rotation
1551604c7d4aSHannes Petermaier
1552604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1553604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1554604c7d4aSHannes Petermaier
155545d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
155645d7f525STom Wai-Hong Tam
155745d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
155845d7f525STom Wai-Hong Tam
1559735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1560735987c5STom Wai-Hong Tam
1561735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1562735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1563735987c5STom Wai-Hong Tam
15647152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1565d791b1dcSwdenk
1566d791b1dcSwdenk		If this option is set, the environment is checked for
1567d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1568d791b1dcSwdenk		of logo, copyright and system information on the LCD
1569e94d2cd9Swdenk		is suppressed and the BMP image at the address
1570d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1571d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1572d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1573d791b1dcSwdenk		loaded very quickly after power-on.
1574d791b1dcSwdenk
1575c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1576c0880485SNikita Kiryanov
1577c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1578c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1579ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1580c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1581c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1582c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1583c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1584c0880485SNikita Kiryanov		there is no need to set this option.
1585c0880485SNikita Kiryanov
15861ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
15871ca298ceSMatthias Weisser
15881ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
15891ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
15901ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
15911ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
15921ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
15931ca298ceSMatthias Weisser		specify 'm' for centering the image.
15941ca298ceSMatthias Weisser
15951ca298ceSMatthias Weisser		Example:
15961ca298ceSMatthias Weisser		setenv splashpos m,m
15971ca298ceSMatthias Weisser			=> image at center of screen
15981ca298ceSMatthias Weisser
15991ca298ceSMatthias Weisser		setenv splashpos 30,20
16001ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16011ca298ceSMatthias Weisser
16021ca298ceSMatthias Weisser		setenv splashpos -10,m
16031ca298ceSMatthias Weisser			=> vertically centered image
16041ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16051ca298ceSMatthias Weisser
160698f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
160798f4a3dfSStefan Roese
160898f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
160998f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
161098f4a3dfSStefan Roese		splashscreen support or the bmp command.
161198f4a3dfSStefan Roese
1612d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1613d5011762SAnatolij Gustschin
1614d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1615d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1616d5011762SAnatolij Gustschin		bmp command.
1617d5011762SAnatolij Gustschin
1618c29fdfc1Swdenk- Compression support:
16198ef70478SKees Cook		CONFIG_GZIP
16208ef70478SKees Cook
16218ef70478SKees Cook		Enabled by default to support gzip compressed images.
16228ef70478SKees Cook
1623c29fdfc1Swdenk		CONFIG_BZIP2
1624c29fdfc1Swdenk
1625c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1626c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1627c29fdfc1Swdenk		compressed images are supported.
1628c29fdfc1Swdenk
1629c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
16306d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1631c29fdfc1Swdenk		be at least 4MB.
1632d791b1dcSwdenk
16338ef70478SKees Cook		CONFIG_LZO
16348ef70478SKees Cook
16358ef70478SKees Cook		If this option is set, support for LZO compressed images
16368ef70478SKees Cook		is included.
16378ef70478SKees Cook
163817ea1177Swdenk- MII/PHY support:
163917ea1177Swdenk		CONFIG_PHY_ADDR
164017ea1177Swdenk
164117ea1177Swdenk		The address of PHY on MII bus.
164217ea1177Swdenk
164317ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
164417ea1177Swdenk
164517ea1177Swdenk		The clock frequency of the MII bus
164617ea1177Swdenk
164717ea1177Swdenk		CONFIG_PHY_GIGE
164817ea1177Swdenk
164917ea1177Swdenk		If this option is set, support for speed/duplex
165011ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
165117ea1177Swdenk
165217ea1177Swdenk		CONFIG_PHY_RESET_DELAY
165317ea1177Swdenk
165417ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
165517ea1177Swdenk		reset before any MII register access is possible.
165617ea1177Swdenk		For such PHY, set this option to the usec delay
165717ea1177Swdenk		required. (minimum 300usec for LXT971A)
165817ea1177Swdenk
165917ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
166017ea1177Swdenk
166117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
166217ea1177Swdenk		command issued before MII status register can be read
166317ea1177Swdenk
1664c609719bSwdenk- IP address:
1665c609719bSwdenk		CONFIG_IPADDR
1666c609719bSwdenk
1667c609719bSwdenk		Define a default value for the IP address to use for
166811ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1669c609719bSwdenk		determined through e.g. bootp.
16701ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1671c609719bSwdenk
1672c609719bSwdenk- Server IP address:
1673c609719bSwdenk		CONFIG_SERVERIP
1674c609719bSwdenk
1675c609719bSwdenk		Defines a default value for the IP address of a TFTP
1676c609719bSwdenk		server to contact when using the "tftboot" command.
16771ebcd654SWolfgang Denk		(Environment variable "serverip")
1678c609719bSwdenk
167997cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
168097cfe861SRobin Getz
168197cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
168297cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
168397cfe861SRobin Getz
16841ebcd654SWolfgang Denk- Gateway IP address:
16851ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
16861ebcd654SWolfgang Denk
16871ebcd654SWolfgang Denk		Defines a default value for the IP address of the
16881ebcd654SWolfgang Denk		default router where packets to other networks are
16891ebcd654SWolfgang Denk		sent to.
16901ebcd654SWolfgang Denk		(Environment variable "gatewayip")
16911ebcd654SWolfgang Denk
16921ebcd654SWolfgang Denk- Subnet mask:
16931ebcd654SWolfgang Denk		CONFIG_NETMASK
16941ebcd654SWolfgang Denk
16951ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
16961ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
16971ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
16981ebcd654SWolfgang Denk		forwarded through a router.
16991ebcd654SWolfgang Denk		(Environment variable "netmask")
17001ebcd654SWolfgang Denk
170153a5c424SDavid Updegraff- Multicast TFTP Mode:
170253a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
170353a5c424SDavid Updegraff
170453a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
170553a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
170611ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
170753a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
170853a5c424SDavid Updegraff		multicast group.
170953a5c424SDavid Updegraff
1710c609719bSwdenk- BOOTP Recovery Mode:
1711c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1712c609719bSwdenk
1713c609719bSwdenk		If you have many targets in a network that try to
1714c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1715c609719bSwdenk		systems send out BOOTP requests at precisely the same
1716c609719bSwdenk		moment (which would happen for instance at recovery
1717c609719bSwdenk		from a power failure, when all systems will try to
1718c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1719c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1720c609719bSwdenk		inserted before sending out BOOTP requests. The
17216c33c785SWolfgang Denk		following delays are inserted then:
1722c609719bSwdenk
1723c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1724c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1725c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1726c609719bSwdenk		4th and following
1727c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1728c609719bSwdenk
172992ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
173092ac8accSThierry Reding
173192ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
173292ac8accSThierry Reding		server will copy the ID from client requests to responses and
173392ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
173492ac8accSThierry Reding		an incoming response. Some servers will check that addresses
173592ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
173692ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
173792ac8accSThierry Reding		respond. Network congestion may also influence the time it
173892ac8accSThierry Reding		takes for a response to make it back to the client. If that
173992ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
174092ac8accSThierry Reding		to allow earlier responses to still be accepted after these
174192ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
174292ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
174392ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
174492ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
174592ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
174692ac8accSThierry Reding
1747fe389a82Sstroese- DHCP Advanced Options:
17481fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
17491fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1750fe389a82Sstroese
17511fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
17521fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
17531fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
17541fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
17551fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
17561fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
17571fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
17581fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
17591fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
17601fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
17611fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
17621fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
17632c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1764fe389a82Sstroese
17655d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
17665d110f0aSWilson Callan		environment variable, not the BOOTP server.
1767fe389a82Sstroese
17682c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
17692c00e099SJoe Hershberger		after the configured retry count, the call will fail
17702c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
17712c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
17722c00e099SJoe Hershberger		is not available.
17732c00e099SJoe Hershberger
1774fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1775fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1776fe389a82Sstroese		than one DNS serverip is offered to the client.
1777fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1778fe389a82Sstroese		serverip will be stored in the additional environment
1779fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1780fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
17811fe80d79SJon Loeliger		is defined.
1782fe389a82Sstroese
1783fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1784fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1785fe389a82Sstroese		need the hostname of the DHCP requester.
17865d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
17871fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
17881fe80d79SJon Loeliger		option 12 to the DHCP server.
1789fe389a82Sstroese
1790d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1791d9a2f416SAras Vaichas
1792d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1793d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1794d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1795d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1796d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1797d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1798d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1799d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1800d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1801d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1802d9a2f416SAras Vaichas		this delay.
1803d9a2f416SAras Vaichas
1804d22c338eSJoe Hershberger - Link-local IP address negotiation:
1805d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1806d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1807d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1808d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1809d22c338eSJoe Hershberger
1810d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1811d22c338eSJoe Hershberger
1812a3d991bdSwdenk - CDP Options:
1813a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1814a3d991bdSwdenk
1815a3d991bdSwdenk		The device id used in CDP trigger frames.
1816a3d991bdSwdenk
1817a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1818a3d991bdSwdenk
1819a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1820a3d991bdSwdenk		of the device.
1821a3d991bdSwdenk
1822a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1823a3d991bdSwdenk
1824a3d991bdSwdenk		A printf format string which contains the ascii name of
1825a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
182611ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1827a3d991bdSwdenk
1828a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1829a3d991bdSwdenk
1830a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1831a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1832a3d991bdSwdenk
1833a3d991bdSwdenk		CONFIG_CDP_VERSION
1834a3d991bdSwdenk
1835a3d991bdSwdenk		An ascii string containing the version of the software.
1836a3d991bdSwdenk
1837a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1838a3d991bdSwdenk
1839a3d991bdSwdenk		An ascii string containing the name of the platform.
1840a3d991bdSwdenk
1841a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1842a3d991bdSwdenk
1843a3d991bdSwdenk		A 32bit integer sent on the trigger.
1844a3d991bdSwdenk
1845a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1846a3d991bdSwdenk
1847a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1848a3d991bdSwdenk		device in .1 of milliwatts.
1849a3d991bdSwdenk
1850a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1851a3d991bdSwdenk
1852a3d991bdSwdenk		A byte containing the id of the VLAN.
1853a3d991bdSwdenk
185479267eddSUri Mashiach- Status LED:	CONFIG_LED_STATUS
1855c609719bSwdenk
1856c609719bSwdenk		Several configurations allow to display the current
1857c609719bSwdenk		status using a LED. For instance, the LED will blink
1858c609719bSwdenk		fast while running U-Boot code, stop blinking as
1859c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1860c609719bSwdenk		start blinking slow once the Linux kernel is running
1861c609719bSwdenk		(supported by a status LED driver in the Linux
186279267eddSUri Mashiach		kernel). Defining CONFIG_LED_STATUS enables this
1863c609719bSwdenk		feature in U-Boot.
1864c609719bSwdenk
18651df7bbbaSIgor Grinberg		Additional options:
18661df7bbbaSIgor Grinberg
186779267eddSUri Mashiach		CONFIG_LED_STATUS_GPIO
18681df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
18691df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
187079267eddSUri Mashiach		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
18711df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
18721df7bbbaSIgor Grinberg
18739dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
18749dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
18759dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
18769dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
18779dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
18789dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
18799dfdcdfeSIgor Grinberg
18803f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1881c609719bSwdenk
18823f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
18833f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
18843f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
18853f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
18863f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
18873f4978c7SHeiko Schocher		interface.
18883f4978c7SHeiko Schocher
18893f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1890ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1891ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1892ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1893ea818dbbSHeiko Schocher		    for defining speed and slave address
1894ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1895ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1896ea818dbbSHeiko Schocher		    for defining speed and slave address
1897ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1898ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1899ea818dbbSHeiko Schocher		    for defining speed and slave address
1900ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1901ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1902ea818dbbSHeiko Schocher		    for defining speed and slave address
19033f4978c7SHeiko Schocher
190400f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
190500f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
190600f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
190700f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
190800f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
190900f792e0SHeiko Schocher		    bus.
191000f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
191100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
191200f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
191300f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
191400f792e0SHeiko Schocher		    second bus.
191500f792e0SHeiko Schocher
19161f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
19171f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
19181f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
19191f2ba722SSimon Glass		    100000 and the slave addr 0!
19201f2ba722SSimon Glass
1921880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
1922880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
1923880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1924880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1925880540deSDirk Eibach
1926fac96408Strem		- drivers/i2c/i2c_mxc.c
1927fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
192803544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
192903544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
193003544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
193103544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1932fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1933fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1934fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1935fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1936fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1937fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
193803544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
193903544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1940b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
1941fac96408Strem		for speed, and 0 for slave.
1942fac96408Strem
19431086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
19441086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
19451086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
19461086bfa9SNobuhiro Iwamatsu
19471086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
19481086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
19491086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
19501086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
19511086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
19521086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
19531086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
19541086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
19551086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
19561086bfa9SNobuhiro Iwamatsu
19572035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
19582035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
19592035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
19602035d77dSNobuhiro Iwamatsu
19612035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
19622035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
19632035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
19642035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
19652035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
19662035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
19672035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
19682035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
19692035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
19702035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
1971b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
19722035d77dSNobuhiro Iwamatsu
19736789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
19746789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
19756789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
19766789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
19776789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
19786789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
19796789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
19806789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
19816789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
19826789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
19836789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
19846789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
19856789e84eSHeiko Schocher
19860bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
19870bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
19880bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
19890bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
19900bdffe71SHeiko Schocher
1991e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
1992e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
1993e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
1994e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
1995e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
1996e717fc6dSNaveen Krishna Ch
1997b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
1998b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
1999b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2000b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2001b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2002b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2003b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2004b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2005b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2006b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2007b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2008b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2009b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2010b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2011071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2012071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2013071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2014071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2015071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2016071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2017071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2018071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2019071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2020b46226bdSDirk Eibach
20213f4978c7SHeiko Schocher		additional defines:
20223f4978c7SHeiko Schocher
20233f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2024945a18e6SSimon Glass		Hold the number of i2c buses you want to use.
20253f4978c7SHeiko Schocher
20263f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
20273f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
20283f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
20293f4978c7SHeiko Schocher		omit this define.
20303f4978c7SHeiko Schocher
20313f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
20323f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
20333f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
20343f4978c7SHeiko Schocher		define.
20353f4978c7SHeiko Schocher
20363f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2037b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
20383f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
20393f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
20403f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
20413f4978c7SHeiko Schocher
20423f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
20433f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
20443f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
20453f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
20463f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
20473f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
20483f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
20493f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
20503f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
20513f4978c7SHeiko Schocher					}
20523f4978c7SHeiko Schocher
20533f4978c7SHeiko Schocher		which defines
20543f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2055ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2056ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2057ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2058ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2059ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
20603f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2061ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2062ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
20633f4978c7SHeiko Schocher
20643f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
20653f4978c7SHeiko Schocher
2066ce3b5d69SSimon Glass- Legacy I2C Support:
2067ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2068b37c7e5eSwdenk		then the following macros need to be defined (examples are
2069b37c7e5eSwdenk		from include/configs/lwmon.h):
2070c609719bSwdenk
2071c609719bSwdenk		I2C_INIT
2072c609719bSwdenk
2073b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2074c609719bSwdenk		controller or configure ports.
2075c609719bSwdenk
2076b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2077b37c7e5eSwdenk
2078c609719bSwdenk		I2C_ACTIVE
2079c609719bSwdenk
2080c609719bSwdenk		The code necessary to make the I2C data line active
2081c609719bSwdenk		(driven).  If the data line is open collector, this
2082c609719bSwdenk		define can be null.
2083c609719bSwdenk
2084b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2085b37c7e5eSwdenk
2086c609719bSwdenk		I2C_TRISTATE
2087c609719bSwdenk
2088c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2089c609719bSwdenk		(inactive).  If the data line is open collector, this
2090c609719bSwdenk		define can be null.
2091c609719bSwdenk
2092b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2093b37c7e5eSwdenk
2094c609719bSwdenk		I2C_READ
2095c609719bSwdenk
2096472d5460SYork Sun		Code that returns true if the I2C data line is high,
2097472d5460SYork Sun		false if it is low.
2098c609719bSwdenk
2099b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2100b37c7e5eSwdenk
2101c609719bSwdenk		I2C_SDA(bit)
2102c609719bSwdenk
2103472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2104472d5460SYork Sun		is false, it clears it (low).
2105c609719bSwdenk
2106b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2107b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2108b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2109b37c7e5eSwdenk
2110c609719bSwdenk		I2C_SCL(bit)
2111c609719bSwdenk
2112472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2113472d5460SYork Sun		is false, it clears it (low).
2114c609719bSwdenk
2115b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2116b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2117b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2118b37c7e5eSwdenk
2119c609719bSwdenk		I2C_DELAY
2120c609719bSwdenk
2121c609719bSwdenk		This delay is invoked four times per clock cycle so this
2122c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2123b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2124b37c7e5eSwdenk		like:
2125b37c7e5eSwdenk
2126b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2127c609719bSwdenk
2128793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2129793b5726SMike Frysinger
2130793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2131793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2132793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2133793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2134793b5726SMike Frysinger
2135793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2136793b5726SMike Frysinger		the generic GPIO functions.
2137793b5726SMike Frysinger
21386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
213947cd00faSwdenk
214047cd00faSwdenk		When a board is reset during an i2c bus transfer
214147cd00faSwdenk		chips might think that the current transfer is still
214247cd00faSwdenk		in progress. On some boards it is possible to access
214347cd00faSwdenk		the i2c SCLK line directly, either by using the
214447cd00faSwdenk		processor pin as a GPIO or by having a second pin
214547cd00faSwdenk		connected to the bus. If this option is defined a
214647cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
214747cd00faSwdenk		is run early in the boot sequence.
214847cd00faSwdenk
2149bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2150bb99ad6dSBen Warren
2151bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2152bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2153bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2154bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2155bb99ad6dSBen Warren
21566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2157bb99ad6dSBen Warren
2158bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
21590f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
21600f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
21610f89c54bSPeter Tyser		a 1D array of device addresses
2162bb99ad6dSBen Warren
2163bb99ad6dSBen Warren		e.g.
2164bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
21656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2166bb99ad6dSBen Warren
2167bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2168bb99ad6dSBen Warren
2169bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
2170945a18e6SSimon Glass			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2171bb99ad6dSBen Warren
2172bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2173bb99ad6dSBen Warren
21746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2175be5e6181STimur Tabi
2176be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2177be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2178be5e6181STimur Tabi
21796d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
21800dc018ecSStefan Roese
21810dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
21820dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
21830dc018ecSStefan Roese
21842ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
21852ac6985aSAndrew Dyer
21862ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
21872ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
21882ac6985aSAndrew Dyer		between writing the address pointer and reading the
21892ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
21902ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
21912ac6985aSAndrew Dyer		devices can use either method, but some require one or
21922ac6985aSAndrew Dyer		the other.
2193be5e6181STimur Tabi
2194c609719bSwdenk- SPI Support:	CONFIG_SPI
2195c609719bSwdenk
2196c609719bSwdenk		Enables SPI driver (so far only tested with
2197c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2198c609719bSwdenk		D/As on the SACSng board)
2199c609719bSwdenk
22006639562eSYoshihiro Shimoda		CONFIG_SH_SPI
22016639562eSYoshihiro Shimoda
22026639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
22036639562eSYoshihiro Shimoda		only SH7757 is supported.
22046639562eSYoshihiro Shimoda
2205c609719bSwdenk		CONFIG_SOFT_SPI
2206c609719bSwdenk
2207c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2208c609719bSwdenk		using hardware support. This is a general purpose
2209c609719bSwdenk		driver that only requires three general I/O port pins
2210c609719bSwdenk		(two outputs, one input) to function. If this is
2211c609719bSwdenk		defined, the board configuration must define several
2212c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2213c609719bSwdenk		an example, see include/configs/sacsng.h.
2214c609719bSwdenk
221504a9e118SBen Warren		CONFIG_HARD_SPI
221604a9e118SBen Warren
221704a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
221804a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
221904a9e118SBen Warren		must define a list of chip-select function pointers.
222004a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
222104a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
222204a9e118SBen Warren
222338254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
222438254f45SGuennadi Liakhovetski
222538254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
22262e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
222738254f45SGuennadi Liakhovetski
2228f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2229f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2230f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2231f659b573SHeiko Schocher
22320133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
22330133502eSMatthias Fuchs
22340133502eSMatthias Fuchs		Enables FPGA subsystem.
22350133502eSMatthias Fuchs
22360133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
22370133502eSMatthias Fuchs
22380133502eSMatthias Fuchs		Enables support for specific chip vendors.
22390133502eSMatthias Fuchs		(ALTERA, XILINX)
22400133502eSMatthias Fuchs
22410133502eSMatthias Fuchs		CONFIG_FPGA_<family>
22420133502eSMatthias Fuchs
22430133502eSMatthias Fuchs		Enables support for FPGA family.
22440133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
22450133502eSMatthias Fuchs
22460133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2247c609719bSwdenk
2248c609719bSwdenk		Specify the number of FPGA devices to support.
2249c609719bSwdenk
22506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2251c609719bSwdenk
2252c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2253c609719bSwdenk
22546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2255c609719bSwdenk
2256c609719bSwdenk		Enable checks on FPGA configuration interface busy
2257c609719bSwdenk		status by the configuration function. This option
2258c609719bSwdenk		will require a board or device specific function to
2259c609719bSwdenk		be written.
2260c609719bSwdenk
2261c609719bSwdenk		CONFIG_FPGA_DELAY
2262c609719bSwdenk
2263c609719bSwdenk		If defined, a function that provides delays in the FPGA
2264c609719bSwdenk		configuration driver.
2265c609719bSwdenk
22666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2267c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2268c609719bSwdenk
22696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2270c609719bSwdenk
2271c609719bSwdenk		Check for configuration errors during FPGA bitfile
2272c609719bSwdenk		loading. For example, abort during Virtex II
2273c609719bSwdenk		configuration if the INIT_B line goes low (which
2274c609719bSwdenk		indicated a CRC error).
2275c609719bSwdenk
22766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2277c609719bSwdenk
2278b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2279b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2280c609719bSwdenk		FPGA configuration sequence. The default time is 500
228111ccc33fSMarcel Ziswiler		ms.
2282c609719bSwdenk
22836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2284c609719bSwdenk
2285b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
228611ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2287c609719bSwdenk
22886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2289c609719bSwdenk
2290c609719bSwdenk		Time to wait after FPGA configuration. The default is
229111ccc33fSMarcel Ziswiler		200 ms.
2292c609719bSwdenk
2293c609719bSwdenk- Configuration Management:
2294b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2295b2b8a696SStefan Roese
2296b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2297b2b8a696SStefan Roese		with a special header) as build targets. By defining
2298b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2299b2b8a696SStefan Roese		special image will be automatically built upon calling
23006de80f21SSimon Glass		make / buildman.
2301b2b8a696SStefan Roese
2302c609719bSwdenk		CONFIG_IDENT_STRING
2303c609719bSwdenk
2304c609719bSwdenk		If defined, this string will be added to the U-Boot
2305c609719bSwdenk		version information (U_BOOT_VERSION)
2306c609719bSwdenk
2307c609719bSwdenk- Vendor Parameter Protection:
2308c609719bSwdenk
2309c609719bSwdenk		U-Boot considers the values of the environment
2310c609719bSwdenk		variables "serial#" (Board Serial Number) and
23117152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2312c609719bSwdenk		are set once by the board vendor / manufacturer, and
2313c609719bSwdenk		protects these variables from casual modification by
2314c609719bSwdenk		the user. Once set, these variables are read-only,
2315c609719bSwdenk		and write or delete attempts are rejected. You can
231611ccc33fSMarcel Ziswiler		change this behaviour:
2317c609719bSwdenk
2318c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2319c609719bSwdenk		file, the write protection for vendor parameters is
232047cd00faSwdenk		completely disabled. Anybody can change or delete
2321c609719bSwdenk		these parameters.
2322c609719bSwdenk
232392ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
232492ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
232511ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2326c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2327c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2328c609719bSwdenk		read-only.]
2329c609719bSwdenk
23302598090bSJoe Hershberger		The same can be accomplished in a more flexible way
23312598090bSJoe Hershberger		for any variable by configuring the type of access
23322598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
23332598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
23342598090bSJoe Hershberger
2335c609719bSwdenk- Protected RAM:
2336c609719bSwdenk		CONFIG_PRAM
2337c609719bSwdenk
2338c609719bSwdenk		Define this variable to enable the reservation of
2339c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2340c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2341c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2342c609719bSwdenk		this default value by defining an environment
2343c609719bSwdenk		variable "pram" to the number of kB you want to
2344c609719bSwdenk		reserve. Note that the board info structure will
2345c609719bSwdenk		still show the full amount of RAM. If pRAM is
2346c609719bSwdenk		reserved, a new environment variable "mem" will
2347c609719bSwdenk		automatically be defined to hold the amount of
2348c609719bSwdenk		remaining RAM in a form that can be passed as boot
2349c609719bSwdenk		argument to Linux, for instance like that:
2350c609719bSwdenk
2351fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2352c609719bSwdenk			saveenv
2353c609719bSwdenk
2354c609719bSwdenk		This way you can tell Linux not to use this memory,
2355c609719bSwdenk		either, which results in a memory region that will
2356c609719bSwdenk		not be affected by reboots.
2357c609719bSwdenk
2358c609719bSwdenk		*WARNING* If your board configuration uses automatic
2359c609719bSwdenk		detection of the RAM size, you must make sure that
2360c609719bSwdenk		this memory test is non-destructive. So far, the
2361c609719bSwdenk		following board configurations are known to be
2362c609719bSwdenk		"pRAM-clean":
2363c609719bSwdenk
23645b8e76c3SHeiko Schocher			IVMS8, IVML24, SPD8xx,
23651b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
23662eb48ff7SHeiko Schocher			FLAGADM
2367c609719bSwdenk
236840fef049SGabe Black- Access to physical memory region (> 4GB)
236940fef049SGabe Black		Some basic support is provided for operations on memory not
237040fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
237140fef049SGabe Black		support access to more than 4GB of memory on 32-bit
237240fef049SGabe Black		machines using physical address extension or similar.
237340fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
237440fef049SGabe Black		currently only supports clearing the memory.
237540fef049SGabe Black
2376c609719bSwdenk- Error Recovery:
2377c609719bSwdenk		CONFIG_PANIC_HANG
2378c609719bSwdenk
2379c609719bSwdenk		Define this variable to stop the system in case of a
2380c609719bSwdenk		fatal error, so that you have to reset it manually.
2381c609719bSwdenk		This is probably NOT a good idea for an embedded
238211ccc33fSMarcel Ziswiler		system where you want the system to reboot
2383c609719bSwdenk		automatically as fast as possible, but it may be
2384c609719bSwdenk		useful during development since you can try to debug
2385c609719bSwdenk		the conditions that lead to the situation.
2386c609719bSwdenk
2387c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2388c609719bSwdenk
2389c609719bSwdenk		This variable defines the number of retries for
2390c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2391c609719bSwdenk		before giving up the operation. If not defined, a
2392c609719bSwdenk		default value of 5 is used.
2393c609719bSwdenk
239440cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
239540cb90eeSGuennadi Liakhovetski
239640cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
239740cb90eeSGuennadi Liakhovetski
239848a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
239948a3e999STetsuyuki Kobayashi
240048a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
240148a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
240248a3e999STetsuyuki Kobayashi		try longer timeout such as
240348a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
240448a3e999STetsuyuki Kobayashi
2405c609719bSwdenk- Command Interpreter:
24068078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
240704a85b3bSwdenk
240804a85b3bSwdenk		Enable auto completion of commands using TAB.
240904a85b3bSwdenk
24106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2411c609719bSwdenk
2412c609719bSwdenk		This defines the secondary prompt string, which is
2413c609719bSwdenk		printed when the command interpreter needs more input
2414c609719bSwdenk		to complete a command. Usually "> ".
2415c609719bSwdenk
2416c609719bSwdenk	Note:
2417c609719bSwdenk
2418c609719bSwdenk		In the current implementation, the local variables
2419c609719bSwdenk		space and global environment variables space are
2420c609719bSwdenk		separated. Local variables are those you define by
24213b57fe0aSwdenk		simply typing `name=value'. To access a local
2422c609719bSwdenk		variable later on, you have write `$name' or
24233b57fe0aSwdenk		`${name}'; to execute the contents of a variable
24243b57fe0aSwdenk		directly type `$name' at the command prompt.
2425c609719bSwdenk
2426c609719bSwdenk		Global environment variables are those you use
2427c609719bSwdenk		setenv/printenv to work with. To run a command stored
2428c609719bSwdenk		in such a variable, you need to use the run command,
2429c609719bSwdenk		and you must not use the '$' sign to access them.
2430c609719bSwdenk
2431c609719bSwdenk		To store commands and special characters in a
2432c609719bSwdenk		variable, please use double quotation marks
2433c609719bSwdenk		surrounding the whole text of the variable, instead
2434c609719bSwdenk		of the backslashes before semicolons and special
2435c609719bSwdenk		symbols.
2436c609719bSwdenk
2437b445bbb4SJeremiah Mahler- Command Line Editing and History:
2438aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2439aa0c71acSWolfgang Denk
244011ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2441aa0c71acSWolfgang Denk		command line input operations
2442aa0c71acSWolfgang Denk
2443f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2444f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2445f3b267b3SMarek Vasut
2446f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2447f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2448f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2449f3b267b3SMarek Vasut		and PS2.
2450f3b267b3SMarek Vasut
2451a8c7c708Swdenk- Default Environment:
2452c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2453c609719bSwdenk
2454c609719bSwdenk		Define this to contain any number of null terminated
2455c609719bSwdenk		strings (variable = value pairs) that will be part of
24567152b1d0Swdenk		the default environment compiled into the boot image.
24572262cfeeSwdenk
2458c609719bSwdenk		For example, place something like this in your
2459c609719bSwdenk		board's config file:
2460c609719bSwdenk
2461c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2462c609719bSwdenk			"myvar1=value1\0" \
2463c609719bSwdenk			"myvar2=value2\0"
2464c609719bSwdenk
2465c609719bSwdenk		Warning: This method is based on knowledge about the
2466c609719bSwdenk		internal format how the environment is stored by the
24672262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2468c609719bSwdenk		interface! Although it is unlikely that this format
24697152b1d0Swdenk		will change soon, there is no guarantee either.
2470c609719bSwdenk		You better know what you are doing here.
2471c609719bSwdenk
2472c609719bSwdenk		Note: overly (ab)use of the default environment is
2473c609719bSwdenk		discouraged. Make sure to check other ways to preset
247474de7aefSWolfgang Denk		the environment like the "source" command or the
2475c609719bSwdenk		boot command first.
2476c609719bSwdenk
24775e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
24785e724ca2SStephen Warren
24795e724ca2SStephen Warren		Define this in order to add variables describing the
24805e724ca2SStephen Warren		U-Boot build configuration to the default environment.
24815e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
24825e724ca2SStephen Warren
24835e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
24845e724ca2SStephen Warren
24855e724ca2SStephen Warren		- CONFIG_SYS_ARCH
24865e724ca2SStephen Warren		- CONFIG_SYS_CPU
24875e724ca2SStephen Warren		- CONFIG_SYS_BOARD
24885e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
24895e724ca2SStephen Warren		- CONFIG_SYS_SOC
24905e724ca2SStephen Warren
24917e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
24927e27f89fSTom Rini
24937e27f89fSTom Rini		Define this in order to add variables describing certain
24947e27f89fSTom Rini		run-time determined information about the hardware to the
24957e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
24967e27f89fSTom Rini
249706fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
249806fd8538SSimon Glass
249906fd8538SSimon Glass		Normally the environment is loaded when the board is
2500b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
250106fd8538SSimon Glass		that so that the environment is not available until
250206fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
250306fd8538SSimon Glass		this is instead controlled by the value of
250406fd8538SSimon Glass		/config/load-environment.
250506fd8538SSimon Glass
2506a8c7c708Swdenk- DataFlash Support:
25072abbe075Swdenk		CONFIG_HAS_DATAFLASH
25082abbe075Swdenk
25092abbe075Swdenk		Defining this option enables DataFlash features and
25102abbe075Swdenk		allows to read/write in Dataflash via the standard
25112abbe075Swdenk		commands cp, md...
25122abbe075Swdenk
2513f61ec45eSEric Nelson- Serial Flash support
2514f61ec45eSEric Nelson		CONFIG_CMD_SF
2515f61ec45eSEric Nelson
2516f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2517f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2518f61ec45eSEric Nelson
2519f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2520f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2521f61ec45eSEric Nelson		commands.
2522f61ec45eSEric Nelson
2523f61ec45eSEric Nelson		The following defaults may be provided by the platform
2524f61ec45eSEric Nelson		to handle the common case when only a single serial
2525f61ec45eSEric Nelson		flash is present on the system.
2526f61ec45eSEric Nelson
2527f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2528f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2529f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2530f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2531f61ec45eSEric Nelson
253224007273SSimon Glass		CONFIG_CMD_SF_TEST
253324007273SSimon Glass
253424007273SSimon Glass		Define this option to include a destructive SPI flash
253524007273SSimon Glass		test ('sf test').
253624007273SSimon Glass
2537b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2538b902e07cSJagannadha Sutradharudu Teki
2539b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2540b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2541b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
2542b902e07cSJagannadha Sutradharudu Teki
25433f85ce27Swdenk- SystemACE Support:
25443f85ce27Swdenk		CONFIG_SYSTEMACE
25453f85ce27Swdenk
25463f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
25473f85ce27Swdenk		chips attached via some sort of local bus. The address
254811ccc33fSMarcel Ziswiler		of the chip must also be defined in the
25496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
25503f85ce27Swdenk
25513f85ce27Swdenk		#define CONFIG_SYSTEMACE
25526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
25533f85ce27Swdenk
25543f85ce27Swdenk		When SystemACE support is added, the "ace" device type
25553f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
25563f85ce27Swdenk
2557ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2558ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2559ecb0ccd9SWolfgang Denk
256028cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2561ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
256228cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2563ecb0ccd9SWolfgang Denk		number generator is used.
2564ecb0ccd9SWolfgang Denk
256528cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
256628cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
256728cb9375SWolfgang Denk		defined, the normal port 69 is used.
256828cb9375SWolfgang Denk
256928cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2570ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2571ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2572ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2573ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2574ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2575ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2576ecb0ccd9SWolfgang Denk
25779e50c406SHeiko Schocher- bootcount support:
25789e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
25799e50c406SHeiko Schocher
25809e50c406SHeiko Schocher		This enables the bootcounter support, see:
25819e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
25829e50c406SHeiko Schocher
25839e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
25849e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
25859e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
25869e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
25879e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
25889e50c406SHeiko Schocher		enable support for the bootcounter in RAM
25899e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
25909e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
25919e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
25929e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
25939e50c406SHeiko Schocher						    the bootcounter.
25949e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
259519c402afSSimon Glass
2596a8c7c708Swdenk- Show boot progress:
2597c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2598c609719bSwdenk
2599c609719bSwdenk		Defining this option allows to add some board-
2600c609719bSwdenk		specific code (calling a user-provided function
2601c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2602c609719bSwdenk		the system's boot progress on some display (for
2603c609719bSwdenk		example, some LED's) on your board. At the moment,
2604c609719bSwdenk		the following checkpoints are implemented:
2605c609719bSwdenk
260694fd1316SSimon Glass
26071372cce2SMarian BalakowiczLegacy uImage format:
26081372cce2SMarian Balakowicz
2609c609719bSwdenk  Arg	Where			When
2610c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2611c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2612c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2613c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2614c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2615c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2616c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2617c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2618c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
26191372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2620c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2621c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2622c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2623c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
26241372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2625c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
26261372cce2SMarian Balakowicz
26271372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
26281372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
26291372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
26301372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
26311372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
26321372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
26331372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
263411ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
26351372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
26361372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
26371372cce2SMarian Balakowicz
2638ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2639c609719bSwdenk
2640a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
264163e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
264263e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
264363e73c9aSwdenk
2644566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2645566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2646566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2647566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2648566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2649566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2650566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2651566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2652566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2653566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2654566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2655566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2656566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2657566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2658566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2659566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2660566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2661566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2662566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2663566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2664566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2665566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2666566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2667566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2668566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2669566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2670566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2671566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2672566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2673566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2674566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2675566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2676566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2677566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2678566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2679566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2680566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2681566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2682566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2683566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2684566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2685566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2686566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2687566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2688566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2689566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2690566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2691c609719bSwdenk
2692566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2693c609719bSwdenk
2694566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2695566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2696566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2697206c60cbSwdenk
2698566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2699bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
2700bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
2701bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
2702566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2703566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
270474de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
270574de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2706566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2707c609719bSwdenk
27081372cce2SMarian BalakowiczFIT uImage format:
27091372cce2SMarian Balakowicz
27101372cce2SMarian Balakowicz  Arg	Where			When
27111372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
27121372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
27131372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
27141372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
27151372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
27161372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2717f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
27181372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
27191372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
27201372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
27211372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
27221372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
272311ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
272411ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
27251372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
27261372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
27271372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
27281372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
27291372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
27301372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
27311372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
27321372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
27331372cce2SMarian Balakowicz
27341372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
27351372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
27361372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
273711ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
27381372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
27391372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
27401372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
27411372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
27421372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
27431372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
27441372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
27451372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
27461372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
27471372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
27481372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
27491372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
27501372cce2SMarian Balakowicz
275111ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
27521372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
27531372cce2SMarian Balakowicz
275411ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
27551372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
27561372cce2SMarian Balakowicz
275711ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
27581372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
27591372cce2SMarian Balakowicz
276021d29f7fSHeiko Schocher- legacy image format:
276121d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
276221d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
276321d29f7fSHeiko Schocher
276421d29f7fSHeiko Schocher		Default:
276521d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
276621d29f7fSHeiko Schocher
276721d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
276821d29f7fSHeiko Schocher		disable the legacy image format
276921d29f7fSHeiko Schocher
277021d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
277121d29f7fSHeiko Schocher		enabled per default for backward compatibility.
277221d29f7fSHeiko Schocher
27734cf2609bSWolfgang Denk- Standalone program support:
27744cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
27754cf2609bSWolfgang Denk
27766feff899SWolfgang Denk		This option defines a board specific value for the
27776feff899SWolfgang Denk		address where standalone program gets loaded, thus
27786feff899SWolfgang Denk		overwriting the architecture dependent default
27794cf2609bSWolfgang Denk		settings.
27804cf2609bSWolfgang Denk
27814cf2609bSWolfgang Denk- Frame Buffer Address:
27824cf2609bSWolfgang Denk		CONFIG_FB_ADDR
27834cf2609bSWolfgang Denk
27844cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
278544a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
278644a53b57SWolfgang Denk		when using a graphics controller has separate video
278744a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
278844a53b57SWolfgang Denk		the given address instead of dynamically reserving it
278944a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
279044a53b57SWolfgang Denk		the memory for the frame buffer depending on the
279144a53b57SWolfgang Denk		configured panel size.
27924cf2609bSWolfgang Denk
27934cf2609bSWolfgang Denk		Please see board_init_f function.
27944cf2609bSWolfgang Denk
2795cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2796cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2797cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2798cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2799cccfc2abSDetlev Zundel
2800cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2801cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2802cccfc2abSDetlev Zundel
2803cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2804cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2805cccfc2abSDetlev Zundel
2806cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2807cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2808cccfc2abSDetlev Zundel
2809cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2810cccfc2abSDetlev Zundel
2811cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2812cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2813cccfc2abSDetlev Zundel
281470c219cdSJoe Hershberger- UBI support
281570c219cdSJoe Hershberger		CONFIG_CMD_UBI
281670c219cdSJoe Hershberger
281770c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
281870c219cdSJoe Hershberger		with the UBI flash translation layer
281970c219cdSJoe Hershberger
282070c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
282170c219cdSJoe Hershberger
2822147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2823147162daSJoe Hershberger
2824147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2825147162daSJoe Hershberger		warnings and errors enabled.
2826147162daSJoe Hershberger
2827ff94bc40SHeiko Schocher
2828ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
2829ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
2830ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
2831ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
2832ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
2833ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
2834ff94bc40SHeiko Schocher
2835ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
2836ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
2837ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
2838ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
2839ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
2840ff94bc40SHeiko Schocher
2841ff94bc40SHeiko Schocher		default: 4096
2842ff94bc40SHeiko Schocher
2843ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
2844ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
2845ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
2846ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
2847ff94bc40SHeiko Schocher		flash), this value is ignored.
2848ff94bc40SHeiko Schocher
2849ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
2850ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
2851ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
2852ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2853ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
2854ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
2855ff94bc40SHeiko Schocher
2856ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
2857ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
2858ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
2859ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
2860ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
2861ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
2862ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
2863ff94bc40SHeiko Schocher		partition.
2864ff94bc40SHeiko Schocher
2865ff94bc40SHeiko Schocher		default: 20
2866ff94bc40SHeiko Schocher
2867ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
2868ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
2869ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
2870ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
2871ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
2872ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
2873ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
2874ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
2875ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2876ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
2877ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
2878ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2879ff94bc40SHeiko Schocher
2880ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2881ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
2882ff94bc40SHeiko Schocher		without a fastmap.
2883ff94bc40SHeiko Schocher		default: 0
2884ff94bc40SHeiko Schocher
28850195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
28860195a7bbSHeiko Schocher		Enable UBI fastmap debug
28870195a7bbSHeiko Schocher		default: 0
28880195a7bbSHeiko Schocher
288970c219cdSJoe Hershberger- UBIFS support
289070c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
289170c219cdSJoe Hershberger
289270c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
289370c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
289470c219cdSJoe Hershberger
289570c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
289670c219cdSJoe Hershberger
2897147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2898147162daSJoe Hershberger
2899147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2900147162daSJoe Hershberger		warnings and errors enabled.
2901147162daSJoe Hershberger
29026a11cf48SDaniel Schwierzeck- SPL framework
29036a11cf48SDaniel Schwierzeck		CONFIG_SPL
29046a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
29056a11cf48SDaniel Schwierzeck
290695579793STom Rini		CONFIG_SPL_LDSCRIPT
290795579793STom Rini		LDSCRIPT for linking the SPL binary.
290895579793STom Rini
29096ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
29106ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
29116ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
29126ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
29138960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29146ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
29156ebc3461SAlbert ARIBAUD
291695579793STom Rini		CONFIG_SPL_MAX_SIZE
29176ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
29186ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
29196ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
29206ebc3461SAlbert ARIBAUD		not exceed it.
292195579793STom Rini
29226a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
29236a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
29246a11cf48SDaniel Schwierzeck
292594a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
292694a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
292794a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
292894a45bb1SScott Wood
292995579793STom Rini		CONFIG_SPL_BSS_START_ADDR
293095579793STom Rini		Link address for the BSS within the SPL binary.
293195579793STom Rini
293295579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
29336ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
29346ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
29356ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
29368960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29376ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
293895579793STom Rini
293995579793STom Rini		CONFIG_SPL_STACK
294095579793STom Rini		Adress of the start of the stack SPL will use
294195579793STom Rini
29428c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
29438c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
29448c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
29458c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
29468c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
29478c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
29488c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
29498c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
29508c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
29518c80eb3bSAlbert ARIBAUD \(3ADEV\)
295294a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
295394a45bb1SScott Wood		Adress of the start of the stack SPL will use after
295494a45bb1SScott Wood		relocation.  If unspecified, this is equal to
295594a45bb1SScott Wood		CONFIG_SPL_STACK.
295694a45bb1SScott Wood
295795579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
295895579793STom Rini		Starting address of the malloc pool used in SPL.
29599ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
29609ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
29619ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
296295579793STom Rini
296395579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
296495579793STom Rini		The size of the malloc pool used in SPL.
29656a11cf48SDaniel Schwierzeck
296647f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
296747f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
296847f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
296947f7bcaeSTom Rini		NAND loading of the Linux Kernel.
297047f7bcaeSTom Rini
29719607faf2STom Rini		CONFIG_SPL_OS_BOOT
29729607faf2STom Rini		Enable booting directly to an OS from SPL.
29739607faf2STom Rini		See also: doc/README.falcon
29749607faf2STom Rini
2975861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
2976861a86f4STom Rini		For ARM, enable an optional function to print more information
2977861a86f4STom Rini		about the running system.
2978861a86f4STom Rini
29794b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
29804b919725SScott Wood		Arch init code should be built for a very small image
29814b919725SScott Wood
2982b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
2983b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
2984b97300b6SPaul Kocialkowski		used in raw mode
2985b97300b6SPaul Kocialkowski
29862b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
29872b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
29882b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
29892b75b0adSPeter Korsgaard
29902b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
29912b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
29922b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
29932b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
29942b75b0adSPeter Korsgaard		(for falcon mode)
29952b75b0adSPeter Korsgaard
2996e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
2997e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
2998e2ccdf89SPaul Kocialkowski		used in fs mode
2999e2ccdf89SPaul Kocialkowski
3000fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3001fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3002fae81c72SGuillaume GARDET
3003fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
30047ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3005fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
30067ad2cc79SPeter Korsgaard
3007fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
30087ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3009fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
30107ad2cc79SPeter Korsgaard
301106f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
301206f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
301306f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
301406f60ae3SScott Wood		continuing (the hardware starts execution after just
301506f60ae3SScott Wood		loading the first page rather than the full 4K).
301606f60ae3SScott Wood
3017651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3018651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3019651fcf60SPrabhakar Kushwaha
30206f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
30216f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
30226f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
30236f2f01b9SScott Wood
30246f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
30256f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
30266f2f01b9SScott Wood
30276f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
30286f2f01b9SScott Wood		Include standard software ECC in the SPL
30296f2f01b9SScott Wood
303095579793STom Rini		CONFIG_SPL_NAND_SIMPLE
30317d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
30327d4b7955SScott Wood		expose the cmd_ctrl() interface.
303395579793STom Rini
30346f4e7d3cSThomas Gleixner		CONFIG_SPL_UBI
30356f4e7d3cSThomas Gleixner		Support for a lightweight UBI (fastmap) scanner and
30366f4e7d3cSThomas Gleixner		loader
30376f4e7d3cSThomas Gleixner
30380c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
30390c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
30400c3117b1SHeiko Schocher		if you need to save space.
30410c3117b1SHeiko Schocher
30427c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
30437c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
30447c8eea59SYing Zhang		SPL binary.
30457c8eea59SYing Zhang
304695579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
304795579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
304895579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
304995579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
305095579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
305195579793STom Rini		Defines the size and behavior of the NAND that SPL uses
30527d4b7955SScott Wood		to read U-Boot
305395579793STom Rini
3054fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3055fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3056fbe76ae4SPrabhakar Kushwaha
305795579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
30587d4b7955SScott Wood		Location in NAND to read U-Boot from
30597d4b7955SScott Wood
30607d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
30617d4b7955SScott Wood		Location in memory to load U-Boot to
30627d4b7955SScott Wood
30637d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
30647d4b7955SScott Wood		Size of image to load
306595579793STom Rini
306695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
30677d4b7955SScott Wood		Entry point in loaded image to jump to
306895579793STom Rini
306995579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
307095579793STom Rini		Define this if you need to first read the OOB and then the
3071b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
307295579793STom Rini
307395579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
307495579793STom Rini		Support for an OMAP3-specific set of functions to return the
307595579793STom Rini		ID and MFR of the first attached NAND chip, if present.
307695579793STom Rini
3077c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3078c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3079c57b953dSPavel Machek
308074752baaSScott Wood		CONFIG_SPL_PAD_TO
30816113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
30826113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
30836113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
30846113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
30856113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
308674752baaSScott Wood
3087ca2fca22SScott Wood		CONFIG_SPL_TARGET
3088ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3089ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3090ca2fca22SScott Wood		example if more than one image needs to be produced.
3091ca2fca22SScott Wood
309287ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
309387ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
309487ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
309587ebee39SSimon Glass		option to re-enable it. This will affect the output of the
309687ebee39SSimon Glass		bootm command when booting a FIT image.
309787ebee39SSimon Glass
30983aa29de0SYing Zhang- TPL framework
30993aa29de0SYing Zhang		CONFIG_TPL
31003aa29de0SYing Zhang		Enable building of TPL globally.
31013aa29de0SYing Zhang
31023aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
31033aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
31043aa29de0SYing Zhang		the TPL payload. By default, this is defined as
31053aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
31063aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
31073aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
31083aa29de0SYing Zhang
3109a8c7c708Swdenk- Interrupt support (PPC):
3110a8c7c708Swdenk
3111a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3112a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
311311ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3114a8c7c708Swdenk		should set decrementer_count to appropriate value. If
311511ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3116a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
311711ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3118a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3119a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3120a8c7c708Swdenk		general timer_interrupt().
3121a8c7c708Swdenk
3122c609719bSwdenk
31239660e442SHelmut RaigerBoard initialization settings:
31249660e442SHelmut Raiger------------------------------
31259660e442SHelmut Raiger
31269660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
31279660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
31289660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
31299660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
31309660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
31319660e442SHelmut Raigertypically in board_init_f() and board_init_r().
31329660e442SHelmut Raiger
31339660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
31349660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
31359660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
31369660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3137c609719bSwdenk
3138c609719bSwdenkConfiguration Settings:
3139c609719bSwdenk-----------------------
3140c609719bSwdenk
31414d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
31424d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
31434d1fd7f1SYork Sun
31446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3145c609719bSwdenk		undefine this when you're short of memory.
3146c609719bSwdenk
31472fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
31482fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
31492fb2604dSPeter Tyser
31506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3151c609719bSwdenk		prompt for user input.
3152c609719bSwdenk
31536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3154c609719bSwdenk
31556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3156c609719bSwdenk
31576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3158c609719bSwdenk
31596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3160c609719bSwdenk		the application (usually a Linux kernel) when it is
3161c609719bSwdenk		booted
3162c609719bSwdenk
31636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3164c609719bSwdenk		List of legal baudrate settings for this board.
3165c609719bSwdenk
31666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3167c609719bSwdenk		Begin and End addresses of the area used by the
3168c609719bSwdenk		simple memory test.
3169c609719bSwdenk
31706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3171c609719bSwdenk		Enable an alternate, more extensive memory test.
3172c609719bSwdenk
31736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
31745f535fe1Swdenk		Scratch address used by the alternate memory test
31755f535fe1Swdenk		You only need to set this if address zero isn't writeable
31765f535fe1Swdenk
3177e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
3178e61a7534SYork Sun		Only implemented for ARMv8 for now.
3179e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3180e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
3181e8149522SYork Sun		This memory can be used as secure memory. A variable
3182e61a7534SYork Sun		gd->arch.secure_ram is used to track the location. In systems
3183e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
3184e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3185e8149522SYork Sun
3186aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
31876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
318814f73ca6SStefan Roese		this specified memory area will get subtracted from the top
318911ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
319014f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
319114f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
319214f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
31935e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
319414f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
31955e12e75dSStefan Roese		will have to get fixed in Linux additionally.
319614f73ca6SStefan Roese
319714f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
319814f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
319914f73ca6SStefan Roese		be touched.
320014f73ca6SStefan Roese
320114f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
320214f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
320314f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
320414f73ca6SStefan Roese		non page size aligned address and this could cause major
320514f73ca6SStefan Roese		problems.
320614f73ca6SStefan Roese
32076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3208c609719bSwdenk		Enable temporary baudrate change while serial download
3209c609719bSwdenk
32106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3211c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3212c609719bSwdenk
32136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3214c609719bSwdenk		Physical start address of Flash memory.
3215c609719bSwdenk
32166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3217c609719bSwdenk		Physical start address of boot monitor code (set by
3218c609719bSwdenk		make config files to be same as the text base address
321914d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
32206d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3221c609719bSwdenk
32226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
32233b57fe0aSwdenk		Size of memory reserved for monitor code, used to
32243b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
32253b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
32263b57fe0aSwdenk		flash sector.
3227c609719bSwdenk
32286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3229c609719bSwdenk		Size of DRAM reserved for malloc() use.
3230c609719bSwdenk
3231d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3232d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3233d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3234d59476b6SSimon Glass		will become available before relocation. The address is just
3235d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3236d59476b6SSimon Glass		space.
3237d59476b6SSimon Glass
3238d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3239d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3240d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3241b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3242d59476b6SSimon Glass		U-Boot relocates itself.
3243d59476b6SSimon Glass
324438687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
324538687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
324638687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
324738687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
324838687ae6SSimon Glass
32491dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
32501dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
32511dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
32521dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
32531dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
32541dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
32551dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
32561dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
32571dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
32581dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
32591dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
32601dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
32611dfdd9baSThierry Reding		written to another region in the same cache-line. This can
32621dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
32631dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
32641dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
32651dfdd9baSThierry Reding
32661dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
32671dfdd9baSThierry Reding
32686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
326915940c9aSStefan Roese		Normally compressed uImages are limited to an
327015940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
32716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
327215940c9aSStefan Roese		to adjust this setting to your needs.
3273c609719bSwdenk
32746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3275c609719bSwdenk		Maximum size of memory mapped by the startup code of
3276c609719bSwdenk		the Linux kernel; all data that must be processed by
32777d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
32787d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
32791bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
32807d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3281c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3282c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3283c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3284c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3285c609719bSwdenk
3286fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3287fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3288fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3289fca43cc8SJohn Rigby		is enabled.
3290fca43cc8SJohn Rigby
3291fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3292fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3293fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3294fca43cc8SJohn Rigby
3295fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3296fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3297fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3298fca43cc8SJohn Rigby
32996d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3300c609719bSwdenk		Max number of Flash memory banks
3301c609719bSwdenk
33026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3303c609719bSwdenk		Max number of sectors on a Flash chip
3304c609719bSwdenk
33056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3306c609719bSwdenk		Timeout for Flash erase operations (in ms)
3307c609719bSwdenk
33086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3309c609719bSwdenk		Timeout for Flash write operations (in ms)
3310c609719bSwdenk
33116d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
33128564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
33138564acf9Swdenk
33146d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
33158564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
33168564acf9Swdenk
33176d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
33188564acf9Swdenk		If defined, hardware flash sectors protection is used
33198564acf9Swdenk		instead of U-Boot software protection.
33208564acf9Swdenk
33216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3322c609719bSwdenk
3323c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3324c609719bSwdenk		without this option such a download has to be
3325c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3326c609719bSwdenk		copy from RAM to flash.
3327c609719bSwdenk
3328c609719bSwdenk		The two-step approach is usually more reliable, since
3329c609719bSwdenk		you can check if the download worked before you erase
333011ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
333111ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3332c609719bSwdenk		downloaded image) this option may be very useful.
3333c609719bSwdenk
33346d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3335c609719bSwdenk		Define if the flash driver uses extra elements in the
33365653fc33Swdenk		common flash structure for storing flash geometry.
33375653fc33Swdenk
333800b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
33395653fc33Swdenk		This option also enables the building of the cfi_flash driver
33405653fc33Swdenk		in the drivers directory
334153cf9435Sstroese
334291809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
334391809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
334491809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
334591809ed5SPiotr Ziecik		to the MTD layer.
334691809ed5SPiotr Ziecik
33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
334896ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
334996ef831fSGuennadi Liakhovetski
335096ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
335196ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
335296ef831fSGuennadi Liakhovetski		write commands.
335396ef831fSGuennadi Liakhovetski
33546d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
33555568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
33565568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
33575568e613SStefan Roese		is useful, if some of the configured banks are only
33585568e613SStefan Roese		optionally available.
33595568e613SStefan Roese
33609a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
33619a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
33629a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
33639a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
33649a042e9cSJerry Van Baren
3365352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3366352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3367352ef3f1SStefan Roese		against the source after the write operation. An error message
3368352ef3f1SStefan Roese		will be printed when the contents are not identical.
3369352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3370352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3371352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3372352ef3f1SStefan Roese		this option if you really know what you are doing.
3373352ef3f1SStefan Roese
33746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
337511ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
337611ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
337753cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
337853cf9435Sstroese		buffers can be full shortly after enabling the interface
337911ccc33fSMarcel Ziswiler		on high Ethernet traffic.
338053cf9435Sstroese		Defaults to 4 if not defined.
3381c609719bSwdenk
3382ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3383ea882bafSWolfgang Denk
3384ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3385ea882bafSWolfgang Denk	internally to store the environment settings. The default
3386ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3387ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3388ea882bafSWolfgang Denk	lib/hashtable.c for details.
3389ea882bafSWolfgang Denk
33902598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
33912598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
33921bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
33932598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
33942598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
33952598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
33962598090bSJoe Hershberger
33972598090bSJoe Hershberger	The format of the list is:
33982598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3399b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
3400b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
34012598090bSJoe Hershberger		entry = variable_name[:attributes]
34022598090bSJoe Hershberger		list = entry[,list]
34032598090bSJoe Hershberger
34042598090bSJoe Hershberger	The type attributes are:
34052598090bSJoe Hershberger		s - String (default)
34062598090bSJoe Hershberger		d - Decimal
34072598090bSJoe Hershberger		x - Hexadecimal
34082598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
34092598090bSJoe Hershberger		i - IP address
34102598090bSJoe Hershberger		m - MAC address
34112598090bSJoe Hershberger
3412267541f7SJoe Hershberger	The access attributes are:
3413267541f7SJoe Hershberger		a - Any (default)
3414267541f7SJoe Hershberger		r - Read-only
3415267541f7SJoe Hershberger		o - Write-once
3416267541f7SJoe Hershberger		c - Change-default
3417267541f7SJoe Hershberger
34182598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
34192598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
3420b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
34212598090bSJoe Hershberger
34222598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
34232598090bSJoe Hershberger		Define this to a list (string) to define validation that
34242598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
34252598090bSJoe Hershberger		environment variable.  To override a setting in the static
34262598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
34272598090bSJoe Hershberger		".flags" variable.
34282598090bSJoe Hershberger
3429bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3430bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
3431bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
3432bdf1fe4eSJoe Hershberger
3433267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3434267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3435267541f7SJoe Hershberger	access flags.
3436267541f7SJoe Hershberger
34370d296cc2SGabe Black- CONFIG_USE_STDINT
34380d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
34390d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
34400d296cc2SGabe Black	building U-Boot to enable this.
34410d296cc2SGabe Black
3442c609719bSwdenkThe following definitions that deal with the placement and management
3443c609719bSwdenkof environment data (variable area); in general, we support the
3444c609719bSwdenkfollowing configurations:
3445c609719bSwdenk
3446c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3447c3eb3fe4SMike Frysinger
3448c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3449c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3450c3eb3fe4SMike Frysinger
34515a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3452c609719bSwdenk
3453c609719bSwdenk	Define this if the environment is in flash memory.
3454c609719bSwdenk
3455c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3456c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3457c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3458c609719bSwdenk	   sector" type flash chips, which have several smaller
3459c609719bSwdenk	   sectors at the start or the end. For instance, such a
3460c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3461c609719bSwdenk	   such a case you would place the environment in one of the
3462c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3463c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3464c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3465c609719bSwdenk	   between U-Boot and the environment.
3466c609719bSwdenk
34670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3468c609719bSwdenk
3469c609719bSwdenk	   Offset of environment data (variable area) to the
3470c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3471c609719bSwdenk	   type flash chips the second sector can be used: the offset
3472c609719bSwdenk	   for this sector is given here.
3473c609719bSwdenk
34746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3475c609719bSwdenk
34760e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3477c609719bSwdenk
3478c609719bSwdenk	   This is just another way to specify the start address of
3479c609719bSwdenk	   the flash sector containing the environment (instead of
34800e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3481c609719bSwdenk
34820e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3483c609719bSwdenk
3484c609719bSwdenk	   Size of the sector containing the environment.
3485c609719bSwdenk
3486c609719bSwdenk
3487c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3488c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3489c609719bSwdenk	   the environment.
3490c609719bSwdenk
34910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3492c609719bSwdenk
34935a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
34940e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3495c609719bSwdenk	   of this flash sector for the environment. This saves
3496c609719bSwdenk	   memory for the RAM copy of the environment.
3497c609719bSwdenk
3498c609719bSwdenk	   It may also save flash memory if you decide to use this
3499c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3500c609719bSwdenk	   since then the remainder of the flash sector could be used
3501c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3502c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3503c609719bSwdenk	   updating the environment in flash makes it always
3504c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3505c609719bSwdenk	   wrong before the contents has been restored from a copy in
3506c609719bSwdenk	   RAM, your target system will be dead.
3507c609719bSwdenk
35080e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
35090e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3510c609719bSwdenk
3511c609719bSwdenk	   These settings describe a second storage area used to hold
351211ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
35133e38691eSwdenk	   a valid backup copy in case there is a power failure during
3514c609719bSwdenk	   a "saveenv" operation.
3515c609719bSwdenk
3516c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3517c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3518c609719bSwdenkaccordingly!
3519c609719bSwdenk
3520c609719bSwdenk
35219314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3522c609719bSwdenk
3523c609719bSwdenk	Define this if you have some non-volatile memory device
3524c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3525c609719bSwdenk	environment.
3526c609719bSwdenk
35270e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
35280e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3529c609719bSwdenk
353011ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3531c609719bSwdenk	  want to use for environment. It is assumed that this memory
3532c609719bSwdenk	  can just be read and written to, without any special
3533c609719bSwdenk	  provision.
3534c609719bSwdenk
3535c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3536b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
353711ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3538c609719bSwdenkU-Boot will hang.
3539c609719bSwdenk
3540c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3541c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3542c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3543c609719bSwdenkto save the current settings.
3544c609719bSwdenk
3545c609719bSwdenk
3546bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3547c609719bSwdenk
3548c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3549c609719bSwdenk	device and a driver for it.
3550c609719bSwdenk
35510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35520e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3553c609719bSwdenk
3554c609719bSwdenk	  These two #defines specify the offset and size of the
3555c609719bSwdenk	  environment area within the total memory of your EEPROM.
3556c609719bSwdenk
35576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3558c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3559c609719bSwdenk	  The default address is zero.
3560c609719bSwdenk
3561189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
3562189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
3563189d257bSChristian Gmeiner
35646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3565c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3566c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3567c609719bSwdenk	  would require six bits.
3568c609719bSwdenk
35696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3570c609719bSwdenk	  If defined, the number of milliseconds to delay between
3571c609719bSwdenk	  page writes.	The default is zero milliseconds.
3572c609719bSwdenk
35736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3574c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3575c609719bSwdenk	  that this is NOT the chip address length!
3576c609719bSwdenk
35776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
35785cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
35795cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
35805cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
35815cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
35825cf91d6bSwdenk	  byte chips.
35835cf91d6bSwdenk
35845cf91d6bSwdenk	  Note that we consider the length of the address field to
35855cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
35865cf91d6bSwdenk	  in the chip address.
35875cf91d6bSwdenk
35886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3589c609719bSwdenk	  The size in bytes of the EEPROM device.
3590c609719bSwdenk
3591548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3592548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3593548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3594548738b4SHeiko Schocher
3595548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3596548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3597548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3598548738b4SHeiko Schocher	  EEPROM. For example:
3599548738b4SHeiko Schocher
3600ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3601548738b4SHeiko Schocher
3602548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3603548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3604c609719bSwdenk
3605057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
36065779d8d9Swdenk
36075779d8d9Swdenk	Define this if you have a DataFlash memory device which you
36085779d8d9Swdenk	want to use for the environment.
36095779d8d9Swdenk
36100e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36110e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
36120e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
36135779d8d9Swdenk
36145779d8d9Swdenk	  These three #defines specify the offset and size of the
36155779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
36165779d8d9Swdenk	  at the specified address.
36175779d8d9Swdenk
3618bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
3619bd83b592SWu, Josh
3620bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
3621bd83b592SWu, Josh	want to use for the environment.
3622bd83b592SWu, Josh
3623bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
3624bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
3625bd83b592SWu, Josh
3626bd83b592SWu, Josh	  These two #defines specify the offset and size of the
3627bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3628bd83b592SWu, Josh	  aligned to an erase sector boundary.
3629bd83b592SWu, Josh
3630bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
3631bd83b592SWu, Josh
3632bd83b592SWu, Josh	  Define the SPI flash's sector size.
3633bd83b592SWu, Josh
3634bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
3635bd83b592SWu, Josh
3636bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
3637bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
3638bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
36399dd05fb8SSimon Glass	  during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
3640bd83b592SWu, Josh	  aligned to an erase sector boundary.
3641bd83b592SWu, Josh
3642bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
3643bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
3644bd83b592SWu, Josh
3645bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
3646bd83b592SWu, Josh
3647bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
3648bd83b592SWu, Josh
3649bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
3650bd83b592SWu, Josh
3651bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
3652bd83b592SWu, Josh
3653bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
3654bd83b592SWu, Josh
36550a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
36560a85a9e7SLiu Gang
36570a85a9e7SLiu Gang	Define this if you have a remote memory space which you
36580a85a9e7SLiu Gang	want to use for the local device's environment.
36590a85a9e7SLiu Gang
36600a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
36610a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
36620a85a9e7SLiu Gang
36630a85a9e7SLiu Gang	  These two #defines specify the address and size of the
36640a85a9e7SLiu Gang	  environment area within the remote memory space. The
36650a85a9e7SLiu Gang	  local device can get the environment from remote memory
3666fc54c7faSLiu Gang	  space by SRIO or PCIE links.
36670a85a9e7SLiu Gang
36680a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
36690a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3670fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3671fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
36720a85a9e7SLiu Gang
367351bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
367413a5695bSwdenk
367513a5695bSwdenk	Define this if you have a NAND device which you want to use
367613a5695bSwdenk	for the environment.
367713a5695bSwdenk
36780e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36790e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
368013a5695bSwdenk
368113a5695bSwdenk	  These two #defines specify the offset and size of the environment
3682fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3683fdd813deSScott Wood	  aligned to an erase block boundary.
36845779d8d9Swdenk
3685fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3686e443c944SMarkus Klotzbuecher
36870e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3688fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3689fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
36909dd05fb8SSimon Glass	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_REDUND must be
3691fdd813deSScott Wood	  aligned to an erase block boundary.
3692e443c944SMarkus Klotzbuecher
3693fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3694fdd813deSScott Wood
3695fdd813deSScott Wood	  Specifies the length of the region in which the environment
3696fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3697fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3698fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3699fdd813deSScott Wood	  the range to be avoided.
3700fdd813deSScott Wood
3701fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3702fdd813deSScott Wood
3703fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3704fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3705fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3706fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3707fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3708e443c944SMarkus Klotzbuecher
3709b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3710b74ab737SGuennadi Liakhovetski
3711b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3712b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3713b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3714b74ab737SGuennadi Liakhovetski
37152b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
37162b74433fSJoe Hershberger
37172b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
37182b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
37192b74433fSJoe Hershberger	accesses, which is important on NAND.
37202b74433fSJoe Hershberger
37212b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
37222b74433fSJoe Hershberger
37232b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
37242b74433fSJoe Hershberger
37252b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
37262b74433fSJoe Hershberger
37272b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
37282b74433fSJoe Hershberger	  environment in.
37292b74433fSJoe Hershberger
3730785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3731785881f7SJoe Hershberger
3732785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3733785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3734785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3735785881f7SJoe Hershberger
37362b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
37372b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
37382b74433fSJoe Hershberger
37392b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
37402b74433fSJoe Hershberger	  when storing the env in UBI.
37412b74433fSJoe Hershberger
3742d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
3743d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
3744d1db76f1SWu, Josh
3745d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
3746d1db76f1SWu, Josh
3747d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
3748d1db76f1SWu, Josh
374941987784SNicolae Rosia       - FAT_ENV_DEVICE_AND_PART:
3750d1db76f1SWu, Josh
3751d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
3752d1db76f1SWu, Josh         be as following:
3753d1db76f1SWu, Josh
3754d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3755d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
3756d1db76f1SWu, Josh                        partition table.
3757d1db76f1SWu, Josh               - "D:0": device D.
3758d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
3759d1db76f1SWu, Josh                              table, or the whole device D if has no partition
3760d1db76f1SWu, Josh                              table.
3761d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
3762b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
3763d1db76f1SWu, Josh                           partition table then means device D.
3764d1db76f1SWu, Josh
3765d1db76f1SWu, Josh       - FAT_ENV_FILE:
3766d1db76f1SWu, Josh
3767d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
3768b445bbb4SJeremiah Mahler         environment.
3769d1db76f1SWu, Josh
3770d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
377191d27a17STom Rini         This must be enabled. Otherwise it cannot save the environment file.
3772d1db76f1SWu, Josh
377306e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
377406e4ae5fSStephen Warren
377506e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
377606e4ae5fSStephen Warren	environment.
377706e4ae5fSStephen Warren
377806e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
377906e4ae5fSStephen Warren
378006e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
378106e4ae5fSStephen Warren
378206e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
378306e4ae5fSStephen Warren
378406e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
378506e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
378606e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
378706e4ae5fSStephen Warren
378806e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
378906e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
379006e4ae5fSStephen Warren
379106e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
379206e4ae5fSStephen Warren	  area within the specified MMC device.
379306e4ae5fSStephen Warren
37945c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
37955c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
37965c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
37975c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
37985c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
37995c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
38005c088ee8SStephen Warren	  maximum possible space before it, to store other data.
38015c088ee8SStephen Warren
380206e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
380306e4ae5fSStephen Warren	  MMC sector boundary.
380406e4ae5fSStephen Warren
380506e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
380606e4ae5fSStephen Warren
380706e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
380806e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
380906e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
381006e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
381106e4ae5fSStephen Warren
38125c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
38135c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
38145c088ee8SStephen Warren
381506e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
381606e4ae5fSStephen Warren	  an MMC sector boundary.
381706e4ae5fSStephen Warren
381806e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
381906e4ae5fSStephen Warren
382006e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
382106e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
382206e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
382306e4ae5fSStephen Warren
3824e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3825c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3826cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3827c609719bSwdenkuntil then to read environment variables.
3828c609719bSwdenk
382985ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
383085ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
383185ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
383285ec0bccSwdenknecessary, because the first environment variable we need is the
383385ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
383485ec0bccSwdenkhave any device yet where we could complain.]
3835c609719bSwdenk
3836c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3837c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
383885ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3839c609719bSwdenk
38406d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3841fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3842fc3e2165Swdenk
38436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3844fc3e2165Swdenk		      also needs to be defined.
3845fc3e2165Swdenk
38466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3847fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3848c609719bSwdenk
3849f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3850f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3851f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3852f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3853f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3854f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3855f5675aa5SRon Madrid
3856b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3857b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3858b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3859b2b92f53SSimon Glass		to do this.
3860b2b92f53SSimon Glass
3861e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3862e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3863e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3864e2e3e2b1SSimon Glass		present.
3865e2e3e2b1SSimon Glass
3866feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
3867feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
3868feb85801SSascha Silbe		build system checks that the actual size does not
3869feb85801SSascha Silbe		exceed it.
3870feb85801SSascha Silbe
3871c609719bSwdenkLow Level (hardware related) configuration options:
3872dc7c9a1aSwdenk---------------------------------------------------
3873c609719bSwdenk
38746d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3875c609719bSwdenk		Cache Line Size of the CPU.
3876c609719bSwdenk
3877e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3878e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3879e46fedfeSTimur Tabi		PowerPC SOCs.
3880e46fedfeSTimur Tabi
3881e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3882e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3883e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3884e46fedfeSTimur Tabi
3885e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3886e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3887e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3888e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3889e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3890e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3891e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3892e46fedfeSTimur Tabi
3893e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3894e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3895e46fedfeSTimur Tabi
3896e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3897e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3898e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3899e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3900e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3901e46fedfeSTimur Tabi
3902e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3903e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3904e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3905e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3906e46fedfeSTimur Tabi
3907e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3908e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3909e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3910e46fedfeSTimur Tabi
39117f6c2cbcSwdenk- Floppy Disk Support:
39126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
39137f6c2cbcSwdenk
39147f6c2cbcSwdenk		the default drive number (default value 0)
39157f6c2cbcSwdenk
39166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
39177f6c2cbcSwdenk
391811ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
39197f6c2cbcSwdenk		(default value 1)
39207f6c2cbcSwdenk
39216d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
39227f6c2cbcSwdenk
39237f6c2cbcSwdenk		defines the offset of register from address. It
39247f6c2cbcSwdenk		depends on which part of the data bus is connected to
392511ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
39267f6c2cbcSwdenk
39276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
39286d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
39297f6c2cbcSwdenk		default value.
39307f6c2cbcSwdenk
39316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
39327f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
39337f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
3934b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
39357f6c2cbcSwdenk		initializations.
39367f6c2cbcSwdenk
39370abddf82SMacpaul Lin- CONFIG_IDE_AHB:
39380abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
39390abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
39400abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
39410abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
39420abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
3943b445bbb4SJeremiah Mahler		is required.
39440abddf82SMacpaul Lin
39456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
394625d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
39475b8e76c3SHeiko Schocher		doing! (11-4) [82xx systems only]
3948c609719bSwdenk
39496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
3950c609719bSwdenk
39517152b1d0Swdenk		Start address of memory area that can be used for
3952c609719bSwdenk		initial data and stack; please note that this must be
3953c609719bSwdenk		writable memory that is working WITHOUT special
3954c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
3955c609719bSwdenk		will become available only after programming the
3956c609719bSwdenk		memory controller and running certain initialization
3957c609719bSwdenk		sequences.
3958c609719bSwdenk
3959c609719bSwdenk		U-Boot uses the following memory types:
3960c609719bSwdenk		- PPC4xx:  data cache
3961c609719bSwdenk
39626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
3963c609719bSwdenk
3964c609719bSwdenk		Offset of the initial data structure in the memory
39656d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
39666d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
3967c609719bSwdenk		data is located at the end of the available space
3968553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
3969acd51f9dSSimon Glass		GENERATED_GBL_DATA_SIZE), and the initial stack is just
39706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
39716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
3972c609719bSwdenk
3973c609719bSwdenk	Note:
3974c609719bSwdenk		On the MPC824X (or other systems that use the data
3975c609719bSwdenk		cache for initial memory) the address chosen for
39766d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
3977c609719bSwdenk		point to an otherwise UNUSED address space between
3978c609719bSwdenk		the top of RAM and the start of the PCI space.
3979c609719bSwdenk
39806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
3981c609719bSwdenk
39826d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
3983c609719bSwdenk		SDRAM timing
3984c609719bSwdenk
39856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
3986c609719bSwdenk		periodic timer for refresh
3987c609719bSwdenk
39886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
39896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
39906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
39916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
3992c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
3993c609719bSwdenk
3994c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
39956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
39966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
3997c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
3998c609719bSwdenk
39999cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
40009cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
40019cacf4fcSDirk Eibach		required.
40029cacf4fcSDirk Eibach
400369fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4004b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
400569fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
400669fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
400769fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
400869fd2d3bSAndrew Sharp		by coreboot or similar.
400969fd2d3bSAndrew Sharp
4010842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4011842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4012842033e6SGabor Juhos
4013a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4014a09b9b68SKumar Gala		Chip has SRIO or not
4015a09b9b68SKumar Gala
4016a09b9b68SKumar Gala- CONFIG_SRIO1:
4017a09b9b68SKumar Gala		Board has SRIO 1 port available
4018a09b9b68SKumar Gala
4019a09b9b68SKumar Gala- CONFIG_SRIO2:
4020a09b9b68SKumar Gala		Board has SRIO 2 port available
4021a09b9b68SKumar Gala
4022c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4023c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4024c8b28152SLiu Gang
4025a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4026a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4027a09b9b68SKumar Gala
4028a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4029a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4030a09b9b68SKumar Gala
4031a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4032a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4033a09b9b68SKumar Gala
403466bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
403566bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
403666bd1846SFabio Estevam		a 16 bit bus.
403766bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4038a430e916SFabio Estevam		Example of drivers that use it:
403966bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4040a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4041eced4626SAlex Waterman
4042eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4043eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4044eced4626SAlex Waterman		a default value will be used.
4045eced4626SAlex Waterman
4046bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4047218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4048218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4049218ca724SWolfgang Denk
4050bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4051bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4052bb99ad6dSBen Warren
40536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4054218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4055218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4056218ca724SWolfgang Denk		to something your driver can deal with.
4057bb99ad6dSBen Warren
40581b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
40591b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
40601b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
40611b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
40621b3e3c4fSYork Sun		header files or board specific files.
40631b3e3c4fSYork Sun
40646f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
40656f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
40666f5e1dc5SYork Sun
4067e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4068e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4069e32d59a2SYork Sun
40704516ff81SYork Sun- CONFIG_FSL_DDR_BIST
40714516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
40724516ff81SYork Sun
40736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4074218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4075218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
40762ad6b513STimur Tabi
4077c26e454dSwdenk- CONFIG_RMII
4078c26e454dSwdenk		Enable RMII mode for all FECs.
4079c26e454dSwdenk		Note that this is a global option, we can't
4080c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4081c26e454dSwdenk
40825cf91d6bSwdenk- CONFIG_CRC32_VERIFY
40835cf91d6bSwdenk		Add a verify option to the crc32 command.
40845cf91d6bSwdenk		The syntax is:
40855cf91d6bSwdenk
40865cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
40875cf91d6bSwdenk
40885cf91d6bSwdenk		Where address/count indicate a memory area
40895cf91d6bSwdenk		and crc32 is the correct crc32 which the
40905cf91d6bSwdenk		area should have.
40915cf91d6bSwdenk
409256523f12Swdenk- CONFIG_LOOPW
409356523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4094602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
409556523f12Swdenk
40967b466641Sstroese- CONFIG_MX_CYCLIC
40977b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
40987b466641Sstroese		"md/mw" commands.
40997b466641Sstroese		Examples:
41007b466641Sstroese
41017b466641Sstroese		=> mdc.b 10 4 500
41027b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
41037b466641Sstroese
41047b466641Sstroese		=> mwc.l 100 12345678 10
41057b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
41067b466641Sstroese
41077b466641Sstroese		This only takes effect if the memory commands are activated
4108602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
41097b466641Sstroese
41108aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4111afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4112e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4113e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4114e03f3169SWolfgang Denk		relocate itself into RAM.
41158aa1a2d1Swdenk
4116e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4117e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4118e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4119e03f3169SWolfgang Denk		these initializations itself.
41208aa1a2d1Swdenk
4121b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4122b5bd0982SSimon Glass		[ARM926EJ-S only] This allows just the call to lowlevel_init()
412390211f77Syeongjun Kim		to be skipped. The normal CP15 init (such as enabling the
4124b5bd0982SSimon Glass		instruction cache) is still performed.
4125b5bd0982SSimon Glass
4126401bb30bSAneesh V- CONFIG_SPL_BUILD
4127df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4128df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4129df81238bSMagnus Lilja		compiling a NAND SPL.
4130400558b5Swdenk
41313aa29de0SYing Zhang- CONFIG_TPL_BUILD
41323aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
41333aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
41343aa29de0SYing Zhang		It is loaded by the SPL.
41353aa29de0SYing Zhang
41365df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
41375df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
41385df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
41395df572f0SYing Zhang		previous 4k of the .text section.
41405df572f0SYing Zhang
41414213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
41424213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
41434213fc29SSimon Glass		effective address. It is therefore not necessary to regard
41444213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
41454213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
41464213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
41474213fc29SSimon Glass		addressable memory. This option causes some memory accesses
41484213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
41494213fc29SSimon Glass
4150588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4151588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4152588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4153b16f521aSGabe Black
415416678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
415516678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
415616678eb4SHeiko Schocher
4157999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4158999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4159999d7d32SKaricheri, Muralidharan		driver that uses this:
4160999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4161999d7d32SKaricheri, Muralidharan
4162f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4163f2717b47STimur Tabi-----------------------------------
4164f2717b47STimur Tabi
4165f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4166f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4167f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4168f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4169f2717b47STimur Tabiwithin that device.
4170f2717b47STimur Tabi
4171dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4172dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4173dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4174dcf1d774SZhao Qiang	is also specified.
4175dcf1d774SZhao Qiang
4176dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4177dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4178f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4179f2717b47STimur Tabi	is also specified.
4180f2717b47STimur Tabi
4181f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4182f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4183f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4184f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4185f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4186f2717b47STimur Tabi
4187f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4188f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4189f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4190f2717b47STimur Tabi	virtual address in NOR flash.
4191f2717b47STimur Tabi
4192f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4193f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4194f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4195f2717b47STimur Tabi
4196f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4197f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4198f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4199f2717b47STimur Tabi
4200292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4201292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4202292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4203fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4204fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4205fc54c7faSLiu Gang	master's memory space.
4206f2717b47STimur Tabi
4207b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4208b940ca64SJ. German Rivera---------------------------------------------------------
4209b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4210b940ca64SJ. German Rivera"firmware".
4211b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4212b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4213b940ca64SJ. German Riverawithin that device.
4214b940ca64SJ. German Rivera
4215b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4216b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4217b940ca64SJ. German Rivera
42185c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
42195c055089SPrabhakar Kushwaha-------------------------------------------
42205c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
42215c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
42225c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
42235c055089SPrabhakar Kushwaha
4224c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
4225c0492141SYork Sun	Define alignment of reserved memory MC requires
42265c055089SPrabhakar Kushwaha
4227f3f431a7SPaul KocialkowskiReproducible builds
4228f3f431a7SPaul Kocialkowski-------------------
4229f3f431a7SPaul Kocialkowski
4230f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
4231f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
4232f3f431a7SPaul Kocialkowski
4233f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
4234f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4235f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
4236f3f431a7SPaul Kocialkowski
4237f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4238f3f431a7SPaul Kocialkowski
4239c609719bSwdenkBuilding the Software:
4240c609719bSwdenk======================
4241c609719bSwdenk
4242218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4243218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4244218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4245218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4246218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4247218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4248c609719bSwdenk
4249218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4250218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4251218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4252218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4253218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4254c609719bSwdenk
4255218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4256218ca724SWolfgang Denk	$ export CROSS_COMPILE
4257c609719bSwdenk
42582f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
42592f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
42602f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
42612f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
42622f8d396bSPeter Tyser
42632f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
42642f8d396bSPeter Tyser
42652f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
42662f8d396bSPeter Tyser      be executed on computers running Windows.
42672f8d396bSPeter Tyser
4268c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4269c609719bSwdenksources you must configure U-Boot for one specific board type. This
4270c609719bSwdenkis done by typing:
4271c609719bSwdenk
4272ab584d67SHolger Freyther	make NAME_defconfig
4273c609719bSwdenk
4274ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
42754d675ae6SMichael Jonesrations; see boards.cfg for supported names.
427654387ac9Swdenk
4277c609719bSwdenkNote: for some board special configuration names may exist; check if
4278c609719bSwdenk      additional information is available from the board vendor; for
42792729af9dSwdenk      instance, the TQM823L systems are available without (standard)
42802729af9dSwdenk      or with LCD support. You can select such additional "features"
428111ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4282c609719bSwdenk
4283ab584d67SHolger Freyther      make TQM823L_defconfig
42842729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4285c609719bSwdenk
4286ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4287c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4288c609719bSwdenk
4289c609719bSwdenk      etc.
4290c609719bSwdenk
4291c609719bSwdenk
4292c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
42937152b1d0Swdenkimages ready for download to / installation on your system:
4294c609719bSwdenk
4295c609719bSwdenk- "u-boot.bin" is a raw binary image
4296c609719bSwdenk- "u-boot" is an image in ELF binary format
4297c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4298c609719bSwdenk
4299baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4300baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4301baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4302baf31249SMarian Balakowicz
4303baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4304baf31249SMarian Balakowicz
4305baf31249SMarian Balakowicz	make O=/tmp/build distclean
4306ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
4307baf31249SMarian Balakowicz	make O=/tmp/build all
4308baf31249SMarian Balakowicz
4309adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4310baf31249SMarian Balakowicz
4311adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
4312baf31249SMarian Balakowicz	make distclean
4313ab584d67SHolger Freyther	make NAME_defconfig
4314baf31249SMarian Balakowicz	make all
4315baf31249SMarian Balakowicz
4316adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
4317baf31249SMarian Balakowiczvariable.
4318baf31249SMarian Balakowicz
4319c609719bSwdenk
4320c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4321c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4322c609719bSwdenknative "make".
4323c609719bSwdenk
4324c609719bSwdenk
4325c609719bSwdenkIf the system board that you have is not listed, then you will need
4326c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4327c609719bSwdenksteps:
4328c609719bSwdenk
43293c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
433085ec0bccSwdenk    files you need. In your board directory, you will need at least
43313c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
43323c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
43333c1496cdSPhil Sutter    your board.
4334c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4335c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
4336ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
4337c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4338c609719bSwdenk    to be installed on your target system.
433985ec0bccSwdenk6.  Debug and solve any problems that might arise.
4340c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4341c609719bSwdenk
4342c609719bSwdenk
4343c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4344c609719bSwdenk==============================================================
4345c609719bSwdenk
4346c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4347c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4348c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4349c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4350218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4351c609719bSwdenk
4352c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4353c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4354c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
43556de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will
43566de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this
43576de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H'
43586de80f21SSimon Glassfor documentation.
4359baf31249SMarian Balakowicz
4360baf31249SMarian Balakowicz
4361c609719bSwdenkSee also "U-Boot Porting Guide" below.
4362c609719bSwdenk
4363c609719bSwdenk
4364c609719bSwdenkMonitor Commands - Overview:
4365c609719bSwdenk============================
4366c609719bSwdenk
4367c609719bSwdenkgo	- start application at address 'addr'
4368c609719bSwdenkrun	- run commands in an environment variable
4369c609719bSwdenkbootm	- boot application image from memory
4370c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
437144f074c7SMarek Vasutbootz   - boot zImage from memory
4372c609719bSwdenktftpboot- boot image via network using TFTP protocol
4373c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4374c609719bSwdenk	       (and eventually "gatewayip")
43751fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4376c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4377c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4378c609719bSwdenkloads	- load S-Record file over serial line
4379c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4380c609719bSwdenkmd	- memory display
4381c609719bSwdenkmm	- memory modify (auto-incrementing)
4382c609719bSwdenknm	- memory modify (constant address)
4383c609719bSwdenkmw	- memory write (fill)
4384c609719bSwdenkcp	- memory copy
4385c609719bSwdenkcmp	- memory compare
4386c609719bSwdenkcrc32	- checksum calculation
43870f89c54bSPeter Tyseri2c	- I2C sub-system
4388c609719bSwdenksspi	- SPI utility commands
4389c609719bSwdenkbase	- print or set address offset
4390c609719bSwdenkprintenv- print environment variables
4391c609719bSwdenksetenv	- set environment variables
4392c609719bSwdenksaveenv - save environment variables to persistent storage
4393c609719bSwdenkprotect - enable or disable FLASH write protection
4394c609719bSwdenkerase	- erase FLASH memory
4395c609719bSwdenkflinfo	- print FLASH memory information
439610635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4397c609719bSwdenkbdinfo	- print Board Info structure
4398c609719bSwdenkiminfo	- print header information for application image
4399c609719bSwdenkconinfo - print console devices and informations
4400c609719bSwdenkide	- IDE sub-system
4401c609719bSwdenkloop	- infinite loop on address range
440256523f12Swdenkloopw	- infinite write loop on address range
4403c609719bSwdenkmtest	- simple RAM test
4404c609719bSwdenkicache	- enable or disable instruction cache
4405c609719bSwdenkdcache	- enable or disable data cache
4406c609719bSwdenkreset	- Perform RESET of the CPU
4407c609719bSwdenkecho	- echo args to console
4408c609719bSwdenkversion - print monitor version
4409c609719bSwdenkhelp	- print online help
4410c609719bSwdenk?	- alias for 'help'
4411c609719bSwdenk
4412c609719bSwdenk
4413c609719bSwdenkMonitor Commands - Detailed Description:
4414c609719bSwdenk========================================
4415c609719bSwdenk
4416c609719bSwdenkTODO.
4417c609719bSwdenk
4418c609719bSwdenkFor now: just type "help <command>".
4419c609719bSwdenk
4420c609719bSwdenk
4421c609719bSwdenkEnvironment Variables:
4422c609719bSwdenk======================
4423c609719bSwdenk
4424c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4425c609719bSwdenkcan be made persistent by saving to Flash memory.
4426c609719bSwdenk
4427c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4428c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4429c609719bSwdenkwithout a value can be used to delete a variable from the
4430c609719bSwdenkenvironment. As long as you don't save the environment you are
4431c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4432c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4433c609719bSwdenk
4434c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4435c96f86eeSWolfgang Denk
4436c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4437c609719bSwdenk
4438c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4439c609719bSwdenk
4440c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4441c609719bSwdenk
4442c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4443c609719bSwdenk
4444c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4445c609719bSwdenk
4446c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4447c609719bSwdenk
44487d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
44497d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
44507d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
44517d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
44527d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
44537d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4454c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4455c3624e6eSGrant Likely		  bootm_mapsize.
4456c3624e6eSGrant Likely
4457c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4458c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4459c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4460c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4461c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4462c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4463c3624e6eSGrant Likely		  used otherwise.
44647d721e34SBartlomiej Sieka
44657d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
44667d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
44677d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
44687d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
44697d721e34SBartlomiej Sieka		  environment variable.
44707d721e34SBartlomiej Sieka
44714bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
44724bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
44734bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
44744bae9090SBartlomiej Sieka
4475c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4476c609719bSwdenk		  "bootp" will just load perform a lookup of the
4477c609719bSwdenk		  configuration from the BOOTP server, but not try to
4478c609719bSwdenk		  load any image using TFTP
4479c609719bSwdenk
4480c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4481c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4482c609719bSwdenk		  be automatically started (by internally calling
4483c609719bSwdenk		  "bootm")
4484c609719bSwdenk
44854a6fd34bSwdenk		  If set to "no", a standalone image passed to the
44864a6fd34bSwdenk		  "bootm" command will be copied to the load address
44874a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
44884a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
44894a6fd34bSwdenk		  data.
44904a6fd34bSwdenk
4491a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4492a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4493fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4494fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4495fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4496fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4497fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4498fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4499fa34f6b2SShawn Guo		  access it during the boot procedure.
4500fa34f6b2SShawn Guo
4501a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4502a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4503a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4504a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4505a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4506a28afca5SDavid A. Long		  must be accessible by the kernel.
4507a28afca5SDavid A. Long
4508eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4509eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4510eea63e05SSimon Glass		  defined.
4511eea63e05SSimon Glass
451217ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
451317ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
451417ea1177Swdenk		  mode (400kHZ). This environment variable is used in
451517ea1177Swdenk		  initialization code. So, for changes to be effective
451617ea1177Swdenk		  it must be saved and board must be reset.
451717ea1177Swdenk
4518c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4519c609719bSwdenk		  If this variable is not set, initrd images will be
4520c609719bSwdenk		  copied to the highest possible address in RAM; this
4521c609719bSwdenk		  is usually what you want since it allows for
4522c609719bSwdenk		  maximum initrd size. If for some reason you want to
4523c609719bSwdenk		  make sure that the initrd image is loaded below the
45246d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4525c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4526c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4527c609719bSwdenk		  address to use (U-Boot will still check that it
4528c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4529c609719bSwdenk
4530c609719bSwdenk		  For instance, when you have a system with 16 MB
45317152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4532c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4533c609719bSwdenk		  the "bootargs" variable. However, now you must make
45347152b1d0Swdenk		  sure that the initrd image is placed in the first
4535c609719bSwdenk		  12 MB as well - this can be done with
4536c609719bSwdenk
4537c609719bSwdenk		  setenv initrd_high 00c00000
4538c609719bSwdenk
453938b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
454038b99261Swdenk		  indication to U-Boot that all addresses are legal
454138b99261Swdenk		  for the Linux kernel, including addresses in flash
454238b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
454338b99261Swdenk		  ramdisk at all. This may be useful to reduce the
454438b99261Swdenk		  boot time on your system, but requires that this
454538b99261Swdenk		  feature is supported by your Linux kernel.
454638b99261Swdenk
4547c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4548c609719bSwdenk
4549c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4550dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4551c609719bSwdenk
4552c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4553c609719bSwdenk
4554c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4555c609719bSwdenk
4556c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4557c609719bSwdenk
4558c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4559c609719bSwdenk
4560c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4561c609719bSwdenk
4562e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4563a3d991bdSwdenk
4564e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4565e2a53458SMike Frysinger		  For example you can do the following
4566a3d991bdSwdenk
456748690d80SHeiko Schocher		  => setenv ethact FEC
456848690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
456948690d80SHeiko Schocher		  => setenv ethact SCC
457048690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4571a3d991bdSwdenk
4572e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4573e1692577SMatthias Fuchs		  available network interfaces.
4574e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4575e1692577SMatthias Fuchs
4576a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4577a3d991bdSwdenk		  either succeed or fail without retrying.
45786e592385Swdenk		  When set to "once" the network operation will
45796e592385Swdenk		  fail when all the available network interfaces
45806e592385Swdenk		  are tried once without success.
4581a3d991bdSwdenk		  Useful on scripts which control the retry operation
4582a3d991bdSwdenk		  themselves.
4583a3d991bdSwdenk
4584b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4585a1cf027aSJean-Christophe PLAGNIOL-VILLARD
4586b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
45878d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
45888d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
45898d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
45908d51aacdSSimon Glass		  is silent.
45918d51aacdSSimon Glass
4592f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
4593ecb0ccd9SWolfgang Denk		  UDP source port.
4594ecb0ccd9SWolfgang Denk
4595f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
459628cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
459728cb9375SWolfgang Denk
4598c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4599c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4600c96f86eeSWolfgang Denk
4601c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4602c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4603c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4604c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4605c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4606c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4607c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4608c96f86eeSWolfgang Denk
4609f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
4610f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
4611f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
4612f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
4613f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
4614f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
4615f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
4616f5fb7346SAlbert ARIBAUD \(3ADEV\)
4617a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
461811ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4619a3d991bdSwdenk		  VLAN tagged frames.
4620c609719bSwdenk
462150768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
462250768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
462350768f5bSAlexandre Messier		  be either the default (28000), or a value based on
462450768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
462550768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
462650768f5bSAlexandre Messier
4627dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4628dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4629dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4630dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4631dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4632dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4633dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4634dc0b7b0eSJason Hobbs
4635dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4636aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
4637dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4638dc0b7b0eSJason Hobbs
4639dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4640dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4641dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4642dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4643dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4644dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4645dc0b7b0eSJason Hobbs
4646c609719bSwdenkThe following environment variables may be used and automatically
4647c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4648c609719bSwdenkdepending the information provided by your boot server:
4649c609719bSwdenk
4650c609719bSwdenk  bootfile	- see above
4651c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4652fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4653c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4654c609719bSwdenk  hostname	- Target hostname
4655c609719bSwdenk  ipaddr	- see above
4656c609719bSwdenk  netmask	- Subnet Mask
4657c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4658c609719bSwdenk  serverip	- see above
4659c609719bSwdenk
4660c609719bSwdenk
4661c609719bSwdenkThere are two special Environment Variables:
4662c609719bSwdenk
4663c609719bSwdenk  serial#	- contains hardware identification information such
4664c609719bSwdenk		  as type string and/or serial number
4665c609719bSwdenk  ethaddr	- Ethernet address
4666c609719bSwdenk
4667c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4668c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4669c609719bSwdenkonce they have been set once.
4670c609719bSwdenk
4671c609719bSwdenk
4672c1551ea8SstroeseFurther special Environment Variables:
4673c1551ea8Sstroese
4674c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4675c1551ea8Sstroese		  with the "version" command. This variable is
4676c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4677c1551ea8Sstroese
4678c1551ea8Sstroese
4679c609719bSwdenkPlease note that changes to some configuration parameters may take
4680c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4681c609719bSwdenk
4682c609719bSwdenk
4683170ab110SJoe HershbergerCallback functions for environment variables:
4684170ab110SJoe Hershberger---------------------------------------------
4685170ab110SJoe Hershberger
4686170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4687b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
4688170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4689170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4690170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4691170ab110SJoe Hershberger
4692170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4693170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4694170ab110SJoe Hershberger
4695170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4696170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4697170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4698170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4699170ab110SJoe Hershberger
4700170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4701170ab110SJoe Hershberger	list = entry[,list]
4702170ab110SJoe Hershberger
4703170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4704170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4705170ab110SJoe Hershberger
4706170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4707170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4708170ab110SJoe Hershbergeroverride any association in the static list. You can define
4709170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4710b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
4711170ab110SJoe Hershberger
4712bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
4713bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
4714bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
4715bdf1fe4eSJoe Hershberger
4716170ab110SJoe Hershberger
4717f07771ccSwdenkCommand Line Parsing:
4718f07771ccSwdenk=====================
4719f07771ccSwdenk
4720f07771ccSwdenkThere are two different command line parsers available with U-Boot:
47217152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4722f07771ccSwdenk
4723f07771ccSwdenkOld, simple command line parser:
4724f07771ccSwdenk--------------------------------
4725f07771ccSwdenk
4726f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4727f07771ccSwdenk- several commands on one line, separated by ';'
4728fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4729f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4730f07771ccSwdenk  for example:
4731fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4732f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4733f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4734f07771ccSwdenk
4735f07771ccSwdenkHush shell:
4736f07771ccSwdenk-----------
4737f07771ccSwdenk
4738f07771ccSwdenk- similar to Bourne shell, with control structures like
4739f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4740f07771ccSwdenk  until...do...done, ...
4741f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4742f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4743f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4744f07771ccSwdenk  command
4745f07771ccSwdenk
4746f07771ccSwdenkGeneral rules:
4747f07771ccSwdenk--------------
4748f07771ccSwdenk
4749f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4750f07771ccSwdenk    command) contains several commands separated by semicolon, and
4751f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4752f07771ccSwdenk    executed anyway.
4753f07771ccSwdenk
4754f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
475511ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4756f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4757f07771ccSwdenk    variables are not executed.
4758f07771ccSwdenk
4759c609719bSwdenkNote for Redundant Ethernet Interfaces:
4760c609719bSwdenk=======================================
4761c609719bSwdenk
476211ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4763c609719bSwdenksuch configurations and is capable of automatic selection of a
47647152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4765c609719bSwdenk
4766c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4767c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4768c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4769c609719bSwdenk
4770c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4771c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4772c609719bSwdenkding setting in the environment; if the corresponding environment
4773c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4774c609719bSwdenk
4775c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4776c609719bSwdenk  environment, the SROM's address is used.
4777c609719bSwdenk
4778c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4779c609719bSwdenk  environment exists, then the value from the environment variable is
4780c609719bSwdenk  used.
4781c609719bSwdenk
4782c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4783c609719bSwdenk  both addresses are the same, this MAC address is used.
4784c609719bSwdenk
4785c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4786c609719bSwdenk  addresses differ, the value from the environment is used and a
4787c609719bSwdenk  warning is printed.
4788c609719bSwdenk
4789c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4790bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4791bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
4792c609719bSwdenk
4793ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4794ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4795ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4796ecee9324SBen WarrenThe naming convention is as follows:
4797ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4798c609719bSwdenk
4799c609719bSwdenkImage Formats:
4800c609719bSwdenk==============
4801c609719bSwdenk
48023310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
48033310c549SMarian Balakowiczimages in two formats:
48043310c549SMarian Balakowicz
48053310c549SMarian BalakowiczNew uImage format (FIT)
48063310c549SMarian Balakowicz-----------------------
48073310c549SMarian Balakowicz
48083310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
48093310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
48103310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
48113310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
48123310c549SMarian Balakowicz
48133310c549SMarian Balakowicz
48143310c549SMarian BalakowiczOld uImage format
48153310c549SMarian Balakowicz-----------------
48163310c549SMarian Balakowicz
48173310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
48183310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
48193310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4820c609719bSwdenk
4821c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4822c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4823f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4824f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4825f5ed9e39SPeter Tyser  INTEGRITY).
48267b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4827afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4828afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4829c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4830c609719bSwdenk* Load Address
4831c609719bSwdenk* Entry Point
4832c609719bSwdenk* Image Name
4833c609719bSwdenk* Image Timestamp
4834c609719bSwdenk
4835c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4836c609719bSwdenkand the data portions of the image are secured against corruption by
4837c609719bSwdenkCRC32 checksums.
4838c609719bSwdenk
4839c609719bSwdenk
4840c609719bSwdenkLinux Support:
4841c609719bSwdenk==============
4842c609719bSwdenk
4843c609719bSwdenkAlthough U-Boot should support any OS or standalone application
48447152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4845c609719bSwdenkU-Boot.
4846c609719bSwdenk
4847c609719bSwdenkU-Boot includes many features that so far have been part of some
4848c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4849c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4850c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
48517152b1d0Swdenkserves several purposes:
4852c609719bSwdenk
4853c609719bSwdenk- the same features can be used for other OS or standalone
4854c609719bSwdenk  applications (for instance: using compressed images to reduce the
4855c609719bSwdenk  Flash memory footprint)
4856c609719bSwdenk
4857c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
48587152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4859c609719bSwdenk
4860c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4861c609719bSwdenk  images; of course this also means that different kernel images can
4862c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4863c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4864c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4865c609719bSwdenk  software is easier now.
4866c609719bSwdenk
4867c609719bSwdenk
4868c609719bSwdenkLinux HOWTO:
4869c609719bSwdenk============
4870c609719bSwdenk
4871c609719bSwdenkPorting Linux to U-Boot based systems:
4872c609719bSwdenk---------------------------------------
4873c609719bSwdenk
4874c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4875c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4876c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4877c609719bSwdenkLinux :-).
4878c609719bSwdenk
4879a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4880c609719bSwdenk
4881c609719bSwdenkJust make sure your machine specific header file (for instance
4882c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
48831dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
48841dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
48856d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4886c609719bSwdenk
48872eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
48882eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
48892eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
48902eb31b13SSimon Glassdoc/driver-model.
48912eb31b13SSimon Glass
4892c609719bSwdenk
4893c609719bSwdenkConfiguring the Linux kernel:
4894c609719bSwdenk-----------------------------
4895c609719bSwdenk
4896c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4897c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4898c609719bSwdenk
4899c609719bSwdenk
4900c609719bSwdenkBuilding a Linux Image:
4901c609719bSwdenk-----------------------
4902c609719bSwdenk
490324ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
490424ee89b9Swdenknot used. If you use recent kernel source, a new build target
490524ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
490624ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
490724ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
490824ee89b9Swdenk100% compatible format.
4909c609719bSwdenk
4910c609719bSwdenkExample:
4911c609719bSwdenk
4912ab584d67SHolger Freyther	make TQM850L_defconfig
4913c609719bSwdenk	make oldconfig
4914c609719bSwdenk	make dep
491524ee89b9Swdenk	make uImage
4916c609719bSwdenk
491724ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
491824ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
491924ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
4920c609719bSwdenk
492124ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
492224ee89b9Swdenk
492324ee89b9Swdenk* convert the kernel into a raw binary image:
492424ee89b9Swdenk
492524ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
492624ee89b9Swdenk				 -R .note -R .comment \
492724ee89b9Swdenk				 -S vmlinux linux.bin
492824ee89b9Swdenk
492924ee89b9Swdenk* compress the binary image:
493024ee89b9Swdenk
493124ee89b9Swdenk	gzip -9 linux.bin
493224ee89b9Swdenk
493324ee89b9Swdenk* package compressed binary image for U-Boot:
493424ee89b9Swdenk
493524ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
493624ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
493724ee89b9Swdenk		-d linux.bin.gz uImage
493824ee89b9Swdenk
493924ee89b9Swdenk
494024ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
494124ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
494224ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
494324ee89b9Swdenkbyte header containing information about target architecture,
494424ee89b9Swdenkoperating system, image type, compression method, entry points, time
494524ee89b9Swdenkstamp, CRC32 checksums, etc.
494624ee89b9Swdenk
494724ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
494824ee89b9Swdenkprint the header information, or to build new images.
4949c609719bSwdenk
4950c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
4951c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
4952c609719bSwdenkchecksum verification:
4953c609719bSwdenk
4954c609719bSwdenk	tools/mkimage -l image
4955c609719bSwdenk	  -l ==> list image header information
4956c609719bSwdenk
4957c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
4958c609719bSwdenkfrom a "data file" which is used as image payload:
4959c609719bSwdenk
4960c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
4961c609719bSwdenk		      -n name -d data_file image
4962c609719bSwdenk	  -A ==> set architecture to 'arch'
4963c609719bSwdenk	  -O ==> set operating system to 'os'
4964c609719bSwdenk	  -T ==> set image type to 'type'
4965c609719bSwdenk	  -C ==> set compression type 'comp'
4966c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
4967c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
4968c609719bSwdenk	  -n ==> set image name to 'name'
4969c609719bSwdenk	  -d ==> use image data from 'datafile'
4970c609719bSwdenk
497169459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
497269459791Swdenkaddress (0x00000000), but the entry point address depends on the
497369459791Swdenkkernel version:
4974c609719bSwdenk
4975c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
497624ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
4977c609719bSwdenk
4978c609719bSwdenkSo a typical call to build a U-Boot image would read:
4979c609719bSwdenk
498024ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
498124ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
4982a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
498324ee89b9Swdenk	> examples/uImage.TQM850L
498424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4985c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4986c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4987c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4988c609719bSwdenk	Load Address: 0x00000000
498924ee89b9Swdenk	Entry Point:  0x00000000
4990c609719bSwdenk
4991c609719bSwdenkTo verify the contents of the image (or check for corruption):
4992c609719bSwdenk
499324ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
499424ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
4995c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
4996c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
4997c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
4998c609719bSwdenk	Load Address: 0x00000000
499924ee89b9Swdenk	Entry Point:  0x00000000
5000c609719bSwdenk
5001c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5002c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5003c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5004c609719bSwdenkneed to be uncompressed:
5005c609719bSwdenk
5006a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
500724ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
500824ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5009a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
501024ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
501124ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5012c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5013c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5014c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5015c609719bSwdenk	Load Address: 0x00000000
501624ee89b9Swdenk	Entry Point:  0x00000000
5017c609719bSwdenk
5018c609719bSwdenk
5019c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5020c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5021c609719bSwdenk
5022c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5023c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5024c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5025c609719bSwdenk	Image Name:   Simple Ramdisk Image
5026c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5027c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5028c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5029c609719bSwdenk	Load Address: 0x00000000
5030c609719bSwdenk	Entry Point:  0x00000000
5031c609719bSwdenk
5032a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5033a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5034a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5035a804b5ceSGuilherme Maciel Ferreirafrom the image:
5036a804b5ceSGuilherme Maciel Ferreira
5037f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5038f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5039f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5040f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5041a804b5ceSGuilherme Maciel Ferreira
5042c609719bSwdenk
5043c609719bSwdenkInstalling a Linux Image:
5044c609719bSwdenk-------------------------
5045c609719bSwdenk
5046c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5047c609719bSwdenkyou must convert the image to S-Record format:
5048c609719bSwdenk
5049c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5050c609719bSwdenk
5051c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5052c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5053c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5054c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5055c609719bSwdenkcommand.
5056c609719bSwdenk
5057c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5058c609719bSwdenkTQM8xxL is in the first Flash bank):
5059c609719bSwdenk
5060c609719bSwdenk	=> erase 40100000 401FFFFF
5061c609719bSwdenk
5062c609719bSwdenk	.......... done
5063c609719bSwdenk	Erased 8 sectors
5064c609719bSwdenk
5065c609719bSwdenk	=> loads 40100000
5066c609719bSwdenk	## Ready for S-Record download ...
5067c609719bSwdenk	~>examples/image.srec
5068c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5069c609719bSwdenk	...
5070c609719bSwdenk	15989 15990 15991 15992
5071c609719bSwdenk	[file transfer complete]
5072c609719bSwdenk	[connected]
5073c609719bSwdenk	## Start Addr = 0x00000000
5074c609719bSwdenk
5075c609719bSwdenk
5076c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5077c609719bSwdenkthis includes a checksum verification so you can be sure no data
5078c609719bSwdenkcorruption happened:
5079c609719bSwdenk
5080c609719bSwdenk	=> imi 40100000
5081c609719bSwdenk
5082c609719bSwdenk	## Checking Image at 40100000 ...
5083c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5084c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5085c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5086c609719bSwdenk	   Load Address: 00000000
5087c609719bSwdenk	   Entry Point:	 0000000c
5088c609719bSwdenk	   Verifying Checksum ... OK
5089c609719bSwdenk
5090c609719bSwdenk
5091c609719bSwdenkBoot Linux:
5092c609719bSwdenk-----------
5093c609719bSwdenk
5094c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5095c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5096c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5097c609719bSwdenkparameters. You can check and modify this variable using the
5098c609719bSwdenk"printenv" and "setenv" commands:
5099c609719bSwdenk
5100c609719bSwdenk
5101c609719bSwdenk	=> printenv bootargs
5102c609719bSwdenk	bootargs=root=/dev/ram
5103c609719bSwdenk
5104c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5105c609719bSwdenk
5106c609719bSwdenk	=> printenv bootargs
5107c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5108c609719bSwdenk
5109c609719bSwdenk	=> bootm 40020000
5110c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5111c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5112c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5113c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5114c609719bSwdenk	   Load Address: 00000000
5115c609719bSwdenk	   Entry Point:	 0000000c
5116c609719bSwdenk	   Verifying Checksum ... OK
5117c609719bSwdenk	   Uncompressing Kernel Image ... OK
5118c609719bSwdenk	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
5119c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5120c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5121c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5122c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5123c609719bSwdenk	...
5124c609719bSwdenk
512511ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
51267152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5127c609719bSwdenkformat!) to the "bootm" command:
5128c609719bSwdenk
5129c609719bSwdenk	=> imi 40100000 40200000
5130c609719bSwdenk
5131c609719bSwdenk	## Checking Image at 40100000 ...
5132c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5133c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5134c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5135c609719bSwdenk	   Load Address: 00000000
5136c609719bSwdenk	   Entry Point:	 0000000c
5137c609719bSwdenk	   Verifying Checksum ... OK
5138c609719bSwdenk
5139c609719bSwdenk	## Checking Image at 40200000 ...
5140c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5141c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5142c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5143c609719bSwdenk	   Load Address: 00000000
5144c609719bSwdenk	   Entry Point:	 00000000
5145c609719bSwdenk	   Verifying Checksum ... OK
5146c609719bSwdenk
5147c609719bSwdenk	=> bootm 40100000 40200000
5148c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5149c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5150c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5151c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5152c609719bSwdenk	   Load Address: 00000000
5153c609719bSwdenk	   Entry Point:	 0000000c
5154c609719bSwdenk	   Verifying Checksum ... OK
5155c609719bSwdenk	   Uncompressing Kernel Image ... OK
5156c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5157c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5158c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5159c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5160c609719bSwdenk	   Load Address: 00000000
5161c609719bSwdenk	   Entry Point:	 00000000
5162c609719bSwdenk	   Verifying Checksum ... OK
5163c609719bSwdenk	   Loading Ramdisk ... OK
5164c609719bSwdenk	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
5165c609719bSwdenk	Boot arguments: root=/dev/ram
5166c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5167c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5168c609719bSwdenk	...
5169c609719bSwdenk	RAMDISK: Compressed image found at block 0
5170c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5171c609719bSwdenk
5172c609719bSwdenk	bash#
5173c609719bSwdenk
51740267768eSMatthew McClintockBoot Linux and pass a flat device tree:
51750267768eSMatthew McClintock-----------
51760267768eSMatthew McClintock
51770267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
51780267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
51790267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
51800267768eSMatthew McClintockflat device tree:
51810267768eSMatthew McClintock
51820267768eSMatthew McClintock=> print oftaddr
51830267768eSMatthew McClintockoftaddr=0x300000
51840267768eSMatthew McClintock=> print oft
51850267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
51860267768eSMatthew McClintock=> tftp $oftaddr $oft
51870267768eSMatthew McClintockSpeed: 1000, full duplex
51880267768eSMatthew McClintockUsing TSEC0 device
51890267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
51900267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
51910267768eSMatthew McClintockLoad address: 0x300000
51920267768eSMatthew McClintockLoading: #
51930267768eSMatthew McClintockdone
51940267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
51950267768eSMatthew McClintock=> tftp $loadaddr $bootfile
51960267768eSMatthew McClintockSpeed: 1000, full duplex
51970267768eSMatthew McClintockUsing TSEC0 device
51980267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
51990267768eSMatthew McClintockFilename 'uImage'.
52000267768eSMatthew McClintockLoad address: 0x200000
52010267768eSMatthew McClintockLoading:############
52020267768eSMatthew McClintockdone
52030267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
52040267768eSMatthew McClintock=> print loadaddr
52050267768eSMatthew McClintockloadaddr=200000
52060267768eSMatthew McClintock=> print oftaddr
52070267768eSMatthew McClintockoftaddr=0x300000
52080267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
52090267768eSMatthew McClintock## Booting image at 00200000 ...
52100267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
52110267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
52120267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
52130267768eSMatthew McClintock   Load Address: 00000000
52140267768eSMatthew McClintock   Entry Point:	 00000000
52150267768eSMatthew McClintock   Verifying Checksum ... OK
52160267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
52170267768eSMatthew McClintockBooting using flat device tree at 0x300000
52180267768eSMatthew McClintockUsing MPC85xx ADS machine description
52190267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
52200267768eSMatthew McClintock[snip]
52210267768eSMatthew McClintock
52220267768eSMatthew McClintock
52236069ff26SwdenkMore About U-Boot Image Types:
52246069ff26Swdenk------------------------------
52256069ff26Swdenk
52266069ff26SwdenkU-Boot supports the following image types:
52276069ff26Swdenk
52286069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
52296069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
52306069ff26Swdenk	well) you can continue to work in U-Boot after return from
52316069ff26Swdenk	the Standalone Program.
52326069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
52336069ff26Swdenk	will take over control completely. Usually these programs
52346069ff26Swdenk	will install their own set of exception handlers, device
52356069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
52366069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
52376069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
52386069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
52396069ff26Swdenk	being started.
52406069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
52416069ff26Swdenk	(Linux) kernel image and one or more data images like
52426069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
52436069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
52446069ff26Swdenk	server provides just a single image file, but you want to get
52456069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
52466069ff26Swdenk
52476069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
52486069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
52496069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
52506069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
52516069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
52526069ff26Swdenk	a multiple of 4 bytes).
52536069ff26Swdenk
52546069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
52556069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
52566069ff26Swdenk	flash memory.
52576069ff26Swdenk
52586069ff26Swdenk   "Script files" are command sequences that will be executed by
52596069ff26Swdenk	U-Boot's command interpreter; this feature is especially
52606069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
52616069ff26Swdenk	as command interpreter.
52626069ff26Swdenk
526344f074c7SMarek VasutBooting the Linux zImage:
526444f074c7SMarek Vasut-------------------------
526544f074c7SMarek Vasut
526644f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
526744f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
526844f074c7SMarek Vasutas the syntax of "bootm" command.
526944f074c7SMarek Vasut
52708ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5271017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5272017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5273017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5274017e1f3fSMarek Vasut
5275c609719bSwdenk
5276c609719bSwdenkStandalone HOWTO:
5277c609719bSwdenk=================
5278c609719bSwdenk
5279c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5280c609719bSwdenkrun "standalone" applications, which can use some resources of
5281c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5282c609719bSwdenk
5283c609719bSwdenkTwo simple examples are included with the sources:
5284c609719bSwdenk
5285c609719bSwdenk"Hello World" Demo:
5286c609719bSwdenk-------------------
5287c609719bSwdenk
5288c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5289c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5290c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5291c609719bSwdenklike that:
5292c609719bSwdenk
5293c609719bSwdenk	=> loads
5294c609719bSwdenk	## Ready for S-Record download ...
5295c609719bSwdenk	~>examples/hello_world.srec
5296c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5297c609719bSwdenk	[file transfer complete]
5298c609719bSwdenk	[connected]
5299c609719bSwdenk	## Start Addr = 0x00040004
5300c609719bSwdenk
5301c609719bSwdenk	=> go 40004 Hello World! This is a test.
5302c609719bSwdenk	## Starting application at 0x00040004 ...
5303c609719bSwdenk	Hello World
5304c609719bSwdenk	argc = 7
5305c609719bSwdenk	argv[0] = "40004"
5306c609719bSwdenk	argv[1] = "Hello"
5307c609719bSwdenk	argv[2] = "World!"
5308c609719bSwdenk	argv[3] = "This"
5309c609719bSwdenk	argv[4] = "is"
5310c609719bSwdenk	argv[5] = "a"
5311c609719bSwdenk	argv[6] = "test."
5312c609719bSwdenk	argv[7] = "<NULL>"
5313c609719bSwdenk	Hit any key to exit ...
5314c609719bSwdenk
5315c609719bSwdenk	## Application terminated, rc = 0x0
5316c609719bSwdenk
5317c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5318c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5319c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5320c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5321c609719bSwdenkcharacter, but this is just a demo program. The application can be
5322c609719bSwdenkcontrolled by the following keys:
5323c609719bSwdenk
5324c609719bSwdenk	? - print current values og the CPM Timer registers
5325c609719bSwdenk	b - enable interrupts and start timer
5326c609719bSwdenk	e - stop timer and disable interrupts
5327c609719bSwdenk	q - quit application
5328c609719bSwdenk
5329c609719bSwdenk	=> loads
5330c609719bSwdenk	## Ready for S-Record download ...
5331c609719bSwdenk	~>examples/timer.srec
5332c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5333c609719bSwdenk	[file transfer complete]
5334c609719bSwdenk	[connected]
5335c609719bSwdenk	## Start Addr = 0x00040004
5336c609719bSwdenk
5337c609719bSwdenk	=> go 40004
5338c609719bSwdenk	## Starting application at 0x00040004 ...
5339c609719bSwdenk	TIMERS=0xfff00980
5340c609719bSwdenk	Using timer 1
5341c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5342c609719bSwdenk
5343c609719bSwdenkHit 'b':
5344c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5345c609719bSwdenk	Enabling timer
5346c609719bSwdenkHit '?':
5347c609719bSwdenk	[q, b, e, ?] ........
5348c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5349c609719bSwdenkHit '?':
5350c609719bSwdenk	[q, b, e, ?] .
5351c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5352c609719bSwdenkHit '?':
5353c609719bSwdenk	[q, b, e, ?] .
5354c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5355c609719bSwdenkHit '?':
5356c609719bSwdenk	[q, b, e, ?] .
5357c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5358c609719bSwdenkHit 'e':
5359c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5360c609719bSwdenkHit 'q':
5361c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5362c609719bSwdenk
5363c609719bSwdenk
536485ec0bccSwdenkMinicom warning:
536585ec0bccSwdenk================
536685ec0bccSwdenk
53677152b1d0SwdenkOver time, many people have reported problems when trying to use the
536885ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
536985ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5370f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
537185ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5372e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5373e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5374e53515a2SKarl O. Pincfor help with kermit.
5375e53515a2SKarl O. Pinc
537685ec0bccSwdenk
537752f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
537852f52c14Swdenkconfiguration to your "File transfer protocols" section:
537952f52c14Swdenk
538052f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
538152f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
538252f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
538352f52c14Swdenk
538452f52c14Swdenk
5385c609719bSwdenkNetBSD Notes:
5386c609719bSwdenk=============
5387c609719bSwdenk
5388c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5389c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5390c609719bSwdenk
5391c609719bSwdenkBuilding requires a cross environment; it is known to work on
5392c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5393c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5394c609719bSwdenkNote that the cross-powerpc package does not install include files;
5395c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5396c609719bSwdenkmissing.  This file has to be installed and patched manually:
5397c609719bSwdenk
5398c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5399c609719bSwdenk	# mkdir powerpc
5400c609719bSwdenk	# ln -s powerpc machine
5401c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5402c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5403c609719bSwdenk
5404c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5405c609719bSwdenkand U-Boot include files.
5406c609719bSwdenk
5407c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5408c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5409c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5410c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
54112a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5412c609719bSwdenk
5413c609719bSwdenk
5414c609719bSwdenkImplementation Internals:
5415c609719bSwdenk=========================
5416c609719bSwdenk
5417c609719bSwdenkThe following is not intended to be a complete description of every
5418c609719bSwdenkimplementation detail. However, it should help to understand the
5419c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5420c609719bSwdenkhardware.
5421c609719bSwdenk
5422c609719bSwdenk
5423c609719bSwdenkInitial Stack, Global Data:
5424c609719bSwdenk---------------------------
5425c609719bSwdenk
5426c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5427c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5428c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5429c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5430c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5431c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5432c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5433c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5434c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5435c609719bSwdenklocked as (mis-) used as memory, etc.
5436c609719bSwdenk
54377152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
54380668236bSWolfgang Denk	U-Boot mailing list:
543943d9616cSwdenk
544043d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
544143d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
544243d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
544343d9616cSwdenk	...
544443d9616cSwdenk
544543d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
544643d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
544743d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
544843d9616cSwdenk	is that the cache is being used as a temporary supply of
544943d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
545011ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
545143d9616cSwdenk	can see how this works by studying the cache architecture and
545243d9616cSwdenk	operation in the architecture and processor-specific manuals.
545343d9616cSwdenk
545443d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
545543d9616cSwdenk	is another option for the system designer to use as an
545611ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
545743d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
545843d9616cSwdenk	board designers haven't used it for something that would
545943d9616cSwdenk	cause you grief during the initial boot! It is frequently not
546043d9616cSwdenk	used.
546143d9616cSwdenk
54626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
546343d9616cSwdenk	with your processor/board/system design. The default value
546443d9616cSwdenk	you will find in any recent u-boot distribution in
54658a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
546643d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
546743d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
546843d9616cSwdenk	that are supposed to respond to that address! That code in
546943d9616cSwdenk	start.S has been around a while and should work as is when
547043d9616cSwdenk	you get the config right.
547143d9616cSwdenk
547243d9616cSwdenk	-Chris Hallinan
547343d9616cSwdenk	DS4.COM, Inc.
547443d9616cSwdenk
5475c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5476c609719bSwdenkcode for the initialization procedures:
5477c609719bSwdenk
5478c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5479c609719bSwdenk  to write it.
5480c609719bSwdenk
5481b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
5482c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
54837152b1d0Swdenk  zation is performed later (when relocating to RAM).
5484c609719bSwdenk
5485c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5486c609719bSwdenk  that.
5487c609719bSwdenk
5488c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5489b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
5490c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5491c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5492c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5493c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5494c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5495c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5496c609719bSwdenkreserve for this purpose.
5497c609719bSwdenk
54987152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5499c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5500c609719bSwdenkGCC's implementation.
5501c609719bSwdenk
5502c609719bSwdenkFor PowerPC, the following registers have specific use:
5503c609719bSwdenk	R1:	stack pointer
5504e7670f6cSWolfgang Denk	R2:	reserved for system use
5505c609719bSwdenk	R3-R4:	parameter passing and return values
5506c609719bSwdenk	R5-R10: parameter passing
5507c609719bSwdenk	R13:	small data area pointer
5508c609719bSwdenk	R30:	GOT pointer
5509c609719bSwdenk	R31:	frame pointer
5510c609719bSwdenk
5511e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5512e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5513e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5514c609719bSwdenk
5515e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5516c609719bSwdenk
5517c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5518c609719bSwdenk    address of the global data structure is known at compile time),
5519c609719bSwdenk    but it turned out that reserving a register results in somewhat
5520c609719bSwdenk    smaller code - although the code savings are not that big (on
5521c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5522c609719bSwdenk    624 text + 127 data).
5523c609719bSwdenk
5524c609719bSwdenkOn ARM, the following registers are used:
5525c609719bSwdenk
5526c609719bSwdenk	R0:	function argument word/integer result
5527c609719bSwdenk	R1-R3:	function argument word
552812eba1b4SJeroen Hofstee	R9:	platform specific
552912eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5530c609719bSwdenk	R11:	argument (frame) pointer
5531c609719bSwdenk	R12:	temporary workspace
5532c609719bSwdenk	R13:	stack pointer
5533c609719bSwdenk	R14:	link register
5534c609719bSwdenk	R15:	program counter
5535c609719bSwdenk
553612eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
553712eba1b4SJeroen Hofstee
553812eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5539c609719bSwdenk
55400df01fd3SThomas ChouOn Nios II, the ABI is documented here:
55410df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
55420df01fd3SThomas Chou
55430df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
55440df01fd3SThomas Chou
55450df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
55460df01fd3SThomas Chou    to access small data sections, so gp is free.
55470df01fd3SThomas Chou
5548afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5549afc1ce82SMacpaul Lin
5550afc1ce82SMacpaul Lin	R0-R1:	argument/return
5551afc1ce82SMacpaul Lin	R2-R5:	argument
5552afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5553afc1ce82SMacpaul Lin	R16:	trampoline register
5554afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5555afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5556afc1ce82SMacpaul Lin	R30:	link register (LP)
5557afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5558afc1ce82SMacpaul Lin	PC:	program counter (PC)
5559afc1ce82SMacpaul Lin
5560afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5561afc1ce82SMacpaul Lin
5562d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5563d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5564c609719bSwdenk
5565c609719bSwdenkMemory Management:
5566c609719bSwdenk------------------
5567c609719bSwdenk
5568c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5569c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5570c609719bSwdenk
5571c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5572c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5573c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5574c609719bSwdenkphysical memory banks.
5575c609719bSwdenk
5576c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5577c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5578c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5579c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
55806d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5581c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5582c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5583c609719bSwdenk
5584c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5585c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5586c609719bSwdenk
5587c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5588c609719bSwdenkthis:
5589c609719bSwdenk
5590c609719bSwdenk	0x0000 0000	Exception Vector code
5591c609719bSwdenk	      :
5592c609719bSwdenk	0x0000 1FFF
5593c609719bSwdenk	0x0000 2000	Free for Application Use
5594c609719bSwdenk	      :
5595c609719bSwdenk	      :
5596c609719bSwdenk
5597c609719bSwdenk	      :
5598c609719bSwdenk	      :
5599c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5600c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5601c609719bSwdenk	0x00FC 0000	Malloc Arena
5602c609719bSwdenk	      :
5603c609719bSwdenk	0x00FD FFFF
5604c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5605c609719bSwdenk	...		eventually: LCD or video framebuffer
5606c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5607c609719bSwdenk	0x00FF FFFF	[End of RAM]
5608c609719bSwdenk
5609c609719bSwdenk
5610c609719bSwdenkSystem Initialization:
5611c609719bSwdenk----------------------
5612c609719bSwdenk
5613c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
561411ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5615c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
56167152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5617c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5618c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
56192eb48ff7SHeiko Schocherwhich provide such a feature like), or in a locked part of the data
56202eb48ff7SHeiko Schochercache. After that, U-Boot initializes the CPU core, the caches and
56212eb48ff7SHeiko Schocherthe SIU.
5622c609719bSwdenk
5623c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5624c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5625c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5626c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5627c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5628c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5629c609719bSwdenkbanks.
5630c609719bSwdenk
5631c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
56327152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5633c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5634c609719bSwdenk0x00000000, with any additional banks following immediately to create
5635c609719bSwdenkcontiguous memory starting from 0.
5636c609719bSwdenk
5637c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5638c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5639c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5640c609719bSwdenkpages, and the final stack is set up.
5641c609719bSwdenk
5642c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5643c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5644c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5645c609719bSwdenknew address in RAM.
5646c609719bSwdenk
5647c609719bSwdenk
5648c609719bSwdenkU-Boot Porting Guide:
5649c609719bSwdenk----------------------
5650c609719bSwdenk
5651c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
56526aff3115Swdenklist, October 2002]
5653c609719bSwdenk
5654c609719bSwdenk
5655c609719bSwdenkint main(int argc, char *argv[])
5656c609719bSwdenk{
5657c609719bSwdenk	sighandler_t no_more_time;
5658c609719bSwdenk
5659c609719bSwdenk	signal(SIGALRM, no_more_time);
5660c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5661c609719bSwdenk
5662c609719bSwdenk	if (available_money > available_manpower) {
56636c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5664c609719bSwdenk		return 0;
5665c609719bSwdenk	}
5666c609719bSwdenk
5667c609719bSwdenk	Download latest U-Boot source;
5668c609719bSwdenk
56690668236bSWolfgang Denk	Subscribe to u-boot mailing list;
56706aff3115Swdenk
56716c3fef28SJerry Van Baren	if (clueless)
5672c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5673c609719bSwdenk
5674c609719bSwdenk	while (learning) {
5675c609719bSwdenk		Read the README file in the top level directory;
56767cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
56776c3fef28SJerry Van Baren		Read applicable doc/*.README;
5678c609719bSwdenk		Read the source, Luke;
56796c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5680c609719bSwdenk	}
5681c609719bSwdenk
56826c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
56836c3fef28SJerry Van Baren		Buy a BDI3000;
56846c3fef28SJerry Van Baren	else
5685c609719bSwdenk		Add a lot of aggravation and time;
5686c609719bSwdenk
56876c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
56886c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
56896c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
56906c3fef28SJerry Van Baren	} else {
5691c609719bSwdenk		Create your own board support subdirectory;
56926c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
56936c3fef28SJerry Van Baren	}
56946c3fef28SJerry Van Baren	Edit new board/<myboard> files
56956c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5696c609719bSwdenk
56976c3fef28SJerry Van Baren	while (!accepted) {
5698c609719bSwdenk		while (!running) {
5699c609719bSwdenk			do {
5700c609719bSwdenk				Add / modify source code;
5701c609719bSwdenk			} until (compiles);
5702c609719bSwdenk			Debug;
5703c609719bSwdenk			if (clueless)
5704c609719bSwdenk				email("Hi, I am having problems...");
5705c609719bSwdenk		}
57066c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
57076c3fef28SJerry Van Baren		if (reasonable critiques)
57086c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
57096c3fef28SJerry Van Baren		else
57106c3fef28SJerry Van Baren			Defend code as written;
57116c3fef28SJerry Van Baren	}
5712c609719bSwdenk
5713c609719bSwdenk	return 0;
5714c609719bSwdenk}
5715c609719bSwdenk
5716c609719bSwdenkvoid no_more_time (int sig)
5717c609719bSwdenk{
5718c609719bSwdenk      hire_a_guru();
5719c609719bSwdenk}
5720c609719bSwdenk
5721c609719bSwdenk
5722c609719bSwdenkCoding Standards:
5723c609719bSwdenk-----------------
5724c609719bSwdenk
5725c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
57262c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
57277ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5728c609719bSwdenk
57292c051651SDetlev ZundelSource files originating from a different project (for example the
57302c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
5731b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
57322c051651SDetlev Zundelsources.
57332c051651SDetlev Zundel
57342c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
57352c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
57362c051651SDetlev Zundelin your code.
5737c609719bSwdenk
5738c178d3daSwdenkPlease also stick to the following formatting rules:
5739180d3f74Swdenk- remove any trailing white space
57407ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5741180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
57427ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5743180d3f74Swdenk- do not add trailing empty lines to source files
5744180d3f74Swdenk
5745c609719bSwdenkSubmissions which do not conform to the standards may be returned
5746c609719bSwdenkwith a request to reformat the changes.
5747c609719bSwdenk
5748c609719bSwdenk
5749c609719bSwdenkSubmitting Patches:
5750c609719bSwdenk-------------------
5751c609719bSwdenk
5752c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5753c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5754c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5755c609719bSwdenk
57560d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5757218ca724SWolfgang Denk
57580668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
57590668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
57600668236bSWolfgang Denk
5761c609719bSwdenkWhen you send a patch, please include the following information with
5762c609719bSwdenkit:
5763c609719bSwdenk
5764c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5765c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5766c609719bSwdenk  patch actually fixes something.
5767c609719bSwdenk
5768c609719bSwdenk* For new features: a description of the feature and your
5769c609719bSwdenk  implementation.
5770c609719bSwdenk
5771c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5772c609719bSwdenk
57737207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
57747207b366SRobert P. J. Day  information and associated file and directory references.
5775c609719bSwdenk
577627af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
577727af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
5778c609719bSwdenk
5779c609719bSwdenk* If your patch adds new configuration options, don't forget to
5780c609719bSwdenk  document these in the README file.
5781c609719bSwdenk
5782218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5783218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
57847ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5785218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5786218ca724SWolfgang Denk  with some other mail clients.
5787c609719bSwdenk
5788218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5789218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5790218ca724SWolfgang Denk  GNU diff.
57916dff5529Swdenk
5792218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5793218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5794218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5795218ca724SWolfgang Denk  affected files).
5796218ca724SWolfgang Denk
5797218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5798218ca724SWolfgang Denk  and compressed attachments must not be used.
5799c609719bSwdenk
580052f52c14Swdenk* If one logical set of modifications affects or creates several
580152f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
580252f52c14Swdenk
580352f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
580452f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
580552f52c14Swdenk
580652f52c14Swdenk
5807c609719bSwdenkNotes:
5808c609719bSwdenk
58096de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched
5810c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5811c609719bSwdenk  for any of the boards.
5812c609719bSwdenk
5813c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5814c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5815c609719bSwdenk  returned with a request to re-formatting / split it.
5816c609719bSwdenk
5817c609719bSwdenk* If you modify existing code, make sure that your new code does not
5818c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5819c609719bSwdenk  When adding new features, these should compile conditionally only
5820c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5821c609719bSwdenk  disabled must not need more memory than the old code without your
5822c609719bSwdenk  modification.
582390dc6704Swdenk
58240668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
58250668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
58260668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
58270668236bSWolfgang Denk  bigger than the size limit should be avoided.
5828