xref: /openbmc/u-boot/README (revision 5b8e76c3)
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
611b55ae402SMarcel Ziswiler		OF_CPU - The proper name of the cpus node (only required for
612b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
613b55ae402SMarcel Ziswiler		OF_SOC - The proper name of the soc node (only required for
614b55ae402SMarcel Ziswiler			MPC512X and MPC5xxx based boards).
615f57f70aaSWolfgang Denk		OF_TBCLK - The timebase frequency.
616c2871f03SKumar Gala		OF_STDOUT_PATH - The path to the console device
617f57f70aaSWolfgang Denk
61811ccc33fSMarcel Ziswiler		boards with QUICC Engines require OF_QE to set UCC MAC
61911ccc33fSMarcel Ziswiler		addresses
6203bb342fcSKim Phillips
6214e253137SKumar Gala		CONFIG_OF_BOARD_SETUP
6224e253137SKumar Gala
6234e253137SKumar Gala		Board code has addition modification that it wants to make
6244e253137SKumar Gala		to the flat device tree before handing it off to the kernel
6256705d81eSwdenk
626c654b517SSimon Glass		CONFIG_OF_SYSTEM_SETUP
627c654b517SSimon Glass
628c654b517SSimon Glass		Other code has addition modification that it wants to make
629c654b517SSimon Glass		to the flat device tree before handing it off to the kernel.
630c654b517SSimon Glass		This causes ft_system_setup() to be called before booting
631c654b517SSimon Glass		the kernel.
632c654b517SSimon Glass
6333887c3fbSHeiko Schocher		CONFIG_OF_IDE_FIXUP
6343887c3fbSHeiko Schocher
6353887c3fbSHeiko Schocher		U-Boot can detect if an IDE device is present or not.
6363887c3fbSHeiko Schocher		If not, and this new config option is activated, U-Boot
6373887c3fbSHeiko Schocher		removes the ATA node from the DTS before booting Linux,
6383887c3fbSHeiko Schocher		so the Linux IDE driver does not probe the device and
6393887c3fbSHeiko Schocher		crash. This is needed for buggy hardware (uc101) where
6403887c3fbSHeiko Schocher		no pull down resistor is connected to the signal IDE5V_DD7.
6413887c3fbSHeiko Schocher
6427eb29398SIgor Grinberg		CONFIG_MACH_TYPE	[relevant for ARM only][mandatory]
6437eb29398SIgor Grinberg
6447eb29398SIgor Grinberg		This setting is mandatory for all boards that have only one
6457eb29398SIgor Grinberg		machine type and must be used to specify the machine type
6467eb29398SIgor Grinberg		number as it appears in the ARM machine registry
6477eb29398SIgor Grinberg		(see http://www.arm.linux.org.uk/developer/machines/).
6487eb29398SIgor Grinberg		Only boards that have multiple machine types supported
6497eb29398SIgor Grinberg		in a single configuration file and the machine type is
6507eb29398SIgor Grinberg		runtime discoverable, do not have to use this setting.
6517eb29398SIgor Grinberg
6520b2f4ecaSNiklaus Giger- vxWorks boot parameters:
6530b2f4ecaSNiklaus Giger
6540b2f4ecaSNiklaus Giger		bootvx constructs a valid bootline using the following
6559e98b7e3SBin Meng		environments variables: bootdev, bootfile, ipaddr, netmask,
6569e98b7e3SBin Meng		serverip, gatewayip, hostname, othbootargs.
6570b2f4ecaSNiklaus Giger		It loads the vxWorks image pointed bootfile.
6580b2f4ecaSNiklaus Giger
6590b2f4ecaSNiklaus Giger		Note: If a "bootargs" environment is defined, it will overwride
6600b2f4ecaSNiklaus Giger		the defaults discussed just above.
6610b2f4ecaSNiklaus Giger
6622c451f78SAneesh V- Cache Configuration:
6632c451f78SAneesh V		CONFIG_SYS_ICACHE_OFF - Do not enable instruction cache in U-Boot
6642c451f78SAneesh V		CONFIG_SYS_DCACHE_OFF - Do not enable data cache in U-Boot
6652c451f78SAneesh V		CONFIG_SYS_L2CACHE_OFF- Do not enable L2 cache in U-Boot
6662c451f78SAneesh V
66793bc2193SAneesh V- Cache Configuration for ARM:
66893bc2193SAneesh V		CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
66993bc2193SAneesh V				      controller
67093bc2193SAneesh V		CONFIG_SYS_PL310_BASE - Physical base address of PL310
67193bc2193SAneesh V					controller register space
67293bc2193SAneesh V
6736705d81eSwdenk- Serial Ports:
67448d0192fSAndreas Engel		CONFIG_PL010_SERIAL
6756705d81eSwdenk
6766705d81eSwdenk		Define this if you want support for Amba PrimeCell PL010 UARTs.
6776705d81eSwdenk
67848d0192fSAndreas Engel		CONFIG_PL011_SERIAL
6796705d81eSwdenk
6806705d81eSwdenk		Define this if you want support for Amba PrimeCell PL011 UARTs.
6816705d81eSwdenk
6826705d81eSwdenk		CONFIG_PL011_CLOCK
6836705d81eSwdenk
6846705d81eSwdenk		If you have Amba PrimeCell PL011 UARTs, set this variable to
6856705d81eSwdenk		the clock speed of the UARTs.
6866705d81eSwdenk
6876705d81eSwdenk		CONFIG_PL01x_PORTS
6886705d81eSwdenk
6896705d81eSwdenk		If you have Amba PrimeCell PL010 or PL011 UARTs on your board,
6906705d81eSwdenk		define this to a list of base addresses for each (supported)
6916705d81eSwdenk		port. See e.g. include/configs/versatile.h
6926705d81eSwdenk
693d57dee57SKaricheri, Muralidharan		CONFIG_SERIAL_HW_FLOW_CONTROL
694d57dee57SKaricheri, Muralidharan
695d57dee57SKaricheri, Muralidharan		Define this variable to enable hw flow control in serial driver.
696d57dee57SKaricheri, Muralidharan		Current user of this option is drivers/serial/nsl16550.c driver
6976705d81eSwdenk
698c609719bSwdenk- Console Baudrate:
699c609719bSwdenk		CONFIG_BAUDRATE - in bps
700c609719bSwdenk		Select one of the baudrates listed in
7016d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
702c609719bSwdenk
703c92fac91SHeiko Schocher- Console Rx buffer length
704c92fac91SHeiko Schocher		With CONFIG_SYS_SMC_RXBUFLEN it is possible to define
705c92fac91SHeiko Schocher		the maximum receive buffer length for the SMC.
706*5b8e76c3SHeiko Schocher		This option is actual only for 82xx possible.
707c92fac91SHeiko Schocher		If using CONFIG_SYS_SMC_RXBUFLEN also CONFIG_SYS_MAXIDLE
708c92fac91SHeiko Schocher		must be defined, to setup the maximum idle timeout for
709c92fac91SHeiko Schocher		the SMC.
710c92fac91SHeiko Schocher
711c609719bSwdenk- Autoboot Command:
712c609719bSwdenk		CONFIG_BOOTCOMMAND
713c609719bSwdenk		Only needed when CONFIG_BOOTDELAY is enabled;
714c609719bSwdenk		define a command string that is automatically executed
715c609719bSwdenk		when no character is read on the console interface
716c609719bSwdenk		within "Boot Delay" after reset.
717c609719bSwdenk
718c609719bSwdenk		CONFIG_BOOTARGS
719c609719bSwdenk		This can be used to pass arguments to the bootm
720c609719bSwdenk		command. The value of CONFIG_BOOTARGS goes into the
721c609719bSwdenk		environment value "bootargs".
722c609719bSwdenk
723c609719bSwdenk		CONFIG_RAMBOOT and CONFIG_NFSBOOT
724c609719bSwdenk		The value of these goes into the environment as
725c609719bSwdenk		"ramboot" and "nfsboot" respectively, and can be used
726c609719bSwdenk		as a convenience, when switching between booting from
72711ccc33fSMarcel Ziswiler		RAM and NFS.
728c609719bSwdenk
729eda0ba38SHeiko Schocher- Bootcount:
730eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
731eda0ba38SHeiko Schocher		Implements a mechanism for detecting a repeating reboot
732eda0ba38SHeiko Schocher		cycle, see:
733eda0ba38SHeiko Schocher		http://www.denx.de/wiki/view/DULG/UBootBootCountLimit
734eda0ba38SHeiko Schocher
735eda0ba38SHeiko Schocher		CONFIG_BOOTCOUNT_ENV
736eda0ba38SHeiko Schocher		If no softreset save registers are found on the hardware
737eda0ba38SHeiko Schocher		"bootcount" is stored in the environment. To prevent a
738eda0ba38SHeiko Schocher		saveenv on all reboots, the environment variable
739eda0ba38SHeiko Schocher		"upgrade_available" is used. If "upgrade_available" is
740eda0ba38SHeiko Schocher		0, "bootcount" is always 0, if "upgrade_available" is
741eda0ba38SHeiko Schocher		1 "bootcount" is incremented in the environment.
742eda0ba38SHeiko Schocher		So the Userspace Applikation must set the "upgrade_available"
743eda0ba38SHeiko Schocher		and "bootcount" variable to 0, if a boot was successfully.
744eda0ba38SHeiko Schocher
745c609719bSwdenk- Pre-Boot Commands:
746c609719bSwdenk		CONFIG_PREBOOT
747c609719bSwdenk
748c609719bSwdenk		When this option is #defined, the existence of the
749c609719bSwdenk		environment variable "preboot" will be checked
750c609719bSwdenk		immediately before starting the CONFIG_BOOTDELAY
751c609719bSwdenk		countdown and/or running the auto-boot command resp.
752c609719bSwdenk		entering interactive mode.
753c609719bSwdenk
754c609719bSwdenk		This feature is especially useful when "preboot" is
755c609719bSwdenk		automatically generated or modified. For an example
756c609719bSwdenk		see the LWMON board specific code: here "preboot" is
757c609719bSwdenk		modified when the user holds down a certain
758c609719bSwdenk		combination of keys on the (special) keyboard when
759c609719bSwdenk		booting the systems
760c609719bSwdenk
761c609719bSwdenk- Serial Download Echo Mode:
762c609719bSwdenk		CONFIG_LOADS_ECHO
763c609719bSwdenk		If defined to 1, all characters received during a
764c609719bSwdenk		serial download (using the "loads" command) are
765c609719bSwdenk		echoed back. This might be needed by some terminal
766c609719bSwdenk		emulations (like "cu"), but may as well just take
767c609719bSwdenk		time on others. This setting #define's the initial
768c609719bSwdenk		value of the "loads_echo" environment variable.
769c609719bSwdenk
770602ad3b3SJon Loeliger- Kgdb Serial Baudrate: (if CONFIG_CMD_KGDB is defined)
771c609719bSwdenk		CONFIG_KGDB_BAUDRATE
772c609719bSwdenk		Select one of the baudrates listed in
7736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_BAUDRATE_TABLE, see below.
774c609719bSwdenk
775c609719bSwdenk- Monitor Functions:
776602ad3b3SJon Loeliger		Monitor commands can be included or excluded
777602ad3b3SJon Loeliger		from the build by using the #include files
778c6c621bdSStephen Warren		<config_cmd_all.h> and #undef'ing unwanted
779ef0f2f57SJoe Hershberger		commands, or adding #define's for wanted commands.
780c609719bSwdenk
781602ad3b3SJon Loeliger		The default command configuration includes all commands
782602ad3b3SJon Loeliger		except those marked below with a "*".
783602ad3b3SJon Loeliger
784b401b73dSMarek Vasut		CONFIG_CMD_AES		  AES 128 CBC encrypt/decrypt
785602ad3b3SJon Loeliger		CONFIG_CMD_ASKENV	* ask for env variable
786602ad3b3SJon Loeliger		CONFIG_CMD_BDI		  bdinfo
787602ad3b3SJon Loeliger		CONFIG_CMD_BOOTD	  bootd
788d2b2ffe3STom Rini		CONFIG_CMD_BOOTI	* ARM64 Linux kernel Image support
789602ad3b3SJon Loeliger		CONFIG_CMD_CACHE	* icache, dcache
790602ad3b3SJon Loeliger		CONFIG_CMD_CONSOLE	  coninfo
791602ad3b3SJon Loeliger		CONFIG_CMD_DHCP		* DHCP support
792602ad3b3SJon Loeliger		CONFIG_CMD_DIAG		* Diagnostics
793602ad3b3SJon Loeliger		CONFIG_CMD_ECHO		  echo arguments
794246c6922SPeter Tyser		CONFIG_CMD_EDITENV	  edit env variable
795602ad3b3SJon Loeliger		CONFIG_CMD_ELF		* bootelf, bootvx
79688733e2cSAndrew Ruder		CONFIG_CMD_ENV_EXISTS	* check existence of env variable
7970c79cda0SMike Frysinger		CONFIG_CMD_EXPORTENV	* export the environment
79803e2ecf6SStephen Warren		CONFIG_CMD_EXT2		* ext2 command support
79903e2ecf6SStephen Warren		CONFIG_CMD_EXT4		* ext4 command support
80016f4d933SStephen Warren		CONFIG_CMD_FS_GENERIC	* filesystem commands (e.g. load, ls)
80116f4d933SStephen Warren					  that work for multiple fs types
80259e890efSChristian Gmeiner		CONFIG_CMD_FS_UUID	* Look up a filesystem UUID
803bdab39d3SMike Frysinger		CONFIG_CMD_SAVEENV	  saveenv
804602ad3b3SJon Loeliger		CONFIG_CMD_FLASH	  flinfo, erase, protect
805602ad3b3SJon Loeliger		CONFIG_CMD_FPGA		  FPGA device initialization support
806a641b979SMike Frysinger		CONFIG_CMD_GO		* the 'go' command (exec code)
807a000b795SKim Phillips		CONFIG_CMD_GREPENV	* search environment
808602ad3b3SJon Loeliger		CONFIG_CMD_I2C		* I2C serial bus support
809602ad3b3SJon Loeliger		CONFIG_CMD_IMI		  iminfo
8108fdf1e0fSVipin Kumar		CONFIG_CMD_IMLS		  List all images found in NOR flash
8114d98b5c8SVincent Stehlé		CONFIG_CMD_IMLS_NAND	* List all images found in NAND flash
8120c79cda0SMike Frysinger		CONFIG_CMD_IMPORTENV	* import an environment
813c167cc02SJoe Hershberger		CONFIG_CMD_INI		* import data from an ini file into the env
814602ad3b3SJon Loeliger		CONFIG_CMD_ITEST	  Integer/string test of 2 values
8154d98b5c8SVincent Stehlé		CONFIG_CMD_LDRINFO	* ldrinfo (display Blackfin loader)
816d22c338eSJoe Hershberger		CONFIG_CMD_LINK_LOCAL	* link-local IP address auto-configuration
817d22c338eSJoe Hershberger					  (169.254.*.*)
818602ad3b3SJon Loeliger		CONFIG_CMD_LOADB	  loadb
819602ad3b3SJon Loeliger		CONFIG_CMD_LOADS	  loads
8204d98b5c8SVincent Stehlé		CONFIG_CMD_MD5SUM	* print md5 message digest
82102c9aa1dSRobin Getz					  (requires CONFIG_CMD_MEMORY and CONFIG_MD5)
82215a33e49SSimon Glass		CONFIG_CMD_MEMINFO	* Display detailed memory information
823602ad3b3SJon Loeliger		CONFIG_CMD_MEMORY	  md, mm, nm, mw, cp, cmp, crc, base,
824a2681707SWolfgang Denk					  loop, loopw
8254d98b5c8SVincent Stehlé		CONFIG_CMD_MEMTEST	* mtest
826602ad3b3SJon Loeliger		CONFIG_CMD_MISC		  Misc functions like sleep etc
827602ad3b3SJon Loeliger		CONFIG_CMD_MMC		* MMC memory mapped support
828602ad3b3SJon Loeliger		CONFIG_CMD_MII		* MII utility commands
82968d7d651SStefan Roese		CONFIG_CMD_MTDPARTS	* MTD partition support
830602ad3b3SJon Loeliger		CONFIG_CMD_NAND		* NAND support
831602ad3b3SJon Loeliger		CONFIG_CMD_NET		  bootp, tftpboot, rarpboot
8324d98b5c8SVincent Stehlé		CONFIG_CMD_NFS		  NFS support
833e92739d3SPeter Tyser		CONFIG_CMD_PCA953X	* PCA953x I2C gpio commands
834e92739d3SPeter Tyser		CONFIG_CMD_PCA953X_INFO * PCA953x I2C gpio info command
835602ad3b3SJon Loeliger		CONFIG_CMD_PCI		* pciinfo
836602ad3b3SJon Loeliger		CONFIG_CMD_PCMCIA		* PCMCIA support
837602ad3b3SJon Loeliger		CONFIG_CMD_PING		* send ICMP ECHO_REQUEST to network
838602ad3b3SJon Loeliger					  host
839602ad3b3SJon Loeliger		CONFIG_CMD_PORTIO	* Port I/O
840ff048ea9SKenneth Waters		CONFIG_CMD_READ		* Read raw data from partition
841602ad3b3SJon Loeliger		CONFIG_CMD_REGINFO	* Register dump
842602ad3b3SJon Loeliger		CONFIG_CMD_RUN		  run command in env variable
843d304931fSSimon Glass		CONFIG_CMD_SANDBOX	* sb command to access sandbox features
844602ad3b3SJon Loeliger		CONFIG_CMD_SAVES	* save S record dump
845c649e3c9SSimon Glass		CONFIG_SCSI		* SCSI Support
846602ad3b3SJon Loeliger		CONFIG_CMD_SDRAM	* print SDRAM configuration information
847602ad3b3SJon Loeliger					  (requires CONFIG_CMD_I2C)
848602ad3b3SJon Loeliger		CONFIG_CMD_SETGETDCR	  Support for DCR Register access
849602ad3b3SJon Loeliger					  (4xx only)
850f61ec45eSEric Nelson		CONFIG_CMD_SF		* Read/write/erase SPI NOR flash
8517d861d95SBob Liu		CONFIG_CMD_SOFTSWITCH	* Soft switch setting command for BF60x
85274de7aefSWolfgang Denk		CONFIG_CMD_SOURCE	  "source" command Support
853602ad3b3SJon Loeliger		CONFIG_CMD_SPI		* SPI serial bus support
8547a83af07SLuca Ceresoli		CONFIG_CMD_TFTPSRV	* TFTP transfer in server mode
8551fb7cd49SSimon Glass		CONFIG_CMD_TFTPPUT	* TFTP put command (upload)
856da83bcd7SJoe Hershberger		CONFIG_CMD_TIME		* run command and report execution time (ARM specific)
857da83bcd7SJoe Hershberger		CONFIG_CMD_TIMER	* access to the system tick timer
858602ad3b3SJon Loeliger		CONFIG_CMD_USB		* USB support
859602ad3b3SJon Loeliger		CONFIG_CMD_CDP		* Cisco Discover Protocol support
860c8339f51SMarek Vasut		CONFIG_CMD_MFSL		* Microblaze FSL support
8614d98b5c8SVincent Stehlé		CONFIG_CMD_XIMG		  Load part of Multi Image
86289c8230dSPrzemyslaw Marczak		CONFIG_CMD_UUID		* Generate random UUID or GUID string
863c609719bSwdenk
864c609719bSwdenk		EXAMPLE: If you want all functions except of network
865c609719bSwdenk		support you can write:
866c609719bSwdenk
867602ad3b3SJon Loeliger		#include "config_cmd_all.h"
868602ad3b3SJon Loeliger		#undef CONFIG_CMD_NET
869c609719bSwdenk
870213bf8c8SGerald Van Baren	Other Commands:
871213bf8c8SGerald Van Baren		fdt (flattened device tree) command: CONFIG_OF_LIBFDT
872c609719bSwdenk
873c609719bSwdenk	Note:	Don't enable the "icache" and "dcache" commands
874602ad3b3SJon Loeliger		(configuration option CONFIG_CMD_CACHE) unless you know
875c609719bSwdenk		what you (and your U-Boot users) are doing. Data
876*5b8e76c3SHeiko Schocher		cache cannot be enabled on systems like the
877c609719bSwdenk		8260 (where accesses to the IMMR region must be
878c609719bSwdenk		uncached), and it cannot be disabled on all other
879c609719bSwdenk		systems where we (mis-) use the data cache to hold an
880c609719bSwdenk		initial stack and some data.
881c609719bSwdenk
882c609719bSwdenk
883c609719bSwdenk		XXX - this list needs to get updated!
884c609719bSwdenk
885302a6487SSimon Glass- Removal of commands
886302a6487SSimon Glass		If no commands are needed to boot, you can disable
887302a6487SSimon Glass		CONFIG_CMDLINE to remove them. In this case, the command line
888302a6487SSimon Glass		will not be available, and when U-Boot wants to execute the
889302a6487SSimon Glass		boot command (on start-up) it will call board_run_command()
890302a6487SSimon Glass		instead. This can reduce image size significantly for very
891302a6487SSimon Glass		simple boot procedures.
892302a6487SSimon Glass
893a5ecbe62SWolfgang Denk- Regular expression support:
894a5ecbe62SWolfgang Denk		CONFIG_REGEX
895a5ecbe62SWolfgang Denk		If this variable is defined, U-Boot is linked against
896a5ecbe62SWolfgang Denk		the SLRE (Super Light Regular Expression) library,
897a5ecbe62SWolfgang Denk		which adds regex support to some commands, as for
898a5ecbe62SWolfgang Denk		example "env grep" and "setexpr".
899a5ecbe62SWolfgang Denk
90045ba8077SSimon Glass- Device tree:
90145ba8077SSimon Glass		CONFIG_OF_CONTROL
90245ba8077SSimon Glass		If this variable is defined, U-Boot will use a device tree
90345ba8077SSimon Glass		to configure its devices, instead of relying on statically
90445ba8077SSimon Glass		compiled #defines in the board file. This option is
90545ba8077SSimon Glass		experimental and only available on a few boards. The device
90645ba8077SSimon Glass		tree is available in the global data as gd->fdt_blob.
90745ba8077SSimon Glass
9082c0f79e4SSimon Glass		U-Boot needs to get its device tree from somewhere. This can
90982f766d1SAlex Deymo		be done using one of the three options below:
910bbb0b128SSimon Glass
911bbb0b128SSimon Glass		CONFIG_OF_EMBED
912bbb0b128SSimon Glass		If this variable is defined, U-Boot will embed a device tree
913bbb0b128SSimon Glass		binary in its image. This device tree file should be in the
914bbb0b128SSimon Glass		board directory and called <soc>-<board>.dts. The binary file
915bbb0b128SSimon Glass		is then picked up in board_init_f() and made available through
916bbb0b128SSimon Glass		the global data structure as gd->blob.
91745ba8077SSimon Glass
9182c0f79e4SSimon Glass		CONFIG_OF_SEPARATE
9192c0f79e4SSimon Glass		If this variable is defined, U-Boot will build a device tree
9202c0f79e4SSimon Glass		binary. It will be called u-boot.dtb. Architecture-specific
9212c0f79e4SSimon Glass		code will locate it at run-time. Generally this works by:
9222c0f79e4SSimon Glass
9232c0f79e4SSimon Glass			cat u-boot.bin u-boot.dtb >image.bin
9242c0f79e4SSimon Glass
9252c0f79e4SSimon Glass		and in fact, U-Boot does this for you, creating a file called
9262c0f79e4SSimon Glass		u-boot-dtb.bin which is useful in the common case. You can
9272c0f79e4SSimon Glass		still use the individual files if you need something more
9282c0f79e4SSimon Glass		exotic.
9292c0f79e4SSimon Glass
93082f766d1SAlex Deymo		CONFIG_OF_BOARD
93182f766d1SAlex Deymo		If this variable is defined, U-Boot will use the device tree
93282f766d1SAlex Deymo		provided by the board at runtime instead of embedding one with
93382f766d1SAlex Deymo		the image. Only boards defining board_fdt_blob_setup() support
93482f766d1SAlex Deymo		this option (see include/fdtdec.h file).
93582f766d1SAlex Deymo
936c609719bSwdenk- Watchdog:
937c609719bSwdenk		CONFIG_WATCHDOG
938c609719bSwdenk		If this variable is defined, it enables watchdog
9396abe6fb6SDetlev Zundel		support for the SoC. There must be support in the SoC
940*5b8e76c3SHeiko Schocher		specific code for a watchdog. For the 8260
9416abe6fb6SDetlev Zundel		CPUs, the SIU Watchdog feature is enabled in the SYPCR
9426abe6fb6SDetlev Zundel		register.  When supported for a specific SoC is
9436abe6fb6SDetlev Zundel		available, then no further board specific code should
9446abe6fb6SDetlev Zundel		be needed to use it.
9456abe6fb6SDetlev Zundel
9466abe6fb6SDetlev Zundel		CONFIG_HW_WATCHDOG
9476abe6fb6SDetlev Zundel		When using a watchdog circuitry external to the used
9486abe6fb6SDetlev Zundel		SoC, then define this variable and provide board
9496abe6fb6SDetlev Zundel		specific code for the "hw_watchdog_reset" function.
950c609719bSwdenk
9517bae0d6fSHeiko Schocher		CONFIG_AT91_HW_WDT_TIMEOUT
9527bae0d6fSHeiko Schocher		specify the timeout in seconds. default 2 seconds.
9537bae0d6fSHeiko Schocher
954c1551ea8Sstroese- U-Boot Version:
955c1551ea8Sstroese		CONFIG_VERSION_VARIABLE
956c1551ea8Sstroese		If this variable is defined, an environment variable
957c1551ea8Sstroese		named "ver" is created by U-Boot showing the U-Boot
958c1551ea8Sstroese		version as printed by the "version" command.
959a1ea8e51SBenoît Thébaudeau		Any change to this variable will be reverted at the
960a1ea8e51SBenoît Thébaudeau		next reset.
961c1551ea8Sstroese
962c609719bSwdenk- Real-Time Clock:
963c609719bSwdenk
964602ad3b3SJon Loeliger		When CONFIG_CMD_DATE is selected, the type of the RTC
965c609719bSwdenk		has to be selected, too. Define exactly one of the
966c609719bSwdenk		following options:
967c609719bSwdenk
968c609719bSwdenk		CONFIG_RTC_PCF8563	- use Philips PCF8563 RTC
9694e8b7544SFabio Estevam		CONFIG_RTC_MC13XXX	- use MC13783 or MC13892 RTC
970c609719bSwdenk		CONFIG_RTC_MC146818	- use MC146818 RTC
9711cb8e980Swdenk		CONFIG_RTC_DS1307	- use Maxim, Inc. DS1307 RTC
972c609719bSwdenk		CONFIG_RTC_DS1337	- use Maxim, Inc. DS1337 RTC
9737f70e853Swdenk		CONFIG_RTC_DS1338	- use Maxim, Inc. DS1338 RTC
974412921d2SMarkus Niebel		CONFIG_RTC_DS1339	- use Maxim, Inc. DS1339 RTC
9753bac3513Swdenk		CONFIG_RTC_DS164x	- use Dallas DS164x RTC
9769536dfccSTor Krill		CONFIG_RTC_ISL1208	- use Intersil ISL1208 RTC
9774c0d4c3bSwdenk		CONFIG_RTC_MAX6900	- use Maxim, Inc. MAX6900 RTC
9782bd3cab3SChris Packham		CONFIG_RTC_DS1337_NOOSC	- Turn off the OSC output for DS1337
97971d19f30SHeiko Schocher		CONFIG_SYS_RV3029_TCR	- enable trickle charger on
98071d19f30SHeiko Schocher					  RV3029 RTC.
981c609719bSwdenk
982b37c7e5eSwdenk		Note that if the RTC uses I2C, then the I2C interface
983b37c7e5eSwdenk		must also be configured. See I2C Support, below.
984b37c7e5eSwdenk
985e92739d3SPeter Tyser- GPIO Support:
986e92739d3SPeter Tyser		CONFIG_PCA953X		- use NXP's PCA953X series I2C GPIO
987e92739d3SPeter Tyser
9885dec49caSChris Packham		The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
9895dec49caSChris Packham		chip-ngpio pairs that tell the PCA953X driver the number of
9905dec49caSChris Packham		pins supported by a particular chip.
9915dec49caSChris Packham
992e92739d3SPeter Tyser		Note that if the GPIO device uses I2C, then the I2C interface
993e92739d3SPeter Tyser		must also be configured. See I2C Support, below.
994e92739d3SPeter Tyser
995aa53233aSSimon Glass- I/O tracing:
996aa53233aSSimon Glass		When CONFIG_IO_TRACE is selected, U-Boot intercepts all I/O
997aa53233aSSimon Glass		accesses and can checksum them or write a list of them out
998aa53233aSSimon Glass		to memory. See the 'iotrace' command for details. This is
999aa53233aSSimon Glass		useful for testing device drivers since it can confirm that
1000aa53233aSSimon Glass		the driver behaves the same way before and after a code
1001aa53233aSSimon Glass		change. Currently this is supported on sandbox and arm. To
1002aa53233aSSimon Glass		add support for your architecture, add '#include <iotrace.h>'
1003aa53233aSSimon Glass		to the bottom of arch/<arch>/include/asm/io.h and test.
1004aa53233aSSimon Glass
1005aa53233aSSimon Glass		Example output from the 'iotrace stats' command is below.
1006aa53233aSSimon Glass		Note that if the trace buffer is exhausted, the checksum will
1007aa53233aSSimon Glass		still continue to operate.
1008aa53233aSSimon Glass
1009aa53233aSSimon Glass			iotrace is enabled
1010aa53233aSSimon Glass			Start:  10000000	(buffer start address)
1011aa53233aSSimon Glass			Size:   00010000	(buffer size)
1012aa53233aSSimon Glass			Offset: 00000120	(current buffer offset)
1013aa53233aSSimon Glass			Output: 10000120	(start + offset)
1014aa53233aSSimon Glass			Count:  00000018	(number of trace records)
1015aa53233aSSimon Glass			CRC32:  9526fb66	(CRC32 of all trace records)
1016aa53233aSSimon Glass
1017c609719bSwdenk- Timestamp Support:
1018c609719bSwdenk
1019c609719bSwdenk		When CONFIG_TIMESTAMP is selected, the timestamp
1020c609719bSwdenk		(date and time) of an image is printed by image
1021c609719bSwdenk		commands like bootm or iminfo. This option is
1022602ad3b3SJon Loeliger		automatically enabled when you select CONFIG_CMD_DATE .
1023c609719bSwdenk
1024923c46f9SKarl O. Pinc- Partition Labels (disklabels) Supported:
1025923c46f9SKarl O. Pinc		Zero or more of the following:
1026923c46f9SKarl O. Pinc		CONFIG_MAC_PARTITION   Apple's MacOS partition table.
1027923c46f9SKarl O. Pinc		CONFIG_ISO_PARTITION   ISO partition table, used on CDROM etc.
1028923c46f9SKarl O. Pinc		CONFIG_EFI_PARTITION   GPT partition table, common when EFI is the
1029923c46f9SKarl O. Pinc				       bootloader.  Note 2TB partition limit; see
1030923c46f9SKarl O. Pinc				       disk/part_efi.c
1031923c46f9SKarl O. Pinc		CONFIG_MTD_PARTITIONS  Memory Technology Device partition table.
1032c609719bSwdenk
1033fc843a02SSimon Glass		If IDE or SCSI support is enabled (CONFIG_IDE or
1034c649e3c9SSimon Glass		CONFIG_SCSI) you must configure support for at
1035923c46f9SKarl O. Pinc		least one non-MTD partition type as well.
1036c609719bSwdenk
1037c609719bSwdenk- IDE Reset method:
10384d13cbadSwdenk		CONFIG_IDE_RESET_ROUTINE - this is defined in several
10394d13cbadSwdenk		board configurations files but used nowhere!
1040c609719bSwdenk
10414d13cbadSwdenk		CONFIG_IDE_RESET - is this is defined, IDE Reset will
10424d13cbadSwdenk		be performed by calling the function
10434d13cbadSwdenk			ide_set_reset(int reset)
10444d13cbadSwdenk		which has to be defined in a board specific file
1045c609719bSwdenk
1046c609719bSwdenk- ATAPI Support:
1047c609719bSwdenk		CONFIG_ATAPI
1048c609719bSwdenk
1049c609719bSwdenk		Set this to enable ATAPI support.
1050c609719bSwdenk
1051c40b2956Swdenk- LBA48 Support
1052c40b2956Swdenk		CONFIG_LBA48
1053c40b2956Swdenk
1054c40b2956Swdenk		Set this to enable support for disks larger than 137GB
10554b142febSHeiko Schocher		Also look at CONFIG_SYS_64BIT_LBA.
1056c40b2956Swdenk		Whithout these , LBA48 support uses 32bit variables and will 'only'
1057c40b2956Swdenk		support disks up to 2.1TB.
1058c40b2956Swdenk
10596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_64BIT_LBA:
1060c40b2956Swdenk			When enabled, makes the IDE subsystem use 64bit sector addresses.
1061c40b2956Swdenk			Default is 32bit.
1062c40b2956Swdenk
1063c609719bSwdenk- SCSI Support:
1064c609719bSwdenk		At the moment only there is only support for the
1065c609719bSwdenk		SYM53C8XX SCSI controller; define
1066c609719bSwdenk		CONFIG_SCSI_SYM53C8XX to enable it.
1067c609719bSwdenk
10686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN [8], CONFIG_SYS_SCSI_MAX_SCSI_ID [7] and
10696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_DEVICE [CONFIG_SYS_SCSI_MAX_SCSI_ID *
10706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_MAX_LUN] can be adjusted to define the
1071c609719bSwdenk		maximum numbers of LUNs, SCSI ID's and target
1072c609719bSwdenk		devices.
10736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
1074c609719bSwdenk
1075447c031bSStefan Reinauer		The environment variable 'scsidevs' is set to the number of
1076447c031bSStefan Reinauer		SCSI devices found during the last scan.
1077447c031bSStefan Reinauer
1078c609719bSwdenk- NETWORK Support (PCI):
1079682011ffSwdenk		CONFIG_E1000
1080ce5207e1SKyle Moffett		Support for Intel 8254x/8257x gigabit chips.
1081ce5207e1SKyle Moffett
1082ce5207e1SKyle Moffett		CONFIG_E1000_SPI
1083ce5207e1SKyle Moffett		Utility code for direct access to the SPI bus on Intel 8257x.
1084ce5207e1SKyle Moffett		This does not do anything useful unless you set at least one
1085ce5207e1SKyle Moffett		of CONFIG_CMD_E1000 or CONFIG_E1000_SPI_GENERIC.
1086ce5207e1SKyle Moffett
1087ce5207e1SKyle Moffett		CONFIG_E1000_SPI_GENERIC
1088ce5207e1SKyle Moffett		Allow generic access to the SPI bus on the Intel 8257x, for
1089ce5207e1SKyle Moffett		example with the "sspi" command.
1090ce5207e1SKyle Moffett
1091ce5207e1SKyle Moffett		CONFIG_CMD_E1000
1092ce5207e1SKyle Moffett		Management command for E1000 devices.  When used on devices
1093ce5207e1SKyle Moffett		with SPI support you can reprogram the EEPROM from U-Boot.
1094682011ffSwdenk
1095c609719bSwdenk		CONFIG_EEPRO100
1096c609719bSwdenk		Support for Intel 82557/82559/82559ER chips.
109711ccc33fSMarcel Ziswiler		Optional CONFIG_EEPRO100_SROM_WRITE enables EEPROM
1098c609719bSwdenk		write routine for first time initialisation.
1099c609719bSwdenk
1100c609719bSwdenk		CONFIG_TULIP
1101c609719bSwdenk		Support for Digital 2114x chips.
1102c609719bSwdenk		Optional CONFIG_TULIP_SELECT_MEDIA for board specific
1103c609719bSwdenk		modem chip initialisation (KS8761/QS6611).
1104c609719bSwdenk
1105c609719bSwdenk		CONFIG_NATSEMI
1106c609719bSwdenk		Support for National dp83815 chips.
1107c609719bSwdenk
1108c609719bSwdenk		CONFIG_NS8382X
1109c609719bSwdenk		Support for National dp8382[01] gigabit chips.
1110c609719bSwdenk
111145219c46Swdenk- NETWORK Support (other):
111245219c46Swdenk
1113c041e9d2SJens Scharsig		CONFIG_DRIVER_AT91EMAC
1114c041e9d2SJens Scharsig		Support for AT91RM9200 EMAC.
1115c041e9d2SJens Scharsig
1116c041e9d2SJens Scharsig			CONFIG_RMII
1117c041e9d2SJens Scharsig			Define this to use reduced MII inteface
1118c041e9d2SJens Scharsig
1119c041e9d2SJens Scharsig			CONFIG_DRIVER_AT91EMAC_QUIET
1120c041e9d2SJens Scharsig			If this defined, the driver is quiet.
1121c041e9d2SJens Scharsig			The driver doen't show link status messages.
1122c041e9d2SJens Scharsig
1123efdd7319SRob Herring		CONFIG_CALXEDA_XGMAC
1124efdd7319SRob Herring		Support for the Calxeda XGMAC device
1125efdd7319SRob Herring
11263bb46d23SAshok		CONFIG_LAN91C96
112745219c46Swdenk		Support for SMSC's LAN91C96 chips.
112845219c46Swdenk
112945219c46Swdenk			CONFIG_LAN91C96_USE_32_BIT
113045219c46Swdenk			Define this to enable 32 bit addressing
113145219c46Swdenk
11323bb46d23SAshok		CONFIG_SMC91111
1133f39748aeSwdenk		Support for SMSC's LAN91C111 chip
1134f39748aeSwdenk
1135f39748aeSwdenk			CONFIG_SMC91111_BASE
1136f39748aeSwdenk			Define this to hold the physical address
1137f39748aeSwdenk			of the device (I/O space)
1138f39748aeSwdenk
1139f39748aeSwdenk			CONFIG_SMC_USE_32_BIT
1140f39748aeSwdenk			Define this if data bus is 32 bits
1141f39748aeSwdenk
1142f39748aeSwdenk			CONFIG_SMC_USE_IOFUNCS
1143f39748aeSwdenk			Define this to use i/o functions instead of macros
1144f39748aeSwdenk			(some hardware wont work with macros)
1145f39748aeSwdenk
1146dc02badaSHeiko Schocher		CONFIG_DRIVER_TI_EMAC
1147dc02badaSHeiko Schocher		Support for davinci emac
1148dc02badaSHeiko Schocher
1149dc02badaSHeiko Schocher			CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
1150dc02badaSHeiko Schocher			Define this if you have more then 3 PHYs.
1151dc02badaSHeiko Schocher
1152b3dbf4a5SMacpaul Lin		CONFIG_FTGMAC100
1153b3dbf4a5SMacpaul Lin		Support for Faraday's FTGMAC100 Gigabit SoC Ethernet
1154b3dbf4a5SMacpaul Lin
1155b3dbf4a5SMacpaul Lin			CONFIG_FTGMAC100_EGIGA
1156b3dbf4a5SMacpaul Lin			Define this to use GE link update with gigabit PHY.
1157b3dbf4a5SMacpaul Lin			Define this if FTGMAC100 is connected to gigabit PHY.
1158b3dbf4a5SMacpaul Lin			If your system has 10/100 PHY only, it might not occur
1159b3dbf4a5SMacpaul Lin			wrong behavior. Because PHY usually return timeout or
1160b3dbf4a5SMacpaul Lin			useless data when polling gigabit status and gigabit
1161b3dbf4a5SMacpaul Lin			control registers. This behavior won't affect the
1162b3dbf4a5SMacpaul Lin			correctnessof 10/100 link speed update.
1163b3dbf4a5SMacpaul Lin
1164c2fff331SMike Rapoport		CONFIG_SMC911X
1165557b377dSJens Gehrlein		Support for SMSC's LAN911x and LAN921x chips
1166557b377dSJens Gehrlein
1167c2fff331SMike Rapoport			CONFIG_SMC911X_BASE
1168557b377dSJens Gehrlein			Define this to hold the physical address
1169557b377dSJens Gehrlein			of the device (I/O space)
1170557b377dSJens Gehrlein
1171c2fff331SMike Rapoport			CONFIG_SMC911X_32_BIT
1172557b377dSJens Gehrlein			Define this if data bus is 32 bits
1173557b377dSJens Gehrlein
1174c2fff331SMike Rapoport			CONFIG_SMC911X_16_BIT
1175557b377dSJens Gehrlein			Define this if data bus is 16 bits. If your processor
1176557b377dSJens Gehrlein			automatically converts one 32 bit word to two 16 bit
1177c2fff331SMike Rapoport			words you may also try CONFIG_SMC911X_32_BIT.
1178557b377dSJens Gehrlein
11793d0075faSYoshihiro Shimoda		CONFIG_SH_ETHER
11803d0075faSYoshihiro Shimoda		Support for Renesas on-chip Ethernet controller
11813d0075faSYoshihiro Shimoda
11823d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_USE_PORT
11833d0075faSYoshihiro Shimoda			Define the number of ports to be used
11843d0075faSYoshihiro Shimoda
11853d0075faSYoshihiro Shimoda			CONFIG_SH_ETHER_PHY_ADDR
11863d0075faSYoshihiro Shimoda			Define the ETH PHY's address
11873d0075faSYoshihiro Shimoda
118868260aabSYoshihiro Shimoda			CONFIG_SH_ETHER_CACHE_WRITEBACK
118968260aabSYoshihiro Shimoda			If this option is set, the driver enables cache flush.
119068260aabSYoshihiro Shimoda
1191b2f97cf2SHeiko Schocher- PWM Support:
1192b2f97cf2SHeiko Schocher		CONFIG_PWM_IMX
11935052e819SRobert P. J. Day		Support for PWM module on the imx6.
1194b2f97cf2SHeiko Schocher
11955e124724SVadim Bendebury- TPM Support:
119690899cc0SChe-liang Chiou		CONFIG_TPM
119790899cc0SChe-liang Chiou		Support TPM devices.
119890899cc0SChe-liang Chiou
11990766ad2fSChristophe Ricard		CONFIG_TPM_TIS_INFINEON
12000766ad2fSChristophe Ricard		Support for Infineon i2c bus TPM devices. Only one device
12011b393db5STom Wai-Hong Tam		per system is supported at this time.
12021b393db5STom Wai-Hong Tam
12031b393db5STom Wai-Hong Tam			CONFIG_TPM_TIS_I2C_BURST_LIMITATION
12041b393db5STom Wai-Hong Tam			Define the burst count bytes upper limit
12051b393db5STom Wai-Hong Tam
12063aa74088SChristophe Ricard		CONFIG_TPM_ST33ZP24
12073aa74088SChristophe Ricard		Support for STMicroelectronics TPM devices. Requires DM_TPM support.
12083aa74088SChristophe Ricard
12093aa74088SChristophe Ricard			CONFIG_TPM_ST33ZP24_I2C
12103aa74088SChristophe Ricard			Support for STMicroelectronics ST33ZP24 I2C devices.
12113aa74088SChristophe Ricard			Requires TPM_ST33ZP24 and I2C.
12123aa74088SChristophe Ricard
1213b75fdc11SChristophe Ricard			CONFIG_TPM_ST33ZP24_SPI
1214b75fdc11SChristophe Ricard			Support for STMicroelectronics ST33ZP24 SPI devices.
1215b75fdc11SChristophe Ricard			Requires TPM_ST33ZP24 and SPI.
1216b75fdc11SChristophe Ricard
1217c01939c7SDirk Eibach		CONFIG_TPM_ATMEL_TWI
1218c01939c7SDirk Eibach		Support for Atmel TWI TPM device. Requires I2C support.
1219c01939c7SDirk Eibach
122090899cc0SChe-liang Chiou		CONFIG_TPM_TIS_LPC
12215e124724SVadim Bendebury		Support for generic parallel port TPM devices. Only one device
12225e124724SVadim Bendebury		per system is supported at this time.
12235e124724SVadim Bendebury
12245e124724SVadim Bendebury			CONFIG_TPM_TIS_BASE_ADDRESS
12255e124724SVadim Bendebury			Base address where the generic TPM device is mapped
12265e124724SVadim Bendebury			to. Contemporary x86 systems usually map it at
12275e124724SVadim Bendebury			0xfed40000.
12285e124724SVadim Bendebury
1229be6c1529SReinhard Pfau		CONFIG_CMD_TPM
1230be6c1529SReinhard Pfau		Add tpm monitor functions.
1231be6c1529SReinhard Pfau		Requires CONFIG_TPM. If CONFIG_TPM_AUTH_SESSIONS is set, also
1232be6c1529SReinhard Pfau		provides monitor access to authorized functions.
1233be6c1529SReinhard Pfau
1234be6c1529SReinhard Pfau		CONFIG_TPM
1235be6c1529SReinhard Pfau		Define this to enable the TPM support library which provides
1236be6c1529SReinhard Pfau		functional interfaces to some TPM commands.
1237be6c1529SReinhard Pfau		Requires support for a TPM device.
1238be6c1529SReinhard Pfau
1239be6c1529SReinhard Pfau		CONFIG_TPM_AUTH_SESSIONS
1240be6c1529SReinhard Pfau		Define this to enable authorized functions in the TPM library.
1241be6c1529SReinhard Pfau		Requires CONFIG_TPM and CONFIG_SHA1.
1242be6c1529SReinhard Pfau
1243c609719bSwdenk- USB Support:
1244c609719bSwdenk		At the moment only the UHCI host controller is
12454d13cbadSwdenk		supported (PIP405, MIP405, MPC5200); define
1246c609719bSwdenk		CONFIG_USB_UHCI to enable it.
1247c609719bSwdenk		define CONFIG_USB_KEYBOARD to enable the USB Keyboard
124830d56faeSwdenk		and define CONFIG_USB_STORAGE to enable the USB
1249c609719bSwdenk		storage devices.
1250c609719bSwdenk		Note:
1251c609719bSwdenk		Supported are USB Keyboards and USB Floppy drives
1252c609719bSwdenk		(TEAC FD-05PUB).
12534d13cbadSwdenk		MPC5200 USB requires additional defines:
12544d13cbadSwdenk			CONFIG_USB_CLOCK
12554d13cbadSwdenk				for 528 MHz Clock: 0x0001bbbb
1256307ecb6dSEric Millbrandt			CONFIG_PSC3_USB
1257307ecb6dSEric Millbrandt				for USB on PSC3
12584d13cbadSwdenk			CONFIG_USB_CONFIG
12594d13cbadSwdenk				for differential drivers: 0x00001000
12604d13cbadSwdenk				for single ended drivers: 0x00005000
1261307ecb6dSEric Millbrandt				for differential drivers on PSC3: 0x00000100
1262307ecb6dSEric Millbrandt				for single ended drivers on PSC3: 0x00004100
12636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_USB_EVENT_POLL
1264fdcfaa1bSZhang Wei				May be defined to allow interrupt polling
1265fdcfaa1bSZhang Wei				instead of using asynchronous interrupts
12664d13cbadSwdenk
12679ab4ce22SSimon Glass		CONFIG_USB_EHCI_TXFIFO_THRESH enables setting of the
12689ab4ce22SSimon Glass		txfilltuning field in the EHCI controller on reset.
12699ab4ce22SSimon Glass
12706e9e0626SOleksandr Tymoshenko		CONFIG_USB_DWC2_REG_ADDR the physical CPU address of the DWC2
12716e9e0626SOleksandr Tymoshenko		HW module registers.
12726e9e0626SOleksandr Tymoshenko
127316c8d5e7SWolfgang Denk- USB Device:
127416c8d5e7SWolfgang Denk		Define the below if you wish to use the USB console.
127516c8d5e7SWolfgang Denk		Once firmware is rebuilt from a serial console issue the
127616c8d5e7SWolfgang Denk		command "setenv stdin usbtty; setenv stdout usbtty" and
127711ccc33fSMarcel Ziswiler		attach your USB cable. The Unix command "dmesg" should print
127816c8d5e7SWolfgang Denk		it has found a new device. The environment variable usbtty
127916c8d5e7SWolfgang Denk		can be set to gserial or cdc_acm to enable your device to
128016c8d5e7SWolfgang Denk		appear to a USB host as a Linux gserial device or a
128116c8d5e7SWolfgang Denk		Common Device Class Abstract Control Model serial device.
128216c8d5e7SWolfgang Denk		If you select usbtty = gserial you should be able to enumerate
128316c8d5e7SWolfgang Denk		a Linux host by
128416c8d5e7SWolfgang Denk		# modprobe usbserial vendor=0xVendorID product=0xProductID
128516c8d5e7SWolfgang Denk		else if using cdc_acm, simply setting the environment
128616c8d5e7SWolfgang Denk		variable usbtty to be cdc_acm should suffice. The following
128716c8d5e7SWolfgang Denk		might be defined in YourBoardName.h
128816c8d5e7SWolfgang Denk
128916c8d5e7SWolfgang Denk			CONFIG_USB_DEVICE
129016c8d5e7SWolfgang Denk			Define this to build a UDC device
129116c8d5e7SWolfgang Denk
129216c8d5e7SWolfgang Denk			CONFIG_USB_TTY
129316c8d5e7SWolfgang Denk			Define this to have a tty type of device available to
129416c8d5e7SWolfgang Denk			talk to the UDC device
129516c8d5e7SWolfgang Denk
1296f9da0f89SVipin KUMAR			CONFIG_USBD_HS
1297f9da0f89SVipin KUMAR			Define this to enable the high speed support for usb
1298f9da0f89SVipin KUMAR			device and usbtty. If this feature is enabled, a routine
1299f9da0f89SVipin KUMAR			int is_usbd_high_speed(void)
1300f9da0f89SVipin KUMAR			also needs to be defined by the driver to dynamically poll
1301f9da0f89SVipin KUMAR			whether the enumeration has succeded at high speed or full
1302f9da0f89SVipin KUMAR			speed.
1303f9da0f89SVipin KUMAR
13046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			CONFIG_SYS_CONSOLE_IS_IN_ENV
130516c8d5e7SWolfgang Denk			Define this if you want stdin, stdout &/or stderr to
130616c8d5e7SWolfgang Denk			be set to usbtty.
130716c8d5e7SWolfgang Denk
130816c8d5e7SWolfgang Denk		If you have a USB-IF assigned VendorID then you may wish to
130916c8d5e7SWolfgang Denk		define your own vendor specific values either in BoardName.h
131016c8d5e7SWolfgang Denk		or directly in usbd_vendor_info.h. If you don't define
131116c8d5e7SWolfgang Denk		CONFIG_USBD_MANUFACTURER, CONFIG_USBD_PRODUCT_NAME,
131216c8d5e7SWolfgang Denk		CONFIG_USBD_VENDORID and CONFIG_USBD_PRODUCTID, then U-Boot
131316c8d5e7SWolfgang Denk		should pretend to be a Linux device to it's target host.
131416c8d5e7SWolfgang Denk
131516c8d5e7SWolfgang Denk			CONFIG_USBD_MANUFACTURER
131616c8d5e7SWolfgang Denk			Define this string as the name of your company for
131716c8d5e7SWolfgang Denk			- CONFIG_USBD_MANUFACTURER "my company"
131816c8d5e7SWolfgang Denk
131916c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCT_NAME
132016c8d5e7SWolfgang Denk			Define this string as the name of your product
132116c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCT_NAME "acme usb device"
132216c8d5e7SWolfgang Denk
132316c8d5e7SWolfgang Denk			CONFIG_USBD_VENDORID
132416c8d5e7SWolfgang Denk			Define this as your assigned Vendor ID from the USB
132516c8d5e7SWolfgang Denk			Implementors Forum. This *must* be a genuine Vendor ID
132616c8d5e7SWolfgang Denk			to avoid polluting the USB namespace.
132716c8d5e7SWolfgang Denk			- CONFIG_USBD_VENDORID 0xFFFF
132816c8d5e7SWolfgang Denk
132916c8d5e7SWolfgang Denk			CONFIG_USBD_PRODUCTID
133016c8d5e7SWolfgang Denk			Define this as the unique Product ID
133116c8d5e7SWolfgang Denk			for your device
133216c8d5e7SWolfgang Denk			- CONFIG_USBD_PRODUCTID 0xFFFF
1333c609719bSwdenk
1334d70a560fSIgor Grinberg- ULPI Layer Support:
1335d70a560fSIgor Grinberg		The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
1336d70a560fSIgor Grinberg		the generic ULPI layer. The generic layer accesses the ULPI PHY
1337d70a560fSIgor Grinberg		via the platform viewport, so you need both the genric layer and
1338d70a560fSIgor Grinberg		the viewport enabled. Currently only Chipidea/ARC based
1339d70a560fSIgor Grinberg		viewport is supported.
1340d70a560fSIgor Grinberg		To enable the ULPI layer support, define CONFIG_USB_ULPI and
1341d70a560fSIgor Grinberg		CONFIG_USB_ULPI_VIEWPORT in your board configuration file.
13426d365ea0SLucas Stach		If your ULPI phy needs a different reference clock than the
13436d365ea0SLucas Stach		standard 24 MHz then you have to define CONFIG_ULPI_REF_CLK to
13446d365ea0SLucas Stach		the appropriate value in Hz.
1345c609719bSwdenk
1346c609719bSwdenk- MMC Support:
1347c609719bSwdenk		The MMC controller on the Intel PXA is supported. To
1348c609719bSwdenk		enable this define CONFIG_MMC. The MMC can be
1349c609719bSwdenk		accessed from the boot prompt by mapping the device
1350c609719bSwdenk		to physical memory similar to flash. Command line is
1351602ad3b3SJon Loeliger		enabled with CONFIG_CMD_MMC. The MMC driver also works with
1352602ad3b3SJon Loeliger		the FAT fs. This is enabled with CONFIG_CMD_FAT.
1353c609719bSwdenk
1354afb35666SYoshihiro Shimoda		CONFIG_SH_MMCIF
1355afb35666SYoshihiro Shimoda		Support for Renesas on-chip MMCIF controller
1356afb35666SYoshihiro Shimoda
1357afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_ADDR
1358afb35666SYoshihiro Shimoda			Define the base address of MMCIF registers
1359afb35666SYoshihiro Shimoda
1360afb35666SYoshihiro Shimoda			CONFIG_SH_MMCIF_CLK
1361afb35666SYoshihiro Shimoda			Define the clock frequency for MMCIF
1362afb35666SYoshihiro Shimoda
13631fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_BOOT
13641fd93c6eSPierre Aubert		Enable some additional features of the eMMC boot partitions.
13651fd93c6eSPierre Aubert
13661fd93c6eSPierre Aubert		CONFIG_SUPPORT_EMMC_RPMB
13671fd93c6eSPierre Aubert		Enable the commands for reading, writing and programming the
13681fd93c6eSPierre Aubert		key for the Replay Protection Memory Block partition in eMMC.
13691fd93c6eSPierre Aubert
1370b3ba6e94STom Rini- USB Device Firmware Update (DFU) class support:
137101acd6abSPaul Kocialkowski		CONFIG_USB_FUNCTION_DFU
1372b3ba6e94STom Rini		This enables the USB portion of the DFU USB class
1373b3ba6e94STom Rini
1374b3ba6e94STom Rini		CONFIG_CMD_DFU
1375b3ba6e94STom Rini		This enables the command "dfu" which is used to have
1376b3ba6e94STom Rini		U-Boot create a DFU class device via USB.  This command
1377b3ba6e94STom Rini		requires that the "dfu_alt_info" environment variable be
1378b3ba6e94STom Rini		set and define the alt settings to expose to the host.
1379b3ba6e94STom Rini
1380b3ba6e94STom Rini		CONFIG_DFU_MMC
1381b3ba6e94STom Rini		This enables support for exposing (e)MMC devices via DFU.
1382b3ba6e94STom Rini
1383c6631764SPantelis Antoniou		CONFIG_DFU_NAND
1384c6631764SPantelis Antoniou		This enables support for exposing NAND devices via DFU.
1385c6631764SPantelis Antoniou
1386a9479f04SAfzal Mohammed		CONFIG_DFU_RAM
1387a9479f04SAfzal Mohammed		This enables support for exposing RAM via DFU.
1388a9479f04SAfzal Mohammed		Note: DFU spec refer to non-volatile memory usage, but
1389a9479f04SAfzal Mohammed		allow usages beyond the scope of spec - here RAM usage,
1390a9479f04SAfzal Mohammed		one that would help mostly the developer.
1391a9479f04SAfzal Mohammed
1392e7e75c70SHeiko Schocher		CONFIG_SYS_DFU_DATA_BUF_SIZE
1393e7e75c70SHeiko Schocher		Dfu transfer uses a buffer before writing data to the
1394e7e75c70SHeiko Schocher		raw storage device. Make the size (in bytes) of this buffer
1395e7e75c70SHeiko Schocher		configurable. The size of this buffer is also configurable
1396e7e75c70SHeiko Schocher		through the "dfu_bufsiz" environment variable.
1397e7e75c70SHeiko Schocher
1398ea2453d5SPantelis Antoniou		CONFIG_SYS_DFU_MAX_FILE_SIZE
1399ea2453d5SPantelis Antoniou		When updating files rather than the raw storage device,
1400ea2453d5SPantelis Antoniou		we use a static buffer to copy the file into and then write
1401ea2453d5SPantelis Antoniou		the buffer once we've been given the whole file.  Define
1402ea2453d5SPantelis Antoniou		this to the maximum filesize (in bytes) for the buffer.
1403ea2453d5SPantelis Antoniou		Default is 4 MiB if undefined.
1404ea2453d5SPantelis Antoniou
1405001a8319SHeiko Schocher		DFU_DEFAULT_POLL_TIMEOUT
1406001a8319SHeiko Schocher		Poll timeout [ms], is the timeout a device can send to the
1407001a8319SHeiko Schocher		host. The host must wait for this timeout before sending
1408001a8319SHeiko Schocher		a subsequent DFU_GET_STATUS request to the device.
1409001a8319SHeiko Schocher
1410001a8319SHeiko Schocher		DFU_MANIFEST_POLL_TIMEOUT
1411001a8319SHeiko Schocher		Poll timeout [ms], which the device sends to the host when
1412001a8319SHeiko Schocher		entering dfuMANIFEST state. Host waits this timeout, before
1413001a8319SHeiko Schocher		sending again an USB request to the device.
1414001a8319SHeiko Schocher
14153aab70afSSebastian Siewior- USB Device Android Fastboot support:
141617da3c0cSPaul Kocialkowski		CONFIG_USB_FUNCTION_FASTBOOT
141717da3c0cSPaul Kocialkowski		This enables the USB part of the fastboot gadget
141817da3c0cSPaul Kocialkowski
14193aab70afSSebastian Siewior		CONFIG_CMD_FASTBOOT
14203aab70afSSebastian Siewior		This enables the command "fastboot" which enables the Android
14213aab70afSSebastian Siewior		fastboot mode for the platform's USB device. Fastboot is a USB
14223aab70afSSebastian Siewior		protocol for downloading images, flashing and device control
14233aab70afSSebastian Siewior		used on Android devices.
14243aab70afSSebastian Siewior		See doc/README.android-fastboot for more information.
14253aab70afSSebastian Siewior
14263aab70afSSebastian Siewior		CONFIG_ANDROID_BOOT_IMAGE
14273aab70afSSebastian Siewior		This enables support for booting images which use the Android
14283aab70afSSebastian Siewior		image format header.
14293aab70afSSebastian Siewior
1430a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_ADDR
14313aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
14323aab70afSSebastian Siewior		downloads. Define this to the starting RAM address to use for
14333aab70afSSebastian Siewior		downloaded images.
14343aab70afSSebastian Siewior
1435a588d99aSPaul Kocialkowski		CONFIG_FASTBOOT_BUF_SIZE
14363aab70afSSebastian Siewior		The fastboot protocol requires a large memory buffer for
14373aab70afSSebastian Siewior		downloads. This buffer should be as large as possible for a
14383aab70afSSebastian Siewior		platform. Define this to the size available RAM for fastboot.
14393aab70afSSebastian Siewior
1440d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH
1441d1b5ed07SSteve Rae		The fastboot protocol includes a "flash" command for writing
1442d1b5ed07SSteve Rae		the downloaded image to a non-volatile storage device. Define
1443d1b5ed07SSteve Rae		this to enable the "fastboot flash" command.
1444d1b5ed07SSteve Rae
1445d1b5ed07SSteve Rae		CONFIG_FASTBOOT_FLASH_MMC_DEV
1446d1b5ed07SSteve Rae		The fastboot "flash" command requires additional information
1447d1b5ed07SSteve Rae		regarding the non-volatile storage device. Define this to
1448d1b5ed07SSteve Rae		the eMMC device that fastboot should use to store the image.
1449d1b5ed07SSteve Rae
14500ff7e585SSteve Rae		CONFIG_FASTBOOT_GPT_NAME
14510ff7e585SSteve Rae		The fastboot "flash" command supports writing the downloaded
14520ff7e585SSteve Rae		image to the Protective MBR and the Primary GUID Partition
14530ff7e585SSteve Rae		Table. (Additionally, this downloaded image is post-processed
14540ff7e585SSteve Rae		to generate and write the Backup GUID Partition Table.)
14550ff7e585SSteve Rae		This occurs when the specified "partition name" on the
14560ff7e585SSteve Rae		"fastboot flash" command line matches this value.
14576f6c8630SPetr Kulhavy		The default is "gpt" if undefined.
14580ff7e585SSteve Rae
1459b6dd69a4SPetr Kulhavy		CONFIG_FASTBOOT_MBR_NAME
1460b6dd69a4SPetr Kulhavy		The fastboot "flash" command supports writing the downloaded
1461b6dd69a4SPetr Kulhavy		image to DOS MBR.
1462b6dd69a4SPetr Kulhavy		This occurs when the "partition name" specified on the
1463b6dd69a4SPetr Kulhavy		"fastboot flash" command line matches this value.
1464b6dd69a4SPetr Kulhavy		If not defined the default value "mbr" is used.
1465b6dd69a4SPetr Kulhavy
14666705d81eSwdenk- Journaling Flash filesystem support:
1467b2482dffSSimon Glass		CONFIG_JFFS2_NAND
14686705d81eSwdenk		Define these for a default partition on a NAND device
14696705d81eSwdenk
14706d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_SECTOR,
14716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
14726705d81eSwdenk		Define these for a default partition on a NOR device
14736705d81eSwdenk
1474c609719bSwdenk- Keyboard Support:
147539f615edSSimon Glass		See Kconfig help for available keyboard drivers.
147639f615edSSimon Glass
147739f615edSSimon Glass		CONFIG_KEYBOARD
147839f615edSSimon Glass
147939f615edSSimon Glass		Define this to enable a custom keyboard support.
148039f615edSSimon Glass		This simply calls drv_keyboard_init() which must be
148139f615edSSimon Glass		defined in your board-specific files. This option is deprecated
148239f615edSSimon Glass		and is only used by novena. For new boards, use driver model
148339f615edSSimon Glass		instead.
1484c609719bSwdenk
1485c609719bSwdenk- Video support:
14867d3053fbSTimur Tabi		CONFIG_FSL_DIU_FB
14877d3053fbSTimur Tabi		Enable the Freescale DIU video driver.	Reference boards for
14887d3053fbSTimur Tabi		SOCs that have a DIU should define this macro to enable DIU
14897d3053fbSTimur Tabi		support, and should also define these other macros:
14907d3053fbSTimur Tabi
14917d3053fbSTimur Tabi			CONFIG_SYS_DIU_ADDR
14927d3053fbSTimur Tabi			CONFIG_VIDEO
14937d3053fbSTimur Tabi			CONFIG_CFB_CONSOLE
14947d3053fbSTimur Tabi			CONFIG_VIDEO_SW_CURSOR
14957d3053fbSTimur Tabi			CONFIG_VGA_AS_SINGLE_DEVICE
14967d3053fbSTimur Tabi			CONFIG_VIDEO_LOGO
14977d3053fbSTimur Tabi			CONFIG_VIDEO_BMP_LOGO
14987d3053fbSTimur Tabi
1499ba8e76bdSTimur Tabi		The DIU driver will look for the 'video-mode' environment
1500ba8e76bdSTimur Tabi		variable, and if defined, enable the DIU as a console during
15018eca9439SFabio Estevam		boot.  See the documentation file doc/README.video for a
1502ba8e76bdSTimur Tabi		description of this variable.
15037d3053fbSTimur Tabi
1504c609719bSwdenk- LCD Support:	CONFIG_LCD
1505c609719bSwdenk
1506c609719bSwdenk		Define this to enable LCD support (for output to LCD
1507c609719bSwdenk		display); also select one of the supported displays
1508c609719bSwdenk		by defining one of these:
1509c609719bSwdenk
151039cf4804SStelian Pop		CONFIG_ATMEL_LCD:
151139cf4804SStelian Pop
151239cf4804SStelian Pop			HITACHI TX09D70VM1CCA, 3.5", 240x320.
151339cf4804SStelian Pop
1514fd3103bbSwdenk		CONFIG_NEC_NL6448AC33:
1515c609719bSwdenk
1516fd3103bbSwdenk			NEC NL6448AC33-18. Active, color, single scan.
1517c609719bSwdenk
1518fd3103bbSwdenk		CONFIG_NEC_NL6448BC20
1519c609719bSwdenk
1520fd3103bbSwdenk			NEC NL6448BC20-08. 6.5", 640x480.
1521fd3103bbSwdenk			Active, color, single scan.
1522fd3103bbSwdenk
1523fd3103bbSwdenk		CONFIG_NEC_NL6448BC33_54
1524fd3103bbSwdenk
1525fd3103bbSwdenk			NEC NL6448BC33-54. 10.4", 640x480.
1526c609719bSwdenk			Active, color, single scan.
1527c609719bSwdenk
1528c609719bSwdenk		CONFIG_SHARP_16x9
1529c609719bSwdenk
1530c609719bSwdenk			Sharp 320x240. Active, color, single scan.
1531c609719bSwdenk			It isn't 16x9, and I am not sure what it is.
1532c609719bSwdenk
1533c609719bSwdenk		CONFIG_SHARP_LQ64D341
1534c609719bSwdenk
1535c609719bSwdenk			Sharp LQ64D341 display, 640x480.
1536c609719bSwdenk			Active, color, single scan.
1537c609719bSwdenk
1538c609719bSwdenk		CONFIG_HLD1045
1539c609719bSwdenk
1540c609719bSwdenk			HLD1045 display, 640x480.
1541c609719bSwdenk			Active, color, single scan.
1542c609719bSwdenk
1543c609719bSwdenk		CONFIG_OPTREX_BW
1544c609719bSwdenk
1545c609719bSwdenk			Optrex	 CBL50840-2 NF-FW 99 22 M5
1546c609719bSwdenk			or
1547c609719bSwdenk			Hitachi	 LMG6912RPFC-00T
1548c609719bSwdenk			or
1549c609719bSwdenk			Hitachi	 SP14Q002
1550c609719bSwdenk
1551c609719bSwdenk			320x240. Black & white.
1552c609719bSwdenk
1553676d319eSSimon Glass		CONFIG_LCD_ALIGNMENT
1554676d319eSSimon Glass
1555b445bbb4SJeremiah Mahler		Normally the LCD is page-aligned (typically 4KB). If this is
1556676d319eSSimon Glass		defined then the LCD will be aligned to this value instead.
1557676d319eSSimon Glass		For ARM it is sometimes useful to use MMU_SECTION_SIZE
1558676d319eSSimon Glass		here, since it is cheaper to change data cache settings on
1559676d319eSSimon Glass		a per-section basis.
1560676d319eSSimon Glass
1561676d319eSSimon Glass
1562604c7d4aSHannes Petermaier		CONFIG_LCD_ROTATION
1563604c7d4aSHannes Petermaier
1564604c7d4aSHannes Petermaier		Sometimes, for example if the display is mounted in portrait
1565604c7d4aSHannes Petermaier		mode or even if it's mounted landscape but rotated by 180degree,
1566604c7d4aSHannes Petermaier		we need to rotate our content of the display relative to the
1567604c7d4aSHannes Petermaier		framebuffer, so that user can read the messages which are
1568604c7d4aSHannes Petermaier		printed out.
1569604c7d4aSHannes Petermaier		Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
1570604c7d4aSHannes Petermaier		initialized with a given rotation from "vl_rot" out of
1571604c7d4aSHannes Petermaier		"vidinfo_t" which is provided by the board specific code.
1572604c7d4aSHannes Petermaier		The value for vl_rot is coded as following (matching to
1573604c7d4aSHannes Petermaier		fbcon=rotate:<n> linux-kernel commandline):
1574604c7d4aSHannes Petermaier		0 = no rotation respectively 0 degree
1575604c7d4aSHannes Petermaier		1 = 90 degree rotation
1576604c7d4aSHannes Petermaier		2 = 180 degree rotation
1577604c7d4aSHannes Petermaier		3 = 270 degree rotation
1578604c7d4aSHannes Petermaier
1579604c7d4aSHannes Petermaier		If CONFIG_LCD_ROTATION is not defined, the console will be
1580604c7d4aSHannes Petermaier		initialized with 0degree rotation.
1581604c7d4aSHannes Petermaier
158245d7f525STom Wai-Hong Tam		CONFIG_LCD_BMP_RLE8
158345d7f525STom Wai-Hong Tam
158445d7f525STom Wai-Hong Tam		Support drawing of RLE8-compressed bitmaps on the LCD.
158545d7f525STom Wai-Hong Tam
1586735987c5STom Wai-Hong Tam		CONFIG_I2C_EDID
1587735987c5STom Wai-Hong Tam
1588735987c5STom Wai-Hong Tam		Enables an 'i2c edid' command which can read EDID
1589735987c5STom Wai-Hong Tam		information over I2C from an attached LCD display.
1590735987c5STom Wai-Hong Tam
15917152b1d0Swdenk- Splash Screen Support: CONFIG_SPLASH_SCREEN
1592d791b1dcSwdenk
1593d791b1dcSwdenk		If this option is set, the environment is checked for
1594d791b1dcSwdenk		a variable "splashimage". If found, the usual display
1595d791b1dcSwdenk		of logo, copyright and system information on the LCD
1596e94d2cd9Swdenk		is suppressed and the BMP image at the address
1597d791b1dcSwdenk		specified in "splashimage" is loaded instead. The
1598d791b1dcSwdenk		console is redirected to the "nulldev", too. This
1599d791b1dcSwdenk		allows for a "silent" boot where a splash screen is
1600d791b1dcSwdenk		loaded very quickly after power-on.
1601d791b1dcSwdenk
1602c0880485SNikita Kiryanov		CONFIG_SPLASHIMAGE_GUARD
1603c0880485SNikita Kiryanov
1604c0880485SNikita Kiryanov		If this option is set, then U-Boot will prevent the environment
1605c0880485SNikita Kiryanov		variable "splashimage" from being set to a problematic address
1606ab5645f1SFabio Estevam		(see doc/README.displaying-bmps).
1607c0880485SNikita Kiryanov		This option is useful for targets where, due to alignment
1608c0880485SNikita Kiryanov		restrictions, an improperly aligned BMP image will cause a data
1609c0880485SNikita Kiryanov		abort. If you think you will not have problems with unaligned
1610c0880485SNikita Kiryanov		accesses (for example because your toolchain prevents them)
1611c0880485SNikita Kiryanov		there is no need to set this option.
1612c0880485SNikita Kiryanov
16131ca298ceSMatthias Weisser		CONFIG_SPLASH_SCREEN_ALIGN
16141ca298ceSMatthias Weisser
16151ca298ceSMatthias Weisser		If this option is set the splash image can be freely positioned
16161ca298ceSMatthias Weisser		on the screen. Environment variable "splashpos" specifies the
16171ca298ceSMatthias Weisser		position as "x,y". If a positive number is given it is used as
16181ca298ceSMatthias Weisser		number of pixel from left/top. If a negative number is given it
16191ca298ceSMatthias Weisser		is used as number of pixel from right/bottom. You can also
16201ca298ceSMatthias Weisser		specify 'm' for centering the image.
16211ca298ceSMatthias Weisser
16221ca298ceSMatthias Weisser		Example:
16231ca298ceSMatthias Weisser		setenv splashpos m,m
16241ca298ceSMatthias Weisser			=> image at center of screen
16251ca298ceSMatthias Weisser
16261ca298ceSMatthias Weisser		setenv splashpos 30,20
16271ca298ceSMatthias Weisser			=> image at x = 30 and y = 20
16281ca298ceSMatthias Weisser
16291ca298ceSMatthias Weisser		setenv splashpos -10,m
16301ca298ceSMatthias Weisser			=> vertically centered image
16311ca298ceSMatthias Weisser			   at x = dspWidth - bmpWidth - 9
16321ca298ceSMatthias Weisser
163398f4a3dfSStefan Roese- Gzip compressed BMP image support: CONFIG_VIDEO_BMP_GZIP
163498f4a3dfSStefan Roese
163598f4a3dfSStefan Roese		If this option is set, additionally to standard BMP
163698f4a3dfSStefan Roese		images, gzipped BMP images can be displayed via the
163798f4a3dfSStefan Roese		splashscreen support or the bmp command.
163898f4a3dfSStefan Roese
1639d5011762SAnatolij Gustschin- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
1640d5011762SAnatolij Gustschin
1641d5011762SAnatolij Gustschin		If this option is set, 8-bit RLE compressed BMP images
1642d5011762SAnatolij Gustschin		can be displayed via the splashscreen support or the
1643d5011762SAnatolij Gustschin		bmp command.
1644d5011762SAnatolij Gustschin
1645c29fdfc1Swdenk- Compression support:
16468ef70478SKees Cook		CONFIG_GZIP
16478ef70478SKees Cook
16488ef70478SKees Cook		Enabled by default to support gzip compressed images.
16498ef70478SKees Cook
1650c29fdfc1Swdenk		CONFIG_BZIP2
1651c29fdfc1Swdenk
1652c29fdfc1Swdenk		If this option is set, support for bzip2 compressed
1653c29fdfc1Swdenk		images is included. If not, only uncompressed and gzip
1654c29fdfc1Swdenk		compressed images are supported.
1655c29fdfc1Swdenk
1656c29fdfc1Swdenk		NOTE: the bzip2 algorithm requires a lot of RAM, so
16576d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		the malloc area (as defined by CONFIG_SYS_MALLOC_LEN) should
1658c29fdfc1Swdenk		be at least 4MB.
1659d791b1dcSwdenk
16608ef70478SKees Cook		CONFIG_LZO
16618ef70478SKees Cook
16628ef70478SKees Cook		If this option is set, support for LZO compressed images
16638ef70478SKees Cook		is included.
16648ef70478SKees Cook
166517ea1177Swdenk- MII/PHY support:
166617ea1177Swdenk		CONFIG_PHY_ADDR
166717ea1177Swdenk
166817ea1177Swdenk		The address of PHY on MII bus.
166917ea1177Swdenk
167017ea1177Swdenk		CONFIG_PHY_CLOCK_FREQ (ppc4xx)
167117ea1177Swdenk
167217ea1177Swdenk		The clock frequency of the MII bus
167317ea1177Swdenk
167417ea1177Swdenk		CONFIG_PHY_GIGE
167517ea1177Swdenk
167617ea1177Swdenk		If this option is set, support for speed/duplex
167711ccc33fSMarcel Ziswiler		detection of gigabit PHY is included.
167817ea1177Swdenk
167917ea1177Swdenk		CONFIG_PHY_RESET_DELAY
168017ea1177Swdenk
168117ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
168217ea1177Swdenk		reset before any MII register access is possible.
168317ea1177Swdenk		For such PHY, set this option to the usec delay
168417ea1177Swdenk		required. (minimum 300usec for LXT971A)
168517ea1177Swdenk
168617ea1177Swdenk		CONFIG_PHY_CMD_DELAY (ppc4xx)
168717ea1177Swdenk
168817ea1177Swdenk		Some PHY like Intel LXT971A need extra delay after
168917ea1177Swdenk		command issued before MII status register can be read
169017ea1177Swdenk
1691c609719bSwdenk- IP address:
1692c609719bSwdenk		CONFIG_IPADDR
1693c609719bSwdenk
1694c609719bSwdenk		Define a default value for the IP address to use for
169511ccc33fSMarcel Ziswiler		the default Ethernet interface, in case this is not
1696c609719bSwdenk		determined through e.g. bootp.
16971ebcd654SWolfgang Denk		(Environment variable "ipaddr")
1698c609719bSwdenk
1699c609719bSwdenk- Server IP address:
1700c609719bSwdenk		CONFIG_SERVERIP
1701c609719bSwdenk
1702c609719bSwdenk		Defines a default value for the IP address of a TFTP
1703c609719bSwdenk		server to contact when using the "tftboot" command.
17041ebcd654SWolfgang Denk		(Environment variable "serverip")
1705c609719bSwdenk
170697cfe861SRobin Getz		CONFIG_KEEP_SERVERADDR
170797cfe861SRobin Getz
170897cfe861SRobin Getz		Keeps the server's MAC address, in the env 'serveraddr'
170997cfe861SRobin Getz		for passing to bootargs (like Linux's netconsole option)
171097cfe861SRobin Getz
17111ebcd654SWolfgang Denk- Gateway IP address:
17121ebcd654SWolfgang Denk		CONFIG_GATEWAYIP
17131ebcd654SWolfgang Denk
17141ebcd654SWolfgang Denk		Defines a default value for the IP address of the
17151ebcd654SWolfgang Denk		default router where packets to other networks are
17161ebcd654SWolfgang Denk		sent to.
17171ebcd654SWolfgang Denk		(Environment variable "gatewayip")
17181ebcd654SWolfgang Denk
17191ebcd654SWolfgang Denk- Subnet mask:
17201ebcd654SWolfgang Denk		CONFIG_NETMASK
17211ebcd654SWolfgang Denk
17221ebcd654SWolfgang Denk		Defines a default value for the subnet mask (or
17231ebcd654SWolfgang Denk		routing prefix) which is used to determine if an IP
17241ebcd654SWolfgang Denk		address belongs to the local subnet or needs to be
17251ebcd654SWolfgang Denk		forwarded through a router.
17261ebcd654SWolfgang Denk		(Environment variable "netmask")
17271ebcd654SWolfgang Denk
172853a5c424SDavid Updegraff- Multicast TFTP Mode:
172953a5c424SDavid Updegraff		CONFIG_MCAST_TFTP
173053a5c424SDavid Updegraff
173153a5c424SDavid Updegraff		Defines whether you want to support multicast TFTP as per
173253a5c424SDavid Updegraff		rfc-2090; for example to work with atftp.  Lets lots of targets
173311ccc33fSMarcel Ziswiler		tftp down the same boot image concurrently.  Note: the Ethernet
173453a5c424SDavid Updegraff		driver in use must provide a function: mcast() to join/leave a
173553a5c424SDavid Updegraff		multicast group.
173653a5c424SDavid Updegraff
1737c609719bSwdenk- BOOTP Recovery Mode:
1738c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY
1739c609719bSwdenk
1740c609719bSwdenk		If you have many targets in a network that try to
1741c609719bSwdenk		boot using BOOTP, you may want to avoid that all
1742c609719bSwdenk		systems send out BOOTP requests at precisely the same
1743c609719bSwdenk		moment (which would happen for instance at recovery
1744c609719bSwdenk		from a power failure, when all systems will try to
1745c609719bSwdenk		boot, thus flooding the BOOTP server. Defining
1746c609719bSwdenk		CONFIG_BOOTP_RANDOM_DELAY causes a random delay to be
1747c609719bSwdenk		inserted before sending out BOOTP requests. The
17486c33c785SWolfgang Denk		following delays are inserted then:
1749c609719bSwdenk
1750c609719bSwdenk		1st BOOTP request:	delay 0 ... 1 sec
1751c609719bSwdenk		2nd BOOTP request:	delay 0 ... 2 sec
1752c609719bSwdenk		3rd BOOTP request:	delay 0 ... 4 sec
1753c609719bSwdenk		4th and following
1754c609719bSwdenk		BOOTP requests:		delay 0 ... 8 sec
1755c609719bSwdenk
175692ac8accSThierry Reding		CONFIG_BOOTP_ID_CACHE_SIZE
175792ac8accSThierry Reding
175892ac8accSThierry Reding		BOOTP packets are uniquely identified using a 32-bit ID. The
175992ac8accSThierry Reding		server will copy the ID from client requests to responses and
176092ac8accSThierry Reding		U-Boot will use this to determine if it is the destination of
176192ac8accSThierry Reding		an incoming response. Some servers will check that addresses
176292ac8accSThierry Reding		aren't in use before handing them out (usually using an ARP
176392ac8accSThierry Reding		ping) and therefore take up to a few hundred milliseconds to
176492ac8accSThierry Reding		respond. Network congestion may also influence the time it
176592ac8accSThierry Reding		takes for a response to make it back to the client. If that
176692ac8accSThierry Reding		time is too long, U-Boot will retransmit requests. In order
176792ac8accSThierry Reding		to allow earlier responses to still be accepted after these
176892ac8accSThierry Reding		retransmissions, U-Boot's BOOTP client keeps a small cache of
176992ac8accSThierry Reding		IDs. The CONFIG_BOOTP_ID_CACHE_SIZE controls the size of this
177092ac8accSThierry Reding		cache. The default is to keep IDs for up to four outstanding
177192ac8accSThierry Reding		requests. Increasing this will allow U-Boot to accept offers
177292ac8accSThierry Reding		from a BOOTP client in networks with unusually high latency.
177392ac8accSThierry Reding
1774fe389a82Sstroese- DHCP Advanced Options:
17751fe80d79SJon Loeliger		You can fine tune the DHCP functionality by defining
17761fe80d79SJon Loeliger		CONFIG_BOOTP_* symbols:
1777fe389a82Sstroese
17781fe80d79SJon Loeliger		CONFIG_BOOTP_SUBNETMASK
17791fe80d79SJon Loeliger		CONFIG_BOOTP_GATEWAY
17801fe80d79SJon Loeliger		CONFIG_BOOTP_HOSTNAME
17811fe80d79SJon Loeliger		CONFIG_BOOTP_NISDOMAIN
17821fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTPATH
17831fe80d79SJon Loeliger		CONFIG_BOOTP_BOOTFILESIZE
17841fe80d79SJon Loeliger		CONFIG_BOOTP_DNS
17851fe80d79SJon Loeliger		CONFIG_BOOTP_DNS2
17861fe80d79SJon Loeliger		CONFIG_BOOTP_SEND_HOSTNAME
17871fe80d79SJon Loeliger		CONFIG_BOOTP_NTPSERVER
17881fe80d79SJon Loeliger		CONFIG_BOOTP_TIMEOFFSET
17891fe80d79SJon Loeliger		CONFIG_BOOTP_VENDOREX
17902c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL
1791fe389a82Sstroese
17925d110f0aSWilson Callan		CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
17935d110f0aSWilson Callan		environment variable, not the BOOTP server.
1794fe389a82Sstroese
17952c00e099SJoe Hershberger		CONFIG_BOOTP_MAY_FAIL - If the DHCP server is not found
17962c00e099SJoe Hershberger		after the configured retry count, the call will fail
17972c00e099SJoe Hershberger		instead of starting over.  This can be used to fail over
17982c00e099SJoe Hershberger		to Link-local IP address configuration if the DHCP server
17992c00e099SJoe Hershberger		is not available.
18002c00e099SJoe Hershberger
1801fe389a82Sstroese		CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
1802fe389a82Sstroese		serverip from a DHCP server, it is possible that more
1803fe389a82Sstroese		than one DNS serverip is offered to the client.
1804fe389a82Sstroese		If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1805fe389a82Sstroese		serverip will be stored in the additional environment
1806fe389a82Sstroese		variable "dnsip2". The first DNS serverip is always
1807fe389a82Sstroese		stored in the variable "dnsip", when CONFIG_BOOTP_DNS
18081fe80d79SJon Loeliger		is defined.
1809fe389a82Sstroese
1810fe389a82Sstroese		CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
1811fe389a82Sstroese		to do a dynamic update of a DNS server. To do this, they
1812fe389a82Sstroese		need the hostname of the DHCP requester.
18135d110f0aSWilson Callan		If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
18141fe80d79SJon Loeliger		of the "hostname" environment variable is passed as
18151fe80d79SJon Loeliger		option 12 to the DHCP server.
1816fe389a82Sstroese
1817d9a2f416SAras Vaichas		CONFIG_BOOTP_DHCP_REQUEST_DELAY
1818d9a2f416SAras Vaichas
1819d9a2f416SAras Vaichas		A 32bit value in microseconds for a delay between
1820d9a2f416SAras Vaichas		receiving a "DHCP Offer" and sending the "DHCP Request".
1821d9a2f416SAras Vaichas		This fixes a problem with certain DHCP servers that don't
1822d9a2f416SAras Vaichas		respond 100% of the time to a "DHCP request". E.g. On an
1823d9a2f416SAras Vaichas		AT91RM9200 processor running at 180MHz, this delay needed
1824d9a2f416SAras Vaichas		to be *at least* 15,000 usec before a Windows Server 2003
1825d9a2f416SAras Vaichas		DHCP server would reply 100% of the time. I recommend at
1826d9a2f416SAras Vaichas		least 50,000 usec to be safe. The alternative is to hope
1827d9a2f416SAras Vaichas		that one of the retries will be successful but note that
1828d9a2f416SAras Vaichas		the DHCP timeout and retry process takes a longer than
1829d9a2f416SAras Vaichas		this delay.
1830d9a2f416SAras Vaichas
1831d22c338eSJoe Hershberger - Link-local IP address negotiation:
1832d22c338eSJoe Hershberger		Negotiate with other link-local clients on the local network
1833d22c338eSJoe Hershberger		for an address that doesn't require explicit configuration.
1834d22c338eSJoe Hershberger		This is especially useful if a DHCP server cannot be guaranteed
1835d22c338eSJoe Hershberger		to exist in all environments that the device must operate.
1836d22c338eSJoe Hershberger
1837d22c338eSJoe Hershberger		See doc/README.link-local for more information.
1838d22c338eSJoe Hershberger
1839a3d991bdSwdenk - CDP Options:
1840a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID
1841a3d991bdSwdenk
1842a3d991bdSwdenk		The device id used in CDP trigger frames.
1843a3d991bdSwdenk
1844a3d991bdSwdenk		CONFIG_CDP_DEVICE_ID_PREFIX
1845a3d991bdSwdenk
1846a3d991bdSwdenk		A two character string which is prefixed to the MAC address
1847a3d991bdSwdenk		of the device.
1848a3d991bdSwdenk
1849a3d991bdSwdenk		CONFIG_CDP_PORT_ID
1850a3d991bdSwdenk
1851a3d991bdSwdenk		A printf format string which contains the ascii name of
1852a3d991bdSwdenk		the port. Normally is set to "eth%d" which sets
185311ccc33fSMarcel Ziswiler		eth0 for the first Ethernet, eth1 for the second etc.
1854a3d991bdSwdenk
1855a3d991bdSwdenk		CONFIG_CDP_CAPABILITIES
1856a3d991bdSwdenk
1857a3d991bdSwdenk		A 32bit integer which indicates the device capabilities;
1858a3d991bdSwdenk		0x00000010 for a normal host which does not forwards.
1859a3d991bdSwdenk
1860a3d991bdSwdenk		CONFIG_CDP_VERSION
1861a3d991bdSwdenk
1862a3d991bdSwdenk		An ascii string containing the version of the software.
1863a3d991bdSwdenk
1864a3d991bdSwdenk		CONFIG_CDP_PLATFORM
1865a3d991bdSwdenk
1866a3d991bdSwdenk		An ascii string containing the name of the platform.
1867a3d991bdSwdenk
1868a3d991bdSwdenk		CONFIG_CDP_TRIGGER
1869a3d991bdSwdenk
1870a3d991bdSwdenk		A 32bit integer sent on the trigger.
1871a3d991bdSwdenk
1872a3d991bdSwdenk		CONFIG_CDP_POWER_CONSUMPTION
1873a3d991bdSwdenk
1874a3d991bdSwdenk		A 16bit integer containing the power consumption of the
1875a3d991bdSwdenk		device in .1 of milliwatts.
1876a3d991bdSwdenk
1877a3d991bdSwdenk		CONFIG_CDP_APPLIANCE_VLAN_TYPE
1878a3d991bdSwdenk
1879a3d991bdSwdenk		A byte containing the id of the VLAN.
1880a3d991bdSwdenk
188179267eddSUri Mashiach- Status LED:	CONFIG_LED_STATUS
1882c609719bSwdenk
1883c609719bSwdenk		Several configurations allow to display the current
1884c609719bSwdenk		status using a LED. For instance, the LED will blink
1885c609719bSwdenk		fast while running U-Boot code, stop blinking as
1886c609719bSwdenk		soon as a reply to a BOOTP request was received, and
1887c609719bSwdenk		start blinking slow once the Linux kernel is running
1888c609719bSwdenk		(supported by a status LED driver in the Linux
188979267eddSUri Mashiach		kernel). Defining CONFIG_LED_STATUS enables this
1890c609719bSwdenk		feature in U-Boot.
1891c609719bSwdenk
18921df7bbbaSIgor Grinberg		Additional options:
18931df7bbbaSIgor Grinberg
189479267eddSUri Mashiach		CONFIG_LED_STATUS_GPIO
18951df7bbbaSIgor Grinberg		The status LED can be connected to a GPIO pin.
18961df7bbbaSIgor Grinberg		In such cases, the gpio_led driver can be used as a
189779267eddSUri Mashiach		status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
18981df7bbbaSIgor Grinberg		to include the gpio_led driver in the U-Boot binary.
18991df7bbbaSIgor Grinberg
19009dfdcdfeSIgor Grinberg		CONFIG_GPIO_LED_INVERTED_TABLE
19019dfdcdfeSIgor Grinberg		Some GPIO connected LEDs may have inverted polarity in which
19029dfdcdfeSIgor Grinberg		case the GPIO high value corresponds to LED off state and
19039dfdcdfeSIgor Grinberg		GPIO low value corresponds to LED on state.
19049dfdcdfeSIgor Grinberg		In such cases CONFIG_GPIO_LED_INVERTED_TABLE may be defined
19059dfdcdfeSIgor Grinberg		with a list of GPIO LEDs that have inverted polarity.
19069dfdcdfeSIgor Grinberg
1907c609719bSwdenk- CAN Support:	CONFIG_CAN_DRIVER
1908c609719bSwdenk
1909c609719bSwdenk		Defining CONFIG_CAN_DRIVER enables CAN driver support
1910c609719bSwdenk		on those systems that support this (optional)
1911*5b8e76c3SHeiko Schocher		feature.
1912c609719bSwdenk
19133f4978c7SHeiko Schocher- I2C Support:	CONFIG_SYS_I2C
1914c609719bSwdenk
19153f4978c7SHeiko Schocher		This enable the NEW i2c subsystem, and will allow you to use
19163f4978c7SHeiko Schocher		i2c commands at the u-boot command line (as long as you set
19173f4978c7SHeiko Schocher		CONFIG_CMD_I2C in CONFIG_COMMANDS) and communicate with i2c
19183f4978c7SHeiko Schocher		based realtime clock chips or other i2c devices. See
19193f4978c7SHeiko Schocher		common/cmd_i2c.c for a description of the command line
19203f4978c7SHeiko Schocher		interface.
19213f4978c7SHeiko Schocher
19223f4978c7SHeiko Schocher		ported i2c driver to the new framework:
1923ea818dbbSHeiko Schocher		- drivers/i2c/soft_i2c.c:
1924ea818dbbSHeiko Schocher		  - activate first bus with CONFIG_SYS_I2C_SOFT define
1925ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED and CONFIG_SYS_I2C_SOFT_SLAVE
1926ea818dbbSHeiko Schocher		    for defining speed and slave address
1927ea818dbbSHeiko Schocher		  - activate second bus with I2C_SOFT_DECLARATIONS2 define
1928ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_2 and CONFIG_SYS_I2C_SOFT_SLAVE_2
1929ea818dbbSHeiko Schocher		    for defining speed and slave address
1930ea818dbbSHeiko Schocher		  - activate third bus with I2C_SOFT_DECLARATIONS3 define
1931ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_3 and CONFIG_SYS_I2C_SOFT_SLAVE_3
1932ea818dbbSHeiko Schocher		    for defining speed and slave address
1933ea818dbbSHeiko Schocher		  - activate fourth bus with I2C_SOFT_DECLARATIONS4 define
1934ea818dbbSHeiko Schocher		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
1935ea818dbbSHeiko Schocher		    for defining speed and slave address
19363f4978c7SHeiko Schocher
193700f792e0SHeiko Schocher		- drivers/i2c/fsl_i2c.c:
193800f792e0SHeiko Schocher		  - activate i2c driver with CONFIG_SYS_I2C_FSL
193900f792e0SHeiko Schocher		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
194000f792e0SHeiko Schocher		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
194100f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
194200f792e0SHeiko Schocher		    bus.
194300f792e0SHeiko Schocher		  - If your board supports a second fsl i2c bus, define
194400f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
194500f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
194600f792e0SHeiko Schocher		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
194700f792e0SHeiko Schocher		    second bus.
194800f792e0SHeiko Schocher
19491f2ba722SSimon Glass		- drivers/i2c/tegra_i2c.c:
19501f2ba722SSimon Glass		  - activate this driver with CONFIG_SYS_I2C_TEGRA
19511f2ba722SSimon Glass		  - This driver adds 4 i2c buses with a fix speed from
19521f2ba722SSimon Glass		    100000 and the slave addr 0!
19531f2ba722SSimon Glass
1954880540deSDirk Eibach		- drivers/i2c/ppc4xx_i2c.c
1955880540deSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
1956880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
1957880540deSDirk Eibach		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
1958880540deSDirk Eibach
1959fac96408Strem		- drivers/i2c/i2c_mxc.c
1960fac96408Strem		  - activate this driver with CONFIG_SYS_I2C_MXC
196103544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 1 with CONFIG_SYS_I2C_MXC_I2C1
196203544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 2 with CONFIG_SYS_I2C_MXC_I2C2
196303544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 3 with CONFIG_SYS_I2C_MXC_I2C3
196403544c66SAlbert ARIBAUD \\(3ADEV\\)		  - enable bus 4 with CONFIG_SYS_I2C_MXC_I2C4
1965fac96408Strem		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
1966fac96408Strem		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
1967fac96408Strem		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
1968fac96408Strem		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
1969fac96408Strem		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
1970fac96408Strem		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
197103544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define speed for bus 4 with CONFIG_SYS_MXC_I2C4_SPEED
197203544c66SAlbert ARIBAUD \\(3ADEV\\)		  - define slave for bus 4 with CONFIG_SYS_MXC_I2C4_SLAVE
1973b445bbb4SJeremiah Mahler		If those defines are not set, default value is 100000
1974fac96408Strem		for speed, and 0 for slave.
1975fac96408Strem
19761086bfa9SNobuhiro Iwamatsu		- drivers/i2c/rcar_i2c.c:
19771086bfa9SNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_RCAR
19781086bfa9SNobuhiro Iwamatsu		  - This driver adds 4 i2c buses
19791086bfa9SNobuhiro Iwamatsu
19801086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
19811086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
19821086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
19831086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
19841086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
19851086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
19861086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
19871086bfa9SNobuhiro Iwamatsu		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
19881086bfa9SNobuhiro Iwamatsu		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
19891086bfa9SNobuhiro Iwamatsu
19902035d77dSNobuhiro Iwamatsu		- drivers/i2c/sh_i2c.c:
19912035d77dSNobuhiro Iwamatsu		  - activate this driver with CONFIG_SYS_I2C_SH
19922035d77dSNobuhiro Iwamatsu		  - This driver adds from 2 to 5 i2c buses
19932035d77dSNobuhiro Iwamatsu
19942035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
19952035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
19962035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
19972035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
19982035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
19992035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
20002035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
20012035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
20022035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
20032035d77dSNobuhiro Iwamatsu		  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
2004b445bbb4SJeremiah Mahler		  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
20052035d77dSNobuhiro Iwamatsu
20066789e84eSHeiko Schocher		- drivers/i2c/omap24xx_i2c.c
20076789e84eSHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
20086789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
20096789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
20106789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
20116789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
20126789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
20136789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
20146789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
20156789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
20166789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
20176789e84eSHeiko Schocher		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
20186789e84eSHeiko Schocher
20190bdffe71SHeiko Schocher		- drivers/i2c/zynq_i2c.c
20200bdffe71SHeiko Schocher		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
20210bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
20220bdffe71SHeiko Schocher		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
20230bdffe71SHeiko Schocher
2024e717fc6dSNaveen Krishna Ch		- drivers/i2c/s3c24x0_i2c.c:
2025e717fc6dSNaveen Krishna Ch		  - activate this driver with CONFIG_SYS_I2C_S3C24X0
2026e717fc6dSNaveen Krishna Ch		  - This driver adds i2c buses (11 for Exynos5250, Exynos5420
2027e717fc6dSNaveen Krishna Ch		    9 i2c buses for Exynos4 and 1 for S3C24X0 SoCs from Samsung)
2028e717fc6dSNaveen Krishna Ch		    with a fix speed from 100000 and the slave addr 0!
2029e717fc6dSNaveen Krishna Ch
2030b46226bdSDirk Eibach		- drivers/i2c/ihs_i2c.c
2031b46226bdSDirk Eibach		  - activate this driver with CONFIG_SYS_I2C_IHS
2032b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH0 activate hardware channel 0
2033b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0 speed channel 0
2034b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0 slave addr channel 0
2035b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH1 activate hardware channel 1
2036b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1 speed channel 1
2037b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1 slave addr channel 1
2038b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH2 activate hardware channel 2
2039b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2 speed channel 2
2040b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2 slave addr channel 2
2041b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_CH3 activate hardware channel 3
2042b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3 speed channel 3
2043b46226bdSDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3 slave addr channel 3
2044071be896SDirk Eibach		  - activate dual channel with CONFIG_SYS_I2C_IHS_DUAL
2045071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_0_1 speed channel 0_1
2046071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_0_1 slave addr channel 0_1
2047071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_1_1 speed channel 1_1
2048071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_1_1 slave addr channel 1_1
2049071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_2_1 speed channel 2_1
2050071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_2_1 slave addr channel 2_1
2051071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SPEED_3_1 speed channel 3_1
2052071be896SDirk Eibach		  - CONFIG_SYS_I2C_IHS_SLAVE_3_1 slave addr channel 3_1
2053b46226bdSDirk Eibach
20543f4978c7SHeiko Schocher		additional defines:
20553f4978c7SHeiko Schocher
20563f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES
2057945a18e6SSimon Glass		Hold the number of i2c buses you want to use.
20583f4978c7SHeiko Schocher
20593f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS
20603f4978c7SHeiko Schocher		define this, if you don't use i2c muxes on your hardware.
20613f4978c7SHeiko Schocher		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
20623f4978c7SHeiko Schocher		omit this define.
20633f4978c7SHeiko Schocher
20643f4978c7SHeiko Schocher		CONFIG_SYS_I2C_MAX_HOPS
20653f4978c7SHeiko Schocher		define how many muxes are maximal consecutively connected
20663f4978c7SHeiko Schocher		on one i2c bus. If you not use i2c muxes, omit this
20673f4978c7SHeiko Schocher		define.
20683f4978c7SHeiko Schocher
20693f4978c7SHeiko Schocher		CONFIG_SYS_I2C_BUSES
2070b445bbb4SJeremiah Mahler		hold a list of buses you want to use, only used if
20713f4978c7SHeiko Schocher		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
20723f4978c7SHeiko Schocher		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
20733f4978c7SHeiko Schocher		CONFIG_SYS_NUM_I2C_BUSES = 9:
20743f4978c7SHeiko Schocher
20753f4978c7SHeiko Schocher		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
20763f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
20773f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
20783f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
20793f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
20803f4978c7SHeiko Schocher					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
20813f4978c7SHeiko Schocher					{1, {I2C_NULL_HOP}}, \
20823f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
20833f4978c7SHeiko Schocher					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
20843f4978c7SHeiko Schocher					}
20853f4978c7SHeiko Schocher
20863f4978c7SHeiko Schocher		which defines
20873f4978c7SHeiko Schocher			bus 0 on adapter 0 without a mux
2088ea818dbbSHeiko Schocher			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
2089ea818dbbSHeiko Schocher			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
2090ea818dbbSHeiko Schocher			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
2091ea818dbbSHeiko Schocher			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
2092ea818dbbSHeiko Schocher			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
20933f4978c7SHeiko Schocher			bus 6 on adapter 1 without a mux
2094ea818dbbSHeiko Schocher			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
2095ea818dbbSHeiko Schocher			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
20963f4978c7SHeiko Schocher
20973f4978c7SHeiko Schocher		If you do not have i2c muxes on your board, omit this define.
20983f4978c7SHeiko Schocher
2099ce3b5d69SSimon Glass- Legacy I2C Support:
2100ea818dbbSHeiko Schocher		If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
2101b37c7e5eSwdenk		then the following macros need to be defined (examples are
2102b37c7e5eSwdenk		from include/configs/lwmon.h):
2103c609719bSwdenk
2104c609719bSwdenk		I2C_INIT
2105c609719bSwdenk
2106b37c7e5eSwdenk		(Optional). Any commands necessary to enable the I2C
2107c609719bSwdenk		controller or configure ports.
2108c609719bSwdenk
2109b37c7e5eSwdenk		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
2110b37c7e5eSwdenk
2111c609719bSwdenk		I2C_PORT
2112c609719bSwdenk
2113c609719bSwdenk		(Only for MPC8260 CPU). The I/O port to use (the code
2114c609719bSwdenk		assumes both bits are on the same port). Valid values
2115c609719bSwdenk		are 0..3 for ports A..D.
2116c609719bSwdenk
2117c609719bSwdenk		I2C_ACTIVE
2118c609719bSwdenk
2119c609719bSwdenk		The code necessary to make the I2C data line active
2120c609719bSwdenk		(driven).  If the data line is open collector, this
2121c609719bSwdenk		define can be null.
2122c609719bSwdenk
2123b37c7e5eSwdenk		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
2124b37c7e5eSwdenk
2125c609719bSwdenk		I2C_TRISTATE
2126c609719bSwdenk
2127c609719bSwdenk		The code necessary to make the I2C data line tri-stated
2128c609719bSwdenk		(inactive).  If the data line is open collector, this
2129c609719bSwdenk		define can be null.
2130c609719bSwdenk
2131b37c7e5eSwdenk		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
2132b37c7e5eSwdenk
2133c609719bSwdenk		I2C_READ
2134c609719bSwdenk
2135472d5460SYork Sun		Code that returns true if the I2C data line is high,
2136472d5460SYork Sun		false if it is low.
2137c609719bSwdenk
2138b37c7e5eSwdenk		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
2139b37c7e5eSwdenk
2140c609719bSwdenk		I2C_SDA(bit)
2141c609719bSwdenk
2142472d5460SYork Sun		If <bit> is true, sets the I2C data line high. If it
2143472d5460SYork Sun		is false, it clears it (low).
2144c609719bSwdenk
2145b37c7e5eSwdenk		eg: #define I2C_SDA(bit) \
2146b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
2147b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
2148b37c7e5eSwdenk
2149c609719bSwdenk		I2C_SCL(bit)
2150c609719bSwdenk
2151472d5460SYork Sun		If <bit> is true, sets the I2C clock line high. If it
2152472d5460SYork Sun		is false, it clears it (low).
2153c609719bSwdenk
2154b37c7e5eSwdenk		eg: #define I2C_SCL(bit) \
2155b37c7e5eSwdenk			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
2156b37c7e5eSwdenk			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
2157b37c7e5eSwdenk
2158c609719bSwdenk		I2C_DELAY
2159c609719bSwdenk
2160c609719bSwdenk		This delay is invoked four times per clock cycle so this
2161c609719bSwdenk		controls the rate of data transfer.  The data rate thus
2162b37c7e5eSwdenk		is 1 / (I2C_DELAY * 4). Often defined to be something
2163b37c7e5eSwdenk		like:
2164b37c7e5eSwdenk
2165b37c7e5eSwdenk		#define I2C_DELAY  udelay(2)
2166c609719bSwdenk
2167793b5726SMike Frysinger		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
2168793b5726SMike Frysinger
2169793b5726SMike Frysinger		If your arch supports the generic GPIO framework (asm/gpio.h),
2170793b5726SMike Frysinger		then you may alternatively define the two GPIOs that are to be
2171793b5726SMike Frysinger		used as SCL / SDA.  Any of the previous I2C_xxx macros will
2172793b5726SMike Frysinger		have GPIO-based defaults assigned to them as appropriate.
2173793b5726SMike Frysinger
2174793b5726SMike Frysinger		You should define these to the GPIO value as given directly to
2175793b5726SMike Frysinger		the generic GPIO functions.
2176793b5726SMike Frysinger
21776d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_INIT_BOARD
217847cd00faSwdenk
217947cd00faSwdenk		When a board is reset during an i2c bus transfer
218047cd00faSwdenk		chips might think that the current transfer is still
218147cd00faSwdenk		in progress. On some boards it is possible to access
218247cd00faSwdenk		the i2c SCLK line directly, either by using the
218347cd00faSwdenk		processor pin as a GPIO or by having a second pin
218447cd00faSwdenk		connected to the bus. If this option is defined a
218547cd00faSwdenk		custom i2c_init_board() routine in boards/xxx/board.c
218647cd00faSwdenk		is run early in the boot sequence.
218747cd00faSwdenk
2188bb99ad6dSBen Warren		CONFIG_I2C_MULTI_BUS
2189bb99ad6dSBen Warren
2190bb99ad6dSBen Warren		This option allows the use of multiple I2C buses, each of which
2191bb99ad6dSBen Warren		must have a controller.	 At any point in time, only one bus is
2192bb99ad6dSBen Warren		active.	 To switch to a different bus, use the 'i2c dev' command.
2193bb99ad6dSBen Warren		Note that bus numbering is zero-based.
2194bb99ad6dSBen Warren
21956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_I2C_NOPROBES
2196bb99ad6dSBen Warren
2197bb99ad6dSBen Warren		This option specifies a list of I2C devices that will be skipped
21980f89c54bSPeter Tyser		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
21990f89c54bSPeter Tyser		is set, specify a list of bus-device pairs.  Otherwise, specify
22000f89c54bSPeter Tyser		a 1D array of device addresses
2201bb99ad6dSBen Warren
2202bb99ad6dSBen Warren		e.g.
2203bb99ad6dSBen Warren			#undef	CONFIG_I2C_MULTI_BUS
22046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
2205bb99ad6dSBen Warren
2206bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on a board with one I2C bus
2207bb99ad6dSBen Warren
2208bb99ad6dSBen Warren			#define CONFIG_I2C_MULTI_BUS
2209945a18e6SSimon Glass			#define CONFIG_SYS_I2C_NOPROBES	{{0,0x50},{0,0x68},{1,0x54}}
2210bb99ad6dSBen Warren
2211bb99ad6dSBen Warren		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
2212bb99ad6dSBen Warren
22136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SPD_BUS_NUM
2214be5e6181STimur Tabi
2215be5e6181STimur Tabi		If defined, then this indicates the I2C bus number for DDR SPD.
2216be5e6181STimur Tabi		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
2217be5e6181STimur Tabi
22186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_RTC_BUS_NUM
22190dc018ecSStefan Roese
22200dc018ecSStefan Roese		If defined, then this indicates the I2C bus number for the RTC.
22210dc018ecSStefan Roese		If not defined, then U-Boot assumes that RTC is on I2C bus 0.
22220dc018ecSStefan Roese
22232ac6985aSAndrew Dyer		CONFIG_SOFT_I2C_READ_REPEATED_START
22242ac6985aSAndrew Dyer
22252ac6985aSAndrew Dyer		defining this will force the i2c_read() function in
22262ac6985aSAndrew Dyer		the soft_i2c driver to perform an I2C repeated start
22272ac6985aSAndrew Dyer		between writing the address pointer and reading the
22282ac6985aSAndrew Dyer		data.  If this define is omitted the default behaviour
22292ac6985aSAndrew Dyer		of doing a stop-start sequence will be used.  Most I2C
22302ac6985aSAndrew Dyer		devices can use either method, but some require one or
22312ac6985aSAndrew Dyer		the other.
2232be5e6181STimur Tabi
2233c609719bSwdenk- SPI Support:	CONFIG_SPI
2234c609719bSwdenk
2235c609719bSwdenk		Enables SPI driver (so far only tested with
2236c609719bSwdenk		SPI EEPROM, also an instance works with Crystal A/D and
2237c609719bSwdenk		D/As on the SACSng board)
2238c609719bSwdenk
22396639562eSYoshihiro Shimoda		CONFIG_SH_SPI
22406639562eSYoshihiro Shimoda
22416639562eSYoshihiro Shimoda		Enables the driver for SPI controller on SuperH. Currently
22426639562eSYoshihiro Shimoda		only SH7757 is supported.
22436639562eSYoshihiro Shimoda
2244c609719bSwdenk		CONFIG_SOFT_SPI
2245c609719bSwdenk
2246c609719bSwdenk		Enables a software (bit-bang) SPI driver rather than
2247c609719bSwdenk		using hardware support. This is a general purpose
2248c609719bSwdenk		driver that only requires three general I/O port pins
2249c609719bSwdenk		(two outputs, one input) to function. If this is
2250c609719bSwdenk		defined, the board configuration must define several
2251c609719bSwdenk		SPI configuration items (port pins to use, etc). For
2252c609719bSwdenk		an example, see include/configs/sacsng.h.
2253c609719bSwdenk
225404a9e118SBen Warren		CONFIG_HARD_SPI
225504a9e118SBen Warren
225604a9e118SBen Warren		Enables a hardware SPI driver for general-purpose reads
225704a9e118SBen Warren		and writes.  As with CONFIG_SOFT_SPI, the board configuration
225804a9e118SBen Warren		must define a list of chip-select function pointers.
225904a9e118SBen Warren		Currently supported on some MPC8xxx processors.	 For an
226004a9e118SBen Warren		example, see include/configs/mpc8349emds.h.
226104a9e118SBen Warren
226238254f45SGuennadi Liakhovetski		CONFIG_MXC_SPI
226338254f45SGuennadi Liakhovetski
226438254f45SGuennadi Liakhovetski		Enables the driver for the SPI controllers on i.MX and MXC
22652e3cd1cdSFabio Estevam		SoCs. Currently i.MX31/35/51 are supported.
226638254f45SGuennadi Liakhovetski
2267f659b573SHeiko Schocher		CONFIG_SYS_SPI_MXC_WAIT
2268f659b573SHeiko Schocher		Timeout for waiting until spi transfer completed.
2269f659b573SHeiko Schocher		default: (CONFIG_SYS_HZ/100)     /* 10 ms */
2270f659b573SHeiko Schocher
22710133502eSMatthias Fuchs- FPGA Support: CONFIG_FPGA
22720133502eSMatthias Fuchs
22730133502eSMatthias Fuchs		Enables FPGA subsystem.
22740133502eSMatthias Fuchs
22750133502eSMatthias Fuchs		CONFIG_FPGA_<vendor>
22760133502eSMatthias Fuchs
22770133502eSMatthias Fuchs		Enables support for specific chip vendors.
22780133502eSMatthias Fuchs		(ALTERA, XILINX)
22790133502eSMatthias Fuchs
22800133502eSMatthias Fuchs		CONFIG_FPGA_<family>
22810133502eSMatthias Fuchs
22820133502eSMatthias Fuchs		Enables support for FPGA family.
22830133502eSMatthias Fuchs		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
22840133502eSMatthias Fuchs
22850133502eSMatthias Fuchs		CONFIG_FPGA_COUNT
2286c609719bSwdenk
2287c609719bSwdenk		Specify the number of FPGA devices to support.
2288c609719bSwdenk
22896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_PROG_FEEDBACK
2290c609719bSwdenk
2291c609719bSwdenk		Enable printing of hash marks during FPGA configuration.
2292c609719bSwdenk
22936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_BUSY
2294c609719bSwdenk
2295c609719bSwdenk		Enable checks on FPGA configuration interface busy
2296c609719bSwdenk		status by the configuration function. This option
2297c609719bSwdenk		will require a board or device specific function to
2298c609719bSwdenk		be written.
2299c609719bSwdenk
2300c609719bSwdenk		CONFIG_FPGA_DELAY
2301c609719bSwdenk
2302c609719bSwdenk		If defined, a function that provides delays in the FPGA
2303c609719bSwdenk		configuration driver.
2304c609719bSwdenk
23056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_CTRLC
2306c609719bSwdenk		Allow Control-C to interrupt FPGA configuration
2307c609719bSwdenk
23086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_CHECK_ERROR
2309c609719bSwdenk
2310c609719bSwdenk		Check for configuration errors during FPGA bitfile
2311c609719bSwdenk		loading. For example, abort during Virtex II
2312c609719bSwdenk		configuration if the INIT_B line goes low (which
2313c609719bSwdenk		indicated a CRC error).
2314c609719bSwdenk
23156d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_INIT
2316c609719bSwdenk
2317b445bbb4SJeremiah Mahler		Maximum time to wait for the INIT_B line to de-assert
2318b445bbb4SJeremiah Mahler		after PROB_B has been de-asserted during a Virtex II
2319c609719bSwdenk		FPGA configuration sequence. The default time is 500
232011ccc33fSMarcel Ziswiler		ms.
2321c609719bSwdenk
23226d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_BUSY
2323c609719bSwdenk
2324b445bbb4SJeremiah Mahler		Maximum time to wait for BUSY to de-assert during
232511ccc33fSMarcel Ziswiler		Virtex II FPGA configuration. The default is 5 ms.
2326c609719bSwdenk
23276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FPGA_WAIT_CONFIG
2328c609719bSwdenk
2329c609719bSwdenk		Time to wait after FPGA configuration. The default is
233011ccc33fSMarcel Ziswiler		200 ms.
2331c609719bSwdenk
2332c609719bSwdenk- Configuration Management:
2333b2b8a696SStefan Roese		CONFIG_BUILD_TARGET
2334b2b8a696SStefan Roese
2335b2b8a696SStefan Roese		Some SoCs need special image types (e.g. U-Boot binary
2336b2b8a696SStefan Roese		with a special header) as build targets. By defining
2337b2b8a696SStefan Roese		CONFIG_BUILD_TARGET in the SoC / board header, this
2338b2b8a696SStefan Roese		special image will be automatically built upon calling
23396de80f21SSimon Glass		make / buildman.
2340b2b8a696SStefan Roese
2341c609719bSwdenk		CONFIG_IDENT_STRING
2342c609719bSwdenk
2343c609719bSwdenk		If defined, this string will be added to the U-Boot
2344c609719bSwdenk		version information (U_BOOT_VERSION)
2345c609719bSwdenk
2346c609719bSwdenk- Vendor Parameter Protection:
2347c609719bSwdenk
2348c609719bSwdenk		U-Boot considers the values of the environment
2349c609719bSwdenk		variables "serial#" (Board Serial Number) and
23507152b1d0Swdenk		"ethaddr" (Ethernet Address) to be parameters that
2351c609719bSwdenk		are set once by the board vendor / manufacturer, and
2352c609719bSwdenk		protects these variables from casual modification by
2353c609719bSwdenk		the user. Once set, these variables are read-only,
2354c609719bSwdenk		and write or delete attempts are rejected. You can
235511ccc33fSMarcel Ziswiler		change this behaviour:
2356c609719bSwdenk
2357c609719bSwdenk		If CONFIG_ENV_OVERWRITE is #defined in your config
2358c609719bSwdenk		file, the write protection for vendor parameters is
235947cd00faSwdenk		completely disabled. Anybody can change or delete
2360c609719bSwdenk		these parameters.
2361c609719bSwdenk
236292ac5208SJoe Hershberger		Alternatively, if you define _both_ an ethaddr in the
236392ac5208SJoe Hershberger		default env _and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
236411ccc33fSMarcel Ziswiler		Ethernet address is installed in the environment,
2365c609719bSwdenk		which can be changed exactly ONCE by the user. [The
2366c609719bSwdenk		serial# is unaffected by this, i. e. it remains
2367c609719bSwdenk		read-only.]
2368c609719bSwdenk
23692598090bSJoe Hershberger		The same can be accomplished in a more flexible way
23702598090bSJoe Hershberger		for any variable by configuring the type of access
23712598090bSJoe Hershberger		to allow for those variables in the ".flags" variable
23722598090bSJoe Hershberger		or define CONFIG_ENV_FLAGS_LIST_STATIC.
23732598090bSJoe Hershberger
2374c609719bSwdenk- Protected RAM:
2375c609719bSwdenk		CONFIG_PRAM
2376c609719bSwdenk
2377c609719bSwdenk		Define this variable to enable the reservation of
2378c609719bSwdenk		"protected RAM", i. e. RAM which is not overwritten
2379c609719bSwdenk		by U-Boot. Define CONFIG_PRAM to hold the number of
2380c609719bSwdenk		kB you want to reserve for pRAM. You can overwrite
2381c609719bSwdenk		this default value by defining an environment
2382c609719bSwdenk		variable "pram" to the number of kB you want to
2383c609719bSwdenk		reserve. Note that the board info structure will
2384c609719bSwdenk		still show the full amount of RAM. If pRAM is
2385c609719bSwdenk		reserved, a new environment variable "mem" will
2386c609719bSwdenk		automatically be defined to hold the amount of
2387c609719bSwdenk		remaining RAM in a form that can be passed as boot
2388c609719bSwdenk		argument to Linux, for instance like that:
2389c609719bSwdenk
2390fe126d8bSWolfgang Denk			setenv bootargs ... mem=\${mem}
2391c609719bSwdenk			saveenv
2392c609719bSwdenk
2393c609719bSwdenk		This way you can tell Linux not to use this memory,
2394c609719bSwdenk		either, which results in a memory region that will
2395c609719bSwdenk		not be affected by reboots.
2396c609719bSwdenk
2397c609719bSwdenk		*WARNING* If your board configuration uses automatic
2398c609719bSwdenk		detection of the RAM size, you must make sure that
2399c609719bSwdenk		this memory test is non-destructive. So far, the
2400c609719bSwdenk		following board configurations are known to be
2401c609719bSwdenk		"pRAM-clean":
2402c609719bSwdenk
2403*5b8e76c3SHeiko Schocher			IVMS8, IVML24, SPD8xx,
24041b0757ecSWolfgang Denk			HERMES, IP860, RPXlite, LWMON,
2405544d97e9SWolfgang Denk			FLAGADM, TQM8260
2406c609719bSwdenk
240740fef049SGabe Black- Access to physical memory region (> 4GB)
240840fef049SGabe Black		Some basic support is provided for operations on memory not
240940fef049SGabe Black		normally accessible to U-Boot - e.g. some architectures
241040fef049SGabe Black		support access to more than 4GB of memory on 32-bit
241140fef049SGabe Black		machines using physical address extension or similar.
241240fef049SGabe Black		Define CONFIG_PHYSMEM to access this basic support, which
241340fef049SGabe Black		currently only supports clearing the memory.
241440fef049SGabe Black
2415c609719bSwdenk- Error Recovery:
2416c609719bSwdenk		CONFIG_PANIC_HANG
2417c609719bSwdenk
2418c609719bSwdenk		Define this variable to stop the system in case of a
2419c609719bSwdenk		fatal error, so that you have to reset it manually.
2420c609719bSwdenk		This is probably NOT a good idea for an embedded
242111ccc33fSMarcel Ziswiler		system where you want the system to reboot
2422c609719bSwdenk		automatically as fast as possible, but it may be
2423c609719bSwdenk		useful during development since you can try to debug
2424c609719bSwdenk		the conditions that lead to the situation.
2425c609719bSwdenk
2426c609719bSwdenk		CONFIG_NET_RETRY_COUNT
2427c609719bSwdenk
2428c609719bSwdenk		This variable defines the number of retries for
2429c609719bSwdenk		network operations like ARP, RARP, TFTP, or BOOTP
2430c609719bSwdenk		before giving up the operation. If not defined, a
2431c609719bSwdenk		default value of 5 is used.
2432c609719bSwdenk
243340cb90eeSGuennadi Liakhovetski		CONFIG_ARP_TIMEOUT
243440cb90eeSGuennadi Liakhovetski
243540cb90eeSGuennadi Liakhovetski		Timeout waiting for an ARP reply in milliseconds.
243640cb90eeSGuennadi Liakhovetski
243748a3e999STetsuyuki Kobayashi		CONFIG_NFS_TIMEOUT
243848a3e999STetsuyuki Kobayashi
243948a3e999STetsuyuki Kobayashi		Timeout in milliseconds used in NFS protocol.
244048a3e999STetsuyuki Kobayashi		If you encounter "ERROR: Cannot umount" in nfs command,
244148a3e999STetsuyuki Kobayashi		try longer timeout such as
244248a3e999STetsuyuki Kobayashi		#define CONFIG_NFS_TIMEOUT 10000UL
244348a3e999STetsuyuki Kobayashi
2444c609719bSwdenk- Command Interpreter:
24458078f1a5SWolfgang Denk		CONFIG_AUTO_COMPLETE
244604a85b3bSwdenk
244704a85b3bSwdenk		Enable auto completion of commands using TAB.
244804a85b3bSwdenk
24496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_PROMPT_HUSH_PS2
2450c609719bSwdenk
2451c609719bSwdenk		This defines the secondary prompt string, which is
2452c609719bSwdenk		printed when the command interpreter needs more input
2453c609719bSwdenk		to complete a command. Usually "> ".
2454c609719bSwdenk
2455c609719bSwdenk	Note:
2456c609719bSwdenk
2457c609719bSwdenk		In the current implementation, the local variables
2458c609719bSwdenk		space and global environment variables space are
2459c609719bSwdenk		separated. Local variables are those you define by
24603b57fe0aSwdenk		simply typing `name=value'. To access a local
2461c609719bSwdenk		variable later on, you have write `$name' or
24623b57fe0aSwdenk		`${name}'; to execute the contents of a variable
24633b57fe0aSwdenk		directly type `$name' at the command prompt.
2464c609719bSwdenk
2465c609719bSwdenk		Global environment variables are those you use
2466c609719bSwdenk		setenv/printenv to work with. To run a command stored
2467c609719bSwdenk		in such a variable, you need to use the run command,
2468c609719bSwdenk		and you must not use the '$' sign to access them.
2469c609719bSwdenk
2470c609719bSwdenk		To store commands and special characters in a
2471c609719bSwdenk		variable, please use double quotation marks
2472c609719bSwdenk		surrounding the whole text of the variable, instead
2473c609719bSwdenk		of the backslashes before semicolons and special
2474c609719bSwdenk		symbols.
2475c609719bSwdenk
2476b445bbb4SJeremiah Mahler- Command Line Editing and History:
2477aa0c71acSWolfgang Denk		CONFIG_CMDLINE_EDITING
2478aa0c71acSWolfgang Denk
247911ccc33fSMarcel Ziswiler		Enable editing and History functions for interactive
2480aa0c71acSWolfgang Denk		command line input operations
2481aa0c71acSWolfgang Denk
2482f3b267b3SMarek Vasut- Command Line PS1/PS2 support:
2483f3b267b3SMarek Vasut		CONFIG_CMDLINE_PS_SUPPORT
2484f3b267b3SMarek Vasut
2485f3b267b3SMarek Vasut		Enable support for changing the command prompt string
2486f3b267b3SMarek Vasut		at run-time. Only static string is supported so far.
2487f3b267b3SMarek Vasut		The string is obtained from environment variables PS1
2488f3b267b3SMarek Vasut		and PS2.
2489f3b267b3SMarek Vasut
2490a8c7c708Swdenk- Default Environment:
2491c609719bSwdenk		CONFIG_EXTRA_ENV_SETTINGS
2492c609719bSwdenk
2493c609719bSwdenk		Define this to contain any number of null terminated
2494c609719bSwdenk		strings (variable = value pairs) that will be part of
24957152b1d0Swdenk		the default environment compiled into the boot image.
24962262cfeeSwdenk
2497c609719bSwdenk		For example, place something like this in your
2498c609719bSwdenk		board's config file:
2499c609719bSwdenk
2500c609719bSwdenk		#define CONFIG_EXTRA_ENV_SETTINGS \
2501c609719bSwdenk			"myvar1=value1\0" \
2502c609719bSwdenk			"myvar2=value2\0"
2503c609719bSwdenk
2504c609719bSwdenk		Warning: This method is based on knowledge about the
2505c609719bSwdenk		internal format how the environment is stored by the
25062262cfeeSwdenk		U-Boot code. This is NOT an official, exported
2507c609719bSwdenk		interface! Although it is unlikely that this format
25087152b1d0Swdenk		will change soon, there is no guarantee either.
2509c609719bSwdenk		You better know what you are doing here.
2510c609719bSwdenk
2511c609719bSwdenk		Note: overly (ab)use of the default environment is
2512c609719bSwdenk		discouraged. Make sure to check other ways to preset
251374de7aefSWolfgang Denk		the environment like the "source" command or the
2514c609719bSwdenk		boot command first.
2515c609719bSwdenk
25165e724ca2SStephen Warren		CONFIG_ENV_VARS_UBOOT_CONFIG
25175e724ca2SStephen Warren
25185e724ca2SStephen Warren		Define this in order to add variables describing the
25195e724ca2SStephen Warren		U-Boot build configuration to the default environment.
25205e724ca2SStephen Warren		These will be named arch, cpu, board, vendor, and soc.
25215e724ca2SStephen Warren
25225e724ca2SStephen Warren		Enabling this option will cause the following to be defined:
25235e724ca2SStephen Warren
25245e724ca2SStephen Warren		- CONFIG_SYS_ARCH
25255e724ca2SStephen Warren		- CONFIG_SYS_CPU
25265e724ca2SStephen Warren		- CONFIG_SYS_BOARD
25275e724ca2SStephen Warren		- CONFIG_SYS_VENDOR
25285e724ca2SStephen Warren		- CONFIG_SYS_SOC
25295e724ca2SStephen Warren
25307e27f89fSTom Rini		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
25317e27f89fSTom Rini
25327e27f89fSTom Rini		Define this in order to add variables describing certain
25337e27f89fSTom Rini		run-time determined information about the hardware to the
25347e27f89fSTom Rini		environment.  These will be named board_name, board_rev.
25357e27f89fSTom Rini
253606fd8538SSimon Glass		CONFIG_DELAY_ENVIRONMENT
253706fd8538SSimon Glass
253806fd8538SSimon Glass		Normally the environment is loaded when the board is
2539b445bbb4SJeremiah Mahler		initialised so that it is available to U-Boot. This inhibits
254006fd8538SSimon Glass		that so that the environment is not available until
254106fd8538SSimon Glass		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
254206fd8538SSimon Glass		this is instead controlled by the value of
254306fd8538SSimon Glass		/config/load-environment.
254406fd8538SSimon Glass
2545a8c7c708Swdenk- DataFlash Support:
25462abbe075Swdenk		CONFIG_HAS_DATAFLASH
25472abbe075Swdenk
25482abbe075Swdenk		Defining this option enables DataFlash features and
25492abbe075Swdenk		allows to read/write in Dataflash via the standard
25502abbe075Swdenk		commands cp, md...
25512abbe075Swdenk
2552f61ec45eSEric Nelson- Serial Flash support
2553f61ec45eSEric Nelson		CONFIG_CMD_SF
2554f61ec45eSEric Nelson
2555f61ec45eSEric Nelson		Defining this option enables SPI flash commands
2556f61ec45eSEric Nelson		'sf probe/read/write/erase/update'.
2557f61ec45eSEric Nelson
2558f61ec45eSEric Nelson		Usage requires an initial 'probe' to define the serial
2559f61ec45eSEric Nelson		flash parameters, followed by read/write/erase/update
2560f61ec45eSEric Nelson		commands.
2561f61ec45eSEric Nelson
2562f61ec45eSEric Nelson		The following defaults may be provided by the platform
2563f61ec45eSEric Nelson		to handle the common case when only a single serial
2564f61ec45eSEric Nelson		flash is present on the system.
2565f61ec45eSEric Nelson
2566f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_BUS		Bus identifier
2567f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_CS		Chip-select
2568f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
2569f61ec45eSEric Nelson		CONFIG_SF_DEFAULT_SPEED		in Hz
2570f61ec45eSEric Nelson
257124007273SSimon Glass		CONFIG_CMD_SF_TEST
257224007273SSimon Glass
257324007273SSimon Glass		Define this option to include a destructive SPI flash
257424007273SSimon Glass		test ('sf test').
257524007273SSimon Glass
2576b902e07cSJagannadha Sutradharudu Teki		CONFIG_SF_DUAL_FLASH		Dual flash memories
2577b902e07cSJagannadha Sutradharudu Teki
2578b902e07cSJagannadha Sutradharudu Teki		Define this option to use dual flash support where two flash
2579b902e07cSJagannadha Sutradharudu Teki		memories can be connected with a given cs line.
2580b445bbb4SJeremiah Mahler		Currently Xilinx Zynq qspi supports these type of connections.
2581b902e07cSJagannadha Sutradharudu Teki
25823f85ce27Swdenk- SystemACE Support:
25833f85ce27Swdenk		CONFIG_SYSTEMACE
25843f85ce27Swdenk
25853f85ce27Swdenk		Adding this option adds support for Xilinx SystemACE
25863f85ce27Swdenk		chips attached via some sort of local bus. The address
258711ccc33fSMarcel Ziswiler		of the chip must also be defined in the
25886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
25893f85ce27Swdenk
25903f85ce27Swdenk		#define CONFIG_SYSTEMACE
25916d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
25923f85ce27Swdenk
25933f85ce27Swdenk		When SystemACE support is added, the "ace" device type
25943f85ce27Swdenk		becomes available to the fat commands, i.e. fatls.
25953f85ce27Swdenk
2596ecb0ccd9SWolfgang Denk- TFTP Fixed UDP Port:
2597ecb0ccd9SWolfgang Denk		CONFIG_TFTP_PORT
2598ecb0ccd9SWolfgang Denk
259928cb9375SWolfgang Denk		If this is defined, the environment variable tftpsrcp
2600ecb0ccd9SWolfgang Denk		is used to supply the TFTP UDP source port value.
260128cb9375SWolfgang Denk		If tftpsrcp isn't defined, the normal pseudo-random port
2602ecb0ccd9SWolfgang Denk		number generator is used.
2603ecb0ccd9SWolfgang Denk
260428cb9375SWolfgang Denk		Also, the environment variable tftpdstp is used to supply
260528cb9375SWolfgang Denk		the TFTP UDP destination port value.  If tftpdstp isn't
260628cb9375SWolfgang Denk		defined, the normal port 69 is used.
260728cb9375SWolfgang Denk
260828cb9375SWolfgang Denk		The purpose for tftpsrcp is to allow a TFTP server to
2609ecb0ccd9SWolfgang Denk		blindly start the TFTP transfer using the pre-configured
2610ecb0ccd9SWolfgang Denk		target IP address and UDP port. This has the effect of
2611ecb0ccd9SWolfgang Denk		"punching through" the (Windows XP) firewall, allowing
2612ecb0ccd9SWolfgang Denk		the remainder of the TFTP transfer to proceed normally.
2613ecb0ccd9SWolfgang Denk		A better solution is to properly configure the firewall,
2614ecb0ccd9SWolfgang Denk		but sometimes that is not allowed.
2615ecb0ccd9SWolfgang Denk
26169e50c406SHeiko Schocher- bootcount support:
26179e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_LIMIT
26189e50c406SHeiko Schocher
26199e50c406SHeiko Schocher		This enables the bootcounter support, see:
26209e50c406SHeiko Schocher		http://www.denx.de/wiki/DULG/UBootBootCountLimit
26219e50c406SHeiko Schocher
26229e50c406SHeiko Schocher		CONFIG_AT91SAM9XE
26239e50c406SHeiko Schocher		enable special bootcounter support on at91sam9xe based boards.
26249e50c406SHeiko Schocher		CONFIG_SOC_DA8XX
26259e50c406SHeiko Schocher		enable special bootcounter support on da850 based boards.
26269e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_RAM
26279e50c406SHeiko Schocher		enable support for the bootcounter in RAM
26289e50c406SHeiko Schocher		CONFIG_BOOTCOUNT_I2C
26299e50c406SHeiko Schocher		enable support for the bootcounter on an i2c (like RTC) device.
26309e50c406SHeiko Schocher			CONFIG_SYS_I2C_RTC_ADDR = i2c chip address
26319e50c406SHeiko Schocher			CONFIG_SYS_BOOTCOUNT_ADDR = i2c addr which is used for
26329e50c406SHeiko Schocher						    the bootcounter.
26339e50c406SHeiko Schocher			CONFIG_BOOTCOUNT_ALEN = address len
263419c402afSSimon Glass
2635a8c7c708Swdenk- Show boot progress:
2636c609719bSwdenk		CONFIG_SHOW_BOOT_PROGRESS
2637c609719bSwdenk
2638c609719bSwdenk		Defining this option allows to add some board-
2639c609719bSwdenk		specific code (calling a user-provided function
2640c609719bSwdenk		"show_boot_progress(int)") that enables you to show
2641c609719bSwdenk		the system's boot progress on some display (for
2642c609719bSwdenk		example, some LED's) on your board. At the moment,
2643c609719bSwdenk		the following checkpoints are implemented:
2644c609719bSwdenk
264594fd1316SSimon Glass
26461372cce2SMarian BalakowiczLegacy uImage format:
26471372cce2SMarian Balakowicz
2648c609719bSwdenk  Arg	Where			When
2649c609719bSwdenk    1	common/cmd_bootm.c	before attempting to boot an image
2650c609719bSwdenk   -1	common/cmd_bootm.c	Image header has bad	 magic number
2651c609719bSwdenk    2	common/cmd_bootm.c	Image header has correct magic number
2652c609719bSwdenk   -2	common/cmd_bootm.c	Image header has bad	 checksum
2653c609719bSwdenk    3	common/cmd_bootm.c	Image header has correct checksum
2654c609719bSwdenk   -3	common/cmd_bootm.c	Image data   has bad	 checksum
2655c609719bSwdenk    4	common/cmd_bootm.c	Image data   has correct checksum
2656c609719bSwdenk   -4	common/cmd_bootm.c	Image is for unsupported architecture
2657c609719bSwdenk    5	common/cmd_bootm.c	Architecture check OK
26581372cce2SMarian Balakowicz   -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
2659c609719bSwdenk    6	common/cmd_bootm.c	Image Type check OK
2660c609719bSwdenk   -6	common/cmd_bootm.c	gunzip uncompression error
2661c609719bSwdenk   -7	common/cmd_bootm.c	Unimplemented compression type
2662c609719bSwdenk    7	common/cmd_bootm.c	Uncompression OK
26631372cce2SMarian Balakowicz    8	common/cmd_bootm.c	No uncompress/copy overwrite error
2664c609719bSwdenk   -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
26651372cce2SMarian Balakowicz
26661372cce2SMarian Balakowicz    9	common/image.c		Start initial ramdisk verification
26671372cce2SMarian Balakowicz  -10	common/image.c		Ramdisk header has bad	   magic number
26681372cce2SMarian Balakowicz  -11	common/image.c		Ramdisk header has bad	   checksum
26691372cce2SMarian Balakowicz   10	common/image.c		Ramdisk header is OK
26701372cce2SMarian Balakowicz  -12	common/image.c		Ramdisk data   has bad	   checksum
26711372cce2SMarian Balakowicz   11	common/image.c		Ramdisk data   has correct checksum
26721372cce2SMarian Balakowicz   12	common/image.c		Ramdisk verification complete, start loading
267311ccc33fSMarcel Ziswiler  -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
26741372cce2SMarian Balakowicz   13	common/image.c		Start multifile image verification
26751372cce2SMarian Balakowicz   14	common/image.c		No initial ramdisk, no multifile, continue.
26761372cce2SMarian Balakowicz
2677ea0364f1SPeter Tyser   15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
2678c609719bSwdenk
2679a47a12beSStefan Roese  -30	arch/powerpc/lib/board.c	Fatal error, hang the system
268063e73c9aSwdenk  -31	post/post.c		POST test failed, detected by post_output_backlog()
268163e73c9aSwdenk  -32	post/post.c		POST test failed, detected by post_run_single()
268263e73c9aSwdenk
2683566a494fSHeiko Schocher   34	common/cmd_doc.c	before loading a Image from a DOC device
2684566a494fSHeiko Schocher  -35	common/cmd_doc.c	Bad usage of "doc" command
2685566a494fSHeiko Schocher   35	common/cmd_doc.c	correct usage of "doc" command
2686566a494fSHeiko Schocher  -36	common/cmd_doc.c	No boot device
2687566a494fSHeiko Schocher   36	common/cmd_doc.c	correct boot device
2688566a494fSHeiko Schocher  -37	common/cmd_doc.c	Unknown Chip ID on boot device
2689566a494fSHeiko Schocher   37	common/cmd_doc.c	correct chip ID found, device available
2690566a494fSHeiko Schocher  -38	common/cmd_doc.c	Read Error on boot device
2691566a494fSHeiko Schocher   38	common/cmd_doc.c	reading Image header from DOC device OK
2692566a494fSHeiko Schocher  -39	common/cmd_doc.c	Image header has bad magic number
2693566a494fSHeiko Schocher   39	common/cmd_doc.c	Image header has correct magic number
2694566a494fSHeiko Schocher  -40	common/cmd_doc.c	Error reading Image from DOC device
2695566a494fSHeiko Schocher   40	common/cmd_doc.c	Image header has correct magic number
2696566a494fSHeiko Schocher   41	common/cmd_ide.c	before loading a Image from a IDE device
2697566a494fSHeiko Schocher  -42	common/cmd_ide.c	Bad usage of "ide" command
2698566a494fSHeiko Schocher   42	common/cmd_ide.c	correct usage of "ide" command
2699566a494fSHeiko Schocher  -43	common/cmd_ide.c	No boot device
2700566a494fSHeiko Schocher   43	common/cmd_ide.c	boot device found
2701566a494fSHeiko Schocher  -44	common/cmd_ide.c	Device not available
2702566a494fSHeiko Schocher   44	common/cmd_ide.c	Device available
2703566a494fSHeiko Schocher  -45	common/cmd_ide.c	wrong partition selected
2704566a494fSHeiko Schocher   45	common/cmd_ide.c	partition selected
2705566a494fSHeiko Schocher  -46	common/cmd_ide.c	Unknown partition table
2706566a494fSHeiko Schocher   46	common/cmd_ide.c	valid partition table found
2707566a494fSHeiko Schocher  -47	common/cmd_ide.c	Invalid partition type
2708566a494fSHeiko Schocher   47	common/cmd_ide.c	correct partition type
2709566a494fSHeiko Schocher  -48	common/cmd_ide.c	Error reading Image Header on boot device
2710566a494fSHeiko Schocher   48	common/cmd_ide.c	reading Image Header from IDE device OK
2711566a494fSHeiko Schocher  -49	common/cmd_ide.c	Image header has bad magic number
2712566a494fSHeiko Schocher   49	common/cmd_ide.c	Image header has correct magic number
2713566a494fSHeiko Schocher  -50	common/cmd_ide.c	Image header has bad	 checksum
2714566a494fSHeiko Schocher   50	common/cmd_ide.c	Image header has correct checksum
2715566a494fSHeiko Schocher  -51	common/cmd_ide.c	Error reading Image from IDE device
2716566a494fSHeiko Schocher   51	common/cmd_ide.c	reading Image from IDE device OK
2717566a494fSHeiko Schocher   52	common/cmd_nand.c	before loading a Image from a NAND device
2718566a494fSHeiko Schocher  -53	common/cmd_nand.c	Bad usage of "nand" command
2719566a494fSHeiko Schocher   53	common/cmd_nand.c	correct usage of "nand" command
2720566a494fSHeiko Schocher  -54	common/cmd_nand.c	No boot device
2721566a494fSHeiko Schocher   54	common/cmd_nand.c	boot device found
2722566a494fSHeiko Schocher  -55	common/cmd_nand.c	Unknown Chip ID on boot device
2723566a494fSHeiko Schocher   55	common/cmd_nand.c	correct chip ID found, device available
2724566a494fSHeiko Schocher  -56	common/cmd_nand.c	Error reading Image Header on boot device
2725566a494fSHeiko Schocher   56	common/cmd_nand.c	reading Image Header from NAND device OK
2726566a494fSHeiko Schocher  -57	common/cmd_nand.c	Image header has bad magic number
2727566a494fSHeiko Schocher   57	common/cmd_nand.c	Image header has correct magic number
2728566a494fSHeiko Schocher  -58	common/cmd_nand.c	Error reading Image from NAND device
2729566a494fSHeiko Schocher   58	common/cmd_nand.c	reading Image from NAND device OK
2730c609719bSwdenk
2731566a494fSHeiko Schocher  -60	common/env_common.c	Environment has a bad CRC, using default
2732c609719bSwdenk
2733566a494fSHeiko Schocher   64	net/eth.c		starting with Ethernet configuration.
2734566a494fSHeiko Schocher  -64	net/eth.c		no Ethernet found.
2735566a494fSHeiko Schocher   65	net/eth.c		Ethernet found.
2736206c60cbSwdenk
2737566a494fSHeiko Schocher  -80	common/cmd_net.c	usage wrong
2738bc0571fcSJoe Hershberger   80	common/cmd_net.c	before calling net_loop()
2739bc0571fcSJoe Hershberger  -81	common/cmd_net.c	some error in net_loop() occurred
2740bc0571fcSJoe Hershberger   81	common/cmd_net.c	net_loop() back without error
2741566a494fSHeiko Schocher  -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
2742566a494fSHeiko Schocher   82	common/cmd_net.c	trying automatic boot
274374de7aefSWolfgang Denk   83	common/cmd_net.c	running "source" command
274474de7aefSWolfgang Denk  -83	common/cmd_net.c	some error in automatic boot or "source" command
2745566a494fSHeiko Schocher   84	common/cmd_net.c	end without errors
2746c609719bSwdenk
27471372cce2SMarian BalakowiczFIT uImage format:
27481372cce2SMarian Balakowicz
27491372cce2SMarian Balakowicz  Arg	Where			When
27501372cce2SMarian Balakowicz  100	common/cmd_bootm.c	Kernel FIT Image has correct format
27511372cce2SMarian Balakowicz -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
27521372cce2SMarian Balakowicz  101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
27531372cce2SMarian Balakowicz -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
27541372cce2SMarian Balakowicz  102	common/cmd_bootm.c	Kernel unit name specified
27551372cce2SMarian Balakowicz -103	common/cmd_bootm.c	Can't get kernel subimage node offset
2756f773bea8SMarian Balakowicz  103	common/cmd_bootm.c	Found configuration node
27571372cce2SMarian Balakowicz  104	common/cmd_bootm.c	Got kernel subimage node offset
27581372cce2SMarian Balakowicz -104	common/cmd_bootm.c	Kernel subimage hash verification failed
27591372cce2SMarian Balakowicz  105	common/cmd_bootm.c	Kernel subimage hash verification OK
27601372cce2SMarian Balakowicz -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
27611372cce2SMarian Balakowicz  106	common/cmd_bootm.c	Architecture check OK
276211ccc33fSMarcel Ziswiler -106	common/cmd_bootm.c	Kernel subimage has wrong type
276311ccc33fSMarcel Ziswiler  107	common/cmd_bootm.c	Kernel subimage type OK
27641372cce2SMarian Balakowicz -107	common/cmd_bootm.c	Can't get kernel subimage data/size
27651372cce2SMarian Balakowicz  108	common/cmd_bootm.c	Got kernel subimage data/size
27661372cce2SMarian Balakowicz -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
27671372cce2SMarian Balakowicz -109	common/cmd_bootm.c	Can't get kernel subimage type
27681372cce2SMarian Balakowicz -110	common/cmd_bootm.c	Can't get kernel subimage comp
27691372cce2SMarian Balakowicz -111	common/cmd_bootm.c	Can't get kernel subimage os
27701372cce2SMarian Balakowicz -112	common/cmd_bootm.c	Can't get kernel subimage load address
27711372cce2SMarian Balakowicz -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
27721372cce2SMarian Balakowicz
27731372cce2SMarian Balakowicz  120	common/image.c		Start initial ramdisk verification
27741372cce2SMarian Balakowicz -120	common/image.c		Ramdisk FIT image has incorrect format
27751372cce2SMarian Balakowicz  121	common/image.c		Ramdisk FIT image has correct format
277611ccc33fSMarcel Ziswiler  122	common/image.c		No ramdisk subimage unit name, using configuration
27771372cce2SMarian Balakowicz -122	common/image.c		Can't get configuration for ramdisk subimage
27781372cce2SMarian Balakowicz  123	common/image.c		Ramdisk unit name specified
27791372cce2SMarian Balakowicz -124	common/image.c		Can't get ramdisk subimage node offset
27801372cce2SMarian Balakowicz  125	common/image.c		Got ramdisk subimage node offset
27811372cce2SMarian Balakowicz -125	common/image.c		Ramdisk subimage hash verification failed
27821372cce2SMarian Balakowicz  126	common/image.c		Ramdisk subimage hash verification OK
27831372cce2SMarian Balakowicz -126	common/image.c		Ramdisk subimage for unsupported architecture
27841372cce2SMarian Balakowicz  127	common/image.c		Architecture check OK
27851372cce2SMarian Balakowicz -127	common/image.c		Can't get ramdisk subimage data/size
27861372cce2SMarian Balakowicz  128	common/image.c		Got ramdisk subimage data/size
27871372cce2SMarian Balakowicz  129	common/image.c		Can't get ramdisk load address
27881372cce2SMarian Balakowicz -129	common/image.c		Got ramdisk load address
27891372cce2SMarian Balakowicz
279011ccc33fSMarcel Ziswiler -130	common/cmd_doc.c	Incorrect FIT image format
27911372cce2SMarian Balakowicz  131	common/cmd_doc.c	FIT image format OK
27921372cce2SMarian Balakowicz
279311ccc33fSMarcel Ziswiler -140	common/cmd_ide.c	Incorrect FIT image format
27941372cce2SMarian Balakowicz  141	common/cmd_ide.c	FIT image format OK
27951372cce2SMarian Balakowicz
279611ccc33fSMarcel Ziswiler -150	common/cmd_nand.c	Incorrect FIT image format
27971372cce2SMarian Balakowicz  151	common/cmd_nand.c	FIT image format OK
27981372cce2SMarian Balakowicz
279921d29f7fSHeiko Schocher- legacy image format:
280021d29f7fSHeiko Schocher		CONFIG_IMAGE_FORMAT_LEGACY
280121d29f7fSHeiko Schocher		enables the legacy image format support in U-Boot.
280221d29f7fSHeiko Schocher
280321d29f7fSHeiko Schocher		Default:
280421d29f7fSHeiko Schocher		enabled if CONFIG_FIT_SIGNATURE is not defined.
280521d29f7fSHeiko Schocher
280621d29f7fSHeiko Schocher		CONFIG_DISABLE_IMAGE_LEGACY
280721d29f7fSHeiko Schocher		disable the legacy image format
280821d29f7fSHeiko Schocher
280921d29f7fSHeiko Schocher		This define is introduced, as the legacy image format is
281021d29f7fSHeiko Schocher		enabled per default for backward compatibility.
281121d29f7fSHeiko Schocher
28124cf2609bSWolfgang Denk- Standalone program support:
28134cf2609bSWolfgang Denk		CONFIG_STANDALONE_LOAD_ADDR
28144cf2609bSWolfgang Denk
28156feff899SWolfgang Denk		This option defines a board specific value for the
28166feff899SWolfgang Denk		address where standalone program gets loaded, thus
28176feff899SWolfgang Denk		overwriting the architecture dependent default
28184cf2609bSWolfgang Denk		settings.
28194cf2609bSWolfgang Denk
28204cf2609bSWolfgang Denk- Frame Buffer Address:
28214cf2609bSWolfgang Denk		CONFIG_FB_ADDR
28224cf2609bSWolfgang Denk
28234cf2609bSWolfgang Denk		Define CONFIG_FB_ADDR if you want to use specific
282444a53b57SWolfgang Denk		address for frame buffer.  This is typically the case
282544a53b57SWolfgang Denk		when using a graphics controller has separate video
282644a53b57SWolfgang Denk		memory.  U-Boot will then place the frame buffer at
282744a53b57SWolfgang Denk		the given address instead of dynamically reserving it
282844a53b57SWolfgang Denk		in system RAM by calling lcd_setmem(), which grabs
282944a53b57SWolfgang Denk		the memory for the frame buffer depending on the
283044a53b57SWolfgang Denk		configured panel size.
28314cf2609bSWolfgang Denk
28324cf2609bSWolfgang Denk		Please see board_init_f function.
28334cf2609bSWolfgang Denk
2834cccfc2abSDetlev Zundel- Automatic software updates via TFTP server
2835cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP
2836cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_CNT_MAX
2837cccfc2abSDetlev Zundel		CONFIG_UPDATE_TFTP_MSEC_MAX
2838cccfc2abSDetlev Zundel
2839cccfc2abSDetlev Zundel		These options enable and control the auto-update feature;
2840cccfc2abSDetlev Zundel		for a more detailed description refer to doc/README.update.
2841cccfc2abSDetlev Zundel
2842cccfc2abSDetlev Zundel- MTD Support (mtdparts command, UBI support)
2843cccfc2abSDetlev Zundel		CONFIG_MTD_DEVICE
2844cccfc2abSDetlev Zundel
2845cccfc2abSDetlev Zundel		Adds the MTD device infrastructure from the Linux kernel.
2846cccfc2abSDetlev Zundel		Needed for mtdparts command support.
2847cccfc2abSDetlev Zundel
2848cccfc2abSDetlev Zundel		CONFIG_MTD_PARTITIONS
2849cccfc2abSDetlev Zundel
2850cccfc2abSDetlev Zundel		Adds the MTD partitioning infrastructure from the Linux
2851cccfc2abSDetlev Zundel		kernel. Needed for UBI support.
2852cccfc2abSDetlev Zundel
285370c219cdSJoe Hershberger- UBI support
285470c219cdSJoe Hershberger		CONFIG_CMD_UBI
285570c219cdSJoe Hershberger
285670c219cdSJoe Hershberger		Adds commands for interacting with MTD partitions formatted
285770c219cdSJoe Hershberger		with the UBI flash translation layer
285870c219cdSJoe Hershberger
285970c219cdSJoe Hershberger		Requires also defining CONFIG_RBTREE
286070c219cdSJoe Hershberger
2861147162daSJoe Hershberger		CONFIG_UBI_SILENCE_MSG
2862147162daSJoe Hershberger
2863147162daSJoe Hershberger		Make the verbose messages from UBI stop printing.  This leaves
2864147162daSJoe Hershberger		warnings and errors enabled.
2865147162daSJoe Hershberger
2866ff94bc40SHeiko Schocher
2867ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_WL_THRESHOLD
2868ff94bc40SHeiko Schocher		This parameter defines the maximum difference between the highest
2869ff94bc40SHeiko Schocher		erase counter value and the lowest erase counter value of eraseblocks
2870ff94bc40SHeiko Schocher		of UBI devices. When this threshold is exceeded, UBI starts performing
2871ff94bc40SHeiko Schocher		wear leveling by means of moving data from eraseblock with low erase
2872ff94bc40SHeiko Schocher		counter to eraseblocks with high erase counter.
2873ff94bc40SHeiko Schocher
2874ff94bc40SHeiko Schocher		The default value should be OK for SLC NAND flashes, NOR flashes and
2875ff94bc40SHeiko Schocher		other flashes which have eraseblock life-cycle 100000 or more.
2876ff94bc40SHeiko Schocher		However, in case of MLC NAND flashes which typically have eraseblock
2877ff94bc40SHeiko Schocher		life-cycle less than 10000, the threshold should be lessened (e.g.,
2878ff94bc40SHeiko Schocher		to 128 or 256, although it does not have to be power of 2).
2879ff94bc40SHeiko Schocher
2880ff94bc40SHeiko Schocher		default: 4096
2881ff94bc40SHeiko Schocher
2882ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_BEB_LIMIT
2883ff94bc40SHeiko Schocher		This option specifies the maximum bad physical eraseblocks UBI
2884ff94bc40SHeiko Schocher		expects on the MTD device (per 1024 eraseblocks). If the
2885ff94bc40SHeiko Schocher		underlying flash does not admit of bad eraseblocks (e.g. NOR
2886ff94bc40SHeiko Schocher		flash), this value is ignored.
2887ff94bc40SHeiko Schocher
2888ff94bc40SHeiko Schocher		NAND datasheets often specify the minimum and maximum NVM
2889ff94bc40SHeiko Schocher		(Number of Valid Blocks) for the flashes' endurance lifetime.
2890ff94bc40SHeiko Schocher		The maximum expected bad eraseblocks per 1024 eraseblocks
2891ff94bc40SHeiko Schocher		then can be calculated as "1024 * (1 - MinNVB / MaxNVB)",
2892ff94bc40SHeiko Schocher		which gives 20 for most NANDs (MaxNVB is basically the total
2893ff94bc40SHeiko Schocher		count of eraseblocks on the chip).
2894ff94bc40SHeiko Schocher
2895ff94bc40SHeiko Schocher		To put it differently, if this value is 20, UBI will try to
2896ff94bc40SHeiko Schocher		reserve about 1.9% of physical eraseblocks for bad blocks
2897ff94bc40SHeiko Schocher		handling. And that will be 1.9% of eraseblocks on the entire
2898ff94bc40SHeiko Schocher		NAND chip, not just the MTD partition UBI attaches. This means
2899ff94bc40SHeiko Schocher		that if you have, say, a NAND flash chip admits maximum 40 bad
2900ff94bc40SHeiko Schocher		eraseblocks, and it is split on two MTD partitions of the same
2901ff94bc40SHeiko Schocher		size, UBI will reserve 40 eraseblocks when attaching a
2902ff94bc40SHeiko Schocher		partition.
2903ff94bc40SHeiko Schocher
2904ff94bc40SHeiko Schocher		default: 20
2905ff94bc40SHeiko Schocher
2906ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP
2907ff94bc40SHeiko Schocher		Fastmap is a mechanism which allows attaching an UBI device
2908ff94bc40SHeiko Schocher		in nearly constant time. Instead of scanning the whole MTD device it
2909ff94bc40SHeiko Schocher		only has to locate a checkpoint (called fastmap) on the device.
2910ff94bc40SHeiko Schocher		The on-flash fastmap contains all information needed to attach
2911ff94bc40SHeiko Schocher		the device. Using fastmap makes only sense on large devices where
2912ff94bc40SHeiko Schocher		attaching by scanning takes long. UBI will not automatically install
2913ff94bc40SHeiko Schocher		a fastmap on old images, but you can set the UBI parameter
2914ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT to 1 if you want so. Please note
2915ff94bc40SHeiko Schocher		that fastmap-enabled images are still usable with UBI implementations
2916ff94bc40SHeiko Schocher		without	fastmap support. On typical flash devices the whole fastmap
2917ff94bc40SHeiko Schocher		fits into one PEB. UBI will reserve PEBs to hold two fastmaps.
2918ff94bc40SHeiko Schocher
2919ff94bc40SHeiko Schocher		CONFIG_MTD_UBI_FASTMAP_AUTOCONVERT
2920ff94bc40SHeiko Schocher		Set this parameter to enable fastmap automatically on images
2921ff94bc40SHeiko Schocher		without a fastmap.
2922ff94bc40SHeiko Schocher		default: 0
2923ff94bc40SHeiko Schocher
29240195a7bbSHeiko Schocher		CONFIG_MTD_UBI_FM_DEBUG
29250195a7bbSHeiko Schocher		Enable UBI fastmap debug
29260195a7bbSHeiko Schocher		default: 0
29270195a7bbSHeiko Schocher
292870c219cdSJoe Hershberger- UBIFS support
292970c219cdSJoe Hershberger		CONFIG_CMD_UBIFS
293070c219cdSJoe Hershberger
293170c219cdSJoe Hershberger		Adds commands for interacting with UBI volumes formatted as
293270c219cdSJoe Hershberger		UBIFS.  UBIFS is read-only in u-boot.
293370c219cdSJoe Hershberger
293470c219cdSJoe Hershberger		Requires UBI support as well as CONFIG_LZO
293570c219cdSJoe Hershberger
2936147162daSJoe Hershberger		CONFIG_UBIFS_SILENCE_MSG
2937147162daSJoe Hershberger
2938147162daSJoe Hershberger		Make the verbose messages from UBIFS stop printing.  This leaves
2939147162daSJoe Hershberger		warnings and errors enabled.
2940147162daSJoe Hershberger
29416a11cf48SDaniel Schwierzeck- SPL framework
29426a11cf48SDaniel Schwierzeck		CONFIG_SPL
29436a11cf48SDaniel Schwierzeck		Enable building of SPL globally.
29446a11cf48SDaniel Schwierzeck
294595579793STom Rini		CONFIG_SPL_LDSCRIPT
294695579793STom Rini		LDSCRIPT for linking the SPL binary.
294795579793STom Rini
29486ebc3461SAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT
29496ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL, BSS included.
29506ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory
29516ebc3461SAlbert ARIBAUD		used by SPL from _start to __bss_end does not exceed it.
29528960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29536ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
29546ebc3461SAlbert ARIBAUD
295595579793STom Rini		CONFIG_SPL_MAX_SIZE
29566ebc3461SAlbert ARIBAUD		Maximum size of the SPL image (text, data, rodata, and
29576ebc3461SAlbert ARIBAUD		linker lists sections), BSS excluded.
29586ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual size does
29596ebc3461SAlbert ARIBAUD		not exceed it.
296095579793STom Rini
29616a11cf48SDaniel Schwierzeck		CONFIG_SPL_TEXT_BASE
29626a11cf48SDaniel Schwierzeck		TEXT_BASE for linking the SPL binary.
29636a11cf48SDaniel Schwierzeck
296494a45bb1SScott Wood		CONFIG_SPL_RELOC_TEXT_BASE
296594a45bb1SScott Wood		Address to relocate to.  If unspecified, this is equal to
296694a45bb1SScott Wood		CONFIG_SPL_TEXT_BASE (i.e. no relocation is done).
296794a45bb1SScott Wood
296895579793STom Rini		CONFIG_SPL_BSS_START_ADDR
296995579793STom Rini		Link address for the BSS within the SPL binary.
297095579793STom Rini
297195579793STom Rini		CONFIG_SPL_BSS_MAX_SIZE
29726ebc3461SAlbert ARIBAUD		Maximum size in memory allocated to the SPL BSS.
29736ebc3461SAlbert ARIBAUD		When defined, the linker checks that the actual memory used
29746ebc3461SAlbert ARIBAUD		by SPL from __bss_start to __bss_end does not exceed it.
29758960af8bSAlbert ARIBAUD		CONFIG_SPL_MAX_FOOTPRINT and CONFIG_SPL_BSS_MAX_SIZE
29766ebc3461SAlbert ARIBAUD		must not be both defined at the same time.
297795579793STom Rini
297895579793STom Rini		CONFIG_SPL_STACK
297995579793STom Rini		Adress of the start of the stack SPL will use
298095579793STom Rini
29818c80eb3bSAlbert ARIBAUD \(3ADEV\)		CONFIG_SPL_PANIC_ON_RAW_IMAGE
29828c80eb3bSAlbert ARIBAUD \(3ADEV\)		When defined, SPL will panic() if the image it has
29838c80eb3bSAlbert ARIBAUD \(3ADEV\)		loaded does not have a signature.
29848c80eb3bSAlbert ARIBAUD \(3ADEV\)		Defining this is useful when code which loads images
29858c80eb3bSAlbert ARIBAUD \(3ADEV\)		in SPL cannot guarantee that absolutely all read errors
29868c80eb3bSAlbert ARIBAUD \(3ADEV\)		will be caught.
29878c80eb3bSAlbert ARIBAUD \(3ADEV\)		An example is the LPC32XX MLC NAND driver, which will
29888c80eb3bSAlbert ARIBAUD \(3ADEV\)		consider that a completely unreadable NAND block is bad,
29898c80eb3bSAlbert ARIBAUD \(3ADEV\)		and thus should be skipped silently.
29908c80eb3bSAlbert ARIBAUD \(3ADEV\)
299194a45bb1SScott Wood		CONFIG_SPL_RELOC_STACK
299294a45bb1SScott Wood		Adress of the start of the stack SPL will use after
299394a45bb1SScott Wood		relocation.  If unspecified, this is equal to
299494a45bb1SScott Wood		CONFIG_SPL_STACK.
299594a45bb1SScott Wood
299695579793STom Rini		CONFIG_SYS_SPL_MALLOC_START
299795579793STom Rini		Starting address of the malloc pool used in SPL.
29989ac4fc82SFabio Estevam		When this option is set the full malloc is used in SPL and
29999ac4fc82SFabio Estevam		it is set up by spl_init() and before that, the simple malloc()
30009ac4fc82SFabio Estevam		can be used if CONFIG_SYS_MALLOC_F is defined.
300195579793STom Rini
300295579793STom Rini		CONFIG_SYS_SPL_MALLOC_SIZE
300395579793STom Rini		The size of the malloc pool used in SPL.
30046a11cf48SDaniel Schwierzeck
300547f7bcaeSTom Rini		CONFIG_SPL_FRAMEWORK
300647f7bcaeSTom Rini		Enable the SPL framework under common/.  This framework
300747f7bcaeSTom Rini		supports MMC, NAND and YMODEM loading of U-Boot and NAND
300847f7bcaeSTom Rini		NAND loading of the Linux Kernel.
300947f7bcaeSTom Rini
30109607faf2STom Rini		CONFIG_SPL_OS_BOOT
30119607faf2STom Rini		Enable booting directly to an OS from SPL.
30129607faf2STom Rini		See also: doc/README.falcon
30139607faf2STom Rini
3014861a86f4STom Rini		CONFIG_SPL_DISPLAY_PRINT
3015861a86f4STom Rini		For ARM, enable an optional function to print more information
3016861a86f4STom Rini		about the running system.
3017861a86f4STom Rini
30184b919725SScott Wood		CONFIG_SPL_INIT_MINIMAL
30194b919725SScott Wood		Arch init code should be built for a very small image
30204b919725SScott Wood
3021b97300b6SPaul Kocialkowski		CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_PARTITION
3022b97300b6SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3023b97300b6SPaul Kocialkowski		used in raw mode
3024b97300b6SPaul Kocialkowski
30252b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_KERNEL_SECTOR
30262b75b0adSPeter Korsgaard		Sector to load kernel uImage from when MMC is being
30272b75b0adSPeter Korsgaard		used in raw mode (for Falcon mode)
30282b75b0adSPeter Korsgaard
30292b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTOR,
30302b75b0adSPeter Korsgaard		CONFIG_SYS_MMCSD_RAW_MODE_ARGS_SECTORS
30312b75b0adSPeter Korsgaard		Sector and number of sectors to load kernel argument
30322b75b0adSPeter Korsgaard		parameters from when MMC is being used in raw mode
30332b75b0adSPeter Korsgaard		(for falcon mode)
30342b75b0adSPeter Korsgaard
3035e2ccdf89SPaul Kocialkowski		CONFIG_SYS_MMCSD_FS_BOOT_PARTITION
3036e2ccdf89SPaul Kocialkowski		Partition on the MMC to load U-Boot from when the MMC is being
3037e2ccdf89SPaul Kocialkowski		used in fs mode
3038e2ccdf89SPaul Kocialkowski
3039fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
3040fae81c72SGuillaume GARDET		Filename to read to load U-Boot when reading from filesystem
3041fae81c72SGuillaume GARDET
3042fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_KERNEL_NAME
30437ad2cc79SPeter Korsgaard		Filename to read to load kernel uImage when reading
3044fae81c72SGuillaume GARDET		from filesystem (for Falcon mode)
30457ad2cc79SPeter Korsgaard
3046fae81c72SGuillaume GARDET		CONFIG_SPL_FS_LOAD_ARGS_NAME
30477ad2cc79SPeter Korsgaard		Filename to read to load kernel argument parameters
3048fae81c72SGuillaume GARDET		when reading from filesystem (for Falcon mode)
30497ad2cc79SPeter Korsgaard
305006f60ae3SScott Wood		CONFIG_SPL_MPC83XX_WAIT_FOR_NAND
305106f60ae3SScott Wood		Set this for NAND SPL on PPC mpc83xx targets, so that
305206f60ae3SScott Wood		start.S waits for the rest of the SPL to load before
305306f60ae3SScott Wood		continuing (the hardware starts execution after just
305406f60ae3SScott Wood		loading the first page rather than the full 4K).
305506f60ae3SScott Wood
3056651fcf60SPrabhakar Kushwaha		CONFIG_SPL_SKIP_RELOCATE
3057651fcf60SPrabhakar Kushwaha		Avoid SPL relocation
3058651fcf60SPrabhakar Kushwaha
30596f2f01b9SScott Wood		CONFIG_SPL_NAND_BASE
30606f2f01b9SScott Wood		Include nand_base.c in the SPL.  Requires
30616f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS.
30626f2f01b9SScott Wood
30636f2f01b9SScott Wood		CONFIG_SPL_NAND_DRIVERS
30646f2f01b9SScott Wood		SPL uses normal NAND drivers, not minimal drivers.
30656f2f01b9SScott Wood
30666f2f01b9SScott Wood		CONFIG_SPL_NAND_ECC
30676f2f01b9SScott Wood		Include standard software ECC in the SPL
30686f2f01b9SScott Wood
306995579793STom Rini		CONFIG_SPL_NAND_SIMPLE
30707d4b7955SScott Wood		Support for NAND boot using simple NAND drivers that
30717d4b7955SScott Wood		expose the cmd_ctrl() interface.
307295579793STom Rini
30736f4e7d3cSThomas Gleixner		CONFIG_SPL_UBI
30746f4e7d3cSThomas Gleixner		Support for a lightweight UBI (fastmap) scanner and
30756f4e7d3cSThomas Gleixner		loader
30766f4e7d3cSThomas Gleixner
30770c3117b1SHeiko Schocher		CONFIG_SPL_NAND_RAW_ONLY
30780c3117b1SHeiko Schocher		Support to boot only raw u-boot.bin images. Use this only
30790c3117b1SHeiko Schocher		if you need to save space.
30800c3117b1SHeiko Schocher
30817c8eea59SYing Zhang		CONFIG_SPL_COMMON_INIT_DDR
30827c8eea59SYing Zhang		Set for common ddr init with serial presence detect in
30837c8eea59SYing Zhang		SPL binary.
30847c8eea59SYing Zhang
308595579793STom Rini		CONFIG_SYS_NAND_5_ADDR_CYCLE, CONFIG_SYS_NAND_PAGE_COUNT,
308695579793STom Rini		CONFIG_SYS_NAND_PAGE_SIZE, CONFIG_SYS_NAND_OOBSIZE,
308795579793STom Rini		CONFIG_SYS_NAND_BLOCK_SIZE, CONFIG_SYS_NAND_BAD_BLOCK_POS,
308895579793STom Rini		CONFIG_SYS_NAND_ECCPOS, CONFIG_SYS_NAND_ECCSIZE,
308995579793STom Rini		CONFIG_SYS_NAND_ECCBYTES
309095579793STom Rini		Defines the size and behavior of the NAND that SPL uses
30917d4b7955SScott Wood		to read U-Boot
309295579793STom Rini
3093fbe76ae4SPrabhakar Kushwaha		CONFIG_SPL_NAND_BOOT
3094fbe76ae4SPrabhakar Kushwaha		Add support NAND boot
3095fbe76ae4SPrabhakar Kushwaha
309695579793STom Rini		CONFIG_SYS_NAND_U_BOOT_OFFS
30977d4b7955SScott Wood		Location in NAND to read U-Boot from
30987d4b7955SScott Wood
30997d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_DST
31007d4b7955SScott Wood		Location in memory to load U-Boot to
31017d4b7955SScott Wood
31027d4b7955SScott Wood		CONFIG_SYS_NAND_U_BOOT_SIZE
31037d4b7955SScott Wood		Size of image to load
310495579793STom Rini
310595579793STom Rini		CONFIG_SYS_NAND_U_BOOT_START
31067d4b7955SScott Wood		Entry point in loaded image to jump to
310795579793STom Rini
310895579793STom Rini		CONFIG_SYS_NAND_HW_ECC_OOBFIRST
310995579793STom Rini		Define this if you need to first read the OOB and then the
3110b445bbb4SJeremiah Mahler		data. This is used, for example, on davinci platforms.
311195579793STom Rini
311295579793STom Rini		CONFIG_SPL_OMAP3_ID_NAND
311395579793STom Rini		Support for an OMAP3-specific set of functions to return the
311495579793STom Rini		ID and MFR of the first attached NAND chip, if present.
311595579793STom Rini
3116c57b953dSPavel Machek		CONFIG_SPL_RAM_DEVICE
3117c57b953dSPavel Machek		Support for running image already present in ram, in SPL binary
3118c57b953dSPavel Machek
311974752baaSScott Wood		CONFIG_SPL_PAD_TO
31206113d3f2SBenoît Thébaudeau		Image offset to which the SPL should be padded before appending
31216113d3f2SBenoît Thébaudeau		the SPL payload. By default, this is defined as
31226113d3f2SBenoît Thébaudeau		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
31236113d3f2SBenoît Thébaudeau		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
31246113d3f2SBenoît Thébaudeau		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
312574752baaSScott Wood
3126ca2fca22SScott Wood		CONFIG_SPL_TARGET
3127ca2fca22SScott Wood		Final target image containing SPL and payload.  Some SPLs
3128ca2fca22SScott Wood		use an arch-specific makefile fragment instead, for
3129ca2fca22SScott Wood		example if more than one image needs to be produced.
3130ca2fca22SScott Wood
313187ebee39SSimon Glass		CONFIG_FIT_SPL_PRINT
313287ebee39SSimon Glass		Printing information about a FIT image adds quite a bit of
313387ebee39SSimon Glass		code to SPL. So this is normally disabled in SPL. Use this
313487ebee39SSimon Glass		option to re-enable it. This will affect the output of the
313587ebee39SSimon Glass		bootm command when booting a FIT image.
313687ebee39SSimon Glass
31373aa29de0SYing Zhang- TPL framework
31383aa29de0SYing Zhang		CONFIG_TPL
31393aa29de0SYing Zhang		Enable building of TPL globally.
31403aa29de0SYing Zhang
31413aa29de0SYing Zhang		CONFIG_TPL_PAD_TO
31423aa29de0SYing Zhang		Image offset to which the TPL should be padded before appending
31433aa29de0SYing Zhang		the TPL payload. By default, this is defined as
31443aa29de0SYing Zhang		CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
31453aa29de0SYing Zhang		CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
31463aa29de0SYing Zhang		payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
31473aa29de0SYing Zhang
3148a8c7c708Swdenk- Interrupt support (PPC):
3149a8c7c708Swdenk
3150a8c7c708Swdenk		There are common interrupt_init() and timer_interrupt()
3151a8c7c708Swdenk		for all PPC archs. interrupt_init() calls interrupt_init_cpu()
315211ccc33fSMarcel Ziswiler		for CPU specific initialization. interrupt_init_cpu()
3153a8c7c708Swdenk		should set decrementer_count to appropriate value. If
315411ccc33fSMarcel Ziswiler		CPU resets decrementer automatically after interrupt
3155a8c7c708Swdenk		(ppc4xx) it should set decrementer_count to zero.
315611ccc33fSMarcel Ziswiler		timer_interrupt() calls timer_interrupt_cpu() for CPU
3157a8c7c708Swdenk		specific handling. If board has watchdog / status_led
3158a8c7c708Swdenk		/ other_activity_monitor it works automatically from
3159a8c7c708Swdenk		general timer_interrupt().
3160a8c7c708Swdenk
3161c609719bSwdenk
31629660e442SHelmut RaigerBoard initialization settings:
31639660e442SHelmut Raiger------------------------------
31649660e442SHelmut Raiger
31659660e442SHelmut RaigerDuring Initialization u-boot calls a number of board specific functions
31669660e442SHelmut Raigerto allow the preparation of board specific prerequisites, e.g. pin setup
31679660e442SHelmut Raigerbefore drivers are initialized. To enable these callbacks the
31689660e442SHelmut Raigerfollowing configuration macros have to be defined. Currently this is
31699660e442SHelmut Raigerarchitecture specific, so please check arch/your_architecture/lib/board.c
31709660e442SHelmut Raigertypically in board_init_f() and board_init_r().
31719660e442SHelmut Raiger
31729660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_F: Call board_early_init_f()
31739660e442SHelmut Raiger- CONFIG_BOARD_EARLY_INIT_R: Call board_early_init_r()
31749660e442SHelmut Raiger- CONFIG_BOARD_LATE_INIT: Call board_late_init()
31759660e442SHelmut Raiger- CONFIG_BOARD_POSTCLK_INIT: Call board_postclk_init()
3176c609719bSwdenk
3177c609719bSwdenkConfiguration Settings:
3178c609719bSwdenk-----------------------
3179c609719bSwdenk
31804d1fd7f1SYork Sun- CONFIG_SYS_SUPPORT_64BIT_DATA: Defined automatically if compiled as 64-bit.
31814d1fd7f1SYork Sun		Optionally it can be defined to support 64-bit memory commands.
31824d1fd7f1SYork Sun
31836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LONGHELP: Defined when you want long help messages included;
3184c609719bSwdenk		undefine this when you're short of memory.
3185c609719bSwdenk
31862fb2604dSPeter Tyser- CONFIG_SYS_HELP_CMD_WIDTH: Defined when you want to override the default
31872fb2604dSPeter Tyser		width of the commands listed in the 'help' command output.
31882fb2604dSPeter Tyser
31896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PROMPT:	This is what U-Boot prints on the console to
3190c609719bSwdenk		prompt for user input.
3191c609719bSwdenk
31926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CBSIZE:	Buffer size for input from the Console
3193c609719bSwdenk
31946d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PBSIZE:	Buffer size for Console output
3195c609719bSwdenk
31966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAXARGS:	max. Number of arguments accepted for monitor commands
3197c609719bSwdenk
31986d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BARGSIZE: Buffer size for Boot Arguments which are passed to
3199c609719bSwdenk		the application (usually a Linux kernel) when it is
3200c609719bSwdenk		booted
3201c609719bSwdenk
32026d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BAUDRATE_TABLE:
3203c609719bSwdenk		List of legal baudrate settings for this board.
3204c609719bSwdenk
32056d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_START, CONFIG_SYS_MEMTEST_END:
3206c609719bSwdenk		Begin and End addresses of the area used by the
3207c609719bSwdenk		simple memory test.
3208c609719bSwdenk
32096d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_ALT_MEMTEST:
3210c609719bSwdenk		Enable an alternate, more extensive memory test.
3211c609719bSwdenk
32126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MEMTEST_SCRATCH:
32135f535fe1Swdenk		Scratch address used by the alternate memory test
32145f535fe1Swdenk		You only need to set this if address zero isn't writeable
32155f535fe1Swdenk
3216e8149522SYork Sun- CONFIG_SYS_MEM_RESERVE_SECURE
3217e61a7534SYork Sun		Only implemented for ARMv8 for now.
3218e8149522SYork Sun		If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
3219e8149522SYork Sun		is substracted from total RAM and won't be reported to OS.
3220e8149522SYork Sun		This memory can be used as secure memory. A variable
3221e61a7534SYork Sun		gd->arch.secure_ram is used to track the location. In systems
3222e8149522SYork Sun		the RAM base is not zero, or RAM is divided into banks,
3223e8149522SYork Sun		this variable needs to be recalcuated to get the address.
3224e8149522SYork Sun
3225aabd7ddbSYork Sun- CONFIG_SYS_MEM_TOP_HIDE:
32266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_MEM_TOP_HIDE is defined in the board config header,
322714f73ca6SStefan Roese		this specified memory area will get subtracted from the top
322811ccc33fSMarcel Ziswiler		(end) of RAM and won't get "touched" at all by U-Boot. By
322914f73ca6SStefan Roese		fixing up gd->ram_size the Linux kernel should gets passed
323014f73ca6SStefan Roese		the now "corrected" memory size and won't touch it either.
323114f73ca6SStefan Roese		This should work for arch/ppc and arch/powerpc. Only Linux
32325e12e75dSStefan Roese		board ports in arch/powerpc with bootwrapper support that
323314f73ca6SStefan Roese		recalculate the memory size from the SDRAM controller setup
32345e12e75dSStefan Roese		will have to get fixed in Linux additionally.
323514f73ca6SStefan Roese
323614f73ca6SStefan Roese		This option can be used as a workaround for the 440EPx/GRx
323714f73ca6SStefan Roese		CHIP 11 errata where the last 256 bytes in SDRAM shouldn't
323814f73ca6SStefan Roese		be touched.
323914f73ca6SStefan Roese
324014f73ca6SStefan Roese		WARNING: Please make sure that this value is a multiple of
324114f73ca6SStefan Roese		the Linux page size (normally 4k). If this is not the case,
324214f73ca6SStefan Roese		then the end address of the Linux memory will be located at a
324314f73ca6SStefan Roese		non page size aligned address and this could cause major
324414f73ca6SStefan Roese		problems.
324514f73ca6SStefan Roese
32466d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_LOADS_BAUD_CHANGE:
3247c609719bSwdenk		Enable temporary baudrate change while serial download
3248c609719bSwdenk
32496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SDRAM_BASE:
3250c609719bSwdenk		Physical start address of SDRAM. _Must_ be 0 here.
3251c609719bSwdenk
32526d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_BASE:
3253c609719bSwdenk		Physical start address of Flash memory.
3254c609719bSwdenk
32556d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_BASE:
3256c609719bSwdenk		Physical start address of boot monitor code (set by
3257c609719bSwdenk		make config files to be same as the text base address
325814d0a02aSWolfgang Denk		(CONFIG_SYS_TEXT_BASE) used when linking) - same as
32596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FLASH_BASE when booting from flash.
3260c609719bSwdenk
32616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MONITOR_LEN:
32623b57fe0aSwdenk		Size of memory reserved for monitor code, used to
32633b57fe0aSwdenk		determine _at_compile_time_ (!) if the environment is
32643b57fe0aSwdenk		embedded within the U-Boot image, or in a separate
32653b57fe0aSwdenk		flash sector.
3266c609719bSwdenk
32676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MALLOC_LEN:
3268c609719bSwdenk		Size of DRAM reserved for malloc() use.
3269c609719bSwdenk
3270d59476b6SSimon Glass- CONFIG_SYS_MALLOC_F_LEN
3271d59476b6SSimon Glass		Size of the malloc() pool for use before relocation. If
3272d59476b6SSimon Glass		this is defined, then a very simple malloc() implementation
3273d59476b6SSimon Glass		will become available before relocation. The address is just
3274d59476b6SSimon Glass		below the global data, and the stack is moved down to make
3275d59476b6SSimon Glass		space.
3276d59476b6SSimon Glass
3277d59476b6SSimon Glass		This feature allocates regions with increasing addresses
3278d59476b6SSimon Glass		within the region. calloc() is supported, but realloc()
3279d59476b6SSimon Glass		is not available. free() is supported but does nothing.
3280b445bbb4SJeremiah Mahler		The memory will be freed (or in fact just forgotten) when
3281d59476b6SSimon Glass		U-Boot relocates itself.
3282d59476b6SSimon Glass
328338687ae6SSimon Glass- CONFIG_SYS_MALLOC_SIMPLE
328438687ae6SSimon Glass		Provides a simple and small malloc() and calloc() for those
328538687ae6SSimon Glass		boards which do not use the full malloc in SPL (which is
328638687ae6SSimon Glass		enabled with CONFIG_SYS_SPL_MALLOC_START).
328738687ae6SSimon Glass
32881dfdd9baSThierry Reding- CONFIG_SYS_NONCACHED_MEMORY:
32891dfdd9baSThierry Reding		Size of non-cached memory area. This area of memory will be
32901dfdd9baSThierry Reding		typically located right below the malloc() area and mapped
32911dfdd9baSThierry Reding		uncached in the MMU. This is useful for drivers that would
32921dfdd9baSThierry Reding		otherwise require a lot of explicit cache maintenance. For
32931dfdd9baSThierry Reding		some drivers it's also impossible to properly maintain the
32941dfdd9baSThierry Reding		cache. For example if the regions that need to be flushed
32951dfdd9baSThierry Reding		are not a multiple of the cache-line size, *and* padding
32961dfdd9baSThierry Reding		cannot be allocated between the regions to align them (i.e.
32971dfdd9baSThierry Reding		if the HW requires a contiguous array of regions, and the
32981dfdd9baSThierry Reding		size of each region is not cache-aligned), then a flush of
32991dfdd9baSThierry Reding		one region may result in overwriting data that hardware has
33001dfdd9baSThierry Reding		written to another region in the same cache-line. This can
33011dfdd9baSThierry Reding		happen for example in network drivers where descriptors for
33021dfdd9baSThierry Reding		buffers are typically smaller than the CPU cache-line (e.g.
33031dfdd9baSThierry Reding		16 bytes vs. 32 or 64 bytes).
33041dfdd9baSThierry Reding
33051dfdd9baSThierry Reding		Non-cached memory is only supported on 32-bit ARM at present.
33061dfdd9baSThierry Reding
33076d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTM_LEN:
330815940c9aSStefan Roese		Normally compressed uImages are limited to an
330915940c9aSStefan Roese		uncompressed size of 8 MBytes. If this is not enough,
33106d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		you can define CONFIG_SYS_BOOTM_LEN in your board config file
331115940c9aSStefan Roese		to adjust this setting to your needs.
3312c609719bSwdenk
33136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_BOOTMAPSZ:
3314c609719bSwdenk		Maximum size of memory mapped by the startup code of
3315c609719bSwdenk		the Linux kernel; all data that must be processed by
33167d721e34SBartlomiej Sieka		the Linux kernel (bd_info, boot arguments, FDT blob if
33177d721e34SBartlomiej Sieka		used) must be put below this limit, unless "bootm_low"
33181bce2aebSRobert P. J. Day		environment variable is defined and non-zero. In such case
33197d721e34SBartlomiej Sieka		all data for the Linux kernel must be between "bootm_low"
3320c3624e6eSGrant Likely		and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.	 The environment
3321c3624e6eSGrant Likely		variable "bootm_mapsize" will override the value of
3322c3624e6eSGrant Likely		CONFIG_SYS_BOOTMAPSZ.  If CONFIG_SYS_BOOTMAPSZ is undefined,
3323c3624e6eSGrant Likely		then the value in "bootm_size" will be used instead.
3324c609719bSwdenk
3325fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_RAMDISK_HIGH:
3326fca43cc8SJohn Rigby		Enable initrd_high functionality.  If defined then the
3327fca43cc8SJohn Rigby		initrd_high feature is enabled and the bootm ramdisk subcommand
3328fca43cc8SJohn Rigby		is enabled.
3329fca43cc8SJohn Rigby
3330fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_CMDLINE:
3331fca43cc8SJohn Rigby		Enables allocating and saving kernel cmdline in space between
3332fca43cc8SJohn Rigby		"bootm_low" and "bootm_low" + BOOTMAPSZ.
3333fca43cc8SJohn Rigby
3334fca43cc8SJohn Rigby- CONFIG_SYS_BOOT_GET_KBD:
3335fca43cc8SJohn Rigby		Enables allocating and saving a kernel copy of the bd_info in
3336fca43cc8SJohn Rigby		space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
3337fca43cc8SJohn Rigby
33386d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_BANKS:
3339c609719bSwdenk		Max number of Flash memory banks
3340c609719bSwdenk
33416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAX_FLASH_SECT:
3342c609719bSwdenk		Max number of sectors on a Flash chip
3343c609719bSwdenk
33446d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_ERASE_TOUT:
3345c609719bSwdenk		Timeout for Flash erase operations (in ms)
3346c609719bSwdenk
33476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_WRITE_TOUT:
3348c609719bSwdenk		Timeout for Flash write operations (in ms)
3349c609719bSwdenk
33506d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_LOCK_TOUT
33518564acf9Swdenk		Timeout for Flash set sector lock bit operation (in ms)
33528564acf9Swdenk
33536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_UNLOCK_TOUT
33548564acf9Swdenk		Timeout for Flash clear lock bits operation (in ms)
33558564acf9Swdenk
33566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_PROTECTION
33578564acf9Swdenk		If defined, hardware flash sectors protection is used
33588564acf9Swdenk		instead of U-Boot software protection.
33598564acf9Swdenk
33606d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DIRECT_FLASH_TFTP:
3361c609719bSwdenk
3362c609719bSwdenk		Enable TFTP transfers directly to flash memory;
3363c609719bSwdenk		without this option such a download has to be
3364c609719bSwdenk		performed in two steps: (1) download to RAM, and (2)
3365c609719bSwdenk		copy from RAM to flash.
3366c609719bSwdenk
3367c609719bSwdenk		The two-step approach is usually more reliable, since
3368c609719bSwdenk		you can check if the download worked before you erase
336911ccc33fSMarcel Ziswiler		the flash, but in some situations (when system RAM is
337011ccc33fSMarcel Ziswiler		too limited to allow for a temporary copy of the
3371c609719bSwdenk		downloaded image) this option may be very useful.
3372c609719bSwdenk
33736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_CFI:
3374c609719bSwdenk		Define if the flash driver uses extra elements in the
33755653fc33Swdenk		common flash structure for storing flash geometry.
33765653fc33Swdenk
337700b1883aSJean-Christophe PLAGNIOL-VILLARD- CONFIG_FLASH_CFI_DRIVER
33785653fc33Swdenk		This option also enables the building of the cfi_flash driver
33795653fc33Swdenk		in the drivers directory
338053cf9435Sstroese
338191809ed5SPiotr Ziecik- CONFIG_FLASH_CFI_MTD
338291809ed5SPiotr Ziecik		This option enables the building of the cfi_mtd driver
338391809ed5SPiotr Ziecik		in the drivers directory. The driver exports CFI flash
338491809ed5SPiotr Ziecik		to the MTD layer.
338591809ed5SPiotr Ziecik
33866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_USE_BUFFER_WRITE
338796ef831fSGuennadi Liakhovetski		Use buffered writes to flash.
338896ef831fSGuennadi Liakhovetski
338996ef831fSGuennadi Liakhovetski- CONFIG_FLASH_SPANSION_S29WS_N
339096ef831fSGuennadi Liakhovetski		s29ws-n MirrorBit flash has non-standard addresses for buffered
339196ef831fSGuennadi Liakhovetski		write commands.
339296ef831fSGuennadi Liakhovetski
33936d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FLASH_QUIET_TEST
33945568e613SStefan Roese		If this option is defined, the common CFI flash doesn't
33955568e613SStefan Roese		print it's warning upon not recognized FLASH banks. This
33965568e613SStefan Roese		is useful, if some of the configured banks are only
33975568e613SStefan Roese		optionally available.
33985568e613SStefan Roese
33999a042e9cSJerry Van Baren- CONFIG_FLASH_SHOW_PROGRESS
34009a042e9cSJerry Van Baren		If defined (must be an integer), print out countdown
34019a042e9cSJerry Van Baren		digits and dots.  Recommended value: 45 (9..1) for 80
34029a042e9cSJerry Van Baren		column displays, 15 (3..1) for 40 column displays.
34039a042e9cSJerry Van Baren
3404352ef3f1SStefan Roese- CONFIG_FLASH_VERIFY
3405352ef3f1SStefan Roese		If defined, the content of the flash (destination) is compared
3406352ef3f1SStefan Roese		against the source after the write operation. An error message
3407352ef3f1SStefan Roese		will be printed when the contents are not identical.
3408352ef3f1SStefan Roese		Please note that this option is useless in nearly all cases,
3409352ef3f1SStefan Roese		since such flash programming errors usually are detected earlier
3410352ef3f1SStefan Roese		while unprotecting/erasing/programming. Please only enable
3411352ef3f1SStefan Roese		this option if you really know what you are doing.
3412352ef3f1SStefan Roese
34136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_RX_ETH_BUFFER:
341411ccc33fSMarcel Ziswiler		Defines the number of Ethernet receive buffers. On some
341511ccc33fSMarcel Ziswiler		Ethernet controllers it is recommended to set this value
341653cf9435Sstroese		to 8 or even higher (EEPRO100 or 405 EMAC), since all
341753cf9435Sstroese		buffers can be full shortly after enabling the interface
341811ccc33fSMarcel Ziswiler		on high Ethernet traffic.
341953cf9435Sstroese		Defaults to 4 if not defined.
3420c609719bSwdenk
3421ea882bafSWolfgang Denk- CONFIG_ENV_MAX_ENTRIES
3422ea882bafSWolfgang Denk
3423ea882bafSWolfgang Denk	Maximum number of entries in the hash table that is used
3424ea882bafSWolfgang Denk	internally to store the environment settings. The default
3425ea882bafSWolfgang Denk	setting is supposed to be generous and should work in most
3426ea882bafSWolfgang Denk	cases. This setting can be used to tune behaviour; see
3427ea882bafSWolfgang Denk	lib/hashtable.c for details.
3428ea882bafSWolfgang Denk
34292598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_DEFAULT
34302598090bSJoe Hershberger- CONFIG_ENV_FLAGS_LIST_STATIC
34311bce2aebSRobert P. J. Day	Enable validation of the values given to environment variables when
34322598090bSJoe Hershberger	calling env set.  Variables can be restricted to only decimal,
34332598090bSJoe Hershberger	hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
34342598090bSJoe Hershberger	the variables can also be restricted to IP address or MAC address.
34352598090bSJoe Hershberger
34362598090bSJoe Hershberger	The format of the list is:
34372598090bSJoe Hershberger		type_attribute = [s|d|x|b|i|m]
3438b445bbb4SJeremiah Mahler		access_attribute = [a|r|o|c]
3439b445bbb4SJeremiah Mahler		attributes = type_attribute[access_attribute]
34402598090bSJoe Hershberger		entry = variable_name[:attributes]
34412598090bSJoe Hershberger		list = entry[,list]
34422598090bSJoe Hershberger
34432598090bSJoe Hershberger	The type attributes are:
34442598090bSJoe Hershberger		s - String (default)
34452598090bSJoe Hershberger		d - Decimal
34462598090bSJoe Hershberger		x - Hexadecimal
34472598090bSJoe Hershberger		b - Boolean ([1yYtT|0nNfF])
34482598090bSJoe Hershberger		i - IP address
34492598090bSJoe Hershberger		m - MAC address
34502598090bSJoe Hershberger
3451267541f7SJoe Hershberger	The access attributes are:
3452267541f7SJoe Hershberger		a - Any (default)
3453267541f7SJoe Hershberger		r - Read-only
3454267541f7SJoe Hershberger		o - Write-once
3455267541f7SJoe Hershberger		c - Change-default
3456267541f7SJoe Hershberger
34572598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_DEFAULT
34582598090bSJoe Hershberger		Define this to a list (string) to define the ".flags"
3459b445bbb4SJeremiah Mahler		environment variable in the default or embedded environment.
34602598090bSJoe Hershberger
34612598090bSJoe Hershberger	- CONFIG_ENV_FLAGS_LIST_STATIC
34622598090bSJoe Hershberger		Define this to a list (string) to define validation that
34632598090bSJoe Hershberger		should be done if an entry is not found in the ".flags"
34642598090bSJoe Hershberger		environment variable.  To override a setting in the static
34652598090bSJoe Hershberger		list, simply add an entry for the same variable name to the
34662598090bSJoe Hershberger		".flags" variable.
34672598090bSJoe Hershberger
3468bdf1fe4eSJoe Hershberger	If CONFIG_REGEX is defined, the variable_name above is evaluated as a
3469bdf1fe4eSJoe Hershberger	regular expression. This allows multiple variables to define the same
3470bdf1fe4eSJoe Hershberger	flags without explicitly listing them for each variable.
3471bdf1fe4eSJoe Hershberger
3472267541f7SJoe Hershberger- CONFIG_ENV_ACCESS_IGNORE_FORCE
3473267541f7SJoe Hershberger	If defined, don't allow the -f switch to env set override variable
3474267541f7SJoe Hershberger	access flags.
3475267541f7SJoe Hershberger
34760d296cc2SGabe Black- CONFIG_USE_STDINT
34770d296cc2SGabe Black	If stdint.h is available with your toolchain you can define this
34780d296cc2SGabe Black	option to enable it. You can provide option 'USE_STDINT=1' when
34790d296cc2SGabe Black	building U-Boot to enable this.
34800d296cc2SGabe Black
3481c609719bSwdenkThe following definitions that deal with the placement and management
3482c609719bSwdenkof environment data (variable area); in general, we support the
3483c609719bSwdenkfollowing configurations:
3484c609719bSwdenk
3485c3eb3fe4SMike Frysinger- CONFIG_BUILD_ENVCRC:
3486c3eb3fe4SMike Frysinger
3487c3eb3fe4SMike Frysinger	Builds up envcrc with the target environment so that external utils
3488c3eb3fe4SMike Frysinger	may easily extract it and embed it in final U-Boot images.
3489c3eb3fe4SMike Frysinger
34905a1aceb0SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_FLASH:
3491c609719bSwdenk
3492c609719bSwdenk	Define this if the environment is in flash memory.
3493c609719bSwdenk
3494c609719bSwdenk	a) The environment occupies one whole flash sector, which is
3495c609719bSwdenk	   "embedded" in the text segment with the U-Boot code. This
3496c609719bSwdenk	   happens usually with "bottom boot sector" or "top boot
3497c609719bSwdenk	   sector" type flash chips, which have several smaller
3498c609719bSwdenk	   sectors at the start or the end. For instance, such a
3499c609719bSwdenk	   layout can have sector sizes of 8, 2x4, 16, Nx32 kB. In
3500c609719bSwdenk	   such a case you would place the environment in one of the
3501c609719bSwdenk	   4 kB sectors - with U-Boot code before and after it. With
3502c609719bSwdenk	   "top boot sector" type flash chips, you would put the
3503c609719bSwdenk	   environment in one of the last sectors, leaving a gap
3504c609719bSwdenk	   between U-Boot and the environment.
3505c609719bSwdenk
35060e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
3507c609719bSwdenk
3508c609719bSwdenk	   Offset of environment data (variable area) to the
3509c609719bSwdenk	   beginning of flash memory; for instance, with bottom boot
3510c609719bSwdenk	   type flash chips the second sector can be used: the offset
3511c609719bSwdenk	   for this sector is given here.
3512c609719bSwdenk
35136d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET is used relative to CONFIG_SYS_FLASH_BASE.
3514c609719bSwdenk
35150e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
3516c609719bSwdenk
3517c609719bSwdenk	   This is just another way to specify the start address of
3518c609719bSwdenk	   the flash sector containing the environment (instead of
35190e8d1586SJean-Christophe PLAGNIOL-VILLARD	   CONFIG_ENV_OFFSET).
3520c609719bSwdenk
35210e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SECT_SIZE:
3522c609719bSwdenk
3523c609719bSwdenk	   Size of the sector containing the environment.
3524c609719bSwdenk
3525c609719bSwdenk
3526c609719bSwdenk	b) Sometimes flash chips have few, equal sized, BIG sectors.
3527c609719bSwdenk	   In such a case you don't want to spend a whole sector for
3528c609719bSwdenk	   the environment.
3529c609719bSwdenk
35300e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3531c609719bSwdenk
35325a1aceb0SJean-Christophe PLAGNIOL-VILLARD	   If you use this in combination with CONFIG_ENV_IS_IN_FLASH
35330e8d1586SJean-Christophe PLAGNIOL-VILLARD	   and CONFIG_ENV_SECT_SIZE, you can specify to use only a part
3534c609719bSwdenk	   of this flash sector for the environment. This saves
3535c609719bSwdenk	   memory for the RAM copy of the environment.
3536c609719bSwdenk
3537c609719bSwdenk	   It may also save flash memory if you decide to use this
3538c609719bSwdenk	   when your environment is "embedded" within U-Boot code,
3539c609719bSwdenk	   since then the remainder of the flash sector could be used
3540c609719bSwdenk	   for U-Boot code. It should be pointed out that this is
3541c609719bSwdenk	   STRONGLY DISCOURAGED from a robustness point of view:
3542c609719bSwdenk	   updating the environment in flash makes it always
3543c609719bSwdenk	   necessary to erase the WHOLE sector. If something goes
3544c609719bSwdenk	   wrong before the contents has been restored from a copy in
3545c609719bSwdenk	   RAM, your target system will be dead.
3546c609719bSwdenk
35470e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR_REDUND
35480e8d1586SJean-Christophe PLAGNIOL-VILLARD	  CONFIG_ENV_SIZE_REDUND
3549c609719bSwdenk
3550c609719bSwdenk	   These settings describe a second storage area used to hold
355111ccc33fSMarcel Ziswiler	   a redundant copy of the environment data, so that there is
35523e38691eSwdenk	   a valid backup copy in case there is a power failure during
3553c609719bSwdenk	   a "saveenv" operation.
3554c609719bSwdenk
3555c609719bSwdenkBE CAREFUL! Any changes to the flash layout, and some changes to the
3556c609719bSwdenksource code will make it necessary to adapt <board>/u-boot.lds*
3557c609719bSwdenkaccordingly!
3558c609719bSwdenk
3559c609719bSwdenk
35609314cee6SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NVRAM:
3561c609719bSwdenk
3562c609719bSwdenk	Define this if you have some non-volatile memory device
3563c609719bSwdenk	(NVRAM, battery buffered SRAM) which you want to use for the
3564c609719bSwdenk	environment.
3565c609719bSwdenk
35660e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
35670e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3568c609719bSwdenk
356911ccc33fSMarcel Ziswiler	  These two #defines are used to determine the memory area you
3570c609719bSwdenk	  want to use for environment. It is assumed that this memory
3571c609719bSwdenk	  can just be read and written to, without any special
3572c609719bSwdenk	  provision.
3573c609719bSwdenk
3574c609719bSwdenkBE CAREFUL! The first access to the environment happens quite early
3575b445bbb4SJeremiah Mahlerin U-Boot initialization (when we try to get the setting of for the
357611ccc33fSMarcel Ziswilerconsole baudrate). You *MUST* have mapped your NVRAM area then, or
3577c609719bSwdenkU-Boot will hang.
3578c609719bSwdenk
3579c609719bSwdenkPlease note that even with NVRAM we still use a copy of the
3580c609719bSwdenkenvironment in RAM: we could work on NVRAM directly, but we want to
3581c609719bSwdenkkeep settings there always unmodified except somebody uses "saveenv"
3582c609719bSwdenkto save the current settings.
3583c609719bSwdenk
3584c609719bSwdenk
3585bb1f8b4fSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_EEPROM:
3586c609719bSwdenk
3587c609719bSwdenk	Use this if you have an EEPROM or similar serial access
3588c609719bSwdenk	device and a driver for it.
3589c609719bSwdenk
35900e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
35910e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
3592c609719bSwdenk
3593c609719bSwdenk	  These two #defines specify the offset and size of the
3594c609719bSwdenk	  environment area within the total memory of your EEPROM.
3595c609719bSwdenk
35966d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR:
3597c609719bSwdenk	  If defined, specified the chip address of the EEPROM device.
3598c609719bSwdenk	  The default address is zero.
3599c609719bSwdenk
3600189d257bSChristian Gmeiner	- CONFIG_SYS_I2C_EEPROM_BUS:
3601189d257bSChristian Gmeiner	  If defined, specified the i2c bus of the EEPROM device.
3602189d257bSChristian Gmeiner
36036d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_BITS:
3604c609719bSwdenk	  If defined, the number of bits used to address bytes in a
3605c609719bSwdenk	  single page in the EEPROM device.  A 64 byte page, for example
3606c609719bSwdenk	  would require six bits.
3607c609719bSwdenk
36086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_PAGE_WRITE_DELAY_MS:
3609c609719bSwdenk	  If defined, the number of milliseconds to delay between
3610c609719bSwdenk	  page writes.	The default is zero milliseconds.
3611c609719bSwdenk
36126d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_LEN:
3613c609719bSwdenk	  The length in bytes of the EEPROM memory array address.  Note
3614c609719bSwdenk	  that this is NOT the chip address length!
3615c609719bSwdenk
36166d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_I2C_EEPROM_ADDR_OVERFLOW:
36175cf91d6bSwdenk	  EEPROM chips that implement "address overflow" are ones
36185cf91d6bSwdenk	  like Catalyst 24WC04/08/16 which has 9/10/11 bits of
36195cf91d6bSwdenk	  address and the extra bits end up in the "chip address" bit
36205cf91d6bSwdenk	  slots. This makes a 24WC08 (1Kbyte) chip look like four 256
36215cf91d6bSwdenk	  byte chips.
36225cf91d6bSwdenk
36235cf91d6bSwdenk	  Note that we consider the length of the address field to
36245cf91d6bSwdenk	  still be one byte because the extra address bits are hidden
36255cf91d6bSwdenk	  in the chip address.
36265cf91d6bSwdenk
36276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	- CONFIG_SYS_EEPROM_SIZE:
3628c609719bSwdenk	  The size in bytes of the EEPROM device.
3629c609719bSwdenk
3630548738b4SHeiko Schocher	- CONFIG_ENV_EEPROM_IS_ON_I2C
3631548738b4SHeiko Schocher	  define this, if you have I2C and SPI activated, and your
3632548738b4SHeiko Schocher	  EEPROM, which holds the environment, is on the I2C bus.
3633548738b4SHeiko Schocher
3634548738b4SHeiko Schocher	- CONFIG_I2C_ENV_EEPROM_BUS
3635548738b4SHeiko Schocher	  if you have an Environment on an EEPROM reached over
3636548738b4SHeiko Schocher	  I2C muxes, you can define here, how to reach this
3637548738b4SHeiko Schocher	  EEPROM. For example:
3638548738b4SHeiko Schocher
3639ea818dbbSHeiko Schocher	  #define CONFIG_I2C_ENV_EEPROM_BUS	  1
3640548738b4SHeiko Schocher
3641548738b4SHeiko Schocher	  EEPROM which holds the environment, is reached over
3642548738b4SHeiko Schocher	  a pca9547 i2c mux with address 0x70, channel 3.
3643c609719bSwdenk
3644057c849cSJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_DATAFLASH:
36455779d8d9Swdenk
36465779d8d9Swdenk	Define this if you have a DataFlash memory device which you
36475779d8d9Swdenk	want to use for the environment.
36485779d8d9Swdenk
36490e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
36500e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_ADDR:
36510e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
36525779d8d9Swdenk
36535779d8d9Swdenk	  These three #defines specify the offset and size of the
36545779d8d9Swdenk	  environment area within the total memory of your DataFlash placed
36555779d8d9Swdenk	  at the specified address.
36565779d8d9Swdenk
3657bd83b592SWu, Josh- CONFIG_ENV_IS_IN_SPI_FLASH:
3658bd83b592SWu, Josh
3659bd83b592SWu, Josh	Define this if you have a SPI Flash memory device which you
3660bd83b592SWu, Josh	want to use for the environment.
3661bd83b592SWu, Josh
3662bd83b592SWu, Josh	- CONFIG_ENV_OFFSET:
3663bd83b592SWu, Josh	- CONFIG_ENV_SIZE:
3664bd83b592SWu, Josh
3665bd83b592SWu, Josh	  These two #defines specify the offset and size of the
3666bd83b592SWu, Josh	  environment area within the SPI Flash. CONFIG_ENV_OFFSET must be
3667bd83b592SWu, Josh	  aligned to an erase sector boundary.
3668bd83b592SWu, Josh
3669bd83b592SWu, Josh	- CONFIG_ENV_SECT_SIZE:
3670bd83b592SWu, Josh
3671bd83b592SWu, Josh	  Define the SPI flash's sector size.
3672bd83b592SWu, Josh
3673bd83b592SWu, Josh	- CONFIG_ENV_OFFSET_REDUND (optional):
3674bd83b592SWu, Josh
3675bd83b592SWu, Josh	  This setting describes a second storage area of CONFIG_ENV_SIZE
3676bd83b592SWu, Josh	  size used to hold a redundant copy of the environment data, so
3677bd83b592SWu, Josh	  that there is a valid backup copy in case there is a power failure
36789dd05fb8SSimon Glass	  during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
3679bd83b592SWu, Josh	  aligned to an erase sector boundary.
3680bd83b592SWu, Josh
3681bd83b592SWu, Josh	- CONFIG_ENV_SPI_BUS (optional):
3682bd83b592SWu, Josh	- CONFIG_ENV_SPI_CS (optional):
3683bd83b592SWu, Josh
3684bd83b592SWu, Josh	  Define the SPI bus and chip select. If not defined they will be 0.
3685bd83b592SWu, Josh
3686bd83b592SWu, Josh	- CONFIG_ENV_SPI_MAX_HZ (optional):
3687bd83b592SWu, Josh
3688bd83b592SWu, Josh	  Define the SPI max work clock. If not defined then use 1MHz.
3689bd83b592SWu, Josh
3690bd83b592SWu, Josh	- CONFIG_ENV_SPI_MODE (optional):
3691bd83b592SWu, Josh
3692bd83b592SWu, Josh	  Define the SPI work mode. If not defined then use SPI_MODE_3.
3693bd83b592SWu, Josh
36940a85a9e7SLiu Gang- CONFIG_ENV_IS_IN_REMOTE:
36950a85a9e7SLiu Gang
36960a85a9e7SLiu Gang	Define this if you have a remote memory space which you
36970a85a9e7SLiu Gang	want to use for the local device's environment.
36980a85a9e7SLiu Gang
36990a85a9e7SLiu Gang	- CONFIG_ENV_ADDR:
37000a85a9e7SLiu Gang	- CONFIG_ENV_SIZE:
37010a85a9e7SLiu Gang
37020a85a9e7SLiu Gang	  These two #defines specify the address and size of the
37030a85a9e7SLiu Gang	  environment area within the remote memory space. The
37040a85a9e7SLiu Gang	  local device can get the environment from remote memory
3705fc54c7faSLiu Gang	  space by SRIO or PCIE links.
37060a85a9e7SLiu Gang
37070a85a9e7SLiu GangBE CAREFUL! For some special cases, the local device can not use
37080a85a9e7SLiu Gang"saveenv" command. For example, the local device will get the
3709fc54c7faSLiu Gangenvironment stored in a remote NOR flash by SRIO or PCIE link,
3710fc54c7faSLiu Gangbut it can not erase, write this NOR flash by SRIO or PCIE interface.
37110a85a9e7SLiu Gang
371251bfee19SJean-Christophe PLAGNIOL-VILLARD- CONFIG_ENV_IS_IN_NAND:
371313a5695bSwdenk
371413a5695bSwdenk	Define this if you have a NAND device which you want to use
371513a5695bSwdenk	for the environment.
371613a5695bSwdenk
37170e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_OFFSET:
37180e8d1586SJean-Christophe PLAGNIOL-VILLARD	- CONFIG_ENV_SIZE:
371913a5695bSwdenk
372013a5695bSwdenk	  These two #defines specify the offset and size of the environment
3721fdd813deSScott Wood	  area within the first NAND device.  CONFIG_ENV_OFFSET must be
3722fdd813deSScott Wood	  aligned to an erase block boundary.
37235779d8d9Swdenk
3724fdd813deSScott Wood	- CONFIG_ENV_OFFSET_REDUND (optional):
3725e443c944SMarkus Klotzbuecher
37260e8d1586SJean-Christophe PLAGNIOL-VILLARD	  This setting describes a second storage area of CONFIG_ENV_SIZE
3727fdd813deSScott Wood	  size used to hold a redundant copy of the environment data, so
3728fdd813deSScott Wood	  that there is a valid backup copy in case there is a power failure
37299dd05fb8SSimon Glass	  during a "saveenv" operation.	 CONFIG_ENV_OFFSET_REDUND must be
3730fdd813deSScott Wood	  aligned to an erase block boundary.
3731e443c944SMarkus Klotzbuecher
3732fdd813deSScott Wood	- CONFIG_ENV_RANGE (optional):
3733fdd813deSScott Wood
3734fdd813deSScott Wood	  Specifies the length of the region in which the environment
3735fdd813deSScott Wood	  can be written.  This should be a multiple of the NAND device's
3736fdd813deSScott Wood	  block size.  Specifying a range with more erase blocks than
3737fdd813deSScott Wood	  are needed to hold CONFIG_ENV_SIZE allows bad blocks within
3738fdd813deSScott Wood	  the range to be avoided.
3739fdd813deSScott Wood
3740fdd813deSScott Wood	- CONFIG_ENV_OFFSET_OOB (optional):
3741fdd813deSScott Wood
3742fdd813deSScott Wood	  Enables support for dynamically retrieving the offset of the
3743fdd813deSScott Wood	  environment from block zero's out-of-band data.  The
3744fdd813deSScott Wood	  "nand env.oob" command can be used to record this offset.
3745fdd813deSScott Wood	  Currently, CONFIG_ENV_OFFSET_REDUND is not supported when
3746fdd813deSScott Wood	  using CONFIG_ENV_OFFSET_OOB.
3747e443c944SMarkus Klotzbuecher
3748b74ab737SGuennadi Liakhovetski- CONFIG_NAND_ENV_DST
3749b74ab737SGuennadi Liakhovetski
3750b74ab737SGuennadi Liakhovetski	Defines address in RAM to which the nand_spl code should copy the
3751b74ab737SGuennadi Liakhovetski	environment. If redundant environment is used, it will be copied to
3752b74ab737SGuennadi Liakhovetski	CONFIG_NAND_ENV_DST + CONFIG_ENV_SIZE.
3753b74ab737SGuennadi Liakhovetski
37542b74433fSJoe Hershberger- CONFIG_ENV_IS_IN_UBI:
37552b74433fSJoe Hershberger
37562b74433fSJoe Hershberger	Define this if you have an UBI volume that you want to use for the
37572b74433fSJoe Hershberger	environment.  This has the benefit of wear-leveling the environment
37582b74433fSJoe Hershberger	accesses, which is important on NAND.
37592b74433fSJoe Hershberger
37602b74433fSJoe Hershberger	- CONFIG_ENV_UBI_PART:
37612b74433fSJoe Hershberger
37622b74433fSJoe Hershberger	  Define this to a string that is the mtd partition containing the UBI.
37632b74433fSJoe Hershberger
37642b74433fSJoe Hershberger	- CONFIG_ENV_UBI_VOLUME:
37652b74433fSJoe Hershberger
37662b74433fSJoe Hershberger	  Define this to the name of the volume that you want to store the
37672b74433fSJoe Hershberger	  environment in.
37682b74433fSJoe Hershberger
3769785881f7SJoe Hershberger	- CONFIG_ENV_UBI_VOLUME_REDUND:
3770785881f7SJoe Hershberger
3771785881f7SJoe Hershberger	  Define this to the name of another volume to store a second copy of
3772785881f7SJoe Hershberger	  the environment in.  This will enable redundant environments in UBI.
3773785881f7SJoe Hershberger	  It is assumed that both volumes are in the same MTD partition.
3774785881f7SJoe Hershberger
37752b74433fSJoe Hershberger	- CONFIG_UBI_SILENCE_MSG
37762b74433fSJoe Hershberger	- CONFIG_UBIFS_SILENCE_MSG
37772b74433fSJoe Hershberger
37782b74433fSJoe Hershberger	  You will probably want to define these to avoid a really noisy system
37792b74433fSJoe Hershberger	  when storing the env in UBI.
37802b74433fSJoe Hershberger
3781d1db76f1SWu, Josh- CONFIG_ENV_IS_IN_FAT:
3782d1db76f1SWu, Josh       Define this if you want to use the FAT file system for the environment.
3783d1db76f1SWu, Josh
3784d1db76f1SWu, Josh       - FAT_ENV_INTERFACE:
3785d1db76f1SWu, Josh
3786d1db76f1SWu, Josh         Define this to a string that is the name of the block device.
3787d1db76f1SWu, Josh
378841987784SNicolae Rosia       - FAT_ENV_DEVICE_AND_PART:
3789d1db76f1SWu, Josh
3790d1db76f1SWu, Josh         Define this to a string to specify the partition of the device. It can
3791d1db76f1SWu, Josh         be as following:
3792d1db76f1SWu, Josh
3793d1db76f1SWu, Josh           "D:P", "D:0", "D", "D:" or "D:auto" (D, P are integers. And P >= 1)
3794d1db76f1SWu, Josh               - "D:P": device D partition P. Error occurs if device D has no
3795d1db76f1SWu, Josh                        partition table.
3796d1db76f1SWu, Josh               - "D:0": device D.
3797d1db76f1SWu, Josh               - "D" or "D:": device D partition 1 if device D has partition
3798d1db76f1SWu, Josh                              table, or the whole device D if has no partition
3799d1db76f1SWu, Josh                              table.
3800d1db76f1SWu, Josh               - "D:auto": first partition in device D with bootable flag set.
3801b445bbb4SJeremiah Mahler                           If none, first valid partition in device D. If no
3802d1db76f1SWu, Josh                           partition table then means device D.
3803d1db76f1SWu, Josh
3804d1db76f1SWu, Josh       - FAT_ENV_FILE:
3805d1db76f1SWu, Josh
3806d1db76f1SWu, Josh         It's a string of the FAT file name. This file use to store the
3807b445bbb4SJeremiah Mahler         environment.
3808d1db76f1SWu, Josh
3809d1db76f1SWu, Josh       - CONFIG_FAT_WRITE:
381091d27a17STom Rini         This must be enabled. Otherwise it cannot save the environment file.
3811d1db76f1SWu, Josh
381206e4ae5fSStephen Warren- CONFIG_ENV_IS_IN_MMC:
381306e4ae5fSStephen Warren
381406e4ae5fSStephen Warren	Define this if you have an MMC device which you want to use for the
381506e4ae5fSStephen Warren	environment.
381606e4ae5fSStephen Warren
381706e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_DEV:
381806e4ae5fSStephen Warren
381906e4ae5fSStephen Warren	  Specifies which MMC device the environment is stored in.
382006e4ae5fSStephen Warren
382106e4ae5fSStephen Warren	- CONFIG_SYS_MMC_ENV_PART (optional):
382206e4ae5fSStephen Warren
382306e4ae5fSStephen Warren	  Specifies which MMC partition the environment is stored in. If not
382406e4ae5fSStephen Warren	  set, defaults to partition 0, the user area. Common values might be
382506e4ae5fSStephen Warren	  1 (first MMC boot partition), 2 (second MMC boot partition).
382606e4ae5fSStephen Warren
382706e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET:
382806e4ae5fSStephen Warren	- CONFIG_ENV_SIZE:
382906e4ae5fSStephen Warren
383006e4ae5fSStephen Warren	  These two #defines specify the offset and size of the environment
383106e4ae5fSStephen Warren	  area within the specified MMC device.
383206e4ae5fSStephen Warren
38335c088ee8SStephen Warren	  If offset is positive (the usual case), it is treated as relative to
38345c088ee8SStephen Warren	  the start of the MMC partition. If offset is negative, it is treated
38355c088ee8SStephen Warren	  as relative to the end of the MMC partition. This can be useful if
38365c088ee8SStephen Warren	  your board may be fitted with different MMC devices, which have
38375c088ee8SStephen Warren	  different sizes for the MMC partitions, and you always want the
38385c088ee8SStephen Warren	  environment placed at the very end of the partition, to leave the
38395c088ee8SStephen Warren	  maximum possible space before it, to store other data.
38405c088ee8SStephen Warren
384106e4ae5fSStephen Warren	  These two values are in units of bytes, but must be aligned to an
384206e4ae5fSStephen Warren	  MMC sector boundary.
384306e4ae5fSStephen Warren
384406e4ae5fSStephen Warren	- CONFIG_ENV_OFFSET_REDUND (optional):
384506e4ae5fSStephen Warren
384606e4ae5fSStephen Warren	  Specifies a second storage area, of CONFIG_ENV_SIZE size, used to
384706e4ae5fSStephen Warren	  hold a redundant copy of the environment data. This provides a
384806e4ae5fSStephen Warren	  valid backup copy in case the other copy is corrupted, e.g. due
384906e4ae5fSStephen Warren	  to a power failure during a "saveenv" operation.
385006e4ae5fSStephen Warren
38515c088ee8SStephen Warren	  This value may also be positive or negative; this is handled in the
38525c088ee8SStephen Warren	  same way as CONFIG_ENV_OFFSET.
38535c088ee8SStephen Warren
385406e4ae5fSStephen Warren	  This value is also in units of bytes, but must also be aligned to
385506e4ae5fSStephen Warren	  an MMC sector boundary.
385606e4ae5fSStephen Warren
385706e4ae5fSStephen Warren	- CONFIG_ENV_SIZE_REDUND (optional):
385806e4ae5fSStephen Warren
385906e4ae5fSStephen Warren	  This value need not be set, even when CONFIG_ENV_OFFSET_REDUND is
386006e4ae5fSStephen Warren	  set. If this value is set, it must be set to the same value as
386106e4ae5fSStephen Warren	  CONFIG_ENV_SIZE.
386206e4ae5fSStephen Warren
38636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPI_INIT_OFFSET
3864c609719bSwdenk
3865c609719bSwdenk	Defines offset to the initial SPI buffer area in DPRAM. The
3866c609719bSwdenk	area is used at an early stage (ROM part) if the environment
3867c609719bSwdenk	is configured to reside in the SPI EEPROM: We need a 520 byte
3868c609719bSwdenk	scratch DPRAM area. It is used between the two initialization
3869c609719bSwdenk	calls (spi_init_f() and spi_init_r()). A value of 0xB00 seems
3870c609719bSwdenk	to be a good choice since it makes it far enough from the
3871c609719bSwdenk	start of the data area as well as from the stack pointer.
3872c609719bSwdenk
3873e881cb56SBruce AdlerPlease note that the environment is read-only until the monitor
3874c609719bSwdenkhas been relocated to RAM and a RAM copy of the environment has been
3875cdb74977SWolfgang Denkcreated; also, when using EEPROM you will have to use getenv_f()
3876c609719bSwdenkuntil then to read environment variables.
3877c609719bSwdenk
387885ec0bccSwdenkThe environment is protected by a CRC32 checksum. Before the monitor
387985ec0bccSwdenkis relocated into RAM, as a result of a bad CRC you will be working
388085ec0bccSwdenkwith the compiled-in default environment - *silently*!!! [This is
388185ec0bccSwdenknecessary, because the first environment variable we need is the
388285ec0bccSwdenk"baudrate" setting for the console - if we have a bad CRC, we don't
388385ec0bccSwdenkhave any device yet where we could complain.]
3884c609719bSwdenk
3885c609719bSwdenkNote: once the monitor has been relocated, then it will complain if
3886c609719bSwdenkthe default environment is used; a new CRC is computed as soon as you
388785ec0bccSwdenkuse the "saveenv" command to store a valid environment.
3888c609719bSwdenk
38896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_ECHO_LINK_DOWN:
3890fc3e2165Swdenk		Echo the inverted Ethernet link state to the fault LED.
3891fc3e2165Swdenk
38926d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		Note: If this option is active, then CONFIG_SYS_FAULT_MII_ADDR
3893fc3e2165Swdenk		      also needs to be defined.
3894fc3e2165Swdenk
38956d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_FAULT_MII_ADDR:
3896fc3e2165Swdenk		MII address of the PHY to check for the Ethernet link state.
3897c609719bSwdenk
3898f5675aa5SRon Madrid- CONFIG_NS16550_MIN_FUNCTIONS:
3899f5675aa5SRon Madrid		Define this if you desire to only have use of the NS16550_init
3900f5675aa5SRon Madrid		and NS16550_putc functions for the serial driver located at
3901f5675aa5SRon Madrid		drivers/serial/ns16550.c.  This option is useful for saving
3902f5675aa5SRon Madrid		space for already greatly restricted images, including but not
3903f5675aa5SRon Madrid		limited to NAND_SPL configurations.
3904f5675aa5SRon Madrid
3905b2b92f53SSimon Glass- CONFIG_DISPLAY_BOARDINFO
3906b2b92f53SSimon Glass		Display information about the board that U-Boot is running on
3907b2b92f53SSimon Glass		when U-Boot starts up. The board function checkboard() is called
3908b2b92f53SSimon Glass		to do this.
3909b2b92f53SSimon Glass
3910e2e3e2b1SSimon Glass- CONFIG_DISPLAY_BOARDINFO_LATE
3911e2e3e2b1SSimon Glass		Similar to the previous option, but display this information
3912e2e3e2b1SSimon Glass		later, once stdio is running and output goes to the LCD, if
3913e2e3e2b1SSimon Glass		present.
3914e2e3e2b1SSimon Glass
3915feb85801SSascha Silbe- CONFIG_BOARD_SIZE_LIMIT:
3916feb85801SSascha Silbe		Maximum size of the U-Boot image. When defined, the
3917feb85801SSascha Silbe		build system checks that the actual size does not
3918feb85801SSascha Silbe		exceed it.
3919feb85801SSascha Silbe
3920c609719bSwdenkLow Level (hardware related) configuration options:
3921dc7c9a1aSwdenk---------------------------------------------------
3922c609719bSwdenk
39236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_CACHELINE_SIZE:
3924c609719bSwdenk		Cache Line Size of the CPU.
3925c609719bSwdenk
39266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DEFAULT_IMMR:
3927c609719bSwdenk		Default address of the IMMR after system reset.
39282535d602Swdenk
39292535d602Swdenk		Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
39302535d602Swdenk		and RPXsuper) to be able to adjust the position of
39312535d602Swdenk		the IMMR register after a reset.
3932c609719bSwdenk
3933e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_DEFAULT:
3934e46fedfeSTimur Tabi		Default (power-on reset) physical address of CCSR on Freescale
3935e46fedfeSTimur Tabi		PowerPC SOCs.
3936e46fedfeSTimur Tabi
3937e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR:
3938e46fedfeSTimur Tabi		Virtual address of CCSR.  On a 32-bit build, this is typically
3939e46fedfeSTimur Tabi		the same value as CONFIG_SYS_CCSRBAR_DEFAULT.
3940e46fedfeSTimur Tabi
3941e46fedfeSTimur Tabi		CONFIG_SYS_DEFAULT_IMMR must also be set to this value,
3942e46fedfeSTimur Tabi		for cross-platform code that uses that macro instead.
3943e46fedfeSTimur Tabi
3944e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS:
3945e46fedfeSTimur Tabi		Physical address of CCSR.  CCSR can be relocated to a new
3946e46fedfeSTimur Tabi		physical address, if desired.  In this case, this macro should
3947e46fedfeSTimur Tabi		be set to that address.	 Otherwise, it should be set to the
3948e46fedfeSTimur Tabi		same value as CONFIG_SYS_CCSRBAR_DEFAULT.  For example, CCSR
3949e46fedfeSTimur Tabi		is typically relocated on 36-bit builds.  It is recommended
3950e46fedfeSTimur Tabi		that this macro be defined via the _HIGH and _LOW macros:
3951e46fedfeSTimur Tabi
3952e46fedfeSTimur Tabi		#define CONFIG_SYS_CCSRBAR_PHYS ((CONFIG_SYS_CCSRBAR_PHYS_HIGH
3953e46fedfeSTimur Tabi			* 1ull) << 32 | CONFIG_SYS_CCSRBAR_PHYS_LOW)
3954e46fedfeSTimur Tabi
3955e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_HIGH:
3956e46fedfeSTimur Tabi		Bits 33-36 of CONFIG_SYS_CCSRBAR_PHYS.	This value is typically
3957e46fedfeSTimur Tabi		either 0 (32-bit build) or 0xF (36-bit build).	This macro is
3958e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3959e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3960e46fedfeSTimur Tabi
3961e46fedfeSTimur Tabi- CONFIG_SYS_CCSRBAR_PHYS_LOW:
3962e46fedfeSTimur Tabi		Lower 32-bits of CONFIG_SYS_CCSRBAR_PHYS.  This macro is
3963e46fedfeSTimur Tabi		used in assembly code, so it must not contain typecasts or
3964e46fedfeSTimur Tabi		integer size suffixes (e.g. "ULL").
3965e46fedfeSTimur Tabi
3966e46fedfeSTimur Tabi- CONFIG_SYS_CCSR_DO_NOT_RELOCATE:
3967e46fedfeSTimur Tabi		If this macro is defined, then CONFIG_SYS_CCSRBAR_PHYS will be
3968e46fedfeSTimur Tabi		forced to a value that ensures that CCSR is not relocated.
3969e46fedfeSTimur Tabi
39707f6c2cbcSwdenk- Floppy Disk Support:
39716d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER
39727f6c2cbcSwdenk
39737f6c2cbcSwdenk		the default drive number (default value 0)
39747f6c2cbcSwdenk
39756d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_STRIDE
39767f6c2cbcSwdenk
397711ccc33fSMarcel Ziswiler		defines the spacing between FDC chipset registers
39787f6c2cbcSwdenk		(default value 1)
39797f6c2cbcSwdenk
39806d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_ISA_IO_OFFSET
39817f6c2cbcSwdenk
39827f6c2cbcSwdenk		defines the offset of register from address. It
39837f6c2cbcSwdenk		depends on which part of the data bus is connected to
398411ccc33fSMarcel Ziswiler		the FDC chipset. (default value 0)
39857f6c2cbcSwdenk
39866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		If CONFIG_SYS_ISA_IO_STRIDE CONFIG_SYS_ISA_IO_OFFSET and
39876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_FDC_DRIVE_NUMBER are undefined, they take their
39887f6c2cbcSwdenk		default value.
39897f6c2cbcSwdenk
39906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		if CONFIG_SYS_FDC_HW_INIT is defined, then the function
39917f6c2cbcSwdenk		fdc_hw_init() is called at the beginning of the FDC
39927f6c2cbcSwdenk		setup. fdc_hw_init() must be provided by the board
3993b445bbb4SJeremiah Mahler		source code. It is used to make hardware-dependent
39947f6c2cbcSwdenk		initializations.
39957f6c2cbcSwdenk
39960abddf82SMacpaul Lin- CONFIG_IDE_AHB:
39970abddf82SMacpaul Lin		Most IDE controllers were designed to be connected with PCI
39980abddf82SMacpaul Lin		interface. Only few of them were designed for AHB interface.
39990abddf82SMacpaul Lin		When software is doing ATA command and data transfer to
40000abddf82SMacpaul Lin		IDE devices through IDE-AHB controller, some additional
40010abddf82SMacpaul Lin		registers accessing to these kind of IDE-AHB controller
4002b445bbb4SJeremiah Mahler		is required.
40030abddf82SMacpaul Lin
40046d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_IMMR:	Physical address of the Internal Memory.
400525d6712aSwdenk		DO NOT CHANGE unless you know exactly what you're
4006*5b8e76c3SHeiko Schocher		doing! (11-4) [82xx systems only]
4007c609719bSwdenk
40086d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_INIT_RAM_ADDR:
4009c609719bSwdenk
40107152b1d0Swdenk		Start address of memory area that can be used for
4011c609719bSwdenk		initial data and stack; please note that this must be
4012c609719bSwdenk		writable memory that is working WITHOUT special
4013c609719bSwdenk		initialization, i. e. you CANNOT use normal RAM which
4014c609719bSwdenk		will become available only after programming the
4015c609719bSwdenk		memory controller and running certain initialization
4016c609719bSwdenk		sequences.
4017c609719bSwdenk
4018c609719bSwdenk		U-Boot uses the following memory types:
4019*5b8e76c3SHeiko Schocher		- MPC8260: IMMR (internal memory of the CPU)
4020c609719bSwdenk		- MPC824X: data cache
4021c609719bSwdenk		- PPC4xx:  data cache
4022c609719bSwdenk
40236d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_GBL_DATA_OFFSET:
4024c609719bSwdenk
4025c609719bSwdenk		Offset of the initial data structure in the memory
40266d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		area defined by CONFIG_SYS_INIT_RAM_ADDR. Usually
40276d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
4028c609719bSwdenk		data is located at the end of the available space
4029553f0982SWolfgang Denk		(sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
4030acd51f9dSSimon Glass		GENERATED_GBL_DATA_SIZE), and the initial stack is just
40316d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
40326d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_GBL_DATA_OFFSET) downward.
4033c609719bSwdenk
4034c609719bSwdenk	Note:
4035c609719bSwdenk		On the MPC824X (or other systems that use the data
4036c609719bSwdenk		cache for initial memory) the address chosen for
40376d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		CONFIG_SYS_INIT_RAM_ADDR is basically arbitrary - it must
4038c609719bSwdenk		point to an otherwise UNUSED address space between
4039c609719bSwdenk		the top of RAM and the start of the PCI space.
4040c609719bSwdenk
40416d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SIUMCR:	SIU Module Configuration (11-6)
4042c609719bSwdenk
40436d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SYPCR:	System Protection Control (11-9)
4044c609719bSwdenk
40456d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_TBSCR:	Time Base Status and Control (11-26)
4046c609719bSwdenk
40476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PISCR:	Periodic Interrupt Status and Control (11-31)
4048c609719bSwdenk
40496d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PLPRCR:	PLL, Low-Power, and Reset Control Register (15-30)
4050c609719bSwdenk
40516d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SCCR:	System Clock and reset Control Register (15-27)
4052c609719bSwdenk
40536d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_OR_TIMING_SDRAM:
4054c609719bSwdenk		SDRAM timing
4055c609719bSwdenk
40566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA:
4057c609719bSwdenk		periodic timer for refresh
4058c609719bSwdenk
40596d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_DER:	Debug Event Register (37-47)
4060c609719bSwdenk
40616d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- FLASH_BASE0_PRELIM, FLASH_BASE1_PRELIM, CONFIG_SYS_REMAP_OR_AM,
40626d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PRELIM_OR_AM, CONFIG_SYS_OR_TIMING_FLASH, CONFIG_SYS_OR0_REMAP,
40636d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR0_PRELIM, CONFIG_SYS_BR0_PRELIM, CONFIG_SYS_OR1_REMAP, CONFIG_SYS_OR1_PRELIM,
40646d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_BR1_PRELIM:
4065c609719bSwdenk		Memory Controller Definitions: BR0/1 and OR0/1 (FLASH)
4066c609719bSwdenk
4067c609719bSwdenk- SDRAM_BASE2_PRELIM, SDRAM_BASE3_PRELIM, SDRAM_MAX_SIZE,
40686d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR_TIMING_SDRAM, CONFIG_SYS_OR2_PRELIM, CONFIG_SYS_BR2_PRELIM,
40696d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_OR3_PRELIM, CONFIG_SYS_BR3_PRELIM:
4070c609719bSwdenk		Memory Controller Definitions: BR2/3 and OR2/3 (SDRAM)
4071c609719bSwdenk
40726d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_MAMR_PTA, CONFIG_SYS_MPTPR_2BK_4K, CONFIG_SYS_MPTPR_1BK_4K, CONFIG_SYS_MPTPR_2BK_8K,
40736d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_MPTPR_1BK_8K, CONFIG_SYS_MAMR_8COL, CONFIG_SYS_MAMR_9COL:
4074c609719bSwdenk		Machine Mode Register and Memory Periodic Timer
4075c609719bSwdenk		Prescaler definitions (SDRAM timing)
4076c609719bSwdenk
4077*5b8e76c3SHeiko Schocher- CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8260 only)
4078ea909b76Swdenk		Offset of the bootmode word in DPRAM used by post
4079ea909b76Swdenk		(Power On Self Tests). This definition overrides
4080ea909b76Swdenk		#define'd default value in commproc.h resp.
4081ea909b76Swdenk		cpm_8260.h.
4082ea909b76Swdenk
40836d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_PCI_SLV_MEM_LOCAL, CONFIG_SYS_PCI_SLV_MEM_BUS, CONFIG_SYS_PICMR0_MASK_ATTRIB,
40846d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR0_LOCAL, CONFIG_SYS_PCIMSK0_MASK, CONFIG_SYS_PCI_MSTR1_LOCAL,
40856d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCIMSK1_MASK, CONFIG_SYS_PCI_MSTR_MEM_LOCAL, CONFIG_SYS_PCI_MSTR_MEM_BUS,
40866d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_CPU_PCI_MEM_START, CONFIG_SYS_PCI_MSTR_MEM_SIZE, CONFIG_SYS_POCMR0_MASK_ATTRIB,
40876d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_LOCAL, CONFIG_SYS_PCI_MSTR_MEMIO_BUS, CPU_PCI_MEMIO_START,
40886d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_MEMIO_SIZE, CONFIG_SYS_POCMR1_MASK_ATTRIB, CONFIG_SYS_PCI_MSTR_IO_LOCAL,
40896d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_PCI_MSTR_IO_BUS, CONFIG_SYS_CPU_PCI_IO_START, CONFIG_SYS_PCI_MSTR_IO_SIZE,
40906d0f6bcfSJean-Christophe PLAGNIOL-VILLARD  CONFIG_SYS_POCMR2_MASK_ATTRIB: (MPC826x only)
4091a47a12beSStefan Roese		Overrides the default PCI memory map in arch/powerpc/cpu/mpc8260/pci.c if set.
40925d232d0eSwdenk
40939cacf4fcSDirk Eibach- CONFIG_PCI_DISABLE_PCIE:
40949cacf4fcSDirk Eibach		Disable PCI-Express on systems where it is supported but not
40959cacf4fcSDirk Eibach		required.
40969cacf4fcSDirk Eibach
409769fd2d3bSAndrew Sharp- CONFIG_PCI_ENUM_ONLY
4098b445bbb4SJeremiah Mahler		Only scan through and get the devices on the buses.
409969fd2d3bSAndrew Sharp		Don't do any setup work, presumably because someone or
410069fd2d3bSAndrew Sharp		something has already done it, and we don't need to do it
410169fd2d3bSAndrew Sharp		a second time.	Useful for platforms that are pre-booted
410269fd2d3bSAndrew Sharp		by coreboot or similar.
410369fd2d3bSAndrew Sharp
4104842033e6SGabor Juhos- CONFIG_PCI_INDIRECT_BRIDGE:
4105842033e6SGabor Juhos		Enable support for indirect PCI bridges.
4106842033e6SGabor Juhos
4107a09b9b68SKumar Gala- CONFIG_SYS_SRIO:
4108a09b9b68SKumar Gala		Chip has SRIO or not
4109a09b9b68SKumar Gala
4110a09b9b68SKumar Gala- CONFIG_SRIO1:
4111a09b9b68SKumar Gala		Board has SRIO 1 port available
4112a09b9b68SKumar Gala
4113a09b9b68SKumar Gala- CONFIG_SRIO2:
4114a09b9b68SKumar Gala		Board has SRIO 2 port available
4115a09b9b68SKumar Gala
4116c8b28152SLiu Gang- CONFIG_SRIO_PCIE_BOOT_MASTER
4117c8b28152SLiu Gang		Board can support master function for Boot from SRIO and PCIE
4118c8b28152SLiu Gang
4119a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_VIRT:
4120a09b9b68SKumar Gala		Virtual Address of SRIO port 'n' memory region
4121a09b9b68SKumar Gala
4122a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_PHYS:
4123a09b9b68SKumar Gala		Physical Address of SRIO port 'n' memory region
4124a09b9b68SKumar Gala
4125a09b9b68SKumar Gala- CONFIG_SYS_SRIOn_MEM_SIZE:
4126a09b9b68SKumar Gala		Size of SRIO port 'n' memory region
4127a09b9b68SKumar Gala
412866bd1846SFabio Estevam- CONFIG_SYS_NAND_BUSWIDTH_16BIT
412966bd1846SFabio Estevam		Defined to tell the NAND controller that the NAND chip is using
413066bd1846SFabio Estevam		a 16 bit bus.
413166bd1846SFabio Estevam		Not all NAND drivers use this symbol.
4132a430e916SFabio Estevam		Example of drivers that use it:
413366bd1846SFabio Estevam		- drivers/mtd/nand/ndfc.c
4134a430e916SFabio Estevam		- drivers/mtd/nand/mxc_nand.c
4135eced4626SAlex Waterman
4136eced4626SAlex Waterman- CONFIG_SYS_NDFC_EBC0_CFG
4137eced4626SAlex Waterman		Sets the EBC0_CFG register for the NDFC. If not defined
4138eced4626SAlex Waterman		a default value will be used.
4139eced4626SAlex Waterman
4140bb99ad6dSBen Warren- CONFIG_SPD_EEPROM
4141218ca724SWolfgang Denk		Get DDR timing information from an I2C EEPROM. Common
4142218ca724SWolfgang Denk		with pluggable memory modules such as SODIMMs
4143218ca724SWolfgang Denk
4144bb99ad6dSBen Warren  SPD_EEPROM_ADDRESS
4145bb99ad6dSBen Warren		I2C address of the SPD EEPROM
4146bb99ad6dSBen Warren
41476d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_SPD_BUS_NUM
4148218ca724SWolfgang Denk		If SPD EEPROM is on an I2C bus other than the first
4149218ca724SWolfgang Denk		one, specify here. Note that the value must resolve
4150218ca724SWolfgang Denk		to something your driver can deal with.
4151bb99ad6dSBen Warren
41521b3e3c4fSYork Sun- CONFIG_SYS_DDR_RAW_TIMING
41531b3e3c4fSYork Sun		Get DDR timing information from other than SPD. Common with
41541b3e3c4fSYork Sun		soldered DDR chips onboard without SPD. DDR raw timing
41551b3e3c4fSYork Sun		parameters are extracted from datasheet and hard-coded into
41561b3e3c4fSYork Sun		header files or board specific files.
41571b3e3c4fSYork Sun
41586f5e1dc5SYork Sun- CONFIG_FSL_DDR_INTERACTIVE
41596f5e1dc5SYork Sun		Enable interactive DDR debugging. See doc/README.fsl-ddr.
41606f5e1dc5SYork Sun
4161e32d59a2SYork Sun- CONFIG_FSL_DDR_SYNC_REFRESH
4162e32d59a2SYork Sun		Enable sync of refresh for multiple controllers.
4163e32d59a2SYork Sun
41644516ff81SYork Sun- CONFIG_FSL_DDR_BIST
41654516ff81SYork Sun		Enable built-in memory test for Freescale DDR controllers.
41664516ff81SYork Sun
41676d0f6bcfSJean-Christophe PLAGNIOL-VILLARD- CONFIG_SYS_83XX_DDR_USES_CS0
4168218ca724SWolfgang Denk		Only for 83xx systems. If specified, then DDR should
4169218ca724SWolfgang Denk		be configured using CS0 and CS1 instead of CS2 and CS3.
41702ad6b513STimur Tabi
4171c26e454dSwdenk- CONFIG_RMII
4172c26e454dSwdenk		Enable RMII mode for all FECs.
4173c26e454dSwdenk		Note that this is a global option, we can't
4174c26e454dSwdenk		have one FEC in standard MII mode and another in RMII mode.
4175c26e454dSwdenk
41765cf91d6bSwdenk- CONFIG_CRC32_VERIFY
41775cf91d6bSwdenk		Add a verify option to the crc32 command.
41785cf91d6bSwdenk		The syntax is:
41795cf91d6bSwdenk
41805cf91d6bSwdenk		=> crc32 -v <address> <count> <crc32>
41815cf91d6bSwdenk
41825cf91d6bSwdenk		Where address/count indicate a memory area
41835cf91d6bSwdenk		and crc32 is the correct crc32 which the
41845cf91d6bSwdenk		area should have.
41855cf91d6bSwdenk
418656523f12Swdenk- CONFIG_LOOPW
418756523f12Swdenk		Add the "loopw" memory command. This only takes effect if
4188602ad3b3SJon Loeliger		the memory commands are activated globally (CONFIG_CMD_MEM).
418956523f12Swdenk
41907b466641Sstroese- CONFIG_MX_CYCLIC
41917b466641Sstroese		Add the "mdc" and "mwc" memory commands. These are cyclic
41927b466641Sstroese		"md/mw" commands.
41937b466641Sstroese		Examples:
41947b466641Sstroese
41957b466641Sstroese		=> mdc.b 10 4 500
41967b466641Sstroese		This command will print 4 bytes (10,11,12,13) each 500 ms.
41977b466641Sstroese
41987b466641Sstroese		=> mwc.l 100 12345678 10
41997b466641Sstroese		This command will write 12345678 to address 100 all 10 ms.
42007b466641Sstroese
42017b466641Sstroese		This only takes effect if the memory commands are activated
4202602ad3b3SJon Loeliger		globally (CONFIG_CMD_MEM).
42037b466641Sstroese
42048aa1a2d1Swdenk- CONFIG_SKIP_LOWLEVEL_INIT
4205afc1ce82SMacpaul Lin		[ARM, NDS32, MIPS only] If this variable is defined, then certain
4206e03f3169SWolfgang Denk		low level initializations (like setting up the memory
4207e03f3169SWolfgang Denk		controller) are omitted and/or U-Boot does not
4208e03f3169SWolfgang Denk		relocate itself into RAM.
42098aa1a2d1Swdenk
4210e03f3169SWolfgang Denk		Normally this variable MUST NOT be defined. The only
4211e03f3169SWolfgang Denk		exception is when U-Boot is loaded (to RAM) by some
4212e03f3169SWolfgang Denk		other boot loader or by a debugger which performs
4213e03f3169SWolfgang Denk		these initializations itself.
42148aa1a2d1Swdenk
4215b5bd0982SSimon Glass- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
4216b5bd0982SSimon Glass		[ARM926EJ-S only] This allows just the call to lowlevel_init()
421790211f77Syeongjun Kim		to be skipped. The normal CP15 init (such as enabling the
4218b5bd0982SSimon Glass		instruction cache) is still performed.
4219b5bd0982SSimon Glass
4220401bb30bSAneesh V- CONFIG_SPL_BUILD
4221df81238bSMagnus Lilja		Modifies the behaviour of start.S when compiling a loader
4222df81238bSMagnus Lilja		that is executed before the actual U-Boot. E.g. when
4223df81238bSMagnus Lilja		compiling a NAND SPL.
4224400558b5Swdenk
42253aa29de0SYing Zhang- CONFIG_TPL_BUILD
42263aa29de0SYing Zhang		Modifies the behaviour of start.S  when compiling a loader
42273aa29de0SYing Zhang		that is executed after the SPL and before the actual U-Boot.
42283aa29de0SYing Zhang		It is loaded by the SPL.
42293aa29de0SYing Zhang
42305df572f0SYing Zhang- CONFIG_SYS_MPC85XX_NO_RESETVEC
42315df572f0SYing Zhang		Only for 85xx systems. If this variable is specified, the section
42325df572f0SYing Zhang		.resetvec is not kept and the section .bootpg is placed in the
42335df572f0SYing Zhang		previous 4k of the .text section.
42345df572f0SYing Zhang
42354213fc29SSimon Glass- CONFIG_ARCH_MAP_SYSMEM
42364213fc29SSimon Glass		Generally U-Boot (and in particular the md command) uses
42374213fc29SSimon Glass		effective address. It is therefore not necessary to regard
42384213fc29SSimon Glass		U-Boot address as virtual addresses that need to be translated
42394213fc29SSimon Glass		to physical addresses. However, sandbox requires this, since
42404213fc29SSimon Glass		it maintains its own little RAM buffer which contains all
42414213fc29SSimon Glass		addressable memory. This option causes some memory accesses
42424213fc29SSimon Glass		to be mapped through map_sysmem() / unmap_sysmem().
42434213fc29SSimon Glass
4244588a13f7SSimon Glass- CONFIG_X86_RESET_VECTOR
4245588a13f7SSimon Glass		If defined, the x86 reset vector code is included. This is not
4246588a13f7SSimon Glass		needed when U-Boot is running from Coreboot.
4247b16f521aSGabe Black
424816678eb4SHeiko Schocher- CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
424916678eb4SHeiko Schocher		Enables the RTC32K OSC on AM33xx based plattforms
425016678eb4SHeiko Schocher
4251999d7d32SKaricheri, Muralidharan- CONFIG_SYS_NAND_NO_SUBPAGE_WRITE
4252999d7d32SKaricheri, Muralidharan		Option to disable subpage write in NAND driver
4253999d7d32SKaricheri, Muralidharan		driver that uses this:
4254999d7d32SKaricheri, Muralidharan		drivers/mtd/nand/davinci_nand.c
4255999d7d32SKaricheri, Muralidharan
4256f2717b47STimur TabiFreescale QE/FMAN Firmware Support:
4257f2717b47STimur Tabi-----------------------------------
4258f2717b47STimur Tabi
4259f2717b47STimur TabiThe Freescale QUICCEngine (QE) and Frame Manager (FMAN) both support the
4260f2717b47STimur Tabiloading of "firmware", which is encoded in the QE firmware binary format.
4261f2717b47STimur TabiThis firmware often needs to be loaded during U-Boot booting, so macros
4262f2717b47STimur Tabiare used to identify the storage device (NOR flash, SPI, etc) and the address
4263f2717b47STimur Tabiwithin that device.
4264f2717b47STimur Tabi
4265dcf1d774SZhao Qiang- CONFIG_SYS_FMAN_FW_ADDR
4266dcf1d774SZhao Qiang	The address in the storage device where the FMAN microcode is located.  The
4267dcf1d774SZhao Qiang	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4268dcf1d774SZhao Qiang	is also specified.
4269dcf1d774SZhao Qiang
4270dcf1d774SZhao Qiang- CONFIG_SYS_QE_FW_ADDR
4271dcf1d774SZhao Qiang	The address in the storage device where the QE microcode is located.  The
4272f2717b47STimur Tabi	meaning of this address depends on which CONFIG_SYS_QE_FW_IN_xxx macro
4273f2717b47STimur Tabi	is also specified.
4274f2717b47STimur Tabi
4275f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_LENGTH
4276f2717b47STimur Tabi	The maximum possible size of the firmware.  The firmware binary format
4277f2717b47STimur Tabi	has a field that specifies the actual size of the firmware, but it
4278f2717b47STimur Tabi	might not be possible to read any part of the firmware unless some
4279f2717b47STimur Tabi	local storage is allocated to hold the entire firmware first.
4280f2717b47STimur Tabi
4281f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NOR
4282f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NOR flash, mapped as
4283f2717b47STimur Tabi	normal addressable memory via the LBC.  CONFIG_SYS_FMAN_FW_ADDR is the
4284f2717b47STimur Tabi	virtual address in NOR flash.
4285f2717b47STimur Tabi
4286f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_NAND
4287f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located in NAND flash.
4288f2717b47STimur Tabi	CONFIG_SYS_FMAN_FW_ADDR is the offset within NAND flash.
4289f2717b47STimur Tabi
4290f2717b47STimur Tabi- CONFIG_SYS_QE_FMAN_FW_IN_MMC
4291f2717b47STimur Tabi	Specifies that QE/FMAN firmware is located on the primary SD/MMC
4292f2717b47STimur Tabi	device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
4293f2717b47STimur Tabi
4294292dc6c5SLiu Gang- CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
4295292dc6c5SLiu Gang	Specifies that QE/FMAN firmware is located in the remote (master)
4296292dc6c5SLiu Gang	memory space.	CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
4297fc54c7faSLiu Gang	can be mapped from slave TLB->slave LAW->slave SRIO or PCIE outbound
4298fc54c7faSLiu Gang	window->master inbound window->master LAW->the ucode address in
4299fc54c7faSLiu Gang	master's memory space.
4300f2717b47STimur Tabi
4301b940ca64SJ. German RiveraFreescale Layerscape Management Complex Firmware Support:
4302b940ca64SJ. German Rivera---------------------------------------------------------
4303b940ca64SJ. German RiveraThe Freescale Layerscape Management Complex (MC) supports the loading of
4304b940ca64SJ. German Rivera"firmware".
4305b940ca64SJ. German RiveraThis firmware often needs to be loaded during U-Boot booting, so macros
4306b940ca64SJ. German Riveraare used to identify the storage device (NOR flash, SPI, etc) and the address
4307b940ca64SJ. German Riverawithin that device.
4308b940ca64SJ. German Rivera
4309b940ca64SJ. German Rivera- CONFIG_FSL_MC_ENET
4310b940ca64SJ. German Rivera	Enable the MC driver for Layerscape SoCs.
4311b940ca64SJ. German Rivera
43125c055089SPrabhakar KushwahaFreescale Layerscape Debug Server Support:
43135c055089SPrabhakar Kushwaha-------------------------------------------
43145c055089SPrabhakar KushwahaThe Freescale Layerscape Debug Server Support supports the loading of
43155c055089SPrabhakar Kushwaha"Debug Server firmware" and triggering SP boot-rom.
43165c055089SPrabhakar KushwahaThis firmware often needs to be loaded during U-Boot booting.
43175c055089SPrabhakar Kushwaha
4318c0492141SYork Sun- CONFIG_SYS_MC_RSV_MEM_ALIGN
4319c0492141SYork Sun	Define alignment of reserved memory MC requires
43205c055089SPrabhakar Kushwaha
4321f3f431a7SPaul KocialkowskiReproducible builds
4322f3f431a7SPaul Kocialkowski-------------------
4323f3f431a7SPaul Kocialkowski
4324f3f431a7SPaul KocialkowskiIn order to achieve reproducible builds, timestamps used in the U-Boot build
4325f3f431a7SPaul Kocialkowskiprocess have to be set to a fixed value.
4326f3f431a7SPaul Kocialkowski
4327f3f431a7SPaul KocialkowskiThis is done using the SOURCE_DATE_EPOCH environment variable.
4328f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH is to be set on the build host's shell, not as a configuration
4329f3f431a7SPaul Kocialkowskioption for U-Boot or an environment variable in U-Boot.
4330f3f431a7SPaul Kocialkowski
4331f3f431a7SPaul KocialkowskiSOURCE_DATE_EPOCH should be set to a number of seconds since the epoch, in UTC.
4332f3f431a7SPaul Kocialkowski
4333c609719bSwdenkBuilding the Software:
4334c609719bSwdenk======================
4335c609719bSwdenk
4336218ca724SWolfgang DenkBuilding U-Boot has been tested in several native build environments
4337218ca724SWolfgang Denkand in many different cross environments. Of course we cannot support
4338218ca724SWolfgang Denkall possibly existing versions of cross development tools in all
4339218ca724SWolfgang Denk(potentially obsolete) versions. In case of tool chain problems we
4340218ca724SWolfgang Denkrecommend to use the ELDK (see http://www.denx.de/wiki/DULG/ELDK)
4341218ca724SWolfgang Denkwhich is extensively used to build and test U-Boot.
4342c609719bSwdenk
4343218ca724SWolfgang DenkIf you are not using a native environment, it is assumed that you
4344218ca724SWolfgang Denkhave GNU cross compiling tools available in your path. In this case,
4345218ca724SWolfgang Denkyou must set the environment variable CROSS_COMPILE in your shell.
4346218ca724SWolfgang DenkNote that no changes to the Makefile or any other source files are
4347218ca724SWolfgang Denknecessary. For example using the ELDK on a 4xx CPU, please enter:
4348c609719bSwdenk
4349218ca724SWolfgang Denk	$ CROSS_COMPILE=ppc_4xx-
4350218ca724SWolfgang Denk	$ export CROSS_COMPILE
4351c609719bSwdenk
43522f8d396bSPeter TyserNote: If you wish to generate Windows versions of the utilities in
43532f8d396bSPeter Tyser      the tools directory you can use the MinGW toolchain
43542f8d396bSPeter Tyser      (http://www.mingw.org).  Set your HOST tools to the MinGW
43552f8d396bSPeter Tyser      toolchain and execute 'make tools'.  For example:
43562f8d396bSPeter Tyser
43572f8d396bSPeter Tyser       $ make HOSTCC=i586-mingw32msvc-gcc HOSTSTRIP=i586-mingw32msvc-strip tools
43582f8d396bSPeter Tyser
43592f8d396bSPeter Tyser      Binaries such as tools/mkimage.exe will be created which can
43602f8d396bSPeter Tyser      be executed on computers running Windows.
43612f8d396bSPeter Tyser
4362c609719bSwdenkU-Boot is intended to be simple to build. After installing the
4363c609719bSwdenksources you must configure U-Boot for one specific board type. This
4364c609719bSwdenkis done by typing:
4365c609719bSwdenk
4366ab584d67SHolger Freyther	make NAME_defconfig
4367c609719bSwdenk
4368ab584d67SHolger Freytherwhere "NAME_defconfig" is the name of one of the existing configu-
43694d675ae6SMichael Jonesrations; see boards.cfg for supported names.
437054387ac9Swdenk
4371c609719bSwdenkNote: for some board special configuration names may exist; check if
4372c609719bSwdenk      additional information is available from the board vendor; for
43732729af9dSwdenk      instance, the TQM823L systems are available without (standard)
43742729af9dSwdenk      or with LCD support. You can select such additional "features"
437511ccc33fSMarcel Ziswiler      when choosing the configuration, i. e.
4376c609719bSwdenk
4377ab584d67SHolger Freyther      make TQM823L_defconfig
43782729af9dSwdenk	- will configure for a plain TQM823L, i. e. no LCD support
4379c609719bSwdenk
4380ab584d67SHolger Freyther      make TQM823L_LCD_defconfig
4381c609719bSwdenk	- will configure for a TQM823L with U-Boot console on LCD
4382c609719bSwdenk
4383c609719bSwdenk      etc.
4384c609719bSwdenk
4385c609719bSwdenk
4386c609719bSwdenkFinally, type "make all", and you should get some working U-Boot
43877152b1d0Swdenkimages ready for download to / installation on your system:
4388c609719bSwdenk
4389c609719bSwdenk- "u-boot.bin" is a raw binary image
4390c609719bSwdenk- "u-boot" is an image in ELF binary format
4391c609719bSwdenk- "u-boot.srec" is in Motorola S-Record format
4392c609719bSwdenk
4393baf31249SMarian BalakowiczBy default the build is performed locally and the objects are saved
4394baf31249SMarian Balakowiczin the source directory. One of the two methods can be used to change
4395baf31249SMarian Balakowiczthis behavior and build U-Boot to some external directory:
4396baf31249SMarian Balakowicz
4397baf31249SMarian Balakowicz1. Add O= to the make command line invocations:
4398baf31249SMarian Balakowicz
4399baf31249SMarian Balakowicz	make O=/tmp/build distclean
4400ab584d67SHolger Freyther	make O=/tmp/build NAME_defconfig
4401baf31249SMarian Balakowicz	make O=/tmp/build all
4402baf31249SMarian Balakowicz
4403adbba996STimo Ketola2. Set environment variable KBUILD_OUTPUT to point to the desired location:
4404baf31249SMarian Balakowicz
4405adbba996STimo Ketola	export KBUILD_OUTPUT=/tmp/build
4406baf31249SMarian Balakowicz	make distclean
4407ab584d67SHolger Freyther	make NAME_defconfig
4408baf31249SMarian Balakowicz	make all
4409baf31249SMarian Balakowicz
4410adbba996STimo KetolaNote that the command line "O=" setting overrides the KBUILD_OUTPUT environment
4411baf31249SMarian Balakowiczvariable.
4412baf31249SMarian Balakowicz
4413c609719bSwdenk
4414c609719bSwdenkPlease be aware that the Makefiles assume you are using GNU make, so
4415c609719bSwdenkfor instance on NetBSD you might need to use "gmake" instead of
4416c609719bSwdenknative "make".
4417c609719bSwdenk
4418c609719bSwdenk
4419c609719bSwdenkIf the system board that you have is not listed, then you will need
4420c609719bSwdenkto port U-Boot to your hardware platform. To do this, follow these
4421c609719bSwdenksteps:
4422c609719bSwdenk
44233c1496cdSPhil Sutter1.  Create a new directory to hold your board specific code. Add any
442485ec0bccSwdenk    files you need. In your board directory, you will need at least
44253c1496cdSPhil Sutter    the "Makefile" and a "<board>.c".
44263c1496cdSPhil Sutter2.  Create a new configuration file "include/configs/<board>.h" for
44273c1496cdSPhil Sutter    your board.
4428c609719bSwdenk3.  If you're porting U-Boot to a new CPU, then also create a new
4429c609719bSwdenk    directory to hold your CPU specific code. Add any files you need.
4430ab584d67SHolger Freyther4.  Run "make <board>_defconfig" with your new name.
4431c609719bSwdenk5.  Type "make", and you should get a working "u-boot.srec" file
4432c609719bSwdenk    to be installed on your target system.
443385ec0bccSwdenk6.  Debug and solve any problems that might arise.
4434c609719bSwdenk    [Of course, this last step is much harder than it sounds.]
4435c609719bSwdenk
4436c609719bSwdenk
4437c609719bSwdenkTesting of U-Boot Modifications, Ports to New Hardware, etc.:
4438c609719bSwdenk==============================================================
4439c609719bSwdenk
4440c609719bSwdenkIf you have modified U-Boot sources (for instance added a new board
4441c609719bSwdenkor support for new devices, a new CPU, etc.) you are expected to
4442c609719bSwdenkprovide feedback to the other developers. The feedback normally takes
4443c609719bSwdenkthe form of a "patch", i. e. a context diff against a certain (latest
4444218ca724SWolfgang Denkofficial or latest in the git repository) version of U-Boot sources.
4445c609719bSwdenk
4446c609719bSwdenkBut before you submit such a patch, please verify that your modifi-
4447c609719bSwdenkcation did not break existing code. At least make sure that *ALL* of
4448c609719bSwdenkthe supported boards compile WITHOUT ANY compiler warnings. To do so,
44496de80f21SSimon Glassjust run the buildman script (tools/buildman/buildman), which will
44506de80f21SSimon Glassconfigure and build U-Boot for ALL supported system. Be warned, this
44516de80f21SSimon Glasswill take a while. Please see the buildman README, or run 'buildman -H'
44526de80f21SSimon Glassfor documentation.
4453baf31249SMarian Balakowicz
4454baf31249SMarian Balakowicz
4455c609719bSwdenkSee also "U-Boot Porting Guide" below.
4456c609719bSwdenk
4457c609719bSwdenk
4458c609719bSwdenkMonitor Commands - Overview:
4459c609719bSwdenk============================
4460c609719bSwdenk
4461c609719bSwdenkgo	- start application at address 'addr'
4462c609719bSwdenkrun	- run commands in an environment variable
4463c609719bSwdenkbootm	- boot application image from memory
4464c609719bSwdenkbootp	- boot image via network using BootP/TFTP protocol
446544f074c7SMarek Vasutbootz   - boot zImage from memory
4466c609719bSwdenktftpboot- boot image via network using TFTP protocol
4467c609719bSwdenk	       and env variables "ipaddr" and "serverip"
4468c609719bSwdenk	       (and eventually "gatewayip")
44691fb7cd49SSimon Glasstftpput - upload a file via network using TFTP protocol
4470c609719bSwdenkrarpboot- boot image via network using RARP/TFTP protocol
4471c609719bSwdenkdiskboot- boot from IDE devicebootd   - boot default, i.e., run 'bootcmd'
4472c609719bSwdenkloads	- load S-Record file over serial line
4473c609719bSwdenkloadb	- load binary file over serial line (kermit mode)
4474c609719bSwdenkmd	- memory display
4475c609719bSwdenkmm	- memory modify (auto-incrementing)
4476c609719bSwdenknm	- memory modify (constant address)
4477c609719bSwdenkmw	- memory write (fill)
4478c609719bSwdenkcp	- memory copy
4479c609719bSwdenkcmp	- memory compare
4480c609719bSwdenkcrc32	- checksum calculation
44810f89c54bSPeter Tyseri2c	- I2C sub-system
4482c609719bSwdenksspi	- SPI utility commands
4483c609719bSwdenkbase	- print or set address offset
4484c609719bSwdenkprintenv- print environment variables
4485c609719bSwdenksetenv	- set environment variables
4486c609719bSwdenksaveenv - save environment variables to persistent storage
4487c609719bSwdenkprotect - enable or disable FLASH write protection
4488c609719bSwdenkerase	- erase FLASH memory
4489c609719bSwdenkflinfo	- print FLASH memory information
449010635afaSKarl O. Pincnand	- NAND memory operations (see doc/README.nand)
4491c609719bSwdenkbdinfo	- print Board Info structure
4492c609719bSwdenkiminfo	- print header information for application image
4493c609719bSwdenkconinfo - print console devices and informations
4494c609719bSwdenkide	- IDE sub-system
4495c609719bSwdenkloop	- infinite loop on address range
449656523f12Swdenkloopw	- infinite write loop on address range
4497c609719bSwdenkmtest	- simple RAM test
4498c609719bSwdenkicache	- enable or disable instruction cache
4499c609719bSwdenkdcache	- enable or disable data cache
4500c609719bSwdenkreset	- Perform RESET of the CPU
4501c609719bSwdenkecho	- echo args to console
4502c609719bSwdenkversion - print monitor version
4503c609719bSwdenkhelp	- print online help
4504c609719bSwdenk?	- alias for 'help'
4505c609719bSwdenk
4506c609719bSwdenk
4507c609719bSwdenkMonitor Commands - Detailed Description:
4508c609719bSwdenk========================================
4509c609719bSwdenk
4510c609719bSwdenkTODO.
4511c609719bSwdenk
4512c609719bSwdenkFor now: just type "help <command>".
4513c609719bSwdenk
4514c609719bSwdenk
4515c609719bSwdenkEnvironment Variables:
4516c609719bSwdenk======================
4517c609719bSwdenk
4518c609719bSwdenkU-Boot supports user configuration using Environment Variables which
4519c609719bSwdenkcan be made persistent by saving to Flash memory.
4520c609719bSwdenk
4521c609719bSwdenkEnvironment Variables are set using "setenv", printed using
4522c609719bSwdenk"printenv", and saved to Flash using "saveenv". Using "setenv"
4523c609719bSwdenkwithout a value can be used to delete a variable from the
4524c609719bSwdenkenvironment. As long as you don't save the environment you are
4525c609719bSwdenkworking with an in-memory copy. In case the Flash area containing the
4526c609719bSwdenkenvironment is erased by accident, a default environment is provided.
4527c609719bSwdenk
4528c96f86eeSWolfgang DenkSome configuration options can be set using Environment Variables.
4529c96f86eeSWolfgang Denk
4530c96f86eeSWolfgang DenkList of environment variables (most likely not complete):
4531c609719bSwdenk
4532c609719bSwdenk  baudrate	- see CONFIG_BAUDRATE
4533c609719bSwdenk
4534c609719bSwdenk  bootdelay	- see CONFIG_BOOTDELAY
4535c609719bSwdenk
4536c609719bSwdenk  bootcmd	- see CONFIG_BOOTCOMMAND
4537c609719bSwdenk
4538c609719bSwdenk  bootargs	- Boot arguments when booting an RTOS image
4539c609719bSwdenk
4540c609719bSwdenk  bootfile	- Name of the image to load with TFTP
4541c609719bSwdenk
45427d721e34SBartlomiej Sieka  bootm_low	- Memory range available for image processing in the bootm
45437d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45447d721e34SBartlomiej Sieka		  a hexadecimal number and defines lowest address allowed
45457d721e34SBartlomiej Sieka		  for use by the bootm command. See also "bootm_size"
45467d721e34SBartlomiej Sieka		  environment variable. Address defined by "bootm_low" is
45477d721e34SBartlomiej Sieka		  also the base of the initial memory mapping for the Linux
4548c3624e6eSGrant Likely		  kernel -- see the description of CONFIG_SYS_BOOTMAPSZ and
4549c3624e6eSGrant Likely		  bootm_mapsize.
4550c3624e6eSGrant Likely
4551c3624e6eSGrant Likely  bootm_mapsize - Size of the initial memory mapping for the Linux kernel.
4552c3624e6eSGrant Likely		  This variable is given as a hexadecimal number and it
4553c3624e6eSGrant Likely		  defines the size of the memory region starting at base
4554c3624e6eSGrant Likely		  address bootm_low that is accessible by the Linux kernel
4555c3624e6eSGrant Likely		  during early boot.  If unset, CONFIG_SYS_BOOTMAPSZ is used
4556c3624e6eSGrant Likely		  as the default value if it is defined, and bootm_size is
4557c3624e6eSGrant Likely		  used otherwise.
45587d721e34SBartlomiej Sieka
45597d721e34SBartlomiej Sieka  bootm_size	- Memory range available for image processing in the bootm
45607d721e34SBartlomiej Sieka		  command can be restricted. This variable is given as
45617d721e34SBartlomiej Sieka		  a hexadecimal number and defines the size of the region
45627d721e34SBartlomiej Sieka		  allowed for use by the bootm command. See also "bootm_low"
45637d721e34SBartlomiej Sieka		  environment variable.
45647d721e34SBartlomiej Sieka
45654bae9090SBartlomiej Sieka  updatefile	- Location of the software update file on a TFTP server, used
45664bae9090SBartlomiej Sieka		  by the automatic software update feature. Please refer to
45674bae9090SBartlomiej Sieka		  documentation in doc/README.update for more details.
45684bae9090SBartlomiej Sieka
4569c609719bSwdenk  autoload	- if set to "no" (any string beginning with 'n'),
4570c609719bSwdenk		  "bootp" will just load perform a lookup of the
4571c609719bSwdenk		  configuration from the BOOTP server, but not try to
4572c609719bSwdenk		  load any image using TFTP
4573c609719bSwdenk
4574c609719bSwdenk  autostart	- if set to "yes", an image loaded using the "bootp",
4575c609719bSwdenk		  "rarpboot", "tftpboot" or "diskboot" commands will
4576c609719bSwdenk		  be automatically started (by internally calling
4577c609719bSwdenk		  "bootm")
4578c609719bSwdenk
45794a6fd34bSwdenk		  If set to "no", a standalone image passed to the
45804a6fd34bSwdenk		  "bootm" command will be copied to the load address
45814a6fd34bSwdenk		  (and eventually uncompressed), but NOT be started.
45824a6fd34bSwdenk		  This can be used to load and uncompress arbitrary
45834a6fd34bSwdenk		  data.
45844a6fd34bSwdenk
4585a28afca5SDavid A. Long  fdt_high	- if set this restricts the maximum address that the
4586a28afca5SDavid A. Long		  flattened device tree will be copied into upon boot.
4587fa34f6b2SShawn Guo		  For example, if you have a system with 1 GB memory
4588fa34f6b2SShawn Guo		  at physical address 0x10000000, while Linux kernel
4589fa34f6b2SShawn Guo		  only recognizes the first 704 MB as low memory, you
4590fa34f6b2SShawn Guo		  may need to set fdt_high as 0x3C000000 to have the
4591fa34f6b2SShawn Guo		  device tree blob be copied to the maximum address
4592fa34f6b2SShawn Guo		  of the 704 MB low memory, so that Linux kernel can
4593fa34f6b2SShawn Guo		  access it during the boot procedure.
4594fa34f6b2SShawn Guo
4595a28afca5SDavid A. Long		  If this is set to the special value 0xFFFFFFFF then
4596a28afca5SDavid A. Long		  the fdt will not be copied at all on boot.  For this
4597a28afca5SDavid A. Long		  to work it must reside in writable memory, have
4598a28afca5SDavid A. Long		  sufficient padding on the end of it for u-boot to
4599a28afca5SDavid A. Long		  add the information it needs into it, and the memory
4600a28afca5SDavid A. Long		  must be accessible by the kernel.
4601a28afca5SDavid A. Long
4602eea63e05SSimon Glass  fdtcontroladdr- if set this is the address of the control flattened
4603eea63e05SSimon Glass		  device tree used by U-Boot when CONFIG_OF_CONTROL is
4604eea63e05SSimon Glass		  defined.
4605eea63e05SSimon Glass
460617ea1177Swdenk  i2cfast	- (PPC405GP|PPC405EP only)
460717ea1177Swdenk		  if set to 'y' configures Linux I2C driver for fast
460817ea1177Swdenk		  mode (400kHZ). This environment variable is used in
460917ea1177Swdenk		  initialization code. So, for changes to be effective
461017ea1177Swdenk		  it must be saved and board must be reset.
461117ea1177Swdenk
4612c609719bSwdenk  initrd_high	- restrict positioning of initrd images:
4613c609719bSwdenk		  If this variable is not set, initrd images will be
4614c609719bSwdenk		  copied to the highest possible address in RAM; this
4615c609719bSwdenk		  is usually what you want since it allows for
4616c609719bSwdenk		  maximum initrd size. If for some reason you want to
4617c609719bSwdenk		  make sure that the initrd image is loaded below the
46186d0f6bcfSJean-Christophe PLAGNIOL-VILLARD		  CONFIG_SYS_BOOTMAPSZ limit, you can set this environment
4619c609719bSwdenk		  variable to a value of "no" or "off" or "0".
4620c609719bSwdenk		  Alternatively, you can set it to a maximum upper
4621c609719bSwdenk		  address to use (U-Boot will still check that it
4622c609719bSwdenk		  does not overwrite the U-Boot stack and data).
4623c609719bSwdenk
4624c609719bSwdenk		  For instance, when you have a system with 16 MB
46257152b1d0Swdenk		  RAM, and want to reserve 4 MB from use by Linux,
4626c609719bSwdenk		  you can do this by adding "mem=12M" to the value of
4627c609719bSwdenk		  the "bootargs" variable. However, now you must make
46287152b1d0Swdenk		  sure that the initrd image is placed in the first
4629c609719bSwdenk		  12 MB as well - this can be done with
4630c609719bSwdenk
4631c609719bSwdenk		  setenv initrd_high 00c00000
4632c609719bSwdenk
463338b99261Swdenk		  If you set initrd_high to 0xFFFFFFFF, this is an
463438b99261Swdenk		  indication to U-Boot that all addresses are legal
463538b99261Swdenk		  for the Linux kernel, including addresses in flash
463638b99261Swdenk		  memory. In this case U-Boot will NOT COPY the
463738b99261Swdenk		  ramdisk at all. This may be useful to reduce the
463838b99261Swdenk		  boot time on your system, but requires that this
463938b99261Swdenk		  feature is supported by your Linux kernel.
464038b99261Swdenk
4641c609719bSwdenk  ipaddr	- IP address; needed for tftpboot command
4642c609719bSwdenk
4643c609719bSwdenk  loadaddr	- Default load address for commands like "bootp",
4644dc7c9a1aSwdenk		  "rarpboot", "tftpboot", "loadb" or "diskboot"
4645c609719bSwdenk
4646c609719bSwdenk  loads_echo	- see CONFIG_LOADS_ECHO
4647c609719bSwdenk
4648c609719bSwdenk  serverip	- TFTP server IP address; needed for tftpboot command
4649c609719bSwdenk
4650c609719bSwdenk  bootretry	- see CONFIG_BOOT_RETRY_TIME
4651c609719bSwdenk
4652c609719bSwdenk  bootdelaykey	- see CONFIG_AUTOBOOT_DELAY_STR
4653c609719bSwdenk
4654c609719bSwdenk  bootstopkey	- see CONFIG_AUTOBOOT_STOP_STR
4655c609719bSwdenk
4656e2a53458SMike Frysinger  ethprime	- controls which interface is used first.
4657a3d991bdSwdenk
4658e2a53458SMike Frysinger  ethact	- controls which interface is currently active.
4659e2a53458SMike Frysinger		  For example you can do the following
4660a3d991bdSwdenk
466148690d80SHeiko Schocher		  => setenv ethact FEC
466248690d80SHeiko Schocher		  => ping 192.168.0.1 # traffic sent on FEC
466348690d80SHeiko Schocher		  => setenv ethact SCC
466448690d80SHeiko Schocher		  => ping 10.0.0.1 # traffic sent on SCC
4665a3d991bdSwdenk
4666e1692577SMatthias Fuchs  ethrotate	- When set to "no" U-Boot does not go through all
4667e1692577SMatthias Fuchs		  available network interfaces.
4668e1692577SMatthias Fuchs		  It just stays at the currently selected interface.
4669e1692577SMatthias Fuchs
4670a3d991bdSwdenk  netretry	- When set to "no" each network operation will
4671a3d991bdSwdenk		  either succeed or fail without retrying.
46726e592385Swdenk		  When set to "once" the network operation will
46736e592385Swdenk		  fail when all the available network interfaces
46746e592385Swdenk		  are tried once without success.
4675a3d991bdSwdenk		  Useful on scripts which control the retry operation
4676a3d991bdSwdenk		  themselves.
4677a3d991bdSwdenk
4678b4e2f89dSJean-Christophe PLAGNIOL-VILLARD  npe_ucode	- set load address for the NPE microcode
4679a1cf027aSJean-Christophe PLAGNIOL-VILLARD
4680b445bbb4SJeremiah Mahler  silent_linux  - If set then Linux will be told to boot silently, by
46818d51aacdSSimon Glass		  changing the console to be empty. If "yes" it will be
46828d51aacdSSimon Glass		  made silent. If "no" it will not be made silent. If
46838d51aacdSSimon Glass		  unset, then it will be made silent if the U-Boot console
46848d51aacdSSimon Glass		  is silent.
46858d51aacdSSimon Glass
4686f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpsrcp	- If this is set, the value is used for TFTP's
4687ecb0ccd9SWolfgang Denk		  UDP source port.
4688ecb0ccd9SWolfgang Denk
4689f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftpdstp	- If this is set, the value is used for TFTP's UDP
469028cb9375SWolfgang Denk		  destination port instead of the Well Know Port 69.
469128cb9375SWolfgang Denk
4692c96f86eeSWolfgang Denk  tftpblocksize - Block size to use for TFTP transfers; if not set,
4693c96f86eeSWolfgang Denk		  we use the TFTP server's default block size
4694c96f86eeSWolfgang Denk
4695c96f86eeSWolfgang Denk  tftptimeout	- Retransmission timeout for TFTP packets (in milli-
4696c96f86eeSWolfgang Denk		  seconds, minimum value is 1000 = 1 second). Defines
4697c96f86eeSWolfgang Denk		  when a packet is considered to be lost so it has to
4698c96f86eeSWolfgang Denk		  be retransmitted. The default is 5000 = 5 seconds.
4699c96f86eeSWolfgang Denk		  Lowering this value may make downloads succeed
4700c96f86eeSWolfgang Denk		  faster in networks with high packet loss rates or
4701c96f86eeSWolfgang Denk		  with unreliable TFTP servers.
4702c96f86eeSWolfgang Denk
4703f5fb7346SAlbert ARIBAUD \(3ADEV\)  tftptimeoutcountmax	- maximum count of TFTP timeouts (no
4704f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unit, minimum value = 0). Defines how many timeouts
4705f5fb7346SAlbert ARIBAUD \(3ADEV\)		  can happen during a single file transfer before that
4706f5fb7346SAlbert ARIBAUD \(3ADEV\)		  transfer is aborted. The default is 10, and 0 means
4707f5fb7346SAlbert ARIBAUD \(3ADEV\)		  'no timeouts allowed'. Increasing this value may help
4708f5fb7346SAlbert ARIBAUD \(3ADEV\)		  downloads succeed with high packet loss rates, or with
4709f5fb7346SAlbert ARIBAUD \(3ADEV\)		  unreliable TFTP servers or client hardware.
4710f5fb7346SAlbert ARIBAUD \(3ADEV\)
4711a3d991bdSwdenk  vlan		- When set to a value < 4095 the traffic over
471211ccc33fSMarcel Ziswiler		  Ethernet is encapsulated/received over 802.1q
4713a3d991bdSwdenk		  VLAN tagged frames.
4714c609719bSwdenk
471550768f5bSAlexandre Messier  bootpretryperiod	- Period during which BOOTP/DHCP sends retries.
471650768f5bSAlexandre Messier		  Unsigned value, in milliseconds. If not set, the period will
471750768f5bSAlexandre Messier		  be either the default (28000), or a value based on
471850768f5bSAlexandre Messier		  CONFIG_NET_RETRY_COUNT, if defined. This value has
471950768f5bSAlexandre Messier		  precedence over the valu based on CONFIG_NET_RETRY_COUNT.
472050768f5bSAlexandre Messier
4721dc0b7b0eSJason HobbsThe following image location variables contain the location of images
4722dc0b7b0eSJason Hobbsused in booting. The "Image" column gives the role of the image and is
4723dc0b7b0eSJason Hobbsnot an environment variable name. The other columns are environment
4724dc0b7b0eSJason Hobbsvariable names. "File Name" gives the name of the file on a TFTP
4725dc0b7b0eSJason Hobbsserver, "RAM Address" gives the location in RAM the image will be
4726dc0b7b0eSJason Hobbsloaded to, and "Flash Location" gives the image's address in NOR
4727dc0b7b0eSJason Hobbsflash or offset in NAND flash.
4728dc0b7b0eSJason Hobbs
4729dc0b7b0eSJason Hobbs*Note* - these variables don't have to be defined for all boards, some
4730aed9fed9SFabio Estevamboards currently use other variables for these purposes, and some
4731dc0b7b0eSJason Hobbsboards use these variables for other purposes.
4732dc0b7b0eSJason Hobbs
4733dc0b7b0eSJason HobbsImage		    File Name	     RAM Address       Flash Location
4734dc0b7b0eSJason Hobbs-----		    ---------	     -----------       --------------
4735dc0b7b0eSJason Hobbsu-boot		    u-boot	     u-boot_addr_r     u-boot_addr
4736dc0b7b0eSJason HobbsLinux kernel	    bootfile	     kernel_addr_r     kernel_addr
4737dc0b7b0eSJason Hobbsdevice tree blob    fdtfile	     fdt_addr_r	       fdt_addr
4738dc0b7b0eSJason Hobbsramdisk		    ramdiskfile	     ramdisk_addr_r    ramdisk_addr
4739dc0b7b0eSJason Hobbs
4740c609719bSwdenkThe following environment variables may be used and automatically
4741c609719bSwdenkupdated by the network boot commands ("bootp" and "rarpboot"),
4742c609719bSwdenkdepending the information provided by your boot server:
4743c609719bSwdenk
4744c609719bSwdenk  bootfile	- see above
4745c609719bSwdenk  dnsip		- IP address of your Domain Name Server
4746fe389a82Sstroese  dnsip2	- IP address of your secondary Domain Name Server
4747c609719bSwdenk  gatewayip	- IP address of the Gateway (Router) to use
4748c609719bSwdenk  hostname	- Target hostname
4749c609719bSwdenk  ipaddr	- see above
4750c609719bSwdenk  netmask	- Subnet Mask
4751c609719bSwdenk  rootpath	- Pathname of the root filesystem on the NFS server
4752c609719bSwdenk  serverip	- see above
4753c609719bSwdenk
4754c609719bSwdenk
4755c609719bSwdenkThere are two special Environment Variables:
4756c609719bSwdenk
4757c609719bSwdenk  serial#	- contains hardware identification information such
4758c609719bSwdenk		  as type string and/or serial number
4759c609719bSwdenk  ethaddr	- Ethernet address
4760c609719bSwdenk
4761c609719bSwdenkThese variables can be set only once (usually during manufacturing of
4762c609719bSwdenkthe board). U-Boot refuses to delete or overwrite these variables
4763c609719bSwdenkonce they have been set once.
4764c609719bSwdenk
4765c609719bSwdenk
4766c1551ea8SstroeseFurther special Environment Variables:
4767c1551ea8Sstroese
4768c1551ea8Sstroese  ver		- Contains the U-Boot version string as printed
4769c1551ea8Sstroese		  with the "version" command. This variable is
4770c1551ea8Sstroese		  readonly (see CONFIG_VERSION_VARIABLE).
4771c1551ea8Sstroese
4772c1551ea8Sstroese
4773c609719bSwdenkPlease note that changes to some configuration parameters may take
4774c609719bSwdenkonly effect after the next boot (yes, that's just like Windoze :-).
4775c609719bSwdenk
4776c609719bSwdenk
4777170ab110SJoe HershbergerCallback functions for environment variables:
4778170ab110SJoe Hershberger---------------------------------------------
4779170ab110SJoe Hershberger
4780170ab110SJoe HershbergerFor some environment variables, the behavior of u-boot needs to change
4781b445bbb4SJeremiah Mahlerwhen their values are changed.  This functionality allows functions to
4782170ab110SJoe Hershbergerbe associated with arbitrary variables.  On creation, overwrite, or
4783170ab110SJoe Hershbergerdeletion, the callback will provide the opportunity for some side
4784170ab110SJoe Hershbergereffect to happen or for the change to be rejected.
4785170ab110SJoe Hershberger
4786170ab110SJoe HershbergerThe callbacks are named and associated with a function using the
4787170ab110SJoe HershbergerU_BOOT_ENV_CALLBACK macro in your board or driver code.
4788170ab110SJoe Hershberger
4789170ab110SJoe HershbergerThese callbacks are associated with variables in one of two ways.  The
4790170ab110SJoe Hershbergerstatic list can be added to by defining CONFIG_ENV_CALLBACK_LIST_STATIC
4791170ab110SJoe Hershbergerin the board configuration to a string that defines a list of
4792170ab110SJoe Hershbergerassociations.  The list must be in the following format:
4793170ab110SJoe Hershberger
4794170ab110SJoe Hershberger	entry = variable_name[:callback_name]
4795170ab110SJoe Hershberger	list = entry[,list]
4796170ab110SJoe Hershberger
4797170ab110SJoe HershbergerIf the callback name is not specified, then the callback is deleted.
4798170ab110SJoe HershbergerSpaces are also allowed anywhere in the list.
4799170ab110SJoe Hershberger
4800170ab110SJoe HershbergerCallbacks can also be associated by defining the ".callbacks" variable
4801170ab110SJoe Hershbergerwith the same list format above.  Any association in ".callbacks" will
4802170ab110SJoe Hershbergeroverride any association in the static list. You can define
4803170ab110SJoe HershbergerCONFIG_ENV_CALLBACK_LIST_DEFAULT to a list (string) to define the
4804b445bbb4SJeremiah Mahler".callbacks" environment variable in the default or embedded environment.
4805170ab110SJoe Hershberger
4806bdf1fe4eSJoe HershbergerIf CONFIG_REGEX is defined, the variable_name above is evaluated as a
4807bdf1fe4eSJoe Hershbergerregular expression. This allows multiple variables to be connected to
4808bdf1fe4eSJoe Hershbergerthe same callback without explicitly listing them all out.
4809bdf1fe4eSJoe Hershberger
4810170ab110SJoe Hershberger
4811f07771ccSwdenkCommand Line Parsing:
4812f07771ccSwdenk=====================
4813f07771ccSwdenk
4814f07771ccSwdenkThere are two different command line parsers available with U-Boot:
48157152b1d0Swdenkthe old "simple" one, and the much more powerful "hush" shell:
4816f07771ccSwdenk
4817f07771ccSwdenkOld, simple command line parser:
4818f07771ccSwdenk--------------------------------
4819f07771ccSwdenk
4820f07771ccSwdenk- supports environment variables (through setenv / saveenv commands)
4821f07771ccSwdenk- several commands on one line, separated by ';'
4822fe126d8bSWolfgang Denk- variable substitution using "... ${name} ..." syntax
4823f07771ccSwdenk- special characters ('$', ';') can be escaped by prefixing with '\',
4824f07771ccSwdenk  for example:
4825fe126d8bSWolfgang Denk	setenv bootcmd bootm \${address}
4826f07771ccSwdenk- You can also escape text by enclosing in single apostrophes, for example:
4827f07771ccSwdenk	setenv addip 'setenv bootargs $bootargs ip=$ipaddr:$serverip:$gatewayip:$netmask:$hostname::off'
4828f07771ccSwdenk
4829f07771ccSwdenkHush shell:
4830f07771ccSwdenk-----------
4831f07771ccSwdenk
4832f07771ccSwdenk- similar to Bourne shell, with control structures like
4833f07771ccSwdenk  if...then...else...fi, for...do...done; while...do...done,
4834f07771ccSwdenk  until...do...done, ...
4835f07771ccSwdenk- supports environment ("global") variables (through setenv / saveenv
4836f07771ccSwdenk  commands) and local shell variables (through standard shell syntax
4837f07771ccSwdenk  "name=value"); only environment variables can be used with "run"
4838f07771ccSwdenk  command
4839f07771ccSwdenk
4840f07771ccSwdenkGeneral rules:
4841f07771ccSwdenk--------------
4842f07771ccSwdenk
4843f07771ccSwdenk(1) If a command line (or an environment variable executed by a "run"
4844f07771ccSwdenk    command) contains several commands separated by semicolon, and
4845f07771ccSwdenk    one of these commands fails, then the remaining commands will be
4846f07771ccSwdenk    executed anyway.
4847f07771ccSwdenk
4848f07771ccSwdenk(2) If you execute several variables with one call to run (i. e.
484911ccc33fSMarcel Ziswiler    calling run with a list of variables as arguments), any failing
4850f07771ccSwdenk    command will cause "run" to terminate, i. e. the remaining
4851f07771ccSwdenk    variables are not executed.
4852f07771ccSwdenk
4853c609719bSwdenkNote for Redundant Ethernet Interfaces:
4854c609719bSwdenk=======================================
4855c609719bSwdenk
485611ccc33fSMarcel ZiswilerSome boards come with redundant Ethernet interfaces; U-Boot supports
4857c609719bSwdenksuch configurations and is capable of automatic selection of a
48587152b1d0Swdenk"working" interface when needed. MAC assignment works as follows:
4859c609719bSwdenk
4860c609719bSwdenkNetwork interfaces are numbered eth0, eth1, eth2, ... Corresponding
4861c609719bSwdenkMAC addresses can be stored in the environment as "ethaddr" (=>eth0),
4862c609719bSwdenk"eth1addr" (=>eth1), "eth2addr", ...
4863c609719bSwdenk
4864c609719bSwdenkIf the network interface stores some valid MAC address (for instance
4865c609719bSwdenkin SROM), this is used as default address if there is NO correspon-
4866c609719bSwdenkding setting in the environment; if the corresponding environment
4867c609719bSwdenkvariable is set, this overrides the settings in the card; that means:
4868c609719bSwdenk
4869c609719bSwdenko If the SROM has a valid MAC address, and there is no address in the
4870c609719bSwdenk  environment, the SROM's address is used.
4871c609719bSwdenk
4872c609719bSwdenko If there is no valid address in the SROM, and a definition in the
4873c609719bSwdenk  environment exists, then the value from the environment variable is
4874c609719bSwdenk  used.
4875c609719bSwdenk
4876c609719bSwdenko If both the SROM and the environment contain a MAC address, and
4877c609719bSwdenk  both addresses are the same, this MAC address is used.
4878c609719bSwdenk
4879c609719bSwdenko If both the SROM and the environment contain a MAC address, and the
4880c609719bSwdenk  addresses differ, the value from the environment is used and a
4881c609719bSwdenk  warning is printed.
4882c609719bSwdenk
4883c609719bSwdenko If neither SROM nor the environment contain a MAC address, an error
4884bef1014bSJoe Hershberger  is raised. If CONFIG_NET_RANDOM_ETHADDR is defined, then in this case
4885bef1014bSJoe Hershberger  a random, locally-assigned MAC is used.
4886c609719bSwdenk
4887ecee9324SBen WarrenIf Ethernet drivers implement the 'write_hwaddr' function, valid MAC addresses
4888ecee9324SBen Warrenwill be programmed into hardware as part of the initialization process.	 This
4889ecee9324SBen Warrenmay be skipped by setting the appropriate 'ethmacskip' environment variable.
4890ecee9324SBen WarrenThe naming convention is as follows:
4891ecee9324SBen Warren"ethmacskip" (=>eth0), "eth1macskip" (=>eth1) etc.
4892c609719bSwdenk
4893c609719bSwdenkImage Formats:
4894c609719bSwdenk==============
4895c609719bSwdenk
48963310c549SMarian BalakowiczU-Boot is capable of booting (and performing other auxiliary operations on)
48973310c549SMarian Balakowiczimages in two formats:
48983310c549SMarian Balakowicz
48993310c549SMarian BalakowiczNew uImage format (FIT)
49003310c549SMarian Balakowicz-----------------------
49013310c549SMarian Balakowicz
49023310c549SMarian BalakowiczFlexible and powerful format based on Flattened Image Tree -- FIT (similar
49033310c549SMarian Balakowiczto Flattened Device Tree). It allows the use of images with multiple
49043310c549SMarian Balakowiczcomponents (several kernels, ramdisks, etc.), with contents protected by
49053310c549SMarian BalakowiczSHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
49063310c549SMarian Balakowicz
49073310c549SMarian Balakowicz
49083310c549SMarian BalakowiczOld uImage format
49093310c549SMarian Balakowicz-----------------
49103310c549SMarian Balakowicz
49113310c549SMarian BalakowiczOld image format is based on binary files which can be basically anything,
49123310c549SMarian Balakowiczpreceded by a special header; see the definitions in include/image.h for
49133310c549SMarian Balakowiczdetails; basically, the header defines the following image properties:
4914c609719bSwdenk
4915c609719bSwdenk* Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
4916c609719bSwdenk  4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
4917f5ed9e39SPeter Tyser  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
4918f5ed9e39SPeter Tyser  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
4919f5ed9e39SPeter Tyser  INTEGRITY).
49207b64fef3SWolfgang Denk* Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
4921afc1ce82SMacpaul Lin  IA64, MIPS, NDS32, Nios II, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
4922afc1ce82SMacpaul Lin  Currently supported: ARM, AVR32, Intel x86, MIPS, NDS32, Nios II, PowerPC).
4923c29fdfc1Swdenk* Compression Type (uncompressed, gzip, bzip2)
4924c609719bSwdenk* Load Address
4925c609719bSwdenk* Entry Point
4926c609719bSwdenk* Image Name
4927c609719bSwdenk* Image Timestamp
4928c609719bSwdenk
4929c609719bSwdenkThe header is marked by a special Magic Number, and both the header
4930c609719bSwdenkand the data portions of the image are secured against corruption by
4931c609719bSwdenkCRC32 checksums.
4932c609719bSwdenk
4933c609719bSwdenk
4934c609719bSwdenkLinux Support:
4935c609719bSwdenk==============
4936c609719bSwdenk
4937c609719bSwdenkAlthough U-Boot should support any OS or standalone application
49387152b1d0Swdenkeasily, the main focus has always been on Linux during the design of
4939c609719bSwdenkU-Boot.
4940c609719bSwdenk
4941c609719bSwdenkU-Boot includes many features that so far have been part of some
4942c609719bSwdenkspecial "boot loader" code within the Linux kernel. Also, any
4943c609719bSwdenk"initrd" images to be used are no longer part of one big Linux image;
4944c609719bSwdenkinstead, kernel and "initrd" are separate images. This implementation
49457152b1d0Swdenkserves several purposes:
4946c609719bSwdenk
4947c609719bSwdenk- the same features can be used for other OS or standalone
4948c609719bSwdenk  applications (for instance: using compressed images to reduce the
4949c609719bSwdenk  Flash memory footprint)
4950c609719bSwdenk
4951c609719bSwdenk- it becomes much easier to port new Linux kernel versions because
49527152b1d0Swdenk  lots of low-level, hardware dependent stuff are done by U-Boot
4953c609719bSwdenk
4954c609719bSwdenk- the same Linux kernel image can now be used with different "initrd"
4955c609719bSwdenk  images; of course this also means that different kernel images can
4956c609719bSwdenk  be run with the same "initrd". This makes testing easier (you don't
4957c609719bSwdenk  have to build a new "zImage.initrd" Linux image when you just
4958c609719bSwdenk  change a file in your "initrd"). Also, a field-upgrade of the
4959c609719bSwdenk  software is easier now.
4960c609719bSwdenk
4961c609719bSwdenk
4962c609719bSwdenkLinux HOWTO:
4963c609719bSwdenk============
4964c609719bSwdenk
4965c609719bSwdenkPorting Linux to U-Boot based systems:
4966c609719bSwdenk---------------------------------------
4967c609719bSwdenk
4968c609719bSwdenkU-Boot cannot save you from doing all the necessary modifications to
4969c609719bSwdenkconfigure the Linux device drivers for use with your target hardware
4970c609719bSwdenk(no, we don't intend to provide a full virtual machine interface to
4971c609719bSwdenkLinux :-).
4972c609719bSwdenk
4973a47a12beSStefan RoeseBut now you can ignore ALL boot loader code (in arch/powerpc/mbxboot).
4974c609719bSwdenk
4975c609719bSwdenkJust make sure your machine specific header file (for instance
4976c609719bSwdenkinclude/asm-ppc/tqm8xx.h) includes the same definition of the Board
49771dc30693SMarkus HeidelbergInformation structure as we define in include/asm-<arch>/u-boot.h,
49781dc30693SMarkus Heidelbergand make sure that your definition of IMAP_ADDR uses the same value
49796d0f6bcfSJean-Christophe PLAGNIOL-VILLARDas your U-Boot configuration in CONFIG_SYS_IMMR.
4980c609719bSwdenk
49812eb31b13SSimon GlassNote that U-Boot now has a driver model, a unified model for drivers.
49822eb31b13SSimon GlassIf you are adding a new driver, plumb it into driver model. If there
49832eb31b13SSimon Glassis no uclass available, you are encouraged to create one. See
49842eb31b13SSimon Glassdoc/driver-model.
49852eb31b13SSimon Glass
4986c609719bSwdenk
4987c609719bSwdenkConfiguring the Linux kernel:
4988c609719bSwdenk-----------------------------
4989c609719bSwdenk
4990c609719bSwdenkNo specific requirements for U-Boot. Make sure you have some root
4991c609719bSwdenkdevice (initial ramdisk, NFS) for your target system.
4992c609719bSwdenk
4993c609719bSwdenk
4994c609719bSwdenkBuilding a Linux Image:
4995c609719bSwdenk-----------------------
4996c609719bSwdenk
499724ee89b9SwdenkWith U-Boot, "normal" build targets like "zImage" or "bzImage" are
499824ee89b9Swdenknot used. If you use recent kernel source, a new build target
499924ee89b9Swdenk"uImage" will exist which automatically builds an image usable by
500024ee89b9SwdenkU-Boot. Most older kernels also have support for a "pImage" target,
500124ee89b9Swdenkwhich was introduced for our predecessor project PPCBoot and uses a
500224ee89b9Swdenk100% compatible format.
5003c609719bSwdenk
5004c609719bSwdenkExample:
5005c609719bSwdenk
5006ab584d67SHolger Freyther	make TQM850L_defconfig
5007c609719bSwdenk	make oldconfig
5008c609719bSwdenk	make dep
500924ee89b9Swdenk	make uImage
5010c609719bSwdenk
501124ee89b9SwdenkThe "uImage" build target uses a special tool (in 'tools/mkimage') to
501224ee89b9Swdenkencapsulate a compressed Linux kernel image with header	 information,
501324ee89b9SwdenkCRC32 checksum etc. for use with U-Boot. This is what we are doing:
5014c609719bSwdenk
501524ee89b9Swdenk* build a standard "vmlinux" kernel image (in ELF binary format):
501624ee89b9Swdenk
501724ee89b9Swdenk* convert the kernel into a raw binary image:
501824ee89b9Swdenk
501924ee89b9Swdenk	${CROSS_COMPILE}-objcopy -O binary \
502024ee89b9Swdenk				 -R .note -R .comment \
502124ee89b9Swdenk				 -S vmlinux linux.bin
502224ee89b9Swdenk
502324ee89b9Swdenk* compress the binary image:
502424ee89b9Swdenk
502524ee89b9Swdenk	gzip -9 linux.bin
502624ee89b9Swdenk
502724ee89b9Swdenk* package compressed binary image for U-Boot:
502824ee89b9Swdenk
502924ee89b9Swdenk	mkimage -A ppc -O linux -T kernel -C gzip \
503024ee89b9Swdenk		-a 0 -e 0 -n "Linux Kernel Image" \
503124ee89b9Swdenk		-d linux.bin.gz uImage
503224ee89b9Swdenk
503324ee89b9Swdenk
503424ee89b9SwdenkThe "mkimage" tool can also be used to create ramdisk images for use
503524ee89b9Swdenkwith U-Boot, either separated from the Linux kernel image, or
503624ee89b9Swdenkcombined into one file. "mkimage" encapsulates the images with a 64
503724ee89b9Swdenkbyte header containing information about target architecture,
503824ee89b9Swdenkoperating system, image type, compression method, entry points, time
503924ee89b9Swdenkstamp, CRC32 checksums, etc.
504024ee89b9Swdenk
504124ee89b9Swdenk"mkimage" can be called in two ways: to verify existing images and
504224ee89b9Swdenkprint the header information, or to build new images.
5043c609719bSwdenk
5044c609719bSwdenkIn the first form (with "-l" option) mkimage lists the information
5045c609719bSwdenkcontained in the header of an existing U-Boot image; this includes
5046c609719bSwdenkchecksum verification:
5047c609719bSwdenk
5048c609719bSwdenk	tools/mkimage -l image
5049c609719bSwdenk	  -l ==> list image header information
5050c609719bSwdenk
5051c609719bSwdenkThe second form (with "-d" option) is used to build a U-Boot image
5052c609719bSwdenkfrom a "data file" which is used as image payload:
5053c609719bSwdenk
5054c609719bSwdenk	tools/mkimage -A arch -O os -T type -C comp -a addr -e ep \
5055c609719bSwdenk		      -n name -d data_file image
5056c609719bSwdenk	  -A ==> set architecture to 'arch'
5057c609719bSwdenk	  -O ==> set operating system to 'os'
5058c609719bSwdenk	  -T ==> set image type to 'type'
5059c609719bSwdenk	  -C ==> set compression type 'comp'
5060c609719bSwdenk	  -a ==> set load address to 'addr' (hex)
5061c609719bSwdenk	  -e ==> set entry point to 'ep' (hex)
5062c609719bSwdenk	  -n ==> set image name to 'name'
5063c609719bSwdenk	  -d ==> use image data from 'datafile'
5064c609719bSwdenk
506569459791SwdenkRight now, all Linux kernels for PowerPC systems use the same load
506669459791Swdenkaddress (0x00000000), but the entry point address depends on the
506769459791Swdenkkernel version:
5068c609719bSwdenk
5069c609719bSwdenk- 2.2.x kernels have the entry point at 0x0000000C,
507024ee89b9Swdenk- 2.3.x and later kernels have the entry point at 0x00000000.
5071c609719bSwdenk
5072c609719bSwdenkSo a typical call to build a U-Boot image would read:
5073c609719bSwdenk
507424ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
507524ee89b9Swdenk	> -A ppc -O linux -T kernel -C gzip -a 0 -e 0 \
5076a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz \
507724ee89b9Swdenk	> examples/uImage.TQM850L
507824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5079c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5080c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5081c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5082c609719bSwdenk	Load Address: 0x00000000
508324ee89b9Swdenk	Entry Point:  0x00000000
5084c609719bSwdenk
5085c609719bSwdenkTo verify the contents of the image (or check for corruption):
5086c609719bSwdenk
508724ee89b9Swdenk	-> tools/mkimage -l examples/uImage.TQM850L
508824ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5089c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5090c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (gzip compressed)
5091c609719bSwdenk	Data Size:    335725 Bytes = 327.86 kB = 0.32 MB
5092c609719bSwdenk	Load Address: 0x00000000
509324ee89b9Swdenk	Entry Point:  0x00000000
5094c609719bSwdenk
5095c609719bSwdenkNOTE: for embedded systems where boot time is critical you can trade
5096c609719bSwdenkspeed for memory and install an UNCOMPRESSED image instead: this
5097c609719bSwdenkneeds more space in Flash, but boots much faster since it does not
5098c609719bSwdenkneed to be uncompressed:
5099c609719bSwdenk
5100a47a12beSStefan Roese	-> gunzip /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux.gz
510124ee89b9Swdenk	-> tools/mkimage -n '2.4.4 kernel for TQM850L' \
510224ee89b9Swdenk	> -A ppc -O linux -T kernel -C none -a 0 -e 0 \
5103a47a12beSStefan Roese	> -d /opt/elsk/ppc_8xx/usr/src/linux-2.4.4/arch/powerpc/coffboot/vmlinux \
510424ee89b9Swdenk	> examples/uImage.TQM850L-uncompressed
510524ee89b9Swdenk	Image Name:   2.4.4 kernel for TQM850L
5106c609719bSwdenk	Created:      Wed Jul 19 02:34:59 2000
5107c609719bSwdenk	Image Type:   PowerPC Linux Kernel Image (uncompressed)
5108c609719bSwdenk	Data Size:    792160 Bytes = 773.59 kB = 0.76 MB
5109c609719bSwdenk	Load Address: 0x00000000
511024ee89b9Swdenk	Entry Point:  0x00000000
5111c609719bSwdenk
5112c609719bSwdenk
5113c609719bSwdenkSimilar you can build U-Boot images from a 'ramdisk.image.gz' file
5114c609719bSwdenkwhen your kernel is intended to use an initial ramdisk:
5115c609719bSwdenk
5116c609719bSwdenk	-> tools/mkimage -n 'Simple Ramdisk Image' \
5117c609719bSwdenk	> -A ppc -O linux -T ramdisk -C gzip \
5118c609719bSwdenk	> -d /LinuxPPC/images/SIMPLE-ramdisk.image.gz examples/simple-initrd
5119c609719bSwdenk	Image Name:   Simple Ramdisk Image
5120c609719bSwdenk	Created:      Wed Jan 12 14:01:50 2000
5121c609719bSwdenk	Image Type:   PowerPC Linux RAMDisk Image (gzip compressed)
5122c609719bSwdenk	Data Size:    566530 Bytes = 553.25 kB = 0.54 MB
5123c609719bSwdenk	Load Address: 0x00000000
5124c609719bSwdenk	Entry Point:  0x00000000
5125c609719bSwdenk
5126a804b5ceSGuilherme Maciel FerreiraThe "dumpimage" is a tool to disassemble images built by mkimage. Its "-i"
5127a804b5ceSGuilherme Maciel Ferreiraoption performs the converse operation of the mkimage's second form (the "-d"
5128a804b5ceSGuilherme Maciel Ferreiraoption). Given an image built by mkimage, the dumpimage extracts a "data file"
5129a804b5ceSGuilherme Maciel Ferreirafrom the image:
5130a804b5ceSGuilherme Maciel Ferreira
5131f41f5b7cSGuilherme Maciel Ferreira	tools/dumpimage -i image -T type -p position data_file
5132f41f5b7cSGuilherme Maciel Ferreira	  -i ==> extract from the 'image' a specific 'data_file'
5133f41f5b7cSGuilherme Maciel Ferreira	  -T ==> set image type to 'type'
5134f41f5b7cSGuilherme Maciel Ferreira	  -p ==> 'position' (starting at 0) of the 'data_file' inside the 'image'
5135a804b5ceSGuilherme Maciel Ferreira
5136c609719bSwdenk
5137c609719bSwdenkInstalling a Linux Image:
5138c609719bSwdenk-------------------------
5139c609719bSwdenk
5140c609719bSwdenkTo downloading a U-Boot image over the serial (console) interface,
5141c609719bSwdenkyou must convert the image to S-Record format:
5142c609719bSwdenk
5143c609719bSwdenk	objcopy -I binary -O srec examples/image examples/image.srec
5144c609719bSwdenk
5145c609719bSwdenkThe 'objcopy' does not understand the information in the U-Boot
5146c609719bSwdenkimage header, so the resulting S-Record file will be relative to
5147c609719bSwdenkaddress 0x00000000. To load it to a given address, you need to
5148c609719bSwdenkspecify the target address as 'offset' parameter with the 'loads'
5149c609719bSwdenkcommand.
5150c609719bSwdenk
5151c609719bSwdenkExample: install the image to address 0x40100000 (which on the
5152c609719bSwdenkTQM8xxL is in the first Flash bank):
5153c609719bSwdenk
5154c609719bSwdenk	=> erase 40100000 401FFFFF
5155c609719bSwdenk
5156c609719bSwdenk	.......... done
5157c609719bSwdenk	Erased 8 sectors
5158c609719bSwdenk
5159c609719bSwdenk	=> loads 40100000
5160c609719bSwdenk	## Ready for S-Record download ...
5161c609719bSwdenk	~>examples/image.srec
5162c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 12 13 ...
5163c609719bSwdenk	...
5164c609719bSwdenk	15989 15990 15991 15992
5165c609719bSwdenk	[file transfer complete]
5166c609719bSwdenk	[connected]
5167c609719bSwdenk	## Start Addr = 0x00000000
5168c609719bSwdenk
5169c609719bSwdenk
5170c609719bSwdenkYou can check the success of the download using the 'iminfo' command;
5171c609719bSwdenkthis includes a checksum verification so you can be sure no data
5172c609719bSwdenkcorruption happened:
5173c609719bSwdenk
5174c609719bSwdenk	=> imi 40100000
5175c609719bSwdenk
5176c609719bSwdenk	## Checking Image at 40100000 ...
5177c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5178c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5179c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5180c609719bSwdenk	   Load Address: 00000000
5181c609719bSwdenk	   Entry Point:	 0000000c
5182c609719bSwdenk	   Verifying Checksum ... OK
5183c609719bSwdenk
5184c609719bSwdenk
5185c609719bSwdenkBoot Linux:
5186c609719bSwdenk-----------
5187c609719bSwdenk
5188c609719bSwdenkThe "bootm" command is used to boot an application that is stored in
5189c609719bSwdenkmemory (RAM or Flash). In case of a Linux kernel image, the contents
5190c609719bSwdenkof the "bootargs" environment variable is passed to the kernel as
5191c609719bSwdenkparameters. You can check and modify this variable using the
5192c609719bSwdenk"printenv" and "setenv" commands:
5193c609719bSwdenk
5194c609719bSwdenk
5195c609719bSwdenk	=> printenv bootargs
5196c609719bSwdenk	bootargs=root=/dev/ram
5197c609719bSwdenk
5198c609719bSwdenk	=> setenv bootargs root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5199c609719bSwdenk
5200c609719bSwdenk	=> printenv bootargs
5201c609719bSwdenk	bootargs=root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5202c609719bSwdenk
5203c609719bSwdenk	=> bootm 40020000
5204c609719bSwdenk	## Booting Linux kernel at 40020000 ...
5205c609719bSwdenk	   Image Name:	 2.2.13 for NFS on TQM850L
5206c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5207c609719bSwdenk	   Data Size:	 381681 Bytes = 372 kB = 0 MB
5208c609719bSwdenk	   Load Address: 00000000
5209c609719bSwdenk	   Entry Point:	 0000000c
5210c609719bSwdenk	   Verifying Checksum ... OK
5211c609719bSwdenk	   Uncompressing Kernel Image ... OK
5212c609719bSwdenk	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
5213c609719bSwdenk	Boot arguments: root=/dev/nfs rw nfsroot=10.0.0.2:/LinuxPPC nfsaddrs=10.0.0.99:10.0.0.2
5214c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5215c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5216c609719bSwdenk	Memory: 15208k available (700k kernel code, 444k data, 32k init) [c0000000,c1000000]
5217c609719bSwdenk	...
5218c609719bSwdenk
521911ccc33fSMarcel ZiswilerIf you want to boot a Linux kernel with initial RAM disk, you pass
52207152b1d0Swdenkthe memory addresses of both the kernel and the initrd image (PPBCOOT
5221c609719bSwdenkformat!) to the "bootm" command:
5222c609719bSwdenk
5223c609719bSwdenk	=> imi 40100000 40200000
5224c609719bSwdenk
5225c609719bSwdenk	## Checking Image at 40100000 ...
5226c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5227c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5228c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5229c609719bSwdenk	   Load Address: 00000000
5230c609719bSwdenk	   Entry Point:	 0000000c
5231c609719bSwdenk	   Verifying Checksum ... OK
5232c609719bSwdenk
5233c609719bSwdenk	## Checking Image at 40200000 ...
5234c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5235c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5236c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5237c609719bSwdenk	   Load Address: 00000000
5238c609719bSwdenk	   Entry Point:	 00000000
5239c609719bSwdenk	   Verifying Checksum ... OK
5240c609719bSwdenk
5241c609719bSwdenk	=> bootm 40100000 40200000
5242c609719bSwdenk	## Booting Linux kernel at 40100000 ...
5243c609719bSwdenk	   Image Name:	 2.2.13 for initrd on TQM850L
5244c609719bSwdenk	   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
5245c609719bSwdenk	   Data Size:	 335725 Bytes = 327 kB = 0 MB
5246c609719bSwdenk	   Load Address: 00000000
5247c609719bSwdenk	   Entry Point:	 0000000c
5248c609719bSwdenk	   Verifying Checksum ... OK
5249c609719bSwdenk	   Uncompressing Kernel Image ... OK
5250c609719bSwdenk	## Loading RAMDisk Image at 40200000 ...
5251c609719bSwdenk	   Image Name:	 Simple Ramdisk Image
5252c609719bSwdenk	   Image Type:	 PowerPC Linux RAMDisk Image (gzip compressed)
5253c609719bSwdenk	   Data Size:	 566530 Bytes = 553 kB = 0 MB
5254c609719bSwdenk	   Load Address: 00000000
5255c609719bSwdenk	   Entry Point:	 00000000
5256c609719bSwdenk	   Verifying Checksum ... OK
5257c609719bSwdenk	   Loading Ramdisk ... OK
5258c609719bSwdenk	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
5259c609719bSwdenk	Boot arguments: root=/dev/ram
5260c609719bSwdenk	time_init: decrementer frequency = 187500000/60
5261c609719bSwdenk	Calibrating delay loop... 49.77 BogoMIPS
5262c609719bSwdenk	...
5263c609719bSwdenk	RAMDISK: Compressed image found at block 0
5264c609719bSwdenk	VFS: Mounted root (ext2 filesystem).
5265c609719bSwdenk
5266c609719bSwdenk	bash#
5267c609719bSwdenk
52680267768eSMatthew McClintockBoot Linux and pass a flat device tree:
52690267768eSMatthew McClintock-----------
52700267768eSMatthew McClintock
52710267768eSMatthew McClintockFirst, U-Boot must be compiled with the appropriate defines. See the section
52720267768eSMatthew McClintocktitled "Linux Kernel Interface" above for a more in depth explanation. The
52730267768eSMatthew McClintockfollowing is an example of how to start a kernel and pass an updated
52740267768eSMatthew McClintockflat device tree:
52750267768eSMatthew McClintock
52760267768eSMatthew McClintock=> print oftaddr
52770267768eSMatthew McClintockoftaddr=0x300000
52780267768eSMatthew McClintock=> print oft
52790267768eSMatthew McClintockoft=oftrees/mpc8540ads.dtb
52800267768eSMatthew McClintock=> tftp $oftaddr $oft
52810267768eSMatthew McClintockSpeed: 1000, full duplex
52820267768eSMatthew McClintockUsing TSEC0 device
52830267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.101
52840267768eSMatthew McClintockFilename 'oftrees/mpc8540ads.dtb'.
52850267768eSMatthew McClintockLoad address: 0x300000
52860267768eSMatthew McClintockLoading: #
52870267768eSMatthew McClintockdone
52880267768eSMatthew McClintockBytes transferred = 4106 (100a hex)
52890267768eSMatthew McClintock=> tftp $loadaddr $bootfile
52900267768eSMatthew McClintockSpeed: 1000, full duplex
52910267768eSMatthew McClintockUsing TSEC0 device
52920267768eSMatthew McClintockTFTP from server 192.168.1.1; our IP address is 192.168.1.2
52930267768eSMatthew McClintockFilename 'uImage'.
52940267768eSMatthew McClintockLoad address: 0x200000
52950267768eSMatthew McClintockLoading:############
52960267768eSMatthew McClintockdone
52970267768eSMatthew McClintockBytes transferred = 1029407 (fb51f hex)
52980267768eSMatthew McClintock=> print loadaddr
52990267768eSMatthew McClintockloadaddr=200000
53000267768eSMatthew McClintock=> print oftaddr
53010267768eSMatthew McClintockoftaddr=0x300000
53020267768eSMatthew McClintock=> bootm $loadaddr - $oftaddr
53030267768eSMatthew McClintock## Booting image at 00200000 ...
53040267768eSMatthew McClintock   Image Name:	 Linux-2.6.17-dirty
53050267768eSMatthew McClintock   Image Type:	 PowerPC Linux Kernel Image (gzip compressed)
53060267768eSMatthew McClintock   Data Size:	 1029343 Bytes = 1005.2 kB
53070267768eSMatthew McClintock   Load Address: 00000000
53080267768eSMatthew McClintock   Entry Point:	 00000000
53090267768eSMatthew McClintock   Verifying Checksum ... OK
53100267768eSMatthew McClintock   Uncompressing Kernel Image ... OK
53110267768eSMatthew McClintockBooting using flat device tree at 0x300000
53120267768eSMatthew McClintockUsing MPC85xx ADS machine description
53130267768eSMatthew McClintockMemory CAM mapping: CAM0=256Mb, CAM1=256Mb, CAM2=0Mb residual: 0Mb
53140267768eSMatthew McClintock[snip]
53150267768eSMatthew McClintock
53160267768eSMatthew McClintock
53176069ff26SwdenkMore About U-Boot Image Types:
53186069ff26Swdenk------------------------------
53196069ff26Swdenk
53206069ff26SwdenkU-Boot supports the following image types:
53216069ff26Swdenk
53226069ff26Swdenk   "Standalone Programs" are directly runnable in the environment
53236069ff26Swdenk	provided by U-Boot; it is expected that (if they behave
53246069ff26Swdenk	well) you can continue to work in U-Boot after return from
53256069ff26Swdenk	the Standalone Program.
53266069ff26Swdenk   "OS Kernel Images" are usually images of some Embedded OS which
53276069ff26Swdenk	will take over control completely. Usually these programs
53286069ff26Swdenk	will install their own set of exception handlers, device
53296069ff26Swdenk	drivers, set up the MMU, etc. - this means, that you cannot
53306069ff26Swdenk	expect to re-enter U-Boot except by resetting the CPU.
53316069ff26Swdenk   "RAMDisk Images" are more or less just data blocks, and their
53326069ff26Swdenk	parameters (address, size) are passed to an OS kernel that is
53336069ff26Swdenk	being started.
53346069ff26Swdenk   "Multi-File Images" contain several images, typically an OS
53356069ff26Swdenk	(Linux) kernel image and one or more data images like
53366069ff26Swdenk	RAMDisks. This construct is useful for instance when you want
53376069ff26Swdenk	to boot over the network using BOOTP etc., where the boot
53386069ff26Swdenk	server provides just a single image file, but you want to get
53396069ff26Swdenk	for instance an OS kernel and a RAMDisk image.
53406069ff26Swdenk
53416069ff26Swdenk	"Multi-File Images" start with a list of image sizes, each
53426069ff26Swdenk	image size (in bytes) specified by an "uint32_t" in network
53436069ff26Swdenk	byte order. This list is terminated by an "(uint32_t)0".
53446069ff26Swdenk	Immediately after the terminating 0 follow the images, one by
53456069ff26Swdenk	one, all aligned on "uint32_t" boundaries (size rounded up to
53466069ff26Swdenk	a multiple of 4 bytes).
53476069ff26Swdenk
53486069ff26Swdenk   "Firmware Images" are binary images containing firmware (like
53496069ff26Swdenk	U-Boot or FPGA images) which usually will be programmed to
53506069ff26Swdenk	flash memory.
53516069ff26Swdenk
53526069ff26Swdenk   "Script files" are command sequences that will be executed by
53536069ff26Swdenk	U-Boot's command interpreter; this feature is especially
53546069ff26Swdenk	useful when you configure U-Boot to use a real shell (hush)
53556069ff26Swdenk	as command interpreter.
53566069ff26Swdenk
535744f074c7SMarek VasutBooting the Linux zImage:
535844f074c7SMarek Vasut-------------------------
535944f074c7SMarek Vasut
536044f074c7SMarek VasutOn some platforms, it's possible to boot Linux zImage. This is done
536144f074c7SMarek Vasutusing the "bootz" command. The syntax of "bootz" command is the same
536244f074c7SMarek Vasutas the syntax of "bootm" command.
536344f074c7SMarek Vasut
53648ac28563STom RiniNote, defining the CONFIG_SUPPORT_RAW_INITRD allows user to supply
5365017e1f3fSMarek Vasutkernel with raw initrd images. The syntax is slightly different, the
5366017e1f3fSMarek Vasutaddress of the initrd must be augmented by it's size, in the following
5367017e1f3fSMarek Vasutformat: "<initrd addres>:<initrd size>".
5368017e1f3fSMarek Vasut
5369c609719bSwdenk
5370c609719bSwdenkStandalone HOWTO:
5371c609719bSwdenk=================
5372c609719bSwdenk
5373c609719bSwdenkOne of the features of U-Boot is that you can dynamically load and
5374c609719bSwdenkrun "standalone" applications, which can use some resources of
5375c609719bSwdenkU-Boot like console I/O functions or interrupt services.
5376c609719bSwdenk
5377c609719bSwdenkTwo simple examples are included with the sources:
5378c609719bSwdenk
5379c609719bSwdenk"Hello World" Demo:
5380c609719bSwdenk-------------------
5381c609719bSwdenk
5382c609719bSwdenk'examples/hello_world.c' contains a small "Hello World" Demo
5383c609719bSwdenkapplication; it is automatically compiled when you build U-Boot.
5384c609719bSwdenkIt's configured to run at address 0x00040004, so you can play with it
5385c609719bSwdenklike that:
5386c609719bSwdenk
5387c609719bSwdenk	=> loads
5388c609719bSwdenk	## Ready for S-Record download ...
5389c609719bSwdenk	~>examples/hello_world.srec
5390c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5391c609719bSwdenk	[file transfer complete]
5392c609719bSwdenk	[connected]
5393c609719bSwdenk	## Start Addr = 0x00040004
5394c609719bSwdenk
5395c609719bSwdenk	=> go 40004 Hello World! This is a test.
5396c609719bSwdenk	## Starting application at 0x00040004 ...
5397c609719bSwdenk	Hello World
5398c609719bSwdenk	argc = 7
5399c609719bSwdenk	argv[0] = "40004"
5400c609719bSwdenk	argv[1] = "Hello"
5401c609719bSwdenk	argv[2] = "World!"
5402c609719bSwdenk	argv[3] = "This"
5403c609719bSwdenk	argv[4] = "is"
5404c609719bSwdenk	argv[5] = "a"
5405c609719bSwdenk	argv[6] = "test."
5406c609719bSwdenk	argv[7] = "<NULL>"
5407c609719bSwdenk	Hit any key to exit ...
5408c609719bSwdenk
5409c609719bSwdenk	## Application terminated, rc = 0x0
5410c609719bSwdenk
5411c609719bSwdenkAnother example, which demonstrates how to register a CPM interrupt
5412c609719bSwdenkhandler with the U-Boot code, can be found in 'examples/timer.c'.
5413c609719bSwdenkHere, a CPM timer is set up to generate an interrupt every second.
5414c609719bSwdenkThe interrupt service routine is trivial, just printing a '.'
5415c609719bSwdenkcharacter, but this is just a demo program. The application can be
5416c609719bSwdenkcontrolled by the following keys:
5417c609719bSwdenk
5418c609719bSwdenk	? - print current values og the CPM Timer registers
5419c609719bSwdenk	b - enable interrupts and start timer
5420c609719bSwdenk	e - stop timer and disable interrupts
5421c609719bSwdenk	q - quit application
5422c609719bSwdenk
5423c609719bSwdenk	=> loads
5424c609719bSwdenk	## Ready for S-Record download ...
5425c609719bSwdenk	~>examples/timer.srec
5426c609719bSwdenk	1 2 3 4 5 6 7 8 9 10 11 ...
5427c609719bSwdenk	[file transfer complete]
5428c609719bSwdenk	[connected]
5429c609719bSwdenk	## Start Addr = 0x00040004
5430c609719bSwdenk
5431c609719bSwdenk	=> go 40004
5432c609719bSwdenk	## Starting application at 0x00040004 ...
5433c609719bSwdenk	TIMERS=0xfff00980
5434c609719bSwdenk	Using timer 1
5435c609719bSwdenk	  tgcr @ 0xfff00980, tmr @ 0xfff00990, trr @ 0xfff00994, tcr @ 0xfff00998, tcn @ 0xfff0099c, ter @ 0xfff009b0
5436c609719bSwdenk
5437c609719bSwdenkHit 'b':
5438c609719bSwdenk	[q, b, e, ?] Set interval 1000000 us
5439c609719bSwdenk	Enabling timer
5440c609719bSwdenkHit '?':
5441c609719bSwdenk	[q, b, e, ?] ........
5442c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0xef6, ter=0x0
5443c609719bSwdenkHit '?':
5444c609719bSwdenk	[q, b, e, ?] .
5445c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x2ad4, ter=0x0
5446c609719bSwdenkHit '?':
5447c609719bSwdenk	[q, b, e, ?] .
5448c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x1efc, ter=0x0
5449c609719bSwdenkHit '?':
5450c609719bSwdenk	[q, b, e, ?] .
5451c609719bSwdenk	tgcr=0x1, tmr=0xff1c, trr=0x3d09, tcr=0x0, tcn=0x169d, ter=0x0
5452c609719bSwdenkHit 'e':
5453c609719bSwdenk	[q, b, e, ?] ...Stopping timer
5454c609719bSwdenkHit 'q':
5455c609719bSwdenk	[q, b, e, ?] ## Application terminated, rc = 0x0
5456c609719bSwdenk
5457c609719bSwdenk
545885ec0bccSwdenkMinicom warning:
545985ec0bccSwdenk================
546085ec0bccSwdenk
54617152b1d0SwdenkOver time, many people have reported problems when trying to use the
546285ec0bccSwdenk"minicom" terminal emulation program for serial download. I (wd)
546385ec0bccSwdenkconsider minicom to be broken, and recommend not to use it. Under
5464f07771ccSwdenkUnix, I recommend to use C-Kermit for general purpose use (and
546585ec0bccSwdenkespecially for kermit binary protocol download ("loadb" command), and
5466e53515a2SKarl O. Pincuse "cu" for S-Record download ("loads" command).  See
5467e53515a2SKarl O. Pinchttp://www.denx.de/wiki/view/DULG/SystemSetup#Section_4.3.
5468e53515a2SKarl O. Pincfor help with kermit.
5469e53515a2SKarl O. Pinc
547085ec0bccSwdenk
547152f52c14SwdenkNevertheless, if you absolutely want to use it try adding this
547252f52c14Swdenkconfiguration to your "File transfer protocols" section:
547352f52c14Swdenk
547452f52c14Swdenk	   Name	   Program			Name U/D FullScr IO-Red. Multi
547552f52c14Swdenk	X  kermit  /usr/bin/kermit -i -l %l -s	 Y    U	   Y	   N	  N
547652f52c14Swdenk	Y  kermit  /usr/bin/kermit -i -l %l -r	 N    D	   Y	   N	  N
547752f52c14Swdenk
547852f52c14Swdenk
5479c609719bSwdenkNetBSD Notes:
5480c609719bSwdenk=============
5481c609719bSwdenk
5482c609719bSwdenkStarting at version 0.9.2, U-Boot supports NetBSD both as host
5483c609719bSwdenk(build U-Boot) and target system (boots NetBSD/mpc8xx).
5484c609719bSwdenk
5485c609719bSwdenkBuilding requires a cross environment; it is known to work on
5486c609719bSwdenkNetBSD/i386 with the cross-powerpc-netbsd-1.3 package (you will also
5487c609719bSwdenkneed gmake since the Makefiles are not compatible with BSD make).
5488c609719bSwdenkNote that the cross-powerpc package does not install include files;
5489c609719bSwdenkattempting to build U-Boot will fail because <machine/ansi.h> is
5490c609719bSwdenkmissing.  This file has to be installed and patched manually:
5491c609719bSwdenk
5492c609719bSwdenk	# cd /usr/pkg/cross/powerpc-netbsd/include
5493c609719bSwdenk	# mkdir powerpc
5494c609719bSwdenk	# ln -s powerpc machine
5495c609719bSwdenk	# cp /usr/src/sys/arch/powerpc/include/ansi.h powerpc/ansi.h
5496c609719bSwdenk	# ${EDIT} powerpc/ansi.h	## must remove __va_list, _BSD_VA_LIST
5497c609719bSwdenk
5498c609719bSwdenkNative builds *don't* work due to incompatibilities between native
5499c609719bSwdenkand U-Boot include files.
5500c609719bSwdenk
5501c609719bSwdenkBooting assumes that (the first part of) the image booted is a
5502c609719bSwdenkstage-2 loader which in turn loads and then invokes the kernel
5503c609719bSwdenkproper. Loader sources will eventually appear in the NetBSD source
5504c609719bSwdenktree (probably in sys/arc/mpc8xx/stand/u-boot_stage2/); in the
55052a8af187Swdenkmeantime, see ftp://ftp.denx.de/pub/u-boot/ppcboot_stage2.tar.gz
5506c609719bSwdenk
5507c609719bSwdenk
5508c609719bSwdenkImplementation Internals:
5509c609719bSwdenk=========================
5510c609719bSwdenk
5511c609719bSwdenkThe following is not intended to be a complete description of every
5512c609719bSwdenkimplementation detail. However, it should help to understand the
5513c609719bSwdenkinner workings of U-Boot and make it easier to port it to custom
5514c609719bSwdenkhardware.
5515c609719bSwdenk
5516c609719bSwdenk
5517c609719bSwdenkInitial Stack, Global Data:
5518c609719bSwdenk---------------------------
5519c609719bSwdenk
5520c609719bSwdenkThe implementation of U-Boot is complicated by the fact that U-Boot
5521c609719bSwdenkstarts running out of ROM (flash memory), usually without access to
5522c609719bSwdenksystem RAM (because the memory controller is not initialized yet).
5523c609719bSwdenkThis means that we don't have writable Data or BSS segments, and BSS
5524c609719bSwdenkis not initialized as zero. To be able to get a C environment working
5525c609719bSwdenkat all, we have to allocate at least a minimal stack. Implementation
5526c609719bSwdenkoptions for this are defined and restricted by the CPU used: Some CPU
5527c609719bSwdenkmodels provide on-chip memory (like the IMMR area on MPC8xx and
5528c609719bSwdenkMPC826x processors), on others (parts of) the data cache can be
5529c609719bSwdenklocked as (mis-) used as memory, etc.
5530c609719bSwdenk
55317152b1d0Swdenk	Chris Hallinan posted a good summary of these issues to the
55320668236bSWolfgang Denk	U-Boot mailing list:
553343d9616cSwdenk
553443d9616cSwdenk	Subject: RE: [U-Boot-Users] RE: More On Memory Bank x (nothingness)?
553543d9616cSwdenk	From: "Chris Hallinan" <clh@net1plus.com>
553643d9616cSwdenk	Date: Mon, 10 Feb 2003 16:43:46 -0500 (22:43 MET)
553743d9616cSwdenk	...
553843d9616cSwdenk
553943d9616cSwdenk	Correct me if I'm wrong, folks, but the way I understand it
554043d9616cSwdenk	is this: Using DCACHE as initial RAM for Stack, etc, does not
554143d9616cSwdenk	require any physical RAM backing up the cache. The cleverness
554243d9616cSwdenk	is that the cache is being used as a temporary supply of
554343d9616cSwdenk	necessary storage before the SDRAM controller is setup. It's
554411ccc33fSMarcel Ziswiler	beyond the scope of this list to explain the details, but you
554543d9616cSwdenk	can see how this works by studying the cache architecture and
554643d9616cSwdenk	operation in the architecture and processor-specific manuals.
554743d9616cSwdenk
554843d9616cSwdenk	OCM is On Chip Memory, which I believe the 405GP has 4K. It
554943d9616cSwdenk	is another option for the system designer to use as an
555011ccc33fSMarcel Ziswiler	initial stack/RAM area prior to SDRAM being available. Either
555143d9616cSwdenk	option should work for you. Using CS 4 should be fine if your
555243d9616cSwdenk	board designers haven't used it for something that would
555343d9616cSwdenk	cause you grief during the initial boot! It is frequently not
555443d9616cSwdenk	used.
555543d9616cSwdenk
55566d0f6bcfSJean-Christophe PLAGNIOL-VILLARD	CONFIG_SYS_INIT_RAM_ADDR should be somewhere that won't interfere
555743d9616cSwdenk	with your processor/board/system design. The default value
555843d9616cSwdenk	you will find in any recent u-boot distribution in
55598a316c9bSStefan Roese	walnut.h should work for you. I'd set it to a value larger
556043d9616cSwdenk	than your SDRAM module. If you have a 64MB SDRAM module, set
556143d9616cSwdenk	it above 400_0000. Just make sure your board has no resources
556243d9616cSwdenk	that are supposed to respond to that address! That code in
556343d9616cSwdenk	start.S has been around a while and should work as is when
556443d9616cSwdenk	you get the config right.
556543d9616cSwdenk
556643d9616cSwdenk	-Chris Hallinan
556743d9616cSwdenk	DS4.COM, Inc.
556843d9616cSwdenk
5569c609719bSwdenkIt is essential to remember this, since it has some impact on the C
5570c609719bSwdenkcode for the initialization procedures:
5571c609719bSwdenk
5572c609719bSwdenk* Initialized global data (data segment) is read-only. Do not attempt
5573c609719bSwdenk  to write it.
5574c609719bSwdenk
5575b445bbb4SJeremiah Mahler* Do not use any uninitialized global data (or implicitly initialized
5576c609719bSwdenk  as zero data - BSS segment) at all - this is undefined, initiali-
55777152b1d0Swdenk  zation is performed later (when relocating to RAM).
5578c609719bSwdenk
5579c609719bSwdenk* Stack space is very limited. Avoid big data buffers or things like
5580c609719bSwdenk  that.
5581c609719bSwdenk
5582c609719bSwdenkHaving only the stack as writable memory limits means we cannot use
5583b445bbb4SJeremiah Mahlernormal global data to share information between the code. But it
5584c609719bSwdenkturned out that the implementation of U-Boot can be greatly
5585c609719bSwdenksimplified by making a global data structure (gd_t) available to all
5586c609719bSwdenkfunctions. We could pass a pointer to this data as argument to _all_
5587c609719bSwdenkfunctions, but this would bloat the code. Instead we use a feature of
5588c609719bSwdenkthe GCC compiler (Global Register Variables) to share the data: we
5589c609719bSwdenkplace a pointer (gd) to the global data into a register which we
5590c609719bSwdenkreserve for this purpose.
5591c609719bSwdenk
55927152b1d0SwdenkWhen choosing a register for such a purpose we are restricted by the
5593c609719bSwdenkrelevant  (E)ABI  specifications for the current architecture, and by
5594c609719bSwdenkGCC's implementation.
5595c609719bSwdenk
5596c609719bSwdenkFor PowerPC, the following registers have specific use:
5597c609719bSwdenk	R1:	stack pointer
5598e7670f6cSWolfgang Denk	R2:	reserved for system use
5599c609719bSwdenk	R3-R4:	parameter passing and return values
5600c609719bSwdenk	R5-R10: parameter passing
5601c609719bSwdenk	R13:	small data area pointer
5602c609719bSwdenk	R30:	GOT pointer
5603c609719bSwdenk	R31:	frame pointer
5604c609719bSwdenk
5605e6bee808SJoakim Tjernlund	(U-Boot also uses R12 as internal GOT pointer. r12
5606e6bee808SJoakim Tjernlund	is a volatile register so r12 needs to be reset when
5607e6bee808SJoakim Tjernlund	going back and forth between asm and C)
5608c609719bSwdenk
5609e7670f6cSWolfgang Denk    ==> U-Boot will use R2 to hold a pointer to the global data
5610c609719bSwdenk
5611c609719bSwdenk    Note: on PPC, we could use a static initializer (since the
5612c609719bSwdenk    address of the global data structure is known at compile time),
5613c609719bSwdenk    but it turned out that reserving a register results in somewhat
5614c609719bSwdenk    smaller code - although the code savings are not that big (on
5615c609719bSwdenk    average for all boards 752 bytes for the whole U-Boot image,
5616c609719bSwdenk    624 text + 127 data).
5617c609719bSwdenk
5618c609719bSwdenkOn ARM, the following registers are used:
5619c609719bSwdenk
5620c609719bSwdenk	R0:	function argument word/integer result
5621c609719bSwdenk	R1-R3:	function argument word
562212eba1b4SJeroen Hofstee	R9:	platform specific
562312eba1b4SJeroen Hofstee	R10:	stack limit (used only if stack checking is enabled)
5624c609719bSwdenk	R11:	argument (frame) pointer
5625c609719bSwdenk	R12:	temporary workspace
5626c609719bSwdenk	R13:	stack pointer
5627c609719bSwdenk	R14:	link register
5628c609719bSwdenk	R15:	program counter
5629c609719bSwdenk
563012eba1b4SJeroen Hofstee    ==> U-Boot will use R9 to hold a pointer to the global data
563112eba1b4SJeroen Hofstee
563212eba1b4SJeroen Hofstee    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
5633c609719bSwdenk
56340df01fd3SThomas ChouOn Nios II, the ABI is documented here:
56350df01fd3SThomas Chou	http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf
56360df01fd3SThomas Chou
56370df01fd3SThomas Chou    ==> U-Boot will use gp to hold a pointer to the global data
56380df01fd3SThomas Chou
56390df01fd3SThomas Chou    Note: on Nios II, we give "-G0" option to gcc and don't use gp
56400df01fd3SThomas Chou    to access small data sections, so gp is free.
56410df01fd3SThomas Chou
5642afc1ce82SMacpaul LinOn NDS32, the following registers are used:
5643afc1ce82SMacpaul Lin
5644afc1ce82SMacpaul Lin	R0-R1:	argument/return
5645afc1ce82SMacpaul Lin	R2-R5:	argument
5646afc1ce82SMacpaul Lin	R15:	temporary register for assembler
5647afc1ce82SMacpaul Lin	R16:	trampoline register
5648afc1ce82SMacpaul Lin	R28:	frame pointer (FP)
5649afc1ce82SMacpaul Lin	R29:	global pointer (GP)
5650afc1ce82SMacpaul Lin	R30:	link register (LP)
5651afc1ce82SMacpaul Lin	R31:	stack pointer (SP)
5652afc1ce82SMacpaul Lin	PC:	program counter (PC)
5653afc1ce82SMacpaul Lin
5654afc1ce82SMacpaul Lin    ==> U-Boot will use R10 to hold a pointer to the global data
5655afc1ce82SMacpaul Lin
5656d87080b7SWolfgang DenkNOTE: DECLARE_GLOBAL_DATA_PTR must be used with file-global scope,
5657d87080b7SWolfgang Denkor current versions of GCC may "optimize" the code too much.
5658c609719bSwdenk
5659c609719bSwdenkMemory Management:
5660c609719bSwdenk------------------
5661c609719bSwdenk
5662c609719bSwdenkU-Boot runs in system state and uses physical addresses, i.e. the
5663c609719bSwdenkMMU is not used either for address mapping nor for memory protection.
5664c609719bSwdenk
5665c609719bSwdenkThe available memory is mapped to fixed addresses using the memory
5666c609719bSwdenkcontroller. In this process, a contiguous block is formed for each
5667c609719bSwdenkmemory type (Flash, SDRAM, SRAM), even when it consists of several
5668c609719bSwdenkphysical memory banks.
5669c609719bSwdenk
5670c609719bSwdenkU-Boot is installed in the first 128 kB of the first Flash bank (on
5671c609719bSwdenkTQM8xxL modules this is the range 0x40000000 ... 0x4001FFFF). After
5672c609719bSwdenkbooting and sizing and initializing DRAM, the code relocates itself
5673c609719bSwdenkto the upper end of DRAM. Immediately below the U-Boot code some
56746d0f6bcfSJean-Christophe PLAGNIOL-VILLARDmemory is reserved for use by malloc() [see CONFIG_SYS_MALLOC_LEN
5675c609719bSwdenkconfiguration setting]. Below that, a structure with global Board
5676c609719bSwdenkInfo data is placed, followed by the stack (growing downward).
5677c609719bSwdenk
5678c609719bSwdenkAdditionally, some exception handler code is copied to the low 8 kB
5679c609719bSwdenkof DRAM (0x00000000 ... 0x00001FFF).
5680c609719bSwdenk
5681c609719bSwdenkSo a typical memory configuration with 16 MB of DRAM could look like
5682c609719bSwdenkthis:
5683c609719bSwdenk
5684c609719bSwdenk	0x0000 0000	Exception Vector code
5685c609719bSwdenk	      :
5686c609719bSwdenk	0x0000 1FFF
5687c609719bSwdenk	0x0000 2000	Free for Application Use
5688c609719bSwdenk	      :
5689c609719bSwdenk	      :
5690c609719bSwdenk
5691c609719bSwdenk	      :
5692c609719bSwdenk	      :
5693c609719bSwdenk	0x00FB FF20	Monitor Stack (Growing downward)
5694c609719bSwdenk	0x00FB FFAC	Board Info Data and permanent copy of global data
5695c609719bSwdenk	0x00FC 0000	Malloc Arena
5696c609719bSwdenk	      :
5697c609719bSwdenk	0x00FD FFFF
5698c609719bSwdenk	0x00FE 0000	RAM Copy of Monitor Code
5699c609719bSwdenk	...		eventually: LCD or video framebuffer
5700c609719bSwdenk	...		eventually: pRAM (Protected RAM - unchanged by reset)
5701c609719bSwdenk	0x00FF FFFF	[End of RAM]
5702c609719bSwdenk
5703c609719bSwdenk
5704c609719bSwdenkSystem Initialization:
5705c609719bSwdenk----------------------
5706c609719bSwdenk
5707c609719bSwdenkIn the reset configuration, U-Boot starts at the reset entry point
570811ccc33fSMarcel Ziswiler(on most PowerPC systems at address 0x00000100). Because of the reset
5709c609719bSwdenkconfiguration for CS0# this is a mirror of the on board Flash memory.
57107152b1d0SwdenkTo be able to re-map memory U-Boot then jumps to its link address.
5711c609719bSwdenkTo be able to implement the initialization code in C, a (small!)
5712c609719bSwdenkinitial stack is set up in the internal Dual Ported RAM (in case CPUs
5713c609719bSwdenkwhich provide such a feature like MPC8xx or MPC8260), or in a locked
5714c609719bSwdenkpart of the data cache. After that, U-Boot initializes the CPU core,
5715c609719bSwdenkthe caches and the SIU.
5716c609719bSwdenk
5717c609719bSwdenkNext, all (potentially) available memory banks are mapped using a
5718c609719bSwdenkpreliminary mapping. For example, we put them on 512 MB boundaries
5719c609719bSwdenk(multiples of 0x20000000: SDRAM on 0x00000000 and 0x20000000, Flash
5720c609719bSwdenkon 0x40000000 and 0x60000000, SRAM on 0x80000000). Then UPM A is
5721c609719bSwdenkprogrammed for SDRAM access. Using the temporary configuration, a
5722c609719bSwdenksimple memory test is run that determines the size of the SDRAM
5723c609719bSwdenkbanks.
5724c609719bSwdenk
5725c609719bSwdenkWhen there is more than one SDRAM bank, and the banks are of
57267152b1d0Swdenkdifferent size, the largest is mapped first. For equal size, the first
5727c609719bSwdenkbank (CS2#) is mapped first. The first mapping is always for address
5728c609719bSwdenk0x00000000, with any additional banks following immediately to create
5729c609719bSwdenkcontiguous memory starting from 0.
5730c609719bSwdenk
5731c609719bSwdenkThen, the monitor installs itself at the upper end of the SDRAM area
5732c609719bSwdenkand allocates memory for use by malloc() and for the global Board
5733c609719bSwdenkInfo data; also, the exception vector code is copied to the low RAM
5734c609719bSwdenkpages, and the final stack is set up.
5735c609719bSwdenk
5736c609719bSwdenkOnly after this relocation will you have a "normal" C environment;
5737c609719bSwdenkuntil that you are restricted in several ways, mostly because you are
5738c609719bSwdenkrunning from ROM, and because the code will have to be relocated to a
5739c609719bSwdenknew address in RAM.
5740c609719bSwdenk
5741c609719bSwdenk
5742c609719bSwdenkU-Boot Porting Guide:
5743c609719bSwdenk----------------------
5744c609719bSwdenk
5745c609719bSwdenk[Based on messages by Jerry Van Baren in the U-Boot-Users mailing
57466aff3115Swdenklist, October 2002]
5747c609719bSwdenk
5748c609719bSwdenk
5749c609719bSwdenkint main(int argc, char *argv[])
5750c609719bSwdenk{
5751c609719bSwdenk	sighandler_t no_more_time;
5752c609719bSwdenk
5753c609719bSwdenk	signal(SIGALRM, no_more_time);
5754c609719bSwdenk	alarm(PROJECT_DEADLINE - toSec (3 * WEEK));
5755c609719bSwdenk
5756c609719bSwdenk	if (available_money > available_manpower) {
57576c3fef28SJerry Van Baren		Pay consultant to port U-Boot;
5758c609719bSwdenk		return 0;
5759c609719bSwdenk	}
5760c609719bSwdenk
5761c609719bSwdenk	Download latest U-Boot source;
5762c609719bSwdenk
57630668236bSWolfgang Denk	Subscribe to u-boot mailing list;
57646aff3115Swdenk
57656c3fef28SJerry Van Baren	if (clueless)
5766c609719bSwdenk		email("Hi, I am new to U-Boot, how do I get started?");
5767c609719bSwdenk
5768c609719bSwdenk	while (learning) {
5769c609719bSwdenk		Read the README file in the top level directory;
57707cb22f97Swdenk		Read http://www.denx.de/twiki/bin/view/DULG/Manual;
57716c3fef28SJerry Van Baren		Read applicable doc/*.README;
5772c609719bSwdenk		Read the source, Luke;
57736c3fef28SJerry Van Baren		/* find . -name "*.[chS]" | xargs grep -i <keyword> */
5774c609719bSwdenk	}
5775c609719bSwdenk
57766c3fef28SJerry Van Baren	if (available_money > toLocalCurrency ($2500))
57776c3fef28SJerry Van Baren		Buy a BDI3000;
57786c3fef28SJerry Van Baren	else
5779c609719bSwdenk		Add a lot of aggravation and time;
5780c609719bSwdenk
57816c3fef28SJerry Van Baren	if (a similar board exists) {	/* hopefully... */
57826c3fef28SJerry Van Baren		cp -a board/<similar> board/<myboard>
57836c3fef28SJerry Van Baren		cp include/configs/<similar>.h include/configs/<myboard>.h
57846c3fef28SJerry Van Baren	} else {
5785c609719bSwdenk		Create your own board support subdirectory;
57866c3fef28SJerry Van Baren		Create your own board include/configs/<myboard>.h file;
57876c3fef28SJerry Van Baren	}
57886c3fef28SJerry Van Baren	Edit new board/<myboard> files
57896c3fef28SJerry Van Baren	Edit new include/configs/<myboard>.h
5790c609719bSwdenk
57916c3fef28SJerry Van Baren	while (!accepted) {
5792c609719bSwdenk		while (!running) {
5793c609719bSwdenk			do {
5794c609719bSwdenk				Add / modify source code;
5795c609719bSwdenk			} until (compiles);
5796c609719bSwdenk			Debug;
5797c609719bSwdenk			if (clueless)
5798c609719bSwdenk				email("Hi, I am having problems...");
5799c609719bSwdenk		}
58006c3fef28SJerry Van Baren		Send patch file to the U-Boot email list;
58016c3fef28SJerry Van Baren		if (reasonable critiques)
58026c3fef28SJerry Van Baren			Incorporate improvements from email list code review;
58036c3fef28SJerry Van Baren		else
58046c3fef28SJerry Van Baren			Defend code as written;
58056c3fef28SJerry Van Baren	}
5806c609719bSwdenk
5807c609719bSwdenk	return 0;
5808c609719bSwdenk}
5809c609719bSwdenk
5810c609719bSwdenkvoid no_more_time (int sig)
5811c609719bSwdenk{
5812c609719bSwdenk      hire_a_guru();
5813c609719bSwdenk}
5814c609719bSwdenk
5815c609719bSwdenk
5816c609719bSwdenkCoding Standards:
5817c609719bSwdenk-----------------
5818c609719bSwdenk
5819c609719bSwdenkAll contributions to U-Boot should conform to the Linux kernel
58202c051651SDetlev Zundelcoding style; see the file "Documentation/CodingStyle" and the script
58217ca9296eSWolfgang Denk"scripts/Lindent" in your Linux kernel source directory.
5822c609719bSwdenk
58232c051651SDetlev ZundelSource files originating from a different project (for example the
58242c051651SDetlev ZundelMTD subsystem) are generally exempt from these guidelines and are not
5825b445bbb4SJeremiah Mahlerreformatted to ease subsequent migration to newer versions of those
58262c051651SDetlev Zundelsources.
58272c051651SDetlev Zundel
58282c051651SDetlev ZundelPlease note that U-Boot is implemented in C (and to some small parts in
58292c051651SDetlev ZundelAssembler); no C++ is used, so please do not use C++ style comments (//)
58302c051651SDetlev Zundelin your code.
5831c609719bSwdenk
5832c178d3daSwdenkPlease also stick to the following formatting rules:
5833180d3f74Swdenk- remove any trailing white space
58347ca9296eSWolfgang Denk- use TAB characters for indentation and vertical alignment, not spaces
5835180d3f74Swdenk- make sure NOT to use DOS '\r\n' line feeds
58367ca9296eSWolfgang Denk- do not add more than 2 consecutive empty lines to source files
5837180d3f74Swdenk- do not add trailing empty lines to source files
5838180d3f74Swdenk
5839c609719bSwdenkSubmissions which do not conform to the standards may be returned
5840c609719bSwdenkwith a request to reformat the changes.
5841c609719bSwdenk
5842c609719bSwdenk
5843c609719bSwdenkSubmitting Patches:
5844c609719bSwdenk-------------------
5845c609719bSwdenk
5846c609719bSwdenkSince the number of patches for U-Boot is growing, we need to
5847c609719bSwdenkestablish some rules. Submissions which do not conform to these rules
5848c609719bSwdenkmay be rejected, even when they contain important and valuable stuff.
5849c609719bSwdenk
58500d28f34bSMagnus LiljaPlease see http://www.denx.de/wiki/U-Boot/Patches for details.
5851218ca724SWolfgang Denk
58520668236bSWolfgang DenkPatches shall be sent to the u-boot mailing list <u-boot@lists.denx.de>;
58530668236bSWolfgang Denksee http://lists.denx.de/mailman/listinfo/u-boot
58540668236bSWolfgang Denk
5855c609719bSwdenkWhen you send a patch, please include the following information with
5856c609719bSwdenkit:
5857c609719bSwdenk
5858c609719bSwdenk* For bug fixes: a description of the bug and how your patch fixes
5859c609719bSwdenk  this bug. Please try to include a way of demonstrating that the
5860c609719bSwdenk  patch actually fixes something.
5861c609719bSwdenk
5862c609719bSwdenk* For new features: a description of the feature and your
5863c609719bSwdenk  implementation.
5864c609719bSwdenk
5865c609719bSwdenk* A CHANGELOG entry as plaintext (separate from the patch)
5866c609719bSwdenk
58677207b366SRobert P. J. Day* For major contributions, add a MAINTAINERS file with your
58687207b366SRobert P. J. Day  information and associated file and directory references.
5869c609719bSwdenk
587027af930eSAlbert ARIBAUD* When you add support for a new board, don't forget to add a
587127af930eSAlbert ARIBAUD  maintainer e-mail address to the boards.cfg file, too.
5872c609719bSwdenk
5873c609719bSwdenk* If your patch adds new configuration options, don't forget to
5874c609719bSwdenk  document these in the README file.
5875c609719bSwdenk
5876218ca724SWolfgang Denk* The patch itself. If you are using git (which is *strongly*
5877218ca724SWolfgang Denk  recommended) you can easily generate the patch using the
58787ca9296eSWolfgang Denk  "git format-patch". If you then use "git send-email" to send it to
5879218ca724SWolfgang Denk  the U-Boot mailing list, you will avoid most of the common problems
5880218ca724SWolfgang Denk  with some other mail clients.
5881c609719bSwdenk
5882218ca724SWolfgang Denk  If you cannot use git, use "diff -purN OLD NEW". If your version of
5883218ca724SWolfgang Denk  diff does not support these options, then get the latest version of
5884218ca724SWolfgang Denk  GNU diff.
58856dff5529Swdenk
5886218ca724SWolfgang Denk  The current directory when running this command shall be the parent
5887218ca724SWolfgang Denk  directory of the U-Boot source tree (i. e. please make sure that
5888218ca724SWolfgang Denk  your patch includes sufficient directory information for the
5889218ca724SWolfgang Denk  affected files).
5890218ca724SWolfgang Denk
5891218ca724SWolfgang Denk  We prefer patches as plain text. MIME attachments are discouraged,
5892218ca724SWolfgang Denk  and compressed attachments must not be used.
5893c609719bSwdenk
589452f52c14Swdenk* If one logical set of modifications affects or creates several
589552f52c14Swdenk  files, all these changes shall be submitted in a SINGLE patch file.
589652f52c14Swdenk
589752f52c14Swdenk* Changesets that contain different, unrelated modifications shall be
589852f52c14Swdenk  submitted as SEPARATE patches, one patch per changeset.
589952f52c14Swdenk
590052f52c14Swdenk
5901c609719bSwdenkNotes:
5902c609719bSwdenk
59036de80f21SSimon Glass* Before sending the patch, run the buildman script on your patched
5904c609719bSwdenk  source tree and make sure that no errors or warnings are reported
5905c609719bSwdenk  for any of the boards.
5906c609719bSwdenk
5907c609719bSwdenk* Keep your modifications to the necessary minimum: A patch
5908c609719bSwdenk  containing several unrelated changes or arbitrary reformats will be
5909c609719bSwdenk  returned with a request to re-formatting / split it.
5910c609719bSwdenk
5911c609719bSwdenk* If you modify existing code, make sure that your new code does not
5912c609719bSwdenk  add to the memory footprint of the code ;-) Small is beautiful!
5913c609719bSwdenk  When adding new features, these should compile conditionally only
5914c609719bSwdenk  (using #ifdef), and the resulting code with the new feature
5915c609719bSwdenk  disabled must not need more memory than the old code without your
5916c609719bSwdenk  modification.
591790dc6704Swdenk
59180668236bSWolfgang Denk* Remember that there is a size limit of 100 kB per message on the
59190668236bSWolfgang Denk  u-boot mailing list. Bigger patches will be moderated. If they are
59200668236bSWolfgang Denk  reasonable and not too big, they will be acknowledged. But patches
59210668236bSWolfgang Denk  bigger than the size limit should be avoided.
5922